iot_watchdog.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_watchdog.h
 *
 * @brief HAL APIs for WatchDog driver
 *******************************************************************************
 */

#ifndef _IOT_WATCHDOG_H_
#define _IOT_WATCHDOG_H_

#define IOT_WATCHDOG_SUCCESS                    ( 0 )    
#define IOT_WATCHDOG_INVALID_VALUE              ( 1 )    
#define IOT_WATCHDOG_TIME_NOT_SET               ( 2 )    
#define IOT_WATCHDOG_FUNCTION_NOT_SUPPORTED     ( 3 )    
typedef enum
{
    eWatchdogTimerStopped,     
    eWatchdogTimerRunning,     
    eWatchdogTimerBarkExpired, 
    eWatchdogTimerBiteExpired  
} IotWatchdogStatus_t;

typedef enum
{
    eWatchdogBiteTimerReset,    
    eWatchdogBiteTimerInterrupt 
} IotWatchdogBiteConfig_t;

struct                           IotWatchdogDescriptor;

typedef struct IotWatchdogDescriptor   * IotWatchdogHandle_t;

typedef enum
{
    eSetWatchdogBarkTime,     
    eGetWatchdogBarkTime,     
    eSetWatchdogBiteTime,     
    eGetWatchdogBiteTime,     
    eGetWatchdogStatus,       
    eSetWatchdogBiteBehaviour 
} IotWatchdogIoctlRequest_t;

typedef void (* IotWatchdogCallback_t)( void * pvUserContext );

IotWatchdogHandle_t iot_watchdog_open( int32_t lWatchdogInstance );

int32_t iot_watchdog_start( IotWatchdogHandle_t const pxWatchdogHandle );

int32_t iot_watchdog_stop( IotWatchdogHandle_t const pxWatchdogHandle );

int32_t iot_watchdog_restart( IotWatchdogHandle_t const pxWatchdogHandle );

void iot_watchdog_set_callback( IotWatchdogHandle_t const pxWatchdogHandle,
                                IotWatchdogCallback_t xCallback,
                                void * pvUserContext );

int32_t iot_watchdog_ioctl( IotWatchdogHandle_t const pxWatchdogHandle,
                            IotWatchdogIoctlRequest_t xRequest,
                            void * const pvBuffer );

int32_t iot_watchdog_close( IotWatchdogHandle_t const pxWatchdogHandle );

#endif /* ifndef _IOT_WATCHDOG_H_ */