About This Manual

This manual describes the Tru64 UNIX Asynchronous Transfer Mode (ATM) subsystem and how to use the ATM kernel interfaces. This document does not describe the application programming interface (API) that user-level applications would use to access the ATM subsystem. Also, this manual is not an ATM networking tutorial.

After reading this manual, you should be able to:

Understand the ATM subsystem architecture

Understand how the different kernel interfaces operate

Write a kernel module

Audience

This manual is for experienced UNIX kernel programmers responsible for writing device drivers and kernel modules. These programmers should be familiar with the following:

ATM technology

ATM Forum User-Network Interface (UNI) Version 3.0 specification

C language programming

The secondary audience is system administrators responsible for configuring network software. These system administrators should be familiar with the following:

ATM technology

C language

Programming interfaces for UNIX operating systems

New and Changed Features

This manual has been revised, and includes the following changes:

Configuration and problem solving information has been relocated to the Network Administration manual.

ATM subsystem tuning information has been relocated to the sys_attrs_atm(5) reference page.

Appendix A has been revised to include new and updated routines.

Appendix B has been revised to include point-to-multipoint connection information.

Organization

This manual is organized into nine chapters and three appendixes.

Chapter 1	Provides an overview of the Tru64 UNIX Asynchronous Transfer Mode (ATM) architecture and its kernel interfaces.
Chapter 2	Describes the ATM header files, generic data structures, macros, and return codes that ATM modules use.
Chapter 3	Describes the ATM device driver interface, its tasks and routines, and associated data structures.
Chapter 4	Describes the ATM signaling module interface, its tasks and routines, and associated data structures.
Chapter 5	Describes the ATM convergence module interface, its tasks and routines, and associated data structures.
Chapter 6	Describes how ATM connections are initiated and terminated, and includes some code fragments that show how these tasks are implemented in software.
Chapter 7	Describes the ATM Module Management Interface (MMI).
Chapter 8	Describes queuing information that kernel module writers require.
Chapter 9	Describes the flow control in the ATM subsystem.
Appendix A	Describes the ATM CMM routines in reference-page format.
Appendix B	Contains programming code fragments that show certain connection-related tasks.
Appendix C	Contains ATM cause and diagnostic codes, their message strings, and brief descriptions.

Related Documents

For information about Tru64 UNIX device driver programming, refer to the following manuals that are part of the Device Driver Documentation kit:

Writing Device Drivers

Reference Pages, Section 9r, Device Drivers (Volume 1)

Reference Pages, Section 9s, 9u, and 9v, Device Drivers (Volume 2)

Writing Network Device Drivers

Writing TURBOchannel Device Drivers

Writing EISA and ISA Bus Device Drivers

Writing VMEbus Device Drivers

Writing PCI Bus Device Drivers

Writing Device Drivers for the SCSI/CAM Architecture Interfaces

For information on kernel module programming, refer to the Writing Kernel Modules manual.

For additional information about ATM, refer to the ATM User-Network Interface Specification, Version 3.0 ISBN 0-13-225863-3 and the ATM User-Network Interface Specification, Version 3.1 ISBN 0-13-393828-X, both published by Prentice-Hall.

For information on installing a Compaq ATM adapter and its device driver, see the documentation that comes with the adapter.

For information about administering networking interfaces, refer to the System Administration manual and the Network Administration manual. For information on configuring the ATM subsystem, see the Network Administration manual.

Icons on Tru64 UNIX Printed Books

The printed version of the Tru64 UNIX documentation uses letter icons on the spines of the books to help specific audiences quickly find the books that meet their needs. (You can order the printed documentation from Compaq.) The following list describes this convention:

G	Books for general users
S	Books for system and network administrators
P	Books for programmers
D	Books for device driver writers
R	Books for reference page users

Some books in the documentation help meet the needs of several audiences. For example, the information in some system books is also used by programmers. Keep this in mind when searching for information on specific topics.

The Documentation Overview provides information on all of the books in the Tru64 UNIX documentation set.

Reader's Comments

Compaq welcomes any comments and suggestions you have on this and other Tru64 UNIX manuals.

You can send your comments in the following ways:

Fax: 603-884-0120 Attn: UBPG Publications, ZKO3-3/Y32

Internet electronic mail: readers_comment@zk3.dec.com
A Reader's Comment form is located on your system in the following location:
```
/usr/doc/readers_comment.txt
```

Mail:
Compaq Computer Corporation
UBPG Publications Manager
ZKO3-3/Y32
110 Spit Brook Road
Nashua, NH 03062-2698

A Reader's Comment form is located in the back of each printed manual. The form is postage paid if you mail it in the United States.

Please include the following information along with your comments:

The full title of the book and the order number. (The order number is printed on the title page of this book and on its back cover.)

The section numbers and page numbers of the information on which you are commenting.

The version of Tru64 UNIX that you are using.

If known, the type of processor that is running the Tru64 UNIX software.

The Tru64 UNIX Publications group cannot respond to system problems or technical support inquiries. Please address technical questions to your local system vendor or to the appropriate Compaq technical support office. Information provided with the software media explains how to send problem reports to Compaq.

Conventions

This document uses the following typographic conventions:

% $: A percent sign represents the C shell system prompt. A dollar sign represents the system prompt for the Bourne, Korn, and POSIX shells.
#: A number sign represents the superuser prompt.
% cat: Boldface type in interactive examples indicates typed user input.
file: Italic (slanted) type indicates variable values, placeholders, and function argument names.
[ | ] { | }: In syntax definitions, brackets indicate items that are optional and braces indicate items that are required. Vertical bars separating items inside brackets or braces indicate that you choose one item from among those listed.
colored text: In syntax definitions, literal elements are colored green. Variable values, placeholders, and function argument names are colored red. No special colored text is used outside of syntax descriptions.
. . .: In syntax definitions, a horizontal ellipsis indicates that the preceding item can be repeated one or more times.
cat(1): A cross-reference to a reference page includes the appropriate section number in parentheses. For example, cat(1) indicates that you can find information on the cat command in Section 1 of the reference pages.
[Return]: In an example, a key name enclosed in a box indicates that you press that key.
[Ctrl/x]: This symbol indicates that you hold down the first named key while pressing the key or mouse button that follows the slash. In examples, this key combination is enclosed in a box (for example, [Ctrl/C] ).