Re: [PATCH v4 7/8] dt-bindings: memory-controllers: ti,gpmc: Convert to yaml

Krzysztof Kozlowski
2021-09-15T07:21:32Z

On 14/09/2021 14:27, Roger Quadros wrote:
> Convert omap-gpmc.txt to ti,gpmc.yaml.
>
> Signed-off-by: Roger Quadros <rogerq@kernel.org>
> ---
> .../bindings/memory-controllers/omap-gpmc.txt | 157 ----------------
> .../bindings/memory-controllers/ti,gpmc.yaml | 172 ++++++++++++++++++
> 2 files changed, 172 insertions(+), 157 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/memory-controllers/omap-gpmc.txt
> create mode 100644 Documentation/devicetree/bindings/memory-controllers/ti,gpmc.yaml
>
> diff --git a/Documentation/devicetree/bindings/memory-controllers/omap-gpmc.txt b/Documentation/devicetree/bindings/memory-controllers/omap-gpmc.txt
> deleted file mode 100644
> index c1359f4d48d7..000000000000
> --- a/Documentation/devicetree/bindings/memory-controllers/omap-gpmc.txt
> +++ /dev/null
> @@ -1,157 +0,0 @@
> -Device tree bindings for OMAP general purpose memory controllers (GPMC)
> -
> -The actual devices are instantiated from the child nodes of a GPMC node.
> -
> -Required properties:
> -
> - - compatible: Should be set to one of the following:
> -
> - ti,omap2420-gpmc (omap2420)
> - ti,omap2430-gpmc (omap2430)
> - ti,omap3430-gpmc (omap3430 & omap3630)
> - ti,omap4430-gpmc (omap4430 & omap4460 & omap543x)
> - ti,am3352-gpmc (am335x devices)
> -
> - - reg: A resource specifier for the register space
> - (see the example below)
> - - ti,hwmods: Should be set to "ti,gpmc" until the DT transition is
> - completed.
> - - #address-cells: Must be set to 2 to allow memory address translation
> - - #size-cells: Must be set to 1 to allow CS address passing
> - - gpmc,num-cs: The maximum number of chip-select lines that controller
> - can support.
> - - gpmc,num-waitpins: The maximum number of wait pins that controller can
> - support.
> - - ranges: Must be set up to reflect the memory layout with four
> - integer values for each chip-select line in use:
> -
> - <cs-number> 0 <physical address of mapping> <size>
> -
> - Currently, calculated values derived from the contents
> - of the per-CS register GPMC_CONFIG7 (as set up by the
> - bootloader) are used for the physical address decoding.
> - As this will change in the future, filling correct
> - values here is a requirement.
> - - interrupt-controller: The GPMC driver implements and interrupt controller for
> - the NAND events "fifoevent" and "termcount" plus the
> - rising/falling edges on the GPMC_WAIT pins.
> - The interrupt number mapping is as follows
> - 0 - NAND_fifoevent
> - 1 - NAND_termcount
> - 2 - GPMC_WAIT0 pin edge
> - 3 - GPMC_WAIT1 pin edge, and so on.
> - - interrupt-cells: Must be set to 2
> - - gpio-controller: The GPMC driver implements a GPIO controller for the
> - GPMC WAIT pins that can be used as general purpose inputs.
> - 0 maps to GPMC_WAIT0 pin.
> - - gpio-cells: Must be set to 2
> -
> -Required properties when using NAND prefetch dma:
> - - dmas GPMC NAND prefetch dma channel
> - - dma-names Must be set to "rxtx"
> -
> -Timing properties for child nodes. All are optional and default to 0.
> -
> - - gpmc,sync-clk-ps: Minimum clock period for synchronous mode, in picoseconds
> -
> - Chip-select signal timings (in nanoseconds) corresponding to GPMC_CONFIG2:
> - - gpmc,cs-on-ns: Assertion time
> - - gpmc,cs-rd-off-ns: Read deassertion time
> - - gpmc,cs-wr-off-ns: Write deassertion time
> -
> - ADV signal timings (in nanoseconds) corresponding to GPMC_CONFIG3:
> - - gpmc,adv-on-ns: Assertion time
> - - gpmc,adv-rd-off-ns: Read deassertion time
> - - gpmc,adv-wr-off-ns: Write deassertion time
> - - gpmc,adv-aad-mux-on-ns: Assertion time for AAD
> - - gpmc,adv-aad-mux-rd-off-ns: Read deassertion time for AAD
> - - gpmc,adv-aad-mux-wr-off-ns: Write deassertion time for AAD
> -
> - WE signals timings (in nanoseconds) corresponding to GPMC_CONFIG4:
> - - gpmc,we-on-ns Assertion time
> - - gpmc,we-off-ns: Deassertion time
> -
> - OE signals timings (in nanoseconds) corresponding to GPMC_CONFIG4:
> - - gpmc,oe-on-ns: Assertion time
> - - gpmc,oe-off-ns: Deassertion time
> - - gpmc,oe-aad-mux-on-ns: Assertion time for AAD
> - - gpmc,oe-aad-mux-off-ns: Deassertion time for AAD
> -
> - Access time and cycle time timings (in nanoseconds) corresponding to
> - GPMC_CONFIG5:
> - - gpmc,page-burst-access-ns: Multiple access word delay
> - - gpmc,access-ns: Start-cycle to first data valid delay
> - - gpmc,rd-cycle-ns: Total read cycle time
> - - gpmc,wr-cycle-ns: Total write cycle time
> - - gpmc,bus-turnaround-ns: Turn-around time between successive accesses
> - - gpmc,cycle2cycle-delay-ns: Delay between chip-select pulses
> - - gpmc,clk-activation-ns: GPMC clock activation time
> - - gpmc,wait-monitoring-ns: Start of wait monitoring with regard to valid
> - data
> -
> -Boolean timing parameters. If property is present parameter enabled and
> -disabled if omitted:
> - - gpmc,adv-extra-delay: ADV signal is delayed by half GPMC clock
> - - gpmc,cs-extra-delay: CS signal is delayed by half GPMC clock
> - - gpmc,cycle2cycle-diffcsen: Add "cycle2cycle-delay" between successive
> - accesses to a different CS
> - - gpmc,cycle2cycle-samecsen: Add "cycle2cycle-delay" between successive
> - accesses to the same CS
> - - gpmc,oe-extra-delay: OE signal is delayed by half GPMC clock
> - - gpmc,we-extra-delay: WE signal is delayed by half GPMC clock
> - - gpmc,time-para-granularity: Multiply all access times by 2
> -
> -The following are only applicable to OMAP3+ and AM335x:
> - - gpmc,wr-access-ns: In synchronous write mode, for single or
> - burst accesses, defines the number of
> - GPMC_FCLK cycles from start access time
> - to the GPMC_CLK rising edge used by the
> - memory device for the first data capture.
> - - gpmc,wr-data-mux-bus-ns: In address-data multiplex mode, specifies
> - the time when the first data is driven on
> - the address-data bus.
> -
> -GPMC chip-select settings properties for child nodes. All are optional.
> -
> -- gpmc,burst-length Page/burst length. Must be 4, 8 or 16.
> -- gpmc,burst-wrap Enables wrap bursting
> -- gpmc,burst-read Enables read page/burst mode
> -- gpmc,burst-write Enables write page/burst mode
> -- gpmc,device-width Total width of device(s) connected to a GPMC
> - chip-select in bytes. The GPMC supports 8-bit
> - and 16-bit devices and so this property must be
> - 1 or 2.
> -- gpmc,mux-add-data Address and data multiplexing configuration.
> - Valid values are 1 for address-address-data
> - multiplexing mode and 2 for address-data
> - multiplexing mode.
> -- gpmc,sync-read Enables synchronous read. Defaults to asynchronous
> - is this is not set.
> -- gpmc,sync-write Enables synchronous writes. Defaults to asynchronous
> - is this is not set.
> -- gpmc,wait-pin Wait-pin used by client. Must be less than
> - "gpmc,num-waitpins".
> -- gpmc,wait-on-read Enables wait monitoring on reads.
> -- gpmc,wait-on-write Enables wait monitoring on writes.
> -
> -Example for an AM33xx board:
> -
> - gpmc: gpmc@50000000 {
> - compatible = "ti,am3352-gpmc";
> - ti,hwmods = "gpmc";
> - reg = <0x50000000 0x2000>;
> - interrupts = <100>;
> - dmas = <&edma 52 0>;
> - dma-names = "rxtx";
> - gpmc,num-cs = <8>;
> - gpmc,num-waitpins = <2>;
> - #address-cells = <2>;
> - #size-cells = <1>;
> - ranges = <0 0 0x08000000 0x10000000>; /* CS0 @addr 0x8000000, size 0x10000000 */
> - interrupt-controller;
> - #interrupt-cells = <2>;
> - gpio-controller;
> - #gpio-cells = <2>;
> -
> - /* child nodes go here */
> - };
> diff --git a/Documentation/devicetree/bindings/memory-controllers/ti,gpmc.yaml b/Documentation/devicetree/bindings/memory-controllers/ti,gpmc.yaml
> new file mode 100644
> index 000000000000..d6cd39bd3940
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/memory-controllers/ti,gpmc.yaml
> @@ -0,0 +1,172 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/memory-controllers/ti,gpmc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments GPMC Memory Controller device-tree bindings
> +
> +maintainers:
> + - Tony Lindgren <tony@atomide.com>
> + - Roger Quadros <rogerq@kernel.org>
> +
> +description:
> + The GPMC is a unified memory controller dedicated for interfacing
> + with external memory devices like
> + - Asynchronous SRAM-like memories and ASICs
> + - Asynchronous, synchronous, and page mode burst NOR flash
> + - NAND flash
> + - Pseudo-SRAM devices
> +
> +properties:
> + compatible:
> + items:
> + - enum:
> + - ti,omap2420-gpmc
> + - ti,omap2430-gpmc
> + - ti,omap3430-gpmc
> + - ti,omap4430-gpmc
> + - ti,am3352-gpmc

How about putting them in alphabetical order?

> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> + description: |
> + Functional clock. Used for bus timing calculations and
> + GPMC configuration.
> +
> + clock-names:
> + items:
> + - const: fck
> +
> + dmas:
> + items:
> + - description: DMA channel for GPMC NAND prefetch
> +
> + dma-names:
> + items:
> + - const: rxtx
> +
> + "#address-cells": true
> +
> + "#size-cells": true
> +
> + gpmc,num-cs:
> + description: maximum number of supported chip-select lines.
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + gpmc,num-waitpins:
> + description: maximum number of supported wait pins.
> + $ref: /schemas/types.yaml#/definitions/uint32
> +
> + ranges:
> + minItems: 1
> + description: |
> + Must be set up to reflect the memory layout with four
> + integer values for each chip-select line in use,
> + <cs-number> 0 <physical address of mapping> <size>
> + items:
> + - description: NAND bank 0
> + - description: NOR/SRAM bank 0
> + - description: NOR/SRAM bank 1
> +
> + '#interrupt-cells':
> + const: 2
> +
> + interrupt-controller:
> + description: |
> + The GPMC driver implements and interrupt controller for
> + the NAND events "fifoevent" and "termcount" plus the
> + rising/falling edges on the GPMC_WAIT pins.
> + The interrupt number mapping is as follows
> + 0 - NAND_fifoevent
> + 1 - NAND_termcount
> + 2 - GPMC_WAIT0 pin edge
> + 3 - GPMC_WAIT1 pin edge, and so on.
> +
> + '#gpio-cells':
> + const: 2
> +
> + gpio-controller:
> + description: |
> + The GPMC driver implements a GPIO controller for the
> + GPMC WAIT pins that can be used as general purpose inputs.
> + 0 maps to GPMC_WAIT0 pin.
> +
> + ti,hwmods:
> + description:
> + Name of the HWMOD associated with GPMC. This is for legacy
> + omap2/3 platforms only.
> + $ref: /schemas/types.yaml#/definitions/string
> + deprecated: true
> +
> + ti,no-idle-on-init:
> + description:
> + Prevent idling the module at init. This is for legacy omap2/3
> + platforms only.
> + type: boolean
> + deprecated: true
> +
> +patternProperties:
> + "@[0-7],[a-f0-9]+$":
> + type: object
> + description: |
> + The child device node represents the device connected to the GPMC
> + bus. The device can be a NAND chip, SRAM device, NOR device
> + or an ASIC.
> +
> + allOf:
> + - $ref: "ti,gpmc-child.yaml"
> +
> + unevaluatedProperties: false
> +
> +required:
> + - compatible
> + - reg
> + - gpmc,num-cs
> + - gpmc,num-waitpins
> + - "#address-cells"
> + - "#size-cells"
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/gpio/gpio.h>
> +
> + gpmc: memory-controller@50000000 {
> + compatible = "ti,am3352-gpmc";
> + reg = <0x50000000 0x2000>;
> + interrupts = <100>;
> + clocks = <&l3s_clkctrl>;
> + clock-names = "fck";
> + dmas = <&edma 52 0>;
> + dma-names = "rxtx";
> + gpmc,num-cs = <8>;
> + gpmc,num-waitpins = <2>;
> + #address-cells = <2>;
> + #size-cells = <1>;
> + ranges = <0 0 0x08000000 0x10000000>; /* CS0 @addr 0x8000000, size 0x10000000 */
> + interrupt-controller;
> + #interrupt-cells = <2>;
> + gpio-controller;
> + #gpio-cells = <2>;
> +
> + nand@0,0 {
> + compatible = "ti,omap2-nand";
> + reg = <0 0 4>;
> + interrupt-parent = <&gpmc>;
> + interrupts = <0 IRQ_TYPE_NONE>, /* fifoevent */
> + <1 IRQ_TYPE_NONE>; /* termcount */

Why these are interrupts of unspecified type (NONE)?

> + ti,nand-xfer-type = "prefetch-dma";
> + ti,nand-ecc-opt = "bch16";
> + ti,elm-id = <&elm>;
> + rb-gpios = <&gpmc 0 GPIO_ACTIVE_HIGH>; /* gpmc_wait0 pin */
> + };
> + };
>

Best regards,
Krzysztof