iot_spi.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_SPI_H_
#define _IOT_SPI_H_
 
/* Standard includes. */
#include <stdint.h>
#include <stddef.h>
 
#define IOT_SPI_SUCCESS                   ( 0 ) 
#define IOT_SPI_INVALID_VALUE             ( 1 ) 
#define IOT_SPI_WRITE_FAILED              ( 2 ) 
#define IOT_SPI_READ_FAILED               ( 3 ) 
#define IOT_SPI_TRANSFER_ERROR            ( 4 ) 
#define IOT_SPI_BUS_BUSY                  ( 5 ) 
#define IOT_SPI_NOTHING_TO_CANCEL         ( 6 ) 
#define IOT_SPI_FUNCTION_NOT_SUPPORTED    ( 7 ) 
typedef enum
{
    eSPISuccess = IOT_SPI_SUCCESS,              
    eSPIWriteError = IOT_SPI_WRITE_FAILED,      
    eSPIReadError = IOT_SPI_READ_FAILED,        
    eSPITransferError = IOT_SPI_TRANSFER_ERROR, 
} IotSPITransactionStatus_t;
 
typedef enum
{
    eSPIMode0, 
    eSPIMode1, 
    eSPIMode2, 
    eSPIMode3, 
} IotSPIMode_t;
 
typedef enum
{
    eSPIMSBFirst, 
    eSPILSBFirst  
} IotSPIBitOrder_t;
 
typedef enum
{
    eSPISetMasterConfig, 
    eSPIGetMasterConfig, 
    eSPIGetTxNoOfbytes,  
    eSPIGetRxNoOfbytes,  
} IotSPIIoctlRequest_t;
 
typedef struct IotSPIMasterConfig
{
    uint32_t ulFreq;               
    IotSPIMode_t eMode;            
    IotSPIBitOrder_t eSetBitOrder; 
    uint8_t ucDummyValue;          
} IotSPIMasterConfig_t;
 
struct                      IotSPIDescriptor;
 
typedef struct IotSPIDescriptor * IotSPIHandle_t;
 
typedef void (* IotSPICallback_t) ( IotSPITransactionStatus_t xStatus,
                                    void * pvSPIparam );
 
IotSPIHandle_t iot_spi_open( int32_t lSPIInstance );
 
void iot_spi_set_callback( IotSPIHandle_t const pxSPIPeripheral,
                           IotSPICallback_t xCallback,
                           void * pvUserContext );
 
int32_t iot_spi_ioctl( IotSPIHandle_t const pxSPIPeripheral,
                       IotSPIIoctlRequest_t xSPIRequest,
                       void * const pvBuffer );
 
int32_t iot_spi_read_sync( IotSPIHandle_t const pxSPIPeripheral,
                           uint8_t * const pvBuffer,
                           size_t xBytes );
 
int32_t iot_spi_read_async( IotSPIHandle_t const pxSPIPeripheral,
                            uint8_t * const pvBuffer,
                            size_t xBytes );
 
int32_t iot_spi_write_sync( IotSPIHandle_t const pxSPIPeripheral,
                            uint8_t * const pvBuffer,
                            size_t xBytes );
 
int32_t iot_spi_write_async( IotSPIHandle_t const pxSPIPeripheral,
                             uint8_t * const pvBuffer,
                             size_t xBytes );
 
int32_t iot_spi_transfer_sync( IotSPIHandle_t const pxSPIPeripheral,
                               uint8_t * const pvTxBuffer,
                               uint8_t * const pvRxBuffer,
                               size_t xBytes );
 
int32_t iot_spi_transfer_async( IotSPIHandle_t const pxSPIPeripheral,
                                uint8_t * const pvTxBuffer,
                                uint8_t * const pvRxBuffer,
                                size_t xBytes );
 
int32_t iot_spi_close( IotSPIHandle_t const pxSPIPeripheral );
 
int32_t iot_spi_cancel( IotSPIHandle_t const pxSPIPeripheral );
 
int32_t iot_spi_select_slave( int32_t lSPIInstance,
                              int32_t lSPISlave );
 
/* end of group iot_spi */
 
#endif /* _IOT_SPI_H_ */