TMPM4G9  V1.0.0.0
bsp_rtc.c File Reference

This file provides API functions for RTC Class. More...

#include "bsp_rtc.h"

Macros

RTC_NULL Pointer

NULL Pointer.

#define RTC_NULL   ((void *)0)
 
Parameter Result

Whether the parameter is specified or not.

#define RTC_PARAM_OK   ((int32_t)1)
 
#define RTC_PARAM_NG   ((int32_t)0)
 
RTCHOURR Macro Definition.

RTCHOURR Register Macro Definition.

Detail.

Bit Bit Symbol
7:6 -
5:0 HO[5:0]
#define RTCPAGER_HO_12_HOUR_MASK   ((uint8_t)0x1F)
 
#define RTCPAGER_HO_12_MERIDIEM_MASK   ((uint8_t)0x20)
 
#define RTCPAGER_HO_12_MERIDIEM_AM   ((uint8_t)0x00)
 
#define RTCPAGER_HO_12_MERIDIEM_PM   ((uint8_t)0x20)
 
RTCPAGER Macro Definition.

RTCPAGER Register Macro Definition.

Detail.

Bit Bit Symbol
7 INTENA
6:5 -
4 ADJUST
3 ENATMR
2 ENAALM
1 -
0 PAGE
#define RTCPAGER_INTENA_MASK   ((uint8_t)0x80)
 
#define RTCPAGER_INTENA_DISABLE   ((uint8_t)0x00)
 
#define RTCPAGER_INTENA_ENABLE   ((uint8_t)0x80)
 
#define RTCPAGER_ADJUST_W_REQ   ((uint8_t)0x10)
 
#define RTCPAGER_ADJUST_R_IDLE   ((uint8_t)0x00)
 
#define RTCPAGER_ADJUST_R_RUN   ((uint8_t)0x10)
 
#define RTCPAGER_ENATMR_MASK   ((uint8_t)0x08)
 
#define RTCPAGER_ENATMR_DISABLE   ((uint8_t)0x00)
 
#define RTCPAGER_ENATMR_ENABLE   ((uint8_t)0x08)
 
#define RTCPAGER_ENAALM_MASK   ((uint8_t)0x04)
 
#define RTCPAGER_ENAALM_DISABLE   ((uint8_t)0x00)
 
#define RTCPAGER_ENAALM_ENABLE   ((uint8_t)0x04)
 
#define RTCPAGER_PAGE_MASK   ((uint8_t)0x01)
 
#define RTCPAGER_PAGE_0   ((uint8_t)0x00)
 
#define RTCPAGER_PAGE_1   ((uint8_t)0x01)
 
RTCRESTR Macro Definition.

RTCRESTR Register Macro Definition.

Detail.

Bit Bit Symbol
7 DIS1HZ
6 DIS16HZ
5 RSTTMR
4 RSTALM
3 -
2 DIS2HZ
1 DIS4HZ
0 DIS8HZ
#define RTCRESTR_RSTTMR_MASK   ((uint8_t)0x20)
 
#define RTCRESTR_RSTTMR_W_RESET   ((uint8_t)0x20)
 
#define RTCRESTR_RSTTMR_R_IDLE   ((uint8_t)0x00)
 
#define RTCRESTR_RSTTMR_R_RUN   ((uint8_t)0x20)
 
#define RTCRESTR_RSTALM_MASK   ((uint8_t)0x10)
 
#define RTCRESTR_RSTALM_RESET   ((uint8_t)0x10)
 

Functions

__STATIC_INLINE uint8_t convert_time_to_reg (uint8_t src)
 Convet time value to register setting value. More...
 
__STATIC_INLINE uint8_t convert_time_to_dec (uint8_t src)
 Convet time value to decimal. More...
 
__STATIC_INLINE void set_page (rtc_t *p_obj, uint8_t page)
 Set PAGE. More...
 
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 API functions for RTC Class.

Version
V1.0.1.2
Date
2017-09-01 08:26:38

DO NOT USE THIS SOFTWARE WITHOUT THE SOFTWARE LICENSE AGREEMENT.

Copyright(C) Toshiba Electronic Device Solutions Corporation 2019