EspSpi.h

Go to the documentation of this file.

 
#pragma once
 
#include "BaseSpi.h"
#include "PlatformMutex.h"
#include "utils/EspTypes.h"
#include <memory>
#include <vector>
 
// Suppress pedantic warnings for ESP-IDF headers
#ifdef __cplusplus
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpedantic"
#endif
 
// ESP-IDF C headers must be wrapped in extern "C" for C++ compatibility
#ifdef __cplusplus
extern "C" {
#endif
#include "driver/spi_common.h"
#include "driver/spi_master.h"
#include "esp_log.h"
#ifdef __cplusplus
}
#endif
 
// Restore warnings after ESP-IDF headers
#ifdef __cplusplus
#pragma GCC diagnostic pop
#endif
 
class EspSpiBus;
class EspSpiDevice;
 
class EspSpiDevice : public BaseSpi {
public:
  EspSpiDevice(EspSpiBus* parent, const hf_spi_device_config_t& config);
  ~EspSpiDevice() noexcept override;
 
  bool Initialize() noexcept override;
  bool Deinitialize() noexcept override;
 
  bool MarkAsDeinitialized() noexcept;
 
  hf_spi_err_t Transfer(const hf_u8_t* tx_data, hf_u8_t* rx_data, hf_u16_t length,
                        hf_u32_t timeout_ms = 0) noexcept override;
 
  const void* GetDeviceConfig() const noexcept override;
 
  hf_spi_err_t AcquireBus(hf_u32_t timeout_ms) noexcept;
 
  hf_spi_err_t ReleaseBus() noexcept;
 
  spi_device_handle_t GetHandle() const noexcept;
  const hf_spi_device_config_t& GetConfig() const noexcept;
 
  hf_spi_err_t GetActualClockFrequency(hf_u32_t& actual_freq_hz) const noexcept;
 
private:
  EspSpiBus* parent_bus_;         
  spi_device_handle_t handle_;    
  hf_spi_device_config_t config_; 
  bool initialized_;              
  PlatformMutex mutex_;               
};
 
class EspSpiBus {
public:
  explicit EspSpiBus(const hf_spi_bus_config_t& config) noexcept;
  ~EspSpiBus() noexcept;
 
  bool Initialize() noexcept;
 
  bool IsInitialized() const noexcept;
 
  bool Deinitialize() noexcept;
 
  int CreateDevice(const hf_spi_device_config_t& device_config) noexcept;
 
  BaseSpi* GetDevice(int device_index) noexcept;
 
  const BaseSpi* GetDevice(int device_index) const noexcept;
 
  EspSpiDevice* GetEspDevice(int device_index) noexcept;
 
  const EspSpiDevice* GetEspDevice(int device_index) const noexcept;
 
  std::size_t GetDeviceCount() const noexcept;
 
  bool RemoveDevice(int device_index) noexcept;
 
  const hf_spi_bus_config_t& GetConfig() const noexcept;
  spi_host_device_t GetHost() const noexcept;
 
private:
  hf_spi_bus_config_t config_; 
  bool initialized_;           
  mutable PlatformMutex mutex_;    
  std::vector<std::unique_ptr<EspSpiDevice>> devices_; 
};