Changed serial number to hex string of internal microcontroller UUID

Author: AaronPerl

inc/astrokey.h

@@ -14,13 +14,47 @@
 
 #include <SI_EFM8UB1_Defs.h>
 #include <stdint.h>
+#include <efm8_usb.h>
 
-// Astrokey USB protocol
+//////////////////////////
+// Device Serial Number //
+//////////////////////////
+
+// Converts a nibble to a hex character
+#define NIBBLE_TO_ASCII(x) ((x) >= 10? (x) - 10 + 'A' : (x) + '0')
+
+// Struct for non-const string descriptors
+#define UTF16LE_PACKED_STRING_DESC(__name, __size) \
+  SI_SEGMENT_VARIABLE(__name,  USB_StringDescriptor_TypeDef, SI_SEG_XDATA) = \
+    { USB_STRING_DESCRIPTOR_UTF16LE_PACKED, __size * 2, USB_STRING_DESCRIPTOR }
+
+// Serial number string descriptor
+extern SI_SEGMENT_VARIABLE(serDesc[], USB_StringDescriptor_TypeDef, SI_SEG_XDATA);
+
+// MCU UUID Flash Address
+#define UUID_ADDR 0xFFC0
+
+// MCU UUID Length in Bytes
+#define UUID_LEN  16
+
+// Length of serial number string (2 characters per byte)
+#define SER_STR_LEN (UUID_LEN * 2)
+
+// MCU UUID
+SI_VARIABLE_SEGMENT_POINTER(UUID, static const uint8_t, SI_SEG_CODE) = UUID_ADDR;
+
+///////////////////////////
+// Astrokey USB protocol //
+///////////////////////////
 
 // wIndex values
 #define ASTROKEY_SET_WORKFLOW 0x01
 #define ASTROKEY_GET_WORKFLOW 0x02
 
+///////////////////////
+// Device Parameters //
+///////////////////////
+
 // Switch configuration
 #define NUM_SWITCHES 5
 #define S0 P0_B0
@@ -32,10 +66,14 @@
 // Switch pressed
 #define PRESSED(x) (!x)
 
-// No macro running
+////////////////////////
+// Workflow Constants //
+////////////////////////
+
+// No workflow running
 #define NO_WORKFLOW 0xFF
 
-// Macro action types
+// Workflow action types
 #define WORKFLOW_ACTION_DOWN  1
 #define WORKFLOW_ACTION_UP    2
 #define WORKFLOW_ACTION_PRESS 3
@@ -53,7 +91,7 @@
 #define MODIFIER_LEFTALT   0x04
 #define MODIFIER_LEFTGUI   0x08
 
-// Macro action struct
+// Workflow action struct
 typedef struct {
   uint8_t actionType;
   uint8_t value;
@@ -74,15 +112,27 @@ typedef struct {
 
 #define WORKFLOW_FLASH_ADDR USER_START_ADDR
 
+////////////////////////
+// Workflow Functions //
+////////////////////////
+
 void saveWorkflow(Action_TypeDef* workflowData, uint8_t saveIndex);
 void loadWorkflow(Action_TypeDef* workflowData, uint8_t loadIndex);
 
+////////////////////////
+// Workflow Variables //
+////////////////////////
+
 extern Action_TypeDef SI_SEG_XDATA workflow[WORKFLOW_MAX_SIZE];
 extern uint8_t workflowNumActions;
 
 extern Action_TypeDef SI_SEG_XDATA tmpWorkflow[WORKFLOW_MAX_SIZE];
 extern volatile int8_t workflowUpdated;
 
+////////////////////////
+// Astrokey Functions //
+////////////////////////
+
 void astrokeyInit();
 void astrokeyPoll();
 

src/astrokey.c

@@ -44,6 +44,9 @@ uint8_t workflowIndex = NO_WORKFLOW;
 // Index of current action in current workflow running;
 uint8_t actionIndices[NUM_SWITCHES] = {0};
 
+// The UUID String descriptor
+UTF16LE_PACKED_STRING_DESC(serDesc[SER_STR_LEN + USB_STRING_DESCRIPTOR_NAME], SER_STR_LEN);
+
 // Checks if a key is currently pressed by the workflow
 // Returns the index of the key in array of keys currently pressed,
 // -1 if the key is not currently being pressed
@@ -242,6 +245,16 @@ uint8_t checkKeyReleased(uint8_t bitMask, uint8_t pressed)
 
 void astrokeyInit()
 {
+  uint8_t i;
+  // Read chip UUID and write hex string to serial string descriptor
+  for (i = 0; i < UUID_LEN; i++)
+  {
+    serDesc[USB_STRING_DESCRIPTOR_NAME + 2 * i + 0] =
+      NIBBLE_TO_ASCII((UUID[i] >> 8) & 0x0F);
+    serDesc[USB_STRING_DESCRIPTOR_NAME + 2 * i + 1] =
+      NIBBLE_TO_ASCII((UUID[i] >> 0) & 0x0F);
+  }
+  // Enter default device configuration
   enter_DefaultMode_from_RESET();
 }
 

src/descriptors.c

@@ -13,6 +13,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <efm8_usb.h>
+#include "astrokey.h"
 #include "descriptors.h"
 
 
@@ -242,17 +243,14 @@ SI_SEGMENT_VARIABLE(msDesc, const MS_OS_20_DescriptorSet_TypeDef, SI_SEG_CODE) =
 #define MFR_SIZE      9
 #define PROD_STRING   'A','s','t','r','o','K','e','y','\0'
 #define PROD_SIZE     9
-#define SER_STRING    '0','1','2','3','4','5','6','7','8','A','B','C','D','E','F','\0'
-#define SER_SIZE      16
 
 
 LANGID_STATIC_CONST_STRING_DESC( langDesc[], LANG_STRING);
 UTF16LE_PACKED_STATIC_CONST_STRING_DESC( mfrDesc[], MFR_STRING, MFR_SIZE );
 UTF16LE_PACKED_STATIC_CONST_STRING_DESC( prodDesc[], PROD_STRING, PROD_SIZE );
-UTF16LE_PACKED_STATIC_CONST_STRING_DESC( serDesc[], SER_STRING, SER_SIZE );
 
 // USB String Table
-SI_SEGMENT_VARIABLE_SEGMENT_POINTER(myUsbStringTable_USEnglish[], static const USB_StringDescriptor_TypeDef, SI_SEG_GENERIC, const SI_SEG_CODE) = 
+SI_SEGMENT_VARIABLE_SEGMENT_POINTER(myUsbStringTable_USEnglish[], static const USB_StringDescriptor_TypeDef, SI_SEG_GENERIC, const SI_SEG_CODE) =
 {
   (SI_VARIABLE_SEGMENT_POINTER(, uint8_t, SI_SEG_CODE))langDesc,
   mfrDesc,