mux.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DEVICETREE_MUX_H_
#define ZEPHYR_INCLUDE_DEVICETREE_MUX_H_
 
#include <zephyr/device.h>
#include <zephyr/devicetree.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif


 
/* Helper that emits one cell value for DT_FOREACH_PHA_CELL_BY_IDX_SEP. */
#define Z_MUX_CELL_VAL(node_id, pha, idx, cell) \
        DT_PHA_BY_IDX(node_id, pha, idx, cell)
 
/* Number of cells in the idx'th element of a phandle-array property. */
#define Z_MUX_PHA_NUM_CELLS(node_id, pha, idx) \
        DT_PHA_NUM_CELLS_BY_IDX(node_id, pha, idx)
 
/* Internal storage identifier generators (mux-controls). */
 
#define Z_MUX_CTRL_CELLS_NAME(node_id, idx) \
        DT_CAT4(zpriv_mux_ctrl_cells_, node_id, _, idx)
 
#define Z_MUX_CTRL_OBJ_NAME(node_id, idx) \
        DT_CAT4(zpriv_mux_ctrl_, node_id, _, idx)
 
/* Internal storage identifier generators (mux-states). */
 
#define Z_MUX_STATE_CELLS_NAME(node_id, idx) \
        DT_CAT4(zpriv_mux_state_cells_, node_id, _, idx)
 
#define Z_MUX_STATE_CTRL_NAME(node_id, idx) \
        DT_CAT4(zpriv_mux_state_ctrl_, node_id, _, idx)
 
#define Z_MUX_STATE_OBJ_NAME(node_id, idx) \
        DT_CAT4(zpriv_mux_state_, node_id, _, idx)
 
/* The first (N - 1) cells form the addressing; cell at index (N - 1) is the
 * state. The cells[] array stores only the addressing portion so the embedded
 * mux_control has the same shape as mux-controls-derived ones. The trailing
 * state value is captured into mux_state.state by position (last argument),
 * not by name, so backends are free to name the trailing cell whatever fits
 * their hardware ("state", "input", "source", ...).
 *
 * GET_ARGS_FIRST_N(N, x0, x1, ..., xK) keeps the first N arguments. Combined
 * with NUM_VA_ARGS_LESS_1(...) it yields "everything except the last", which
 * is exactly the addressing portion of a mux-states specifier.
 *
 * GET_ARG_N(N, x0, x1, ..., xK) is 1-indexed, so GET_ARG_N(K, ...) over a
 * list of K cells yields the last one (the state value).
 *
 * For 1-cell mux-states (trailing state cell only, no addressing) the cells
 * array is empty (len == 0).
 */
#define Z_MUX_STATE_ADDRESSING_CELLS(node_id, idx)                                            \
        GET_ARGS_FIRST_N(                                                                     \
                NUM_VA_ARGS_LESS_1(                                                           \
                        DT_FOREACH_PHA_CELL_BY_IDX_SEP(node_id, mux_states, idx,              \
                                                       Z_MUX_CELL_VAL, (,))),                 \
                DT_FOREACH_PHA_CELL_BY_IDX_SEP(node_id, mux_states, idx, Z_MUX_CELL_VAL, (,)))
 
#define Z_MUX_STATE_LAST_CELL(node_id, idx)                                                   \
        GET_ARG_N(Z_MUX_PHA_NUM_CELLS(node_id, mux_states, idx),                              \
                DT_FOREACH_PHA_CELL_BY_IDX_SEP(node_id, mux_states, idx, Z_MUX_CELL_VAL, (,)))


#define MUX_CONTROL_DT_GET_BY_IDX(node_id, idx) (&Z_MUX_CTRL_OBJ_NAME(node_id, idx))

#define MUX_CONTROL_DT_GET(node_id) MUX_CONTROL_DT_GET_BY_IDX(node_id, 0)

#define MUX_CONTROL_DT_GET_BY_NAME(node_id, name) \
        MUX_CONTROL_DT_GET_BY_IDX(node_id,        \
                DT_PHA_ELEM_IDX_BY_NAME(node_id, mux_controls, name))

#define MUX_STATE_DT_GET_BY_IDX(node_id, idx) (&Z_MUX_STATE_OBJ_NAME(node_id, idx))

#define MUX_STATE_DT_GET(node_id) MUX_STATE_DT_GET_BY_IDX(node_id, 0)

#define MUX_STATE_DT_GET_BY_NAME(node_id, name) \
        MUX_STATE_DT_GET_BY_IDX(node_id,        \
                DT_PHA_ELEM_IDX_BY_NAME(node_id, mux_states, name))

#define MUX_CONTROL_DT_DEV_GET_BY_IDX(node_id, idx) \
        DEVICE_DT_GET(DT_PHANDLE_BY_IDX(node_id, mux_controls, idx))

#define MUX_CONTROL_DT_DEV_GET(node_id) MUX_CONTROL_DT_DEV_GET_BY_IDX(node_id, 0)

#define MUX_STATE_DT_DEV_GET_BY_IDX(node_id, idx) \
        DEVICE_DT_GET(DT_PHANDLE_BY_IDX(node_id, mux_states, idx))

#define MUX_STATE_DT_DEV_GET(node_id) MUX_STATE_DT_DEV_GET_BY_IDX(node_id, 0)

 
#define Z_MUX_STATE_DEFINE_FOR_EACH(node_id, prop, idx) \
        MUX_STATE_DT_SPEC_DEFINE_BY_IDX(node_id, idx);


#define MUX_STATE_DT_SPEC_DEFINE_ALL(node_id) \
        DT_FOREACH_PROP_ELEM(node_id, mux_states, Z_MUX_STATE_DEFINE_FOR_EACH)

#define MUX_STATE_DT_INST_SPEC_DEFINE_ALL(inst) \
        MUX_STATE_DT_SPEC_DEFINE_ALL(DT_DRV_INST(inst))

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DEVICETREE_MUX_H_ */