| 1 | Universal Serial Bus Base Stack README |
|---|
| 2 | |
|---|
| 3 | September 23, 2004 |
|---|
| 4 | |
|---|
| 5 | OS/2 Device Driver Development |
|---|
| 6 | IBM Solution Technologies |
|---|
| 7 | Austin, TX |
|---|
| 8 | |
|---|
| 9 | This README contains information on |
|---|
| 10 | the Universal Serial Bus (USB) Basic Device Driver Support (USBBASIC) |
|---|
| 11 | for 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 | |
|---|
| 22 | CONTENTS |
|---|
| 23 | ________ |
|---|
| 24 | |
|---|
| 25 | 1.0 Introduction |
|---|
| 26 | 2.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 |
|---|
| 43 | 3.0 Copyright and Trademark Information |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | 1.0 Introduction |
|---|
| 47 | _________________ |
|---|
| 48 | |
|---|
| 49 | This USBBASIC.EXE driver package provides you with IBM's most current support |
|---|
| 50 | for Universal Serial Bus (USB) devices on the OS/2 Operating System. It contains |
|---|
| 51 | support 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 | |
|---|
| 57 | This package is a prerequisite for all the other USB packages. |
|---|
| 58 | |
|---|
| 59 | 1.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 | |
|---|
| 79 | 2.0 USB-Basic Support |
|---|
| 80 | ______________________ |
|---|
| 81 | |
|---|
| 82 | 2.1 Installation Instructions |
|---|
| 83 | ============================== |
|---|
| 84 | |
|---|
| 85 | 2.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 | |
|---|
| 93 | 2.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 | |
|---|
| 100 | At the OS/2 command prompt, type USBINST. |
|---|
| 101 | USBINST installs the USB drivers or refresh the USB support currently on your PC. |
|---|
| 102 | |
|---|
| 103 | If installing on an IBM 365 system add the parameter /FS to the USBUHCD entry |
|---|
| 104 | in CONFIG.SYS (for parameter explanation see section 2.3). |
|---|
| 105 | |
|---|
| 106 | This completes the USBBASIC installation procedure. You must REBOOT your system. |
|---|
| 107 | You can install any of the other additional USB device drivers |
|---|
| 108 | after you have REBOOTed the system. |
|---|
| 109 | |
|---|
| 110 | |
|---|
| 111 | 2.2 Adding USB Basic support to the OS/2 Installation Disks or Utility Diskettes |
|---|
| 112 | ================================================================================ |
|---|
| 113 | |
|---|
| 114 | The USB Basic Device Support package provides the host controller interface |
|---|
| 115 | support for USB. It is a prerequisite for all USB device support |
|---|
| 116 | and must be the first USB drivers added to the Installation diskettes or |
|---|
| 117 | Utility diskettes and allows use of any USB devices when booting. |
|---|
| 118 | Individual USB device support packages can then be added to the Installation or |
|---|
| 119 | Utility diskettes. (eg. USB Diskette, USB CDROM, USB Keyboard, USB Mouse, etc.) |
|---|
| 120 | Refer to the readme included in the individual USB device support package for |
|---|
| 121 | instructions on updating the diskettes. If there is insufficient disk space on |
|---|
| 122 | the boot diskettes for the additional USB drivers, then follow the procedure |
|---|
| 123 | in the README.TXT found in the root directory |
|---|
| 124 | of your OS/2 system on the procedure to make additional space on the boot diskettes. |
|---|
| 125 | When removing existing files from the Installation or Utility diskettes, make sure |
|---|
| 126 | you remove or comment out the corresponding statements from both the CONFIG.SYS file |
|---|
| 127 | and the SNOOPER.LST (if it exists) file. As a general rule, driver updates/additions |
|---|
| 128 | to the installation or utility diskettes will require driver file replacement or |
|---|
| 129 | additions and changes to both the CONFIG.SYS file and the SNOOPER.LST file. |
|---|
| 130 | |
|---|
| 131 | 2.2.1 Modifying Diskette 1 |
|---|
| 132 | |
|---|
| 133 | First determine the number and type of USB host controllers contained on your system |
|---|
| 134 | by performing the following instructions from section 2.1.2. |
|---|
| 135 | |
|---|
| 136 | Add the following sequence of statements |
|---|
| 137 | to 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 | |
|---|
| 151 | Copy 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 | |
|---|
| 160 | For Warp 4 and Warp 3 the IDEDASD package from the OS/2 DDPak also should be |
|---|
| 161 | applied if installing OS/2 on a hard drive larger than 8.4GB. |
|---|
| 162 | |
|---|
| 163 | Note: 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 | |
|---|
| 175 | 2.3 Additional Driver Parameters |
|---|
| 176 | ================================ |
|---|
| 177 | |
|---|
| 178 | The following are additional parameter that you can use in CONFIG.SYS |
|---|
| 179 | for the USB Basic Drivers: |
|---|
| 180 | |
|---|
| 181 | 2.3.1 USBD driver parameters for BASEDEV=USBD.SYS |
|---|
| 182 | |
|---|
| 183 | PARAMETER 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 | |
|---|
| 212 | 2.3.2 USBHID driver parameters for BASEDEV=USBHID.SYS |
|---|
| 213 | |
|---|
| 214 | PARAMETER FUNCTION |
|---|
| 215 | |
|---|
| 216 | /V Verbose Mode, displays driver information |
|---|
| 217 | during OS/2 initialization. |
|---|
| 218 | |
|---|
| 219 | 2.3.3 USBOHCD driver parameters for BASEDEV=USBOHCD.SYS |
|---|
| 220 | |
|---|
| 221 | PARAMETER 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 | |
|---|
| 230 | 2.3.4 USBUHCD driver parameters for BASEDEV=USBUHCD.SYS |
|---|
| 231 | |
|---|
| 232 | PARAMETER 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 | |
|---|
| 241 | 2.3.5 USBEHCD driver parameters for BASEDEV=USBEHCD.SYS |
|---|
| 242 | |
|---|
| 243 | PARAMETER 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 | |
|---|
| 253 | 2.4 Un-Install Instructions |
|---|
| 254 | ============================ |
|---|
| 255 | |
|---|
| 256 | Delete 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 |
|---|
| 262 | and 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 | |
|---|
| 269 | Safely shut down and then re-boot your system to have those changes take affect. |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | 2.5 Recommendations when not using any USB devices |
|---|
| 273 | ================================================== |
|---|
| 274 | |
|---|
| 275 | If you are running OS/2 on an IBM ThinkPad or other notebook system and you |
|---|
| 276 | do not use any USB devices then you may want to "remark" out the USB device driver |
|---|
| 277 | statements in your CONFIG.SYS file. You can remark out a USB device driver by |
|---|
| 278 | preceding the line in config.sys with "rem " or "REM ". This action may lower |
|---|
| 279 | your notebook's system power requirements and may help to extend the battery's |
|---|
| 280 | operating life. |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | 2.6 Tested UHCI Adapters |
|---|
| 284 | ======================== |
|---|
| 285 | |
|---|
| 286 | The following are UCHI Adapters that have been tested: |
|---|
| 287 | |
|---|
| 288 | D-Link DU-A2 PCI USB controller |
|---|
| 289 | |
|---|
| 290 | Intel 82371AB/EB PCI to USB Universal Host Controller |
|---|
| 291 | |
|---|
| 292 | Intel 82801AA USB Universal Host Controller |
|---|
| 293 | |
|---|
| 294 | Intel 82801CA/CAM USB Universal Host Controller |
|---|
| 295 | |
|---|
| 296 | |
|---|
| 297 | 2.7 Tested OHCI Adapters |
|---|
| 298 | ======================== |
|---|
| 299 | |
|---|
| 300 | The following are OCHI Adapters that have been tested: |
|---|
| 301 | |
|---|
| 302 | Belkin USB BusPort F5U005 |
|---|
| 303 | |
|---|
| 304 | Entrega PCI4U 4Port USB Upgrade |
|---|
| 305 | |
|---|
| 306 | Sis 7001 PCI to USB Open Host Controller |
|---|
| 307 | |
|---|
| 308 | |
|---|
| 309 | 2.8 Tested EHCI Adapters |
|---|
| 310 | ======================== |
|---|
| 311 | |
|---|
| 312 | The following are ECHI Adapters that have been tested: |
|---|
| 313 | |
|---|
| 314 | Adaptec USB2Connect Adapter Card AUA-3100LP |
|---|
| 315 | |
|---|
| 316 | Intel 845 based motherboard with built-in USB 2.0 chipset |
|---|
| 317 | |
|---|
| 318 | USB 2.0 Hi-Speed PCI Card F5U220 |
|---|
| 319 | |
|---|
| 320 | |
|---|
| 321 | 2.9 Hardware Requirements |
|---|
| 322 | ========================== |
|---|
| 323 | |
|---|
| 324 | Any PCI to USB Host Controller bridge compatible with the |
|---|
| 325 | USB version 1.1 or 2.0 specifications and using at least one of the |
|---|
| 326 | UHCI, OHCI or EHCI interfaces. |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | 3.0 Copyright and Trademark Information |
|---|
| 330 | ________________________________________ |
|---|
| 331 | |
|---|
| 332 | The following terms, are registered trademarks of the International |
|---|
| 333 | Business Machines Corporation in the United States, or other countries, |
|---|
| 334 | or both: |
|---|
| 335 | o IBM |
|---|
| 336 | o OS/2 |
|---|
| 337 | o Warp |
|---|
| 338 | |
|---|
| 339 | Other company, product, and service names may be trademarks or service |
|---|
| 340 | marks of others. |
|---|
| 341 | |
|---|
| 342 | THE INFORMATION PROVIDED IN THIS README IS PROVIDED "AS IS" WITHOUT |
|---|
| 343 | WARRANTY OF ANY KIND. IBM DISCLAIMS ALL WARRANTIES, WHETHER |
|---|
| 344 | EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION, THE IMPLIED |
|---|
| 345 | WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE AND MERCHANTABILITY |
|---|
| 346 | WITH RESPECT TO THE INFORMATION IN THIS DOCUMENT. BY FURNISHING |
|---|
| 347 | THIS DOCUMENT, IBM GRANTS NO LICENSES TO ANY PATENTS OR COPYRIGHTS. |
|---|
| 348 | |
|---|
| 349 | (C) Copyright IBM Corporation, 2001, 2004. All rights reserved. |
|---|
| 350 | U.S. Government Users Restricted Rights -- Use, duplication or |
|---|
| 351 | disclosure restricted by GSA ADP Schedule Contract with IBM Corp. |
|---|
