Skip to content

Commit c28b5d3

Browse files
kartbencarlescufi
authored andcommitted
doc: fix STM32_CLOCK bit field documentation
Fix Doxygen documentation by moving @brief just before STM32_CLOCK definition. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 26d8714 commit c28b5d3

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

include/zephyr/dt-bindings/clock/stm32f1_clock.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@
2424
/** System clock */
2525
#define STM32_SRC_SYSCLK 0x005
2626

27+
28+
#define STM32_CLOCK_REG_MASK 0xFFU
29+
#define STM32_CLOCK_REG_SHIFT 0U
30+
#define STM32_CLOCK_SHIFT_MASK 0x1FU
31+
#define STM32_CLOCK_SHIFT_SHIFT 8U
32+
#define STM32_CLOCK_MASK_MASK 0x7U
33+
#define STM32_CLOCK_MASK_SHIFT 13U
34+
#define STM32_CLOCK_VAL_MASK 0x7U
35+
#define STM32_CLOCK_VAL_SHIFT 16U
36+
2737
/**
2838
* @brief STM32 clock configuration bit field.
2939
*
@@ -37,16 +47,6 @@
3747
* @param mask Mask for the RCC_CFGRx field.
3848
* @param val Clock value (0, 1, ... 7).
3949
*/
40-
41-
#define STM32_CLOCK_REG_MASK 0xFFU
42-
#define STM32_CLOCK_REG_SHIFT 0U
43-
#define STM32_CLOCK_SHIFT_MASK 0x1FU
44-
#define STM32_CLOCK_SHIFT_SHIFT 8U
45-
#define STM32_CLOCK_MASK_MASK 0x7U
46-
#define STM32_CLOCK_MASK_SHIFT 13U
47-
#define STM32_CLOCK_VAL_MASK 0x7U
48-
#define STM32_CLOCK_VAL_SHIFT 16U
49-
5050
#define STM32_CLOCK(val, mask, shift, reg) \
5151
((((reg) & STM32_CLOCK_REG_MASK) << STM32_CLOCK_REG_SHIFT) | \
5252
(((shift) & STM32_CLOCK_SHIFT_MASK) << STM32_CLOCK_SHIFT_SHIFT) | \

include/zephyr/dt-bindings/clock/stm32f4_clock.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@
3636
/* I2S_CKIN not supported yet */
3737
/* #define STM32_SRC_I2S_CKIN 0x008 */
3838

39+
40+
#define STM32_CLOCK_REG_MASK 0xFFU
41+
#define STM32_CLOCK_REG_SHIFT 0U
42+
#define STM32_CLOCK_SHIFT_MASK 0x1FU
43+
#define STM32_CLOCK_SHIFT_SHIFT 8U
44+
#define STM32_CLOCK_MASK_MASK 0x7U
45+
#define STM32_CLOCK_MASK_SHIFT 13U
46+
#define STM32_CLOCK_VAL_MASK 0x7U
47+
#define STM32_CLOCK_VAL_SHIFT 16U
48+
3949
/**
4050
* @brief STM32 clock configuration bit field.
4151
*
@@ -49,16 +59,6 @@
4959
* @param mask Mask for the RCC_CFGRx field.
5060
* @param val Clock value (0, 1, ... 7).
5161
*/
52-
53-
#define STM32_CLOCK_REG_MASK 0xFFU
54-
#define STM32_CLOCK_REG_SHIFT 0U
55-
#define STM32_CLOCK_SHIFT_MASK 0x1FU
56-
#define STM32_CLOCK_SHIFT_SHIFT 8U
57-
#define STM32_CLOCK_MASK_MASK 0x7U
58-
#define STM32_CLOCK_MASK_SHIFT 13U
59-
#define STM32_CLOCK_VAL_MASK 0x7U
60-
#define STM32_CLOCK_VAL_SHIFT 16U
61-
6262
#define STM32_CLOCK(val, mask, shift, reg) \
6363
((((reg) & STM32_CLOCK_REG_MASK) << STM32_CLOCK_REG_SHIFT) | \
6464
(((shift) & STM32_CLOCK_SHIFT_MASK) << STM32_CLOCK_SHIFT_SHIFT) | \

include/zephyr/dt-bindings/clock/stm32f7_clock.h

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,16 @@
3535
/** Peripheral bus clock */
3636
#define STM32_SRC_PCLK 0x007
3737

38+
39+
#define STM32_CLOCK_REG_MASK 0xFFU
40+
#define STM32_CLOCK_REG_SHIFT 0U
41+
#define STM32_CLOCK_SHIFT_MASK 0x1FU
42+
#define STM32_CLOCK_SHIFT_SHIFT 8U
43+
#define STM32_CLOCK_MASK_MASK 0x7U
44+
#define STM32_CLOCK_MASK_SHIFT 13U
45+
#define STM32_CLOCK_VAL_MASK 0x7U
46+
#define STM32_CLOCK_VAL_SHIFT 16U
47+
3848
/**
3949
* @brief STM32 clock configuration bit field.
4050
*
@@ -48,16 +58,6 @@
4858
* @param mask Mask for the RCC_CFGRx field.
4959
* @param val Clock value (0, 1, ... 7).
5060
*/
51-
52-
#define STM32_CLOCK_REG_MASK 0xFFU
53-
#define STM32_CLOCK_REG_SHIFT 0U
54-
#define STM32_CLOCK_SHIFT_MASK 0x1FU
55-
#define STM32_CLOCK_SHIFT_SHIFT 8U
56-
#define STM32_CLOCK_MASK_MASK 0x7U
57-
#define STM32_CLOCK_MASK_SHIFT 13U
58-
#define STM32_CLOCK_VAL_MASK 0x7U
59-
#define STM32_CLOCK_VAL_SHIFT 16U
60-
6161
#define STM32_CLOCK(val, mask, shift, reg) \
6262
((((reg) & STM32_CLOCK_REG_MASK) << STM32_CLOCK_REG_SHIFT) | \
6363
(((shift) & STM32_CLOCK_SHIFT_MASK) << STM32_CLOCK_SHIFT_SHIFT) | \

0 commit comments

Comments
 (0)