Debian Codegraph @

gobi-api/Gobi_2011-11-28-1533/Core/ProtocolEnum.h

raw
1 /*===========================================================================
2 FILE:
3 ProtocolEnum.h
4
5 DESCRIPTION:
6 Generic protocol enumerations and related methods
7
8 PUBLIC ENUMERATIONS AND METHODS:
9 eProtocolType
10
11 Copyright (c) 2011, Code Aurora Forum. All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of Code Aurora Forum nor
21 the names of its contributors may be used to endorse or promote
22 products derived from this software without specific prior written
23 permission.
24
25
26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
30 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 POSSIBILITY OF SUCH DAMAGE.
37 ===========================================================================*/
38
39 //---------------------------------------------------------------------------
40 // Pragmas
41 //---------------------------------------------------------------------------
42 #pragma once
43
44 //---------------------------------------------------------------------------
45 // Definitions
46 //---------------------------------------------------------------------------
47
48 /*=========================================================================*/
49 // eProtocolType Enumeration
50 //
51 // NOTE: QMI protocol types need to be in the same order as eQMIService
52 // with RX added first then TX
53 /*=========================================================================*/
54 enum eProtocolType
55 {
56 ePROTOCOL_ENUM_BEGIN = -1,
57
58 ePROTOCOL_COMMAND, // 000 Protocol server command
59 ePROTOCOL_AT, // 001 AT command protocol
60 ePROTOCOL_NMEA, // 002 NMEA (GPS) protocol
61 ePROTOCOL_DIAG_RX, // 003 DIAG protocol (incoming)
62 ePROTOCOL_DIAG_TX, // 004 DIAG protocol (outgoing)
63 ePROTOCOL_DOWNLOAD_RX, // 005 Download protocol (incoming)
64 ePROTOCOL_DOWNLOAD_TX, // 006 Download protocol (outgoing)
65 ePROTOCOL_SDOWNLOAD_RX, // 007 Streaming download protocol (incoming)
66 ePROTOCOL_SDOWNLOAD_TX, // 008 Streaming download protocol (outgoing)
67 ePROTOCOL_QDL_RX, // 009 QDL streaming protocol (incoming)
68 ePROTOCOL_QDL_TX, // 010 QDL streaming protocol (outgoing)
69
70 ePROTOCOL_QMI_CTL_RX = 60, // 060 QMI CTL protocol (incoming)
71 ePROTOCOL_QMI_CTL_TX, // 061 QMI CTL protocol (outgoing)
72 ePROTOCOL_QMI_WDS_RX, // 062 QMI WDS protocol (incoming)
73 ePROTOCOL_QMI_WDS_TX, // 063 QMI WDS protocol (outgoing)
74 ePROTOCOL_QMI_DMS_RX, // 064 QMI DMS protocol (incoming)
75 ePROTOCOL_QMI_DMS_TX, // 065 QMI DMS protocol (outgoing)
76 ePROTOCOL_QMI_NAS_RX, // 066 QMI NAS protocol (incoming)
77 ePROTOCOL_QMI_NAS_TX, // 067 QMI NAS protocol (outgoing)
78 ePROTOCOL_QMI_QOS_RX, // 068 QMI QOS protocol (incoming)
79 ePROTOCOL_QMI_QOS_TX, // 069 QMI QOS protocol (outgoing)
80 ePROTOCOL_QMI_WMS_RX, // 070 QMI WMS protocol (incoming)
81 ePROTOCOL_QMI_WMS_TX, // 071 QMI WMS protocol (outgoing)
82 ePROTOCOL_QMI_PDS_RX, // 072 QMI PDS protocol (incoming)
83 ePROTOCOL_QMI_PDS_TX, // 073 QMI PDS protocol (outgoing)
84 ePROTOCOL_QMI_AUTH_RX, // 074 QMI AUTH protocol (incoming)
85 ePROTOCOL_QMI_AUTH_TX, // 075 QMI AUTH protocol (outgoing)
86 ePROTOCOL_QMI_AT_RX, // 076 QMI AUTH protocol (incoming)
87 ePROTOCOL_QMI_AT_TX, // 077 QMI AUTH protocol (outgoing)
88 ePROTOCOL_QMI_VOICE_RX, // 078 QMI Voice protocol (incoming)
89 ePROTOCOL_QMI_VOICE_TX, // 079 QMI Voice protocol (outgoing)
90 ePROTOCOL_QMI_CAT2_RX, // 080 QMI CAT (new) protocol (incoming)
91 ePROTOCOL_QMI_CAT2_TX, // 081 QMI CAT (new) protocol (outgoing)
92 ePROTOCOL_QMI_UIM_RX, // 082 QMI UIM protocol (incoming)
93 ePROTOCOL_QMI_UIM_TX, // 083 QMI UIM protocol (outgoing)
94 ePROTOCOL_QMI_PBM_RX, // 084 QMI PBM protocol (incoming)
95 ePROTOCOL_QMI_PBM_TX, // 085 QMI PBM protocol (outgoing)
96 ePROTOCOL_QMI_13_RX, // 086 QMI service ID 13 protocol (incoming)
97 ePROTOCOL_QMI_13_TX, // 087 QMI service ID 13 protocol (outgoing)
98 ePROTOCOL_QMI_14_RX, // 088 QMI service ID 14 protocol (incoming)
99 ePROTOCOL_QMI_14_TX, // 089 QMI service ID 14 protocol (outgoing)
100 ePROTOCOL_QMI_15_RX, // 090 QMI service ID 15 protocol (incoming)
101 ePROTOCOL_QMI_15_TX, // 091 QMI service ID 15 protocol (outgoing)
102 ePROTOCOL_QMI_LOC_RX, // 092 QMI UIM protocol (incoming)
103 ePROTOCOL_QMI_LOC_TX, // 093 QMI UIM protocol (outgoing)
104 ePROTOCOL_QMI_SAR_RX, // 094 QMI PBM protocol (incoming)
105 ePROTOCOL_QMI_SAR_TX, // 095 QMI PBM protocol (outgoing)
106 ePROTOCOL_QMI_18_RX, // 096 QMI service ID 18 protocol (incoming)
107 ePROTOCOL_QMI_18_TX, // 097 QMI service ID 18 protocol (outgoing)
108 ePROTOCOL_QMI_19_RX, // 098 QMI service ID 19 protocol (incoming)
109 ePROTOCOL_QMI_19_TX, // 099 QMI service ID 19 protocol (outgoing)
110 ePROTOCOL_QMI_RMTFS_RX, // 100 QMI RMTFS protocol (incoming)
111 ePROTOCOL_QMI_RMTFS_TX, // 101 QMI RMTFS protocol (outgoing)
112 ePROTOCOL_QMI_21_RX, // 102 QMI service ID 21 protocol (incoming)
113 ePROTOCOL_QMI_21_TX, // 103 QMI service ID 21 protocol (outgoing)
114 ePROTOCOL_QMI_22_RX, // 104 QMI service ID 22 protocol (incoming)
115 ePROTOCOL_QMI_22_TX, // 105 QMI service ID 22 protocol (outgoing)
116 ePROTOCOL_QMI_23_RX, // 106 QMI service ID 23 protocol (incoming)
117 ePROTOCOL_QMI_23_TX, // 107 QMI service ID 23 protocol (outgoing)
118 ePROTOCOL_QMI_24_RX, // 108 QMI service ID 24 protocol (incoming)
119 ePROTOCOL_QMI_24_TX, // 109 QMI service ID 24 protocol (outgoing)
120
121 ePROTOCOL_QMI_CAT_RX = 508, // 508 QMI CAT protocol (incoming)
122 ePROTOCOL_QMI_CAT_TX, // 509 QMI CAT protocol (outgoing)
123 ePROTOCOL_QMI_RMS_RX, // 510 QMI RMS protocol (incoming)
124 ePROTOCOL_QMI_RMS_TX, // 511 QMI RMS protocol (outgoing)
125 ePROTOCOL_QMI_OMA_RX, // 512 QMI OMA protocol (incoming)
126 ePROTOCOL_QMI_OMA_TX, // 513 QMI OMA protocol (outgoing)
127
128 ePROTOCOL_ENUM_END
129 };
130
131 /*===========================================================================
132 METHOD:
133 IsValid (Inline Method)
134
135 DESCRIPTION:
136 eProtocolType validity check
137
138 PARAMETERS:
139 pt [ I ] - Enum value being verified
140
141 RETURN VALUE:
142 bool
143 ===========================================================================*/
144 inline bool IsValid( eProtocolType pt )
145 {
146 bool retVal = false;
147 if ( (pt > ePROTOCOL_ENUM_BEGIN && pt <= ePROTOCOL_QDL_TX)
148 || (pt >= ePROTOCOL_QMI_CTL_RX && pt <= ePROTOCOL_QMI_24_TX)
149 || (pt >= ePROTOCOL_QMI_CAT_RX && pt < ePROTOCOL_ENUM_END) )
150 {
151 retVal = true;
152 }
153
154 return retVal;
155 };
156
157 /*===========================================================================
158 METHOD:
159 IsQMIProtocol (Inline Method)
160
161 DESCRIPTION:
162 Does the passed in value represent a QMI protocol?
163
164 PARAMETERS:
165 pt [ I ] - Enum value being checked
166
167 RETURN VALUE:
168 bool
169 ===========================================================================*/
170 inline bool IsQMIProtocol( eProtocolType pt )
171 {
172 bool retVal = false;
173 if ( (pt >= ePROTOCOL_QMI_CTL_RX && pt <= ePROTOCOL_QMI_24_TX)
174 || (pt >= ePROTOCOL_QMI_CAT_RX && pt < ePROTOCOL_ENUM_END) )
175 {
176 retVal = true;
177 }
178
179 return retVal;
180 };
181
182 /*===========================================================================
183 METHOD:
184 IsQMIProtocolRX (Inline Method)
185
186 DESCRIPTION:
187 Does the passed in value represent a QMI protocol and if so in the
188 incoming direction?
189
190 PARAMETERS:
191 pt [ I ] - Enum value being checked
192
193 RETURN VALUE:
194 bool
195 ===========================================================================*/
196 inline bool IsQMIProtocolRX( eProtocolType pt )
197 {
198 bool retVal = false;
199
200 // QMI protocol values that are even are RX
201 if ( (IsQMIProtocol( pt ) == true)
202 && ((DWORD)pt % 2 == 0) )
203 {
204 retVal = true;
205 }
206
207 return retVal;
208 };
209
210 /*===========================================================================
211 METHOD:
212 IsQMIProtocolTX (Inline Method)
213
214 DESCRIPTION:
215 Does the passed in value represent a QMI protocol and if so in the
216 outgoing direction?
217
218 PARAMETERS:
219 pt [ I ] - Enum value being checked
220
221 RETURN VALUE:
222 bool
223 ===========================================================================*/
224 inline bool IsQMIProtocolTX( eProtocolType pt )
225 {
226 bool retVal = false;
227
228 // QMI protocol values that are odd are TX
229 if ( (IsQMIProtocol( pt ) == true)
230 && ((DWORD)pt % 2 == 1) )
231 {
232 retVal = true;
233 }
234
235 return retVal;
236 };