1 /* Copyright (C) 2013-2015 by Jacob Alexander
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 #ifndef __output_com_h
23 #define __output_com_h
25 // ----- Includes -----
31 #include <buildvars.h> // Defines USB Parameters, partially generated by CMake
35 // ----- Defines -----
37 // Max size of key buffer needed for NKRO
38 // Boot mode uses only the first 6 bytes
39 #define USB_NKRO_BITFIELD_SIZE_KEYS 27
40 #define USB_BOOT_MAX_KEYS 6
44 // ----- Enumerations -----
46 // USB NKRO state transitions (indicates which Report ID's need refreshing)
47 // Boot mode just checks if any keys were changed (as everything is sent every time)
48 typedef enum USBKeyChangeState {
49 USBKeyChangeState_None = 0x00,
50 USBKeyChangeState_Modifiers = 0x01,
51 USBKeyChangeState_MainKeys = 0x02,
52 USBKeyChangeState_SecondaryKeys = 0x04,
53 USBKeyChangeState_TertiaryKeys = 0x08,
54 USBKeyChangeState_QuartiaryKeys = 0x10,
55 USBKeyChangeState_System = 0x20,
56 USBKeyChangeState_Consumer = 0x40,
57 USBKeyChangeState_All = 0x7F,
62 // ----- Variables -----
64 // Variables used to communciate to the output module
65 // XXX Even if the output module is not USB, this is internally understood keymapping scheme
66 extern uint8_t USBKeys_Modifiers;
67 extern uint8_t USBKeys_Keys[USB_NKRO_BITFIELD_SIZE_KEYS];
68 extern uint8_t USBKeys_Sent;
69 extern volatile uint8_t USBKeys_LEDs;
71 extern uint8_t USBKeys_SysCtrl; // 1KRO container for System Control HID table
72 extern uint16_t USBKeys_ConsCtrl; // 1KRO container for Consumer Control HID table
74 extern volatile uint8_t USBKeys_Protocol; // 0 - Boot Mode, 1 - NKRO Mode
76 // Misc variables (XXX Some are only properly utilized using AVR)
77 extern uint8_t USBKeys_Idle_Config;
78 extern uint8_t USBKeys_Idle_Count;
80 extern USBKeyChangeState USBKeys_Changed;
82 extern uint8_t Output_Available; // 0 - Output module not fully functional, 1 - Output module working
86 // ----- Capabilities -----
88 // Output capabilities
89 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
90 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
91 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args );
93 // Configuration capabilities
94 void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args );
95 void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args );
99 // ----- Functions -----
104 void Output_flushBuffers();
106 void Output_firmwareReload();
107 void Output_softReset();
109 // Relies on USB serial module
110 unsigned int Output_availablechar();
112 int Output_getchar();
113 int Output_putchar( char c );
114 int Output_putstr( char* str );