-/* Copyright (C) 2013-2014 by Jacob Alexander
+/* Copyright (C) 2013-2015 by Jacob Alexander
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* THE SOFTWARE.
*/
-#ifndef __output_com_h
-#define __output_com_h
+#pragma once
// ----- Includes -----
// ----- Defines -----
-// Indicator for other modules through USBKeys_MaxSize for how capable the USB module is when sending large number of keypresses
-#define USB_MAX_KEY_SEND 6
+// Max size of key buffer needed for NKRO
+// Boot mode uses only the first 6 bytes
+#define USB_NKRO_BITFIELD_SIZE_KEYS 27
+#define USB_BOOT_MAX_KEYS 6
+
+
+
+// ----- Enumerations -----
+
+// USB NKRO state transitions (indicates which Report ID's need refreshing)
+// Boot mode just checks if any keys were changed (as everything is sent every time)
+typedef enum USBKeyChangeState {
+ USBKeyChangeState_None = 0x00,
+ USBKeyChangeState_Modifiers = 0x01,
+ USBKeyChangeState_MainKeys = 0x02,
+ USBKeyChangeState_SecondaryKeys = 0x04,
+ USBKeyChangeState_TertiaryKeys = 0x08,
+ USBKeyChangeState_QuartiaryKeys = 0x10,
+ USBKeyChangeState_System = 0x20,
+ USBKeyChangeState_Consumer = 0x40,
+ USBKeyChangeState_All = 0x7F,
+} USBKeyChangeState;
// ----- Variables -----
-// Variables used to communciate to the usb module
-extern uint8_t USBKeys_Modifiers;
-extern uint8_t USBKeys_Array[USB_MAX_KEY_SEND];
-extern uint8_t USBKeys_Sent;
-extern volatile uint8_t USBKeys_LEDs;
+// Variables used to communciate to the output module
+// XXX Even if the output module is not USB, this is internally understood keymapping scheme
+extern uint8_t USBKeys_Modifiers;
+extern uint8_t USBKeys_Keys[USB_NKRO_BITFIELD_SIZE_KEYS];
+extern uint8_t USBKeys_Sent;
+extern volatile uint8_t USBKeys_LEDs;
+
+extern uint8_t USBKeys_SysCtrl; // 1KRO container for System Control HID table
+extern uint16_t USBKeys_ConsCtrl; // 1KRO container for Consumer Control HID table
- static const uint8_t USBKeys_MaxSize = USB_MAX_KEY_SEND;
+extern volatile uint8_t USBKeys_Protocol; // 0 - Boot Mode, 1 - NKRO Mode
// Misc variables (XXX Some are only properly utilized using AVR)
-extern uint8_t USBKeys_Protocol;
-extern uint8_t USBKeys_Idle_Config;
-extern uint8_t USBKeys_Idle_Count;
+extern uint8_t USBKeys_Idle_Config;
+extern uint8_t USBKeys_Idle_Count;
+
+extern USBKeyChangeState USBKeys_Changed;
+
+extern volatile uint8_t Output_Available; // 0 - Output module not fully functional, 1 - Output module working
+
+extern uint8_t Output_DebugMode; // 0 - Debug disabled, 1 - Debug enabled
// ----- Functions -----
-void output_setup();
+void Output_setup();
+void Output_send();
+
+void Output_flushBuffers();
-void output_send();
+void Output_firmwareReload();
+void Output_softReset();
-void output_firmwareReload();
+// Relies on USB serial module
+unsigned int Output_availablechar();
-#endif
+int Output_getchar();
+int Output_putchar( char c );
+int Output_putstr( char* str );