FROMLIST: pstore-ram: add Device Tree bindings
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / misc / ramoops.txt
1 Ramoops oops/panic logger
2 =========================
3
4 ramoops provides persistent RAM storage for oops and panics, so they can be
5 recovered after a reboot.
6
7 Parts of this storage may be set aside for other persistent log buffers, such
8 as kernel log messages, or for optional ECC error-correction data.  The total
9 size of these optional buffers must fit in the reserved region.
10
11 Any remaining space will be used for a circular buffer of oops and panic
12 records.  These records have a configurable size, with a size of 0 indicating
13 that they should be disabled.
14
15
16 Required properties:
17
18 - compatible: must be "ramoops"
19
20 - memory-region: phandle to a region of memory that is preserved between reboots
21
22
23 Optional properties:
24
25 - ecc-size: enables ECC support and specifies ECC buffer size in bytes
26   (defaults to no ECC)
27
28 - record-size: maximum size in bytes of each dump done on oops/panic
29   (defaults to 0)
30
31 - console-size: size in bytes of log buffer reserved for kernel messages
32   (defaults to 0)
33
34 - ftrace-size: size in bytes of log buffer reserved for function tracing and
35   profiling (defaults to 0)
36
37 - pmsg-size: size in bytes of log buffer reserved for userspace messages
38   (defaults to 0)
39
40 - unbuffered: if present, use unbuffered mappings to map the reserved region
41   (defaults to buffered mappings)
42
43 - no-dump-oops: if present, only dump panics (defaults to panics and oops)