Universal Serial Bus Class Definitions for Communication Devices

Version 1.1 January 19, 1999

USB Class Definitions for Communication Devices

Scope of this Revision

This version 1.1 of this class specification is intended for product design. Every attempt has been made to ensure a consistent and implementable specification. Implementations should ensure compliance with this revision.

Revision History
Revision 1.1 1.09d 1.09c 1.09b 1.09a 1.0.8a1.0.9rc 1.0 0.9a- 0.9f 0.8 0.8h Issue date January 19, 1999 January 19, 1999 December 17, 1998 December 14, 1998 October 21, 1998 April 28, 1998 October 13, 1998 May 8, 1998 May 26, 1997 October 10, 1997 December 11, 1996 May 20, 1997 Comments Approved by DWG as 1.1 RR91 RR90 RR69-89 RR68 1.08 releases Approved by DWG as 1.0

0.9 releases.

0.8 releases.

Version 1.1

ii

January 19, 1999

USB Class Definitions for Communication Devices

Contributors
Andy Nicholson Charlie Tai Chuck Brabenac Dan Moore Dave Perry Diego Friedel Ed Endejan Jim Wilson Joe Decuir John Howard Ken Lauffenburger Kenny Richards Mats Webjrn Nathan Peacock Paul E. Berg Randy Fehr Ron Lewis Paul Chehowski Shelagh Callahan Stefan Eder Terry Moore Microsoft Corporation Intel Corporation Intel Corporation Diamond Multimedia Systems Mitel Corporation AVM 3Com Corporation U.S. Robotics Microsoft Corporation Intel Corporation Efficient Networks, Inc. Microsoft Corporation Universal Access Northern Telecom Moore Computer Consultants, Inc. Northern Telecom Rockwell Semiconductors Mitel Corporation Intel Corporation Siemens Semiconductors Moore Computer Consultants, Inc.

Version 1.1

iii

January 19, 1999

USB Class Definitions for Communication Devices

USB Class Definitions for Communication Devices Copyright 1996-1999 USB Implementers Forum All rights reserved.

INTELLECTUAL PROPERTY DISCLAIMER THIS SPECIFICATION IS PROVIDED AS IS WITH NO WARRANTIES WHATSOEVER INCLUDING ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR ANY PARTICULAR PURPOSE, OR ANY WARRANTY OTHERWISE ARISING OUT OF ANY PROPOSAL, SPECIFICATION, OR SAMPLE. A LICENSE IS HEREBY GRANTED TO REPRODUCE AND DISTRIBUTE THIS SPECIFICATION FOR INTERNAL USE ONLY. NO OTHER LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY OTHER INTELLECTUAL PROPERTY RIGHTS IS GRANTED OR INTENDED HEREBY. AUTHORS OF THIS SPECIFICATION DISCLAIM ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF PROPRIETARY RIGHTS, RELATING TO IMPLEMENTATION OF INFORMATION IN THIS SPECIFICATION. AUTHORS OF THIS SPECIFICATION ALSO DO NOT WARRANT OR REPRESENT THAT SUCH IMPLEMENTATION(S) WILL NOT INFRINGE SUCH RIGHTS. Hayes is a registered trademark of Hayes Microcomputer Products, Inc. All other product names are trademarks, registered trademarks, or service marks of their respective owners. Please send comments via the discussion forum at: http://www.usb.org/developers/dwg/communications_class_grp/

Version 1.1

iv

January 19, 1999

USB Class Definitions for Communication Devices

Contents
1. Introduction ............................................................................................................................... 1 1.1 Scope.................................................................................................................................. 1 1.2 Purpose............................................................................................................................... 1 1.3 Related Documents ............................................................................................................. 1 1.4 Terms and Abbreviations ..................................................................................................... 4 Management Overview .............................................................................................................. 7 Functional Characteristics ........................................................................................................ 8 3.1 Device Organization............................................................................................................. 8 3.1.1 Communication Device Management ............................................................................ 8 3.2 Device Operation ................................................................................................................. 9 3.3 Interface Definitions ............................................................................................................. 9 3.3.1 Communication Class Interface..................................................................................... 9 3.3.2 Data Class Interface ................................................................................................... 10 3.3.2.1 Protocol Data Wrapper........................................................................................................ 11 3.4 Endpoint Requirements...................................................................................................... 12 3.4.1 Communication Class Endpoint Requirements ............................................................ 12 3.4.2 Data Class Endpoint Requirements............................................................................. 12 3.5 Device Models ................................................................................................................... 12 3.6 USB POTS Models ............................................................................................................ 12 3.6.1 Direct Line Control Model ........................................................................................... 13 3.6.1.1 DL Model ........................................................................................................................... 13 3.6.1.2 Datapump Model ................................................................................................................ 14 3.6.2 Abstract Control Model ............................................................................................... 15 3.6.2.1 Abstract Control Model Serial Emulation............................................................................. 16 3.6.3 USB Telephone Model................................................................................................ 17 3.6.3.1 Telephone Control Model.................................................................................................... 17 3.7 USB ISDN Models ............................................................................................................. 18 3.7.1 Multi-Channel Model................................................................................................... 18 3.7.1.1 Topology ............................................................................................................................ 20 3.7.2 USB CAPI Model........................................................................................................ 20 3.7.2.1 CAPI Control Model ........................................................................................................... 21 3.8 USB Networking Models .................................................................................................... 22 3.8.1 Common Data Plane Characteristics........................................................................... 22 3.8.1.1 Segment Delineation ........................................................................................................... 23 3.8.1.2 Segment Size ...................................................................................................................... 24 3.8.2 Ethernet Networking Control Model............................................................................. 24 3.8.3 ATM Networking Control Model .................................................................................. 26 4. Class-Specific Codes for Communication Devices ................................................................ 28 4.1 Communication Device Class Code.................................................................................... 28 4.2 Communication Interface Class Code ................................................................................. 28 4.3 Communication Interface Class SubClass Codes................................................................ 28 4.4 Communication Interface Class Control Protocol Codes ...................................................... 29 4.5 Data Interface Class Codes................................................................................................ 29 4.6 Data Interface Class SubClass Codes ................................................................................ 29 4.7 Data Interface Class Protocol Codes .................................................................................. 29 Descriptors .............................................................................................................................. 31 5.1 Standard USB Descriptor Definitions .................................................................................. 31 5.1.1 Device Descriptor ....................................................................................................... 31

2. 3.

5.

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

5.1.2 Configuration Descriptor ............................................................................................. 31 5.1.3 Interface Descriptors .................................................................................................. 31 5.1.4 Endpoint Descriptors .................................................................................................. 32 5.2 Class-Specific Descriptors.................................................................................................. 32 5.2.1 Class-Specific Device Descriptor ................................................................................ 32 5.2.2 Class-Specific Configuration Descriptor....................................................................... 32 5.2.3 Functional Descriptors ................................................................................................ 32 5.2.3.1 Header Functional Descriptor .............................................................................................. 34 5.2.3.2 Call Management Functional Descriptor .............................................................................. 34 5.2.3.3 Abstract Control Management Functional Descriptor ........................................................... 35 5.2.3.4 Direct Line Management Functional Descriptor ................................................................... 36 5.2.3.5 Telephone Ringer Functional Descriptor .............................................................................. 37 5.2.3.6 Telephone Operational Modes Functional Descriptor ........................................................... 38 5.2.3.7 Telephone Call and Line State Reporting Capabilities Descriptor.......................................... 39 5.2.3.8 Union Functional Descriptor................................................................................................ 40 5.2.3.9 Country Selection Functional Descriptor.............................................................................. 41 5.2.3.10 USB Terminal Functional Descriptor............................................................................... 41 5.2.3.11 Network Channel Terminal Functional Descriptor............................................................ 42 5.2.3.12 Protocol Unit Functional Descriptor................................................................................. 43 5.2.3.13 Extension Unit Functional Descriptor .............................................................................. 43 5.2.3.14 Multi-Channel Management Functional Descriptor .......................................................... 44 5.2.3.15 CAPI Control Management Functional Descriptor ........................................................... 44 5.2.3.16 Ethernet Networking Functional Descriptor ..................................................................... 45 5.2.3.17 ATM Networking Functional Descriptor.......................................................................... 47 5.3 Sample Class-Specific Functional Descriptors .................................................................... 49 6. Communication Interface Class Messages............................................................................. 51 6.1 Overview ........................................................................................................................... 51 6.2 Management Element Requests......................................................................................... 51 6.2.1 SendEncapsulatedCommand...................................................................................... 54 6.2.2 GetEncapsulatedResponse ........................................................................................ 54 6.2.3 SetCommFeature ....................................................................................................... 54 6.2.4 GetCommFeature....................................................................................................... 54 6.2.5 ClearCommFeature .................................................................................................... 55 6.2.6 SetAuxLineState ........................................................................................................ 56 6.2.7 SetHookState ............................................................................................................. 56 6.2.8 PulseSetup ................................................................................................................ 56 6.2.9 SendPulse ................................................................................................................. 57 6.2.10 SetPulseTime ............................................................................................................. 57 6.2.11 RingAuxJack .............................................................................................................. 57 6.2.12 SetLineCoding............................................................................................................ 57 6.2.13 GetLineCoding ........................................................................................................... 58 6.2.14 SetControlLineState ................................................................................................... 58 6.2.15 SendBreak ................................................................................................................. 59 6.2.16 SetRingerParms ......................................................................................................... 59 6.2.17 GetRingerParms ........................................................................................................ 60 6.2.18 SetOperationParms .................................................................................................... 60 6.2.19 GetOperationParms.................................................................................................... 60 6.2.20 SetLineParms ............................................................................................................ 61 6.2.21 GetLineParms ............................................................................................................ 62 6.2.22 DialDigits.................................................................................................................... 63 6.2.23 SetUnitParameter ....................................................................................................... 64 6.2.24 GetUnitParameter ...................................................................................................... 64 6.2.25 ClearUnitParameter .................................................................................................... 64

Version 1.1

vi

January 19, 1999

USB Class Definitions for Communication Devices

6.2.26 GetProfile ................................................................................................................... 65 6.2.27 SetEthernetMulticastFilters ......................................................................................... 65 6.2.28 SetEthernetPowerManagementPatternFilter ................................................................ 65 6.2.29 GetEthernetPowerManagementPatternFilter ............................................................... 66 6.2.30 SetEthernetPacketFilter .............................................................................................. 66 6.2.31 GetEthernetStatistic.................................................................................................... 67 6.2.32 SetATMDataFormat.................................................................................................... 69 6.2.33 GetATMDeviceStatistics ............................................................................................. 71 6.2.34 SetATMDefaultVC ...................................................................................................... 72 6.2.35 GetATMVCStatistics ................................................................................................... 72 6.3 Notification Element Notifications........................................................................................ 73 6.3.1 NetworkConnection .................................................................................................... 74 6.3.2 ResponseAvailable ..................................................................................................... 74 6.3.3 AuxJackHookState ..................................................................................................... 74 6.3.4 RingDetect ................................................................................................................. 74 6.3.5 SerialState ................................................................................................................. 75 6.3.6 CallStateChange ........................................................................................................ 75 6.3.7 LineStateChange ....................................................................................................... 77 6.3.8 ConnectionSpeedChange ........................................................................................... 77
Appendix A: Communication Device Class Examples ................................................................... 79 A.1 Basic Telephone ................................................................................................................ 79 A.2 Modem .............................................................................................................................. 79 A.3 CAPI Device ...................................................................................................................... 79 Appendix B: Sample Configurations .............................................................................................. 80 B.1 Basic Telephony Configurations ......................................................................................... 80 B.2 Modem Configurations ....................................................................................................... 80 B.3 CAPI Device Configuration................................................................................................. 81 Appendix C: Multi-channel ISDN B-Channel setup .............................................................................. 83 C.1 General ............................................................................................................................. 83 Appendix D: Multi-Channel Implementation Examples ........................................................................ 84 D.1 ISDN BRI T/A with two POTS interfaces ................................................................................ 84 D.2 ISDN BRI T/A with vendor specific protocol (Bonding) ............................................................. 85 D.3 Passive ISDN Solutions ..................................................................................................... 85 Appendix E: Data Class Protocol Definitions ................................................................................. 88 Definitions.................................................................................................................................. 88 E.1 Physical Interface Protocols ............................................................................................... 88 E.1.2 I.430: BASIC USER-NETWORK INTERFACE LAYER 1............................................... 88 E.2 Framing Protocols.............................................................................................................. 92 E.2.1 HDLC Framing ............................................................................................................ 92 E.2.2 Transparent framing ................................................................................................... 95 E.3 Data Link Protocols............................................................................................................ 97 E.3.1 Q.921 Management: ISDN USER-NETWORK INTERFACE DATA LINK LAYER SPECIFICATION FOR CIRCUIT MODE BEARER SERVICES.................................................... 97 E.3.2 Q.921: ISDN USER-NETWORK INTERFACE DATA LINK LAYER SPECIFICATION FOR CIRCUIT MODE BEARER SERVICES....................................................................................... 99 E.3.3 Q.921 TEI-multiplexor: TERMINAL ENDPOINT IDENTIFIER MULTIPLEXOR FOR ISDN USER-NETWORK INTERFACE DATA LINK LAYER................................................................ 101 E.4 Network layer Protocols ................................................................................................... 102 E.4.1 Q.931/Euro-ISDN User Side ..................................................................................... 102 Version 1.1

vii

January 19, 1999

USB Class Definitions for Communication Devices

E.4.2 E.4.3

V.42bis: Data compression procedures for DCE using error correction procedures ..... 109 V.120: V.24 rate adaptation to ISDN ......................................................................... 110

Version 1.1

viii

January 19, 1999

USB Class Definitions for Communication Devices

List of Tables
Table 1: Data Class Protocol Wrapper Layout .......................................................................................................... 11 Table 2: Requests  Direct Line Control Model* .................................................................................................... 13 Table 3: Notifications  Direct Line Control Model* .............................................................................................. 14 Table 4: Requests  Abstract Control Model*......................................................................................................... 16 Table 5: Notifications  Abstract Control Model*................................................................................................... 16 Table 6: Requests  Telephone Control Model*...................................................................................................... 18 Table 7: Notifications  Telephone Control Model*................................................................................................ 18 Table 8: Requests  Multi-Channel Model*............................................................................................................ 19 Table 9: Requests  CAPI Control Model*............................................................................................................. 21 Table 10: Requests  Ethernet Networking Control Model* .................................................................................... 25 Table 11: Notifications  Ethernet and ATM Networking Control Models*............................................................. 25 Table 12: Requests  ATM Networking Control Model* ........................................................................................ 26 Table 13: Notifications  Ethernet and ATM Networking Control Models*............................................................. 27 Table 14: Communication Device Class Code .......................................................................................................... 28 Table 15: Communication Interface Class Code ....................................................................................................... 28 Table 16: Communication Interface Class SubClass Codes ....................................................................................... 28 Table 17: Communication Interface Class Control Protocol Codes............................................................................ 29 Table 18: Data Interface Class Code ........................................................................................................................ 29 Table 19: Data Interface Class Protocol Codes ......................................................................................................... 29 Table 20: Communication Device Class Descriptor Requirements ............................................................................ 31 Table 21: Communication Class Interface Descriptor Requirements.......................................................................... 31 Table 22: Data Class Interface Descriptor Requirements........................................................................................... 32 Table 23: Functional Descriptor General Format ...................................................................................................... 32 Table 24: Type Values for the bDescriptorType Field............................................................................................... 33 Table 25: bDescriptor SubType in Functional Descriptors ........................................................................................ 33 Table 26: Class-Specific Descriptor Header Format.................................................................................................. 34 Table 27: Call Management Functional Descriptor ................................................................................................... 34 Table 28: Abstract Control Management Functional Descriptor ................................................................................ 35 Table 29: Direct Line Management Functional Descriptor ........................................................................................ 36 Table 30: Telephone Ringer Functional Descriptor ................................................................................................... 37 Table 31: Telephone Operational Modes Functional Descriptor ................................................................................ 39 Table 32: Telephone Call State Reporting Capabilities Descriptor............................................................................. 40 Table 33: Union Interface Functional Descriptor ...................................................................................................... 40 Table 34: Country Selection Functional Descriptor................................................................................................... 41 Table 35: USB Terminal Functional Descriptor ........................................................................................................ 42 Table 36: Network Channel Terminal Functional Descriptor..................................................................................... 42 Table 37: Protocol Unit Functional Descriptor.......................................................................................................... 43 Table 38: Extension Unit Functional Descriptor ....................................................................................................... 43 Table 39: Multi-Channel Management Functional Descriptor ................................................................................... 44 Table 40: CAPI Control Management Functional Descriptor .................................................................................... 45 Table 41: Ethernet Networking Functional Descriptor .............................................................................................. 45 Table 42: Ethernet Statistics Capabilities................................................................................................................. 46 Table 43: ATM Networking Functional Descriptor................................................................................................... 47 Table 44: Sample Communication Class Specific Interface Descriptor* .................................................................... 49 Table 45: Class-Specific Requests............................................................................................................................ 51 Table 46: Class-Specific Request Codes................................................................................................................... 53 Table 47: Communication Feature Selector Codes.................................................................................................... 55 Version 1.1

ix

January 19, 1999

USB Class Definitions for Communication Devices

Table 48: Feature Status Returned for ABSTRACT_STATE Selector ....................................................................... 55 Table 49: POTS Relay Configuration Values ........................................................................................................... 56 Table 50: Line Coding Structure .............................................................................................................................. 58 Table 51: Control Signal Bitmap Values for SetControlLineState ............................................................................. 58 Table 52: Ringer Configuration Bitmap Values ........................................................................................................ 59 Table 53: Operation Mode Values............................................................................................................................ 60 Table 54: Line State Change Value Definitions ........................................................................................................ 61 Table 55: Line Status Information Structure ............................................................................................................. 62 Table 56: Line State Bitmap .................................................................................................................................... 62 Table 57: Call State Bitmap ..................................................................................................................................... 63 Table 58: Call State Value Definitions ..................................................................................................................... 63 Table 59: Characters in a Dialing Command ............................................................................................................ 63 Table 60: Unit Parameter Structure .......................................................................................................................... 64 Table 61: Power Management Pattern Filter Structure .............................................................................................. 66 Table 62: Ethernet Packet Filter Bitmap ................................................................................................................... 67 Table 63: Ethernet Statistics Feature Selector Codes................................................................................................. 68 Table 64: ATM Data Format.................................................................................................................................... 69 Table 65: ATM Device Statistics Feature Selector Codes.......................................................................................... 71 Table 66: ATM VC Selector Codes.......................................................................................................................... 72 Table 67: Class-Specific Notifications ..................................................................................................................... 73 Table 68: Class-Specific Notification Codes............................................................................................................. 73 Table 69: UART State Bitmap Values...................................................................................................................... 75 Table 70: Call State Change Value Definitions......................................................................................................... 76 Table 71: Line State Change Values......................................................................................................................... 77 Table 72: ConnectionSpeedChange Data Structure ................................................................................................... 78 Table 73: Telephone Configurations ........................................................................................................................ 80 Table 74: Example Modem Configurations .............................................................................................................. 80 Table 75: Example CAPI Device Configurations...................................................................................................... 82 Table 76: Command Type Encoding ........................................................................................................................ 88 Table 77: I.430 Configuration Parameter List ........................................................................................................... 88 Table 78: I.430 Command Message Format ............................................................................................................. 88 Table 79: I.430 Commands...................................................................................................................................... 89 Table 80: I.430 Activate, Deactivate Command Wrapper.......................................................................................... 89 Table 81: I.430 PhActivateBReq Command Wrapper ............................................................................................... 90 Table 82: I.430 PhDeactivateBReq Command Wrapper............................................................................................ 90 Table 83: I.430 PhDataReq Command Wrapper ....................................................................................................... 90 Table 84: I.430 MphErrorInd Command Wrapper .................................................................................................... 90 Table 85: I.430 MphInformationInd Command Wrapper .......................................................................................... 91 Table 86: HDLC Configuration Parameter List......................................................................................................... 92 Table 87: HDLC Commands ................................................................................................................................... 94 Table 88: HDLC ControlRes, StatusReq Command Wrapper.................................................................................... 94 Table 89: HDLC ControlReq Command Wrapper .................................................................................................... 94 Table 90: HDLC StatusInd/Res Command Wrapper ................................................................................................. 94 Table 91: HDLC DataReq/Ind Command Wrapper................................................................................................... 95 Table 92: TRANS Configuration Parameter List ...................................................................................................... 95 Table 93: TRANS Commands ................................................................................................................................. 96 Table 94: TRANS ControlRes, StatusReq Command Wrapper.................................................................................. 96 Table 95: TRANS ControlReq Command Wrapper .................................................................................................. 96 Table 96: TRANS StatusInd/Res Command Wrapper ............................................................................................... 96 Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

Table 97: TRANS DataReq/Ind Command Wrapper................................................................................................. 97 Table 98: Q.921M Configuration Parameter List ...................................................................................................... 97 Table 99: Q.921M Command Message Format......................................................................................................... 98 Table 100: Q.921M Commands ............................................................................................................................... 98 Table 101: Q.921M DlAssignReq wrapper............................................................................................................... 98 Table 102: Q.921M DlAssignInd, DlRemoveInd Command Wrapper ....................................................................... 99 Table 103: Q.921M DlErrorReq, DlErrorCon Command Wrapper ............................................................................ 99 Table 104: Q.921 Configuration Parameter List........................................................................................................ 99 Table 105: Command Message Format .................................................................................................................. 100 Table 106: Q.921 commands ................................................................................................................................. 100 Table 107: Q.921 General Message Structure ......................................................................................................... 100 Table 108: Q.931/Euro-ISDN Configuration Parameter List ................................................................................... 102 Table 109: Q.931/Euro-ISDN Command Message Format...................................................................................... 102 Table 110: Q.931/Euro-ISDN Commands .............................................................................................................. 104 Table 111: Q.931/Euro-ISDN System Management Commands.............................................................................. 104 Table 112: Q.931/Euro-ISDN General Command Structure .................................................................................... 104 Table 113: V.42bis Configuration Parameter List ................................................................................................... 109

Version 1.1

xi

January 19, 1999

USB Class Definitions for Communication Devices

1. Introduction
There are three classes that make up the definition for communication devices: the Communication Device Class, Communication Interface Class and the Data Interface Class. The Communication Device Class is a device level definition and is used by the host to properly identify a communication device that may present several different types of interfaces. The Communication Interface Class defines a general-purpose mechanism that can be used to enable all types of communication services on the Universal Serial Bus (USB). The Data Interface Class defines a generalpurpose mechanism to enable bulk or isochronous transfer on the USB when the data does not meet the requirements for any other class.

1.1 Scope
Given the broad nature of communication equipment, this specification does not attempt to dictate how all communication equipment should use the USB. Rather, it defines an architecture that is capable of supporting any communication device. The current release of the specification focuses on supporting connectivity to telecommunication services (devices that have traditionally terminated an analog or digital telephone line), and medium speed networking services (Always Connected LAN/WAN media types). The specification currently outlines the following types of devices:

x x

Telecommunications devices: analog modems, ISDN terminal adapters, digital telephones, and analog telephones Networking devices: ADSL modems, cable modems, 10BASE-T Ethernet adapters/hubs, and Ethernet cross-over cables.

This specification does not attempt to redefine existing standards for connection and control of communication services. The Communication Class defines mechanisms for a device and host to identify which existing protocols to use. Where possible, existing data formats are used and the transport of these formats are merely enabled by the USB through the definition of the appropriate descriptors, interfaces, and requests. More specifically, this specification describes a framework of USB interfaces, data structures, and requests under which a wide variety of communication devices can be defined and implemented.

1.2 Purpose
This specification provides information to guide implementers in using the USB logical structures for communication devices. This information applies to manufacturers of communication devices and system software developers.

1.3 Related Documents

Universal Serial Bus Specification, version 1.0 and version 1.1 (also referred to as the USB Specification). This specification is available on the World Wide Web site http://www.usb.org. Universal Serial Bus Common Class Specification, version 1.0. This specification is available on the World Wide Web site http://www.usb.org. ANSI/TIA-602, Serial Asynchronous Automatic Dialing and Control - available at http://www.eia.org. Bellcore NI-1 (National ISDN 1), Support network terminating services for ISDN service - available at http://www.bellcore.com. ITU V.25ter, Serial Asynchronous Automatic Dialing and Control - available at http://www.itu.ch ITU-T V.42 (03/93), Error correction procedures for DCE using asynchronous to synchronous conversion

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

ITU-T V.42bis (1990), Data compression procedures for data circuit terminating equipment (DCE) using error correction procedures ITU-T I.430 (11/95), Basic user-network interface layer 1 specification ITU-T I.431 (03/93), Primary rate user-network interface layer 1 specification ITU-T Q.921 (03/93), ISDN user-network interface data link layer specification ITU-T Q.922 (1992), ISDN data link layer specification for frame mode bearer services ITU-T Q.931 (03/93), ISDN user-network interfacelayer 3 specification for basic Call Control ITU-T Q.2931 (02/95), B-ISDN DSS2 User Network Interface (UNI) Layer 3 Specification for Basic Call/Connection Control. ITU-T X.25 (03/93), Interface between data terminal equipment (DTE) and data circuit-terminating equipment (DCE) for terminals operating in the packet mode and connected to public data networks by dedicated circuit ITU-T X.75 (10/96), Packet switched signaling system between public networks providing data transmission services available at http://www.itu.ch. ITU-T T.30 (07/96), Procedures for document facsimile transmission in the general switched telephone network available at http://www.itu.ch. ITU-T.200, Programmable communication interface for terminal equipment connected to ISDN appendix II ITU-T V.110 (09/92), Support of data terminal equipment with V-series type interfaces by an integrated services digital network. ITU-T V.120 (09/92), Support by an ISDN terminal adapter equipment with V-series type interface with provision for statistical multiplexing. CAPi2.0, COMMON-ISDN-API Version 2.0 available at http://www.capi.org. ETSI prETS 300 838, integrated service digital network (ISDN); harmonized programmable communication interface (HPCI) for ISDN ETSI prETS 300 917, digital cellular telecommunications system (Phase 2+); GSM application programming Interface (GSM-API) (GSM 07.08 version 5.0.0) Data Over Cable Service Interface Specifications (DOCSIS) Customer Premises to CPE Interface (CMCI) Interim Specification, SP-CMCI-I02-980317, March, 1998 available at http://www.cablemodem.com. Ethernet Version 2.0, Digital, Intel, Xerox (DIX), 1982. ISO/IEC 8802-3 (ANSI/IEEE Std 802.3): 1993, Information technology Local and metropolitan area networks Part 3: Carrier sense multiple access with collision detection (CSMA/CD) access method and physical layer specifications. ADSL Forum TR-002, ATM over ADSL Recommendations, March 1997. ANSI T1.413, Network and Customer Installation Interfaces - Asymmetric Digital Subscriber Line (ADSL) Metallic interface 1995. ITU-T I.361 - B-ISDN ATM Layer specification, November 95. ITU-T I.363 B-ISDN ATM Adaptation Layer (AAL) Specification, March 93

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

ITU-T I.413 (3/93) - B-ISDN User-Network Interface ITU-T I.610 - B-ISDN Operation and Maintenance Principles and Functions, March 93. Detailed examples of typical communication device classes are provided in separate white papers that are not a part of this specification. The latest copies of the white papers can be found at http://www.usb.org.

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

1.4 Terms and Abbreviations

802.3 AAL ADSL ASVD AT COMMAND SET ATM BRI BYTE CALL MANAGEMENT
Second generation networking cabling and signaling, commonly known as Ethernet II.(IEEE 802.3) ATM Adaptation Layer Asymmetric Digital Subscriber Line Analog Simultaneous Voice and Data, signaling method mixes data and voice. A telecommunication device control protocol. For details, see TIA-602 or V.25ter. Asynchronous Transfer Mode ISDN Basic Rate Interface, consisting of one D channel and two B channels. For the purposes of this document, the definition of a byte is 8 bits. Refers to a process that is responsible for the setting up and tearing down of calls. This same process also controls the operational parameters of the call. The term call, and therefore call management, describes processes which refer to a higher level of call control, rather than those processes responsible for the physical connection. COMMON-ISDN-API Refers to a USB interface that identifies itself as using the Communication Class definition. Refers to a USB interface that identifies itself as using the Data Class definition. Data Circuit Terminating Equipment; for example, a modem or ISDN TA. Refers to requests and responses that control and configure the operational state of the device. Device management requires the use of a Communication Class interface. A networking cabling and signaling specification jointly developed by DEC, Intel and Xerox. Digital Simultaneous Voice and Data, signaling method mixes data and digitized voice. Data Terminal Equipment; for example, a PC. Family name for protocol building blocks. See Terminal and Unit below. Generic term representing any data frames that may be exchanged over DIX or 802.3 networks. A reliable technique used in modems to switch between data mode and command mode. Developed by Dale Heatherington, an employee of Hayes during the early 1980s. This is covered under United States patent number 4,549,302. Header Error Control Integrated Services Digital Network. International Telecommunications Union (formerly CCITT).

CAPI COMMUNICATION INTERFACE DATA INTERFACE DCE DEVICE MANAGEMENT DIX DSVD DTE ENTITY ETHERNET FRAME HEATHERINGTON ESCAPE SEQUENCE HEC ISDN ITU

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

I.430 I.431 MANAGEMENT

ELEMENT

ISDN BRI physical interface standard. See ITU-T I.430 above ISDN PRI physical interface standard. See ITU-T I.431 above Refers to a type of USB pipe that manages the communication device and its interfaces. Currently, only the Default Pipe is used for this purpose. A Communication Class interface, which has been designated the master of zero or more interfaces that implement a complete function in a USB communication device. This interface will accept management requests for the union. National ISDN 1 is intended to be a set of standards, which every manufacture can conform to for building switch independent ISDN devices. Future standards, denoted as NI-2 and NI-3, are currently being developed. Refers to a type of USB pipe. Although a notification element is not required to be an interrupt pipe, a notification element is typically defined in this way. Protocol Data Unit - A combination of the SDU and the current protocol layer's header and/or trailer. Plain Old Telephone Service. See PSTN. Primary Rate Interface, which consists of one or two D channels and up to 30 B channels. Public Switched Telephone Network. ISDN data link layer protocol. See ITU-T Q.921 above ISDN data link layer protocol. See ITU-T Q.922 above ISDN call control protocol. See ITU-T Q.931 above B-ISDN User Network Interface Layer 3 Specification. See ITU-T Q.2931 above. Service Data Unit User data and control information created at the upper protocol layers that is transferred transparently through a primitive by layer (N+1) to layer (N) and subsequently to (N-1). Protocol for sending faxes over PSTN. See ITU-T T.30 above. Terminal Adapter, which is the equivalent of a modem for ISDN. Entity that represents a starting/ending point for a protocol stack. Telecommunications Industry Association. Time Independent Escape Sequence, which is an alternative method to the Heatherington Escape Sequence for switching between command mode and data mode on an analog modem. This was developed by a group of modem manufacturers in 1991. A relationship between a collection of one or more interfaces that can be considered to form a functional unit. Entity that provides the basic building blocks to describe a protocol stack. A device which simultaneously sends voice and video with optional data.

MASTER
INTERFACE

NI-1

NOTIFICATION
ELEMENT

PDU POTS PRI PSTN Q.921 Q.922 Q.931 Q.2931 SDU

T.30 TA TERMINAL TIA TIES

UNION UNIT VIDEO PHONE

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

V.25TER V.4 V.42 V.42BIS V.110 V.120 X.25 X.75

This is the ITU-T standard for Serial Asynchronous Automatic Dialing and Control, which is commonly known as the AT command set. This is the ITU-T standard for general structure of signals of international alphabet number 5 code for data transmission over the public telephone network. V.42bis data link layer protocol. See ITU-T V.42 above Data compression procedures. See ITU-T V.42bis above Rate adoption procedures. See ITU-T V.110 above Rate adoption procedures. See ITU-T V.120 above See ITU-T X.25 above. Packet switched signaling layer for PSTN. See ITU-T X.75 above

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

2. Management Overview
Several types of communication devices can benefit from the USB. This specification provides models for telecommunication devices, such as telephones, analog modems, ISDN devices and networking devices. It describes:

Specifications for:

   x     x

Communication Device Class Communication Interface Class Data Interface Class

Framework for building a communication device: Assembling the relevant USB logical structures into configurations. Communication Class interface and its usage. Data Class interface and its usage. Usage of additional class types or vendor specific interfaces.

Implementation examples of communication devices, such as a basic telephone, and an analog modem.

Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

3. Functional Characteristics
This section describes the functional characteristics of the Communication Device Class, Communication Interface Class and Data Interface Class, including:

Device organization:

    x

Endpoint requirements. Constructing interfaces from endpoints. Constructing configurations from a variety of interfaces, some of which are defined by other class specifications. Identifying groups of interfaces within configurations that make functional units and assigning a master interface for each union.

Device operation

Although this specification defines both the Communication Interface Class and Data Interface Class, they are two different classes. All communication devices shall have an interface using the Communication Class to manage the device and optionally specify themselves as communication devices by using the Communication Device Class code. Additionally, the device has some number of other interfaces used for actual data transmission. The Data Interface Class identifies data transmission interfaces when the data does not match the structure or usage model for any other type of class, such as Audio.

3.1 Device Organization

A communication device has three basic responsibilities:

x x x

Device management Operational management Data transmission

The device shall use a Communication Class interface to perform device management and optionally for call management. The data streams are defined in terms of the USB class of data that is being transmitted. If there is no appropriate USB class, then the designer can use the Data Class defined in this specification to model the data streams. Device management refers to the requests and notifications that control and configure the operational state of the device, as well as notify the host of events occurring on the device. Call management refers to a process that is responsible for the setting up and tearing down of calls. This same process also controls the operational parameters of the call. The term call, and therefore call management, describes processes that refer to a higher level of call control than those processes responsible for the physical connection. Data transmission is accomplished using interfaces in addition to the Communication Class interface. These interfaces can use any defined USB class or can be vendor-specific.

3.1.1 Communication Device Management

There are two levels of device management for communication devices. The most basic form of device management results from control transfers made on endpoint 0 as outlined in Chapter 9 of the USB Specification. Device management is also required at a higher level, which is specific to communication devices. An example would be configuration of country-specific details for proper configuration of the telephone services. To allow device management at the communication device level, a Union shall be made between all the interfaces that make up the functional unit of the device. A functional descriptor is used to define the group of interfaces that make up a functional unit within a device and is outlined in Section 5.2.3.8, Union Functional Descriptor, of this specification. Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

With the increasing popularity of multi-channel devices, a new class of device may need to expose multiple device management interfaces for device management at the communication device level. This would allow individual control of the multiple channels, such as an ISDN device. In this case, the Union would be between the Communication Class interface providing call control and the various interfaces it was managing at the moment.

3.2 Device Operation

Communication devices present data to the host in a form defined by another class, such as Audio, Data, or HID Interface. To allow the appropriate class driver to manage that data, the host is presented with one or more interfaces, as specified for that class. The interfaces required may change according to events that are initiated by the user or the network during a communication session: for example, the transition from a data only call to a data and voice call. To allow the host to properly deal with the situation where multiple interfaces are used to create a single function, the device can optionally identify itself at the device level with the Communication Device Class code. This allows the host, if needed, to load any special drivers to properly configure the multiple interfaces into a single function in the host. Note: In the case where the device does not choose to identify itself at the device level with the Communication Device Class code, the device shall employ a USB Common Class Feature mechanism that associates multiple interfaces on the device with a single driver in the host. As of December 15, 1998, this feature was still under development within the Common Class Working Group. Static characteristics of the device, such as the physical connections, are described in terms of the USB device, interface, and endpoint descriptors. The data that moves over the physical interfaces is dynamic in nature, causing the characteristics of the interfaces to change as the data requirements change. These dynamic changes are defined in terms of messages transmitted between the device and host over the Communication Class interface. The device can use a standard or proprietary mechanism to inform its host software when an interface is available and what the format of the data will be. The host software can also use this same mechanism to retrieve information about data formats for an interface and select a data format when more than one is available.

3.3 Interface Definitions

Two classes of interfaces are described in this specification: Communication Class interfaces and Data Class interfaces. The Communication Class interface is a management interface and is required of all communication devices. The Data Class interface can be used to transport data whose structure and usage is not defined by any other class, such as Audio. The format of the data moving over this interface can be identified using the associated Communication Class interface.

3.3.1 Communication Class Interface

This interface is used for device management and, optionally, call management. Device management includes the requests that manage the operational state of the device, the device responses, and event notifications. Call management includes the requests for setting up and tearing down calls, and the managing of their operational parameters. The Communication Class defines a Communication Class interface consisting of a management element and optionally a notification element. The management element configures and controls the device, and consists of endpoint 0. The notification element transports events to the host, and in most cases, consists of a interrupt endpoint. Notification elements pass messages via an interrupt or bulk endpoint, using a standardized format. Messages are formatted as a standardized 8-byte header, followed by a variable-length data field. The header identifies the kind of notification, and the interface associated with the notification; it also indicates the length of the variable length portion of the message. The Communication Class interface shall provide device management by furnishing a management element (endpoint 0); the interface optionally can provide host notification by furnishing a notification element. Only the management element is required for a complete Communication Class interface. The management element also meets the requirements for devices as outlined in the USB Specification. Call management is provided in the communication Version 1.1

January 19, 1999

USB Class Definitions for Communication Devices

interface and optionally multiplexed on a data interface. The following configurations describe how the device might provide call management with and without the use of the Communication Class interface:

The device does not provide any call management on the Communication Class interface and is made up of only a management element (endpoint 0). In this case, the Communication Class interface is minimally represented and only provides device management over a management element (endpoint 0). This corresponds to the Multi-Channel Control Model, as described in Section 3.7.1, and the CAPI Control Model as described in Section 3.7.2. The device does not provide an internal implementation of call management and only accepts minimum set of call management commands from the host. In this case, both a management element and a notification element represent the Communication Class interface. This corresponds to the Direct Line Control Model, as described in Section 3.6.1 Direct Line Control Model. The device provides an internal implementation of call management over the Data Class interface but not the Communication Class interface. In this case, the Communication Class interface is also minimally represented and only provides device management over a management element (endpoint 0). This configuration most closely corresponds to the Abstract Control Model in which commands and data are multiplexed over the Data Class interface. Activation of the command mode from data mode is accomplished using the Heatherington Escape Sequence or the TIES method. For more information about the Abstract Control Model, see Section 3.6.2, Abstract Control Model. The device provides an internal implementation of call management that is accessed by the host over the Communication Class interface. In this case, the Communication Class interface performs both call and device management, and consists of a management element (endpoint 0) and a notification element (normally a interrupt endpoint). The management element will transport both call management and device management commands. The notification element will transport asynchronous event information from the device to the host, such as notification of an available response, which then prompts the host to retrieve the response over the management element. This corresponds to the Abstract Control Model. For more information about the Abstract Control Model, see Section 3.6.2, Abstract Control Model.

3.3.2 Data Class Interface

The Data Class defines a data interface as an interface with a class type of Data Class. Data transmission on a communication device is not restricted to interfaces using the Data Class. Rather, a data interface is used to transmit and/or receive data that is not defined by any other class. This data could be:

x x x

Some form of raw data from a communication line. Legacy modem data. Data using a proprietary format.

At this time, it is the responsibility of the host software and device to communicate with each other over some other interface (such as a Communication Class interface) to determine the appropriate format to use. As more complicated communication devices are defined, it may become necessary to define a method of describing the protocol used within the Data Class interface. The attributes of a Data Class interface are as follows:

x x x x

The Interface descriptor uses the Data Class code as its class type. This is the only place that the Data Class code is to be used. The data is always a byte stream. The Data Class does not define the format of the stream, unless a protocol data wrapper is used. If the interface contains isochronous endpoints, on these endpoints, the data is considered synchronous. If the interface contains bulk endpoints, on these endpoints, the data is considered asynchronous.

Version 1.1

10

January 19, 1999

USB Class Definitions for Communication Devices

Isochronous pipes are used for data that meets the following criteria:

x x

Constant bit rate. Real-time communication that requires low latency.

In general, isochronous endpoints can be used where raw information (either sampled or direct) from the network is sent to the host for further processing and interpretation. For example, an inexpensive ISDN TA could use an isochronous pipe for transport of the raw-sampled bits off a network connection. In this case, the host system would be responsible for the different network protocol that makes up an ISDN connection. This type of interface shall only be used in situations in which an Audio Class interface would not provide the necessary definitions or control. The type and formatting of the media to be used is specified via messaging over the management element of a Communication Class interface when the host activates an interface or the device requests that an interface be activated. The bandwidth of the pipe is defined by the Endpoint descriptors and can be changed by selecting an alternate interface of an appropriate bandwidth.

3.3.2.1 Protocol Data Wrapper

To support embedded high-level protocols in a device, the data and commands between host and device must retain their order. This ensures that a protocol stack that is designed to run in a real time operating system can be split into two parts running in separate devices. Therefore, commands and data for a protocol have to be multiplexed onto the same interface using a wrapper; this wrapper also has the facility to send data to any layer of the stack. Each protocol specifies how to define protocol-specific commands and data fields going across its upper interface edge. The host and device agree upon the wrapper feature at the time the protocol of the data is established. It is the responsibility of the host software and the device to communicate with each other over some other interface (such as a Communication Class interface) to determine the protocol. The wrapper is not used if there is no protocol established. It is optional to use the wrapper if the established protocol could use it; it is mandatory to use the wrapper if the protocol requires it. To enable the different types of protocol stacks found on communication devices, two general forms have been defined for the data wrapper header as defined in Table 1. The structure for both forms is the same, the only difference is the usage of the source protocol ID. If no source protocol is needed or known, then offset 3, bSrcProtocol is set to 00h. The second form of the data wrapper header allows for both a source and destination protocol for the more structured protocol stack where both a source and destination protocol are needed. Both data wrapper forms impose no restrictions on the data format, beyond the general requirement that the data is byte data. In any case where the source protocol is unneeded or unknown the source protocol ID (bSrcProtocol) of 00h is used. Note: Use of a Protocol Data Wrapper on an isochronous pipe is not recommended, because of the possible loss of data because of the unreliable nature of isochronous pipes. Table 1: Data Class Protocol Wrapper Layout
Offset Field Size Value Description

0 2 3 4 N+3 bDstProtocol bSrcProtocol BData0 BDataN-1

2 1 1 1 1

Number Protocol Protocol Number Number

Size of wrapper in bytes Destination protocol ID. Source protocol ID. First data bytes

Nth data byte

Version 1.1

11

January 19, 1999

USB Class Definitions for Communication Devices

3.4 Endpoint Requirements

The following sections describe the requirements for endpoints in Communication Class or Data Class interfaces.

3.4.1 Communication Class Endpoint Requirements

The Communication Class interface requires one endpoint, a management element. It optionally can have an additional endpoint, the notification element. The management element uses the default endpoint for all standard and Communication Class-specific requests. The notification element normally uses an interrupt endpoint.

3.4.2 Data Class Endpoint Requirements

The type of endpoints belonging to a Data Class interface are restricted to being either isochronous or bulk, and are expected to exist in pairs of the same type (one In and one Out).

3.5 Device Models

Particular USB communication device configurations are constructed from the interfaces described in previous sections and those described by other class specifications. All communication devices consist of a Communication Class interface plus zero or more other data transmission interfaces, adhering to some other USB class requirements or implemented as vendor-specific interfaces. For example, the following descriptors are appropriate for a communication device:

Device descriptor contains the class code of the Communication Device Class, defined in Table 14. Optionally, the device descriptor contains a class code of 00h, which indicates that the host should look at the interfaces to determine how to use the device. An Interface descriptor with the Communication Class code, which contains a management element and optionally a notification element. Zero or more other interfaces with class codes of various types such as Audio, Data, etc.

x x

The device models outlined in the following sections are divided into several categories. As this specification develops, other models will be added. The term model describes a type of device and the interfaces that make it up. The term control model describes the type of Communication Class interface being used and is assigned a SubClass code for that interface. A control model can be used in several device models in which the method of device control and call management are similar.

3.6 USB POTS Models

A USB telephony device used on a POTS line has several types of interfaces that could be presented to the host. The arrangement and use of those different interfaces depends upon the type of POTS telephony device and the basic model used to build the device. The difference between the various models of telephony devices can be divided according to the amount of processing the device performs on the analog signal before presenting it to the host. To help illustrate how the different types of interfaces could be put together to build a USB POTS telephony device, three example models are presented in the following sections. Note: In many cases, a Data Class interface might not be used to present data to the host. Where the USB device is constructed with minimal intelligence, some analog class-specific interface control codes are required.

Version 1.1

12

January 19, 1999

USB Class Definitions for Communication Devices

3.6.1 Direct Line Control Model

The Direct Line Control Model contains two examples: the Direct Line Model (or DL Model) and the Datapump Model. A Communication Class interface of type Direct Line Control Model will consist of a minimum of two pipes; one is used to implement the management element and the other to implement a notification element. In addition, the device can use two or more pipes to implement channels over which to carry vendor-specific data.

3.6.1.1

DL Model

The DL Model is the simplest type of connection to a POTS line. At this level, the USB device is only converting the analog POTS line signal to digital data and presenting it to the USB bus. The modem modulation protocol (e.g. V.34, V.32bis) is implemented in the host. Instead of using the Data Class, the Audio Class is used to present the digitally converted data to the host. This type of connection could also be useful for a voice-only device, such as an answering machine. Because the DL Model is the simplest, it provides a perfect example of why a device requires the Direct Line Control Model control codes. The key feature of a DL Model device is low cost, so reducing the processing power requirements on the USB device is essential. The DL Model uses a Direct Line Control Model SubClass code in the descriptor definition of its Communication Class interface.
Data Compression (V.42bis) Error Correction (V.42) Carrier Modulation (datapump) Audio Class Interface Communication Class Interface Command and Control

USB Host USB Device

POTS Interface (CODEC) Data Access Arrangement (DAA) Control

Figure 1: DL Model

These requests for controlling the interface between the USB device and the POTS line are presented in Table 2. There are also some additional signals that fall outside the analog phone signal which shall go back to the host as notifications, which are represented in Table 3. These requests and notifications are transported via the Communication Class interface for the device. Table 2: Requests
Request SET_AUX_LINE_STATE SET_HOOK_STATE PULSE_SETUP SEND_PULSE SET_PULSE_TIME Code 10h 11h 12h 13h 14h

 Direct Line Control Model*

Reqd/Opt Optional Required Optional Optional Optional

Description Request to connect or disconnect secondary jack from POTS circuit or CODEC, depending on hook state. Select relay setting for on-hook, off-hook, and caller ID. Initiate pulse dialing preparation. Request number of make/break cycles to generate. Setup value for time of make and break periods when pulse dialing.

Version 1.1

13

January 19, 1999

USB Class Definitions for Communication Devices

Request RING_AUX_JACK

Code 15h

Description Request for a ring signal to be generated on secondary phone jack.

Reqd/Opt Optional

*These requests are specific to the Communication Class. The only class-specific request codes that are valid for a Communication Class interface with a Communication Class SubClass code of Direct Line Control Model are listed in the previous Table 2. The other class-specific requests not listed in the previous table, such as SEND_ENCAPSULATED_COMMAND, are inappropriate for a Direct Line Control Model and shall generate a STALL condition if sent to such an interface. For example, hanging up the line would be accomplished by using SET_HOOK_STATE, rather than by sending ATH via SEND_ENCAPSULATED_COMMAND. Table 3: Notifications
Notification AUX_JACK_HOOK_ STATE RING_DETECT Code 08h 09h Description Indicates hook state of secondary device plugged into the auxiliary phone jack. Message to notify host that ring voltage was detected on POTS interface.

 Direct Line Control Model*

Reqd/Opt Optional Required

* These notifications are specific to the Communication Class. The only class-specific notification codes, which are valid for a Communication Class interface with a Communication Class SubClass code of Direct Line Control Model, are listed in the previous table. The other class-specific notifications not listed in the previous table, such as RESPONSE_AVAILABLE, are inappropriate for a Direct Line Control Model and shall not be sent by such a device.

3.6.1.2 Datapump Model

The Datapump view of the device is the next logical break and is similar to the DL Model. In the Datapump view, the USB device handles the carrier modulation instead of the host. Because there are no standard interfaces for Datapumps, and it would be difficult to generalize the I/O space and registers required, it is assumed a vendor-specific interface is employed based on the specifics of the Datapump being used. The POTS line interface requests and notifications required for the Datapump USB device are the same as the DL Model as described in Table 2 and Table 3, so the Direct Line Control Model SubClass code shall be used.
Data Compression (V.42bis) Error Correction (V.42) Vendor Defined I/F USB Host USB Device Carrier Modulation (datapump) Control Data Access Arrangement (DAA) Command and Control Communication Class Interface

Figure 2: Datapump Model

Version 1.1

14

January 19, 1999

USB Class Definitions for Communication Devices

3.6.2 Abstract Control Model

With an Abstract Control Model, the USB device understands standard V.25ter (AT) commands. The device contains a Datapump and micro-controller that handles the AT commands and relay controls. The device uses both a Data Class interface and a Communication Class interface. For an illustration of the use of both interfaces, see Figure 3. The device can also, at times, make use of other class interfaces; for example a device could use an Audio Class interface for the audio functions in a speakerphone. A Communication Class interface of type Abstract Control Model will consist of a minimum of two pipes; one is used to implement the management element and the other to implement a notification element. In addition, the device can use two pipes to implement channels over which to carry unspecified data, typically over a Data Class interface. For POTS line control, an Abstract Control Model shall either support V.25ter commands embedded in the data stream or V.25ter commands sent down the Communication Class interface. When V.25ter commands are multiplexed in the data stream, the Heatherington Escape Sequence or the TIES method would define the only supported escape sequences.

USB Host Data Class Interface USB Device Communication Class Interface

Data Compression (V.42bis) Control Error Correction (V.42) Carrier Modulation (datapump) Data Access Arrangement (DAA)

Figure 3: Abstract Control Model

Error correction and data compression could be implemented on the host, and not necessarily on the device. This type of device differs from the Direct Line Control Model, because the data from the USB device is presented to the host via a native class-defined interface rather than a vendor-specific Datapump interface. Also, V.25ter commands are used to control the POTS line interface. V.80 defines one way that the host can control the DCE data stream to accomplish this, but there are also proprietary methods.

3.6.2.1 Abstract Control Model Serial Emulation

The Abstract Control Model can bridge the gap between legacy modem devices and USB devices. To support certain types of legacy applications, two problems need to be addressed. The first is supporting specific legacy control signals and state variables which are addressed directly by the various carrier modulation standards. Because of these dependencies, they are important for developing an analog modem, which presents an Abstract Control Model type Communication Class interface to the host. To support these requirement additional requests (Table 4) and notifications (Table 5) have been created. The second significant item which is needed to bridge the gap between legacy modem designs and the Abstract Control Model is a means to multiplex call control (AT commands) on the Data Class interface. Legacy modem designs are limited by only supporting one channel for both "AT" commands and the actual data. To allow this type of functionality, the device must have a means to specify this limitation to the host.

Version 1.1

15

January 19, 1999

USB Class Definitions for Communication Devices

When describing this type of device, the Communication Class interface would still specify a Abstract Control Model, but call control would actually occur over the Data Class interface. To describe this particular characteristic, the Call Management Functional Descriptor (Section 5.2.3.2) would have bit D1 of bmCapabilities set. For devices that support both modes, call control over the Communication Class interface and call control over a Data Class interface, and need to switch between them, then the GetCommFeature (Section 6.2.4) request is used to switch between modes. Table 4: Requests
Request SEND_ENCAPSULATED_ COMMAND GET_ENCAPSULATED_ RESPONSE SET_COMM_FEATURE GET_COMM_FEATURE CLEAR_COMM_FEATURE SET_LINE_CODING GET_LINE_CODING SET_CONTROL_LINE_STATE SEND_BREAK Code 00h 01h 02h 03h 04h 20h 21h 22h 23h

 Abstract Control Model*

Reqd/Opt Required Required Optional Optional Optional + +

Description Issues a command in the format of the supported control protocol. Requests a response in the format of the supported control protocol. Controls the settings for a particular communication feature. Returns the current settings for the communication feature. Clears the settings for a particular communication feature. Configures DTE rate, stop-bits, parity, and number-of-character bits. Requests current DTE rate, stop-bits, parity, and number-of-character bits. RS-232 signal used to tell the DCE device the DTE device is now present. Sends special carrier modulation used to specify RS-232 style break.

Optional Optional

Optional Optional

* These requests are specific to the Communication Class. + For an analog modem, it is strongly recommended to support these requests. The only class-specific request codes that are valid for a Communication Class interface with a Communication Class SubClass code of Abstract Control Model are listed in the previous Table 4. The other class-specific requests not listed in the previous table, such as SET_HOOK_STATE, are inappropriate for an Abstract Control Model and would generate a STALL condition if sent to such an interface. For example, hanging up the line would be accomplished by sending ATH via SEND_ENCAPSULATED_COMMAND, rather than by using SET_HOOK_STATE. Table 5: Notifications
Notification NETWORK_CONNECTION RESPONSE_AVAILABLE SERIAL_STATE Code 00h 01h 20h

 Abstract Control Model*

Reqd/Opt Optional +

Description Notification to host of network connection status. Notification to host to issue a GET_ENCAPSULATED_RESPONSE request. Returns the current state of the carrier detect, DSR, break, and ring signal.

Required +

Optional

* These notifications are specific to the Communication Class. + For an analog modem, it is strongly recommended to support these requests. The only class-specific notification codes, which are valid for a Communication Class interface with a Communication Class SubClass code of Abstract Control Model, are listed in the previous Table 5. The other class-specific notifications not listed in the previous table, such as RING_DETECT, are inappropriate for an Abstract Control Model and shall not be sent by such a device.

Version 1.1

16

January 19, 1999

USB Class Definitions for Communication Devices

3.6.3 USB Telephone Model

A USB telephone device has a type of Communication Class interface that will be presented to the host, and it has the SubClass code of Telephone Control Model. A telephone device will not typically present a Data Class interface.

3.6.3.1 Telephone Control Model

Telephone devices with multiple lines will have a separate Communication Class interface for each physical line connected to the device. Each individual interface will correspond to a different physical line representing a network connection to the device. Functional descriptors will be used to describe the various capabilities of a USB telephone device. These functional descriptors are defined in Section 5.2.3, Functional Descriptors. A Communication Class interface of SubClass code Telephone Control Model will consist of a minimum of two pipes: one to implement the management element and the other to implement the notification element. This model describes the simplest version of a USB telephone device using only a Communication Class interface; other, more complicated implementations are possible. To create more complicated implementations of a USB telephone device for example, use an Audio Class interface to provide the audio capabilities of a telephone and a Human Interface Device Class interface to provide the keypad capabilities of a telephone.
USB Host USB Device Communication Class Interface

Control

Line & Call Control Ringer

Figure 4: Telephone Control Model

The requests for controlling the USB telephone device via its Communication Class interface are presented in Table 6. Unsolicited messages from the USB telephone device to the host are sent using the notification element messages that are presented in Table 7. These requests and notifications are transported via the Communication Class interface for the device. Table 6: Requests
Request SET_COMM_FEATURE GET_COMM_FEATURE CLEAR_COMM_FEATURE SET_RINGER_PARMS Code 02h 03h 04h 30h

 Telephone Control Model*

Reqd/Opt Optional Optional Optional Optional

Description Used to set a unique communication feature, which is normally specific to a particular device. Returns the current settings for the communication feature. Clears the settings for a particular communication feature. Configures the ringer for a telephone device.

Version 1.1

17

January 19, 1999

USB Class Definitions for Communication Devices

Request GET_RINGER_PARMS SET_OPERATION_PARMS GET_OPERATION_PARMS SET_LINE_PARMS

Code 31h 32h 33h 34h

Description Gets the current ringer configuration for a telephone device. Configures the operational mode of the telephone. Gets the current operational mode of the telephone. Allows changing the current state of the line associated with the interface, providing basic call capabilities, such as dialing and answering calls. Gets current status of the line. Dials digits on the network connection.

Reqd/Opt Required Optional Optional Required

GET_LINE_PARMS DIAL_DIGITS

35h 36h

Required Required

* These requests are specific to the Communication Class. Table 7: Notifications

Notification CALL_STATE_CHANGE LINE_STATE_CHANGE Code 28h 29h

 Telephone Control Model*

Reqd/Opt Required Optional

Description Reports a state change on a call. Reports a state change on a line.

* These notifications are specific to the Communication Class.

3.7 USB ISDN Models

An ISDN network provides several channels that an USB ISDN device may present to a host. They consist of a call control channel (D-Channel) and some data channels (B-Channels). Depending on functional requirements on the device, these channels may be presented to the host on separate Data Class interfaces using the Multi-Channel Model, or multiplexed onto one Data Class interface using the CAPI Model. Common for the two models are that the Communication Class interface is only used for device management.

3.7.1 Multi-Channel Model

A Multi-Channel communication device is defined as a communication device having a number of channels multiplexed on the physical network interface, where each channel has independent call control. The prime characteristic of a Multi-Channel device is its ability to multiplex several channels on a physical network interface using a MUX protocol stack. Assuming there are n channels (x .. z) on the physical interface, where n is network and device specific, physical channels are mapped to a standard set of channels (0 .. n-1) by the protocol stack. The standard channels carrying data with unspecified format are then explicitly mapped to some USB interface (See Section 5.2.3.11 for more details). The protocol stack may also expose an USB interface for protocol management.

Version 1.1

18

January 19, 1999

USB Class Definitions for Communication Devices

Communication Class Interface Device control

Data Class Interface

USB

Ch 0
Ch x Ch y Ch z

Data Class Interface

Protocol stack

Ch 1

Ch n-1
Data Class Interface Protocol stack

Before a channel is presented to USB it is assigned a Class interface. A Data Class interface has to run a protocol stack on the channel in order to define what data the channel carries. Note: A single protocol is considered a protocol stack and framing is considered a protocol. A Protocol Data Wrapper should be used if access to any protocols in the protocol stack is needed. The Multi-Channel model is based on the Open Systems Interconnection (OSI) model which is a layered architecture to structure data communication. The OSI construct is implemented for example in ISDN communication and TCP/IP protocols (for Internet access), as well as local area networks. The basic idea of the OSI model is a hierarchical structure of functions necessary for communication. The OSI model defines 7 layers for handling communication procedures. These layers communicate on a peer-to-peer basis by using a fixed protocol. A communication layer n uses the services of layer n-1 to transfer data and information to a peer entity. Interlayer service access points and connection endpoints provide the means for the transfer of protocol primitives (data, commands and notifications) between the layers. Though in theory, the OSI model strictly separates the different layers and assigned functions, in practice functional units may not be exactly assigned to a definite layer and partly span one or two layers. A Multi-Channel communication device uses for device management a Communication Class interface with a Communication Class SubClass code of Multi-Channel. The only class-specific request codes that are valid for this SubClass code are listed in Table 8. All other class-specific requests not listed in the table are inappropriate for an Multi-Channel Model and would generate a STALL condition if sent to such an interface. Table 8: Requests
Request SET_UNIT_ PARAMETER GET_UNIT_ PARAMETER Code 37h 38h

 Multi-Channel Model*
Reqd/Opt Optional Required

Description Used to set a Unit specific parameter Used to retrieve a Unit specific parameter

Version 1.1

19

MUX Protocol stack

Data Class Interface

Protocol stack

January 19, 1999

USB Class Definitions for Communication Devices

Request CLEAR_UNIT_ PARAMETER

Code 39h

Description Used to set a Unit specific parameter to its default state.

Reqd/Opt Optional

* These requests are specific to the Communication Class.

3.7.1.1 Topology
To be able to manipulate the properties of a protocol stacks, its functionality must be divided into addressable Entities. Two types of such generic Entities are identified and are called Units and Terminals. Protocol stacks are built by connecting together several of these Entities to form the required topology. These Entities may be connected in a many to one or one to many fashion in order to bond channels or share a channel among many interfaces.

Units: Units are Entities that provide the basic building blocks to describe different protocol stacks. There are two kinds of Units: Protocol and Extension. Protocol Units identify instances of protocols defined in this document. Extension Units are vendor specific extensions to this set. Each Unit has one or more Child pins used to connect to its immediate neighboring Unit or Terminal below it on the stack. Terminals: Terminals are Entities that represents a starting/ending point for a protocol stack. It is used to interface between the outside world and Units in the protocol stack and serves as a receptacle for data flowing in and out. There are two kinds of Terminals: USB and Network Channel Terminals. USB Terminals are those on the top of the protocol stack. Network Channel Terminals are those on the bottom end of the stack. The USB Terminal has one or more Child pins used to connect to its immediate neighboring Unit or Terminal below it on the stack. The Network Channel Terminal, having no Unit or Terminal below it, has no Child pins.

Each Unit and Terminal within a Configuration is assigned a unique identification number, the EntityID, contained in the bEntityID field of the Unit and Terminal descriptor. The value 0x00 is reserved for undefined IDs, effectively restricting the total number of addressable Entities (both Units and Terminals) to 255. Besides uniquely identifying all addressable Entities, the IDs are also used to describe the topology of the protocol stack(s); i.e. the bChild of a Unit or USB Terminal descriptor indicates to which other lower Unit or Terminal this one is connected. A protocol stack can be thought of as some number of Units and Terminals connected together, with the upper most unit exposed as a USB interface and the lower most unit connected to the actual device hardware. By selecting an interface, either during configuration or by setting an alternate interface, you enable the protocol stack. Taking this concept further, if you defined an optional alternate interface with no endpoints (must be number zero), this can be used to relinquish bandwidth (for Isochronous endpoints) and at the same time move a stack into a deactivated state. By moving from a configured protocol stack interface to an alternate interface, with no endpoints, you deactivate the protocol stack. If the default alternate interface zero is used, with no endpoints, the stack will start from a deactivated state and will need to be activated when needed. When the Unit is activated, its state is reset. When a unit is deactivated it will not respond to any message sent to it from Entities above or below.

3.7.2 USB CAPI Model

A USB CAPI device has a single type of Communication Class interface that will be presented to the host and it will have the SubClass code of a CAPI Control Model. A USB CAPI device will present a Data Class interface which is used to exchange CAPI messages. The CAPI Control Model do not use a notification element. CAPI provides an abstraction of services which is independent from the underlying network. Multiple lines, if provided by the underlying network, will be presented through one single interface and controlled and managed via CAPI messages.

Version 1.1

20

January 19, 1999

USB Class Definitions for Communication Devices

The definition of CAPI covers all network relevant details such as call-management and protocol-relevant issues where appropriate. The management and data information are part of the CAPI messages which are by definition operating system independent. The USB CAPI Model supports both intelligent and simple CAPI device designs.

3.7.2.1 CAPI Control Model

With a CAPI Control Model, the USB device understands CAPI commands and CAPI messages. The device will make use of both a Data Class Interface and a Communication Class interface, see Figure 5.

CAPI

Command and Control

Data Class Interface

USB Host USB Device

Communication Class Interface

CAPI D B1 B2

Basic Rate Interfaces

Figure 5: CAPI Control Model for a Basic-Rate Configuration

The CAPI functionality is divided into two parts as shown in the diagram above. Dividing CAPI into two parts allows for different CAPI device designs. Intelligent CAPI devices handle the call management according to the underlying network, for example Q.931 or NI-1 for ISDN, as well as a full set of protocols within the data channels, for example X.75, V.120, V.110, V.42bis, T.30 etc. on the USB device itself. For these devices the CAPI part within the USB device is powerful and is usually loaded as firmware on startup on the device. A firmware download to a device is done through manufacturer specific operations. Simple CAPI devices implement some low layer functionality, usually the direct network interface only. These devices enable the creation of low-cost solutions and require the host to do the bulk of the protocol processing. These simple USB devices are also managed and controlled by CAPI messages. All messages exchanged between the host and CAPI consist of a fixed-length header and a parameter area of variable length. The message length is stored at the beginning of the fixed-length header thus enabling adaptive drivers to forward CAPI messages without further knowledge of the internal CAPI message format. The messages carry all management and data information for the CAPI device. These messages are exchanged via the Data Interface of the device. The CAPI message stream encapsulates all types of data a connection of the underlying network can carry. If conversions to other data formats are necessary these can be accomplished within the host and done in software. In such a way the support of an audio interface is included. This approach enables a integration into the framework of abstract host interfaces as well as the support of existing CAPI applications. The CAPI device reports its implemented functionality using a Communication Class specific request, in order to allow the host to choose an appropriate upper part of the CAPI to run within the host. The request is transported via the Communication Class interface for the device and presented in Table 9. Table 9: Requests
Request GET_PROFILE Code 3Ah Description Returns the implemented capabilities of the device

 CAPI Control Model*

Reqd/Opt Required

* These requests are specific to the Communication Class.

Version 1.1

21

January 19, 1999

USB Class Definitions for Communication Devices

The only class specific request which is valid for a Communication Class interface with a Communication Class SubClass code of the CAPI Control Model is listed in Table 9 above. The other class specific requests not listed in the above table, such as SEND_ENCAPSULATED_COMMAND, are inappropriate for a CAPI Control Model and shall generate a STALL condition if sent to such an interface.

3.8 USB Networking Models

A USB Networking device has a type of Communication Class Interface that will be presented to the host for configuring and managing the networking device. Networking devices are typically Always Connected, spending all of their time with the link up. The Communication Class Interface is primarily used to configure and manage the networking device, not to place calls. In contrast to a telecommunications device, a networking device will always have at least one associated Data Class interface to exchange network traffic. In a typical host software stack, the same driver that is responsible for configuring and managing the network device is also the client that is a source/sink of networking traffic. An example of such a host resident networking driver is either an ATM or Ethernet driver. The usage of more than one pair of Communication/Data interfaces will be common for devices that expose more than one interface to the network. For example, an MCNS DOCSIS cable modem has two 48 bit MAC addresses. Its first MAC address is used to manage cable modem functions, while the second MAC address is used for subscriber access to the Internet. For a cable modem implementation where its management functions are migrated to the host, two different Communication Class and Data Class interfaces will be exposed to the host (one pair for each of the 2 MAC addresses). Networking devices are differentiated by their SubClass code, which currently are comprised of the Ethernet Networking Control Model and ATM Networking Control Model.

3.8.1 Common Data Plane Characteristics

The core Data-In/Data-Out pipe mechanism is the same for all networking device models supported by this specification, independent of the media type (e.g., Cable, xDSL, Ethernet) or media data type (e.g., ATM cells, Ethernet frames). Typical USB-based Networking devices will support bulk transfers as the default configuration to exchange data between a host and the USB device. While each data packet of a bulk endpoint is limited to the maximum packet size defined in the associated endpoint descriptor, it should be noted that a host might request multiple bulk USB protocol packets within a single USB frame. For maximum throughput, a Networking device must be prepared to transfer multiple bulk packets within a single USB frame. Some USB-based Networking device implementations may support isochronous data transfers in addition to (or instead of) bulk transfers. Isochronous transfers guarantee data throughput and bounded latency, consistent with the needs of real-time streams (audio, video). Isochronous data errors are reported to receiver, but no data integrity (i.e., retransmission) is provided by the USB link. The Data Class Interface Descriptor protocol code for all Networking Control Models is 00h. USB provides no inherent flow control mechanism for isochronous pipes, and this specification defines no higher level mechanism for doing so. Instead, it is assumed that the host software is responsible for doing traffic shaping as necessary to match any end-to-end negotiation. If the networking device is performing traffic shaping, then either a bulk endpoint should be used, or the flow control methods should be provided using vendor-specific methods. The Data Class interface of a networking device shall have a minimum of two interface settings. The first setting (the default interface setting) includes no endpoints and therefore no networking traffic is exchanged whenever the default interface setting is selected. One or more additional interface settings are used for normal operation, and therefore each

Version 1.1

22

January 19, 1999

USB Class Definitions for Communication Devices

includes a pair of endpoints (one IN, and one OUT) to exchange network traffic. Select an alternate interface setting to initialize the network aspects of the device and to enable the exchange of network traffic. To recover the network aspects of a device to known states, select the default interface setting (with no endpoints) and then select the appropriate alternate interface setting. This action will flush device buffers, clear any filters or statistics counters and will cause NETWORK_CONNECTION and CONNECTION_SPEED_CHANGE notifications to be sent to the host. The effect of a "reset" on the device physical layer is media dependent and beyond the scope of this specification.

Host System
MAC Layer Network Driver Segment Delineation Networking MAC Frames/Cells

Networking Device
Device MAC Segment Delineation

Segment delineation

USB Driver

USB device firmware

USB System Software

USB Interface Firmware

USB Host Controller

Figure 6 - USB Network Device Example

USB Device Controller

3.8.1.1 Segment Delineation

For almost any type of USB attached networking device, a mechanism is needed where both the networking device and the Host can delineate the beginning and ending of a segment within the data stream delivered by an endpoint. The meaning and cause of segment end is media dependent. Below are some examples:

x x x

The end of an Ethernet frame The end of an AAL5 ATM SDU The end of an AAL5 ATM PDU

Version 1.1

23

January 19, 1999

USB Class Definitions for Communication Devices

The arrival of a high priority ATM cell

This positive delineation is done using a USB short packet mechanism. When a segment spans N USB packets, the first packet through packet N-1 shall be the maximum packet size defined for the USB endpoint. If the Nth packet is less than maximum packet size the USB transfer of this short packet will identify the end of the segment. If the Nth packet is exactly maximum packet size, it shall be followed by a zero-length packet (which is a short packet) to assure the end of segment is properly identified. When transmitting data to the networking device, it is assumed that the client of the host USB driver takes the appropriate actions to cause a short packet to be sent to the networking device. For segments with lengths that are an even multiple of the pipes max packet size, the ability to write a buffer of zero length is required to generate this short packet.

3.8.1.2 Segment Size

The host and the attached network device must negotiate to establish the maximum segment size. The upper limit for this is usually a function of the buffering capacity of the attached device, but there may be other factors involved as well. For networking devices that exchange Ethernet frames, the size of a segment is also negotiable. Typical Ethernet frames are 1514 bytes or less in length (not including the CRC), but this could be longer (e.g., 802.1Q VLAN tagging). An ATM oriented device moving cells is a different matter. In the case of AAL5 SDU exchanges, the segment size could be up to 64K bytes in length, and is a function of device buffering capacity and the results of end-to-end negotiation with Q.2931.

3.8.2 Ethernet Networking Control Model

The Ethernet Networking Control Model is used for exchanging Ethernet framed data between the device and host. A Communication Class interface is used to configure and manage various Ethernet functions, where an "Ethernet Networking Control Model" SubClass code is indicated in the descriptor definition of its Communication Class interface. A Data Class interface is used to exchange Ethernet encapsulated frames sent over USB. These frames shall include everything from the Ethernet destination address (DA) up to the end of the data field. The CRC checksum must not be included for either send or receive data. It is the responsibility of the device hardware to generate and check CRC as required for the specific media. Receive frames that have a bad checksum must not be forwarded to the host. This implies that the device must be able to buffer at least one complete Ethernet frame.

Host MAC layer networking driver USB Host Data Class Interface USB Device Communication Class Interface

Media Access Control Control Physical (PHY)

Figure 7: Ethernet Networking Model

Version 1.1

24

January 19, 1999

USB Class Definitions for Communication Devices

Although a typical USB Networking device stays in an always connected state, some Networking device management requests are required to properly initialize both the device and the host networking stack. There also may be occasional changes of device configuration or state, e.g., adding multicast filters. The only class-specific request codes that are valid for a Communication Class interface with a Communication Class SubClass code of Ethernet Networking Control Model are listed in Table 10. Table 10: Requests
Request SEND_ENCAPSULATED_ COMMAND Code 00h

 Ethernet Networking Control Model*

Reqd/Opt Optional

Description Issues a command in the format of the supported control protocol. The intent of this mechanism is to support networking devices (e.g., host-based cable modems) that require an additional vendor-defined interface for media specific hardware configuration and management. Requests a response in the format of the supported control protocol. As applications are loaded and unloaded on the host, the networking transport will instruct the devices MAC driver to change settings of the Networking devices multicast filters. Some hosts are able to conserve energy and stay quiet in a sleeping state while not being used. USB Networking devices may provide special pattern filtering hardware that enables it to wake up the attached host on demand when something is attempting to contact the host (e.g., an incoming web browser connection). Primitives are needed in management plane to negotiate the setting of these special filters Retrieves the status of the above power management pattern filter setting Sets device filter for running a network analyzer application on the host machine Retrieves Ethernet device statistics such as frames transmitted, frames received, and bad frames received.

GET_ENCAPSULATED_ RESPONSE SET_ETHERNET_ MULTICAST_FILTERS

01h 40h

Optional Optional

SET_ETHERNET_ POWER_MANAGEMENT_ PATTERN_FILTER

41h

Optional **

GET_ETHERNET_ POWER_MANAGEMENT_ PATTERN_FILTER SET_ETHERNET_ PACKET_FILTER GET_ETHERNET_ STATISTIC

42h

Optional **

43h 44h

Required Optional

* These requests are specific to the Communication Class. ** If the SET_ETHERNET_POWER_MANAGEMENT_PATTERN_FILTER command is supported, then the GET_ETHERNET_POWER_MANAGEMENT_PATTERN_FILTER request must be supported as well. The only class-specific notification codes, which are valid for a Communication Class interface with a Communication Class SubClass code of Ethernet Networking, are listed in the following table. Table 11: Notifications
Notification NETWORK_CONNECTION RESPONSE_AVAILABLE CONNECTION_SPEED_ CHANGE Code 00h 01h 2Ah

 Ethernet and ATM Networking Control Models*

Description Reports whether or not the physical layer (modem, Ethernet PHY, etc.) link is up. Notification to host to issue a GET_ENCAPSULATED_RESPONSE request. Reports a change in upstream or downstream speed of the networking device connection. Reqd/Opt Required Optional Required

* These notifications are specific to the Communication Class.

Version 1.1

25

January 19, 1999

USB Class Definitions for Communication Devices

3.8.3 ATM Networking Control Model

An ATM USB device is used to move ATM cells or AAL5 SDUs to and from the host. The segmentation and reassembly (SAR) function in the ATM adaptation layer may be implemented on the host, and not necessarily on the device. A Communication Class interface is used to configure and manage various ATM functions, where an "ATM Networking Control Model" SubClass code is indicated in the descriptor definition of its Communication Class interface. This Communication Class interface consists of a minimum of two pipes; one is used to implement the management element and the other to implement a notification element. A Data Class interface is used to exchange ATM cells or AAL5 SDUs sent over USB. The host may perform traffic shaping on an aggregated basis according to the upstream speed reported via the Communication Class interface.

Host ATMnetworking driver

USB Host Data Class Interface ATMData Plane USB Device Communication Class Interface Control

Figure 8: ATM Networking Model

These requests for controlling the interface between the USB ATM device are presented in the following table. There are also some additional signals that shall go back to the host as notifications, which are represented in Table 13. These requests and notifications are transported via the Communication Class interface for the device. Table 12: Requests
Request SEND_ENCAPSULATED_ COMMAND Code 00h

 ATM Networking Control Model*

Reqd/Opt Optional

Description Issues a command in the format of the supported control protocol. The intent of this mechanism is to support networking devices (e.g., host-based cable modems) that require an additional vendor-defined interface for media specific hardware configuration and management. Requests a response in the format of the supported control protocol. Chooses which ATM data format will be exchanged between the host and the ATM Networking device. Retrieves global statistics from the ATM Networking device. Pre-selects the VPI/VCI value for subsequent GetATMVCStatistics requests Retrieves statistics from the ATM Networking device for a particular VPI/VCI.

GET_ENCAPSULATED_ RESPONSE SET_ATM_DATA_ FORMAT GET_ATM_DEVICE_ STATISTICS SET_ATM_DEFAULT_VC GET_ATM_VC_ STATISTICS

01h 50h 51h 52h 53h

Optional Required Required Optional Optional

* These requests are specific to the Communication Class. The only class specific request codes that are valid for a Communication Class interface with a SubClass code of ATM Networking Control Model are listed in the previous table. The other class specific requests not listed in the previous

Version 1.1

26

January 19, 1999

USB Class Definitions for Communication Devices

table are inappropriate for an ATM Networking Control Model and must generate a STALL condition if sent to such an interface. Table 13: Notifications
Notification NETWORK_CONNECTION RESPONSE_AVAILABLE CONNECTION_SPEED_ CHANGE Code 00h 01h 2Ah

 Ethernet and ATM Networking Control Models*

Description Reports whether or not the physical layer (modem, Ethernet PHY, etc.) link is up. Notification to host to issue a GET_ENCAPSULATED_RESPONSE request. Reports a change in upstream or downstream speed of the networking device connection. Reqd/Opt Required Optional Required

* These notifications are specific to the Communication Class. The only class specific notification codes, which are valid for a Communication Class interface with a SubClass code of ATM Networking Control Model, are listed in the previous table. The other class specific notifications not listed in the previous table are inappropriate for a ATM Networking Control Model and shall not be sent by a device.

Version 1.1

27

January 19, 1999

USB Class Definitions for Communication Devices

4. Class-Specific Codes for Communication Devices

This section lists the codes for the Communication Device Class, Communication Interface Class and Data Interface Class, including subclasses and protocols. These values are used in the bDeviceClass, bInterfaceClass, bInterfaceSubClass, and bInterfaceProtocol fields of the standard device descriptors as defined in chapter 9 of the USB Specification.

4.1 Communication Device Class Code

The following table defines the Communication Device Class code: Table 14: Communication Device Class Code
Code 02h Class Communication Device Class

4.2 Communication Interface Class Code

The following table defines the Communication Class code: Table 15: Communication Interface Class Code
Code 02h Class Communication Interface Class

4.3 Communication Interface Class SubClass Codes

The following table defines the SubClass codes for the Communication Interface Class: Table 16: Communication Interface Class SubClass Codes
Code 00h 01h 02h 03h 04h 05h 06h 07h 08h-7Fh 80h-FEh SubClass RESERVED Direct Line Control Model Abstract Control Model Telephone Control Model Multi-Channel Control Model CAPI Control Model Ethernet Networking Control Model ATM Networking Control Model RESERVED (future use) RESERVED (vendor specific)

The Datapump Model, as described in Section 3.6.1.2, Datapump Model, is not listed in Communication Class SubClass codes, because a device of that type will use a Direct Line Control Model for POTS line control and a vendor-specific interface.

Version 1.1

28

January 19, 1999

USB Class Definitions for Communication Devices

4.4 Communication Interface Class Control Protocol Codes

A communication control protocol is used by the USB host to control communication functions in the device or on the network. This specification defines code values for certain standard control protocols. It also reserves codes for additional standard or vendor-specific control protocols. If the Communication Class control model does not require a specific protocol, the value of 00h should be used. Table 17: Communication Interface Class Control Protocol Codes
Protocol code 00h 01h 02h-FEh FFh USB Specification Reference document USB Specification V.25ter Description No class specific protocol required Common AT commands (also known as Hayes compatible) RESERVED (future use) Vendor-specific

4.5 Data Interface Class Codes

The following table defines the Data Interface Class code: Table 18: Data Interface Class Code
Code 0Ah Class Data Interface Class

4.6 Data Interface Class SubClass Codes

At this time this field is un-used for Data Class interfaces and should have a value of 00h.

4.7 Data Interface Class Protocol Codes

The following table defines the Protocol codes for the Data Interface Class: Table 19: Data Interface Class Protocol Codes
Protocol Code 00h 01h 2Fh 30h 31h 32h 33h 4Fh 50h 51h 52h Reference Document USB specification None I.430 ISO/IEC 33091993 None None Q.921M Q.921 Q921TM Description No class specific protocol required RESERVED (future use) Physical interface protocol for ISDN BRI HDLC Transparent RESERVED (future use) Management protocol for Q.921 data link protocol Data link protocol for Q.931 TEI-multiplexor for Q.921 data link protocol

Version 1.1

29

January 19, 1999

USB Class Definitions for Communication Devices

Protocol Code 53h 8Fh 90h 91h 92h 93h 94h - FCh FDh

Reference Document None V.42bis Q.931/EuroISDN V.120 CAPI2.0 None None

Description RESERVED (future use) Data compression procedures Euro-ISDN protocol control V.24 rate adaptation to ISDN CAPI Commands RESERVED (future use) Host based driver. Note: This protocol code should only be used in messages between host and device to identify the host driver portion of a protocol stack. The protocol(s) are described using a Protocol Unit Functional Descriptors on Communication Class Interface. Vendor-specific

FEh FFh

CDC specification USB specification

In certain types of USB communication devices, no protocol will need to be specified in the Data Class interface descriptor. In these cases the value of 00h should be used.

Version 1.1

30

January 19, 1999

USB Class Definitions for Communication Devices

5. Descriptors
5.1 Standard USB Descriptor Definitions
This section defines requirements for the standard USB descriptors for the Communication Device Class, Communication Interface Class and Data Interface Class.

5.1.1 Device Descriptor

Communication device functionality resides at the interface level, with the exception being the definition of the Communication Device Class code. The device code is used solely to identify the device as a communication device and as such, multiple interfaces might be used to form USB functions. This is important to the host for configuration of the drivers to properly enumerate the device. All communication devices will have at least one Communication Class interface that will function as the device master interface. The following tables define the values to properly build a device descriptor and the accompanying interface descriptors. Table 20: Communication Device Class Descriptor Requirements
Offset 4 5 6 Field Size 1 1 1 Value 02h 00h 00h Description Communication Device Class code as defined in Table 14. Communication Device Subclass code, unused at this time. Communication Device Protocol code, unused at this time.

bDeviceClass bDeviceSubClass bDeviceProtocol

5.1.2 Configuration Descriptor

The Communication Device Class uses the standard configuration descriptor defined in chapter 9 of the USB Specification.

5.1.3 Interface Descriptors

The Communication Interface Class uses the standard Interface descriptor as defined in chapter 9 of the USB Specification. The fields defined in the following table shall be used as specified. The use of the remaining fields of the Communication Interface Class descriptor remains unchanged. Table 21: Communication Class Interface Descriptor Requirements
Offset 5 6 7 Field Size 1 1 1 Value Class SubClass Protocol Description Communication Interface Class code, as defined in Table 15. Communication Interface Class SubClass code, as defined in Table 16. Communication Interface Class Protocol code, which applies to the subclass, as specified in the previous field, is defined in Table 17.

bInterfaceClass bInterfaceSubClass bInterfaceProtocol

Version 1.1

31

January 19, 1999

USB Class Definitions for Communication Devices

The Data Interface Class also uses the standard Interface descriptor as defined in chapter 9 of the USB Specification. The fields defined in the following table shall be used as specified. The use of the remaining fields of the Data Interface Class descriptor remains unchanged. Table 22: Data Class Interface Descriptor Requirements
Offset 5 6 7 Field Size 1 1 1 Value 0Ah 00h Protocol Description Data Interface Class code, as defined in Table 18. Data Class SubClass code. Data Class Protocol code, which applies to the subclass, as specified in the previous field, is defined in Table 19.

bInterfaceClass bInterfaceSubClass bInterfaceProtocol

5.1.4 Endpoint Descriptors

The Communication Interface Class and Data Interface Class use the standard Endpoint descriptor, as defined in chapter 9 of the USB Specification.

5.2 Class-Specific Descriptors

This section describes class-specific descriptors for the Communication Interface Class and Data Interface Class. A class-specific descriptor exists only at the Interface level. Each class-specific descriptor is defined as a concatenation of all of the functional descriptors for the Interface. The first functional descriptor returned by the device for the interface shall be a header functional descriptor.

5.2.1 Class-Specific Device Descriptor

This descriptor contains information applying to the entire communication device. The Communication Device Class does not currently use any class-specific descriptor information at the Device level.

5.2.2 Class-Specific Configuration Descriptor

The Communication Device Class currently does not use any class-specific descriptor information at the Configuration level.

5.2.3 Functional Descriptors

Functional descriptors describe the content of the class-specific information within an Interface descriptor. Functional descriptors all start with a common header descriptor, which allows host software to easily parse the contents of classspecific descriptors. Each class-specific descriptor consists of one or more functional descriptors. Although the Communication Class currently defines class specific descriptor information, the Data Class does not. Table 23: Functional Descriptor General Format
Offset 0 Field Size 1 Value Number Description Size of this descriptor.

bFunctionLength

Version 1.1

32

January 19, 1999

USB Class Definitions for Communication Devices

Offset 1 2 3

Field

Size 1 1 1

Value Constant Constant Misc.

Description CS_INTERFACE, as defined in Table 24. Identifier (ID) of functional descriptor. For a list of the supported values, see Table 25. First function specific data byte. These fields will vary depending on the functional descriptor being represented. Nth function specific data byte. These fields will vary depending on the functional descriptor being represented.

bDescriptorType bDescriptorSubtype
(function specific data0)

N+2

(functional specific data N-1)

Misc.

The bDescriptorType values are the same ones defined in the USB Device Class Definition for Audio Devices Specification. They were derived by using the DEVICE, CONFIGURATION, STRING, INTERFACE, and ENDPOINT constants defined in chapter 9 of the USB Specification and by setting the class-specific bit defined within the Common Class Specification to generate corresponding class-specific constants. Table 24: Type Values for the bDescriptorType Field
Descriptor type CS_INTERFACE CS_ENDPOINT Value 24h 25h

Table 25: bDescriptor SubType in Functional Descriptors

Descriptor subtype 00h Comm IF descriptor Yes Data IF descriptor Yes Functional description Header Functional Descriptor, which marks the beginning of the concatenated set of functional descriptors for the interface. Call Management Functional Descriptor. Abstract Control Management Functional Descriptor. Direct Line Management Functional Descriptor. Telephone Ringer Functional Descriptor. Telephone Call and Line State Reporting Capabilities Functional Descriptor. Union Functional descriptor Country Selection Functional Descriptor Telephone Operational Modes Functional Descriptor USB Terminal Functional Descriptor

01h 02h 03h 04h 05h

Yes Yes Yes Yes Yes

No No No No No

06h 07h 08h 09h

Yes Yes Yes Yes

No No No No

Version 1.1

33

January 19, 1999

USB Class Definitions for Communication Devices

Descriptor subtype 0Ah 0Bh 0Ch 0Dh 0Eh 0Fh 10h 11h-FFh

Comm IF descriptor Yes Yes Yes Yes Yes Yes Yes N/A

Data IF descriptor No No No No No No No N/A

Functional description Network Channel Terminal Descriptor Protocol Unit Functional Descriptor Extension Unit Functional Descriptor Multi-Channel Management Functional Descriptor CAPI Control Management Functional Descriptor Ethernet Networking Functional Descriptor ATM Networking Functional Descriptor RESERVED (future use)

5.2.3.1 Header Functional Descriptor

The class-specific descriptor shall start with a header that is defined in Table 23. The bcdCDC field identifies the release of the USB Class Definitions for Communication Devices Specification (this specification) with which this interface and its descriptors comply. Table 26: Class-Specific Descriptor Header Format
Offset 0 1 2 3 Field Size 1 1 1 2 Value Number Constant Constant Number Description Size of this descriptor in bytes. CS_INTERFACE descriptor type. Header functional descriptor subtype as defined in Table 25. USB Class Definitions for Communication Devices Specification release number in binary-coded decimal.

bFunctionLength bDescriptorType bDescriptorSubtype bcdCDC

5.2.3.2 Call Management Functional Descriptor

The Call Management functional descriptor describes the processing of calls for the Communication Class interface. It can only occur within the class-specific portion of an Interface descriptor. Table 27: Call Management Functional Descriptor
Offset 0 1 2 Field Size 1 1 1 Value Number Constant Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE Call Management functional descriptor subtype, as defined in Table 25.

bFunctionLength bDescriptorType bDescriptorSubtype

Version 1.1

34

January 19, 1999

USB Class Definitions for Communication Devices

Offset 3

Field

Size 1

Value Bitmap

Description The capabilities that this configuration supports: D7..D2: D1: RESERVED (Reset to zero) 0 - Device sends/receives call management information only over the Communication Class interface. 1 - Device can send/receive call management information over a Data Class interface. 0 - Device does not handle call management itself. 1 - Device handles call management itself.

bmCapabilities

D0:

The previous bits, in combination, identify which call management scenario is used. If bit D0 is reset to 0, then the value of bit D1 is ignored. In this case, bit D1 is reset to zero for future compatibility. 4

bDataInterface

Number

Interface number of Data Class interface optionally used for call management. *

* Zero based index of the interface in this configuration.(bInterfaceNum)

5.2.3.3 Abstract Control Management Functional Descriptor

The Abstract Control Management functional descriptor describes the commands supported by the Communication Class interface, as defined in Section 3.6.2, with the SubClass code of Abstract Control Model. It can only occur within the class-specific portion of an Interface descriptor. Table 28: Abstract Control Management Functional Descriptor
Offset 0 1 2 Field Size 1 1 1 Value Number Constant Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE Abstract Control Management functional descriptor subtype as defined in Table 25.

bFunctionLength bDescriptorType bDescriptorSubtype

Version 1.1

35

January 19, 1999

USB Class Definitions for Communication Devices

Offset 3

Field

Size 1

Value Bitmap

Description The capabilities that this configuration supports. (A bit value of zero means that the request is not supported.) D7..D4: D3: D2: D1: RESERVED (Reset to zero) 1 - Device supports the notification Network_Connection. 1 - Device supports the request Send_Break 1 - Device supports the request combination of Set_Line_Coding, Set_Control_Line_State, Get_Line_Coding, and the notification Serial_State. 1 - Device supports the request combination of Set_Comm_Feature, Clear_Comm_Feature, and Get_Comm_Feature.

bmCapabilities

D0:

The previous bits, in combination, identify which requests/notifications are supported by a Communication Class interface with the SubClass code of Abstract Control Model.

5.2.3.4 Direct Line Management Functional Descriptor

The Direct Line Management functional descriptor describes the commands supported by the Communication Class interface, as defined in Section 3.6.1, with the SubClass code of Direct Line Control Model. It can only occur within the class-specific portion of an Interface descriptor. Table 29: Direct Line Management Functional Descriptor
Offset 0 1 2 Field Size 1 1 1 Value Number Constant Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE Direct Line Management functional descriptor subtype, as defined in Table 25.

bFunctionLength bDescriptorType bDescriptorSubtype

Version 1.1

36

January 19, 1999

USB Class Definitions for Communication Devices

Offset 3

Field

Size 1

Value Bitmap

Description The capabilities that this configuration supports. (A value of zero means that the request or notification is not supported.) D7..D3: D2: RESERVED (Reset to zero) 1 - Device requires extra Pulse_Setup request during pulse dialing sequence to disengage holding circuit. (see Section 6.2.8) 1 - Device supports the request combination of Set_Aux_Line_State, Ring_Aux_Jack, and notification Aux_Jack_Hook_State. 1 - Device supports the request combination of Pulse_Setup, Send_Pulse, and Set_Pulse_Time.

bmCapabilities

D1:

D0:

The previous bits, in combination, identify which requests/notifications are supported by a Communication Class interface with the SubClass code of DL Control Modem.

5.2.3.5 Telephone Ringer Functional Descriptor

The Telephone Ringer functional descriptor describes the ringer capabilities supported by the Communication Class interface, as defined in Section 3.6.3.1, with the SubClass code of Telephone Control. It can only occur within the class-specific portion of an Interface descriptor. For a multiple line phone device, where separate Communication Class interfaces would exist for each line supported by the phone, typically one interface would be designated via a Union functional descriptor to be the controlling interface for the device. If only one ringer existed for all the lines, the Telephone Ringer Functional descriptor would only be needed for the descriptor of this controlling interface. Table 30: Telephone Ringer Functional Descriptor
Offset 0 1 2 Field Size 1 1 1 Value Number Constant Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE Telephone Ringer functional descriptor subtype as defined in Table 25.

bFunctionLength bDescriptorType bDescriptorSubtype

Version 1.1

37

January 19, 1999

USB Class Definitions for Communication Devices

Offset 3

Field

Size 1

Value Number

Description Number of discrete steps in volume supported by the ringer, values are: 0: 1: 256 discrete volume steps. 1 discrete volume step (i.e., fixed volume). Value 0 will be ringer off setting and Value 1 to 255 will result in the same ringer volume level. 2 discrete volume steps Value 0 will be ringer off setting and Values 1 to 127 will result in the first volume level setting. Values 128 to 255 will result in the 2nd volume level setting 3 discrete volume steps. Value 0 will be ringer off setting and Values 1 to 84 will result in the first volume level setting. Value 85 to 170 will result in the 2nd volume level setting. Value 171 to 255 will result in the 3rd volume level setting.

bRingerVolSteps

2:

3:

As a general rule, the range of volume settings is broken up into a number of equal steps, the number of steps defined by the bRingerVolSteps value. A general formula for defining ranges, based on X=bRingerVolSteps and values [1 to Y] defining the first volume range is: Y = (256/X) - 1, where X<>0 and X<=128 Second volume range is: [ (Y+1) to (Y+Y) ] Note: that the maximum value in the last range must always be 255 4

bNumRingerPatterns

Number

Number of ringer patterns supported, values of 1 to 255 with a value of 0 being reserved for future use.

5.2.3.6 Telephone Operational Modes Functional Descriptor

The Telephone Operational Modes functional descriptor describes the operational modes supported by the Communication Class interface, as defined in Section 3.6.3.1, with the SubClass code of Telephone Control. It can only occur within the class-specific portion of an Interface descriptor. The modes supported are Simple, Standalone, and Computer Centric. See Section 6.2.18, SetOperationParms for a definition of the various operational modes and Table 53 for the definition of the operational mode values. For a multiple line phone device, where separate Communication Class interfaces would exist for each line supported by the phone, typically one interface would be designated via a Union functional descriptor to be the controlling interface for the device. In this case, the Telephone Operational Modes descriptor would only be needed for the descriptor of this controlling interface.

Version 1.1

38

January 19, 1999

USB Class Definitions for Communication Devices

Table 31: Telephone Operational Modes Functional Descriptor

Offset 0 1 2 3 Field Size 1 1 1 1 Value Number Constant Constant Bitmap Description Size of this functional descriptor, in bytes. CS_INTERFACE Telephone Operational Modes functional descriptor subtype as defined in Table 25. This configuration supports the following operational modes: D7..D3: D2: RESERVED (Reset to zero) 0 - Does not support Computer Centric mode. 1 - Supports Computer Centric mode. 0 - Does not support Standalone mode. 1 - Supports Standalone mode. 0 - Does not support Simple mode. 1 - Supports Simple mode.

bFunctionLength bDescriptorType bDescriptorSubtype bmCapabilities

D1:

D0:

5.2.3.7 Telephone Call and Line State Reporting Capabilities Descriptor

The Telephone Call and Line State Reporting Capabilities functional descriptor describes the abilities of a telephone device to report optional call and line states. All telephone devices, as a minimum, shall be capable of reporting the following call states:

x x x x x x

Idle Dialtone Dialing Connected Ringing Answered

Call state reports that are optional and will be described by this descriptor are states such as:

x x x x x x

Interrupted dialtone Ringback Busy Fast busy (also known as equipment busy or reorder tone) Caller ID Distinctive ringing decoding

Line state reports are optional and will be described by this descriptor. The Telephone Call State Reporting Capabilities functional descriptor can exist in the class-specific portion of a Communication Class interface, as defined in Section 3.6.3.1, with the SubClass code of Telephone Control. For a multiple line phone device, where separate Communication Class interfaces would exist for the each line supported by the phone, typically one interface would be designated via a Union functional descriptor, to be the controlling interface Version 1.1

39

January 19, 1999

USB Class Definitions for Communication Devices

for the device. In this case, the Telephone Call State Reporting Capabilities Functional descriptor would only be needed for the descriptor of this controlling interface, if each of the Communication Class interfaces supported the same call state reporting capabilities. Table 32: Telephone Call State Reporting Capabilities Descriptor
Offset 0 1 2 3 Field Size 1 1 1 4 Value Number Constant Constant Bitmap Description Size of this functional descriptor, in bytes. CS_INTERFACE Telephone Call State Reporting Capabilities descriptor subtype, as defined in Table 25. Call and line state reporting capabilities of the device when the following bits are set: D31-D6: RESERVED (Reset to zero) D5: 0 Does not support line state change notification. 1 Does support line state change notification. 0 Cannot report dual tone multifrequency (DTMF) digits input remotely over the telephone line. 1 Can report DTMF digits input remotely over the telephone line. 0 Reports only incoming ringing. 1 Reports incoming distinctive ringing patterns. 0 Does not report caller ID. 1 Reports caller ID information. 0 Reports only dialing state. 1 Reports ringback, busy, and fast busy states. 0 Reports only dialtone (does not differentiate between normal and interrupted dialtone). 1 Reports interrupted dialtone in addition to normal dialtone.

bFunctionLength bDescriptorType bDescriptorSubtype bmCapabilities

D4:

D3:

D2: D1:

D0:

5.2.3.8 Union Functional Descriptor

The Union functional descriptor describes the relationship between a group of interfaces that can be considered to form a functional unit. It can only occur within the class-specific portion of an Interface descriptor. One of the interfaces in the group is designated as a master or controlling interface for the group, and certain class-specific messages can be sent to this interface to act upon the group as a whole. Similarly, notifications for the entire group can be sent from this interface but apply to the entire group of interfaces. Interfaces in this group can include Communication, Data, or any other valid USB interface class (including, but not limited to, Audio, HID, and Monitor). Table 33: Union Interface Functional Descriptor
Offset 0 1 Field Size 1 1 Value Number Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE

bFunctionLength bDescriptorType

Version 1.1

40

January 19, 1999

USB Class Definitions for Communication Devices

Offset 2 3

Field

Size 1 1

Value Constant Constant

Description Union functional descriptor SubType as defined in Table 25. The interface number of the Communication or Data Class interface, designated as the master or controlling interface for the union.* Interface number of first slave or associated interface in the union. *

bDescriptorSubtype bMasterInterface

4 N+3

bSlaveInterface0

1 1

Number Number

bSlaveInterfaceN-1

Interface number of N-1 slave or associated interface in the union. *

* Zero based index of the interface in this configuration (bInterfaceNum).

5.2.3.9 Country Selection Functional Descriptor

The Country Selection functional descriptor identifies the countries in which the communication device is qualified to operate. The parameters of the network connection often vary from one country to another, especially in Europe. Also legal requirements impose certain restrictions on devices because of different regulations by the governing body of the network to which the device must adhere. This descriptor can only occur within the class-specific portion of an Interface descriptor and should only be provided to a master Communication Class interface of a union. The country codes used in the Country Selection Functional Descriptor are not the same as the country codes used in dialing international telephone calls. Implementers should refer to the ISO 3166 specification for more information. Table 34: Country Selection Functional Descriptor
Offset 0 1 2 3 Field Size 1 1 1 1 Value Number Constant Constant Index Description Size of this functional descriptor, in bytes. CS_INTERFACE Country Selection functional descriptor Subtype as defined in Table 25. Index of a string giving the release date for the implemented ISO 3166 Country Codes. Date shall be presented as ddmmyyyy with dd=day, mm=month, and yyyy=year. 4

bFunctionLength bDescriptorType bDescriptorSubtype iCountryCodeRelDate

wCountryCode0

Number

Country code in hexadecimal format as defined in ISO 3166, release date as specified in offset 3 for the first supported country.

2N+2

Number Country code in hexadecimal format as defined in ISO 3166, release date as specified in offset 3 for Nth country supported.

wCountryCodeN-1

5.2.3.10 USB Terminal Functional Descriptor

The USB Terminal Functional Descriptor provides a means to indicate a relationship between a Unit and an USB Interface. It also defines parameters specific to the interface between the device and the host. It can only occur within the class-specific portion of an Interface descriptor.

Version 1.1

41

January 19, 1999

USB Class Definitions for Communication Devices

Table 35: USB Terminal Functional Descriptor

Offset 0 1 2 3 4 5 6 Field Size 1 1 1 1 1 1 1 Value Number Constant Constant Constant Number Number Bitmap Description Size of this functional descriptor, in bytes. CS_INTERFACE USB Terminal Functional Descriptor Subtype as defined in Table 25. Constant uniquely identifying the Terminal The input interface number of the associated USB interface. The output interface number of the associated USB interface. D7..D1: D0: RESERVED (Reset to zero) Protocol wrapper usage 0 - No wrapper used 1 - Wrapper used

bFunctionLength bDescriptorType bDescriptorSubtype bEntityId bInInterfaceNo bOutInterfaceNo bmOptions

7 6+N

bChildId0

1 1

Constant Constant

First ID of lower Terminal or Unit to which this Terminal is connected.

bChildIdN-1

Nth ID of lower Terminal or Unit to which this Terminal is connected.

5.2.3.11 Network Channel Terminal Functional Descriptor

The Network Channel Terminal Functional descriptor provides a means to indicate a relationship between a Unit and a Network Channel. It can only occur within the class-specific portion of an Interface descriptor. Table 36: Network Channel Terminal Functional Descriptor
Offset 0 1 2 3 4 5 6 Field Size 1 1 1 1 1 1 1 Value Number Constant Constant Constant Index Number Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE Network Channel Terminal Functional Descriptor Subtype as defined in Table 25. Constant uniquely identifying the Terminal Index of string descriptor, describing the name of the Network Channel Terminal. The channel index of the associated network channel according to indexing rules below. Type of physical interface: 0 None 1 ISDN 2 to 200 RESERVED (future use) 201 to 255 - Vendor specific

bFunctionLength bDescriptorType bDescriptorSubtype bEntityId iName bChannelIndex bPhysicalInterface

Version 1.1

42

January 19, 1999

USB Class Definitions for Communication Devices

Channel Indexing Rule

A zero-based value identifying the index in the array of concurrent channels multiplexed on the physical interface. For an ISDN physical interface the bChannelIndex starts with zero for the D-channel, one for B1 and so forth.

5.2.3.12 Protocol Unit Functional Descriptor

A communication protocol stack is a combination of communication functions (protocols) into a layered structure. Each layer in the stack presents some abstract function for the layer above according to some layer-interface-standard, making it possible to replace a function with another as long as it conforms to the standard. Each layer may have a set of protocol parameters, defined in Appendix E, to configure it for proper operation in the actual environment and the parameters may be retrieved and/or modified. The Unit state is initially reset. See Section 6.2.23 SetUnitParameter, Section 6.2.24 GetUnitParameter, and Section 6.2.25 ClearUnitParameter for details. A Protocol Unit Functional Descriptor identifies with bEntityId a specific protocol instance of bProtocol in a stack. It can only occur within the class-specific portion of an Interface descriptor. Table 37: Protocol Unit Functional Descriptor
Offset 0 1 2 3 4 5 4+N Field Size 1 1 1 1 1 1 1 Value Number Constant Constant Constant Protocol Constant Constant Nth ID of lower Terminal or Unit to which this Terminal is connected. Description Size of this functional descriptor, in bytes. CS_INTERFACE Protocol Unit Functional Descriptor Subtype as defined in Table 25. Constant uniquely identifying the Unit Protocol code as defined in Table 19 First ID of lower Terminal or Unit to which this Terminal is connected.

bFunctionLength bDescriptorType bDescriptorSubtype bEntityId bProtocol bChildId0

bChildIdN-1

5.2.3.13 Extension Unit Functional Descriptor

The Extension Unit Functional Descriptor provides minimal information about the Extension Unit for a generic driver at least to notice the presence of vendor-specific components within the protocol stack. The bExtensionCode field may contain a vendor-specific code that further identifies the Extension Unit. If it is not used, it should be set to zero. The Unit may have a set of vendor specific parameters to configure it for proper operation in the actual environment and the parameters may be retrieved and/or modified. The Unit state is initially reset. Set Section 6.2.23 SetUnitParameter, Section 6.2.24 GetUnitParameter, and Section 6.2.25 ClearUnitParameter for details. The descriptor can only occur within the class-specific portion of an Interface descriptor. Table 38: Extension Unit Functional Descriptor
Offset 0 1 2 Field Size 1 1 1 Value Number Constant Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE Extension Unit Functional Descriptor Subtype as defined in Table 25

bFunctionLength bDescriptorType bDescriptorSubtype

Version 1.1

43

January 19, 1999

USB Class Definitions for Communication Devices

Offset 3 4 5 6 5+N

Field

Size 1 1 1 1 1

Value Constant Number Index Constant Constant

Description Constant uniquely identifying the Unit Vendor specific code identifying the Extension Unit. Index of string descriptor, describing the name of the Extension Unit. First ID of lower Terminal or Unit to which this Terminal is connected.

bEntityId bExtensionCode iName bChildId0

bChildIdN-1

Nth ID of lower Terminal or Unit to which this Terminal is connected.

5.2.3.14 Multi-Channel Management Functional Descriptor

The Multi-Channel Management functional descriptor describes the commands supported by the Communication Class interface, as defined in Section 3.6.1, with the SubClass code of Multi-Channel. It can only occur within the classspecific portion of an Interface descriptor. Table 39: Multi-Channel Management Functional Descriptor
Offset 0 1 2 3 Field Size 1 1 1 1 Value Number Constant Constant Bitmap Description Size of this functional descriptor, in bytes. CS_INTERFACE Multi-Channel Management functional descriptor subtype, as defined in Table 25 The capabilities that this configuration supports. (A value of zero means that the request or notification is not supported.) D7..D3: D2: RESERVED (Reset to zero) 1 Device supports the request Set_Unit_Parameter.

bFunctionLength bDescriptorType bDescriptorSubtype bmCapabilities

D1: D0:

1 Device supports the request Clear_Unit_Parameter. 1 Device stores Unit parameters in non-volatile memory.

The previous bits identify which requests are supported by a Communication Class interface with the SubClass code of Multi-Channel Control Model.

5.2.3.15 CAPI Control Management Functional Descriptor

The CAPI control management functional descriptor describes the commands supported by the CAPI Control Model over the Data Class interface with the protocol code of CAPI control. It can only occur within the class specific portion of Communication Class Interface descriptor.

Version 1.1

44

January 19, 1999

USB Class Definitions for Communication Devices

Table 40: CAPI Control Management Functional Descriptor

Offset 0 1 2 3 Field Size 1 1 1 1 Value Number Constant Constant Bitmap Description Size of this functional descriptor, in bytes. CS_INTERFACE CAPI Control Management Functional Descriptor Subtype as defined in Table 25 Which capabilities are supported by this configuration. D7..D1: D0: RESERVED (reset to zero). 1 device is an Intelligent CAPI device 0 device is a Simple CAPI device

bFunctionLength bDescriptorType bDescriptorSubtype bmCapabilities

The above bits, in combination, identify which requests/notifications are supported by a Communication Class interface with the protocol code of CAPI Control.

5.2.3.16 Ethernet Networking Functional Descriptor

The Ethernet Networking functional descriptor describes the operational modes supported by the Communication Class interface, as defined in Section 3.8.2, with the SubClass code of Ethernet Networking Control. It can only occur within the class-specific portion of an Interface descriptor. Table 41: Ethernet Networking Functional Descriptor
Offset 0 1 2 3 Field Size 1 1 1 1 Value Number Constant Constant Index Description Size of this functional descriptor, in bytes. CS_INTERFACE Ethernet Networking functional descriptor subtype as defined in Table 25. Index of string descriptor. The string descriptor holds the 48bit Ethernet MAC address. The Unicode representation of the MAC address is as follows: the first Unicode character represents the high order nibble of the first byte of the MAC address in network byte order. The next character represents the next 4 bits and so on. The Unicode character is chosen from the set of values 30h through 39h and 41h through 46h (0-9 and A-F). iMACAddress can not be zero and the Unicode representation must be 12 characters long. For example, the MAC Address 0123456789ABh is represented as the Unicode string "0123456789AB".

bFunctionLength bDescriptorType bDescriptorSubtype iMACAddress

Version 1.1

45

January 19, 1999

USB Class Definitions for Communication Devices

Offset 4

Field

Size 4

Value Bitmap

Description Indicates which Ethernet statistics functions the device collects. If a bit is set to 0, the host network driver is expected to keep count for the corresponding statistic (if able). See Table 42 for a detailed listing of possible Ethernet statistics. Support for any of these statistics is optional. If none of these bits are set, the device does not support the GetEthernetStatistic request.

bmEthernetStatistics

wMaxSegmentSize

Number

The maximum segment size that the Ethernet device is capable of supporting. This is typically 1514 bytes, but could be extended (e.g., 802.1d VLAN) Contains the number of multicast filters that can be configured by the host. D15: 0 - The device performs perfect multicast address filtering (no hashing). 1- The device uses imperfect multicast address filtering (hashing). Here, the host software driver must perform further qualification itself to achieve perfect filtering. Indicates the number of multicast address filters supported by the device (0 to 32767). If the host finds the number of filters supported by the device to be inadequate, it may choose to set the device's Ethernet Packet Filter to forward all multicast frames to the host, performing all multicast filtering in software instead. If this value is 0, the device does not support the SetEthernetMulticastFilters request.

10

wNumberMCFilters

Bitmap

D14..0:

12

bNumberPowerFilters

Number

Contains the number of pattern filters that are available for causing wake-up of the host.

Table 42: Ethernet Statistics Capabilities

Offset D0 D1 D2 D3 D4 D5 D6 D7 D8 Field XMIT_OK RVC_OK XMIT_ERROR RCV_ERROR RCV_NO_BUFFER DIRECTED_BYTES_XMIT DIRECTED_FRAMES_XMIT MULTICAST_BYTES_XMIT MULTICAST_FRAMES_XMIT Description Frames transmitted without errors Frames received without errors Frames not transmitted, or transmitted with errors Frames received with errors that are not delivered to the USB host. Frame missed, no buffers Directed bytes transmitted without errors Directed frames transmitted without errors Multicast bytes transmitted without errors Multicast frames transmitted without errors

Version 1.1

46

January 19, 1999

USB Class Definitions for Communication Devices

Offset D9 D10 D11 D12 D13 D14 D15 D16 D17 D18 D19 D20 D21 D22 D23 D24 D25 D26 D27 D28 D29-D31

Field BROADCAST_BYTES_XMIT BROADCAST_FRAMES_XMIT DIRECTED_BYTES_RCV DIRECTED_FRAMES_RCV MULTICAST_BYTES_RCV MULTICAST_FRAMES_RCV BROADCAST_BYTES_RCV BROADCAST_FRAMES_RCV RCV_CRC_ERROR TRANSMIT_QUEUE_LENGTH RCV_ERROR_ALIGNMENT XMIT_ONE_COLLISION XMIT_MORE_COLLISIONS XMIT_DEFERRED XMIT_MAX_COLLISIONS RCV_OVERRUN XMIT_UNDERRUN XMIT_HEARTBEAT_FAILURE XMIT_TIMES_CRS_LOST XMIT_LATE_COLLISIONS RESERVED

Description Broadcast bytes transmitted without errors Broadcast frames transmitted without errors Directed bytes received without errors Directed frames received without errors Multicast bytes received without errors Multicast frames received without errors Broadcast bytes received without errors Broadcast frames received without errors Frames received with circular redundancy check (CRC) or frame check sequence (FCS) error Length of transmit queue Frames received with alignment error Frames transmitted with one collision Frames transmitted with more than one collision Frames transmitted after deferral Frames not transmitted due to collisions Frames not received due to overrun Frames not transmitted due to underrun Frames transmitted with heartbeat failure Times carrier sense signal lost during transmission Late collisions detected Must be set to zero

5.2.3.17 ATM Networking Functional Descriptor

The ATM Networking functional descriptor describes the operational modes supported by the Communication Class interface, as defined in Section 3.8.3, with the SubClass code of ATM Networking Control. It can only occur within the class-specific portion of an Interface descriptor. Table 43: ATM Networking Functional Descriptor
Offset 0 1 2 Field Size 1 1 1 Value Number Constant Constant Description Size of this functional descriptor, in bytes. CS_INTERFACE ATM Networking functional descriptor subtype as defined in Table 25.

bFunctionLength bDescriptorType bDescriptorSubtype

Version 1.1

47

January 19, 1999

USB Class Definitions for Communication Devices

Offset 3

Field

Size 1

Value Index

Description Index of string descriptor. The string descriptor holds the End System Identifier. The first 6 bytes are the unique hardware ID (like a MAC address), and the 7th byte is the end system selector byte. The Unicode representation of End System Identifier is as follows: the first Unicode character represents the high order nibble of the first byte of the Identifier in network byte order. The next character represents the next 4 bits, and so on. The Unicode character is chosen from the set of values 30h through 39h and 41h through 46h (0-9 and A-F). iEndSystemIdentifier can not be zero and the Unicode representation must be 14 characters long. For example, the End System Identifier 0123456789ABCDh is represented as the Unicode string "0123456789ABCD". The ATM data types the device supports: D7..D4: D3: D2: D1: D0: RESERVED (Reset to zero) Type 3 -- AAL5 SDU Type 2 -- ATM header template + concatenated ATM cell payloads Type 1 -- Concatenated ATM cells RESERVED (Reset to zero)

iEndSystemIdentifier

bmDataCapabilities

Bitmap

NOTE: Support for the Type 1 Data Format is mandatory. 5

bmATMDeviceStatistics

Bitmap

Indicates which optional statistics functions the device collects. If set to 0, the host network driver is expected to keep count. D3 and D4 are only applicable to type 3 devices. If neither D3 nor D4 are set, the type 3 device does not support the SetATMDefaultVC and GetATMVCStatistics requests. D7..D5: D4: RESERVED (Reset to zero) Device counts upstream cells sent on a per VC basis (VC_US_CELLS_ SENT) Device counts downstream cells received on a per VC basis (VC_DS_CELLS_ RECEIVED) Device counts cells with HEC error detected and corrected (DS_CELLS_HEC_ERROR_ CORRECTED) Device counts upstream cells sent (US_CELLS_SENT) Device counts downstream cells received (DS_CELLS_RECEIVED)

D3:

D2:

D1: D0:

6 8

wType2MaxSegmentSize wType3MaxSegmentSize

2 2

Number Number

The maximum segment size that the Type 2 device is capable of supporting The maximum segment size that the Type 3 device is capable of supporting

Version 1.1

48

January 19, 1999

USB Class Definitions for Communication Devices

Offset 10

Field

Size 2

Value Number

Description The maximum number of simultaneous virtual circuits the device is capable of supporting (Type 3 only)

wMaxVC

The wType2MaxSegmentSize and wType3MaxSegmentSize indicate the maximum number of bytes of data in a network segment (i.e., between 2 USB short packets) a device would send to the host via USB for Type 2 and Type 3 devices, respectively. It is expected that a device supporting both Type 2 and Type 3 ATM data formats (as stipulated in the bmDataCapabilities field) may employ different buffer management strategies for different ATM data formats, thus may indicate a different maximum segment size for each type. The host driver should allocate buffers accordingly that are large enough to hold the incoming data to prevent any overflow or partial cell/SDU problems. These two fields also serve to inform the host the device buffer capability, and expect the host to transfer network segments no longer than that specified here. Note that this information does not preclude a device or a host to do cut-through forwarding (i.e., start forwarding the portion of the network segment received so far) before receiving a complete network segment. This maximum segment size does not apply to Type 1 devices, which by definition forward a stream of cells in both directions, and have no concept of network segment size. However, as an implementation note, the host driver should allocate its buffers to contain an integral number of 53-byte cells to prevent partial cells.

5.3 Sample Class-Specific Functional Descriptors

Table 44 presents an example of the Communication Class Functional Descriptors for a simple Abstract Control Model device. Table 44: Sample Communication Class Specific Interface Descriptor*
Offset 0 1 2 3 Field Size 1 1 1 2 Value 05h 24h 00h 0110h Description Size of this functional descriptor, in bytes. CS_INTERFACE Header. This is defined in Table 25, which defines this as a header. USB Class Definitions for Communication Devices Specification release number in binary-coded decimal. Size of this functional descriptor, in bytes. CS_INTERFACE Abstract Control Management functional descriptor subtype as defined in Table 25. This field contains the value 0Fh, because the device supports all the corresponding commands for the Abstract Control Model interface. Size of this functional descriptor, in bytes CS_INTERFACE Union Descriptor Functional Descriptor subtype as defined in Table 25. Interface number of the control (Communication Class) interface Interface number of the slave (Data Class) interface

bFunctionLength bDescriptorType bDescriptorSubtype bcdCDC

5 6 7 8

bFunctionLength bDescriptorType bDescriptorSubtype bmCapabilities

1 1 1 1

04h 24h 02h 0Fh

9 10 11 12 13

bFunctionLength bDescriptorType bDescriptorSubtype bMasterInterface bSlaveInterface0

1 1 1 1 1

05h 24h 06h 00h 01h

Version 1.1

49

January 19, 1999

USB Class Definitions for Communication Devices

Offset 14 15 16 17

Field

Size 1 1 1 1

Value 05h 24h 01h 03h

Description Size of this functional descriptor, in bytes CS_INTERFACE Call Management Functional Descriptor subtype as defined in Table 25. Indicate that the device handles call management itself (bit D0 is set), and will process commands multiplexed over the data interface in addition to commands sent using SEND_ENCAPSULATED_COMMAND (bit D1 is set). Indicates that multiplexed commands are handled via data interface 01h (same value as used in the UNION Functional Descriptor)

bFunctionLength bDescriptorType bDescriptorSubtype bmCapabilities

18

bDataInterface

01h

* This descriptor is specific to the Communication Class.

Version 1.1

50

January 19, 1999

USB Class Definitions for Communication Devices

6. Communication Interface Class Messages

6.1 Overview
The Communication Interface Class supports the standard requests defined in chapter 9 of the USB Specification. In addition, the Communication Interface Class has some class-specific requests and notifications. These are used for device and call management.

6.2 Management Element Requests

The Communication Interface Class supports the following class-specific requests. This section describes the requests that are specific to the Communication Interface Class. These requests are sent over the management element and can apply to different device views as defined by the Communication Class interface codes. Table 45: Class-Specific Requests
bmRequestType 00100001B bRequest SEND_ENCAPSULATED _COMMAND wValue Zero wIndex Interface wLength Amount of data, in bytes, associated with this recipient. Amount of data, in bytes, associated with this recipient. Length of State Data Length of Status Data Zero Zero Zero Zero Zero Zero Zero Size of properties Size of Structure Zero Zero Data Control protocol-based command

10100001B

GET_ENCAPSULATED _RESPONSE

Zero

Interface

Protocoldependent data response

00100001B 10100001B 00100001B 00100001B 00100001B 00100001B 00100001B 00100001B 00100001B 00100001B 10100001B 00100001B 00100001B

SET_COMM_FEATURE GET_COMM_FEATURE CLEAR_COMM_ FEATURE SET_AUX_LINE_STATE SET_HOOK_STATE PULSE_SETUP SEND_PULSE SET_PULSE_TIME RING_AUX_JACK SET_LINE_CODING GET_LINE_CODING SET_CONTROL_LINE _STATE SEND_BREAK

Feature Selector Feature Selector Feature Selector 0 Disconnect 1 Connect Relay Config. Enable/ Disable Cycles Timing Number of Rings Zero Zero Control Signal Bitmap Duration of Break

Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface

State Status None None None None None None None Line Coding Structure Line Coding Structure None None

Version 1.1

51

January 19, 1999

USB Class Definitions for Communication Devices

bmRequestType 00100001B

bRequest SET_RINGER_PARMS

wValue Zero

wIndex Interface

wLength 4

Data Ringer Configuration bitmap Ringer Configuration bitmap None Operation mode None/Data Line Status Information structure Dialing string Unit Parameter Unit Parameter None Profile Information N 48 bit Multicast addresses Power management pattern filter structure Pattern active boolean

10100001B

GET_RINGER_PARMS

Zero

Interface

00100001B 10100001B 00100001B 10100001B

SET_OPERATION_ PARMS GET_OPERATION_ PARMS SET_LINE_PARMS GET_LINE_PARMS

Operation Mode Zero Lines State Change Zero

Interface Interface Interface Interface

Zero 2 Length of Data Size of Structure Length of Dial String Length of Unit Parameter Length of Unit Parameter Zero 64 N*6

00100001B 00100001B 10100001B 00100001B 10100001B 00100001B

DIAL_DIGITS SET_UNIT_ PARAMETER GET_UNIT_ PARAMETER CLEAR_UNIT_ PARAMETER GET_PROFILE SET_ETHERNET_ MULTICAST_FILTERS SET_ETHERNET_ POWER_ MANAGEMENT_ PATTERN_FILTER GET_ETHERNET_ POWER_ MANAGEMENT_ PATTERN_FILTER SET_ETHERNET_ PACKET_FILTER GET_ETHERNET_ STATISTIC SET_ATM_DATA_ FORMAT GET_ATM_DEVICE_ STATISTICS SET_ATM_DEFAULT_ VC GET_ATM_VC_ STATISTICS

Zero Unit Parameter Structure Unit Parameter Structure Unit Parameter Structure Zero Number of filters (N) Filter number

Interface Interface Interface Interface Interface Interface

00100001B

Interface

Size of structure

10100001B

Filter number

Interface

00100001B 10100001B

Packet Filter Bitmap Feature Selector Data Format Feature Selector Zero

Interface Interface

Zero 4

None 32 bit unsigned integer None 32 bit unsigned integer 1-byte VPI followed by 2byte VCI value 32 bit unsigned integer

00100001B 10100001B

Interface Interface

Zero 4

00100001B

Interface

10100001B

Feature Selector

Interface

Version 1.1

52

January 19, 1999

USB Class Definitions for Communication Devices

Table 46: Class-Specific Request Codes

Request SEND_ENCAPSULATED_COMMAND GET_ENCAPSULATED_RESPONSE SET_COMM_FEATURE GET_COMM_FEATURE CLEAR_COMM_FEATURE RESERVED (future use) SET_AUX_LINE_STATE SET_HOOK_STATE PULSE_SETUP SEND_PULSE SET_PULSE_TIME RING_AUX_JACK RESERVED (future use) SET_LINE_CODING GET_LINE_CODING SET_CONTROL_LINE_STATE SEND_BREAK RESERVED (future use) SET_RINGER_PARMS GET_RINGER_PARMS SET_OPERATION_PARMS GET_OPERATION_PARMS SET_LINE_PARMS GET_LINE_PARMS DIAL_DIGITS SET_UNIT_PARAMETER GET_UNIT_PARAMETER CLEAR_UNIT_PARAMETER GET_PROFILE RESERVED (future use) SET_ETHERNET_MULTICAST_FILTERS SET_ETHERNET_POWER_MANAGEMENT_PATTERN FILTER GET_ETHERNET_POWER_MANAGEMENT_PATTERN FILTER SET_ETHERNET_PACKET_FILTER GET_ETHERNET_STATISTIC RESERVED (future use) Value 00h 01h 02h 03h 04h 05h-0Fh 10h 11h 12h 13h 14h 15h 16h-1Fh 20h 21h 22h 23h 24h-2Fh 30h 31h 32h 33h 34h 35h 36h 37h 38h 39h 3Ah 3Bh-3Fh 40h 41h 42h 43h 44h 45h-4Fh

Version 1.1

53

January 19, 1999

USB Class Definitions for Communication Devices

Request SET_ATM_DATA_FORMAT GET_ATM_DEVICE_STATISTICS SET_ATM_DEFAULT_VC GET_ATM_VC_STATISTICS RESERVED (future use)

Value 50h 51h 52h 53h 54h-FFh

6.2.1 SendEncapsulatedCommand
This request is used to issue a command in the format of the supported control protocol of the Communication Class interface.
bmRequestType 00100001B bRequest SEND_ENCAPSULATED _COMMAND wValue Zero wIndex Interface wLength Amount of data, in bytes, associated with this recipient. Data Control protocol-based command

6.2.2 GetEncapsulatedResponse
This request is used to request a response in the format of the supported control protocol of the Communication Class interface.
bmRequestType 10100001B bRequest GET_ ENCAPSULATED_ RESPONSE wValue Zero wIndex Interface wLength Amount of data, in bytes, associated with this recipient. Data Protocol dependent data

6.2.3 SetCommFeature
This request controls the settings for a particular communication feature of a particular target
bmRequestType 00100001B bRequest SET_COMM_FEATURE wValue Feature Selector wIndex Interface wLength Length of State Data Data State

For more information about the defined list of feature selectors per target, see Section 6.2.4, GetCommFeature.

6.2.4 GetCommFeature
This request returns the current settings for the communication feature as selected Version 1.1

54

January 19, 1999

USB Class Definitions for Communication Devices

bmRequestType 10100001B

bRequest GET_COMM_FEATURE

wValue Feature Selector

wIndex Interface

wLength Length of Status Data

Data Status

Table 47: Communication Feature Selector Codes

Feature selector RESERVED ABSTRACT_STATE Code 00h 01h Targets None Interface Length of Data None 2 Description Reserved for future use Two bytes of data describing multiplexed state and idle state for this Abstract Model communications device. This selector is only valid for Abstract Control Model. Country code in hexadecimal format as defined in ISO 3166, release date as specified in offset 3 of the Country Selection Functional Descriptor. This selector is only valid for devices that provide a Country Selection Functional Descriptor, and the value supplied shall appear as supported country in the Country Selection Functional Descriptor

COUNTRY_SETTING

02h

Interface

For the ABSTRACT_STATE selector, the following two bytes of data are defined: Table 48: Feature Status Returned for ABSTRACT_STATE Selector
Bit position D15..D2 D1 Description RESERVED (Reset to zero) Data Multiplexed State 1: 0: D0 Enables the multiplexing of call management commands on a Data Class. Disables multiplexing.

Idle Setting 1: All of the endpoints in this interface will not accept data from the host or offer data to the host. This allows the host call management software to synchronize the call management element with other media stream interfaces and endpoints, particularly those associated with a different host entity (such as a voice stream configured as a USB Audio Class device). The endpoints in this interface will continue to accept/offer data.

0:

6.2.5 ClearCommFeature
This request controls the settings for a particular communication feature of a particular target, setting the selected feature to its default state. The validity of the feature selectors depends upon the target type of the request.
bmRequestType 00100001B bRequest CLEAR_ COMM_FEATURE wValue Feature Selector wIndex Interface wLength Zero Data None

Version 1.1

55

January 19, 1999

USB Class Definitions for Communication Devices

For more information about for the defined list of feature selectors per target, see Section 6.2.4, GetCommFeature.

6.2.6 SetAuxLineState
This request is used to connect or disconnect a secondary jack to POTS circuit or CODEC, depending on hook state.
bmRequestType 00100001B bRequest SET_AUX_LINE_STATE wValue 0 - Disconnect 1 - Connect wIndex Interface wLength Zero Data None

State selector values in the wValue field are used to instruct the device to connect or disconnect the secondary phone jack from the POTS circuit or CODEC, depending on hook state. Device will acknowledge the status change.

6.2.7 SetHookState
This request is used to set the necessary POTS line relay code for on-hook, off-hook, and caller ID states.
bmRequestType 00100001B bRequest SET_HOOK_STATE wValue Relay Config. wIndex Interface wLength Zero Data None

The wValue will instruct the device to configure the necessary relays for going off-hook, on-hook, or into a snooping state for receiving caller ID data. Table 49: POTS Relay Configuration Values
Code ON_HOOK OFF_HOOK SNOOPING Value 0000h 0001h 0002h

6.2.8 PulseSetup
This request is used to prepare for a pulse-dialing cycle.
bmRequestType 00100001B bRequest PULSE_SETUP wValue Enable/ Disable wIndex Interface wLength Zero Data None

If wValue field contains the value FFFFh, the request is being sent to disengage the holding circuit after the dialing sequence has been completed. Any other value in the wValue field is meant to prepare the device for a pulse-dialing cycle.

Version 1.1

56

January 19, 1999

USB Class Definitions for Communication Devices

Not all devices require a PulseSetup request to disengage the holding circuit after a pulse dialing cycle. The extra request in the dialing cycle is generally required for devices designed to be usable in multiple countries. The device indicates whether the extra request is required or not by setting bit D2 of Direct Line Management Functional Descriptor, in Section 5.2.3.4.

6.2.9 SendPulse
This request is used to generate a specified number of make/break pulse cycles.
bmRequestType 00100001B bRequest SEND_PULSE wValue Cycles wIndex Interface wLength Zero Data None

The wValue field contains the number of make/break pulse cycles to generate.

6.2.10 SetPulseTime
This request sets the timing of the make and break periods for pulse dialing.
bmRequestType 00100001B bRequest SET_PULSE_TIME wValue Timing wIndex Interface wLength Zero Data None

The wValue field specifies the break time period in the high byte and the make time period in the low byte. The time periods are specified in milliseconds.

6.2.11 RingAuxJack
This request is used to generate a ring signal on a secondary phone jack.
bmRequestType 00100001B bRequest RING_AUX_JACK wValue Number of Rings wIndex Interface wLength Zero Data None

The wValue field contains the number of ring signals to generate on a secondary phone jack of the device.

6.2.12 SetLineCoding
This request allows the host to specify typical asynchronous line-character formatting properties, which may be required by some applications. This request applies to asynchronous byte stream data class interfaces and endpoints; it also applies to data transfers both from the host to the device and from the device to the host.
bmRequestType 00100001B bRequest SET_LINE_CODING wValue Zero wIndex Interface wLength Size of Structure Data Line Coding Structure

Version 1.1

57

January 19, 1999

USB Class Definitions for Communication Devices

For the definition of valid properties, see Table 50, Section 6.2.13, GetLineCoding.

6.2.13 GetLineCoding
This request allows the host to find out the currently configured line coding.
bmRequestType 10100001B bRequest GET_LINE_CODING wValue Zero wIndex Interface Wlength Size of Structure Data Line Coding Structure

The line coding properties are defined in the following table: Table 50: Line Coding Structure
Offset 0 4 Field Size 4 1 Value Number Number Description Data terminal rate, in bits per second. Stop bits 0 - 1 Stop bit 1 - 1.5 Stop bits 2 - 2 Stop bits 5

dwDTERate bCharFormat

bParityType

Number

Parity 0 - None 1 - Odd 2 - Even 3 - Mark 4 - Space

bDataBits

Number

Data bits (5, 6, 7, 8 or 16).

6.2.14 SetControlLineState
This request generates RS-232/V.24 style control signals.
bmRequestType 00100001B bRequest SET_CONTROL_LINE _STATE wValue Control Signal Bitmap wIndex Interface WLength Zero Data None

Table 51: Control Signal Bitmap Values for SetControlLineState

Bit position D15..D2 D1 Description RESERVED (Reset to zero) Carrier control for half duplex modems. This signal corresponds to V.24 signal 105 and RS-232 signal RTS. 0 - Deactivate carrier 1 - Activate carrier The device ignores the value of this bit when operating in full duplex mode.

Version 1.1

58

January 19, 1999

USB Class Definitions for Communication Devices

Bit position D0

Description Indicates to DCE if DTE is present or not. This signal corresponds to V.24 signal 108/2 and RS-232 signal DTR. 0 - Not Present 1 - Present

6.2.15 SendBreak
This request sends special carrier modulation that generates an RS-232 style break.
bmRequestType 00100001B bRequest SEND_BREAK wValue Duration of Break wIndex Interface wLength Zero Data None

The wValue field contains the length of time, in milliseconds, of the break signal. If wValue contains a value of FFFFh, then the device will send a break until another SendBreak request is received with the wValue of 0000h.

6.2.16 SetRingerParms
This request configures the ringer for the communication device, either on a global basis (master interface of the union), or on a per-line basis for multiple line devices.
bmRequestType 00100001B bRequest SET_RINGER_PARMS wValue Zero wIndex Interface wLength 4 Data Ringer Configuration bitmap

The command sets up the ringer characteristics for the communication device or for the line. The Ringer Configuration bitmap is defined in the following table: Table 52: Ringer Configuration Bitmap Values
Bit position D31 Description 0=A ringer does not exist. 1=A ringer exists. When using the GetRingerParms request to return the Ringer Configuration bitmap, a value of zero for this bit means a ringer does not exist for the addressed element (i.e. device or line). D30..D16 D15..D8 RESERVED (Reset to zero) Ringer Volume Setting 0Ringer Volume Off 255 - Maximum Ringer Volume Ringer Pattern Type Selection This corresponds to an internal ringer pattern or sound supported within the device, which could be a distinctive ringing type pattern or a sound effect type ring like a chirping sound, siren sound, etc.

D7..D0

Version 1.1

59

January 19, 1999

USB Class Definitions for Communication Devices

6.2.17 GetRingerParms
This request returns the ringer capabilities of the device and the current status of the devices ringer, including its enabled state and current selection.
bmRequestType 10100001B bRequest GET_RINGER_PARMS wValue Zero wIndex Interface wLength 4 Data Ringer Configuration bitmap

This command is typically sent to the master interface of the union. If the ringer for each line can be configured independently, then sending the command to the interface representing a line gets the ringer information for that line. For a description of the returned Ringer Configuration bitmap values, see Table 52.

6.2.18 SetOperationParms
Sets the operational mode for the device, between a simple mode, standalone mode and a host centric mode. Standalone mode means no control from the host; host centric mode means all control is performed from the host.
bmRequestType 00100001B bRequest SET_OPERATION_ PARMS wValue Operation Mode wIndex Interface wLength Zero Data None

The wValue field is used to specify the mode of operation to be used. Current supported modes of operation are defined in the following table: Table 53: Operation Mode Values
Operation mode 0 Description Simple Mode Communication device operates in standalone fashion, and sends no status information to the host and accepts only SetOperationMode commands from host. The device is capable of independent operation.. Standalone Mode Communication device operates in standalone fashion, but sends complete status information to the host and will accept any command from the host. Host Centric Mode Communication device is completely controlled by computer but will not perform any communication functions without host control.

In the case of dialing on a phone device, mode 0 would correspond to operating as a typical phone, where the phone would dial out the digits over the phone line. Mode 1 would be the same, except each of the digits dialed by the phone would be reported to the host. In mode 2, the phone would simply report which digits were pushed on the phone keypad to the host, and the host would be responsible for dialing the digits over the phone line.

6.2.19 GetOperationParms
This request gets the current operational mode for the device.

Version 1.1

60

January 19, 1999

USB Class Definitions for Communication Devices

bmRequestType 10100001B

bRequest GET_OPERATION_ PARMS

wValue Zero

wIndex Interface

wLength 2

Data Operation mode

The returned operation mode value describes the current operational mode of the device, as specified in Table 53.

6.2.20 SetLineParms
This request is used to change the state of the line, corresponding to the interface or master interface of a union to which the command was sent.
bmRequestType 00100001B bRequest SET_LINE_PARMS wValue Line State Change wIndex Interface wLength Length of Data Data Data

Some of the commands will require extra data, which will be provided in a packet transmitted during the Data phase. Current line state change values supported are defined in the following table: Table 54: Line State Change Value Definitions
Line State change value 0000h 0001h 0002h 0003h 0004h Description Drop the active call on the line. Start a new call on the line. Apply ringing to the line. Remove ringing from the line. Switch to a specific call on the line. Data is used to pass a 1-byte call index that identifies the call.

Version 1.1

61

January 19, 1999

USB Class Definitions for Communication Devices

6.2.21 GetLineParms
This request is used to report the state of the line that corresponds to the interface or master interface of a union to which the command was sent.
bmRequestType 10100001B bRequest GET_LINE_PARMS wValue Zero wIndex Interface wLength Size of Structure Data Line Status Information Structure

This command is issued to the interface or master interface of a union representing a specific line. The returned Line Status Information structure is defined in the following table: Table 55: Line Status Information Structure
Offset 0 2 Field Size 2 4 Value Number Bitmap Description Size of this structure, in bytes. Ringer Configuration bitmap for this line. For the format of this field, see Table 52. Defines current state of the line. Defines current state of first call on the line.

wLength dwRingerBitmap

6 10 6 + N*4

dwLineState dwCallState0

4 4 4

Bitmap Bitmap Bitmap

dwCallStateN-1

Defines current state of call N on the line.

The Line State bitmap format provided within the line status information is defined in the following table: Table 56: Line State Bitmap
Bit position D31 Description Active flag 0 - No activity on the line. 1 - Line is active (i.e. not idle). RESERVED (Reset to zero) Index of active call on this line. Equals 255 if no call exists on the line.

D30..D8 D7..D0

The Call State bitmap format provided within the line status information is defined in the following table:

Version 1.1

62

January 19, 1999

USB Class Definitions for Communication Devices

Table 57: Call State Bitmap

Bit position D31 Description Active flag 0 - No active call. 1 - Call is active (i.e., not idle). RESERVED (Reset to zero) Call state change value. (For definitions of call state change values, see Table 70.) Call state value. (For definitions of call state values, see Table 58.)

D30..D16 D15..D8 D7..D0

Table 58: Call State Value Definitions

Call state value 00h 01h 02h 03h 04h 05h 06h Description Call is idle. Typical dial tone. Interrupted dial tone. Dialing is in progress. Ringback. Call state additional data, D15..D8, contains extra information, as defined in Table 70. Connected. Call state additional data, D15..D8, contains extra information, as defined in Table 70. Incoming call. Call state additional data, D15..D8, contains extra information, as defined in Table 70.

6.2.22 DialDigits
This request dials the DTMF digits over the specified line.
bmRequestType 00100001B bRequest DIAL_ DIGITS wValue Zero wIndex Interface wLength Length of Dialing String Data Dialing string

The data packet consists of a dialing command, with only the following characters in V.4 supported as being part of the command: Table 59: Characters in a Dialing Command
Characters 0-9 *# Pp Tt ! Action Dial the specified digit. Dial the specified DTMF key. Use pulse dialing for dialing all subsequent digits. Use tone dialing for dialing all subsequent digits. Insert a hook switch flash into the dialing string.

Version 1.1

63

January 19, 1999

USB Class Definitions for Communication Devices

Characters , ; Ww Dd Uu

Action (Comma) Pause the dialing for a fixed period of time defined by the device (usually 2 seconds). (Semicolon) Indicates that more digits will be provided later. Wait for dial tone or interrupted dial tone before continuing to dial digits. Hold tone on. All subsequent dialing tones are left on until hold tone off is received. Hold tone off. All held dialing tones are turned off.

6.2.23 SetUnitParameter
This request sets the value of a parameter belonging to a Unit identified by Unit Parameter Structure, see Table 60. The timing of when the new parameter takes effect depends on the protocol or vendor specific function.
bmRequestType 00100001B bRequest SET_UNIT _PARAMETER wValue Unit Parameter Structure wIndex Interface wLength Length of Unit Parameter Data Unit Parameter

Table 60: Unit Parameter Structure

Offset 0 1 Field Size 1 1 Value Number Number Description Unit Id A zero based value indicating Unit parameter index.

bEntityId bParameterIndex

6.2.24 GetUnitParameter
This request returns the current value of a parameter belonging to a Unit pointed out by Unit Parameter Structure, see Table 60.
bmRequestType 10100001B bRequest GET_UNIT _PARAMETER wValue Unit Parameter Structure wIndex Interface wLength Length of Unit Parameter Data Unit Parameter

6.2.25 ClearUnitParameter
This request restores the default value of a parameter belonging to a Unit identified by Unit Parameter Structure, see Table 60. The timing of when the new parameter takes effect depends on the protocol or vendor specific function.
bmRequestType 00100001B bRequest CLEAR_UNIT _PARAMETER wValue Unit Parameter Structure wIndex Interface wLength Zero Data None

Version 1.1

64

January 19, 1999

USB Class Definitions for Communication Devices

6.2.26 GetProfile
This request returns the profile information as defined by CAPI 2.0. The profile describes the implemented capabilities of the device.
bmRequestType 10100001B bRequest GET_PROFILE wValue Zero wIndex Interface wLength 64 Data Profile Information according to CAPI 2.0 chapter 8

6.2.27 SetEthernetMulticastFilters
This request sets the Ethernet device multicast filters as specified in the sequential list of 48 bit Ethernet multicast addresses.
bmRequestType 00100001B bRequest SET_ETHERNET_ MULTICAST_FILTER wValue Number of filters (N) wIndex Interface wLength N*6 Data A list of N 48 bit Multicast addresses, in network byte order

If the host wishes to change a single multicast filter in the device, it must reprogram the entire list of filters using this request. This sequential programming method for the entire multicast list is well-suited for devices that use hashing techniques. Although the Data field for this request might be quite large, devices with limited buffering capacity may use NAKs as necessary to process (e.g., hash) a small number of multicast addresses at a time.

6.2.28 SetEthernetPowerManagementPatternFilter
This request sets up the specified Ethernet power management pattern filter as described in the data structure.
bmRequestType 00100001B bRequest SET_ETHERNET_ POWER_ MANAGEMENT_ PATTERN_FILTER wValue Filter number wIndex Interface wLength Size of structure Data Power management pattern filter structure

Some hosts are able to conserve energy and stay quiet in a sleeping state while not being used. USB Networking devices may provide special pattern filtering hardware that enables it to wake up the attached host on demand when something is attempting to contact the host (e.g., an incoming web browser connection). NOTE: To enable remote wake up, additional steps must be completed that are described in the USB Specification. If the host simply wishes to clear (remove) any previous setting for the specified pattern filter, the value of wLength is set to Zero and no Data field (pattern filter structure) follows.

Version 1.1

65

January 19, 1999

USB Class Definitions for Communication Devices

If the specified pattern is not able to fit into the device, any pattern previously loaded is considered destroyed, and the device must set a value of FALSE (0x0000) into the associated status that will be read by the GetEthernetPowerManagementPatternFilter request. Table 61: Power Management Pattern Filter Structure
Field MaskSize Mask Size 2 MaskSize Value Number Bitmask Description Contains the size (in bytes) of the Mask. Each byte of Mask contains 8 masking bits, where each one of them represents whether or not the associated byte of the Pattern should be compared with what is seen on the media by the networking device. The least significant bit (D0) of the first Mask byte is associated with the first byte of the pattern, which starts at the Destination Address (DA) of the Ethernet frame. If the last byte of Mask contains trailing zeros in its highest order bits, the associated bytes in the Pattern field are not sent in this request. Pattern Specified by Mask Number This is a string of bytes to perform pattern matching on, starting from offset 0 of the Ethernet frame (the Destination Address).

6.2.29 GetEthernetPowerManagementPatternFilter
This request retrieves the status of the specified Ethernet power management pattern filter from the device. If the device has an active pattern set for the specified filter, a TRUE (0x0001) will be returned. If a FALSE (0x0000) is returned, either no pattern has yet been set for the specified filter, or the prior attempt by the host software to set this filter was not successful (i.e., was not able to fit).
bmRequestType 10100001B bRequest GET_ETHERNET_ POWER_ MANAGEMENT_ PATTERN_FILTER wValue Filter number wIndex Interface wLength 2 Data Pattern active boolean

6.2.30 SetEthernetPacketFilter
This request is used to configure device Ethernet packet filter settings. The Packet Filter is the inclusive OR of the bitmap shown in Table 62. Though network adapters for faster buses (e.g., PCI) may offer other hardware filters, the medium speed networking devices (< 10Mbit/s) attached via USB are only required to support promiscuous and all multicast modes. The host networking software driver is responsible for performing additional filtering as required.
bmRequestType 00100001B bRequest SET_ETHERNET_ PACKET_FILTER wValue Packet Filter Bitmap wIndex Interface wLength Zero Data None

Note that for some device types, the ability to run in promiscuous mode may be severely restricted or prohibited. For example, DOCSIS cable modems are only permitted to forward certain frames to its attached host. Even if forwarding of all frames were allowed, the raw cable modem downstream rate available on the RF interface can be many times the maximum USB throughput.

Version 1.1

66

January 19, 1999

USB Class Definitions for Communication Devices

Table 62: Ethernet Packet Filter Bitmap

Bit position D15..D5 D4 Description RESERVED (Reset to zero) PACKET_TYPE_MULTICAST 1: 0: D3 All multicast packets enumerated in the device's multicast address list are forwarded up to the host. (required) Disabled. The ability to disable forwarding of these multicast packets is optional. ***

PACKET_TYPE_BROADCAST 1: 0: All broadcast packets received by the networking device are forwarded up to the host. (required) Disabled. The ability to disable forwarding of broadcast packets is optional. ***

D2

PACKET_TYPE_DIRECTED 1: Directed packets received containing a destination address equal to the MAC address of the networking device are forwarded up to the host (required) Disabled. The ability to disable forwarding of directed packets is optional. ***

0: D1

PACKET_TYPE_ALL_MULTICAST 1: ALL multicast frames received by the networking device are forwarded up to the host, not just the ones enumerated in the device's multicast address list (required) Disabled.

0: D0

PACKET_TYPE_PROMISCUOUS: 1: 0: ALL frames received by the networking device are forwarded up to the host (required) Disabled.

*** Support for inhibiting (Dx = 0) the forwarding of "ordinary" directed, multicast and broadcast packets to the host is optional. Since there are no associated descriptors for the device to designate which filters are supported by a particular device, the host must blindly set these bits as desired, filtering out these undesired packets in host software should they appear.

6.2.31 GetEthernetStatistic
This request is used to retrieve a statistic based on the feature selector. The value returned indicates the number of matching frames with the specified statistic that have occurred since the device has been powered on or reset. This number is a 32 bit unsigned integer, which is incremented at each occurrence, and will be wrapped to 0 if reaching the maximum value.
bmRequestType 10100001B bRequest GET_ETHERNET_ STATISTIC wValue Feature Selector wIndex Interface wLength 4 Data 32 bit unsigned integer

Version 1.1

67

January 19, 1999

USB Class Definitions for Communication Devices

Table 63: Ethernet Statistics Feature Selector Codes

Feature selector RESERVED XMIT_OK RCV_OK XMIT_ERROR RCV_ERROR RCV_NO_BUFFER DIRECTED_BYTES_XMIT DIRECTED_FRAMES_XMIT MULTICAST_BYTES_XMIT MULTICAST_FRAMES_ XMIT BROADCAST_BYTES_XMIT BROADCAST_FRAMES_ XMIT DIRECTED_BYTES_RCV DIRECTED_FRAMES_RCV MULTICAST_BYTES_RCV MULTICAST_FRAMES_ RCV BROADCAST_BYTES_RCV BROADCAST_FRAMES_ RCV RCV_CRC_ERROR Code 00h 01h 02h 03h 04h 05h 06h 07h 08h 09h 0Ah 0Bh 0Ch 0Dh 0Eh 0Fh 10h 11h 12h Targets None Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Interface Length of Data None 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 Description Reserved for future use Frames transmitted without errors Frames received without errors Frames not transmitted, or transmitted with errors Frames received with errors Frames missed, no buffers Directed bytes transmitted without errors Directed frames transmitted without errors Multicast bytes transmitted without errors Multicast frames transmitted without errors Broadcast bytes transmitted without errors Broadcast frames transmitted without errors Directed bytes received without errors Directed frames received without errors Multicast bytes received without errors Multicast frames received without errors Broadcast bytes received without errors Broadcast frames received without errors Frames received with circular redundancy check (CRC) or frame check sequence (FCS) error Length of transmit queue Frames received with alignment error Frames transmitted with one collision Frames transmitted with more than one collision Frames transmitted after deferral Frames not transmitted due to collisions Frames not received due to overrun Frames not transmitted due to underrun Frames transmitted with heartbeat failure

TRANSMIT_QUEUE_ LENGTH RCV_ERROR_ALIGNMENT XMIT_ONE_COLLISION XMIT_MORE_COLLISIONS XMIT_DEFERRED XMIT_MAX_COLLISIONS RCV_OVERRUN XMIT_UNDERRUN XMIT_HEARTBEAT_ FAILURE

13h 14h 15h 16h 17h 18h 19h 1Ah 1Bh

Interface Interface Interface Interface Interface Interface Interface Interface Interface

4 4 4 4 4 4 4 4 4

Version 1.1

68

January 19, 1999

USB Class Definitions for Communication Devices

Feature selector XMIT_TIMES_CRS_LOST XMIT_LATE_COLLISIONS

Code 1Ch 1Dh

Targets Interface Interface

Length of Data 4 4

Description Times carrier sense signal lost during transmission Late collisions detected

Refer to the ISO/IEC 8802-3 (ANSI/IEEE Std 802.3) specification for additional information on the meaning of each of these statistics.

6.2.32 SetATMDataFormat
This request is used to set the data format selected by the host in the wValue field.
bmRequestType 00100001B bRequest SET_ATM_DATA_ FORMAT wValue Data Format wIndex Interface wLength Zero Data None

Table 64: ATM Data Format

wValue 1 2 3 Description Type 1 format: concatenated ATM cells Type 2 format: ATM header template + concatenated ATM cell payloads Type 3 format: AAL 5 SDU

The ATM Networking Control Model data format selected specifies how much processing is done in the USB device, versus how much is done in the host. Specifically, the Type 3 data format requires that ATM segmentation and reassembly (SAR) functions be implemented in the USB device, while Type 1 and Type 2 data formats enable different functional partitioning, and migrate the SAR function to the host. As you move from Type 1 to Type 3, the amount of processing performed in the USB device increases. Support of Type 1 Data Format is mandatory to ensure minimal interoperability. If supported by the device, it is recommended that Type 3 Data Format be chosen by the host whenever possible. Type 1 Data Format Type 1 ATM oriented USB devices (e.g., ADSL modems or IEEE 802.14 cable modems) do the least amount of processing on the incoming data and are therefore the simplest types of such devices. The main function of the USB device is to pass the ATM cells from the WAN link to the host, and vice versa. The data format consists of a number of concatenated 53 byte ATM cells. The HEC field in the ATM cell header exists only as a placeholder when transferred over USB, and will be generated and verified by the ATM-oriented device for upstream and downstream traffic, respectively. For Type 1 devices, all ATM and AAL functions are performed by the host, e.g. AAL layer encapsulation, ATM SAR, and traffic shaping (for upstream direction only). Various AAL types, Operation Administration and Maintenance (OAM) cells, and Resource Management (RM) cells are enabled, if supported by the host. Type 2 Data Format The Type 2 ATM-oriented USB device improves USB bus bandwidth efficiency by removing duplicate ATM cell headers prior to transfer over USB. This data format consists of a 4-byte ATM cell header template (excluding the

Version 1.1

69

January 19, 1999

USB Class Definitions for Communication Devices

HEC field) followed by a number of 48-byte ATM cell payloads. As with Type 1 devices, the AAL encapsulation, SAR and traffic shaping are all performed by the host. The Type 2 device needs to assemble cells based on the header template before transmitting them over the WAN link. All the AAL types are supported. OAM cells for flow management are enabled, as are RM cells for the ABR service. A unique requirement for this type of device is that all cell payloads must share the same cell header template. To accomplish this, extra processing rules need to be applied in the host and USB device as follows:
N

The 48-octet cell payloads shall be contiguous without additional intervening cell headers, all destined to the same VC, and have the same payload type. For AAL5 VCs, the ATM-user-to-ATM-user indication bit in the payload type is used to delimit the AAL5 CPCS PDU. This bit shall be set if the last cell in this segment (i.e., data between 2 consecutive USB short packets) completes an AAL5 CPCS PDU. Note that in this case no other cells can be appended in the same segment after an AAL 5 CPCS PDU has been completed. The device at the other end of the USB bus has to set the ATM-userto-ATM-user indication bit in the payload type only for the last cell in this segment, but not for any preceding cells, before forwarding them.

The ATM cell header template transferred between the USB device and host can not include the 8-bit HEC field.

Also, the USB device will have to perform the following functions:
N N N

Generate and insert a HEC field for upstream traffic. Verify and remove the HEC field from the downstream traffic. Discard cells with HEC errors from the downstream traffic.

For Type 1 and Type 2 ATM oriented USB devices, any number of ATM cells or payloads could be concatenated in an USB buffer as long as it adheres to the rules stipulated above. The general guideline to flush the buffer and send it via USB is when:
N N N N

The maximum segment size (wType2MaxSegmentSize) is reached (for Type 2 only), or Encounter the end of an AAL5 PDU, or The timer expires (so you dont hold the cells too long if there are no immediate incoming cells), or One or more cells from a low-latency VC are received. NOTE: If a grouping of low latency VC cells are received (e.g., a 20ms audio frame), it is recommended that devices not flush (generate a USB short packet) after every ATM cell in this instance to improve link efficiency and reduce host overhead. The methods for accomplishing this are beyond the scope of this document

Type 3 Data Format Type 3 ATM oriented devices will process the AAL5 SDUs (e.g., Q.2931, ILMI and other SDUs like PPP packets in data VCs) as they arrive from the host, before sending them to the WAN link. This is accomplished by adding AAL5 encapsulation (including the appropriate padding and the CRC generation) to form the AAL5 PDU. The AAL5 PDU formed then goes through the SAR function before being transmitted over the WAN link. For the ATM cells arriving from the WAN link, the device will reassemble them into AAL5 PDUs, validate the AAL5 CRC (discard the AAL5 PDU if incorrect), strip off the AAL5 encapsulation and transfer AAL5 SDU to the host. This data format consists of the first 4 bytes of an ATM cell header (excluding the HEC field) followed by a single AAL5 SDU. The VPI/VCI value in the cell header indicates which VC this AAL5 SDU belongs to and the first bit of the PTI field shall be set to 0 for AAL5 SDUs. OAM and RM cells can be supported by sending those cells with the corresponding PTI bits set in the cell header. Version 1.1

70

January 19, 1999

USB Class Definitions for Communication Devices

6.2.33 GetATMDeviceStatistics
This request is used to retrieve the device statistics based on the feature selector.
BmRequestType 10100001B bRequest GET_ATM_DEVICE_ STATISTICS wValue Feature Selector wIndex Interface wLength 4 Data 32 bit unsigned integer

In Table 65, the terms UPSTREAM(US) and DOWNSTREAM(DS) refer to the direction of the data flow across the connection between the device and the network. The value returned indicates the number of cells matching the specified statistic that have occurred since the device has been powered on or reset, or since the SET_INTERFACE request has been received (see Section 3.8.1 for more details). This number is a 32 bit unsigned integer, which is incremented at each occurrence and will be wrapped to zero upon reaching the maximum value. Table 65: ATM Device Statistics Feature Selector Codes
Feature selector RESERVED US_CELLS_SENT Code 00h 01h Targets None Interface Length of Data None 4 Description Reserved for future use The number of cells that have been sent upstream to the WAN link by the ATM layer. Support for this statistic by device hardware is optional. The number of cells that have been received downstream from the WAN link by the ATM layer. Support for this statistic by device hardware is optional. The number of cells that have been received downstream from the WAN link by the ATM layer and discarded due to congestion on the USB link. Support for the feature code by the device is MANDATORY. The number of cells that have been received downstream from the WAN link by the ATM layer and discarded due to AAL5 CRC errors. Support for this feature code by Type 3 devices is MANDATORY. The number of cells that have been received downstream from the WAN link and discarded due to HEC errors in the cell header. Support for this statistic by device hardware is MANDATORY. The number of cells that have been received downstream from the WAN link and have been detected with HEC errors in the cell header and successfully corrected. Support for this statistic by device hardware is optional.

DS_ CELLS_RECEIVED

02h

Interface

DS_CELLS_USB_ CONGESTION

03h

Interface

DS_CELLS_AAL5_ CRC_ERROR

04h

Interface

DS_CELLS_HEC_ ERROR

05h

Interface

DS_CELLS_HEC_ ERROR_CORRECTED

06h

Interface

Version 1.1

71

January 19, 1999

USB Class Definitions for Communication Devices

6.2.34 SetATMDefaultVC
This request is used to pre-select the VPI/VCI value for subsequent GetATMVCStatistics requests. This request only applies to type 3 devices.
bmRequestType 00100001B bRequest SET_ATM_DEFAULT_VC wValue Zero wIndex Interface wLength 3 Data 1-byte VPI followed by 2byte VCI value

6.2.35 GetATMVCStatistics
This request is used to retrieve the ATM device statistics based on the feature selector for a pre-selected VPI/VCI as stipulated in latest preceding SetATMDefaultVC request. This request only applies to type 3 devices.
bmRequestType 10100001B bRequest GET_ATM_VC_ STATISTICS wValue Feature Selector wIndex Interface wLength 4 Data 32 bit unsigned integer

Table 66: ATM VC Selector Codes

Feature selector RESERVED VC_US_CELLS_SENT Code 00h 01h Targets None Interface Length of Data None 4 Description Reserved for future use The number of cells that have been sent upstream to the WAN link for the specified VPI/VCI since the device has been powered on or reset. This number is a 32 bit unsigned integer, which is incremented each time a cell is sent, and will be wrapped to 0 if reaching the maximum value. Support for this statistic by the device is optional. The number of cells that have been received downstream from the WAN link for the specified VPI/VCI since the device has been powered on or reset. This number is a 32 bit unsigned integer, which is incremented each time a cell is received, and will be wrapped to 0 if reaching the maximum value. Support for this statistic by the device is optional.

VC_DS_ CELLS_RECEIVED

02h

Interface

Version 1.1

72

January 19, 1999

USB Class Definitions for Communication Devices

6.3 Notification Element Notifications

This section defines the Communication Interface Class notifications that the device uses to notify the host of interface, or endpoint events. Table 67: Class-Specific Notifications
bmRequestType 10100001B 10100001B 10100001B 10100001B 10100001B 10100001B bNotification NETWORK_ CONNECTION RESPONSE_AVAILABLE AUX_JACK_HOOK_ STATE RING_DETECT SERIAL_STATE CALL_STATE_CHANGE wValue 0 Disconnect 1 Connected Zero 0 On hook 1 Off hook Zero Zero Call Index and Call State Change Value wIndex Interface Interface Interface Interface Interface Interface wLength Zero Zero Zero Zero 2 Length of Data Data None None None None UART State bitmap Variable-length structure containing additional information for call state change. Variable length Line State structure. Connection Speed Change Data Structure

10100001B

LINE_STATE_CHANGE

Value

Interface

Length of Data

10100001B

CONNECTION_SPEED_ CHANGE

Zero

Interface

Table 68: Class-Specific Notification Codes

Notification NETWORK_CONNECTION RESPONSE_AVAILABLE RESERVED (future use) AUX_JACK_HOOK_STATE RING_DETECT RESERVED (future use) SERIAL_STATE RESERVED (future use) CALL_STATE_CHANGE LINE_STATE_CHANGE CONNECTION_SPEED_CHANGE RESERVED (future use) Value 00h 01h 02h-07h 08h 09h 0Ah-1Fh 20h 21h-27h 28h 29h 2Ah 2Bh-FFh

Version 1.1

73

January 19, 1999

USB Class Definitions for Communication Devices

6.3.1 NetworkConnection
This notification allows the device to notify the host about network connection status.
bmRequestType 10100001B bNotification NETWORK_ CONNECTION wValue 0 - Disconnect 1 - Connected wIndex Interface wLength Zero Data None

6.3.2 ResponseAvailable
This notification allows the device to notify the host that a response is available. This response can be retrieved with a subsequent GetEncapsulatedResponse request.
bmRequestType 10100001B bNotification RESPONSE_AVAILABLE wValue Zero wIndex Interface wLength Zero Data None

6.3.3 AuxJackHookState
This notification indicates the loop has changed on the auxiliary phone interface of the USB device. The secondary or downstream device, which is connected to the auxiliary phone interface, has changed hook states.
bmRequestType 10100001B bNotification AUX_JACK_ HOOK_STATE wValue 0 On hook 1 Off hook wIndex Interface wLength Zero Data None

On devices that provide separate control of the auxiliary or downstream phone interface, this notification provides a means of announcing hook state changes of devices plugged into that interface. When the USB device has separate control of this phone interface, it is helpful to know when the secondary device, which is plugged into the auxiliary phone interface, switches between the on-hook/off-hook states. The wValue field returns whether loop current was detected or not detected. Notification is only sent when the state changes.

6.3.4 RingDetect
This notification indicates ring voltage on the POTS line interface of the USB device.
bmRequestType 10100001B bNotification RING_DETECT wValue Zero wIndex Interface wLength Zero Data None

Version 1.1

74

January 19, 1999

USB Class Definitions for Communication Devices

6.3.5 SerialState
This notification sends asynchronous notification of UART status.
bmRequestType 10100001B bNotification SERIAL_STATE wValue Zero wIndex Interface wLength 2 Data UART State bitmap

The Data field is a bitmapped value that contains the current state of carrier detect, transmission carrier, break, ring signal, and device overrun error. These signals are typically found on a UART and are used for communication status reporting. A state is considered enabled if its respective bit is set to 1. SerialState is used like a real interrupt status register. Once a notification has been sent, the device will reset and reevaluate the different signals. For the consistent signals like carrier detect or transmission carrier, this will mean another notification will not be generated until there is a state change. For the irregular signals like break, the incoming ring signal, or the overrun error state, this will reset their values to zero and again will not send another notification until their state changes. Table 69: UART State Bitmap Values
Bits D15..D7 D6 D5 D4 D3 D2 D1 Field Description RESERVED (future use)

bOverRun bParity bFraming bRingSignal bBreak bTxCarrier

Received data has been discarded due to overrun in the device. A parity error has occurred. A framing error has occurred. State of ring signal detection of the device. State of break detection mechanism of the device. State of transmission carrier. This signal corresponds to V.24 signal 106 and RS-232 signal DSR. State of receiver carrier detection mechanism of device. This signal corresponds to V.24 signal 109 and RS-232 signal DCD.

D0

bRxCarrier

6.3.6 CallStateChange
This notification identifies that a change has occurred to the state of a call on the line corresponding to the interface or union for the line.
bmRequestType 10100001B bNotification CALL_STATE_CHANGE wValue Call Index and Call State Change Value. wIndex Interface wLength Length of Data Data Variable length structure containing additional information for call state change.

Version 1.1

75

January 19, 1999

USB Class Definitions for Communication Devices

The high-order byte D15-D8 of the wValue field will contain the call index, and the low-order byte D7-D0 will contain the call state change value. Not all devices may be capable of reporting all changes of the call state, which should not cause any problems to the higher-level software. All extra data associated with a call state change (i.e., Caller ID data) is returned within the data field. Currently, defined call state values are listed in the following table: Table 70: Call State Change Value Definitions
Call state change 00h 01h 02h 03h Description RESERVED Call has become idle. Dialing. Ringback, with an extra byte of data provided to describe the type of ringback signaling 0 = normal 1 = busy 2 = fast busy 3-254 = reserved for future use 255=unknown ringback type Connected, with an extra byte of data provided to describe the type of connection 0 = voice connection 1 = answering machine connection 2 = fax machine connection 3 = data modem connection 4-254 = reserved for future use 255 = unknown connection type Incoming Call, with the following extra bytes of data (minimum of 4 extra bytes): Extra data byte 0 - Indicates the ringing pattern present as: 0 = ringing pattern 1 (default or normal pattern) 1 = ringing pattern 2 2 = ringing pattern 3 3 ringing pattern 4 4-255 = reserved for future use Extra data byte 1 - Size of the string (next n bytes) which contains the time (in displayable format) of the incoming call as delivered via Caller ID. The string is not null terminated and is encoded using one character per byte. It is not a UNICODE string. If time is not available then a size of 0 is required as a place setter. Next data byte following number - Size of string (next n bytes) which contains the phone number of calling party as delivered via Caller ID. The string is not null terminated and is encoded using one character per byte. It is not a UNICODE string. If no number is available then a size of 0 is required as a placesetter. Next data byte following name - Size of string (next n bytes) which contains the name of the calling party as delivered via Caller ID. The string is not null terminated and is encoded using one character per byte. It is not a UNICODE string. If no name is available then a size of 0 is required as a place-setter.

04h

05h

Version 1.1

76

January 19, 1999

USB Class Definitions for Communication Devices

6.3.7 LineStateChange
This notification identifies that a change has occurred to the state of the line corresponding to the interface or master interface of a union sending the notification message.
bmRequestType 10100001B bNotification LINE_STATE_CHANGE wValue Value wIndex Interface wLength Length of Data Data Variable Length Line State structure.

Some line state changes may provide extra information, and this information would be provided in the attached extra Line State data structure. Current line state change information are defined in the following table: Table 71: Line State Change Values
Line State change 0000h 0001h 0002h 0003h Description Line has become idle. Line connected to hold position. Hook-switch has gone off hook. Hook-switch has gone on hook.

6.3.8 ConnectionSpeedChange
This notification allows the device to inform the host-networking driver that a change in either the upstream or the downstream bit rate of the connection has occurred.
bmRequestType 10100001B bNotification CONNECTION_SPEED_ CHANGE wValue Zero wIndex Interface wLength 8 Data Connection Speed Change Data Structure

The data phase for this notification contains a data structure with two 32 bit unsigned integers. The two values are the upstream bit rate, followed immediately by the downstream bit rate. (Table 72) To assure that the host networking driver can always report the correct link speed, the device must send this notification immediately after every NETWORK_CONNECTION notification is sent. This normally occurs when the physical layer makes or loses a connection, but additionally appears implicitly after the device is reset (see discussion in Section 3.8.1 Common Data Plane Characteristics).

Version 1.1

77

January 19, 1999

USB Class Definitions for Communication Devices

Table 72: ConnectionSpeedChange Data Structure

Offset 0 4 Field USBitRate DSBitRate Size 4 4 Value Number Number Description Contains the upstream bit rate, in bits per second Contains the downstream bit rate, in bits per second.

Version 1.1

78

January 19, 1999

USB Class Definitions for Communication Devices

Appendix A: Communication Device Class Examples

This appendix highlights some examples of typical communication device classes. Detailed examples are provided in separate white papers that are not a part of this specification. The latest copies of the white papers can be found at http://www.usb.org.

A.1

Basic Telephone

A basic telephone is defined as the household/desktop type phone common to most users. This phone has a handset, keypad, and a 2-wire connection to a local telephone company. In this example, a USB port is added for connecting the phone to the host. By connecting the phone to a host via the USB, the following functions can be supported: 1. 2. 3. Host monitoring of incoming and outgoing calls. Host-originated dialing of a call. Host recording and playback of voice over the phone line.

This example is not intended to define the computer telephony application features or user interface. The example demonstrates how the USB Communication Interface Class protocol can be used to identify, control, and monitor a telephony device.

A.2

Modem

For compatibility with legacy computer software and to facilitate the development of generic drivers, a USB modem should conform to the ANSI/TIA-602 standard. For common extended functions, the following standards are recommended:
N N N N N N N N N

Modem identification: ITU V.25ter +G commands Data modems: ITU V.25ter (modulation, error control, data compression) Data modems: ITU V.80 In-band DCE control and synchronous data modes for asynchronous DTE Fax modems: ITU T.31 or T.32 +F commands (or TIA equivalents) Voice modems: TIA IS-101 +V commands General wireless modems: PCCA STD-101 +W commands (TIA 678) Analog cellular modems: PCCA STD-101 Annex I (TIA 678 Annex C) Digital cellular modems: TIA IS-707, TIA IS-135 or GSM 7.07 +C commands. Text phone modems: V.25ter, +MV18 commands.

For a complete list of standard modem command sets, see the ITU Supplement to V.25ter. Note: A USB modem may provide means to accommodate common functions performed on a 16550 UART. For more information, see Section 3.6.2.1, Abstract Control Model Serial Emulation.

A.3

CAPI Device

For compatibility with existing CAPI software, and to facilitate the development of generic adaptive drivers, a USB CAPI Device has to conform to the CAPI 2.0 specification.

Version 1.1

79

January 19, 1999

USB Class Definitions for Communication Devices

Appendix B: Sample Configurations

B.1 Basic Telephony Configurations

This section defines three examples of telephony configurations: a basic telephone, a telephone with keypad, and a combination telephone with analog modem. The minimum requirement for this type of device is a configuration with a single Communication Class interface. If you wish to support a standard telephone keypad, you would require an additional Human Interface Device Class interface to support the keypad. The most basic audio-capable telephone is constructed by adding an Audio interface for audio transmission and reception. A more advanced configuration could optionally have local Audio interfaces connected to the handset and microphone/speaker, and one Data interface. In this case, the Data interface could be the raw linear data as sampled from the network. The responsibility for demodulation and interpretation of this data would lie within the host at the application level (i.e., processor-based modem). Table 73: Telephone Configurations
Example configuration Basic telephone Interface (class code ) Communication Class Reference section 3.3.1 Description Device management and call management. Consisting of a management element and a notification element. Device management and call management. Consisting of a management element and a notification element. I/O for a keypad interface. Device management and call management. Consisting of a management element and a notification element. I/O for uncompressed audio. Demodulated modem data.

Communication Class Telephone with keypad HID Class Communication Class Audio/data telephone

3.3.1

HID 1.0 3.3.1

Audio Class Data Class

Audio 1.0 3.3.2

A communication device that supports audio type media streams over its interfaces can use the selected Audio interface to indicate which voice or audio coding formats it supports (for example, IS-101 for voice modems).

B.2

Modem Configurations

This section defines three examples of modem configurations: legacy modem, DSVD modem, and multimedia modem. The first configuration covers legacy modems for data, fax, and voice. The second configuration covers SVD modems, such as ASVD (ITU V.61) and DSVD (ITU V.70). The third configuration covers multimedia modems that would be used in ITU H.324 situation. Table 74: Example Modem Configurations
Example configuration Interface (class code ) Communication Class Legacy modem Data Class 3.3.2 Reference section 3.3.1 Description Device management and call management. Consisting of a management element and a notification element. Demodulated modem data.

Version 1.1

80

January 19, 1999

USB Class Definitions for Communication Devices

Table 74: Example Modem Configurations

Example configuration Interface (class code ) Communication Class Reference section 3.3.1 Description Device management and call management. Consisting of a management element and a notification element. Demodulated modem data. I/O for uncompressed audio. Device management and call management. Consisting of a management element and a notification element. Demodulated modem data. I/O for uncompressed audio. I/O for video (for example, H.263).

SVD modem

Data Class Audio Class Communication Class

3.3.2 Audio 1.0 3.3.1

Multimedia modem

Data Class Audio Class Image Class

3.3.2 Audio 1.0 TBD

Most of todays modem type devices single-media or multimedia contain various types of media processing resources such as compression engines (for example, V.42bis) or audio/video CODECs. Given the projections of increased processing power for future host systems and the availability of appropriate media transport to and from the host (i.e., the USB), it is likely that various models of media processing will emerge that do not rely solely on the device for these resources. In this case, where media processing resources are located arbitrarily within the system (for example, V.42bis on the host and V.34 on the device), interface choices for media types could vary. For example, if a device developer chose to include an MPEG2 CODEC in a device, a bi-directional isochronous interface may be more appropriate for transport of the video stream. Conversely, if the CODEC is not in the USB device, a bi-directional bulk interface would be more appropriate. The processing required for some types of media streams is asymmetrical in nature. For example, MPEG2 decompression is trivial by todays standards, although compression requires substantial processing resources. In light of this fact, it may be appropriate to configure an interface with the appropriate asymmetry. Continuing the MPEG example, a device that relies on host-based decompression and device-based compression would choose an interface that consists of an isochronous endpoint for video in the host-to-device direction and a bulk endpoint for the device-tohost direction. An example of the bandwidth implications of device in contrast with host-based media stream processing is outlined in the following list. USB bandwidth is expressed in bytes per millisecond (B/ms). For example, typical performance of V.42bis is 3-4:1 on data streams, 33.6 kb/s V.34 data could unpack to 16.8 B/ms. Similar bandwidth issues are relevant to audio and video, but they will be handled by the video or audio interfaces rather than Communication Class interfaces.
N N

G.723 voice CODEC (5.5 - 6.5 Kb/s) could be unpacked to 11 kHz audio by the modem (22 B/ms). H.263 compressed video is in the 2.5 B/ms range; but if H.263 is decompressed, a typical bandwidth is approximately 96 B/ms.

B.3

CAPI Device Configuration

This section describes two examples of configurations of CAPI Devices. The first configuration covers the intelligent CAPI Device which implements the whole CAPI functionality on the device including call management (Q.931, NI-1, 5ESS, GSM, etc.) and the variety of the supported B channel protocols such as X.75, X.25, T.30, V.42bis, X.31, V.110, V.120 etc. The second configuration covers the simple CAPI Device which implements CAPI conform access to the Layer 1.

Version 1.1

81

January 19, 1999

USB Class Definitions for Communication Devices

Table 75: Example CAPI Device Configurations

Example Configuration Intelligent CAPI Device Interface (Class Code) Communication Class Data Class Communication Class Simple CAPI Device Data Class Reference Section 3.3.1 3.3.2 3.3.1 3.3.2 Description Device Management consisting of a Management Element CAPI Messages Device Management consisting of a Management Element CAPI Messages for simple CAPI Devices

Version 1.1

82

January 19, 1999

USB Class Definitions for Communication Devices

Appendix C: Multi-channel ISDN B-Channel setup

C.1 General

The basic idea is that call control to/from the host is performed through some sort of protocol state machine. This state machine will be specific for each protocol due to the problems in finding one generic that will suit all possible protocol derivatives that are in use, i.e. for ISDN layer 3 there are for example Q.931 (ITU), DSS1 (Europe), 1TR6 (Germany), VN4 (France), DMS100 Custom (USA), 5ESS Custom (USA), NI-1 (USA), NTT (Japan) and NS2 (USA). The call control protocol is accessed through a Data Class Interface. This is to enable a flexible interface with as few restrictions as possible on the protocol. Each channel (2B+D) on the physical interface is represented by an interface with appropriate Interface Descriptors and Terminal/Unit Functional Descriptors if needed. The interface connected to the D-channel may then run a call control protocol stack starting with I.430 and some Framing, Data link and Network protocols (HDLC,Q.921 and Q.931). For each interface there exists a number of alternate settings. By incorporating an alternate setting with bNumEndpoints = 00h for each interface involved in data transfer, a device offers to the host the option to temporarily relinquish USB bandwidth. If such setting is implemented, it must be as a default alternate setting (alternate setting zero).

Version 1.1

83

January 19, 1999

USB Class Definitions for Communication Devices

Appendix D: Multi-Channel Implementation Examples

D.1 ISDN BRI T/A with two POTS interfaces
Ifc 0: Comm class Ifc 1: Audio class AudioControl Device management Device management

Management EP

Protocol Unit HDLC

Protocol Unit I.430

Network Terminal D-ch

Shared int EP

Extension Unit POTS 1 call control Extension Unit POTS 2 call control Bulk Two EP

Protocol Unit Q.931 Protocol Unit Q.931 Protocol Unit Q.931 Protocol Unit HDLC Protocol Unit HDLC

Protocol Unit Q.921 Protocol Unit Q.921 Protocol Unit Q.921

Network Terminal B1-ch Network Terminal B2-ch Network Terminal B1-ch

Extension Unit TEI-mux

Ifc 2: Data class

USB Terminal

Bulk Two EP

Ifc 3: Data class

USB Terminal

Bulk Two EP

Ifc 4: Data class

USB Terminal

Isoch One EP

Ifc 5: Audio class AudioStreaming Ifc 6: Audio class AudioStreaming Ifc 7: Audio class AudioStreaming Ifc 8: Audio class AudioStreaming

USB Terminal

Isoch One EP

Isoch One EP

USB Terminal

Network Terminal B2-ch

Isoch One EP

Version 1.1

84

January 19, 1999

USB Class Definitions for Communication Devices

D.2

ISDN BRI T/A with vendor specific protocol (Bonding)

Ifc 0: Comm class Ifc 1: Audio class AudioControl Device management Device management

Management EP

Shared int EP

Protocol Unit HDLC

Protocol Unit I.430

Network Terminal D-ch

Bulk Two EP

Ifc 2: Data class

USB Terminal

Protocol Unit Q.931 Protocol Unit HDLC Protocol Unit HDLC Extension Unit Bonding

Protocol Unit Q.921

Network Terminal B1-ch Network Terminal B2-ch Network Terminal B1-ch Network Terminal B2-ch

Bulk Two EP

Ifc 3: Data class

USB Terminal

Bulk Two EP

Ifc 4: Data class

USB Terminal

Bulk Two EP

Ifc 5: Data class

USB Terminal

Isoch One EP

Ifc 6: Audio class AudioStreaming Ifc 7: Audio class AudioStreaming Ifc 8: Audio class AudioStreaming Ifc 9: Audio class AudioStreaming

USB Terminal

Network Terminal B1-ch

Isoch One EP

Isoch One EP

USB Terminal

Network Terminal B2-ch

Isoch One EP

D.3

Passive ISDN Solutions

The multi-channel model allows for different device implementations depending on the system requirements. Many of the ISDN devices described in this section utilize capabilities such as synchronized isochronous data transfers and shared endpoints as defined in the Universal Serial Bus Common Class Specification. Devices may also support a subset of the interfaces and alternate settings shown sections D.1 and D.2. This allows the realization of device designs Version 1.1

85

January 19, 1999

USB Class Definitions for Communication Devices

that are characterized by fewer requirements on the devices ISDN and USB portions, thus reducing the number and complexity of required components (e.g. number of interfaces and endpoints). This is necessary as an ISDN terminal may support only pure data applications (data class), pure voice applications (audio class) or both. Such designs use isochronous transfer instead of bulk in order to minimize buffer size, and locate the D-channel protocol stack in the host. For example a USB ISDN device that follows the ISDN model provides multiplexing and framing functions for the Dand B-channels on the ISDN BRI physical interface. The channel data is transferred frame-interpreted (HDLC frames) for the D-channel and unmodified (transparent data) or optionally frame-interpreted for the B-channels (B1 and B2). In the examples provided (Figure 9 through Figure 11), the D-channel control and data frame transfers are realized by using a data class interface. In order to fulfill the strict ISDN timing requirements for PTT approval, data is transferred isochronously via shared endpoints (as in Figure 9 and Figure 10) together with B-channel data. Alternatively, it is handled via a separate endpoint pair (as in Figure 11). Due to the timing requirements for D-channel collision resolution on the S-bus it is required to have the HDLC formatting done at the USB device, i.e. transparent framing cannot be used. The examples further illustrate the different potential methods for handling the B-channels. Each B-channel utilizes a pair of Audio Class interfaces (isochronous pipes) when transferring voice data (as in Figure 11), and a Data Class interface when transferring raw un-interpreted frame data (Figure 10). The optional implementation of frame interpretation is not needed for the B-channel if the host provides the means for HDLC data encoding/decoding and error handling. Depending on the system requirements, another implementation may use an Audio Class and Data Class interface for the B-channels (as in Figure 9). Shared or separate endpoints can also be used for the B-channels. Sync Information for channel B1 or channel B2 can be handled via an isochronous endpoint, or for B1 and B2 together via a shared isochronous endpoint. This endpoint can be omitted if no explicit sync info is required, e.g. when implicit feed forward information is contained in the IN datastream. The Multi-Channel model allows different device implementations depending on the system requirements.
Ifc 0: Comm Class Management EP Ifc 1: Audio Class Audio Control Device Management Device Management

Ifc 2: Data Class D-channel control/data

USB Ter minal

Protocol Unit HDLC

Network Terminal D-Channel

Ifc 3: Data Class Ifc 4: Audio Class Audio Streaming

USB Ter minal

Protocol Unit Transparent

Network Terminal B1-Channel

Iso Shared In EP

USB Ter minal Ifc 5: Audio Class Audio Streaming

Network Terminal B1-Channel

Iso Shared Out EP Ifc 6: Data Class Ifc 7: Audio Class Audio Streaming USB Ter minal Ifc 8: Audio Class Audio Streaming USB Ter minal Protocol Unit Transparent Network Terminal B2-Channel

Network Terminal B2-Channel

Iso Shared EP

B-Channel Sync (optional)

Figure 9: Passive ISDN Example 1

Version 1.1

86

January 19, 1999

USB Class Definitions for Communication Devices

Management EP

Ifc 0: Comm Class

Device Management

Ifc 1: Data Class D-channel control/data Iso Shared In EP Ifc 2: Data Class Iso Shared Out EP Ifc 3: Data Class

USB Ter minal

Protocol Unit HDLC

Network Terminal D-Channel

USB Ter minal

Protocol Unit Transparent

Network Terminal B1-Channel

USB Ter minal

Protocol Unit Transparent

Network Terminal B2-Channel

Iso Shared EP

B-Channel Sync (optional)

Figure 10: Passive ISDN Example 2

Ifc 0: Comm Class Management EP Ifc 1: Audio Class Audio Control

Device Management Device Management

Iso Shared In EP Ifc 2: Data Class D-channel control/data Iso Shared Out EP Ifc 3: Audio Class Audio Streaming USB Ter minal Iso Shared In EP Ifc 4: Audio Class Audio Streaming USB Ter minal Protocol Unit HDLC Network Terminal D-Channel

Network Terminal B1-Channel

Iso Shared Out EP

Ifc 5: Audio Class Audio Streaming USB Ter minal Ifc 6: Audio Class Audio Streaming

Network Terminal B2-Channel

Iso Shared EP

B-Channel Sync (optional)

Figure 11: Passive ISDN Example 3

Version 1.1

87

January 19, 1999

USB Class Definitions for Communication Devices

Appendix E: Data Class Protocol Definitions

Definitions
N N N N

A REQuest is a command from a higher protocol level to a lower. A CONfirm is an answer from a lower protocol level to a higher on a Request. An INDication is a command from a lower protocol level to a higher. A RESponse is an answer from a higher protocol level to a lower on an Indication. Table 76: Command Type Encoding
Command type REQ CON IND RES Value XXXXXX00b XXXXXX11b XXXXXX01b XXXXXX10b

E.1

Physical Interface Protocols

E.1.2 I.430: BASIC USER-NETWORK INTERFACE LAYER 1

Protocol code: Description: According to Table 19. This is a protocol running on an ISDN BRI device with an S0-interface. It provides de-multiplexing of two B-channels and a D-channel. The protocol covers both user and network side of a connection. Table 77: I.430 Configuration Parameter List
bParameterIndex 0 Field Size 1 Value Bitmap Description D7..D2: D1: RESERVED (Reset to zero) D-channel transmit priority class 0 - Class 1 1 - Class 2 0 User side 1 Network side

bmOptions

D0:

Note : The parameter list is read by the protocol on activation of the Protocol Unit. Table 78: I.430 Command Message Format
Command I430_PH_DATA_REQ I430_PH_ACTIVATE_REQ Corresponding ITU I.430 Primitive PH-DATA request PH-ACTIVATE request ITU I.430 Message Reference 2.3 Primitives between layer 1 and the other entities, Note 1 6.2.1.3 Activate primitives

Version 1.1

88

January 19, 1999

USB Class Definitions for Communication Devices

Command I430_PH_ACTIVATE_IND I430_PH_ACTIVATE_B_REQ I430_PH_DEACTIVATE_IND I430_PH_DEACTIVATE_B_REQ I430_MPH_ERROR_IND I430_MPH_ACTIVATE_IND I430_MPH_DEACTIVATE_REQ I430_MPH_DEACTIVATE_IND I430_MPH_INFORMATION_IND

Corresponding ITU I.430 Primitive PH-ACTIVATE indication N.A. PH-DEACTIVATE indication N.A. MPH-ERROR indication MPH-ACTIVATE indication MPH-DEACTIVATE request MPH-DEACTIVATE indication MPH-INFORMATION indication

ITU I.430 Message Reference 6.2.1.3 Activate primitives Note 2 6.2.1.4 Deactivate primitives, Note 4 Note 3 6.2.1.5 Management primitives 6.2.1.3 Activate primitives 6.2.1.4 Deactivate primitives 6.2.1.4 Deactivate primitives 6.2.1.5 Management primitives

Commands according to I.430 Table E.1 I.430 Primitives associated with layer 1. Note 1: PH-DATA request does not have a data field since this function is performed by other protocols such as HDLC. Therefore PH-DATA is excluded from the command list since it doesnt have any function. Note 2: This primitive is an USB extension to enable a specific B-channel. Note 3: This primitive is an USB extension to disable a specific B-channel. Note 4: This primitive will deactivate the physical layer connection (including all B-channels). Table 79: I.430 Commands
bCommand I430_PH_DATA_xxx I430_PH_ACTIVATE_xxx I430_PH_DEACTIVATE_xxx I430_PH_ACTIVATE_B_xxx I430_PH_DEACTIVATE_B_xxx I430_MPH_ERROR_xxx I430_MPH_ACTIVATE_xxx I430_MPH_DEACTIVATE_xxx I430_MPH_INFORMATION_xxx Value 000000NNb 000001NNb 000010NNb 000011NNb 000100NNb 000101NNb 000110NNb 000111NNb 001000NNb Request X X X X X Indication X X X X X X Confirm Response -

NOTE 1: NN in Value encoded according to Table 76 NOTE 2: X : Exists - : Does not exist Table 80: I.430 Activate, Deactivate Command Wrapper
Offset 0 Field Size 1 Value Number Description I430_PH_ACTIVATE_REQ, I430_PH_ACTIVATE_IND, I430_PH_DEACTIVATE_IND, I430_MPH_ACTIVATE_IND, I430_MPH_DEACTIVATE_REQ, I430_MPH_DEACTIVATE_IND command as defined in Table 79

bCommand

Version 1.1

89

January 19, 1999

USB Class Definitions for Communication Devices

Table 81: I.430 PhActivateBReq Command Wrapper

Offset 0 1 Field Size 1 1 Value Number Number Description I430_PH_ACTIVATE_B_REQ command as defined in Table 79 Index of B-channel to activate 0 RESERVED 1 B1-channel 2 B2-channel 3 to FFh RESERVED

bCommand bChannel

Table 82: I.430 PhDeactivateBReq Command Wrapper

Offset 0 1 Field Size 1 1 Value Number Number Description I430_PH_DEACTIVATE_B_REQ command as defined in Table 79 Index of B-channel to deactivate 0 RESERVED 1 B1-channel 2 B2-channel 3 to FFh - RESERVED

bCommand bChannel

Table 83: I.430 PhDataReq Command Wrapper

Offset 0 1 Field Size 1 1 Value Number Number Description I430_PH_DATA_REQ command as defined in Table 79 D-channel transmit data priority class 0 Priority class 1 1 Priority class 2 2 to FFh RESERVED

bCommand bPriority

Table 84: I.430 MphErrorInd Command Wrapper

Offset 0 1 Field Size 1 1 Value Number Number Description I430_PH_ERROR_IND command as defined in Table 79 Error codes 0 = Error, RX info 0 1 = Error, RX info 2 2 = Error, lost framing 3 = Recover from error, RX info 0 4 = Recover from error, RX info 2 5 = Recover from error, RX info 4 6 = FFh RESERVED

bCommand bInfo

Note: See I.430 "TABLE 5/I.430", "TABLE 6/I.430", "TABLE C.1/I.430", "TABLE C.2/I.430" for more details

Version 1.1

90

January 19, 1999

USB Class Definitions for Communication Devices

Table 85: I.430 MphInformationInd Command Wrapper

Offset 0 1 Field Size 1 1 Value Number Number Description I430_PH_INFORMATION_IND command as defined in Table 79 0: Physical layer disconnected 1: Physical layer connected 2 .. FFh: RESERVED (future use)

bCommand bInfo

I430_PH_DEACTIVATE_IND I430_PH_ACTIVATE_REQ Activation requested I430_PH_DEACTIVATE_IND Information transfer not available

I430_PH_ACTIVATE_IND I430_PH_ACTIVATE_IND Information transfer available (Note) I430_PH_DEACTIVATE_IND

I430_PH_ACTIVATE_IND, I430_PH_ACTIVATE_B_REQ, I430_PH_DEACTIVATE_B_REQ, I430_PH_DATA_REQ Note: Layer 2 is not aware if the information transfer capability is temporariliy interrupted

Figure 12: I.430 Layer 1 and Layer 2

Version 1.1

91

January 19, 1999

USB Class Definitions for Communication Devices

I430_MPH_DEACTIVATE_REQ Information transfer interrupted Information transfer not available I430_MPH_ACTIVATE_IND I430_MPH_DEACTIVATE_IND

I430_MPH_ERROR_IND

I430_MPH_ACTIVATE_IND

Information transfer available (Note)

I430_MPH_DEACTIVATE_REQ

I430_MPH_ACTIVATE_IND

Figure 13: Layer 1 - Management Network Side

Any state

I430_MPH_ACTIVATE_IND, I430_MPH_DEACTIVATE_IND, I430_MPH_INFO_IND, I430_MPH_ERROR_IND

Figure 14: Layer 1 - Management User Side

E.2

Framing Protocols

E.2.1 HDLC Framing

Protocol code: Description: According to Table 19. The HDLC framing protocol provides functions for creating and extracting HDLC frames on a serial synchronous data stream. See ISO/IEC 3309-1993 for further details. Table 86: HDLC Configuration Parameter List
bParameterIndex 0 Field Size 2 Value Number Description Max number of bytes in a buffer excluding FCS

wBufferLength

Version 1.1

92

January 19, 1999

USB Class Definitions for Communication Devices

bParameterIndex 1

Field

Size 2

Value Bitmap

Description D15: D14: RESERVED (Reset to zero) TX and RX data handling 0 TX data is transmitted to the line. RX data is sent to the host. 1 - TX data is transmitted to the line and looped back to RX. RX data from the line is ignored. TX frame handling after transmission 0 Discard frame 1 Return frame to host (for the sending protocol) Address filtering mode 00 None 01 8 bit address 10 16 bit address 11 RESERVED

bmConfig

D13:

D12..D11:

D10..D7: Min number of flags between frames (0 15) in TX direction D6: Idle 0 Flags 1 Mark Generate FCS on TX data 0 Generate FCS 1 Do not generate FCS Check FCS on RX data 00 Verify FCS 01 Verify FCS and remove invalid frame 10 Ignore FCS 11 RESERVED Frame check sequence (FCS) on TX and RX data 00 None 01 CRC16 10 CRC32 11 RESERVED Data encoding 0 NRZ 1 NRZI

D5:

D4..D3:

D2..D1:

D0:

wAddr Comparator0

Number

First address comparator. 8 bit address D7..D0: Address D15..D8: RESERVED (Reset to zero) 16 bit address D15..D0: Address

1+N

Number Nth address comparator. 8 bit address D7..D0 Address D15..D8: RESERVED (Reset to zero) 16 bit address D15..D0: Address

wAddr ComparatorN-1

Note: The parameter list is read by the protocol on activation of Protocol Unit.

Version 1.1

93

January 19, 1999

USB Class Definitions for Communication Devices

Table 87: HDLC Commands

bCommand HDLC_CONTROL_xxx HDLC_STATUS_xxx HDLC_DATA_xxx Value 000000NNb 000001NNb 000010NNb Request X X X Indication X X Confirm Response X X -

NOTE 1: NN in Value encoded according to Table 76 NOTE 2: X : Exists - : Does not exist Table 88: HDLC ControlRes, StatusReq Command Wrapper
Offset 0 Field Size 1 Value Number Description HDLC_CONTROL_RES or HDLC_STATUS_REQ command as defined in Table 87

bCommand

Note: The device should return a HDLC_STATUS_RES on reception of HDLC_STATUS_REQ Table 89: HDLC ControlReq Command Wrapper
Offset 0 1 Field Size 1 1 Value Number Bitmap Description HDLC_CONTROL_REQ command as defined in Table 87 D7..D3: D2: RESERVED (Reset to zero) Receiver abort 0 No action 1 Abort ongoing RX and abort pending RX buffers

bCommand bmControl

D1:

FCS generation 0 Generate correct FCS 1 Generate bad FCS Transmitter abort 0 No action 1 Abort ongoing TX and discard pending buffers ahead of this command

D0:

Note: The device should return a HDLC_CONTROL_RES on reception of HDLC_CONTROL_REQ Table 90: HDLC StatusInd/Res Command Wrapper
Offset 0 Field Size 1 Value Number Description HDLC_STATUS_IND or HDLC_STATUS_RES command as defined in Table 87

bCommand

Version 1.1

94

January 19, 1999

USB Class Definitions for Communication Devices

Offset 1

Field

Size 1

Value Bitmap

Description D7..D5: D4: RESERVED (Reset to zero) Source of receive data 0 Normal RX data 1 Return of TX data Frame length status 00 OK 01 Too short frame 10 Too long frame 11 Frame length is not an integer multiple of 8 bits FCS status 0 OK 1 Error Received frames discarded due to overrun 0 No 1 Yes

bmStatus

D3..D2:

D1:

D0:

Note: The HDLC_STATUS_IND should immediately precede the HDLC_DATA_IND to which it applies. It is optional to send a HDLC_STATUS_IND if received data is without errors. Table 91: HDLC DataReq/Ind Command Wrapper
Offset 0 1 0+N Field Size 1 1 1 Value Number Number Number Nth byte with protocol data. FCS excluded. Description HDLC_DATA_REQ or HDLC_DATA_IND command as defined in Table 87 First byte with protocol data. FCS excluded.

bCommand bProtocolData0

bProtocolDataN-1

E.2.2 Transparent framing

Protocol code: Description: According to Table 19. This protocol provides no framing on a synchronous bitstream. Table 92: TRANS Configuration Parameter List
bParameterIndex 0 Field Size 1 Value Bitmap Description D7..D2: D1: RESERVED (Reset to zero) TX and RX data handling 0 TX data is transmitted to the line. RX data is sent to the host. 1 - TX data is transmitted to the line and looped back to RX. RX data from the line is ignored. Data encoding 0 NRZ 1 NRZI RESERVED (Reset to zero) NRZI encoding option 0 NRZI not available 1 NRZI available

bmConfig

D0:

bmConfigCapabil ities

Bitmap (read only)

D7..D1: D0:

Version 1.1

95

January 19, 1999

USB Class Definitions for Communication Devices

Note : The parameter list is read by the protocol on activation of Protocol Unit. Table 93: TRANS Commands
bCommand TRANS_CONTROL_xxx TRANS_STATUS_xxx TRANS_DATA_xxx Value 000000NNb 000001NNb 000010NNb Request X X X Indication X X Confirm Response X X -

NOTE 1: NN in Value encoded according to Table 76 NOTE 2: X : Exists - : Does not exist Table 94: TRANS ControlRes, StatusReq Command Wrapper
Offset 0 Field Size 1 Value Number Description TRANS_CONTROL_RES or TRANS_STATUS_REQ command as defined in Table 93

bCommand

Note: The device should return a TRANS_STATUS_RES on reception of TRANS_STATUS_REQ Table 95: TRANS ControlReq Command Wrapper
Offset 0 1 Field Size 1 1 Value Number Bitmap Description TRANS_CONTROL_REQ command as defined in Table 93 D7..D3 : RESERVED (Reset to zero) D2: Transmitter data underrun option 0 Transmit continuous idle mark whenever the transmit buffer is underrun. 1 Repeatedly transmit the last buffer received from the host whenever the transmit buffer is underrun (for tones, etc) Receiver abort 0 No action 1 Abort ongoing RX and abort pending RX buffers. Transmitter abort 0 No action 1 Abort ongoing TX and discard pending buffers ahead of this one

bCommand bmControl

D1:

D0:

Note: The device should return a TRANS_CONTROL_RES on reception of TRANS_CONTROL_REQ Table 96: TRANS StatusInd/Res Command Wrapper
Offset 0 Field Size 1 Value Number Description TRANS_STATUS_IND or TRANS_STATUS_RES command as defined in Table 93

bCommand

Version 1.1

96

January 19, 1999

USB Class Definitions for Communication Devices

Offset 1

Field

Size 1

Value Bitmap

Description D7 .. D2 : RESERVED (Reset to zero) D1: Transmitter underrun 0 No transmitter underrun has occurred 1 Transmitter underrun has occurred Receive overrun 0 No received data discarded due to overrun 1 Received data discarded due to overrun

bmStatus

D0:

Note: The TRANS_STATUS_IND should immediately precede the TRANS_DATA_IND to which it applies. It is optional to send a TRANS_STATUS_IND if received data is without errors. Table 97: TRANS DataReq/Ind Command Wrapper
Offset 0 1 0+N Field Size 1 1 1 Value Number Number Number Description TRANS_DATA_REQ or TRANS_DATA_IND command as defined in Table 93 First byte with protocol data Nth byte with protocol data

bCommand bProtocolData0 bProtocolDataN-1

E.3

Data Link Protocols

E.3.1 Q.921 Management: ISDN USER-NETWORK INTERFACE DATA LINK LAYER SPECIFICATION FOR CIRCUIT MODE BEARER SERVICES
Protocol code: Description: According to Table 19. Management procedure defined by Q.921 handles TEI negotiation and distribution of received messages. This protocol will reside below all Q.921 data link procedures, as opposed to the definition by ITU-T where the management entity resides above all data link procedures (ref FIGURE 9/Q.921). All command-names (Q921M_DL_xxx) are therefore reversed in order to maintain the definition of Request, Indication, Response and Confirm, but are in all other aspects identical to ITU-T specification. The protocol covers both user and network side of a connection. Table 98: Q.921M Configuration Parameter List
bParameterIndex 0 Field Size 1 Value Bitmap D7..D1: D0 : 1 2 3 Description RESERVED (Reset to zero) 0 User side 1 Network side

bmOptions

bT201 bN202 bT202

1 1 1

Number Number Number

Maximum time between retransmission of the TEI identity check message Maximum number of transmissions of the TEI identity request message Minimum time between the transmission of TEI identity request messages

Version 1.1

97

January 19, 1999

USB Class Definitions for Communication Devices

bParameterIndex 4

Field

Size 1

Value Bitmap

Description D7 .. D1: Non-automatic TEI value D0: 0 Use non-automatic TEI value 1 Use automatic TEI value

bmTEI

Note 1: Parameters 1 3 according to Q.921 5.9 List of system parameters Note 2: The parameter list is read by the protocol on activation of Protocol Unit. Table 99: Q.921M Command Message Format
Command Q921M_DL_ASSIGN_REQ Q921M_DL_ASSIGN_IND Q921M_DL_REMOVE_IND Q921M_DL_ERROR_REQ Q921M_DL_ERROR_CON Q921M_DL_DATA_REQ Q921M_DL_DATA_IND Q921M_DL_UNIT_DATA_REQ Q921M_DL_UNIT_DATA_IND Corresponding ITU Q.921 data link layer primitive MDL Assign indication MDL Assign request MDL Remove request MDL Error indication MDL Error response Data request Data request UData request UData request ITU Q.921 message reference 4.1.1.5 MDL-ASSIGN 4.1.1.5 MDL-ASSIGN 4.1.1.6 MDL-REMOVE 4.1.1.7 MDL-ERROR 4.1.1.7 MDL-ERROR 4.1.1.3 DL-DATA 4.1.1.3 DL-DATA 4.1.1.4 DL-UNIT-DATA 4.1.1.4 DL-UNIT-DATA

Note: Commands according to Q.921 TABLE 6/Q.921 Primitives associated with this recommendation Table 100: Q.921M Commands
Command Q921M_DL_ASSIGN_xxx Q921M_DL_REMOVE_xxx Q921M_DL_ERROR_xxx Q921M_DL_DATA_xxx Q921M_DL_UNIT_DATA_xxx Value 000000NNb 000001NNb 000010NNb 000011NNb 000100NNb Request X X X X Indication X X X X Response Confirm X -

NOTE 1: NN in Value encoded according to Table 76 NOTE 2: X : Exists - : Does not exist The Q921M_DL_DATA_xxx and Q921M_DL_UNIT_DATA_xxx follow the message structure according to Table 107. Table 101: Q.921M DlAssignReq wrapper
Offset 0 Field Size 1 Value Number Description Q921M_DL_ASSIGN _REQ command as defined Table 100

bCommand

Version 1.1

98

January 19, 1999

USB Class Definitions for Communication Devices

Table 102: Q.921M DlAssignInd, DlRemoveInd Command Wrapper

Offset 0 Field Size 1 Value Number Description Q921M_DL_ASSIGN _IND, Q921M_DL_REMOVE _IND command as defined Table 100 TEI value

bCommand

bTei

Number

Table 103: Q.921M DlErrorReq, DlErrorCon Command Wrapper

Offset 0 Field Size 1 Value Number Description Q921M_DL_ERROR_IND, Q921M_DL_ERROR_CON command as defined in Table 100 Error code according to Q.921 "TABLE II.1/Q.921 Management Entity Actions for MDL-Error-Indications" where A=1, B=2,

bCommand

bError

Number

E.3.2 Q.921: ISDN USER-NETWORK INTERFACE DATA LINK LAYER SPECIFICATION FOR CIRCUIT MODE BEARER SERVICES
Protocol code: Description: According to Table 19. Q.921 is the link access procedure used by Q.931.. The protocol covers both user and network side of a connection. Table 104: Q.921 Configuration Parameter List
bParameterIndex 0 Field Size 1 Value Bitmap D7..D1 D0 1 Description RESERVED (Reset to zero) 0 User side 1 Network side

bmOptions

bT200

Number

Maximum time until an acknowledgment. must be received after the transmission of an Iframe Maximum number of retransmissions of a frame Maximum number of bytes in an information field Maximum number of outstanding I-frames Maximum time allowed without frames being exchanged SAPI value according Table 2 of Q.921

2 3 4 5 6

bN200 bN201 bK bT203 bSAPI

1 1 1 1 1

Number Number Number Number Number

Note 1: Parameters at offset 1 5 according to Q.921 "5.9 List of system parameters Note 2 : The parameter list is read by the protocol on activation of Protocol Unit

Version 1.1

99

January 19, 1999

USB Class Definitions for Communication Devices

Table 105: Command Message Format

Command Q921_DL_ESTABLISH_REQ Q921_DL_ESTABLISH_IND Q921_DL_ESTABLISH_CON Q921_DL_RELEASE_REQ Q921_DL_RELEASE_IND Q921_DL_RELEASE_CON Q921_DL_DATA_REQ Q921_DL_DATA_IND Q921_DL_UNIT DATA_REQ Q921_DL_UNIT DATA_IND Corresponding ITU Q.921 data link layer primitive Establish request Establish indication Establish confirm Release request Release indication Release confirm Data request Data indication Udata request Udata indication ITU Q.921 message reference 4.1.1.1 DL-ESTABLISH 4.1.1.1 DL-ESTABLISH 4.1.1.1 DL-ESTABLISH 4.1.1.2 DL-RELEASE 4.1.1.2 DL-RELEASE 4.1.1.2 DL-RELEASE 4.1.1.3 DL-DATA 4.1.1.3 DL-DATA 4.1.1.4 DL-UNIT DATA 4.1.1.4 DL-UNIT DATA

Note: Commands according to Q.921 "TABLE 6of Q.921 Primitives associated with this recommendation Table 106: Q.921 commands
Command Q921_DL_ESTABLISH_xx Q921_DL_RELEASE_xxx Q921_DL_DATA_xxx Q921_DL_UNIT DATA_xxx Value 000000NNb 000001NNb 000010NNb 000011NNb Request X X X X Indication X X X X Response Confirm X X -

NOTE 1: NN in Value encoded according to Table 76 NOTE 2: X : Exists - : Does not exist Table 107: Q.921 General Message Structure
Offset 0 1 0+N Field Size 1 1 1 Value Number Parameter Parameter Description Command according to Table 100 and Table 106 First byte with optional parameter data associated with the message Nth byte with optional parameter data associated with the message

bCommand bMessageData0 bMessageDataN-1

Version 1.1

100

January 19, 1999

USB Class Definitions for Communication Devices

Q921_DL_RELEASE_IND, Q921_DL_UNIT_DATA_REQ/IND

Q921_DL_RELEASE_IND

Data link connection released

Q921_DL_RELEASE_CON

Q921_DL_ESTABLISH_REQ Q921_DL_ESTABLISH_IND/CON Q921_DL_ESTABLISH_IND/CON, Q921_DL_RELEASE_IND, Q921_DL_UNIT_DATA_REQ/IND Q921_DL_ESTABLISH_IND, Q921_DL_UNIT_DATA_REQ/IND

Q921_DL_RELEASE_IND

Awaiting establish

Waiting release

Q921_DL_ESTABLISH_CON

Q921_DL_ESTABLISH_REQ

Link connection established

Q921_DL_RELEASE_REQ

Q921_DL_ESTABLISH_IND/CON, Q921_DL_UNIT_DATA_REQ/IND Q921_DL_DATA_REQ/IND

Figure 15: State Transition Diagram for Q.921

E.3.3 Q.921 TEI-multiplexor: TERMINAL ENDPOINT IDENTIFIER MULTIPLEXOR FOR ISDN USER-NETWORK INTERFACE DATA LINK LAYER
Protocol code: Description: According to Table 19. TEI-multiplexor protocol is used to connect multiple instances of Q.921 to a D-channel in a device. The TEI-mux protocol distributes incoming messages to all connected Q.921 protocols for sending outgoing messages down the stack to the D-channel. This protocol has no configurable parameters, and it covers both user and network side of a connection.

Version 1.1

101

January 19, 1999

USB Class Definitions for Communication Devices

E.4

Network layer Protocols

E.4.1 Q.931/Euro-ISDN User Side

Protocol code: Description: According to Table 19. Call control protocol of the Q.931/Euro-ISDN userside is the ISDN connection. The protocol implements the interface described by Primitives to/from call control in Q.931 Annex A User side and network side SDL diagrams. NOTE: Extensions for symmetric call operation are not supported. Most commands use a general command structure as defined in Table 112 that corresponds to the message format defined in Q.931 chapter 4.1. The ones that dont are explicitly defined within this document. Table 108: Q.931/Euro-ISDN Configuration Parameter List
bParameterIndex 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 Field Size 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 Value Number Number Number Number Number Number Number Number Number Number Number Number Number Number Number Number Description See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1 See Note 1

bT301 bT302 bT303 bT304 bT305 bT308 bT309 bT310 bT313 bT314 bT316 bT317 bT318 bT319 bT321 bT322

Note 1 : Parameters according to Q.931 TABLE 9-2 "Timers in the user side. Note 2 : The parameter list is read by the protocol on activation of Protocol Unit. Table 109: Q.931/Euro-ISDN Command Message Format
Command Q931_ALERT_REQ Q931_ALERT_IND Q931_DISC_REQ Q931_DISC_IND Q931_ERROR_IND Corresponding ITU Q.931 call control primitive Alerting request Alerting indication Disc request Disc indication Error indication ITU Q.931 message format reference 3.1.1 Alerting 3.1.1 Alerting 3.1.5 Disconnect 3.1.5 Disconnect 3.1.5 Disconnect /Note 1

Version 1.1

102

January 19, 1999

USB Class Definitions for Communication Devices

Command Q931_GET_STATISTICS_REQ Q931_GET_STATISTICS_CON Q931_INFO_REQ Q931_INFO_IND Q931_LINK_FAIL_IND Q931_MORE_REQ Q931_MORE_IND Q931_NOTIFY_REQ Q931_NOTIFY_IND Q931_PROCEED_REQ Q931_PROCEED_IND Q931_PROGRESS_REQ Q931_PROGRESS_IND Q931_REJECT_REQ Q931_REJECT_IND Q931_RELEASE_REQ Q931_RELEASE_IND Q931_RELEASE_CON Q.931_RESTART_REQ Q.931_RESTART_CON Q931_RESUME_REQ Q931_RESUME_CON Q931_RESUME_CON Q931_SETUP_REQ Q931_SETUP_IND Q931_SETUP_RES Q931_SETUP_CON Q931_SETUP_CON Q931_COMPLETE_IND Q931_COMPLETE_IND Q931_STATUS_IND Q931_SUSPEND_REQ Q931_SUSPEND_CON Q931_SUSPEND_CON Q931_TIMEOUT_IND Q931_USERINFO_REQ Q931_USERINFO_IND

Corresponding ITU Q.931 call control primitive N.A. N.A. Info request Info indication Link fail indication More info request More info indication Notify request Notify indication Proceeding request Proceeding indication Progress request Progress indication Reject request Reject indication Release request Release indication Release confirm Management restart request Management restart acknowledge Resume request Resume confirm (ok) Resume confirm (error) Setup request Setup indication Setup response Setup confirm (ok) Setup confirm (error) Setup complete indication (ok) Setup complete indication (error) Status indication Suspend request Suspend confirm (ok) Suspend confirm (error) Timeout indication N.A. N.A.

ITU Q.931 message format reference N.A. N.A. 3.1.6 Information 3.1.6 Information 3.1.5 Disconnect /Note 1 3.1.15 Setup acknowledge 3.1.15 Setup acknowledge 3.1.7 Notify 3.1.7 Notify 3.1.2 Call proceeding 3.1.2 Call proceeding 3.1.8 Progress 3.1.8 Progress 3.1.10 Release complete 3.1.10 Release complete 3.1.9 Release 3.1.9 Release 3.1.9 Release 3.4.1 Restart 3.4.2 Restart acknowledge 3.1.11 Resume 3.1.12 Resume acknowledge 3.1.12 Resume reject 3.1.14 Setup 3.1.14 Setup 3.1.3 Connect 3.1.3 Connect 3.1.5 Disconnect /Note 1 3.1.4 Connect acknowledge 3.1.5 Disconnect /Note 1 3.1.16 Status 3.1.18 Suspend 3.1.19 Suspend acknowledge 3.1.20 Suspend reject 3.1.5 Disconnect /Note 1 3.3.13 User information 3.3.13 User information

Note 1: Only mandatory fields are used

Version 1.1

103

January 19, 1999

USB Class Definitions for Communication Devices

Table 110: Q.931/Euro-ISDN Commands

bMessageType Q931_ALERT_xxx Q931_COMPLETE_xxx Q931_DISC_xxx Q931_ERROR_xxx Q931_INFO_xxx Q931_LINK_FAIL_xxx Q931_MORE_xxx Q931_NOTIFY_xxx Q931_PROCEED_xxx Q931_PROGRESS_xxx Q931_REJECT_xxx Q931_RELEASE_xxx Q931_RESUME_xxx Q931_SETUP_xxx Q931_SUSPEND_xxx Q931_STATUS_xxx Q931_TIMEOUT_xxx Q931_USERINFO_xxx Value 000000NNb 000001NNb 000010NNb 000011NNb 000100NNb 000101NNb 000110NNb 000111NNb 001000NNb 001001NNb 001010NNb 001011NNb 001100NNb 001101NNb 001110NNb 001111NNb 010000NNb 010001NNb Request X X X X X X X X X X X X X Indication X X X X X X X X X X X X X X X X Confirm X X X X Response X -

Note 1: NN in Value encoded according to Table 76 Note 2: X : Exists - : Does not exist Table 111: Q.931/Euro-ISDN System Management Commands
bCommand Q931_RESTART_xxx Value 100000NNb Request X Indication Confirm X Response -

Note 1: NN in Value encoded according to Table 76 Note 2: X : Exists - : Does not exist Table 112: Q.931/Euro-ISDN General Command Structure
Offset 0 1 1+N Field Size 1 2 to N Size of info element Value Number Info element Info element Reference Command according to Table 110 Q.931 Chapter 4.3 Optional information element according to command.

bCommand iCallReference iInformationElement

Version 1.1

104

January 19, 1999

USB Class Definitions for Communication Devices

6 Call present

Q931_SETUP_IND

0 Null

Q931_SETUP_REQ

1 Call initiated

Q931_RESUME_REQ 17 Resume request

Figure 16: Q.931 Handling of Null State

Version 1.1

105

January 19, 1999

USB Class Definitions for Communication Devices

0 Null 11 Disconnect request Q931_REJECT_IND 11 Disconnect request

Q931_SETUP_CON (error)

Q931_SETUP_CON (timeout error)

1 Call initiated

Q931_SETUP_CON (error)

Q931_MORE_IND

Q931_PROCEED_IND

Q931_INFO_REQ, Q931_PROGRESS_IND, Q931_ERROR_IND

2 Overlap sending

Q931_PROCEED_IND

3 Outgoing call proceeding

Q931_PROGRESS_IND

Q931_ALERT_IND Q931_RELEASE_REQ

Q931_ALERT_IND Q931_RELEASE_REQ

19 Release request

4 Call delivered

Q931_USERINFO_REQ Q931_USERINFO_IND

19 Release request

Q931_SETUP_CON

Q931_SETUP_CON

10 Active

Q931_SETUP_CON

Figure 17: Q.931 Handling of Outgoing-Call States

Version 1.1

106

January 19, 1999

USB Class Definitions for Communication Devices

0 Null

Q931_REJECT_REQ

6 Call present

Q931_MORE_REQ

25 Overlap receiving

Q931_PROCEED_REQ Q931_ALERT_REQ Q931_SETUP_RES Q931_PROGRESS_REQ 9 Incoming call proceeding

12 Disconnect indication

Q931_COMPLETE_IN D (error) Q931_SETUP_RES 8 Connect request

Q931_ALERT_REQ 7 Call received

Q931_SETUP_RES

Q931_USERINFO_REQ Q931_USERINFO_IND

Q931_INFO_IND Q931_TIMEOUT_IND Q931_PROGRESS_REQ Q931_ERROR_IND

Q931_COMPLETE_IN D

10 Active 25 Overlap receiving Q931_ALERT_REQ 7 Call received Q931_SETUP_RES Q931_PROCEED_REQ 9 Incoming call proceeding

8 Connect request

Figure 18: Q.931 Handling of Incoming Call-Setup States

Version 1.1

107

January 19, 1999

USB Class Definitions for Communication Devices

Q931_NOTIFY_REQ Q931_NOTIFY_IND

10 Active

Q931_SUSPEND_REQ

15 Suspend request

NOTE: Transition due to change of state (to 19, Release request) in device without host beeing informed

11 Disc request

Q931_RELEASE_CON, Q931_RELEASE_CON (error), Q931_STATUS_IND (error)

0 Null

12 Disc indication

Q931_RELEASE_REQ

19 Release request

12 Disconnect indication

Q931_DISC_IND

15 Suspend request

Q931_SUSPEND_CON (error)

10 Active

Q931_RELEASE_IND, Q931_SUSPEND_CON

0 Null

19 Release request

Q931_RESUME_CON (timeout error)

17 Resume request Q931_RESUME_CON 10 Active

Q931_RESUME_CON (error)

0 Null

19 Release request

Q931_RELEASE_CON, Q931_RELEASE_CON (error), Q931_STATUS_IND (error)

0 Null

Figure 19: Q.931 Handling of Specific States

Version 1.1

108

January 19, 1999

USB Class Definitions for Communication Devices

Any state

Q931_LINK_FAIL_IND, Q931_RELEASE_IND

0 Null

Any state except 0,11,12, 17,19

Q931_DISC_REQ Q931_DISC_IND

11 Disconnect request 12 Disc indication

Any state except 0,19

Q931_STATUS_IND (error) Q931_STATUS_IND

11 Disconnect request 0 Null

Q931_INFO_REQ

Any state except 0,1,6,17,19

Q931_INFO_IND

Any state except 0,1,6,17,19, 25

Q931_USERINFO_REQ Q931_USERINFO_IND

Any state

Figure 20: Q.931 Handling of Generic States

E.4.2 V.42bis: Data compression procedures for DCE using error correction procedures
Protocol code: Description: According to Table 19. V.42bis is a data compression protocol Table 113: V.42bis Configuration Parameter List
bParameterIndex 0 Field Size 1 Value Number Description V.42bis data compression request

bP0

Version 1.1

109

January 19, 1999

USB Class Definitions for Communication Devices

bParameterIndex 1 2

Field

Size 2 1

Value Number Number

Description Number of code words Maximum string size

wP1 bP2

Note 1: Parameters according to V.42bis 10 Parameters Note 2: The parameter list is read by the protocol on activation of Protocol Unit

E.4.3 V.120: V.24 rate adaptation to ISDN

Protocol code: Description: According to Table 19. V.120 is a Rate adaptation protocol. The protocol has no configurable parameters

Version 1.1

110

January 19, 1999