driver_ds1302.h

Go to the documentation of this file.

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



typedef enum
{
    DS1302_BOOL_FALSE = 0x00,        
    DS1302_BOOL_TRUE  = 0x01,        
} ds1302_bool_t;

typedef enum
{
    DS1302_AM = 0x00,        
    DS1302_PM = 0x01,        
} ds1302_am_pm_t;

typedef enum
{
    DS1302_FORMAT_12H = 0x01,        
    DS1302_FORMAT_24H = 0x00,        
} ds1302_format_t;

typedef enum
{
    DS1302_CHARGE_ENABLE  = (0xA << 4),      
    DS1302_CHARGE_DISABLE = (0x0 << 0),      
    DS1302_CHARGE_1_DIODE = (1 << 2),        
    DS1302_CHARGE_2_DIODE = (2 << 2),        
    DS1302_CHARGE_2K      = (1 << 0),        
    DS1302_CHARGE_4K      = (2 << 0),        
    DS1302_CHARGE_8K      = (3 << 0),        
} ds1302_charge_t;

typedef struct ds1302_time_s
{
    uint16_t year;                 
    uint8_t month;                 
    uint8_t week;                  
    uint8_t date;                  
    uint8_t hour;                  
    uint8_t minute;                
    uint8_t second;                
    ds1302_format_t format;        
    ds1302_am_pm_t am_pm;          
} ds1302_time_t;

typedef struct ds1302_handle_s
{
    uint8_t (*ce_gpio_init)(void);                          
    uint8_t (*ce_gpio_deinit)(void);                        
    uint8_t (*ce_gpio_write)(uint8_t value);                
    uint8_t (*sclk_gpio_init)(void);                        
    uint8_t (*sclk_gpio_deinit)(void);                      
    uint8_t (*sclk_gpio_write)(uint8_t value);              
    uint8_t (*io_gpio_init)(void);                          
    uint8_t (*io_gpio_deinit)(void);                        
    uint8_t (*io_gpio_write)(uint8_t value);                
    uint8_t (*io_gpio_read)(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;                                         
} ds1302_handle_t;

typedef struct ds1302_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;           
} ds1302_info_t;



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

#define DRIVER_DS1302_LINK_CE_GPIO_INIT(HANDLE, FUC)        (HANDLE)->ce_gpio_init = FUC

#define DRIVER_DS1302_LINK_CE_GPIO_DEINIT(HANDLE, FUC)      (HANDLE)->ce_gpio_deinit = FUC

#define DRIVER_DS1302_LINK_CE_GPIO_WRITE(HANDLE, FUC)       (HANDLE)->ce_gpio_write = FUC

#define DRIVER_DS1302_LINK_SCLK_GPIO_INIT(HANDLE, FUC)      (HANDLE)->sclk_gpio_init = FUC

#define DRIVER_DS1302_LINK_SCLK_GPIO_DEINIT(HANDLE, FUC)    (HANDLE)->sclk_gpio_deinit = FUC

#define DRIVER_DS1302_LINK_SCLK_GPIO_WRITE(HANDLE, FUC)     (HANDLE)->sclk_gpio_write = FUC

#define DRIVER_DS1302_LINK_IO_GPIO_INIT(HANDLE, FUC)        (HANDLE)->io_gpio_init = FUC

#define DRIVER_DS1302_LINK_IO_GPIO_DEINIT(HANDLE, FUC)      (HANDLE)->io_gpio_deinit = FUC

#define DRIVER_DS1302_LINK_CS_GPIO_WRITE(HANDLE, FUC)       (HANDLE)->io_gpio_write = FUC

#define DRIVER_DS1302_LINK_CS_GPIO_READ(HANDLE, FUC)        (HANDLE)->io_gpio_read = FUC

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

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

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



uint8_t ds1302_info(ds1302_info_t *info);

uint8_t ds1302_init(ds1302_handle_t *handle);

uint8_t ds1302_deinit(ds1302_handle_t *handle);

uint8_t ds1302_set_time(ds1302_handle_t *handle, ds1302_time_t *t);

uint8_t ds1302_get_time(ds1302_handle_t *handle, ds1302_time_t *t);

uint8_t ds1302_set_oscillator(ds1302_handle_t *handle, ds1302_bool_t enable);

uint8_t ds1302_get_oscillator(ds1302_handle_t *handle, ds1302_bool_t *enable);

uint8_t ds1302_set_write_protect(ds1302_handle_t *handle, ds1302_bool_t enable);

uint8_t ds1302_get_write_protect(ds1302_handle_t *handle, ds1302_bool_t *enable);

uint8_t ds1302_set_charge(ds1302_handle_t *handle, uint8_t charge);

uint8_t ds1302_get_charge(ds1302_handle_t *handle, uint8_t *charge);

uint8_t ds1302_read_ram(ds1302_handle_t *handle, uint8_t addr, uint8_t *buf, uint8_t len);

uint8_t ds1302_write_ram(ds1302_handle_t *handle, uint8_t addr, uint8_t *buf, uint8_t len);



uint8_t ds1302_clock_burst_write(ds1302_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t ds1302_clock_burst_read(ds1302_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t ds1302_ram_burst_write(ds1302_handle_t *handle, uint8_t *buf, uint8_t len);

uint8_t ds1302_ram_burst_read(ds1302_handle_t *handle, uint8_t *buf, uint8_t len);



uint8_t ds1302_set_reg(ds1302_handle_t *handle, uint8_t reg, uint8_t *buf, uint8_t len);

uint8_t ds1302_get_reg(ds1302_handle_t *handle, uint8_t reg, uint8_t *buf, uint8_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif