From 1bb257a9b33d499e1d9f6edad8d3396243741b81 Mon Sep 17 00:00:00 2001 From: Patrick Delaunay Date: Mon, 13 Jan 2020 11:34:58 +0100 Subject: dt-bindings: gpio: document the new pull-up/pull-down flags This commit extends the flags that can be used in GPIO specifiers to indicate if a pull-up resistor or pull-down resistor should be enabled. It is the backport of linux commit ede033e1e863c ('dt-bindings: gpio: document the new pull-up/pull-down flags') from Thomas Petazzoni and integrated in v5.1-rc1 https://github.com/torvalds/linux/commit/ede033e1e863c Signed-off-by: Patrick Delaunay Reviewed-by: Simon Glass --- doc/device-tree-bindings/gpio/gpio.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'doc') diff --git a/doc/device-tree-bindings/gpio/gpio.txt b/doc/device-tree-bindings/gpio/gpio.txt index e146917ff33..e9ef0212af8 100644 --- a/doc/device-tree-bindings/gpio/gpio.txt +++ b/doc/device-tree-bindings/gpio/gpio.txt @@ -65,6 +65,30 @@ Example of a node using GPIOs: GPIO_ACTIVE_HIGH is 0, so in this example gpio-specifier is "18 0" and encodes GPIO pin number, and GPIO flags as accepted by the "qe_pio_e" gpio-controller. +Optional standard bitfield specifiers for the last cell: + +- Bit 0: 0 means active high, 1 means active low +- Bit 1: 0 mean push-pull wiring, see: + https://en.wikipedia.org/wiki/Push-pull_output + 1 means single-ended wiring, see: + https://en.wikipedia.org/wiki/Single-ended_triode +- Bit 2: 0 means open-source, 1 means open drain, see: + https://en.wikipedia.org/wiki/Open_collector +- Bit 3: 0 means the output should be maintained during sleep/low-power mode + 1 means the output state can be lost during sleep/low-power mode +- Bit 4: 0 means no pull-up resistor should be enabled + 1 means a pull-up resistor should be enabled + This setting only applies to hardware with a simple on/off + control for pull-up configuration. If the hardware has more + elaborate pull-up configuration, it should be represented + using a pin control binding. +- Bit 5: 0 means no pull-down resistor should be enabled + 1 means a pull-down resistor should be enabled + This setting only applies to hardware with a simple on/off + control for pull-down configuration. If the hardware has more + elaborate pull-down configuration, it should be represented + using a pin control binding. + 1.1) GPIO specifier best practices ---------------------------------- -- cgit v1.3.1 From 6a0388c5b12b911e4e2a65b60731c1c245821181 Mon Sep 17 00:00:00 2001 From: Patrick Delaunay Date: Mon, 13 Jan 2020 11:35:10 +0100 Subject: dt-bindings: gpio: alignment with kernel v5.3 Update the binding file for gpio, it is just an alignment with kernel v5.3. The U-Boot code example for gpio-hog (not directly linked to binding) is moved in a new file doc/README.gpio. [commit 21676b706e99 ("gpio: fixes for gpio-hog support") & 'commit 4762a9988ede ("gpio: add gpio-hog support")'] Signed-off-by: Patrick Delaunay Reviewed-by: Simon Glass --- doc/README.gpio | 42 +++++ doc/device-tree-bindings/gpio/gpio.txt | 280 ++++++++++++++++++--------------- 2 files changed, 196 insertions(+), 126 deletions(-) create mode 100644 doc/README.gpio (limited to 'doc') diff --git a/doc/README.gpio b/doc/README.gpio new file mode 100644 index 00000000000..548ff37b8cc --- /dev/null +++ b/doc/README.gpio @@ -0,0 +1,42 @@ + +GPIO hog (CONFIG_GPIO_HOG) +-------- + +All the GPIO hog are initialized in gpio_hog_probe_all() function called in +board_r.c just before board_late_init() but you can also acces directly to +the gpio with gpio_hog_lookup_name(). + + +Example, for the device tree: + + tca6416@20 { + compatible = "ti,tca6416"; + reg = <0x20>; + #gpio-cells = <2>; + gpio-controller; + + env_reset { + gpio-hog; + input; + gpios = <6 GPIO_ACTIVE_LOW>; + }; + boot_rescue { + gpio-hog; + input; + line-name = "foo-bar-gpio"; + gpios = <7 GPIO_ACTIVE_LOW>; + }; + }; + +You can than access the gpio in your board code with: + + struct gpio_desc *desc; + int ret; + + ret = gpio_hog_lookup_name("boot_rescue", &desc); + if (ret) + return; + if (dm_gpio_get_value(desc) == 1) + printf("\nBooting into Rescue System\n"); + else if (dm_gpio_get_value(desc) == 0) + printf("\nBoot normal\n"); diff --git a/doc/device-tree-bindings/gpio/gpio.txt b/doc/device-tree-bindings/gpio/gpio.txt index e9ef0212af8..1481ed607d7 100644 --- a/doc/device-tree-bindings/gpio/gpio.txt +++ b/doc/device-tree-bindings/gpio/gpio.txt @@ -4,19 +4,12 @@ Specifying GPIO information for devices 1) gpios property ----------------- -Nodes that makes use of GPIOs should specify them using one or more -properties, each containing a 'gpio-list': - - gpio-list ::= [gpio-list] - single-gpio ::= - gpio-phandle : phandle to gpio controller node - gpio-specifier : Array of #gpio-cells specifying specific gpio - (controller specific) - GPIO properties should be named "[-]gpios", with being the purpose of this GPIO for the device. While a non-existent is considered valid for compatibility reasons (resolving to the "gpios" property), it is not allowed -for new bindings. +for new bindings. Also, GPIO properties named "[-]gpio" are valid and old +bindings use it, but are only supported for compatibility reasons and should not +be used for newer bindings since it has been deprecated. GPIO properties can contain one or more GPIO phandles, but only in exceptional cases should they contain more than one. If your device uses several GPIOs with @@ -31,30 +24,28 @@ The following example could be used to describe GPIO pins used as device enable and bit-banged data signals: gpio1: gpio1 { - gpio-controller - #gpio-cells = <2>; - }; - gpio2: gpio2 { - gpio-controller - #gpio-cells = <1>; + gpio-controller; + #gpio-cells = <2>; }; [...] - enable-gpios = <&gpio2 2>; data-gpios = <&gpio1 12 0>, <&gpio1 13 0>, <&gpio1 14 0>, <&gpio1 15 0>; -Note that gpio-specifier length is controller dependent. In the -above example, &gpio1 uses 2 cells to specify a gpio, while &gpio2 -only uses one. +In the above example, &gpio1 uses 2 cells to specify a gpio. The first cell is +a local offset to the GPIO line and the second cell represent consumer flags, +such as if the consumer desire the line to be active low (inverted) or open +drain. This is the recommended practice. -gpio-specifier may encode: bank, pin position inside the bank, -whether pin is open-drain and whether pin is logically inverted. -Exact meaning of each specifier cell is controller specific, and must -be documented in the device tree binding for the device. Use the macros -defined in include/dt-bindings/gpio/gpio.h whenever possible: +The exact meaning of each specifier cell is controller specific, and must be +documented in the device tree binding for the device, but it is strongly +recommended to use the two-cell approach. + +Most controllers are specifying a generic flag bitfield in the last cell, so +for these, use the macros defined in +include/dt-bindings/gpio/gpio.h whenever possible: Example of a node using GPIOs: @@ -140,6 +131,80 @@ Every GPIO controller node must contain both an empty "gpio-controller" property, and a #gpio-cells integer property, which indicates the number of cells in a gpio-specifier. +Some system-on-chips (SoCs) use the concept of GPIO banks. A GPIO bank is an +instance of a hardware IP core on a silicon die, usually exposed to the +programmer as a coherent range of I/O addresses. Usually each such bank is +exposed in the device tree as an individual gpio-controller node, reflecting +the fact that the hardware was synthesized by reusing the same IP block a +few times over. + +Optionally, a GPIO controller may have a "ngpios" property. This property +indicates the number of in-use slots of available slots for GPIOs. The +typical example is something like this: the hardware register is 32 bits +wide, but only 18 of the bits have a physical counterpart. The driver is +generally written so that all 32 bits can be used, but the IP block is reused +in a lot of designs, some using all 32 bits, some using 18 and some using +12. In this case, setting "ngpios = <18>;" informs the driver that only the +first 18 GPIOs, at local offset 0 .. 17, are in use. + +If these GPIOs do not happen to be the first N GPIOs at offset 0...N-1, an +additional set of tuples is needed to specify which GPIOs are unusable, with +the gpio-reserved-ranges binding. This property indicates the start and size +of the GPIOs that can't be used. + +Optionally, a GPIO controller may have a "gpio-line-names" property. This is +an array of strings defining the names of the GPIO lines going out of the +GPIO controller. This name should be the most meaningful producer name +for the system, such as a rail name indicating the usage. Package names +such as pin name are discouraged: such lines have opaque names (since they +are by definition generic purpose) and such names are usually not very +helpful. For example "MMC-CD", "Red LED Vdd" and "ethernet reset" are +reasonable line names as they describe what the line is used for. "GPIO0" +is not a good name to give to a GPIO line. Placeholders are discouraged: +rather use the "" (blank string) if the use of the GPIO line is undefined +in your design. The names are assigned starting from line offset 0 from +left to right from the passed array. An incomplete array (where the number +of passed named are less than ngpios) will still be used up until the last +provided valid line index. + +Example: + +gpio-controller@00000000 { + compatible = "foo"; + reg = <0x00000000 0x1000>; + gpio-controller; + #gpio-cells = <2>; + ngpios = <18>; + gpio-reserved-ranges = <0 4>, <12 2>; + gpio-line-names = "MMC-CD", "MMC-WP", "VDD eth", "RST eth", "LED R", + "LED G", "LED B", "Col A", "Col B", "Col C", "Col D", + "Row A", "Row B", "Row C", "Row D", "NMI button", + "poweroff", "reset"; +} + +The GPIO chip may contain GPIO hog definitions. GPIO hogging is a mechanism +providing automatic GPIO request and configuration as part of the +gpio-controller's driver probe function. + +Each GPIO hog definition is represented as a child node of the GPIO controller. +Required properties: +- gpio-hog: A property specifying that this child node represents a GPIO hog. +- gpios: Store the GPIO information (id, flags, ...) for each GPIO to + affect. Shall contain an integer multiple of the number of cells + specified in its parent node (GPIO controller node). +Only one of the following properties scanned in the order shown below. +This means that when multiple properties are present they will be searched +in the order presented below and the first match is taken as the intended +configuration. +- input: A property specifying to set the GPIO direction as input. +- output-low A property specifying to set the GPIO direction as output with + the value low. +- output-high A property specifying to set the GPIO direction as output with + the value high. + +Optional properties: +- line-name: The GPIO label name. If not present the node name is used. + Example of two SOC GPIO banks defined as gpio-controller nodes: qe_pio_a: gpio-controller@1400 { @@ -161,46 +226,40 @@ Example of two SOC GPIO banks defined as gpio-controller nodes: Some or all of the GPIOs provided by a GPIO controller may be routed to pins on the package via a pin controller. This allows muxing those pins between -GPIO and other functions. +GPIO and other functions. It is a fairly common practice among silicon +engineers. + +2.2) Ordinary (numerical) GPIO ranges +------------------------------------- It is useful to represent which GPIOs correspond to which pins on which pin -controllers. The gpio-ranges property described below represents this, and -contains information structures as follows: - - gpio-range-list ::= [gpio-range-list] - single-gpio-range ::= | - numeric-gpio-range ::= - - named-gpio-range ::= '<0 0>' - pinctrl-phandle : phandle to pin controller node - gpio-base : Base GPIO ID in the GPIO controller - pinctrl-base : Base pinctrl pin ID in the pin controller - count : The number of GPIOs/pins in this range - -The "pin controller node" mentioned above must conform to the bindings -described in ../pinctrl/pinctrl-bindings.txt. - -In case named gpio ranges are used (ranges with both and - set to 0), the property gpio-ranges-group-names contains one string -for every single-gpio-range in gpio-ranges: - gpiorange-names-list ::= [gpiorange-names-list] - gpiorange-name : Name of the pingroup associated to the GPIO range in - the respective pin controller. - -Elements of gpiorange-names-list corresponding to numeric ranges contain -the empty string. Elements of gpiorange-names-list corresponding to named -ranges contain the name of a pin group defined in the respective pin -controller. The number of pins/GPIOs in the range is the number of pins in -that pin group. +controllers. The gpio-ranges property described below represents this with +a discrete set of ranges mapping pins from the pin controller local number space +to pins in the GPIO controller local number space. -Previous versions of this binding required all pin controller nodes that -were referenced by any gpio-ranges property to contain a property named -#gpio-range-cells with value <3>. This requirement is now deprecated. -However, that property may still exist in older device trees for -compatibility reasons, and would still be required even in new device -trees that need to be compatible with older software. +The format is: <[pin controller phandle], [GPIO controller offset], + [pin controller offset], [number of pins]>; + +The GPIO controller offset pertains to the GPIO controller node containing the +range definition. + +The pin controller node referenced by the phandle must conform to the bindings +described in pinctrl/pinctrl-bindings.txt. + +Each offset runs from 0 to N. It is perfectly fine to pile any number of +ranges with just one pin-to-GPIO line mapping if the ranges are concocted, but +in practice these ranges are often lumped in discrete sets. + +Example: -Example 1: + gpio-ranges = <&foo 0 20 10>, <&bar 10 50 20>; + +This means: +- pins 20..29 on pin controller "foo" is mapped to GPIO line 0..9 and +- pins 50..69 on pin controller "bar" is mapped to GPIO line 10..29 + + +Verbose example: qe_pio_e: gpio-controller@1460 { #gpio-cells = <2>; @@ -211,12 +270,33 @@ Example 1: }; Here, a single GPIO controller has GPIOs 0..9 routed to pin controller -pinctrl1's pins 20..29, and GPIOs 10..19 routed to pin controller pinctrl2's -pins 50..59. +pinctrl1's pins 20..29, and GPIOs 10..29 routed to pin controller pinctrl2's +pins 50..69. + + +2.3) GPIO ranges from named pin groups +-------------------------------------- -Example 2: +It is also possible to use pin groups for gpio ranges when pin groups are the +easiest and most convenient mapping. - gpio_pio_i: gpio-controller@14B0 { +Both both and must set to 0 when using named pin groups +names. + +The property gpio-ranges-group-names must contain exactly one string for each +range. + +Elements of gpio-ranges-group-names must contain the name of a pin group +defined in the respective pin controller. The number of pins/GPIO lines in the +range is the number of pins in that pin group. The number of pins of that +group is defined int the implementation and not in the device tree. + +If numerical and named pin groups are mixed, the string corresponding to a +numerical pin range in gpio-ranges-group-names must be empty. + +Example: + + gpio_pio_i: gpio-controller@14b0 { #gpio-cells = <2>; compatible = "fsl,qe-pario-bank-e", "fsl,qe-pario-bank"; reg = <0x1480 0x18>; @@ -231,66 +311,14 @@ Example 2: "bar"; }; -Here, three GPIO ranges are defined wrt. two pin controllers. pinctrl1 GPIO -ranges are defined using pin numbers whereas the GPIO ranges wrt. pinctrl2 -are named "foo" and "bar". - -3) GPIO hog definitions ------------------------ - -The GPIO chip may contain GPIO hog definitions. GPIO hogging is a mechanism -providing automatic GPIO request and configuration as part of the -gpio-controller's driver probe function. - -Each GPIO hog definition is represented as a child node of the GPIO controller. -Required properties: -- gpio-hog: A property specifying that this child node represents a GPIO hog. -- gpios: Store the GPIO information (id, flags) for the GPIO to - affect. - - ! Not yet support more than one gpio ! +Here, three GPIO ranges are defined referring to two pin controllers. -Only one of the following properties scanned in the order shown below. -- input: A property specifying to set the GPIO direction as input. -- output-low A property specifying to set the GPIO direction as output with - the value low. -- output-high A property specifying to set the GPIO direction as output with - the value high. +pinctrl1 GPIO ranges are defined using pin numbers whereas the GPIO ranges +in pinctrl2 are defined using the pin groups named "foo" and "bar". -Optional properties: -- line-name: The GPIO label name. If not present the node name is used. - -Example: - - tca6416@20 { - compatible = "ti,tca6416"; - reg = <0x20>; - #gpio-cells = <2>; - gpio-controller; - - env_reset { - gpio-hog; - input; - gpios = <6 GPIO_ACTIVE_LOW>; - }; - boot_rescue { - gpio-hog; - input; - line-name = "foo-bar-gpio"; - gpios = <7 GPIO_ACTIVE_LOW>; - }; - }; - -For the above Example you can than access the gpio in your boardcode -with: - - struct gpio_desc *desc; - int ret; - - ret = gpio_hog_lookup_name("boot_rescue", &desc); - if (ret) - return; - if (dm_gpio_get_value(desc) == 1) - printf("\nBooting into Rescue System\n"); - else if (dm_gpio_get_value(desc) == 0) - printf("\nBoot normal\n"); +Previous versions of this binding required all pin controller nodes that +were referenced by any gpio-ranges property to contain a property named +#gpio-range-cells with value <3>. This requirement is now deprecated. +However, that property may still exist in older device trees for +compatibility reasons, and would still be required even in new device +trees that need to be compatible with older software. -- cgit v1.3.1 From b09e28fc54bb51c41df9e0302f3ddac952c6d9fa Mon Sep 17 00:00:00 2001 From: Patrick Delaunay Date: Fri, 28 Feb 2020 15:18:12 +0100 Subject: doc: update reference to README.imximage Update reference in many files detected by scripts/documentation-file-ref-check README.imximage => imx/mkimage/imximage.txt Signed-off-by: Patrick Delaunay --- board/advantech/dms-ba16/dms-ba16_1g.cfg | 2 +- board/advantech/dms-ba16/dms-ba16_2g.cfg | 2 +- board/aristainetos/aristainetos2.cfg | 2 +- board/bachmann/ot1200/mx6q_4x_mt41j128.cfg | 2 +- board/barco/titanium/imximage.cfg | 2 +- board/boundary/nitrogen6x/nitrogen6dl.cfg | 2 +- board/boundary/nitrogen6x/nitrogen6dl2g.cfg | 2 +- board/boundary/nitrogen6x/nitrogen6q.cfg | 2 +- board/boundary/nitrogen6x/nitrogen6q2g.cfg | 2 +- board/boundary/nitrogen6x/nitrogen6s.cfg | 2 +- board/boundary/nitrogen6x/nitrogen6s1g.cfg | 2 +- board/ccv/xpress/imximage.cfg | 2 +- board/freescale/mx25pdk/imximage.cfg | 2 +- board/freescale/mx51evk/imximage.cfg | 2 +- board/freescale/mx53ard/imximage_dd3.cfg | 2 +- board/freescale/mx53evk/imximage.cfg | 2 +- board/freescale/mx53loco/imximage.cfg | 2 +- board/freescale/mx53smd/imximage.cfg | 2 +- board/freescale/mx6qarm2/imximage.cfg | 2 +- board/freescale/mx6qarm2/imximage_mx6dl.cfg | 2 +- board/freescale/mx6slevk/imximage.cfg | 2 +- board/freescale/mx6ullevk/imximage.cfg | 2 +- board/freescale/mx7dsabresd/imximage.cfg | 2 +- board/freescale/s32v234evb/s32v234evb.cfg | 2 +- board/freescale/vf610twr/imximage.cfg | 2 +- board/ge/bx50v3/bx50v3.cfg | 2 +- board/ge/mx53ppd/imximage.cfg | 2 +- board/menlo/m53menlo/imximage.cfg | 2 +- board/phytec/pcm052/imximage.cfg | 2 +- board/seco/mx6quq7/mx6quq7-2g.cfg | 2 +- board/technexion/pico-imx6ul/imximage.cfg | 2 +- board/toradex/colibri-imx6ull/imximage.cfg | 2 +- board/toradex/colibri_imx7/imximage.cfg | 2 +- board/toradex/colibri_vf/imximage.cfg | 2 +- board/tqc/tqma6/clocks.cfg | 2 +- board/tqc/tqma6/tqma6dl.cfg | 2 +- board/tqc/tqma6/tqma6q.cfg | 2 +- board/tqc/tqma6/tqma6s.cfg | 2 +- board/warp/imximage.cfg | 2 +- board/warp7/imximage.cfg | 2 +- doc/imx/misc/sdp.txt | 2 +- 41 files changed, 41 insertions(+), 41 deletions(-) (limited to 'doc') diff --git a/board/advantech/dms-ba16/dms-ba16_1g.cfg b/board/advantech/dms-ba16/dms-ba16_1g.cfg index c2624ddc3e1..1c737baaf28 100644 --- a/board/advantech/dms-ba16/dms-ba16_1g.cfg +++ b/board/advantech/dms-ba16/dms-ba16_1g.cfg @@ -4,7 +4,7 @@ * Copyright 2015 Timesys Corporation. * Copyright 2015 General Electric Company * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/advantech/dms-ba16/dms-ba16_2g.cfg b/board/advantech/dms-ba16/dms-ba16_2g.cfg index 4ce93ff74b3..371a84eb7e2 100644 --- a/board/advantech/dms-ba16/dms-ba16_2g.cfg +++ b/board/advantech/dms-ba16/dms-ba16_2g.cfg @@ -4,7 +4,7 @@ * Copyright 2015 Timesys Corporation. * Copyright 2015 General Electric Company * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/aristainetos/aristainetos2.cfg b/board/aristainetos/aristainetos2.cfg index 965ad64b496..d088cc83ad4 100644 --- a/board/aristainetos/aristainetos2.cfg +++ b/board/aristainetos/aristainetos2.cfg @@ -6,7 +6,7 @@ * Based on: * Copyright (C) 2013 Boundary Devices * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/bachmann/ot1200/mx6q_4x_mt41j128.cfg b/board/bachmann/ot1200/mx6q_4x_mt41j128.cfg index ba5c0747979..f4f605fc8d0 100644 --- a/board/bachmann/ot1200/mx6q_4x_mt41j128.cfg +++ b/board/bachmann/ot1200/mx6q_4x_mt41j128.cfg @@ -3,7 +3,7 @@ * Copyright (C) 2011 Freescale Semiconductor, Inc. * Jason Liu * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/barco/titanium/imximage.cfg b/board/barco/titanium/imximage.cfg index 101fc76de47..1fc26ed2c94 100644 --- a/board/barco/titanium/imximage.cfg +++ b/board/barco/titanium/imximage.cfg @@ -6,7 +6,7 @@ * Copyright (C) 2011 Freescale Semiconductor, Inc. * Jason Liu * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/boundary/nitrogen6x/nitrogen6dl.cfg b/board/boundary/nitrogen6x/nitrogen6dl.cfg index 56b3bcbb2fb..9558e26a2f1 100644 --- a/board/boundary/nitrogen6x/nitrogen6dl.cfg +++ b/board/boundary/nitrogen6x/nitrogen6dl.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Boundary Devices * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/boundary/nitrogen6x/nitrogen6dl2g.cfg b/board/boundary/nitrogen6x/nitrogen6dl2g.cfg index 13f7a89232f..f5a107c2254 100644 --- a/board/boundary/nitrogen6x/nitrogen6dl2g.cfg +++ b/board/boundary/nitrogen6x/nitrogen6dl2g.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Boundary Devices * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/boundary/nitrogen6x/nitrogen6q.cfg b/board/boundary/nitrogen6x/nitrogen6q.cfg index 1304b52d183..b0bbf0d7975 100644 --- a/board/boundary/nitrogen6x/nitrogen6q.cfg +++ b/board/boundary/nitrogen6x/nitrogen6q.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Boundary Devices * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/boundary/nitrogen6x/nitrogen6q2g.cfg b/board/boundary/nitrogen6x/nitrogen6q2g.cfg index e5e923d3cff..4999254329f 100644 --- a/board/boundary/nitrogen6x/nitrogen6q2g.cfg +++ b/board/boundary/nitrogen6x/nitrogen6q2g.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Boundary Devices * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/boundary/nitrogen6x/nitrogen6s.cfg b/board/boundary/nitrogen6x/nitrogen6s.cfg index e5f814b7158..16d778491a4 100644 --- a/board/boundary/nitrogen6x/nitrogen6s.cfg +++ b/board/boundary/nitrogen6x/nitrogen6s.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Boundary Devices * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/boundary/nitrogen6x/nitrogen6s1g.cfg b/board/boundary/nitrogen6x/nitrogen6s1g.cfg index f3d754e23aa..0320078a911 100644 --- a/board/boundary/nitrogen6x/nitrogen6s1g.cfg +++ b/board/boundary/nitrogen6x/nitrogen6s1g.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Boundary Devices * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/ccv/xpress/imximage.cfg b/board/ccv/xpress/imximage.cfg index be7e391ddbe..b59dc842c1b 100644 --- a/board/ccv/xpress/imximage.cfg +++ b/board/ccv/xpress/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2015-2016 Stefan Roese * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx25pdk/imximage.cfg b/board/freescale/mx25pdk/imximage.cfg index 209775f2fde..762ccd0ab3f 100644 --- a/board/freescale/mx25pdk/imximage.cfg +++ b/board/freescale/mx25pdk/imximage.cfg @@ -3,7 +3,7 @@ * (C) Copyright 2009 * Stefano Babic DENX Software Engineering sbabic@denx.de. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx51evk/imximage.cfg b/board/freescale/mx51evk/imximage.cfg index 75500e70f35..ff2ec4aa273 100644 --- a/board/freescale/mx51evk/imximage.cfg +++ b/board/freescale/mx51evk/imximage.cfg @@ -3,7 +3,7 @@ * (C Copyright 2009 * Stefano Babic DENX Software Engineering sbabic@denx.de. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx53ard/imximage_dd3.cfg b/board/freescale/mx53ard/imximage_dd3.cfg index 9533dfb4564..fd033187b7c 100644 --- a/board/freescale/mx53ard/imximage_dd3.cfg +++ b/board/freescale/mx53ard/imximage_dd3.cfg @@ -3,7 +3,7 @@ * (C) Copyright 2009 * Stefano Babic DENX Software Engineering sbabic@denx.de. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx53evk/imximage.cfg b/board/freescale/mx53evk/imximage.cfg index d4158daafec..ef103d6da7d 100644 --- a/board/freescale/mx53evk/imximage.cfg +++ b/board/freescale/mx53evk/imximage.cfg @@ -3,7 +3,7 @@ * (C Copyright 2009 * Stefano Babic DENX Software Engineering sbabic@denx.de. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx53loco/imximage.cfg b/board/freescale/mx53loco/imximage.cfg index db578b2cf2d..d12801d19f2 100644 --- a/board/freescale/mx53loco/imximage.cfg +++ b/board/freescale/mx53loco/imximage.cfg @@ -3,7 +3,7 @@ * Copyright (C) 2011 Freescale Semiconductor, Inc. * Jason Liu * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx53smd/imximage.cfg b/board/freescale/mx53smd/imximage.cfg index 9533dfb4564..fd033187b7c 100644 --- a/board/freescale/mx53smd/imximage.cfg +++ b/board/freescale/mx53smd/imximage.cfg @@ -3,7 +3,7 @@ * (C) Copyright 2009 * Stefano Babic DENX Software Engineering sbabic@denx.de. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx6qarm2/imximage.cfg b/board/freescale/mx6qarm2/imximage.cfg index b0608f34673..74a33c25032 100644 --- a/board/freescale/mx6qarm2/imximage.cfg +++ b/board/freescale/mx6qarm2/imximage.cfg @@ -3,7 +3,7 @@ * Copyright (C) 2011-2014 Freescale Semiconductor, Inc. * Jason Liu * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx6qarm2/imximage_mx6dl.cfg b/board/freescale/mx6qarm2/imximage_mx6dl.cfg index 509c659649f..0d1353119ba 100644 --- a/board/freescale/mx6qarm2/imximage_mx6dl.cfg +++ b/board/freescale/mx6qarm2/imximage_mx6dl.cfg @@ -3,7 +3,7 @@ * Copyright (C) 2014 Freescale Semiconductor, Inc. * Jason Liu * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx6slevk/imximage.cfg b/board/freescale/mx6slevk/imximage.cfg index fd71bef286b..b97761a5162 100644 --- a/board/freescale/mx6slevk/imximage.cfg +++ b/board/freescale/mx6slevk/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Freescale Semiconductor, Inc. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx6ullevk/imximage.cfg b/board/freescale/mx6ullevk/imximage.cfg index 40818d0a037..155503997d2 100644 --- a/board/freescale/mx6ullevk/imximage.cfg +++ b/board/freescale/mx6ullevk/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2016 Freescale Semiconductor, Inc. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/mx7dsabresd/imximage.cfg b/board/freescale/mx7dsabresd/imximage.cfg index a0f39c4062e..05446ac833d 100644 --- a/board/freescale/mx7dsabresd/imximage.cfg +++ b/board/freescale/mx7dsabresd/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2015 Freescale Semiconductor, Inc. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/s32v234evb/s32v234evb.cfg b/board/freescale/s32v234evb/s32v234evb.cfg index 526b7d177fe..7881512139d 100644 --- a/board/freescale/s32v234evb/s32v234evb.cfg +++ b/board/freescale/s32v234evb/s32v234evb.cfg @@ -4,7 +4,7 @@ */ /* - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/freescale/vf610twr/imximage.cfg b/board/freescale/vf610twr/imximage.cfg index b1a8e8ef069..e2fa1a582d2 100644 --- a/board/freescale/vf610twr/imximage.cfg +++ b/board/freescale/vf610twr/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright 2013 Freescale Semiconductor, Inc. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/ge/bx50v3/bx50v3.cfg b/board/ge/bx50v3/bx50v3.cfg index f872ea24fc9..de3955a94d2 100644 --- a/board/ge/bx50v3/bx50v3.cfg +++ b/board/ge/bx50v3/bx50v3.cfg @@ -4,7 +4,7 @@ * Copyright 2015 Timesys Corporation. * Copyright 2015 General Electric Company * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/ge/mx53ppd/imximage.cfg b/board/ge/mx53ppd/imximage.cfg index 8dd1b0f979e..1ee81983907 100644 --- a/board/ge/mx53ppd/imximage.cfg +++ b/board/ge/mx53ppd/imximage.cfg @@ -7,7 +7,7 @@ * Copyright (C) 2011 Freescale Semiconductor, Inc. * Jason Liu * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/menlo/m53menlo/imximage.cfg b/board/menlo/m53menlo/imximage.cfg index 68b3eb5c1c3..282caf65e09 100644 --- a/board/menlo/m53menlo/imximage.cfg +++ b/board/menlo/m53menlo/imximage.cfg @@ -3,7 +3,7 @@ * M53 DRAM init values * Copyright (C) 2012-2013 Marek Vasut * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/phytec/pcm052/imximage.cfg b/board/phytec/pcm052/imximage.cfg index d25f6119421..cf72b84e77e 100644 --- a/board/phytec/pcm052/imximage.cfg +++ b/board/phytec/pcm052/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright 2015 3ADEV * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/seco/mx6quq7/mx6quq7-2g.cfg b/board/seco/mx6quq7/mx6quq7-2g.cfg index c48d64ba407..68d13cc92bc 100644 --- a/board/seco/mx6quq7/mx6quq7-2g.cfg +++ b/board/seco/mx6quq7/mx6quq7-2g.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Seco USA Inc * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/technexion/pico-imx6ul/imximage.cfg b/board/technexion/pico-imx6ul/imximage.cfg index ad9cc5a8f11..993c1da6700 100644 --- a/board/technexion/pico-imx6ul/imximage.cfg +++ b/board/technexion/pico-imx6ul/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2015 Freescale Semiconductor, Inc. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/toradex/colibri-imx6ull/imximage.cfg b/board/toradex/colibri-imx6ull/imximage.cfg index a11e288c6c9..8d869d9f79e 100644 --- a/board/toradex/colibri-imx6ull/imximage.cfg +++ b/board/toradex/colibri-imx6ull/imximage.cfg @@ -3,7 +3,7 @@ * Copyright (C) 2016 Freescale Semiconductor, Inc. * Copyright (C) 2018 Toradex AG * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/toradex/colibri_imx7/imximage.cfg b/board/toradex/colibri_imx7/imximage.cfg index 1b4f272bb62..bdce48b7ffa 100644 --- a/board/toradex/colibri_imx7/imximage.cfg +++ b/board/toradex/colibri_imx7/imximage.cfg @@ -3,7 +3,7 @@ * Copyright (C) 2015 Freescale Semiconductor, Inc. * 2015 Toradex AG * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/toradex/colibri_vf/imximage.cfg b/board/toradex/colibri_vf/imximage.cfg index 623371d0694..7e629d2f9e7 100644 --- a/board/toradex/colibri_vf/imximage.cfg +++ b/board/toradex/colibri_vf/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright 2014 Toradex, Inc. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/tqc/tqma6/clocks.cfg b/board/tqc/tqma6/clocks.cfg index a98b30bfe70..1f2001c75f0 100644 --- a/board/tqc/tqma6/clocks.cfg +++ b/board/tqc/tqma6/clocks.cfg @@ -3,7 +3,7 @@ * Copyright (C) 2013 Boundary Devices * Copyright (C) 2013, 2014 Markus Niebel * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image */ diff --git a/board/tqc/tqma6/tqma6dl.cfg b/board/tqc/tqma6/tqma6dl.cfg index 84c38b470b9..80c71503161 100644 --- a/board/tqc/tqma6/tqma6dl.cfg +++ b/board/tqc/tqma6/tqma6dl.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2014 - 2015 Markus Niebel * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/tqc/tqma6/tqma6q.cfg b/board/tqc/tqma6/tqma6q.cfg index 6141be673b0..82a0a271d4f 100644 --- a/board/tqc/tqma6/tqma6q.cfg +++ b/board/tqc/tqma6/tqma6q.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013, 2014 Markus Niebel * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/tqc/tqma6/tqma6s.cfg b/board/tqc/tqma6/tqma6s.cfg index 2d2d65ecc63..9cdbb3c7676 100644 --- a/board/tqc/tqma6/tqma6s.cfg +++ b/board/tqc/tqma6/tqma6s.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013, 2014 Markus Niebel * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/warp/imximage.cfg b/board/warp/imximage.cfg index dea331cab15..619f6aa7b06 100644 --- a/board/warp/imximage.cfg +++ b/board/warp/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2013 Freescale Semiconductor, Inc. * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/board/warp7/imximage.cfg b/board/warp7/imximage.cfg index a4c2f677a1a..9e7d4725e4a 100644 --- a/board/warp7/imximage.cfg +++ b/board/warp7/imximage.cfg @@ -2,7 +2,7 @@ /* * Copyright (C) 2016 NXP Semiconductors * - * Refer doc/README.imximage for more details about how-to configure + * Refer doc/imx/mkimage/imximage.txt for more details about how-to configure * and create imximage boot image * * The syntax is taken as close as possible with the kwbimage diff --git a/doc/imx/misc/sdp.txt b/doc/imx/misc/sdp.txt index 6ea6e413950..49b281234b7 100644 --- a/doc/imx/misc/sdp.txt +++ b/doc/imx/misc/sdp.txt @@ -22,7 +22,7 @@ described in the manual. It is a replacement for Freescale's MFGTOOLS. The host side utilities are typically capable to interpret the i.MX -specific image header (see doc/README.imximage). There are extensions +specific image header (see doc/imx/mkimage/imximage.txt). There are extensions for imx_loader's imx_usb utility which allow to interpret the U-Boot specific legacy image format (see mkimage(1)). Also the U-Boot side support beside the i.MX specific header the U-Boot legacy header. -- cgit v1.3.1 From 3256afb55ed7faf5ddf7e1a063b13e3930b7a025 Mon Sep 17 00:00:00 2001 From: Patrick Delaunay Date: Fri, 28 Feb 2020 15:18:15 +0100 Subject: doc: device-tree-bindings: update reference to binding directory Update reference in files detected by scripts/documentation-file-ref-check doc/devicetree/device-tree-bindings/ => doc/device-tree-bindings/ Signed-off-by: Patrick Delaunay --- doc/device-tree-bindings/video/rockchip-lvds.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/device-tree-bindings/video/rockchip-lvds.txt b/doc/device-tree-bindings/video/rockchip-lvds.txt index 07e3d3f9deb..7432e221669 100644 --- a/doc/device-tree-bindings/video/rockchip-lvds.txt +++ b/doc/device-tree-bindings/video/rockchip-lvds.txt @@ -20,7 +20,7 @@ Required properties: , This describes the output face. - display-timings : described by - doc/devicetree/device-tree-bindings/video/display-timing.txt. + doc/device-tree-bindings/video/display-timing.txt. Example: lvds: lvds@ff96c000 { -- cgit v1.3.1