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