]> Devoid-pointer.net GitWeb - omnibook.git/commitdiff
* Remove much of the included documentation
authorMathieu Bérard <mathieu.berard@crans.org>
Wed, 7 Feb 2007 13:16:43 +0000 (13:16 +0000)
committerMathieu Bérard <mathieu.berard@crans.org>
Wed, 7 Feb 2007 13:16:43 +0000 (13:16 +0000)
  The Project DokuWiki website is now the main source of
  informations regarding the module

doc/INSTALL [deleted file]
doc/README
doc/README-1st [deleted file]
doc/README-Hotkeys [deleted file]
doc/README-Windows-Driver [deleted file]
doc/TODO [deleted file]

diff --git a/doc/INSTALL b/doc/INSTALL
deleted file mode 100644 (file)
index 028127a..0000000
+++ /dev/null
@@ -1,52 +0,0 @@
-Installation instructions for omnibook module on kernel series 2.6
-==================================================================
-
- This file explains how to install omnibook module from its sources on 2.6
- series kernels.
-
-Step 1
-
-  You must have full configured source for the Linux kernel which you
-  want to use for the omnibook module. Note that omnibook module is part
-  of the kernel, so there is necessary to resolve all symbol dependencies
-  between the used kernel and omnibook code. Partly installed kernels
-  (for example from distributor makers) can be unuseable for this action.
-
-  You need GNU make and C compiler (gcc).
-  gcc version needs to be the same as the one the kernel was compiled with 
-  (eg. gcc-4.0 for gcc-4.0 compiled kernel).
-
-Step 2
-
-  Run `make install' as the super-user. This will install omnibook.ko kernel
-  module into modules directory of your currently running kernel
-  (usually in /lib/modules/version_of_your_kernel).
-  You may install and load the module with `make load' command. In this case
-  you may skip Step 3.
-
-Step 3
-
-   Load the installed module with `modprobe omnibook' command. It will
-   enables the OmniBook features on your machine.
-   To unload module issue an `modprobe -r omnibook' command. It will disable
-   the OmniBook features and unload the module.
-
-Step 4 (optional)
-
-   Add necessary module options to your /etc/modprobe.conf or in a file
-   in /etc/modporbe.d/. E.g.: "options omnibook apmemu=1 dock=1 user=1"
-
-Step 5 (optional)
-
-   Edit your startup scripts (eg. /etc/rc.local, /etc/rc.modules or /etc/modules) 
-   to load this module at boot time.
-
-How to integrate omnibook module to kernel sources?
----------------------------------------------------
-  
- Run in the directory where you previously extracted the omnibook module sources:
- `make kpatch KSRC="/patch/to/kernel/source"'
-
- Configure and compile your kernel as usual. If you use `make menuconfig', the 
- omnibook module config options are in 'Processor type and feature'.  
index 93d231aee801cb3679ffe8b8bd68d4ffae8b2e89..e8fb7cdfd97fb619c72059f8a4f0c81527f57929 100644 (file)
-Kernel Support for HP OmniBooks, Pavilions, Toshiba Satellites,
-                       and Compal laptops
+===============================================================
+Kernel Support for HP OmniBooks, Pavilions and Compal laptops
 ===============================================================
 
+This package is intended to provide Linux kernel support for many laptops such as:
+- HP OmniBook and Pavilion
+- Toshiba Satellite and Tecra which are not supported by the toshiba_acpi module
+- Compal ACL00
+- Many laptops manufactured by Compal Electronics, Inc as ODM
+
+Supported features depends on the exact laptop model but may include:
+- Enabling hotkey buttons
+- Console (LCD display) blanking
+- Battery status monitoring.
+- Fan and fan policy support
+- Touchpad control
+- AC Adapter status monitoring
+- External display monitors status monitoring and control
+- LCD brightness (backlight) monitoring and control
+- Docking station/port replicator status
+- CPU temperature monitoring
+- Mute LED monitoring and control
+- Wifi and Bluetooth adapters monitoring and control
+- Cooling method control
+- CPU Throttling control
+
+Useful links:
+
+Full documentation (HOWTO, Installation instructions, Supported laptops list... ):
+http://omnibook.sourceforge.net/doku.php?id=start
+
+Sourceforge project page:
+http://sourceforge.net/projects/omnibook
 
-This package intended to provide Linux kernel support for HP OmniBook
-and Pavilion machines. The state of this code is experimental but it
-wants to be a framework to extend the Linux support for HP OmniBook
-and Pavilion, Toshiba Satellite and Compal ACL00 laptops
-manufactured by Compal Electronics, Inc as ODM.
-
-How does it work?
------------------
-   Some features of supported laptops can be controlled via the keyboard control
-   and data registers. Commands and parameters were discovered by Pavel
-   Mihaylov.
-
-   Some other features available via /proc/omnibook/* provided by the
-   Embedded Controller or other I/O registers of your laptop. Information
-   comes from DSDT ACPI table of HP OmniBook XE3 GF disassembled by Ducrot
-   Bruno and others or discovered by me.
-
-   Note: You do not have to enable APM or ACPI to use this driver.
-
-   Most supported models seems to have same keyboard and embedded controller:
-   National Semiconductor PC87570 Keyboard and ACPI Embedded Controller or
-   compatible, but with different types of firmware.
-   See http://www.national.com/pf/PC/PC87570.html for more info.
-
-   It seems there is more types of firmware (only the tested models are
-   listed):
-    1. HP OmniBook XE3 GF
-       HP OmniBook XT1000
-       HP Pavilion ZT1141
-       HP Pavilion ZT1175
-       HP Pavilion ZT1195
-       Toshiba Satellite 1000
-       Toshiba Satellite 1005
-       Toshiba Satellite 1110
-       Toshiba Satellite 1115
-       Toshiba Satellite 1900
-       Toshiba Satellite 1905
-       Toshiba Satellite 1950
-       Toshiba Satellite 1955
-       Toshiba Satellite 3000
-       Toshiba Satellite 3005
-       Compal ACL00
-       Compal ACL10
-    2. HP OmniBook XE3 GC
-       HP OmniBook XE3 GD
-       HP OmniBook XE3 GE
-       HP Pavilion N5290
-       HP Pavilion N5415
-       HP Pavilion N5430
-       HP Pavilion N5441
-       HP Pavilion XH545
-    3. HP OmniBook 500
-       HP Pavilion ZU1155
-       HP Pavilion ZU1175
-    4. HP OmniBook 510
-    5. HP OmniBook 6000
-    6. HP OmniBook 6100
-    7. HP OmniBook xe4100
-       HP OmniBook xe4400
-       HP OmniBook xe4500
-       HP OmniBook vt6200
-       HP OmniBook xt6200
-       HP Pavilion xt155
-       HP Pavilion ze4125
-       HP/Compaq nx9000
-       HP/Compaq nx9010
-    8. HP OmniBook 4150
-       HP OmniBook 900B
-    9. HP OmniBook XE2
-   10. Fujitsu-Siemens Amilo D (CY23)
-   11. Toshiba Satellite P10
-       Toshiba Satellite P15
-       Toshiba Satellite P20
-   12. Toshiba Satellite M30X
-       Toshiba Satellite M35X
-       Toshiba Satellite M40X
-       Toshiba Satellite M70
-       Toshiba Satellite M100
-       Toshiba Tecra S2
-   13. Toshiba Satellite M40
-       Toshiba Satellite M45
-       Toshiba Tecra S1
-   14. Toshiba Satellite A105
-   
-   If your model is not listed above you may try to load the module. If it
-   have same DMI identification strings as a supported machine it may works
-   out of the box. Please report it.
-   Only the /proc/omnibook/dmi and /proc/omnibook/version are working when
-   you load the module on an unsupported machine.
-   In this case you may load the module with ectype parameter to force using
-   a certain EC firmware type or see how became you machine supported at the
-   end of this document.
-
-What are the provided features?
--------------------------------
- 1. Enabling hotkey buttons. See README-Hotkeys for details.
-    You may enable or disable it via /proc/omnibook/hotkeys.
-    There is a power management handler for reenabling the buttons at resume
-    if they were enabled previously.
-
- 2. Console (LCD display) blanking if APM does not do it (e.g. using ACPI).
-    It turns off the backlight of LCD display for more intensive power
-    saving when your console is idle.
-    You may enable or disable it via /proc/omnibook/blank.
-
- 3. Battery status monitoring via /proc/omnibook/battery.
-
- 4. Fan and fan policy support via /proc/omnibook/fan and
-    /proc/omnibook/fan_policy.
-
- 5. You may enable or disable touchpad via /proc/omnibook/touchpad.
-    There is a power management handler for redisabling the touchpad
-    at resume if it was disabled previously.
-
- 6. Emulate /proc/apm battery status monitoring. On the HP OmniBook XE3 GF the
-    APM subsystem unable to monitor the battery but there are many status
-    monitoring application using /proc/apm to get info.
-    Note: this is working only if you have AC adapter and battery status
-    monitoring enabled (see ac and battery module parameters).
-
- 7. AC Adapter status monitoring via /proc/omnibook/ac.
-
- 8. Display status monitoring /proc/omnibook/display.
-
- 9. LCD brightness setting and monitoring via /proc/omnibook/lcd.
-
-10. Docking station/port replicator support via /proc/omnibook/dock.
-
-11. Wifi and Bluetooth adapters monitoring and control via
-    /proc/omnibook/bluetooth and /proc/omnibook/wifi
-
-How to use?
------------
- 1. The hotkeys are enabled by default by this module.
-    To disable it use the command:
-
-       $ echo off > /proc/omnibook/hotkeys
-
-    The command
-
-       $ echo on > /proc/omnibook/hotkeys
-
-    enables hotkeys buttons.
-    
-    Reading to that same file allow you to read the state of the hotkeys:
-
-       $ cat /proc/omnibook/hotkeys
-       Multimedia hotkeys are enabled.
-       Fn hotkeys are enabled.
-
-    The items displayed depends on your laptop model.
-    Some Toshiba models support advanced hotkeys control. Alternatively to and
-    on/off command you can fine-tune the behavior of your keyboard's hotkeys
-    writing an hexadecimal number to the hotkeys files.
-    To enable a specific hotkeys feature, add its code to this hexadecimal
-    number. The feature/code table follow:
-
-       Onetouch buttons:               0x1
-       Multimedia hotkeys are:         0x2
-       Fn hotkeys are:                 0x4
-       Stick key is:                   0x8
-       Press Fn twice to lock:         0x10
-       Dock events:                    0x20
-       Fn + F5 hotkey:                 0x40
-
-    That is to enable multimedia hotkeys only do: 
-       $echo 0x2 > /proc/omnibook/hotkeys
-    To enable Fn hotkeys and Dock events only do:
-       $echo 0x24 > /proc/omnibook/hotkeys     (as 0x24 = 0x4 + 0x20)
-
-    Finally 'off' is equivalent to 0x0, and 'on' to 0x67 that is
-    Onetouch, Multimedia, Fn, Dock and Fn+F5.
-
-    Unsupported features won't be displayed in /proc/omnibook/hotkeys and writing
-    their corresponding codes won't have any effect.
-
- 2. Console (LCD display) blanking is enabled by this module on machines that
-    support it. It only enabled if another blanking solution
-    (e.g. CONFIG_APM_DISPLAY_BLANK) is not used.
-    To disable this behavior use command:
-
-       $ echo 0 > /proc/omnibook/blank
-
-    To enable this behavior use command:
-
-       $ echo 1 > /proc/omnibook/blank
-
- 3. To see the battery status use
-
-       $ cat /proc/omnibook/battery
-
-    It produce similar output to that you can see below.
-
-       Battery:                      0
-       Type:                    Li-Ion
-       Serial Number:            20722
-       Present Voltage:          12668 mV
-       Design Voltage:           11100 mV
-       Remaining Capacity:        4859 mAh
-       Last Full Capacity:        4933 mAh
-       Design Capacity:           5400 mAh
-       Gauge:                       98 %
-       Status:                charging
-
-    On some models (e.g. HP OmniBook XE3 GF) /proc/apm does not work, even
-    apm is enabled, but via this file you can monitor your battery
-    independently from apm code.
-
-    ACPI driver might reports some bad value about battery:
-
-       $ cat /proc/acpi/battery/BAT1/info
-       present:                 yes
-       design capacity:         5400 mAh
-       last full capacity:      5400 mAh
-       battery technology:      rechargeable
-       design voltage:          8191 mV
-       design capacity warning: 540 mAh
-       design capacity low:     162 mAh
-       capacity granularity 1:  264 mAh
-       capacity granularity 2:  3780 mAh
-       model number:            LIP9071
-       serial number:
-       battery type:            LiON
-       OEM info:                HP
-
-       This is because the methods used for batteries in the DSDT do
-       not give correct information. If you want to fix it you may
-       have to change methods in the DSDT.
-       See http://www.intel.com/technology/iapc/acpi/bios_override.htm
-       for details.
-       ACPI support for battery should be good on recent laptops.
-
- 4. The /proc/omnibook/fan file provides information about fan status:
-
-       $ cat /proc/omnibook/fan
-       Fan is off
-
-    or
-
-       $ cat /proc/omnibook/fan
-       Fan is on
-
-    On certain machines you may turn on the fan by
-
-       $ echo 1 > /proc/omnibook/fan
-
-    command and turn off by issuing
-
-       $ echo 0 > /proc/omnibook/fan
-
-    command.
-
-    Note: On XE3 GF style machines direct fan control works only if the CPU
-          temperature is between fan on and fan off temperature (see below).
-
-    The /proc/omnibook/fan_policy file provides information about fan control 
-    policy of your machine. Currently it is available on XE3 GF style models
-    because ot these machines have easily available hardware fan policy
-    support. On other machines fan policy can be available via ACPI. To see
-    the fan policy settings see the file /proc/omnibook/fan_policy:
-
-       $ cat /proc/omnibook/fan_policy
-       Fan off temperature:        60 C
-       Fan on temperature:         75 C
-       Fan level 2 temperature:    85 C
-       Fan level 3 temperature:    90 C
-       Fan level 4 temperature:    95 C
-       Fan level 5 temperature:    95 C
-       Fan level 6 temperature:    95 C
-       Fan level 7 temperature:    95 C
-       Minimal temperature to set: 25 C
-       Maximal temperature to set: 95 C
-
-    The important values:
-
-    Fan off temperature:        If fan is cooling the CPU and reaches this
-                                temperature it will be switched off.
-    Fan on temperature:         If fan is off and the CPU temperature
-                                reaches this value the fan turns on.
-    Fan level n temperature:    Fan will be run at level n when CPU
-                                temperature reaches this value. These are
-                                informational values only expect the 7th
-                                level. When CPU temperature reaches the 7th
-                                value, the laptop (at least mine) turns off
-                                so use it carefully.
-
-    To set the fan policy write the proper values into the
-    /proc/omnibook/fan_policy file. Each value must be greater than or
-    equal to the previous one. You do not have to write all values.
-    For example you may set fan off temperature to 60 C, fan on temperature
-    to 70 C and fan level 2 temperature to 80 C by
-
-       $ echo 60 70 80 > /proc/omnibook/fan_policy
-
-    command.
-    A zero value (echo 0 > /proc/omnibook/fan_policy) sets the default
-    values (60 75 85 90 95 95 95 95) of omnibook module.
-
-    Note: These default values are not the hardware defaults. You may get
-          hardware defaults after resetting your machine (removing both
-          AC power and battery).
-
-    Note: If you prefer the direct fan control on XE3 GF style machines
-          set the fan off temperature low and fan on temperature high and
-          use /proc/omnibook/fan to control the fan directly.
-          Warning: You may overheat your CPU.
-
- 5. The touchpad is enabled by default by the BIOS.
-    To disable it use the command:
-
-       $ echo 0 > /proc/omnibook/touchpad
-
-    The command
-
-       $ echo 1 > /proc/omnibook/touchpad
-
-    enables the touchpad.
-
- 6. The /proc/apm emulation is disabled by default on all machines. You have
-    to enable it explicit using the module parameter apmemu. To enable it use:
-
-       $ insmod omnibook apmemu=1
-
-    You can enable it by /etc/modules.conf with the following entry:
-
-       $ options omnibook apmemu=1
-
-    If your kernel have APM support, but the /proc/apm reports buggy values,
-    you may boot your kernel without apm support, and try to load omnibook
-    module with APM emulation.
-
-    Note: This works only if battery and AC adapter monitoring is supported
-          on you machine.
-
- 7. To see the AC adapter status use
-
-       $ cat /proc/omnibook/ac
-
-    command. It produce similar output to that you can see below.
-
-       $ cat /proc/omnibook/ac
-       AC on-line
-
-    Or if you are on battery power:
-
-       $ cat /proc/omnibook/ac
-       AC off-line
-
- 8. To see the display status use
-
-       $ cat /proc/omnibook/display
-
-    The displayed output depends on your laptop model, as an example:
-
-       $ cat /proc/omnibook/display
-       Internal LCD: display present port enabled
-       External VGA: display absent port disabled
-       External TV-OUT: display absent port disabled
-
-    If you are adventuresome, and if your laptop model support it,
-    you can try to enable or disable a specific display port.
-    To do that, write an hexadecimal number to the display file, adding the
-    code of display ports you want to enable, the others will be disabled:
-
-       Internal LCD panel:     0x1
-       External VGA port:      0x2
-       External TV port:       0x4
-
-    For example to enable the LCD panel and the TV-OUT port only, you have to
-    write 0x1 + 0x4 = 0x5:
-
-       $ echo 0x5 > /proc/omnibook/display
-
-    It may or may not work, or even crash your X server. Proceed with caution.
-
- 9. To see the LCD brightness use
-
-       $ cat /proc/omnibook/lcd
-
-    It produce similar output to that you can see below.
-
-       $ cat /proc/omnibook/lcd
-       LCD brightness:  5 (max value: 7)
-
-    To set it use similar command to that you can see below:
-
-       $ echo 1 > /proc/omnibook/lcd
-
-    The value of LCD brightness must be between 0 and the printed max boundary,
-    here you can see it's 7.
-
-    Bug:  Setting the LCD brightness on HP OmniBook XE3 GF via
-          /proc/omnibook/lcd is working if you press one of the
-          brightness control keys once after writing the value
-          into /proc/omnibook/lcd.
-
-    To turn off the LCD backlight use
-
-       $ echo off > /proc/omnibook/lcd
-
-    To turn it back on use
-
-       $ echo on > /proc/omnibook/lcd
-
-    This is useful if you have an X server, such as the ATI Radeon,
-    that does not know how to turn off the LCD backlight.  Use a
-    long-running perl script which monitors xscreensaver activity
-    such as the one below:
-
-       open(XS,"/usr/X11R6/bin/xscreensaver-command -watch|") or die;
-       while(<XS>) {
-          if(/^BLANK/i) {
-             system("echo off > /proc/omnibook/lcd");
-          } elsif(/^UNBLANK/i) {
-             system("echo on > /proc/omnibook/lcd");
-          }
-       }
-
-       Note: You have to enable users to set values in /proc/omnibook
-              (See the user parameter below).
-
-10. To check that your laptop is docked in a docking station or port
-    replicator use
-
-       $ cat /proc/omnibook/dock
-
-    command. It produce similar output to that you can see below.
-
-       $ cat /proc/omnibook/dock
-       Laptop is undocked
-
-    or
-
-       $ cat /proc/omnibook/dock
-       Laptop is docked
-
-    Note: docking station support is disabled by default on all machines.
-    You have to enable it explicit way by module parameter dock. To enable
-    it use:
-
-        $ insmod omnibook dock=1
-
-    You can enable it by /etc/modules.conf with the following entry:
-
-       options omnibook dock=1
-
-11. To read wifi and bluetooth adapters status reading the 
-    /proc/omnibook/wifi and /proc/omnibook/bluetooth files respectively:
-
-       $ cat /proc/omnibook/wifi
-       Wifi adapter is present and enabled.
-       Wifi Kill switch is on.
-
-       $ cat /proc/omnibook/bluetooth
-       Bluetooth adapter is absent.
-    
-    You can enable or disable a dectected adapters writing 1 or 0 respectibely
-    to the corresponding file: 
-
-       $ echo 0 >  /proc/omnibook/wifi
-       [ Wifi led shut down, connectivity is lost ]
-
-       $ cat /proc/omnibook/wifi
-       Wifi adapter is present and disabled.
-       Wifi Kill switch is on.
-
-
-You may enable features above via the proper module parameters. See the 
-output of
-
-       $ modinfo omnibook
-
-command.
-
-Usually you have to be root to change anything via files in /proc/omnibook.
-If you want to do it as ordinary user, and you trust the other (e.g.
-networked) users or you are the only user of the laptop you may load the
-module with the parameter user to enable non-root accounts to set omnibook
-paremeters as follows:
-
-       $ insmod omnibook user=1
-
-You can enable users to set parameters by /etc/modules.conf with the
-following entry:
-
-       $ options omnibook user=1
-
-Graphical frontends
--------------------
-There are at least four graphical frontends for omnibook kernel module:
-
-1. wmtemp from Ducrot Bruno <ducrot@poupinou.org> is a WindowMaker dockapp
-   to monitor the CPU temperature and control the fan. It is available from
-   http://sf.net/projects/omke.
-2. komnibook from Guilherme Fortunato <guilherme@linksat.com.br> is a KDE
-   frontend that would stay in the tray and display/set status information
-   of the laptop. It is available from http://sf.net/projects/omke.
-3. HAL and gnome-power-manager. HAL understand the LCD brightness level exported
-   in the /proc/omnibook/lcd file. gnome-power-manager uses HAL as its backend,
-   See http://hal.freedesktop.org/wiki/Software_2fhal and 
-   http://www.gnome.org/projects/gnome-power-manager
-   Many thanks to Richard Hughes for the HAL patch that add omnibook support.
-4. KToshiba from Azael Avalos <coproscefalo@gmail.com> is another KDE frontend
-   See http://ktoshiba.sourceforge.net/index.html and the list of supported
-   features http://ktoshiba.sourceforge.net/feats.html 
-
-How can your laptop be supported?
----------------------------------
-If your model is unsupported and you want it to be supported I need four
-things:
-
-1. Force the module to load with an embedded controller firmware type
-   detailed above. For example if you want to test that your machine
-   is an XE3GF style model, use the following command:
-
-       insmod omnibook ectype=1
-
-   then test the features are working properly, and send me the result.
-
-   Warning!!! Forced load on an unsupported machine may cause
-   unpredictable result. You have been warned...
-
-2. Send me DMI strings of your machine (/proc/omnibook/dmi after
-   loading omnibook module on any machine).
-
-3. If possible send me the DSDT of your machine. If your kernel is 
-   configured for ACPI you can found it at /proc/acpi/dsdt. Use the
-   following command to get the DSDT AML file.
-
-       cat /proc/acpi/dsdt > my_model_name.aml
-
-   If your kernel does not support ACPI you can get DSDT by pmtools
-   can be found on Intel's developer site at
-   http://www.intel.com/technology/IAPC/acpi/downloads.htm.
-   Compile it and issue command similar to below to create the DSDT AML
-   file.
-
-       acpidmp DSDT > my_model_name.aml
-
-   Please send me the AML file. Note: it is binary file.
-
-4. Developers or advanced users who want to help the development of this driver
-   can enable an experimental features of the omnibook kernel module:
-   /proc/omnibook/dump, which dump the content of the embedded 
-   controller memory.
-
-   It have to be manually enabled using the dump=1 kernel module parameters 
-   and can be used in conjunction with a careful examination 
-   of a decompiled DSDT to spot where your laptop stores interesting information
-   such as FAN speed or CPU temperature.
-
-This code was written without any documentation from HP or Compal so it
-is provided as is without any warranty.
-
-Contributions, bug reports and text corrections are welcome.
-
-If you experience any problems after using this module try to reboot your
-computer. If it does not help (eg. the laptop reboots in edless loop) turn
-off the machine and remove the battery and the AC power cord for some
-minutes. It it does not help too, remove the battery, plug in the AC power
-cord, turn on the machine and unplug the AC power cord. It will reset your
-laptop.
-
-Unfortunately the official HP technical support refusing to share any
-information with similar messages (in 2002):
-
-> Thank you for contacting Hewlett Packard laptop email support.
-> 
-> I'm sorry, but I won't be able to help you with that. HP does not
-> recommend or support the installation of any version of Linux on any of
-> our notebook products.
-
-Compal Electronics, Inc. does not response to information requests at all.
-
-Meanwhile (in 2002) Compaq and HP merged and as I know Compaq will the
-supplier of the new laptop models in the merged company.
-
-Some new models of Toshiba Satellite notebooks (M70 and M40X) seems to
-be made by Compal.
-
-The NbSmi backend code which implement support for some Toshiba Satellite
-was made using technical documentation provided by Toshiba.
-This code is contained in the nbsmi.c file
-Thanks Toshiba for this Linux-friendly behavior.
-This technical documentation was provided with the following disclaimer:
-
------ Disclaimer Verbatim copy Begin -----
- PLEASE READ THIS INTELLECTUAL PROPERTY DISCLAIMER CAREFULLY BEFORE 
-USING THE TOSHIBA TECHNICAL INFORMATION AS ATTACHED.
-    BY USING THE TOSHIBA TECHNICAL INFORMATION, YOU ARE AGREEING TO BE 
-BOUND BY ALL OF THE TERMS OF THIS INTELLECTUAL PROPERTY DISCLAIMER.
-    IF YOU DO NOT AGREE TO THE TERMS OF THIS INTELLECTUAL PROPERTY 
-DISCLAIMER, PROMPTLY RETURN THE ATTACHED TOSHIBA TECHNICAL INFORMATION.
-
-                 Copyright (C) 1999, Toshiba Corp. All rights reserved.
-
-
-                    INTELLECTUAL PROPERTY DISCLAIMER
-
-    NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, OF ANY 
-INTELLECTUAL PROPERTY RIGHTS OF TOSHIBA IS GRANTED OR INTENDED HEREBY.  
-NOTWITHSTANDING FORGOING, TOSHIBA WILL NOT MAKE ANY CLAIM BASED ON THE 
-INTELLECTUAL PROPERTY RIGHTS AGAINST SOFTWARE FOR LINUX DEVELOPED USING 
-TOSHIBA TECHNICAL INFORMATION, PROVIDED THAT SUCH SOFTWARE IS USED FOR 
-OR DISTRIBUTED WITH LINUX FOR EXECUTION ON TOSHIABA COMPUTER PRODUCTS.
-
-    TOSHIBA DISCLAIMS ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT 
-OF PROPRIETARY RIGHTS RELATING TO IMPLEMENTATION OF TOSHIBA TECHNICAL 
-INFORMATION.  TOSHIBA DOES NOT WARRANT OR REPRESENT THAT SUCH 
-IMPLEMENTATION(S) WILL NOT INFRINGE SUCH RIGHTS.
-
-    TOSHIBA TECHNICAL INFORMATION IS PROVIDED "AS IS" WITH NO WARRNTIES 
-WHATSOEVER INCLUDING ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR ANY 
-PARTICULAR PURPOSE.
----- Disclaimer End ----
+Other links not related to the project:
 
-For more information you can see the OmniBook mailing list at
+For HP Omnibook specific issues ou can see the OmniBook mailing list:
 http://zurich.ai.mit.edu/mailman/listinfo/omnibook
 
-or the Toshiba linux mailing list at 
+or the Toshiba linux mailing list:
 http://linux.toshiba-dme.co.jp/linux/
 
-You can find actual version of this code at
-http://sourceforge.net/projects/omnibook
diff --git a/doc/README-1st b/doc/README-1st
deleted file mode 100644 (file)
index bf215cd..0000000
+++ /dev/null
@@ -1,17 +0,0 @@
-This package intended to provide Linux kernel support for HP OmniBook,
-HP Pavilion, Toshiba Satellite and Compal laptops.
-The state of this code is experimental.
-
-This code was written using technical documentation provided by Toshiba about
-some Toshiba Satellites (M40 ...) and Toshiba Tecra. 
-This code was written without any documentation about other laptop models.
-
-It is provided as is without any warranty. Use it on your own risk.
-
-The code in the files in the omnibook distribution is licensed for use
-under the terms of GNU General Public License, included as the file
-named COPYING.
-
-For installation instructions please read the file named INSTALL.
-For usage informations and/or bug reports you may read file named README.
-For current bugs and problems see file named BUGS.
diff --git a/doc/README-Hotkeys b/doc/README-Hotkeys
deleted file mode 100644 (file)
index 0371390..0000000
+++ /dev/null
@@ -1,199 +0,0 @@
-Kernel Support for Special hotkey buttons
-=========================================
-
-Some laptops have special multimedia keys, their branding name varies
-on laptop manufacturer (OneTouch for HP omnibook, one can also encounter the
-names E-Keys, EasyAcess, you name it).
-They may be disabled by default and need to be enabled.
-
-This module try to detect your laptop model and enable those hotkey buttons
-to generate scancodes.
-Look in syslog messages for "keyboard: unknown scancode e0 xx" messages to
-identify the scancode assigned to button. Use setkeycodes from console-tools
-package to assign keycodes to them.
-
-The scancodes are different on different models:
-
-HP OmniBook XE3 GC, GD, GE and HP Pavilion N5xxx
-------------------------------------------------
-
-WWW button:                    e073
-Mail button:                   e074
-Presentation button:           e072
-Help button:                   e071
-
-Previous Track button:         e010
-Play / Pause button:           e022
-Stop / Eject button:           e024
-Next Track button:             e019
-
-
-HP OmniBook XE3 GF
-------------------
-
-WWW button:                     e032
-Mail button:                    e06c
-Presentation button:            e074
-Help button:                    e073
-
-Previous Track button:          e010
-Play / Pause button:            e022
-Stop / Eject button:            e024
-Next Track button:              e019
-
-Volume down (& Fn-Down arrow): e02e
-Volume up (& Fn-Up arrow):     e030
-Mute / Unmute (Fn-F7):          e020
-
-
-HP OmniBook xe4xxx and ze4xxx
------------------------------
-
-Mail button:                    e06c
-Presentation button:            e073
-WWW button:                     e032
-Lock button:                    e071
-Help button:                    e070
-
-Volume down button:             e02e
-Volume up button:               e030
-Mute / Unmute button:           e020
-
-
-HP OmniBook xt155
------------------
-
-Mail button:                    e06c
-Presentation button:            e073
-WWW button:                     e032
-Lock button:                    e071
-Help button:                    e070
-
-
-HP OmniBook XT1000 and ZT11xx
------------------------------
-
-Mail button:                    e06c
-Presentation button:            e074
-WWW button:                     e032
-Lock button:                    e073
-Help button:                    e072
-
-MP3 button:                     e071
-Previous Track button:          e010
-Play / Pause button:            e022
-Stop / Eject button:            e024
-Next Track button:              e019
-
-Volume down button:             e02e
-Volume up button:               e030
-Mute / Unmute button:           e020
-
-
-HP OmniBook 5xx
----------------
-
-Presentation button:           e074
-Help button:                   e073
-
-Previous Track button:          e010 (*)
-Play / Pause button:            e022 (*)
-Stop / Eject button:            e024 (*)
-Next Track button:              e019 (*)
-
-Volume down button:             e02e (*)
-Volume up button:               e030 (*)
-
-(*) On the docking station
-
-
-Toshiba Satellite 3000-100
---------------------------
-
-WWW button:                    e071
-Mail button:                   e073
-
-DVD button:                    e006
-CD button:                     e013
-
-Stop / Eject button:           e024
-Previous Track button:         e010
-Next Track button:             e019
-Play / Pause button:           e022
-
-Volume up button:              e075
-Volume down button:            e076
-
-
-HP/Compaq nx9000
-----------------
-
-Mail button:                    e06c
-Search button:                  e073
-Information button:             e032
-Lock button:                    e071
-Help button:                    e070
-
-Volume down button:             e02e
-Volume up button:               e030
-Mute / Unmute button:           e020
-
-
-Fujitsu-Siemens Amilo D
------------------------
-
-User 1 / Stop / Eject button:   e071
-User 1 / Play / Pause button:   e072
-Email / Previous Track button:  e074
-WWW / Next Track button:        e073
-
-Volume up button:               e075
-Volume down button:             e076
-
-
-Toshiba Satellite M70 or M40X
------------------------------
-
-Lock (Fn + F1)                 e06e
-Light Bubble (Fn + F2)         e062
-Suspend (Fn + F3)              e017
-Hibernate (Fn + F4)            e018
-Toggle Display (Fn + F5)       e041
-Brightness Down (Fn + F6)      e06f
-Brightness Up (Fn + F7)                e059
-Toggle Wifi (Fn + F8)          e016
-Touchpad On/Off (Fn + F9)      e01e/e01f
-Zoom - (Fn + 1)                        e01a
-Zoom + (Fn + 2)                        e01b
-Zoom (Fn + Space)              e043
-Internet                       e013
-Media Player                   e014
-Play/Pause                     e077
-Stop                           e012
-Next                           e039
-Prev                           e074
-Wifi Kill Switch               e015
-
-
-There are programs specifically designed for such application keys as 
-gnome-keybinding-properties for Gnome Desktop.
-
-HP omnibook XE3L machines are same as XE3 models but they have application 
-launcher buttons only but do not have multimedia (CD and volume control) buttons.
-
-The extra buttons near the touchpad are not OneTouch buttons. You need
-driver for touchpad to use them. If you have Synaptics touchpad you may
-try the driver can be found at http://web.telia.com/~u89404340/touchpad/
-
-The ("Big Blue") Sleep button also not a OneTouch button, it usually
-handled by APM or ACPI stuff depending on your BIOS implementation.
-
-Unfortunately the volume control buttons on XE3GC and OB5xx style models are
-implemented in different way and do not generates scancodes.
-
-The volume control buttons on the right side of OB5xx and OB6xxxx wired into
-the sound chip. The newer ALSA driver for maestro3 sound chip contains
-support for these buttons.
-
-The volume control buttons on the docking station of OB500 are real OneTouch
-buttons (see above).
diff --git a/doc/README-Windows-Driver b/doc/README-Windows-Driver
deleted file mode 100644 (file)
index 2dc31e3..0000000
+++ /dev/null
@@ -1,10 +0,0 @@
-hp's onetouch windows utility
------------------------------
-
-When installing hp's onetouch utility in Windows, you can find a ONETOUCH.CFG 
-file in the installation folder which seems to contain EC Controller commands 
-for some special features of the embedded controller (like mute led, etc..).
-
-It looks like the Windows DLL that sends commands to the EC controller is 
-LgKCUtl.DLL, also found in the onetouch installation folder. Maybe this is 
-useful to somebody someday :)
diff --git a/doc/TODO b/doc/TODO
deleted file mode 100644 (file)
index b9fefb8..0000000
--- a/doc/TODO
+++ /dev/null
@@ -1,21 +0,0 @@
-TODO
-====
-
-Current issues:
-
-* See if/how key polling can be ported to 2.6
-* LED API support
-* Create a clean access method to the i8042 kbd controller (this will require
-  a kernel patch)
-* To be cleaned: battery dump fan_policy
-
-Old items imported from previous version:
-
-* Fix LCD brighness handling on XE3GF style machines
-* Fully support OB5xx, OB6xxx and XE4500 style machines
-* Battery support for OB5xx, OB6xxx and XE4500 style machines
-
-Will probably remain here forever:
-
-* Adding more features of embedded controller
-* Support more machines