/**
 * @file    wm_rtc.h
 *
 * @brief   rtc Driver Module
 *
 * @author  dave
 *
 * Copyright (c) 2014 Winner Microelectronics Co., Ltd.
 */
#ifndef WM_RTC_H
#define WM_RTC_H

#include <time.h>
#include "wm_type_def.h"

/** rtc interrupt callback */
typedef void (*tls_rtc_irq_callback)(void *arg);

/**
 * @defgroup Driver_APIs Driver APIs
 * @brief Driver APIs
 */

/**
 * @addtogroup Driver_APIs
 * @{
 */

/**
 * @defgroup RTC_Driver_APIs RTC Driver APIs
 * @brief RTC driver APIs
 */

/**
 * @addtogroup RTC_Driver_APIs
 * @{
 */

/**
 * @brief          This function is used to set pmu rtc time
 *
 * @param[in]      tblock    time value
 *
 * @return         None
 *
 * @note           None
 */
void tls_set_rtc(struct tm *tblock);

/**
 * @brief          This function is used to get pmu rtc time
 *
 * @param[out]     tblock    time value
 *
 * @return         None
 *
 * @note           None
 */
void tls_get_rtc(struct tm *tblock);

/** NOT PART OF THE OFFICIAL SDK **/
/**
 * @brief Checks if the RTC peripheral is running or not
 * 
 * @return true 
 * @return false 
 */
bool tls_is_rtc_running(void);
/**********************************/

/**
 * @brief          This function is used to register pmu rtc interrupt
 *
 * @param[in]      callback    the rtc interrupt call back function
 * @param[in]      arg         parameter of call back function
 *
 * @return         None
 *
 * @note
 * User does not need to clear the interrupt flag.
 * Rtc callback function is called in interrupt,
 * so do not operate the critical data in the callback fuuction.
 * Sending messages to other tasks to handle is recommended.
 */
void tls_rtc_isr_register(tls_rtc_irq_callback callback, void *arg);

/**
 * @brief          This function is used to start pmu rtc timer
 *
 * @param[in]      tblock    timer value
 *
 * @return         None
 *
 * @note           None
 */
void tls_rtc_timer_start(struct tm *tblock);

/**
 * @brief          This function is used to stop pmu rtc timer
 *
 * @param          None
 *
 * @return         None
 *
 * @note           This function also is used to clear rtc timer interrupt
 */
void tls_rtc_timer_stop(void);


/**
 * @}
 */

/**
 * @}
 */

#endif