#
# $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. 
on>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/lcd4linux.git/log/?h=master&amp;id=6a15acd34f99c18aba3ac5b50118a9df5145ac3a&amp;follow=1'>root</a>/<a href='/lcd4linux.git/log/exec.c?h=master&amp;id=6a15acd34f99c18aba3ac5b50118a9df5145ac3a&amp;follow=1'>exec.c</a> (<a href='/lcd4linux.git/log/exec.c?h=master&amp;id=6a15acd34f99c18aba3ac5b50118a9df5145ac3a'>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/exec.c?h=master&amp;id=6a15acd34f99c18aba3ac5b50118a9df5145ac3a&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='2001-05-31 10:26:41 +0000'>2001-05-31</span></td><td><a href='/lcd4linux.git/commit/curses.m4?h=master&amp;id=61fda368378481fd2449e584c1f6ab4de52dcd25&amp;follow=1'>[lcd4linux @ 2001-05-31 10:26:41 by ltoetsch]</a></td><td>ltoetsch</td><td>7</td><td><span class='deletions'>-171</span>/<span class='insertions'>+1032</span></td></tr>
<tr><td><span title='2001-05-27 17:32:35 +0000'>2001-05-27</span></td><td><a href='/lcd4linux.git/commit/README?h=master&amp;id=2012487dc33d7c5ec99b8246303470eb0c5c8a25&amp;follow=1'>[lcd4linux @ 2001-05-27 17:32:35 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-47</span>/<span class='insertions'>+50</span></td></tr>
<tr><td><span title='2001-05-27 07:19:28 +0000'>2001-05-27</span></td><td><a href='/lcd4linux.git/commit/pixmap.c?h=master&amp;id=7430904ad42f0011dc13f385886f0164aa362bdc&amp;follow=1'>[lcd4linux @ 2001-05-27 07:19:28 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-5</span>/<span class='insertions'>+22</span></td></tr>
<tr><td><span title='2001-05-26 06:51:28 +0000'>2001-05-26</span></td><td><a href='/lcd4linux.git/commit/TODO?h=master&amp;id=ff0e2b1fb47d2891cd8d490382bb3d7f70927c43&amp;follow=1'>[lcd4linux @ 2001-05-26 06:51:28 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2001-05-06 10:01:27 +0000'>2001-05-06</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=1dcb7f846df70302b2d85973e50f123f11a71d03&amp;follow=1'>[lcd4linux @ 2001-05-06 10:01:27 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+7</span></td></tr>
<tr><td><span title='2001-04-27 05:04:57 +0000'>2001-04-27</span></td><td><a href='/lcd4linux.git/commit/pixmap.c?h=master&amp;id=850d421bcdf6f502f9e8e0b8be3ba4c75f31a82c&amp;follow=1'>[lcd4linux @ 2001-04-27 05:04:57 by reinelt]</a></td><td>reinelt</td><td>9</td><td><span class='deletions'>-125</span>/<span class='insertions'>+185</span></td></tr>
<tr><td><span title='2001-03-24 09:26:25 +0000'>2001-03-24</span></td><td><a href='/lcd4linux.git/commit/TODO?h=master&amp;id=7bd45509770b7daf6c7e083b9e584dccf0aacb7f&amp;follow=1'>[lcd4linux @ 2001-03-24 09:26:25 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+5</span></td></tr>
<tr><td><span title='2001-03-24 09:04:19 +0000'>2001-03-24</span></td><td><a href='/lcd4linux.git/commit/TODO?h=master&amp;id=084b30a65598d6592c388c4cf5b892feadc38cca&amp;follow=1'>[lcd4linux @ 2001-03-24 09:04:19 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+5</span></td></tr>
<tr><td><span title='2001-03-17 11:44:10 +0000'>2001-03-17</span></td><td><a href='/lcd4linux.git/commit/pixmap.c?h=master&amp;id=9147c25eb4389bc3a1317ffcf9b9a65376079c76&amp;follow=1'>[lcd4linux @ 2001-03-17 11:44:10 by ltoetsch]</a></td><td>ltoetsch</td><td>1</td><td><span class='deletions'>-20</span>/<span class='insertions'>+42</span></td></tr>
<tr><td><span title='2001-03-17 11:11:31 +0000'>2001-03-17</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=12bfd2f6220f354bcb4efb25e2f33e83f546b20f&amp;follow=1'>[lcd4linux @ 2001-03-17 11:11:31 by ltoetsch]</a></td><td>ltoetsch</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+5</span></td></tr>
<tr><td><span title='2001-03-16 16:40:17 +0000'>2001-03-16</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=3d24b9bd4612dd293bde38976798288ecb4e1722&amp;follow=1'>[lcd4linux @ 2001-03-16 16:40:17 by ltoetsch]</a></td><td>ltoetsch</td><td>12</td><td><span class='deletions'>-24</span>/<span class='insertions'>+112</span></td></tr>
<tr><td><span title='2001-03-16 09:28:08 +0000'>2001-03-16</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=8cb47a24a9ab1b5bbf81819d4567be4308db2b54&amp;follow=1'>[lcd4linux @ 2001-03-16 09:28:08 by ltoetsch]</a></td><td>ltoetsch</td><td>5</td><td><span class='deletions'>-11</span>/<span class='insertions'>+35</span></td></tr>
<tr><td><span title='2001-03-15 15:49:23 +0000'>2001-03-15</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=f28003f1779e7e560ccc70e90d88b376208f6cd6&amp;follow=1'>[lcd4linux @ 2001-03-15 15:49:22 by ltoetsch]</a></td><td>ltoetsch</td><td>3</td><td><span class='deletions'>-14</span>/<span class='insertions'>+27</span></td></tr>
<tr><td><span title='2001-03-15 14:25:05 +0000'>2001-03-15</span></td><td><a href='/lcd4linux.git/commit/socket.c?h=master&amp;id=cafef33d38d19a9075897b7484a5cb2c594da1da&amp;follow=1'>[lcd4linux @ 2001-03-15 14:25:05 by ltoetsch]</a></td><td>ltoetsch</td><td>11</td><td><span class='deletions'>-125</span>/<span class='insertions'>+278</span></td></tr>
<tr><td><span title='2001-03-15 11:10:53 +0000'>2001-03-15</span></td><td><a href='/lcd4linux.git/commit/mail2.c?h=master&amp;id=05ed83934da5b17841c34009456e9e27073a488a&amp;follow=1'>[lcd4linux @ 2001-03-15 11:10:53 by ltoetsch]</a></td><td>ltoetsch</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+8</span></td></tr>
<tr><td><span title='2001-03-15 09:47:13 +0000'>2001-03-15</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=1bbd55d6180fc18c16b401eafae2fa7ab84d01fa&amp;follow=1'>[lcd4linux @ 2001-03-15 09:47:13 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-16</span>/<span class='insertions'>+31</span></td></tr>
<tr><td><span title='2001-03-15 09:13:22 +0000'>2001-03-15</span></td><td><a href='/lcd4linux.git/commit/exec.c?h=master&amp;id=4b219e09f035d52e3f02b4a4fd042185a06fb670&amp;follow=1'>[lcd4linux @ 2001-03-15 09:13:22 by ltoetsch]</a></td><td>ltoetsch</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+9</span></td></tr>
<tr><td><span title='2001-03-14 16:47:41 +0000'>2001-03-14</span></td><td><a href='/lcd4linux.git/commit/TODO?h=master&amp;id=6332ea0ded15b1ec775ffdb94cc7d8c779138356&amp;follow=1'>[lcd4linux @ 2001-03-14 16:47:41 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-41</span>/<span class='insertions'>+59</span></td></tr>
<tr><td><span title='2001-03-14 15:30:53 +0000'>2001-03-14</span></td><td><a href='/lcd4linux.git/commit/HD44780.c?h=master&amp;id=3ede643c6ae5328dddda6c39a9a4c992c8f1fed7&amp;follow=1'>[lcd4linux @ 2001-03-14 15:30:53 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-21</span>/<span class='insertions'>+34</span></td></tr>
<tr><td><span title='2001-03-14 15:14:59 +0000'>2001-03-14</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=911169ea04acef49f285158270ac94c1153d90d8&amp;follow=1'>[lcd4linux @ 2001-03-14 15:14:59 by reinelt]</a></td><td>reinelt</td><td>8</td><td><span class='deletions'>-152</span>/<span class='insertions'>+365</span></td></tr>
<tr><td><span title='2001-03-14 13:19:29 +0000'>2001-03-14</span></td><td><a href='/lcd4linux.git/commit/socket.h?h=master&amp;id=dfc23a8138bb7aa72043d754170c1c48e66485c0&amp;follow=1'>[lcd4linux @ 2001-03-14 13:19:29 by ltoetsch]</a></td><td>ltoetsch</td><td>16</td><td><span class='deletions'>-128</span>/<span class='insertions'>+773</span></td></tr>
<tr><td><span title='2001-03-13 08:34:15 +0000'>2001-03-13</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=f3076919635e550ed752db4030468a3f256f60a1&amp;follow=1'>[lcd4linux @ 2001-03-13 08:34:15 by reinelt]</a></td><td>reinelt</td><td>6</td><td><span class='deletions'>-29</span>/<span class='insertions'>+50</span></td></tr>
<tr><td><span title='2001-03-13 08:03:41 +0000'>2001-03-13</span></td><td><a href='/lcd4linux.git/commit/acconfig.h?h=master&amp;id=ab548cb3e831ea2443d6362acc319eb01c0ceab6&amp;follow=1'>[lcd4linux @ 2001-03-13 08:03:41 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-1</span>/<span class='insertions'>+35</span></td></tr>
<tr><td><span title='2001-03-13 07:53:00 +0000'>2001-03-13</span></td><td><a href='/lcd4linux.git/commit/Makefile.in?h=master&amp;id=6132a83fb8a4b6158222fbf6080656fac105c470&amp;follow=1'>[lcd4linux @ 2001-03-13 07:53:00 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-13</span>/<span class='insertions'>+15</span></td></tr>
<tr><td><span title='2001-03-13 07:41:22 +0000'>2001-03-13</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.c?h=master&amp;id=fff98857c9d3c95a5c7fcd9c8b6c4b15ca183a71&amp;follow=1'>[lcd4linux @ 2001-03-13 07:41:22 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-2</span>/<span class='insertions'>+52</span></td></tr>
<tr><td><span title='2001-03-12 13:44:58 +0000'>2001-03-12</span></td><td><a href='/lcd4linux.git/commit/udelay.h?h=master&amp;id=064f4880a2349039356945b3a9f2081f035c32c1&amp;follow=1'>[lcd4linux @ 2001-03-12 13:44:58 by reinelt]</a></td><td>reinelt</td><td>8</td><td><span class='deletions'>-58</span>/<span class='insertions'>+232</span></td></tr>
<tr><td><span title='2001-03-12 12:49:24 +0000'>2001-03-12</span></td><td><a href='/lcd4linux.git/commit/configure.in?h=master&amp;id=62fdec1130f15faf0ed0562f79525f64f7f6e9bd&amp;follow=1'>[lcd4linux @ 2001-03-12 12:49:24 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-63</span>/<span class='insertions'>+71</span></td></tr>
<tr><td><span title='2001-03-12 12:39:36 +0000'>2001-03-12</span></td><td><a href='/lcd4linux.git/commit/udelay.h?h=master&amp;id=3f2399e0a62d4df4e055ec5273f5b7738c55e81d&amp;follow=1'>[lcd4linux @ 2001-03-12 12:39:36 by reinelt]</a></td><td>reinelt</td><td>14</td><td><span class='deletions'>-448</span>/<span class='insertions'>+830</span></td></tr>
<tr><td><span title='2001-03-09 16:24:30 +0000'>2001-03-09</span></td><td><a href='/lcd4linux.git/commit/configure.in?h=master&amp;id=ae1c4ae6f41459fdd78ac41cc43fdfa34cdc1067&amp;follow=1'>[lcd4linux @ 2001-03-09 16:24:30 by ltoetsch]</a></td><td>ltoetsch</td><td>2</td><td><span class='deletions'>-155</span>/<span class='insertions'>+345</span></td></tr>
<tr><td><span title='2001-03-09 15:04:53 +0000'>2001-03-09</span></td><td><a href='/lcd4linux.git/commit/configure?h=master&amp;id=3ebeb1868ff674096294f7abe90e8d11845a794c&amp;follow=1'>[lcd4linux @ 2001-03-09 15:04:53 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-103</span>/<span class='insertions'>+109</span></td></tr>
<tr><td><span title='2001-03-09 14:30:01 +0000'>2001-03-09</span></td><td><a href='/lcd4linux.git/commit/TODO?h=master&amp;id=ae91355deae7f98b5786c78bee9805d1348a64a1&amp;follow=1'>[lcd4linux @ 2001-03-09 14:30:01 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+7</span></td></tr>
<tr><td><span title='2001-03-09 14:24:49 +0000'>2001-03-09</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=1a47930ac414d55721085a2b8983d301bb0dbacc&amp;follow=1'>[lcd4linux @ 2001-03-09 14:24:49 by ltoetsch]</a></td><td>ltoetsch</td><td>3</td><td><span class='deletions'>-7</span>/<span class='insertions'>+18</span></td></tr>
<tr><td><span title='2001-03-09 13:08:11 +0000'>2001-03-09</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=d216db15731515a28358a8b8a13e06817343cc81&amp;follow=1'>[lcd4linux @ 2001-03-09 13:08:11 by ltoetsch]</a></td><td>ltoetsch</td><td>12</td><td><span class='deletions'>-86</span>/<span class='insertions'>+384</span></td></tr>
<tr><td><span title='2001-03-09 12:14:24 +0000'>2001-03-09</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=9798af2267cd73c68b0ef22e9d2b27eac1aba2f5&amp;follow=1'>[lcd4linux @ 2001-03-09 12:14:24 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-21</span>/<span class='insertions'>+34</span></td></tr>
<tr><td><span title='2001-03-08 15:25:38 +0000'>2001-03-08</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=824e3605cf8644295dc837a17f329c2e2bd619a3&amp;follow=1'>[lcd4linux @ 2001-03-08 15:25:38 by ltoetsch]</a></td><td>ltoetsch</td><td>9</td><td><span class='deletions'>-93</span>/<span class='insertions'>+214</span></td></tr>
<tr><td><span title='2001-03-08 09:02:04 +0000'>2001-03-08</span></td><td><a href='/lcd4linux.git/commit/seti.h?h=master&amp;id=af1aa94e53eea7a721806610ffdad0affe8d2d0f&amp;follow=1'>[lcd4linux @ 2001-03-08 09:02:04 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-133</span>/<span class='insertions'>+21</span></td></tr>
<tr><td><span title='2001-03-08 08:39:55 +0000'>2001-03-08</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=3ed93cefbb0fe1943d1d5c53b238aaa7eb4d03dd&amp;follow=1'>[lcd4linux @ 2001-03-08 08:39:54 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-4</span>/<span class='insertions'>+12</span></td></tr>
<tr><td><span title='2001-03-07 18:10:21 +0000'>2001-03-07</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=21f603cb1ed2fd2ca5e009b50a1f6debc311c1ab&amp;follow=1'>[lcd4linux @ 2001-03-07 18:10:21 by ltoetsch]</a></td><td>ltoetsch</td><td>10</td><td><span class='deletions'>-110</span>/<span class='insertions'>+319</span></td></tr>
<tr><td><span title='2001-03-05 18:20:21 +0000'>2001-03-05</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=e8e1dc888de11ad73dbab1ea08d6b995dae83113&amp;follow=1'>[lcd4linux @ 2001-03-05 18:20:21 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-13</span>/<span class='insertions'>+25</span></td></tr>
<tr><td><span title='2001-03-04 15:01:12 +0000'>2001-03-04</span></td><td><a href='/lcd4linux.git/commit/README.Raster?h=master&amp;id=a30ff3c4a40988b573dd094f6a5c3af5138b78eb&amp;follow=1'>[lcd4linux @ 2001-03-04 15:01:12 by ltoetsch]</a></td><td>ltoetsch</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+3</span></td></tr>
<tr><td><span title='2001-03-02 20:18:12 +0000'>2001-03-02</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=4f3c19b6c507608b273a9e27c678d2d28596ee62&amp;follow=1'>[lcd4linux @ 2001-03-02 20:18:12 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-36</span>/<span class='insertions'>+89</span></td></tr>