ds1307.h

Go to the documentation of this file.

/*
 * Copyright (C) 2017 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef DS1307_H
#define DS1307_H
 
#include <stdbool.h>
#include <time.h>
 
#include "nvram.h"
#include "periph/i2c.h"
#include "periph/gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DS1307_I2C_ADDRESS      (0x68)
 
#ifndef DS1307_I2C_MAX_CLK
#define DS1307_I2C_MAX_CLK      (I2C_SPEED_FAST)
#endif
 
#define DS1307_NVRAM_MAX_SIZE   (56U)
 
typedef struct {
    i2c_t i2c;                  
    nvram_t nvram;              
} ds1307_t;
 
typedef struct {
    i2c_t i2c;                  
} ds1307_params_t;
 
typedef enum {
    DS1307_SQW_MODE_0 = 0x00,       
    DS1307_SQW_MODE_1000HZ = 0x10,  
    DS1307_SQW_MODE_4096HZ = 0x11,  
    DS1307_SQW_MODE_8192HZ = 0x12,  
    DS1307_SQW_MODE_32768HZ = 0x13, 
    DS1307_SQW_MODE_1 = 0x80,       
} ds1307_sqw_mode_t;
 
int ds1307_init(ds1307_t *dev, const ds1307_params_t *params);
 
int ds1307_set_time(const ds1307_t *dev, const struct tm *time);
 
int ds1307_get_time(const ds1307_t *dev, struct tm *time);
 
int ds1307_halt(const ds1307_t *dev);
 
int ds1307_set_sqw_mode(const ds1307_t *dev, ds1307_sqw_mode_t mode);
 
int ds1307_get_sqw_mode(const ds1307_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DS1307_H */