ubloxcfg.h

Go to the documentation of this file.

/* ************************************************************************************************/ // clang-format off
#ifndef __UBLOXCFG_H__
#define __UBLOXCFG_H__
 
#include <stdint.h>
#include <stdbool.h>
 
#include "ubloxcfg_gen.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ****************************************************************************************************************** */
 
typedef enum UBLOXCFG_SIZE_e
{
    UBLOXCFG_SIZE_BIT   = 0x01, 
    UBLOXCFG_SIZE_ONE   = 0x02, 
    UBLOXCFG_SIZE_TWO   = 0x03, 
    UBLOXCFG_SIZE_FOUR  = 0x04, 
    UBLOXCFG_SIZE_EIGHT = 0x05  
} UBLOXCFG_SIZE_t;
 
 
#define UBLOXCFG_ID2SIZE(id) (UBLOXCFG_SIZE_t)(((id) >> 28) & 0x0f)
 
 
#define UBLOXCFG_ID2GROUP(id) ((id) & 0x0fff0000)
 
 
#define UBLOXCFG_ID2IDGRP(id) ((id) & 0x0000ffff)
 
typedef enum UBLOXCFG_TYPE_e
{
    UBLOXCFG_TYPE_U1, 
    UBLOXCFG_TYPE_U2, 
    UBLOXCFG_TYPE_U4, 
    UBLOXCFG_TYPE_U8, 
    UBLOXCFG_TYPE_I1, 
    UBLOXCFG_TYPE_I2, 
    UBLOXCFG_TYPE_I4, 
    UBLOXCFG_TYPE_I8, 
    UBLOXCFG_TYPE_X1, 
    UBLOXCFG_TYPE_X2, 
    UBLOXCFG_TYPE_X4, 
    UBLOXCFG_TYPE_X8, 
    UBLOXCFG_TYPE_R4, 
    UBLOXCFG_TYPE_R8, 
    UBLOXCFG_TYPE_E1, 
    UBLOXCFG_TYPE_E2, 
    UBLOXCFG_TYPE_E4, 
    UBLOXCFG_TYPE_L   
} UBLOXCFG_TYPE_t;
 
typedef struct UBLOXCFG_CONST_s
{
    const char         *name;  
    const char         *title; 
    const char         *value; 
    union
    {
        int32_t          E;   
        uint64_t         X;   
    } val;                    
} UBLOXCFG_CONST_t;
 
typedef struct UBLOXCFG_ITEM_s
{
    uint32_t                id;        
    UBLOXCFG_TYPE_t         type;      
    UBLOXCFG_SIZE_t         size;      
    const char             *name;      
    const char             *title;     
    const char             *unit;      
    const char             *scale;     
    const UBLOXCFG_CONST_t *consts;    
    int                     nConsts;   
    double                  scalefact; 
    int                     order;     
} UBLOXCFG_ITEM_t;
 
typedef struct UBLOXCFG_MSGRATE_s
{
    const char            *msgName;    
    const UBLOXCFG_ITEM_t *itemUart1;  
    const UBLOXCFG_ITEM_t *itemUart2;  
    const UBLOXCFG_ITEM_t *itemSpi;    
    const UBLOXCFG_ITEM_t *itemI2c;    
    const UBLOXCFG_ITEM_t *itemUsb;    
} UBLOXCFG_MSGRATE_t;
 
 
const UBLOXCFG_ITEM_t *ubloxcfg_getItemByName(const char *name);
 
 
const UBLOXCFG_ITEM_t *ubloxcfg_getItemById(const uint32_t id);
 
 
const UBLOXCFG_ITEM_t **ubloxcfg_getAllItems(int *num);
 
 
const UBLOXCFG_MSGRATE_t *ubloxcfg_getMsgRateCfg(const char *msgName);
 
 
const UBLOXCFG_MSGRATE_t **ubloxcfg_getAllMsgRateCfgs(int *num);
 
typedef enum UBLOXCFG_LAYER_e
{
    UBLOXCFG_LAYER_RAM,      
    UBLOXCFG_LAYER_BBR,      
    UBLOXCFG_LAYER_FLASH,    
    UBLOXCFG_LAYER_DEFAULT   
} UBLOXCFG_LAYER_t;
 
const char *ubloxcfg_layerName(const UBLOXCFG_LAYER_t layer);
 
 
bool ubloxcfg_layerFromName(const char *name, UBLOXCFG_LAYER_t *layer);
 
 
/* ****************************************************************************************************************** */
 
typedef union UBLOXCFG_VALUE_u
{
    uint8_t   U1; 
    uint16_t  U2; 
    uint32_t  U4; 
    uint64_t  U8; 
    int8_t    I1; 
    int16_t   I2; 
    int32_t   I4; 
    int64_t   I8; 
    uint8_t   X1; 
    uint16_t  X2; 
    uint32_t  X4; 
    uint64_t  X8; 
    float     R4; 
    double    R8; 
    int8_t    E1; 
    int16_t   E2; 
    int32_t   E4; 
    bool      L;  
    uint8_t  _bytes[8]; 
    uint64_t _raw;      
} UBLOXCFG_VALUE_t;
 
typedef struct UBLOXCFG_KEYVAL_s
{
    uint32_t         id;       
    UBLOXCFG_VALUE_t val;      
} UBLOXCFG_KEYVAL_t;
 
 
#define UBLOXCFG_KEYVAL_ANY(name, value) { .id = UBLOXCFG_ ## name ## _ID, .val = { .UBLOXCFG_ ## name ## _TYPE = (value) } }
 
 
#define UBLOXCFG_KEYVAL_ENU(name, value) { .id = UBLOXCFG_ ## name ## _ID, .val = { .UBLOXCFG_ ## name ## _TYPE = (UBLOXCFG_ ## name ## _ ## value) } }
 
 
#define UBLOXCFG_KEYVAL_MSG(msg, port, rate)  UBLOXCFG_KEYVAL_ANY(msg ## _ ## port, rate)
 
 
bool ubloxcfg_makeData(uint8_t *data, const int size, const UBLOXCFG_KEYVAL_t *keyVal, const int nKeyVal, int *dataSize);
 
 
bool ubloxcfg_parseData(const uint8_t *data, const int size, UBLOXCFG_KEYVAL_t *keyVal, const int maxKeyVal, int *nKeyVal);
 
 
const char *ubloxcfg_typeStr(UBLOXCFG_TYPE_t type);
 
 
bool ubloxcfg_stringifyValue(char *str, const int size, const UBLOXCFG_TYPE_t type, const UBLOXCFG_ITEM_t *item, const UBLOXCFG_VALUE_t *val);
 
 
bool ubloxcfg_splitValueStr(char *str, char **valueStr, char **prettyStr);
 
 
bool ubloxcfg_stringifyKeyVal(char *str, const int size, const UBLOXCFG_KEYVAL_t *keyVal);
 
#define UBLOXCFG_MAX_KEYVAL_STR_SIZE (_UBLOXCFG_MAX_ITEM_LEN +    /* "CFG-LOOOOONG-NAME"      (item name) */ \
                                      20 +                        /* " (0x........, XX) = "   (item Id and type) */ \
                                      21 +                        /* "0x................ ()"  (X8) */ \
                                      _UBLOXCFG_MAX_CONSTS_LEN +  /* "FIRST|LAST|BLA"         (all defined constants) */ \
                                      19 +                        /* "|0x................"    (remaining bits X8) */ \
                                      10)
 
 
bool ubloxcfg_valueFromString(const char *str, const UBLOXCFG_TYPE_t type, const UBLOXCFG_ITEM_t *item, UBLOXCFG_VALUE_t *value);
 
 
/* ****************************************************************************************************************** */
 
 
uint16_t ubloxcfg_getVersion(void);
 
 
/*
    \param[out] numSources  Number of sources strings returned
    \returns a list of strings that each name a source of the data
*/
const char **ubloxcfg_getSources(int *numSources);
 
 
/* ****************************************************************************************************************** */
#ifdef __cplusplus
}
#endif
#endif // __UBLOXCFG_H__
// eof