diff mbox series

[v4,2/3] Documentation: ABI: testing: mt6360: Add ADC sysfs guideline

Message ID 1600191369-28040-3-git-send-email-gene.chen.richtek@gmail.com
State New
Headers show
Series iio: adc: mt6360: Add ADC driver for MT6360 | expand

Commit Message

Gene Chen Sept. 15, 2020, 5:36 p.m. UTC
From: Gene Chen <gene_chen@richtek.com>

Add ABI documentation for mt6360 ADC sysfs interfaces.

Signed-off-by: Gene Chen <gene_chen@richtek.com>
---
 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

Comments

Jonathan Cameron Sept. 17, 2020, 5:42 p.m. UTC | #1
On Wed, 16 Sep 2020 01:36:08 +0800
Gene Chen <gene.chen.richtek@gmail.com> wrote:

> From: Gene Chen <gene_chen@richtek.com>
> 
> Add ABI documentation for mt6360 ADC sysfs interfaces.
> 
> Signed-off-by: Gene Chen <gene_chen@richtek.com>
Would you consider using the proposed label attribute for channels?

https://lore.kernel.org/linux-iio/20200916132115.81795-1-cristian.pop@analog.com/T/#u

I'm hoping that will remove the need to have ext name used in the majority of
cases and would like to know if it would work for you?
It may not work for this particular case of course.

Other comments inline.

> ---
>  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..4b1c270
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
> @@ -0,0 +1,83 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_USBID_input


The mixture of case is a bit ugly.  Could we do 
in_voltage_usbin_input?

> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 USBID ADC which connected to connector ID pin.
> +		Reading returns voltage in uV
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV5_input

> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 VBUS ADC with high accuracy
> +		Reading returns voltage in uV

Why would we ever read the low accuracy version?  

> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV2_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 VBUS ADC with low accuracy
> +		Reading returns voltage in uV
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VSYS_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 VSYS ADC
> +		Reading returns voltage in uV
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VBAT_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 VBAT ADC
> +		Reading returns voltage in uV
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_current_IBUS_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 IBUS ADC
> +		Reading returns current in uA
Given voltage and current are already clear from the channel type,
could we avoid the repetition?

in_current_bus_input perhaps?

> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_current_IBAT_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 IBAT ADC
> +		Reading returns current in uA
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_CHG_VDDP_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 CHG_VDDP ADC
> +		Reading returns voltage in uV
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_temp_TEMP_JC_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 IC junction temperature
> +		Reading returns temperature in degree
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VREF_TS_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 VREF_TS ADC
> +		Reading returns voltage in uV
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_TS_input
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 TS ADC
> +		Reading returns voltage in uV
> +
> +What:		/sys/bus/iio/devices/iio:deviceX/timestamp
> +KernelVersion:	5.8.0
> +Contact:	gene_chen@richtek.com
> +Description:
> +		Indicated MT6360 timestamp
> +		Reading returns current timestamp in ms

That's an odd bit of ABI.  Why would we want to read the current timestamp from
sysfs?  Timestamps in IIO also tend to be in nano seconds.
Gene Chen Sept. 18, 2020, 7:21 a.m. UTC | #2
Jonathan Cameron <jic23@kernel.org> 於 2020年9月18日 週五 上午1:43寫道:
>
> On Wed, 16 Sep 2020 01:36:08 +0800
> Gene Chen <gene.chen.richtek@gmail.com> wrote:
>
> > From: Gene Chen <gene_chen@richtek.com>
> >
> > Add ABI documentation for mt6360 ADC sysfs interfaces.
> >
> > Signed-off-by: Gene Chen <gene_chen@richtek.com>
> Would you consider using the proposed label attribute for channels?
>
> https://lore.kernel.org/linux-iio/20200916132115.81795-1-cristian.pop@analog.com/T/#u
>
> I'm hoping that will remove the need to have ext name used in the majority of
> cases and would like to know if it would work for you?
> It may not work for this particular case of course.
>
> Other comments inline.
>

because of ADC layout is fixed, I can't switch channel to specific
purpose for userspace.

> > ---
> >  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..4b1c270
> > --- /dev/null
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
> > @@ -0,0 +1,83 @@
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_USBID_input
>
>
> The mixture of case is a bit ugly.  Could we do
> in_voltage_usbin_input?
>

ACK

> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 USBID ADC which connected to connector ID pin.
> > +             Reading returns voltage in uV
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV5_input
>
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 VBUS ADC with high accuracy
> > +             Reading returns voltage in uV
>
> Why would we ever read the low accuracy version?
>
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV2_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 VBUS ADC with low accuracy
> > +             Reading returns voltage in uV
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VSYS_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 VSYS ADC
> > +             Reading returns voltage in uV
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBAT_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 VBAT ADC
> > +             Reading returns voltage in uV
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBUS_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 IBUS ADC
> > +             Reading returns current in uA
> Given voltage and current are already clear from the channel type,
> could we avoid the repetition?
>
> in_current_bus_input perhaps?
>

ACK

> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBAT_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 IBAT ADC
> > +             Reading returns current in uA
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_CHG_VDDP_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 CHG_VDDP ADC
> > +             Reading returns voltage in uV
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_temp_TEMP_JC_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 IC junction temperature
> > +             Reading returns temperature in degree
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VREF_TS_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 VREF_TS ADC
> > +             Reading returns voltage in uV
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_TS_input
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 TS ADC
> > +             Reading returns voltage in uV
> > +
> > +What:                /sys/bus/iio/devices/iio:deviceX/timestamp
> > +KernelVersion:       5.8.0
> > +Contact:     gene_chen@richtek.com
> > +Description:
> > +             Indicated MT6360 timestamp
> > +             Reading returns current timestamp in ms
>
> That's an odd bit of ABI.  Why would we want to read the current timestamp from
> sysfs?  Timestamps in IIO also tend to be in nano seconds.
>
>
>
>

ACK, I will remove this.
Jonathan Cameron Sept. 18, 2020, 8:03 a.m. UTC | #3
On Fri, 18 Sep 2020 15:21:44 +0800
Gene Chen <gene.chen.richtek@gmail.com> wrote:

> Jonathan Cameron <jic23@kernel.org> 於 2020年9月18日 週五 上午1:43寫道:
> >
> > On Wed, 16 Sep 2020 01:36:08 +0800
> > Gene Chen <gene.chen.richtek@gmail.com> wrote:
> >  
> > > From: Gene Chen <gene_chen@richtek.com>
> > >
> > > Add ABI documentation for mt6360 ADC sysfs interfaces.
> > >
> > > Signed-off-by: Gene Chen <gene_chen@richtek.com>  
> > Would you consider using the proposed label attribute for channels?
> >
> > https://lore.kernel.org/linux-iio/20200916132115.81795-1-cristian.pop@analog.com/T/#u
> >
> > I'm hoping that will remove the need to have ext name used in the majority of
> > cases and would like to know if it would work for you?
> > It may not work for this particular case of course.
> >
> > Other comments inline.
> >  
> 
> because of ADC layout is fixed, I can't switch channel to specific
> purpose for userspace.

That patch set doesn't allow userspace to change the purpose. It provides
a *_label attribute for each channel to allow for identification of the channel.
That can be provided by ACPI / DT or can be provided by the driver itself.
The advantage is that it removes the nasty freeform parsing that is needed
to work out the filenames.

> 
> > > ---
> > >  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..4b1c270
> > > --- /dev/null
> > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
> > > @@ -0,0 +1,83 @@
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_USBID_input  
> >
> >
> > The mixture of case is a bit ugly.  Could we do
> > in_voltage_usbin_input?
> >  
> 
> ACK
> 
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 USBID ADC which connected to connector ID pin.
> > > +             Reading returns voltage in uV
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV5_input  
> >  
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 VBUS ADC with high accuracy
> > > +             Reading returns voltage in uV  
> >
> > Why would we ever read the low accuracy version?
> >  
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV2_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 VBUS ADC with low accuracy
> > > +             Reading returns voltage in uV
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VSYS_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 VSYS ADC
> > > +             Reading returns voltage in uV
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBAT_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 VBAT ADC
> > > +             Reading returns voltage in uV
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBUS_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 IBUS ADC
> > > +             Reading returns current in uA  
> > Given voltage and current are already clear from the channel type,
> > could we avoid the repetition?
> >
> > in_current_bus_input perhaps?
> >  
> 
> ACK
> 
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBAT_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 IBAT ADC
> > > +             Reading returns current in uA
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_CHG_VDDP_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 CHG_VDDP ADC
> > > +             Reading returns voltage in uV
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_temp_TEMP_JC_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 IC junction temperature
> > > +             Reading returns temperature in degree
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VREF_TS_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 VREF_TS ADC
> > > +             Reading returns voltage in uV
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_TS_input
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 TS ADC
> > > +             Reading returns voltage in uV
> > > +
> > > +What:                /sys/bus/iio/devices/iio:deviceX/timestamp
> > > +KernelVersion:       5.8.0
> > > +Contact:     gene_chen@richtek.com
> > > +Description:
> > > +             Indicated MT6360 timestamp
> > > +             Reading returns current timestamp in ms  
> >
> > That's an odd bit of ABI.  Why would we want to read the current timestamp from
> > sysfs?  Timestamps in IIO also tend to be in nano seconds.
> >
> >
> >
> >  
> 
> ACK, I will remove this.
Gene Chen Sept. 18, 2020, 10:33 a.m. UTC | #4
Jonathan Cameron <Jonathan.Cameron@huawei.com> 於 2020年9月18日 週五 下午4:05寫道:
>
> On Fri, 18 Sep 2020 15:21:44 +0800
> Gene Chen <gene.chen.richtek@gmail.com> wrote:
>
> > Jonathan Cameron <jic23@kernel.org> 於 2020年9月18日 週五 上午1:43寫道:
> > >
> > > On Wed, 16 Sep 2020 01:36:08 +0800
> > > Gene Chen <gene.chen.richtek@gmail.com> wrote:
> > >
> > > > From: Gene Chen <gene_chen@richtek.com>
> > > >
> > > > Add ABI documentation for mt6360 ADC sysfs interfaces.
> > > >
> > > > Signed-off-by: Gene Chen <gene_chen@richtek.com>
> > > Would you consider using the proposed label attribute for channels?
> > >
> > > https://lore.kernel.org/linux-iio/20200916132115.81795-1-cristian.pop@analog.com/T/#u
> > >
> > > I'm hoping that will remove the need to have ext name used in the majority of
> > > cases and would like to know if it would work for you?
> > > It may not work for this particular case of course.
> > >
> > > Other comments inline.
> > >
> >
> > because of ADC layout is fixed, I can't switch channel to specific
> > purpose for userspace.
>
> That patch set doesn't allow userspace to change the purpose. It provides
> a *_label attribute for each channel to allow for identification of the channel.
> That can be provided by ACPI / DT or can be provided by the driver itself.
> The advantage is that it removes the nasty freeform parsing that is needed
> to work out the filenames.
>

May I ask how to get this patch for test the labels?
I supposed userspace catch meanings by iio device sysfs node name.
The label defined in DT means it can be modified. But actually shouldn't.

> >
> > > > ---
> > > >  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..4b1c270
> > > > --- /dev/null
> > > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
> > > > @@ -0,0 +1,83 @@
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_USBID_input
> > >
> > >
> > > The mixture of case is a bit ugly.  Could we do
> > > in_voltage_usbin_input?
> > >
> >
> > ACK
> >
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 USBID ADC which connected to connector ID pin.
> > > > +             Reading returns voltage in uV
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV5_input
> > >
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 VBUS ADC with high accuracy
> > > > +             Reading returns voltage in uV
> > >
> > > Why would we ever read the low accuracy version?
> > >

VBUSDIV5 with lower accuracy(+-75mA) higher measure range(1~22V)
VBUSDIV2 with higher accracy (+-30mA) lower measure range(1~9.76V)
I will fix the description

> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV2_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 VBUS ADC with low accuracy
> > > > +             Reading returns voltage in uV
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VSYS_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 VSYS ADC
> > > > +             Reading returns voltage in uV
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBAT_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 VBAT ADC
> > > > +             Reading returns voltage in uV
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBUS_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 IBUS ADC
> > > > +             Reading returns current in uA
> > > Given voltage and current are already clear from the channel type,
> > > could we avoid the repetition?
> > >
> > > in_current_bus_input perhaps?
> > >
> >
> > ACK
> >
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBAT_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 IBAT ADC
> > > > +             Reading returns current in uA
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_CHG_VDDP_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 CHG_VDDP ADC
> > > > +             Reading returns voltage in uV
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_temp_TEMP_JC_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 IC junction temperature
> > > > +             Reading returns temperature in degree
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VREF_TS_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 VREF_TS ADC
> > > > +             Reading returns voltage in uV
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_TS_input
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 TS ADC
> > > > +             Reading returns voltage in uV
> > > > +
> > > > +What:                /sys/bus/iio/devices/iio:deviceX/timestamp
> > > > +KernelVersion:       5.8.0
> > > > +Contact:     gene_chen@richtek.com
> > > > +Description:
> > > > +             Indicated MT6360 timestamp
> > > > +             Reading returns current timestamp in ms
> > >
> > > That's an odd bit of ABI.  Why would we want to read the current timestamp from
> > > sysfs?  Timestamps in IIO also tend to be in nano seconds.
> > >
> > >
> > >
> > >
> >
> > ACK, I will remove this.
>
>
Jonathan Cameron Sept. 18, 2020, 3:12 p.m. UTC | #5
On Fri, 18 Sep 2020 18:33:06 +0800
Gene Chen <gene.chen.richtek@gmail.com> wrote:

> Jonathan Cameron <Jonathan.Cameron@huawei.com> 於 2020年9月18日 週五 下午4:05寫道:
> >
> > On Fri, 18 Sep 2020 15:21:44 +0800
> > Gene Chen <gene.chen.richtek@gmail.com> wrote:
> >  
> > > Jonathan Cameron <jic23@kernel.org> 於 2020年9月18日 週五 上午1:43寫道:  
> > > >
> > > > On Wed, 16 Sep 2020 01:36:08 +0800
> > > > Gene Chen <gene.chen.richtek@gmail.com> wrote:
> > > >  
> > > > > From: Gene Chen <gene_chen@richtek.com>
> > > > >
> > > > > Add ABI documentation for mt6360 ADC sysfs interfaces.
> > > > >
> > > > > Signed-off-by: Gene Chen <gene_chen@richtek.com>  
> > > > Would you consider using the proposed label attribute for channels?
> > > >
> > > > https://lore.kernel.org/linux-iio/20200916132115.81795-1-cristian.pop@analog.com/T/#u
> > > >
> > > > I'm hoping that will remove the need to have ext name used in the majority of
> > > > cases and would like to know if it would work for you?
> > > > It may not work for this particular case of course.
> > > >
> > > > Other comments inline.
> > > >  
> > >
> > > because of ADC layout is fixed, I can't switch channel to specific
> > > purpose for userspace.  
> >
> > That patch set doesn't allow userspace to change the purpose. It provides
> > a *_label attribute for each channel to allow for identification of the channel.
> > That can be provided by ACPI / DT or can be provided by the driver itself.
> > The advantage is that it removes the nasty freeform parsing that is needed
> > to work out the filenames.
> >  
> 
> May I ask how to get this patch for test the labels?

You should be able to use the link above then click on "raw" next to the from line.
That will download you a patch that you can apply with git am.

> I supposed userspace catch meanings by iio device sysfs node name.

That is the idea.

> The label defined in DT means it can be modified. But actually shouldn't.

In your case, I agree that they are fixed in the hardware so the driver should
provide a read_label callback that simply prints the relevant const string when
requested for a particular channel.

For more general devices, the idea is that DT or similar can provide naming to
indicate that a particular board uses this channel to measure the bus voltage
or things like that. Here we don't need that flexibility.

Jonathan

> 
> > >  
> > > > > ---
> > > > >  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..4b1c270
> > > > > --- /dev/null
> > > > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
> > > > > @@ -0,0 +1,83 @@
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_USBID_input  
> > > >
> > > >
> > > > The mixture of case is a bit ugly.  Could we do
> > > > in_voltage_usbin_input?
> > > >  
> > >
> > > ACK
> > >  
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 USBID ADC which connected to connector ID pin.
> > > > > +             Reading returns voltage in uV
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV5_input  
> > > >  
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 VBUS ADC with high accuracy
> > > > > +             Reading returns voltage in uV  
> > > >
> > > > Why would we ever read the low accuracy version?
> > > >  
> 
> VBUSDIV5 with lower accuracy(+-75mA) higher measure range(1~22V)
> VBUSDIV2 with higher accracy (+-30mA) lower measure range(1~9.76V)
> I will fix the description

Great.

> 
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV2_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 VBUS ADC with low accuracy
> > > > > +             Reading returns voltage in uV
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VSYS_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 VSYS ADC
> > > > > +             Reading returns voltage in uV
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VBAT_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 VBAT ADC
> > > > > +             Reading returns voltage in uV
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBUS_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 IBUS ADC
> > > > > +             Reading returns current in uA  
> > > > Given voltage and current are already clear from the channel type,
> > > > could we avoid the repetition?
> > > >
> > > > in_current_bus_input perhaps?
> > > >  
> > >
> > > ACK
> > >  
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_current_IBAT_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 IBAT ADC
> > > > > +             Reading returns current in uA
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_CHG_VDDP_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 CHG_VDDP ADC
> > > > > +             Reading returns voltage in uV
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_temp_TEMP_JC_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 IC junction temperature
> > > > > +             Reading returns temperature in degree
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_VREF_TS_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 VREF_TS ADC
> > > > > +             Reading returns voltage in uV
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/in_voltage_TS_input
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 TS ADC
> > > > > +             Reading returns voltage in uV
> > > > > +
> > > > > +What:                /sys/bus/iio/devices/iio:deviceX/timestamp
> > > > > +KernelVersion:       5.8.0
> > > > > +Contact:     gene_chen@richtek.com
> > > > > +Description:
> > > > > +             Indicated MT6360 timestamp
> > > > > +             Reading returns current timestamp in ms  
> > > >
> > > > That's an odd bit of ABI.  Why would we want to read the current timestamp from
> > > > sysfs?  Timestamps in IIO also tend to be in nano seconds.
> > > >
> > > >
> > > >
> > > >  
> > >
> > > ACK, I will remove this.  
> >
> >
diff mbox series

Patch

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..4b1c270
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-mt6360
@@ -0,0 +1,83 @@ 
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_USBID_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 USBID ADC which connected to connector ID pin.
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV5_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 VBUS ADC with high accuracy
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VBUSDIV2_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 VBUS ADC with low accuracy
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VSYS_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 VSYS ADC
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VBAT_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 VBAT ADC
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_current_IBUS_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 IBUS ADC
+		Reading returns current in uA
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_current_IBAT_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 IBAT ADC
+		Reading returns current in uA
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_CHG_VDDP_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 CHG_VDDP ADC
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_temp_TEMP_JC_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 IC junction temperature
+		Reading returns temperature in degree
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_VREF_TS_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 VREF_TS ADC
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/in_voltage_TS_input
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 TS ADC
+		Reading returns voltage in uV
+
+What:		/sys/bus/iio/devices/iio:deviceX/timestamp
+KernelVersion:	5.8.0
+Contact:	gene_chen@richtek.com
+Description:
+		Indicated MT6360 timestamp
+		Reading returns current timestamp in ms