driver_ds1307.h

Go to the documentation of this file.

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



typedef enum
{
    DS1307_BOOL_FALSE = 0x00,        
    DS1307_BOOL_TRUE  = 0x01,        
} ds1307_bool_t;

typedef enum
{
    DS1307_AM = 0x00,        
    DS1307_PM = 0x01,        
} ds1307_am_pm_t;

typedef enum
{
    DS1307_FORMAT_12H = 0x01,        
    DS1307_FORMAT_24H = 0x00,        
} ds1307_format_t;

typedef enum
{
    DS1307_OUTPUT_LEVEL_LOW  = 0x00,        
    DS1307_OUTPUT_LEVEL_HIGH = 0x01,        
} ds1307_output_level_t;

typedef enum
{
    DS1307_OUTPUT_MODE_LEVEL       = 0x00,        
    DS1307_OUTPUT_MODE_SQUARE_WAVE = 0x01,        
} ds1307_output_mode_t;

typedef enum
{
    DS1307_SQUARE_WAVE_FREQUENCY_1_HZ     = 0x00,        
    DS1307_SQUARE_WAVE_FREQUENCY_4096_HZ  = 0x01,        
    DS1307_SQUARE_WAVE_FREQUENCY_8192_HZ  = 0x02,        
    DS1307_SQUARE_WAVE_FREQUENCY_32768_HZ = 0x03,        
} ds1307_square_wave_frequency_t;

typedef struct ds1307_time_s
{
    uint16_t year;                 
    uint8_t month;                 
    uint8_t week;                  
    uint8_t date;                  
    uint8_t hour;                  
    uint8_t minute;                
    uint8_t second;                
    ds1307_format_t format;        
    ds1307_am_pm_t am_pm;          
} ds1307_time_t;

typedef struct ds1307_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);                                                      
    uint8_t inited;                                                                     
} ds1307_handle_t;

typedef struct ds1307_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;           
} ds1307_info_t;



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

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

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

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

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

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

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



uint8_t ds1307_info(ds1307_info_t *info);

uint8_t ds1307_init(ds1307_handle_t *handle);

uint8_t ds1307_deinit(ds1307_handle_t *handle);

uint8_t ds1307_set_time(ds1307_handle_t *handle, ds1307_time_t *t);

uint8_t ds1307_get_time(ds1307_handle_t *handle, ds1307_time_t *t);

uint8_t ds1307_read_ram(ds1307_handle_t *handle, uint8_t addr, uint8_t *buf, uint8_t len);

uint8_t ds1307_write_ram(ds1307_handle_t *handle, uint8_t addr, uint8_t *buf, uint8_t len);

uint8_t ds1307_set_oscillator(ds1307_handle_t *handle, ds1307_bool_t enable);

uint8_t ds1307_get_oscillator(ds1307_handle_t *handle, ds1307_bool_t *enable);

uint8_t ds1307_set_output_level(ds1307_handle_t *handle, ds1307_output_level_t level);

uint8_t ds1307_get_output_level(ds1307_handle_t *handle, ds1307_output_level_t *level);

uint8_t ds1307_set_output_mode(ds1307_handle_t *handle, ds1307_output_mode_t mode);

uint8_t ds1307_get_output_mode(ds1307_handle_t *handle, ds1307_output_mode_t *mode);

uint8_t ds1307_set_square_wave_frequency(ds1307_handle_t *handle, ds1307_square_wave_frequency_t freq);

uint8_t ds1307_get_square_wave_frequency(ds1307_handle_t *handle, ds1307_square_wave_frequency_t *freq);



uint8_t ds1307_set_reg(ds1307_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t ds1307_get_reg(ds1307_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif