hal.h

/*NB_REVISION*/
 
/*NB_COPYRIGHT*/
 
#ifndef _NB_HAL_H_
#define _NB_HAL_H_
 
#include <stdint.h>
 
#if defined(NB_SSL_SUPPORTED) || defined(NB_SSH_SUPPORTED)
// SSL For Hashing Certs
#include <crypto/ssl.h>
#include <crypto/wolfssl/ssl.h>
#endif /* defined(NB_SSL_SUPPORTED) || defined(NB_SSH_SUPPORTED) */
 
enum HalStorage_t
{
    HalStore_Config = 0x01,
    HalStore_Cert = 0x02,
    HalStore_UserParams = 0x03,
    HalStore_App = 0x04,
    HalStore_FileSys = 0xFC
};
 
enum HalError_t : int
{
    HALSTORE_NO_ERROR = 0,
    HALSTORE_ERR_UNKNOWN = -1,
    HALSTORE_BADARG = -2,
    HALSTORE_TOOBIG = -3,
    HALSTORE_NOTSUPPORTED = -4,
    HALSTORE_NOTAVAILABLE = -5,
    HALSTORE_NOTREADY = -6,
};
 
 
void HardwareSetup();
 
void PostConfigHardwareInit();
 
void ForceReboot(bool fromIRQ = false) __attribute__((noreturn));
 
 
 
int HalStorage_Save(uint8_t area, void *pData, int len, int offset = 0);
 
int HalStorage_SavePartial(uint8_t area, void *pData, int len, int offset);
 
int HalStorage_Prepare(uint8_t area, int len, int offset = 0);
 
int HalStorage_Finalize(uint8_t area);
 
int HalStorage_Erase(uint8_t area, int len = -1, int offset = 0);
 
int HalStorage_GetAllocated(uint8_t area);
 
int HalStorage_GetMaxAllocation(uint8_t area);
 
int HalStorage_RemainingSpace(uint8_t area);
 
int HalStorage_WriteOffset(uint8_t area);
 
int HalStorage_AddressOffset(uint8_t area, void *pWhere);
 
void FlashErase(void *pWhere, int len);
 
void FlashProgram(void *pWhere, void *pWhat, int len);
 
void FlashProgramAppImage(void *pWhere, void *pWhat, int len);
 
void DisableCache();
 
void EnableCache();
 
uint32_t spaceleft();
 
extern void (*watchdog_service_function)(void);
 
extern uint16_t HalGetTickFraction(void);
 
#ifdef GATHER_RANDOM_USE_HW
extern bool HalHWRandRdy(void);
 
extern uint32_t HalGetHWRand32(void);
#endif
 
extern uint32_t HalTickMaxCount;
 
void StdioCheckIntc(void);
 
void SysLogCheckIntc(void);
 
#if defined(NB_SSL_SUPPORTED) || defined(NB_SSH_SUPPORTED)
 
bool HalDeviceCertValid();
 
// TODO: Should there be a HalDeviceKeyValid() ?
 
uint8_t *HalGetDeviceCert();
 
uint16_t HalGetDeviceCertLen();
 
uint8_t *HalGetDeviceKey();
 
uint16_t HalGetDeviceKeyLen();
 
 
uint16_t HalGetDeviceFormat();
 
bool HalSaveNewDeviceCert(const uint8_t *cert, uint16_t certlen, uint8_t format = SSL_FILETYPE_PEM);
 
bool HalSaveNewDeviceKey(const uint8_t *key, uint16_t keylen, uint8_t format = SSL_FILETYPE_PEM);
 
void HalEraseDeviceCertAndKey();
#endif /* defined(NB_SSL_SUPPORTED) || defined(NB_SSH_SUPPORTED) */
 
#endif /* _NB_HAL_H_ */