Ticket #391: USBBASIC.TXT

File USBBASIC.TXT, 13.0 KB (added by mckinnis, 10 years ago)
Line 
1Universal Serial Bus Base Stack README
2
3September 23, 2004
4
5   OS/2 Device Driver Development
6   IBM Solution Technologies
7   Austin, TX
8
9This README contains information on
10the Universal Serial Bus (USB) Basic Device Driver Support (USBBASIC)
11for OS/2. The following versions of OS/2 are supported by this package:
12
13  OS/2 Warp 3,
14  OS/2 Warp 4,
15  OS/2 Warp Server for e-business,
16  OS/2 Warp 4 Convenience Pack 1,
17  OS/2 Warp 4 Convenience Pack 2,
18  OS/2 Warp Server for e-business Convenience Pack 1,
19  OS/2 Warp Server for e-business Convenience Pack 2.
20
21
22CONTENTS
23________
24
251.0 Introduction
262.0 USB-Basic Support
27  2.1 Installation Instructions
28  2.2 Adding the USB Basic stack to the OS/2 Installation Disks
29      or Utility Diskettes
30    2.2.1 Modifying Diskette 1
31  2.3 Additional Driver  Parameters
32    2.3.1 USBD driver parameters for BASEDEV=USBD.SYS
33    2.3.2 USBHID driver parameters for BASEDEV=USBHID.SYS
34    2.3.3 USBOHCD driver parameters for BASEDEV=USBOHCD.SYS
35    2.3.4 USBUHCD driver parameters for BASEDEV=USBUHCD.SYS
36    2.3.5 USBEHCD driver parameters for BASEDEV=USBEHCD.SYS
37  2.4 Un-Install Instructions
38  2.5 Recomendations
39  2.6 Tested UHCI Adapters
40  2.7 Tested OHCI Adapters
41  2.8 Tested EHCI Adapters
42  2.9 Hardware Requirements
433.0  Copyright and Trademark Information
44
45
461.0  Introduction
47_________________
48
49This USBBASIC.EXE driver package provides you with IBM's most current support
50for Universal Serial Bus (USB) devices on the OS/2 Operating System. It contains
51support for three types of host controller interfaces:
52
53  Open Host Controller Interface (OHCI)
54  Universal Host Controller Interface (UHCI).
55  Enhanced Host Controller Interface (EHCI).
56
57This package is a prerequisite for all the other USB packages.
58
591.1  The USBBASIC.EXE file is a self extracting file that contains
60     the following (15) files.
61
62     -  HCIMONIT.EXE  Host Controller adapter(s) monitor utility
63     -  HCIMONIT.SYM  Debug symbol file for HCIMONIT.EXE
64     -  USBBASIC.TXT  This readme file
65     -  USBD.SYS      USB Base Driver
66     -  USBD.SYM      Debug symbol file for USBD.SYS
67     -  USBEHCD.SYS   EHCI compliant USB host controller driver
68     -  USBEHCD.SYM   Debug symbol file for USBEHCD.SYS
69     -  USBHID.SYS    USB Human Interface Driver
70     -  USBHID.SYM    Debug symbol file for USBHID.SYS
71     -  USBINST.EXE   Installation executable that installs USB Base Stack
72     -  USBINST.SYM   Debug symbol file for USBINST.EXE
73     -  USBOHCD.SYS   OHCI compliant USB host controller driver
74     -  USBOHCD.SYM   Debug symbol file for USBOHCD.SYS
75     -  USBUHCD.SYS   UHCI compliant USB host controller driver
76     -  USBUHCD.SYM   Debug symbol file for USBUHCD.SYS
77
78
792.0  USB-Basic Support
80______________________
81
822.1  Installation Instructions
83==============================
84
852.1.1  To use the USB driver files, you must first expand the USBBASIC.EXE package
86       file into its (7) component files by performing the following:
87       (a.) opening an OS/2 window
88       (b.) changing to the directory where USBBASIC.EXE is stored
89       (c.) type USBBASIC at the OS/2 command prompt (this will extract the files).
90
91       Continue with the USB Installation Instructions.
92
932.1.2  Execute the Host Controller Utility (HCIMONIT.EXE).
94       It reports the number of UHCI, OHCI and EHCI Host controllers
95       contained on your system. If no UHCI, OHCI or EHCI
96       Host controllers are reported, you do not need to continue
97       with the install. If you do not have a USB Host controller,
98       you will not have any USB capability.
99
100At the OS/2 command prompt, type USBINST.
101USBINST installs the USB drivers or refresh the USB support currently on your PC.
102
103If installing on an IBM 365 system add the parameter /FS to the USBUHCD entry
104in CONFIG.SYS (for parameter explanation see section 2.3).
105
106This completes the USBBASIC installation procedure. You must REBOOT your system.
107You can install any of the other additional USB device drivers
108after you have REBOOTed the system.
109
110
1112.2 Adding USB Basic support to the OS/2 Installation Disks or Utility Diskettes
112================================================================================
113
114The USB Basic Device Support package provides the host controller interface
115support for USB. It is a prerequisite for all USB device support
116and must be the first USB drivers added to the Installation diskettes or
117Utility diskettes and allows use of any USB devices when booting.
118Individual USB device support packages can then be added to the Installation or
119Utility diskettes. (eg. USB Diskette, USB CDROM, USB Keyboard, USB Mouse, etc.)
120Refer to the readme included in the individual USB device support package for
121instructions on updating the diskettes. If there is insufficient disk space on
122the boot diskettes for the additional USB drivers, then follow the procedure
123in the README.TXT found in the root directory
124of your OS/2 system on the procedure to make additional space on the boot diskettes. 
125When removing existing files from the Installation or Utility diskettes, make sure
126you remove or comment out the corresponding statements from both the CONFIG.SYS file
127and the SNOOPER.LST (if it exists) file. As a general rule, driver updates/additions
128to the installation or utility diskettes will require driver file replacement or
129additions and changes to both the CONFIG.SYS file and the SNOOPER.LST file.
130
1312.2.1 Modifying Diskette 1
132
133First determine the number and type of USB host controllers contained on your system
134by performing the following instructions from section 2.1.2.
135
136Add the following sequence of statements
137to the CONFIG.SYS file on the Diskette 1:
138
139  SET SAVECONNECT=1
140  SET COPYFROMFLOPPY=1
141  BASEDEV=USBD.SYS /I13
142
143  BASEDEV=USBUHCD.SYS (one copy of this statement for each UHCI controller reported by HCIMONIT utility)
144
145  BASEDEV=USBOHCD.SYS (one copy of this statement for each OHCI controller reported by HCIMONIT utility)
146
147  BASEDEV=USBEHCD.SYS (one copy of this statement for each EHCI controller reported by HCIMONIT utility)
148
149  BASEDEV=USBHID.SYS
150
151Copy the following USB Device Drivers files to the Diskette:
152
153  USBD.SYS    ( USB Base Driver )
154  USBUHCD.SYS ( USB UHCI Host Controller Driver)
155  USBOHCD.SYS ( USB OHCI Host Controller Driver )
156  USBEHCD.SYS ( USB EHCI Host Controller Driver )
157  USBHID.SYS  ( USB Human Interface Driver )
158
159
160For Warp 4 and Warp 3 the IDEDASD package from the OS/2 DDPak also should be
161applied if installing OS/2 on a hard drive larger than 8.4GB.
162
163Note: After installation from the modified diskettes remove the parameter /I13 from
164      the statement BASEDEV=USBD.SYS and rearrange the USB device driver statements
165      in the following order:
166         1. USB Host Controller Driver statements like
167            BASEDEV=USBUHCD.SYS,
168            BASEDEV=USBOHCD.SYS,
169            BASEDEV=USBEHCD.SYS
170         2. USB Base Driver statement
171            BASEDEV=USBD.SYS
172         3. Any Other USB Driver statements
173
174
1752.3 Additional Driver Parameters
176================================
177
178The following are additional parameter that you can use in CONFIG.SYS
179for the USB Basic Drivers:
180
1812.3.1 USBD driver parameters for BASEDEV=USBD.SYS
182
183PARAMETER       FUNCTION
184
185   /V           Verbose Mode, displays driver information during OS/2
186                initialization.
187
188
189   /I13          /I13 parameter could be used to delay USB host
190                 overtaking by the USB driver stack until after other
191                 device drivers finish required initialization operations.
192                 It could be used to boot from the USB floppy drive.
193
194                 /REQ parameter controls USBD driver initialization:
195                 driver at initalization time checks for a listed host
196                 controller and fail to load if no
197                 listed driver is loaded. The USB stack
198                 supports the following parameter settings:
199
200  /REQ:USBUHCD$  USBD driver is loaded only if UHCI compliant host driver is loaded
201  /REQ:USBOHCD$  USBD driver is loaded only if OHCI compliant host driver is loaded
202  /REQ:USBEHCD$  USBD driver is loaded only if EHCI compliant host driver is loaded
203
204  /REQ:USBUHCD$,USBOHCD$,USBEHCD$
205                 USBD driver is loaded only if one of the OHCI/UHCI/EHCI compliant
206                 host drivers is loaded. This most general form of parameter
207                 and must be used in most cases. If you are using /REQ parameter
208                 all statements "BASEDEV=USBUHCD.SYS", "BASEDEV=USBOHCD.SYS"
209                 and "BASEDEV=USBEHCD.SYS" must be first in the sequence of
210                 USB statements.
211
2122.3.2 USBHID driver parameters for BASEDEV=USBHID.SYS
213
214PARAMETER       FUNCTION
215
216  /V            Verbose Mode, displays driver information
217                during OS/2 initialization.
218
2192.3.3 USBOHCD driver parameters for BASEDEV=USBOHCD.SYS
220
221PARAMETER       FUNCTION
222
223  /V            Verbose Mode, displays driver information during OS/2
224                initialization.
225
226  /FS           Forces the driver to stop the USB host during the OS/2 shutdown process.
227                This parameter can be used to prevent POST (power on system
228                test) failures on some hardware with a legacy keyboard.
229
2302.3.4 USBUHCD driver parameters for BASEDEV=USBUHCD.SYS
231
232PARAMETER       FUNCTION
233
234  /V            Verbose Mode, displays driver information during OS/2
235                initialization.
236
237  /FS           Forces the driver to stop the USB host during the OS/2 shutdown process.
238                This parameter can be used to prevent POST (power on system
239                test) failures on some hardware with a legacy keyboard.
240
2412.3.5 USBEHCD driver parameters for BASEDEV=USBEHCD.SYS
242
243PARAMETER       FUNCTION
244
245  /V            Verbose Mode, displays driver information during OS/2
246                initialization.
247
248  /FS           Forces the driver to stop the USB host during OS/2 shutdown process.
249                This parameter can be used to prevent POST (power on system
250                test) failures on some hardware with a legacy keyboard.
251
252
2532.4  Un-Install Instructions
254============================
255
256Delete or remark out the following lines from CONFIG.SYS file starting with
257   BASEDEV=USBD.SYS
258   BASEDEV=USBHID.SYS
259   BASEDEV=USBOHCD.SYS
260   BASEDEV=USBEHCD.SYS
261   BASEDEV=USBUHCD.SYS
262and delete the following files from the \os2\boot directory:
263   USBD.SYS
264   USBHID.SYS
265   USBOHCD.SYS
266   USBUHCD.SYS
267   USBEHCD.SYS
268
269Safely shut down and then re-boot your system to have those changes take affect.
270
271
2722.5 Recommendations when not using any USB devices
273==================================================
274
275If you are running OS/2 on an IBM ThinkPad or other notebook system and you
276do not use any USB devices then you may want to "remark" out the USB device driver
277statements in your CONFIG.SYS file. You can remark out a USB device driver by
278preceding the line in config.sys with "rem " or "REM ". This action may lower
279your notebook's system power requirements and may help to extend the battery's
280operating life.
281
282
2832.6 Tested UHCI Adapters
284========================
285
286The following are UCHI Adapters that have been tested:
287
288D-Link DU-A2 PCI USB controller
289
290Intel 82371AB/EB PCI to USB Universal Host Controller
291
292Intel 82801AA USB Universal Host Controller
293
294Intel 82801CA/CAM USB Universal Host Controller
295
296
2972.7 Tested OHCI Adapters
298========================
299
300The following are OCHI Adapters that have been tested:
301
302Belkin USB BusPort F5U005
303
304Entrega PCI4U 4Port USB Upgrade
305
306Sis 7001 PCI to USB Open Host Controller
307
308
3092.8 Tested EHCI Adapters
310========================
311
312The following are ECHI Adapters that have been tested:
313
314Adaptec USB2Connect Adapter Card AUA-3100LP
315
316Intel 845 based motherboard with built-in USB 2.0 chipset
317
318USB 2.0 Hi-Speed PCI Card F5U220
319
320
3212.9  Hardware Requirements
322==========================
323
324Any PCI to USB Host Controller bridge compatible with the
325USB version 1.1 or 2.0 specifications and using at least one of the
326UHCI, OHCI or EHCI interfaces.
327
328
3293.0  Copyright and Trademark Information
330________________________________________
331
332The following terms, are registered trademarks of the International
333Business Machines Corporation in the United States, or other countries,
334or both:
335o IBM
336o OS/2
337o Warp
338
339Other company, product, and service names may be trademarks or service
340marks of others.
341
342THE INFORMATION PROVIDED IN THIS README IS PROVIDED "AS IS" WITHOUT
343WARRANTY OF ANY KIND.  IBM DISCLAIMS ALL WARRANTIES, WHETHER
344EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION, THE IMPLIED
345WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE AND MERCHANTABILITY
346WITH RESPECT TO THE INFORMATION IN THIS DOCUMENT. BY FURNISHING
347THIS DOCUMENT, IBM GRANTS NO LICENSES TO ANY PATENTS OR COPYRIGHTS.
348
349(C) Copyright IBM Corporation, 2001, 2004. All rights reserved.
350U.S. Government Users Restricted Rights -- Use, duplication or
351disclosure restricted by GSA ADP Schedule Contract with IBM Corp.