summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/misc/ramoops.txt
blob: cd02cec67d380a12f03429941598b1d7c032adc0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
Ramoops oops/panic logger
=========================

ramoops provides persistent RAM storage for oops and panics, so they can be
recovered after a reboot. It is a backend to pstore, so this node is named
"ramoops" after the backend, rather than "pstore" which is the subsystem.

Parts of this storage may be set aside for other persistent log buffers, such
as kernel log messages, or for optional ECC error-correction data.  The total
size of these optional buffers must fit in the reserved region.

Any remaining space will be used for a circular buffer of oops and panic
records.  These records have a configurable size, with a size of 0 indicating
that they should be disabled.

At least one of "record-size", "console-size", "ftrace-size", or "pmsg-size"
must be set non-zero, but are otherwise optional as listed below.


Required properties:

- compatible: must be "ramoops"

- memory-region: phandle to a region of memory that is preserved between
  reboots


Optional properties:

- ecc-size: enables ECC support and specifies ECC buffer size in bytes
  (defaults to 0: no ECC)

- record-size: maximum size in bytes of each dump done on oops/panic
  (defaults to 0: disabled)

- console-size: size in bytes of log buffer reserved for kernel messages
  (defaults to 0: disabled)

- ftrace-size: size in bytes of log buffer reserved for function tracing and
  profiling (defaults to 0: disabled)

- pmsg-size: size in bytes of log buffer reserved for userspace messages
  (defaults to 0: disabled)

- unbuffered: if present, use unbuffered mappings to map the reserved region
  (defaults to buffered mappings)

- no-dump-oops: if present, only dump panics (defaults to panics and oops)