i2c.h

Go to the documentation of this file.

 
#ifndef _I2C_H
#define _I2C_H
 
#include "hal_types.h"
 
#define TX_MESSAGE_MAX_LENGTH 1024
#define RX_MESSAGE_MAX_LENGTH 1024
 
typedef enum {
    _HAL_I2C_TXN_STATE_MIN = 0,                         
    HAL_I2C_TXN_STATE_CREATED = _HAL_I2C_TXN_STATE_MIN, 
    HAL_I2C_TXN_STATE_QUEUED,                           
    HAL_I2C_TXN_STATE_PROCESSING,                       
    HAL_I2C_TXN_STATE_COMPLETED,                        
    _HAL_I2C_TXN_STATE_MAX                              
} hal_i2c_txn_state_t;
 
typedef enum {
    _HAL_I2C_OP_MIN = 0,                
    HAL_I2C_OP_WRITE = _HAL_I2C_OP_MIN, 
    HAL_I2C_OP_READ,                    
    HAL_I2C_OP_WRITE_READ,              
    _HAL_I2C_OP_MAX                     
} hal_i2c_op_t;
 
typedef enum {
    _HAL_I2C_TXN_RESULT_MIN = 0,                       
    HAL_I2C_TXN_RESULT_NONE = _HAL_I2C_TXN_RESULT_MIN, 
    HAL_I2C_TXN_RESULT_SUCCESS,                        
    HAL_I2C_TXN_RESULT_FAIL,                           
    _HAL_I2C_TX_RESULT_MAX                             
} hal_i2c_txn_result_t;
 
typedef struct {
    // Immutable input. Can not change once transaction has been submitted.
    uint8_t target_addr;                     
    hal_i2c_op_t i2c_op;                     
    uint8_t tx_data[TX_MESSAGE_MAX_LENGTH];  
    size_t expected_bytes_to_tx;             
    size_t expected_bytes_to_rx;             
    // Poll to determine when transaction has been completed.
    hal_i2c_txn_state_t processing_state;    
    // Results of the transaction. Only valid once processing_state == COMPLETED.
    // Initialize to prescribed values when submitting transaction.
    hal_i2c_txn_result_t transaction_result; 
    size_t actual_bytes_received;            
    size_t actual_bytes_transmitted;         
    uint8_t rx_data[RX_MESSAGE_MAX_LENGTH];  
} hal_i2c_txn_t;
 
hal_status_t hal_i2c_init();
 
hal_status_t hal_i2c_submit_transaction(hal_i2c_txn_t *txn);
 
hal_status_t hal_i2c_transaction_servicer();
 
#endif /* _I2C_H */