Merge pull request #224 from nomis52/id

Handle multiple microchip OIDs.

Author: nomis52

README.md

@@ -65,6 +65,17 @@ make
 make check
 ```
 
+## PLASA Identifiers & UIDs
+
+The code by default uses the Open Lighting PLASA ID (0x7a70). This range is
+owned by the Open Lighting Project and at this time we do not sub-license
+ranges to anyone else. You *may not* ship product with the Open Lighting
+PLASA ID.
+
+Per https://wiki.openlighting.org/index.php/Open_Lighting_Allocations the
+UIDs 7a70:fffffe00 to 7a70:fffffefe may be used for development (in house)
+purposes.
+
 ## Dev Notes
 
 A bulk-in transfer with a full 512 bytes of DMX data takes < 1ms on my mac

boardcfg/ethernet_sk2/bootloader_settings.h

@@ -22,7 +22,6 @@
 
 #include "bootloader.h"
 #include "common_settings.h"
-#include "config_options.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -74,12 +73,6 @@ extern "C" {
  */
 #define SWITCH_ACTIVE_HIGH false
 
-/**
- * @brief The hardware model.
- * @sa JaRuleModel
- */
-#define HARDWARE_MODEL MODEL_ETHERNET_SK2
-
 /**
  * @brief The LEDS to flash in bootloader mode.
  */

boardcfg/ethernet_sk2/common_settings.h

@@ -66,6 +66,12 @@ extern "C" {
  */
 #define CFG_UID_SOURCE CFG_OPT_UID_FROM_MAC
 
+/**
+ * @brief The hardware model.
+ * @sa JaRuleModel
+ */
+#define HARDWARE_MODEL MODEL_ETHERNET_SK2
+
 /**
  * @}
  *

boardcfg/number1/bootloader_settings.h

@@ -22,7 +22,6 @@
 
 #include "bootloader.h"
 #include "common_settings.h"
-#include "config_options.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -74,12 +73,6 @@ extern "C" {
  */
 #define SWITCH_ACTIVE_HIGH false
 
-/**
- * @brief The hardware model.
- * @sa JaRuleModel
- */
-#define HARDWARE_MODEL MODEL_NUMBER1
-
 /**
  * @brief The LEDS to flash in bootloader mode.
  */

boardcfg/number1/common_settings.h

@@ -66,6 +66,12 @@ extern "C" {
  */
 #define CFG_UID_SOURCE CFG_OPT_UID_FROM_MAC
 
+/**
+ * @brief The hardware model.
+ * @sa JaRuleModel
+ */
+#define HARDWARE_MODEL MODEL_NUMBER1
+
 /**
  * @}
  *

boardcfg/number8/bootloader_settings.h

@@ -22,7 +22,6 @@
 
 #include "bootloader.h"
 #include "common_settings.h"
-#include "config_options.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -74,12 +73,6 @@ extern "C" {
  */
 #define SWITCH_ACTIVE_HIGH false
 
-/**
- * @brief The hardware model.
- * @sa JaRuleModel
- */
-#define HARDWARE_MODEL MODEL_NUMBER8
-
 /**
  * @brief The LEDS to flash in bootloader mode.
  */

boardcfg/number8/common_settings.h

@@ -66,6 +66,12 @@ extern "C" {
  */
 #define CFG_UID_SOURCE CFG_OPT_UID_FROM_MAC
 
+/**
+ * @brief The hardware model.
+ * @sa JaRuleModel
+ */
+#define HARDWARE_MODEL MODEL_NUMBER8
+
 /**
  * @}
  *

boardcfg/template/bootloader_settings.h

@@ -74,12 +74,6 @@ extern "C" {
  */
 #define SWITCH_ACTIVE_HIGH false
 
-/**
- * @brief The hardware model.
- * @sa JaRuleModel
- */
-#define HARDWARE_MODEL MODEL_UNDEFINED
-
 /**
  * @brief The LEDS to flash in bootloader mode.
  */

boardcfg/template/common_settings.h

@@ -66,6 +66,12 @@ extern "C" {
  */
 #define CFG_UID_SOURCE CFG_OPT_UID_FROM_MAC
 
+/**
+ * @brief The hardware model.
+ * @sa JaRuleModel
+ */
+#define HARDWARE_MODEL MODEL_UNDEFINED
+
 /**
  * @}
  *

common/uid_store.c

@@ -31,6 +31,8 @@
 #include "peripheral/eth/plib_eth.h"
 
 static uint8_t kUIDArray[UID_LENGTH];
+static const uint32_t MICROCHIP_OID1 = 0x00001ec0;
+static const uint32_t MICROCHIP_OID2 = 0x00d88039;
 
 inline uint8_t ShiftRight(uint8_t b) {
   return (b >> 4) & 0x0f;
@@ -42,23 +44,49 @@ inline uint8_t ShiftLeft(uint8_t b) {
 
 void UIDStore_Init() {
   // The UID is derived from the RDM manufacturer ID & the MAC address.
-  // The first 3 bytes of the MAC address is the Microchip OID 00:1e:c0 which
-  // is constant. The bottom 3 bytes contain the unique serial number.
+  // The first 3 bytes of the MAC address is the Microchip OIDs, which are one
+  // of 00:1E:C0, 00:04:A3 or D8:80:39. The bottom 3 bytes contain the unique
+  // serial number.
   //
   // To support more than one responder per device, we set the lower 4 bits of
   // the UID to 0 so we have 16 responders per device. These means the complete
   // UID takes the form:
-  //   MMMM:1AAAAAA0
-  // Where M is the PLASA manufacturer ID and A are the values from the MAC
-  // address.
-  kUIDArray[0] = CFG_MANUFACTURER_ID >> 8;
-  kUIDArray[1] = CFG_MANUFACTURER_ID & 0xff;
-  kUIDArray[2] = 0x10 + ShiftRight(PLIB_ETH_StationAddressGet(ETH_ID_0, 4));
-  kUIDArray[3] = ShiftLeft(PLIB_ETH_StationAddressGet(ETH_ID_0, 4)) +
-                 ShiftRight(PLIB_ETH_StationAddressGet(ETH_ID_0, 5));
-  kUIDArray[4] = ShiftLeft(PLIB_ETH_StationAddressGet(ETH_ID_0, 5)) +
-                 ShiftRight(PLIB_ETH_StationAddressGet(ETH_ID_0, 6));
-  kUIDArray[5] = ShiftLeft(PLIB_ETH_StationAddressGet(ETH_ID_0, 6));
+  //   MMMM:XAAAAAA0
+  // Where M is the PLASA manufacturer ID, X is derived from the OID and A is
+  // the values from the MAC address. X is derived from the OID as follows:
+  //
+  //   00:1E:C0 -> 1
+  //   D8:80:39 -> 2
+  uint32_t oid = (PLIB_ETH_StationAddressGet(ETH_ID_0, 1) << 16) +
+                 (PLIB_ETH_StationAddressGet(ETH_ID_0, 2) << 8) +
+                 PLIB_ETH_StationAddressGet(ETH_ID_0, 3);
+  uint8_t upper_id = 0;
+  if (oid == MICROCHIP_OID1) {
+    upper_id = 0x10;
+  } else if (oid == MICROCHIP_OID2) {
+    upper_id = 0x20;
+  }
+
+  if (upper_id) {
+    kUIDArray[0] = CFG_MANUFACTURER_ID >> 8;
+    kUIDArray[1] = CFG_MANUFACTURER_ID & 0xff;
+    kUIDArray[2] = upper_id +
+                   ShiftRight(PLIB_ETH_StationAddressGet(ETH_ID_0, 4));
+    kUIDArray[3] = ShiftLeft(PLIB_ETH_StationAddressGet(ETH_ID_0, 4)) +
+                   ShiftRight(PLIB_ETH_StationAddressGet(ETH_ID_0, 5));
+    kUIDArray[4] = ShiftLeft(PLIB_ETH_StationAddressGet(ETH_ID_0, 5)) +
+                   ShiftRight(PLIB_ETH_StationAddressGet(ETH_ID_0, 6));
+    kUIDArray[5] = ShiftLeft(PLIB_ETH_StationAddressGet(ETH_ID_0, 6));
+  } else {
+    // If we didn't match the OID, default to the NULL UID to make it obvious
+    // what happened
+    kUIDArray[0] = 0;
+    kUIDArray[1] = 0;
+    kUIDArray[2] = 0;
+    kUIDArray[3] = 0;
+    kUIDArray[4] = 0;
+    kUIDArray[5] = 0;
+  }
 }
 
 const uint8_t* const kUID = &kUIDArray[0];