]> git.decadent.org.uk Git - exar-uart-driver.git/blob - README.exar
Add readme and copy of GPLv2
[exar-uart-driver.git] / README.exar
1 Vizzini USB Serial
2 ==================
3
4 Version 1.0, 06/11/2013
5
6 The source code is compatible with these kernel versions (and probably others):
7     3.5.0 and newer.
8
9
10 Installation
11 ------------
12
13 * Make sure the Vizzini device is unplugged from the Linux host.
14
15 * Make sure that the cdc-acm driver and any previously loaded vizzini
16   driver modules are not loaded.
17
18         # rmmod cdc_acm
19         # rmmod vizzini
20         # modprobe -r usbserial
21
22 * Install the vizzini driver module.
23
24         # modprobe usbserial
25         # insmod ./vizzini.ko
26
27 * Plug Vizzini into the host.  You should see four devices created,
28   typically /dev/ttyUSB[0-3].
29
30
31 Operation
32 ---------
33
34 The vizzini driver presents a standard Linux TTY interface that can be
35 configured and manipulated with the usual APIs (tcgetattr(),
36 tcsetattr(), ioctl(), read(), write(), etc).
37
38 The normal supported character modes are 7N1, 7N2, 7P1, 7P2, 8N1, 8N2,
39 8P1, 8P2, with odd, even, mark and space parity.
40
41 Vizzini also supports 9N1 and 9N2.  It is enabled by using the CS5
42 character size.  In this mode a 9-bit character can be written to the
43 device with two bytes.  Bits 0..7 of the character are taken from the
44 first byte, and bit-8 of the character is taken from bit-0 of the
45 second byte.
46
47 Similarly, a 9-bit character can be read from the device as a pair of
48 bytes.  Bits 0..7 of the character are in the first byte, and bit-8 of
49 the character is taken from bit-0 of the second byte.  Bits 1..7 of
50 the second byte are undefined.
51