hitec_session.h

Go to the documentation of this file.

 
#ifndef HITEC_SESSION_H
#define HITEC_SESSION_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "hitec_reg.h"
#include "hitec_wire.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* --- timings -------------------------------------------------------------- */

#define HITEC_SES_TRIES 3u
#define HITEC_SES_C_GAP_MS 2u
#define HITEC_SES_D_GAP_MS HITEC_D_WRITE_GAP_MS
#define HITEC_SES_D_ENTRY_WAIT_MS HITEC_D_REBOOT_WAIT_MS
#define HITEC_SES_C_ENTRY_WINDOW_US 2000000u
#define HITEC_SES_C_NEXT_WINDOW_US 1000000u
#define HITEC_SES_POWER_WINDOW_US 1000u
#define HITEC_SES_OFF_MS 500u
#define HITEC_SES_OFF_MS_MAX 10000u
#define HITEC_SES_SET_BYTES 32u
 
/* --- steps and results ---------------------------------------------------- */

typedef enum {
    HITEC_SES_CLOCK_US = 0,  
    HITEC_SES_CLOCK_MS = 1,  
} hitec_ses_clock_t;

typedef enum {
    HITEC_SES_STEP_XFER = 0,  
    HITEC_SES_STEP_POWER,     
    HITEC_SES_STEP_WAIT,      
    HITEC_SES_STEP_DONE,      
} hitec_ses_kind_t;

typedef enum {
    HITEC_DEC_NONE = 0,    
    HITEC_DEC_C = 1,       
    HITEC_DEC_D = 2,       
    HITEC_DEC_LISTEN = 3,  
} hitec_dec_t;

typedef struct {
    uint8_t      kind;     
    uint8_t      decoder;  
    uint8_t      dec_arg;  
    uint16_t     off_ms;   
    uint16_t     wait_ms;  
    hitec_xfer_t xfer;     
} hitec_ses_step_t;

typedef enum {
    HITEC_SES_RAN = 0,
    HITEC_SES_CUT,
    HITEC_SES_FAILED,
} hitec_ses_run_t;

typedef struct {
    uint8_t  run;    
    uint8_t  rx;     
    uint16_t value;  
} hitec_ses_result_t;

typedef enum {
    HITEC_SES_OK = 0,           
    HITEC_SES_BUSY,             
    HITEC_SES_ERR_BUSY,         
    HITEC_SES_ERR_ARG,          
    HITEC_SES_ERR_NOT_IN_MODE,  
    HITEC_SES_ERR_NO_SERVO,     
    HITEC_SES_ERR_ENTRY,        
    HITEC_SES_ERR_READ,         
    HITEC_SES_ERR_WRITE,        
    HITEC_SES_ERR_VERIFY,       
    HITEC_SES_ERR_PLAN,         
    HITEC_SES_ERR_STEP,         
    HITEC_SES_ERR_CUT,          
    HITEC_SES_ERR_LINK,         
    HITEC_SES_ERR_ABORTED,      
} hitec_ses_t;

typedef struct {
    /* --- for the caller to read ------------------------------------------- */
    hitec_image_t image;   
    hitec_plan_t  plan;    
    uint8_t  diff[HITEC_SES_SET_BYTES];
    uint8_t  series;       
    uint8_t  clock;        
    uint8_t  in_mode;      
    uint8_t  result;       
    uint8_t  last_rx;      
    uint8_t  fail_addr;    
    uint8_t  tries;        
    uint8_t  step_index;   
    uint8_t  plan_result;  
    uint16_t done;         
    uint16_t total;        
    uint16_t off_ms;       
 
    /* --- private ----------------------------------------------------------- */
    hitec_image_t target;  
    hitec_ses_step_t step; 
    uint8_t  todo[HITEC_SES_SET_BYTES];  
    uint32_t t_mark;       
    uint32_t gap;          
    uint8_t  op;           
    uint8_t  phase;        
    uint8_t  out;          
    uint8_t  abort;        
    uint8_t  gap_on;       
    uint8_t  addr;         
    uint8_t  power;        
    uint8_t  compare;      
    uint8_t  sent;         
    uint8_t  unsure;       
} hitec_session_t;
 
/* --- operations ----------------------------------------------------------- */

bool hitec_session_init(hitec_session_t *s, uint8_t series, uint8_t clock);

hitec_ses_t hitec_session_enter(hitec_session_t *s, bool power,
                                uint16_t off_ms);

hitec_ses_t hitec_session_read_all(hitec_session_t *s);

hitec_ses_t hitec_session_read_set(hitec_session_t *s, const uint8_t *addrs,
                                   uint16_t n);

hitec_ses_t hitec_session_write(hitec_session_t *s,
                                const hitec_image_t *target);

hitec_ses_t hitec_session_run_plan(hitec_session_t *s,
                                   const hitec_plan_t *plan,
                                   const hitec_image_t *expect);

hitec_ses_t hitec_session_leave(hitec_session_t *s);

bool hitec_session_abort(hitec_session_t *s);
 
/* --- stepping ------------------------------------------------------------- */

hitec_ses_kind_t hitec_session_next(hitec_session_t *s, uint32_t now,
                                    hitec_ses_step_t *out);

hitec_ses_t hitec_session_feed(hitec_session_t *s, uint32_t now,
                               const hitec_ses_result_t *r);

hitec_ses_t hitec_session_result(const hitec_session_t *s);

bool hitec_ses_in_set(const uint8_t *set, uint8_t addr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* HITEC_SESSION_H */