USBPRINT README October 15, 2001 OS/2 Device Driver Development IBM Solution Technologies Austin, TX This README contains information for the Universal Serial Bus (USB) Print Support for IBM OS/2 Warp 3.0 release with FixPak35, OS/2 Warp 4 with Fixpak6, WSoD v2.0 with FixPak11, OS/2 Warp Server for e-business, OS/2 Warp 4 Convenience Pack 1, OS/2 Warp 4 Convenience Pack 2, OS/2 Warp Server for e-business Convenience Pack 1, OS/2 Warp Server for e-business Convenience Pack 2. CONTENTS ________ 1.0 Introduction 2.0 USB-Print Support 2.1 USB Print Support Installation/upgrading 2.2 5.0 WSoD installation instructions 2.3 USB Print Driver Additional Parameters 2.4 USB Print Support Un-Install Instructions 2.5 List of Supported USB-Printers 2.6 Requirements 2.7 Dependencies 3.0 Copyright and Trademark Information 1.0 Introduction _________________ This USBPRTEN.EXE driver package provides you with IBM's most current support for Universal Serial Bus (USB) print devices on the OS/2 Operating System. 1.1 The USBPRTEN.EXE** file that you received contains the following files in a self-extracting compressed format. - USBPRINT.TXT This file that you are reading - RSPDDI.EXE Physical device driver installation utility - USBPRT.SYS USB physical printer driver - USBPRT.SYM - USBMON.EXE USB Auto Monitor Executable - USBPRT.DDP USB physical driver stack installation profile - USBPRT.PDR USB Printer Port driver - USBPRT.HLP USB Printer Port driver help file - CLEANUP.CMD Command file that deletes all USB print support files from installation directory to release disk space after installation - TSTUSBC.EXE Tests USB Stack **NOTE: The file name is language dependent, USBPRTEN.EXE is the English version name. 2.0 USB-Print Support ______________________ 2.1 USB-Print Installation/upgrading ===================================== 2.1.1 To use these USB driver files, you must expand the USBPRTEN.EXE file into its component files by (a.) opening an OS/2 window and (b.) typing USBPRTEN at the OS/2 command prompt. Once the USBPRTEN.EXE file is expanded, please continue with the USB Installation Instructions. 2.1.2 Open the existing (or create new) printer object properties window. 2.1.3 Select the "Output Port" page. 2.1.4 Select the "Install new port" button (click the right mouse button on LPT1 port icon and select the "Install..." menu option to open the dialog for the print object). 2.1.5 When the "Install New Port" dialog opens, select the "New port drivers" radio button and type the full path to the expanded port driver in the "Directory" edit box. 2.1.6 Select "Refresh" , afterwards choose the USB port. 2.1.7 Select "Install" to install the port. NOTE: Use the DDINSTAL utility from OS/2 command line to reinstall physical drivers if notified about install failure during automated install. If USBBASIC stack was not installed on the system you will see the message "The file, TSTUSBC.EXE, returned a non-zero return code.This DDP file did not run." You have to install USBBASIC before installing USBPRTEN.EXE. 2.1.8 Shutdown and restart your operating system if prompted to do so from the previous step. 2.2 WSoD installation instructions =================================== USB print support package consists of 2 separate components: 1) physical device driver and auto monitor support utility (files USBPRT.SYS, USBMON.EXE); 2) port driver (USBPRT.PDR, USBPRT.HLP). In order to make physical driver and utility operational USBPRT.SYS file must be available in the requester's (client workstation) \os2\boot directory and the utility - in the requester's \os2\ directory. CONFIG.SYS file on the requester must contain the following lines: DEVICE=:\OS2\BOOT\USBPRT.SYS Port driver files USBPRT.PDR and USBPRT.HLP must be available in the requester's \OS2\DLL directory and the requester OS2SYS.INI file must contain USBPRT key with the value :\OS2\DLL\USBPRT.PDR for the application PM_PORT_DRIVER. See the detailed instructions below how to do it. Auto monitor feature is enabled through a startup item for USBMON.EXE with the parameter USBPRT for each requester. One of possible scenarios to enable USB print support for WSoD is the following (assuming that WSoD related information is located on the server's drive F: directory \IBMLAN\RPL and the requester boot driver letter is Z:): 1) stop RPL server - type the command "NET STOP RPL" (without quotes) in OS/2 command window on the server. 2) copy port driver files (USBPRT.PDR, USBPRT.HLP) to the \IBMLAN\RPL\BB20.US\OS2\DLL directory with the following commands: COPY A:\USBPRT.PDR F:\IBMLAN\RPL\BB20.US\OS2\DLL /B COPY A:\USBPRT.HLP F:\IBMLAN\RPL\BB20.US\OS2\DLL /B Remember: use the WSoD server's drive letter instead of F: if needed. 3) copy physical driver file to the \IBMLAN\RPL\BB20.US\OS2\BOOT directory: COPY A:\USBPRT.SYS F:\IBMLAN\RPL\BB20.US\OS2\BOOT /B Remember: use the WSoD server's drive instead of F: if needed. Note: You may be needed to update USB Base drivers. Print support may not work with the previous versions of USB Base drivers. All previously installed USB devices will work with the new USB Base drivers. 4) copy the auto monitor executable to the \IBMLAN\RPL\BB20.US\OS2 directory: COPY A:\USBMON.EXE F:\IBMLAN\RPL\BB20.US\OS2\ /B Remember: use the WSOD server's drive letter instead of F: if needed. 5) update CONFIG.SYS file for each WSOD requester equipped with USB host hardware. CONFIG.SYS file for requester with a name 'machine_name' resides in F:\IBMLAN\RPL\MACHINES\machine_name directory. Use E text editor to add lines DEVICE=Z:\OS2\BOOT\USBPRT.SYS at the bottom of CONFIG.SYS file. Remember: use the requester's boot drive letter instead of Z: if needed. 6) add USBPRT key to the application PM_PORT_DRIVER in OS2SYS.INI file for each USB enabled user. User's INI file for "user_name" resides in the F:\IBMLAN\RPLUSER\user_name directory. Use INIEDIT utility to add USBPRT key - open OS2SYS.INI file (use the "File"->"Other..." menu item to open the user specific OS2SYS.INI file), open the PM_PORT_DRIVER application INI file entries, create a new key (select the "Edit"->"Add..." menu item and fill in the "Key" field in the opened dialog). Open this key item and set its value to Z:\OS2\DLL\USBPRT.PDR in ASCII entry box, select the "Null Terminated" checkbox. Remember: use the requester's boot drive letter instead of Z: if needed. 7) re-create RPL images: type the command "GETRPL" (without quotes) in OS/2 command window on the server. 8) start RPL server: type the command "NET START RPL" (without quotes) in OS/2 command window on the server. After booting the requester will have USB Print support enabled. 2.3 USB Print Driver Additional Parameters ========================================== DEVICE=drive:\OS2\BOOT\USBPRT.SYS Where drive: is the drive letter of the OS/2 boot partition on your system. PARAMETER FUNCTION /V Verbose Mode, displays driver information during OS/2 initialization. /LPT Set driver name as LPTn (by default name is $USBPRT). 2.4 USB Print Support Un-Install Instructions ============================================== 2.4.1 Open the print object and delete all the USB printer ports, disable spooler and delete USBPRT.PDR and USBPRD.HLP files from OS2\DLL\ directory. 2.4.2 Delete line containing USB physical driver name - USBPRT from CONFIG.SYS file. 2.4.3 Delete USBPRT.SYS file from \os2\boot\ directory and USBMON.EXE file from \os2\ directory. 2.4.4 Delete the "Auto Monitor" object from the "Startup" folder. 2.4.5 Shutdown and restart your operating system. 2.4 List of Supported USB-Printers ================================== This software package is tested on the following USB printer devices: Hewlett Packard DeskJet 895Cse Hewlett Packard LaserJet 4050 (with USB I/O card) Lexmark Optra E310 Lexmark Optra S1855 (with USB EIO card) Lexmark Z51 Epson Stylus Color 740 Epson Stylus Color 900 Epson Stylus Color 1200 Brother HL-1240 Brother HL-1250 Brother HL-2060 Xerox P1202 Xerox DocuPrint P8ex 2.5 Requirements ================ 2.5.1 Hardware USBPRT.SYS is designed to work with any standard USB printer. 2.5.2 Software (a.) USB Basic support 2.6 Dependencies ================ This package contains only USB-Printer support, in order to use USB-Printers USB base stack driver package (USBBASIC.EXE) must also be installed. 3.0 Copyright and Trademark Information ________________________________________ The following terms, are registered trademarks of the International Business Machines Corporation in the United States, or other countries, or both: o IBM o OS/2 o Warp Other company, product, and service names may be trademarks or service marks of others. THE INFORMATION PROVIDED IN THIS README IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE AND MERCHANTABILITY WITH RESPECT TO THE INFORMATION IN THIS DOCUMENT. BY FURNISHING THIS DOCUMENT, IBM GRANTS NO LICENSES TO ANY PATENTS OR COPYRIGHTS. (C) Copyright IBM Corporation, 2001. All rights reserved. U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.