#
# $Id: README.Drivers,v 1.4 2001/03/09 13:08:11 ltoetsch Exp $
#

How to write new display drivers for lcd4linux

If you plan to write a new display driver for lcd4linux, you should follow
this guidelines:

* use Skeleton.c as a start point.
  You might also have a look at Text.c

* create a new sourcefile <drivername>.c and add it to the bottom of
  Makefile.am

* add an entry to configure.in

* there's no need for a <drivername>.h

* create one (or more) unique display names (your driver will be selected by
  this name in the 'Display'-line of lcd4linux.conf).

* include "display.h" in your driver, to get the LCD structure and various 
  BAR_ definitions

* include "cfg.h" if you need to access settings in the config file.

* create a LCD table at the bottom of your driver, and fill it with the
  appropriate values. Take care that you specify the correct bar capabilities
  of your display or driver:

  BAR_L:  horizontal bars headed left
  BAR_R:  horizontal bars headed right
  BAR_H2: driver supports horizontal dual-bars
  BAR_U:  vertical bars bottom-up
  BAR_D:  vertical bars top-down
  BAR_V2: driver supports vertical dual-bars

* edit display.c and create a reference to your LCD table:

     external LCD YourDriver[];

* extend the FAMILY table in display.c with your driver:

     FAMILY Driver[] = {
       { "Skeleton",      Skeleton },
       { "MatrixOrbital", MatrixOrbital },
       { "YourFamily",    YourDriver },
       { "" }
     };

* write the correspondig init(), clear(), put(), bar(), quit() and
  flush()-functions. There's no need to use a framebuffer and display its
  contents with the flush()- call (as in MatrixOrbital.c), you can directly
  write to the display in the put()- and bar()-functions, and use an empty
  flush()-function. But if you have a limited number of user-defined
  characters, and therefore you have to do some sort of 'character reduction'
  or similar stuff, you will have to use a framebuffer and the flush()-call. 
alue=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/lcd4linux.git/log/?id=c7f5ce26a88f2a5c2794e675809a643de0ba08d3&amp;follow=1'>root</a>/<a href='/lcd4linux.git/log/debug.c?id=c7f5ce26a88f2a5c2794e675809a643de0ba08d3&amp;follow=1'>debug.c</a> (<a href='/lcd4linux.git/log/debug.c?id=c7f5ce26a88f2a5c2794e675809a643de0ba08d3'>unfollow</a>)</div><div class='content'><table class='list nowrap'><tr class='nohover'><th class='left'>Age</th><th class='left'>Commit message (<a href='/lcd4linux.git/log/debug.c?id=c7f5ce26a88f2a5c2794e675809a643de0ba08d3&amp;showmsg=1&amp;follow=1'>Expand</a>)</th><th class='left'>Author</th><th class='left'>Files</th><th class='left'>Lines</th></tr>
<tr><td><span title='2002-08-30 03:54:01 +0000'>2002-08-30</span></td><td><a href='/lcd4linux.git/commit/Text.c?id=63570aa624fabbfabfefef50d6dc1e6e6cf7a822&amp;follow=1'>[lcd4linux @ 2002-08-30 03:54:01 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+8</span></td></tr>
<tr><td><span title='2002-08-22 05:51:36 +0000'>2002-08-22</span></td><td><a href='/lcd4linux.git/commit/BeckmannEgle.c?id=9efcb33edc0a46ef1d274c3f9ce506d514ee440c&amp;follow=1'>[lcd4linux @ 2002-08-22 05:51:36 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-7</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2002-08-21 06:09:53 +0000'>2002-08-21</span></td><td><a href='/lcd4linux.git/commit/udelay.c?id=f99cf1488f583b2065c3163f0c23c21fc1baecb2&amp;follow=1'>[lcd4linux @ 2002-08-21 06:09:53 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-10</span>/<span class='insertions'>+48</span></td></tr>
<tr><td><span title='2002-08-19 10:51:06 +0000'>2002-08-19</span></td><td><a href='/lcd4linux.git/commit/M50530.c?id=7ed47d0ee20b96f16955a71bc3fcf3dad607bcfb&amp;follow=1'>[lcd4linux @ 2002-08-19 10:51:06 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-259</span>/<span class='insertions'>+60</span></td></tr>
<tr><td><span title='2002-08-19 09:43:43 +0000'>2002-08-19</span></td><td><a href='/lcd4linux.git/commit/BeckmannEgle.c?id=1b5ce6fb9be2a5e199442c5227bb456ee588a6d4&amp;follow=1'>[lcd4linux @ 2002-08-19 09:43:43 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-261</span>/<span class='insertions'>+57</span></td></tr>
<tr><td><span title='2002-08-19 09:30:18 +0000'>2002-08-19</span></td><td><a href='/lcd4linux.git/commit/MatrixOrbital.c?id=0a222223da77df452af54599d7229737f23a4979&amp;follow=1'>[lcd4linux @ 2002-08-19 09:30:18 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-256</span>/<span class='insertions'>+106</span></td></tr>
<tr><td><span title='2002-08-19 09:11:34 +0000'>2002-08-19</span></td><td><a href='/lcd4linux.git/commit/USBLCD.c?id=ea9550a25fe75ddbe92ff807df0b7a2cdf9affca&amp;follow=1'>[lcd4linux @ 2002-08-19 09:11:34 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-257</span>/<span class='insertions'>+51</span></td></tr>
<tr><td><span title='2002-08-19 07:52:19 +0000'>2002-08-19</span></td><td><a href='/lcd4linux.git/commit/bar.h?id=2e0aea4d5beae921b86b259adddae549955db036&amp;follow=1'>[lcd4linux @ 2002-08-19 07:52:19 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-8</span>/<span class='insertions'>+17</span></td></tr>
<tr><td><span title='2002-08-19 07:36:29 +0000'>2002-08-19</span></td><td><a href='/lcd4linux.git/commit/bar.h?id=3459cefb2dcd1736f50e8134fdc2518aa8edc402&amp;follow=1'>[lcd4linux @ 2002-08-19 07:36:29 by reinelt]</a></td><td>reinelt</td><td>7</td><td><span class='deletions'>-359</span>/<span class='insertions'>+481</span></td></tr>
<tr><td><span title='2002-08-19 04:41:20 +0000'>2002-08-19</span></td><td><a href='/lcd4linux.git/commit/processor.c?id=d72755a9609479f9b3463a96c3a71fd7084f2fb3&amp;follow=1'>[lcd4linux @ 2002-08-19 04:41:20 by reinelt]</a></td><td>reinelt</td><td>20</td><td><span class='deletions'>-32</span>/<span class='insertions'>+166</span></td></tr>
<tr><td><span title='2002-08-18 08:11:11 +0000'>2002-08-18</span></td><td><a href='/lcd4linux.git/commit/USBLCD.c?id=0d5e6f24b79e5127a66db4cf1e4155424ba26ded&amp;follow=1'>[lcd4linux @ 2002-08-18 08:11:11 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-26</span>/<span class='insertions'>+28</span></td></tr>
<tr><td><span title='2002-08-17 14:14:21 +0000'>2002-08-17</span></td><td><a href='/lcd4linux.git/commit/udelay.c?id=35755c86f661f8af41911331567e7fd4520cdfe7&amp;follow=1'>[lcd4linux @ 2002-08-17 14:14:21 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-67</span>/<span class='insertions'>+101</span></td></tr>
<tr><td><span title='2002-08-17 13:10:23 +0000'>2002-08-17</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?id=38316eabe17ef143a2951b72c7cdd318b99a6c71&amp;follow=1'>[lcd4linux @ 2002-08-17 13:10:22 by reinelt]</a></td><td>reinelt</td><td>9</td><td><span class='deletions'>-182</span>/<span class='insertions'>+765</span></td></tr>
<tr><td><span title='2002-08-17 12:54:08 +0000'>2002-08-17</span></td><td><a href='/lcd4linux.git/commit/T6963.c?id=bbdb125fd6cdaf4acae3459b1b0e42e66bb9e96f&amp;follow=1'>[lcd4linux @ 2002-08-17 12:54:08 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-7</span>/<span class='insertions'>+23</span></td></tr>
<tr><td><span title='2002-04-30 07:20:15 +0000'>2002-04-30</span></td><td><a href='/lcd4linux.git/commit/M50530.c?id=55ca707f900b9df3a701129017e7ab85d243c94c&amp;follow=1'>[lcd4linux @ 2002-04-30 07:20:15 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-173</span>/<span class='insertions'>+129</span></td></tr>
<tr><td><span title='2002-04-29 11:00:28 +0000'>2002-04-29</span></td><td><a href='/lcd4linux.git/commit/udelay.h?id=e0bc8f47b964169bcbec3ce14d1aca38bc024cee&amp;follow=1'>[lcd4linux @ 2002-04-29 11:00:25 by reinelt]</a></td><td>reinelt</td><td>14</td><td><span class='deletions'>-2339</span>/<span class='insertions'>+5100</span></td></tr>
<tr><td><span title='2001-09-14 05:57:06 +0000'>2001-09-14</span></td><td><a href='/lcd4linux.git/commit/TODO?id=c9a403a8364c906a54c24a9465299bb7e45e53f6&amp;follow=1'>[lcd4linux @ 2001-09-14 05:57:06 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+5</span></td></tr>
<tr><td><span title='2001-09-13 07:40:57 +0000'>2001-09-13</span></td><td><a href='/lcd4linux.git/commit/TODO?id=f54b102fdb2005e01be18a40d2952a13b442931b&amp;follow=1'>[lcd4linux @ 2001-09-13 07:40:57 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+6</span></td></tr>
<tr><td><span title='2001-09-12 06:17:22 +0000'>2001-09-12</span></td><td><a href='/lcd4linux.git/commit/mail2.c?id=5d9989113b56376af1c7707b8a67088c44d42020&amp;follow=1'>[lcd4linux @ 2001-09-12 06:17:22 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-1</span>/<span class='insertions'>+8</span></td></tr>
<tr><td><span title='2001-09-12 05:58:16 +0000'>2001-09-12</span></td><td><a href='/lcd4linux.git/commit/socket.c?id=3e02257318034a35959a9680159f1c99399fa0f7&amp;follow=1'>[lcd4linux @ 2001-09-12 05:58:16 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-9</span>/<span class='insertions'>+27</span></td></tr>
<tr><td><span title='2001-09-12 05:37:22 +0000'>2001-09-12</span></td><td><a href='/lcd4linux.git/commit/socket.c?id=4340dc126ba0920dc93c0e74d48cfee769547399&amp;follow=1'>[lcd4linux @ 2001-09-12 05:37:22 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-23</span>/<span class='insertions'>+99</span></td></tr>
<tr><td><span title='2001-09-11 06:43:43 +0000'>2001-09-11</span></td><td><a href='/lcd4linux.git/commit/TODO?id=9e49a79d95a7c61099ab86b6106d98a77b66a79e&amp;follow=1'>[lcd4linux @ 2001-09-11 06:43:43 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+10</span></td></tr>