# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/scsi/hisilicon,hip05-sas-v1.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: HiSilicon SAS controller

maintainers:
  - Xingui Yang <yangxingui@huawei.com>

properties:
  compatible:
    items:
      - enum:
          - hisilicon,hip05-sas-v1
          - hisilicon,hip06-sas-v2
          - hisilicon,hip07-sas-v2

  reg:
    minItems: 1
    items:
      - description: SAS registers
      - description: CPLD SGPIO control registers

  clocks:
    minItems: 1
    maxItems: 2

  dma-coherent: true

  interrupts:
    description: >
      Interrupt specifiers for PHY, SATA, and completion queues; ordering and
      number depend on controller version.

      For v1 hw: Interrupts for phys, completion queues, and fatal
      sources; the interrupts are ordered in 3 groups, as follows:

        - Phy interrupts - Each phy has 3 interrupt sources:
            - broadcast
            - phyup
            - abnormal
          The phy interrupts are ordered into groups of 3 per phy
          (broadcast, phyup, and abnormal) in increasing order.
        - Completion queue interrupts - each completion queue has 1 interrupt
          source.
        - Fatal interrupts - the fatal interrupts are ordered as follows:
            - ECC
            - AXI bus

      For v2 hw: Interrupts for phys, Sata, and completion queues;
      the interrupts are ordered in 3 groups, as follows:

        - Phy interrupts - Each controller has 2 phy interrupts:
            - phy up/down
            - channel interrupt
        - Sata interrupts - Each phy on the controller has 1 Sata interrupt.
        - Completion queue interrupts - each completion queue has 1 interrupt
          source
    minItems: 58
    maxItems: 128

  ctrl-reset-reg:
    description: Offset to controller reset register in SAS syscon region.
    $ref: /schemas/types.yaml#/definitions/uint32

  ctrl-reset-sts-reg:
    description: Offset to controller reset status register in SAS syscon region.
    $ref: /schemas/types.yaml#/definitions/uint32

  ctrl-clock-ena-reg:
    description: Offset to controller clock enable register in SAS syscon region.
    $ref: /schemas/types.yaml#/definitions/uint32

  hip06-sas-v2-quirk-amt:
    description:
      Indicates that the v2 controller has the "am-max-transmissions" limitation.
    type: boolean

  hisilicon,sas-syscon:
    description: Phandle of syscon used for SAS control.
    $ref: /schemas/types.yaml#/definitions/phandle

  hisilicon,signal-attenuation:
    description:
      De-emphasis, preshoot, and boost attenuation readings for the board,
      used to calculate signal attenuation (y = (x-10000)/10000).
    $ref: /schemas/types.yaml#/definitions/uint32-array
    minItems: 3
    maxItems: 3
    items:
      minimum: 7600
      maximum: 12400

  phy-count:
    description: Number of PHYs accessible by the controller.
    $ref: /schemas/types.yaml#/definitions/uint32

  queue-count:
    description: Number of delivery and completion queues in the controller.
    $ref: /schemas/types.yaml#/definitions/uint32

  sas-addr:
    description: SAS address, array of 8 bytes representing host SAS address.
    $ref: /schemas/types.yaml#/definitions/uint8-array
    minItems: 8
    maxItems: 8

required:
  - compatible
  - reg
  - interrupts
  - ctrl-reset-reg
  - ctrl-reset-sts-reg
  - ctrl-clock-ena-reg
  - hisilicon,sas-syscon
  - phy-count
  - queue-count
  - sas-addr

additionalProperties: false

examples:
  - |
    sas@c1000000 {
        compatible = "hisilicon,hip05-sas-v1";
        reg = <0xc1000000 0x10000>;
        dma-coherent;
        interrupts = <259 4>, <263 4>, <264 4>, /* phy0 */
                     <269 4>, <273 4>, <274 4>, /* phy1 */
                     <279 4>, <283 4>, <284 4>, /* phy2 */
                     <289 4>, <293 4>, <294 4>, /* phy3 */
                     <299 4>, <303 4>, <304 4>, /* phy4 */
                     <309 4>, <313 4>, <314 4>, /* phy5 */
                     <319 4>, <323 4>, <324 4>, /* phy6 */
                     <329 4>, <333 4>, <334 4>, /* phy7 */
                     <336 1>, <337 1>, <338 1>, /* cq0-2 */
                     <339 1>, <340 1>, <341 1>, /* cq3-5 */
                     <342 1>, <343 1>, <344 1>, /* cq6-8 */
                     <345 1>, <346 1>, <347 1>, /* cq9-11 */
                     <348 1>, <349 1>, <350 1>, /* cq12-14 */
                     <351 1>, <352 1>, <353 1>, /* cq15-17 */
                     <354 1>, <355 1>, <356 1>, /* cq18-20 */
                     <357 1>, <358 1>, <359 1>, /* cq21-23 */
                     <360 1>, <361 1>, <362 1>, /* cq24-26 */
                     <363 1>, <364 1>, <365 1>, /* cq27-29 */
                     <366 1>, <367 1>,          /* cq30-31 */
                     <376 4>,                   /* fatal ecc */
                     <381 4>;                   /* fatal axi */
        ctrl-reset-reg = <0xa60>;
        ctrl-reset-sts-reg = <0x5a30>;
        ctrl-clock-ena-reg = <0x338>;
        hisilicon,sas-syscon = <&pcie_sas>;
        queue-count = <32>;
        phy-count = <8>;
        sas-addr = [50 01 88 20 16 00 00 0a];
    };