Commit 1eb4480b authored by Stelian Pop's avatar Stelian Pop Committed by Linus Torvalds

[PATCH] sonypi: documentation fixes

In the latest round of updates for the sonypi driver, I fergot to send the
attached patch which fixes the driver documentation.

The patch contains mostly whitespace fixes and some additional information
regarding the input layer usage.
Signed-off-by: default avatarStelian Pop <stelian@popies.net>
Signed-off-by: default avatarAndrew Morton <akpm@osdl.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@osdl.org>
parent 5b1f9e43
Sony Programmable I/O Control Device Driver Readme Sony Programmable I/O Control Device Driver Readme
-------------------------------------------------- --------------------------------------------------
Copyright (C) 2001-2003 Stelian Pop <stelian@popies.net> Copyright (C) 2001-2004 Stelian Pop <stelian@popies.net>
Copyright (C) 2001-2002 Alcôve <www.alcove.com> Copyright (C) 2001-2002 Alcôve <www.alcove.com>
Copyright (C) 2001 Michael Ashley <m.ashley@unsw.edu.au> Copyright (C) 2001 Michael Ashley <m.ashley@unsw.edu.au>
Copyright (C) 2001 Junichi Morita <jun1m@mars.dti.ne.jp> Copyright (C) 2001 Junichi Morita <jun1m@mars.dti.ne.jp>
...@@ -23,16 +23,18 @@ generate, like: ...@@ -23,16 +23,18 @@ generate, like:
Those events (see linux/sonypi.h) can be polled using the character device node Those events (see linux/sonypi.h) can be polled using the character device node
/dev/sonypi (major 10, minor auto allocated or specified as a option). /dev/sonypi (major 10, minor auto allocated or specified as a option).
A simple daemon which translates the jogdial movements into mouse wheel events A simple daemon which translates the jogdial movements into mouse wheel events
can be downloaded at: <http://popies.net/sonypi/> can be downloaded at: <http://popies.net/sonypi/>
Another option to intercept the events is to get them directly through the
input layer.
This driver supports also some ioctl commands for setting the LCD screen This driver supports also some ioctl commands for setting the LCD screen
brightness and querying the batteries charge information (some more brightness and querying the batteries charge information (some more
commands may be added in the future). commands may be added in the future).
This driver can also be used to set the camera controls on Picturebook series This driver can also be used to set the camera controls on Picturebook series
(brightness, contrast etc), and is used by the video4linux driver for the (brightness, contrast etc), and is used by the video4linux driver for the
Motion Eye camera. Motion Eye camera.
Please note that this driver was created by reverse engineering the Windows Please note that this driver was created by reverse engineering the Windows
...@@ -47,7 +49,7 @@ module argument syntax (<param>=<value> when passing the option to the ...@@ -47,7 +49,7 @@ module argument syntax (<param>=<value> when passing the option to the
module or sonypi.<param>=<value> on the kernel boot line when sonypi is module or sonypi.<param>=<value> on the kernel boot line when sonypi is
statically linked into the kernel). Those options are: statically linked into the kernel). Those options are:
minor: minor number of the misc device /dev/sonypi, minor: minor number of the misc device /dev/sonypi,
default is -1 (automatic allocation, see /proc/misc default is -1 (automatic allocation, see /proc/misc
or kernel logs) or kernel logs)
...@@ -59,14 +61,14 @@ statically linked into the kernel). Those options are: ...@@ -59,14 +61,14 @@ statically linked into the kernel). Those options are:
get enabled unless you set this parameter to 1. get enabled unless you set this parameter to 1.
Do not use this option unless it's actually necessary, Do not use this option unless it's actually necessary,
some Vaio models don't deal well with this option. some Vaio models don't deal well with this option.
This option is available only if the kernel is This option is available only if the kernel is
compiled without ACPI support (since it conflicts compiled without ACPI support (since it conflicts
with it and it shouldn't be required anyway if with it and it shouldn't be required anyway if
ACPI is already enabled). ACPI is already enabled).
verbose: set to 1 to print unknown events received from the verbose: set to 1 to print unknown events received from the
sonypi device. sonypi device.
set to 2 to print all events received from the set to 2 to print all events received from the
sonypi device. sonypi device.
compat: uses some compatibility code for enabling the sonypi compat: uses some compatibility code for enabling the sonypi
...@@ -75,14 +77,15 @@ statically linked into the kernel). Those options are: ...@@ -75,14 +77,15 @@ statically linked into the kernel). Those options are:
add this option and report to the author. add this option and report to the author.
mask: event mask telling the driver what events will be mask: event mask telling the driver what events will be
reported to the user. This parameter is required for some reported to the user. This parameter is required for
Vaio models where the hardware reuses values used in some Vaio models where the hardware reuses values
other Vaio models (like the FX series who does not used in other Vaio models (like the FX series who does
have a jogdial but reuses the jogdial events for not have a jogdial but reuses the jogdial events for
programmable keys events). The default event mask is programmable keys events). The default event mask is
set to 0xffffffff, meaning that all possible events will be set to 0xffffffff, meaning that all possible events
tried. You can use the following bits to construct will be tried. You can use the following bits to
your own event mask (from drivers/char/sonypi.h): construct your own event mask (from
drivers/char/sonypi.h):
SONYPI_JOGGER_MASK 0x0001 SONYPI_JOGGER_MASK 0x0001
SONYPI_CAPTURE_MASK 0x0002 SONYPI_CAPTURE_MASK 0x0002
SONYPI_FNKEY_MASK 0x0004 SONYPI_FNKEY_MASK 0x0004
...@@ -97,10 +100,10 @@ statically linked into the kernel). Those options are: ...@@ -97,10 +100,10 @@ statically linked into the kernel). Those options are:
SONYPI_MEMORYSTICK_MASK 0x0800 SONYPI_MEMORYSTICK_MASK 0x0800
SONYPI_BATTERY_MASK 0x1000 SONYPI_BATTERY_MASK 0x1000
useinput: if set (which is the default) jogdial events are useinput: if set (which is the default) two input devices are
forwarded to the input subsystem as mouse wheel created, one which interprets the jogdial events as
events. mouse events, the other one which acts like a
keyboard reporting the pressing of the special keys.
Module use: Module use:
----------- -----------
...@@ -123,17 +126,17 @@ Bugs: ...@@ -123,17 +126,17 @@ Bugs:
external monitor on/off. There is no workaround yet, since this external monitor on/off. There is no workaround yet, since this
driver disables all APM management for those keys, by enabling the driver disables all APM management for those keys, by enabling the
ACPI management (and the ACPI core stuff is not complete yet). If ACPI management (and the ACPI core stuff is not complete yet). If
you have one of those laptops with working Fn keys and want to you have one of those laptops with working Fn keys and want to
continue to use them, don't use this driver. continue to use them, don't use this driver.
- some users reported that the laptop speed is lower (dhrystone - some users reported that the laptop speed is lower (dhrystone
tested) when using the driver with the fnkeyinit parameter. I cannot tested) when using the driver with the fnkeyinit parameter. I cannot
reproduce it on my laptop and not all users have this problem. reproduce it on my laptop and not all users have this problem.
This happens because the fnkeyinit parameter enables the ACPI This happens because the fnkeyinit parameter enables the ACPI
mode (but without additional ACPI control, like processor mode (but without additional ACPI control, like processor
speed handling etc). Use ACPI instead of APM if it works on your speed handling etc). Use ACPI instead of APM if it works on your
laptop. laptop.
- since all development was done by reverse engineering, there is - since all development was done by reverse engineering, there is
_absolutely no guarantee_ that this driver will not crash your _absolutely no guarantee_ that this driver will not crash your
laptop. Permanently. laptop. Permanently.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment