1 /* 2 * Copyright (c) 2022-2023 HPMicro 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 * 6 */ 7 #ifndef HPM_CLOCK_DRV_H 8 #define HPM_CLOCK_DRV_H 9 10 #include "hpm_common.h" 11 #include "hpm_sysctl_drv.h" 12 #include "hpm_csr_drv.h" 13 14 15 /** 16 * @brief Error codes for clock driver 17 */ 18 enum { 19 status_clk_div_invalid = MAKE_STATUS(status_group_clk, 0), 20 status_clk_src_invalid = MAKE_STATUS(status_group_clk, 1), 21 status_clk_invalid = MAKE_STATUS(status_group_clk, 2), 22 status_clk_operation_unsupported = MAKE_STATUS(status_group_clk, 3), 23 status_clk_shared_ahb = MAKE_STATUS(status_group_clk, 4), 24 status_clk_shared_axi0 = MAKE_STATUS(status_group_clk, 5), 25 status_clk_shared_axi1 = MAKE_STATUS(status_group_clk, 6), 26 status_clk_shared_axi2 = MAKE_STATUS(status_group_clk, 7), 27 status_clk_shared_cpu0 = MAKE_STATUS(status_group_clk, 8), 28 status_clk_shared_cpu1 = MAKE_STATUS(status_group_clk, 9), 29 status_clk_fixed = MAKE_STATUS(status_group_clk, 10), 30 31 }; 32 33 34 35 /** 36 * @brief Clock source group definitions 37 */ 38 #define CLK_SRC_GROUP_COMMON (0U) 39 #define CLK_SRC_GROUP_ADC (1U) 40 #define CLK_SRC_GROUP_WDG (3U) 41 #define CLK_SRC_GROUP_PMIC (4U) 42 #define CLK_SRC_GROUP_AHB (5U) 43 #define CLK_SRC_GROUP_AXI (6U) 44 #define CLK_SRC_GROUP_DAC (7U) 45 #define CLK_SRC_GROUP_CPU0 (9U) 46 #define CLK_SRC_GROUP_SRC (10U) 47 #define CLK_SRC_GROUP_PWDG (11U) 48 #define CLK_SRC_GROUP_INVALID (15U) 49 50 #define MAKE_CLK_SRC(src_grp, index) (((uint8_t)(src_grp)<<4) | (index)) 51 #define GET_CLK_SRC_GROUP(src) (((uint8_t)(src)>>4) & 0x0FU) 52 #define GET_CLK_SRC_INDEX(src) ((uint8_t)(src) & 0x0FU) 53 54 #define GET_CLOCK_SOURCE_FROM_CLK_SRC(clk_src) (clock_source_t)((uint32_t)(clk_src) & 0xFU) 55 56 /** 57 * @brief Clock source definitions 58 */ 59 typedef enum _clock_sources { 60 clk_src_osc24m = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 0), 61 clk_src_pll0_clk0 = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 1), 62 clk_src_pll0_clk1 = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 2), 63 clk_src_pll0_clk2 = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 3), 64 clk_src_pll1_clk0 = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 4), 65 clk_src_pll1_clk1 = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 5), 66 clk_src_pll2_clk0 = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 6), 67 clk_src_pll2_clk1 = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 7), 68 clk_src_osc32k = MAKE_CLK_SRC(CLK_SRC_GROUP_COMMON, 8), 69 70 clk_adc_src_ana0 = MAKE_CLK_SRC(CLK_SRC_GROUP_ADC, 0), 71 clk_adc_src_ana1 = MAKE_CLK_SRC(CLK_SRC_GROUP_ADC, 0), 72 clk_adc_src_ana2 = MAKE_CLK_SRC(CLK_SRC_GROUP_ADC, 0), 73 clk_adc_src_ahb0 = MAKE_CLK_SRC(CLK_SRC_GROUP_ADC, 1), 74 75 clk_dac_src_ana3 = MAKE_CLK_SRC(CLK_SRC_GROUP_DAC, 0), 76 clk_dac_src_ana4 = MAKE_CLK_SRC(CLK_SRC_GROUP_DAC, 0), 77 clk_dac_src_ahb0 = MAKE_CLK_SRC(CLK_SRC_GROUP_DAC, 1), 78 79 clk_wdg_src_ahb0 = MAKE_CLK_SRC(CLK_SRC_GROUP_WDG, 0), 80 clk_wdg_src_osc32k = MAKE_CLK_SRC(CLK_SRC_GROUP_WDG, 1), 81 82 clk_pwdg_src_osc24m = MAKE_CLK_SRC(CLK_SRC_GROUP_PWDG, 0), 83 clk_pwdg_src_osc32k = MAKE_CLK_SRC(CLK_SRC_GROUP_PWDG, 1), 84 85 clk_src_invalid = MAKE_CLK_SRC(CLK_SRC_GROUP_INVALID, 15), 86 } clk_src_t; 87 88 89 #define RESOURCE_INVALID (0xFFFFU) 90 #define RESOURCE_SHARED_CPU0 (0xFFFDU) 91 92 /* Clock NAME related Macros */ 93 #define MAKE_CLOCK_NAME(resource, src_type, node) (((uint32_t)(resource) << 16) | ((uint32_t)(src_type) << 8) | ((uint32_t)(node))) 94 #define GET_CLK_SRC_GROUP_FROM_NAME(name) (((uint32_t)(name) >> 8) & 0xFFUL) 95 #define GET_CLK_NODE_FROM_NAME(name) ((uint32_t)(name) & 0xFFUL) 96 #define GET_CLK_RESOURCE_FROM_NAME(name) ((uint32_t)(name) >> 16) 97 98 /** 99 * @brief Peripheral Clock Type Description 100 */ 101 typedef enum _clock_name { 102 clock_cpu0 = MAKE_CLOCK_NAME(sysctl_resource_cpu0, CLK_SRC_GROUP_CPU0, clock_node_cpu0), 103 clock_mchtmr0 = MAKE_CLOCK_NAME(sysctl_resource_mchtmr0, CLK_SRC_GROUP_COMMON, clock_node_mchtmr0), 104 clock_cpu1 = MAKE_CLOCK_NAME(sysctl_resource_cpu1, CLK_SRC_GROUP_CPU0, clock_node_cpu1), 105 clock_mchtmr1 = MAKE_CLOCK_NAME(sysctl_resource_mchtmr1, CLK_SRC_GROUP_COMMON, clock_node_mchtmr1), 106 clock_xpi0 = MAKE_CLOCK_NAME(sysctl_resource_xpi0, CLK_SRC_GROUP_COMMON, clock_node_xpi0), 107 clock_gptmr0 = MAKE_CLOCK_NAME(sysctl_resource_gptmr0, CLK_SRC_GROUP_COMMON, clock_node_gptmr0), 108 clock_gptmr1 = MAKE_CLOCK_NAME(sysctl_resource_gptmr1, CLK_SRC_GROUP_COMMON, clock_node_gptmr1), 109 clock_gptmr2 = MAKE_CLOCK_NAME(sysctl_resource_gptmr2, CLK_SRC_GROUP_COMMON, clock_node_gptmr2), 110 clock_gptmr3 = MAKE_CLOCK_NAME(sysctl_resource_gptmr3, CLK_SRC_GROUP_COMMON, clock_node_gptmr3), 111 clock_uart0 = MAKE_CLOCK_NAME(sysctl_resource_uart0, CLK_SRC_GROUP_COMMON, clock_node_uart0), 112 clock_uart1 = MAKE_CLOCK_NAME(sysctl_resource_uart1, CLK_SRC_GROUP_COMMON, clock_node_uart1), 113 clock_uart2 = MAKE_CLOCK_NAME(sysctl_resource_uart2, CLK_SRC_GROUP_COMMON, clock_node_uart2), 114 clock_uart3 = MAKE_CLOCK_NAME(sysctl_resource_uart3, CLK_SRC_GROUP_COMMON, clock_node_uart3), 115 clock_uart4 = MAKE_CLOCK_NAME(sysctl_resource_uart4, CLK_SRC_GROUP_COMMON, clock_node_uart4), 116 clock_uart5 = MAKE_CLOCK_NAME(sysctl_resource_uart5, CLK_SRC_GROUP_COMMON, clock_node_uart5), 117 clock_uart6 = MAKE_CLOCK_NAME(sysctl_resource_uart6, CLK_SRC_GROUP_COMMON, clock_node_uart6), 118 clock_uart7 = MAKE_CLOCK_NAME(sysctl_resource_uart7, CLK_SRC_GROUP_COMMON, clock_node_uart7), 119 clock_i2c0 = MAKE_CLOCK_NAME(sysctl_resource_i2c0, CLK_SRC_GROUP_COMMON, clock_node_i2c0), 120 clock_i2c1 = MAKE_CLOCK_NAME(sysctl_resource_i2c1, CLK_SRC_GROUP_COMMON, clock_node_i2c1), 121 clock_i2c2 = MAKE_CLOCK_NAME(sysctl_resource_i2c2, CLK_SRC_GROUP_COMMON, clock_node_i2c2), 122 clock_i2c3 = MAKE_CLOCK_NAME(sysctl_resource_i2c3, CLK_SRC_GROUP_COMMON, clock_node_i2c3), 123 clock_spi0 = MAKE_CLOCK_NAME(sysctl_resource_spi0, CLK_SRC_GROUP_COMMON, clock_node_spi0), 124 clock_spi1 = MAKE_CLOCK_NAME(sysctl_resource_spi1, CLK_SRC_GROUP_COMMON, clock_node_spi1), 125 clock_spi2 = MAKE_CLOCK_NAME(sysctl_resource_spi2, CLK_SRC_GROUP_COMMON, clock_node_spi2), 126 clock_spi3 = MAKE_CLOCK_NAME(sysctl_resource_spi3, CLK_SRC_GROUP_COMMON, clock_node_spi3), 127 clock_can0 = MAKE_CLOCK_NAME(sysctl_resource_can0, CLK_SRC_GROUP_COMMON, clock_node_can0), 128 clock_can1 = MAKE_CLOCK_NAME(sysctl_resource_can1, CLK_SRC_GROUP_COMMON, clock_node_can1), 129 clock_can2 = MAKE_CLOCK_NAME(sysctl_resource_can2, CLK_SRC_GROUP_COMMON, clock_node_can2), 130 clock_can3 = MAKE_CLOCK_NAME(sysctl_resource_can3, CLK_SRC_GROUP_COMMON, clock_node_can3), 131 clock_lin0 = MAKE_CLOCK_NAME(sysctl_resource_lin0, CLK_SRC_GROUP_COMMON, clock_node_lin0), 132 clock_lin1 = MAKE_CLOCK_NAME(sysctl_resource_lin1, CLK_SRC_GROUP_COMMON, clock_node_lin1), 133 clock_lin2 = MAKE_CLOCK_NAME(sysctl_resource_lin2, CLK_SRC_GROUP_COMMON, clock_node_lin2), 134 clock_lin3 = MAKE_CLOCK_NAME(sysctl_resource_lin3, CLK_SRC_GROUP_COMMON, clock_node_lin3), 135 136 clock_ahb = MAKE_CLOCK_NAME(RESOURCE_SHARED_CPU0, CLK_SRC_GROUP_AHB, clock_node_ahb), 137 clock_axi = MAKE_CLOCK_NAME(RESOURCE_SHARED_CPU0, CLK_SRC_GROUP_AXI, clock_node_axi), 138 clock_axic = MAKE_CLOCK_NAME(sysctl_resource_axic, CLK_SRC_GROUP_AXI, clock_node_axi), 139 clock_axis = MAKE_CLOCK_NAME(sysctl_resource_axis, CLK_SRC_GROUP_AXI, clock_node_axi), 140 clock_ahbp = MAKE_CLOCK_NAME(sysctl_resource_ahbp, CLK_SRC_GROUP_AHB, clock_node_ahb), 141 142 clock_ptpc = MAKE_CLOCK_NAME(sysctl_resource_ptpc, CLK_SRC_GROUP_COMMON, clock_node_ptpc), 143 clock_ref0 = MAKE_CLOCK_NAME(sysctl_resource_ref0, CLK_SRC_GROUP_COMMON, clock_node_ref0), 144 clock_ref1 = MAKE_CLOCK_NAME(sysctl_resource_ref1, CLK_SRC_GROUP_COMMON, clock_node_ref0), 145 clock_watchdog0 = MAKE_CLOCK_NAME(sysctl_resource_wdg0, CLK_SRC_GROUP_WDG, 0), 146 clock_watchdog1 = MAKE_CLOCK_NAME(sysctl_resource_wdg1, CLK_SRC_GROUP_WDG, 1), 147 clock_puart = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_PMIC, 0), 148 clock_pwdg = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_PWDG, 0), 149 clock_sdp = MAKE_CLOCK_NAME(sysctl_resource_sdp0, CLK_SRC_GROUP_AXI, 0), 150 clock_xdma = MAKE_CLOCK_NAME(sysctl_resource_dma1, CLK_SRC_GROUP_AXI, 1), 151 clock_rom = MAKE_CLOCK_NAME(sysctl_resource_rom0, CLK_SRC_GROUP_AXI, 2), 152 clock_ram0 = MAKE_CLOCK_NAME(sysctl_resource_ram0, CLK_SRC_GROUP_AXI, 3), 153 clock_usb0 = MAKE_CLOCK_NAME(sysctl_resource_usb0, CLK_SRC_GROUP_AXI, 4), 154 clock_kman = MAKE_CLOCK_NAME(sysctl_resource_kman, CLK_SRC_GROUP_AHB, 0), 155 clock_gpio = MAKE_CLOCK_NAME(sysctl_resource_gpio, CLK_SRC_GROUP_AHB, 1), 156 clock_mbx0 = MAKE_CLOCK_NAME(sysctl_resource_mbx0, CLK_SRC_GROUP_AHB, 2), 157 clock_hdma = MAKE_CLOCK_NAME(sysctl_resource_dma0, CLK_SRC_GROUP_AHB, 3), 158 clock_rng = MAKE_CLOCK_NAME(sysctl_resource_rng0, CLK_SRC_GROUP_AHB, 4), 159 clock_mot0 = MAKE_CLOCK_NAME(sysctl_resource_mot0, CLK_SRC_GROUP_AHB, 5), 160 clock_mot1 = MAKE_CLOCK_NAME(sysctl_resource_mot1, CLK_SRC_GROUP_AHB, 6), 161 clock_mot2 = MAKE_CLOCK_NAME(sysctl_resource_mot2, CLK_SRC_GROUP_AHB, 7), 162 clock_mot3 = MAKE_CLOCK_NAME(sysctl_resource_mot3, CLK_SRC_GROUP_AHB, 8), 163 clock_crc0 = MAKE_CLOCK_NAME(sysctl_resource_crc0, CLK_SRC_GROUP_AHB, 9), 164 clock_acmp = MAKE_CLOCK_NAME(sysctl_resource_acmp, CLK_SRC_GROUP_AHB, 10), 165 clock_msyn = MAKE_CLOCK_NAME(sysctl_resource_msyn, CLK_SRC_GROUP_AHB, 11), 166 clock_sdm0 = MAKE_CLOCK_NAME(sysctl_resource_sdm0, CLK_SRC_GROUP_AHB, 13), 167 clock_mbx1 = MAKE_CLOCK_NAME(sysctl_resource_mbx1, CLK_SRC_GROUP_AHB, 14), 168 clock_lmm0 = MAKE_CLOCK_NAME(sysctl_resource_lmm0, CLK_SRC_GROUP_CPU0, 0), 169 clock_lmm1 = MAKE_CLOCK_NAME(sysctl_resource_lmm1, CLK_SRC_GROUP_CPU0, 1), 170 clock_tsns = MAKE_CLOCK_NAME(sysctl_resource_tsns, CLK_SRC_GROUP_CPU0, 2), 171 172 173 /* For ADC, there are 2-stage clock source and divider configurations */ 174 clock_ana0 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_COMMON, clock_node_ana0), 175 clock_ana1 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_COMMON, clock_node_ana1), 176 clock_ana2 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_COMMON, clock_node_ana2), 177 clock_adc0 = MAKE_CLOCK_NAME(sysctl_resource_adc0, CLK_SRC_GROUP_ADC, 0), 178 clock_adc1 = MAKE_CLOCK_NAME(sysctl_resource_adc1, CLK_SRC_GROUP_ADC, 1), 179 clock_adc2 = MAKE_CLOCK_NAME(sysctl_resource_adc2, CLK_SRC_GROUP_ADC, 2), 180 181 /* For DAC, there are 2-stage clock source and divider configurations */ 182 clock_ana3 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_COMMON, clock_node_ana3), 183 clock_ana4 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_COMMON, clock_node_ana4), 184 clock_dac0 = MAKE_CLOCK_NAME(sysctl_resource_dac0, CLK_SRC_GROUP_DAC, 0), 185 clock_dac1 = MAKE_CLOCK_NAME(sysctl_resource_dac1, CLK_SRC_GROUP_DAC, 1), 186 187 /* Clock sources */ 188 clk_osc0clk0 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 0), 189 clk_pll0clk0 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 1), 190 clk_pll0clk1 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 2), 191 clk_pll0clk2 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 3), 192 clk_pll1clk0 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 4), 193 clk_pll1clk1 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 5), 194 clk_pll2clk0 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 6), 195 clk_pll2clk1 = MAKE_CLOCK_NAME(RESOURCE_INVALID, CLK_SRC_GROUP_SRC, 7), 196 } clock_name_t; 197 198 extern uint32_t hpm_core_clock; 199 200 #ifdef __cplusplus 201 extern "C" { 202 #endif 203 204 /** 205 * @brief Get specified IP frequency 206 * @param[in] clock_name IP clock name 207 * 208 * @return IP clock frequency in Hz 209 */ 210 uint32_t clock_get_frequency(clock_name_t clock_name); 211 212 /** 213 * @brief Get Clock frequency for selected clock source 214 * @param [in] source clock source 215 * @return clock frequency for selected clock source 216 */ 217 uint32_t get_frequency_for_source(clock_source_t source); 218 219 /** 220 * @brief Get the IP clock source 221 * Note: This API return the direct clock source 222 * @param [in] clock_name clock name 223 * @return IP clock source 224 */ 225 clk_src_t clock_get_source(clock_name_t clock_name); 226 227 /** 228 * @brief Set ADC clock source 229 * @param[in] clock_name ADC clock name 230 * @param[in] src ADC clock source 231 * 232 * @return #status_success Setting ADC clock source is successful 233 * #status_clk_invalid Invalid ADC clock 234 * #status_clk_src_invalid Invalid ADC clock source 235 */ 236 hpm_stat_t clock_set_adc_source(clock_name_t clock_name, clk_src_t src); 237 238 /** 239 * @brief Set DAC clock source 240 * @param[in] clock_name DAC clock name 241 * @param[in] src DAC clock source 242 * 243 * @return #status_success Setting DAC clock source is successful 244 * #status_clk_invalid Invalid DAC clock 245 * #status_clk_src_invalid Invalid DAC clock source 246 */ 247 hpm_stat_t clock_set_dac_source(clock_name_t clock_name, clk_src_t src); 248 249 /** 250 * @brief Set the IP clock source and divider 251 * @param[in] clock_name clock name 252 * @param[in] src clock source 253 * @param[in] div clock divider, valid range (1 - 256) 254 * 255 * @return #status_success Setting Clock source and divider is successful. 256 * #status_clk_src_invalid clock source is invalid. 257 * #status_clk_fixed clock source and divider is a fixed value 258 * #status_clk_shared_ahb Clock is shared with the AHB clock 259 * #status_clk_shared_axi0 Clock is shared with the AXI0 clock 260 * #status_clk_shared_axi1 CLock is shared with the AXI1 clock 261 * #status_clk_shared_axi2 Clock is shared with the AXI2 clock 262 * #status_clk_shared_cpu0 Clock is shared with the CPU0 clock 263 * #status_clk_shared_cpu1 Clock is shared with the CPU1 clock 264 */ 265 hpm_stat_t clock_set_source_divider(clock_name_t clock_name, clk_src_t src, uint32_t div); 266 267 /** 268 * @brief Enable IP clock 269 * @param[in] clock_name IP clock name 270 */ 271 void clock_enable(clock_name_t clock_name); 272 273 /** 274 * @brief Disable IP clock 275 * @param[in] clock_name IP clock name 276 */ 277 void clock_disable(clock_name_t clock_name); 278 279 /** 280 * @brief Add IP to specified group 281 * @param[in] clock_name IP clock name 282 * @param[in] group resource group index, valid value: 0/1/2/3 283 */ 284 void clock_add_to_group(clock_name_t clock_name, uint32_t group); 285 286 /** 287 * @brief Remove IP from specified group 288 * @param[in] clock_name IP clock name 289 * @param[in] group resource group index, valid value: 0/1/2/3 290 */ 291 void clock_remove_from_group(clock_name_t clock_name, uint32_t group); 292 293 /** 294 * @brief Check IP in specified group 295 * @param[in] clock_name IP clock name 296 * @return true if in group, false if not in group 297 */ 298 bool clock_check_in_group(clock_name_t clock_name, uint32_t group); 299 300 /** 301 * @brief Disconnect the clock group from specified CPU 302 * @param[in] group clock group index, value value is 0/1/2/3 303 * @param[in] cpu CPU index, valid value is 0/1 304 */ 305 void clock_connect_group_to_cpu(uint32_t group, uint32_t cpu); 306 307 /** 308 * @brief Disconnect the clock group from specified CPU 309 * @param[in] group clock group index, value value is 0/1/2/3 310 * @param[in] cpu CPU index, valid value is 0/1 311 */ 312 void clock_disconnect_group_from_cpu(uint32_t group, uint32_t cpu); 313 314 /** 315 * @brief Delay specified microseconds 316 * 317 * @param [in] us expected delay interval in microseconds 318 */ 319 void clock_cpu_delay_us(uint32_t us); 320 321 /** 322 * @brief Delay specified milliseconds 323 * 324 * @param [in] ms expected delay interval in milliseconds 325 */ 326 void clock_cpu_delay_ms(uint32_t ms); 327 328 /** 329 * @brief Update the Core clock frequency 330 */ 331 void clock_update_core_clock(void); 332 333 334 #ifdef __cplusplus 335 } 336 #endif 337 338 #endif /* HPM_CLOCK_DRV_H */ 339