no_os_rtc.h File Reference

Header of the RTC interface. More...

#include <stdint.h>

Include dependency graph for no_os_rtc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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. More...
int32_t	no_os_rtc_remove (struct no_os_rtc_desc *dev)
	Free the resources allocated by no_os_rtc_init(). More...
int32_t	no_os_rtc_start (struct no_os_rtc_desc *dev)
	Start the real time clock. More...
int32_t	no_os_rtc_stop (struct no_os_rtc_desc *dev)
	Stop the real time clock. More...
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. More...
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. More...
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. More...

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.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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.

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

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.

Here is the caller graph for this function: