Support factory provisioning of product revision

-- Modified the ConfigurationManager to support storing the product revision value in
persistent storage.  This makes it possible for a factory provisioning process to set a
device’s product revision without installing new firmware.

The compile-time product revision value is now used as a default in the cases where no value
is stored in flash.

Author: Jay Logue

build/esp32/components/openweave/Kconfig

@@ -416,15 +416,20 @@ menu "OpenWeave Device Layer"
                 The device product id (in hex).  This is a unique id assigned by the device vendor to identify the product or device type.
                 Defaults to a Nest-assigned id designating a non-production or test "product".
 
-        config DEVICE_PRODUCT_REVISION
-            int "Device Product Revision"
+        config DEFAULT_DEVICE_PRODUCT_REVISION
+            int "Default Device Product Revision"
             range 0 65535
             default 1
             help
-                The device product revision.  This number is assigned to device or product by the device vendor.  The number is
-                scoped to the device product id, and typically corresponds to a revision of the physical device, a change to its
-                packaging, and/or a change to its marketing presentation.  This value is generally *not* incremented for device
-                software revisions.
+                The default device product revision.  
+                
+                Product revisions are specific to a particular device vendor and product id, and typically
+                correspond to a revision of the physical device, a change to its packaging, and/or a change
+                to its marketing presentation. This value is generally *not* incremented for device software
+                revisions.
+
+                This is a default value which is used when a product revision has not been stored in device
+                persistent storage (e.g. by a factory provisioning process). 
 
         config DEVICE_FIRMWARE_REVISION
             string "Device Firmware Revision"

src/adaptations/device-layer/ESP32/ESP32Config.cpp

@@ -32,6 +32,8 @@ namespace Weave {
 namespace DeviceLayer {
 namespace Internal {
 
+// *** CAUTION ***: Changing the names or namespaces of these values will *break* existing devices.
+
 // NVS namespaces used to store device configuration information.
 const char ESP32Config::kConfigNamespace_WeaveFactory[]                    = "weave-factory";
 const char ESP32Config::kConfigNamespace_WeaveConfig[]                     = "weave-config";
@@ -42,6 +44,7 @@ const ESP32Config::Key ESP32Config::kConfigKey_SerialNum               = { kConf
 const ESP32Config::Key ESP32Config::kConfigKey_DeviceId                = { kConfigNamespace_WeaveFactory, "device-id"          };
 const ESP32Config::Key ESP32Config::kConfigKey_DeviceCert              = { kConfigNamespace_WeaveFactory, "device-cert"        };
 const ESP32Config::Key ESP32Config::kConfigKey_DevicePrivateKey        = { kConfigNamespace_WeaveFactory, "device-key"         };
+const ESP32Config::Key ESP32Config::kConfigKey_ProductRevision         = { kConfigNamespace_WeaveFactory, "product-rev"        };
 const ESP32Config::Key ESP32Config::kConfigKey_ManufacturingDate       = { kConfigNamespace_WeaveFactory, "mfg-date"           };
 const ESP32Config::Key ESP32Config::kConfigKey_PairingCode             = { kConfigNamespace_WeaveFactory, "pairing-code"       };
 

src/adaptations/device-layer/include/Weave/DeviceLayer/ConfigurationManager.h

@@ -89,6 +89,7 @@ class ConfigurationManager
     WEAVE_ERROR StorePrimaryWiFiMACAddress(const uint8_t * buf);
     WEAVE_ERROR StorePrimary802154MACAddress(const uint8_t * buf);
     WEAVE_ERROR StoreManufacturingDate(const char * mfgDate);
+    WEAVE_ERROR StoreProductRevision(uint16_t productRev);
     WEAVE_ERROR StoreFabricId(uint64_t fabricId);
     WEAVE_ERROR StoreDeviceCertificate(const uint8_t * cert, size_t certLen);
     WEAVE_ERROR StoreDevicePrivateKey(const uint8_t * key, size_t keyLen);
@@ -300,6 +301,11 @@ inline WEAVE_ERROR ConfigurationManager::StoreManufacturingDate(const char * mfg
     return static_cast<ImplClass*>(this)->_StoreManufacturingDate(mfgDate);
 }
 
+inline WEAVE_ERROR ConfigurationManager::StoreProductRevision(uint16_t productRev)
+{
+    return static_cast<ImplClass*>(this)->_StoreProductRevision(productRev);
+}
+
 inline WEAVE_ERROR ConfigurationManager::StoreFabricId(uint64_t fabricId)
 {
     return static_cast<ImplClass*>(this)->_StoreFabricId(fabricId);

src/adaptations/device-layer/include/Weave/DeviceLayer/ESP32/ESP32Config.h

@@ -56,6 +56,7 @@ class ESP32Config
     static const Key kConfigKey_DeviceId;
     static const Key kConfigKey_DeviceCert;
     static const Key kConfigKey_DevicePrivateKey;
+    static const Key kConfigKey_ProductRevision;
     static const Key kConfigKey_ManufacturingDate;
     static const Key kConfigKey_PairingCode;
     static const Key kConfigKey_FabricId;

src/adaptations/device-layer/include/Weave/DeviceLayer/ESP32/WeaveDevicePlatformConfig.h

@@ -39,7 +39,7 @@
 #define WEAVE_DEVICE_CONFIG_SERVICE_DIRECTORY_CACHE_SIZE CONFIG_SERVICE_DIRECTORY_CACHE_SIZE
 #define WEAVE_DEVICE_CONFIG_DEVICE_VENDOR_ID CONFIG_DEVICE_VENDOR_ID
 #define WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_ID CONFIG_DEVICE_PRODUCT_ID
-#define WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION CONFIG_DEVICE_PRODUCT_REVISION
+#define WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION
 #define WEAVE_DEVICE_CONFIG_DEVICE_FIRMWARE_REVISION CONFIG_DEVICE_FIRMWARE_REVISION
 #define WEAVE_DEVICE_CONFIG_WIFI_STATION_RECONNECT_INTERVAL CONFIG_WIFI_STATION_RECONNECT_INTERVAL
 #define WEAVE_DEVICE_CONFIG_MAX_SCAN_NETWORKS_RESULTS CONFIG_MAX_SCAN_NETWORKS_RESULTS

src/adaptations/device-layer/include/Weave/DeviceLayer/WeaveDeviceConfig.h

@@ -127,15 +127,20 @@
 #endif
 
 /**
- * WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION
+ * WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION
  *
- * The product revision number assigned to device or product by the device vendor.  This
- * number is scoped to the device product id, and typically corresponds to a revision of the
- * physical device, a change to its packaging, and/or a change to its marketing presentation.
- * This value is generally *not* incremented for device software revisions.
+ * The default product revision number assigned to the device or product by the device vendor.
+ *
+ * Product revisions are specific to a particular device vendor and product id, and typically
+ * correspond to a revision of the physical device, a change to its packaging, and/or a change
+ * to its marketing presentation. This value is generally *not* incremented for device software
+ * revisions.
+ *
+ * This is a default value which is used when a product revision has not been stored in device
+ * persistent storage (e.g. by a factory provisioning process).
  */
-#ifndef WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION
-#define WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION 1
+#ifndef WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION
+#define WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION 1
 #endif
 
 /**

src/adaptations/device-layer/include/Weave/DeviceLayer/internal/GenericConfigurationManagerImpl.h

@@ -50,6 +50,7 @@ class GenericConfigurationManagerImpl
     WEAVE_ERROR _GetVendorId(uint16_t & vendorId);
     WEAVE_ERROR _GetProductId(uint16_t & productId);
     WEAVE_ERROR _GetProductRevision(uint16_t & productRev);
+    WEAVE_ERROR _StoreProductRevision(uint16_t productRev);
     WEAVE_ERROR _GetFirmwareRevision(char * buf, size_t bufSize, size_t & outLen);
     WEAVE_ERROR _GetFirmwareBuildTime(uint16_t & year, uint8_t & month, uint8_t & dayOfMonth,
             uint8_t & hour, uint8_t & minute, uint8_t & second);
@@ -125,13 +126,6 @@ inline WEAVE_ERROR GenericConfigurationManagerImpl<ImplClass>::_GetProductId(uin
     return WEAVE_NO_ERROR;
 }
 
-template<class ImplClass>
-inline WEAVE_ERROR GenericConfigurationManagerImpl<ImplClass>::_GetProductRevision(uint16_t & productRev)
-{
-    productRev = (uint16_t)WEAVE_DEVICE_CONFIG_DEVICE_PRODUCT_REVISION;
-    return WEAVE_NO_ERROR;
-}
-
 
 
 

src/adaptations/device-layer/include/Weave/DeviceLayer/internal/GenericConfigurationManagerImpl.ipp

@@ -211,6 +211,32 @@ WEAVE_ERROR GenericConfigurationManagerImpl<ImplClass>::_StorePrimary802154MACAd
     return WEAVE_ERROR_UNSUPPORTED_WEAVE_FEATURE;
 }
 
+template<class ImplClass>
+inline WEAVE_ERROR GenericConfigurationManagerImpl<ImplClass>::_GetProductRevision(uint16_t & productRev)
+{
+    WEAVE_ERROR err;
+    uint32_t val;
+
+    err = Impl()->ReadConfigValue(ImplClass::kConfigKey_ProductRevision, val);
+    if (err == WEAVE_DEVICE_ERROR_CONFIG_NOT_FOUND)
+    {
+        productRev = (uint16_t)WEAVE_DEVICE_CONFIG_DEFAULT_DEVICE_PRODUCT_REVISION;
+        err = WEAVE_NO_ERROR;
+    }
+    else
+    {
+        productRev = (uint16_t)val;
+    }
+
+    return err;
+}
+
+template<class ImplClass>
+inline WEAVE_ERROR GenericConfigurationManagerImpl<ImplClass>::_StoreProductRevision(uint16_t productRev)
+{
+    return Impl()->WriteConfigValue(ImplClass::kConfigKey_ProductRevision, (uint32_t)productRev);
+}
+
 template<class ImplClass>
 WEAVE_ERROR GenericConfigurationManagerImpl<ImplClass>::_GetManufacturingDate(uint16_t& year, uint8_t& month, uint8_t& dayOfMonth)
 {
@@ -679,7 +705,7 @@ void GenericConfigurationManagerImpl<ImplClass>::LogDeviceConfig()
     WeaveLogProgress(DeviceLayer, "  Device Id: %016" PRIX64, FabricState.LocalNodeId);
 
     {
-        char serialNum[ConfigurationManager::kMaxSerialNumberLength];
+        char serialNum[ConfigurationManager::kMaxSerialNumberLength + 1];
         size_t serialNumLen;
         err = Impl()->_GetSerialNumber(serialNum, sizeof(serialNum), serialNumLen);
         WeaveLogProgress(DeviceLayer, "  Serial Number: %s", (err == WEAVE_NO_ERROR) ? serialNum : "(not set)");
@@ -704,6 +730,29 @@ void GenericConfigurationManagerImpl<ImplClass>::LogDeviceConfig()
         WeaveLogProgress(DeviceLayer, "  Product Id: %" PRIu16 " (0x%" PRIX16 ")", productId, productId);
     }
 
+    {
+        uint16_t productRev;
+        if (Impl()->_GetProductRevision(productRev) != WEAVE_NO_ERROR)
+        {
+            productRev = 0;
+        }
+        WeaveLogProgress(DeviceLayer, "  Product Revision: %" PRIu16, productRev);
+    }
+
+    {
+        uint16_t year;
+        uint8_t month, dayOfMonth;
+        err = Impl()->_GetManufacturingDate(year, month, dayOfMonth);
+        if (err == WEAVE_NO_ERROR)
+        {
+            WeaveLogProgress(DeviceLayer, "  Manufacturing Date: %04" PRIu16 "/%02" PRIu8 "/%02" PRIu8, year, month, dayOfMonth);
+        }
+        else
+        {
+            WeaveLogProgress(DeviceLayer, "  Manufacturing Date: (not set)");
+        }
+    }
+
     if (FabricState.FabricId != kFabricIdNotSpecified)
     {
         WeaveLogProgress(DeviceLayer, "  Fabric Id: %016" PRIX64, FabricState.FabricId);

src/adaptations/device-layer/include/Weave/DeviceLayer/nRF5/nRF5Config.h

@@ -58,6 +58,8 @@ class NRF5Config
 {
 public:
 
+    // *** CAUTION ***: Changing the FDS file or record ids of these values will *break* existing devices.
+
     // Limits/definitions imposed by the Nordic SDK
     static constexpr uint16_t kFDSFileIdMin                     = 0x0000; /**< Minimum value that can be used for a FDS file id (per Nordic SDK) */
     static constexpr uint16_t kFDSFileIdMax                     = 0xBFFF; /**< Maximum value that can be used for a FDS file id (per Nordic SDK) */
@@ -90,6 +92,7 @@ class NRF5Config
     static constexpr Key kConfigKey_LastUsedEpochKeyId          = NRF5ConfigKey(kFileId_WeaveConfig,  0x000C);
     static constexpr Key kConfigKey_FailSafeArmed               = NRF5ConfigKey(kFileId_WeaveConfig,  0x000D);
     static constexpr Key kConfigKey_GroupKey                    = NRF5ConfigKey(kFileId_WeaveConfig,  0x000E);
+    static constexpr Key kConfigKey_ProductRevision             = NRF5ConfigKey(kFileId_WeaveFactory, 0x000F);
 
     // Range of FDS record keys used to store Weave persisted counter values.
     static constexpr uint16_t kPersistedCounterRecordKeyBase    = kFDSRecordKeyMin;