i2c.h

Go to the documentation of this file.

/*
 * Copyright 2018-2019 NXP
 * All rights reserved.
 *
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef __HAL_I2C_ADAPTER_H__
#define __HAL_I2C_ADAPTER_H__
 
/*******************************************************************************
 * Definitions
 ******************************************************************************/
#define HAL_I2C_MASTER_HANDLE_SIZE (80U)
 
#define HAL_I2C_SLAVE_HANDLE_SIZE (88U)
 
typedef enum _hal_i2c_status
{
    kStatus_HAL_I2cSuccess         = kStatus_Success,                      
    kStatus_HAL_I2cError           = MAKE_STATUS(kStatusGroup_HAL_I2C, 1), 
    kStatus_HAL_I2cBusy            = MAKE_STATUS(kStatusGroup_HAL_I2C, 2), 
    kStatus_HAL_I2cIdle            = MAKE_STATUS(kStatusGroup_HAL_I2C, 3), 
    kStatus_HAL_I2cNak             = MAKE_STATUS(kStatusGroup_HAL_I2C, 4), 
    kStatus_HAL_I2cArbitrationLost = MAKE_STATUS(kStatusGroup_HAL_I2C, 5), 
    kStatus_HAL_I2cTimeout         = MAKE_STATUS(kStatusGroup_HAL_I2C, 6), 
    kStatus_HAL_I2cAddrressNak     = MAKE_STATUS(kStatusGroup_HAL_I2C, 7), 
} hal_i2c_status_t;
 
typedef struct _hal_i2c_master_config
{
    uint32_t srcClock_Hz;  
    uint32_t baudRate_Bps; 
    bool enableMaster;     
    uint8_t instance;      
} hal_i2c_master_config_t;
 
typedef struct _hal_i2c_slave_config
{
    uint32_t srcClock_Hz;  
    uint16_t slaveAddress; 
    bool enableSlave;      
    uint8_t instance;      
} hal_i2c_slave_config_t;
 
typedef enum _hal_i2c_direction
{
    kHAL_I2cWrite = 0U, 
    kHAL_I2cRead  = 1U  
} hal_i2c_direction_t;
 
typedef enum _hal_i2c_master_transfer_flag
{
    kHAL_I2cTransferDefaultFlag = 0x0U,       
    kHAL_I2cTransferNoStartFlag = 0x1U,       
    kHAL_I2cTransferRepeatedStartFlag = 0x2U, 
    kHAL_I2cTransferNoStopFlag        = 0x4U, 
} hal_i2c_master_transfer_flag_t;
 
typedef enum _hal_i2c_slave_transfer_event
{
    kHAL_I2cSlaveAddressMatchEvent = 0x01U, 
    kHAL_I2cSlaveTransmitEvent     = 0x02U, 
    kHAL_I2cSlaveReceiveEvent = 0x04U,      
    kHAL_I2cSlaveTransmitAckEvent = 0x08U,  
    kHAL_I2cSlaveCompletionEvent  = 0x20U,  
    kHAL_I2cSlaveStartEvent       = 0x10U,  
    kHAL_I2cSlaveGenaralcallEvent = 0x40U,  
    kHAL_I2cSlaveAllEvents = kHAL_I2cSlaveAddressMatchEvent | kHAL_I2cSlaveTransmitEvent | kHAL_I2cSlaveReceiveEvent |
                             kHAL_I2cSlaveTransmitAckEvent | kHAL_I2cSlaveCompletionEvent | kHAL_I2cSlaveStartEvent |
                             kHAL_I2cSlaveGenaralcallEvent,
} hal_i2c_slave_transfer_event_t;
 
typedef struct _hal_i2c_master_transfer
{
    uint8_t *volatile data;        
    volatile size_t dataSize;      
    uint32_t flags;                
    uint32_t subaddress;           
    uint8_t subaddressSize;        
    uint8_t slaveAddress;          
    hal_i2c_direction_t direction; 
} hal_i2c_master_transfer_t;
 
typedef struct _hal_i2c_slave_transfer
{
    hal_i2c_slave_transfer_event_t event; 
    uint8_t *volatile data;               
    volatile size_t dataSize;             
    hal_i2c_status_t completionStatus;    
    size_t transferredCount; 
} hal_i2c_slave_transfer_t;
 
typedef void *hal_i2c_master_handle_t;
 
typedef void *hal_i2c_slave_handle_t;
 
#define HAL_I2C_MASTER_HANDLE_DEFINE(name) \
    uint32_t name[(HAL_I2C_MASTER_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t)]
 
#define HAL_I2C_SLAVE_HANDLE_DEFINE(name) \
    uint32_t name[(HAL_I2C_SLAVE_HANDLE_SIZE + sizeof(uint32_t) - 1U) / sizeof(uint32_t)]
 
typedef void (*hal_i2c_master_transfer_callback_t)(hal_i2c_master_handle_t handle,
                                                   hal_i2c_status_t completionStatus,
                                                   void *callbackParam);
 
typedef void (*hal_i2c_slave_transfer_callback_t)(hal_i2c_slave_handle_t handle,
                                                  hal_i2c_slave_transfer_t *transfer,
                                                  void *callbackParam);
 
/*******************************************************************************
 * API
 ******************************************************************************/
 
#if defined(__cplusplus)
extern "C" {
#endif /*_cplusplus. */
 
hal_i2c_status_t HAL_I2cMasterInit(hal_i2c_master_handle_t handle, const hal_i2c_master_config_t *config);
 
hal_i2c_status_t HAL_I2cSlaveInit(hal_i2c_slave_handle_t handle, const hal_i2c_slave_config_t *config);
 
hal_i2c_status_t HAL_I2cMasterDeinit(hal_i2c_master_handle_t handle);
 
hal_i2c_status_t HAL_I2cSlaveDeinit(hal_i2c_slave_handle_t handle);
 
hal_i2c_status_t HAL_I2cMasterWriteBlocking(hal_i2c_master_handle_t handle,
                                            const uint8_t *txBuff,
                                            size_t txSize,
                                            uint32_t flags);
 
hal_i2c_status_t HAL_I2cMasterReadBlocking(hal_i2c_master_handle_t handle,
                                           uint8_t *rxBuff,
                                           size_t rxSize,
                                           uint32_t flags);
 
hal_i2c_status_t HAL_I2cSlaveWriteBlocking(hal_i2c_slave_handle_t handle, const uint8_t *txBuff, size_t txSize);
 
hal_i2c_status_t HAL_I2cSlaveReadBlocking(hal_i2c_slave_handle_t handle, uint8_t *rxBuff, size_t rxSize);
 
hal_i2c_status_t HAL_I2cMasterTransferBlocking(hal_i2c_master_handle_t handle, hal_i2c_master_transfer_t *xfer);
 
hal_i2c_status_t HAL_I2cMasterTransferInstallCallback(hal_i2c_master_handle_t handle,
                                                      hal_i2c_master_transfer_callback_t callback,
                                                      void *callbackParam);
 
hal_i2c_status_t HAL_I2cMasterTransferNonBlocking(hal_i2c_master_handle_t handle, hal_i2c_master_transfer_t *xfer);
 
hal_i2c_status_t HAL_I2cMasterTransferGetCount(hal_i2c_master_handle_t handle, size_t *count);
 
hal_i2c_status_t HAL_I2cMasterTransferAbort(hal_i2c_master_handle_t handle);
 
hal_i2c_status_t HAL_I2cSlaveTransferInstallCallback(hal_i2c_slave_handle_t handle,
                                                     hal_i2c_slave_transfer_callback_t callback,
                                                     void *callbackParam);
 
hal_i2c_status_t HAL_I2cSlaveTransferNonBlocking(hal_i2c_slave_handle_t handle, uint32_t eventMask);
 
hal_i2c_status_t HAL_I2cSlaveTransferAbort(hal_i2c_slave_handle_t handle);
 
hal_i2c_status_t HAL_I2cSlaveTransferGetCount(hal_i2c_slave_handle_t handle, size_t *count);
 
#if defined(__cplusplus)
}
#endif /*_cplusplus. */
 
#endif /* __HAL_I2C_ADAPTER_H__*/