small update

firmware/lib/layout/key-functions.h

@@ -30,6 +30,7 @@ void key_functions__jump_to_bootloader (void);
 
 // special
 void key_functions__toggle_capslock       (void);
+void key_functions__type_byte_hex         (uint8_t byte);
 void key_functions__send_unicode_sequence (const char * string);
 
 
@@ -96,6 +97,14 @@ void key_functions__send_unicode_sequence (const char * string);
  *   the state of both shift keys.
  */
 
+// === key_functions__type_byte_hex() ===
+/**                          functions/key_functions__type_byte_hex/description
+ * Send the characters (2 of `[0-9A-F]`) corresponding to `byte` in base 16
+ *
+ * Arguments:
+ * - `byte`: The byte to send a representation of
+ */
+
 // === key_functions__send_unicode_sequence() ===
 /**                  functions/key_functions__send_unicode_sequence/description
  * Send the "unicode sequence" for each character in `string`
@@ -160,9 +169,9 @@ void key_functions__send_unicode_sequence (const char * string);
  *               "こんにちは世界 γειά σου κόσμε hello world ^_^" ) );
  *
  * - It's probably better to define a proper macro key than to use this
- *   function for sending sequences of characters, despite the relative
- *   inconvenience.  But... if you're not concerned about portability, or other
- *   factors that might arise because of what this function is *actually*
- *   typing... it's possible to do it this way to... :) lol
+ *   function for sending sequences of "normal" characters, despite the
+ *   relative inconvenience.  But... if you're not concerned about portability,
+ *   or other factors that might arise because of what this function is
+ *   *actually* typing... it's possible to do it this way to... :) lol
  */
 

firmware/lib/layout/key-functions/special.c

@@ -21,6 +21,7 @@
 #include <avr/pgmspace.h>
 #include "../../../../firmware/lib/usb.h"
 #include "../../../../firmware/lib/usb/usage-page/keyboard.h"
+#include "../key-functions.h"
 
 // ----------------------------------------------------------------------------
 
@@ -78,32 +79,9 @@ static void _set_modifier_state(struct _modifier_state_t state) {
     usb__kb__send_report();
 }
 
-/**                                       functions/_send_hex_digit/description
- * Press then release the keycode corresponding to the character (0-9 A-F)
- * representing the low 4 bits of `digit` in base 16
- *
- * Warnings:
- * - Drops the high bit, but *does not do bounds checking on the value*
- *
- * Arguments:
- * - `digit`: A `uint8_t` who's low 4 bits represents the character to send
- */
-static void _send_hex_digit(uint8_t digit) {
-    digit &= 0x0F;
-
-    if      (digit == 0) digit  = KEYBOARD__0_RightParenthesis;
-    else if (digit < 10) digit += KEYBOARD__1_Exclamation-1;
-    else                 digit += KEYBOARD__a_A-10;
-
-    usb__kb__set_key(true, digit);
-    usb__kb__send_report();
-    usb__kb__set_key(false, digit);
-    usb__kb__send_report();
-}
-
 // ----------------------------------------------------------------------------
 
-void key_functions__toggle_capslock (uint16_t ignore) {
+void key_functions__toggle_capslock(uint16_t ignore) {
     struct _modifier_state_t state = _read_modifier_state();
     // -------
     struct _modifier_state_t temp_state = state;
@@ -121,6 +99,22 @@ void key_functions__toggle_capslock (uint16_t ignore) {
     _set_modifier_state(state);
 }
 
+void key_functions__type_byte_hex(uint8_t byte) {
+    uint8_t c[2] = { byte >> 4, byte & 0xF };
+
+    for (uint8_t i=0; i<2; i++) {
+        if      (c[i] == 0) c[i]  = KEYBOARD__0_RightParenthesis;
+        else if (c[i] < 10) c[i] += KEYBOARD__1_Exclamation-1;
+        else                c[i] += KEYBOARD__a_A-10;
+
+        usb__kb__set_key(true, c[i]);
+        usb__kb__send_report();
+        usb__kb__set_key(false, c[i]);
+    }
+
+    usb__kb__send_report();
+}
+
 /**                  functions/key_functions__send_unicode_sequence/description
  * Implementation notes:
  *
@@ -144,7 +138,7 @@ void key_functions__toggle_capslock (uint16_t ignore) {
  *      0x010000 - 0x10FFFF      21   11110xxx  10xxxxxx  10xxxxxx  10xxxxxx
  *     ----------------------------------------------------------------------
  */
-void key_functions__send_unicode_sequence (const char * string) {
+void key_functions__send_unicode_sequence(const char * string) {
     struct _modifier_state_t state = _read_modifier_state();
     _set_modifier_state( (struct _modifier_state_t){} );
 
@@ -191,10 +185,8 @@ void key_functions__send_unicode_sequence (const char * string) {
         usb__kb__set_key(false, KEYBOARD__Equal_Plus); usb__kb__send_report();
 
         // send character
-        _send_hex_digit( (c_full >> 12)       );
-        _send_hex_digit( (c_full >>  8) & 0xF );
-        _send_hex_digit( (c_full >>  4) & 0xF );
-        _send_hex_digit( (c_full      ) & 0xF );
+        key_functions__type_byte_hex( c_full >> 8 );
+        key_functions__type_byte_hex( c_full & 0xFF );
 
         // send end sequence
         usb__kb__set_key(false, KEYBOARD__LeftAlt); usb__kb__send_report();