From fcdcb817774b93b001d1a88b746e07f641241a64 Mon Sep 17 00:00:00 2001 From: Ahmad Fatoum Date: Tue, 12 Jan 2021 14:51:20 +0100 Subject: documentation: devicetree: migrate remaining binding to reST Eventually, we will want to have formalized YAML bindings and scripts to turn them into reST for display in the online documentation. For now, just turn the remaining text files into reST, so they can be searched as well. Signed-off-by: Ahmad Fatoum Signed-off-by: Sascha Hauer --- .../bindings/firmware/altr,passive-serial.rst | 27 ++++++++++++++ .../bindings/firmware/altr,passive-serial.txt | 25 ------------- .../bindings/firmware/altr,socfpga-fpga-mgr.rst | 21 +++++++++++ .../bindings/firmware/altr,socfpga-fpga-mgr.txt | 19 ---------- .../devicetree/bindings/mtd/partition.rst | 42 ++++++++++++++++++++++ .../devicetree/bindings/mtd/partition.txt | 39 -------------------- 6 files changed, 90 insertions(+), 83 deletions(-) create mode 100644 Documentation/devicetree/bindings/firmware/altr,passive-serial.rst delete mode 100644 Documentation/devicetree/bindings/firmware/altr,passive-serial.txt create mode 100644 Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst delete mode 100644 Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.txt create mode 100644 Documentation/devicetree/bindings/mtd/partition.rst delete mode 100644 Documentation/devicetree/bindings/mtd/partition.txt (limited to 'Documentation') diff --git a/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst b/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst new file mode 100644 index 0000000000..1012137bc9 --- /dev/null +++ b/Documentation/devicetree/bindings/firmware/altr,passive-serial.rst @@ -0,0 +1,27 @@ +Altera FPGAs in passive serial mode +=================================== + +This binding defines the control interface to Altera FPGAs in +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 +- ``nstat-gpios``: Specify GPIO for controlling the nstat pin +- ``confd-gpios``: Specify GPIO for controlling the confd pin +- ``nconfig-gpios``: Specify GPIO for controlling the nconfig pin + +Example: + +.. code-block:: none + + fpga@0 { + compatible = "altr,fpga-passive-serial"; + nstat-gpios = <&gpio4 18 0>; + confd-gpios = <&gpio4 19 0>; + nconfig-gpios = <&gpio4 20 0>; + spi-max-frequency = <10000000>; + reg = <0>; + }; diff --git a/Documentation/devicetree/bindings/firmware/altr,passive-serial.txt b/Documentation/devicetree/bindings/firmware/altr,passive-serial.txt deleted file mode 100644 index eec12fbace..0000000000 --- a/Documentation/devicetree/bindings/firmware/altr,passive-serial.txt +++ /dev/null @@ -1,25 +0,0 @@ -Altera FPGAs in passive serial mode ------------------------------------ - -This binding defines the control interface to Altera FPGAs in -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 -- nstat-gpios: Specify GPIO for controlling the nstat pin -- confd-gpios: Specify GPIO for controlling the confd pin -- nconfig-gpios: Specify GPIO for controlling the nconfig pin - -Example: - - fpga@0 { - compatible = "altr,fpga-passive-serial"; - nstat-gpios = <&gpio4 18 0>; - confd-gpios = <&gpio4 19 0>; - nconfig-gpios = <&gpio4 20 0>; - spi-max-frequency = <10000000>; - reg = <0>; - }; diff --git a/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst b/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst new file mode 100644 index 0000000000..9f7de6b985 --- /dev/null +++ b/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.rst @@ -0,0 +1,21 @@ +Altera SOCFPGA FPGA Manager +=========================== + +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. + +Example: + +.. code-block:: none + + fpgamgr@ff706000 { + compatible = "altr,socfpga-fpga-mgr"; + reg = <0xff706000 0x1000>, + <0xffb90000 0x1000>; + }; diff --git a/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.txt b/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.txt deleted file mode 100644 index 70ec4abf25..0000000000 --- a/Documentation/devicetree/bindings/firmware/altr,socfpga-fpga-mgr.txt +++ /dev/null @@ -1,19 +0,0 @@ -Altera SOCFPGA FPGA Manager ---------------------------- - -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. - -Example: - - fpgamgr@ff706000 { - compatible = "altr,socfpga-fpga-mgr"; - reg = <0xff706000 0x1000>, - <0xffb90000 0x1000>; - }; diff --git a/Documentation/devicetree/bindings/mtd/partition.rst b/Documentation/devicetree/bindings/mtd/partition.rst new file mode 100644 index 0000000000..6db54070a9 --- /dev/null +++ b/Documentation/devicetree/bindings/mtd/partition.rst @@ -0,0 +1,42 @@ +Representing flash partitions in devicetree +=========================================== + +In addition to the upstream binding, another property is added: + +Optional properties: +- ``partuuid`` : The partition UUID for this partition. + +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 + +Examples: + +.. code-block:: none + + flash@0 { + partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + state_part: state { + partuuid = "16367da7-c518-499f-9aad-e1f366692365"; + }; + }; + }; + + emmc@1 { + boot0-partitions { + compatible = "fixed-partitions"; + #address-cells = <1>; + #size-cells = <1>; + + barebox@0 { + label = "barebox"; + reg = <0x0 0x300000>; + }; + }; + }; diff --git a/Documentation/devicetree/bindings/mtd/partition.txt b/Documentation/devicetree/bindings/mtd/partition.txt deleted file mode 100644 index 4288a82437..0000000000 --- a/Documentation/devicetree/bindings/mtd/partition.txt +++ /dev/null @@ -1,39 +0,0 @@ -Representing flash partitions in devicetree - -In addition to the upstream binding, another property is added: - -Optional properties: -- partuuid : The partition UUID for this partition. - -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 - -Examples: - -flash@0 { - partitions { - compatible = "fixed-partitions"; - #address-cells = <1>; - #size-cells = <1>; - - state_part: state { - partuuid = "16367da7-c518-499f-9aad-e1f366692365"; - }; - }; -}; - -emmc@1 { - boot0-partitions { - compatible = "fixed-partitions"; - #address-cells = <1>; - #size-cells = <1>; - - barebox@0 { - label = "barebox"; - reg = <0x0 0x300000>; - }; - }; -}; -- cgit v1.2.3