README.TXT Digital UNIX ATM Sockets Application Programmers Interface (API). Version 1.10 ================================================================= Copyright (c) Digital Equipment Corporation, 1997. All Rights Reserved. Unpublished rights reserved under the copyright laws of the United States. RESTRICTED RIGHTS LEGEND Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in Subparagraph (c)(1)(ii) of DFARS 252.227-7013, or in FAR 52.227-19, as applicable. Contents: 1. INTRODUCTION 2. LATEST SOFTWARE RELEASES 3. INSTALLATION REQUIREMENTS 4. INSTALLATION 5. REMOVING PREVIOUS API VERSIONS 6. TROUBLESHOOTING **************** * INTRODUCTION * **************** This TAR kit contains the Digital UNIX ATM API for all revisions of Digital UNIX 4.0, 4.0B, and 4.0C[PAE1]. This kit includes: * A programmer's reference document (in both Microsoft Word 6.0 document form and postscript form), * Several example user applications demonstrating UBR, paced UBR, and CBR, * A release.txt file describing known bugs, limitations, and bug fixes, the ATMSOCK driver, and * This file. **************************** * LATEST SOFTWARE RELEASES * **************************** The latest software releases are available on the World Wide Web at the following addresses: North America: http://www.networks.digital.com Europe: http://www.networks.europe.digital.com Australia: http://www.digital.com.au/networks You can also use the Bulletin Board System to access software releases. Set your modem to 8 bits, no parity, 1 stop bit and dial 508-486-5777 (U.S.A.) For the latest in supported platforms and product information regarding your Digital ATMworks product, call your local authorized Digital reseller or dial 1-800-DIGITAL in the U.S.A. ***************************** * INSTALLATION REQUIREMENTS * ***************************** The ATM sockets API requires Digital UNIX 4.0, 4.0B or 4.0C. ATM Sockets is not supported on any other version of the operating system. To determine which Digital UNIX version you are running look at the /etc/motd file. **************** * INSTALLATION * **************** The following installation procedure allows dynamic installation of the ATM API. This release may be installed without rebuilding the kernel or rebooting the system, provided an earlier revision of the ATM API does not exist on the target system. To install the Digital UNIX ATM API, please follow the instructions given below. 1. Before installing version 1.10, first remove any previous versions of the ATM API. Please refer to the section "REMOVING PREVIOUS API VERSIONS" before continuing the installation procedure. 2. Make sure all physical ATM devices are in the "DOWN" state. The following command determines the state of each physical adapter. atmconfig drvlist 3. If there are ATM devices in the "UP" state, place them in the "DOWN" state with the following command (example shows adapter device "lta0"). atmconfig down driver=lta0 4. To install the ATM API, copy the atmsock.tar file into the root directory (you must be logged in as root). 5. Extract the contents of the tar file with the following command: cd / tar -xvf atmsock.tar 6. Install the driver subset with the following command: setld -l /usr/opt/ATMSOCK At the installation menu, select the ATM API option that is appropriate for the installed version of Digital Unix 4.0. When this operation is complete, the ATM API is installed and operational. To verify the installation, use the following command. atmconfig cvglist This command should display a line titled "sockets_api". 7. Once the ATM API is installed successfully, return all ATM devices to the "UP" state with the following command: (example shows adapter device "lta0"): atmconfig up driver=lta0 This procedure is required because of a limitation within the kernel's ATM subsystem. ********************************** * REMOVING PREVIOUS API VERSIONS * ********************************** 1. To remove older versions of the ATM sockets API, follow these instructions: A. To determine if an old version is installed, use the following command. setld -i Examine the list of subsets for any installed instances of the following modules. ATMSOCK4090 ATMSOCK4091 ATMSOCK400 All of these subsets must be removed from your system. B. Removing old subset ATMSOCK4090: 1. Delete the subset from the kernel configuration: setld -d ATMSOCK4090 2. Determine the configuration name used by your system. It is most commonly the hostname of the system in uppercase letters. To determine the configuration name, look in the /sys directory and find the sub-directory that is a word in uppercase letters. Note that the subdirectory "BINARY" appears on all systems and is not the configuration name. 3. Edit the configuration file (/sys/conf/ where CONFNAME> is the system's configuration name). Delete the following line from the list of options. options ATMSOCK 4. Rebuild the kernel. This will take a few minutes. doconfig -c [n] 5. Copy the new kernel into the root directory. Note that it may be prudent to save a copy of the old kernel. mv /vmunix /vmunix.save cp /sys//vmunix /vmunix sync 6. Reboot the system to make the changes take effect. shutdown -r +5 C. Removing old subsets ATMSOCK4091 and ATMSOCK 400: 1. Delete the subset from the kernel configuration: setld -d ATMSOCK4091 or ATMSOCK400 2. Reboot the system to make the changes take effect. shutdown -r +5 ******************* * TROUBLESHOOTING * ******************* The ATM sockets API posts messages to the console under certain conditions. This should be the first place to look when experiencing trouble. Also read the programmer's reference document for various error values returned by the API. ===================================================== TRADEMARKS DEC, DIGITAL, and DECpc are trademarks of Digital Equipment Corporation. All other trademarks and registered trademarks are the property of their respective holders. [PAE1]