2020-08-24 09:07:58

by Gene Chen

Subject: [PATCH v3 2/2] Documentation: ABI: testing: mt6360: Add ADC sysfs guideline

From: Gene Chen <[email protected]>

Add ABI documentation for mt6360 ADC sysfs interfaces.

Signed-off-by: Gene Chen <[email protected]>
---
Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360 | 83 ++++++++++++++++++++++
1 file changed, 83 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360 b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
new file mode 100644
index 0000000..9dab17e
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
@@ -0,0 +1,83 @@
+What: /sys/bus/iio/devices/iio:deviceX/usbid_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 USBID ADC
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/vbusdiv5_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 VBUS ADC with high accuracy
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/vbusdiv2_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 VBUS ADC with low accuracy
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/vsys_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 VSYS ADC
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/vbat_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 VBAT ADC
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/ibus_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 IBUS ADC
+ Reading returns current in uA
+
+What: /sys/bus/iio/devices/iio:deviceX/ibat_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 IBAT ADC
+ Reading returns current in uA
+
+What: /sys/bus/iio/devices/iio:deviceX/chg_vddp_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 CHG_VDDP ADC
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/temp_jc_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 IC junction temperature
+ Reading returns current temperature in degree
+
+What: /sys/bus/iio/devices/iio:deviceX/vref_ts_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 VREF_TS ADC
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/ts_input
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 TS ADC
+ Reading returns current voltage in uV
+
+What: /sys/bus/iio/devices/iio:deviceX/timestamp
+KernelVersion: 5.8.0
+Contact: [email protected]
+Description:
+ Indicated MT6360 timestamp
+ Reading returns current timestamp in ms
--
2.7.4

2020-08-29 17:16:28

by Jonathan Cameron

Subject: Re: [PATCH v3 2/2] Documentation: ABI: testing: mt6360: Add ADC sysfs guideline

On Mon, 24 Aug 2020 17:06:25 +0800
Gene Chen <[email protected]> wrote:

> From: Gene Chen <[email protected]>
>
> Add ABI documentation for mt6360 ADC sysfs interfaces.

Please check this. The actual filenames don't look correct
to me.

>
> Signed-off-by: Gene Chen <[email protected]>
> ---
> Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360 | 83 ++++++++++++++++++++++
> 1 file changed, 83 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360 b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
> new file mode 100644
> index 0000000..9dab17e
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
> @@ -0,0 +1,83 @@
> +What: /sys/bus/iio/devices/iio:deviceX/usbid_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 USBID ADC
Can we give a bit of text saying what that is?

It's nice if people writing userspace software looking at this don't have
to go find the datasheet just to give a human readable description of the
channel.

> + Reading returns current voltage in uV
drop _current_ as that's a bit confusing :)

Reading returns voltage in uV

> +
> +What: /sys/bus/iio/devices/iio:deviceX/vbusdiv5_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 VBUS ADC with high accuracy
> + Reading returns current voltage in uV

Is this measuring output of a regulator which has taken vbus and divided
it by 5? I'm rather confused.

> +
> +What: /sys/bus/iio/devices/iio:deviceX/vbusdiv2_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 VBUS ADC with low accuracy
> + Reading returns current voltage in uV
> +
> +What: /sys/bus/iio/devices/iio:deviceX/vsys_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 VSYS ADC
> + Reading returns current voltage in uV
> +
> +What: /sys/bus/iio/devices/iio:deviceX/vbat_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 VBAT ADC
> + Reading returns current voltage in uV
> +
> +What: /sys/bus/iio/devices/iio:deviceX/ibus_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 IBUS ADC
> + Reading returns current in uA
> +
> +What: /sys/bus/iio/devices/iio:deviceX/ibat_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 IBAT ADC
> + Reading returns current in uA
> +
> +What: /sys/bus/iio/devices/iio:deviceX/chg_vddp_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 CHG_VDDP ADC
> + Reading returns current voltage in uV
> +
> +What: /sys/bus/iio/devices/iio:deviceX/temp_jc_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 IC junction temperature
> + Reading returns current temperature in degree
> +
> +What: /sys/bus/iio/devices/iio:deviceX/vref_ts_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 VREF_TS ADC
> + Reading returns current voltage in uV
> +
> +What: /sys/bus/iio/devices/iio:deviceX/ts_input
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 TS ADC
> + Reading returns current voltage in uV
> +
> +What: /sys/bus/iio/devices/iio:deviceX/timestamp
> +KernelVersion: 5.8.0
> +Contact: [email protected]
> +Description:
> + Indicated MT6360 timestamp
> + Reading returns current timestamp in ms