:orphan:
.. raw:: html
.. dtcompatible:: adi,ltc4286
.. _dtbinding_adi_ltc4286:
adi,ltc4286 (on i2c bus)
########################
.. sidebar:: Overview
:Name: ``adi,ltc4286``
:Vendor: :ref:`Analog Devices, Inc. `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=adi,ltc4286>` using
this compatible
:Driver: :zephyr_file:`drivers/sensor/adi/ltc4286/ltc4286.c`
Description
***********
.. code-block:: none
LTC4286 High Power Positive Hot-Swap Controller with Power Monitoring Telemetry
Properties
**********
.. tabs::
.. group-tab:: Node specific properties
Properties not inherited from the base binding file.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``rsense-uohms``
- ``int``
- .. code-block:: none
Resistor sense value in micro-ohms.
The device default for this setting is 500 uOhms from the typical application,
but will depend on the attached resistor value across the SENSE+ and SENSE- pins.
Default value: ``500``
* - ``write-protect-enable``
- ``boolean``
- .. code-block:: none
Sets whether the device can be written to during use.
* - ``vds-enable``
- ``boolean``
- .. code-block:: none
Sets the device to use V_DS for auxiliary input measurement.
* - ``vin-vout-enable``
- ``boolean``
- .. code-block:: none
Enables V_IN or V_OUT as an auxiliary input for ADC Measurement.
The choice between the two depends on VPWR_SELECT in MFR_CONFIG1.
vpower-select determines the source selected;
V_IN if vpower-select is set, V_OUT if vpower-select is unset.
* - ``display-averaged-read``
- ``boolean``
- .. code-block:: none
selects averaged values for reading telemetry data
(V_IN, V_OUT, I_OUT, P_IN). If unset, averaged values will be selected.
* - ``average-samples-set``
- ``int``
- .. code-block:: none
sets the number of samples used for averaging the ADC values.
Min value - 2 samples
Max value - 65536 samples
The device default value is 64 samples.
Default value: ``64``
Legal values: ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, ``256``, ``512``, ``1024``, ``2048``, ``4096``, ``8192``, ``16384``, ``32768``, ``65536``
* - ``vrange-select``
- ``boolean``
- .. code-block:: none
sets the voltage range used for V_IN and V_OUT measurements.
If set, uses 102.4V. If unset, uses 25.6V.
* - ``vpower-select``
- ``boolean``
- .. code-block:: none
sets V_OUT as voltage used for power multiplication if set.
sets V_IN as voltage if unset. Also affects vin-vout-select.
* - ``pmbus-1mbit-enable``
- ``boolean``
- .. code-block:: none
set to enable 1Mbit-compatible PMBus timing.
* - ``reset-fault-enable``
- ``boolean``
- .. code-block:: none
sets a fault reset on an edge of the EN pin. set to disable the
EN pin from triggering a reset fault.
* - ``power-grid-reset-control-set``
- ``boolean``
- .. code-block:: none
configures PG_LATCH reset condition in MFR_PADS_LIVE_STATUS.
If set, FB Low resets PG_LATCH. If unset, FET off resets PG_LATCH.
* - ``mass-write-enable``
- ``boolean``
- .. code-block:: none
set to disable mass write (or global address) when using
multiple instances of this device on the same bus line.
* - ``external-temp-sensor-enable``
- ``boolean``
- .. code-block:: none
set to disable the use of external temperature sensor on GPIO3.
If set, an on-chip temperature sensor will be used.
* - ``debounce-timer-enable``
- ``boolean``
- .. code-block:: none
set to disable a debounce timer for EN pin transitions.
* - ``dev-gpio-reboot-enable``
- ``boolean``
- .. code-block:: none
set to enable a GPIO pin to generate a reboot.
* - ``dev-gpio-reboot-inv``
- ``boolean``
- .. code-block:: none
invert the polarity of the GPIO reboot pin, to activate on falling edge.
* - ``dev-gpio-cmp-input-pin``
- ``int``
- .. code-block:: none
GPIO pin ID to select as CMP input.
The device default for this function is on pin 5.
Default value: ``5``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``current-limit-set``
- ``int``
- .. code-block:: none
Set the reference voltage for current limit ILIM of device, from
6mV to 20mV in 2mV increments.
The device default is 10mV.
Default value: ``10``
Legal values: ``6``, ``8``, ``10``, ``12``, ``14``, ``16``, ``18``, ``20``
* - ``reboot-init-fet-only``
- ``boolean``
- .. code-block:: none
selects the chip initialization options following a reboot signal.
If set, no device reset occurs, and only the FET is turned off then on by
the turn-on delay selected in reboot-delay-config. if unset, chip reset.
* - ``dev-gpio-reboot-pin``
- ``int``
- .. code-block:: none
GPIO pin ID to use for reboot signal input.
Should overlap with dev-gpio-alert-pin
The device default for this function is on pin 6.
Default value: ``6``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``dev-gpio-alert-pin``
- ``int``
- .. code-block:: none
GPIO pin ID to use for alert signal output.
Ensure that the pin selected (0-7) does not overlap with other pins
* - ``reboot-delay-config``
- ``int``
- .. code-block:: none
selects the auto-reboot turn-on delay following a reboot signal.
0 - 0.580s
1 - 1.16s
2 - 2.32s
3 - 4.64s
4 - 9.28s
5 - 18.6s
6 - 37.1s
7 - 74.2s
The device default is 0.580s.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``overcurrent-fault-retries``
- ``int``
- .. code-block:: none
Configures the number of auto-retries the device attempts when an OC fault
occurs. If set to 7, the device will ignore the retry counter.
The device default is 0 retries.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``overcurrent-fault-response-shutdown``
- ``boolean``
- .. code-block:: none
Configures if the device performs a shutdown sequence if an OC fault occurs.
* - ``overvolt-fault-retries``
- ``int``
- .. code-block:: none
Configures the number of auto-retries the device attempts when an OV fault
occurs. If set to 7, the device will ignore the retry counter.
The device default is to ignore the counter.
Default value: ``7``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``overvolt-fault-response-shutdown``
- ``boolean``
- .. code-block:: none
Configures if the device performs a shutdown sequence if an OV fault occurs.
* - ``undervolt-fault-retries``
- ``int``
- .. code-block:: none
Configures the number of auto-retries the device attempts when an UV fault
occurs. If set to 7, the device will ignore the retry counter.
The device default is to ignore the counter.
Default value: ``7``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``undervolt-fault-response-shutdown``
- ``boolean``
- .. code-block:: none
Configures if the device performs a shutdown sequence if an UV fault occurs.
* - ``overtemp-fault-retries``
- ``int``
- .. code-block:: none
Configures the number of auto-retries the device attempts when an OT fault
occurs. If set to 7, the device will ignore the retry counter.
The device default is 0 retries.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``overtemp-fault-response-shutdown``
- ``boolean``
- .. code-block:: none
Configures if the device performs a shutdown sequence if an OT fault occurs.
* - ``overpower-fault-timer``
- ``int``
- .. code-block:: none
Determines the time spent for an overpower event before causing a fault.
Default value: ``1023``
* - ``overpower-fault-retries``
- ``int``
- .. code-block:: none
Configures the number of auto-retries the device attempts when an OP fault
occurs. If set to 7, the device will ignore the retry counter.
The device default is 0 retries.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``overpower-fault-response-shutdown``
- ``boolean``
- .. code-block:: none
Configures if the device performs a shutdown sequence if an OP fault occurs.
* - ``fet-fault-retries``
- ``int``
- .. code-block:: none
Configures the number of auto-retries the device attempts when a FET fault
occurs. If set to 7, the device will ignore the retry counter.
The device default is 0 retries.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``fet-fault-response-bad``
- ``boolean``
- .. code-block:: none
Configures if the device performs a shutdown sequence if a FET fault occurs.
* - ``gpo1-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO1 pin.
Options:
0 - Three-state
1 - MFR_GPO_DATA[GPIO#-1]
2 - Comparator Output
3 - Power good
4 - Fault
5 - IOUT_OC_STATUS
8 - OP1_STATUS
9 - Alert
10 - Latched Alert
15 - Temperature Sensor (Reserved for GPIO3 only)
The device default is as a Power Good status output pin.
Default value: ``3``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``8``, ``9``, ``10``
* - ``gpo2-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO2 pin. See gpo1-output-select for options.
The device default is as a FAULT status output pin.
Default value: ``4``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``8``, ``9``, ``10``
* - ``gpo3-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO3 pin. See gpo1-output-select for options.
15 - Temperature Sensor is exclusive to GPIO3 pin.
The device default is as a Temperature sensor output pin.
Default value: ``15``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``8``, ``9``, ``10``, ``15``
* - ``gpo4-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO4 pin. See gpo1-output-select for options.
The device default is as a IOUT_OC status output pin.
Default value: ``5``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``8``, ``9``, ``10``
* - ``gpo5-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO5 pin. See gpo1-output-select for options.
Disabled by default.
The device default is as a reserved pin.
Default value: ``7``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``7``, ``8``, ``9``, ``10``
* - ``gpo6-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO6 pin. See gpo1-output-select for options.
The device default is as a Three-state output pin.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``8``, ``9``, ``10``
* - ``gpo7-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO7 pin. See gpo1-output-select for options.
The device default is as a Comparator Output pin.
Default value: ``2``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``8``, ``9``, ``10``
* - ``gpo8-output-select``
- ``int``
- .. code-block:: none
Sets the output of the GPIO8 pin. See gpo1-output-select for options.
The device default is as a OP1 status output pin.
Default value: ``8``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``8``, ``9``, ``10``
* - ``reboot-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO pin used to signal a reboot to the device.
* - ``op-status-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO pin used to signal an overpower fault of the device.
* - ``oc-status-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO pin used to signal an overcurrent fault of the device.
* - ``comp-out-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO pin used as input for comparator output signal.
* - ``fault-out-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO pin used to signal if any fault occurs on the device.
* - ``power-good-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO pin used to signal the power status on the device.
* - ``alert-gpios``
- ``phandle-array``
- .. code-block:: none
GPIO pin used to signal an ALERT# from the device.
* - ``friendly-name``
- ``string``
- .. code-block:: none
Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.
This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).
* - ``supply-gpios``
- ``phandle-array``
- .. code-block:: none
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``
- .. code-block:: none
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.
.. group-tab:: Deprecated node specific properties
Deprecated properties not inherited from the base binding file.
(None)
.. group-tab:: Base properties
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,ltc4286" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``status``
- ``string``
- .. code-block:: none
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 :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
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 :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
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 :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
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 :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
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``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of 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``
- .. code-block:: none
This property encodes the number of 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``
- .. code-block:: none
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``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``dma-ranges``
- ``compound``
- .. code-block:: none
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``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" property.
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``wakeup-source``
- ``boolean``
- .. code-block:: none
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``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.