Documentation/devicetree/bindings/regulator/rohm,bd71815-regulator.yaml

   1 # SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/regulator/rohm,bd71815-regulator.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: ROHM BD71815 Power Management Integrated Circuit regulators
   8
   9 maintainers:
  10   - Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
  11
  12 description: |
  13   This module is part of the ROHM BD718215 MFD device. For more details
  14   see Documentation/devicetree/bindings/mfd/rohm,bd71815-pmic.yaml.
  15
  16   The regulator controller is represented as a sub-node of the PMIC node
  17   on the device tree.
  18
  19   The valid names for BD71815 regulator nodes are
  20   buck1, buck2, buck3, buck4, buck5,
  21   ldo1, ldo2, ldo3, ldo4, ldo5,
  22   ldodvref, ldolpsr, wled
  23
  24 properties:
  25   wled:
  26     type: object
  27     description:
  28       properties for wled regulator
  29     $ref: regulator.yaml#
  30
  31     properties:
  32       regulator-name:
  33         const: wled
  34
  35 patternProperties:
  36   "^((ldo|buck)[1-5]|ldolpsr|ldodvref)$":
  37     type: object
  38     description:
  39       Properties for single LDO/BUCK regulator.
  40     $ref: regulator.yaml#
  41
  42     properties:
  43       regulator-name:
  44         pattern: "^((ldo|buck)[1-5]|ldolpsr|ldodvref)$"
  45         description:
  46           should be "ldo1", ..., "ldo5", "buck1", ..., "buck5" and "ldolpsr"
  47           for ldolpsr regulator, "ldodvref" for ldodvref reglator.
  48
  49       rohm,vsel-gpios:
  50         description:
  51           GPIO used to control ldo4 state (when ldo4 is controlled by GPIO).
  52
  53       rohm,dvs-run-voltage:
  54         description:
  55           PMIC "RUN" state voltage in uV when PMIC HW states are used. See
  56           comments below for bucks/LDOs which support this. 0 means
  57           regulator should be disabled at RUN state.
  58         $ref: "/schemas/types.yaml#/definitions/uint32"
  59         minimum: 0
  60         maximum: 3300000
  61
  62       rohm,dvs-snvs-voltage:
  63         description:
  64           Whether to keep regulator enabled at "SNVS" state or not.
  65           0 means regulator should be disabled at SNVS state, non zero voltage
  66           keeps regulator enabled. BD71815 does not change voltage level
  67           when PMIC transitions to SNVS.SNVS voltage depends on the previous
  68           state (from which the PMIC transitioned to SNVS).
  69         $ref: "/schemas/types.yaml#/definitions/uint32"
  70         minimum: 0
  71         maximum: 3300000
  72
  73       rohm,dvs-suspend-voltage:
  74         description:
  75           PMIC "SUSPEND" state voltage in uV when PMIC HW states are used. See
  76           comments below for bucks/LDOs which support this. 0 means
  77           regulator should be disabled at SUSPEND state.
  78         $ref: "/schemas/types.yaml#/definitions/uint32"
  79         minimum: 0
  80         maximum: 3300000
  81
  82       rohm,dvs-lpsr-voltage:
  83         description:
  84           PMIC "LPSR" state voltage in uV when PMIC HW states are used. See
  85           comments below for bucks/LDOs which support this. 0 means
  86           regulator should be disabled at LPSR state.
  87         $ref: "/schemas/types.yaml#/definitions/uint32"
  88         minimum: 0
  89         maximum: 3300000
  90
  91         # Bucks 1 and 2 support giving separate voltages for operational states
  92         # (RUN /CLEAN according to data-sheet) and non operational states
  93         # (LPSR/SUSPEND). The voltage is automatically changed when HW
  94         # state changes. Omitting these properties from bucks 1 and 2 leave
  95         # buck voltages to not be toggled by HW state. Enable status may still
  96         # be toggled by state changes depending on HW default settings.
  97         #
  98         # Bucks 3-5 and ldos 1-5 support setting the RUN state voltage here.
  99         # Given RUN voltage is used at all states if regulator is enabled at
 100         # given state.
 101         # Values given for other states are regarded as enable/disable at
 102         # given state (see below).
 103         #
 104         # All regulators except WLED support specifying enable/disable status
 105         # for each of the HW states (RUN/SNVS/SUSPEND/LPSR). HW defaults can
 106         # be overridden by setting voltage to 0 (regulator disabled at given
 107         # state) or non-zero (regulator enabled at given state). Please note
 108         # that setting non zero voltages for bucks 1/2 will also enable voltage
 109         # changes according to state change.
 110
 111     required:
 112       - regulator-name
 113
 114     unevaluatedProperties: false
 115
 116 additionalProperties: false