[PATCH] added Tieman Voyager USB Braille driver

 added Tieman Voyager USB Braille driver

CREDITS

@@ -637,6 +637,11 @@ S: Northampton
 S: NN1 3QT
 S: United Kingdom
 
+N: Stephane Dalton
+E: sdalton@videotron.ca
+D: Tieman Voyager USB Braille display driver.
+S: Qubec, Canada
+
 N: Uwe Dannowski
 E: Uwe.Dannowski@ira.uka.de
 W: http://i30www.ira.uka.de/~dannowsk/
@@ -743,6 +748,11 @@ E: cort@fsmlabs.com
 W: http://www.fsmlabs.com/linuxppcbk.html
 D: PowerPC
 
+N: Stphane Doyon
+E: s.doyon@videotron.ca
+D: Tieman Voyager USB Braille display driver.
+S: Qubec, Canada
+
 N: Oleg Drokin
 E: green@ccssu.crimea.ua
 W: http://www.ccssu.crimea.ua/~green

Documentation/usb/brlvger.txt

+Kernel Driver for the Tieman Voyager Braille Display (USB)
+
+Authors:
+Stéphane Dalton <sdalton@videotron.ca>
+Stéphane Doyon  <s.doyon@videotron.ca>
+
+Version 0.8, April 17, 2002
+
+The brlvger driver supports a Braille display (aka Braille terminal)
+model Voyager from Tieman.
+
+The driver has been in heavy use for about six months now (as of April
+17th 2002) by a very few users (about 3-4), who say it has worked very
+well for them.
+
+We have tested it with a Voyager 44, but it should also support
+the Voyager 70.
+
+This driver implements a character device which allows userspace programs
+access to the braille displays raw functions. You still need a userspace
+program to perform the screen-review functions and control the
+display. Get BRLTTY from http://mielke.cc/brltty/ (version 2.99.8 or
+later). It has a Voyager driver which interfaces with this kernel driver.
+
+The interface is through a character device, major 180, minor 128, called
+"brlvger" under devfs.
+
+Many thanks to the Tieman people: Corand van Strien, Ivar Illing, Daphne
+Vogelaar and Ingrid Vogel. They provided us with a Braille display (as
+well as programming information) so that we could write this driver. They
+replaced the display when it broke and they answered our technical
+questions. It is very motivating when companies take an interest in such
+projects and are so supportive.
+
+Thanks to Andor Demarteau <ademarte@students.cs.uu.nl> who got this whole
+project started and beta-tested all our early buggy attempts.

MAINTAINERS

@@ -1514,6 +1514,13 @@ P:     Julien Blache
 M:     jb@technologeek.org
 S:     Maintained
 
+TIEMAN VOYAGER USB BRAILLE DISPLAY DRIVER
+P:      Stephane Dalton
+M:      sdalton@videotron.ca
+P:      Stphane Doyon
+M:      s.doyon@videotron.ca
+S:      Maintained
+
 TLAN NETWORK DRIVER
 P:	Torben Mathiasen
 M:	torben.mathiasen@compaq.com

drivers/usb/Config.in

@@ -32,6 +32,7 @@ if [ "$CONFIG_USB" = "y" -o  "$CONFIG_USB" = "m" ]; then
    dep_tristate '  Texas Instruments Graph Link USB (aka SilverLink) cable support' CONFIG_USB_TIGL $CONFIG_USB
    dep_tristate '  USB Auerswald ISDN support (EXPERIMENTAL)' CONFIG_USB_AUERSWALD $CONFIG_USB $CONFIG_EXPERIMENTAL
    dep_tristate '  USB Diamond Rio500 support (EXPERIMENTAL)' CONFIG_USB_RIO500 $CONFIG_USB $CONFIG_EXPERIMENTAL
+   dep_tristate '  Tieman Voyager USB Braille display support (EXPERIMENTAL)' CONFIG_USB_BRLVGER $CONFIG_USB $CONFIG_EXPERIMENTAL
 
 fi
 endmenu

drivers/usb/Makefile

@@ -53,6 +53,7 @@ subdir-$(CONFIG_USB_SCANNER)	+= image
 subdir-$(CONFIG_USB_SERIAL)	+= serial
 
 subdir-$(CONFIG_USB_AUERSWALD)	+= misc
+subdir-$(CONFIG_USB_BRLVGER)	+= misc
 subdir-$(CONFIG_USB_EMI26)	+= misc
 subdir-$(CONFIG_USB_RIO500)	+= misc
 subdir-$(CONFIG_USB_TIGL)	+= misc

drivers/usb/misc/Config.help

@@ -7,6 +7,16 @@ CONFIG_USB_AUERSWALD
   The module will be called auerswald.o. If you want to compile it as
   a module, say M here and read <file:Documentation/modules.txt>.
 
+CONFIG_USB_BRLVOYAGER
+  Say Y here if you want to use the Voyager USB Braille display from
+  Tieman. See <file:Documentation/usb/brlvger.txt> for more
+  information.
+
+  This code is also available as a module ( = code which can be
+  inserted in and removed from the running kernel whenever you want).
+  The module will be called brlvger.o. If you want to compile it as
+  a module, say M here and read <file:Documentation/modules.txt>.
+
 CONFIG_USB_EMI26
   This driver loads firmware to Emagic EMI 2|6 low latency USB
   Audio interface.

drivers/usb/misc/Makefile

@@ -6,6 +6,7 @@
 O_TARGET	:= misc.o
 
 obj-$(CONFIG_USB_AUERSWALD)	+= auerswald.o
+obj-$(CONFIG_USB_BRLVGER)	+= brlvger.o
 obj-$(CONFIG_USB_EMI26)		+= emi26.o
 obj-$(CONFIG_USB_RIO500)	+= rio500.o
 obj-$(CONFIG_USB_TIGL)		+= tiglusb.o

include/linux/brlvger.h

+/*
+ *      Tieman Voyager braille display USB driver.
+ *
+ *      Copyright 2001-2002 Stephane Dalton <sdalton@videotron.ca>
+ *                      and Stphane Doyon  <s.doyon@videotron.ca>
+ *            Maintained by Stphane Doyon  <s.doyon@videotron.ca>.
+ */
+/*
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  (at your option) any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef _LINUX_BRLVGER_H
+#define _LINUX_BRLVGER_H
+
+/* Ioctl request codes */
+#define BRLVGER_GET_INFO	0
+#define BRLVGER_DISPLAY_ON	2
+#define BRLVGER_DISPLAY_OFF	3
+#define BRLVGER_BUZZ		4
+
+/* Number of supported devices, and range of covered minors */
+#define MAX_NR_BRLVGER_DEVS	2
+
+/* Base minor for the char devices */
+#define BRLVGER_MINOR		128
+
+/* Size of some fields */
+#define BRLVGER_HWVER_SIZE	2
+#define BRLVGER_FWVER_SIZE	200 /* arbitrary, a long string */
+#define BRLVGER_SERIAL_BIN_SIZE	8
+#define BRLVGER_SERIAL_SIZE	((2*BRLVGER_SERIAL_BIN_SIZE)+1)
+
+struct brlvger_info {
+	__u8 driver_version[12];
+	__u8 driver_banner[200];
+
+	__u32 display_length;
+	/* All other char[] fields are strings except this one.
+	   Hardware version: first byte is major, second byte is minor. */
+	__u8 hwver[BRLVGER_HWVER_SIZE];
+	__u8 fwver[BRLVGER_FWVER_SIZE];
+	__u8 serialnum[BRLVGER_SERIAL_SIZE];
+};
+
+#endif