import of upstream 2.4.34.4 from kernel.org
[linux-2.4.git] / 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 graphing handhelds 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/handheld of course and a program capable to communicate with 
20 your calculator. A good choice is TiLP (http://www.tilp.info).
21
22 HOW TO USE IT:
23
24 You must have first compiled USB support, support for your specific USB host
25 controller (UHCI or OHCI).
26
27 Next, (as root) from your appropriate modules directory (lib/modules/2.5.XX):
28
29        insmod usb/usbcore.o
30        insmod usb/usb-uhci.o  <OR>  insmod usb/ohci-hcd.o
31        insmod tiglusb.o
32
33 If it is not already there (it usually is), create the device:
34
35        mknod /dev/tiglusb0 c 115 16
36
37 You will have to set permissions on this device to allow you to read/write
38 from it:
39
40        chmod 666 /dev/tiglusb0
41        
42 Now you are ready to run a linking program such as TiLP. Be sure to configure 
43 it properly (RTFM).
44        
45 MODULE PARAMETERS:
46
47   You can set these with:  insmod tiglusb NAME=VALUE
48   There is currently no way to set these on a per-cable basis.
49
50   NAME: timeout
51   TYPE: integer
52   DEFAULT: 15
53   DESC: Timeout value in tenth of seconds. If no data is available once this 
54        time has expired then the driver will return with a timeout error.
55
56 QUIRKS:
57
58 The following problem seems to be specific to the link cable since it appears 
59 on all platforms (Linux, Windows, Mac OS-X). A guy told me it was a common but
60 weird behaviour with Cypress microcontrollers (it uses an CY7C64013).
61
62 In some very particular cases, the driver returns with success (no error) but
63 without any data. The application should retry a read operation at least once.
64
65 This problem and the need to issue IOCTL_TIUSB_RESET_PIPES before doing any
66 packet transfer (like TI's software do) make this driver difficult to use in 
67 pure raw access.
68
69 HOW TO CONTACT US:
70
71 You can email me at roms@tilp.info. Please prefix the subject line
72 with "TIGLUSB: " so that I am certain to notice your message.
73 You can also mail JB at jb@jblache.org: he has written the first release of 
74 this driver but he better knows the Mac OS-X driver.
75
76 CREDITS:
77
78 The code is based on dabusb.c, printer.c and scanner.c !
79 The driver has been developed without any support from Texas Instruments Inc.