ra8_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_i2c_speed_standard  = 100000U,  
  k_ra8_i2c_speed_fast      = 400000U,  
  k_ra8_i2c_speed_fast_plus = 1000000U, 
} ra8_i2c_speed_t;

typedef struct {
  uint32_t bus_hz;   
  uint32_t pclkb_hz; 
} ra8_i2c_cfg_t;

typedef enum : uint8_t {
  k_ra8_i2c_err_none     = 0x00U, 
  k_ra8_i2c_err_arb_lost = 0x01U, 
  k_ra8_i2c_err_nack     = 0x02U, 
  k_ra8_i2c_err_timeout  = 0x04U, 
} ra8_i2c_err_mask_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_i2c_init(uint8_t channel, const ra8_i2c_cfg_t* cfg);

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

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

[[nodiscard]] ra8_err_t ra8_i2c_write(uint8_t        channel,
                                      uint8_t        peripheral_7b,
                                      const uint8_t* data,
                                      uint32_t       len,
                                      bool           send_stop);

[[nodiscard]] ra8_err_t
ra8_i2c_read(uint8_t channel, uint8_t peripheral_7b, uint8_t* data, uint32_t len);

[[nodiscard]] ra8_err_t ra8_i2c_transfer(uint8_t        channel,
                                         uint8_t        peripheral_7b,
                                         const uint8_t* wr,
                                         uint32_t       wr_len,
                                         uint8_t*       rd,
                                         uint32_t       rd_len);

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

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

[[nodiscard]] ra8_err_t ra8_i2c_clear_errors(uint8_t channel);
 
/* =============================================================================
 * Target (peripheral) role
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_i2c_peripheral_slot_0 = 0U, 
  k_ra8_i2c_peripheral_slot_1 = 1U, 
  k_ra8_i2c_peripheral_slot_2 = 2U, 
} ra8_i2c_peripheral_slot_t;

typedef enum : uint8_t {
  k_ra8_i2c_peripheral_event_none  = 0U, 
  k_ra8_i2c_peripheral_event_write = 1U, 
  k_ra8_i2c_peripheral_event_read  = 2U, 
  k_ra8_i2c_peripheral_event_stop  = 3U, 
} ra8_i2c_peripheral_event_t;

typedef void (*ra8_i2c_peripheral_event_fn_t)(void* ctx, ra8_i2c_peripheral_event_t event);

typedef struct {
  uint8_t                   own_addr_7b;   
  ra8_i2c_peripheral_slot_t slot;          
  bool                      general_call;  
  bool                      clock_stretch; 
  bool                      irq_enable;    
} ra8_i2c_peripheral_cfg_t;

[[nodiscard]] ra8_err_t ra8_i2c_peripheral_init(uint8_t                         channel,
                                                const ra8_i2c_peripheral_cfg_t* cfg);

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

[[nodiscard]] ra8_err_t ra8_i2c_peripheral_poll(uint8_t                     channel,
                                                ra8_i2c_peripheral_event_t* out_event);

[[nodiscard]] ra8_err_t ra8_i2c_peripheral_receive(uint8_t   channel,
                                                   uint8_t*  buf,
                                                   uint32_t  capacity,
                                                   uint32_t* out_received);

[[nodiscard]] ra8_err_t
ra8_i2c_peripheral_transmit(uint8_t channel, const uint8_t* data, uint32_t len, uint32_t* out_sent);

[[nodiscard]] ra8_err_t
ra8_i2c_peripheral_attach_handler(uint8_t channel, ra8_i2c_peripheral_event_fn_t fn, void* ctx);

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