Analyze and document the t6963 driver:
* Add Doxygen comments (also for internal functions, shortened for API). * Document initialization. * Remove some unused variables and defines. * Pass through indent. * Remove references to LCD pins from documentation and add some warning.
This commit is contained in:
mmdolze
@@ -7,46 +7,90 @@ T6963 chipset from Toshiba. Usually, this chipset is used on big character LCD
|
||||
displays that can often act as a screen.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The driver uses the text mode of the chipset with a custom font loaded which
|
||||
resembles the characters from Code Page 437.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Only displays in 'Single Scan' configurations are supported. Displays configured
|
||||
as 'Dual Scan' are currently not supported. Those use onboard memory differently.
|
||||
Check the datasheet of your display!
|
||||
</para>
|
||||
|
||||
<sect2 id="t6963-connections">
|
||||
<title>Connections</title>
|
||||
|
||||
<warning>
|
||||
<para>
|
||||
Displays using T6963 chipset come in a variety of pin-outs and power configurations.
|
||||
They usually require negative voltage for contrast and some displays have
|
||||
a negative voltage generator onboard. Therefore the wiring table below does
|
||||
only list signal names, not LCD pins. Be sure to get the correct datasheet
|
||||
for your display and identify the pins to use!
|
||||
</para>
|
||||
<para>
|
||||
We do not give wiring examples for power, contrast, and other control lines.
|
||||
You have to figure out this from your display's datasheet!
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
<table id="t6963-connections.mapping">
|
||||
<title>T6963 wiring schematic</title>
|
||||
<tgroup cols="2">
|
||||
<tgroup cols="5" align="left">
|
||||
<colspec colname="lpt1"/>
|
||||
<colspec colname="lpt2" align="right"/>
|
||||
<colspec colname="base" align="center"/>
|
||||
<colspec colname="lcd1"/>
|
||||
<colspec colname="lcd2"/>
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Parallel port</entry>
|
||||
<entry>LCD</entry>
|
||||
<entry namest="lpt1" nameend="lpt2" align="center">Parallel port</entry>
|
||||
<entry morerows="1"><-></entry>
|
||||
<entry namest="lcd1" nameend="lcd2" align="center">LCD</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>name</entry>
|
||||
<entry>pin</entry>
|
||||
<entry>name</entry>
|
||||
<entry>pin</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>1 (Strobe)</entry>
|
||||
<entry>5 (WR)</entry>
|
||||
<entry>nSTRB</entry>
|
||||
<entry>1</entry>
|
||||
<entry></entry>
|
||||
<entry>/WR</entry>
|
||||
<entry>*</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>2-9 (Data)</entry>
|
||||
<entry>11-18 (Data)</entry>
|
||||
<entry>D0-D7</entry>
|
||||
<entry>2-9</entry>
|
||||
<entry></entry>
|
||||
<entry>DB0-DB7</entry>
|
||||
<entry>*</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>14 (Autofeed)</entry>
|
||||
<entry>7 (CE)</entry>
|
||||
<entry>nLF</entry>
|
||||
<entry>14</entry>
|
||||
<entry></entry>
|
||||
<entry>/CE</entry>
|
||||
<entry>*</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>16 (Init)</entry>
|
||||
<entry>8 (C/D)</entry>
|
||||
<entry>INIT</entry>
|
||||
<entry>16</entry>
|
||||
<entry></entry>
|
||||
<entry>C/D</entry>
|
||||
<entry>*</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>17 (Slct)</entry>
|
||||
<entry>6 (RD)</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>18 (GND)</entry>
|
||||
<entry>3 (GND)</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>+5V</entry>
|
||||
<entry>3 (LCD +)</entry>
|
||||
<entry>nSEL</entry>
|
||||
<entry>17</entry>
|
||||
<entry></entry>
|
||||
<entry>/RD</entry>
|
||||
<entry>*</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
@@ -100,18 +144,31 @@ can be done by specifying "--enable-drivers=all" or by
|
||||
<term>
|
||||
<property>ECPlpt</property> = ¶meters.yesdefno;
|
||||
</term>
|
||||
<listitem><para>
|
||||
<listitem>
|
||||
<para>
|
||||
Is ECP mode on? [default: <literal>yes</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
||||
</para></listitem>
|
||||
</para>
|
||||
<para>
|
||||
Despite its name, this driver does not use ECP mode of parallel port. This
|
||||
option turns bi-directional mode of the port on or off. Leave this on
|
||||
unless you experience problems.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<property>graphic</property> = ¶meters.yesnodef;
|
||||
</term>
|
||||
<listitem><para>
|
||||
<listitem>
|
||||
<para>
|
||||
Use graphic? [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
||||
</para></listitem>
|
||||
</para>
|
||||
<para>
|
||||
Enables / disables drawing of the content of the graphic RAM. This is
|
||||
currently a no-op as the driver does not make use of the graphic RAM.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
@@ -119,35 +176,4 @@ can be done by specifying "--enable-drivers=all" or by
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2 id="t6963-running">
|
||||
<title>Running</title>
|
||||
|
||||
<para>
|
||||
Modify the <filename>LCDd.conf</filename> file before you run LCDd. In this config file are
|
||||
detailed instructions on how to configure the T6963 driver.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Then as usual, start LCDd with the correct config file:
|
||||
</para>
|
||||
|
||||
<para>
|
||||
E.g. <command>LCDd -c ./LCDd.conf</command>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you want to override the driver selection in LCDd.conf then use:
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<command>LCDd -c ./LCDd.conf -d T6963</command>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you use this, the T6963 driver will read the options from the config
|
||||
file anyway.
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
</sect1>
|
||||
|
||||
Reference in New Issue
Block a user