config.h

Go to the documentation of this file.

#ifndef CONFIG_H
#define CONFIG_H
 
#include <stdint.h>
#include <stdbool.h>
#include <assert.h>
#include <stddef.h>
 
#include "pixelkey_errors.h"
 
#define CONFIG_DATA_VERSION     (1)
 
typedef struct st_config_neopixel_phy
{
    uint16_t frequency_khz; 
    uint8_t  duty_cycle_b0; 
    uint8_t  duty_cycle_b1; 
} config_neopixel_phy_t;
 
static_assert(sizeof(config_neopixel_phy_t) == 4, "config_neopixel_phy_t must be 4 bytes or an upgrade path provided.");
 
// Saved to memory; must be packed!
#pragma pack(push, 1)
typedef struct st_config_data
{
    struct
    {
        uint16_t crc;                     
        uint8_t  length;                  
        uint8_t  version;                 
    } header;
    union
    {
        struct
        {
            uint32_t echo_enabled   :  1; 
            uint32_t gamma_enabled  :  1; 
            uint32_t                : 30;
        } flags_b;                        
        uint32_t flags;                   
    };
    float    gamma_factor;                
    uint32_t framerate;                   
    uint32_t num_neopixels;               
    uint8_t  max_rgb_value;               
    config_neopixel_phy_t neopixel_phy;   
} config_data_t;
#pragma pack(pop)
 
static_assert(offsetof(config_data_t, header) == 0, "Config header must be the first element of config_data_t.");
static_assert(offsetof(config_data_t, header.crc) == 0, "CRC must start at byte 0.");
static_assert(offsetof(config_data_t, header.length) == 2, "Length must start at byte 2.");
static_assert(offsetof(config_data_t, header.version) == 3, "Version must start at byte 3.");
 
typedef struct st_config_api
{
    pixelkey_error_t (* write)(config_data_t const * const p_config_data);
    pixelkey_error_t (* read)(config_data_t ** pp_config_data);
} config_api_t;
 
config_api_t const * config(void);
config_data_t const * config_default(void);
config_data_t const * config_get_or_default(void);
void config_register(config_api_t const * p_instance);
pixelkey_error_t config_validate(void);
 
#endif