iot_reset.h

Go to the documentation of this file.

/*
 * Common IO - basic V1.0.0
 * Copyright (C) 2020 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
 */
 
#ifndef _IOT_RESET_H_
#define _IOT_RESET_H_
 
#include <stdint.h>
 
#define IOT_RESET_SUCCESS                   ( 0 )    
#define IOT_RESET_FUNCTION_NOT_SUPPORTED    ( 1 )    
#define IOT_RESET_INVALID_VALUE             ( 2 )    
typedef enum
{
    eResetPowerOnBoot, 
    eResetWarmBoot,    
    eResetColdBoot,    
    eResetWatchdog,    
    eResetBusTimeout,  
    eResetPmic,        
    eResetBrownOut,    
    eResetOther,       
} IotResetReason_t;
 
typedef enum
{
    eResetWarmBootFlag, 
    eResetColdBootFlag, 
} IotResetBootFlag_t;
 
void iot_reset_reboot( IotResetBootFlag_t xResetBootFlag );
 
int32_t iot_reset_shutdown( void );
 
int32_t iot_get_reset_reason( IotResetReason_t * xResetReason );
 
#endif /* ifndef _IOT_RESET_H_ */