ra8_devcfg.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint32_t {
  k_ra8_devcfg_magic        = 0x52413843U, 
  k_ra8_devcfg_schema_ver   = 1U,          
  k_ra8_devcfg_hdr_bytes    = 32U,         
  k_ra8_devcfg_body_bytes   = 96U,         
  k_ra8_devcfg_record_len   = 128U,        
  k_ra8_devcfg_slot_bytes   = 192U,        
  k_ra8_devcfg_sig_headroom = 64U,         
  k_ra8_devcfg_page_bytes   = 32U,         
  k_ra8_devcfg_copy0_off    = 0x00000040U, 
  k_ra8_devcfg_copy1_off    = 0x00000100U, 
} ra8_devcfg_layout_t;

typedef enum : uint8_t {
  k_ra8_devcfg_serial_len       = 16U, 
  k_ra8_devcfg_panel_serial_len = 12U, 
  k_ra8_devcfg_panel_lut_len    = 8U,  
  k_ra8_devcfg_touch_cal_len    = 36U, 
  k_ra8_devcfg_hdr_rsvd_len     = 12U, 
  k_ra8_devcfg_body_rsvd_len    = 10U, 
} ra8_devcfg_field_len_t;

typedef enum : uint8_t {
  k_ra8_devcfg_off_magic        = 0U,   
  k_ra8_devcfg_off_schema       = 4U,   
  k_ra8_devcfg_off_reclen       = 6U,   
  k_ra8_devcfg_off_seq          = 8U,   
  k_ra8_devcfg_off_crc          = 12U,  
  k_ra8_devcfg_off_flags        = 16U,  
  k_ra8_devcfg_off_hdr_rsvd     = 20U,  
  k_ra8_devcfg_off_serial       = 32U,  
  k_ra8_devcfg_off_panel_serial = 48U,  
  k_ra8_devcfg_off_panel_lut    = 60U,  
  k_ra8_devcfg_off_touch_cal    = 68U,  
  k_ra8_devcfg_off_mfg_date     = 104U, 
  k_ra8_devcfg_off_key_id       = 108U, 
  k_ra8_devcfg_off_hw_rev       = 112U, 
  k_ra8_devcfg_off_fixture      = 114U, 
  k_ra8_devcfg_off_vcom         = 116U, 
  k_ra8_devcfg_off_body_rsvd    = 118U, 
} ra8_devcfg_off_t;

typedef enum : uint16_t {
  k_ra8_devcfg_vcom_min_mv = 500U,  
  k_ra8_devcfg_vcom_max_mv = 4000U, 
} ra8_devcfg_vcom_range_t;

typedef enum : uint32_t {
  k_ra8_devcfg_flag_provisioned = 0x00000001U, 
  k_ra8_devcfg_flag_vcom_valid  = 0x00000002U, 
  k_ra8_devcfg_flag_touch_valid = 0x00000004U, 
} ra8_devcfg_flags_t;

typedef struct {
  char     serial[k_ra8_devcfg_serial_len];             
  char     panel_serial[k_ra8_devcfg_panel_serial_len]; 
  char     panel_lut_id[k_ra8_devcfg_panel_lut_len];    
  uint8_t  touch_cal[k_ra8_devcfg_touch_cal_len];       
  uint32_t mfg_date;                                    
  uint32_t device_key_id;                               
  uint16_t hw_rev;                                      
  uint16_t fixture_id;                                  
  uint16_t panel_vcom_mv;                               
} ra8_devcfg_body_t;

typedef struct {
  ra8_devcfg_body_t body;           
  uint32_t          flags;          
  uint32_t          seq;            
  uint16_t          schema_version; 
} ra8_devcfg_record_t;

typedef ra8_err_t (*ra8_devcfg_read_fn_t)(uint32_t offset, uint8_t* dst, uint32_t len);

typedef ra8_err_t (*ra8_devcfg_write_fn_t)(uint32_t offset, const uint8_t* src, uint32_t len);

typedef struct {
  ra8_devcfg_read_fn_t  read;  
  ra8_devcfg_write_fn_t write; 
} ra8_devcfg_store_t;

[[nodiscard]] ra8_err_t ra8_devcfg_load(const ra8_devcfg_store_t* store);

[[nodiscard]] ra8_err_t ra8_devcfg_get_vcom_mv(uint16_t* out_mv);

[[nodiscard]] ra8_err_t ra8_devcfg_get_body(const ra8_devcfg_body_t** out_body);

[[nodiscard]] bool ra8_devcfg_is_blank(void);

[[nodiscard]] ra8_err_t ra8_devcfg_commit(const ra8_devcfg_store_t*  store,
                                          const ra8_devcfg_record_t* rec);

void ra8_devcfg_reset(void);

const ra8_devcfg_store_t* ra8_devcfg_default_store(void);
 
#ifdef __cplusplus
}
#endif