iot_power.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_HAL_POWER_H_
#define _IOT_HAL_POWER_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#define IOT_POWER_SUCCESS                   ( 0 ) 
#define IOT_POWER_INVALID_VALUE             ( 1 ) 
#define IOT_POWER_NOT_INITIALIZED           ( 2 ) 
#define IOT_POWER_GET_FAILED                ( 3 ) 
#define IOT_POWER_SET_FAILED                ( 4 ) 
#define IOT_POWER_FUNCTION_NOT_SUPPORTED    ( 5 ) 
struct                        IotPowerDescriptor;
 
typedef struct IotPowerDescriptor * IotPowerHandle_t;
 
typedef enum
{
    eHighPowerPerfMode,        
    eNormalPowerPerfMode,      
    eLowPowerPerfMode,         
    eUnknownPowerMode = 0xFFFF 
} IotPowerMode_t;
 
typedef enum
{
    eIdleNoneMode,          
    eIdlePCMode,            
    eIdleClkSrcOffModeMode, 
    eIdleVddOffMode         
} IotPowerIdleMode_t;
 
typedef struct IotPowerWakeupSources
{
    uint8_t * pucWakeupSources; 
    uint16_t usLength;          
} IotPowerWakeupSources_t;
 
typedef enum IotPowerIoctlRequest
{
    eSetPCWakeThreshold,        
    eGetPCWakeThreshold,        
    eSetClkSrcOffWakeThreshold, 
    eGetClkSrcOffWakeThreshold, 
    eSetVddOffWakeThreshold,    
    eGetVddOffWakeThreshold,    
    eSetWakeupSources,          
    eGetWakeupSources,          
    eGetLastIdleMode            
} IotPowerIoctlRequest_t;
 
typedef void ( * IotPowerCallback_t )( bool bIdleState,
                                       void * pvUserContext );
 
IotPowerHandle_t iot_power_open( void );
 
int32_t iot_power_set_mode( IotPowerHandle_t const pxPowerHandle,
                            IotPowerMode_t xMode );
 
int32_t iot_power_reset_mode( IotPowerHandle_t const pxPowerHandle );
 
void iot_power_set_callback( IotPowerHandle_t const pxPowerHandle,
                             IotPowerCallback_t xCallback,
                             void * pvUserContext );
 
int32_t iot_power_ioctl( IotPowerHandle_t const pxPowerHandle,
                         IotPowerIoctlRequest_t xRequest,
                         void * const pvBuffer );
 
int32_t iot_power_get_mode( IotPowerHandle_t const pxPowerHandle,
                            IotPowerMode_t * xMode );
 
int32_t iot_power_close( IotPowerHandle_t const pxPowerHandle );
 
#endif /* ifndef _IOT_HAL_POWER_H_ */