hal_rtc.h

/* Copyright Statement:
 *
 * (C) 2005-2017 MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __HAL_RTC_H__
#define __HAL_RTC_H__
#include "hal_platform.h"

#ifdef HAL_RTC_MODULE_ENABLED

#ifdef HAL_RTC_FEATURE_TIME_CALLBACK

#else

#endif

#ifdef HAL_RTC_FEATURE_TIME_CALLBACK

#else

#endif

#ifdef HAL_RTC_FEATURE_TIME_CALLBACK

#endif

#ifdef HAL_RTC_FEATURE_SLEEP

#endif



#ifdef __cplusplus
extern "C" {
#endif

#ifdef HAL_RTC_FEATURE_SLEEP

#define HAL_RTC_SLEEP_MAGIC      (0xBABEBABE)
#endif

typedef enum {
    HAL_RTC_STATUS_ERROR = -2,                              
    HAL_RTC_STATUS_INVALID_PARAM = -1,                      
    HAL_RTC_STATUS_OK = 0                                   
} hal_rtc_status_t;

#ifdef HAL_RTC_FEATURE_TIME_CALLBACK

typedef void (*hal_rtc_time_callback_t)(void *user_data);
#endif

typedef void (*hal_rtc_alarm_callback_t)(void *user_data);

hal_rtc_status_t hal_rtc_init(void);

hal_rtc_status_t hal_rtc_deinit(void);

hal_rtc_status_t hal_rtc_set_time(const hal_rtc_time_t *time);

hal_rtc_status_t hal_rtc_get_time(hal_rtc_time_t *time);

#ifdef HAL_RTC_FEATURE_TIME_CALLBACK

hal_rtc_status_t hal_rtc_set_time_notification_period(hal_rtc_time_notification_period_t period);
#endif

hal_rtc_status_t hal_rtc_set_alarm(const hal_rtc_time_t *time);

hal_rtc_status_t hal_rtc_get_alarm(hal_rtc_time_t *time);

hal_rtc_status_t hal_rtc_enable_alarm(void);

hal_rtc_status_t hal_rtc_disable_alarm(void);

#ifdef HAL_RTC_FEATURE_TIME_CALLBACK

hal_rtc_status_t hal_rtc_set_time_callback(hal_rtc_time_callback_t callback_function, void *user_data);
#endif

#ifdef HAL_RTC_FEATURE_SLEEP

hal_rtc_status_t hal_rtc_sleep(uint32_t magic);
#endif

hal_rtc_status_t hal_rtc_set_alarm_callback(const hal_rtc_alarm_callback_t callback_function, void *user_data);

#ifdef HAL_RTC_FEATURE_CALIBRATION

hal_rtc_status_t hal_rtc_set_one_shot_calibration(int16_t ticks);

hal_rtc_status_t hal_rtc_get_one_shot_calibration(int16_t *ticks);

hal_rtc_status_t hal_rtc_set_repeat_calibration(int16_t ticks_per_8_seconds);

hal_rtc_status_t hal_rtc_get_repeat_calibration(int16_t *ticks_per_8_seconds);
#endif

hal_rtc_status_t hal_rtc_set_data(uint16_t offset, const char *buf, uint16_t len);

hal_rtc_status_t hal_rtc_get_data(uint16_t offset, char *buf, uint16_t len);

hal_rtc_status_t hal_rtc_clear_data(uint16_t offset, uint16_t len);

hal_rtc_status_t hal_rtc_get_f32k_frequency(uint32_t *frequency);

#ifdef HAL_RTC_FEATURE_RETENTION_SRAM

hal_rtc_status_t hal_rtc_retention_sram_config(uint32_t mask, hal_rtc_sram_mode_t mode);

hal_rtc_status_t hal_rtc_enter_retention_mode(void);

void hal_rtc_exit_retention_mode(void);
#endif

#ifdef HAL_RTC_FEATURE_ELAPSED_TICK

hal_rtc_status_t hal_rtc_get_elapsed_tick(bool is_after_sleep, uint32_t *elapsed_tick);
#endif

#ifdef __cplusplus
}
#endif

#endif /*HAL_RTC_MODULE_ENABLED*/
#endif /*__HAL_RTC_H__*/