sdk-ameba-v4.0c_180328/component/common/mbed/hal/rtc_api.h

/** mbed Microcontroller Library
  ******************************************************************************
  * @file    rtc_api.h
  * @author 
  * @version V1.0.0
  * @brief   This file provides mbed RTC API
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2006-2013 ARM Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  ****************************************************************************** 
  */
#ifndef MBED_RTC_API_H
#define MBED_RTC_API_H

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

#ifdef __cplusplus
extern "C" {
#endif

/** @addtogroup rtc RTC
 *  @ingroup    hal
 *  @brief      rtc functions
 *  @{
 */

#if CONFIG_PLATFORM_8711B
///@name AmebaZ Only 
///@{
typedef void (*alarm_irq_handler)(void);

struct alarm_s {
	uint32_t yday;//which day of the year
	uint32_t hour;
	uint32_t min;
	uint32_t sec;
};

typedef struct alarm_s alarm_t;
///@}
#endif //CONFIG_PLATFORM_8711B

///@name Ameba Common
///@{

/**
  * @brief  Initializes the RTC device, include clock, RTC registers and function.
  * @param  none
  * @retval none
  */
void rtc_init(void);

/**
  * @brief  Deinitializes the RTC device.
  * @param  none
  * @retval none
  */
void rtc_free(void);

/**
  * @brief  This function tells whether RTC is enabled or not.
  * @param  none
  * @retval 1: RTC is enable.
  * @retval 0: RTC is disable.
  */
int rtc_isenabled(void);

/**
  * @brief  Get current timestamp in seconds from RTC.
  * @param  none
  * @retval : The current timestamp in seconds which is calculated from 1970.1.1 00:00:00.
  */
time_t rtc_read(void);

/**
  * @brief  Set the specified timestamp in seconds to RTC.
  * @param  t: Seconds from 1970.1.1 00:00:00 to specified data and time which is to be set.
  * @retval  none
  */
void rtc_write(time_t t);

///@}

#if CONFIG_PLATFORM_8711B
///@name AmebaZ Only 
///@{
/**
  * @brief  Set the specified RTC Alarm and interrupt.
  * @param  alarm: alarm object define in application software.
  * @param  alarmHandler:  alarm interrupt callback function.
  * @retval   status:
  *            - 1: success
  *            - Others: failure
  */
u32 rtc_set_alarm(alarm_t *alrm, alarm_irq_handler alarmHandler);

/**
  * @brief  Disable RTC Alarm and function.
  * @param  none
  * @retval   none
  */
void rtc_disable_alarm(void);
///@}
#endif //CONFIG_PLATFORM_8711B

/*\@}*/

#ifdef __cplusplus
}
#endif

#endif