/***************************************************************************//**
 *   @file   rtc.h
 *   @brief  Header of the RTC interface
 *   @author Andrei Drimbarean (andrei.drimbarean@analog.com)
********************************************************************************
 * 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.
*******************************************************************************/

#ifndef RTC_H_
#define RTC_H_

/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/

#include <stdint.h>

/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/

/**
 * @struct rtc_desc
 * @brief Structure holding RTC descriptor.
 */
struct rtc_desc {
	/** ID of the real time clock core. */
	uint8_t id;
	/** Frequency of the RTC */
	uint32_t freq;
	/** Load value of the RTC */
	uint32_t load;
	/** Device specific RTC parameters. */
	void *extra;
};

/**
 * @struct rtc_init_param
 * @brief Structure holding RTC initialization parameters.
 */
struct rtc_init_param {
	/** ID of the real time clock core. */
	uint8_t id;
	/** Frequency of the RTC */
	uint32_t freq;
	/** Load value of the RTC */
	uint32_t load;
	/** Device specific RTC parameters. */
	void *extra;
};

/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/

/** Initialize the RTC peripheral. */
int32_t rtc_init(struct rtc_desc **device, struct rtc_init_param *init_param);

/** Free the resources allocated by rtc_init(). */
int32_t rtc_remove(struct rtc_desc *dev);

/** Start the real time clock. */
int32_t rtc_start(struct rtc_desc *dev);

/** Stop the real time clock. */
int32_t rtc_stop(struct rtc_desc *dev);

/** Get the current count for the real time clock. */
int32_t rtc_get_cnt(struct rtc_desc *dev, uint32_t *tmr_cnt);

/** Set the current count for the real time clock. */
int32_t rtc_set_cnt(struct rtc_desc *dev, uint32_t tmr_cnt);

#endif /* RTC_H_ */
