flash.h

Go to the documentation of this file.

#ifndef _FLASH_H_
#define _FLASH_H_

#include <stdint.h>

/*
 * 2 logical sections: one private for the usecase/application (will be erased if a different application is flashed)
 *                     one common for the system (will be kept/migrated if a different application is flashed)
 */
enum nv_section {
    NV_SECTION_PRIVATE,
    NV_SECTION_COMMON,
};

/*
 * Definition of the common section structure
 * A field has a minimum size of 1 block = sizeof(uint32_t) bytes
 * Each time the structure is extended, NV_COMMON_SECTION_LENGTH must be updated
 */
#define NV_COMMON_MAGIC                     0x442A6B6E

#define NV_COMMON_MAGIC_OFFSET                  0
#define NV_COMMON_MAGIC_SIZE                    1 /* in blocks */
#define NV_COMMON_SECTION_LENGTH_OFFSET             (NV_COMMON_MAGIC_OFFSET + NV_COMMON_MAGIC_SIZE * sizeof(uint32_t))
#define NV_COMMON_SECTION_LENGTH_SIZE               1 /* in blocks */
#define NV_COMMON_FIRST_FIELD_OFFSET                (NV_COMMON_SECTION_LENGTH_OFFSET + NV_COMMON_SECTION_LENGTH_SIZE * sizeof(uint32_t))

/* The list of available fields starts here (the offsets must be multiples of sizeof(uint32_t)) */
#define NV_COMMON_PICOWAN_DEVICE_ADDRESS_OFFSET         NV_COMMON_FIRST_FIELD_OFFSET
#define NV_COMMON_PICOWAN_DEVICE_ADDRESS_SIZE           1 /* in blocks */
#define NV_COMMON_PICOWAN_NETWORK_SESSION_KEY_OFFSET        (NV_COMMON_PICOWAN_DEVICE_ADDRESS_OFFSET + NV_COMMON_PICOWAN_DEVICE_ADDRESS_SIZE * sizeof(uint32_t))
#define NV_COMMON_PICOWAN_NETWORK_SESSION_KEY_SIZE      4 /* in blocks */
#define NV_COMMON_PICOWAN_APPLICATION_SESSION_KEY_OFFSET    (NV_COMMON_PICOWAN_NETWORK_SESSION_KEY_OFFSET + NV_COMMON_PICOWAN_NETWORK_SESSION_KEY_SIZE * sizeof(uint32_t))
#define NV_COMMON_PICOWAN_APPLICATION_SESSION_KEY_SIZE      4 /* in blocks */
#define NV_COMMON_DEVICE_EUI_OFFSET             (NV_COMMON_PICOWAN_APPLICATION_SESSION_KEY_OFFSET + NV_COMMON_PICOWAN_APPLICATION_SESSION_KEY_SIZE * sizeof(uint32_t))
#define NV_COMMON_DEVICE_EUI_SIZE               2 /* in blocks */
#define NV_COMMON_APPLICATION_EUI_OFFSET            (NV_COMMON_DEVICE_EUI_OFFSET + NV_COMMON_DEVICE_EUI_SIZE * sizeof(uint32_t))
#define NV_COMMON_APPLICATION_EUI_SIZE              2 /* in blocks */
#define NV_COMMON_APPLICATION_KEY_OFFSET            (NV_COMMON_APPLICATION_EUI_OFFSET + NV_COMMON_APPLICATION_EUI_SIZE * sizeof(uint32_t))
#define NV_COMMON_APPLICATION_KEY_SIZE              4 /* in blocks */
#define NV_COMMON_LORA_DEVICE_ADDRESS_OFFSET            (NV_COMMON_APPLICATION_KEY_OFFSET + NV_COMMON_APPLICATION_KEY_SIZE * sizeof(uint32_t))
#define NV_COMMON_LORA_DEVICE_ADDRESS_SIZE          1 /* in blocks */
#define NV_COMMON_LORA_NETWORK_SESSION_KEY_OFFSET       (NV_COMMON_LORA_DEVICE_ADDRESS_OFFSET + NV_COMMON_LORA_DEVICE_ADDRESS_SIZE * sizeof(uint32_t))
#define NV_COMMON_LORA_NETWORK_SESSION_KEY_SIZE         4 /* in blocks */
#define NV_COMMON_LORA_APPLICATION_SESSION_KEY_OFFSET       (NV_COMMON_LORA_NETWORK_SESSION_KEY_OFFSET + NV_COMMON_LORA_NETWORK_SESSION_KEY_SIZE * sizeof(uint32_t))
#define NV_COMMON_LORA_APPLICATION_SESSION_KEY_SIZE     4 /* in blocks */
#define NV_COMMON_LORA_UPLINK_COUNTER_OFFSET            (NV_COMMON_LORA_APPLICATION_SESSION_KEY_OFFSET + NV_COMMON_LORA_APPLICATION_SESSION_KEY_SIZE * sizeof(uint32_t))
#define NV_COMMON_LORA_UPLINK_COUNTER_SIZE          1 /* in blocks */
#define NV_COMMON_LORA_DOWNLINK_COUNTER_OFFSET          (NV_COMMON_LORA_UPLINK_COUNTER_OFFSET + NV_COMMON_LORA_UPLINK_COUNTER_SIZE * sizeof(uint32_t))
#define NV_COMMON_LORA_DOWNLINK_COUNTER_SIZE            1 /* in blocks */

/* Size of the section in blocks, starting from FIRST_FIELD */
#define NV_COMMON_SECTION_LENGTH                NV_COMMON_PICOWAN_DEVICE_ADDRESS_SIZE + \
                                NV_COMMON_PICOWAN_NETWORK_SESSION_KEY_SIZE + \
                                NV_COMMON_PICOWAN_APPLICATION_SESSION_KEY_SIZE + \
                                NV_COMMON_DEVICE_EUI_SIZE + \
                                NV_COMMON_APPLICATION_EUI_SIZE + \
                                NV_COMMON_APPLICATION_KEY_SIZE + \
                                NV_COMMON_LORA_DEVICE_ADDRESS_SIZE + \
                                NV_COMMON_LORA_NETWORK_SESSION_KEY_SIZE + \
                                NV_COMMON_LORA_APPLICATION_SESSION_KEY_SIZE + \
                                NV_COMMON_LORA_UPLINK_COUNTER_SIZE + \
                                NV_COMMON_LORA_DOWNLINK_COUNTER_SIZE

/*
 * Definition of the private section structure
 * A field has a minimum size of 1 block = sizeof(uint32_t) bytes
 * Each time the structure is extended, NV_PRIVATE_SECTION_LENGTH must be updated
 */

#define NV_PRIVATE_MAGIC_OFFSET                 0
#define NV_PRIVATE_MAGIC_SIZE                   1 /* in blocks */
#define NV_PRIVATE_SECTION_LENGTH_OFFSET            (NV_PRIVATE_MAGIC_OFFSET + NV_PRIVATE_MAGIC_SIZE * sizeof(uint32_t))
#define NV_PRIVATE_SECTION_LENGTH_SIZE              1 /* in blocks */
#define NV_PRIVATE_FIRST_FIELD_OFFSET               (NV_PRIVATE_SECTION_LENGTH_OFFSET + NV_PRIVATE_SECTION_LENGTH_SIZE * sizeof(uint32_t))


int8_t flash_data_nvread(enum nv_section section, uint32_t offset, uint32_t *data, uint32_t length);

int8_t flash_data_nvwrite(enum nv_section section, uint32_t offset, uint32_t *data, uint32_t length);

void flash_data_nvcheck(uint32_t private_magic, uint32_t private_size);

#endif