# BRCM_VERSION=3
[bcm963xx.git] / kernel / linux / Documentation / usb / silverlink.txt
1 -------------------------------------------------------------------------
2 Readme for Linux device driver for the Texas Instruments SilverLink cable
3 -------------------------------------------------------------------------
4
5 Author: Romain LiĆ©vin & Julien Blache
6 Homepage: http://lpg.ticalc.org/prj_usb
7
8 INTRODUCTION:
9
10 This is a driver for the TI-GRAPH LINK USB (aka SilverLink) cable, a cable 
11 designed by TI for connecting their TI8x/9x calculators to a computer 
12 (PC or Mac usually).
13
14 If you need more information, please visit the 'SilverLink drivers' homepage 
15 at the above URL.
16
17 WHAT YOU NEED:
18
19 A TI calculator of course and a program capable to communicate with your 
20 calculator.
21 TiLP will work for sure (since I am his developer !). yal92 may be able to use
22 it by changing tidev for tiglusb (may require some hacking...).
23
24 HOW TO USE IT:
25
26 You must have first compiled USB support, support for your specific USB host
27 controller (UHCI or OHCI).
28
29 Next, (as root) from your appropriate modules directory (lib/modules/2.5.XX):
30
31        insmod usb/usbcore.o
32        insmod usb/usb-uhci.o  <OR>  insmod usb/ohci-hcd.o
33        insmod tiglusb.o
34
35 If it is not already there (it usually is), create the device:
36
37        mknod /dev/tiglusb0 c 115 16
38
39 You will have to set permissions on this device to allow you to read/write
40 from it:
41
42        chmod 666 /dev/tiglusb0
43        
44 Now you are ready to run a linking program such as TiLP. Be sure to configure 
45 it properly (RTFM).
46        
47 MODULE PARAMETERS:
48
49   You can set these with:  insmod tiglusb NAME=VALUE
50   There is currently no way to set these on a per-cable basis.
51
52   NAME: timeout
53   TYPE: integer
54   DEFAULT: 15
55   DESC: Timeout value in tenth of seconds. If no data is available once this 
56        time has expired then the driver will return with a timeout error.
57
58 QUIRKS:
59
60 The following problem seems to be specific to the link cable since it appears 
61 on all platforms (Linux, Windows, Mac OS-X). 
62
63 In some very particular cases, the driver returns with success but
64 without any data. The application should retry a read operation at least once.
65
66 HOW TO CONTACT US:
67
68 You can email me at roms@lpg.ticalc.org. Please prefix the subject line
69 with "TIGLUSB: " so that I am certain to notice your message.
70 You can also mail JB at jb@jblache.org: he has written the first release of 
71 this driver but he better knows the Mac OS-X driver.
72
73 CREDITS:
74
75 The code is based on dabusb.c, printer.c and scanner.c !
76 The driver has been developed independently of Texas Instruments.