diff mbox

[2/4] iio: Documentation: Add max961x sysfs documentation

Message ID 1487948756-25172-3-git-send-email-jacopo+renesas@jmondi.org (mailing list archive)
State Superseded
Delegated to: Geert Uytterhoeven
Headers show

Commit Message

Jacopo Mondi Feb. 24, 2017, 3:05 p.m. UTC
Add documentation for max961x driver.
The only attribute to document is the current sense shunt resistor
value.

Signed-off-by: Jacopo Mondi <jacopo+renesas@jmondi.org>
---
 Documentation/ABI/testing/sysfs-bus-iio-adc-max961x | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-max961x

Comments

Jonathan Cameron Feb. 25, 2017, 3:54 p.m. UTC | #1
On 24/02/17 15:05, Jacopo Mondi wrote:
> Add documentation for max961x driver.
> The only attribute to document is the current sense shunt resistor
> value.
> 
> Signed-off-by: Jacopo Mondi <jacopo+renesas@jmondi.org>
Interestingly generic as it only applies to some of the channels.
We might need to have the channel where it is effecting the output specified in the
name, even if we end up with several repeats of the same thing for different
computed channels.

Jonathan
> ---
>  Documentation/ABI/testing/sysfs-bus-iio-adc-max961x | 5 +++++
>  1 file changed, 5 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
> new file mode 100644
> index 0000000..dbd5e75
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
> @@ -0,0 +1,5 @@
> +What:		/sys/bus/iio/devices/iio:deviceX/in_shunt_resistor
> +Date:		February 2017
> +KernelVersion:	4.10
> +Contact:	linux-iio@vger.kernel.org
> +Description: 	The value of the shunt resistor in micro Ohms.
>
Jacopo Mondi March 21, 2017, 4:09 p.m. UTC | #2
Hi Jonathan,

On Sat, Feb 25, 2017 at 03:54:45PM +0000, Jonathan Cameron wrote:
> On 24/02/17 15:05, Jacopo Mondi wrote:
> > Add documentation for max961x driver.
> > The only attribute to document is the current sense shunt resistor
> > value.
> > 
> > Signed-off-by: Jacopo Mondi <jacopo+renesas@jmondi.org>
> Interestingly generic as it only applies to some of the channels.
> We might need to have the channel where it is effecting the output specified in the
> name, even if we end up with several repeats of the same thing for different
> computed channels.
> 

Sorry, I'm getting on this a bit late...

Do you still think we should have an attribute for each of the
channels this values affects?
We will end up having 2 distinct processed channels (power and
current) that depends on this value.
I can expose them as 2 distinct attributes if you think this is the
case...

A note on the series in general: given the lack of comments, I will
send v2 exposing two processed channels, with no buffered reads, and
gain selection performed in kernel space.
If we will have to add buffered reads to accomodate higher sampling
frequency we'll do that later on eventually.

Thanks
  j

> Jonathan
> > ---
> >  Documentation/ABI/testing/sysfs-bus-iio-adc-max961x | 5 +++++
> >  1 file changed, 5 insertions(+)
> >  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
> > 
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
> > new file mode 100644
> > index 0000000..dbd5e75
> > --- /dev/null
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
> > @@ -0,0 +1,5 @@
> > +What:		/sys/bus/iio/devices/iio:deviceX/in_shunt_resistor
> > +Date:		February 2017
> > +KernelVersion:	4.10
> > +Contact:	linux-iio@vger.kernel.org
> > +Description: 	The value of the shunt resistor in micro Ohms.
> > 
>
Jonathan Cameron March 22, 2017, 8:43 p.m. UTC | #3
On 21/03/17 16:09, jacopo wrote:
> Hi Jonathan,
> 
> On Sat, Feb 25, 2017 at 03:54:45PM +0000, Jonathan Cameron wrote:
>> On 24/02/17 15:05, Jacopo Mondi wrote:
>>> Add documentation for max961x driver.
>>> The only attribute to document is the current sense shunt resistor
>>> value.
>>>
>>> Signed-off-by: Jacopo Mondi <jacopo+renesas@jmondi.org>
>> Interestingly generic as it only applies to some of the channels.
>> We might need to have the channel where it is effecting the output specified in the
>> name, even if we end up with several repeats of the same thing for different
>> computed channels.
>>
> 
> Sorry, I'm getting on this a bit late...
> 
> Do you still think we should have an attribute for each of the
> channels this values affects?
> We will end up having 2 distinct processed channels (power and
> current) that depends on this value.
> I can expose them as 2 distinct attributes if you think this is the
> case...
Better to have two attributes exposing the same thing than imply it
is relevant to more of channels than it is...
> 
> A note on the series in general: given the lack of comments, I will
> send v2 exposing two processed channels, with no buffered reads, and
> gain selection performed in kernel space.
> If we will have to add buffered reads to accomodate higher sampling
> frequency we'll do that later on eventually.
Great.

Jonathan
> 
> Thanks
>   j
> 
>> Jonathan
>>> ---
>>>  Documentation/ABI/testing/sysfs-bus-iio-adc-max961x | 5 +++++
>>>  1 file changed, 5 insertions(+)
>>>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
>>>
>>> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
>>> new file mode 100644
>>> index 0000000..dbd5e75
>>> --- /dev/null
>>> +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
>>> @@ -0,0 +1,5 @@
>>> +What:		/sys/bus/iio/devices/iio:deviceX/in_shunt_resistor
>>> +Date:		February 2017
>>> +KernelVersion:	4.10
>>> +Contact:	linux-iio@vger.kernel.org
>>> +Description: 	The value of the shunt resistor in micro Ohms.
>>>
>>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-iio" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>
diff mbox

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
new file mode 100644
index 0000000..dbd5e75
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-max961x
@@ -0,0 +1,5 @@ 
+What:		/sys/bus/iio/devices/iio:deviceX/in_shunt_resistor
+Date:		February 2017
+KernelVersion:	4.10
+Contact:	linux-iio@vger.kernel.org
+Description: 	The value of the shunt resistor in micro Ohms.