d6d5b31791
PMIC5 GEN3 ADC has support for clients to read voltage and current on supported channels connected to the PMIC. Clients include reading voltage phone power and on board system thermistors for thermal management. ADCs on certain PMICs have support to read battery current. Change-Id: Ief7cbdf77d227ba2cb4ef7919aa66d9962d98e37 Signed-off-by: Jishnu Prakash <quic_jprakash@quicinc.com> [quic_amelende@quicinc.com: Converted binding change from .txt to .yaml] Signed-off-by: Anjelique Melendez <quic_amelende@quicinc.com>
574 lines
17 KiB
YAML
574 lines
17 KiB
YAML
# SPDX-License-Identifier: GPL-2.0-only
|
|
%YAML 1.2
|
|
---
|
|
$id: http://devicetree.org/schemas/iio/adc/qcom,spmi-vadc.yaml#
|
|
$schema: http://devicetree.org/meta-schemas/core.yaml#
|
|
|
|
title: Qualcomm's SPMI PMIC ADC
|
|
|
|
maintainers:
|
|
- Andy Gross <agross@kernel.org>
|
|
- Bjorn Andersson <bjorn.andersson@linaro.org>
|
|
|
|
description: |
|
|
SPMI PMIC voltage ADC (VADC) provides interface to clients to read
|
|
voltage. The VADC is a 15-bit sigma-delta ADC.
|
|
SPMI PMIC5/PMIC7 voltage ADC (ADC) provides interface to clients to read
|
|
voltage. The VADC is a 16-bit sigma-delta ADC.
|
|
|
|
properties:
|
|
compatible:
|
|
oneOf:
|
|
- items:
|
|
- const: qcom,pms405-adc
|
|
- const: qcom,spmi-adc-rev2
|
|
- enum:
|
|
- qcom,spmi-vadc
|
|
- qcom,spmi-adc5
|
|
- qcom,spmi-adc5-gen3
|
|
- qcom,spmi-adc5-lite
|
|
- qcom,spmi-adc-rev2
|
|
- qcom,spmi-adc7
|
|
- qcom,spmi-adc7-sw-calib
|
|
|
|
reg:
|
|
minItems: 1
|
|
maxItems: 2
|
|
description: |
|
|
- For compatible property "qcom,spmi-vadc", "qcom,spmi-adc5", "qcom,spmi-adc-rev2",
|
|
"qcom,spmi-adc7", "qcom,spmi-adc5-lite", reg is the VADC base address.
|
|
- For compatible property "qcom,spmi-adc7-sw-calib", two registers are required.
|
|
First register is the VADC peripheral base address and the second is the
|
|
ADC common peripheral base addess.
|
|
- For compatible property "qcom,spmi-adc5-gen3", each reg corresponds
|
|
to the SDAM peripheral base address that is being used.
|
|
|
|
qcom,debug-base:
|
|
$ref: /schemas/types.yaml#/definitions/uint32
|
|
description: |
|
|
Debug ADC peripheral base address in the SPMI PMIC register map. Defined for
|
|
compatible "qcom,spmi-adc5-gen3".
|
|
|
|
'#address-cells':
|
|
const: 1
|
|
|
|
'#size-cells':
|
|
const: 0
|
|
|
|
'#io-channel-cells':
|
|
const: 1
|
|
|
|
'#thermal-sensor-cells':
|
|
const: 1
|
|
description: |
|
|
For compatible property "qcom,spmi-adc5-gen3", property is required for ADC_TM device.
|
|
|
|
interrupts:
|
|
minItems: 1
|
|
maxItems: 2
|
|
description: |
|
|
End of conversion interrupt.
|
|
- For compatible property "qcom,spmi-adc5-gen3", interrupts are defined
|
|
for each SDAM being used.
|
|
|
|
interrupt-names:
|
|
minItems: 1
|
|
maxItems: 2
|
|
description: |
|
|
For compatible property "qcom,spmi-adc5-gen3", names should be defined
|
|
as "adc-sdam<N>" where <N> represents the SDAM index.
|
|
|
|
required:
|
|
- compatible
|
|
- reg
|
|
- '#address-cells'
|
|
- '#size-cells'
|
|
- '#io-channel-cells'
|
|
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
type: object
|
|
additionalProperties: false
|
|
description: |
|
|
Represents the external channels which are connected to the ADC.
|
|
- For compatible property "qcom,spmi-vadc" following channels, also known as
|
|
reference point channels, are used for result calibration and their channel
|
|
configuration nodes should be defined:
|
|
VADC_REF_625MV and/or VADC_SPARE1(based on PMIC version) VADC_REF_1250MV,
|
|
VADC_GND_REF and VADC_VDD_VADC.
|
|
- For compatible property "qcom,spmi-adc7-sw-calib" following channels, also known as
|
|
reference point channels, are used for result calibration and their channel
|
|
configuration nodes should be defined:
|
|
ADC7_REF_GND, ADC7_1P25VREF and ADC7_VREF_VADC.
|
|
|
|
properties:
|
|
reg:
|
|
maxItems: 1
|
|
description: |
|
|
ADC channel number.
|
|
See include/dt-bindings/iio/qcom,spmi-vadc.h
|
|
For PMIC7 ADC, the channel numbers are specified separately per PMIC
|
|
in the PMIC-specific files in include/dt-bindings/iio/.
|
|
|
|
label:
|
|
$ref: /schemas/types.yaml#/definitions/string
|
|
description: |
|
|
ADC input of the platform as seen in the schematics.
|
|
For thermistor inputs connected to generic AMUX or GPIO inputs
|
|
these can vary across platform for the same pins. Hence select
|
|
the platform schematics name for this channel.
|
|
|
|
qcom,decimation:
|
|
$ref: /schemas/types.yaml#/definitions/uint32
|
|
description: |
|
|
This parameter is used to decrease ADC sampling rate.
|
|
Quicker measurements can be made by reducing decimation ratio.
|
|
|
|
qcom,pre-scaling:
|
|
description: |
|
|
Used for scaling the channel input signal before the signal is
|
|
fed to VADC. The configuration for this node is to know the
|
|
pre-determined ratio and use it for post scaling. It is a pair of
|
|
integers, denoting the numerator and denominator of the fraction by which
|
|
input signal is multiplied. For example, <1 3> indicates the signal is scaled
|
|
down to 1/3 of its value before ADC measurement.
|
|
If property is not found default value depending on chip will be used.
|
|
$ref: /schemas/types.yaml#/definitions/uint32-array
|
|
oneOf:
|
|
- items:
|
|
- const: 1
|
|
- enum: [ 1, 3, 4, 6, 20, 8, 10, 16 ]
|
|
- items:
|
|
- const: 10
|
|
- const: 81
|
|
- items:
|
|
- enum: [ 32, 14, 28 ]
|
|
- const: 100
|
|
- items:
|
|
- const: 1000
|
|
- enum: [ 305185, 610370 ]
|
|
|
|
qcom,ratiometric:
|
|
description: |
|
|
Channel calibration type.
|
|
- For compatible property "qcom,spmi-vadc", if this property is
|
|
specified VADC will use the VDD reference (1.8V) and GND for
|
|
channel calibration. If property is not found, channel will be
|
|
calibrated with 0.625V and 1.25V reference channels, also
|
|
known as absolute calibration.
|
|
- For all other compatible properties, if this property is specified
|
|
VADC will use the VDD reference (1.875V) and GND for channel calibration.
|
|
If property is not found, channel will be calibrated with 0V and 1.25V
|
|
reference channels, also known as absolute calibration.
|
|
type: boolean
|
|
|
|
qcom,no-cal:
|
|
description: |
|
|
- For compatible property "qcom,spmi-adc7-sw-calib", if this property
|
|
is specified for a channel, VADC will not use any reference channels
|
|
for that channel's calibration. It is needed for the three calibration
|
|
channels alone, mutually exclusive with ratiometric calibration and
|
|
not meant for any other compatible property. If this property is not
|
|
found, then the channel will be calibrated with 0.625V and 1.25V
|
|
reference channels, also known as absolute calibration.
|
|
type: boolean
|
|
|
|
qcom,hw-settle-time:
|
|
$ref: /schemas/types.yaml#/definitions/uint32
|
|
description: |
|
|
Time between AMUX getting configured and the ADC starting
|
|
conversion. The 'hw_settle_time' is an index used from valid values
|
|
and programmed in hardware to achieve the hardware settling delay.
|
|
|
|
qcom,avg-samples:
|
|
$ref: /schemas/types.yaml#/definitions/uint32
|
|
description: |
|
|
Number of samples to be used for measurement.
|
|
Averaging provides the option to obtain a single measurement
|
|
from the ADC that is an average of multiple samples. The value
|
|
selected is 2^(value).
|
|
|
|
qcom,scale-fn-type:
|
|
$ref: /schemas/types.yaml#/definitions/uint32
|
|
description: |
|
|
The index of the VADC scale function used to convert raw ADC code to
|
|
physical scaled units for the channel. Defined for compatibles
|
|
"qcom,spmi-adc5", "qcom,spmi-adc7" and "qcom,spmi-adc5-gen3".
|
|
See include/dt-bindings/iio/qcom,spmi-vadc.h for values.
|
|
|
|
qcom,adc-tm-type:
|
|
$ref: /schemas/types.yaml#/definitions/uint32
|
|
description: |
|
|
Type of ADC_TM usage defined for a given channel. Defined for compatible
|
|
"qcom,spmi-adc5-gen3".
|
|
0 - not used for ADC_TM
|
|
1 - connected to thermistor; supports temperature threshold violation detection
|
|
and temperature reading
|
|
2 - connected to thermistor; supports temperature reading
|
|
3 - not connected to thermistor; supports non-thermal threshold violation detection
|
|
enum: [ 0, 1, 2, 3]
|
|
default: 0
|
|
|
|
qcom,rscale-type:
|
|
$ref: /schemas/types.yaml#/definitions/uint32
|
|
description: |
|
|
Type of reverse scaling function used for the ADC_TM channels. Defined for
|
|
compatible "qcom,spmi-adc5-gen3" and valid only for the case of
|
|
non-thermal ADC_TM client.
|
|
const: 0
|
|
|
|
required:
|
|
- reg
|
|
|
|
allOf:
|
|
- if:
|
|
properties:
|
|
compatible:
|
|
contains:
|
|
const: qcom,spmi-vadc
|
|
|
|
then:
|
|
properties:
|
|
reg:
|
|
maxItems: 1
|
|
interrupts:
|
|
maxItems: 1
|
|
qcom,debug-base: false
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
properties:
|
|
qcom,decimation:
|
|
enum: [ 512, 1024, 2048, 4096 ]
|
|
default: 512
|
|
|
|
qcom,hw-settle-time:
|
|
enum: [ 0, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1, 2,
|
|
4, 6, 8, 10 ]
|
|
default: 0
|
|
|
|
qcom,avg-samples:
|
|
enum: [ 1, 2, 4, 8, 16, 32, 64, 128, 256, 512 ]
|
|
default: 1
|
|
|
|
qcom,no-cal: false
|
|
qcom,adc-tm-type: false
|
|
qcom,rscale-type: false
|
|
|
|
- if:
|
|
properties:
|
|
compatible:
|
|
contains:
|
|
const: qcom,spmi-adc-rev2
|
|
|
|
then:
|
|
properties:
|
|
reg:
|
|
maxItems: 1
|
|
interrupts:
|
|
maxItems: 1
|
|
qcom,debug-base: false
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
properties:
|
|
qcom,decimation:
|
|
enum: [ 256, 512, 1024 ]
|
|
default: 1024
|
|
|
|
qcom,hw-settle-time:
|
|
enum: [ 0, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1, 2,
|
|
4, 6, 8, 10 ]
|
|
default: 0
|
|
|
|
qcom,avg-samples:
|
|
enum: [ 1, 2, 4, 8, 16 ]
|
|
default: 1
|
|
|
|
qcom,no-cal: false
|
|
qcom,adc-tm-type: false
|
|
qcom,rscale-type: false
|
|
|
|
- if:
|
|
properties:
|
|
compatible:
|
|
contains:
|
|
const: qcom,spmi-adc5
|
|
|
|
then:
|
|
properties:
|
|
reg:
|
|
maxItems: 1
|
|
interrupts:
|
|
maxItems: 1
|
|
qcom,debug-base: false
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
properties:
|
|
qcom,decimation:
|
|
enum: [ 250, 420, 840 ]
|
|
default: 840
|
|
|
|
qcom,hw-settle-time:
|
|
enum: [ 15, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1, 2,
|
|
4, 6, 8, 10, 16, 32, 64, 128 ]
|
|
default: 15
|
|
|
|
qcom,avg-samples:
|
|
enum: [ 1, 2, 4, 8, 16 ]
|
|
default: 1
|
|
|
|
qcom,no-cal: false
|
|
qcom,adc-tm-type: false
|
|
qcom,rscale-type: false
|
|
|
|
- if:
|
|
properties:
|
|
compatible:
|
|
contains:
|
|
const: qcom,spmi-adc5-gen3
|
|
|
|
then:
|
|
properties:
|
|
reg:
|
|
minItems: 2
|
|
interrupts:
|
|
minItems: 2
|
|
interrupt-names:
|
|
items:
|
|
- const: adc-sdam0
|
|
- const: adc-sdam1
|
|
required:
|
|
- interrupts
|
|
- interrupt-names
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
properties:
|
|
qcom,decimation:
|
|
enum: [ 85, 340, 1360 ]
|
|
default: 1360
|
|
|
|
qcom,hw-settle-time:
|
|
enum: [ 15, 100, 200, 300, 400, 500, 600, 700, 1000, 2000, 4000,
|
|
8000, 16000, 32000, 64000, 128000 ]
|
|
default: 15
|
|
|
|
qcom,avg-samples:
|
|
enum: [ 1, 2, 4, 8, 16 ]
|
|
default: 1
|
|
|
|
qcom,no-cal: false
|
|
|
|
- if:
|
|
properties:
|
|
compatible:
|
|
contains:
|
|
const: qcom,spmi-adc5-lite
|
|
|
|
then:
|
|
properties:
|
|
reg:
|
|
maxItems: 1
|
|
interrupts:
|
|
maxItems: 1
|
|
qcom,debug-base: false
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
properties:
|
|
qcom,decimation:
|
|
enum: [ 250, 420, 840 ]
|
|
default: 840
|
|
|
|
qcom,hw-settle-time:
|
|
enum: [ 15, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1, 2,
|
|
4, 6, 8, 10]
|
|
default: 15
|
|
|
|
qcom,avg-samples:
|
|
enum: [ 1, 2, 4, 8, 16 ]
|
|
default: 1
|
|
|
|
qcom,no-cal: false
|
|
qcom,adc-tm-type: false
|
|
qcom,rscale-type: false
|
|
|
|
- if:
|
|
properties:
|
|
compatible:
|
|
contains:
|
|
const: qcom,spmi-adc7
|
|
|
|
then:
|
|
properties:
|
|
reg:
|
|
maxItems: 1
|
|
interrupts:
|
|
maxItems: 1
|
|
qcom,debug-base: false
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
properties:
|
|
qcom,decimation:
|
|
enum: [ 85, 340, 1360 ]
|
|
default: 1360
|
|
|
|
qcom,hw-settle-time:
|
|
enum: [ 15, 100, 200, 300, 400, 500, 600, 700, 1000, 2000, 4000,
|
|
8000, 16000, 32000, 64000, 128000 ]
|
|
default: 15
|
|
|
|
qcom,avg-samples:
|
|
enum: [ 1, 2, 4, 8, 16 ]
|
|
default: 1
|
|
|
|
qcom,no-cal: false
|
|
qcom,adc-tm-type: false
|
|
qcom,rscale-type: false
|
|
|
|
- if:
|
|
properties:
|
|
compatible:
|
|
contains:
|
|
const: qcom,spmi-adc7-sw-calib
|
|
|
|
then:
|
|
properties:
|
|
reg:
|
|
minItems: 2
|
|
interrupts:
|
|
maxItems: 1
|
|
qcom,debug-base: false
|
|
patternProperties:
|
|
"^channel@[0-9a-f]+$":
|
|
properties:
|
|
qcom,decimation:
|
|
enum: [ 85, 340, 1360 ]
|
|
default: 1360
|
|
|
|
qcom,hw-settle-time:
|
|
enum: [ 15, 100, 200, 300, 400, 500, 600, 700, 1000, 2000, 4000,
|
|
8000, 16000, 32000, 64000, 128000 ]
|
|
default: 15
|
|
|
|
qcom,avg-samples:
|
|
enum: [ 1, 2, 4, 8, 16 ]
|
|
default: 1
|
|
|
|
qcom,adc-tm-type: false
|
|
qcom,rscale-type: false
|
|
|
|
not:
|
|
required:
|
|
- qcom,no-cal
|
|
- qcom,ratiometric
|
|
|
|
additionalProperties: false
|
|
|
|
examples:
|
|
- |
|
|
spmi {
|
|
#address-cells = <1>;
|
|
#size-cells = <0>;
|
|
/* VADC node */
|
|
pmic_vadc: adc@3100 {
|
|
compatible = "qcom,spmi-vadc";
|
|
reg = <0x3100>;
|
|
interrupts = <0x0 0x31 0x0 0x1>;
|
|
#address-cells = <1>;
|
|
#size-cells = <0>;
|
|
#io-channel-cells = <1>;
|
|
|
|
/* Channel node */
|
|
channel@39 {
|
|
reg = <0x39>;
|
|
qcom,decimation = <512>;
|
|
qcom,ratiometric;
|
|
qcom,hw-settle-time = <200>;
|
|
qcom,avg-samples = <1>;
|
|
qcom,pre-scaling = <1 3>;
|
|
};
|
|
|
|
channel@9 {
|
|
reg = <0x9>;
|
|
};
|
|
|
|
channel@a {
|
|
reg = <0xa>;
|
|
};
|
|
|
|
channel@e {
|
|
reg = <0xe>;
|
|
};
|
|
|
|
channel@f {
|
|
reg = <0xf>;
|
|
};
|
|
};
|
|
};
|
|
|
|
- |
|
|
#include <dt-bindings/iio/qcom,spmi-adc7-pmk8350.h>
|
|
#include <dt-bindings/iio/qcom,spmi-adc7-pm8350.h>
|
|
#include <dt-bindings/interrupt-controller/irq.h>
|
|
|
|
spmi {
|
|
#address-cells = <1>;
|
|
#size-cells = <0>;
|
|
adc@3100 {
|
|
reg = <0x3100>;
|
|
compatible = "qcom,spmi-adc7";
|
|
#address-cells = <1>;
|
|
#size-cells = <0>;
|
|
#io-channel-cells = <1>;
|
|
|
|
/* Other properties are omitted */
|
|
channel@44 {
|
|
reg = <PMK8350_ADC7_AMUX_THM1_100K_PU>;
|
|
qcom,ratiometric;
|
|
qcom,hw-settle-time = <200>;
|
|
label = "xo_therm";
|
|
};
|
|
|
|
channel@47 {
|
|
reg = <PM8350_ADC7_AMUX_THM4_100K_PU(1)>;
|
|
qcom,ratiometric;
|
|
qcom,hw-settle-time = <200>;
|
|
label = "conn_therm";
|
|
};
|
|
};
|
|
};
|
|
|
|
- |
|
|
#include <dt-bindings/iio/qcom,spmi-adc5-gen3-pmk8550.h>
|
|
#include <dt-bindings/interrupt-controller/irq.h>
|
|
|
|
spmi {
|
|
#address-cells = <1>;
|
|
#size-cells = <0>;
|
|
vadc@9000 {
|
|
compatible = "qcom,spmi-adc5-gen3";
|
|
reg = <0x9000>, <0x9100>;
|
|
qcom,debug-base = <0x7600>;
|
|
#address-cells = <1>;
|
|
#size-cells = <0>;
|
|
#io-channel-cells = <1>;
|
|
#thermal-sensor-cells = <1>;
|
|
interrupt-names = "adc-sdam0", "adc-sdam1";
|
|
interrupts = <0x0 0x90 0x1 IRQ_TYPE_EDGE_RISING>,
|
|
<0x0 0x91 0x1 IRQ_TYPE_EDGE_RISING>;
|
|
|
|
channel@0 {
|
|
reg = <PMK8550_ADC5_GEN3_OFFSET_REF>;
|
|
label = "pmk8550_offset_ref";
|
|
qcom,pre-scaling = <1 1>;
|
|
};
|
|
|
|
channel@4 {
|
|
reg = <PMK8550_ADC5_GEN3_AMUX_THM1_XO_THERM_100K_PU>;
|
|
label = "pmk8550_xo_therm";
|
|
qcom,ratiometric;
|
|
qcom,hw-settle-time = <200>;
|
|
qcom,pre-scaling = <1 1>;
|
|
qcom,adc-tm-type = <1>;
|
|
};
|
|
};
|
|
};
|