driver_rx8025t.h

Go to the documentation of this file.

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



typedef enum
{
    RX8025T_BOOL_FALSE = 0x00,        
    RX8025T_BOOL_TRUE  = 0x01,        
} rx8025t_bool_t;

typedef enum
{
    RX8025T_TEMPERATURE_COMPENSATION_INTERVAL_0P5_SECOND = 0x00,        
    RX8025T_TEMPERATURE_COMPENSATION_INTERVAL_2P0_SECOND = 0x01,        
    RX8025T_TEMPERATURE_COMPENSATION_INTERVAL_10_SECOND  = 0x02,        
    RX8025T_TEMPERATURE_COMPENSATION_INTERVAL_30_SECOND  = 0x03,        
} rx8025t_temperature_compensation_interval_t;

typedef enum
{
    RX8025T_FLAG_UPDATE            = (1 << 5),        
    RX8025T_FLAG_TIMER             = (1 << 4),        
    RX8025T_FLAG_ALARM             = (1 << 3),        
    RX8025T_FLAG_VOLTAGE_LOW       = (1 << 1),        
    RX8025T_FLAG_VOLTAGE_DETECTION = (1 << 0),        
} rx8025t_flag_t;

typedef enum
{
    RX8025T_ALARM_WEEK = 0,        
    RX8025T_ALARM_DAY  = 1,        
} rx8025t_alarm_t;

typedef enum
{
    RX8025T_UPDATE_SELECT_SECOND = 0,        
    RX8025T_UPDATE_SELECT_MINUTE = 1,        
} rx8025t_update_select_t;

typedef enum
{
    RX8025T_TIMER_CLOCK_4096_HZ = 0x00,        
    RX8025T_TIMER_CLOCK_64_HZ   = 0x01,        
    RX8025T_TIMER_CLOCK_1_HZ    = 0x02,        
    RX8025T_TIMER_CLOCK_MINUTE  = 0x03,        
} rx8025t_timer_clock_t;

typedef enum
{
    RX8025T_SQUARE_WAVE_FREQUENCY_1_HZ     = 0x02,        
    RX8025T_SQUARE_WAVE_FREQUENCY_1024_HZ  = 0x01,        
    RX8025T_SQUARE_WAVE_FREQUENCY_32768_HZ = 0x00,        
} rx8025t_square_wave_frequency_t;

typedef enum
{
    RX8025T_STATUS_UPDATE            = 0x00,        
    RX8025T_STATUS_TIMER             = 0x10,        
    RX8025T_STATUS_ALARM             = 0x20,        
    RX8025T_STATUS_VOLTAGE_LOW       = 0x30,        
    RX8025T_STATUS_VOLTAGE_DETECTION = 0x40,        
} rx8025t_status_t;

typedef struct rx8025t_time_s
{
    uint16_t year;                 
    uint8_t month;                 
    uint8_t week;                  
    uint8_t date;                  
    uint8_t hour;                  
    uint8_t minute;                
    uint8_t second;                
} rx8025t_time_t;

typedef struct rx8025t_handle_s
{
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    void (*receive_callback)(uint8_t type);                                             
    void (*debug_print)(const char *const fmt, ...);                                    
    void (*delay_ms)(uint32_t ms);                                                      
    uint8_t inited;                                                                     
} rx8025t_handle_t;

typedef struct rx8025t_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;           
} rx8025t_info_t;



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

#define DRIVER_RX8025T_LINK_IIC_INIT(HANDLE, FUC)          (HANDLE)->iic_init = FUC

#define DRIVER_RX8025T_LINK_IIC_DEINIT(HANDLE, FUC)        (HANDLE)->iic_deinit = FUC

#define DRIVER_RX8025T_LINK_IIC_READ(HANDLE, FUC)          (HANDLE)->iic_read = FUC

#define DRIVER_RX8025T_LINK_IIC_WRITE(HANDLE, FUC)         (HANDLE)->iic_write = FUC

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

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

#define DRIVER_RX8025T_LINK_RECEIVE_CALLBACK(HANDLE, FUC)  (HANDLE)->receive_callback = FUC



uint8_t rx8025t_info(rx8025t_info_t *info);

uint8_t rx8025t_irq_handler(rx8025t_handle_t *handle);

uint8_t rx8025t_init(rx8025t_handle_t *handle);

uint8_t rx8025t_deinit(rx8025t_handle_t *handle);

uint8_t rx8025t_start(rx8025t_handle_t *handle);

uint8_t rx8025t_stop(rx8025t_handle_t *handle);

uint8_t rx8025t_set_time(rx8025t_handle_t *handle, rx8025t_time_t *t);

uint8_t rx8025t_get_time(rx8025t_handle_t *handle, rx8025t_time_t *t);

uint8_t rx8025t_set_temperature_compensation_interval(rx8025t_handle_t *handle, rx8025t_temperature_compensation_interval_t interval);

uint8_t rx8025t_get_temperature_compensation_interval(rx8025t_handle_t *handle, rx8025t_temperature_compensation_interval_t *interval);

uint8_t rx8025t_set_update_interrupt(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_update_interrupt(rx8025t_handle_t *handle, rx8025t_bool_t *enable);

uint8_t rx8025t_set_timer_interrupt(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_timer_interrupt(rx8025t_handle_t *handle, rx8025t_bool_t *enable);

uint8_t rx8025t_set_alarm_interrupt(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_alarm_interrupt(rx8025t_handle_t *handle, rx8025t_bool_t *enable);

uint8_t rx8025t_get_flag(rx8025t_handle_t *handle, uint8_t *flag);

uint8_t rx8025t_clear_flag(rx8025t_handle_t *handle);

uint8_t rx8025t_set_test(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_test(rx8025t_handle_t *handle, rx8025t_bool_t *enable);

uint8_t rx8025t_set_alarm_day_week(rx8025t_handle_t *handle, rx8025t_alarm_t alarm);

uint8_t rx8025t_get_alarm_day_week(rx8025t_handle_t *handle, rx8025t_alarm_t *alarm);

uint8_t rx8025t_set_update_select(rx8025t_handle_t *handle, rx8025t_update_select_t select);

uint8_t rx8025t_get_update_select(rx8025t_handle_t *handle, rx8025t_update_select_t *select);

uint8_t rx8025t_set_timer(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_timer(rx8025t_handle_t *handle, rx8025t_bool_t *enable);

uint8_t rx8025t_set_square_wave_frequency(rx8025t_handle_t *handle, rx8025t_square_wave_frequency_t freq);

uint8_t rx8025t_get_square_wave_frequency(rx8025t_handle_t *handle, rx8025t_square_wave_frequency_t *freq);

uint8_t rx8025t_set_timer_clock(rx8025t_handle_t *handle, rx8025t_timer_clock_t clk);

uint8_t rx8025t_get_timer_clock(rx8025t_handle_t *handle, rx8025t_timer_clock_t *clk);

uint8_t rx8025t_set_timer_counter(rx8025t_handle_t *handle, uint16_t counter);

uint8_t rx8025t_get_timer_counter(rx8025t_handle_t *handle, uint16_t *counter);

uint8_t rx8025t_set_ram(rx8025t_handle_t *handle, uint8_t data);

uint8_t rx8025t_get_ram(rx8025t_handle_t *handle, uint8_t *data);

uint8_t rx8025t_set_minute_alarm(rx8025t_handle_t *handle, uint8_t minute);

uint8_t rx8025t_get_minute_alarm(rx8025t_handle_t *handle, uint8_t *minute);

uint8_t rx8025t_set_hour_alarm(rx8025t_handle_t *handle, uint8_t hour);

uint8_t rx8025t_get_hour_alarm(rx8025t_handle_t *handle, uint8_t *hour);

uint8_t rx8025t_set_date_alarm(rx8025t_handle_t *handle, uint8_t date);

uint8_t rx8025t_get_date_alarm(rx8025t_handle_t *handle, uint8_t *date);

uint8_t rx8025t_set_week_alarm(rx8025t_handle_t *handle, uint8_t week);

uint8_t rx8025t_get_week_alarm(rx8025t_handle_t *handle, uint8_t *week);

uint8_t rx8025t_set_minute_alarm_mask(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_minute_alarm_mask(rx8025t_handle_t *handle, rx8025t_bool_t *enable);

uint8_t rx8025t_set_hour_alarm_mask(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_hour_alarm_mask(rx8025t_handle_t *handle, rx8025t_bool_t *enable);

uint8_t rx8025t_set_week_day_alarm_mask(rx8025t_handle_t *handle, rx8025t_bool_t enable);

uint8_t rx8025t_get_week_day_alarm_mask(rx8025t_handle_t *handle, rx8025t_bool_t *enable);



uint8_t rx8025t_set_reg(rx8025t_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t rx8025t_get_reg(rx8025t_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif