driver_x9cxx.h

Go to the documentation of this file.

 
#ifndef DRIVER_X9CXX_H
#define DRIVER_X9CXX_H
 
#include <stdint.h>
#include <stdio.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



#ifndef X9CXX_STEP_DELAY_US
    #define X9CXX_STEP_DELAY_US        10         
#endif

#ifndef X9CXX_OPERATE_DELAY_US
    #define X9CXX_OPERATE_DELAY_US        10         
#endif

#ifndef X9CXX_STORE_DELAY_MS
    #define X9CXX_STORE_DELAY_MS        30        
#endif

typedef enum
{
    X9C102 = 1000,          
    X9C103 = 10000,         
    X9C503 = 50000,         
    X9C104 = 100000,        
} x9cxx_type_t;

typedef enum
{
    X9CXX_BOOL_FALSE = 0x00,        
    X9CXX_BOOL_TRUE  = 0x01,        
} x9cxx_bool_t;

typedef struct x9cxx_handle_s
{
    uint8_t (*cs_gpio_init)(void);                          
    uint8_t (*cs_gpio_deinit)(void);                        
    uint8_t (*cs_gpio_write)(uint8_t value);                
    uint8_t (*up_down_gpio_init)(void);                     
    uint8_t (*up_down_gpio_deinit)(void);                   
    uint8_t (*up_down_gpio_write)(uint8_t value);           
    uint8_t (*inc_gpio_init)(void);                         
    uint8_t (*inc_gpio_deinit)(void);                       
    uint8_t (*inc_gpio_write)(uint8_t value);               
    void (*debug_print)(const char *const fmt, ...);        
    void (*delay_ms)(uint32_t ms);                          
    void (*delay_us)(uint32_t us);                          
    uint8_t inited;                                         
    uint8_t valid;                                          
    uint8_t step;                                           
    uint32_t type;                                          
} x9cxx_handle_t;

typedef struct x9cxx_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} x9cxx_info_t;



#define DRIVER_X9CXX_LINK_INIT(HANDLE, STRUCTURE)              memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_X9CXX_LINK_CS_GPIO_INIT(HANDLE, FUC)           (HANDLE)->cs_gpio_init = FUC

#define DRIVER_X9CXX_LINK_CS_GPIO_DEINIT(HANDLE, FUC)         (HANDLE)->cs_gpio_deinit = FUC

#define DRIVER_X9CXX_LINK_CS_GPIO_WRITE(HANDLE, FUC)          (HANDLE)->cs_gpio_write = FUC

#define DRIVER_X9CXX_LINK_UP_DOWN_GPIO_INIT(HANDLE, FUC)      (HANDLE)->up_down_gpio_init = FUC

#define DRIVER_X9CXX_LINK_UP_DOWN_GPIO_DEINIT(HANDLE, FUC)    (HANDLE)->up_down_gpio_deinit = FUC

#define DRIVER_X9CXX_LINK_UP_DOWN_GPIO_WRITE(HANDLE, FUC)     (HANDLE)->up_down_gpio_write = FUC

#define DRIVER_X9CXX_LINK_INC_GPIO_INIT(HANDLE, FUC)          (HANDLE)->inc_gpio_init = FUC

#define DRIVER_X9CXX_LINK_INC_GPIO_DEINIT(HANDLE, FUC)        (HANDLE)->inc_gpio_deinit = FUC

#define DRIVER_X9CXX_LINK_INC_GPIO_WRITE(HANDLE, FUC)         (HANDLE)->inc_gpio_write = FUC

#define DRIVER_X9CXX_LINK_DEBUG_PRINT(HANDLE, FUC)            (HANDLE)->debug_print = FUC

#define DRIVER_X9CXX_LINK_DELAY_MS(HANDLE, FUC)               (HANDLE)->delay_ms = FUC

#define DRIVER_X9CXX_LINK_DELAY_US(HANDLE, FUC)               (HANDLE)->delay_us = FUC



uint8_t x9cxx_info(x9cxx_info_t *info);

uint8_t x9cxx_set_type(x9cxx_handle_t *handle, x9cxx_type_t type);

uint8_t x9cxx_get_type(x9cxx_handle_t *handle, x9cxx_type_t *type);

uint8_t x9cxx_init(x9cxx_handle_t *handle);

uint8_t x9cxx_deinit(x9cxx_handle_t *handle);

uint8_t x9cxx_reset_to_min(x9cxx_handle_t *handle, x9cxx_bool_t store_enable);

uint8_t x9cxx_reset_to_max(x9cxx_handle_t *handle, x9cxx_bool_t store_enable);

uint8_t x9cxx_increment(x9cxx_handle_t *handle, uint8_t step, x9cxx_bool_t store_enable);

uint8_t x9cxx_decrement(x9cxx_handle_t *handle, uint8_t step, x9cxx_bool_t store_enable);

uint8_t x9cxx_set_absolute_step_counter(x9cxx_handle_t *handle, uint8_t counter, x9cxx_bool_t store_enable);

uint8_t x9cxx_get_step_counter(x9cxx_handle_t *handle, uint8_t *counter);

uint8_t x9cxx_resistor_convert_to_register(x9cxx_handle_t *handle, float ohm, uint8_t *step);

uint8_t x9cxx_resistor_convert_to_data(x9cxx_handle_t *handle, uint8_t step, float *ohm);


 
#ifdef __cplusplus
}
#endif
 
#endif