Commit 0f3680ed authored by Serge Semin's avatar Serge Semin Committed by Damien Le Moal
Browse files

dt-bindings: ata: ahci-platform: Detach common AHCI bindings 



In order to create a more sophisticated AHCI controller DT bindings let's
divide the already available generic AHCI platform YAML schema into the
platform part and a set of the common AHCI properties. The former part
will be used to evaluate the AHCI DT nodes mainly compatible with the
generic AHCI controller while the later schema will be used for more
thorough AHCI DT nodes description. For instance such YAML schemas design
will be useful for our DW AHCI SATA controller derivative with four clock
sources, two reset lines, one system controller reference and specific
max Rx/Tx DMA xfers size constraints.

Note the phys and target-supply property requirement is preserved in the
generic AHCI platform bindings because some platforms can lack of the
explicitly specified PHYs or target device power regulators.

Also note the SATA/AHCI ports properties have been moved to the
$defs-paragraph of the schemas. It's done in order to create the
extendable properties hierarchy such that particular AHCI-controller
could add vendor-specific port properties.

Signed-off-by: default avatarSerge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Signed-off-by: default avatarDamien Le Moal <damien.lemoal@opensource.wdc.com>
parent 6f997d4b

Documentation/devicetree/bindings/ata/ahci-common.yaml

0 → 100644
+100 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/ata/ahci-common.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Common Properties for Serial ATA AHCI controllers



maintainers:

  - Hans de Goede <hdegoede@redhat.com>

  - Damien Le Moal <damien.lemoal@opensource.wdc.com>



description:

  This document defines device tree properties for a common AHCI SATA

  controller implementation. It's hardware interface is supposed to

  conform to the technical standard defined by Intel (see Serial ATA

  Advanced Host Controller Interface specification for details). The

  document doesn't constitute a DT-node binding by itself but merely

  defines a set of common properties for the AHCI-compatible devices.



select: false



allOf:

  - $ref: sata-common.yaml#



properties:

  reg:

    description:

      Generic AHCI registers space conforming to the Serial ATA AHCI

      specification.



  reg-names:

    description: CSR space IDs



  interrupts:

    description:

      Generic AHCI state change interrupt. Can be implemented either as a

      single line attached to the controller or as a set of the signals

      indicating the particular port events.



  ahci-supply:

    description: Power regulator for AHCI controller



  target-supply:

    description: Power regulator for SATA target device



  phy-supply:

    description: Power regulator for SATA PHY



  phys:

    description: Reference to the SATA PHY node

    maxItems: 1



  phy-names:

    maxItems: 1



  ports-implemented:

    $ref: '/schemas/types.yaml#/definitions/uint32'

    description:

      Mask that indicates which ports the HBA supports. Useful if PI is not

      programmed by the BIOS, which is true for some embedded SoC's.

    maximum: 0x1f



patternProperties:

  "^sata-port@[0-9a-f]+$":

    $ref: '#/$defs/ahci-port'

    description:

      It is optionally possible to describe the ports as sub-nodes so

      to enable each port independently when dealing with multiple PHYs.



required:

  - reg

  - interrupts



additionalProperties: true



$defs:

  ahci-port:

    $ref: /schemas/ata/sata-common.yaml#/$defs/sata-port



    properties:

      reg:

        description: AHCI SATA port identifier

        maxItems: 1



      phys:

        description: Individual AHCI SATA port PHY

        maxItems: 1



      phy-names:

        description: AHCI SATA port PHY ID

        maxItems: 1



      target-supply:

        description: Power regulator for SATA port target device



    required:

      - reg



...

Documentation/devicetree/bindings/ata/ahci-platform.yaml

+9 −63
Original line number Diff line number Diff line
@@ -36,8 +36,7 @@ select: 
    - compatible



allOf:

  - $ref: "sata-common.yaml#"



  - $ref: "ahci-common.yaml#"



properties:

  compatible:
@@ -69,89 +68,36 @@ properties: 
    maxItems: 1



  clocks:

    description:

      Clock IDs array as required by the controller.

    minItems: 1

    maxItems: 3



  clock-names:

    description:

      Names of clocks corresponding to IDs in the clock property.

    minItems: 1

    maxItems: 3



  interrupts:

    maxItems: 1



  ahci-supply:

    description:

      regulator for AHCI controller



  phy-supply:

    description:

      regulator for PHY power



  phys:

    description:

      List of all PHYs on this controller

    maxItems: 1



  phy-names:

    description:

      Name specifier for the PHYs

    maxItems: 1



  ports-implemented:

    $ref: '/schemas/types.yaml#/definitions/uint32'

    description: |

      Mask that indicates which ports that the HBA supports

      are available for software to use. Useful if PORTS_IMPL

      is not programmed by the BIOS, which is true with

      some embedded SoCs.

    maximum: 0x1f



  power-domains:

    maxItems: 1



  resets:

    maxItems: 1



  target-supply:

    description:

      regulator for SATA target power



required:

  - compatible

  - reg

  - interrupts



patternProperties:

  "^sata-port@[0-9a-f]+$":

    type: object

    additionalProperties: false

    description:

      Subnode with configuration of the Ports.



    properties:

      reg:

        maxItems: 1



      phys:

        maxItems: 1

    $ref: /schemas/ata/ahci-common.yaml#/$defs/ahci-port



      phy-names:

        maxItems: 1

    anyOf:

      - required: [ phys ]

      - required: [ target-supply ]



      target-supply:

        description:

          regulator for SATA target power

    unevaluatedProperties: false



required:

  - compatible

  - reg



    anyOf:

      - required: [ phys ]

      - required: [ target-supply ]

  - interrupts



unevaluatedProperties: false

Documentation/devicetree/bindings/ata/sata-common.yaml

+6 −2
Original line number Diff line number Diff line
@@ -35,9 +35,15 @@ properties: 


patternProperties:

  "^sata-port@[0-9a-e]$":

    $ref: '#/$defs/sata-port'

    description: |

      DT nodes for ports connected on the SATA host. The SATA port

      nodes will be named "sata-port".



additionalProperties: true



$defs:

  sata-port:

    type: object



    properties:
@@ -49,6 +55,4 @@ patternProperties: 
          multiplier making it possible to connect up to 15 disks to a single

          SATA port.



additionalProperties: true



...