TMPM4G9  V1.0.0.0
bsp_rtc.h File Reference

This file provides all the functions prototypes for RTC Class. More...

#include "txz_sample_def.h"

Go to the source code of this file.

Data Structures

struct  uart_handle
 RTC handle structure definenition. More...
 

Macros

#define RTC_RANGE_SEC_MIN   ((uint8_t)0x00)
 
#define RTC_RANGE_SEC_MAX   ((uint8_t)0x3B)
 
#define RTC_RANGE_MIN_MIN   ((uint8_t)0x00)
 
#define RTC_RANGE_MIN_MAX   ((uint8_t)0x3B)
 
#define RTC_ALARM_MIN_OFF   ((uint8_t)0x7F)
 
#define RTC_ALARM_MIN_ON   ((uint8_t)0x00)
 
#define RTC_RANGE_24_HOUR_MIN   ((uint8_t)0x00)
 
#define RTC_RANGE_24_HOUR_MAX   ((uint8_t)0x17)
 
#define RTC_RANGE_12_HOUR_MIN   ((uint8_t)0x00)
 
#define RTC_RANGE_12_HOUR_MAX   ((uint8_t)0x0B)
 
#define RTC_MERIDIEM_AM   ((uint8_t)0x00)
 
#define RTC_MERIDIEM_PM   ((uint8_t)0x20)
 
#define RTC_ALARM_HOUR_OFF   ((uint8_t)0x3F)
 
#define RTC_ALARM_HOUR_ON   ((uint8_t)0x00)
 
#define RTC_DAY_SUNDAY   ((uint8_t)0x00)
 
#define RTC_DAY_MONDAY   ((uint8_t)0x01)
 
#define RTC_DAY_TUESDAY   ((uint8_t)0x02)
 
#define RTC_DAY_WEDNESDAY   ((uint8_t)0x03)
 
#define RTC_DAY_THURSDAY   ((uint8_t)0x04)
 
#define RTC_DAY_FRIDAY   ((uint8_t)0x05)
 
#define RTC_DAY_SATURDAY   ((uint8_t)0x06)
 
#define RTC_ALARM_DAY_OFF   ((uint8_t)0x03)
 
#define RTC_ALARM_DAY_ON   ((uint8_t)0x00)
 
#define RTC_RANGE_DATE_MIN   ((uint8_t)0x00)
 
#define RTC_RANGE_DATE_MAX   ((uint8_t)0x1F)
 
#define RTC_ALARM_DATE_OFF   ((uint8_t)0x3F)
 
#define RTC_ALARM_DATE_ON   ((uint8_t)0x00)
 
#define RTC_MONTH_JAN   ((uint8_t)0x01)
 
#define RTC_MONTH_FEB   ((uint8_t)0x02)
 
#define RTC_MONTH_MAR   ((uint8_t)0x03)
 
#define RTC_MONTH_APR   ((uint8_t)0x04)
 
#define RTC_MONTH_MAY   ((uint8_t)0x05)
 
#define RTC_MONTH_JUN   ((uint8_t)0x06)
 
#define RTC_MONTH_JUL   ((uint8_t)0x07)
 
#define RTC_MONTH_AUG   ((uint8_t)0x08)
 
#define RTC_MONTH_SEP   ((uint8_t)0x09)
 
#define RTC_MONTH_OCT   ((uint8_t)0x10)
 
#define RTC_MONTH_NOV   ((uint8_t)0x11)
 
#define RTC_MONTH_DEC   ((uint8_t)0x12)
 
#define RTC_HOUR_NOTATION_12   ((uint8_t)0x00)
 
#define RTC_HOUR_NOTATION_24   ((uint8_t)0x01)
 
#define RTC_RANGE_YEAR_MIN   ((uint8_t)0x00)
 
#define RTC_RANGE_YEAR_MAX   ((uint8_t)0x63)
 
#define RTC_LEAP_YEAR_0   ((uint8_t)0x00)
 
#define RTC_LEAP_YEAR_1   ((uint8_t)0x01)
 
#define RTC_LEAP_YEAR_2   ((uint8_t)0x02)
 
#define RTC_LEAP_YEAR_3   ((uint8_t)0x03)
 
#define RTC_INT_SRC_1HZ   ((uint8_t)0x47)
 
#define RTC_INT_SRC_2HZ   ((uint8_t)0xC3)
 
#define RTC_INT_SRC_4HZ   ((uint8_t)0xC5)
 
#define RTC_INT_SRC_8HZ   ((uint8_t)0xC6)
 
#define RTC_INT_SRC_16HZ   ((uint8_t)0x87)
 
#define RTC_INT_SRC_ALARM   ((uint8_t)0xC7)
 

Typedefs

typedef struct uart_handle rtc_t
 RTC handle structure definenition. More...
 

Functions

TXZ_Result rtc_init (rtc_t *p_obj)
 Construct object. More...
 
TXZ_Result rtc_deinit (rtc_t *p_obj)
 Destruct object. More...
 
TXZ_Result rtc_enable_int (rtc_t *p_obj)
 Enable INTRTC. More...
 
TXZ_Result rtc_disable_int (rtc_t *p_obj)
 Disable INTRTC. More...
 
TXZ_Result rtc_set_int_source (rtc_t *p_obj, uint8_t src)
 Set interrupt source signal. More...
 
TXZ_Result rtc_set_hour_notation (rtc_t *p_obj, uint8_t notation)
 Set hour notation. More...
 
TXZ_Result rtc_get_hour_notation (rtc_t *p_obj, uint8_t *p_notation)
 Get hour notation. More...
 
TXZ_Result rtc_clock_enable (rtc_t *p_obj)
 Enable clock(timer). More...
 
TXZ_Result rtc_clock_disable (rtc_t *p_obj)
 Disable clock(timer). More...
 
TXZ_Result rtc_clock_reset_counter (rtc_t *p_obj)
 Reset the second counter. More...
 
TXZ_Result rtc_clock_set_sec (rtc_t *p_obj, uint8_t sec)
 Set clock second. More...
 
TXZ_Result rtc_clock_get_sec (rtc_t *p_obj, uint8_t *p_sec)
 Get clock second. More...
 
TXZ_Result rtc_clock_set_min (rtc_t *p_obj, uint8_t min)
 Set clock minute. More...
 
TXZ_Result rtc_clock_get_min (rtc_t *p_obj, uint8_t *p_min)
 Get clock minute. More...
 
TXZ_Result rtc_clock_set_hour_24 (rtc_t *p_obj, uint8_t hour)
 Set clock hour. More...
 
TXZ_Result rtc_clock_get_hour_24 (rtc_t *p_obj, uint8_t *p_hour)
 Get clock hour. More...
 
TXZ_Result rtc_clock_set_hour_12 (rtc_t *p_obj, uint8_t meridiem, uint8_t hour)
 Set clock hour. More...
 
TXZ_Result rtc_clock_get_hour_12 (rtc_t *p_obj, uint8_t *p_meridiem, uint8_t *p_hour)
 Get clock hour. More...
 
TXZ_Result rtc_clock_set_day (rtc_t *p_obj, uint8_t day)
 Set clock day. More...
 
TXZ_Result rtc_clock_get_day (rtc_t *p_obj, uint8_t *p_day)
 Get clock day. More...
 
TXZ_Result rtc_clock_set_date (rtc_t *p_obj, uint8_t date)
 Set clock date. More...
 
TXZ_Result rtc_clock_get_date (rtc_t *p_obj, uint8_t *p_date)
 Get clock date. More...
 
TXZ_Result rtc_clock_set_month (rtc_t *p_obj, uint8_t month)
 Set clock month. More...
 
TXZ_Result rtc_clock_get_month (rtc_t *p_obj, uint8_t *p_month)
 Get clock month. More...
 
TXZ_Result rtc_clock_set_year (rtc_t *p_obj, uint8_t year)
 Set clock year. More...
 
TXZ_Result rtc_clock_get_year (rtc_t *p_obj, uint8_t *p_year)
 Get clock year. More...
 
TXZ_Result rtc_clock_set_leap (rtc_t *p_obj, uint8_t leap)
 Set clock leap. More...
 
TXZ_Result rtc_clock_get_leap (rtc_t *p_obj, uint8_t *p_leap)
 Get clock leap. More...
 
TXZ_Result rtc_alarm_enable (rtc_t *p_obj)
 Enable alarm. More...
 
TXZ_Result rtc_alarm_disable (rtc_t *p_obj)
 Disable alarm. More...
 
TXZ_Result rtc_alarm_reset (rtc_t *p_obj)
 Reset alarm. More...
 
TXZ_Result rtc_alarm_set_min (rtc_t *p_obj, uint8_t compare, uint8_t min)
 Set alarm minute. More...
 
TXZ_Result rtc_alarm_get_min (rtc_t *p_obj, uint8_t *p_compare, uint8_t *p_min)
 Get alarm minute. More...
 
TXZ_Result rtc_alarm_set_hour_24 (rtc_t *p_obj, uint8_t compare, uint8_t hour)
 Set alarm hour. More...
 
TXZ_Result rtc_alarm_get_hour_24 (rtc_t *p_obj, uint8_t *p_compare, uint8_t *p_hour)
 Get alarm hour. More...
 
TXZ_Result rtc_alarm_set_hour_12 (rtc_t *p_obj, uint8_t compare, uint8_t meridiem, uint8_t hour)
 Set alarm hour. More...
 
TXZ_Result rtc_alarm_get_hour_12 (rtc_t *p_obj, uint8_t *p_compare, uint8_t *p_meridiem, uint8_t *p_hour)
 Get alarm hour. More...
 
TXZ_Result rtc_alarm_set_day (rtc_t *p_obj, uint8_t compare, uint8_t day)
 Set alarm day. More...
 
TXZ_Result rtc_alarm_get_day (rtc_t *p_obj, uint8_t *p_compare, uint8_t *p_day)
 Get alarm day. More...
 
TXZ_Result rtc_alarm_set_date (rtc_t *p_obj, uint8_t compare, uint8_t date)
 Set alarm date. More...
 
TXZ_Result rtc_alarm_get_date (rtc_t *p_obj, uint8_t *p_compare, uint8_t *p_date)
 Get alarm date. More...
 

Detailed Description

This file provides all the functions prototypes for RTC Class.

Version
V1.0.0.1
Date
2017-10-17 18:28:31

DO NOT USE THIS SOFTWARE WITHOUT THE SOFTWARE LICENSE AGREEMENT.

Copyright(C) Toshiba Electronic Device Solutions Corporation 2019