Control and status protocol between a data device and a wireless communication unit

FIELD OF THE INVENTION

The present invention relates to wireless communication units, such as modems, for data devices. In particular, the present invention relates to communication protocols between a data device and a wireless communication unit.

BACKGROUND OF THE INVENTION

Typically, a host unit controls the operation of a modem unit. The host unit will obtain status information from the modem unit and use this status information to determine the best way to control the modem unit. Received signal strength and similar information is provided by the modem unit to the host unit. Additionally, data to transmit is sent from the host unit to the modem unit and data received by the modem unit needs to be sent from the modem unit to the host unit.

The data sent between the modem unit and the host unit can be relatively large. In some circumstances, this blocks the ability of control and status information to be transferred between the host unit and the modem unit.

It is desired to have an improved protocol system for sending messages between a host unit and a modem unit.

Document <patcit id="pcit0001" dnum="WO0213593A2"><text>WO 02/13593 A2</text></patcit> discloses a wireless radio frequency modem that plugs into a host computer and shares a central processing unit and a memory with the host computer, wherein principal modem functions are distributed between the modem and the host computer.

SUMMARY OF THE INVENTION

The present invention uses a host interface protocol which allows for the multiplexing of data signals with control and status signals, debugging information and other commands. The host interface protocol preferably includes a length field, a message ID field indicating what type of message is enclosed, and an optional payload field.

Control and status protocols can be transferred within the optional payload field. A separate control and status protocol is used to transfer the control and status messages.

One embodiment of the present invention is a system including a host unit with a processor and wireless communication unit, such as a modem unit, including a transceiver and first-in-first-out-buffers (FIFO). Communication between the host unit and the wireless communication unit uses a host interface protocol. The host interface protocol defines a message header with a length field and a message ID field. The message ID field allows multiplexing between data stream transfers and status transfers for information sent to the host and wireless communication units. A control and status protocol is used for control and status message transfers between the host and the wireless communication unit, control and status messages being wrapped within the host interface protocol messages.

Further embodiments are disclosed in the appended claims.

BRIEF DESCRIPTION OF THE DRAWING FIGURES

<ul id="ul0001" list-style="none"><li><figref idref="f0001">Fig. 1</figref> is a diagram illustrating a host unit and a wireless communication unit for use with the system of the present invention.</li><li><figref idref="f0001">Fig. 2</figref> is a diagram that illustrates portions of the protocol stack for data transfers between the host unit and the wireless communication unit.</li><li><figref idref="f0002">Fig. 3</figref> is a diagram illustrating the interrelation of the control and status messages and post-interface protocol messages.</li><li><figref idref="f0003">Fig. 4</figref> is a diagram of prior-art data transmitted between host unit and wireless communication unit.</li><li><figref idref="f0003">Figs. 5A and 5B</figref> are diagrams illustrating a host interface protocol that allows for multiplexing data for transmission as well as the control and status messages.</li><li><figref idref="f0004">Fig. 6A</figref> is a diagram that illustrates host interface protocol messages.</li><li><figref idref="f0004">Fig. 6B</figref> is a diagram that illustrates a header for host interface protocol messages.</li><li><figref idref="f0005">Fig. 7</figref> is a diagram that illustrates the transfer of control and status messages between the host unit and the wireless communication unit.</li><li><figref idref="f0005">Fig. 8</figref> is a diagram that illustrates the control and status message protocol for one embodiment of the present invention.</li><li><figref idref="f0006">Fig. 9</figref> is a diagram that illustrates control and status message transfers between the wireless communication unit and the host for one embodiment of the present invention.</li><li><figref idref="f0007">Fig. 10</figref> is a diagram that illustrates the transfer of control and status messages between the host and the wireless communication unit for one embodiment of the present invention.</li></ul>

DETAILED DESCRIPTION

<figref idref="f0001">Fig. 1</figref> is a diagram that illustrates the interconnection between a host unit 22 and a wireless communication unit 24 of one embodiment of the present invention. The host unit 22 can be a portable or a laptop computer, a personal digital assistant (PDA), or any other type of data device. The wireless communication in one embodiment is a modem. The wireless communication unit 24 is preferably a removable card modem unit, such as a PCMCIA card.

The host unit 22 preferably includes a processor 26, and a protocol stack software 30 which allows the processor 26 to implement the protocol stack of the system of the present invention. The wireless communication unit 24 includes a transmitter (TX) FIFO buffer 32 for storing data from the host unit 22, a receiver (RX) FIFO buffer 33 for storing data to send to the host unit 22, a processor 34, a transceiver 36 and protocol stack software 38 that allows it to implement the protocol stack of the system of the present invention. The system 20 including the host unit 22 and the wireless communication unit 24 can be used for transmitting data over a wireless network, and thus can allow the host unit 22 to send E-mail messages or connect to the Internet.

<figref idref="f0001">Fig. 2</figref> is a diagram that illustrates a portion of the protocol stack for message transmission between the host unit 22 and the wireless communication unit 24 shown in <figref idref="f0001">Fig 1</figref>. A data-link protocol 40 concerns the data-link between the host unit and the wireless communication unit. The data-link protocol provides framing of datagrams. On top of the data-link protocol is the host interface protocol 42 which is described below. Running on top of the host interface protocol is the control and status protocol 44, also described below. Also running on the host interface protocol are any data transfer protocols 45 which allow for the transfer of data to be transmitted over the wireless communication unit or from the wireless communication unit to the host unit. Other protocols 46 can also be run on top of the host interface protocol 42. As will be discussed below, the ability of the host interface protocol to multiplex between data transfers and control and status information is quite useful.

<figref idref="f0002">Fig. 3</figref> is a diagram that illustrates the transfer of control and status messages within the host interface protocol message. At the wireless communication unit, a control and status message is constructed which is wrapped within a host interface protocol message. Depending upon the system layout, different data-link layers are used for the message transfer. At the host unit, the host interface protocol message is examined and, in a preferred embodiment, an application programming interface (API) running the protocol stack will extract the control and status packet from the host interface protocol packet.

<figref idref="f0003">Figs. 4 and 5A-5B</figref> illustrate the advantage of having a host interface protocol to multiplex between data transfers and control and status transfers. <figref idref="f0003">Fig. 4</figref> shows data 50 for transmission. Such data can be relatively long and prevent any control and status signals to be sent while the data is being transferred. <figref idref="f0003">Fig. 5A</figref> shows the use of the host interface protocol such that the data for transmission is broken up. Some of the host interface protocol messages include the data for transmission but others can include the control and status information in a control and status protocol message. This allows for control and status information to be multiplexed within larger data transmissions between the host unit and the wireless communication unit. The example shown in <figref idref="f0003">Fig. 5A</figref> illustrates a host interface protocol message 54 including the control and status protocol message interspersed between host interface protocol messages 52 and 56 which contain data for transmission.

The host interface protocol does not need to have a payload but can contain some signaling information within the header itself. This is shown in <figref idref="f0003">Fig. 5B</figref>, in which the payloadless header 60 is positioned between the host interface protocol message 58 and host interface protocol message 62 which contain data for transmission.

<figref idref="f0004">Fig. 6A</figref> illustrates a host interface protocol message with the message header 64 and optional message payload 66. <figref idref="f0004">Fig. 6B</figref> illustrates the message header with the message payload length 64a, pad-byte bit flag 64b message identifier 64c, message specific parameter 64d and optional pad-byte containing random data 64c. Note that the message identified 64c is quite useful because it allows for the multiplexing between data transfers and control and status transfers, as described above.

A variety of different messages can be exchanged between the host unit and the wireless communication unit. As will be described, the host interface protocol allows for the multiplexing between over-the-air data, wireless communication debugging and flash software downloads, and other types of messages. The message payload length field 64a helps identify the memory block buffer requirements to store the message. This length field is also useful to support alternative data length message transfer systems such as direct memory access. The length also helps indicate whether there is an odd or even number of bytes communicated in the message payload. In one embodiment, the maximum payload length for the host interface protocol is 2000 bytes. The pad-byte flag indicates whether any padding bytes are put in front of the message payload. If the pad-byte flag is set, then the message has padding bytes and the message payload length includes the length of the padding bytes and the message payload. The message identifier field indicates the message type.

The message specific parameter field indicates a word or line message header. The message type defines the use of this field.

In a preferred example, different message IDs are used in different directions to prevent the echoing of messages across the interface and to aid in software debugging. The message ID header is preferably kept as simple as possible to reduce the complexity of the system. Additionally, the host interface protocol preferably implements a grant request/response mechanism to seek permission prior to sending data, such that flow control can be accommodated over the interface. The host interface protocol also allows for the production of a signal to the host to indicate when the wireless communication unit resets. This simplifies the startup procedures on both sides of the interface. Additionally, the host interface protocol preferably implements a method of discarding stale messages that might be present in the FIFO buffers after a reset or a crash. The system also provides a mechanism to report error messages from the wireless communication device to the host. The host interface protocol also allows for interactive communication between the wireless communication unit and the host unit. Additionally, when the data-link layer uses an interface of high reliability (such as a PCMCIA interface), the host interface protocol can be simplified such that it reduces the processing burden on the microprocessor. The host interface protocol also preferably allows for feedback during the flash software upgrade.

In one embodiment there are three fundamental types of messages transferred between the host unit and the wireless communication unit indicated by the message ID field. These three fundamental types of messages are requests, responses, and indications.

A request message provides a means for the host to ask the wireless communication unit either to perform an operation or return a value. The wireless communication unit always responds to a request message with a response message. Because of the master/slave relationship between the host unit and the wireless communication unit, the wireless communication unit is not allowed to make requests of the host unit in a preferred embodiment. One and only one response message is sent in answer to each request message. Note that in order to provide full control to the wireless communication unit, a response to a specific request must be provided before a second request of the same type is issued. This effectively provides a stop-and-wait flow control on a per-request basis. If the host never receives a response within a time-out period, this is a failure case and thus the host unit can assume that the wireless communication unit has failed and should be recovered from a restart state.

Response messages are always sent from the wireless communication unit as a reply to the request from the host unit. The format and type of data of the response varies according to the type of response. Responses are not sent unsolicited. Thus, each response is paired with a specific request. In one embodiment, the request message IDs are in the range 00 to 31, and the response message IDs are in the range 64 to 95.

Indication messages provide a means to send unsolicited data from either side of the interface. Indications are used when no reply or return data is required from the receiver. No acknowledgment or reply is sent by the receiver of an indication in a preferred embodiment. The indications can include the over-the-air messages received from the wireless communication unit and sent to the host unit, as well as messages to be sent over the air from the host unit to the wireless communication unit and data passing back and forth between the flash memory. In one embodiment the indication messages ID from the host are in the range 32 to 63; indication message ID sent from the card are in the range 96 to 127.

In one example, the host interface protocol rules are such that if a message is received from either side of the interface containing undefined message ID, it will be discarded. If the maximum size of the message is exceeded, the receiver will discard the entire packet and ignore the message. In a preferred example, the pad-byte flag set will only be used for messages sent from the wireless communication unit to the host unit. The card will discard received reverse-channel data indication messages containing unexpected message sequencing numbers. The card application will ignore all boot loader specific messages. The boot loader will only receive the packets and the protocol if the host has placed the wireless communication unit into a firmware download mode. The boot indication packet can be sent from the host device during startup to provide the host driver with startup information, but it will not wait for or process host messages.

Appendix I included with this specification includes a list of message identifiers.

One example of the messaging supported by the host interface protocol is given below. The boot loader messages allow the loading of firmware onto a flash memory card in the wireless communication unit. The boot loader messages include download start requests, download response, download continuation requests, download continuation responses, download end requests, download end responses, flash program requests, flash program responses, launch fragment indication, and start application indication.

The wireless communication device startup messages include host data-link synchronization indication, data-link synchronization indication, boot information indication, restart indication.

The over-the-air messages include reverse channel grant messages, reverse channel data indications, forward channel data indications.

The control and status messages which can be indicated by a header without payload include system shutdown indications, configuration information requests, configuration information responses, packet session activation requests, packet session activation responses, link status indications, abort indications, wireless communication device control and status indications, host control and status indications, loopback requests, loopback responses, packet data protocol (PDP) context summary requests, PDP context summary responses, host environment indications.

Debugging messages which can be sent include wireless communication device command indications, host command indications, wireless communication device protocol stack indications, host protocol stack indications, wireless communication device AT command indications, host AT command indications, wireless communication device debug log indications, host debug log indications.

Details of the host interface protocol of one embodiment are described within Appendix I.

<figref idref="f0005">Fig. 7</figref> illustrates the control and status packet for a get request and a response to a get request. Note that the application parameter is set the same, and the object ID is set the same.

<figref idref="f0005">Fig. 8</figref> illustrates the control and status packets which are wrapped within the host interface protocol messages in a preferred embodiment of the present invention.

The control and status packet is preferably encapsulated within the host interface protocol. Starting with a control and status message, both the wireless communication unit and the host unit must encapsulate and de-encapsulate the control and status message and then perform any data-link layer framing that is necessary. Two types of data-link layer framing are anticipated, one for Universal Asynchronous Receive-Transmit (UART) communications and another for Network Drive Interface Specification (NDIS) communications. The control and status data communicated in the variable length binary packets all multibyte fields preferably use a network byte order. The control and status packets go into the payload section of the host interface protocol packets, and such are a subtype of the information available on that interface.

The fields of the control and status packet available are shown in <figref idref="f0005">Fig. 8</figref> for one embodiment of the present invention. The control and status packet 70 includes an object ID field 70a, an error flag field 70b, an operation type field 70c, a reserved byte A field 70d, an application parameter field 70e, a reserved byte B field 70f, a length field 70g and a parameter field 70h. The object ID 70a indicates the type of the control and status message. The operation type field 70c indicates the type of operation, request, response notification, and so on. The reserved fields 70d and 70f are reserved for a specific type of use and are set to zero if not used. The application parameter field 70e indicates the ID of the sender task and is set to 0 if not used. The length field 70g preferably indicates the length of the parameter field 70h. In one embodiment, the maximum size of the control and status packet is fixed to 256 bytes including the header, so that the maximum parameter length is 246 bytes.

The types of control and status transactions available include polled command and response to allow the application to poll a wireless communication unit. The command sent to the wireless communication unit and the response returned to acknowledge the command. Depending upon the context of the command, the response may contain data such as status information or may simply be an acknowledgment. There are two types of operation for the poll commands; get requests, and response to get requests. Other types of transactions is write/action command and response. This type of transaction allows the application to write certain parameters or trigger an action within the wireless communication unit. If the transaction is used as a write command, the response will contain the newly-changed data. No parameters are included when the transaction is used in an action trigger. There are two types of operation types for this transaction. Set request, and response to set request.

Another type of control and status transactions are notifications. Notification information is unsolicited asynchronous status updates sent by the wireless communication unit. Upon power-up, notifications are always disabled. Notifications must be explicitly enabled the control and status mechanism. Different types of information can be sent. The criteria for unsolicited update depend upon the actual information being forwarded. Notifications include notification requests, response to notification requests, notification packets, notification stop requests and response to notification stop requests.

The host interface protocol and control and status frames can be sent over any link layer protocol. Examples of link layers include NDIS protocol framing and UART link layer protocol. The link layer over the FIFO considers the host interface protocol packet structure plus an optional payload at the end. This optional payload consists of either a point to point protocol (PPP) packet, and control and status packet, an AT command packet, a protocol stack message or debug message. Each of these packet types is identified by its unique message ID. The UART link layer protocol is a link layer over the UART consisting of marking the host interface protocol package with start and end flags and escaping the data within.

Appendix I illustrates the different control and status messages of one embodiment of the present invention in detail.

<figref idref="f0006">FIG. 9</figref> illustrates the transfers between the wireless communication unit and the host unit for one embodiment of the present invention.

<figref idref="f0007">FIG. 10</figref> illustrates the transfers between the host unit and the wireless communication unit for one embodiment of the present invention. <tables id="tabl0001" num="0001"><table frame="none"><title><b>Table of Contents</b></title><tgroup cols="7"><colspec colnum="1" colname="col1" colwidth="8mm" /><colspec colnum="2" colname="col2" colwidth="36mm" /><colspec colnum="3" colname="col3" colwidth="54mm" /><colspec colnum="4" colname="col4" colwidth="44mm" /><colspec colnum="5" colname="col5" colwidth="9mm" /><colspec colnum="6" colname="col6" colwidth="9mm" /><colspec colnum="7" colname="col7" colwidth="9mm" /><tbody><row><entry colsep="0" rowsep="0">1</entry><entry colsep="0" rowsep="0">General</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">4</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.1</entry><entry colsep="0" rowsep="0">Purpose</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">4</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.2</entry><entry colsep="0" rowsep="0">Scope</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">4</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.3</entry><entry colsep="0" rowsep="0">Document Filing</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">4</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.3.1</entry><entry colsep="0" rowsep="0">Location and Format</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">4</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.3.2</entry><entry colsep="0" rowsep="0">Revision Control Tools/Methods</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">4</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.4</entry><entry colsep="0" rowsep="0">Revision History</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">4</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.5</entry><entry colsep="0" rowsep="0">Glossary</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">8</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">1.6</entry><entry colsep="0" rowsep="0">References</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">8</entry></row><row><entry colsep="0" rowsep="0">2</entry><entry colsep="0" rowsep="0">Overview</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">10</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">2.1</entry><entry colsep="0" rowsep="0">Design Goals and Requirements</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">11</entry></row><row><entry colsep="0" rowsep="0">3</entry><entry colsep="0" rowsep="0">Message Primitives (Overview)</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">12</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">3.1.</entry><entry colsep="0" rowsep="0">Fundamental Types</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">12</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">3.1.1</entry><entry colsep="0" rowsep="0">Requests</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">12</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">3.1.2</entry><entry colsep="0" rowsep="0">Responses</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">12</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">3.1.3</entry><entry colsep="0" rowsep="0">Indications</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">12</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">3.2</entry><entry colsep="0" rowsep="0">Host Interface Rules</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">12</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">3.3</entry><entry colsep="0" rowsep="0">Summary of message identifiers</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">13</entry></row><row><entry colsep="0" rowsep="0">4</entry><entry colsep="0" rowsep="0">Message Primitives (Details)</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">17</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.1</entry><entry colsep="0" rowsep="0">Boot Loader Messages (including firmware download)</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">17</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.1.1</entry><entry colsep="0" rowsep="0">Boot Loader-Boot &amp; Hold Messages</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">17</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.1.2</entry><entry colsep="0" rowsep="0">Modem Startup Messages</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">24</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.2</entry><entry colsep="0" rowsep="0">Over the Air Messages</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">24</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.2.1</entry><entry colsep="0" rowsep="0">Reverse Channel Grant Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">26</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.2.2</entry><entry colsep="0" rowsep="0">Reverse Channel Data Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">26</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.2.3</entry><entry colsep="0" rowsep="0">Forward Channel Data Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">27</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3</entry><entry colsep="0" rowsep="0">Control and Status Messages</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">27</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.1</entry><entry colsep="0" rowsep="0">Save Non-volatile Data Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">27</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.2</entry><entry colsep="0" rowsep="0">Configuration Information Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">28</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.3</entry><entry colsep="0" rowsep="0">Context Activation Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">32</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry namest="col3" nameend="col6" colsep="0" rowsep="0" align="left">A Link Status Indication message will always be sent in response to a Context Activation Indication message</entry><entry rowsep="0">32</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.4</entry><entry colsep="0" rowsep="0">Link Status Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">33</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.5</entry><entry colsep="0" rowsep="0">Abort Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">33</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.6</entry><entry colsep="0" rowsep="0">Modem Control and Status Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">34</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.7</entry><entry colsep="0" rowsep="0">Host Control and Status Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">34</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.8</entry><entry colsep="0" rowsep="0">Loop Back Request</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">35</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.9</entry><entry colsep="0" rowsep="0">Loop Back Response</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">35</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.10</entry><entry colsep="0" rowsep="0">PDP Context Summary Request</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">36</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.11</entry><entry colsep="0" rowsep="0">PDP Context Summary Response</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">37</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.12</entry><entry colsep="0" rowsep="0">GPRS Attach Request</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">37</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.13</entry><entry colsep="0" rowsep="0">GPRS Attach Response</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">37</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.14</entry><entry colsep="0" rowsep="0">Profile Template Request</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">37</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.15</entry><entry colsep="0" rowsep="0">Profile Template Response</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">37</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.3.16</entry><entry colsep="0" rowsep="0">Host Environment Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">37</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.4</entry><entry colsep="0" rowsep="0">Clock Switch Messages</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">38</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.4.1</entry><entry colsep="0" rowsep="0">Host Suspend Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">38</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.4.2</entry><entry colsep="0" rowsep="0">Host Suspend Complete Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">38</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.4.3</entry><entry colsep="0" rowsep="0">Host Resume Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">38</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5</entry><entry colsep="0" rowsep="0">Debugging Messages</entry><entry colsep="0" rowsep="0">Host Resume Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">39</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5.1</entry><entry colsep="0" rowsep="0">Modem SWI Command Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">39</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5.2</entry><entry colsep="0" rowsep="0">Host SWI Command Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">39</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5.3</entry><entry colsep="0" rowsep="0">Modem Protocol Stack Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">39</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5.4</entry><entry colsep="0" rowsep="0">Host Protocol Stack Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">39</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5.5</entry><entry colsep="0" rowsep="0">Modem AT Command Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">40</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5.6</entry><entry colsep="0" rowsep="0">Host AT Command Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">40</entry></row><row><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0">4.5.7</entry><entry colsep="0" rowsep="0">Modem (Rosette) Debug Log Indication</entry><entry colsep="0" rowsep="0" /><entry colsep="0" rowsep="0" /><entry rowsep="0">40</entry></row><row><entry colsep="0" /><entry colsep="0" /><entry colsep="0">4.5.8</entry><entry colsep="0">Host (Rosetta) Debug Log Indication</entry><entry colsep="0" /><entry colsep="0" /><entry>41</entry></row></tbody></tgroup></table></tables>

<u>1 General</u>

1.1 Purpose

This document defines the protocol used to communicate between the host and the card for the Bandit (GPRS) project.

1.2 Scope

This document describes configuration and control information formatting and message sequencing. This document does not contain physical layer information (such as register and ISR information).

1

.

3 Document Filing

1.3.1 Location and Format

The electronic version of this document is stored in the Vault under document number 2110342.

For convenience, a copy of this document is also available at: <u>\\TETLEY\PROJECTS\Bandit\dev\fw\docs\jdd\Host ip1p17.doc</u>

This document has been created using MS Word 2000®.

1.3.2 Revision Control Tools/Methods

The revision control tool method consists of keeping a distinct electronic copy of the document per document version for managing changes to the document. All versions of the Host Interface Protocol are available at: <u>\\TETLEY\PROJECTS\Bandit\dev\fw\does\idd\old Host ip\</u>

1.4 Revision History

<tables id="tabl0002" num="0002"><table frame="all"><tgroup cols="4"><colspec colnum="1" colname="col1" colwidth="18mm" /><colspec colnum="2" colname="col2" colwidth="21mm" /><colspec colnum="3" colname="col3" colwidth="19mm" /><colspec colnum="4" colname="col4" colwidth="109mm" /><thead><row><entry align="center" valign="top">Revision</entry><entry align="center" valign="top">Date</entry><entry align="center" valign="top">Author</entry><entry align="center" valign="top">Summary of change</entry></row></thead><tbody><row><entry>1.0</entry><entry>June 30, 2000</entry><entry>Victor Gonzalez</entry><entry>Initial Draft derived from Bullet (Metricom) documents "Host to Microprocessor Message Identifier Types for the Bullet Project" and ProjMem001.</entry></row><row><entry>1.1</entry><entry>July 19, 2000</entry><entry>Victor Gonzalez</entry><entry>Updated Flow Control message primitives, Fragment Launch Indication primitive, Restart Indication primitive, and added crash dump message primitive.</entry></row><row><entry>1.2</entry><entry>July 24, 2000</entry><entry>Victor Gonzalez</entry><entry>Added in control messages to suspend host during clock changes on the FIFO. Modified Command Request/Response message payload to specify SME vs. SWI vs. PCI command request/responses. Specified the value in the length field excludes the size of the length field itself.</entry></row><row><entry>1.3</entry><entry>August 2, 2000</entry><entry>Victor Gonzalez</entry><entry>Separated Command/Response messages into distinct SWI, SME, and Layer 1 Command/Response messages. Added serial numbers to Reverse Channel Data Indication messages. Added version ID &amp; date to boot information message (was binary crash indication message).</entry></row><row><entry>1.4</entry><entry>August 29, 2000</entry><entry>Rachel Bedet</entry><entry>Modified Flow Control section and Reverse Channel Grant indication to use message sequence numbers rather than blocks of data. Added new "used for" column to the message identifiers summary table. Added description and diagram of Host Suspend/Resume message indications. Updated description for Boot information indication. Added new user parameter field to the message header.</entry></row><row><entry>1.5</entry><entry>September 7, 2000</entry><entry>Rachel Bedet</entry><entry>Reorder section Overview sections. Reorder Message ids Modified MSN granting scheme Added new to indicate message padding (single bit from message id)</entry></row><row><entry>1.6</entry><entry>September 15, 2000</entry><entry>Rachel Bedet</entry><entry>Redefined length field to be the message payload length field. Clarified launch fragment indication usage. Reordered document to define message header in one-section and message payload in another. Added host interface protocol rules section. Changed maximum grant limit to be 127. Changed L1_REQ/L1_RESP, SME_REQ/SME_RESP and SWI_REQ/SWI_RESP to be indications.</entry></row><row><entry>1.7</entry><entry>September 20, 2000</entry><entry>Rachel Bedet</entry><entry>Corrected summary table, Added Application version string to Boot Information Indication payload Created new Abort Indication Created new Save non-volatile data indication Created new Start application indication Clarified Launch Fragment indication.</entry></row><row><entry>1.8</entry><entry>September 27, 2000</entry><entry>Rachel Bedet</entry><entry>Rename HSME_IND/MSME_HMD to HSAS_IND/MSAS_IND Added new Loop Back Request/Response Changed all message payload strings to be NULL terminated ASCII strings. Clarified the usage of the pad byte flag on the card side. Reversed launch 0x00 for a "normal" launch image. Modified MSN behind and ahead definitions.</entry></row><row><entry>1.9</entry><entry>November 21, 2000</entry><entry>Rachel Bedet</entry><entry>Define SAS stream numbers Added new Configuration Information and Context Activation Indications Updated Reverse Channel Grant Indication 1-byte return code values.</entry></row><row><entry>1.10</entry><entry>November 27, 2000</entry><entry>Rachel Bedet</entry><entry>Moved the message specific field to payload for all status and control message (except for loop back request/response) Added MAC address and IMEI version to Boot Information Indication Updated payload contents for Link Status Indication</entry></row><row><entry>1.11</entry><entry>February 6, 2001</entry><entry>Victor Gonzalez</entry><entry>Defined the "cause" values in the Link Status Indication message.</entry></row><row><entry>1.12</entry><entry>February 20, 2001</entry><entry>Rachel Bedet</entry><entry>Added the new "Watcher specific" column to the message summary table. Create the Modem Control and Status Indication and the Host Control and Status Indication.</entry></row><row><entry>1.13</entry><entry>February 28, 2001</entry><entry>Rachel Bedet</entry><entry>Create new Flash Program Request/Response packets Modified the Boot Loader - Boot &amp; Hold <u>Messages</u> section of the document to explain new packet use.</entry></row><row><entry>1.14</entry><entry>March 15, 2001</entry><entry>Rachel Bedet</entry><entry>Updated copyright year. Clarified contents of the pad byte. Fixed grammatical errors.</entry></row><row><entry>1.15</entry><entry>April 27, 2001</entry><entry>Victor Gonzalez</entry><entry>Updated HIP CNS messages</entry></row><row><entry>1.16</entry><entry>May 7,2001</entry><entry>Victor Gonzalez</entry><entry>Updated HIP CNS messages; added AT command messages, debug indications, and rename SAS messages to make them more generic</entry></row><row><entry>1.17</entry><entry>June 14, 2001</entry><entry>Victor Gonzalez Riley Hoyt</entry><entry>Updated LSI, CIL, CAI messages; added PDP Context summary req./resp. messages; added Profile Template req./resp. messages; added Attach req./resp. messages; replace EDGE references with GPRS references throughout; renumbered messages to match Posetta implementation (MSWI_IND/HSWI_IND swapped with MAT_IND/HAT_IND respectively) and added (Rosetta) Debug Log messages MRD_IND/HRD_IND; Added RTCONF_IND message; Change firmware download continuation from an indication to request response in order to provide flow control; Stated that request/response pair are <u>stop</u><u>and</u><u>wait;</u></entry></row></tbody></tgroup></table></tables>

1.5 Glossary

<tables id="tabl0003" num="0003"><table frame="all"><tgroup cols="2"><colspec colnum="1" colname="col1" colwidth="13mm" /><colspec colnum="2" colname="col2" colwidth="153mm" /><thead><row><entry valign="top">Term</entry><entry valign="top">Description</entry></row></thead><tbody><row>&lt;entry /&gt;<entry>Personal Computer Memory Card International Association, term used to describe the electrical and physical interface between the host PC and the modem.</entry></row><row><entry>FIFO</entry><entry>First In First Out memory device that is used to interface between two processors. The device uses sequential access as opposed to random access.</entry></row></tbody></tgroup></table></tables>

1.6 References

<tables id="tabl0004" num="0004"><table frame="all"><tgroup cols="3"><colspec colnum="1" colname="col1" colwidth="11mm" /><colspec colnum="2" colname="col2" colwidth="47mm" /><colspec colnum="3" colname="col3" colwidth="79mm" /><thead><row><entry valign="top">Ref</entry><entry valign="top">Doc</entry><entry valign="top">Document title</entry></row></thead><tbody><row><entry>R-1</entry><entry>2110330, Rev. 1.2</entry><entry>GPRS Contract Book</entry></row><row><entry>R-2</entry><entry>TBD</entry><entry>Bandit Boot Loader Design</entry></row><row><entry>R-3</entry><entry>SWI GPRS Project Memo 003</entry><entry>GPRS Aircard 710 Baseband Hardware Architecture</entry></row><row><entry>R-4</entry><entry>SWI GPRS Project Memo 007</entry><entry>GPRS AirCard 710 Programmer's guide</entry></row><row><entry>R-5</entry><entry>TBD</entry><entry>Bandit Host Interface Design</entry></row><row><entry>R-6</entry><entry>TBD</entry><entry>CWE Control and Status Protocol</entry></row></tbody></tgroup></table></tables>

<u>2</u><u>Overview</u>

The Bandit GPRS project deliverable consists of a Type II PC Card, GPRS packet switched data modem. The interface between the host PC and the card is via PCMCIA. Low-level specifications for this interface, including a description of data framing, is described in the AirCard 710 Hardware Architecture [R-3]. The purpose of this document is to describe the format of the data in the messages as well as the message primitives sent across the interface.

A variety of different messages are exchanged between the host PC and the modem. Examples of these messages are: "over-the-air" data, modem debugging and flash software downloads. This document specifies the message-based protocol between the modem and the host.

The messages consist of a message header followed by an optional variable length message payload. The contents of the message payload are specific to each message type. <tables id="tabl0005" num="0005"><table frame="all"><tgroup cols="2"><colspec colnum="1" colname="col1" colwidth="29mm" /><colspec colnum="2" colname="col2" colwidth="44mm" /><thead><row><entry align="center" valign="top">Message Header</entry><entry align="center" valign="top">Message Payload (optional)</entry></row></thead><tbody><row><entry colsep="0" align="center">32 bits</entry><entry align="center">Variable length</entry></row></tbody></tgroup></table></tables>

The message header is comprised of a payload length field, pad-byte bit flag, message identifier and a message specific parameter. <tables id="tabl0006" num="0006"><table frame="all"><tgroup cols="5"><colspec colnum="1" colname="col1" colwidth="34mm" /><colspec colnum="2" colname="col2" colwidth="24mm" /><colspec colnum="3" colname="col3" colwidth="21mm" /><colspec colnum="4" colname="col4" colwidth="38mm" /><colspec colnum="5" colname="col5" colwidth="50mm" /><thead><row><entry align="center" valign="top">Message Payload Length</entry><entry align="center" valign="top">Pad-Byte bit flag</entry><entry align="center" valign="top">Message Identifier</entry><entry align="center" valign="top">Message Specific Parameter</entry><entry align="center" valign="top">Pad Byte (optional - containing random data)</entry></row></thead><tbody><row><entry align="center">16 bits</entry><entry align="center">1 bit</entry><entry align="center">7 bits</entry><entry align="center">8 bits</entry><entry align="center">8 bits</entry></row></tbody></tgroup></table></tables>

The message payload length field is useful for various purposes. It helps identify the memory block buffer requirements to store the message. This length field is also useful to support alternative data link message transfer mechanisms such as DMA. Finally, length is also useful to indicate whether there is an even or odd number of bytes communicated in the message payload (note that the underlying data-link is fixed 16-bit wide). The minimum and maximum values of the message payload length field are 0 and 2000 respectively.

The pad byte flag field indicates if there is a pad byte is in front of the message payload If the pad byte flag is set then the message has a pad byte and the message payload length includes the length of the pad byte and the message payload.

The message identifier field identifies the message type.

The message specific parameter field provides a word aligned message header. The message type defines the use of this field. For example, the "Reverse Channel Grant Indication" uses the message specific parameter as a message sequence number whereas the "Download Start Response" uses it as a return code.

2.1 Design Goals and Requirements

The design of this protocol needs to meet the following requirements and goals: <ul id="ul0002" list-style="bullet" compact="compact"><li>Different message ids used in different directions to prevent echoing of messages across the interface and to aid in software debugging.</li><li>Simple message id header to reduce complexity of data link state machine.</li><li>Provide a grant request/response mechanism to seek permission prior to sending data such that flow control is accommodated over the interface</li><li>Provide a signal to the host to indicate if the modem has reset. This simplifies startup procedures on both sides of the interface.</li><li>Provide a method of discarding stale messages that might be present in the FIFO after a reset or crash.</li><li>Provide simple and extensible mechanism to report error messages from the modem to the host.</li><li>Provide simple and extensible interactive communication mechanism between the modem to the host. This mechanism should allow for a command-line type of interface.</li><li>Rely on the high reliability PCMCIA interface to reduce the processing burden on the microprocessor.</li><li>Provide feedback during various phases of the flash software upgrade process.</li></ul>

<u>3 Message Primitives (Overview)</u>

3.1 Fundamental Types

There are 3 fundamental types of messages that flow between the PC host and the modem microprocessor: requests, responses and indications.

3.1.1 Requests

A request message provides a means for the host (master) to ask the card (slave) to either perform an operation or return a value. The slave always responds to a request message with a response message. Because of the master/slave relationship, the card is not allowed to make requests of the host. One and only one response is sent for every request. Note that in order to provide flow control to the modem, a response to a specific request must be received before a second request of the same type can be issued. This effectively provides stop and wait flow control on a per request basis. If the host never receives a response to a request (timeout) this is a failure case and thus can assume that the modem device has failed and should be recovered from a restart state.

Request message ids are in the range of 00 to 31.

3.1.2 Responses

A response message is always sent from the card to reply to a request from the host. The format and type of data in the response varies according to the type of response.

Responses can never be sent unsolicited (i.e. every response is paired with a specific request).

Response message ids are in the range of 64 to 95.

3.1.3 Indications

Indication messages provide a means to send unsolicited data from either side of the interface. Indications are used when no reply or return data is required from the receiver. No acknowledgement or reply is ever sent by the receiver of an indication.

Indication message ids sent from the host PC are in the range 32 to 63.

Indication message ids sent from the card are in the range of 96 to 127.

3.2 Host interface Rules

<ol id="ol0001" compact="compact" ol-style=""><li>1. If a message is received by either side of the interface containing undefined message id it will simply be discarded.</li><li>2. If the maximum length of a message is ever exceeded, the receiver will discard the entire packet and ignore the message.</li><li>3. All multi-byte fields used in this protocol will be in network byte order. That is the most significant byte is sent first followed by lesser significant bytes. The least significant byte of a multi-byte field is sent last. Note that this differs from the way Intel processors would store multi-byte fields and special methods must be used to write multi-byte fields.</li><li>4. The host will never send a message to the card with the pad byte flag set. The modem will ignore the pad byte flag.</li><li>5. The card will discard any received "Reverse Channel Data Indication" messages that contain unexpected message sequence numbers.</li><li>6. The card application will ignore all boot loader specific messages.</li><li>7. The boot loader will only receive packets on this protocol if the host has placed the modem into firmware download mode. Note that the "boot indication" packet can be sent from the device during start to provide the host driver with startup information but it will never wait for or process host messages.</li></ol>

3.3 Summary of message Identifiers

<tables id="tabl0007" num="0007"><table frame="all"><tgroup cols="8"><colspec colnum="1" colname="col1" colwidth="20mm" /><colspec colnum="2" colname="col2" colwidth="20mm" /><colspec colnum="3" colname="col3" colwidth="20mm" /><colspec colnum="4" colname="col4" colwidth="47mm" /><colspec colnum="5" colname="col5" colwidth="27mm" /><colspec colnum="6" colname="col6" colwidth="59mm" /><colspec colnum="7" colname="col7" colwidth="33mm" /><colspec colnum="8" colname="col8" colwidth="18mm" /><thead><row><entry align="center" valign="top"><b>Message ID</b></entry><entry align="center" valign="top"><b>Direction</b></entry><entry align="center" valign="top"><b>Message type</b></entry><entry align="center" valign="top"><b>Message Specific Parameter</b></entry><entry align="center" valign="top"><b>Name</b></entry><entry align="center" valign="top"><b>Description</b></entry><entry align="center" valign="top"><b>Used in</b></entry><entry align="center" valign="top"><b>Watcher Specific</b></entry></row></thead><tbody><row><entry align="center">00 (0x00)</entry><entry align="center">Host -&gt; Modem</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">DS_REQ</entry><entry>Qownload start request</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">01 (0x01)</entry><entry align="center">Host -&gt; Modem</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">DE_REQ</entry><entry>Download end request</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">02 (0x02)</entry><entry align="center">Host <b>-</b>&gt; Modern</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">DCONT_REQ</entry><entry>Download continuation request</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">03 (0x03)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">LOOP_REQ</entry><entry>Loop back request</entry><entry>Application</entry><entry align="center">X</entry></row><row><entry align="center">04 (0x04)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">PROG_REQ</entry><entry>Flash program request</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">05 (0x05)</entry><entry align="center">Host -&gt; Modem</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">PSUM_REQ</entry><entry>PDP Context Summary request</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">06 (0x06)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">ATT_REQ</entry><entry>GPRS Attach request</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">07 (0x07)</entry><entry align="center">Host -&gt; Modem</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">PT_REQ</entry><entry>Profile Template request</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">08 (0x08)</entry><entry align="center">Host-&gt; Modern</entry><entry align="center">Request</entry><entry align="center">Unused</entry><entry align="center">CONF_REQ</entry><entry>Configuration Information Request</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">09 (0x09)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Request</entry><entry align="center">Packet session ID (optional)</entry><entry align="center">PSACT_REQ</entry><entry>Packet Session Activation Indication</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">10 (0x0A) 31 (0x1F)</entry><entry align="center">Host -&gt; Modem</entry><entry align="center">Request</entry><entry align="center">-</entry><entry align="center">-</entry><entry>Undefined (not implemented)</entry>&lt;entry /&gt;<entry align="center" /></row><row><entry align="center" /><entry align="center" /><entry align="center" /><entry align="center" /><entry align="center" />&lt;entry /&gt;&lt;entry /&gt;<entry align="center" /></row><row><entry align="center" /><entry align="center" /><entry align="center" /><entry align="center" /><entry align="center" />&lt;entry /&gt;&lt;entry /&gt;<entry align="center" /></row><row><entry align="center">32 (0x20)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">MSYNC_IND</entry><entry>Modern data link sync indication</entry><entry>Boot Loader and Application</entry><entry align="center" /></row><row><entry align="center">33 (Ox21)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Launch Code</entry><entry align="center">MLAUN_IND</entry><entry>Launch fragment indication</entry><entry>Boat Loader only</entry><entry align="center" /></row><row><entry align="center">34 (0x22)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">-</entry><entry align="center">-</entry><entry>Not implemented</entry><entry>-</entry><entry align="center" /></row><row><entry align="center">35 (0x23)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Message Sequence Number</entry><entry align="center">RDATA_IND</entry><entry>Reverse channel data indication</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">36 (0x24)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">MSWI_IND</entry><entry>Modern SWI command indication, command line debugger</entry><entry>SW1 Debugging</entry><entry align="center">X</entry></row><row><entry align="center">37 (0x25)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">-</entry><entry>Undefined (not implemented)</entry><entry>-</entry><entry align="center" /></row><row><entry align="center">38 (0x26)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">SAVE_IND</entry><entry>Save non-volatile data</entry><entry>Application</entry><entry align="center">X</entry></row><row><entry align="center">39 (0x27)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">SUSC_IND</entry><entry>Host Suspend Complete indication</entry><entry>Application Clock Switch</entry><entry align="center" /></row><row><entry align="center">40 (0x28)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Launch Code</entry><entry align="center">STRT_IND</entry><entry>Start Application Indication</entry><entry>Boot Loader Only</entry><entry align="center" /></row><row><entry align="center">41 (0x29)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">-</entry><entry>-</entry><entry>-</entry><entry align="center" /></row><row><entry align="center">42 (0x2A)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">ACT_IND</entry><entry>Context Activation Indication</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">43 (0x2B)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">MCNS_IND</entry><entry>Modern Control and Status Indication</entry><entry>Application</entry><entry align="center">X</entry></row><row><entry align="center">44 (0x2C)</entry><entry align="center">Host → Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">MAT_IND</entry><entry>Modern AT Command indication</entry><entry>SWI Debugging</entry><entry align="center">X</entry></row><row><entry align="center">45 (0x2D)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Depends on protocol stack in use</entry><entry align="center">MSTACK_IND</entry><entry>Modern Protocol Stack debug indication</entry><entry>Protocol Steck Debugging (example: CAIT)</entry><entry align="center">X</entry></row><row><entry align="center">46 (0x2E)</entry><entry align="center">Host → Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">MRD_IND</entry><entry>Modern (Rosetta) Debug Log indication</entry><entry>SWI Debugging</entry><entry align="center">X</entry></row><row><entry align="center">47 (0x2F)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">RTCONF_IND</entry><entry>Run-time configuration Indication</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">48 (0x30) 63 (0x3F)</entry><entry align="center">Host -&gt; Modern</entry><entry align="center">Indication</entry><entry align="center">-</entry><entry align="center">-</entry><entry>Undefined (not implemented)p1c!ntcntc&lt;!)</entry><entry>-</entry><entry align="center" /></row><row><entry align="center">64 (0x40)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Return Code</entry><entry align="center">DS_RESP</entry><entry>Download start response</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">65 (0x41)</entry><entry align="center">Modern Host</entry><entry align="center">Response</entry><entry align="center">Return Code</entry><entry align="center">DE_RESP</entry><entry>Download end response</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">66 (0x42)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Unused</entry><entry align="center">DCONT_RESP</entry><entry>Download continuation response</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">- 67 (0x43)</entry><entry align="center">Modern Host</entry><entry align="center">Response</entry><entry align="center">Unused</entry><entry align="center">LOOP_RESP</entry><entry>Loop Back response</entry><entry>Application</entry><entry align="center">X</entry></row><row><entry align="center">68 (0x44)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Unused</entry><entry align="center">PROG_RESP</entry><entry>Flash Program response</entry><entry>Boot Loader only</entry><entry align="center">X</entry></row><row><entry align="center">69 (0x45)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Unused</entry><entry align="center">PSUM_RESP</entry><entry>PDP Context Summary response</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">70 (0x46)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Unused</entry><entry align="center">ATT_RESP</entry><entry>GPRS Attach response</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">71 (0x47)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Unused</entry><entry align="center">PT_RESP</entry><entry>Profile Template response</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">72 (0x48)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Error code</entry><entry align="center">CONF_RESP</entry><entry>Configuration Information Response</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">73 (0x49)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Response</entry><entry align="center">Error code</entry><entry align="center">PSACT_RESP</entry><entry>Packet Session Activate Response</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">74 (0x4A) 95 (0x5F)</entry><entry align="center">Modern Host</entry><entry align="center">Response</entry><entry align="center">-</entry><entry align="center">-</entry><entry>Undefined (not Implemented)</entry><entry>-</entry><entry align="center" /></row><row><entry align="center">96 (0x60)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">HSYNC_IND</entry><entry>Host data link sync indication</entry><entry>Boot Loader and Application</entry><entry align="center" /></row><row><entry align="center">97 (0x61)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">BOOT_IND</entry><entry>Boot Information Indication</entry><entry>Boot Loadeer only</entry><entry align="center" /></row><row><entry align="center">98 (0x62)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Return Code</entry><entry align="center">RSTART_IND</entry><entry>Restart indication</entry><entry>Boot Loader and Application Startup</entry><entry align="center" /></row><row><entry align="center">99 (0x63)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">FDATA_IND</entry><entry>Forward channel data indication</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">100 (0x64)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Message Sequence Number</entry><entry align="center">RG_IND</entry><entry>Reverse Channel Grant Indication</entry><entry>Application Flow Control</entry><entry align="center" /></row><row><entry align="center">101 (0x65)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">HSWI_IND</entry><entry>Host SWl command indication, ui command line debugger</entry><entry>SWl Debugging</entry><entry align="center">X</entry></row><row><entry align="center">102 (0x66)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">-</entry><entry align="center">-</entry><entry>Undefined (not implemented)</entry><entry>-</entry><entry align="center" /></row><row><entry align="center">103 (0x67)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">SUS_IND</entry><entry>Host Suspend indication</entry><entry>Application Clock Switch</entry><entry align="center" /></row><row><entry align="center">104 (0x68)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">RES_IND</entry><entry>Host Resume indication</entry><entry>Application Clock Switch</entry><entry align="center" /></row><row><entry align="center">105 (0x69)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">LINK_IND</entry><entry>Link Status indication</entry><entry>Application</entry><entry align="center" /></row><row><entry align="center">106 (0x6A)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">AB_IND</entry><entry>Abort indication</entry><entry>Application</entry><entry align="center">X</entry></row><row><entry align="center">107 (0X6B)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">HCNS_IND</entry><entry>Host Control and Status Indication</entry><entry>Application</entry><entry align="center">X</entry></row><row><entry align="center">108 (0x6C)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">HAT_IND</entry><entry>Host AT Commamd indication</entry><entry>SWI Debugging</entry><entry align="center">X</entry></row><row><entry align="center">109 (0x6D)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">indication</entry><entry align="center">Ubused</entry><entry align="center">HSWI_IND</entry><entry>Host SWI command indication</entry><entry>SWI Debugging</entry><entry align="center">X</entry></row><row><entry align="center">109 (0x6D)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Optional use to multiplex various protocol stock debugging streams</entry><entry align="center">HSTACK_IND</entry><entry>Host Protocol Stack indication</entry><entry>Protocol stuck Debugging (example: CAIT)</entry><entry align="center">X</entry></row><row><entry align="center">110 (0x6E)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">Unused</entry><entry align="center">HRD_IND</entry><entry>Host (Rosetts) Debug Log indication</entry><entry>SWI Debugging</entry><entry align="center">X</entry></row><row><entry align="center">111 (0x6F) 127 (0x7F)</entry><entry align="center">Modern -&gt; Host</entry><entry align="center">Indication</entry><entry align="center">-</entry><entry align="center">-</entry><entry>Undefined (not implemented)</entry><entry>-</entry><entry align="center" /></row></tbody></tgroup></table></tables>

4 Message Primitives (Details)

4.1 Boot Loader Messages (Including firmware download)

4.1.1 Boot Loader - Boot &amp; Hold Messages

The boot loader can only read HIP protocol messages when the modem device has entered firmware download mode (in PCMCIA card configurations this is achieved when the EPGA/ASIC "Boot &amp; Hold" bit is set. The messages described in this section are only implemented in the boot loader image.

The modem device executes firmware that resides on Flash memory on the card. To support the ability to upgrade the contents of the flash memory in the field, the ability to download new firmware images into the card (from the host PC to the card) is provided. The following message sequence diagram depicts the message flow between the host and the modem during a firmware download session. <img file="EP1579653B1_D0001.tif" />

The download start request is used to signal the modem to initialize for a program download procedure. A Download start response is always sent in response to this message. After the download start request, the remainder of the program is downloaded using multiple download continuation requests and responses. The download end request is used to signal the card that the program download process is complete. The card concludes with a download end response. The host will send a flash program request at this time. The card will complete copying the downloaded program to flash and send a flash program response back to the host. The host will then either send a launch fragment indication to start the application program on the card or reset the card.

Note: In some modem products the flash will require programming during the download process (there is not enough RAM to buffer the entire image before programming).

A running checksum is applied to the entire software download process beginning with the download start request and finishing with the download end request. The 16-bit checksum variable is initialized to 0 at the download start request. The host then "walks" through and sums each byte (one byte at a time) of the message payload of all download packets (start, continue and end) into a 16-bit accumulator. The resultant 16-bit checksum is then sent as the payload of the download end request.

The modem performs a similar procedure and initializes a 16-bit checksum variable to 0 upon the reception of the download start request and sums all download message payload bytes one byte at a time. The modem then verifies the calculated checksum against the checksum received in the "download end request". The modem will respond with a "download end response".

<i>4.1.1.1 Download Start Request</i>

The download start request is used to signal the modern to initialize for a program download procedure. This request causes the modem to initialize any required resources as well as provide an acknowledgement that the file format and file type is correct. <tables id="tabl0008" num="0008"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x00</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>Message payload consists of the image header optionally followed by as much of the image data will fit in the remaining packet (given the maximum message size)</entry></row></tbody></tgroup></table></tables>

<i>4.1.1.2 Download Start Response</i>

The download start response is sent to reply to the host's download start request. This response is only implemented in the boot loader image (application software will discard any and all download requests). <tables id="tabl0009" num="0009"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x40</entry></row><row rowsep="0"><entry>Message Specific Parameter: return code</entry></row><row rowsep="0"><entry>• 0x00 - Success, continue download process</entry></row><row rowsep="0"><entry>• 0x01 - Error, download process aborted.</entry></row><row><entry>Message payload is optional. If present the payload will consist of a NULL terminated ASCII error string describing the error reason. Examples of some possible error reasons might be: "invalid product ID" or "invalid load address"</entry></row></tbody></tgroup></table></tables>

<i>4.1.1.3 Download Continuation Request</i>

The download continuation request is used to download the software flash image to the card. After a download start request, the remainder of the image download is carried out using this request. After receiving this request, the card will send a download continue response thus providing end to end flow control for firmware downloads. <tables id="tabl0010" num="0010"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="105mm" /><tbody><row rowsep="0"><entry>Message Id: 0x02</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>Message payload carries the next "chunk" of the downloaded image.</entry></row></tbody></tgroup></table></tables>

<i>4.1.1,4 Download Continuation Response</i>

The download continuation response is used to acknowledge that the transfer of each download chunk (see download continuation request). <tables id="tabl0011" num="0011"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="99mm" /><tbody><row rowsep="0"><entry>Message Id: 0x42</entry></row><row rowsep="0"><entry>Message Specific Parameter: error code</entry></row><row rowsep="0"><entry>00 - success</entry></row><row rowsep="0"><entry>01 - failure</entry></row><row><entry>There is no message payload associated with this message.</entry></row></tbody></tgroup></table></tables>

<i>4.1.1.5 Download End Request</i>

The download end request is used to signal the card that the program download process is complete. After receiving this request, the card will validate the downloaded program (incl. verifying the checksum) and send a download end response indicating if the download was successful. <tables id="tabl0012" num="0012"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="139mm" /><tbody><row rowsep="0"><entry>Message Id: 0x01</entry></row><row rowsep="0"><entry>Message Specific Parameter: Unused</entry></row><row><entry>Message payload is a 16-bit field containing the checksum for the entire download process</entry></row></tbody></tgroup></table></tables>

<i>4.1.1.6 Download End Response</i>

The download end response is sent to reply to the host's download end request. This response is only implemented in the boot loader image.

After sending this response, the card will expect a Flash Program Request from the host <tables id="tabl0013" num="0013"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x41</entry></row><row rowsep="0"><entry>Message Specific Parameter: return code</entry></row><row rowsep="0"><entry>• 0x00 - Success, complete program downloaded</entry></row><row rowsep="0"><entry>• 0x01 - Error, download process aborted.</entry></row><row><entry>The message payload is optional. If present it will consist of a NULL terminated ASCII error string describing the error reason.</entry></row></tbody></tgroup></table></tables>

<i>Flash Program Request</i>

The flash program request is used to signal the card to copy the download image into flash. After receiving this request, the card will program the flash and send a flash program response indicating if the flash programming was successful. <tables id="tabl0014" num="0014"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="64mm" /><tbody><row rowsep="0"><entry>Message Id: 0x04</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>The message payload is unused.</entry></row></tbody></tgroup></table></tables>

<i>4.1.1.7 Flash Program Response</i>

The flash program response is sent to reply to the host's flash program request. This response is only implemented in the boot loader image.

After sending the response the card will not restart itself, it will simply wait either to receive a launch fragment indication or to be reset from the host. <tables id="tabl0015" num="0015"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x44</entry></row><row rowsep="0"><entry>Message Specific Parameter: return code</entry></row><row rowsep="0"><entry>• 0x00 - Success, complete program copied to flash</entry></row><row rowsep="0"><entry>• 0x01 - Error, flash programming failed</entry></row><row><entry>The message payload is optional. If present it will consist of a NULL terminated ASCII error string describing the error reason.</entry></row></tbody></tgroup></table></tables>

Note that in some modern designs the flash is actually programmed during the data transfer process instead of at the end of the process. In any case the "Program Request/Response" will be sent from the host application and the modern device must implement these messages. In doing so the host firmware download application can be consistent regardless of the actual method used on the modem device.

<i>4.1.1.8 Launch Fragment Indication</i>

Prior to receiving a Launch Fragment Indication from the host, the card should have received a Download Start Request, multiple Download Continuation Requests, a Download End Request and a Flash Program Request, completing a successful firmware download. If the download was not completed or successful then the boot loader will discard any Launch Fragment Indications it receives. Given that an image was successfully downloaded, the card will launch the image (regardless of where image resides: RAM or Flash) with the provided launch code when a Launch Fragment Indication is received. <tables id="tabl0016" num="0016"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="114mm" /><tbody><row rowsep="0"><entry>Message Id: 0x21</entry></row><row rowsep="0"><entry>Message Specific Parameter: launch code</entry></row><row rowsep="0"><entry>• 0x00 - reserved to indicate the normal launch of the firmware image.</entry></row><row><entry>There is no message payload associated with this message.</entry></row></tbody></tgroup></table></tables>

<i>4.1.1.9 start Application Indication</i>

The Start Application Indication is sent from the host to the card to start the standard application with the specific launch code as an input parameter. This message will be ignored if there is no application or if the application is bad. <tables id="tabl0017" num="0017"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="130mm" /><tbody><row rowsep="0"><entry>Message Id: 0x28.</entry></row><row rowsep="0"><entry>Message Specific Parameter: launch code</entry></row><row rowsep="0"><entry>• 0x00 - reserved to indicate the normal launch of the firmware application image.</entry></row><row><entry>There is no message payload associated with this message.</entry></row></tbody></tgroup></table></tables>

4.1.2 Modem Startup Messages

<i>4.1.2.1 Host Data Link Synchronization Indication</i>

The host data link synchronization indication (sent by modem to the host) is used to provide a simple unacknowledged method of start-up sequencing. This indication serves 2 purposes: data link synchronization and a means to discard stale messages that might be present in the FIFO after a restart. This dual purpose implies that this message must be sent twice at start-up: once to establish link framing and once to force the link layer into the normal message processing state. There is no message payload in this indication. <tables id="tabl0018" num="0018"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="99mm" /><tbody><row rowsep="0"><entry>Message Id: 0x60</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>There is no message payload associated with this message.</entry></row></tbody></tgroup></table></tables>

After the boot loader image sends two data link sync messages it then sends, the Boot Information Indication which may be followed by the Restart Indication message to inform the host of the operational state of the modem.

After the application image sends two data link sync messages it sends a Restart Indication message to indicate to the host that the application is running.

Note: The NDIS driver must always send a "Modem Data Link Sync" message when it receives this message thus ensuring that the modem device will always receive it's data. link sync message.

<i>4.1.2.2 Modem Data Link Synchronization Indication</i>

The modem data link synchronization indication is used to provide a simple unacknowledged method of start-up sequencing. The modem data link synchronization procedure operates exactly the same as the host data link sync procedure defined in section 4.1.2.1.

The host will always send a modem data link sync indication to the card when it receives a host data link sync indication from the card. <tables id="tabl0019" num="0019"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="99mm" /><tbody><row rowsep="0"><entry>Message Id: 0x20</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>There is no message payload associated with this message.</entry></row></tbody></tgroup></table></tables>

<i>4.1.2.3 Boot Information Indication</i>

The "Boot Information Indication" message is sent from the card to the host PC during the boot procedures. Crash information is diagnostic information that is saved during card failure. For more information regarding the usage of the "Boot Information Indication" in the boot load procedure, refer to the Bandit Boot Loader Design document (reference [R-2). <tables id="tabl0020" num="0020"><table frame="all"><tgroup cols="5"><colspec colnum="1" colname="col1" colwidth="9mm" /><colspec colnum="2" colname="col2" colwidth="32mm" /><colspec colnum="3" colname="col3" colwidth="60mm" /><colspec colnum="4" colname="col4" colwidth="26mm" /><colspec colnum="5" colname="col5" colwidth="9mm" /><tbody><row><entry namest="col1" nameend="col5" rowsep="0" align="left">Message Id: 0x61</entry></row><row><entry namest="col1" nameend="col5" rowsep="0" align="left">Message Specific Parameter: unused</entry></row><row><entry namest="col1" nameend="col5" align="left">The Message payload is as follows:</entry></row><row><entry morerows="4" rowsep="0" /><entry>MAC Address</entry><entry>Card specific MAC address</entry><entry>6 bytes</entry><entry morerows="4" rowsep="0" /></row><row><entry>IMEI version</entry><entry>Card specific IMEI version</entry><entry>16 bytes</entry></row><row><entry>Boot loader version</entry><entry>Null terminated ASCII string</entry><entry>80 bytes</entry></row><row><entry>Application version</entry><entry>Null terminated ASCII string</entry><entry>84 bytes</entry></row><row><entry>Crash dump</entry><entry>Null terminated ASCII crash dump string</entry><entry>Variable length</entry></row><row><entry namest="col1" nameend="col5" align="left" /></row></tbody></tgroup></table></tables>

<i>4.1.2.4 Restart Indication</i>

Whenever the card resets it sends the restart indication message. This message provides information on the restart status of the card software. Note that this message can be sent by the boot loader (if application is deemed corrupt or not present) but in the general case this message is sent by the card firmware application. This message is used by the host to detect that the wireless application has started and has entered the normal operational message processing state. <tables id="tabl0021" num="0021"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x62</entry></row><row rowsep="0"><entry>Message Specific Parameter: Return Code</entry></row><row rowsep="0"><entry>• 0x00 - Card application firmware running (sent by application firmware). Information string contains software version card application</entry></row><row rowsep="0"><entry>• 0x01 - Failed to start application, no application detected (sent by boot loader).</entry></row><row rowsep="0"><entry>• 0x02 - Failed to start application, corrupted application detected (sent by boot loader).</entry></row><row rowsep="0"><entry>• 0x03 - Waiting in Boot &amp; Hold state for program download (sent by boot loader when detecting Boot &amp; Hold condition).</entry></row><row rowsep="0"><entry>• 0x04 - RAM test failed.</entry></row><row><entry>Message payload is an optional. If present will consist of a NULL terminated ASCII string whose purpose is to provide additional information (example: aid in debugging).</entry></row></tbody></tgroup></table></tables>

4.2 Over the Air Messages

Data that is sent from the host PC to the card for the purpose of sending data "over the air" back into the network is termed "reverse channel data)". It is important to provide flow control in the reverse channel direction from the host PC to the card. In the opposite direction, the card does not have the capability-to flow-control data received from the network hence there is no flow control support in the forward channel direction. <img file="EP1579653B1_D0002.tif" />

The "Reverse Channel Grant Indication" message primitive sends an 8-bit message sequence number (MSN) from the card to the host. The indication informs the host of the MSN of the last reverse channel data message the host is permitted to send to the card. The host will continue to send "Reverse Channel Data Indications" until the message containing the MSN specified in the most recent "Reverse Channel Grant Indication" has been sent to the card or until a "Reverse Channel Grant Indication" is received that revokes permission to send further messages.

The "Reverse Channel Grant Indication" message is unsolicited. The host PC must be prepared at any time to receive another " Reverse Channel Grant Indication" message specifying a different MSN. The host can continue to send messages to the card until the MSN of the next message to be sent is ahead of the granted MSN. Any MSN between (granted MSN + 1) modulus 256 and (granted MSN + 128) modulus 256 inclusively is considered to be ahead the granted MSN. Any MSN between (granted MSN - 127) modulus 256 and (granted MSN) inclusively is considered to be behind the grant.

The card is limited to granting 127 messages at a time.

Upon receiving a restart indication, the host PC will initialize its last sent MSN to 0. Likewise on the card the last received MSN will be initialized to 0. Lets examine a possible use case. After initialization the card sends a "Reverse Channel Grant Indication" containing the MSN 120. Upon receiving this grant indication the host is free to send out 120 messages incrementing its last sent variable each time a message is sent. The card will update its last received MSN value with the sequence number found in the message specific parameter of the last received "Reverse Channel Data Indication". Suppose that the last sent MSN on the host is MSN 100 and the card last read message MSN 99 out of the FIFO. Perhaps at this point the card determines that it has the resources available to receive another 127 messages. The card will send another "Reverse Channel Grant Indication" containing MSN 226 ((last read MSN 99 + 127) modulus 256). The host is free to send out messages until it increments its last sent MSN to 226. [Consider that the card starts to over heat when the last sent MSN on the host is 159 and the last read message MSN on the card is 150. The card will send a "Reverse Channel Grant Indication" specifying MSN 150. The host will receive this indication and stop sending messages to the card.

The "Forward Channel Data Indication" message is used without a "grant" scheme and hence does not support flow control. In this case, the OTA data is sent from the card to the host PC with the assumption that the host will be able to handle all OTA data in the message payload portion of the message with no need for flow control.

4.2.1 Reverse Channel Grant Indication

This indication is sent from the modem to the host PC and is used to inform the host PC of the message sequence number of the last message it is prepared to accept from the host PC. The algorithm detailing the how the modem determines how many messages it is capable of receiving is beyond the scope of this document. <tables id="tabl0022" num="0022"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="94mm" /><tbody><row rowsep="0"><entry>Message Id: 0x64</entry></row><row rowsep="0"><entry>Message Specific Parameter: Message Sequence Number</entry></row><row rowsep="0"><entry>Message payload consists of a 1-byte return code:</entry></row><row rowsep="0"><entry>• 0x00 - card is okay</entry></row><row><entry>• 0x02 - the card is overeating</entry></row></tbody></tgroup></table></tables>

4.2.2 Reverse Channel Data Indication

Data that is sent from the modem "over the air" back into the network is termed "reverse channel data", This indication is sent from the host PC to the modem and is used to deliver data that is to be queued for transmission "over the air" by the modem. <tables id="tabl0023" num="0023"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="138mm" /><tbody><row rowsep="0"><entry>Message Id: 0x23</entry></row><row rowsep="0"><entry>Message Specific Parameter: Message Sequence number</entry></row><row><entry>Message payload consists of the "over the air" data to be queued for transmission by the card.</entry></row></tbody></tgroup></table></tables>

This indication is sent from the host PC to the card only when the host PC has been granted permission to send these indications to the card. Permission is granted to the host PC according to the message payload of the previously received Reverse Channel Grant Indication message. The last received message sequence number may be used by the card to determine up to which message sequence number send permission will be granted

4.2.3 Forward Channel Data Indication

Data that is sent from the network "over the air" to the modem is termed "forward channel data". This indication is sent from the modem to the host PC and is used to deliver "over the air" data that has been received by the modem. <tables id="tabl0024" num="0024"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="159mm" /><tbody><row rowsep="0"><entry>Message Id., 0x63</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused (in the future this field could be used to indicate data fragments)</entry></row><row><entry>Message payload carries the forward channel OTA data received by the modem.</entry></row></tbody></tgroup></table></tables>

4.3 Control and Status Messages

Control and status data is sent between the card and the host PC to provide management of the modem device. This management consists of: <ul id="ul0003" list-style="bullet"><li>Non-volatile configuration of the device</li><li>Run-time configuration of the device</li><li>Status reporting and monitoring of the device</li><li>Transport of debug information to/from the device</li></ul>

4.3.1 System Shut Down Indication

The system shut down indication Save Non-volatile Data Indication is an unsolicited message sent by the host to instruct the card to save its non-volatile data. <tables id="tabl0025" num="0025"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="99mm" /><tbody><row rowsep="0"><entry>Message Id: 0x26</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>There is no message payload associated with this message.</entry></row></tbody></tgroup></table></tables>

For example, this could be sent when the watcher program terminates.

4.3.2 Configuration Information Request

The Configuration Information Request is sent from the host to the modem device to configure packet session information. Note that this information will vary for each wireless protocol. In order to accommodate the varying needs of each wireless protocol, the format of the configuration information portion of the message is flexible (on a per protocol basis). This message can be sent at anytime (once the modem application is up and running). Generally this message is sent whenever the user modifies any packet session settings/configurations. This data can be stored in non-volatile storage on the device (recommended) but it is not mandatory. Some example usages are: <ul id="ul0004" list-style="none" compact="compact"><li>• GPRS - This message will be sent when the host modifies any PDP Context Profile using Watcher or when an application submits an OID_WW_GPRS_DCONT OID.</li></ul><tables id="tabl0026" num="0026"><table frame="all"><tgroup cols="5"><colspec colnum="1" colname="col1" colwidth="9mm" /><colspec colnum="2" colname="col2" colwidth="41mm" /><colspec colnum="3" colname="col3" colwidth="92mm" /><colspec colnum="4" colname="col4" colwidth="17mm" /><colspec colnum="5" colname="col5" colwidth="9mm" /><tbody><row><entry namest="col1" nameend="col5" rowsep="0" align="left">Message Id: 0x08</entry></row><row><entry namest="col1" nameend="col5" rowsep="0" align="left">Message Specific Parameter: unused</entry></row><row><entry namest="col1" nameend="col5" align="left">Message payload consists of the following information structure:</entry></row><row><entry morerows="4" rowsep="0" /><entry>Protocol type</entry><entry>Specifies the format used for this message. Allows multiple wireless technologies to use same command ID for differing message formats 0 - GPRS 1 - UMTS 2- 255 Reserved for future wireless protocols</entry><entry>1 byte</entry><entry morerows="4" rowsep="0" /></row><row><entry>Query/Set flag</entry><entry>Indicates if request is a set or query operation. Profile information is optional in a query operation. The response always contain profile information regardless of query/set flag. 00 - Query of profile information. 01 - Set of profile information.</entry><entry>1 byte</entry></row><row><entry>Profile ID</entry><entry>ID specifying which profile is being acted on (queried or set). Range dependent on protocol. GPRS - range is 0 - 2</entry><entry>1 byte</entry></row><row><entry>Length</entry><entry>Length of the following variable field (protocol specific configuration message). Can be set to 0 for query operation.</entry><entry>2 bytes</entry></row><row><entry>Configuration buffer Protocol specific Configuration buffer.</entry><entry>Format varies depending on the protocol type field</entry><entry>Variable length</entry></row><row><entry namest="col1" nameend="col5" align="left" /></row></tbody></tgroup></table></tables>

<i>4.3.2.1 GPRS configuration buffer</i>

The following table describes the format of the configuration buffer for the GPRS protocol type. <tables id="tabl0027" num="0027"><table frame="all"><tgroup cols="3"><colspec colnum="1" colname="col1" colwidth="39mm" /><colspec colnum="2" colname="col2" colwidth="107mm" /><colspec colnum="3" colname="col3" colwidth="21mm" /><tbody><row><entry>Valid flag</entry><entry>0 - This PDP context is valid 1 -This PDP Context is invalid or not yet configured</entry><entry>1 byte</entry></row><row><entry>Automatic Context Activation flag</entry><entry>0 - deferred context activation (context only activated when requested by user) 1 - immediate context activation ("always connected" configuration) - automatic context activation on packet transmission (Host driver automatically activates context with presence of IP data) Note: Not used by modem, provided only for bost storage convenience.</entry><entry>1 byte</entry></row><row><entry>PDP type</entry><entry>0 - IPv4 PDP type 1 -PPP PDP type</entry><entry>1 byte</entry></row><row><entry>APN length</entry><entry>Length of APN below (0-100). 0 indicates no APN specified</entry><entry>1 byte</entry></row><row><entry>APN</entry><entry>Example mo.cellco.co.uk</entry><entry>100 ASCII characters</entry></row><row><entry>PDP address Length</entry><entry>length of PDP address below (0-16). 0 indicates dynamic addressing. Not used by modem, provided only for host storage convenience.</entry><entry>1 byte</entry></row><row><entry>PDP address</entry><entry>IP or PDP address when using static PDP address configuration. Example (of an IPv4 address which are typically 4 bytes): 0x7F000201. Not used by modem. provided only for host storage convenience.</entry><entry>16 bytes</entry></row><row><entry>Data Compression flag</entry><entry>0 - no compression 1 compression</entry><entry>1 byte</entry></row><row><entry>Header Compression flag</entry><entry>0 - no compression 1 - compression</entry><entry>1 byte</entry></row><row><entry>QoS precedence</entry><entry>Valid values 1 - 3</entry><entry>1 byte</entry></row><row><entry>QoS delay</entry><entry>Valid values 1 - 4</entry><entry>1 byte</entry></row><row><entry>QoS reliability</entry><entry>Valid values 1 - 5</entry><entry>1 byte</entry></row><row><entry>QoS peak</entry><entry>Valid values 1- 9</entry><entry>1 byte</entry></row><row><entry>Qos mean</entry><entry>Valid values 1 - 31</entry><entry>1 byte</entry></row><row><entry>Min precedence</entry><entry>Valid values 1 - 3</entry><entry>1 byte</entry></row><row><entry>Min delay</entry><entry>Valid values 1 - 4</entry><entry>1 byte</entry></row><row><entry>Min reliability</entry><entry>Valid values 1 - 5</entry><entry>1 byte</entry></row><row><entry>Min peak</entry><entry>Valid values 1 - 9</entry><entry>1 byte</entry></row><row><entry>Min mean</entry><entry>Valid values 1-31</entry><entry>1 byte</entry></row><row><entry>Primary DNS address length</entry><entry>Length of Primary DNS address. Valid range 0-16.0 indicates no DNS address present. Not used by modem, provided only for host storage convenience.</entry><entry>1 byte</entry></row><row><entry>Primary DNS address</entry><entry>Primary DNS address. Example: 0x7F000201 is 127.0.2.1 Not used by modem, provided only for host storage convenience.</entry><entry>16 bytes</entry></row><row><entry>Secondary DNS address length</entry><entry>Length of Secondary DNS address. Valid range 0- 16.0 indicates no DNS address present. Not used by modem, provided only for host storage convenience.</entry><entry>1 byte</entry></row><row><entry>Secondary DNS address</entry><entry>Secondary DNS address. Example: 0x7F000201 is 127.0.21 Not used by modem, provided only for host storage convenience.</entry><entry>16 bytes</entry></row><row><entry>PPP name</entry><entry>32-character NULL terminated string. Not used by modem, provided only for host storage convenience,</entry><entry>33 bytes</entry></row><row><entry>PPP password</entry><entry>32-character NULL terminated string. Not used by modem, provided only for host storage convenience.</entry><entry>33 bytes</entry></row></tbody></tgroup></table></tables>

4.3.3 Configuration Information Response

This response is sent from the modem to the host in response to the Configuration Information Request.

Message Id: 0x08

Message Specific Parameter: Response error code. <ul id="ul0005" list-style="bullet" compact="compact"><li>0x00 - Success, configuration valid</li><li>0x01 - Error, configuration invalid for protocol type specified</li></ul>

Message payload always contains the profile information of the ID specified regardless of set or query operation. <tables id="tabl0028" num="0028"><table frame="all"><tgroup cols="3"><colspec colnum="1" colname="col1" colwidth="45mm" /><colspec colnum="2" colname="col2" colwidth="101mm" /><colspec colnum="3" colname="col3" colwidth="21mm" /><tbody><row><entry>Protocol type</entry><entry>Specifies the format used for this message. Allows multiple wireless technologies to use same command ID for differing message formats 0 - GPRS 1 - UMTS 2- 255 Reserved for future wireless protocols</entry><entry>I byte</entry></row><row><entry>Query/Set flag</entry><entry>Indicates if request is a set or query Operation. Profile information is optional in a query operation. The response always contain profile information regardless of query/set flag. 00 - Query of profile information. 01- Set of profile information.</entry><entry>1 byte</entry></row><row><entry>Profile ID</entry><entry>ID specifying which profile is being acted on (queried or set). Range dependent on protocol. GFRS - range is 0 - 2</entry><entry>I byte</entry></row><row><entry>Length</entry><entry>Length of the following variable field (protocol specific configuration message)</entry><entry>2 bytes</entry></row><row><entry>Configuration buffer Protocol specific configuration buffer.</entry><entry>Format varies depending on the protocol type field. See 4.3.2.1</entry><entry>Variable length</entry></row></tbody></tgroup></table></tables>

4.3.4 Packet Session Activation Request

The Packet Session Activation Request is a message sent by the host to initiate a packet session on the modem device (in GPRS this is a context activation). An example usage would be in the GPRS product when a host application submits the OID_WW_GPRS_CONTEXT_ACTIVATION OID. Note that a Packet Session Response message will always be sent in response to a Packet Session Request message. <tables id="tabl0029" num="0029"><table frame="all"><tgroup cols="5"><colspec colnum="1" colname="col1" colwidth="9mm" /><colspec colnum="2" colname="col2" colwidth="25mm" /><colspec colnum="3" colname="col3" colwidth="113mm" /><colspec colnum="4" colname="col4" colwidth="12mm" /><colspec colnum="5" colname="col5" colwidth="9mm" /><tbody><row><entry namest="col1" nameend="col5" rowsep="0" align="left">Message Id: 0x09</entry></row><row><entry namest="col1" nameend="col5" rowsep="0" align="left">Message Specific Parameter: unused.</entry></row><row><entry namest="col1" nameend="col5" align="left">Message payload consists of the following information structure:</entry></row><row><entry morerows="1" /><entry>Context ID or Packet session ID</entry><entry>This field is always present however it's use is optional (dependent on on the wireless protocol is use). GPRS - This field is defined as the Context ID. Identifies the context id being activated or deactivated (valid range of values can be derived using the PDP Context Summary Request M.I.P. message-but planned range is 0-2). The card will issue an error response message if the Context ID is out of range or invalid.</entry><entry>1 byte</entry><entry morerows="1" /></row><row><entry>Action</entry><entry>0x00 - Activate the packet session 0x01 - Deactivate the packet session</entry><entry>1 byte</entry></row></tbody></tgroup></table></tables>

4.3.5 Packet Session Activation Response

This response is sent from the modem to the host in response to the Packet Session Activation Request. <tables id="tabl0030" num="0030"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x49</entry></row><row rowsep="0"><entry>Message Specific Parameter: Error code. Possible values are:</entry></row><row rowsep="0"><entry>0 - success</entry></row><row rowsep="0"><entry>1 - failure</entry></row><row><entry>The message payload is optional If present it will consist of a "short" NULL terminated ASCII error string describing the error reason. Maximum payload length is 33 bytes (32 characters plus NULL terminator). This is only provided to aid in the process of debugging host software (terse strings are preferred).</entry></row></tbody></tgroup></table></tables>

4.3.6 Link Status Indication.

The Link Status Indication is an unsolicited message sent by the modem to inform the host of a change in packet session status. This indication is to be used by the host driver (NDIS) to detect state changes in the packet session. <ul id="ul0006" list-style="none" compact="compact"><li>Message Id: 0x69</li><li>Message Specific Parameter: unused</li></ul>

Message payload consists of the following information structure: <tables id="tabl0031" num="0031"><table frame="all"><tgroup cols="3"><colspec colnum="1" colname="col1" colwidth="36mm" /><colspec colnum="2" colname="col2" colwidth="116mm" /><colspec colnum="3" colname="col3" colwidth="15mm" /><tbody><row><entry>Session ID (or Context ID)</entry><entry>Optional field always present but may not be used in all wireless protocol products.: Identifies the packet session (or GPRS context) which has changed state (valid range of values can be derived using the PDP Context Info Req. H.I.P. message - but usual range is 0-2. 255 is used when not related to any specific session, i.e. at start-up).</entry><entry>1 byte</entry></row><row rowsep="0"><entry>Coverage Code</entry><entry>0x00 - No coverage</entry><entry>1 byte</entry></row><row rowsep="0">&lt;entry /&gt;<entry>0x01 - Coverage, but no packet coverage available</entry>&lt;entry /&gt;</row><row rowsep="0">&lt;entry /&gt;<entry>0x02 - Coverage, packet coverage available</entry>&lt;entry /&gt;</row><row>&lt;entry /&gt;<entry>0x03 - Active packet session is established</entry>&lt;entry /&gt;</row><row rowsep="0"><entry>Session State</entry><entry>0x01 -NDIS CSC Data (for 1x)</entry><entry>1 byte</entry></row><row rowsep="0">&lt;entry /&gt;<entry>0x02 - NDIS Voice Call (for 1x)</entry>&lt;entry /&gt;</row><row rowsep="0">&lt;entry /&gt;<entry>0x04 - MDIS Packet</entry>&lt;entry /&gt;</row><row rowsep="0">&lt;entry /&gt;<entry>0x10 - UART CSC Data</entry>&lt;entry /&gt;</row><row rowsep="0">&lt;entry /&gt;<entry>0x20 - UART Voice</entry>&lt;entry /&gt;</row><row>&lt;entry /&gt;<entry>0x40 - UART Packet (for 1x)</entry>&lt;entry /&gt;</row><row><entry>Reason string</entry><entry>Descriptive NULL terminated string indicating the reason for link status change. Max string length is 32 characters plus a terminating NULL. Shorter strings may be used but buffer length will always be fixed at 33 bytes.</entry><entry>33 bytes</entry></row><row rowsep="0"><entry morerows="1">Active session link type (PDP context type)</entry><entry>0 - IPv4 session type</entry><entry>1 byte</entry></row><row rowsep="0"><entry>1 - PPP session type</entry>&lt;entry /&gt;</row><row rowsep="0">&lt;entry /&gt;<entry>2 - IPv6 session type</entry>&lt;entry /&gt;</row><row>&lt;entry /&gt;<entry>255 - Unknown (no session established)</entry>&lt;entry /&gt;</row><row><entry>Session (PDP) address length</entry><entry>Length of session address below (0 - 16 bytes). 0 indicates no address provided by network (PPP session type).</entry><entry>1 byte</entry></row><row><entry>Session (PDP) address</entry><entry>IP address of the session</entry><entry>16</entry></row><row><entry>QOS precedence</entry><entry>Valid range 1 - 3</entry><entry>1 byte</entry></row><row><entry>QOS delay</entry><entry>Valid range 1 - 4</entry><entry>1 byte</entry></row><row><entry>QOS reliability</entry><entry>Valid range 1 - 5</entry><entry>1 byte</entry></row><row><entry>QOS peak</entry><entry>Valid range 1 - 9</entry><entry>1 byte</entry></row><row><entry>QOS mean</entry><entry>Valid range 1 - 31</entry><entry>1 byte</entry></row></tbody></tgroup></table></tables>

4.3.7 Abort Indication

The Abort Indication is an unsolicited message sent by the card when it is aborting to inform the host of the reason for aborting. <tables id="tabl0032" num="0032"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="122mm" /><tbody><row rowsep="0"><entry>Message Id: 0x6A</entry></row><row rowsep="0"><entry>Message Specific Parameter: Unused</entry></row><row><entry>Message payload consists of error code followed by a null terminated error string.</entry></row></tbody></tgroup></table></tables>

4.3.8 Modem Control and Status Indication

The Modem Control and Status Indication is an unsolicited message sent by the host to the modem for transport of control and status protocol packets. <tables id="tabl0033" num="0033"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="134mm" /><tbody><row rowsep="0"><entry>Message Id:0x2B</entry></row><row rowsep="0"><entry>Message Specific Parameter: Unused</entry></row><row><entry>The message payload is defined in reference R-6 (CWE Control and Status Protocol).</entry></row></tbody></tgroup></table></tables>

4.3.9 Host Control and Status Indication

The Host Control and Status Indication is an unsolicited message sent by the modem to the host for transport of control and status protocol packets. <tables id="tabl0034" num="0034"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="134mm" /><tbody><row rowsep="0"><entry>Message Id: 0x6B</entry></row><row rowsep="0"><entry>Message Specific Parameter: Unused</entry></row><row><entry>The message payload is defined in reference R-6 (CWE Control and Status Protocol).</entry></row></tbody></tgroup></table></tables>

4.3.10 Loop Back Request

The Loop Back Request is sent from the host to the card. The Message Payload of this request will be echo-ed back to the host in the Message Payload of the Loop Back Response. This message is used for testing firmware, host drivers and application software. The intent is not to use this message during normal operation. <ul id="ul0007" list-style="none"><li>Message Id: 0x03</li><li>Message Specific Parameter: unused</li></ul><tables id="tabl0035" num="0035"><table frame="all"><tgroup cols="3" rowsep="0"><colspec colnum="1" colname="col1" colwidth="26mm" /><colspec colnum="2" colname="col2" colwidth="54mm" /><colspec colnum="3" colname="col3" colwidth="28mm" /><tbody><row rowsep="1"><entry>Loopback data</entry><entry>Data to be looped back in response</entry><entry>0 to max payload</entry></row></tbody></tgroup></table></tables>

The loopback request is stop and wait such that after the host has sent a loop back request to the card it should not send another loop back request until it has received a loop back response from the card.

The card will discard additional loop back requests if it is currently processing a loop back response.

4.3.11 Loop Back Response

The Loop Back Response is sent from the card to the host in response to a Loop Back Request. The contents of the Message Payload will be those of the received Message Payload of the Loop Back Request. This message is used for testing firmware, host drivers and application software. The intent is not to use this message during normal operation. <ul id="ul0008" list-style="none"><li>Message Id: 0x43</li><li>Message Specific Parameter: firmware image sending the response <ul id="ul0009" list-style="bullet" compact="compact"><li>0x00 - response was sent from boot loader image.</li><li>0x01 - response was sent from application image.</li></ul></li></ul><tables id="tabl0036" num="0036"><table frame="all"><tgroup cols="3" rowsep="0"><colspec colnum="1" colname="col1" colwidth="26mm" /><colspec colnum="2" colname="col2" colwidth="48mm" /><colspec colnum="3" colname="col3" colwidth="28mm" /><tbody><row rowsep="1"><entry>Loopback data</entry><entry>Data received from host request</entry><entry>0 to max payload</entry></row></tbody></tgroup></table></tables>

4.3.12 PDP Context Summary Request

The PDP Context Summary Request is sent by the host PC to the card to request a summary about the all of the PDP Contexts on the card. This message is also used to store the user's default context id (user profile). The expected response to this message is the PDP Context Summary Response message. <ul id="ul0010" list-style="none"><li>Message Id: 0x05</li><li>Message Specific Parameter: unused.</li></ul>

The message payload is defined as follows: <tables id="tabl0037" num="0037"><table frame="all"><tgroup cols="3"><colspec colnum="1" colname="col1" colwidth="36mm" /><colspec colnum="2" colname="col2" colwidth="109mm" /><colspec colnum="3" colname="col3" colwidth="16mm" /><tbody><row rowsep="0"><entry>Update flag</entry><entry>The update flag indicates if the user wants to update tht default context id field.</entry><entry>1 byte</entry></row><row rowsep="0">&lt;entry /&gt;<entry>0x00 - don't update</entry>&lt;entry /&gt;</row><row>&lt;entry /&gt;<entry>0x01 - Update modern non-volatile ram with default context id.</entry>&lt;entry /&gt;</row><row><entry>Default context ID field</entry><entry>User's default context ID. Valid range is 1 - 16.</entry><entry>1 byte</entry></row></tbody></tgroup></table></tables>

This message is stop and wait. Additional messages will be discarded by the modem until the response is sent.

<b>Usage note:</b> At start-up the host would sent this request with the "Update flag" set to 0x00 in order to read the context profile summary without changing the default context ID field.

After the user has changed the default context ID this request would be sent with the "Update flag" set to 0x01 in order to save the new default setting.

4.3.13 PDP Context Summary Response

The PDP Context Summary Response is sent from the card to the host in response to a PDP Context Summary Request. <ul id="ul0011" list-style="none" compact="compact"><li>Message Id: 0x45</li><li>Message Specific Parameter: Unused</li></ul>

Message payload consists of the following PDP Context information structure: <tables id="tabl0038" num="0038"><table frame="all"><tgroup cols="3"><colspec colnum="1" colname="col1" colwidth="36mm" /><colspec colnum="2" colname="col2" colwidth="90mm" /><colspec colnum="3" colname="col3" colwidth="16mm" /><tbody><row><entry>noOfDefCont</entry><entry>Number of defined PDP Contexts currently defined on the card</entry><entry>1 byte.</entry></row><row><entry>maxNoOfCont</entry><entry>Maximum number of defined contexts that the card supports</entry><entry>1 byte</entry></row><row><entry>Default context ID field</entry><entry>User's default context ID. Valid range is 1 - 16.</entry><entry>1 byte</entry></row><row><entry>cid1value</entry><entry>The value for defined Context ID 1</entry><entry>1 byte</entry></row><row rowsep="0"><entry>cid1state</entry><entry>Status of Context ID 1</entry><entry>1 byte</entry></row><row rowsep="0">&lt;entry /&gt;<entry>0x00 - Active</entry>&lt;entry /&gt;</row><row rowsep="0">&lt;entry /&gt;<entry>0x01 - Inactive</entry>&lt;entry /&gt;</row><row>&lt;entry /&gt;<entry>0x02 - Deleted</entry>&lt;entry /&gt;</row><row>&lt;entry /&gt;<entry>···</entry>&lt;entry /&gt;</row><row><entry>cid16value</entry><entry>The value for defined Context ID 3</entry><entry>1 byte</entry></row><row rowsep="0"><entry>cid16state</entry><entry>Status of Context ID 3</entry><entry>1 byte</entry></row><row rowsep="0">&lt;entry /&gt;<entry>0x00 - Active</entry>&lt;entry /&gt;</row><row rowsep="0">&lt;entry /&gt;<entry>0x01 - Inactive</entry>&lt;entry /&gt;</row><row>&lt;entry /&gt;<entry>0x02 - Deleted</entry>&lt;entry /&gt;</row></tbody></tgroup></table></tables>

4.3.14 Host Environment Indication

The Host Environment Indication will send information about the host to the card. This unsolicited message will be sent anytime after a Restart Indication from the card indicating the host's enviroment capabilties. No response is defined for this message. <ul id="ul0012" list-style="none" compact="compact"><li>Message Id: 0x2F</li><li>Message Specific Parameter: Unused</li></ul>

Message payload consists of the following PDP information structure: <tables id="tabl0039" num="0039"><table frame="all"><tgroup cols="3" rowsep="0"><colspec colnum="1" colname="col1" colwidth="34mm" /><colspec colnum="2" colname="col2" colwidth="119mm" /><colspec colnum="3" colname="col3" colwidth="13mm" /><tbody><row><entry>Modem deep sleep support</entry><entry>This field is used to inform the modem of the host's capability of supporting deep sleep of the modern in which the clock signal is removed from the host interface logic. possible values are:</entry><entry>1 byte</entry></row><row>&lt;entry /&gt;<entry>00 - Host does not support modem deep sleep (i.e. the interface logic must remain fully operational at all times).</entry>&lt;entry /&gt;</row><row rowsep="1">&lt;entry /&gt;<entry>01- Host does support modern deep sleep (i.e. the clock to the host interface logic can be removed). The host will use the sleep logic signals specified in the CWE host interface document.</entry>&lt;entry /&gt;</row><row rowsep="1"><entry>Host MTU size</entry><entry>The maximum transmission unit size (in bytes) used by the host for IP data-grams. This information can be useful to the card for managing flow control of IP packets to the modem.</entry><entry>2 bytes</entry></row></tbody></tgroup></table></tables>

Debugging Messages

4.3.15 Modem SWI Command Indication

The Modem SKI Command Indication is used to send an unsolicited string from the host to the modem where no response is expected. The purpose is to implement simple command line user interfaces that provide additional debugging information. <tables id="tabl0040" num="0040"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="125mm" /><tbody><row rowsep="0"><entry>Message Id: 0x24</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>The message payload consists of a variable length null terminated response string.</entry></row></tbody></tgroup></table></tables>

4.3.16 Host SWI Command Indication

The Host SWI Command Indication is used to send an unsolicited string from the modem to the host where no response is expected. The purpose is to implement simple command line user interfaces that provide additional debugging information. <tables id="tabl0041" num="0041"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="125mm" /><tbody><row rowsep="0"><entry>Message Id: 0x65</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>The message payload consists of a variable length null terminated response string.</entry></row></tbody></tgroup></table></tables>

4.3.17 Modem Protocol Stack Indication

The Modem Protocol Stack Indication is sent by the host PC to the card to communicate with the protocol stack diagnostic tool on the card. An example of this is the Qualcomm CAIT debug stream or the TTPcom genie stream. <tables id="tabl0042" num="0042"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x2D</entry></row><row rowsep="0"><entry>Message Specific Parameter: Depends on protocol stack used, can provide additional multiplexing such that multiple debug streams can be carried with this same command ID.</entry></row><row><entry>The message payload consists of a variable length binary data.</entry></row></tbody></tgroup></table></tables>

4.3.18 Host Protocol Stack Indication

The Host Protocol Stack Indication is sent by the card to the host PC to communicate with the protocol stack diagnostic tool on the host. Examples of use are the CAIT and Genie debug streams. <tables id="tabl0043" num="0043"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="161mm" /><tbody><row rowsep="0"><entry>Message Id: 0x6D</entry></row><row rowsep="0"><entry>Message Specific Parameter: Depends on stack used. This can provide additional multiplexing such that multiple debug streams can be carried with this same command ID.</entry></row><row><entry>The message payload consists of a variable length binary data.</entry></row></tbody></tgroup></table></tables>

4.3.19 Modem AT Command Indication

The Modem AT Command <b>Indication</b> is sent by the host PC to the card. This message comprises an AT command that should be processed by the card. <tables id="tabl0044" num="0044"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="112mm" /><tbody><row rowsep="0"><entry>Message Id: 0x2C</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>The message payload consists of a variable length null terminated string.</entry></row></tbody></tgroup></table></tables>

4.3.20 Host AT Command Indication

The Host AT Command Indication is sent by the card to the host PC. This message comprises an AT command response or unsolicited AT command indication. <tables id="tabl0045" num="0045"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="112mm" /><tbody><row rowsep="0"><entry>Message Id: 0x6C</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>The message payload consists of a variable length null terminated string.</entry></row></tbody></tgroup></table></tables>

4.3.21 Modem (Rosetta) Debug Log Indication

The Modem (Rosetta) Debug Log Indication is used to send an unsolicited string from the host to the modem where no response is expected. <tables id="tabl0046" num="0046"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="125mm" /><tbody><row rowsep="0"><entry>Message Id: 0x2E</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>The message payload consists of a variable length null terminated response string.</entry></row></tbody></tgroup></table></tables>

Editor's note: It's unclear if this message is required.

4.3.22 Host (Rosetta) Debug Log Indication

The Host (Rosetta) Debug Log Indication is used to send an unsolicited string from the modem to the host where no response is expected. <tables id="tabl0047" num="0047"><table frame="all"><tgroup cols="1"><colspec colnum="1" colname="col1" colwidth="125mm" /><tbody><row rowsep="0"><entry>Message Id: 0x6E</entry></row><row rowsep="0"><entry>Message Specific Parameter: unused</entry></row><row><entry>The message payload consists of a variable length null terminated response string.</entry></row></tbody></tgroup></table></tables>

Editor's note: It's unclear if this message is required.

A. Editor

'

s notes

<ul id="ul0013" list-style="bullet"><li>Need to define which messages are mandatory and which are optional.</li><li>Add start-up sequencing document.</li><li>Check that error strings are variable length</li><li>Remove table around table concept (might be causing word to crash).</li><li>Need to change wording of context ID to profile id.</li></ul>