adi,max20362-regulator (on i2c bus)

Description

Analog Devices MAX20362 PMIC

The PMIC has a bidirectional buck-boost converter, a CAP output and an LDO.
Each rail that is used must be defined as a child node, strictly following the
bboost, cap and ldo node names.

Examples

max20362_regulators: max20362@68 {
  compatible = "adi,max20362-regulator";
  reg = <0x68>;
  bat-bbin-vdrop = <0>;
  dvs-src = <0>;
  ldo-src = <1>;

  bboost {
    /* all properties for BBOOST */
  };
  cap {
    /* all properties for CAP */
  };
  ldo {
    /* all properties for LDO */
  };
};

Properties

Top level properties

These property descriptions apply to “adi,max20362-regulator” nodes themselves. This page also describes child node properties in the following sections.

Properties not inherited from the base binding file.

Name	Type	Details
`bat-bbin-vdrop`	`int`	Voltage drop from BAT to BBIN in millivolts. Refer to the macros from <zephyr/dt-bindings/regulator/max20362.h>: - 0: 55 mV (MAX20362_BAT_BBIN_VDROP_55MV) - 1: 100 mV (MAX20362_BAT_BBIN_VDROP_100MV) - 2: 150 mV (MAX20362_BAT_BBIN_VDROP_150MV) - 3: 200 mV (MAX20362_BAT_BBIN_VDROP_200MV) This property is required. Legal values: `0`, `1`, `2`, `3`
`dvs-src`	`int`	Interface for DVS. Refer to the macros from <zephyr/dt-bindings/regulator/max20362.h>: - 0: I2C (MAX20362_DVS_SRC_I2C) - 1: Pseudo-SPI (MAX20362_DVS_SRC_PSEUDO_SPI) - 2: Round-Robin (MAX20362_DVS_SRC_ROUND_ROBIN) This property is required. Legal values: `0`, `1`, `2`
`ldo-src`	`int`	LDO input source. If the source is buck-boost, the LDO control can wait for the buck to be on before turning on the LDO. Refer to the macros from <zephyr/dt-bindings/regulator/max20362.h>: - 0: BBOUT (MAX20362_LDO_SRC_BBOUT) - 1: CAP (MAX20362_LDO_SRC_CAP) - 2: BATT (MAX20362_LDO_SRC_BATT) This property is required. Legal values: `0`, `1`, `2`
`supply-gpios`	`phandle-array`	GPIO specifier that controls power to the device. This property should be provided when the device has a dedicated switch that controls power to the device. The supply state is entirely the responsibility of the device driver. Contrast with vin-supply.
`vin-supply`	`phandle`	Reference to the regulator that controls power to the device. The referenced devicetree node must have a regulator compatible. This property should be provided when device power is supplied by a shared regulator. The supply state is dependent on the request status of all devices fed by the regulator. Contrast with supply-gpios. If both properties are provided then the regulator must be requested before the supply GPIOS is set to an active state, and the supply GPIOS must be set to an inactive state before releasing the regulator.

Properties inherited from the base binding file, which defines common properties that may be set on many nodes. Not all of these may apply to the “adi,max20362-regulator” compatible.

Name	Type	Details
`reg`	`array`	device address on i2c bus This property is required. See Important properties for more information.
`status`	`string`	Indicates the operational status of the hardware or other resource that the node represents. In particular: - "okay" means the resource is operational and, for example, can be used by device drivers - "disabled" means the resource is not operational and the system should treat it as if it is not present For details, see "2.3.4 status" in Devicetree Specification v0.4. Legal values: `okay`, `disabled`, `reserved`, `fail`, `fail-sss` See Important properties for more information.
`compatible`	`string-array`	This property is a list of strings that essentially define what type of hardware or other resource this devicetree node represents. Each device driver checks for specific compatible property values to find the devicetree nodes that represent resources that the driver should manage. The recommended format is "vendor,device", The "vendor" part is an abbreviated name of the vendor. The "device" is usually from the datasheet. The compatible property can have multiple values, ordered from most- to least-specific. Having additional values is useful when the device is a specific instance of a more general family, to allow the system to match the most specific driver available. For details, see "2.3.1 compatible" in Devicetree Specification v0.4. This property is required. See Important properties for more information.
`reg-names`	`string-array`	Optional names given to each register block in the "reg" property. For example: / { soc { #address-cells = <1>; #size-cells = <1>; uart@1000 { reg = <0x1000 0x2000>, <0x3000 0x4000>; reg-names = "foo", "bar"; }; }; }; The uart@1000 node has two register blocks: - one with base address 0x1000, size 0x2000, and name "foo" - another with base address 0x3000, size 0x4000, and name "bar"
`ranges`	`compound`	Information used to define a mapping (or translation) between the address space of a bus (the "child address space") and the address space of the bus node's parent (the "parent address space"). The "ranges" property is typically empty, or a sequence of triplets (child bus address, parent bus address, length). If the "ranges" property is empty, it specifies that the parent and child address spaces are identical and no address translation is required. If the "ranges" property is not present in a bus node, it is assumed that no mapping exists between children of the node and the parent address space. For details, see "2.3.8 ranges" in Devicetree Specification v0.4.
`interrupts`	`array`	Information about interrupts generated by the device, encoded as an array of one or more interrupt specifiers. The format of the data in this property varies by where the device appears in the interrupt tree. Devices with the same "interrupt-parent" will use the same format in their interrupts properties. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4. See Important properties for more information.
`interrupts-extended`	`compound`	Extended interrupt specifier for device, used as an alternative to the "interrupts" property. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4.
`interrupt-names`	`string-array`	Optional names given to each interrupt generated by a device. The interrupts themselves are defined in either "interrupts" or "interrupts-extended" properties. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4.
`interrupt-parent`	`phandle`	If present, this refers to the node which handles interrupts generated by this device. For details, see "2.4 Interrupts and Interrupt Mapping" in Devicetree Specification v0.4.
`label`	`string`	Human readable string describing the device. Use of this property is deprecated except as needed on a case-by-case basis. For details, see "4.1.2 Miscellaneous Properties" in Devicetree Specification v0.4. See Important properties for more information.
`clocks`	`phandle-array`	Information about the device's clock providers. In general, this property should follow conventions established in the dt-schema binding: https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
`clock-names`	`string-array`	Optional names given to each clock provider in the "clocks" property.
`#address-cells`	`int`	This property encodes the number of <u32> cells used by address fields in "reg" properties in this node's children. For details, see "2.3.5 #address-cells and #size-cells" in Devicetree Specification v0.4.
`#size-cells`	`int`	This property encodes the number of <u32> cells used by size fields in "reg" properties in this node's children. For details, see "2.3.5 #address-cells and #size-cells" in Devicetree Specification v0.4.
`dma-coherent`	`boolean`	Indicates that the device is capable of coherent DMA operations. For details, see "2.3.10 dma-coherent" in Devicetree Specification v0.4.
`dmas`	`phandle-array`	DMA channel specifiers relevant to the device.
`dma-names`	`string-array`	Optional names given to the DMA channel specifiers in the "dmas" property.
`dma-ranges`	`compound`	The dma-ranges provides a means of defining a mapping or translation between the physical address space of the bus and the physical address space of the parent of the bus. For details, see "2.3.9 dma-ranges" in Devicetree Specification v0.4.
`io-channels`	`phandle-array`	IO channel specifiers relevant to the device.
`io-channel-names`	`string-array`	Optional names given to the IO channel specifiers in the "io-channels" property.
`mboxes`	`phandle-array`	Mailbox / IPM channel specifiers relevant to the device.
`mbox-names`	`string-array`	Optional names given to the mbox specifiers in the "mboxes" property.
`power-domains`	`phandle-array`	Power domain specifiers relevant to the device.
`power-domain-names`	`string-array`	Optional names given to the power domain specifiers in the "power-domains" property.
`#power-domain-cells`	`int`	Number of cells in power-domains property
`hwlocks`	`phandle-array`	HW spinlock id relevant to the device.
`hwlock-names`	`string-array`	Optional names given to the hwlock specifiers in the "hwlocks" property.
`zephyr,deferred-init`	`boolean`	Do not initialize device automatically on boot. Device should be manually initialized using device_init().
`wakeup-source`	`boolean`	Property to identify that a device can be used as wake up source. When this property is provided a specific flag is set into the device that tells the system that the device is capable of wake up the system. Wake up capable devices are disabled (interruptions will not wake up the system) by default but they can be enabled at runtime if necessary.
`zephyr,pm-device-runtime-auto`	`boolean`	Automatically configure the device for runtime power management after the init function runs.
`zephyr,disabling-power-states`	`phandles`	List of power states that will disable this device power.

Child node properties

Name	Type	Details
`regulator-init-microvolt`	`int`	Voltage set during initialisation
`regulator-min-microvolt`	`int`	smallest voltage consumers may set
`regulator-max-microvolt`	`int`	largest voltage consumers may set
`regulator-init-microamp`	`int`	Current set during initialisation
`regulator-max-microamp`	`int`	largest current consumers may set
`regulator-always-on`	`boolean`	boolean, regulator should never be disabled
`regulator-boot-on`	`boolean`	bootloader/firmware enabled regulator. It's expected that this regulator was left on by the bootloader. If the bootloader didn't leave it on then OS should turn it on at boot but shouldn't prevent it from being turned off later. This property is intended to only be used for regulators where software cannot read the state of the regulator.
`regulator-initial-mode`	`int`	Initial operating mode. The set of possible operating modes depends on the capabilities of every hardware so each device binding documentation explains which values the regulator supports.
`regulator-allowed-modes`	`array`	List of operating modes that software is allowed to configure for the regulator at run-time. Elements may be specified in any order. The set of possible operating modes depends on the capabilities of every hardware so each device binding document explains which values the regulator supports.