graphlcd-base/docs/DRIVER.ks0108
changeset 4 df6a40031aa5
equal deleted inserted replaced
3:d0e62fc47285 4:df6a40031aa5
       
     1 ---------------------------------------------------------------------
       
     2 GraphLCD driver library
       
     3 
       
     4 The KS0108 driver
       
     5 ---------------------------------------------------------------------
       
     6 
       
     7 Description
       
     8 -----------
       
     9 The KS0108 driver supports LC displays that use the Samsung KS0108
       
    10 controller, connected to the parallel port of your PC.
       
    11 
       
    12 
       
    13 Wirings
       
    14 -------
       
    15 The KS0108 driver supports the following connection on a parallel
       
    16 port:
       
    17 
       
    18   printerport   LCD          other
       
    19   -----------   ----------   ----------
       
    20   GND    (18)   GND   (01)   GND          (Ground)
       
    21                 Vdd   (02)   +5V
       
    22                 Vo    (03)                (LCD Contrast In)
       
    23   nSEL   (17)   R/S   (04)                (Register Select)
       
    24                 R/W   (05)   GND          (Read/Write)
       
    25   nSTRB  (01)   EN    (06)                (Enable)
       
    26   D0     (02)   D0    (07)                (DataBit0)
       
    27   D1     (03)   D1    (08)                (DataBit1)
       
    28   D2     (04)   D2    (09)                (DataBit2)
       
    29   D3     (05)   D3    (10)                (DataBit3)
       
    30   D4     (06)   D4    (11)                (DataBit4)
       
    31   D5     (07)   D5    (12)                (DataBit5)
       
    32   D6     (08)   D6    (13)                (DataBit6)
       
    33   D7     (09)   D7    (14)                (DataBit7)
       
    34   nAUTO  (14)   CS1   (15)                (ChipSelect Controller 1)
       
    35   INIT   (16)   CS2   (16)                (ChipSelect Controller 2)
       
    36                 RESET (17)   +5V          (Controller Reset)
       
    37                 Vout  (18)                (Contrast Out)
       
    38                 LED+  (19)   +4V          (Backlight)
       
    39                 LED-  (20)   GND          (Backlight GND)
       
    40 
       
    41 Note: The pin numbering may vary with other displays.
       
    42 
       
    43 If you want to connect a 192x64 or 256x64 display (with 3 or 4
       
    44 ChipSelects) or two 128x64 displays, you must add a binary decoder for
       
    45 the ChipSelect lines. The mode ist auto-selected based on the width and
       
    46 height parameters.
       
    47 
       
    48         nAUTO (14)
       
    49         |   INIT (16)
       
    50     Vdd |   |   GND GND
       
    51     |   |   |   |   |
       
    52     16  15  14  13  12  11  10  09
       
    53    --------------------------------
       
    54   |                                |
       
    55    >                               |
       
    56   |                                |
       
    57    --------------------------------
       
    58     01  02  03  04  05  06  07  08
       
    59     |   |   |   |               |
       
    60     CS1 |   |   |               GND
       
    61         CS2 |   CS4 (CS2 second LCD)
       
    62             CS3 (CS1 second LCD)
       
    63 
       
    64 
       
    65 Configuration Parameters
       
    66 ------------------------
       
    67 The KS0108 driver supports the following parameters in config file:
       
    68 
       
    69 Device
       
    70  Instead of using the direct output via port address (see Port), you
       
    71  can use the parport device (/dev/parportX). The advantage over the
       
    72  direct output via port address is that this works for non-root users
       
    73  also. But it's a little bit slower. The modules ppdev.o, parport.o
       
    74  and parport_pc.o must be loaded or compiled into the kernel.
       
    75 
       
    76 Port
       
    77  Sets the port address of the parallel port. If this parameter is not
       
    78  given, 0x378 is used. To use this direct output, the program that
       
    79  uses the driver library has to be started with user 'root'.
       
    80 
       
    81 Width
       
    82  Sets the horizontal size of the display. If this parameter is not
       
    83  given, a default value of 128 pixels is used.
       
    84 
       
    85 Height
       
    86  Sets the vertical size of the display. If this parameter is not
       
    87  given, a default value of 64 pixels is used.
       
    88 
       
    89 UpsideDown
       
    90  Rotates the display output by 180 degrees. This might be useful, if
       
    91  the LCD is mounted upside-down.
       
    92  Possible values: 'yes', 'no'
       
    93  Default value: 'no'
       
    94 
       
    95 Invert
       
    96  Inverts the display.
       
    97  Possible values: 'yes', 'no'
       
    98  Default value: 'no'
       
    99 
       
   100 AdjustTiming
       
   101  To get a timing that is as accurate as possible, the drivers measure
       
   102  the time for port commands (see: benchmark in syslog). You might
       
   103  decrease or increase the time to wait after port commands with this
       
   104  parameter. Normally, there is no need to change this parameter.
       
   105  Possible values: -50 <= x <= 50
       
   106  Default value: 0
       
   107 
       
   108 RefreshDisplay
       
   109  Normally, most of the drivers do not update the whole display, but
       
   110  only the areas that have changed since last update. So it might be,
       
   111  that some faulty pixels would stay a longer time. To avoid this, the
       
   112  plugin makes a complete refresh from time to time. This parameter
       
   113  defines how often a complete refresh will be done.
       
   114  e.g.: A value of 5 means, that the plugin will make a complete
       
   115        refresh on every 5th update.
       
   116  A value of 0 completely disables complete refreshs. 
       
   117  Possible values: 0 <= x <= 50
       
   118  Default value: 5
       
   119 
       
   120 Control
       
   121  Sets the variant of setting the display control lines.
       
   122  Possible values: 0, 1
       
   123  Default value: 1
       
   124