Ivan Kluchnikov | e3a0596 | 2012-03-18 15:48:51 +0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2012 Thomas Cooper <tacooper@vt.edu> |
| 3 | * |
| 4 | * This software is distributed under the terms of the GNU Affero Public License. |
| 5 | * See the COPYING file in the main directory for details. |
| 6 | * |
| 7 | * This use of this software may be subject to additional restrictions. |
| 8 | * See the LEGAL file in the main directory for details. |
| 9 | |
| 10 | This program is free software: you can redistribute it and/or modify |
| 11 | it under the terms of the GNU Affero General Public License as published by |
| 12 | the Free Software Foundation, either version 3 of the License, or |
| 13 | (at your option) any later version. |
| 14 | |
| 15 | This program is distributed in the hope that it will be useful, |
| 16 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | GNU Affero General Public License for more details. |
| 19 | |
| 20 | You should have received a copy of the GNU Affero General Public License |
| 21 | along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 22 | |
| 23 | */ |
| 24 | |
| 25 | #ifndef GSML1PRIM_H |
| 26 | #define GSML1PRIM_H |
| 27 | |
| 28 | #include <stdint.h> |
| 29 | |
| 30 | typedef enum GsmL1_SubCh_t { |
| 31 | GsmL1_SubCh_NA, |
| 32 | } GsmL1_SubCh_t; |
| 33 | |
| 34 | typedef enum GsmL1_Sapi_t { |
| 35 | GsmL1_Sapi_Fcch, |
| 36 | GsmL1_Sapi_Sch, |
| 37 | GsmL1_Sapi_Sacch, |
| 38 | GsmL1_Sapi_Sdcch, |
| 39 | GsmL1_Sapi_Bcch, |
| 40 | GsmL1_Sapi_Pch, |
| 41 | GsmL1_Sapi_Agch, |
| 42 | GsmL1_Sapi_Cbch, |
| 43 | GsmL1_Sapi_Rach, |
| 44 | GsmL1_Sapi_TchF, |
| 45 | GsmL1_Sapi_FacchF, |
| 46 | GsmL1_Sapi_TchH, |
| 47 | GsmL1_Sapi_FacchH, |
| 48 | GsmL1_Sapi_Nch, |
| 49 | GsmL1_Sapi_Pdtch, |
| 50 | GsmL1_Sapi_Pacch, |
| 51 | GsmL1_Sapi_Pbcch, |
| 52 | GsmL1_Sapi_Pagch, |
| 53 | GsmL1_Sapi_Ppch, |
| 54 | GsmL1_Sapi_Pnch, |
| 55 | GsmL1_Sapi_Ptcch, |
| 56 | GsmL1_Sapi_Prach, |
| 57 | GsmL1_Sapi_Idle, |
| 58 | GsmL1_Sapi_NUM, |
| 59 | } GsmL1_Sapi_t; |
| 60 | |
| 61 | typedef enum GsmL1_Status_t { |
| 62 | GsmL1_Status_Success, |
| 63 | GsmL1_Status_Generic, |
| 64 | GsmL1_Status_NoMemory, |
| 65 | GsmL1_Status_Timeout, |
| 66 | GsmL1_Status_InvalidParam, |
| 67 | GsmL1_Status_Busy, |
| 68 | GsmL1_Status_NoRessource, |
| 69 | GsmL1_Status_Uninitialized, |
| 70 | GsmL1_Status_NullInterface, |
| 71 | GsmL1_Status_NullFctnPtr, |
| 72 | GsmL1_Status_BadCrc, |
| 73 | GsmL1_Status_BadUsf, |
| 74 | GsmL1_Status_InvalidCPS, |
| 75 | GsmL1_Status_UnexpectedBurst, |
| 76 | GsmL1_Status_UnavailCodec, |
| 77 | GsmL1_Status_CriticalError, |
| 78 | GsmL1_Status_OverheatError, |
| 79 | GsmL1_Status_DeviceError, |
| 80 | GsmL1_Status_FacchError, |
| 81 | GsmL1_Status_AlreadyDeactivated, |
| 82 | GsmL1_Status_TxBurstFifoOvrn, |
| 83 | GsmL1_Status_TxBurstFifoUndr, |
| 84 | GsmL1_Status_NotSynchronized, |
| 85 | GsmL1_Status_Unsupported, |
| 86 | GSML1_STATUS_NUM, |
| 87 | } GsmL1_Status_t; |
| 88 | |
| 89 | typedef enum GsmL1_PrimId_t { |
| 90 | GsmL1_PrimId_MphInitReq, |
| 91 | GsmL1_PrimId_MphCloseReq, |
| 92 | GsmL1_PrimId_MphConnectReq, |
| 93 | GsmL1_PrimId_MphDisconnectReq, |
| 94 | GsmL1_PrimId_MphActivateReq, |
| 95 | GsmL1_PrimId_MphDeactivateReq, |
| 96 | GsmL1_PrimId_MphConfigReq, |
| 97 | GsmL1_PrimId_MphMeasureReq, |
| 98 | GsmL1_PrimId_MphInitCnf, |
| 99 | GsmL1_PrimId_MphCloseCnf, |
| 100 | GsmL1_PrimId_MphConnectCnf, |
| 101 | GsmL1_PrimId_MphDisconnectCnf, |
| 102 | GsmL1_PrimId_MphActivateCnf, |
| 103 | GsmL1_PrimId_MphDeactivateCnf, |
| 104 | GsmL1_PrimId_MphConfigCnf, |
| 105 | GsmL1_PrimId_MphMeasureCnf, |
| 106 | GsmL1_PrimId_MphTimeInd, |
| 107 | GsmL1_PrimId_MphSyncInd, |
| 108 | GsmL1_PrimId_PhEmptyFrameReq, |
| 109 | GsmL1_PrimId_PhDataReq, |
| 110 | GsmL1_PrimId_PhConnectInd, |
| 111 | GsmL1_PrimId_PhReadyToSendInd, |
| 112 | GsmL1_PrimId_PhDataInd, |
| 113 | GsmL1_PrimId_PhRaInd, |
| 114 | GsmL1_PrimId_NUM, |
| 115 | } GsmL1_PrimId_t; |
| 116 | |
| 117 | typedef enum GsmL1_Dir_t { |
| 118 | GsmL1_Dir_TxDownlink, |
| 119 | GsmL1_Dir_RxUplink, |
| 120 | } GsmL1_Dir_t; |
| 121 | |
| 122 | typedef enum GsmL1_DevType_t { |
| 123 | GsmL1_DevType_TxdRxu, |
| 124 | } GsmL1_DevType_t; |
| 125 | |
| 126 | typedef enum GsmL1_TchPlType_t { |
| 127 | GsmL1_TchPlType_NA, |
| 128 | GsmL1_TchPlType_Efr, |
| 129 | GsmL1_TchPlType_Fr, |
| 130 | GsmL1_TchPlType_Hr, |
| 131 | GsmL1_TchPlType_Amr, |
| 132 | GsmL1_TchPlType_Amr_SidBad, |
| 133 | GsmL1_TchPlType_Amr_Onset, |
| 134 | GsmL1_TchPlType_Amr_Ratscch, |
| 135 | GsmL1_TchPlType_Amr_SidUpdateInH, |
| 136 | GsmL1_TchPlType_Amr_SidFirstP1, |
| 137 | GsmL1_TchPlType_Amr_SidFirstP2, |
| 138 | GsmL1_TchPlType_Amr_SidFirstInH, |
| 139 | GsmL1_TchPlType_Amr_RatscchMarker, |
| 140 | GsmL1_TchPlType_Amr_RatscchData, |
| 141 | } GsmL1_TchPlType_t; |
| 142 | |
| 143 | typedef enum GsmL1_ConfigParamId_t { |
| 144 | GsmL1_ConfigParamId_SetNbTsc, |
| 145 | GsmL1_ConfigParamId_SetTxPowerLevel, |
| 146 | GsmL1_ConfigParamId_SetLogChParams, |
| 147 | GsmL1_ConfigParamId_SetCipheringParams, |
| 148 | } GsmL1_ConfigParamId_t; |
| 149 | |
| 150 | typedef struct GsmL1_DeviceParam_t { |
| 151 | enum GsmL1_DevType_t devType; |
| 152 | int freqBand; |
| 153 | uint16_t u16Arfcn; |
| 154 | uint16_t u16BcchArfcn; |
| 155 | uint8_t u8NbTsc; |
| 156 | uint8_t u8Ncc; |
| 157 | float fRxPowerLevel; |
| 158 | float fTxPowerLevel; |
| 159 | } GsmL1_DeviceParam_t; |
| 160 | |
| 161 | typedef struct GsmL1_MsgUnitParam_t { |
| 162 | uint8_t u8Buffer[256]; |
| 163 | uint8_t u8Size; |
| 164 | } GsmL1_MsgUnitParam_t; |
| 165 | |
| 166 | typedef struct GsmL1_MeasParam_t { |
| 167 | float fRssi; |
| 168 | float fLinkQuality; |
| 169 | float fBer; |
| 170 | int16_t i16BurstTiming; |
| 171 | } GsmL1_MeasParam_t; |
| 172 | |
| 173 | typedef struct GsmL1_LogChParam_t { |
| 174 | union { |
| 175 | struct { |
| 176 | enum GsmL1_TchPlType_t tchPlType; |
| 177 | |
| 178 | enum { |
| 179 | GsmL1_AmrCmiPhase_NA, |
| 180 | GsmL1_AmrCmiPhase_Odd, |
| 181 | } amrCmiPhase; |
| 182 | |
| 183 | enum { |
| 184 | GsmL1_AmrCodecMode_Unset, |
| 185 | } amrInitCodecMode; |
| 186 | |
| 187 | enum { |
| 188 | GsmL1_AmrCodec_Unset, |
| 189 | GsmL1_AmrCodec_4_75, |
| 190 | GsmL1_AmrCodec_5_15, |
| 191 | GsmL1_AmrCodec_5_9, |
| 192 | GsmL1_AmrCodec_6_7, |
| 193 | GsmL1_AmrCodec_7_4, |
| 194 | GsmL1_AmrCodec_7_95, |
| 195 | GsmL1_AmrCodec_10_2, |
| 196 | GsmL1_AmrCodec_12_2, |
| 197 | } amrActiveCodecSet[8]; |
| 198 | } tch; |
| 199 | |
| 200 | struct { |
| 201 | uint8_t u8Bsic; |
| 202 | uint8_t u8NbrOfAgch; |
| 203 | } rach; |
| 204 | |
| 205 | struct { |
| 206 | uint8_t u8MsPowerLevel; |
| 207 | } sacch; |
| 208 | |
| 209 | struct { |
| 210 | uint8_t u8NbrOfAgch; |
| 211 | } agch; |
| 212 | }; |
| 213 | } GsmL1_LogChParam_t; |
| 214 | |
| 215 | typedef enum GsmL1_LogChComb_t { |
| 216 | GsmL1_LogChComb_0, |
| 217 | GsmL1_LogChComb_I, |
| 218 | GsmL1_LogChComb_II, |
| 219 | GsmL1_LogChComb_IV, |
| 220 | GsmL1_LogChComb_V, |
| 221 | GsmL1_LogChComb_VII, |
| 222 | GsmL1_LogChComb_XIII, |
| 223 | } GsmL1_LogChComb_t; |
| 224 | |
| 225 | enum { |
| 226 | GsmL1_FreqBand_850, |
| 227 | GsmL1_FreqBand_900, |
| 228 | GsmL1_FreqBand_1800, |
| 229 | GsmL1_FreqBand_1900, |
| 230 | }; |
| 231 | |
| 232 | typedef struct GsmL1_MphInitReq_t { |
| 233 | struct GsmL1_DeviceParam_t deviceParam; |
| 234 | } GsmL1_MphInitReq_t; |
| 235 | |
| 236 | typedef struct GsmL1_MphCloseReq_t { |
| 237 | uint32_t hLayer1; |
| 238 | } GsmL1_MphCloseReq_t; |
| 239 | |
| 240 | typedef struct GsmL1_MphConnectReq_t { |
| 241 | uint32_t hLayer1; |
| 242 | uint8_t u8Tn; |
| 243 | enum GsmL1_LogChComb_t logChComb; |
| 244 | } GsmL1_MphConnectReq_t; |
| 245 | |
| 246 | typedef struct GsmL1_MphDisconnectReq_t { |
| 247 | uint32_t hLayer1; |
| 248 | } GsmL1_MphDisconnectReq_t; |
| 249 | |
| 250 | typedef struct GsmL1_MphActivateReq_t { |
| 251 | uint32_t hLayer1; |
| 252 | struct GsmL1_LogChParam_t logChPrm; |
| 253 | uint8_t u8Tn; |
| 254 | enum GsmL1_SubCh_t subCh; |
| 255 | enum GsmL1_Dir_t dir; |
| 256 | enum GsmL1_Sapi_t sapi; |
| 257 | uint32_t hLayer2; |
| 258 | float fBFILevel; |
| 259 | } GsmL1_MphActivateReq_t; |
| 260 | |
| 261 | typedef struct GsmL1_MphDeactivateReq_t { |
| 262 | uint32_t hLayer1; |
| 263 | uint8_t u8Tn; |
| 264 | enum GsmL1_SubCh_t subCh; |
| 265 | enum GsmL1_Dir_t dir; |
| 266 | enum GsmL1_Sapi_t sapi; |
| 267 | } GsmL1_MphDeactivateReq_t; |
| 268 | |
| 269 | typedef struct GsmL1_ConfigParam_t { |
| 270 | struct { |
| 271 | enum GsmL1_Sapi_t sapi; |
| 272 | uint8_t u8Tn; |
| 273 | enum GsmL1_SubCh_t subCh; |
| 274 | enum GsmL1_Dir_t dir; |
| 275 | struct GsmL1_LogChParam_t logChParams; |
| 276 | } setLogChParams; |
| 277 | } GsmL1_ConfigParam_t; |
| 278 | |
| 279 | typedef struct GsmL1_MphConfigReq_t { |
| 280 | uint32_t hLayer1; |
| 281 | enum GsmL1_ConfigParamId_t cfgParamId; |
| 282 | struct GsmL1_ConfigParam_t cfgParams; |
| 283 | } GsmL1_MphConfigReq_t; |
| 284 | |
| 285 | typedef struct GsmL1_MphConfigCnf_t { |
| 286 | enum GsmL1_Status_t status; |
| 287 | enum GsmL1_ConfigParamId_t cfgParamId; |
| 288 | struct GsmL1_ConfigParam_t cfgParams; |
| 289 | } GsmL1_MphConfigCnf_t; |
| 290 | |
| 291 | typedef struct GsmL1_MphMeasureReq_t { |
| 292 | uint32_t hLayer1; |
| 293 | } GsmL1_MphMeasureReq_t; |
| 294 | |
| 295 | typedef struct GsmL1_MphInitCnf_t { |
| 296 | uint32_t hLayer1; |
| 297 | enum GsmL1_Status_t status; |
| 298 | } GsmL1_MphInitCnf_t; |
| 299 | |
| 300 | typedef struct GsmL1_MphCloseCnf_t { |
| 301 | enum GsmL1_Status_t status; |
| 302 | } GsmL1_MphCloseCnf_t; |
| 303 | |
| 304 | typedef struct GsmL1_MphConnectCnf_t { |
| 305 | enum GsmL1_Status_t status; |
| 306 | } GsmL1_MphConnectCnf_t; |
| 307 | |
| 308 | typedef struct GsmL1_MphDisconnectCnf_t { |
| 309 | enum GsmL1_Status_t status; |
| 310 | } GsmL1_MphDisconnectCnf_t; |
| 311 | |
| 312 | typedef struct GsmL1_MphActivateCnf_t { |
| 313 | enum GsmL1_Status_t status; |
| 314 | uint8_t u8Tn; |
| 315 | int sapi; |
| 316 | } GsmL1_MphActivateCnf_t; |
| 317 | |
| 318 | typedef struct GsmL1_MphDeactivateCnf_t { |
| 319 | enum GsmL1_Status_t status; |
| 320 | uint8_t u8Tn; |
| 321 | enum GsmL1_Sapi_t sapi; |
| 322 | } GsmL1_MphDeactivateCnf_t; |
| 323 | |
| 324 | typedef struct GsmL1_MphMeasureCnf_t { |
| 325 | enum GsmL1_Status_t status; |
| 326 | } GsmL1_MphMeasureCnf_t; |
| 327 | |
| 328 | typedef struct GsmL1_MphTimeInd_t { |
| 329 | uint32_t u32Fn; |
| 330 | } GsmL1_MphTimeInd_t; |
| 331 | |
| 332 | typedef struct GsmL1_MphSyncInd_t { |
| 333 | } GsmL1_MphSyncInd_t; |
| 334 | |
| 335 | typedef struct GsmL1_PhEmptyFrameReq_t { |
| 336 | uint32_t hLayer1; |
| 337 | uint8_t u8Tn; |
| 338 | uint32_t u32Fn; |
| 339 | enum GsmL1_Sapi_t sapi; |
| 340 | enum GsmL1_SubCh_t subCh; |
| 341 | uint8_t u8BlockNbr; |
| 342 | } GsmL1_PhEmptyFrameReq_t; |
| 343 | |
| 344 | typedef struct GsmL1_PhDataReq_t { |
| 345 | uint32_t hLayer1; |
| 346 | uint8_t u8Tn; |
| 347 | uint32_t u32Fn; |
| 348 | enum GsmL1_Sapi_t sapi; |
| 349 | enum GsmL1_SubCh_t subCh; |
| 350 | uint8_t u8BlockNbr; |
| 351 | struct GsmL1_MsgUnitParam_t msgUnitParam; |
| 352 | } GsmL1_PhDataReq_t; |
| 353 | |
| 354 | typedef struct GsmL1_PhConnectInd_t { |
Ivan Kluchnikov | 27482ba | 2012-04-17 20:36:44 +0400 | [diff] [blame] | 355 | uint8_t u8Tn; |
| 356 | uint8_t u8Tsc; |
| 357 | uint16_t u16Arfcn; |
Ivan Kluchnikov | e3a0596 | 2012-03-18 15:48:51 +0400 | [diff] [blame] | 358 | } GsmL1_PhConnectInd_t; |
| 359 | |
| 360 | typedef struct GsmL1_PhReadyToSendInd_t { |
| 361 | uint32_t hLayer1; |
| 362 | uint8_t u8Tn; |
| 363 | uint32_t u32Fn; |
| 364 | enum GsmL1_Sapi_t sapi; |
| 365 | enum GsmL1_SubCh_t subCh; |
| 366 | uint8_t u8BlockNbr; |
| 367 | uint32_t hLayer2; |
| 368 | } GsmL1_PhReadyToSendInd_t; |
| 369 | |
| 370 | typedef struct GsmL1_PhDataInd_t { |
| 371 | struct GsmL1_MeasParam_t measParam; |
| 372 | struct GsmL1_MsgUnitParam_t msgUnitParam; |
| 373 | enum GsmL1_Sapi_t sapi; |
| 374 | uint32_t hLayer2; |
| 375 | } GsmL1_PhDataInd_t; |
| 376 | |
| 377 | typedef struct GsmL1_PhRaInd_t { |
| 378 | struct GsmL1_MeasParam_t measParam; |
| 379 | struct GsmL1_MsgUnitParam_t msgUnitParam; |
| 380 | uint32_t u32Fn; |
| 381 | uint32_t hLayer2; |
| 382 | } GsmL1_PhRaInd_t; |
| 383 | |
| 384 | typedef struct GsmL1_Prim_t { |
| 385 | union { |
| 386 | struct GsmL1_MphInitReq_t mphInitReq; |
| 387 | struct GsmL1_MphCloseReq_t mphCloseReq; |
| 388 | struct GsmL1_MphConnectReq_t mphConnectReq; |
| 389 | struct GsmL1_MphDisconnectReq_t mphDisconnectReq; |
| 390 | struct GsmL1_MphActivateReq_t mphActivateReq; |
| 391 | struct GsmL1_MphDeactivateReq_t mphDeactivateReq; |
| 392 | struct GsmL1_MphConfigReq_t mphConfigReq; |
| 393 | struct GsmL1_MphMeasureReq_t mphMeasureReq; |
| 394 | struct GsmL1_MphInitCnf_t mphInitCnf; |
| 395 | struct GsmL1_MphCloseCnf_t mphCloseCnf; |
| 396 | struct GsmL1_MphConnectCnf_t mphConnectCnf; |
| 397 | struct GsmL1_MphDisconnectCnf_t mphDisconnectCnf; |
| 398 | struct GsmL1_MphActivateCnf_t mphActivateCnf; |
| 399 | struct GsmL1_MphDeactivateCnf_t mphDeactivateCnf; |
| 400 | struct GsmL1_MphConfigCnf_t mphConfigCnf; |
| 401 | struct GsmL1_MphMeasureCnf_t mphMeasureCnf; |
| 402 | struct GsmL1_MphTimeInd_t mphTimeInd; |
| 403 | struct GsmL1_MphSyncInd_t mphSyncInd; |
| 404 | struct GsmL1_PhEmptyFrameReq_t phEmptyFrameReq; |
| 405 | struct GsmL1_PhDataReq_t phDataReq; |
| 406 | struct GsmL1_PhConnectInd_t phConnectInd; |
| 407 | struct GsmL1_PhReadyToSendInd_t phReadyToSendInd; |
| 408 | struct GsmL1_PhDataInd_t phDataInd; |
| 409 | struct GsmL1_PhRaInd_t phRaInd; |
| 410 | } u; |
| 411 | |
| 412 | enum GsmL1_PrimId_t id; |
| 413 | } GsmL1_Prim_t; |
Ivan Kluchnikov | 1efac07 | 2012-04-11 21:39:53 +0400 | [diff] [blame] | 414 | |
| 415 | #endif |