channel_typed.h

Go to the documentation of this file.

#pragma once

 
#include "fl/channels/bus.h"
#include "fl/channels/bus_traits.h"
#include "fl/channels/channel.h"
#include "fl/channels/config.h"
#include "fl/stl/noexcept.h"
#include "fl/stl/static_assert.h"
#include "fl/stl/type_traits.h"
 
namespace fl {
 
namespace detail {

template<Bus B, typename Chipset>
struct resolve_bus {
    static constexpr Bus value = B;
};
 
template<typename Chipset>
struct resolve_bus<Bus::AUTO, Chipset> {
    static constexpr Bus value = DefaultBus<Chipset>::value;
};
 
}  // namespace detail

template<Bus B, typename Chipset>
class TypedChannel {
public:
    static constexpr Bus kBus = detail::resolve_bus<B, Chipset>::value;
 
    // Compile-time contract: the named bus must accept this chipset family.
    //
    // The diagnostic message (suppressed on pre-C++17 toolchains by
    // FL_STATIC_ASSERT) describes the contract: route ClocklessChipset to a
    // clockless bus (RMT/PARLIO/I2S/...) and SpiChipsetConfig to an SPI bus.
    FL_STATIC_ASSERT(
        BusSupports<kBus, Chipset>::value,
        "TypedChannel: Bus does not support this Chipset family");

    static ChannelPtr create(const ChannelConfigOf<Chipset>& cfg) FL_NOEXCEPT {
        // Naming `BusTraits<kBus>::instance` here is the ODR-use that links
        // the driver translation unit even in the static-only `--gc-sections`
        // mode (issue #2428 Phase 5 binary-size fix).
        (void)&BusTraits<kBus>::instance;
        ChannelConfig erased = cfg.toErased();
        return Channel::create(erased);
    }

    static ChannelPtr create(const ChannelConfig& cfg) FL_NOEXCEPT {
        (void)&BusTraits<kBus>::instance;
        return Channel::create(cfg);
    }
 
private:
    TypedChannel() FL_NOEXCEPT = delete;
};
 
}  // namespace fl