iot_i2c.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_I2C_H_
#define _IOT_I2C_H_

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

#define IOT_I2C_STANDARD_MODE_BPS         ( 100000 )  
#define IOT_I2C_FAST_MODE_BPS             ( 400000 )  
#define IOT_I2C_FAST_MODE_PLUS_BPS        ( 1000000 ) 
#define IOT_I2C_HIGH_SPEED_BPS            ( 3400000 ) 
#define IOT_I2C_SUCCESS                   ( 0 )     
#define IOT_I2C_INVALID_VALUE             ( 1 )     
#define IOT_I2C_BUSY                      ( 2 )     
#define IOT_I2C_WRITE_FAILED              ( 3 )     
#define IOT_I2C_READ_FAILED               ( 4 )     
#define IOT_I2C_NACK                      ( 5 )     
#define IOT_I2C_BUS_TIMEOUT               ( 6 )     
#define IOT_I2C_NOTHING_TO_CANCEL         ( 7 )     
#define IOT_I2C_FUNCTION_NOT_SUPPORTED    ( 8 )     
#define IOT_I2C_SLAVE_ADDRESS_NOT_SET     ( 9 )     
typedef enum
{
    eI2CBusIdle = 0,            
    eI2cBusBusy = IOT_I2C_BUSY, 
} IotI2CBusStatus_t;

typedef enum
{
    eI2CCompleted = IOT_I2C_SUCCESS,         
    eI2CDriverFailed,                        
    eI2CNackFromSlave = IOT_I2C_NACK,        
    eI2CMasterTimeout = IOT_I2C_BUS_TIMEOUT, 
} IotI2COperationStatus_t;

typedef struct IotI2CConfig
{
    uint32_t ulMasterTimeout; 
    uint32_t ulBusFreq;       
} IotI2CConfig_t;

typedef enum
{
    eI2CSendNoStopFlag,  
    eI2CSetSlaveAddr,    
    eI2CSetMasterConfig, 
    eI2CGetMasterConfig, 
    eI2CGetBusState,     
    eI2CBusReset,        
    eI2CGetTxNoOfbytes,  
    eI2CGetRxNoOfbytes,  
} IotI2CIoctlRequest_t;

struct                    IotI2CDescriptor;

typedef struct IotI2CDescriptor * IotI2CHandle_t;

typedef void (* IotI2CCallback_t) ( IotI2COperationStatus_t xOpStatus,
                                    void * pvUserContext );

IotI2CHandle_t iot_i2c_open( int32_t lI2CInstance );

void iot_i2c_set_callback( IotI2CHandle_t const pxI2CPeripheral,
                           IotI2CCallback_t xCallback,
                           void * pvUserContext );

int32_t iot_i2c_read_sync( IotI2CHandle_t const pxI2CPeripheral,
                           uint8_t * const pucBuffer,
                           size_t xBytes );

int32_t iot_i2c_write_sync( IotI2CHandle_t const pxI2CPeripheral,
                            uint8_t * const pucBuffer,
                            size_t xBytes );

int32_t iot_i2c_read_async( IotI2CHandle_t const pxI2CPeripheral,
                            uint8_t * const pucBuffer,
                            size_t xBytes );

int32_t iot_i2c_write_async( IotI2CHandle_t const pxI2CPeripheral,
                             uint8_t * const pucBuffer,
                             size_t xBytes );

int32_t iot_i2c_ioctl( IotI2CHandle_t const pxI2CPeripheral,
                       IotI2CIoctlRequest_t xI2CRequest,
                       void * const pvBuffer );


int32_t iot_i2c_close( IotI2CHandle_t const pxI2CPeripheral );

int32_t iot_i2c_cancel( IotI2CHandle_t const pxI2CPeripheral );

/* end of group iot_i2c */

#endif /* ifndef _IOT_I2C_H_ */