GmProvision.hpp

/*
 * GmProvision.h
 *
 *  Created on: Nov 29, 2017
 *      Author: rcram
 */
 
#ifndef GMPROVISION_H_
#define GMPROVISION_H_
#ifdef __cplusplus
extern "C"
{
#endif
// To allow inclusion in CPP projects add this
 
#define HW_TYPE_LEN                 4  // Hardware type � 4 bytes of information
#define SERIAL_NUMBER_LEN           16 // Serial number � write 16 bytes of information.
#define SSID_LEN                    32 //SSID (wifi name) � 32 bytes, holding a zero-terminated C string.
#define SDCARD_SPI_BUS_SPEED_LEN    32 // SDCard SPI bus speed � 32-bit unsigned integer.
#define USB_BUS_SPEED_LEN           32 //USB card bus speed � 32 bit unsigned integer
#define MACHINE_NAME_LEN            40 //Friendly machine name � 40 bytes, holding a zero-terminated C string.
#define APP_INFO_LEN                32 //- a 32-byte block of information
#define PASSWORD_LN                 64 // Wifi password.
#define SERIAL_NO_LEN               16
 
/* These error codes are larger than any EEPROM code size, so do not
 * mimic any valid EEPROM storage location.
 */
#define  GM_PROVISION_EOF     1000000
#define  GM_PROVISION_CORRUPT 1000001
#define  GM_PROVISION_OK      1000002
 
#define GM_PROVISIONING_FIRST_RECORD_OFFSET 0
 
#define GEO_PROVISION_EOF          (0x01010101)
#define GEO_PROVISION_EOF_SIZE     8
#define GEO_PROV_EOF_TYPE          (0x01010101)
 
 
 
 
#define GEO_PROVISIONING_BASE_BLOCK_OBSOLETE0 0x00 // Do not reuse these numbers, which are obsolete and
#define GEO_PROVISIONING_BASE_BLOCK_OBSOLETE1 0x01 // Obsolete, do not re-use.
#define GEO_PROVISIONING_BASE_BLOCK 0x02
#define GEO_PROVISIONING_NETWORK_BLOCK 0x03
 
// Start address is 0x0 to 0x17FC and where the sizeof(...) words would be written.
#define E2PROM_TEST_ADDRESS 0x100
 
namespace Geometrics
{
    /*******************************************************************************************
     * Geo Machine Provisioning Parameters
     *******************************************************************************************/
    typedef struct _GeoMachineProvisioning{
        uint32_t m_iRecordType;  //  Offset 0, size 4 Will be hard-coded to value GEO_PROVISIONING_BASE_BLOCK
        uint32_t m_iRecordSize;  //  Offset 4, size 4: size of the entire data structure including type and size and all below
        char     m_iMachineName [MACHINE_NAME_LEN+4]; // Offset 8, size 44
        char     m_iSSID        [SSID_LEN+4]; // Offset 52, size 36
        char     m_password[PASSWORD_LN+4];   // Ofset  88, size 68
        char     m_serialNumber [SERIAL_NO_LEN+4]; // Offset 156, size 20
        int      m_iSystemBoardType;
        int      m_iSystemInfo1;
        int      m_iSystemInfo2;
        int      m_iSystemInfo3;
    } GeoMachineProvisioning, *GeoMachinePtr; // Total record size 176
 
    typedef struct _GeoNetworkInfoProvisioning
    {
      uint32_t m_iRecordType;  //  Offset 0, size 4 Will be hard-coded to value GEO_PROVISIONING_NETWORK_BLOCK
      uint32_t m_iRecordSize;  //  Offset 4, size 4: size of the entire data structure including type and size and all below
      char     m_ipv4AddressAsString[16]; // Offset 8, size 16
      uint32_t m_reserved1;    // Offset 24, size 4
      uint32_t m_reserved2;    // Offset 28, size 4
    } GeoNetworkInfoProvisioning; // Total record size 32
 
    #define GM_BASIC_PROVISIONING_SIZE (sizeof(GeoMachineProvisioning))
 
    typedef struct _GeoProvisionEof
    {
       uint32_t m_iRecordType;  // GEO_PROVISION_EOF
       uint32_t m_iRecordSize;  // 8, the size of this record.
    } GeoProvisionEof;
 
    class GmProvisioning
    {
    public:
        /****************************************************************************************************************
         * Function Prototypes**************************************************************************************
         ****************************************************************************************************************/
        static int ClearProvisioning ();
        static int EraseProvisioning ();
 
 
        /********************************************************************************************/
        /*  Set default values into basic provisioning structure                                    */
        /********************************************************************************************/
        static int InitializeGeoMachineProvisioningParameters(GeoMachinePtr  );
 
      #if GEO_STATIC_NETWORK_PROVISIONED == GEO_TRUE
        static int InitializeNetworkProvisioning(GeoNetworkInfoProvisioning *networkParameters, const char *ipAddress );
      #endif
 
 
        // Prep EEPROM library.
        static void InitEEPROM_ConfigProvisioning(void);
 
        static int FindProvisioningRecord (uint32_t startAddress,
                                    uint32_t recordType,
                                    uint32_t recordSize);
        static int OverwriteOrAppend (uint32_t  startAddress,
                               uint32_t  recordType,
                               uint32_t  recordSize,
                               char     *source,
                               bool      bRetry);
        static int GetProvisioningRecord (uint32_t  startAddress,
                                   uint32_t  recordType,
                                   uint32_t  recordSize,
                                   char     *dest);
 
 
 
        // Write a config block.
        static int WriteProvisionParametersToEEPROM(void *ptr , uint32_t location, int size );
 
        // Read a config block.
        static int ReadProvisionParametersFromEEPROM(void *ptr , uint32_t location, int size, uint32_t type );
    };
}
 
#ifdef __cplusplus
}
#endif
#endif /* GMPROVISION_H_ */