iot_rtc.h

Go to the documentation of this file.

/*
 * FreeRTOS Common IO V1.0.0
 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

/*******************************************************************************
 * @file iot_rtc.h
 *
 * @brief HAL APIs for RTC
 *******************************************************************************
 */

#ifndef _IOT_RTC_H_
#define _IOT_RTC_H_

#define IOT_RTC_SUCCESS                   ( 0 )    
#define IOT_RTC_INVALID_VALUE             ( 1 )    
#define IOT_RTC_NOT_STARTED               ( 2 )    
#define IOT_RTC_GET_FAILED                ( 3 )    
#define IOT_RTC_SET_FAILED                ( 4 )    
#define IOT_RTC_FUNCTION_NOT_SUPPORTED    ( 5 )    
typedef enum
{
    eRtcTimerStopped,              
    eRtcTimerRunning,              
    eRtcTimerAlarmTriggered,       
    eRtcTimerWakeupTriggered,      
} IotRtcStatus_t;

typedef struct IotRtcDatetime
{
    uint8_t ucSecond; 
    uint8_t ucMinute; 
    uint8_t ucHour;   
    uint8_t ucDay;    
    uint8_t ucMonth;  
    uint16_t usYear;  
    uint8_t ucWday;   
} IotRtcDatetime_t;

typedef enum IotRtcIoctlRequest
{
    eSetRtcAlarm,       
    eGetRtcAlarm,       
    eCancelRtcAlarm,    
    eSetRtcWakeupTime,  
    eGetRtcWakeupTime,  
    eCancelRtcWakeup,   
    eGetRtcStatus       
} IotRtcIoctlRequest_t;

struct                      IotRtcDescriptor_t;

typedef struct IotRtcDescriptor_t   * IotRtcHandle_t;

typedef void ( * IotRtcCallback_t)( IotRtcStatus_t xStatus, void * pvUserContext );

IotRtcHandle_t iot_rtc_open( int32_t lRtcInstance );

void iot_rtc_set_callback( IotRtcHandle_t const pxRtcHandle,
                           IotRtcCallback_t xCallback,
                           void * pvUserContext );

int32_t iot_rtc_ioctl( IotRtcHandle_t const pxRtcHandle,
                       IotRtcIoctlRequest_t xRequest,
                       void * const pvBuffer );

int32_t iot_rtc_set_datetime( IotRtcHandle_t const pxRtcHandle,
                              const IotRtcDatetime_t * pxDatetime );

int32_t iot_rtc_get_datetime( IotRtcHandle_t const pxRtcHandle,
                              IotRtcDatetime_t * pxDatetime );

int32_t iot_rtc_close( IotRtcHandle_t const pxRtcHandle );

#endif /* ifndef _IOT_RTC_H_ */