diff --git a/docs/lcdproc-user/drivers/IOWarrior.docbook b/docs/lcdproc-user/drivers/IOWarrior.docbook index 9e55eae..4d42471 100644 --- a/docs/lcdproc-user/drivers/IOWarrior.docbook +++ b/docs/lcdproc-user/drivers/IOWarrior.docbook @@ -1,11 +1,82 @@ The IOWarrior Driver + +General + -This section talks about using LCDproc with LCD displays that use the -IOWarrior chipset. +IOWarrior is the name of a series of multi-purpose USB controller chips +produced and sold by Code Mercenaries. +This series currently consists of three main types, that - among other features - +support controlling LCD displays: + + + + IOWarrior24 + + + USB 1.1 Low Speed + 16 generic I/O Pins, typ. 125Hz read rate + I2C master function, 100kHz, throughput typ. 750 bytes/sec + SPI master interface, up to 2MHz, throughput typ. 750 bytes/sec + control an HD44780 compatible LCD + drive a matrix of up to 8x32 LEDs + decode RC5 compatible infrared remote controls + + + + + + IOWarrior40 + + + USB 1.1 Low Speed + 32 generic I/O Pins, typ. 125Hz read rate + I2C master function, 100kHz, throughput typ. 750 bytes/sec + control an HD44780 compatible LCD + drive a matrix of up to 8x32 LEDs + drive a 8x8 switch or button matrix + + + + + + IOWarrior56 + + + USB 1.1 Full Speed + 50 generic I/O Pins, typ. 1000Hz read rate + I2C master function, 50, 100, or 400kHz + SPI master interface, up to 12MHz, throughput up to 62Kbytes/sec + control various display modules, including most graphic modules + drive a matrix of up to 8x64 LEDs + drive a 8x8 switch or button matrix + + + + + +The IOWarrior driver currently only supports writing +to a single-controller HD44780-type display. +LED output using the output() function is also implemented, +although not tested very well. +The hardware's support for input using keys or IR and multi-controller displays +is not implemented yet. +The latter requres extra circuitry for IOWarrior24 and IOWarrior40. + + + +The driver was developed and tested with IOWarrior24 and the IOWarrior40. +Although there are chances for it to work with an IOWarrior50, +the current state regarding support of this chip is unknown due to the +lack of the required hardware. + + + + + Configuration in LCDd.conf @@ -24,8 +95,7 @@ IOWarrior chipset. - display dimensions - Default: 20x4. + Set the display dimensions. If not given, it defaults to 20x4. @@ -35,8 +105,8 @@ IOWarrior chipset. SERIALNO - serial number [exactly as listed by usbview] - (if not given, the 1st IOWarrior found gets used) + Use the IOWarrior module with the serial number SERIALNO. + If this parameter is missing, the default is to use the first IOWarrior module found. @@ -52,7 +122,8 @@ IOWarrior chipset. Specifies if the last line is pixel addressable or it controls an - underline effect. [default: yes (= pixel addressable); legal: yes, no] + underline effect. + The default yes means, it is pixel addressable.