handle.hpp

Go to the documentation of this file.

/**
 * @file handle.hpp
 * @brief I2C handle type for hardware abstraction
 * @ingroup hal
 *
 * Canonical definition of I2cHandle - the primary way to reference
 * I2C peripherals in SBL. Used by drivers, generated hardware configs,
 * and user code.
 */
 
#ifndef SBL_HAL_I2C_HANDLE_HPP_
#define SBL_HAL_I2C_HANDLE_HPP_
 
#include <cstdint>
 
namespace sbl {
 
/**
 * @brief I2C peripheral handle
 *
 * Represents an I2C configuration as resolved from hardware manifests.
 * Includes peripheral number, pin mappings, and bus speed.
 *
 * Examples:
 * - STM32H7 I2C1 on PB8/PB9: I2cHandle{1, 1, 8, 4, 1, 9, 4, 100000}
 * - STM32H7 I2C2 on PB10/PB11: I2cHandle{2, 1, 10, 4, 1, 11, 4, 400000}
 */
struct I2cHandle {
    uint32_t peripheral;  ///< I2C peripheral number (e.g., 1 for I2C1)
    uint32_t scl_port;    ///< SCL GPIO port number
    uint32_t scl_pin;     ///< SCL GPIO pin number
    uint32_t scl_af;      ///< SCL alternate function (STM32)
    uint32_t sda_port;    ///< SDA GPIO port number
    uint32_t sda_pin;     ///< SDA GPIO pin number
    uint32_t sda_af;      ///< SDA alternate function (STM32)
    uint32_t speed_hz;    ///< Bus speed in Hz (100000, 400000, 1000000)
};
 
} // namespace sbl
 
#endif // SBL_HAL_I2C_HANDLE_HPP_