zephyr,coredump

Vendor: Zephyr-specific binding

Description

Pseudo-device to help capturing desired data into core dumps

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

memory-regions

array

Start address and size of memory regions to be collected in a core dump

coredump-type

string

Designate which type of coredump device this will be.
A device of type COREDUMP_TYPE_MEMCPY can directly memcpy the provided memory-regions
into the coredump. The memory-regions array can contain 0 or more entries, and more
regions can be added at runtime through the coredump_device_register_memory API.
A device of type COREDUMP_TYPE_CALLBACK must specify exactly one entry in the
memory-regions array with a size of 0 and a desired size. The coredump device will statically
allocate a block of memory of the desired size and provide a callback with a pointer to
that memory which will be invoked at the time of a dump. This allows a consumer to add data
into the coredump that may not be directly accessible through a memcpy and/or provides an
opportunity to manipulate data for inclusion in the dump. The coredump_device_register_memory
API is not available for a device of this type.

This property is required.

Legal values: 'COREDUMP_TYPE_MEMCPY', 'COREDUMP_TYPE_CALLBACK'

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

Base properties

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,coredump” compatible.

Name

Type

Details

status

string

indicates the operational status of a device

Legal values: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'

See Important properties for more information.

compatible

string-array

compatible strings

This property is required.

See Important properties for more information.

reg

array

register space

See Important properties for more information.

reg-names

string-array

name of each register space

interrupts

array

interrupts for device

See Important properties for more information.

interrupts-extended

compound

extended interrupt specifier for device

interrupt-names

string-array

name of each interrupt

interrupt-parent

phandle

phandle to interrupt controller node

label

string

Human readable string describing the device (used as device_get_binding() argument)

See Important properties for more information.

This property is deprecated.

clocks

phandle-array

Clock gate information

clock-names

string-array

name of each clock

#address-cells

int

number of address cells in reg property

#size-cells

int

number of size cells in reg property

dmas

phandle-array

DMA channels specifiers

dma-names

string-array

Provided names of DMA channel specifiers

io-channels

phandle-array

IO channels specifiers

io-channel-names

string-array

Provided names of IO channel specifiers

mboxes

phandle-array

mailbox / IPM channels specifiers

mbox-names

string-array

Provided names of mailbox / IPM channel specifiers

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.

power-domain

phandle

Power domain the device belongs to.

The device will be notified when the power domain it belongs to is either
suspended or resumed.