Documentation/devicetree/bindings/chosen.txt

   1 The chosen node
   2 ---------------
   3
   4 The chosen node does not represent a real device, but serves as a place
   5 for passing data between firmware and the operating system, like boot
   6 arguments. Data in the chosen node does not represent the hardware.
   7
   8
   9 stdout-path property
  10 --------------------
  11
  12 Device trees may specify the device to be used for boot console output
  13 with a stdout-path property under /chosen, as described in the Devicetree
  14 Specification, e.g.
  15
  16 / {
  17         chosen {
  18                 stdout-path = "/serial@f00:115200";
  19         };
  20
  21         serial@f00 {
  22                 compatible = "vendor,some-uart";
  23                 reg = <0xf00 0x10>;
  24         };
  25 };
  26
  27 If the character ":" is present in the value, this terminates the path.
  28 The meaning of any characters following the ":" is device-specific, and
  29 must be specified in the relevant binding documentation.
  30
  31 For UART devices, the preferred binding is a string in the form:
  32
  33         <baud>{<parity>{<bits>{<flow>}}}
  34
  35 where
  36
  37         baud    - baud rate in decimal
  38         parity  - 'n' (none), 'o', (odd) or 'e' (even)
  39         bits    - number of data bits
  40         flow    - 'r' (rts)
  41
  42 For example: 115200n8r
  43
  44 Implementation note: Linux will look for the property "linux,stdout-path" or
  45 on PowerPC "stdout" if "stdout-path" is not found.  However, the
  46 "linux,stdout-path" and "stdout" properties are deprecated. New platforms
  47 should only use the "stdout-path" property.
  48
  49 linux,booted-from-kexec
  50 -----------------------
  51
  52 This property is set (currently only on PowerPC, and only needed on
  53 book3e) by some versions of kexec-tools to tell the new kernel that it
  54 is being booted by kexec, as the booting environment may differ (e.g.
  55 a different secondary CPU release mechanism)
  56
  57 linux,usable-memory-range
  58 -------------------------
  59
  60 This property (arm64 only) holds a base address and size, describing a
  61 limited region in which memory may be considered available for use by
  62 the kernel. Memory outside of this range is not available for use.
  63
  64 This property describes a limitation: memory within this range is only
  65 valid when also described through another mechanism that the kernel
  66 would otherwise use to determine available memory (e.g. memory nodes
  67 or the EFI memory map). Valid memory may be sparse within the range.
  68 e.g.
  69
  70 / {
  71         chosen {
  72                 linux,usable-memory-range = <0x9 0xf0000000 0x0 0x10000000>;
  73         };
  74 };
  75
  76 The main usage is for crash dump kernel to identify its own usable
  77 memory and exclude, at its boot time, any other memory areas that are
  78 part of the panicked kernel's memory.
  79
  80 While this property does not represent a real hardware, the address
  81 and the size are expressed in #address-cells and #size-cells,
  82 respectively, of the root node.
  83
  84 linux,elfcorehdr
  85 ----------------
  86
  87 This property (currently used only on arm64) holds the memory range,
  88 the address and the size, of the elf core header which mainly describes
  89 the panicked kernel's memory layout as PT_LOAD segments of elf format.
  90 e.g.
  91
  92 / {
  93         chosen {
  94                 linux,elfcorehdr = <0x9 0xfffff000 0x0 0x800>;
  95         };
  96 };
  97
  98 While this property does not represent a real hardware, the address
  99 and the size are expressed in #address-cells and #size-cells,
 100 respectively, of the root node.