ketCube_cfg.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __KETCUBE_CFG_H
#define __KETCUBE_CFG_H
 
#include "ketCube_common.h"
#ifndef DESKTOP_BUILD
#include "ketCube_eeprom.h"
#endif
#include "ketCube_compilation.h"
#include "ketCube_module_id.h"
 
typedef enum {
    KETCUBE_EEPROM_ALLOC_CORE    = 0,    
    KETCUBE_EEPROM_ALLOC_MODULES = 0,    
    KETCUBE_EEPROM_ALLOC_LAST    = 2048, 
} ketCube_cfg_AllocEEPROM_t;
 
typedef enum {
    KETCUBE_EEPROM_LEN_CORE    = 64,    
    KETCUBE_EEPROM_LEN_MODULES = 1024,  
} ketCube_cfg_LenEEPROM_t;
 
typedef enum {
    KETCUBE_CFG_OK = 0,         
    KETCUBE_CFG_ERROR = 1,      
    ketCube_cfg_Load_ERROR = 2, 
    ketCube_cfg_Save_ERROR = 3, 
    KETCUBE_CFG_BUFF_SMALL = 4, 
    KETCUBE_CFG_INV_HEX = 5     
} ketCube_cfg_Error_t;
 
typedef enum {
    KETCUBE_CFG_MODULE_OK = (uint8_t) 0,
    KETCUBE_CFG_MODULE_ERROR = !(KETCUBE_CFG_MODULE_OK)
} ketCube_cfg_ModError_t;
 
typedef enum {
    KETCUBE_CFG_DRV_OK = (uint8_t) 0,
    KETCUBE_CFG_DRV_ERROR = !(KETCUBE_CFG_MODULE_OK)
} ketCube_cfg_DrvError_t;
 
typedef struct ketCube_InterModMsg_t {
    uint8_t modID;              
    uint8_t msgLen;             
    uint8_t *msg;               
} ketCube_InterModMsg_t;
 
typedef enum ketCube_severity_t {
    KETCUBE_CFG_SEVERITY_NONE  = 0x0,
    KETCUBE_CFG_SEVERITY_ERROR = 0x1,
    KETCUBE_CFG_SEVERITY_INFO  = 0x2,
    KETCUBE_CFG_SEVERITY_DEBUG = 0x3
} ketCube_severity_t;
 
extern const char * ketCube_severity_strAlias[4];
 
typedef ketCube_cfg_ModError_t(*ketCube_cfg_ModVoidFn_t) (void);
typedef
ketCube_cfg_ModError_t(*ketCube_cfg_ModInitFn_t) (ketCube_InterModMsg_t ***
                                                  msg);
typedef ketCube_cfg_ModError_t(*ketCube_cfg_ModDataFn_t) (uint8_t * buffer, uint8_t * len);     //< Pointer to a function processing data of spec. length 
typedef ketCube_cfg_ModError_t(*ketCube_cfg_ModDataPtrFn_t) (ketCube_InterModMsg_t * msg);      //< Pointer to a function processing data of spec. length 
 
typedef struct ketCube_cfg_ModuleCfgByte_t {
    bool enable:1;                      
    ketCube_severity_t severity:2;      
    uint8_t RFU:5;                      
} ketCube_cfg_ModuleCfgByte_t;
 
typedef struct ketCube_cfg_varDescr_t {
    uint16_t moduleID;     
    uint8_t offset;        
    uint8_t size;          
} ketCube_cfg_varDescr_t;
 
typedef struct ketCube_cfg_Module_t {
    char *name;                 
    char *descr;                
    ketCube_moduleID_t id;      
    ketCube_cfg_ModInitFn_t fnInit;             
    ketCube_cfg_ModVoidFn_t fnSleepEnter;       
    ketCube_cfg_ModVoidFn_t fnSleepExit;        
    ketCube_cfg_ModDataFn_t fnGetSensorData;    
    ketCube_cfg_ModDataFn_t fnSendData;         
    ketCube_cfg_ModVoidFn_t fnReceiveData;      
    ketCube_cfg_ModDataPtrFn_t fnProcessMsg;    
    ketCube_cfg_ModuleCfgByte_t * cfgPtr;       
    ketCube_cfg_LenEEPROM_t cfgLen;             
    ketCube_cfg_AllocEEPROM_t EEpromBase;       
} ketCube_cfg_Module_t;
 
/* Indicate pending events */
extern volatile bool KETCube_eventsProcessed;
 
extern ketCube_cfg_Error_t ketCube_cfg_Load(uint8_t * data,
                                            ketCube_cfg_moduleIDs_t id,
                                            ketCube_cfg_AllocEEPROM_t addr,
                                            ketCube_cfg_LenEEPROM_t len);
extern ketCube_cfg_Error_t ketCube_cfg_LoadStr(char *data, uint8_t buffLen,
                                               ketCube_cfg_moduleIDs_t id,
                                               ketCube_cfg_AllocEEPROM_t
                                               addr,
                                               ketCube_cfg_LenEEPROM_t
                                               len);
extern ketCube_cfg_Error_t ketCube_cfg_Save(uint8_t * data,
                                            ketCube_cfg_moduleIDs_t id,
                                            ketCube_cfg_AllocEEPROM_t addr,
                                            ketCube_cfg_LenEEPROM_t len);
extern ketCube_cfg_Error_t ketCube_cfg_SaveStr(char *data,
                                               ketCube_cfg_moduleIDs_t id,
                                               ketCube_cfg_AllocEEPROM_t
                                               addr,
                                               ketCube_cfg_LenEEPROM_t
                                               len);
 
extern ketCube_cfg_Error_t ketCube_cfg_SetDefaults(ketCube_cfg_moduleIDs_t id,
                                                   ketCube_cfg_AllocEEPROM_t addr,
                                                   ketCube_cfg_LenEEPROM_t len);
 
#endif                          /* __KETCUBE_CFG_H */