no-OS
Functions
rtc.c File Reference

Implementation of RTC driver for ADuCM302x. More...

#include <stdlib.h>
#include "error.h"
#include "rtc.h"
#include "rtc_extra.h"
#include "irq.h"
Include dependency graph for rtc.c:

Functions

int32_t rtc_init (struct rtc_desc **device, struct rtc_init_param *init_param)
 Initialize the RTC peripheral. More...
 
int32_t rtc_remove (struct rtc_desc *dev)
 Free the resources allocated by rtc_init(). More...
 
int32_t rtc_start (struct rtc_desc *dev)
 Start the real time clock. More...
 
int32_t rtc_stop (struct rtc_desc *dev)
 Stop the real time clock. More...
 
int32_t rtc_get_cnt (struct rtc_desc *dev, uint32_t *tmr_cnt)
 Get the current count for the real time clock. More...
 
int32_t rtc_set_cnt (struct rtc_desc *dev, uint32_t tmr_cnt)
 Set the current count for the real time clock. More...
 

Detailed Description

Implementation of RTC driver for ADuCM302x.

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:

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

◆ rtc_get_cnt()

int32_t rtc_get_cnt ( struct rtc_desc dev,
uint32_t *  tmr_cnt 
)

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
SUCCESS in case of success, FAILURE otherwise.

◆ rtc_init()

int32_t rtc_init ( struct rtc_desc **  device,
struct rtc_init_param init_param 
)

Initialize the RTC peripheral.

Parameters
device- The RTC descriptor.
init_param- The structure that contains the RTC initialization.
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ rtc_remove()

int32_t rtc_remove ( struct rtc_desc dev)

Free the resources allocated by rtc_init().

Parameters
dev- The RTC descriptor.
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ rtc_set_cnt()

int32_t rtc_set_cnt ( struct rtc_desc dev,
uint32_t  tmr_cnt 
)

Set the current count for the real time clock.

Parameters
dev- The RTC descriptor.
tmr_cnt- New value of the timer counter.
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ rtc_start()

int32_t rtc_start ( struct rtc_desc dev)

Start the real time clock.

Parameters
dev- The RTC descriptor.
Returns
SUCCESS in case of success, FAILURE otherwise.

◆ rtc_stop()

int32_t rtc_stop ( struct rtc_desc dev)

Stop the real time clock.

Parameters
dev- The RTC descriptor.
Returns
SUCCESS in case of success, FAILURE otherwise.