DS1307 RTC

Device drive interface for the DS1307 real-time clock. More...

Detailed Description

Device drive interface for the DS1307 real-time clock.

Modules
	DS1307 RTC driver compile configuration

Files
file	ds1307_internal.h
	Register definitions for DS1307 RTC.
file	ds1307_params.h
	Default configuration for DS1307 devices.
file	ds1307.h
	DS1307 definitions.

Data Structures
struct	ds1307_t
	Device descriptor for DS1307 devices. More...
struct	ds1307_params_t
	Set of configuration parameters for DS1307 devices. More...

Macros
#define	DS1307_I2C_ADDRESS   (0x68)
	I2C address of DS1307 RTC.
#define	DS1307_NVRAM_MAX_SIZE   (56U)
	Maximum size in byte of on-chip NVRAM.

Enumerations
enum	ds1307_sqw_mode_t {   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 }
	Modes for the DS1307 square wave / output driver. More...

Functions
int	ds1307_init (ds1307_t *dev, const ds1307_params_t *params)
	Initialize the given DS1307 device.
int	ds1307_set_time (const ds1307_t *dev, const struct tm *time)
	Set RTC to a given time.
int	ds1307_get_time (const ds1307_t *dev, struct tm *time)
	Get current RTC time.
int	ds1307_halt (const ds1307_t *dev)
	Halt clock.
int	ds1307_set_sqw_mode (const ds1307_t *dev, ds1307_sqw_mode_t mode)
	Set mode of square wave / output driver.
int	ds1307_get_sqw_mode (const ds1307_t *dev)
	Get current mode of square wave / output driver.

Macro Definition Documentation

DS1307_I2C_ADDRESS

#define DS1307_I2C_ADDRESS   (0x68)

I2C address of DS1307 RTC.

Definition at line 37 of file ds1307.h.

DS1307_NVRAM_MAX_SIZE

#define DS1307_NVRAM_MAX_SIZE   (56U)

Maximum size in byte of on-chip NVRAM.

Definition at line 56 of file ds1307.h.

Enumeration Type Documentation

ds1307_sqw_mode_t

enum ds1307_sqw_mode_t

Modes for the DS1307 square wave / output driver.

Enumerator
DS1307_SQW_MODE_0	OUT: 0.
DS1307_SQW_MODE_1000HZ	SQW: 1kHz.
DS1307_SQW_MODE_4096HZ	SQW: 4.096 kHz.
DS1307_SQW_MODE_8192HZ	SQW: 8.192 kHz.
DS1307_SQW_MODE_32768HZ	SQW: 32.768 kHz.
DS1307_SQW_MODE_1	OUT: 1.

Definition at line 76 of file ds1307.h.

Function Documentation

ds1307_get_sqw_mode()

int ds1307_get_sqw_mode

(

const ds1307_t *

dev

)

Get current mode of square wave / output driver.

Note

To get the actual output of the driver, attach the pin via GPIO

Parameters

[in]

dev

device descriptor of the targeted device

Returns

current mode of the square wave / output driver (see ds1307_sqw_mode_t)

< 0 if unable to speak to the device

ds1307_get_time()

int ds1307_get_time	(	const ds1307_t *	dev,
		struct tm *	time
	)

Get current RTC time.

Parameters

[in]	dev	device descriptor of the targeted device
[out]	time	pointer to the struct to write the time to.

Returns

0 on success

< 0 if unable to speak to the device

ds1307_halt()

int ds1307_halt

(

const ds1307_t *

dev

)

Halt clock.

Note

Can be reversed using ds1307_set_time()

Parameters

[in]

dev

device descriptor of the targeted device

Returns

0 on success

< 0 if unable to speak to the device

ds1307_init()

int ds1307_init	(	ds1307_t *	dev,
		const ds1307_params_t *	params
	)

Initialize the given DS1307 device.

Parameters

[out]	dev	device descriptor of the targeted device
[in]	params	device configuration (i2c bus, address and bus clock)

Returns

0 on success

< 0 if unable to speak to the device

ds1307_set_sqw_mode()

int ds1307_set_sqw_mode	(	const ds1307_t *	dev,
		ds1307_sqw_mode_t	mode
	)

Set mode of square wave / output driver.

Note

To get the actual output of the driver, attach the pin via GPIO

Parameters

[in]	dev	device descriptor of the targeted device
[in]	mode	mode for the square wave / output driver

Returns

0 on success

< 0 if unable to speak to the device

ds1307_set_time()

int ds1307_set_time	(	const ds1307_t *	dev,
		const struct tm *	time
	)

Set RTC to a given time.

Parameters

[in]	dev	device descriptor of the targeted device
[in]	time	pointer to the struct holding the time to set.

Returns

0 on success

< 0 if unable to speak to the device