iio: Documentation update for outputs / dac
Subsystems (3)
PATCH 1/1 iio: Documentation update for outputs / dac
Attached is the documentation update for iio outputs / dac.
iio: Documentation update for outputs / dac
drivers/staging/iio/Documentation/sysfs-bus-iio +20 -0
@@ -168,6 +168,7 @@ Description: What: /sys/bus/iio/devices/deviceX/inY_scale What: /sys/bus/iio/devices/deviceX/inY_supply_scale What: /sys/bus/iio/devices/deviceX/in_scale +What: /sys/bus/iio/devices/deviceX/outY_scale What: /sys/bus/iio/devices/deviceX/accel_scale What: /sys/bus/iio/devices/deviceX/accel_peak_scale What: /sys/bus/iio/devices/deviceX/gyro_scale
@@ -222,6 +223,25 @@ Description: If a discrete set of scale values are available, they are listed in this attribute. +What: /sys/bus/iio/devices/deviceX/outY_raw +KernelVersion: 2.6.37 +Contact: [email protected] +Description: + Raw (unscaled, no bias etc.) output voltage for + channel Y. In special cases where the channel does not + correspond to externally available output one of the named + versions may be used. The number must always be specified and + unique if the output corresponds to a single channel. + +What: /sys/bus/iio/devices/deviceX/outY&Z&..._raw +KernelVersion: 2.6.37 +Contact: [email protected] +Description: + Raw (unscaled, no bias etc.) output voltage for an aggregate of + channel Y, channel Z, etc. This interface is available in cases + where a single output sets the value for multiple channels + simultaneously. + What: /sys/bus/iio/devices/deviceX/deviceX:eventY KernelVersion: 2.6.35 Contact: [email protected]
Quoted 1 line · Roland Stigge
Attached is the documentation update for iio outputs / dac.
Hi Roland,
Any chance at all you can get git-send-email to work for you? Saves me the step of pasting the attachment back into the email every time!
More or less fine, couple of minor comments inline.
Thanks for doing this,
Jonathan
Quoted 17 lines
iio: Documentation update for outputs / dac
Signed-off-by Roland Stigge <[email protected]>drivers/staging/iio/Documentation/sysfs-bus-iio +1
-0@@ -168,6 +168,7 @@ Description: What: /sys/bus/iio/devices/deviceX/inY_scale What: /sys/bus/iio/devices/deviceX/inY_supply_scale What: /sys/bus/iio/devices/deviceX/in_scale +What: /sys/bus/iio/devices/deviceX/outY_scale What: /sys/bus/iio/devices/deviceX/accel_scale What: /sys/bus/iio/devices/deviceX/accel_peak_scale What: /sys/bus/iio/devices/deviceX/gyro_scale
drivers/staging/iio/Documentation/sysfs-bus-iio Description: · line 231
Quoted 9 lines
drivers/staging/iio/Documentation/sysfs-bus-iio +6
-0@@ -222,6 +223,25 @@ Description: If a discrete set of scale values are available, they are listed in this attribute. +What: /sys/bus/iio/devices/deviceX/outY_raw +KernelVersion: 2.6.37 +Contact: [email protected] +Description: + Raw (unscaled, no bias etc.) output voltage for + channel Y.
Get rid of this bit about named output. I'm not sure it makes sense to allow this and I don't think we currently have an examples in tree.
drivers/staging/iio/Documentation/sysfs-bus-iio Description: · line 236
Quoted 6 lines
In special cases where the channel does not
drivers/staging/iio/Documentation/sysfs-bus-iio +5
-0+ correspond to externally available output one of the named + versions may be used. The number must always be specified and + unique if the output corresponds to a single channel. + +What: /sys/bus/iio/devices/deviceX/outY&Z&..._raw
Please avoid ... syntax, it makes it very difficult to search the file. Just list the two case version
outY&Z_raw for now and we can document more advanced cases if they ever show up as extra what entries.
Quoted 11 lines
drivers/staging/iio/Documentation/sysfs-bus-iio +8
-0+KernelVersion: 2.6.37 +Contact: [email protected] +Description: + Raw (unscaled, no bias etc.) output voltage for an aggregate of + channel Y, channel Z, etc. This interface is available in cases + where a single output sets the value for multiple channels + simultaneously. + What: /sys/bus/iio/devices/deviceX/deviceX:eventY KernelVersion: 2.6.35 Contact: [email protected]
Hi,
Quoted 3 lines · Jonathan Cameron
Any chance at all you can get git-send-email to work for you? Saves me the step of pasting the attachment back into the email every time!
Thanks for the hint. Will test with another patch. :-)
Quoted 9 lines
drivers/staging/iio/Documentation/sysfs-bus-iio Description:
Quoted 6 lines
drivers/staging/iio/Documentation/sysfs-bus-iio +6
-0+What: /sys/bus/iio/devices/deviceX/outY_raw +KernelVersion: 2.6.37 +Contact: [email protected] +Description: + Raw (unscaled, no bias etc.) output voltage for + channel Y.Get rid of this bit about named output. I'm not sure it makes sense to allow this and I don't think we currently have an examples in tree.
Do you mean we shouldn't document /sys/bus/iio/devices/deviceX/outY_raw (which is quite analogous to inY_raw) but /sys/bus/iio/devices/deviceX/outY_scale and /sys/bus/iio/devices/deviceX/outY&Z_raw?
Or how did I get you wrong?
Thanks,
Roland
Quoted 19 lines · Roland Stigge
Hi,
Quoted 3 lines · Jonathan Cameron
Any chance at all you can get git-send-email to work for you? Saves me the step of pasting the attachment back into the email every time!
Thanks for the hint. Will test with another patch. :-)
Quoted 9 lines
drivers/staging/iio/Documentation/sysfs-bus-iio Description:
Quoted 6 lines
drivers/staging/iio/Documentation/sysfs-bus-iio +6
-0+What: /sys/bus/iio/devices/deviceX/outY_raw +KernelVersion: 2.6.37 +Contact: [email protected] +Description: + Raw (unscaled, no bias etc.) output voltage for + channel Y.Get rid of this bit about named output. I'm not sure it makes sense to allow this and I don't think we currently have an examples in tree.
Quoted 5 lines
Do you mean we shouldn't document
/sys/bus/iio/devices/deviceX/outY_raw(which is quite analogous toinY_raw) but/sys/bus/iio/devices/deviceX/outY_scaleand /sys/bus/iio/devices/deviceX/outY&Z_raw?
No, the named bit for inputs is todo with inY_supply_raw etc rather than the scale and compound versions both of which should indeed be documented. I just mean remove the bit in the description of outY_raw which refers to 'names'. Basically get rid of ' In special cases where the channel does not
correspond to externally available output one of the named versions may be used.' as it doesn't apply to outputs. '
Any internal only output would be a somewhat odd beast.
Thanks,
Jonathan