
This package contains a driver for mode 2 of the Cherry keyboard G80-1501
on Linux 2.6.x. In mode 2 the keyboard sends the chipcard data encapsulated 
within ALT sequences.

This driver has been tested with Libchipcard2 and 3, but it should work with
any other software which uses the CTAPI interface.

The keyboard card reader only supports German Medical cards 
("Krankenversichertenkarte"), so only these kinds of cards can be used with
this driver.



Driver Build and System Setup
-----------------------------

Necessary steps:

1.) First you have to install the kernel sources for kernel 2.6.12 (or higher)
    Normally these are installed to /usr/src/linux. 
2.) enter the linux source directory and do a "make menuconfig" (this will
    start the kernel configuration tool, just quit it after it starts)
3.) do a "make modules" (this will build some kernel module scripts which are
    needed). You can stop this process by pressing CTRL-C as soon as a screen
    page is full (because at that point the scripts have been created)
4.) enter the driver source folder, do a "make" followed by a "make install"
    This should install the driver and the kernel module "cherry.ko" to the
    places where the system expects them

5.) After booting your system the driver module is in place.

6.) Now you must choose a major device number for the cherry device:
    For PCs it is safe to use "56" which is the default value.

7.) This major device number is used for the following command:
        mknod /dev/cherry c 56 3

8.) This number is also needed when loading the kernel module:
        modprobe cherry major=56
    If you omit the argument then "56" is used as a default.

    You can copy the file "doc/cherry" to /etc/modprobe.d in order to let
    the system load the cherry kernel module automatically on demand.


Now the driver libctapi-cherry.so is ready.


If the kernel module should be running wild (e.g. due to a bug) then the
key combination LEFT-SHIFT + LEFT-CTRL + RIGHT-SHIFT + RIGHT-CTRL + ESC 
stops the driver immediately. 
You will then have to unload and load the kernel module in order to reactivate
it.


Hamburg, Germany, 2006/09/24
Martin Preuss <martin@libchipcard.de>


