i2c.h

#pragma once
 
/************************************************************************************************
 * @file   i2c.h
 *
 * @brief  I2C Library Header file
 *
 * @date   2024-11-02
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stddef.h>
#include <stdint.h>
 
/* Inter-component Headers */
 
/* Intra-component Headers */
#include "gpio.h"
#include "status.h"
 
#define I2C_TIMEOUT_MS 100U
#define I2C_MAX_NUM_DATA 32U
 
typedef uint8_t I2CAddress;
 
typedef enum {
  I2C_PORT_1 = 0, 
  I2C_PORT_2,     
  I2C_PORT_3,     
  NUM_I2C_PORTS,  
} I2CPort;
 
typedef enum {
  I2C_SPEED_STANDARD = 0, 
  I2C_SPEED_FAST,         
  NUM_I2C_SPEEDS,         
} I2CSpeed;
 
typedef struct {
  I2CSpeed speed;  
  GpioAddress sda; 
  GpioAddress scl; 
} I2CSettings;
 
StatusCode i2c_init(I2CPort i2c, const I2CSettings *settings);
 
StatusCode i2c_read(I2CPort i2c, I2CAddress addr, uint8_t *rx_data, size_t rx_len);
 
StatusCode i2c_write(I2CPort i2c, I2CAddress addr, uint8_t *tx_data, size_t tx_len);
 
StatusCode i2c_read_reg(I2CPort i2c, I2CAddress addr, uint8_t reg, uint8_t *rx_data, size_t rx_len);
 
StatusCode i2c_write_reg(I2CPort i2c, I2CAddress addr, uint8_t reg, uint8_t *tx_data, size_t tx_len);
 
StatusCode i2c_read_mem(I2CPort i2c, I2CAddress addr, uint8_t mem_addr, uint8_t *rx_data, size_t rx_len);
 
#ifdef MS_PLATFORM_X86
 
StatusCode i2c_set_rx_data(I2CPort i2c, const uint8_t *data, size_t len);
 
StatusCode i2c_get_tx_data(I2CPort i2c, uint8_t *data, size_t len);
 
size_t i2c_get_tx_num_bytes(I2CPort i2c);
 
StatusCode i2c_clear_buffers(I2CPort i2c);
 
#endif