TMPM4G9  V1.0.0.0
RTC_UART Exported Functions

Functions

horol_thorol_initialize (horol_initial_setting_t *p_param)
 Initialize. More...
 
void horol_finalize (horol_t *p_instance)
 Finalize. More...
 
void horol_start (horol_t *p_instance)
 Start. More...
 
void horol_stop (horol_t *p_instance)
 Stop. More...
 
void horol_get_current_clock (horol_t *p_instance, horol_clock_value_t *p_dst)
 Get Current Clock Information. More...
 
void horol_irq_handler (horol_t *p_instance)
 IRQ Handler. More...
 
uint32_t horol_make_anno_domini (uint8_t century, uint8_t year)
 Make A.D. More...
 
TXZ_Result horol_set_alarm_clock (horol_t *p_instance, horol_clock_value_t *p_src)
 Set alarm clock. More...
 
int main (void)
 Main Function. More...
 
void irq_usb_uart_rx (BSPUsbUart uart)
 USB UART reception IRQ. More...
 
void irq_usb_uart_tx (BSPUsbUart uart)
 USB UART transmit IRQ. More...
 
void irq_usb_uart_err (BSPUsbUart uart)
 USB UART error IRQ. More...
 
void irq_timer (BSPTimer timer)
 Timer. More...
 
void irq_rtc (void)
 RTC IRQ. More...
 

Detailed Description

Function Documentation

§ horol_finalize()

void horol_finalize ( horol_t p_instance)

Finalize.

Parameters
p_instance:Instance Source Address.
Returns
-
Return values
-
Note
Parameter check isn't performed.
Attention
This function is not available in interrupt.

§ horol_get_current_clock()

void horol_get_current_clock ( horol_t p_instance,
horol_clock_value_t p_dst 
)

Get Current Clock Information.

Parameters
p_instance:Instance Source Address.
p_dst:Current Clock Destination Address.
Returns
-
Return values
-
Note
Parameter check isn't performed.
Attention
This function is not available in interrupt.
In progress, RTC Interrupt Disable.

§ horol_initialize()

horol_t * horol_initialize ( horol_initial_setting_t p_param)

Initialize.

Parameters
p_param:Initial Setting Information Source Address.
Returns
Instance Address.
Return values
(value!= NULL) :Valid value.
Note
Parameter check isn't performed.
When write data, use CaseA or CaseB or CaseC (Please refer to RTC datasheet).
CaseA :Use to 1Hz interrupt.
CaseB :Reset Counter.
CaseC :Disable Timer.
Attention
Singleton.
This function is not available in interrupt.

§ horol_irq_handler()

void horol_irq_handler ( horol_t p_instance)

IRQ Handler.

Parameters
p_instance:Instance Source Address.
Returns
-
Return values
-
Note
When read data, use CaseA or CaseB (Please refer to RTC datasheet).
CaseA :Read in 1Hz interrupt.
CaseB :Twice read.
This Sample uses CaseA(1Hz interrupt), so no need to twice read.

§ horol_make_anno_domini()

uint32_t horol_make_anno_domini ( uint8_t  century,
uint8_t  year 
)

Make A.D.

Parameters
century:Century.
year:Year.
Returns
A.D.
Return values
-
Note
-

§ horol_set_alarm_clock()

TXZ_Result horol_set_alarm_clock ( horol_t p_instance,
horol_clock_value_t p_src 
)

Set alarm clock.

Parameters
p_instance:Instance Source Address.
p_src:Current Clock Destination Address.
Returns
Result.
Return values
TXZ_SUCCESS:Success
TXZ_ERROR:Failure
Note
-

§ horol_start()

void horol_start ( horol_t p_instance)

Start.

Parameters
p_instance:Instance Source Address.
Returns
-
Return values
-
Note
Parameter check isn't performed.
Attention
This function is not available in interrupt.

§ horol_stop()

void horol_stop ( horol_t p_instance)

Stop.

Parameters
p_instance:Instance Source Address.
Returns
-
Return values
-
Note
Parameter check isn't performed.
Attention
This function is not available in interrupt.

§ irq_rtc()

void irq_rtc ( void  )

RTC IRQ.

Parameters
-
Returns
-
Return values
-
Note
This function is called BSP.

§ irq_timer()

void irq_timer ( BSPTimer  timer)

Timer.

Parameters
timer:Timer.
Returns
-
Return values
-
Note
This function is called BSP.

§ irq_usb_uart_err()

void irq_usb_uart_err ( BSPUsbUart  uart)

USB UART error IRQ.

Parameters
uart:USB UART.
Returns
-
Return values
-
Note
This function is called BSP.

§ irq_usb_uart_rx()

void irq_usb_uart_rx ( BSPUsbUart  uart)

USB UART reception IRQ.

Parameters
uart:USB UART.
Returns
-
Return values
-
Note
This function is called BSP.

§ irq_usb_uart_tx()

void irq_usb_uart_tx ( BSPUsbUart  uart)

USB UART transmit IRQ.

Parameters
uart:USB UART.
Returns
-
Return values
-
Note
This function is called BSP.

§ main()

int main ( void  )

Main Function.

Parameters
-
Returns
-
Return values
-
Note
-