iot_uart.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_UART_H_
#define _IOT_UART_H_

/* Standard includes. */
#include <stddef.h>
#include <stdint.h>

#define IOT_UART_BAUD_RATE_DEFAULT         ( 115200 )

#define IOT_UART_SUCCESS                   ( 0 ) 
#define IOT_UART_INVALID_VALUE             ( 1 ) 
#define IOT_UART_WRITE_FAILED              ( 2 ) 
#define IOT_UART_READ_FAILED               ( 3 ) 
#define IOT_UART_BUSY                      ( 4 ) 
#define IOT_UART_NOTHING_TO_CANCEL         ( 5 ) 
#define IOT_UART_FUNCTION_NOT_SUPPORTED    ( 6 ) 
typedef enum
{
    eUartCompleted = IOT_UART_SUCCESS,            
    eUartLastWriteFailed = IOT_UART_WRITE_FAILED, 
    eUartLastReadFailed = IOT_UART_READ_FAILED,   
} IotUARTOperationStatus_t;

typedef enum
{
    eUartParityNone,    
    eUartParityOdd,     
    eUartParityEven,    
} IotUARTParity_t;

typedef enum
{
    eUartStopBitsOne,   
    eUartStopBitsTwo,   
} IotUARTStopBits_t;

typedef void ( * IotUARTCallback_t )( IotUARTOperationStatus_t xStatus,
                                      void * pvUserContext );


struct                       IotUARTDescriptor_t;

typedef struct IotUARTDescriptor_t * IotUARTHandle_t;

typedef enum
{
    eUartSetConfig,  
    eUartGetConfig,  
    eGetTxNoOfbytes, 
    eGetRxNoOfbytes  
} IotUARTIoctlRequest_t;

typedef struct
{
    uint32_t ulBaudrate;            
    IotUARTParity_t xParity;        
    IotUARTStopBits_t xStopbits;    
    uint8_t ucWordlength;           
    uint8_t ucFlowControl;          
} IotUARTConfig_t;

IotUARTHandle_t iot_uart_open( int32_t lUartInstance );

void iot_uart_set_callback( IotUARTHandle_t const pxUartPeripheral,
                            IotUARTCallback_t xCallback,
                            void * pvUserContext );

int32_t iot_uart_read_sync( IotUARTHandle_t const pxUartPeripheral,
                            uint8_t * const pvBuffer,
                            size_t xBytes );

int32_t iot_uart_write_sync( IotUARTHandle_t const pxUartPeripheral,
                             uint8_t * const pvBuffer,
                             size_t xBytes );

int32_t iot_uart_read_async( IotUARTHandle_t const pxUartPeripheral,
                             uint8_t * const pvBuffer,
                             size_t xBytes );

int32_t iot_uart_write_async( IotUARTHandle_t const pxUartPeripheral,
                              uint8_t * const pvBuffer,
                              size_t xBytes );

int32_t iot_uart_ioctl( IotUARTHandle_t const pxUartPeripheral,
                        IotUARTIoctlRequest_t xUartRequest,
                        void * const pvBuffer );

int32_t iot_uart_cancel( IotUARTHandle_t const pxUartPeripheral );

int32_t iot_uart_close( IotUARTHandle_t const pxUartPeripheral );


/* end of group IOT_UART */
#endif /* _IOT_UART_H_ */