sense_bus.h

Go to the documentation of this file.

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

typedef enum {
    SENSE_OK = 0,
    SENSE_NACK,      
    SENSE_TIMEOUT,   
    SENSE_BUS_LOW,   
    SENSE_STUCK,     
    SENSE_OFFLINE,   
    SENSE_BAD_ARG,   
} sense_err_t;

typedef struct {
    sense_err_t (*read)(void *ctx, uint8_t addr, uint8_t reg,
                        uint8_t *buf, size_t n);
    sense_err_t (*write)(void *ctx, uint8_t addr, uint8_t reg,
                         const uint8_t *buf, size_t n);
    void *ctx;
} sense_i2c_t;
 
#define SENSE_STUCK_TIMEOUTS  2u   
#define SENSE_RECOVER_MS    100u   
#define SENSE_FAILS           3u   
#define SENSE_RETRY_MS     1000u   
 
typedef struct {
    sense_i2c_t io;
    uint16_t errors;      
    uint8_t  timeouts;    
    bool     stuck;       
    bool     trial;       
    bool     recovered;   
    uint32_t recover_at;  
    uint32_t recoveries;  
} sense_bus_t;

void sense_bus_init(sense_bus_t *b, const sense_i2c_t *io);

sense_err_t sense_bus_read(sense_bus_t *b, uint8_t addr, uint8_t reg,
                           uint8_t *buf, size_t n);

sense_err_t sense_bus_write16(sense_bus_t *b, uint8_t addr, uint8_t reg,
                              uint16_t value);

void sense_bus_note(sense_bus_t *b, sense_err_t e);

bool sense_bus_recovery_due(const sense_bus_t *b, uint32_t now_ms);

void sense_bus_recovered(sense_bus_t *b, uint32_t now_ms);
 
/* ----------------------------------------------------------- one part */

typedef enum {
    SENSE_PART_UNSET = 0,  
    SENSE_PART_UNPROBED,   
    SENSE_PART_ABSENT,     
    SENSE_PART_WRONG_ID,   
    SENSE_PART_REFUSED,    
    SENSE_PART_ONLINE,
    SENSE_PART_OFFLINE,    
} sense_state_t;

typedef struct {
    sense_bus_t  *bus;
    uint8_t       addr;
    sense_state_t state;
    uint8_t       fails;       
    sense_err_t   last_err;    
    uint16_t      id_maker;    
    uint16_t      id_device;   
    uint32_t      now;         
    uint32_t      probe_at;    
} sense_part_t;

void sense_part_init(sense_part_t *p, sense_bus_t *bus, uint8_t addr);

bool sense_part_probe_due(sense_part_t *p, uint32_t now_ms);

void sense_part_probed(sense_part_t *p, sense_state_t state);

sense_err_t sense_part_read(sense_part_t *p, uint8_t reg,
                            uint8_t *buf, size_t n);
sense_err_t sense_part_write16(sense_part_t *p, uint8_t reg, uint16_t value);

void sense_part_sample_failed(sense_part_t *p, uint8_t before);

void sense_part_lost(sense_part_t *p);
 
/* ------------------------------------------------------------- codec */

uint16_t sense_be16(const uint8_t *b);
uint32_t sense_be24(const uint8_t *b);
uint64_t sense_be40(const uint8_t *b);

int32_t sense_sext32(uint32_t v, unsigned bits);
int64_t sense_sext64(uint64_t v, unsigned bits);

int64_t sense_muldiv(int64_t a, uint32_t mul, uint64_t div);

typedef enum {
    SENSE_CLIP_LOW  = -1,  
    SENSE_CLIP_NONE =  0,
    SENSE_CLIP_HIGH =  1,  
} sense_clip_t;

typedef struct {
    int32_t      value;
    sense_clip_t clip;
} sense_value_t;
 
#ifdef __cplusplus
}
#endif