graphlcd-base/docs/DRIVER.ks0108
changeset 4 df6a40031aa5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/graphlcd-base/docs/DRIVER.ks0108	Wed Feb 06 17:32:55 2008 +0000
     1.3 @@ -0,0 +1,124 @@
     1.4 +---------------------------------------------------------------------
     1.5 +GraphLCD driver library
     1.6 +
     1.7 +The KS0108 driver
     1.8 +---------------------------------------------------------------------
     1.9 +
    1.10 +Description
    1.11 +-----------
    1.12 +The KS0108 driver supports LC displays that use the Samsung KS0108
    1.13 +controller, connected to the parallel port of your PC.
    1.14 +
    1.15 +
    1.16 +Wirings
    1.17 +-------
    1.18 +The KS0108 driver supports the following connection on a parallel
    1.19 +port:
    1.20 +
    1.21 +  printerport   LCD          other
    1.22 +  -----------   ----------   ----------
    1.23 +  GND    (18)   GND   (01)   GND          (Ground)
    1.24 +                Vdd   (02)   +5V
    1.25 +                Vo    (03)                (LCD Contrast In)
    1.26 +  nSEL   (17)   R/S   (04)                (Register Select)
    1.27 +                R/W   (05)   GND          (Read/Write)
    1.28 +  nSTRB  (01)   EN    (06)                (Enable)
    1.29 +  D0     (02)   D0    (07)                (DataBit0)
    1.30 +  D1     (03)   D1    (08)                (DataBit1)
    1.31 +  D2     (04)   D2    (09)                (DataBit2)
    1.32 +  D3     (05)   D3    (10)                (DataBit3)
    1.33 +  D4     (06)   D4    (11)                (DataBit4)
    1.34 +  D5     (07)   D5    (12)                (DataBit5)
    1.35 +  D6     (08)   D6    (13)                (DataBit6)
    1.36 +  D7     (09)   D7    (14)                (DataBit7)
    1.37 +  nAUTO  (14)   CS1   (15)                (ChipSelect Controller 1)
    1.38 +  INIT   (16)   CS2   (16)                (ChipSelect Controller 2)
    1.39 +                RESET (17)   +5V          (Controller Reset)
    1.40 +                Vout  (18)                (Contrast Out)
    1.41 +                LED+  (19)   +4V          (Backlight)
    1.42 +                LED-  (20)   GND          (Backlight GND)
    1.43 +
    1.44 +Note: The pin numbering may vary with other displays.
    1.45 +
    1.46 +If you want to connect a 192x64 or 256x64 display (with 3 or 4
    1.47 +ChipSelects) or two 128x64 displays, you must add a binary decoder for
    1.48 +the ChipSelect lines. The mode ist auto-selected based on the width and
    1.49 +height parameters.
    1.50 +
    1.51 +        nAUTO (14)
    1.52 +        |   INIT (16)
    1.53 +    Vdd |   |   GND GND
    1.54 +    |   |   |   |   |
    1.55 +    16  15  14  13  12  11  10  09
    1.56 +   --------------------------------
    1.57 +  |                                |
    1.58 +   >                               |
    1.59 +  |                                |
    1.60 +   --------------------------------
    1.61 +    01  02  03  04  05  06  07  08
    1.62 +    |   |   |   |               |
    1.63 +    CS1 |   |   |               GND
    1.64 +        CS2 |   CS4 (CS2 second LCD)
    1.65 +            CS3 (CS1 second LCD)
    1.66 +
    1.67 +
    1.68 +Configuration Parameters
    1.69 +------------------------
    1.70 +The KS0108 driver supports the following parameters in config file:
    1.71 +
    1.72 +Device
    1.73 + Instead of using the direct output via port address (see Port), you
    1.74 + can use the parport device (/dev/parportX). The advantage over the
    1.75 + direct output via port address is that this works for non-root users
    1.76 + also. But it's a little bit slower. The modules ppdev.o, parport.o
    1.77 + and parport_pc.o must be loaded or compiled into the kernel.
    1.78 +
    1.79 +Port
    1.80 + Sets the port address of the parallel port. If this parameter is not
    1.81 + given, 0x378 is used. To use this direct output, the program that
    1.82 + uses the driver library has to be started with user 'root'.
    1.83 +
    1.84 +Width
    1.85 + Sets the horizontal size of the display. If this parameter is not
    1.86 + given, a default value of 128 pixels is used.
    1.87 +
    1.88 +Height
    1.89 + Sets the vertical size of the display. If this parameter is not
    1.90 + given, a default value of 64 pixels is used.
    1.91 +
    1.92 +UpsideDown
    1.93 + Rotates the display output by 180 degrees. This might be useful, if
    1.94 + the LCD is mounted upside-down.
    1.95 + Possible values: 'yes', 'no'
    1.96 + Default value: 'no'
    1.97 +
    1.98 +Invert
    1.99 + Inverts the display.
   1.100 + Possible values: 'yes', 'no'
   1.101 + Default value: 'no'
   1.102 +
   1.103 +AdjustTiming
   1.104 + To get a timing that is as accurate as possible, the drivers measure
   1.105 + the time for port commands (see: benchmark in syslog). You might
   1.106 + decrease or increase the time to wait after port commands with this
   1.107 + parameter. Normally, there is no need to change this parameter.
   1.108 + Possible values: -50 <= x <= 50
   1.109 + Default value: 0
   1.110 +
   1.111 +RefreshDisplay
   1.112 + Normally, most of the drivers do not update the whole display, but
   1.113 + only the areas that have changed since last update. So it might be,
   1.114 + that some faulty pixels would stay a longer time. To avoid this, the
   1.115 + plugin makes a complete refresh from time to time. This parameter
   1.116 + defines how often a complete refresh will be done.
   1.117 + e.g.: A value of 5 means, that the plugin will make a complete
   1.118 +       refresh on every 5th update.
   1.119 + A value of 0 completely disables complete refreshs. 
   1.120 + Possible values: 0 <= x <= 50
   1.121 + Default value: 5
   1.122 +
   1.123 +Control
   1.124 + Sets the variant of setting the display control lines.
   1.125 + Possible values: 0, 1
   1.126 + Default value: 1
   1.127 +