1 /* Copyright (C) 2013-2014 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 // Indicator for other modules through USBKeys_MaxSize for how capable the USB module is when sending large number of keypresses
38 #define USB_MAX_KEY_SEND 6
42 // ----- Variables -----
44 // Variables used to communciate to the output module
45 // XXX Even if the output module is not USB, this is internally understood keymapping scheme
46 extern uint8_t USBKeys_Modifiers;
47 extern uint8_t USBKeys_Array[USB_MAX_KEY_SEND];
48 extern uint8_t USBKeys_Sent;
49 extern volatile uint8_t USBKeys_LEDs;
51 static const uint8_t USBKeys_MaxSize = USB_MAX_KEY_SEND;
52 extern volatile uint8_t USBKeys_Protocol; // 0 - Boot Mode, 1 - NKRO Mode
54 // Misc variables (XXX Some are only properly utilized using AVR)
55 extern uint8_t USBKeys_Idle_Config;
56 extern uint8_t USBKeys_Idle_Count;
60 // ----- Functions -----
65 void Output_firmwareReload();
66 void Output_softReset();
68 // Relies on USB serial module
69 unsigned int Output_availablechar();
72 int Output_putchar( char c );
73 int Output_putstr( char* str );