gpio_bl61x_wo.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 MASSDRIVER EI (massdriver.space)
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_DRIVERS_GPIO_GPIO_BL61X_WO_H_
#define ZEPHYR_DRIVERS_GPIO_GPIO_BL61X_WO_H_
 
#ifdef __cplusplus
extern "C" {
#endif

 
#include <zephyr/drivers/gpio.h>
#include <zephyr/sys/util_macro.h>
 
#define BL61X_WO_PIN_CNT        16 


BUILD_ASSERT(IS_ENABLED(CONFIG_GPIO_BL61X_WO),
             "BFLB Wire Out must be activated to use this header");

#define BL61X_WO_VALIDATE_TIME(_node)                                                           \
        BUILD_ASSERT((DT_PROP(_node, time_t0h) < DT_PROP(_node, time_total)),                   \
                     "BFLB WO device time-t0h must be smaller than time-total");                \
        BUILD_ASSERT((DT_PROP(_node, time_t1h) < DT_PROP(_node, time_total)),                   \
                     "BFLB WO device time-t1h must be smaller than time-total")
#define BL61X_WO_VALIDATE_FREQ(_node)                                                           \
        BUILD_ASSERT((DT_PROP(_node, time_t0h) < (Z_HZ_ns / DT_PROP(_node, frequency))),        \
                     "BFLB WO device time-t0h must be smaller than the frequency's period");    \
        BUILD_ASSERT((DT_PROP(_node, time_t1h) < (Z_HZ_ns / DT_PROP(_node, frequency))),        \
                     "BFLB WO device time-t1h must be smaller than the frequency's period")

#define BL61X_WO_VALIDATE(_node)                                                                \
        BUILD_ASSERT((DT_PROP_OR(_node, frequency, 0) | DT_PROP_OR(_node, time_total, 0)) != 0, \
                     "BFLB WO device must have frequency or time_total set");                   \
        BUILD_ASSERT(DT_NODE_HAS_PROP(_node, time_t0h),                                         \
                "BFLB WO device must have time-t0h, device binding is bad if this was allowed");\
        BUILD_ASSERT(DT_NODE_HAS_PROP(_node, time_t1h),                                         \
                "BFLB WO device must have time-t1h, device binding is bad if this was allowed");\
        IF_ENABLED(DT_NODE_HAS_PROP(_node, time_total), (BL61X_WO_VALIDATE_TIME(_node)));       \
        IF_ENABLED(DT_NODE_HAS_PROP(_node, frequency), (BL61X_WO_VALIDATE_FREQ(_node)))
#define BL61X_WO_VALIDATE_INST(_inst, _compat) BL61X_WO_VALIDATE(DT_INST(_inst, _compat))


typedef void (*bl61x_wo_callback_t) (void *user_data);

 */
struct bl61x_wo_config {
        uint16_t total_cycles; 
        uint8_t set_cycles; 
        uint8_t unset_cycles; 
        bool set_invert; 
        bool unset_invert; 
        bool park_high; 
};

uint16_t bl61x_wo_frequency_to_cycles(const uint32_t frequency, const bool exact);

uint16_t bl61x_wo_time_to_cycles(const uint32_t time, const bool exact);

int bl61x_wo_configure(const struct bl61x_wo_config *const config,
                       const uint8_t *pins, const gpio_flags_t *flags, const size_t pin_cnt);

int bl61x_wo_configure_dt(const struct bl61x_wo_config *const config,
                          const struct gpio_dt_spec *pins, const size_t pin_cnt);

int bl61x_wo_write(const uint16_t *const data, const size_t len);

int bl61x_wo_write_async(const uint16_t *const data, const size_t len,
                         bl61x_wo_callback_t cb, void *user_data);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_DRIVERS_GPIO_GPIO_BL61X_WO_H_ */