driver_pcf8563.h

Go to the documentation of this file.

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



typedef enum
{
    PCF8563_BOOL_FALSE = 0x00,        
    PCF8563_BOOL_TRUE  = 0x01,        
} pcf8563_bool_t;

typedef enum
{
    PCF8563_CLOCK_OUT_32P768KHZ = 0x00,        
    PCF8563_CLOCK_OUT_1P024KHZ  = 0x01,        
    PCF8563_CLOCK_OUT_32HZ      = 0x02,        
    PCF8563_CLOCK_OUT_1HZ       = 0x03,        
} pcf8563_clock_out_t;

typedef enum
{
    PCF8563_TIMER_FREQ_4P096KHZ   = 0x00,        
    PCF8563_TIMER_FREQ_64HZ       = 0x01,        
    PCF8563_TIMER_FREQ_1HZ        = 0x02,        
    PCF8563_TIMER_FREQ_1_DIV_60HZ = 0x03,        
} pcf8563_timer_freq_t;

typedef enum
{
    PCF8563_INTERRUPT_MODE_LEVEL = 0x00,        
    PCF8563_INTERRUPT_MODE_PULSE = 0x01,        
} pcf8563_interrupt_mode_t;

typedef enum
{
    PCF8563_INTERRUPT_EVENT_TIMER = 0x00,        
    PCF8563_INTERRUPT_EVENT_ALARM = 0x01,        
} pcf8563_interrupt_event_t;

typedef struct pcf8563_time_s
{
    uint16_t year;         
    uint8_t month;         
    uint8_t week;          
    uint8_t date;          
    uint8_t hour;          
    uint8_t minute;        
    uint8_t second;        
} pcf8563_time_t;

typedef struct pcf8563_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 (*debug_print)(const char *const fmt, ...);                                    
    void (*delay_ms)(uint32_t ms);                                                      
    void (*receive_callback)(uint8_t type);                                             
    uint8_t inited;                                                                     
} pcf8563_handle_t;

typedef struct pcf8563_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;           
} pcf8563_info_t;



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

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

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

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

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

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

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

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



uint8_t pcf8563_info(pcf8563_info_t *info);

uint8_t pcf8563_irq_handler(pcf8563_handle_t *handle);

uint8_t pcf8563_init(pcf8563_handle_t *handle);

uint8_t pcf8563_deinit(pcf8563_handle_t *handle);

uint8_t pcf8563_set_time(pcf8563_handle_t *handle, pcf8563_time_t *t);

uint8_t pcf8563_get_time(pcf8563_handle_t *handle, pcf8563_time_t *t);

uint8_t pcf8563_set_test_mode(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_test_mode(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_rtc_stop(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_rtc_stop(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_power_on_reset(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_power_on_reset(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_minute_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_minute_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_minute_alarm(pcf8563_handle_t *handle, uint8_t minute);

uint8_t pcf8563_get_minute_alarm(pcf8563_handle_t *handle, uint8_t *minute);

uint8_t pcf8563_set_hour_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_hour_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_hour_alarm(pcf8563_handle_t *handle, uint8_t hour);

uint8_t pcf8563_get_hour_alarm(pcf8563_handle_t *handle, uint8_t *hour);

uint8_t pcf8563_set_day_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_day_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_day_alarm(pcf8563_handle_t *handle, uint8_t day);

uint8_t pcf8563_get_day_alarm(pcf8563_handle_t *handle, uint8_t *day);

uint8_t pcf8563_set_week_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_week_alarm_enable(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_week_alarm(pcf8563_handle_t *handle, uint8_t week);

uint8_t pcf8563_get_week_alarm(pcf8563_handle_t *handle, uint8_t *week);

uint8_t pcf8563_set_clock_out_enable(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_clock_out_enable(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_clock_out(pcf8563_handle_t *handle, pcf8563_clock_out_t clk);

uint8_t pcf8563_get_clock_out(pcf8563_handle_t *handle, pcf8563_clock_out_t *clk);

uint8_t pcf8563_set_timer_enable(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_timer_enable(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_timer_freq(pcf8563_handle_t *handle, pcf8563_timer_freq_t freq);

uint8_t pcf8563_get_timer_freq(pcf8563_handle_t *handle, pcf8563_timer_freq_t *freq);

uint8_t pcf8563_set_timer_value(pcf8563_handle_t *handle, uint8_t value);

uint8_t pcf8563_get_timer_value(pcf8563_handle_t *handle, uint8_t *value);

uint8_t pcf8563_set_timer_interrupt(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_timer_interrupt(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_alarm_interrupt(pcf8563_handle_t *handle, pcf8563_bool_t enable);

uint8_t pcf8563_get_alarm_interrupt(pcf8563_handle_t *handle, pcf8563_bool_t *enable);

uint8_t pcf8563_set_interrupt_mode(pcf8563_handle_t *handle, pcf8563_interrupt_mode_t mode);

uint8_t pcf8563_get_interrupt_mode(pcf8563_handle_t *handle, pcf8563_interrupt_mode_t *mode);

uint8_t pcf8563_clear_status(pcf8563_handle_t *handle, pcf8563_interrupt_event_t event);



uint8_t pcf8563_set_reg(pcf8563_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t pcf8563_get_reg(pcf8563_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif