spi.h

Go to the documentation of this file.

#pragma once

 
 
#include "fl/stl/stdint.h"
#include "fl/stl/unique_ptr.h"
#include "fl/stl/span.h"
 
// SPI components
#include "fl/channels/spi/config.h"             // IWYU pragma: export
#include "fl/channels/spi/transaction.h"        // IWYU pragma: export
#include "fl/channels/spi/device.h"             // IWYU pragma: export
#include "fl/channels/spi/lane.h"               // IWYU pragma: export
#include "fl/channels/spi/write_result.h"       // IWYU pragma: export
#include "fl/channels/spi/multi_lane_device.h"  // IWYU pragma: export
// IWYU pragma: begin_keep
#include "platforms/shared/spi_types.h"  // ok platform headers
#include "fl/stl/noexcept.h"
// IWYU pragma: end_keep  // ok platform headers
 
namespace fl {
 
// ============================================================================
// Public API - Main SPI Device Class
// ============================================================================

class Spi {
public:
    Spi() FL_NOEXCEPT : is_ok(false), error_code(SPIError::NOT_INITIALIZED) {}

    Spi(int clock_pin, fl::span<const int> data_pins,
        spi_output_mode_t output_mode = spi_output_mode_t::SPI_HW,
        u32 clock_speed_hz = 0xffffffff);

    explicit Spi(const SpiConfig& config);

    Spi(Spi&& other) FL_NOEXCEPT;

    Spi& operator=(Spi&& other) FL_NOEXCEPT;

    ~Spi() FL_NOEXCEPT;

    bool ok() const { return is_ok; }

    SPIError error() const { return error_code; }

    explicit operator bool() const { return ok(); }

    template<typename... Spans>
    WriteResult write(Spans&&... lanes) {
        if (!device) {
            return WriteResult("SPI device not initialized");
        }
        return device->write(fl::forward<Spans>(lanes)...);
    }

    bool wait(u32 timeout_ms = 0xFFFFFFFF);

    spi::MultiLaneDevice* get() { return device.get(); }
    const spi::MultiLaneDevice* get() const { return device.get(); }
 
private:
    fl::unique_ptr<spi::MultiLaneDevice> device;
    bool is_ok;
    SPIError error_code;
};
 
// ============================================================================
// Type Aliases
// ============================================================================
 
using SpiTransaction = spi::Transaction;
 
template<typename T = void>
using SpiResult = spi::Result<T>;
 
} // namespace fl