gpio_requirements.hpp

Go to the documentation of this file.

/**
 * @file gpio_requirements.hpp
 * @brief GPIO driver requirements validator
 * @ingroup validation
 *
 * Validates that GPIO drivers provide required functionality using the
 * method detection system. This is the core GPIO contract enforcement
 * for Sound Byte Libs drivers.
 *
 * ## GPIO Driver Contract
 *
 * Every Sound Byte Libs GPIO driver MUST implement these methods:
 * - `set_mode(const GpioHandle&, PinMode)` - Configure pin mode
 * - `write(const GpioHandle&, bool)` - Write logical value (handles active_low)
 * - `read(const GpioHandle&) -> bool` - Read logical value (handles active_low)
 * - `toggle(const GpioHandle&)` - Toggle pin output
 *
 * ## Validation Usage
 *
 * Add validation at the bottom of driver gpio.hpp:
 * ```cpp
 * #include <sbl/validation/gpio_requirements.hpp>
 * static_assert(sbl::validation::gpio_driver_valid<sbl::driver::Gpio>,
 *               "GPIO driver missing required methods");
 * ```
 *
 * @see method_detection.hpp
 */
 
#ifndef SBL_VALIDATION_GPIO_REQUIREMENTS_HPP_
#define SBL_VALIDATION_GPIO_REQUIREMENTS_HPP_
 
#include "method_detection.hpp"
 
namespace sbl {
namespace validation {
 
/**
 * @brief GPIO driver requirements validator
 *
 * Validates that GPIO drivers provide all required handle-first methods.
 */
template<typename GpioDriver>
class GpioDriverRequirements {
public:
    /**
     * @brief Validate all required GPIO methods
     */
    static constexpr bool validate() {
        static_assert(has_gpio_set_mode<GpioDriver>::value,
                      "SBL ERROR: GPIO driver missing set_mode() method.\n"
                      "Required: static void set_mode(const GpioHandle&, PinMode)");
 
        static_assert(has_gpio_write<GpioDriver>::value,
                      "SBL ERROR: GPIO driver missing write() method.\n"
                      "Required: static void write(const GpioHandle&, bool)");
 
        static_assert(has_gpio_read<GpioDriver>::value,
                      "SBL ERROR: GPIO driver missing read() method.\n"
                      "Required: static bool read(const GpioHandle&)");
 
        static_assert(has_gpio_toggle<GpioDriver>::value,
                      "SBL ERROR: GPIO driver missing toggle() method.\n"
                      "Required: static void toggle(const GpioHandle&)");
 
        return true;
    }
};
 
/**
 * @brief Helper to validate a GPIO driver implementation
 *
 * Usage:
 * ```cpp
 * static_assert(sbl::validation::gpio_driver_valid<MyGpioDriver>,
 *               "GPIO driver incomplete");
 * ```
 */
template<typename GpioDriver>
constexpr bool gpio_driver_valid = GpioDriverRequirements<GpioDriver>::validate();
 
} // namespace validation
} // namespace sbl
 
#endif // SBL_VALIDATION_GPIO_REQUIREMENTS_HPP_