Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Data Structures | Macros
stm32_clock_control.h File Reference
#include <zephyr/drivers/clock_control.h>
#include <zephyr/dt-bindings/clock/stm32_clock.h>

Go to the source code of this file.

Data Structures

struct  stm32_pclken
 Driver structure definition. More...
 

Macros

#define STM32_CLOCK_CONTROL_NODE   DT_NODELABEL(rcc)
 Common clock control device node for all STM32 chips.
 
#define STM32_AHB_PRESCALER   DT_PROP(DT_NODELABEL(rcc), ahb_prescaler)
 RCC node related symbols.
 
#define STM32_APB1_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb1_prescaler)
 
#define STM32_APB2_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb2_prescaler)
 
#define STM32_APB3_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb3_prescaler)
 
#define STM32_APB5_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb5_prescaler)
 
#define STM32_APB7_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb7_prescaler)
 
#define STM32_AHB3_PRESCALER   DT_PROP(DT_NODELABEL(rcc), ahb3_prescaler)
 
#define STM32_AHB4_PRESCALER   DT_PROP(DT_NODELABEL(rcc), ahb4_prescaler)
 
#define STM32_AHB5_PRESCALER   DT_PROP_OR(DT_NODELABEL(rcc), ahb5_prescaler, 1)
 
#define STM32_CPU1_PRESCALER   DT_PROP(DT_NODELABEL(rcc), cpu1_prescaler)
 
#define STM32_CPU2_PRESCALER   DT_PROP(DT_NODELABEL(rcc), cpu2_prescaler)
 
#define STM32_FLASH_PRESCALER   STM32_CORE_PRESCALER
 
#define STM32_ADC_PRESCALER   DT_PROP(DT_NODELABEL(rcc), adc_prescaler)
 
#define STM32_ADC12_PRESCALER   DT_PROP(DT_NODELABEL(rcc), adc12_prescaler)
 
#define STM32_ADC34_PRESCALER   DT_PROP(DT_NODELABEL(rcc), adc34_prescaler)
 
#define STM32_D1CPRE   DT_PROP(DT_NODELABEL(rcc), d1cpre)
 STM2H7RS specific RCC dividers.
 
#define STM32_HPRE   DT_PROP(DT_NODELABEL(rcc), hpre)
 
#define STM32_D2PPRE1   DT_PROP(DT_NODELABEL(rcc), d2ppre1)
 
#define STM32_D2PPRE2   DT_PROP(DT_NODELABEL(rcc), d2ppre2)
 
#define STM32_D1PPRE   DT_PROP(DT_NODELABEL(rcc), d1ppre)
 
#define STM32_D3PPRE   DT_PROP(DT_NODELABEL(rcc), d3ppre)
 
#define STM32_AHB5_DIV   DT_PROP(DT_NODELABEL(rcc), ahb5_div)
 STM2WBA specifics RCC dividers.
 
#define DT_RCC_CLOCKS_CTRL   DT_CLOCKS_CTLR(DT_NODELABEL(rcc))
 
#define STM32_LSE_ENABLED   0
 PLL node related symbols.
 
#define STM32_LSE_FREQ   0
 
#define STM32_LSE_DRIVING   0
 
#define STM32_LSE_BYPASS   0
 
#define STM32_MSIS_ENABLED   0
 
#define STM32_MSIS_RANGE   0
 
#define STM32_MSIS_PLL_MODE   0
 
#define STM32_MSIK_ENABLED   0
 
#define STM32_MSIK_RANGE   0
 
#define STM32_MSIK_PLL_MODE   0
 
#define STM32_CSI_FREQ   0
 
#define STM32_LSI_FREQ   0
 
#define STM32_HSI_DIV_ENABLED   0
 
#define STM32_HSI_DIVISOR   1
 
#define STM32_HSI_FREQ   0
 
#define STM32_HSE_FREQ   0
 
#define STM32_CLOCK_INFO(clk_index, node_id)
 Device tree clocks helpers

 
#define STM32_DT_CLOCKS(node_id)
 
#define STM32_DT_INST_CLOCKS(inst)
 
#define STM32_DOMAIN_CLOCK_INST_SUPPORT(inst)
 
#define STM32_DT_INST_DEV_DOMAIN_CLOCK_SUPPORT    (DT_INST_FOREACH_STATUS_OKAY(STM32_DOMAIN_CLOCK_INST_SUPPORT) 0)
 
#define STM32_DOMAIN_CLOCK_SUPPORT(id)
 
#define STM32_DT_DEV_DOMAIN_CLOCK_SUPPORT    (DT_FOREACH_STATUS_OKAY(STM32_DOMAIN_CLOCK_SUPPORT) 0)
 
#define STM32_CLOCK_REG_GET(clock)
 Clock source binding accessors.
 
#define STM32_CLOCK_SHIFT_GET(clock)
 Obtain position field from clock configuration.
 
#define STM32_CLOCK_MASK_GET(clock)
 Obtain mask field from clock configuration.
 
#define STM32_CLOCK_VAL_GET(clock)
 Obtain value field from clock configuration.
 
#define STM32_MCO_CFGR_REG_GET(mco_cfgr)
 Obtain register field from MCO configuration.
 
#define STM32_MCO_CFGR_SHIFT_GET(mco_cfgr)
 Obtain position field from MCO configuration.
 
#define STM32_MCO_CFGR_MASK_GET(mco_cfgr)
 Obtain mask field from MCO configuration.
 
#define STM32_MCO_CFGR_VAL_GET(mco_cfgr)
 Obtain value field from MCO configuration.
 

Macro Definition Documentation

◆ DT_RCC_CLOCKS_CTRL

#define DT_RCC_CLOCKS_CTRL   DT_CLOCKS_CTLR(DT_NODELABEL(rcc))

◆ STM32_ADC12_PRESCALER

#define STM32_ADC12_PRESCALER   DT_PROP(DT_NODELABEL(rcc), adc12_prescaler)

◆ STM32_ADC34_PRESCALER

#define STM32_ADC34_PRESCALER   DT_PROP(DT_NODELABEL(rcc), adc34_prescaler)

◆ STM32_ADC_PRESCALER

#define STM32_ADC_PRESCALER   DT_PROP(DT_NODELABEL(rcc), adc_prescaler)

◆ STM32_AHB3_PRESCALER

#define STM32_AHB3_PRESCALER   DT_PROP(DT_NODELABEL(rcc), ahb3_prescaler)

◆ STM32_AHB4_PRESCALER

#define STM32_AHB4_PRESCALER   DT_PROP(DT_NODELABEL(rcc), ahb4_prescaler)

◆ STM32_AHB5_DIV

#define STM32_AHB5_DIV   DT_PROP(DT_NODELABEL(rcc), ahb5_div)

STM2WBA specifics RCC dividers.

◆ STM32_AHB5_PRESCALER

#define STM32_AHB5_PRESCALER   DT_PROP_OR(DT_NODELABEL(rcc), ahb5_prescaler, 1)

◆ STM32_AHB_PRESCALER

#define STM32_AHB_PRESCALER   DT_PROP(DT_NODELABEL(rcc), ahb_prescaler)

RCC node related symbols.

◆ STM32_APB1_PRESCALER

#define STM32_APB1_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb1_prescaler)

◆ STM32_APB2_PRESCALER

#define STM32_APB2_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb2_prescaler)

◆ STM32_APB3_PRESCALER

#define STM32_APB3_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb3_prescaler)

◆ STM32_APB5_PRESCALER

#define STM32_APB5_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb5_prescaler)

◆ STM32_APB7_PRESCALER

#define STM32_APB7_PRESCALER   DT_PROP(DT_NODELABEL(rcc), apb7_prescaler)

◆ STM32_CLOCK_CONTROL_NODE

#define STM32_CLOCK_CONTROL_NODE   DT_NODELABEL(rcc)

Common clock control device node for all STM32 chips.

◆ STM32_CLOCK_INFO

#define STM32_CLOCK_INFO ( clk_index,
node_id )
Value:
{ \
.enr = DT_CLOCKS_CELL_BY_IDX(node_id, clk_index, bits), \
.bus = DT_CLOCKS_CELL_BY_IDX(node_id, clk_index, bus) & \
GENMASK(STM32_CLOCK_DIV_SHIFT - 1, 0), \
.div = DT_CLOCKS_CELL_BY_IDX(node_id, clk_index, bus) >> \
STM32_CLOCK_DIV_SHIFT, \
}
DT_CLOCKS_CELL_BY_IDX
#define DT_CLOCKS_CELL_BY_IDX(node_id, idx, cell)
Get a clock specifier's cell value at an index.
Definition clocks.h:207
STM32_CLOCK_DIV_SHIFT
#define STM32_CLOCK_DIV_SHIFT
Definition stm32_clock.h:26

Device tree clocks helpers

◆ STM32_CLOCK_MASK_GET

#define STM32_CLOCK_MASK_GET ( clock)
Value:
(((clock) >> STM32_CLOCK_MASK_SHIFT) & STM32_CLOCK_MASK_MASK)
STM32_CLOCK_MASK_MASK
#define STM32_CLOCK_MASK_MASK
Definition stm32c0_clock.h:36
STM32_CLOCK_MASK_SHIFT
#define STM32_CLOCK_MASK_SHIFT
Definition stm32c0_clock.h:37

Obtain mask field from clock configuration.

Parameters
clockClock bit field value.

◆ STM32_CLOCK_REG_GET

#define STM32_CLOCK_REG_GET ( clock)
Value:
(((clock) >> STM32_CLOCK_REG_SHIFT) & STM32_CLOCK_REG_MASK)
STM32_CLOCK_REG_SHIFT
#define STM32_CLOCK_REG_SHIFT
Definition stm32c0_clock.h:33
STM32_CLOCK_REG_MASK
#define STM32_CLOCK_REG_MASK
Definition stm32c0_clock.h:32

Clock source binding accessors.

Obtain register field from clock configuration.

Parameters
clockclock bit field value.

◆ STM32_CLOCK_SHIFT_GET

#define STM32_CLOCK_SHIFT_GET ( clock)
Value:
(((clock) >> STM32_CLOCK_SHIFT_SHIFT) & STM32_CLOCK_SHIFT_MASK)
STM32_CLOCK_SHIFT_SHIFT
#define STM32_CLOCK_SHIFT_SHIFT
Definition stm32c0_clock.h:35
STM32_CLOCK_SHIFT_MASK
#define STM32_CLOCK_SHIFT_MASK
Definition stm32c0_clock.h:34

Obtain position field from clock configuration.

Parameters
clockClock bit field value.

◆ STM32_CLOCK_VAL_GET

#define STM32_CLOCK_VAL_GET ( clock)
Value:
(((clock) >> STM32_CLOCK_VAL_SHIFT) & STM32_CLOCK_VAL_MASK)
STM32_CLOCK_VAL_MASK
#define STM32_CLOCK_VAL_MASK
Definition stm32c0_clock.h:38
STM32_CLOCK_VAL_SHIFT
#define STM32_CLOCK_VAL_SHIFT
Definition stm32c0_clock.h:39

Obtain value field from clock configuration.

Parameters
clockClock bit field value.

◆ STM32_CPU1_PRESCALER

#define STM32_CPU1_PRESCALER   DT_PROP(DT_NODELABEL(rcc), cpu1_prescaler)

◆ STM32_CPU2_PRESCALER

#define STM32_CPU2_PRESCALER   DT_PROP(DT_NODELABEL(rcc), cpu2_prescaler)

◆ STM32_CSI_FREQ

#define STM32_CSI_FREQ   0

◆ STM32_D1CPRE

#define STM32_D1CPRE   DT_PROP(DT_NODELABEL(rcc), d1cpre)

STM2H7RS specific RCC dividers.

◆ STM32_D1PPRE

#define STM32_D1PPRE   DT_PROP(DT_NODELABEL(rcc), d1ppre)

◆ STM32_D2PPRE1

#define STM32_D2PPRE1   DT_PROP(DT_NODELABEL(rcc), d2ppre1)

◆ STM32_D2PPRE2

#define STM32_D2PPRE2   DT_PROP(DT_NODELABEL(rcc), d2ppre2)

◆ STM32_D3PPRE

#define STM32_D3PPRE   DT_PROP(DT_NODELABEL(rcc), d3ppre)

◆ STM32_DOMAIN_CLOCK_INST_SUPPORT

#define STM32_DOMAIN_CLOCK_INST_SUPPORT ( inst)
Value:
DT_INST_CLOCKS_HAS_IDX(inst, 1) ||
DT_INST_CLOCKS_HAS_IDX
#define DT_INST_CLOCKS_HAS_IDX(inst, idx)
Equivalent to DT_CLOCKS_HAS_IDX(DT_DRV_INST(inst), idx)
Definition clocks.h:261

◆ STM32_DOMAIN_CLOCK_SUPPORT

#define STM32_DOMAIN_CLOCK_SUPPORT ( id)
Value:
DT_CLOCKS_HAS_IDX(DT_NODELABEL(id), 1) ||
DT_CLOCKS_HAS_IDX
#define DT_CLOCKS_HAS_IDX(node_id, idx)
Test if a node has a clocks phandle-array property at a given index.
Definition clocks.h:52
DT_NODELABEL
#define DT_NODELABEL(label)
Get a node identifier for a node label.
Definition devicetree.h:196

◆ STM32_DT_CLOCKS

#define STM32_DT_CLOCKS ( node_id)
Value:
{ \
LISTIFY(DT_NUM_CLOCKS(node_id), \
STM32_CLOCK_INFO, (,), node_id) \
}
DT_NUM_CLOCKS
#define DT_NUM_CLOCKS(node_id)
Get the number of elements in a clocks property.
Definition clocks.h:107
STM32_CLOCK_INFO
#define STM32_CLOCK_INFO(clk_index, node_id)
Device tree clocks helpers
Definition stm32_clock_control.h:444

◆ STM32_DT_DEV_DOMAIN_CLOCK_SUPPORT

#define STM32_DT_DEV_DOMAIN_CLOCK_SUPPORT    (DT_FOREACH_STATUS_OKAY(STM32_DOMAIN_CLOCK_SUPPORT) 0)

◆ STM32_DT_INST_CLOCKS

#define STM32_DT_INST_CLOCKS ( inst)
Value:
STM32_DT_CLOCKS(DT_DRV_INST(inst))
DT_DRV_INST
#define DT_DRV_INST(inst)
Node identifier for an instance of a DT_DRV_COMPAT compatible.
Definition devicetree.h:3869
STM32_DT_CLOCKS
#define STM32_DT_CLOCKS(node_id)
Definition stm32_clock_control.h:452

◆ STM32_DT_INST_DEV_DOMAIN_CLOCK_SUPPORT

#define STM32_DT_INST_DEV_DOMAIN_CLOCK_SUPPORT    (DT_INST_FOREACH_STATUS_OKAY(STM32_DOMAIN_CLOCK_INST_SUPPORT) 0)

◆ STM32_FLASH_PRESCALER

#define STM32_FLASH_PRESCALER   STM32_CORE_PRESCALER

◆ STM32_HPRE

#define STM32_HPRE   DT_PROP(DT_NODELABEL(rcc), hpre)

◆ STM32_HSE_FREQ

#define STM32_HSE_FREQ   0

◆ STM32_HSI_DIV_ENABLED

#define STM32_HSI_DIV_ENABLED   0

◆ STM32_HSI_DIVISOR

#define STM32_HSI_DIVISOR   1

◆ STM32_HSI_FREQ

#define STM32_HSI_FREQ   0

◆ STM32_LSE_BYPASS

#define STM32_LSE_BYPASS   0

◆ STM32_LSE_DRIVING

#define STM32_LSE_DRIVING   0

◆ STM32_LSE_ENABLED

#define STM32_LSE_ENABLED   0

PLL node related symbols.

PLL/PLL1 clock source PLL2 clock source PLL3 clock source Fixed clocks related symbols

◆ STM32_LSE_FREQ

#define STM32_LSE_FREQ   0

◆ STM32_LSI_FREQ

#define STM32_LSI_FREQ   0

◆ STM32_MCO_CFGR_MASK_GET

#define STM32_MCO_CFGR_MASK_GET ( mco_cfgr)
Value:
(((mco_cfgr) >> STM32_MCO_CFGR_MASK_SHIFT) & STM32_MCO_CFGR_MASK_MASK)
STM32_MCO_CFGR_MASK_SHIFT
#define STM32_MCO_CFGR_MASK_SHIFT
Definition stm32_common_clocks.h:29
STM32_MCO_CFGR_MASK_MASK
#define STM32_MCO_CFGR_MASK_MASK
Definition stm32_common_clocks.h:28

Obtain mask field from MCO configuration.

Parameters
mco_cfgrMCO configuration bit field value.

◆ STM32_MCO_CFGR_REG_GET

#define STM32_MCO_CFGR_REG_GET ( mco_cfgr)
Value:
(((mco_cfgr) >> STM32_MCO_CFGR_REG_SHIFT) & STM32_MCO_CFGR_REG_MASK)
STM32_MCO_CFGR_REG_SHIFT
#define STM32_MCO_CFGR_REG_SHIFT
Definition stm32_common_clocks.h:25
STM32_MCO_CFGR_REG_MASK
#define STM32_MCO_CFGR_REG_MASK
STM32 MCO configuration values.
Definition stm32_common_clocks.h:24

Obtain register field from MCO configuration.

Parameters
mco_cfgrMCO configuration bit field value.

◆ STM32_MCO_CFGR_SHIFT_GET

#define STM32_MCO_CFGR_SHIFT_GET ( mco_cfgr)
Value:
(((mco_cfgr) >> STM32_MCO_CFGR_SHIFT_SHIFT) & STM32_MCO_CFGR_SHIFT_MASK)
STM32_MCO_CFGR_SHIFT_SHIFT
#define STM32_MCO_CFGR_SHIFT_SHIFT
Definition stm32_common_clocks.h:27
STM32_MCO_CFGR_SHIFT_MASK
#define STM32_MCO_CFGR_SHIFT_MASK
Definition stm32_common_clocks.h:26

Obtain position field from MCO configuration.

Parameters
mco_cfgrMCO configuration bit field value.

◆ STM32_MCO_CFGR_VAL_GET

#define STM32_MCO_CFGR_VAL_GET ( mco_cfgr)
Value:
(((mco_cfgr) >> STM32_MCO_CFGR_VAL_SHIFT) & STM32_MCO_CFGR_VAL_MASK)
STM32_MCO_CFGR_VAL_SHIFT
#define STM32_MCO_CFGR_VAL_SHIFT
Definition stm32_common_clocks.h:31
STM32_MCO_CFGR_VAL_MASK
#define STM32_MCO_CFGR_VAL_MASK
Definition stm32_common_clocks.h:30

Obtain value field from MCO configuration.

Parameters
mco_cfgrMCO configuration bit field value.

◆ STM32_MSIK_ENABLED

#define STM32_MSIK_ENABLED   0

◆ STM32_MSIK_PLL_MODE

#define STM32_MSIK_PLL_MODE   0

◆ STM32_MSIK_RANGE

#define STM32_MSIK_RANGE   0

◆ STM32_MSIS_ENABLED

#define STM32_MSIS_ENABLED   0

◆ STM32_MSIS_PLL_MODE

#define STM32_MSIS_PLL_MODE   0

◆ STM32_MSIS_RANGE

#define STM32_MSIS_RANGE   0