#
# $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. 
ct>
<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='/debian/lcd4linux.git/log/?id=ac55352fc07e11744480b7caed2681a8c456305e&amp;follow=1'>root</a>/<a href='/debian/lcd4linux.git/log/FAQ?id=ac55352fc07e11744480b7caed2681a8c456305e&amp;follow=1'>FAQ</a> (<a href='/debian/lcd4linux.git/log/FAQ?id=ac55352fc07e11744480b7caed2681a8c456305e'>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='/debian/lcd4linux.git/log/FAQ?id=ac55352fc07e11744480b7caed2681a8c456305e&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='2005-04-05 05:12:57 +0000'>2005-04-05</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.conf.sample?id=3efb9ba8c1225b83f8ddceafc773368e5057e542&amp;follow=1'>[lcd4linux @ 2005-04-05 05:12:48 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-407</span>/<span class='insertions'>+33</span></td></tr>
<tr><td><span title='2005-04-05 04:46:06 +0000'>2005-04-05</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_math.c?id=17464fd68003af274013f49316a397df33ecbd23&amp;follow=1'>[lcd4linux @ 2005-04-05 04:46:06 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+20</span></td></tr>
<tr><td><span title='2005-04-04 20:11:14 +0000'>2005-04-04</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_imon.c?id=f27536bd017902cb39c208ec346775b592fb56be&amp;follow=1'>[lcd4linux @ 2005-04-04 20:11:14 by nicowallmeier]</a></td><td>nicowallmeier</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+6</span></td></tr>
<tr><td><span title='2005-04-03 07:07:51 +0000'>2005-04-03</span></td><td><a href='/debian/lcd4linux.git/commit/plugins.m4?id=bc7da25bcdea985d6f4f484e517b3a121b086a29&amp;follow=1'>[lcd4linux @ 2005-04-03 07:07:43 by reinelt]</a></td><td>reinelt</td><td>8</td><td><span class='deletions'>-9</span>/<span class='insertions'>+152</span></td></tr>
<tr><td><span title='2005-04-02 05:28:58 +0000'>2005-04-02</span></td><td><a href='/debian/lcd4linux.git/commit/drv_USBLCD.c?id=2d8c20e14ccd6be77bd959d1a5a928e5f6b4ecee&amp;follow=1'>[lcd4linux @ 2005-04-02 05:28:58 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-19</span>/<span class='insertions'>+27</span></td></tr>
<tr><td><span title='2005-04-01 05:16:04 +0000'>2005-04-01</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_pop3.c?id=5f33ee56af142ec69f13422eb0f4eab8741aa0d1&amp;follow=1'>[lcd4linux @ 2005-04-01 05:16:04 by reinelt]</a></td><td>reinelt</td><td>5</td><td><span class='deletions'>-584</span>/<span class='insertions'>+694</span></td></tr>
<tr><td><span title='2005-03-30 04:57:50 +0000'>2005-03-30</span></td><td><a href='/debian/lcd4linux.git/commit/plugin_cfg.c?id=3e6c870d3cefb3b1e61b779566d2f051f1b23083&amp;follow=1'>[lcd4linux @ 2005-03-30 04:57:50 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-23</span>/<span class='insertions'>+67</span></td></tr>
<tr><td><span title='2005-03-28 22:29:23 +0000'>2005-03-28</span></td><td><a href='/debian/lcd4linux.git/commit/drv_HD44780.c?id=77d259034099fff8737a1d5af47e8edf8d84efc0&amp;follow=1'>[lcd4linux @ 2005-03-28 22:29:23 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-250</span>/<span class='insertions'>+346</span></td></tr>
<tr><td><span title='2005-03-28 19:39:23 +0000'>2005-03-28</span></td><td><a href='/debian/lcd4linux.git/commit/drv_generic_i2c.h?id=af796d8411d9bac1143ba6deaf43a2275704a1da&amp;follow=1'>[lcd4linux @ 2005-03-28 19:39:14 by reinelt]</a></td><td>reinelt</td><td>9</td><td><span class='deletions'>-256</span>/<span class='insertions'>+1147</span></td></tr>
<tr><td><span title='2005-03-25 15:44:43 +0000'>2005-03-25</span></td><td><a href='/debian/lcd4linux.git/commit/drv_HD44780.c?id=55476cb223f943a19effc402d2f3021df4cf7474&amp;follow=1'>[lcd4linux @ 2005-03-25 15:44:43 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+5</span></td></tr>
<tr><td><span title='2005-03-23 12:23:35 +0000'>2005-03-23</span></td><td><a href='/debian/lcd4linux.git/commit/drv_Crystalfontz.c?id=5b94e9a28bff5f356524424754bd3f7440853b51&amp;follow=1'>[lcd4linux @ 2005-03-23 12:23:35 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-27</span>/<span class='insertions'>+32</span></td></tr>
<tr><td><span title='2005-02-24 07:07:55 +0000'>2005-02-24</span></td><td><a href='/debian/lcd4linux.git/commit/ChangeLog?id=0da5b22888490f156a60f2e511eb6ebc401ae893&amp;follow=1'>[lcd4linux @ 2005-02-24 07:07:55 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+53</span></td></tr>
<tr><td><span title='2005-02-24 07:06:48 +0000'>2005-02-24</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.conf.sample?id=b3c3e822b6c56387cb3583a771767def47624463&amp;follow=1'>[lcd4linux @ 2005-02-24 07:06:45 by reinelt]</a></td><td>reinelt</td><td>11</td><td><span class='deletions'>-28</span>/<span class='insertions'>+347</span></td></tr>
<tr><td><span title='2005-02-24 06:51:40 +0000'>2005-02-24</span></td><td><a href='/debian/lcd4linux.git/commit/drv_LCDLinux.c?id=0f91618aa36e77c0c9e8433f28dd3e313003a3db&amp;follow=1'>[lcd4linux @ 2005-02-24 06:51:40 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-4</span>/<span class='insertions'>+5</span></td></tr>
<tr><td><span title='2005-01-30 06:43:22 +0000'>2005-01-30</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.conf.sample?id=c45466ff9231463f65a2146e300b863757f19663&amp;follow=1'>[lcd4linux @ 2005-01-30 06:43:22 by reinelt]</a></td><td>reinelt</td><td>4</td><td><span class='deletions'>-69</span>/<span class='insertions'>+95</span></td></tr>
<tr><td><span title='2005-01-29 09:30:56 +0000'>2005-01-29</span></td><td><a href='/debian/lcd4linux.git/commit/drv_HD44780.c?id=2d48ef36661d92d603affc5ae9408de8ee242559&amp;follow=1'>[lcd4linux @ 2005-01-29 09:30:56 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-8</span>/<span class='insertions'>+11</span></td></tr>
<tr><td><span title='2005-01-22 22:57:57 +0000'>2005-01-22</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.conf.sample?id=b285743489e7d237cb32fc3aaae0ffdad6c264a4&amp;follow=1'>[lcd4linux @ 2005-01-22 22:57:57 by reinelt]</a></td><td>reinelt</td><td>9</td><td><span class='deletions'>-47</span>/<span class='insertions'>+382</span></td></tr>
<tr><td><span title='2005-01-22 12:44:41 +0000'>2005-01-22</span></td><td><a href='/debian/lcd4linux.git/commit/drv_MatrixOrbital.c?id=8f661b82c70ded73c02fa0b3491f8e6998fe7e51&amp;follow=1'>[lcd4linux @ 2005-01-22 12:44:41 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+6</span></td></tr>
<tr><td><span title='2005-01-18 06:30:24 +0000'>2005-01-18</span></td><td><a href='/debian/lcd4linux.git/commit/widget_text.h?id=5c96185f5d3077e315ed18ca0f774a229732be7f&amp;follow=1'>[lcd4linux @ 2005-01-18 06:30:21 by reinelt]</a></td><td>reinelt</td><td>89</td><td><span class='deletions'>-261</span>/<span class='insertions'>+603</span></td></tr>
<tr><td><span title='2005-01-17 06:38:48 +0000'>2005-01-17</span></td><td><a href='/debian/lcd4linux.git/commit/drv_HD44780.c?id=47329b6aa4a64ea94fdf83061a91e5a3cbf7c9bb&amp;follow=1'>[lcd4linux @ 2005-01-17 06:38:48 by reinelt]</a></td><td>reinelt</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+6</span></td></tr>
<tr><td><span title='2005-01-17 06:29:25 +0000'>2005-01-17</span></td><td><a href='/debian/lcd4linux.git/commit/lcd4linux.conf.sample?id=444e8ec2669f2c1814084609a21ff42cd1513f4f&amp;follow=1'>[lcd4linux @ 2005-01-17 06:29:24 by reinelt]</a></td><td>reinelt</td><td>3</td><td><span class='deletions'>-33</span>/<span class='insertions'>+85</span></td></tr>