diff options
Diffstat (limited to 'Documentation/ABI')
4 files changed, 146 insertions, 24 deletions
diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index cfedf63cce15..05449c68952c 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio +++ b/Documentation/ABI/testing/sysfs-bus-iio | |||
@@ -40,9 +40,9 @@ Contact: linux-iio@vger.kernel.org | |||
40 | Description: | 40 | Description: |
41 | Some devices have internal clocks. This parameter sets the | 41 | Some devices have internal clocks. This parameter sets the |
42 | resulting sampling frequency. In many devices this | 42 | resulting sampling frequency. In many devices this |
43 | parameter has an effect on input filters etc rather than | 43 | parameter has an effect on input filters etc. rather than |
44 | simply controlling when the input is sampled. As this | 44 | simply controlling when the input is sampled. As this |
45 | effects datardy triggers, hardware buffers and the sysfs | 45 | effects data ready triggers, hardware buffers and the sysfs |
46 | direct access interfaces, it may be found in any of the | 46 | direct access interfaces, it may be found in any of the |
47 | relevant directories. If it effects all of the above | 47 | relevant directories. If it effects all of the above |
48 | then it is to be found in the base device directory. | 48 | then it is to be found in the base device directory. |
@@ -74,7 +74,7 @@ What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_raw | |||
74 | KernelVersion: 2.6.35 | 74 | KernelVersion: 2.6.35 |
75 | Contact: linux-iio@vger.kernel.org | 75 | Contact: linux-iio@vger.kernel.org |
76 | Description: | 76 | Description: |
77 | Raw (unscaled no bias removal etc) voltage measurement from | 77 | Raw (unscaled no bias removal etc.) voltage measurement from |
78 | channel Y. In special cases where the channel does not | 78 | channel Y. In special cases where the channel does not |
79 | correspond to externally available input one of the named | 79 | correspond to externally available input one of the named |
80 | versions may be used. The number must always be specified and | 80 | versions may be used. The number must always be specified and |
@@ -118,7 +118,7 @@ What: /sys/bus/iio/devices/iio:deviceX/in_temp_z_raw | |||
118 | KernelVersion: 2.6.35 | 118 | KernelVersion: 2.6.35 |
119 | Contact: linux-iio@vger.kernel.org | 119 | Contact: linux-iio@vger.kernel.org |
120 | Description: | 120 | Description: |
121 | Raw (unscaled no bias removal etc) temperature measurement. | 121 | Raw (unscaled no bias removal etc.) temperature measurement. |
122 | If an axis is specified it generally means that the temperature | 122 | If an axis is specified it generally means that the temperature |
123 | sensor is associated with one part of a compound device (e.g. | 123 | sensor is associated with one part of a compound device (e.g. |
124 | a gyroscope axis). Units after application of scale and offset | 124 | a gyroscope axis). Units after application of scale and offset |
@@ -148,10 +148,9 @@ KernelVersion: 2.6.35 | |||
148 | Contact: linux-iio@vger.kernel.org | 148 | Contact: linux-iio@vger.kernel.org |
149 | Description: | 149 | Description: |
150 | Angular velocity about axis x, y or z (may be arbitrarily | 150 | Angular velocity about axis x, y or z (may be arbitrarily |
151 | assigned) Data converted by application of offset then scale to | 151 | assigned). Has all the equivalent parameters as per voltageY. |
152 | radians per second. Has all the equivalent parameters as | 152 | Units after application of scale and offset are radians per |
153 | per voltageY. Units after application of scale and offset are | 153 | second. |
154 | radians per second. | ||
155 | 154 | ||
156 | What: /sys/bus/iio/devices/iio:deviceX/in_incli_x_raw | 155 | What: /sys/bus/iio/devices/iio:deviceX/in_incli_x_raw |
157 | What: /sys/bus/iio/devices/iio:deviceX/in_incli_y_raw | 156 | What: /sys/bus/iio/devices/iio:deviceX/in_incli_y_raw |
@@ -161,7 +160,7 @@ Contact: linux-iio@vger.kernel.org | |||
161 | Description: | 160 | Description: |
162 | Inclination raw reading about axis x, y or z (may be | 161 | Inclination raw reading about axis x, y or z (may be |
163 | arbitrarily assigned). Data converted by application of offset | 162 | arbitrarily assigned). Data converted by application of offset |
164 | and scale to Degrees. | 163 | and scale to degrees. |
165 | 164 | ||
166 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_raw | 165 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_raw |
167 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_raw | 166 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_raw |
@@ -203,7 +202,7 @@ Contact: linux-iio@vger.kernel.org | |||
203 | Description: | 202 | Description: |
204 | If known for a device, offset to be added to <type>[Y]_raw prior | 203 | If known for a device, offset to be added to <type>[Y]_raw prior |
205 | to scaling by <type>[Y]_scale in order to obtain value in the | 204 | to scaling by <type>[Y]_scale in order to obtain value in the |
206 | <type> units as specified in <type>[y]_raw documentation. | 205 | <type> units as specified in <type>[Y]_raw documentation. |
207 | Not present if the offset is always 0 or unknown. If Y or | 206 | Not present if the offset is always 0 or unknown. If Y or |
208 | axis <x|y|z> is not present, then the offset applies to all | 207 | axis <x|y|z> is not present, then the offset applies to all |
209 | in channels of <type>. | 208 | in channels of <type>. |
@@ -249,7 +248,7 @@ What: /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibbias | |||
249 | KernelVersion: 2.6.35 | 248 | KernelVersion: 2.6.35 |
250 | Contact: linux-iio@vger.kernel.org | 249 | Contact: linux-iio@vger.kernel.org |
251 | Description: | 250 | Description: |
252 | Hardware applied calibration offset. (assumed to fix production | 251 | Hardware applied calibration offset (assumed to fix production |
253 | inaccuracies). | 252 | inaccuracies). |
254 | 253 | ||
255 | What /sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale | 254 | What /sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale |
@@ -266,7 +265,7 @@ what /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale | |||
266 | KernelVersion: 2.6.35 | 265 | KernelVersion: 2.6.35 |
267 | Contact: linux-iio@vger.kernel.org | 266 | Contact: linux-iio@vger.kernel.org |
268 | Description: | 267 | Description: |
269 | Hardware applied calibration scale factor. (assumed to fix | 268 | Hardware applied calibration scale factor (assumed to fix |
270 | production inaccuracies). If shared across all channels, | 269 | production inaccuracies). If shared across all channels, |
271 | <type>_calibscale is used. | 270 | <type>_calibscale is used. |
272 | 271 | ||
@@ -279,7 +278,7 @@ What: /sys/.../iio:deviceX/in_capacitance_scale_available | |||
279 | KernelVersion: 2.635 | 278 | KernelVersion: 2.635 |
280 | Contact: linux-iio@vger.kernel.org | 279 | Contact: linux-iio@vger.kernel.org |
281 | Description: | 280 | Description: |
282 | If a discrete set of scale values are available, they | 281 | If a discrete set of scale values is available, they |
283 | are listed in this attribute. | 282 | are listed in this attribute. |
284 | 283 | ||
285 | What /sys/bus/iio/devices/iio:deviceX/out_voltageY_hardwaregain | 284 | What /sys/bus/iio/devices/iio:deviceX/out_voltageY_hardwaregain |
@@ -330,9 +329,11 @@ Contact: linux-iio@vger.kernel.org | |||
330 | Description: | 329 | Description: |
331 | Specifies the output powerdown mode. | 330 | Specifies the output powerdown mode. |
332 | DAC output stage is disconnected from the amplifier and | 331 | DAC output stage is disconnected from the amplifier and |
333 | 1kohm_to_gnd: connected to ground via an 1kOhm resistor | 332 | 1kohm_to_gnd: connected to ground via an 1kOhm resistor, |
334 | 100kohm_to_gnd: connected to ground via an 100kOhm resistor | 333 | 6kohm_to_gnd: connected to ground via a 6kOhm resistor, |
335 | three_state: left floating | 334 | 20kohm_to_gnd: connected to ground via a 20kOhm resistor, |
335 | 100kohm_to_gnd: connected to ground via an 100kOhm resistor, | ||
336 | three_state: left floating. | ||
336 | For a list of available output power down options read | 337 | For a list of available output power down options read |
337 | outX_powerdown_mode_available. If Y is not present the | 338 | outX_powerdown_mode_available. If Y is not present the |
338 | mode is shared across all outputs. | 339 | mode is shared across all outputs. |
@@ -355,9 +356,10 @@ KernelVersion: 2.6.38 | |||
355 | Contact: linux-iio@vger.kernel.org | 356 | Contact: linux-iio@vger.kernel.org |
356 | Description: | 357 | Description: |
357 | Writing 1 causes output Y to enter the power down mode specified | 358 | Writing 1 causes output Y to enter the power down mode specified |
358 | by the corresponding outY_powerdown_mode. Clearing returns to | 359 | by the corresponding outY_powerdown_mode. DAC output stage is |
359 | normal operation. Y may be suppressed if all outputs are | 360 | disconnected from the amplifier. Clearing returns to normal |
360 | controlled together. | 361 | operation. Y may be suppressed if all outputs are controlled |
362 | together. | ||
361 | 363 | ||
362 | What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency | 364 | What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency |
363 | KernelVersion: 3.4.0 | 365 | KernelVersion: 3.4.0 |
@@ -421,12 +423,12 @@ Description: | |||
421 | different values, but the device can only enable both thresholds | 423 | different values, but the device can only enable both thresholds |
422 | or neither. | 424 | or neither. |
423 | Note the driver will assume the last p events requested are | 425 | Note the driver will assume the last p events requested are |
424 | to be enabled where p is however many it supports (which may | 426 | to be enabled where p is how many it supports (which may vary |
425 | vary depending on the exact set requested. So if you want to be | 427 | depending on the exact set requested. So if you want to be |
426 | sure you have set what you think you have, check the contents of | 428 | sure you have set what you think you have, check the contents of |
427 | these attributes after everything is configured. Drivers may | 429 | these attributes after everything is configured. Drivers may |
428 | have to buffer any parameters so that they are consistent when | 430 | have to buffer any parameters so that they are consistent when |
429 | a given event type is enabled a future point (and not those for | 431 | a given event type is enabled at a future point (and not those for |
430 | whatever event was previously enabled). | 432 | whatever event was previously enabled). |
431 | 433 | ||
432 | What: /sys/.../iio:deviceX/events/in_accel_x_roc_rising_en | 434 | What: /sys/.../iio:deviceX/events/in_accel_x_roc_rising_en |
@@ -702,7 +704,7 @@ What: /sys/.../buffer/scan_elements/in_anglvel_type | |||
702 | What: /sys/.../buffer/scan_elements/in_magn_type | 704 | What: /sys/.../buffer/scan_elements/in_magn_type |
703 | What: /sys/.../buffer/scan_elements/in_incli_type | 705 | What: /sys/.../buffer/scan_elements/in_incli_type |
704 | What: /sys/.../buffer/scan_elements/in_voltageY_type | 706 | What: /sys/.../buffer/scan_elements/in_voltageY_type |
705 | What: /sys/.../buffer/scan_elements/in_voltage-in_type | 707 | What: /sys/.../buffer/scan_elements/in_voltage_type |
706 | What: /sys/.../buffer/scan_elements/in_voltageY_supply_type | 708 | What: /sys/.../buffer/scan_elements/in_voltageY_supply_type |
707 | What: /sys/.../buffer/scan_elements/in_timestamp_type | 709 | What: /sys/.../buffer/scan_elements/in_timestamp_type |
708 | KernelVersion: 2.6.37 | 710 | KernelVersion: 2.6.37 |
@@ -723,7 +725,7 @@ Description: | |||
723 | the buffer output value appropriately. The storagebits value | 725 | the buffer output value appropriately. The storagebits value |
724 | also specifies the data alignment. So s48/64>>2 will be a | 726 | also specifies the data alignment. So s48/64>>2 will be a |
725 | signed 48 bit integer stored in a 64 bit location aligned to | 727 | signed 48 bit integer stored in a 64 bit location aligned to |
726 | a a64 bit boundary. To obtain the clean value, shift right 2 | 728 | a 64 bit boundary. To obtain the clean value, shift right 2 |
727 | and apply a mask to zero the top 16 bits of the result. | 729 | and apply a mask to zero the top 16 bits of the result. |
728 | For other storage combinations this attribute will be extended | 730 | For other storage combinations this attribute will be extended |
729 | appropriately. | 731 | appropriately. |
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9523 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9523 new file mode 100644 index 000000000000..2ce9c3f68eee --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-ad9523 | |||
@@ -0,0 +1,37 @@ | |||
1 | What: /sys/bus/iio/devices/iio:deviceX/pll2_feedback_clk_present | ||
2 | What: /sys/bus/iio/devices/iio:deviceX/pll2_reference_clk_present | ||
3 | What: /sys/bus/iio/devices/iio:deviceX/pll1_reference_clk_a_present | ||
4 | What: /sys/bus/iio/devices/iio:deviceX/pll1_reference_clk_b_present | ||
5 | What: /sys/bus/iio/devices/iio:deviceX/pll1_reference_clk_test_present | ||
6 | What: /sys/bus/iio/devices/iio:deviceX/vcxo_clk_present | ||
7 | KernelVersion: 3.4.0 | ||
8 | Contact: linux-iio@vger.kernel.org | ||
9 | Description: | ||
10 | Reading returns either '1' or '0'. | ||
11 | '1' means that the clock in question is present. | ||
12 | '0' means that the clock is missing. | ||
13 | |||
14 | What: /sys/bus/iio/devices/iio:deviceX/pllY_locked | ||
15 | KernelVersion: 3.4.0 | ||
16 | Contact: linux-iio@vger.kernel.org | ||
17 | Description: | ||
18 | Reading returns either '1' or '0'. '1' means that the | ||
19 | pllY is locked. | ||
20 | |||
21 | What: /sys/bus/iio/devices/iio:deviceX/store_eeprom | ||
22 | KernelVersion: 3.4.0 | ||
23 | Contact: linux-iio@vger.kernel.org | ||
24 | Description: | ||
25 | Writing '1' stores the current device configuration into | ||
26 | on-chip EEPROM. After power-up or chip reset the device will | ||
27 | automatically load the saved configuration. | ||
28 | |||
29 | What: /sys/bus/iio/devices/iio:deviceX/sync_dividers | ||
30 | KernelVersion: 3.4.0 | ||
31 | Contact: linux-iio@vger.kernel.org | ||
32 | Description: | ||
33 | Writing '1' triggers the clock distribution synchronization | ||
34 | functionality. All dividers are reset and the channels start | ||
35 | with their predefined phase offsets (out_altvoltageY_phase). | ||
36 | Writing this file has the effect as driving the external | ||
37 | /SYNC pin low. | ||
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4350 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4350 new file mode 100644 index 000000000000..d89aded01c5a --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4350 | |||
@@ -0,0 +1,21 @@ | |||
1 | What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_frequency_resolution | ||
2 | KernelVersion: 3.4.0 | ||
3 | Contact: linux-iio@vger.kernel.org | ||
4 | Description: | ||
5 | Stores channel Y frequency resolution/channel spacing in Hz. | ||
6 | The value given directly influences the MODULUS used by | ||
7 | the fractional-N PLL. It is assumed that the algorithm | ||
8 | that is used to compute the various dividers, is able to | ||
9 | generate proper values for multiples of channel spacing. | ||
10 | |||
11 | What: /sys/bus/iio/devices/iio:deviceX/out_altvoltageY_refin_frequency | ||
12 | KernelVersion: 3.4.0 | ||
13 | Contact: linux-iio@vger.kernel.org | ||
14 | Description: | ||
15 | Sets channel Y REFin frequency in Hz. In some clock chained | ||
16 | applications, the reference frequency used by the PLL may | ||
17 | change during runtime. This attribute allows the user to | ||
18 | adjust the reference frequency accordingly. | ||
19 | The value written has no effect until out_altvoltageY_frequency | ||
20 | is updated. Consider to use out_altvoltageY_powerdown to power | ||
21 | down the PLL and it's RFOut buffers during REFin changes. | ||
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als b/Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als new file mode 100644 index 000000000000..694a52c8cf82 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-light-lm3533-als | |||
@@ -0,0 +1,62 @@ | |||
1 | What: /sys/.../events/in_illuminance0_thresh_either_en | ||
2 | Date: April 2012 | ||
3 | KernelVersion: 3.5 | ||
4 | Contact: Johan Hovold <jhovold@gmail.com> | ||
5 | Description: | ||
6 | Event generated when channel passes one of the four thresholds | ||
7 | in each direction (rising|falling) and a zone change occurs. | ||
8 | The corresponding light zone can be read from | ||
9 | in_illuminance0_zone. | ||
10 | |||
11 | What: /sys/.../events/in_illuminance0_threshY_hysteresis | ||
12 | Date: May 2012 | ||
13 | KernelVersion: 3.5 | ||
14 | Contact: Johan Hovold <jhovold@gmail.com> | ||
15 | Description: | ||
16 | Get the hysteresis for thresholds Y, that is, | ||
17 | |||
18 | threshY_hysteresis = threshY_raising - threshY_falling | ||
19 | |||
20 | What: /sys/.../events/illuminance_threshY_falling_value | ||
21 | What: /sys/.../events/illuminance_threshY_raising_value | ||
22 | Date: April 2012 | ||
23 | KernelVersion: 3.5 | ||
24 | Contact: Johan Hovold <jhovold@gmail.com> | ||
25 | Description: | ||
26 | Specifies the value of threshold that the device is comparing | ||
27 | against for the events enabled by | ||
28 | in_illuminance0_thresh_either_en (0..255), where Y in 0..3. | ||
29 | |||
30 | Note that threshY_falling must be less than or equal to | ||
31 | threshY_raising. | ||
32 | |||
33 | These thresholds correspond to the eight zone-boundary | ||
34 | registers (boundaryY_{low,high}) and defines the five light | ||
35 | zones. | ||
36 | |||
37 | What: /sys/bus/iio/devices/iio:deviceX/in_illuminance0_zone | ||
38 | Date: April 2012 | ||
39 | KernelVersion: 3.5 | ||
40 | Contact: Johan Hovold <jhovold@gmail.com> | ||
41 | Description: | ||
42 | Get the current light zone (0..4) as defined by the | ||
43 | in_illuminance0_threshY_{falling,rising} thresholds. | ||
44 | |||
45 | What: /sys/bus/iio/devices/iio:deviceX/out_currentY_raw | ||
46 | Date: May 2012 | ||
47 | KernelVersion: 3.5 | ||
48 | Contact: Johan Hovold <jhovold@gmail.com> | ||
49 | Description: | ||
50 | Get output current for channel Y (0..255), that is, | ||
51 | out_currentY_currentZ_raw, where Z is the current zone. | ||
52 | |||
53 | What: /sys/bus/iio/devices/iio:deviceX/out_currentY_currentZ_raw | ||
54 | Date: May 2012 | ||
55 | KernelVersion: 3.5 | ||
56 | Contact: Johan Hovold <jhovold@gmail.com> | ||
57 | Description: | ||
58 | Set the output current for channel out_currentY when in zone | ||
59 | Z (0..255), where Y in 0..2 and Z in 0..4. | ||
60 | |||
61 | These values correspond to the ALS-mapper target registers for | ||
62 | ALS-mapper Y + 1. | ||