TURBOWAYS 155 (or 100) MCA ETHERNET or TOKEN-RING NETWARE SERVER ODI LAN DRIVER CONTENTS About This File Supported Platforms TURBOWAYS 155 (or 100) ATM Adapter Installation Instructions ATMENDD or ATMTRDD LAN Driver Installation Procedure NetWare Server Description of Files Configurable ATMENDD or ATMTRDD LAN Driver Parameters Required Configurable Parameters Optional Configurable Parameters Sample ATM.CFG Configuration File for NetWare Server ATMENDD or ATMTRDD LAN Driver Performance Tuning NetWare Server IBM TURBOWAYS Adapter Custom Statistic Counters Obtaining Updated Software ========================================================================== ABOUT THIS FILE This file describes the use of the IBM TURBOWAYS 155 (or 100) LAN Emulation Ethernet and Token-ring LAN Drivers (ATMENDD.LAN and ATMTRDD.LAN) with the IBM TURBOWAYS 155 (or 100) Adapter. This file describes the installation and configuration of the ATMENDD and ATMTRDD LAN drivers. It contains information about the following topics: o Supported platforms o Software installation procedures o Configurable ATMENDD and ATMTRDD LAN drivers parameters o ATMENDD and ATMTRDD Custom Statistic Counters ========================================================================== SUPPORTED PLATFORMS The ATMENDD and ATMTRDD LAN drivers are supported in any of the hardware environments supported by the IBM TURBOWAYS 155 (or 100) Adapters. The following operating system environments are supported: o Novell NetWare 3.12 o Novell NetWare 4.01 or higher The IBM 8260 ATM Switch/Control Point must have a code level of v.1.0.8 or later (the code level is displayed on the console). This level of code can be obtained through your IBM Service Representative. ========================================================================== TURBOWAYS 155 (or 100) ATM ADAPTER INSTALLATION INSTRUCTIONS To install the adapter, follow instructions in the 155 (or 100) Mbps ATM ADAPTER INSTALLATION AND TESTING INSTRUCTIONS that is shipped with the product. Some systems with early levels of BIOS may present a problem in configuring the adapter or loading the adapter device driver. If you are concerned about the level of BIOS in an IBM PS/2 system, contact the IBM PC Company Help Center at 800-772-2227 in the United States or IBM's HelpPC at 800-565-3344 in Canada. ========================================================================== ATMENDD and ATMTRDD LAN DRIVERS INSTALLATION PROCEDURE This section gives an overview of how to install the ATMENDD and ATMTRDD LAN drivers on the NetWare Server platform. For more detailed instructions see the TURBOWAYS 155 (or 100) ADAPTER INSTALLATION AND TESTING INSTRUCTIONS that is shipped with the adapter. See the TURBOWAYS 155 (or 100) ADAPTER INSTALLATION AND TESTING INSTRUCTIONS for instructions on how to install the IBM TURBOWAYS 155 (or 100) Adapter. To install the ATMENDD or ATMTRDD LAN driver on a NetWare Server, perform the following steps: 1. Choose a target directory path on the fixed disk (for example, C:\SERVER.312) for installation of the ATMENDD or ATMTRDD LAN drivers and its associated files. All files (in step 2, below) should be copied to this target directory. 2. Copy the following files to the target directory: o ATMENDD.LAN or ATMTRDD.LAN o ATMENDD.LDI or ATMTRDD.LDI o RICLOAD.NLM o DDIF100.OUT o DDIF155.OUT o RIC_BASE.REL o RIC_KERN.REL o ATM100.CFG o ATM155.CFG o ETHERTSM.NLM o MSM.NLM (if running NetWare 4.x) o MSM31X.NLM (if running NetWare 3.12) NOTE: Some of the older versions of the MSM and MSM31X module do not have a function that the ATMENDD or ATMTRDD LAN driver requires. If you get a message from the NetWare server when trying to load the ATMENDD or ATMTRDD LAN driver that says a required function was not found, make sure you have updated your MSM or MSM31X module. 3. If you need to change any ATMENDD or ATMTRDD LAN driver parameter values from their defaults, these parameters can be specified on the command line when the ATMENDD or ATMTRDD LAN driver is loaded, or they can be specified by creating an ATM.CFG configuration file. If the optional @ATM.CFG command line parameter is used to specify an ATM.CFG configuration file, then the configuration file must be located in the same directory as the ATMENDD.LAN or ATMTRDD.LAN file. You can use any text editor to create or edit the ATM.CFG file before loading the ATMENDD or ATMTRDD LAN driver. See "Example ATM.CFG Configuration File for NetWare Server" for an example ATM.CFG file. NOTE: A sample config file called ATM.CFG has been included on the diskette. NOTE: A semicolon ";" will NOT comment out a line in a Netware CFG file. 4. Add the following lines to the AUTOEXEC.NCF file: SEARCH ADD 1 C:\SERVER.312 LOAD ATMENDD @ATM.CFG SLOT=X FRAME=ETHERNET_802.2 NAME=EN802.2 or LOAD ATMTRDD @ATM.CFG SLOT=X FRAME=TOKEN-RING NAME=TR802.5 where C:\SERVER.312 is the name of the directory where the LAN driver files are located. NOTES: a. Replace the C:\SERVER.312 path name with the path of the target directory you used to copy the driver files. b. @ATM.CFG is an optional command line parameter (see step 3, above). c. If you receive a message from the NetWare server about outdated API calls, this is normal and not an error message. The current ATMENDD and ATMTRDD LAN drivers are compatible with multiple NetWare versions (4.x and 3.12). API calls exist for each version of NetWare. If a later version of NetWare sees an API call for a previous version, the outdated API calls message will appear because it is not applicable to the version of NetWare being used. See NOVELL NETWARE SYSTEM ADMINISTRATION for more information about the AUTOEXEC.NCF and STARTUP.NCF files. 5. Bind needed protocol stacks to the ATMENDD or ATMTRDD LAN driver. For example, to bind IPX to the ATMENDD or ATMTRDD LAN driver with an IPX network number of 1234, you would add the following line to your AUTOEXEC.NCF file: BIND IPX TO EN802.2 NET=1234 or BIND IPX TO TR802.5 NET=1234. NOTE: EN802.2 or TR802.5 is the name specified when the driver was loaded in the example in step 4. Using a name different from the driver name is advantageous when it is necessary to load the driver with multiple frame types. See NOVELL NETWARE SYSTEM ADMINISTRATION for more information about binding protocol stacks and a description of the IPX protocol. 6. For your convenience, a copy of the MSM.NLM, MSM31X.NLM and ETHERTSM.NLM or TOKENTSM.NLM have been shipped on the adapter options diskette. Please contact Novell to ensure you have the latest copy of these files. ========================================================================== DESCRIPTION OF FILES The following is a description of the files shipped with the IBM TURBOWAYS 155 (or 100) Adapter. README.1ST This file. ATMENDD.LAN or ATMTRDD.LAN This is the LAN driver for ATM Ethernet or Token-ring LAN Emulation. This driver works with an IBM TURBOWAYS 155 (or 100) Adapter in a NetWare server and looks to the NetWare server like it is an Ethernet or Token-ring LAN driver. In order to successfully bring up this driver, you must have the following: - the IBM TURBOWAYS 155 (or 100) Adapter connected to an ATM switch - an Ethernet or Token-ring LAN Emulation Server running on that switch - the proper LAN Emulation Server address configured and passed to the LAN driver; this 40 hexadecimal digit address is passed as two 20 digit (high and low) portions using the LAHA (LES ATM High Address) and LALA (LES ATM Low Address) keywords; see the section below for a description of the various keywords ATMENDD.LDI or ATMTRDD.LDI This is the installation definition file for the ATMENDD.LAN or ATMTRDD.LAN driver for use with NetWare's server INSTALL program. INSTALL in NetWare 4.x uses this file. This file tells install what the required keyword parameters are and how to prompt the user for them. RICLOAD.NLM This is the NLM that loads the microcode files to the TURBOWAYS 155 (or 100) adapters and initializes the adapter. This module is automatically loaded when you This file can be anywhere in the search path on the NetWare server (see the 'SEARCH' command in the NetWare documentation). DDIF100.OUT and DDIF155.OUT These are the microcode device driver interface files. These files accept and respond to the device driver requests to the TURBOWAYS 155 (or 100) adapter, and notify the device driver of any significant events. These files currently must be located in the same directory as the ATMENDD.LAN or ATMTRDD.LAN driver. RIC_BASE.REL This is the microcode base file. This file currently must be located in the same directory as the ATMENDD.LAN or ATMTRDD.LAN driver. RIC_KERN.REL This is the microcode kernel file. This file currently must be located in the same directory as the ATMENDD.LAN or ATMTRDD.LAN driver. ATM100.CFG and ATM155.CFG These files are the Microcode configuration files. Each file currently contains the instance number of the TURBOWAYS 155 (or 100) adapter to be initialized, a list of the microcode files to load, and any parameters to be used while loading. These files currently must be located in the same directory as the ATMENDD.LAN or ATMTR100.LAN driver. ETHERTSM.NLM Novell Ethernet Topology Support Module. This is the v2.50 of the ETHERTSM. You may want to check Novell's distribution sites for a later version of this module. TOKENTSM.NLM Novell Token-ring Topology Support Module. This is the v2.50 of the TOKENTSM. You may want to check Novell's distribution sites for a later version of this module. MSM.NLM Novell Generic Media Support Module. This is the v2.50 of the MSM. This module is for use on NetWare 4.x. Please contact Novell to ensure you have the latest copy of these files. NOTE: Some of the older versions of the MSM module do not have a function that the ATMENDD or ATMTRDD LAN driver requires. If you get a message from the NetWare server when trying to load the ATMENDD or ATMTRDD LAN driver that says a required function was not found, make sure you have updated your MSM module. MSM31X.NLM Novell Generic Media Support Module. This is the v2.50 of the MSM31X. This module is for use on NetWare 3.1x. Please contact Novell to ensure you have the latest copy of these files. NOTE: Some of the older versions of the MSM31X module do not have a function that the ATMENDD or ATMTRDD LAN driver requires. If you get a message from the NetWare server when trying to load the ATMENDD or ATMTRDD LAN driver that says a required function was not found, make sure you have updated your MSM31X module. ========================================================================== REQUIRED CONFIGURABLE ATMENDD or ATMTRDD LAN DRIVER PARAMETERS The following parameters can be configured at the NetWare Server by setting keywords on the command line or in the ATM.CFG file. A sample ATM.CFG or ATM.CFG file is shown in "Sample ATM.CFG Configuration File for NetWare Server." SLOT= This keyword defines the slot number of the corresponding IBM TURBOWAYS 155 (or 100) Adapter in the computer. To avoid being prompted to enter a slot number when the ATMENDD or ATMTRDD LAN driver is loaded, specify this keyword in the AUTOEXEC.NCF file. This keyword must be within the range of 1-8. LAHA= This keyword defines the high-order bytes of the ATM address of the LAN Emulation Server that will service this end system. This keyword is specified as 20 hexadecimal digits. The entire (40 hexidecimal digits) LAN Emulation Server ATM address can be obtained either from the LAN Emulation Server console screen or from your system administrator. LALA= This keyword defines the low-order bytes of the ATM address of the LAN Emulation Server that will service this end system. This keyword is specified as 20 hexadecimal digits. The entire (40 hexadecimal digits) LAN Emulation Server ATM address can be obtained either from the LAN Emulation Server console screen or from your system administrator. CID= This kewoyword is only required when the TURBOWAYS 100 is to be configured. Since the ATMENDD or ATMTRDD LAN driver is capable of running on either the TURBOWAYS 100 or the TURBOWAYS 155, this parameter is used to identify the adapter to be configured. The driver defaults to the TURBOWAYS 155. When this keyword is set to 1 at the load time, the TURBOWAYS 100 will be configured. To configure the TURBOWAYS 100 adapter, set this parameter during the load command as shown below: CID = 1 ========================================================================== OPTIONAL CONFIGURABLE ATMENDD or ATMTRDD LAN DRIVER PARAMETERS The following parameters can be configured at the NetWare Server by setting keywords on the command line or in the ATM.CFG file. A sample ATM.CFG file is shown in "Sample ATM.CFG Configuration File for NetWare Server." FRAME= This keyword defines the frame type to be used with the IBM TURBOWAYS 155 (or 100) Adapter when loading the ATMENDD LAN driver. This default value is ETHERNET_802.2. o ETHERNET_802.2 o ETHERNET_802.3 o ETHERNET_II o ETHERNET_SNAP This keyword defines the frame type to be used with the IBM TURBOWAYS 155 (or 100) Adapter when loading the ATMTRDD LAN driver. This default value is TOKEN-RING. o TOKEN-RING o TOKEN-RING_SNAP NODE= This keyword is used to set a locally administered address for the IBM TURBOWAYS 155 (or 100) Adapter. A local address must contain 12 hexadecimal characters and can be specified in either MSB (Most Significant Bit) or LSB (Least Significant Bit) format. To specify a MSB node address the letter "M" immediately follows the last digit of the node address. If an "M" or "L" is not specified after the last digit of the node address, the default format for the address is LSB for Ethernet. This keyword is specified on the command line or in the ATM.CFG as NODE for the NetWare Server. See "Sample ATM.CFG Configuration File for NetWare Server" for a sample ATM.CFG file. If a node address is specified in MSB format, the characters must be within the range 400000000000-7FFFFFFFFFFF (for example, 400000000001M). This same address specified in LSB format would be 020000000080L with an "L" optionally appended to the end. NOTES: 1. Do not assign the same local address to 2 or more stations. Severe station communication or network failures may occur when 2 or more stations are assigned the same address. 2. If you do not assign a locally administered address, the adapter uses the universally administered address permanently embedded on the adapter. RXBUFFERS= This keyword defines the number of receive buffers used by the ATMENDD or ATMTRDD LAN driver. The range for this keyword is 5 to 64. The default is 10. (Receive buffer size is defined by the server SET command. See NOVELL NETWARE SYSTEM ADMINISTRATION for more information.) TXBUFFERS= This keyword defines the number of transmit buffers used by the ATMENDD or ATMTRDD LAN driver. The range for this keyword is 1 to 32. The default is 5. Maximum transmit frame size is defined by the server SET command. See NOVELL NETWARE SYSTEM ADMINISTRATION for more information.) MC= This keyword defines the number of connections that driver can maintain. The range for this keyword is 6 to 1024. The default value is 260. SMC= This keyword defines the size of the cache for the MAC addresses. The range for this keyword is 1 to 2000. The default is 1000 entries. APMC= This keyword defines the time before a MAC address entry ages out. The range for this keyword is 60 to 300 seconds. The default is 60 seconds. LRI= This keyword defines the time between registrations to LES. The range for this keyword is 30 to 600 seconds. The default is 60 seconds. LRRC= This keyword defines the number of times this station will try to register with LES before reporting a failure. The range for this keyword is 2 to 10. The default is 3. LKAC= This keyword defines the number of times this station will re-register with LES without expecting a reply. This range for this keyword is 5 to 50. The default is 10. MMA= This keyword defines the maximum number of multicast addresses that the ATMENDD or ATMTRDD LAN driver can use. The range for this keyword is 8 to 64. The default is 8. BEPR= This keyword defines the data rate for data plane connections in KBits/sec. The range for this keyword is 1000 to 100000 for the TURBOWAYS 100 and is 1000 to 155500 for the TURBOWAYS 155. The default is 25000. NOTE: This value should be set to the same value in the client machines. CPPR= This keyword defines the data rate for control plane connections in KBits/sec. The range for this keyword is 1000 to 100000 for the TURBOWAYS 100 and is 1000 to 155500 for the TURBOWAYS 155. The default is 25000. ========================================================================== EXAMPLE ATM.CFG CONFIGURATION FILE FOR NETWARE SERVER The following lines are an example of how the configuration file might look. Any valid command line keyword parameter can be specified in the configuration file. Specify only one keyword per line. SLOT=3 NODE=020000002222L LAHA=0123456789ABCDEF0123 LALA=456789ABCDEF01234567 NOTE: A semicolon ";" will NOT comment out a line in a Netware CFG file. ========================================================================== ATMENDD or ATMTRDD LAN DRIVER PERFORMANCE TUNING This section describes how to get the best performance from the IBM TURBOWAYS 155 (or 100) Adapter and ATMENDD or ATMTRDD LAN driver. NetWare Server The maximum frame size (excluding the Ethernet header) that can be sent or received by the ETHERNET LAN driver is 1514 and it is 17996 for the TOKEN-RING LAN driver. Since frame sizes are typically negotiated between the NetWare server and workstations, it is best to configure receive buffer sizes at the server that equal the maximum transmit buffer size at workstations. For this reason, increasing your receive buffer size to a value that is too big only increases the amount of memory that is used by NetWare and may not increase the performance of the IBM TURBOWAYS 155 (or 100) Adapter, the ATMENDD/ATMTRDD LAN driver or NetWare. Since the ATMENDD.LAN or ATMTRDD.LAN driver uses NetWare receive buffers to receive frames, the size of receive buffers used by the ATMENDD.LAN or ATMTRDD.LAN driver is configurable by changing the size of the NetWare receive buffers. To obtain the best performance from the ATMENDD or ATMTRDD LAN driver edit the STARTUP.NCF file and modify the following NetWare parameter according to your configuration as indicated below: ATMENDD.LAN Set Maximum Physical Receive Packet Size = 1518 ATMTRDD.LAN Set Maximum Physical Receive Packet Size = 17996 If the above parameter is not found in the STARTUP.NCF, use the NetWare set command to view system parameters and ensure that the default for this parameter is greater than the values appropriate for your configuration. If it is less, specify the above parameter in the STARTUP.NCF. ========================================================================== IBM TURBOWAYS 155 (or 100) ADAPTER CUSTOM STATISTIC COUNTERS The custom statistic counters give the user information that is specific to the IBM TURBOWAYS 155 (or 100) Adapter and ATMENDD or ATMTRDD LAN driver. The following descriptions of the custom statistic counters and what action, if any, you should take based on these counters. Errors Reported by Adapter: DESCRIPTION: This counter indicates the number of hardware errors reported by the IBM TURBOWAYS 155 (or 100) Adapter. CAUSE/ACTION: The IBM TURBOWAYS 155 (or 100) Adapter and ATMENDD or ATMTRDD LAN driver may recover from these errors. If this counter continues to increase, Run the adapter diagnostic tests located on the Option Diskette that was shipped with the IBM TURBOWAYS 155 (or 100) Adapter. If there are no problems with the adapter, reload the ATMENDD or ATMTRDD LAN driver. If a problem was found, follow the instructions supplied with the diagnostic tests to correct the problem. All Queued RCBs In Use Count: DESCRIPTION: This counter indicates the number of times the LAN driver had all of the available RCBs in use and a frame was thrown away because there was not an RCB available. CAUSE/ACTION: The number of RCBs specified when the LAN driver was loaded is too small. If this count continues to increase, unload the driver and reload it with more RCBs. Use RXBUFFERS to increase the number of RCBs. Total CRC Errors: DESCRIPTION: This counter indicates the number of CRC errors detected. CAUSE/ACTION: The IBM TURBOWAYS 155 (or 100) Adapter and ATMENDD or ATMTRDD LAN driver may recover from these errors. If this counter continues to increase, run the adapter diagnostic tests located on the Option Diskette that was shipped with the IBM TURBOWAYS 155 (or 100) Adapter. If there are no problems with the adapter, reload the ATMENDD or ATMTRDD LAN driver. If a problem was found, follow the instructions supplied with the diagnostic tests to correct the problem. ========================================================================== Obtaining Updated Software When an updated version of the software is made available, you can you can get it by downloading the files in any of several ways described below. 1. From the World Wide Web Use the URL given below to obtain a listing of networking files and download atm155ne.exe for the Ethernet driver or atm155nt.exe for the Token-ring driver. http://www.raleigh.ibm.com/tbo/tbofix.hmtl Note: this directory will be changing so if access is not known start with just http://www.raleigh.ibm.com and query. 2. By Anonymous FTP From the FTP site given below, you can find atm155ne.exe and atm155ne.exe atm155ne.exe in the pub/products/lanprods/atm subdirectory. Download the files as binary. www.raleigh.ibm.com 3. From the IBM Bulletin Board Customers in the US can access the IBM BBS by dialing 919-517-0001. Go to directory 32 or type REFDISK to directly access directory 32. ==========================================================================