zephyr,mapped-partition
Description
Memory-mapped partition of a flash (or other non-volatile storage) memory.
The `zephyr,mapped-partition` node should be (descendant) children of the NVM memory node, either
directly or through intermediatory grouping child nodes or through parent
`zephyr,mapped-partition` nodes. Note that the NVM memory node and NVM controller nodes must have
`ranges` properties to indicate that they are all part of the SoC's address space which specify
the full range of the NVM area (usually the same as the `reg` property with a 0x0 prepended
before the offset value). Nested `zephyr,mapped-partition` nodes are supported, and should have
`ranges` properties set to indicate their range to their child nodes.
Examples
/*
* The NVM controller node defines the ranges which map the NVM memory nodes to the CPU address
* space.
*/
flash_controller: flash-controller@4001e000 {
compatible = "vnd,flash-controller"
reg = <0x4001e000 0x1000>
ranges;
#address-cells = <1>;
#size-cells = <1>;
/*
* An NVM memory node describes a consecutive block of non volatile physical memory.
* Partitions are added to the this node, adhering to physical limitations like
* write-block-size. An empty `ranges;` property is required to ensure any partition
* added to the NVM memory is mapped correctly to the CPU address space, and a
* nodelabel should be defined make it easier for applications to add add partitions
* to the NVM memory node.
*/
flash0: flash@0 {
compatible = "soc-nv-flash"
reg = <0x0 DT_SIZE_K(1024)>;
ranges = <0x0 0x0 DT_SIZE_K(1024)>
#address-cells = <1>;
#size-cells = <1>;
/*
* The 'partitions' grouping is optional, it allows for clearing all partitions
* in a device (e.g. using a dtc overlay file) but is not required. If used,
* then it needs a `ranges;` property and to specify the #address-cells and
* #size-cells properties
*/
partitions {
ranges;
#address-cells = <1>;
#size-cells = <1>;
/*
* Offsets are relative to the flash0 node, if flash0 had an address of
* 0x10000000 then the below offset of 0x0 means address 0x10000000
*/
boot_partition: partition@0 {
compatible = "zephyr,mapped-partition";
label = "mcuboot";
reg = <0x0 0xc000>;
};
slot0_partition: partition@c000 {
compatible = "zephyr,mapped-partition";
label = "image-0";
reg = <0xc000 0x76000>;
};
slot1_partition: partition@82000 {
compatible = "zephyr,mapped-partition";
label = "image-1";
reg = <0x82000 0x76000>;
};
/*
* Below example disables an NVM partition, if using the flash map
* subsystem with the default mappings then the below partition will
* not be present in the flash map
*/
storage_partition: partition@f8000 {
compatible = "zephyr,mapped-partition";
label = "storage";
reg = <0xf8000 0x8000>;
status = "disabled";
};
};
};
flash1: flash@10000000 {
compatible = "soc-nv-flash"
reg = <0x10000000 DT_SIZE_K(256)>;
ranges = <0x0 0x10000000 DT_SIZE_K(256)>;
#address-cells = <1>;
#size-cells = <1>;
/*
* Below demonstrates usage without partitions {}; grouping, and demos
* partitions inside of a parent partition
*/
external_partition: partition@0 {
compatible = "zephyr,mapped-partition";
reg = <0x0 0x10000>;
ranges = <0x0 0x0 0x10000>;
#address-cells = <1>;
#size-cells = <1>;
external_inner_a_partition: partition@0 {
compatible = "zephyr,mapped-partition";
reg = <0x0 0x6000>;
};
external_inner_b_partition: partition@6000 {
compatible = "zephyr,mapped-partition";
reg = <0x6000 0xa000>;
};
};
};
};
Properties
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
Set this property if the partition is read-only
|
Deprecated properties not inherited from the base binding file.
(None)
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 “zephyr,mapped-partition” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
Number of cells required to represent a child node's reg property address. This must be
large enough to represent the start offset of each partition.
|
|
|
Number of cells required to represent a child node's reg property address. This must be
large enough to represent the size of each partition in bytes.
|
|
|
Human readable string describing the NVM partition.
See Important properties for more information. |
|
|
This should be in the format <OFFSET SIZE>, where OFFSET is the offset of the flash
partition relative to the base address of the parent memory, and SIZE is the size of the
partition in bytes.
This property is required. See Important properties for more information. |
|
|
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: See Important properties for more information. |
|
|
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. |
|
|
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"
|
|
|
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. |
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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
|
|
|
Optional names given to each clock provider in the "clocks" property.
|
|
|
DMA channel specifiers relevant to the device.
|
|
|
Optional names given to the DMA channel specifiers in the "dmas" property.
|
|
|
IO channel specifiers relevant to the device.
|
|
|
Optional names given to the IO channel specifiers in the "io-channels" property.
|
|
|
Mailbox / IPM channel specifiers relevant to the device.
|
|
|
Optional names given to the mbox specifiers in the "mboxes" property.
|
|
|
Power domain specifiers relevant to the device.
|
|
|
Optional names given to the power domain specifiers in the "power-domains" property.
|
|
|
Number of cells in power-domains property
|
|
|
HW spinlock id relevant to the device.
|
|
|
Optional names given to the hwlock specifiers in the "hwlocks" property.
|
|
|
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
|
|
|
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.
|
|
|
Automatically configure the device for runtime power management after the
init function runs.
|
|
|
List of power states that will disable this device power.
|