Bindings/memory-controllers/arm,pl35x-smc.yaml

   1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/memory-controllers/arm,pl35x-smc.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Arm PL35x Series Static Memory Controller (SMC)
   8
   9 maintainers:
  10   - Miquel Raynal <miquel.raynal@bootlin.com>
  11   - Naga Sureshkumar Relli <naga.sureshkumar.relli@xilinx.com>
  12
  13 description: |
  14   The PL35x Static Memory Controller is a bus where you can connect two kinds
  15   of memory interfaces, which are NAND and memory mapped interfaces (such as
  16   SRAM or NOR) depending on the specific configuration.
  17
  18   The TRM is available here:
  19   https://documentation-service.arm.com/static/5e8e2524fd977155116a58aa
  20
  21 # We need a select here so we don't match all nodes with 'arm,primecell'
  22 select:
  23   properties:
  24     compatible:
  25       contains:
  26         enum:
  27           - arm,pl353-smc-r2p1
  28           - arm,pl354
  29   required:
  30     - compatible
  31
  32 properties:
  33   $nodename:
  34     pattern: "^memory-controller@[0-9a-f]+$"
  35
  36   compatible:
  37     items:
  38       - enum:
  39           - arm,pl353-smc-r2p1
  40           - arm,pl354
  41       - const: arm,primecell
  42
  43   "#address-cells":
  44     const: 2
  45
  46   "#size-cells":
  47     const: 1
  48
  49   reg:
  50     items:
  51       - description:
  52           Configuration registers for the host and sub-controllers.
  53           The three chip select regions are defined in 'ranges'.
  54
  55   clocks:
  56     minItems: 1
  57     maxItems: 2
  58
  59   clock-names:
  60     minItems: 1
  61     maxItems: 2
  62
  63   ranges:
  64     minItems: 1
  65     maxItems: 8
  66
  67   interrupts:
  68     minItems: 1
  69     items:
  70       - description: Combined or Memory interface 0 IRQ
  71       - description: Memory interface 1 IRQ
  72
  73 patternProperties:
  74   "@[0-7],[a-f0-9]+$":
  75     type: object
  76     description: |
  77       The child device node represents the controller connected to the SMC
  78       bus. The controller can be a NAND controller or a pair of any memory
  79       mapped controllers such as NOR and SRAM controllers.
  80
  81     properties:
  82       compatible:
  83         description:
  84           Compatible of memory controller.
  85
  86       reg:
  87         items:
  88           - items:
  89               - description: |
  90                   Chip-select ID, as in the parent range property.
  91                 minimum: 0
  92                 maximum: 7
  93               - description: |
  94                   Offset of the memory region requested by the device.
  95               - description: |
  96                   Length of the memory region requested by the device.
  97
  98     required:
  99       - compatible
 100       - reg
 101
 102 required:
 103   - compatible
 104   - reg
 105   - clock-names
 106   - clocks
 107
 108 additionalProperties: false
 109
 110 allOf:
 111   - if:
 112       properties:
 113         compatible:
 114           contains:
 115             const: arm,pl354
 116     then:
 117       properties:
 118         clocks:
 119           # According to TRM, really should be 3 clocks
 120           maxItems: 1
 121
 122         clock-names:
 123           const: apb_pclk
 124
 125     else:
 126       properties:
 127         clocks:
 128           items:
 129             - description: clock for the memory device bus
 130             - description: main clock of the SMC
 131
 132         clock-names:
 133           items:
 134             - const: memclk
 135             - const: apb_pclk
 136
 137 examples:
 138   - |
 139     smcc: memory-controller@e000e000 {
 140       compatible = "arm,pl353-smc-r2p1", "arm,primecell";
 141       reg = <0xe000e000 0x0001000>;
 142       clock-names = "memclk", "apb_pclk";
 143       clocks = <&clkc 11>, <&clkc 44>;
 144       ranges = <0x0 0x0 0xe1000000 0x1000000 /* Nand CS region */
 145                 0x1 0x0 0xe2000000 0x2000000 /* SRAM/NOR CS0 region */
 146                 0x2 0x0 0xe4000000 0x2000000>; /* SRAM/NOR CS1 region */
 147       #address-cells = <2>;
 148       #size-cells = <1>;
 149
 150       nfc0: nand-controller@0,0 {
 151         compatible = "arm,pl353-nand-r2p1";
 152         reg = <0 0 0x1000000>;
 153         #address-cells = <1>;
 154         #size-cells = <0>;
 155       };
 156     };