spi.h

Go to the documentation of this file.

 
#pragma once
 
#include "fl/stl/stdint.h"
#include "fl/chipsets/spi_chipsets.h"
#include "fl/stl/noexcept.h"
 
namespace fl {

struct SpiEncoder {
    SpiChipset chipset;          
    u32 clock_hz;           

    static inline SpiEncoder apa102(u32 clock_hz = 6000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::APA102, clock_hz};
        return config;
    }

    static inline SpiEncoder apa102HD(u32 clock_hz = 6000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::APA102HD, clock_hz};
        return config;
    }

    static inline SpiEncoder sk9822(u32 clock_hz = 12000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::SK9822, clock_hz};
        return config;
    }

    static inline SpiEncoder sk9822HD(u32 clock_hz = 12000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::SK9822HD, clock_hz};
        return config;
    }

    static inline SpiEncoder dotstar(u32 clock_hz = 6000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::DOTSTAR, clock_hz};
        return config;
    }

    static inline SpiEncoder dotstarHD(u32 clock_hz = 6000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::DOTSTARHD, clock_hz};
        return config;
    }

    static inline SpiEncoder hd107(u32 clock_hz = 40000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::HD107, clock_hz};
        return config;
    }

    static inline SpiEncoder hd107HD(u32 clock_hz = 40000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::HD107HD, clock_hz};
        return config;
    }

    static inline SpiEncoder hd108(u32 clock_hz = 25000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::HD108, clock_hz};
        return config;
    }

    static inline SpiEncoder ws2801(u32 clock_hz = 1000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::WS2801, clock_hz};
        return config;
    }

    static inline SpiEncoder ws2803(u32 clock_hz = 25000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::WS2803, clock_hz};
        return config;
    }

    static inline SpiEncoder p9813(u32 clock_hz = 10000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::P9813, clock_hz};
        return config;
    }

    static inline SpiEncoder lpd8806(u32 clock_hz = 12000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::LPD8806, clock_hz};
        return config;
    }

    static inline SpiEncoder lpd6803(u32 clock_hz = 12000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::LPD6803, clock_hz};
        return config;
    }

    static inline SpiEncoder sm16716(u32 clock_hz = 16000000) FL_NOEXCEPT {
        SpiEncoder config = {SpiChipset::SM16716, clock_hz};
        return config;
    }

    static inline SpiEncoder spiEncoderForChipset(SpiChipset chipset, u32 speed_hz_override = 0) FL_NOEXCEPT {
        SpiEncoder enc = {chipset, 6000000}; // fallback
        switch (chipset) {
            case SpiChipset::APA102:    enc = apa102(); break;
            case SpiChipset::APA102HD:  enc = apa102HD(); break;
            case SpiChipset::DOTSTAR:   enc = dotstar(); break;
            case SpiChipset::DOTSTARHD: enc = dotstarHD(); break;
            case SpiChipset::SK9822:    enc = sk9822(); break;
            case SpiChipset::SK9822HD:  enc = sk9822HD(); break;
            case SpiChipset::HD107:     enc = hd107(); break;
            case SpiChipset::HD107HD:   enc = hd107HD(); break;
            case SpiChipset::HD108:     enc = hd108(); break;
            case SpiChipset::WS2801:    enc = ws2801(); break;
            case SpiChipset::WS2803:    enc = ws2803(); break;
            case SpiChipset::P9813:     enc = p9813(); break;
            case SpiChipset::LPD8806:   enc = lpd8806(); break;
            case SpiChipset::LPD6803:   enc = lpd6803(); break;
            case SpiChipset::SM16716:   enc = sm16716(); break;
            default: break; // unknown chipset: keep fallback
        }
        if (speed_hz_override != 0) {
            enc.clock_hz = speed_hz_override;
        }
        return enc;
    }

    constexpr bool operator==(const SpiEncoder& other) const FL_NOEXCEPT {
        return chipset == other.chipset &&
               clock_hz == other.clock_hz;
    }

    constexpr bool operator!=(const SpiEncoder& other) const FL_NOEXCEPT {
        return !(*this == other);
    }
};
 
} // namespace fl