1 /*
2  * Copyright (c) 2024 STMicroelectronics
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 #ifndef ZEPHYR_INCLUDE_DT_BINDINGS_CLOCK_STM32U0_CLOCK_H_
7 #define ZEPHYR_INCLUDE_DT_BINDINGS_CLOCK_STM32U0_CLOCK_H_
8 
9 #include "stm32_common_clocks.h"
10 
11 /** Bus gatting clocks */
12 #define STM32_CLOCK_BUS_AHB1    0x48
13 #define STM32_CLOCK_BUS_IOP     0x4C
14 #define STM32_CLOCK_BUS_APB1    0x58
15 #define STM32_CLOCK_BUS_APB1_2  0x60
16 
17 #define STM32_PERIPH_BUS_MIN	STM32_CLOCK_BUS_AHB1
18 #define STM32_PERIPH_BUS_MAX	STM32_CLOCK_BUS_APB1_2
19 
20 /** Domain clocks */
21 /* RM0503, clock configuration register (RCC_CCIPR) */
22 
23 /** System clock */
24 /* defined in stm32_common_clocks.h */
25 
26 /** Fixed clocks  */
27 /* Low speed clocks defined in stm32_common_clocks.h */
28 #define STM32_SRC_HSI		(STM32_SRC_LSI + 1)
29 #define STM32_SRC_HSI48		(STM32_SRC_HSI + 1)
30 #define STM32_SRC_MSI		(STM32_SRC_HSI48 + 1)
31 #define STM32_SRC_HSE		(STM32_SRC_MSI + 1)
32 /** Peripheral bus clock */
33 #define STM32_SRC_PCLK		(STM32_SRC_HSE + 1)
34 /** PLL clock outputs */
35 #define STM32_SRC_PLL_P		(STM32_SRC_PCLK + 1)
36 #define STM32_SRC_PLL_Q		(STM32_SRC_PLL_P + 1)
37 #define STM32_SRC_PLL_R		(STM32_SRC_PLL_Q + 1)
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 
48 /**
49  * @brief STM32 clock configuration bit field.
50  *
51  * - reg   (1/2/3)         [ 0 : 7 ]
52  * - shift (0..31)         [ 8 : 12 ]
53  * - mask  (0x1, 0x3, 0x7) [ 13 : 15 ]
54  * - val   (0..7)          [ 16 : 18 ]
55  *
56  * @param reg RCC_CCIPRx register offset
57  * @param shift Position within RCC_CCIPRx.
58  * @param mask Mask for the RCC_CCIPRx field.
59  * @param val Clock value (0, 1, ... 7).
60  */
61 #define STM32_DOMAIN_CLOCK(val, mask, shift, reg)					\
62 	((((reg) & STM32_CLOCK_REG_MASK) << STM32_CLOCK_REG_SHIFT) |		\
63 	 (((shift) & STM32_CLOCK_SHIFT_MASK) << STM32_CLOCK_SHIFT_SHIFT) |	\
64 	 (((mask) & STM32_CLOCK_MASK_MASK) << STM32_CLOCK_MASK_SHIFT) |		\
65 	 (((val) & STM32_CLOCK_VAL_MASK) << STM32_CLOCK_VAL_SHIFT))
66 
67 /** @brief RCC_CCIPR register offset */
68 #define CCIPR_REG		0x88
69 
70 /** @brief RCC_BDCR register offset */
71 #define BDCR_REG		0x90
72 
73 /** @brief Device domain clocks selection helpers */
74 /** CCIPR devices */
75 #define USART1_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 0, CCIPR_REG)
76 #define USART2_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 2, CCIPR_REG)
77 #define LPUART3_SEL(val)	STM32_DOMAIN_CLOCK(val, 3, 6, CCIPR_REG)
78 #define LPUART2_SEL(val)	STM32_DOMAIN_CLOCK(val, 3, 8, CCIPR_REG)
79 #define LPUART1_SEL(val)	STM32_DOMAIN_CLOCK(val, 3, 10, CCIPR_REG)
80 #define I2C1_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 12, CCIPR_REG)
81 #define I2C3_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 16, CCIPR_REG)
82 #define LPTIM1_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 18, CCIPR_REG)
83 #define LPTIM2_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 20, CCIPR_REG)
84 #define LPTIM3_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 22, CCIPR_REG)
85 #define TIM1_SEL(val)		STM32_DOMAIN_CLOCK(val, 1, 24, CCIPR_REG)
86 #define TIM15_SEL(val)		STM32_DOMAIN_CLOCK(val, 1, 25, CCIPR_REG)
87 #define CLK48_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 26, CCIPR_REG)
88 #define ADC_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 28, CCIPR_REG)
89 /** BDCR devices */
90 #define RTC_SEL(val)		STM32_DOMAIN_CLOCK(val, 3, 8, BDCR_REG)
91 
92 #endif /* ZEPHYR_INCLUDE_DT_BINDINGS_CLOCK_STM32U0_CLOCK_H_ */
93