9  * SPDX-License-Identifier: Apache-2.0
20  * @defgroup devicetree-pwms Devicetree PWMs API
31  *     pwm1: pwm-controller@... { ... };
33  *     pwm2: pwm-controller@... { ... };
60  *     pwm1: pwm-controller@... { ... };
62  *    pwm2: pwm-controller@... { ... };
67  *             pwm-names = "alpha", "beta";
76  * @param name lowercase-and-underscores name of a pwms element
77  *             as defined by the node's pwm-names property
94  * @brief Get PWM specifier's cell value at an index
98  *     pwm1: pwm-controller@... {
100  *             #pwm-cells = <2>;
103  *     pwm2: pwm-controller@... {
105  *             #pwm-cells = <2>;
115  *     pwm-cells:
116  *       - channel
117  *       - period
118  *       - flags
131  * @param cell lowercase-and-underscores cell name
132  * @return the cell value at index "idx"
135 #define DT_PWMS_CELL_BY_IDX(node_id, idx, cell) \  argument
136 	DT_PHA_BY_IDX(node_id, pwms, idx, cell)
139  * @brief Get a PWM specifier's cell value by name
143  *     pwm1: pwm-controller@... {
145  *             #pwm-cells = <2>;
148  *     pwm2: pwm-controller@... {
150  *             #pwm-cells = <2>;
156  *             pwm-names = "alpha", "beta";
161  *     pwm-cells:
162  *       - channel
163  *       - period
164  *       - flags
176  * @param name lowercase-and-underscores name of a pwms element
177  *             as defined by the node's pwm-names property
178  * @param cell lowercase-and-underscores cell name
179  * @return the cell value in the specifier at the named element
182 #define DT_PWMS_CELL_BY_NAME(node_id, name, cell) \  argument
183 	DT_PHA_BY_NAME(node_id, pwms, name, cell)
186  * @brief Equivalent to DT_PWMS_CELL_BY_IDX(node_id, 0, cell)
188  * @param cell lowercase-and-underscores cell name
189  * @return the cell value at index 0
192 #define DT_PWMS_CELL(node_id, cell) DT_PWMS_CELL_BY_IDX(node_id, 0, cell)  argument
195  * @brief Get a PWM specifier's channel cell value at an index
204  * @return the channel cell value at index "idx"
211  * @brief Get a PWM specifier's channel cell value by name
219  * @param name lowercase-and-underscores name of a pwms element
220  *             as defined by the node's pwm-names property
221  * @return the channel cell value in the specifier at the named element
230  * @return the channel cell value at index 0
236  * @brief Get PWM specifier's period cell value at an index
245  * @return the period cell value at index "idx"
252  * @brief Get a PWM specifier's period cell value by name
260  * @param name lowercase-and-underscores name of a pwms element
261  *             as defined by the node's pwm-names property
262  * @return the period cell value in the specifier at the named element
271  * @return the period cell value at index 0
277  * @brief Get a PWM specifier's flags cell value at an index
280  * If there is no "flags" cell in the PWM specifier, zero is returned.
281  * Refer to the node's binding to check specifier cell names if necessary.
287  * @return the flags cell value at index "idx", or zero if there is none
294  * @brief Get a PWM specifier's flags cell value by name
297  * If there is no "flags" cell in the PWM specifier, zero is returned.
298  * Refer to the node's binding to check specifier cell names if necessary.
301  * there is a flags cell, but expands to zero if there is none.
304  * @param name lowercase-and-underscores name of a pwms element
305  *             as defined by the node's pwm-names property
306  * @return the flags cell value in the specifier at the named element,
316  * @return the flags cell value at index 0, or zero if there is none
338  * @param name lowercase-and-underscores name of a pwms element
339  *             as defined by the node's pwm-names property
356  * @brief Get a DT_DRV_COMPAT instance's PWM specifier's cell value
360  * @param cell lowercase-and-underscores cell name
361  * @return the cell value at index "idx"
363 #define DT_INST_PWMS_CELL_BY_IDX(inst, idx, cell) \  argument
364 	DT_PWMS_CELL_BY_IDX(DT_DRV_INST(inst), idx, cell)
367  * @brief Get a DT_DRV_COMPAT instance's PWM specifier's cell value by name
369  * @param name lowercase-and-underscores name of a pwms element
370  *             as defined by the node's pwm-names property
371  * @param cell lowercase-and-underscores cell name
372  * @return the cell value in the specifier at the named element
375 #define DT_INST_PWMS_CELL_BY_NAME(inst, name, cell) \  argument
376 	DT_PWMS_CELL_BY_NAME(DT_DRV_INST(inst), name, cell)
379  * @brief Equivalent to DT_INST_PWMS_CELL_BY_IDX(inst, 0, cell)
381  * @param cell lowercase-and-underscores cell name
382  * @return the cell value at index 0
384 #define DT_INST_PWMS_CELL(inst, cell) \  argument
385 	DT_INST_PWMS_CELL_BY_IDX(inst, 0, cell)
391  * @return the channel cell value at index "idx"
400  * @param name lowercase-and-underscores name of a pwms element
401  *             as defined by the node's pwm-names property
402  * @return the channel cell value in the specifier at the named element
411  * @return the channel cell value at index 0
420  * @return the period cell value at index "idx"
429  * @param name lowercase-and-underscores name of a pwms element
430  *             as defined by the node's pwm-names property
431  * @return the period cell value in the specifier at the named element
440  * @return the period cell value at index 0
449  * @return the flags cell value at index "idx", or zero if there is none
458  * @param name lowercase-and-underscores name of a pwms element
459  *             as defined by the node's pwm-names property
460  * @return the flags cell value in the specifier at the named element,
470  * @return the flags cell value at index 0, or zero if there is none