MityDSP::tcDspRtcDS1305 Class Reference

Instances of this class handle access to the DS1305 real-time clock chip. More...

#include <core/DspRtcDS1305.h>

Inheritance diagram for MityDSP::tcDspRtcDS1305:

Public Member Functions
	tcDspRtcDS1305 (tcDspMcbsp apMcbsp, tcDspOutputLatch apLatch, unsigned int anCSID, unsigned int anYear=Y2K)
	This constructor is used to initialize a DS1305 real-time clock over a specified McBSP interface.
	~tcDspRtcDS1305 ()
	Default Destructor.
tsCLTime	get_time (unsigned short *apHundredths=NULL)
	This routine reads the current time from the real-time clock and returns it as a 32-bit tsCLTime value.
void	set_time (tsCLTime asTime)
	This routine provides an alternate interface to the set_time routine, using a tsCLTime value.
void	set_time (unsigned int anYear, unsigned int anMonth, unsigned int anDay, unsigned int anHour, unsigned int anMin, unsigned int anSec)
	This routine sets the current time of the real-time clock using discrete year, month, day, hour, minute and second values.

Detailed Description

Instances of this class handle access to the DS1305 real-time clock chip.

This constructor is used to initialize a DS1305 real-time clock over a specified McBSP interface.

Parameters:

`[in]`	apMcbsp	The tcDspMcbsp object to use for communication.
`[in]`	apLatch	The tcDspOutputLatch to use for McBSP chip select.
`[in]`	anCSID	The chip select ID to use with apLatch.
`[in]`	anYear	Base year for this real-time clock.

tcDspRtcDS1305::~tcDspRtcDS1305 ( )

Default Destructor.

tsCLTime tcDspRtcDS1305::get_time ( unsigned short * apHundredths = NULL ) [virtual]

This routine reads the current time from the real-time clock and returns it as a 32-bit tsCLTime value.

void tcDspRtcDS1305::set_time ( tsCLTime asTime ) [virtual]

This routine provides an alternate interface to the set_time routine, using a tsCLTime value.

Parameters:

[in] asTime A tsCLTime structure representing the current time.

This routine sets the current time of the real-time clock using discrete year, month, day, hour, minute and second values.

The current epoch is updated if required.

Parameters: