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     unevaluatedProperties: false
  31
  32     properties:
  33       regulator-name:
  34         const: wled
  35
  36 patternProperties:
  37   "^((ldo|buck)[1-5]|ldolpsr|ldodvref)$":
  38     type: object
  39     description:
  40       Properties for single LDO/BUCK regulator.
  41     $ref: regulator.yaml#
  42
  43     properties:
  44       regulator-name:
  45         pattern: "^((ldo|buck)[1-5]|ldolpsr|ldodvref)$"
  46         description:
  47           should be "ldo1", ..., "ldo5", "buck1", ..., "buck5" and "ldolpsr"
  48           for ldolpsr regulator, "ldodvref" for ldodvref reglator.
  49
  50       rohm,vsel-gpios:
  51         description:
  52           GPIO used to control ldo4 state (when ldo4 is controlled by GPIO).
  53
  54       rohm,dvs-run-voltage:
  55         description:
  56           PMIC "RUN" state voltage in uV when PMIC HW states are used. See
  57           comments below for bucks/LDOs which support this. 0 means
  58           regulator should be disabled at RUN state.
  59         $ref: "/schemas/types.yaml#/definitions/uint32"
  60         minimum: 0
  61         maximum: 3300000
  62
  63       rohm,dvs-snvs-voltage:
  64         description:
  65           Whether to keep regulator enabled at "SNVS" state or not.
  66           0 means regulator should be disabled at SNVS state, non zero voltage
  67           keeps regulator enabled. BD71815 does not change voltage level
  68           when PMIC transitions to SNVS.SNVS voltage depends on the previous
  69           state (from which the PMIC transitioned to SNVS).
  70         $ref: "/schemas/types.yaml#/definitions/uint32"
  71         minimum: 0
  72         maximum: 3300000
  73
  74       rohm,dvs-suspend-voltage:
  75         description:
  76           PMIC "SUSPEND" state voltage in uV when PMIC HW states are used. See
  77           comments below for bucks/LDOs which support this. 0 means
  78           regulator should be disabled at SUSPEND state.
  79         $ref: "/schemas/types.yaml#/definitions/uint32"
  80         minimum: 0
  81         maximum: 3300000
  82
  83       rohm,dvs-lpsr-voltage:
  84         description:
  85           PMIC "LPSR" state voltage in uV when PMIC HW states are used. See
  86           comments below for bucks/LDOs which support this. 0 means
  87           regulator should be disabled at LPSR state.
  88         $ref: "/schemas/types.yaml#/definitions/uint32"
  89         minimum: 0
  90         maximum: 3300000
  91
  92         # Bucks 1 and 2 support giving separate voltages for operational states
  93         # (RUN /CLEAN according to data-sheet) and non operational states
  94         # (LPSR/SUSPEND). The voltage is automatically changed when HW
  95         # state changes. Omitting these properties from bucks 1 and 2 leave
  96         # buck voltages to not be toggled by HW state. Enable status may still
  97         # be toggled by state changes depending on HW default settings.
  98         #
  99         # Bucks 3-5 and ldos 1-5 support setting the RUN state voltage here.
 100         # Given RUN voltage is used at all states if regulator is enabled at
 101         # given state.
 102         # Values given for other states are regarded as enable/disable at
 103         # given state (see below).
 104         #
 105         # All regulators except WLED support specifying enable/disable status
 106         # for each of the HW states (RUN/SNVS/SUSPEND/LPSR). HW defaults can
 107         # be overridden by setting voltage to 0 (regulator disabled at given
 108         # state) or non-zero (regulator enabled at given state). Please note
 109         # that setting non zero voltages for bucks 1/2 will also enable voltage
 110         # changes according to state change.
 111
 112     required:
 113       - regulator-name
 114
 115     unevaluatedProperties: false
 116
 117 additionalProperties: false