| 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) 2012, 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_RMTFS_RX, // 088 QMI RMTFS protocol (incoming) |
| 99 |
ePROTOCOL_QMI_RMTFS_TX, // 089 QMI RMTFS 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_CSD_RX, // 100 QMI CSD protocol (incoming) |
| 111 |
ePROTOCOL_QMI_CSD_TX, // 101 QMI CSD protocol (outgoing) |
| 112 |
ePROTOCOL_QMI_EFS_RX, // 102 QMI EFS protocol (incoming) |
| 113 |
ePROTOCOL_QMI_EFS_TX, // 103 QMI EFS 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_TS_RX, // 106 QMI TS protocol (incoming) |
| 117 |
ePROTOCOL_QMI_TS_TX, // 107 QMI TS protocol (outgoing) |
| 118 |
ePROTOCOL_QMI_TMD_RX, // 108 QMI TMD protocol (incoming) |
| 119 |
ePROTOCOL_QMI_TMD_TX, // 109 QMI TMD protocol (outgoing) |
| 120 |
ePROTOCOL_QMI_25_RX, // 110 QMI service ID 25 protocol (incoming) |
| 121 |
ePROTOCOL_QMI_25_TX, // 111 QMI service ID 25 protocol (outgoing) |
| 122 |
ePROTOCOL_QMI_26_RX, // 112 QMI service ID 26 protocol (incoming) |
| 123 |
ePROTOCOL_QMI_26_TX, // 113 QMI service ID 26 protocol (outgoing) |
| 124 |
ePROTOCOL_QMI_27_RX, // 114 QMI service ID 27 protocol (incoming) |
| 125 |
ePROTOCOL_QMI_27_TX, // 115 QMI service ID 27 protocol (outgoing) |
| 126 |
ePROTOCOL_QMI_28_RX, // 116 QMI service ID 28 protocol (incoming) |
| 127 |
ePROTOCOL_QMI_28_TX, // 117 QMI service ID 28 protocol (outgoing) |
| 128 |
|
| 129 |
ePROTOCOL_QMI_CAT_RX = 508, // 508 QMI CAT protocol (incoming) |
| 130 |
ePROTOCOL_QMI_CAT_TX, // 509 QMI CAT protocol (outgoing) |
| 131 |
ePROTOCOL_QMI_RMS_RX, // 510 QMI RMS protocol (incoming) |
| 132 |
ePROTOCOL_QMI_RMS_TX, // 511 QMI RMS protocol (outgoing) |
| 133 |
ePROTOCOL_QMI_OMA_RX, // 512 QMI OMA protocol (incoming) |
| 134 |
ePROTOCOL_QMI_OMA_TX, // 513 QMI OMA protocol (outgoing) |
| 135 |
|
| 136 |
ePROTOCOL_ENUM_END |
| 137 |
}; |
| 138 |
|
| 139 |
/*=========================================================================== |
| 140 |
METHOD: |
| 141 |
IsValid (Inline Method) |
| 142 |
|
| 143 |
DESCRIPTION: |
| 144 |
eProtocolType validity check |
| 145 |
|
| 146 |
PARAMETERS: |
| 147 |
pt [ I ] - Enum value being verified |
| 148 |
|
| 149 |
RETURN VALUE: |
| 150 |
bool |
| 151 |
===========================================================================*/ |
| 152 |
inline bool IsValid( eProtocolType pt ) |
| 153 |
{ |
| 154 |
bool retVal = false; |
| 155 |
if ( (pt > ePROTOCOL_ENUM_BEGIN && pt <= ePROTOCOL_QDL_TX) |
| 156 |
|| (pt >= ePROTOCOL_QMI_CTL_RX && pt <= ePROTOCOL_QMI_28_TX) |
| 157 |
|| (pt >= ePROTOCOL_QMI_CAT_RX && pt < ePROTOCOL_ENUM_END) ) |
| 158 |
{ |
| 159 |
retVal = true; |
| 160 |
} |
| 161 |
|
| 162 |
return retVal; |
| 163 |
}; |
| 164 |
|
| 165 |
/*=========================================================================== |
| 166 |
METHOD: |
| 167 |
IsQMIProtocol (Inline Method) |
| 168 |
|
| 169 |
DESCRIPTION: |
| 170 |
Does the passed in value represent a QMI protocol? |
| 171 |
|
| 172 |
PARAMETERS: |
| 173 |
pt [ I ] - Enum value being checked |
| 174 |
|
| 175 |
RETURN VALUE: |
| 176 |
bool |
| 177 |
===========================================================================*/ |
| 178 |
inline bool IsQMIProtocol( eProtocolType pt ) |
| 179 |
{ |
| 180 |
bool retVal = false; |
| 181 |
if ( (pt >= ePROTOCOL_QMI_CTL_RX && pt <= ePROTOCOL_QMI_28_TX) |
| 182 |
|| (pt >= ePROTOCOL_QMI_CAT_RX && pt < ePROTOCOL_ENUM_END) ) |
| 183 |
{ |
| 184 |
retVal = true; |
| 185 |
} |
| 186 |
|
| 187 |
return retVal; |
| 188 |
}; |
| 189 |
|
| 190 |
/*=========================================================================== |
| 191 |
METHOD: |
| 192 |
IsQMIProtocolRX (Inline Method) |
| 193 |
|
| 194 |
DESCRIPTION: |
| 195 |
Does the passed in value represent a QMI protocol and if so in the |
| 196 |
incoming direction? |
| 197 |
|
| 198 |
PARAMETERS: |
| 199 |
pt [ I ] - Enum value being checked |
| 200 |
|
| 201 |
RETURN VALUE: |
| 202 |
bool |
| 203 |
===========================================================================*/ |
| 204 |
inline bool IsQMIProtocolRX( eProtocolType pt ) |
| 205 |
{ |
| 206 |
bool retVal = false; |
| 207 |
|
| 208 |
// QMI protocol values that are even are RX |
| 209 |
if ( (IsQMIProtocol( pt ) == true) |
| 210 |
&& ((DWORD)pt % 2 == 0) ) |
| 211 |
{ |
| 212 |
retVal = true; |
| 213 |
} |
| 214 |
|
| 215 |
return retVal; |
| 216 |
}; |
| 217 |
|
| 218 |
/*=========================================================================== |
| 219 |
METHOD: |
| 220 |
IsQMIProtocolTX (Inline Method) |
| 221 |
|
| 222 |
DESCRIPTION: |
| 223 |
Does the passed in value represent a QMI protocol and if so in the |
| 224 |
outgoing direction? |
| 225 |
|
| 226 |
PARAMETERS: |
| 227 |
pt [ I ] - Enum value being checked |
| 228 |
|
| 229 |
RETURN VALUE: |
| 230 |
bool |
| 231 |
===========================================================================*/ |
| 232 |
inline bool IsQMIProtocolTX( eProtocolType pt ) |
| 233 |
{ |
| 234 |
bool retVal = false; |
| 235 |
|
| 236 |
// QMI protocol values that are odd are TX |
| 237 |
if ( (IsQMIProtocol( pt ) == true) |
| 238 |
&& ((DWORD)pt % 2 == 1) ) |
| 239 |
{ |
| 240 |
retVal = true; |
| 241 |
} |
| 242 |
|
| 243 |
return retVal; |
| 244 |
}; |