ADD: keymap macro for human to read easier

[max/tmk_keyboard.git] / usb_keyboard.h

diff --git a/usb_keyboard.h b/usb_keyboard.h
index 90c2c5af62ca3f83a6b7fa889e1fd8bc64e30c54..691ef8b275269cda975aea899a00eab08b0e8a0e 100644 (file)
--- a/usb_keyboard.h
+++ b/usb_keyboard.h
@@ -2,6 +2,7 @@
 #define  USB_KEYBOARD_H 1
 
 #include <stdint.h>
+#include <stdbool.h>
 #include "usb.h"
 
 
@@ -10,26 +11,38 @@
 #define KEYBOARD_SIZE          8
 #define KEYBOARD_BUFFER                EP_DOUBLE_BUFFER
 
-// modifier bits
-#define MOD_LCTRL   (1<<0)
-#define MOD_LSHIFT  (1<<1)
-#define MOD_LALT    (1<<2)
-#define MOD_LGUI    (1<<3)
-#define MOD_RCTRL   (1<<4)
-#define MOD_RSHIFT  (1<<5)
-#define MOD_RALT    (1<<6)
-#define MOD_RGUI    (1<<7)
-
-
+#define BIT_LCTRL   (1<<0)
+#define BIT_LSHIFT  (1<<1)
+#define BIT_LALT    (1<<2)
+#define BIT_LGUI    (1<<3)
+#define BIT_RCTRL   (1<<4)
+#define BIT_RSHIFT  (1<<5)
+#define BIT_RALT    (1<<6)
+#define BIT_RGUI    (1<<7)
+#define BIT_LCTL BIT_LCTRL
+#define BIT_RCTL BIT_RCTRL
+#define BIT_LSFT BIT_LSHIFT
+#define BIT_RSFT BIT_RSHIFT
+
+
+// TODO: change variable name: usb_keyboard_ or usb_kb_
 extern uint8_t keyboard_modifier_keys;
 extern uint8_t keyboard_keys[6];
 extern uint8_t keyboard_protocol;
 extern uint8_t keyboard_idle_config;
 extern uint8_t keyboard_idle_count;
-extern volatile uint8_t keyboard_leds;
+extern volatile uint8_t keyboard_leds; // TODO: delete NOT USED?
 
 
 int8_t usb_keyboard_press(uint8_t key, uint8_t modifier);
 int8_t usb_keyboard_send(void);
+void usb_keyboard_init(void);
+void usb_keyboard_clear(void);
+void usb_keyboard_clear_key(void);
+void usb_keyboard_clear_mod(void);
+bool usb_keyboard_is_sent(void);
+bool usb_keyboard_has_key(void);
+bool usb_keyboard_has_mod(void);
+void usb_keyboard_print(void);
 
 #endif