parallel_device.h

Go to the documentation of this file.

#pragma once

 
#include "fl/stl/stdint.h"
#include "fl/stl/vector.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/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
 
// Forward declarations for backends
namespace fl {
    class SpiIsr1;
    class SpiIsr2;
    class SpiIsr4;
    class SpiIsr8;
    class SpiIsr16;
    class SpiIsr32;
    class SpiBlock1;
    class SpiBlock2;
    class SpiBlock4;
    class SpiBlock8;
    class SpiBlock16;
    class SpiBlock32;
}
 
namespace fl {
namespace spi {
 
// ============================================================================
// ParallelDevice - 1-32 GPIO pins (single stream → LUT → parallel output)
// ============================================================================

class ParallelDevice {
public:
    struct Config {
        u8 clock_pin;              
        fl::vector<u8> gpio_pins;  
        SpiParallelMode mode;           
        u32 timer_hz;              
 
        Config() FL_NOEXCEPT;  // Implemented in .cpp to avoid circular dependency
    };

    explicit ParallelDevice(const Config& config);

    ~ParallelDevice() FL_NOEXCEPT;
 
    // Disable copy/move
    ParallelDevice(const ParallelDevice&) FL_NOEXCEPT = delete;
    ParallelDevice& operator=(const ParallelDevice&) FL_NOEXCEPT = delete;
    ParallelDevice(ParallelDevice&&) FL_NOEXCEPT = delete;
    ParallelDevice& operator=(ParallelDevice&&) FL_NOEXCEPT = delete;
 
    // ========== Initialization ==========

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

    void end();

    bool isReady() const;
 
    // ========== Transmission ==========

    Result<Transaction> write(const u8* data, size_t size);

    // Use (max)() to prevent macro expansion by Arduino.h's max macro
    bool waitComplete(u32 timeout_ms = (fl::numeric_limits<u32>::max)());

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

    void configureLUT(const u32* set_masks, const u32* clear_masks);

    const Config& getConfig() const;
 
private:
    struct Impl;
    fl::unique_ptr<Impl> pImpl;
};
 
} // namespace spi
} // namespace fl