ra8_smbus.h

Go to the documentation of this file.

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

typedef enum : uint16_t {
  k_ra8_smbus_block_max     = 255U, 
  k_ra8_smbus_frame_max     = 258U, 
  k_ra8_smbus_alert_addr_7b = 0x0CU 
} ra8_smbus_limits_t;

typedef struct {
  ra8_i2c_bus_ops_t bus;         
  bool              pec_enabled; 
} ra8_smbus_cfg_t;

typedef void (*ra8_smbus_alert_fn_t)(void* ctx, uint8_t target_7b, uint8_t status);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_smbus_init(const ra8_smbus_cfg_t* cfg);

[[nodiscard]] ra8_err_t ra8_smbus_deinit(void);
 
/* =============================================================================
 * Byte protocols (SMBus 3.2 sec 6.5.2 / 6.5.3 / 6.5.4 / 6.5.5)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_smbus_send_byte(uint8_t target_7b, uint8_t data);

[[nodiscard]] ra8_err_t ra8_smbus_receive_byte(uint8_t target_7b, uint8_t* out_data);

[[nodiscard]] ra8_err_t ra8_smbus_write_byte_data(uint8_t target_7b, uint8_t cmd, uint8_t data);

[[nodiscard]] ra8_err_t ra8_smbus_read_byte_data(uint8_t target_7b, uint8_t cmd, uint8_t* out_data);
 
/* =============================================================================
 * Block protocols (SMBus 3.2 sec 6.5.7 / 6.5.8)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_smbus_block_write(uint8_t target_7b, uint8_t cmd, const uint8_t* data, uint8_t len);

[[nodiscard]] ra8_err_t
ra8_smbus_block_read(uint8_t target_7b, uint8_t cmd, uint8_t* buf, uint8_t cap, uint8_t* out_len);
 
/* =============================================================================
 * SMBALERT# / Host Notify (SMBus 3.2 sec 6.5.13)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_smbus_alert_register_callback(ra8_smbus_alert_fn_t fn, void* ctx);

[[nodiscard]] ra8_err_t ra8_smbus_alert_dispatch(void);
 
/* =============================================================================
 * PEC helpers (exposed for unit tests)
 * =============================================================================
 */

uint8_t ra8_smbus_pec(const uint8_t* data, uint32_t len);
 
#ifdef __cplusplus
}
#endif