zephyr,retention
Vendor: Zephyr-specific binding
Note
An implementation of a driver matching this compatible is available in subsys/retention/retention.c.
Description
Retention subsystem area, which has a retained memory parent. Example
64-byte area with 2-byte prefix and 1-byte checksum with 61 usable bytes
for user storage:
sram@2003FFC0 {
compatible = "zephyr,memory-region", "mmio-sram";
reg = <0x2003FFC0 64>;
zephyr,memory-region = "RetainedMem";
status = "okay";
retainedmem {
compatible = "zephyr,retained-ram";
status = "okay";
#address-cells = <1>;
#size-cells = <1>;
retention0: retention@0 {
compatible = "zephyr,retention";
status = "okay";
reg = <0x0 0x40>;
prefix = [04 fa];
checksum = <1>;
};
};
};
Properties
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
An optional magic prefix, which indicates that the data has been set
(applies to the header of the data, reduces the available user data
size).
|
|
|
An optional data verification checksum, which indicates that the data is
valid (appended to the footer of the data, reduces the available user
data size). Value is size in bytes (0 for none, 1 for 8-bit CRC, 2 for
16-bit CRC, 4 for 32-bit CRC). Default is to not use a checksum.
|
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,retention” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
Address reg cell is for the offset of the area in parent node, can be
increased if multiple retention partitions are used or parts are
reserved.
Constant value: |
|
|
Size reg cell is for the size of the area, which includes sizes of
prefix and checksum (if enabled).
Constant value: |
|
|
register space
This property is required. See Important properties for more information. |
|
|
indicates the operational status of a device
Legal values: See Important properties for more information. |
|
|
compatible strings
This property is required. See Important properties for more information. |
|
|
name of each register space
|
|
|
interrupts for device
See Important properties for more information. |
|
|
extended interrupt specifier for device
|
|
|
name of each interrupt
|
|
|
phandle to interrupt controller node
|
|
|
Human readable string describing the device (used as device_get_binding() argument)
See Important properties for more information. This property is deprecated. |
|
|
Clock gate information
|
|
|
name of each clock
|
|
|
DMA channels specifiers
|
|
|
Provided names of DMA channel specifiers
|
|
|
IO channels specifiers
|
|
|
Provided names of IO channel specifiers
|
|
|
mailbox / IPM channels specifiers
|
|
|
Provided names of mailbox / IPM channel specifiers
|
|
|
Power domain specifiers
|
|
|
Provided names of power domain specifiers
|
|
|
Number of cells in power-domains 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.
|