TLE92466ED_HAL.hpp

Go to the documentation of this file.

 
#ifndef TLE92466ED_HAL_HPP
#define TLE92466ED_HAL_HPP
 
#include <cstdint>
#include <concepts>
#include <span>
#include <expected>
 
namespace TLE92466ED {
 
enum class HALError : uint8_t {
    None = 0,                 
    BusError,                 
    Timeout,                  
    InvalidParameter,         
    ChipselectError,          
    TransferError,            
    HardwareNotReady,         
    BufferOverflow,           
    CRCError,                 
    UnknownError              
};
 
template<typename T>
using HALResult = std::expected<T, HALError>;
 
struct SPIConfig {
    uint32_t frequency{1'000'000};        
    uint8_t mode{0};                      
    uint8_t bits_per_word{8};             
    bool msb_first{true};                 
    uint32_t timeout_ms{100}; 
};
 
class HAL {
public:
    virtual ~HAL() = default;
 
    [[nodiscard]] virtual HALResult<void> init() noexcept = 0;
 
    [[nodiscard]] virtual HALResult<void> deinit() noexcept = 0;
 
    [[nodiscard]] virtual HALResult<uint32_t> transfer32(uint32_t tx_data) noexcept = 0;
 
    [[nodiscard]] virtual HALResult<void> transfer_multi(
        std::span<const uint32_t> tx_data,
        std::span<uint32_t> rx_data) noexcept = 0;
 
    [[nodiscard]] virtual HALResult<void> chip_select() noexcept = 0;
 
    [[nodiscard]] virtual HALResult<void> chip_deselect() noexcept = 0;
 
    [[nodiscard]] virtual HALResult<void> delay(uint32_t microseconds) noexcept = 0;
 
    [[nodiscard]] virtual HALResult<void> configure(const SPIConfig& config) noexcept = 0;
 
    [[nodiscard]] virtual bool is_ready() const noexcept = 0;
 
    [[nodiscard]] virtual HALError get_last_error() const noexcept = 0;
 
    [[nodiscard]] virtual HALResult<void> clear_errors() noexcept = 0;
 
protected:
    HAL() = default;
 
    HAL(const HAL&) = delete;
    HAL& operator=(const HAL&) = delete;
 
    HAL(HAL&&) noexcept = default;
    HAL& operator=(HAL&&) noexcept = default;
};
 
template<typename T>
concept HALInterface = std::is_base_of_v<HAL, T> && requires(T hal, uint32_t data, SPIConfig cfg) {
    { hal.init() } -> std::same_as<HALResult<void>>;
    { hal.transfer32(data) } -> std::same_as<HALResult<uint32_t>>;
    { hal.chip_select() } -> std::same_as<HALResult<void>>;
    { hal.chip_deselect() } -> std::same_as<HALResult<void>>;
    { hal.is_ready() } -> std::same_as<bool>;
    { hal.configure(cfg) } -> std::same_as<HALResult<void>>;
};
 
} // namespace TLE92466ED
 
#endif // TLE92466ED_HAL_HPP