iot_rtc.h File Reference

This file contains all the RTC HAL API definitions. More...

Go to the source code of this file.

Data Structures
struct	IotRtcDatetime_t
	RTC date and time format info. More...

Macros
#define	IOT_RTC_SUCCESS   ( 0 )
	Return values used by RTC driver. More...
#define	IOT_RTC_INVALID_VALUE   ( 1 )
#define	IOT_RTC_NOT_STARTED   ( 2 )
#define	IOT_RTC_GET_FAILED   ( 3 )
#define	IOT_RTC_SET_FAILED   ( 4 )
#define	IOT_RTC_FUNCTION_NOT_SUPPORTED   ( 5 )

Typedefs
typedef struct IotRtcDescriptor_t *	IotRtcHandle_t
	IotRtcHandle_t type is the RTC handle returned by calling iot_rtc_open() this is initialized in open and returned to caller. Caller must pass this pointer to the rest of the APIs.
typedef void(*	IotRtcCallback_t) (IotRtcStatus_t xStatus, void *pvUserContext)
	RTC notification callback type. This callback is passed to the driver by using iot_rtc_set_callback API. The callback is used to get the notifications for Alarm and Wakeup timers. More...

Enumerations
enum	IotRtcStatus_t { eRtcTimerStopped, eRtcTimerRunning, eRtcTimerAlarmTriggered, eRtcTimerWakeupTriggered }
	RTC driver status values. More...
enum	IotRtcIoctlRequest_t {   eSetRtcAlarm, eGetRtcAlarm, eCancelRtcAlarm, eSetRtcWakeupTime,   eGetRtcWakeupTime, eCancelRtcWakeup, eGetRtcStatus }
	Ioctl request types. More...

Functions
IotRtcHandle_t	iot_rtc_open (int32_t lRtcInstance)
	iot_rtc_open is used to initialize the RTC timer. It usually resets the RTC timer, sets up the clock for RTC etc... More...
void	iot_rtc_set_callback (IotRtcHandle_t const pxRtcHandle, IotRtcCallback_t xCallback, void *pvUserContext)
	iot_rtc_set_callback is used to set the callback to be called when alarmTime triggers. The caller must set the Alarm time using IOCTL to get the callback. More...
int32_t	iot_rtc_ioctl (IotRtcHandle_t const pxRtcHandle, IotRtcIoctlRequest_t xRequest, void *const pvBuffer)
	iot_rtc_ioctl is used to set RTC configuration and RTC properties like Wakeup time, alarms etc. Supported IOCTL requests are defined in iot_RtcIoctlRequest_t More...
int32_t	iot_rtc_set_datetime (IotRtcHandle_t const pxRtcHandle, const IotRtcDatetime_t *pxDatetime)
	iot_rtc_set_date_time is used to set the current time as a reference in RTC timer counter. More...
int32_t	iot_rtc_get_datetime (IotRtcHandle_t const pxRtcHandle, IotRtcDatetime_t *pxDatetime)
	iot_rtc_get_datetime is used to get the current time from the RTC counter. The time must be set first as a reference to get the time. More...
int32_t	iot_rtc_close (IotRtcHandle_t const pxRtcHandle)
	iot_rtc_close is used to de-Initialize RTC Timer. it resets the RTC timer and may stop the timer. More...

Detailed Description

This file contains all the RTC HAL API definitions.