wave3.h

Go to the documentation of this file.

 
 
#pragma once
 
// allow-include-after-namespace
 
#include "fl/stl/align.h"
#include "fl/stl/compiler_control.h"
#include "fl/stl/stdint.h"
#include "fl/stl/noexcept.h"
 
namespace fl {
 
struct ChipsetTiming;

struct Wave3Byte {
    u8 data[3]; // 24 bits total (8 LED bits × 3 ticks each)
};

struct FL_ALIGNAS(4) Wave3BitExpansionLut {
    u16 lut[16]; // nibble → 12-bit pattern in lower bits of u16
};

bool canUseWave3(const ChipsetTiming& timing) FL_NO_EXCEPT;

u32 wave3ClockFrequencyHz(const ChipsetTiming& timing) FL_NO_EXCEPT;

Wave3BitExpansionLut buildWave3ExpansionLUT(const ChipsetTiming& timing) FL_NO_EXCEPT;
 
// Forward declaration; implementation is out-of-line in detail/wave3.cpp.hpp
void wave3(u8 lane,
           const Wave3BitExpansionLut& lut,
           u8 (&FL_RESTRICT_PARAM output)[sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
// Public transposition functions (implementations in wave3.cpp.hpp)
void wave3Transpose_2(
    const u8 (&FL_RESTRICT_PARAM lanes)[2],
    const Wave3BitExpansionLut& lut,
    u8 (&FL_RESTRICT_PARAM output)[2 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
void wave3Transpose_4(
    const u8 (&FL_RESTRICT_PARAM lanes)[4],
    const Wave3BitExpansionLut& lut,
    u8 (&FL_RESTRICT_PARAM output)[4 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
void wave3Transpose_8(
    const u8 (&FL_RESTRICT_PARAM lanes)[8],
    const Wave3BitExpansionLut& lut,
    u8 (&FL_RESTRICT_PARAM output)[8 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
void wave3Transpose_16(
    const u8 (&FL_RESTRICT_PARAM lanes)[16],
    const Wave3BitExpansionLut& lut,
    u8 (&FL_RESTRICT_PARAM output)[16 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
// Untranspose functions (for testing - reverse the transpose operation)
void wave3Untranspose_2(
    const u8 (&FL_RESTRICT_PARAM transposed)[2 * sizeof(Wave3Byte)],
    u8 (&FL_RESTRICT_PARAM output)[2 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
void wave3Untranspose_4(
    const u8 (&FL_RESTRICT_PARAM transposed)[4 * sizeof(Wave3Byte)],
    u8 (&FL_RESTRICT_PARAM output)[4 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
void wave3Untranspose_8(
    const u8 (&FL_RESTRICT_PARAM transposed)[8 * sizeof(Wave3Byte)],
    u8 (&FL_RESTRICT_PARAM output)[8 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
void wave3Untranspose_16(
    const u8 (&FL_RESTRICT_PARAM transposed)[16 * sizeof(Wave3Byte)],
    u8 (&FL_RESTRICT_PARAM output)[16 * sizeof(Wave3Byte)]) FL_NO_EXCEPT;
 
} // namespace fl
 
// Include inline implementations for optimal performance
// This must be after the namespace to avoid the include-after-namespace linter error