Merge branch 'hid-suspend' into picolcd
[pandora-kernel.git] / Documentation / ABI / testing / sysfs-driver-hid-picolcd
1 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/operation_mode
2 Date:           March 2010
3 Contact:        Bruno Prémont <bonbons@linux-vserver.org>
4 Description:    Make it possible to switch the PicoLCD device between LCD
5                 (firmware) and bootloader (flasher) operation modes.
6
7                 Reading: returns list of available modes, the active mode being
8                 enclosed in brackets ('[' and ']')
9
10                 Writing: causes operation mode switch. Permitted values are
11                 the non-active mode names listed when read.
12
13                 Note: when switching mode the current PicoLCD HID device gets
14                 disconnected and reconnects after above delay (see attribute
15                 operation_mode_delay for its value).
16
17
18 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/operation_mode_delay
19 Date:           April 2010
20 Contact:        Bruno Prémont <bonbons@linux-vserver.org>
21 Description:    Delay PicoLCD waits before restarting in new mode when
22                 operation_mode has changed.
23
24                 Reading/Writing: It is expressed in ms and permitted range is
25                 0..30000ms.
26
27
28 What:           /sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/<hid-bus>:<vendor-id>:<product-id>.<num>/fb_update_rate
29 Date:           March 2010
30 Contact:        Bruno Prémont <bonbons@linux-vserver.org>
31 Description:    Make it possible to adjust defio refresh rate.
32
33                 Reading: returns list of available refresh rates (expressed in Hz),
34                 the active refresh rate being enclosed in brackets ('[' and ']')
35
36                 Writing: accepts new refresh rate expressed in integer Hz
37                 within permitted rates.
38
39                 Note: As device can barely do 2 complete refreshes a second
40                 it only makes sense to adjust this value if only one or two
41                 tiles get changed and it's not appropriate to expect the application
42                 to flush it's tiny changes explicitely at higher than default rate.
43