diff options
author | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-17 10:37:25 +0200 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-26 11:07:10 +0200 |
commit | 3fef396bb42efc0bb12b0a8caf0d076ab1c4d879 (patch) | |
tree | 91625b2407ed25dffd093b19159135481eb80f84 /Documentation/devicetree | |
parent | 7e65163b9165bccca780da91fad247c0e4ac7f9f (diff) | |
download | barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.gz barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.xz |
Documentation: Add new sphinxs docs
This is a rewrite of the Documentation in reStructuredText format using
Sphinx as build system, see http://sphinx-doc.org/.
The documentation is built into static html pages with 'make docs'.
The pages can be found under Documentation/html after building.
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/devicetree')
-rw-r--r-- | Documentation/devicetree/bindings/README | 6 | ||||
-rw-r--r-- | Documentation/devicetree/bindings/barebox/barebox,environment.rst | 25 | ||||
-rw-r--r-- | Documentation/devicetree/bindings/leds/common.rst | 9 | ||||
-rw-r--r-- | Documentation/devicetree/bindings/misc/fsl,imx-iim.rst | 21 | ||||
-rw-r--r-- | Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst | 21 | ||||
-rw-r--r-- | Documentation/devicetree/index.rst | 13 |
6 files changed, 95 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/README b/Documentation/devicetree/bindings/README new file mode 100644 index 0000000000..b818ee8243 --- /dev/null +++ b/Documentation/devicetree/bindings/README @@ -0,0 +1,6 @@ + +barebox uses the same devicetree bindings as the kernel. For +the bindings derived from the kernel look in the kernel sources +for reference. + +barebox specific bindings are documented here. diff --git a/Documentation/devicetree/bindings/barebox/barebox,environment.rst b/Documentation/devicetree/bindings/barebox/barebox,environment.rst new file mode 100644 index 0000000000..d243484d90 --- /dev/null +++ b/Documentation/devicetree/bindings/barebox/barebox,environment.rst @@ -0,0 +1,25 @@ +barebox environment +=================== + +This driver provides an environment for barebox from the devicetree. + +Required properties: +- compatible: should be "barebox,environment" +- device-path: path to the environment + +The device-path is a multistring property. The first string should be a +nodepath to the node containing the physical device of the environment. +The subsequent strings are of the form <type>:<options> to further describe +the path to the environment. Supported values for <type>: + +partname:<partname> This describes a partition on a device. <partname> can + be the label for mtd partitions, the number for DOS + partitions (beginning with 0) or the name for GPT + partitions + +Example:: + + environment@0 { + compatible = "barebox,environment"; + device-path = &flash, "partname:barebox-environment"; + }; diff --git a/Documentation/devicetree/bindings/leds/common.rst b/Documentation/devicetree/bindings/leds/common.rst new file mode 100644 index 0000000000..63a45bda5c --- /dev/null +++ b/Documentation/devicetree/bindings/leds/common.rst @@ -0,0 +1,9 @@ +Common leds properties +====================== + +- linux,default-trigger barebox,default-trigger: This parameter, if present, is a + string defining the trigger assigned to the LED. Current triggers are: + "heartbeat" - LED flashes at a constant rate + "panic" - LED turns on when barebox panics + "net" - LED indicates network activity + diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst new file mode 100644 index 0000000000..a067579189 --- /dev/null +++ b/Documentation/devicetree/bindings/misc/fsl,imx-iim.rst @@ -0,0 +1,21 @@ +Freescale i.MX IIM (Ic Identification Module) +============================================= + +Required properties: + +- compatible: fsl,imx27-iim +- reg: physical register base and size + +Optional properties: + +- barebox,provide-mac-address: Provide MAC addresses for ethernet devices. This + can be multiple entries in the form <&phandle bankno fuseofs> to specify a MAC + address to a ethernet device. + +Example:: + + iim: iim@83f98000 { + compatible = "fsl,imx51-iim", "fsl,imx27-iim"; + reg = <0x83f98000 0x4000>; + barebox,provide-mac-address = <&fec 1 9>; + }; diff --git a/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst new file mode 100644 index 0000000000..472b9e251f --- /dev/null +++ b/Documentation/devicetree/bindings/misc/fsl,imx-ocotp.rst @@ -0,0 +1,21 @@ +Freescale i.MX OCOTP (On-Chip OTP) +================================== + +Required properties: + +- compatible: fsl,imx6q-ocotp +- reg: physical register base and size + +Optional properties: + +- barebox,provide-mac-address: Provide MAC addresses for ethernet devices. This + can be multiple entries in the form <&phandle regofs> to specify a MAC + address to a ethernet device. + +Example:: + + ocotp1: ocotp@021bc000 { + compatible = "fsl,imx6q-ocotp"; + reg = <0x021bc000 0x4000>; + barebox,provide-mac-address = <&fec 0x620>; + }; diff --git a/Documentation/devicetree/index.rst b/Documentation/devicetree/index.rst new file mode 100644 index 0000000000..a24d635fde --- /dev/null +++ b/Documentation/devicetree/index.rst @@ -0,0 +1,13 @@ +barebox specific devicetree bindings +==================================== + +Contents: + +.. toctree:: + :glob: + :numbered: + :maxdepth: 1 + + bindings/barebox/* + bindings/leds/* + bindings/misc/* |