Merge pull request #115 from pycom/pybytes_config_block

Pybytes config block

Author: peter-pycom

esp32/pycom_config.h

@@ -11,7 +11,16 @@
 #define PYCOM_CONFIG_H_
 
 #include "py/mpconfig.h"
+#include <assert.h>
 
+/**
+ * pycom_config_block_t is written and read directly to the config partition
+ * (see ./esp32/lib/partitions_xMB.csv)
+ * When adding attributes to this config block, be sure to only add them *after*
+ * all existing attributes.
+ *
+ * the _Static_assert()'s below enforce that the memory layout doesn't change
+ */
 
 /******************************************************************************
  DEFINE CONSTANTS
@@ -29,6 +38,7 @@ typedef struct {
     uint8_t sigfox_public_key[16];
     uint8_t lora_region;
 } pycom_lpwan_config_t;
+_Static_assert(sizeof(pycom_lpwan_config_t) == 53, "pycom_lpwan_config_t should have a size of 53 bytes");
 
 typedef struct {
     uint8_t wifi_on_boot :1;
@@ -37,23 +47,27 @@ typedef struct {
     uint8_t wifi_auth :3;
     uint8_t wifi_antenna :1;
 } pycom_wifi_config_t;
+_Static_assert(sizeof(pycom_wifi_config_t) == 1, "pycom_wifi_config_t should have a size of 1 bytes");
 
 typedef struct {
     uint8_t wifi_ssid[33];
     uint8_t wifi_pwd[65];
 } pycom_wifi_sta_config_t;
+_Static_assert(sizeof(pycom_wifi_sta_config_t) == 98, "pycom_wifi_sta_config_t should have a size of 98 bytes");
 
 typedef struct {
     uint8_t wifi_ssid[33];
     uint8_t wifi_pwd[65];
 } pycom_wifi_ap_config_t;
+_Static_assert(sizeof(pycom_wifi_ap_config_t) == 98, "pycom_wifi_ap_config_t should have a size of 98 bytes");
 
 typedef struct {
     uint8_t heartbeat_on_boot :1;
     uint8_t rgb_error_color[3];
     uint8_t rgb_safeboot_color[3];
     uint8_t rgb_heartbeat_color[3];
 } pycom_rgbled_config_t;
+_Static_assert(sizeof(pycom_rgbled_config_t) == 10, "pycom_rgbled_config_t should have a size of 10 bytes");
 
 typedef struct {
     uint8_t device_token[40];
@@ -65,22 +79,26 @@ typedef struct {
     uint8_t auto_start;
     uint8_t reserved[11];
 } pycom_pybytes_config_t;
+_Static_assert(sizeof(pycom_pybytes_config_t) == 348, "pycom_pybytes_config_t should have a size of 348 bytes");
 
 typedef struct {
     uint8_t sw_version[12];
     uint8_t boot_fs_type;
     uint8_t boot_partition;
     uint8_t hw_type;
 } pycom_config_t;
+_Static_assert(sizeof(pycom_config_t) == 15, "pycom_config_t should have a size of 15 bytes");
 
 typedef struct {
-    uint8_t wdt_on_boot;
+    uint8_t wdt_on_boot; // 1byte + 3bytes padding
     uint32_t wdt_on_boot_timeout;
 } pycom_wdt_config_t;
+_Static_assert(sizeof(pycom_wdt_config_t) == 8, "pycom_wdt_config_t should have a size of 8 bytes");
 
 typedef struct {
     uint8_t lte_modem_en_on_boot;
 } pycom_lte_config_t;
+_Static_assert(sizeof(pycom_lte_config_t) == 1, "pycom_lte_config_t should have a size of 1 bytes");
 
 typedef struct {
     uint8_t carrier[129];
@@ -90,20 +108,23 @@ typedef struct {
     uint8_t band;
     uint8_t reset;
 } pycom_pybytes_lte_config_t;
-
-typedef struct {
-    pycom_lpwan_config_t lpwan_config;
-    pycom_wifi_config_t wifi_config;
-    pycom_wifi_sta_config_t wifi_sta_config;
-    pycom_rgbled_config_t rgbled_config;
-    pycom_pybytes_config_t pybytes_config;
-    pycom_wdt_config_t wdt_config;
-    pycom_lte_config_t lte_config;
-    pycom_config_t pycom_config;
-    pycom_wifi_ap_config_t wifi_ap_config;
-    pycom_pybytes_lte_config_t pycom_pybytes_lte_config;
-    uint8_t pycom_reserved[112];
-} pycom_config_block_t;
+// pycom_pybytes_lte_config_t is the last used member of pycom_config_block_t, so no _Static_assert(sizeof()) needed
+
+typedef struct {                                         // size
+    pycom_lpwan_config_t lpwan_config;                   //   53
+    pycom_wifi_config_t wifi_config;                     //    1
+    pycom_wifi_sta_config_t wifi_sta_config;             //   98
+    pycom_rgbled_config_t rgbled_config;                 //   10
+    pycom_pybytes_config_t pybytes_config;               //  348
+    uint8_t pycom_unused[2];                             //    2 since wdt_config has 4byte-alignment, there are currently two bytes of padding before it
+    pycom_wdt_config_t wdt_config;                       //    8 since wdt_config contains a uint32_t, it has 4byte-alignment
+    pycom_lte_config_t lte_config;                       //    1
+    pycom_config_t pycom_config;                         //   15
+    pycom_wifi_ap_config_t wifi_ap_config;               //   98
+    pycom_pybytes_lte_config_t pycom_pybytes_lte_config; //  278
+    uint8_t pycom_reserved[112];                         //  112
+} pycom_config_block_t;                                  // 1024
+_Static_assert(sizeof(pycom_config_block_t) == 1024, "pycom_config_block_t should have a size of 1024 bytes"); // partition is 4Kb, I think multiples of 1Kb <= 4Kb are ok
 
 typedef enum
 {