device.h

Go to the documentation of this file.

#pragma once

 
#include "fl/stl/limits.h"
#include "fl/stl/stdint.h"
#include "fl/stl/unique_ptr.h"
#include "fl/stl/optional.h"
#include "fl/task/promise.h"  // for fl::task::Error
#include "fl/channels/spi/config.h"
#include "fl/channels/spi/transaction.h"
// 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 - DMABuffer, SPIError, TransmitMode
 
namespace fl {
namespace spi {
 
// ============================================================================
// Main Device Class
// ============================================================================

class Device {
public:
    explicit Device(const Config& config) FL_NO_EXCEPT;

    ~Device() FL_NO_EXCEPT;
 
    // ========== Initialization ==========

    fl::optional<fl::task::Error> begin() FL_NO_EXCEPT;

    void end() FL_NO_EXCEPT;

    bool isReady() const FL_NO_EXCEPT;
 
    // ========== Transaction API (Primary Interface) ==========

    Result<Transaction> writeAsync(const u8* data, size_t size) FL_NO_EXCEPT;
 
    // ========== Zero-Copy DMA API (Expert) ==========

    DMABuffer acquireBuffer(size_t size) FL_NO_EXCEPT;

    fl::optional<fl::task::Error> transmit(DMABuffer& buffer, bool async = true) FL_NO_EXCEPT;

    bool waitComplete(u32 timeout_ms = (fl::numeric_limits<u32>::max)()) FL_NO_EXCEPT;

    bool isBusy() const FL_NO_EXCEPT;
 
    // ========== Configuration ==========

    fl::optional<fl::task::Error> setClockSpeed(u32 speed_hz) FL_NO_EXCEPT;

    const Config& getConfig() const FL_NO_EXCEPT;
 
private:
    friend class Transaction;  // Allow Transaction to access Device internals
 
    struct Impl;  // Forward declaration (pImpl pattern)
    fl::unique_ptr<Impl> pImpl;
 
    // Non-copyable, non-movable (owns hardware resources)
    Device(const Device&) FL_NO_EXCEPT = delete;
    Device& operator=(const Device&) FL_NO_EXCEPT = delete;
};
 
} // namespace spi
} // namespace fl