st,stm32wba-pwr

Description

STM32WBA power controller

Power controller of STM32WBA series

Controls the memory retained in s2ram power state.

Examples

/*
 * Not used RAM retained (and so powered) is simply a
 * pointless waste of energy.
 * `/chosen/zephyr,sram` (Zephyr system memory) is mapped on
 * sram0 memory controller.
 * According the required ram, sram0 memory controller will use
 * SRAM1 (up to 448KB) and SRAM2 (up to 64KB) physical banks.
 *
 * Let's imagine a build report shows an application needs
 * 120 KB of RAM and Standby low-power feature is required.
 * In this case only the first 2 pages of SRAM1 will be retained.
 * And SRAM2 is not retained by default.
 * The overlay file can be modified like this:
 */
sram0: memory@20000000 {
        reg = <0x20000000 DT_SIZE_K(120)>;
};

/*
 * If for any specific reason application needs to retain SRAM2:
 */
&pwr {
        power-supply = "smps";
        retain-sram2;
        status = "okay";
};

/*
 * If full memory is required, SRAM1 and SRAM2 will be
 * fully retained and the sram0 memory node will appear
 * like this:
 */
sram0: memory@20000000 {
        reg = <0x20000000 DT_SIZE_K(512)>;
};

Properties

Top level properties

These property descriptions apply to “st,stm32wba-pwr” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

Name	Type	Details
`retain-sram2`	`boolean`	Enables retention of SRAM2 while in Standby low-power mode. (Standby mode is a suspend-to-RAM power state) If this property is present, the entire SRAM2 memory region will be retained in Standby mode (all contents preserved). If this property is not present, the SRAM2 memory region will will not be retained in Standby mode (all contents are lost), except if the Zephyr RAM region `/chosen/zephyr,sram` overlaps with SRAM2 (in this case, retention is always enabled).
`power-supply`	`string`	Power supply configuration This property specifies the voltage regulators configuration and indicates how the core domain voltage (Vcore) is generated. Refer to your product's Datasheet and Reference Manual for details. ldo: LDO supply The LDO is enabled and generates Vcore; the SMPS is disabled. smps: SMPS supply The SMPS is enabled and generates Vcore; the LDO is disabled. This property is required. Legal values: `ldo`, `smps`
`wkup-pins-nb`	`int`	Max nbr of system wake-up pins. For example wkup-pins-nb = <8>; on the stm32u5
`wkup-pin-srcs`	`int`	Number of wake-up GPIO sources to select from for each wake-up pin. If not specified, that means there is only 1 GPIO source for each wake-up pin. For example, each wake-up pin on STM32U5 is associated with 4 wake-up sources, 3 of them correspond to GPIOs.
`wkup-pins-pol`	`boolean`	True if SoC has a wake-up pins polarity config register
`wkup-pins-pupd`	`boolean`	True if SoC has pull-up/down config register(s) for GPIO ports that are associated with wake-up pins.

Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “st,stm32wba-pwr” compatible.

Name	Type	Details
`reg`	`array`	Information used to address the device. The value is specific to the device (i.e. is different depending on the compatible property). The "reg" property is typically a sequence of (address, length) pairs. Each pair is called a "register block". Values are conventionally written in hex. For details, see "2.3.6 reg" in Devicetree Specification v0.4. This property is required. See Important properties for more information.
`#address-cells`	`int`	This property encodes the number of <u32> cells used by address fields in "reg" properties in this node's children. For details, see "2.3.5 #address-cells and #size-cells" in Devicetree Specification v0.4. Constant value: `1`
`#size-cells`	`int`	This property encodes the number of <u32> cells used by size fields in "reg" properties in this node's children. For details, see "2.3.5 #address-cells and #size-cells" in Devicetree Specification v0.4.
`status`	`string`	Indicates the operational status of the hardware or other resource that the node represents. In particular: - "okay" means the resource is operational and, for example, can be used by device drivers - "disabled" means the resource is not operational and the system should treat it as if it is not present For details, see "2.3.4 status" in Devicetree Specification v0.4. Legal values: `okay`, `disabled`, `reserved`, `fail`, `fail-sss` See Important properties for more information.
`compatible`	`string-array`	This property is a list of strings that essentially define what type of hardware or other resource this devicetree node represents. Each device driver checks for specific compatible property values to find the devicetree nodes that represent resources that the driver should manage. The recommended format is "vendor,device", The "vendor" part is an abbreviated name of the vendor. The "device" is usually from the datasheet. The compatible property can have multiple values, ordered from most- to least-specific. Having additional values is useful when the device is a specific instance of a more general family, to allow the system to match the most specific driver available. For details, see "2.3.1 compatible" in Devicetree Specification v0.4. This property is required. See Important properties for more information.
`reg-names`	`string-array`	Optional names given to each register block in the "reg" property. For example: / { soc { #address-cells = <1>; #size-cells = <1>; uart@1000 { reg = <0x1000 0x2000>, <0x3000 0x4000>; reg-names = "foo", "bar"; }; }; }; The uart@1000 node has two register blocks: - one with base address 0x1000, size 0x2000, and name "foo" - another with base address 0x3000, size 0x4000, and name "bar"
`interrupts`	`array`	Information about interrupts generated by the device, encoded as an array of one or more interrupt specifiers. The format of the data in this property varies by where the device appears in the interrupt tree. Devices with the same "interrupt-parent" will use the same format in their interrupts properties. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4. See Important properties for more information.
`interrupts-extended`	`compound`	Extended interrupt specifier for device, used as an alternative to the "interrupts" property. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4.
`interrupt-names`	`string-array`	Optional names given to each interrupt generated by a device. The interrupts themselves are defined in either "interrupts" or "interrupts-extended" properties. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4.
`interrupt-parent`	`phandle`	If present, this refers to the node which handles interrupts generated by this device. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4.
`label`	`string`	Human readable string describing the device. Use of this property is deprecated except as needed on a case-by-case basis. For details, see "4.1.2 Miscellaneous Properties" in Devicetree Specification v0.4. See Important properties for more information.
`clocks`	`phandle-array`	Information about the device's clock providers. In general, this property should follow conventions established in the dt-schema binding: https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
`clock-names`	`string-array`	Optional names given to each clock provider in the "clocks" property.
`dmas`	`phandle-array`	DMA channel specifiers relevant to the device.
`dma-names`	`string-array`	Optional names given to the DMA channel specifiers in the "dmas" property.
`io-channels`	`phandle-array`	IO channel specifiers relevant to the device.
`io-channel-names`	`string-array`	Optional names given to the IO channel specifiers in the "io-channels" property.
`mboxes`	`phandle-array`	Mailbox / IPM channel specifiers relevant to the device.
`mbox-names`	`string-array`	Optional names given to the mbox specifiers in the "mboxes" property.
`power-domains`	`phandle-array`	Power domain specifiers relevant to the device.
`power-domain-names`	`string-array`	Optional names given to the power domain specifiers in the "power-domains" property.
`#power-domain-cells`	`int`	Number of cells in power-domains property
`hwlocks`	`phandle-array`	HW spinlock id relevant to the device.
`hwlock-names`	`string-array`	Optional names given to the hwlock specifiers in the "hwlocks" property.
`zephyr,deferred-init`	`boolean`	Do not initialize device automatically on boot. Device should be manually initialized using device_init().
`wakeup-source`	`boolean`	Property to identify that a device can be used as wake up source. When this property is provided a specific flag is set into the device that tells the system that the device is capable of wake up the system. Wake up capable devices are disabled (interruptions will not wake up the system) by default but they can be enabled at runtime if necessary.
`zephyr,pm-device-runtime-auto`	`boolean`	Automatically configure the device for runtime power management after the init function runs.
`zephyr,disabling-power-states`	`phandles`	List of power states that will disable this device power.

Child node properties

Name

Type

Details

reg

array

Wake-up pin identifier, same as "index" in node name

This property is required.

See Important properties for more information.

wkup-gpios

phandle-array

Specifies the GPIOs, if any, that are associated with the wake-up pin.

For example, for GPIO PB2 associated with wakeup source 1 on wake-up
event 1 on STM32U5 SoCs:
wkup-gpios = <&gpiob 2 STM32_PWR_WKUP_EVT_SRC_1>, <...>;