#
# $Id: README.Drivers,v 1.3 2000/05/21 06:20:35 reinelt 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

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

* 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() 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. 
select name='qt'>
<option value='grep'>log msg</option>
<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=c0cba80bb174c7dcb9f7e4839614eb7c6c5c1fc3&amp;follow=1'>root</a>/<a href='/lcd4linux.git/log/thread.h?h=master&amp;id=c0cba80bb174c7dcb9f7e4839614eb7c6c5c1fc3&amp;follow=1'>thread.h</a> (<a href='/lcd4linux.git/log/thread.h?h=master&amp;id=c0cba80bb174c7dcb9f7e4839614eb7c6c5c1fc3'>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/thread.h?h=master&amp;id=c0cba80bb174c7dcb9f7e4839614eb7c6c5c1fc3&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='2008-12-27 08:14:21 +0000'>2008-12-27</span></td><td><a href='/lcd4linux.git/commit/drv_X11.c?h=master&amp;id=426e8c3cae8d64abc629da147f26344b87a26799&amp;follow=1'>ported r819 from volker_dev</a></td><td>michael</td><td>1</td><td><span class='deletions'>-17</span>/<span class='insertions'>+21</span></td></tr>
<tr><td><span title='2008-12-27 08:06:57 +0000'>2008-12-27</span></td><td><a href='/lcd4linux.git/commit/smoketest.sh?h=master&amp;id=86bd0d06e81a18de3e5d330eae4ebddcb756d8c3&amp;follow=1'>ported and modified r818 from volker_dev</a></td><td>michael</td><td>3</td><td><span class='deletions'>-11</span>/<span class='insertions'>+151</span></td></tr>
<tr><td><span title='2008-12-27 07:28:23 +0000'>2008-12-27</span></td><td><a href='/lcd4linux.git/commit/plugins.m4?h=master&amp;id=0d315ad93204252fb69e0fed101a51b8c027d096&amp;follow=1'>port r817 from volker_dev</a></td><td>michael</td><td>3</td><td><span class='deletions'>-24</span>/<span class='insertions'>+944</span></td></tr>
<tr><td><span title='2008-12-27 06:44:47 +0000'>2008-12-27</span></td><td><a href='/lcd4linux.git/commit/drv_generic_graphic.c?h=master&amp;id=1c01c975d4ae2ff0489180291fdc7a887039dae8&amp;follow=1'>ported (modified) r815 from voker_dev</a></td><td>michael</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+23</span></td></tr>
<tr><td><span title='2008-12-24 14:02:47 +0000'>2008-12-24</span></td><td><a href='/lcd4linux.git/commit/smoketest.sh?h=master&amp;id=52df507b2fc152a99b816fd88e9bc8bfe05e0d7d&amp;follow=1'>cleanup &amp; cosmetics</a></td><td>michael</td><td>5</td><td><span class='deletions'>-22</span>/<span class='insertions'>+31</span></td></tr>
<tr><td><span title='2008-12-24 13:44:00 +0000'>2008-12-24</span></td><td><a href='/lcd4linux.git/commit/lcd4linux.conf.sample?h=master&amp;id=fb997fc9b040a7c49c7073a7bc454bb68891379b&amp;follow=1'>driver for the PHAnderson serial-to-HD44780 adapter boards by Nicolas Weill</a></td><td>michael</td><td>5</td><td><span class='deletions'>-5</span>/<span class='insertions'>+444</span></td></tr>
<tr><td><span title='2008-12-24 09:40:58 +0000'>2008-12-24</span></td><td><a href='/lcd4linux.git/commit/plugins.m4?h=master&amp;id=6266c2fb61ca14e4c4ff64851d0323fd480c757a&amp;follow=1'>w1retap plugin by Jonathan Hudson</a></td><td>michael</td><td>7</td><td><span class='deletions'>-0</span>/<span class='insertions'>+298</span></td></tr>
<tr><td><span title='2008-12-24 08:28:24 +0000'>2008-12-24</span></td><td><a href='/lcd4linux.git/commit/drv_Pertelian.c?h=master&amp;id=16d014e412692d4479c6e091c11335a07f193e76&amp;follow=1'>Enables/controls the backlight on the Pertelian LCD device by Jonathan Hudson</a></td><td>michael</td><td>1</td><td><span class='deletions'>-10</span>/<span class='insertions'>+13</span></td></tr>
<tr><td><span title='2008-12-23 15:46:23 +0000'>2008-12-23</span></td><td><a href='/lcd4linux.git/commit/plugins.m4?h=master&amp;id=91348c5ecee2d7b22b2cb8d0af5a41d309efab91&amp;follow=1'>hddtemp plugin from Scott Bronson</a></td><td>michael</td><td>7</td><td><span class='deletions'>-0</span>/<span class='insertions'>+343</span></td></tr>
<tr><td><span title='2008-12-23 14:55:32 +0000'>2008-12-23</span></td><td><a href='/lcd4linux.git/commit/drv_Crystalfontz.c?h=master&amp;id=c881473ad3e54d4f9c149358173b52b3405262c7&amp;follow=1'>keypad bug fixed</a></td><td>michael</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2008-12-23 13:37:07 +0000'>2008-12-23</span></td><td><a href='/lcd4linux.git/commit/drv_generic_parport.c?h=master&amp;id=8b185a53fc6c35d570987ab9ff2c194dcaa24cd2&amp;follow=1'>patch from a.nielsen: inverted parport signals, support GPI on HD44780</a></td><td>michael</td><td>2</td><td><span class='deletions'>-24</span>/<span class='insertions'>+89</span></td></tr>
<tr><td><span title='2008-12-23 13:28:14 +0000'>2008-12-23</span></td><td><a href='/lcd4linux.git/commit/drv_LCDLinux.c?h=master&amp;id=87b31372d32f6f0a3d90790392b7024823d1cc1e&amp;follow=1'>indent run</a></td><td>michael</td><td>1</td><td><span class='deletions'>-4</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2008-11-25 20:38:34 +0000'>2008-11-25</span></td><td><a href='/lcd4linux.git/commit/drv_LCDLinux.c?h=master&amp;id=6ab08ab6c2eb5db99af7d011a9fd8526af3b0aed&amp;follow=1'>fix lcd4linux driver for multible onboard controllers</a></td><td>michux</td><td>1</td><td><span class='deletions'>-4</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2008-11-23 00:20:58 +0000'>2008-11-23</span></td><td><a href='/lcd4linux.git/commit/drivers.m4?h=master&amp;id=0c9798c9429cabcded458ba127972ea096e69978&amp;follow=1'>fix automake - check for libftdi</a></td><td>michux</td><td>4</td><td><span class='deletions'>-9</span>/<span class='insertions'>+173</span></td></tr>
<tr><td><span title='2008-11-22 23:46:47 +0000'>2008-11-22</span></td><td><a href='/lcd4linux.git/commit/plugin_button_exec.c?h=master&amp;id=5162ea943ae34684aacdb8fe29da91e6a974979e&amp;follow=1'>update button_exec plugin - fix segfault</a></td><td>michux</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2008-11-22 23:34:20 +0000'>2008-11-22</span></td><td><a href='/lcd4linux.git/commit/plugin_fifo.c?h=master&amp;id=98870dbee74445b3d7de7468fccdb3ef4d6d2ff2&amp;follow=1'>update fifo plugin - untested</a></td><td>michux</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2008-10-07 19:32:42 +0000'>2008-10-07</span></td><td><a href='/lcd4linux.git/commit/drv_picoLCDGraphic.c?h=master&amp;id=3654ca81e0aa3116c24d849336560cc96ff73f11&amp;follow=1'>Replace write to external variable usb_debug by calling usb_set_debug().</a></td><td>bwalle</td><td>7</td><td><span class='deletions'>-16</span>/<span class='insertions'>+7</span></td></tr>
<tr><td><span title='2008-10-06 04:29:12 +0000'>2008-10-06</span></td><td><a href='/lcd4linux.git/commit/drv_picoLCD.c?h=master&amp;id=a80978985167df7650209888a5a89ea8089c091d&amp;follow=1'>adding GPI to picoLCD for reading button events  by Igor Mammedov &lt;niallain@g...</a></td><td>michael</td><td>1</td><td><span class='deletions'>-1</span>/<span class='insertions'>+22</span></td></tr>
<tr><td><span title='2008-10-06 04:25:14 +0000'>2008-10-06</span></td><td><a href='/lcd4linux.git/commit/plugin_time.c?h=master&amp;id=c43556a211b45fefe29b73d912c7cc6ff6d8bfdf&amp;follow=1'>properties fixed</a></td><td>michael</td><td>11</td><td><span class='deletions'>-3290</span>/<span class='insertions'>+2675</span></td></tr>
<tr><td><span title='2008-10-05 16:57:13 +0000'>2008-10-05</span></td><td><a href='/lcd4linux.git/commit/configure?h=master&amp;id=5592dc410563ea62d44ff341a7b12bf564a809f4&amp;follow=1'>Rebuild auto-generated autoconf stuff due to last change in drivers.m4.</a></td><td>bwalle</td><td>3</td><td><span class='deletions'>-2657</span>/<span class='insertions'>+3297</span></td></tr>
<tr><td><span title='2008-10-05 16:55:26 +0000'>2008-10-05</span></td><td><a href='/lcd4linux.git/commit/drivers.m4?h=master&amp;id=7e4ae629678f086951b4ae213bc3dc17c04b27ee&amp;follow=1'>Add 'ULA200' driver when --with-drivers=all is specified</a></td><td>bwalle</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2008-09-14 04:00:49 +0000'>2008-09-14</span></td><td><a href='/lcd4linux.git/commit/plugin_time.c?h=master&amp;id=7695365a0e6ffada25b74e1ac8fa0a54bc5aa32d&amp;follow=1'>strftime_tz patch from Bernhard Walle</a></td><td>michael</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+11</span></td></tr>
<tr><td><span title='2008-09-08 01:52:03 +0000'>2008-09-08</span></td><td><a href='/lcd4linux.git/commit/plugin_time.c?h=master&amp;id=a97c5c7ecd9800e86882af4476e2dc6098b78cfb&amp;follow=1'>strftime_tz() plugin by Bernhard Walle</a></td><td>michael</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+25</span></td></tr>
<tr><td><span title='2008-09-03 03:28:52 +0000'>2008-09-03</span></td><td><a href='/lcd4linux.git/commit/smoketest.sh?h=master&amp;id=e6f31f6b7949440cd735d0184c846aa2a3330f23&amp;follow=1'>ULA200 driver by Bernhard Walle</a></td><td>michael</td><td>7</td><td><span class='deletions'>-2</span>/<span class='insertions'>+825</span></td></tr>
<tr><td><span title='2008-09-03 03:26:29 +0000'>2008-09-03</span></td><td><a href='/lcd4linux.git/commit/drv_D4D.c?h=master&amp;id=1285008c5f75c28d6304ba984c432992c450ba3a&amp;follow=1'>indent</a></td><td>michael</td><td>1</td><td><span class='deletions'>-4</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2008-08-31 18:27:53 +0000'>2008-08-31</span></td><td><a href='/lcd4linux.git/commit/drv_generic_serial.c?h=master&amp;id=02b0138a4213eff843990f96531cf31918d6dfe2&amp;follow=1'>Increased the maximum bps to 230400, if defined in &lt;termios.h&gt;.</a></td><td>sonic74</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+7</span></td></tr>
<tr><td><span title='2008-08-27 22:32:47 +0000'>2008-08-27</span></td><td><a href='/lcd4linux.git/commit/drv_D4D.c?h=master&amp;id=9e0932674b6e85098e3902f4c3083e80c9590be5&amp;follow=1'>git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@889 3ae390bd-cb1e-0410-...</a></td><td>sonic74</td><td>1</td><td><span class='deletions'>-18</span>/<span class='insertions'>+11</span></td></tr>
<tr><td><span title='2008-08-27 03:30:06 +0000'>2008-08-27</span></td><td><a href='/lcd4linux.git/commit/drv_D4D.c?h=master&amp;id=b645e0908429a1ed5c61f2708931bfa026254d52&amp;follow=1'>D4D updates by Sven</a></td><td>michael</td><td>1</td><td><span class='deletions'>-38</span>/<span class='insertions'>+60</span></td></tr>
<tr><td><span title='2008-08-03 03:10:49 +0000'>2008-08-03</span></td><td><a href='/lcd4linux.git/commit/smoketest.sh?h=master&amp;id=38367abf672c32015cacd8b469c390a048f2c97f&amp;follow=1'>driver for 4D Systems serial displays by Sven Killig</a></td><td>michael</td><td>9</td><td><span class='deletions'>-45</span>/<span class='insertions'>+846</span></td></tr>
<tr><td><span title='2008-08-03 02:44:22 +0000'>2008-08-03</span></td><td><a href='/lcd4linux.git/commit/drv_IRLCD.c?h=master&amp;id=e91cbd072ab678b68095a5e81fc37df6ae44c975&amp;follow=1'>signed/unsigned mismatch</a></td><td>michael</td><td>1</td><td><span class='deletions'>-3</span>/<span class='insertions'>+3</span></td></tr>
<tr><td><span title='2008-07-26 14:41:51 +0000'>2008-07-26</span></td><td><a href='/lcd4linux.git/commit/plugin_mpd.c?h=master&amp;id=58d42c80d71e628ddf8fc32cae477f17cb3a3f25&amp;follow=1'>added command functions</a></td><td>michux</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+130</span></td></tr>
<tr><td><span title='2008-07-15 10:22:19 +0000'>2008-07-15</span></td><td><a href='/lcd4linux.git/commit/svn_version.h?h=master&amp;id=b243fddf0754e8d193febc0598941fd1638ff33b&amp;follow=1'>added IRLCD driver by Jean-Philippe Civade</a></td><td>michael</td><td>10</td><td><span class='deletions'>-5</span>/<span class='insertions'>+467</span></td></tr>
<tr><td><span title='2008-07-15 09:55:18 +0000'>2008-07-15</span></td><td><a href='/lcd4linux.git/commit/mkinstalldirs?h=master&amp;id=38a69aee81b48e2df7714310c39b5cdf171b9123&amp;follow=1'>'autoreconf -f -i' run &amp; config.rpath added</a></td><td>michael</td><td>8</td><td><span class='deletions'>-370</span>/<span class='insertions'>+1617</span></td></tr>