no_os_rtc.h File Reference

Header of the RTC interface. More...

#include <stdint.h>

Include dependency graph for no_os_rtc.h:

Classes
struct	no_os_rtc_desc
	Structure holding RTC descriptor. More...
struct	no_os_rtc_init_param
	Structure holding RTC initialization parameters. More...

Functions
int32_t	no_os_rtc_init (struct no_os_rtc_desc **device, struct no_os_rtc_init_param *init_param)
	Initialize the RTC peripheral.
int32_t	no_os_rtc_remove (struct no_os_rtc_desc *dev)
	Free the resources allocated by no_os_rtc_init().
int32_t	no_os_rtc_start (struct no_os_rtc_desc *dev)
	Start the real time clock.
int32_t	no_os_rtc_stop (struct no_os_rtc_desc *dev)
	Stop the real time clock.
int32_t	no_os_rtc_get_cnt (struct no_os_rtc_desc *dev, uint32_t *tmr_cnt)
	Get the current count for the real time clock.
int32_t	no_os_rtc_set_cnt (struct no_os_rtc_desc *dev, uint32_t tmr_cnt)
	Set the current count for the real time clock.
int32_t	no_os_rtc_set_irq_time (struct no_os_rtc_desc *dev, uint32_t irq_time)
	Set the current count for the real time clock.

Detailed Description

Header of the RTC interface.

Author

Andrei Drimbarean (andre.nosp@m.i.dr.nosp@m.imbar.nosp@m.ean@.nosp@m.analo.nosp@m.g.co.nosp@m.m)

Copyright 2020(c) Analog Devices, Inc.

SPDX-License-Identifier: BSD-3-Clause

Function Documentation

no_os_rtc_get_cnt()

int32_t no_os_rtc_get_cnt	(	struct no_os_rtc_desc *	dev,
		uint32_t *	tmr_cnt )

Get the current count for the real time clock.

Get the current count for the real time clock.

Parameters

dev	- The RTC descriptor.
tmr_cnt	- Pointer where the read counter will be stored.

Returns

0 in case of success, -1 otherwise.

Parameters

dev	- The RTC descriptor.
tmr_cnt	- Pointer where the read counter will be stored.

Returns

0 in case of success, errno codes otherwise.

no_os_rtc_init()

int32_t no_os_rtc_init	(	struct no_os_rtc_desc **	device,
		struct no_os_rtc_init_param *	init_param )

Initialize the RTC peripheral.

Initialize the RTC peripheral.

Parameters

device	- The RTC descriptor.
init_param	- The structure that contains the RTC initialization.

Returns

0 in case of success, -1 otherwise.

Parameters

device	- The RTC descriptor.
init_param	- The structure that contains the RTC initialization.

Returns

0 in case of success, errno codes otherwise.

no_os_rtc_remove()

int32_t no_os_rtc_remove

(

struct no_os_rtc_desc *

dev

)

Free the resources allocated by no_os_rtc_init().

Free the resources allocated by no_os_rtc_init().

Parameters

dev	- The RTC descriptor.

Returns

0 in case of success, -1 otherwise.

Parameters

dev	- The RTC descriptor.

Returns

0 in case of success, errno codes otherwise.

no_os_rtc_set_cnt()

int32_t no_os_rtc_set_cnt	(	struct no_os_rtc_desc *	dev,
		uint32_t	tmr_cnt )

Set the current count for the real time clock.

Set the current count for the real time clock.

Parameters

dev	- The RTC descriptor.
tmr_cnt	- New value of the timer counter.

Returns

0 in case of success, -1 otherwise.

Parameters

dev	- The RTC descriptor.
tmr_cnt	- New value of the timer counter.

Returns

0 in case of success, errno codes otherwise.

no_os_rtc_set_irq_time()

int32_t no_os_rtc_set_irq_time	(	struct no_os_rtc_desc *	dev,
		uint32_t	irq_time )

Set the current count for the real time clock.

Set the time at which an interrupt will occur

Parameters

dev	- The RTC descriptor.
irq_time	- The number of seconds at which the interrupt must occur.

Returns

0

no_os_rtc_start()

int32_t no_os_rtc_start

(

struct no_os_rtc_desc *

dev

)

Start the real time clock.

Start the real time clock.

Parameters

dev	- The RTC descriptor.

Returns

0 in case of success, -1 otherwise.

Parameters

dev	- The RTC descriptor.

Returns

0 in case of success, errno codes otherwise.

no_os_rtc_stop()

int32_t no_os_rtc_stop

(

struct no_os_rtc_desc *

dev

)

Stop the real time clock.

Stop the real time clock.

Parameters

dev	- The RTC descriptor.

Returns

0 in case of success, -1 otherwise.

Parameters

dev	- The RTC descriptor.

Returns

0 in case of success, errno codes otherwise.