Nut/OS  4.10.3
API Reference
Functions
rtc.c File Reference

RTC for Philips PCF8563 clock chip. More...

#include <dev/rtc.h>
Include dependency graph for rtc.c:

Go to the source code of this file.

Functions

int NutRegisterRtc (NUTRTC *rtc)
 Register a specified RTC.
int NutRtcGetTime (struct _tm *tm)
 Get date and time from the registered RTC.
int NutRtcSetTime (CONST struct _tm *tm)
 Set date and time of the registered RTC.
int NutRtcGetAlarm (int idx, struct _tm *tm, int *aflags)
 Get alarm date and time from the registered RTC.
int NutRtcSetAlarm (int idx, CONST struct _tm *tm, int aflags)
 Set alarm date and time of the registered RTC.
int NutRtcGetStatus (uint32_t *sflags)
 Query status flags from the registered RTC.
int NutRtcClearStatus (uint32_t sflags)
 Clear status flags of the registered RTC.

Detailed Description

RTC for Philips PCF8563 clock chip. 

 *
 * $Log$
 * Revision 1.3  2008/08/11 06:59:42  haraldkipp
 * BSD types replaced by stdint types (feature request #1282721).
 *
 * Revision 1.2  2006/10/08 16:48:09  haraldkipp
 * Documentation fixed
 *
 * Revision 1.1  2006/10/05 17:18:49  haraldkipp
 * Hardware independant RTC layer added.
 *
 *
 *

Definition in file rtc.c.

Function Documentation

int NutRegisterRtc ( NUTRTC *  rtc)

Register a specified RTC.

This will also initialize any hardware, if required.

Parameters:
rtcPointer to the NUTRTC structure.
Returns:
0 on success or -1 in case of an error.

Definition at line 69 of file rtc.c.

References _NUTRTC::rtc_init.

Referenced by main().

int NutRtcGetTime ( struct _tm *  tm)

Get date and time from the registered RTC.

Portable applications should use standard C functions.

Parameters:
tmPoints to a structure that receives the date and time information.
Returns:
0 on success or -1 in case of an error.

Definition at line 91 of file rtc.c.

References _NUTRTC::rtc_gettime.

Referenced by time().

int NutRtcSetTime ( CONST struct _tm *  tm)

Set date and time of the registered RTC.

Portable applications should stime().

Parameters:
tmPoints to a structure which contains the date and time information.
Returns:
0 on success or -1 in case of an error.

Definition at line 109 of file rtc.c.

References _NUTRTC::rtc_settime.

Referenced by stime().

int NutRtcGetAlarm ( int  idx,
struct _tm *  tm,
int *  aflags 
)

Get alarm date and time from the registered RTC.

Parameters:
idxZero based index. Two alarms are supported.
tmPoints to a structure that receives the date and time information.
aflagsPoints to an unsigned long that receives the enable flags.
Returns:
0 on success or -1 in case of an error.

Definition at line 128 of file rtc.c.

References _NUTRTC::rtc_getalarm.

int NutRtcSetAlarm ( int  idx,
CONST struct _tm *  tm,
int  aflags 
)

Set alarm date and time of the registered RTC.

Parameters:
idxZero based index. Two alarms are supported.
tmPoints to a structure which contains the date and time information. May be NULL to clear the alarm.
aflagsEach bit enables a specific comparision.
  • Bit 0: Seconds
  • Bit 1: Minutes
  • Bit 2: Hours
  • Bit 3: Day of month
  • Bit 4: Month
  • Bit 7: Day of week (Sunday is zero)
Returns:
0 on success or -1 in case of an error.

Definition at line 152 of file rtc.c.

References _NUTRTC::rtc_setalarm.

int NutRtcGetStatus ( uint32_t *  sflags)

Query status flags from the registered RTC.

Parameters:
sflagsPoints to an unsigned long that receives the status flags.
  • Bit 0: Power fail.
  • Bit 5: Alarm 0 occured.
  • Bit 6: Alarm 1 occured.
Returns:
0 on success or -1 in case of an error.

Definition at line 170 of file rtc.c.

References _NUTRTC::rtc_getstatus.

Referenced by main().

int NutRtcClearStatus ( uint32_t  sflags)

Clear status flags of the registered RTC.

Parameters:
sflagsStatus flags to clear.
Returns:
Always 0.

Definition at line 185 of file rtc.c.

References _NUTRTC::rtc_clrstatus.