iot_gpio.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
 */

#ifndef _IOT_GPIO_H_
#define _IOT_GPIO_H_

#define IOT_GPIO_SUCCESS                   ( 0 )    
#define IOT_GPIO_INVALID_VALUE             ( 1 )    
#define IOT_GPIO_READ_FAILED               ( 2 )    
#define IOT_GPIO_WRITE_FAILED              ( 3 )    
#define IOT_GPIO_FUNCTION_NOT_SUPPORTED    ( 4 )    
typedef enum
{
    eGpioDirectionInput,    
    eGpioDirectionOutput    
} IotGpioDirection_t;

typedef enum
{
    eGpioOpenDrain,         
    eGpioPushPull           
} IotGpioOutputMode_t;

typedef enum
{
    eGpioPullNone,          
    eGpioPullUp,            
    eGpioPullDown           
} IotGpioPull_t;

typedef enum
{
    eGpioInterruptNone,     
    eGpioInterruptRising,   
    eGpioInterruptFalling,  
    eGpioInterruptEdge,     
    eGpioInterruptLow,      
    eGpioInterruptHigh,     
} IotGpioInterrupt_t;

typedef enum
{
    eSetGpioFunction,       
    eSetGpioDirection,      
    eSetGpioPull,           
    eSetGpioOutputMode,     
    eSetGpioInterrupt,      
    eSetGpioSpeed,          
    eSetGpioDriveStrength,  
    eGetGpioFunction,       
    eGetGpioDirection,      
    eGetGpioPull,           
    eGetGpioOutputType,     
    eGetGpioInterrupt,      
    eGetGpioSpeed,          
    eGetGpioDriveStrength   
} IotGpioIoctlRequest_t;

struct                  IotGpioDescriptor;

typedef struct IotGpioDescriptor * IotGpioHandle_t;

typedef void ( * IotGpioCallback_t )( uint8_t ucPinState,
                                      void * pvUserContext );

IotGpioHandle_t iot_gpio_open( int32_t lGpioNumber );

void iot_gpio_set_callback( IotGpioHandle_t const pxGpio,
                            IotGpioCallback_t xGpioCallback,
                            void * pvUserContext );

int32_t iot_gpio_read_sync( IotGpioHandle_t const pxGpio,
                            uint8_t * pucPinState );

int32_t iot_gpio_write_sync( IotGpioHandle_t const pxGpio,
                             uint8_t ucPinState );

int32_t iot_gpio_close( IotGpioHandle_t const pxGpio );

int32_t iot_gpio_ioctl( IotGpioHandle_t const pxGpio,
                        IotGpioIoctlRequest_t xRequest,
                        void * const pvBuffer );

#endif /* _IOT_GPIO_H_ */