Sierra Wireless AC597 Developer's Manual

Type
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 Duetothenatureofwirelesscommunications,transmission
andreceptionofdatacanneverbeguaranteed.Datamaybe
delayed,corrupted(i.e.,haveerrors)orbetotallylost.
Althoughsignificantdelaysorlossesofdataarerarewhen
wirelessdevicessuchastheSierraWirelessmodemareusedin
anormal
mannerwithawellconstructednetwork,theSierra
Wirelessmodemshouldnotbeusedinsituationswherefailure
totransmitorreceivedatacouldresultindamageofanykind
totheuseroranyotherparty,includingbutnotlimitedto
personalinjury,death,orlossofproperty.Sierra
Wireless
acceptsnoresponsibilityfordamagesofanykindresulting
fromdelaysorerrorsindatatransmittedorreceivedusingthe
SierraWirelessmodem,orforfailureoftheSierraWireless
modemtotransmitorreceivesuchdata.
Safety and Hazards DonotoperatetheSierraWirelessmodeminareaswhere
blastingisinprogress,whereexplosiveatmospheresmaybe
present,nearmedicalequipment,nearlifesupportequipment,
oranyequipmentwhichmaybesusceptibletoanyformof
radiointerference.Insuchareas,theSierraWirelessmodem
MUSTBEPOWEREDOFF
.TheSierraWirelessmodemcan
transmitsignalsthatcouldinterferewiththisequipment.
DonotoperatetheSierraWirelessmodeminanyaircraft,
whethertheaircraftisonthegroundorinflight.Inaircraft,the
SierraWirelessmodemMUSTBEPOWE REDOFF.When
operating,theSierraWirelessmodemcantransmitsignalsthat
couldinterferewithvariousonboardsystems.
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.
Thedriveroroperatorofanyvehicleshouldnotoperatethe
SierraWirelessmodemwhileincontrolofavehicle.Doingso
willdetractfromthedriveroroperatorʹscontrolandoperation
ofthatvehicle.In somestatesandprovinces, operatingsuch
communicationsdeviceswhileincontrolofavehicle
isan
offence.
Limitation of
Liability
Theinformationinthismanualissubjecttochangewithout
noticeanddoesnotrepresentacommitmentonthepartof
SierraWireless.SIERRAWIRELESSANDITSAFFILIATES
SPECIFICALLYDISCLAIMLIABILIT YFORANYANDALL
DIRECT,INDIRECT,SPECIAL,GENERAL,INCIDENTAL,
CONSEQUENTIAL,PUNITIVEOREXEMPLARYDA MA GES
INCLUDING,BUTNOTLIMITEDTO,LOSS
OFPROFITSOR
Mini Card / AirCard / Compass USB Driver Developer’s Guide
4 Proprietary and Confidential 2130634
REVENUEORANTICIPATEDPROFITSORREVENUE
ARISINGOUTOFTHEUSEORINABILITYTOUSEANY
SIERRAWIRELESSPRODUCT,EVENIFSIERRAWIRELESS
AND/ORITSAFFILIATESHASBEENADVISEDOFTHE
POSSIBILITYOFSUCHDAMAGESORTHEYARE
FORESEEABLEORFORCLAIMSBYANYTHIRDPARTY.
Notwithstandingtheforegoing,innoeventshallSierra
Wirelessand/oritsaffiliatesaggregateliabilityarisingunderor
inconnectionwiththeSierraWirelessproduct,regardlessof
thenumberofevents,occurrences,orclaimsgivingriseto
liability,beinexcessofthepricepaidbythepurchaserforthe
SierraWireless
product.
Patents Portionsofthisproductmay becoveredbysomeorallofthe
followingUSpatents:
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
andotherpatentspending.
Thisproductincludes
technologylicensedfrom:
LicensedbyQUALCOMMIncorporatedunderoneormoreof
thefollowingUnitedStatespatentsand/ortheircounterparts
inothernations:
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
ManufacturedorsoldbySierraWirelessoritslicenseesunder
oneormorepatentslicensedfromInterDigitalGroup.
Copyright ©2008SierraWireless.Allrightsreserved.
Trademarks AirCard
®
and“H eartoftheWirelessMachine
®
areregistered
trademarksofSierraWireless.Watcher
®
isatrademarkof
SierraWireless,registeredintheEuropeanCommunity.
SierraWireless,theSierraWirelesslogo,theredwavedesign,
andtheredtippedantennaaretrademarksofSierraWireless.
QUALCOMM
®
3G
Preface
Rev 1.9 Sep.08 Proprietary and Confidential 5
Windows
®
isaregisteredtrademarkofMicrosoftCorporation.
QUALCOMM
®
isaregisteredtrademarkofQUALCOMM
Incorporated.Usedunderlicense.
Othertrademarksarethepropertyoftherespectiveowners.
Contact
Information
Consultourwebsiteforuptodateproductdescriptions,
documentation,applicationnotes,firmwareupgrades,trouble
shootingtips,andpressreleases:
www.sierrawireless.com
Revision History
Sales Desk: Phone: 1-604-232-1488
Hours: 8:00 AM to 5:00 PM Pacific Time
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
SierraWirelessmanufacturesseveralembeddedmodules,PC
Cards,ExpressCards,andUSBmodems.Eachofthesedevices
includesaUSBinterfaceforcommunicationwithahost
device.TheUSBinterfaceisbasedonaQUALCOMMchipset.
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
Whereapplicablethroughoutthisguide,devicesarereferred
toindividually,orasgroupssharingcommondevicecharac
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
.
ThisguideisintendedforusewhendesigningnonWindows
driversforthesemodules.Itdescribesthefollowinginfor
mation:
Services(protocols)availableovertheUSBconnection(AT/
PPP,HCnSIP,CnS,DM,NMEA,Massstorage)
ThephysicalUSBinterface(deviceandendpoint
descriptors)
Supporteddriverarchitectures(nonMUXmode,MUX
mode,HybridMUXmode)
CommandsusedovertheUSBinterfacetocontrolthe
module’sstate
Document organization
Thisguideincludesthefollowingsections:
Introduction(thissection)
USB architecture
Describesthephysicalinterfaceandsupporteddriverarchi
tectures.
Services
Describesavailabledatatransferservices(protocols).
Appendix A USB descriptors
Providesdeviceandendpointdescriptorinformation.
Appendix B Vendor-specific commands
Describescommandsthatcanbeusedtocontrolthemodule’s
state.
Appendix C Supported CDC USB commands
DescribessupportforCDCUSBcommands,requests,and
notifications.
Introduction
Rev 1.9 Sep.08 Proprietary and Confidential 11
Related documents
Relatedandsupportingdocumentsandproductsinclude:
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
Thischapterdescribessupporteddriverarchitecturesfordata
transfer,andthephysicalUS Binterfaceforeacharchitecture.
USB standards compliance
TheAC59X,AC8XX,C59X,C8XX,MC572X,andMC87XX
complywithUSB2.0standards,includingthefollowing:
USBslaveonly
USB2.0(backwardscompatiblewithUSB1.1)
Fullspeed12Mb/sandlowspeed1.5Mb/sdatatransfer
rates.
Highspeed480Mb/sissupportedbyC8XX,MC8785V,
MC8790,MC8790V,MC8791V,andMC8792V.
StandardUSBflowcontrol
StandardUSBpowermanagement—SuspendstheUSBbus
whenitisidle,toconservepower.
ThearchitectureforthesedevicesisderivedfromtheAbstract
ControlModel(ACM)described inthe UniversalSerialBus
ClassDefinitionsforCommunicationDevices,Version1.1(CDC)
specification.
Tobestsupportadvancedpowermanagement,amodified
(noncomposite)endpoint/interfacemodelcombinesthe
CommunicationandDataInterfacepipeswithtwoproprietary
pipes(HIPandNMEA/Data1)intoonevendorspecific
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
Themodulessupporttwoorthreedriverarchitectures:
Nonmultiplexing(NonMUX)mode‐Supportedservice
channels(see
Services,page33)arecarriedovermultiple
setsofendpoints.
Multiplexing(MUX)mode‐Allservicechannelsarecarried
overasinglesetofendpoints,andifsupported,Mass
Storageisimplementedoverasecondsetofendpoints.
HybridMUXmode‐Data/ATservicesarecarriedover
onepairofendpoints;theotherservicesaremultiplexed
Mini Card / AirCard / Compass USB Driver Developer’s Guide
14 Proprietary and Confidential 2130634
overasecondpairofendpoints.Ifsupported,MassStorage
isimplementedoverathirdsetofendpoints.
USB endpoints
USBendpointsareuniquelyaddressableportionsofaUSB
deviceusedtotransferinformationbetweenthehostand
module.Eachdefinedendpointisaunidirectionalli nkfrom
themodemtothehost(IN)orfromthehosttothemodem
(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.
EachphysicalendpointisdefinedinUSB descriptors(page39)
andisreferredtointhisdocumentbyalogicalendpoint
number(forexample,endpoint‘2’)anddirection(INorOUT).
Wherebidirectionalcommunicationisrequiredforaspecific
dataservice,twoendpointsareused:
AC8XX/MC8775/MC8775V/MC87 80/MC8781:These
endpointsusethesamelogicalendpointnumber.For
example,whereendpoints2INand2OUTareusedfor
bidirectionaltransferofATcommandsbetweenthehost
andmodule,theseendpointshavethesamelogical
endpointnumber(2)anddifferentphysicalendpoint
numbers(INis0x82andOUTis
0x02).
C8XX/MC8785V/MC8790/MC8790V/MC8791V/MC8792V:
Dependingontheservice,theseendpointsmayormaynot
havethesamelogicalendpointnumber.Forexample,
endpoints3INand3OUTareusedfortransferofNMEA
commands,while5INand4OUTareusedfortransferof
ATcommands.
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.
ThearchitectureusedfornonMUXmodedependsonthe
moduletype:
AC59X/AC8XX/C59X/MC572X/MC87 75/MC8775V/
MC8780/MC 8781NonMUXmodeisaproprietarynon
compositearchitectureinwhicheachservicetypeis
enabledoverspecificUSBendpoints:
· AC59X/C59X/MC572XTable21andFigure21
· AC8XX/MC8775/MC8775V/MC8780/MC8781Table22
andFigure22
C8XX/MC8785V/MC8790/MC8790V/MC8791V/
MC8792V—NonMUXmodeisacompositearchitecturein
whicheachservicetypeisenabledoveritsowninterface.
See
Table23andFigure23.
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 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40
  • Page 41 41
  • Page 42 42
  • Page 43 43
  • Page 44 44
  • Page 45 45
  • Page 46 46
  • Page 47 47
  • Page 48 48
  • Page 49 49
  • Page 50 50
  • Page 51 51
  • Page 52 52
  • Page 53 53
  • Page 54 54
  • Page 55 55
  • Page 56 56
  • Page 57 57
  • Page 58 58
  • Page 59 59
  • Page 60 60
  • Page 61 61
  • Page 62 62
  • Page 63 63
  • Page 64 64
  • Page 65 65
  • Page 66 66
  • Page 67 67
  • Page 68 68
  • Page 69 69
  • Page 70 70
  • Page 71 71
  • Page 72 72
  • Page 73 73
  • Page 74 74

Sierra Wireless AC597 Developer's Manual

Type
Developer's Manual

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI