Sierra Wireless AirPrime MC5727 Developer's Manual

2130634

Rev 1.9



Mini Card / AirCard / Compass

USB Driver Developer’s Guide

Refers to:

AC595 / AC595U / AC597 / AC597E

AC875 / AC875U

AC880 / AC880E / AC880U

AC881 / AC881U

C597

C885 / C888

MC5725 / MC5725V / MC5727

MC8775 / MC8775V

MC8780 / MC8781 / MC8785V

MC8790 / MC8790V

MC8791V

MC8792V

Preface

Rev 1.9 Sep.08 Proprietary and Confidential 3

Important Notice Duetothenatureofwirelesscommunications,transmission

andreceptionofdatacanneverbeguaranteed.Datamaybe

delayed,corrupted(i.e.,haveerrors)orbetotallylost.

Althoughsignificantdelaysorlossesofdataarerarewhen

wirelessdevicessuchastheSierraWirelessmodemareusedin

anormal

mannerwithawell‐constructednetwork,theSierra

Wirelessmodemshouldnotbeusedinsituationswherefailure

totransmitorreceivedatacouldresultindamageofanykind

totheuseroranyotherparty,includingbutnotlimitedto

personalinjury,death,orlossofproperty.Sierra

Wireless

acceptsnoresponsibilityfordamagesofanykindresulting

fromdelaysorerrorsindatatransmittedorreceivedusingthe

SierraWirelessmodem,orforfailureoftheSierraWireless

modemtotransmitorreceivesuchdata.

Safety and Hazards DonotoperatetheSierraWirelessmodeminareaswhere

blastingisinprogress,whereexplosiveatmospheresmaybe

present,nearmedicalequipment,nearlifesupportequipment,

oranyequipmentwhichmaybesusceptibletoanyformof

radiointerference.Insuchareas,theSierraWirelessmodem

MUSTBEPOWEREDOFF

.TheSierraWirelessmodemcan

transmitsignalsthatcouldinterferewiththisequipment.

DonotoperatetheSierraWirelessmodeminanyaircraft,

whethertheaircraftisonthegroundorinflight.Inaircraft,the

SierraWirelessmodemMUSTBEPOWE REDOFF.When

operating,theSierraWirelessmodemcantransmitsignalsthat

couldinterferewithvariousonboardsystems.

Note: Some airlines may permit the use of cellular phones while the

aircraft is on the ground and the door is open. Sierra Wireless

modems may be used at this time.

Thedriveroroperatorofanyvehicleshouldnotoperatethe

SierraWirelessmodemwhileincontrolofavehicle.Doingso

willdetractfromthedriveroroperatorʹscontrolandoperation

ofthatvehicle.In somestatesandprovinces, operatingsuch

communicationsdeviceswhileincontrolofavehicle

isan

offence.

Limitation of

Liability

Theinformationinthismanualissubjecttochangewithout

noticeanddoesnotrepresentacommitmentonthepartof

SierraWireless.SIERRAWIRELESSANDITSAFFILIATES

SPECIFICALLYDISCLAIMLIABILIT YFORANYANDALL

DIRECT,INDIRECT,SPECIAL,GENERAL,INCIDENTAL,

CONSEQUENTIAL,PUNITIVEOREXEMPLARYDA MA GES

INCLUDING,BUTNOTLIMITEDTO,LOSS

OFPROFITSOR

Mini Card / AirCard / Compass USB Driver Developer’s Guide

4 Proprietary and Confidential 2130634

REVENUEORANTICIPATEDPROFITSORREVENUE

ARISINGOUTOFTHEUSEORINABILITYTOUSEANY

SIERRAWIRELESSPRODUCT,EVENIFSIERRAWIRELESS

AND/ORITSAFFILIATESHASBEENADVISEDOFTHE

POSSIBILITYOFSUCHDAMAGESORTHEYARE

FORESEEABLEORFORCLAIMSBYANYTHIRDPARTY.

Notwithstandingtheforegoing,innoeventshallSierra

Wirelessand/oritsaffiliatesaggregateliabilityarisingunderor

inconnectionwiththeSierraWirelessproduct,regardlessof

thenumberofevents,occurrences,orclaimsgivingriseto

liability,beinexcessofthepricepaidbythepurchaserforthe

SierraWireless

product.

Patents Portionsofthisproductmay becoveredbysomeorallofthe

followingUSpatents:

5,515,013 5,629,960 5,845,216 5,847,553 5,878,234

5,890,057 5,929,815 6,169,884 6,191,741 6,199,168

6,339,405 6,359,591 6,400,336 6,516,204 6,561,851

6,643,501 6,653,979 6,697,030 6,785,830 6,845,249

6,847,830 6,876,697 6,879,585 6,886,049 6,968,171

6,985,757 7,023,878 7,053,843 7,106,569 7,145,267

7,200,512 7,287,162 7,295,171 D442,170 D459,303

D559,256 D560,911

andotherpatentspending.

Thisproductincludes

technologylicensedfrom:

LicensedbyQUALCOMMIncorporatedunderoneormoreof

thefollowingUnitedStatespatentsand/ortheircounterparts

inothernations:

4,901,307 5,056,109 5,101,501 5,109,390 5,228,054

5,267,261 5,267,262 5,337,338 5,414,796 5,416,797

5,490,165 5,504,773 5,506,865 5,511,073 5,535,239

5,544,196 5,568,483 5,600,754 5,657,420 5,659,569

5,710,784 5,778,338

ManufacturedorsoldbySierraWirelessoritslicenseesunder

oneormorepatentslicensedfromInterDigitalGroup.

Trademarks AirCard

®

and“H eartoftheWirelessMachine

®

”areregistered

trademarksofSierraWireless.Watcher

®

isatrademarkof

SierraWireless,registeredintheEuropeanCommunity.



SierraWireless,theSierraWirelesslogo,theredwavedesign,

andthered‐tippedantennaaretrademarksofSierraWireless.

QUALCOMM

®

3G

Preface

Rev 1.9 Sep.08 Proprietary and Confidential 5

Windows

®

isaregisteredtrademarkofMicrosoftCorporation.

QUALCOMM

®

isaregisteredtrademarkofQUALCOMM

Incorporated.Usedunderlicense.

Othertrademarksarethepropertyoftherespectiveowners.

Contact

Information

Consultourwebsiteforup‐to‐dateproductdescriptions,

documentation,applicationnotes,firmwareupgrades,trouble

‐

shootingtips,andpressreleases:

www.sierrawireless.com

Revision History

Sales Desk: Phone: 1-604-232-1488

Hours: 8:00 AM to 5:00 PM Pacific Time

E-mail: [email protected]

Post: Sierra Wireless

13811 Wireless Way

Richmond, BC

Canada V6V 3A4

Fax: 1-604-231-1109

Web: www.sierrawireless.com

Revision

number

Release

date

Changes

1.3 Jun 2007 - Added MC8785 / AC885E / AC885U

- Updated idProduct values

1.4 Sep 2007 - Added vendor commands: Get TRU-Install Information (page 68), Set TRU-

Install Mode (page 69)

1.5 Feb 2008 - Removed old products, added C885

- Updated USB descriptors for MC8785V / AC885E / C885

- Updated USB architecture for MC8785V / AC885E / C885

- Updated descriptions on non-MUX and MUX mode for MC8785V / AC885E

/ C885

1.6 Apr 2008 - Added MC5727.

- Removed AC597U.

Mini Card / AirCard / Compass USB Driver Developer’s Guide

6 Proprietary and Confidential 2130634

1.8 Sep 2008 - Changed document title (removed ‘Embedded Module’, added ‘Compass’

- Added MC8790, AC8790V, C597, C888

- Reorganized and updated Table 1-1, “Devices described in this guide,” on

page 9

- Updated Mux, Non-Mux, and Hybrid-Mux sections in Chapter 2 to reflect

details of new devices, including NMEA and Mass Storage.

- Added Mass Storage section

- Split and updated USB descriptor information into multiple tables in

Appendix A.

1.9 Sep 2008 - Added MC8791V and MC8792V

Revision

number

Release

date

Changes

Rev 1.9 Sep.08 Proprietary and Confidential 7

Table of Contents

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Document organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Related documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

USB architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

USB standards compliance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Supported driver architectures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Non-MUX (non-multiplexing) mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

MUX (multiplexing) mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Hybrid-MUX (Hybrid multiplexing) mode . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Activating / Deactivating MUX mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

USB-standard Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

USB Interrupt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

AT/PPP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

HIP (Host Interface Protocol) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

CnS (Control and Status). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

DM (QUALCOMM Diagnostic Monitoring) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

NMEA (National Marine Electronics Association) . . . . . . . . . . . . . . . . . . . . . . 36

Data 1, Data 2, Data 3 (Additional PPP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Mass Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

USB descriptors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Vendor-specific commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57

Command availability. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Mini Card / AirCard / Compass USB Driver Developer’s Guide

8 Proprietary and Confidential 2130634

Set Device Power State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Set Mode Non-MUX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Set Mode MUX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Get Mode MUX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Get NDIS Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Get NDIS Preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Get Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Set Mode NMEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Get Mode NMEA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Set Host Power State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Get TRU-Install Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Set TRU-Install Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Supported CDC USB commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

1

Rev 1.9 Sep.08 Proprietary and Confidential 9

1: Introduction

SierraWirelessmanufacturesseveralembeddedmodules,PC

Cards,ExpressCards,andUSBmodems.Eachofthesedevices

includesaUSBinterfaceforcommunicationwithahost

device.TheUSBinterfaceisbasedonaQUALCOMMchipset.

Table 1-1: Devices described in this guide

Network Device Device

Type

a

QUALCOMM

chipset

Standards

CDMA

AC595

PC MSM6800 IS-95A / CDMA 1X

1xEV-DO Rev-0 / Rev-A

AC595U

U

AC597E

E MSM6800A

C597

U

MC5725

MC5725V

MC MSM6800

MC5727

MC MSM6800A

GSM

AC875

PC MSM6280 GSM / GPRS / EDGE /

W-CDMA / HSDPA

AC875U

U

AC880

PC MSM7200

MSM7201

GSM / GPRS / EDGE /

W-CDMA / HSDPA /

HSUPA

AC880E

E

AC880U

U

AC881

PC

AC881U

U

C885

U MSM7201A

C888

U MSM6290

MC8775

MC8775V

MC MSM6280 GSM / GPRS / EDGE /

W-CDMA / HSDPA

MC8780

MC8781

MC MSM7200

MSM7201

GSM / GPRS / EDGE /

W-CDMA / HSDPA /

HSUPA

MC8785V

MC MSM7201A

MC8790

MC8790V

MC8791V

MC8792V

MC MSM6290

a. MC — Mini Card (embedded module); PC — PC Card; E — PC ExpressCard; U — USB modem

Mini Card / AirCard / Compass USB Driver Developer’s Guide

10 Proprietary and Confidential 2130634

Whereapplicablethroughoutthisguide,devicesarereferred

toindividually,orasgroupssharingcommondevicecharac

‐

teristics:

• MC572X=MC5725/MC5725V/MC5727

• MC87XX=MC8775/MC8775V/MC8780/MC8781/

MC8785V/M C8790/MC8790V/MC8791V/MC8792V

• AC59X=AC595/AC595U/AC597E

• AC8XX=AC875/AC875U/AC880/AC880E/AC880U/

AC881/AC881U

• C59X=C597

• C8XX=C885/C888

Purpose of this guide

Note: Sierra Wireless provides

drivers and a connection

manager application (Watcher



)

for Windows

2000, Windows XP

and Windows Vista



.

Thisguideisintendedforusewhendesigningnon‐Windows

driversforthesemodules.Itdescribesthefollowinginfor

‐

mation:

• Services(protocols)availableovertheUSBconnection(AT/

PPP,HCnSIP,CnS,DM,NMEA,Massstorage)

• ThephysicalUSBinterface(deviceandendpoint

descriptors)

• Supporteddriverarchitectures(non‐MUXmode,MUX

mode,Hybrid‐MUXmode)

• CommandsusedovertheUSBinterfacetocontrolthe

module’sstate

Document organization

Thisguideincludesthefollowingsections:

• Introduction(thissection)

• USB architecture

Describesthephysicalinterfaceandsupporteddriverarchi‐

tectures.

• Services

Describesavailabledatatransferservices(protocols).

• Appendix A USB descriptors

Providesdeviceandendpointdescriptorinformation.

• Appendix B Vendor-specific commands

Describescommandsthatcanbeusedtocontrolthemodule’s

state.

• Appendix C Supported CDC USB commands

DescribessupportforCDCUSBcommands,requests,and

notifications.

Introduction

Rev 1.9 Sep.08 Proprietary and Confidential 11

Related documents

Relatedandsupportingdocumentsandproductsinclude:

Table 1-2: Related documentation

Document title Related content

UMTS Modems Supported AT

Commands (Document

2130617)

This document lists the standard AT commands supported

by the MC87XX, AC8XX, and C885. For descriptions of

standard AT commands, see AT Command Set for User

Equipment (UE) (Release 6).

AT Command Set for User

Equipment (UE) (Release 6)

This document lists standard AT commands—the AC59X,

C59X, and MC572X support many of these commands.

CDMA 1xEV-DO CnS Reference

(Document 2130754)

This document describes the CnS (Control and Status)

messages that are available for use with the AC59X,

C59X, and MC572X.

Extended AT Command

Reference (Document 2130621)

This document describes proprietary AT commands for the

AC59X, C59X, and MC572X. For MC87XX-specific

commands, see MC87xx Modem Extended AT Command

Reference (Document 2130616).

MC87xx Modem CnS Reference

(Document 2130602)

This document describes the CnS messages that are

available for use with the MC87XX.

MC87xx Modem Extended AT

Command Reference

(Document 2130616)

This document describes proprietary AT commands for the

MC87XX. For MC5725 / MC5725V / MC5727-specific

commands, see the Extended AT Command Reference

(Document 2130621).

Terminal Equipment to User

Equipment (TE-UE) multiplexer

protocol (Release 6)

This 3GPP technical specification describes the 27.010

multiplexer protocol.

The document (3GPP TS 27.010) can be downloaded from

www.3gpp.org.

Universal Serial Bus Class

Definitions for Communication

Devices, Version 1.1

This specification can be downloaded from www.usb.org.

Universal Serial Bus

Specification, Rev 2.0

This specification can be downloaded from www.usb.org.

Mini Card / AirCard / Compass USB Driver Developer’s Guide

12 Proprietary and Confidential 2130634

2

Rev 1.9 Sep.08 Proprietary and Confidential 13

2: USB architecture

Thischapterdescribessupporteddriverarchitecturesfordata

transfer,andthephysicalUS Binterfaceforeacharchitecture.

USB standards compliance

TheAC59X,AC8XX,C59X,C8XX,MC572X,andMC87XX

complywithUSB2.0standards,includingthefollowing:

• USBslaveonly

• USB2.0(backwardscompatiblewithUSB1.1)

• Full‐speed12Mb/sandlow‐speed1.5Mb/sdatatransfer

rates.

• High‐speed480Mb/sissupportedbyC8XX,MC8785V,

MC8790,MC8790V,MC8791V,andMC8792V.

• StandardUSBflowcontrol

• StandardUSBpowermanagement—SuspendstheUSBbus

whenitisidle,toconservepower.

ThearchitectureforthesedevicesisderivedfromtheAbstract

ControlModel(ACM)described inthe UniversalSerialBus

ClassDefinitionsforCommunicationDevices,Version1.1(CDC)

specification.

Tobestsupportadvancedpowermanagement,amodified

(non‐composite)endpoint/interfacemodelcombinesthe

CommunicationandDataInterfacepipeswithtwoproprietary

pipes(HIPandNMEA/Data1)intoonevendor‐specific

interface.

Note: It is assumed that you

have a good understanding of

USB principles and architecture.

For detailed information, refer to

Universal Serial Bus Class

Definitions for Communication

Devices, Version 1.1. This (and

other resources) can be

downloaded from www.usb.org.

Note: These devices do not claim any CDC classes in the descriptors

and do not support functional descriptors. As a result, these devices

are not normally compatible with native CDC-ACM drivers.

Supported driver architectures

Themodulessupporttwoorthreedriverarchitectures:

• Non‐multiplexing(Non‐MUX)mode‐Supportedservice

channels(see

Services,page33)arecarriedovermultiple

setsofendpoints.

• Multiplexing(MUX)mode‐Allservicechannelsarecarried

overasinglesetofendpoints,andifsupported,Mass

Storageisimplementedoverasecondsetofendpoints.

• Hybrid‐MUXmode‐Data/ATservicesarecarriedover

onepairofendpoints;theotherservicesaremultiplexed

Mini Card / AirCard / Compass USB Driver Developer’s Guide

14 Proprietary and Confidential 2130634

overasecondpairofendpoints.Ifsupported,MassStorage

isimplementedoverathirdsetofendpoints.

USB endpoints

USBendpointsareuniquelyaddressableportionsofaUSB

deviceusedtotransferinformationbetweenthehostand

module.Eachdefinedendpointisaunidirectionalli nkfrom

themodemtothehost(IN)orfromthehosttothemodem

(OUT).

Note: The logical endpoint

numbers in this guide are used

for ease of reading. When

developing your drivers, you

must use the actual, physical,

endpoints.

EachphysicalendpointisdefinedinUSB descriptors(page39)

andisreferredtointhisdocumentbyalogicalendpoint

number(forexample,endpoint‘2’)anddirection(INorOUT).

Wherebidirectionalcommunicationisrequiredforaspecific

dataservice,twoendpointsareused:

• AC8XX/MC8775/MC8775V/MC87 80/MC8781:These

endpointsusethesamelogicalendpointnumber.For

example,whereendpoints2‐INand2‐OUTareusedfor

bidirectionaltransferofATcommandsbetweenthehost

andmodule,theseendpointshavethesamelogical

endpointnumber(2)anddifferentphysicalendpoint

numbers(INis0x82andOUTis

0x02).

• C8XX/MC8785V/MC8790/MC8790V/MC8791V/MC8792V:

Dependingontheservice,theseendpointsmayormaynot

havethesamelogicalendpointnumber.Forexample,

endpoints3‐INand3‐OUTareusedfortransferofNMEA

commands,while5‐INand4‐OUTareusedfortransferof

ATcommands.

Non-MUX (non-multiplexing) mode

Note: The module always starts

in non-MUX mode – the host can

then choose to put it in MUX

mode or take it out.

Thearchitectureusedfornon‐MUXmodedependsonthe

moduletype:

• AC59X/AC8XX/C59X/MC572X/MC87 75/MC8775V/

MC8780/MC 8781—Non‐MUXmodeisaproprietarynon‐

compositearchitectureinwhicheachservicetypeis

enabledoverspecificUSBendpoints:

· AC59X/C59X/MC572X—Table2‐1andFigure2‐1

· AC8XX/MC8775/MC8775V/MC8780/MC8781—Table2‐2

andFigure2‐2

• C8XX/MC8785V/MC8790/MC8790V/MC8791V/

MC8792V—Non‐MUXmodeisacompositearchitecturein

whicheachservicetypeisenabledoveritsowninterface.

See

Table2‐3andFigure2‐3.

USB architecture

Rev 1.9 Sep.08 Proprietary and Confidential 15

Table 2-1: AC59X / C59X / MC572X—Non-MUX mode endpoints

Endpoint Supported service

0 (Control)

Management element

1 IN (Interrupt)

Notification element

Note: The interrupt line (1-IN) is used to flow control the

host from the modem over the AT/PPP channel only.

2 IN / OUT (Bulk)

Primary data channel (AT/PPP)

4 IN / OUT (Bulk)

HIP (carrying CnS and DM)

Note: If required, OEMs can consult with Sierra Wireless

to discuss how to change the default data service.

Possible service types are DM, HIP (carrying CnS), and

HIP (carrying CnS and DM).

5 IN / OUT (Bulk)

NMEA

• Enabled by default only on MC5725 / MC5725V

/ MC5727.

6 IN / 7 OUT (Bulk) —

Interface 1

Note: TRU-Install mode

uses Interface 0.

(C59X only) Mass storage (when enabled)

Note: You can access the micro-SD device in both

TRU-Install mode (Interface

0) and modem mode

(Interface

1). In TRU-Install mode, the TRU-Install

CDROM and SD disk are presented as two logical unit

numbers (LUNs).

Mini Card / AirCard / Compass USB Driver Developer’s Guide

16 Proprietary and Confidential 2130634

Figure 2-1: AC59X / C59X / MC572X—Non-MUX mode endpoints

NMEA

HIP (carrying CnS),

HIP (carrying CnS and DM), or

DM

AT

AT and PPP

0

Interface 0

1 IN

USB

interface

The host-side driver

accepts and interprets

incoming and

outgoing data for each

supported service

(AT, HIP, DM, NMEA).

Each service uses a

different set of USB

endpoints.

Host Device

AC59X / C59X / MC572X

Management

Element

endpoints

AT

NMEA

Interface 0

2 IN

2 OUT

Interface 0

4 IN

4 OUT

Interface 0

5 IN

5 OUT

Note: The default data service can

be changed if required. Contact

Sierra Wireless for details.

Control

Notification

Element

Interrupt

Note: Used to flow-control the host

over the AT channel only.

HIP (carrying CnS),

HIP (carrying CnS

and DM), or

DM

Note: The factory

default setting for the

service on endpoint 4 is

HIP (CnS & DM).

MS (Mass Storage)

MS Driver

(C597 only)

Interface 1

6 IN

7 OUT

Note: When in TRU-Install

mode, the micro-SD

device uses Interface 0

(same endpoints).

USB architecture

Rev 1.9 Sep.08 Proprietary and Confidential 17

Table 2-2: AC8XX / MC8775–MC8781 — Non-MUX mode endpoints

Endpoint Supported service

0 (Control)

Management element

1 IN (Interrupt)

Notification element

Interrupt used by the module to flow control the host

over each supported data channel (AT, HIP, Data 1).

2 IN / OUT (Bulk)

Data 1 (PPP) (Primary PPP context)

Also supports AT commands to set up the PPP

context.

3 IN / OUT (Bulk)

(MSM7201-based modules only)

NMEA

Supported on AC880 / AC880E /AC880U / AC881 /

AC881U / MC8780 / MC8781 if all of the following are

true:

• Firmware revision F1_2_x_x or higher is used

• GPS is enabled

• Modem is not in boot-and-hold mode

4 IN / OUT (Bulk)

HIP (CnS and QUALCOMM DM diagnostics)

5 IN / OUT (Bulk)

AT (AT / PPP) (Primary AT context)

Note: You can customize port mappings in non-MUX mode using the

AT!NVPORTMAP command. For details, see MC87xx Modem Extended AT

Command Reference (Document 2130616).

Note: AirCard modems may need to be reconfigured using AT!NVPORTMAP. For

non-MUX mode, the endpoint configuration shown here is recommended.

Mini Card / AirCard / Compass USB Driver Developer’s Guide

18 Proprietary and Confidential 2130634

Figure 2-2: AC8XX / MC8775–MC8781 — Non-MUX mode endpoints

AT (AT / PPP)

(Primary AT context)

HIP

(carrying CnS / DM)

Control

Data 1 (PPP)

(Primary PPP context)

(Also supports AT commands to set

up the PPP context)

0

2 IN

USB

interface

The host-side driver

accepts and interprets

incoming and outgoing

data for each supported

service (AT, HIP, Data 1).

Each service uses a

different set of USB

endpoints.

Host Device

AC8XX / MC8775-MC8781

endpoints

Data 1

HIP

(carrying CnS / DM)

AT

2 OUT

4 IN

4 OUT

5 IN

5 OUT

1 IN

Interrupt

Note:

Endpoint 1-IN is an

interrupt endpoint used

by the modem to flow-

control the host for each

of the channels (AT,

HIP, Data 1, NMEA).

Note: Used to flow-control the host

over each channel (AT, HIP, Data 1).

Management

Element

Notification

Element

(MC8780 / MC8781 / AC880 / AC880E /

AC880U / AC881 / AC881U)

NMEA

Only if all of the following are true:

- F/W revision F1_2_xx or higher,

- GPS is enabled

- Not in boot-and-hold mode

3 IN

3 OUT

NMEA

USB architecture

Rev 1.9 Sep.08 Proprietary and Confidential 19

Table 2-3: C8XX / MC8785V to MC8792V — Non-MUX mode

endpoints

Endpoint Supported service

0 (Control)

Management element

1 IN / OUT (Bulk) —

Interface 0

HIP

2 IN / OUT (Bulk) —

Interface 1

QUALCOMM DM diagnostics

3 IN / OUT (Bulk) —

Interface 2

NMEA

4 IN (Interrupt) —

Interface 3

Notification element

Interrupt used by the module to flow control the host

over each supported data channel.

5 IN / 4 OUT (Bulk) —

Interface 3

AT

6 IN (Interrupt) —

Interface 4

Notification element

Interrupt used by the module to flow control the host

over each supported data channel.

7 IN / 5 OUT (Bulk) —

Interface 4

Primary data channel (PDP context 1)

8 IN (Interrupt) —

Interface 5

Notification element

Interrupt used by the module to flow control the host

over each supported data channel.

9 IN / 6 OUT (Bulk) —

Interface 5

Secondary data channel (PDP context 2)

10 IN (Interrupt) —

Interface 6

Notification element

Interrupt used by the module to flow control the host

over each supported data channel.

11 IN / 7 OUT (Bulk) —

Interface 6

Tertiary data channel (PDP context 3)

Mini Card / AirCard / Compass USB Driver Developer’s Guide

20 Proprietary and Confidential 2130634

12 IN / 8 OUT (Bulk) —

Interface 7

Note: TRU-Install mode

uses Interface 0 (endpoints

1-IN and 1-OUT).

(C8XX only) Mass storage (when enabled)

Note: You can access the micro-SD device in TRU-Install

mode (Interface 0) and modem mode (Interface 7). In

TRU-Install mode, the TRU-Install CDROM and SD disk

are presented as two logical unit numbers (LUNs).

Note: In these products, each COM port has its own interface and their endpoint

assignments are found in the USB interface descriptor. Do not use the

AT!NVPORTMAP command with these products.

Table 2-3: C8XX / MC8785V to MC8792V — Non-MUX mode endpoints

(Continued)

Endpoint Supported service

Page is loading ...

Sierra Wireless AirPrime MC5727 Developer's Manual

Related papers

Other documents