#
# $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. 
tion>
<option value='author'>author</option>
<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=2415ddad4bd685c7d71403ba1332294ab0f2891a&amp;follow=1'>root</a>/<a href='/lcd4linux.git/log/lcd4kde.conf?h=master&amp;id=2415ddad4bd685c7d71403ba1332294ab0f2891a&amp;follow=1'>lcd4kde.conf</a> (<a href='/lcd4linux.git/log/lcd4kde.conf?h=master&amp;id=2415ddad4bd685c7d71403ba1332294ab0f2891a'>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/lcd4kde.conf?h=master&amp;id=2415ddad4bd685c7d71403ba1332294ab0f2891a&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='2000-10-08 09:16:40 +0000'>2000-10-08</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=c862bfeed14239f56f09935c7f7270a4f81406e6&amp;follow=1'>[lcd4linux @ 2000-10-08 09:16:40 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-51</span>/<span class='insertions'>+84</span></td></tr>
<tr><td><span title='2000-08-10 18:42:20 +0000'>2000-08-10</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.c?h=master&amp;id=5ab3a459f9fbb73a64c4455d2965409b1ba5f1f4&amp;follow=1'>[lcd4linux @ 2000-08-10 18:42:20 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-22</span>/<span class='insertions'>+114</span></td></tr>
<tr><td><span title='2000-08-10 09:44:09 +0000'>2000-08-10</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=994c3f1ff0c2b7ab62cfa413827ab17667805aa5&amp;follow=1'>[lcd4linux @ 2000-08-10 09:44:09 by reinelt]</a></td><td>reinelt</td><td>21</td><td><span class='deletions'>-1068</span>/<span class='insertions'>+1162</span></td></tr>
<tr><td><span title='2000-08-09 14:14:11 +0000'>2000-08-09</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.c?h=master&amp;id=0cb72bf49d0a0decda8285f8fa5a559bffa9e118&amp;follow=1'>[lcd4linux @ 2000-08-09 14:14:11 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-11</span>/<span class='insertions'>+41</span></td></tr>
<tr><td><span title='2000-08-09 11:03:07 +0000'>2000-08-09</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=fc2a80a97829537355a889ed4bf564ca5b6a9c75&amp;follow=1'>[lcd4linux @ 2000-08-09 11:03:07 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-13</span>/<span class='insertions'>+28</span></td></tr>
<tr><td><span title='2000-08-09 09:50:29 +0000'>2000-08-09</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=1645d61018c24013525f3953613aaea56714bab4&amp;follow=1'>[lcd4linux @ 2000-08-09 09:50:29 by reinelt]</a></td><td>reinelt</td><td>13</td><td><span class='deletions'>-127</span>/<span class='insertions'>+204</span></td></tr>
<tr><td><span title='2000-07-31 10:43:44 +0000'>2000-07-31</span></td><td><a href='/lcd4linux.git/commit/udelay.c?h=master&amp;id=7ff246c0458df37567dcefebfd9a720f9b98cdb7&amp;follow=1'>[lcd4linux @ 2000-07-31 10:43:44 by reinelt]</a></td><td>reinelt</td><td>8</td><td><span class='deletions'>-91</span>/<span class='insertions'>+235</span></td></tr>
<tr><td><span title='2000-07-31 06:46:35 +0000'>2000-07-31</span></td><td><a href='/lcd4linux.git/commit/cfg.c?h=master&amp;id=5369cdf6f69abc9a33581e8209f4fc1d2ea468f1&amp;follow=1'>[lcd4linux @ 2000-07-31 06:46:35 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-5</span>/<span class='insertions'>+15</span></td></tr>
<tr><td><span title='2000-06-04 21:43:50 +0000'>2000-06-04</span></td><td><a href='/lcd4linux.git/commit/Crystalfontz.c?h=master&amp;id=1e6198b7be4ecc45b8c62d814df8559163e9712c&amp;follow=1'>[lcd4linux @ 2000-06-04 21:43:50 by herp]</a></td><td>herp</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+9</span></td></tr>
<tr><td><span title='2000-05-21 06:20:35 +0000'>2000-05-21</span></td><td><a href='/lcd4linux.git/commit/system.h?h=master&amp;id=2c5d16713862968233858a2430deb67fd485078a&amp;follow=1'>[lcd4linux @ 2000-05-21 06:20:35 by reinelt]</a></td><td>reinelt</td><td>7</td><td><span class='deletions'>-35</span>/<span class='insertions'>+148</span></td></tr>
<tr><td><span title='2000-05-03 17:14:51 +0000'>2000-05-03</span></td><td><a href='/lcd4linux.git/commit/Crystalfontz.c?h=master&amp;id=4b2b6ee2f0eed08a6e9117d343360e778734f26e&amp;follow=1'>[lcd4linux @ 2000-05-03 17:14:51 by herp]</a></td><td>herp</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2000-05-03 09:37:32 +0000'>2000-05-03</span></td><td><a href='/lcd4linux.git/commit/README.Crystalfontz?h=master&amp;id=1df2f43206a2cb86e2792d8315b5e14f269ed83f&amp;follow=1'>[lcd4linux @ 2000-05-03 09:37:32 by herp]</a></td><td>herp</td><td>3</td><td><span class='deletions'>-0</span>/<span class='insertions'>+658</span></td></tr>
<tr><td><span title='2000-05-02 23:07:48 +0000'>2000-05-02</span></td><td><a href='/lcd4linux.git/commit/display.c?h=master&amp;id=6373b1b0c309ef99f98295cfc70b5411c96afce2&amp;follow=1'>[lcd4linux @ 2000-05-02 23:07:48 by herp]</a></td><td>herp</td><td>4</td><td><span class='deletions'>-15</span>/<span class='insertions'>+24</span></td></tr>
<tr><td><span title='2000-05-02 06:05:00 +0000'>2000-05-02</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=23a1214b15e7750a9cd0b849c394ba90824bd638&amp;follow=1'>[lcd4linux @ 2000-05-02 06:05:00 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-7</span>/<span class='insertions'>+312</span></td></tr>
<tr><td><span title='2000-04-30 06:40:42 +0000'>2000-04-30</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=e6cc895f5d708709e837a4735a83b922b8328e69&amp;follow=1'>[lcd4linux @ 2000-04-30 06:40:42 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-17</span>/<span class='insertions'>+37</span></td></tr>
<tr><td><span title='2000-04-28 05:19:55 +0000'>2000-04-28</span></td><td><a href='/lcd4linux.git/commit/display.c?h=master&amp;id=c501b39d5995b0dc42468f75172f35aa12244772&amp;follow=1'>[lcd4linux @ 2000-04-28 05:19:55 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-12</span>/<span class='insertions'>+554</span></td></tr>
<tr><td><span title='2000-04-20 05:48:42 +0000'>2000-04-20</span></td><td><a href='/lcd4linux.git/commit/Makefile.in?h=master&amp;id=9382c096f395f353bdd47f3c16fe899cad540734&amp;follow=1'>[lcd4linux @ 2000-04-20 05:48:42 by reinelt]</a></td><td>reinelt</td><td>2</td><td><span class='deletions'>-0</span>/<span class='insertions'>+18</span></td></tr>
<tr><td><span title='2000-04-19 04:44:20 +0000'>2000-04-19</span></td><td><a href='/lcd4linux.git/commit/README.HD44780?h=master&amp;id=6b0b31cdb7d5dc8bf2d80978066e20900c5e55ba&amp;follow=1'>[lcd4linux @ 2000-04-19 04:44:20 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2000-04-17 05:14:27 +0000'>2000-04-17</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=b8d1fec4ab4011a52dad5afb82ab339baf5df31e&amp;follow=1'>[lcd4linux @ 2000-04-17 05:14:27 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-5</span>/<span class='insertions'>+119</span></td></tr>
<tr><td><span title='2000-04-15 16:56:52 +0000'>2000-04-15</span></td><td><a href='/lcd4linux.git/commit/udelay.h?h=master&amp;id=c8f4049a367f0384549b5c5907603222370664cb&amp;follow=1'>[lcd4linux @ 2000-04-15 16:56:52 by reinelt]</a></td><td>reinelt</td><td>7</td><td><span class='deletions'>-58</span>/<span class='insertions'>+197</span></td></tr>
<tr><td><span title='2000-04-15 11:56:35 +0000'>2000-04-15</span></td><td><a href='/lcd4linux.git/commit/system.c?h=master&amp;id=5843f20a9d5e4d6840fa92f239258b11297cb36c&amp;follow=1'>[lcd4linux @ 2000-04-15 11:56:35 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-10</span>/<span class='insertions'>+60</span></td></tr>
<tr><td><span title='2000-04-15 11:13:54 +0000'>2000-04-15</span></td><td><a href='/lcd4linux.git/commit/processor.c?h=master&amp;id=24f64dfa553a9b713aeb3c1a1f1592ab7973f85e&amp;follow=1'>[lcd4linux @ 2000-04-15 11:13:54 by reinelt]</a></td><td>reinelt</td><td>10</td><td><span class='deletions'>-28</span>/<span class='insertions'>+144</span></td></tr>
<tr><td><span title='2000-04-13 06:09:52 +0000'>2000-04-13</span></td><td><a href='/lcd4linux.git/commit/system.h?h=master&amp;id=6dfd10e9f5aef7c0411aaf0c0de775a3c011e33a&amp;follow=1'>[lcd4linux @ 2000-04-13 06:09:52 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-54</span>/<span class='insertions'>+126</span></td></tr>
<tr><td><span title='2000-04-12 08:05:45 +0000'>2000-04-12</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=73ffb61bfcbbba0abaeb26912a7408c4e0d143ab&amp;follow=1'>[lcd4linux @ 2000-04-12 08:05:45 by reinelt]</a></td><td>reinelt</td><td>6</td><td><span class='deletions'>-24</span>/<span class='insertions'>+535</span></td></tr>
<tr><td><span title='2000-04-10 04:40:53 +0000'>2000-04-10</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.c?h=master&amp;id=66d30deaa9b4b9bb575560b69e811265eebbffec&amp;follow=1'>[lcd4linux @ 2000-04-10 04:40:53 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-31</span>/<span class='insertions'>+65</span></td></tr>
<tr><td><span title='2000-04-07 05:42:20 +0000'>2000-04-07</span></td><td><a href='/lcd4linux.git/commit/lock.h?h=master&amp;id=a3e3fa4aafc6404907419bf9652a32cc1d7d54cf&amp;follow=1'>[lcd4linux @ 2000-04-07 05:42:20 by reinelt]</a></td><td>reinelt</td><td>6</td><td><span class='deletions'>-17</span>/<span class='insertions'>+266</span></td></tr>
<tr><td><span title='2000-04-05 05:58:36 +0000'>2000-04-05</span></td><td><a href='/lcd4linux.git/commit/configure.in?h=master&amp;id=ef1af83c23834f8e4ee75fde0395ada84fd1acb5&amp;follow=1'>[lcd4linux @ 2000-04-05 05:58:36 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-17</span>/<span class='insertions'>+65</span></td></tr>