iot_timer.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_timer.h
 *
 * @brief HAL APIs for a generic timer driver
 *******************************************************************************
 */

#ifndef _IOT_TIMER_H_
#define _IOT_TIMER_H_

#define IOT_TIMER_SUCCESS                   ( 0 )    
#define IOT_TIMER_INVALID_VALUE             ( 1 )    
#define IOT_TIMER_FUNCTION_NOT_SUPPORTED    ( 2 )    
#define IOT_TIMER_NOT_RUNNING               ( 3 )    
#define IOT_TIMER_SET_FAILED                ( 4 )    
struct                        IotTimerDescriptor;

typedef struct IotTimerDescriptor   * IotTimerHandle_t;

typedef void ( * IotTimerCallback_t)( void * pvUserContext );

IotTimerHandle_t iot_timer_open( int32_t lTimerInstance );

void iot_timer_set_callback( IotTimerHandle_t const pxTimerHandle,
                             IotTimerCallback_t xCallback,
                             void * pvUserContext );

int32_t iot_timer_start( IotTimerHandle_t const pxTimerHandle );

int32_t iot_timer_stop( IotTimerHandle_t const pxTimerHandle );

int32_t iot_timer_get_value( IotTimerHandle_t const pxTimerHandle,
                             uint64_t * ullMicroSeconds );

int32_t iot_timer_delay( IotTimerHandle_t const pxTimerHandle,
                         uint32_t ulDelayMicroSeconds );

int32_t iot_timer_cancel( IotTimerHandle_t const pxTimerHandle );

int32_t iot_timer_close( IotTimerHandle_t const pxTimerHandle );

#endif /* ifndef _IOT_TIMER_H_ */