ra8_i3c_i2c.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
 
/* =============================================================================
 * Public types
 * =============================================================================
 */

typedef enum : uint32_t {
  k_ra8_i3c_i2c_speed_standard  = 100000U,  
  k_ra8_i3c_i2c_speed_fast      = 400000U,  
  k_ra8_i3c_i2c_speed_fast_plus = 1000000U, 
} ra8_i3c_i2c_speed_t;

typedef struct {
  uint32_t bus_hz;   
  uint32_t pclka_hz; 
} ra8_i3c_i2c_cfg_t;

typedef enum : uint8_t {
  k_ra8_i3c_i2c_err_none     = 0x00U, 
  k_ra8_i3c_i2c_err_arb_lost = 0x01U, 
  k_ra8_i3c_i2c_err_nack     = 0x02U, 
  k_ra8_i3c_i2c_err_timeout  = 0x04U, 
} ra8_i3c_i2c_err_mask_t;

typedef void (*ra8_i3c_i2c_complete_fn_t)(void* ctx, uint8_t err_mask);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_i3c_i2c_init(uint8_t channel, const ra8_i3c_i2c_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_i3c_i2c_deinit(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_i3c_i2c_set_clock(uint8_t channel, uint32_t bus_hz, uint32_t pclka_hz);
 
/* =============================================================================
 * Polling transfers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_i3c_i2c_write(uint8_t        channel,
                                          uint8_t        target_7b,
                                          const uint8_t* data,
                                          uint32_t       len,
                                          bool           restart);

[[nodiscard]] ra8_err_t
ra8_i3c_i2c_read(uint8_t channel, uint8_t target_7b, uint8_t* buf, uint32_t len, bool restart);

[[nodiscard]] ra8_err_t ra8_i3c_i2c_transfer(uint8_t        channel,
                                             uint8_t        target_7b,
                                             const uint8_t* tx,
                                             uint32_t       tx_len,
                                             uint8_t*       rx,
                                             uint32_t       rx_len);

[[nodiscard]] ra8_err_t ra8_i3c_i2c_abort(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_i3c_i2c_scan(uint8_t channel, uint8_t target_7b, bool* out_acked);
 
/* =============================================================================
 * Status
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_i3c_i2c_get_errors(uint8_t channel, uint8_t* out_mask);

[[nodiscard]] ra8_err_t ra8_i3c_i2c_clear_errors(uint8_t channel);
 
/* =============================================================================
 * Interrupt path
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_i3c_i2c_attach_handler(uint8_t channel, ra8_i3c_i2c_complete_fn_t fn, void* ctx);

void ra8_i3c_i2c_dispatch_eri(uint8_t channel);
 
#ifdef __cplusplus
}
#endif