xref: /openbmc/linux/Documentation/devicetree/bindings/ufs/ufs-common.yaml (revision c900529f3d9161bfde5cca0754f83b4d3c3e0220)
185440732SKrzysztof Kozlowski# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
285440732SKrzysztof Kozlowski%YAML 1.2
385440732SKrzysztof Kozlowski---
485440732SKrzysztof Kozlowski$id: http://devicetree.org/schemas/ufs/ufs-common.yaml#
585440732SKrzysztof Kozlowski$schema: http://devicetree.org/meta-schemas/core.yaml#
685440732SKrzysztof Kozlowski
785440732SKrzysztof Kozlowskititle: Common properties for Universal Flash Storage (UFS) Host Controllers
885440732SKrzysztof Kozlowski
985440732SKrzysztof Kozlowskimaintainers:
1085440732SKrzysztof Kozlowski  - Alim Akhtar <alim.akhtar@samsung.com>
1185440732SKrzysztof Kozlowski  - Avri Altman <avri.altman@wdc.com>
1285440732SKrzysztof Kozlowski
1385440732SKrzysztof Kozlowskiproperties:
1485440732SKrzysztof Kozlowski  clocks: true
1585440732SKrzysztof Kozlowski
1685440732SKrzysztof Kozlowski  clock-names: true
1785440732SKrzysztof Kozlowski
1885440732SKrzysztof Kozlowski  freq-table-hz:
1985440732SKrzysztof Kozlowski    items:
2085440732SKrzysztof Kozlowski      items:
2185440732SKrzysztof Kozlowski        - description: Minimum frequency for given clock in Hz
2285440732SKrzysztof Kozlowski        - description: Maximum frequency for given clock in Hz
2385440732SKrzysztof Kozlowski    description: |
2485440732SKrzysztof Kozlowski      Array of <min max> operating frequencies in Hz stored in the same order
2585440732SKrzysztof Kozlowski      as the clocks property. If this property is not defined or a value in the
2685440732SKrzysztof Kozlowski      array is "0" then it is assumed that the frequency is set by the parent
2785440732SKrzysztof Kozlowski      clock or a fixed rate clock source.
2885440732SKrzysztof Kozlowski
2985440732SKrzysztof Kozlowski  interrupts:
3085440732SKrzysztof Kozlowski    maxItems: 1
3185440732SKrzysztof Kozlowski
3285440732SKrzysztof Kozlowski  lanes-per-direction:
3385440732SKrzysztof Kozlowski    $ref: /schemas/types.yaml#/definitions/uint32
3485440732SKrzysztof Kozlowski    enum: [1, 2]
3585440732SKrzysztof Kozlowski    default: 2
3685440732SKrzysztof Kozlowski    description:
3785440732SKrzysztof Kozlowski      Number of lanes available per direction.  Note that it is assume same
3885440732SKrzysztof Kozlowski      number of lanes is used both directions at once.
3985440732SKrzysztof Kozlowski
4085440732SKrzysztof Kozlowski  vdd-hba-supply:
4185440732SKrzysztof Kozlowski    description:
4285440732SKrzysztof Kozlowski      Phandle to UFS host controller supply regulator node.
4385440732SKrzysztof Kozlowski
4485440732SKrzysztof Kozlowski  vcc-supply:
4585440732SKrzysztof Kozlowski    description:
4685440732SKrzysztof Kozlowski      Phandle to VCC supply regulator node.
4785440732SKrzysztof Kozlowski
4885440732SKrzysztof Kozlowski  vccq-supply:
4985440732SKrzysztof Kozlowski    description:
5085440732SKrzysztof Kozlowski      Phandle to VCCQ supply regulator node.
5185440732SKrzysztof Kozlowski
5285440732SKrzysztof Kozlowski  vccq2-supply:
5385440732SKrzysztof Kozlowski    description:
5485440732SKrzysztof Kozlowski      Phandle to VCCQ2 supply regulator node.
5585440732SKrzysztof Kozlowski
5685440732SKrzysztof Kozlowski  vcc-supply-1p8:
5785440732SKrzysztof Kozlowski    type: boolean
5885440732SKrzysztof Kozlowski    description:
5985440732SKrzysztof Kozlowski      For embedded UFS devices, valid VCC range is 1.7-1.95V or 2.7-3.6V. This
6085440732SKrzysztof Kozlowski      boolean property when set, specifies to use low voltage range of
6185440732SKrzysztof Kozlowski      1.7-1.95V. Note for external UFS cards this property is invalid and valid
6285440732SKrzysztof Kozlowski      VCC range is always 2.7-3.6V.
6385440732SKrzysztof Kozlowski
6485440732SKrzysztof Kozlowski  vcc-max-microamp:
6585440732SKrzysztof Kozlowski    description:
6685440732SKrzysztof Kozlowski      Specifies max. load that can be drawn from VCC supply.
6785440732SKrzysztof Kozlowski
6885440732SKrzysztof Kozlowski  vccq-max-microamp:
6985440732SKrzysztof Kozlowski    description:
7085440732SKrzysztof Kozlowski      Specifies max. load that can be drawn from VCCQ supply.
7185440732SKrzysztof Kozlowski
7285440732SKrzysztof Kozlowski  vccq2-max-microamp:
7385440732SKrzysztof Kozlowski    description:
7485440732SKrzysztof Kozlowski      Specifies max. load that can be drawn from VCCQ2 supply.
7585440732SKrzysztof Kozlowski
7685440732SKrzysztof Kozlowskidependencies:
77*45698208SRob Herring  freq-table-hz: [ clocks ]
7885440732SKrzysztof Kozlowski
7985440732SKrzysztof Kozlowskirequired:
8085440732SKrzysztof Kozlowski  - interrupts
8185440732SKrzysztof Kozlowski
8285440732SKrzysztof KozlowskiadditionalProperties: true
83