Documentation/devicetree/bindings/ufs/ufs-common.yaml

   1 # SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/ufs/ufs-common.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Common properties for Universal Flash Storage (UFS) Host Controllers
   8
   9 maintainers:
  10   - Alim Akhtar <alim.akhtar@samsung.com>
  11   - Avri Altman <avri.altman@wdc.com>
  12
  13 properties:
  14   clocks: true
  15
  16   clock-names: true
  17
  18   freq-table-hz:
  19     items:
  20       items:
  21         - description: Minimum frequency for given clock in Hz
  22         - description: Maximum frequency for given clock in Hz
  23     description: |
  24       Array of <min max> operating frequencies in Hz stored in the same order
  25       as the clocks property. If this property is not defined or a value in the
  26       array is "0" then it is assumed that the frequency is set by the parent
  27       clock or a fixed rate clock source.
  28
  29   interrupts:
  30     maxItems: 1
  31
  32   lanes-per-direction:
  33     $ref: /schemas/types.yaml#/definitions/uint32
  34     enum: [1, 2]
  35     default: 2
  36     description:
  37       Number of lanes available per direction.  Note that it is assume same
  38       number of lanes is used both directions at once.
  39
  40   vdd-hba-supply:
  41     description:
  42       Phandle to UFS host controller supply regulator node.
  43
  44   vcc-supply:
  45     description:
  46       Phandle to VCC supply regulator node.
  47
  48   vccq-supply:
  49     description:
  50       Phandle to VCCQ supply regulator node.
  51
  52   vccq2-supply:
  53     description:
  54       Phandle to VCCQ2 supply regulator node.
  55
  56   vcc-supply-1p8:
  57     type: boolean
  58     description:
  59       For embedded UFS devices, valid VCC range is 1.7-1.95V or 2.7-3.6V. This
  60       boolean property when set, specifies to use low voltage range of
  61       1.7-1.95V. Note for external UFS cards this property is invalid and valid
  62       VCC range is always 2.7-3.6V.
  63
  64   vcc-max-microamp:
  65     description:
  66       Specifies max. load that can be drawn from VCC supply.
  67
  68   vccq-max-microamp:
  69     description:
  70       Specifies max. load that can be drawn from VCCQ supply.
  71
  72   vccq2-max-microamp:
  73     description:
  74       Specifies max. load that can be drawn from VCCQ2 supply.
  75
  76 dependencies:
  77   freq-table-hz: [ 'clocks' ]
  78
  79 required:
  80   - interrupts
  81
  82 additionalProperties: true