diff options
Diffstat (limited to 'Documentation/devicetree/bindings')
12 files changed, 128 insertions, 19 deletions
diff --git a/Documentation/devicetree/bindings/barebox/aliases.rst b/Documentation/devicetree/bindings/barebox/aliases.rst index 527cc85ef6..2848a88f15 100644 --- a/Documentation/devicetree/bindings/barebox/aliases.rst +++ b/Documentation/devicetree/bindings/barebox/aliases.rst @@ -2,9 +2,10 @@ barebox DT aliases ================== barebox can use the properties in the ``/aliases`` node to arrive -at deterministic names for devices, e.g.:: +at deterministic names for devices, e.g.: .. code-block:: none + / { aliases { mmc0 = &sdhci; @@ -18,17 +19,22 @@ probing the node at ``&iwdg`` will be named ``wdog0``. By default, barebox will assume the aliases in the DT to align with the bootsource communicated by the firmware. If this is not the case, -a device tree override is possible via an -``/aliases/barebox,bootsource-${bootsource}${bootsource_instance}`` +a device tree override is possible via a +``/chosen/barebox,bootsource-${bootsource}${bootsource_instance}`` property: .. code-block:: none - &{/aliases} { - mmc0 = &sdmmc0; - mmc1 = &sdhci; - barebox,bootsource-mmc0 = &sdhci; - barebox,bootsource-mmc1 = &sdmmc0; + / { + aliases { + mmc0 = &sdmmc0; + mmc1 = &sdhci; + }; + + chosen { + barebox,bootsource-mmc0 = &sdhci; + barebox,bootsource-mmc1 = &sdmmc0; + }; }; This will ensure that when booting from MMC, ``/dev/mmc${bootsource_instance}`` diff --git a/Documentation/devicetree/bindings/barebox/barebox,environment.rst b/Documentation/devicetree/bindings/barebox/barebox,environment.rst index 918efd15f5..67d1173b2f 100644 --- a/Documentation/devicetree/bindings/barebox/barebox,environment.rst +++ b/Documentation/devicetree/bindings/barebox/barebox,environment.rst @@ -9,6 +9,7 @@ Required properties: * ``device-path``: path to the device environment is on Optional properties: + * ``file-path``: path to a file in the device named by device-path The device-path is a multistring property. The first string should contain @@ -22,6 +23,9 @@ the path to the environment. Supported values for <type>: be the label for MTD partitions, the number for DOS partitions (beginning with 0) or the name for GPT partitions. +If the *environment* is located in a GPT partition, use +``6C3737F2-07F8-45D1-AD45-15D260AAB24D`` as partition type GUID. + The file-path is the name of a file located in a FAT filesystem on the device named in device-path. This filesystem will be mounted and the environment loaded from the file's location in the directory tree. diff --git a/Documentation/devicetree/bindings/barebox/virtual-reg.rst b/Documentation/devicetree/bindings/barebox/virtual-reg.rst new file mode 100644 index 0000000000..7d576d0cef --- /dev/null +++ b/Documentation/devicetree/bindings/barebox/virtual-reg.rst @@ -0,0 +1,29 @@ +virtual-reg property +==================== + +The ``virtual-reg`` property provides a hint on the 32-bit virtual +address mapping the first physical base address in the ``reg`` property. +This is meant to allow the OS to use the boot firmware's virtual memory +mapping to access device resources early in the kernel boot process. + +When barebox is compiled with ``CONFIG_MMU`` support and the +implementation supports remapping, devices with ``virtual_reg`` will have +all their resources remapped at the physical/virtual address offset calculated +by subtracting ``virtual-reg`` from the first address in ``reg``. + +This is normally used to map I/O memory away from the zero page, so it +can be used again to trap null pointer dereferences, while allowing +full access to the device memory:: + +.. code-block:: none + + &{/soc} { + #address-cells = <1>; + #size-cells = <1>; + + flash@0 { + reg = <0 0x10000>; + virtual-reg = <0x1000>; + /* => memory region remapped from [0x1000, 0x11000] to [0x0000, 0x10000] */ + }; + }; diff --git a/Documentation/devicetree/bindings/clocks/xlnx,ps7-clkc.rst b/Documentation/devicetree/bindings/clocks/xlnx,ps7-clkc.rst new file mode 100644 index 0000000000..523b0cf56e --- /dev/null +++ b/Documentation/devicetree/bindings/clocks/xlnx,ps7-clkc.rst @@ -0,0 +1,10 @@ +Xilinx PS7 clkc +=============== + +In addition to the upstream bindings, following properties are understood: + +Optional properties: + +- ``ps-clock-frequency`` : Overrides the ps clock frequency set by the driver. + Per default the clock is set to 33.3MHz. When this property is set, the frequency + is overwritten by the devicetree property. diff --git a/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst b/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst index 1012137bc9..cbddd700ce 100644 --- a/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst +++ b/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst @@ -6,6 +6,7 @@ passive serial mode. This is used to upload the firmware and to start the FPGA. Required properties: + - ``compatible``: shall be ``"altr,fpga-passive-serial"`` or ``"altr,fpga-arria10-passive-serial"`` for Arria 10 - ``reg``: SPI chip select diff --git a/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst b/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst index 9f7de6b985..478e8e6fc4 100644 --- a/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst +++ b/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst @@ -5,10 +5,12 @@ This binding defines the FPGA Manager on Altera SOCFPGAs. This is used to upload the firmware to the FPGA part of the SoC. Required properties: + - ``compatible``: shall be ``"altr,socfpga-fpga-mgr"`` - ``reg``: Must contain 2 register ranges: - 1. The control address space of the FPGA manager. - 2. The configuration data address space where the firmware data is written to. + + 1. The control address space of the FPGA manager. + 2. The configuration data address space where the firmware data is written to. Example: diff --git a/Documentation/devicetree/bindings/leds/common.rst b/Documentation/devicetree/bindings/leds/common.rst index 911a55f4f6..8bf41f0d64 100644 --- a/Documentation/devicetree/bindings/leds/common.rst +++ b/Documentation/devicetree/bindings/leds/common.rst @@ -9,9 +9,10 @@ Common leds properties * ``net`` - LED indicates network activity (tx and rx) * ``net-rx`` - LED indicates network activity (rx only) * ``net-tx`` - LED indicates network activity (tx only) + * ``default-on`` - LED is switched on by default * ``label``: The label for this LED. If omitted, the label is taken from the node name (excluding the unit address). * ``panic-indicator`` - This property specifies that the LED should be used as a - panic indicator. + panic indicator. diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst index 202bb3aa07..1c45267b1b 100644 --- a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst +++ b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst @@ -6,13 +6,14 @@ Required properties: * ``compatible``: ``fsl,imx6q-ocotp`` * ``reg``: physical register base and size -Optional properties: +Deprecated properties: * ``barebox,provide-mac-address``: Provide MAC addresses for Ethernet devices. This can be multiple entries in the form <&phandle regofs> to assign a MAC - address to an Ethernet device. + address to an Ethernet device. This has been deprecated in favor or the upstream + nvmem cell binding. -Example: +Legacy example: .. code-block:: none @@ -21,3 +22,21 @@ Example: reg = <0x021bc000 0x4000>; barebox,provide-mac-address = <&fec 0x620>; }; + +Upstream alternative: + +.. code-block:: none + + &ocotp1 { + #address-cells = <1>; + #size-cells = <1>; + + fec_mac_addr: mac-addr@88 { + reg = <0x88 6>; + }; + }; + + &fec { + nvmem-cells = <&fec_mac_addr>; + nvmem-cell-names = "mac-address"; + }; diff --git a/Documentation/devicetree/bindings/mtd/partition.rst b/Documentation/devicetree/bindings/mtd/partition.rst index 6db54070a9..0ba117dffc 100644 --- a/Documentation/devicetree/bindings/mtd/partition.rst +++ b/Documentation/devicetree/bindings/mtd/partition.rst @@ -1,22 +1,33 @@ +.. _devicetree_binding_mtd_partition: + Representing flash partitions in devicetree =========================================== In addition to the upstream binding, another property is added: Optional properties: -- ``partuuid`` : The partition UUID for this partition. + +* ``partuuid``: The global partition UUID for this partition. + For GPT partitions, the partuuid is the 16-byte GPT Partition UUID (e.g. + ``de6f4f5c-c055-4374-09f7-8c6821dfb60e``). + For MBR partitions, the partuuid is the 4-byte disk identifier + followed by a dash and the partition number (starting with 1, e.g. + ``c9178f9d-01``). + + The partuuid is case-insensitive. Additionally, barebox also supports partitioning the eMMC boot partitions if the partition table node is named appropriately: -- ``partitions`` : user partition -- ``boot0-partitions`` : boot0 partition -- ``boot1-partitions`` : boot1 partition + +* ``partitions`` : user partition +* ``boot0-partitions`` : boot0 partition +* ``boot1-partitions`` : boot1 partition Examples: .. code-block:: none - flash@0 { + / { partitions { compatible = "fixed-partitions"; #address-cells = <1>; diff --git a/Documentation/devicetree/bindings/power/restart.rst b/Documentation/devicetree/bindings/power/restart.rst new file mode 100644 index 0000000000..9a84c4f224 --- /dev/null +++ b/Documentation/devicetree/bindings/power/restart.rst @@ -0,0 +1,15 @@ +System Restart Controllers +========================== + +In addition to upstream bindings, following properties are understood: + +Optional properties: + +- ``restart-priority`` : Overrides the priority set by the driver. Normally, + the device with the biggest reach should reset the system. + See :ref:`system_reset` for more information. + +- ``barebox,restart-warm-bootrom`` : Restart will not cause loss to non-volatile + registers sampled by the bootrom at startup. This is a necessary precondition + for working :ref:`reboot_mode` communication between barebox and the SoC's + BootROM. diff --git a/Documentation/devicetree/bindings/regulator/regulator.rst b/Documentation/devicetree/bindings/regulator/regulator.rst index 9afc020acd..754c474328 100644 --- a/Documentation/devicetree/bindings/regulator/regulator.rst +++ b/Documentation/devicetree/bindings/regulator/regulator.rst @@ -4,6 +4,7 @@ Voltage/Current Regulators In addition to the upstream bindings, another property is added: Optional properties: + - ``barebox,allow-dummy-supply`` : A property to allow usage of dummy power regulator. This can be added to regulator nodes, whose drivers are not yet supported. It will rely on regulator reset defaults and use of dummy regulator diff --git a/Documentation/devicetree/bindings/watchdog/watchdog.rst b/Documentation/devicetree/bindings/watchdog/watchdog.rst new file mode 100644 index 0000000000..753dc7e35f --- /dev/null +++ b/Documentation/devicetree/bindings/watchdog/watchdog.rst @@ -0,0 +1,10 @@ +Watchdogs +========= + +In addition to the upstream bindings, following properties are understood: + +Optional properties: + +- ``watchdog-priority`` : Overrides the priority set by the driver. Normally, + the watchdog device with the biggest reach should reset the system. + See :ref:`system_reset` for more information. |