Skip to content

Commit

Permalink
doc: fix NUMICRO_PINMUX bit field documentation
Browse files Browse the repository at this point in the history
Fix Doxygen documentation by moving @brief just before NUMICRO_PINMUX
definition.

Signed-off-by: Benjamin Cabé <[email protected]>
  • Loading branch information
kartben authored and carlescufi committed May 17, 2023
1 parent dfd0eed commit d793764
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions include/zephyr/dt-bindings/pinctrl/numicro-pinctrl.h
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
#ifndef ZEPHYR_INCLUDE_DT_BINDINGS_PINCTRL_NUMICRO_PINCTRL_H_
#define ZEPHYR_INCLUDE_DT_BINDINGS_PINCTRL_NUMICRO_PINCTRL_H_

#define NUMICRO_MFP_SHIFT 0U
#define NUMICRO_MFP_MASK 0xFU
#define NUMICRO_PIN_SHIFT 4U
#define NUMICRO_PIN_MASK 0xFU
#define NUMICRO_PORT_SHIFT 8U
#define NUMICRO_PORT_MASK 0xFU

/**
* @brief Pin configuration configuration bit field.
*
Expand All @@ -20,13 +27,6 @@
* @param pin Pin (0..15)
* @param mfp Multi-function value (0..15)
*/
#define NUMICRO_MFP_SHIFT 0U
#define NUMICRO_MFP_MASK 0xFU
#define NUMICRO_PIN_SHIFT 4U
#define NUMICRO_PIN_MASK 0xFU
#define NUMICRO_PORT_SHIFT 8U
#define NUMICRO_PORT_MASK 0xFU

#define NUMICRO_PINMUX(port, pin, mfp) \
(((((port) - 'A') & NUMICRO_PORT_MASK) << NUMICRO_PORT_SHIFT) | \
(((pin) & NUMICRO_PIN_MASK) << NUMICRO_PIN_SHIFT) | \
Expand Down

0 comments on commit d793764

Please sign in to comment.