epan/dissectors/packet-gsmtap.h

   1 /* packet-gsmtap.h
   2  * Routines for GSMTAP packet disassembly
   3  *
   4  * (C) 2008-2016 Harald Welte <laforge@gnumonks.org>
   5  *
   6  * SPDX-License-Identifier: GPL-2.0-or-later
   7  */
   8
   9 #ifndef _PACKET_GSMTAP_H
  10 #define _PACKET_GSMTAP_H
  11
  12 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
  13 /* The following types and definitions are imported from libosmocore,
  14  * the original source of the GSMTAP format.
  15  *
  16  * prior to getting them accepted/included into the official Osmocom
  17  * GSMTAP definition, available from
  18  * http://cgit.osmocom.org/libosmocore/tree/include/osmocom/core/gsmtap.h
  19  *
  20  * The GSMTAP maintainer can be contacted via the
  21  * openbsc@lists.osmocom.org mailing list, or by private e-mail
  22  * to laforge@gnumonks.org
  23  */
  24 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
  25 #define GSMTAP_TYPE_UM                  0x01
  26 #define GSMTAP_TYPE_ABIS                0x02
  27 #define GSMTAP_TYPE_UM_BURST            0x03    /* raw burst bits */
  28 #define GSMTAP_TYPE_SIM                 0x04
  29 #define GSMTAP_TYPE_TETRA_I1            0x05    /* tetra air interface */
  30 #define GSMTAP_TTPE_TETRA_I1_BURST      0x06    /* tetra air interface */
  31 #define GSMTAP_TYPE_WMX_BURST           0x07    /* WiMAX burst */
  32 #define GSMTAP_TYPE_GB_LLC              0x08 /* GPRS Gb interface: LLC */
  33 #define GSMTAP_TYPE_GB_SNDCP            0x09 /* GPRS Gb interface: SNDCP */
  34 #define GSMTAP_TYPE_GMR1_UM             0x0a    /* GMR-1 L2 packets */
  35 #define GSMTAP_TYPE_UMTS_RLC_MAC        0x0b
  36 #define GSMTAP_TYPE_UMTS_RRC            0x0c
  37 #define GSMTAP_TYPE_LTE_RRC             0x0d    /* LTE interface */
  38 #define GSMTAP_TYPE_LTE_MAC             0x0e    /* LTE MAC interface */
  39 #define GSMTAP_TYPE_LTE_MAC_FRAMED      0x0f    /* LTE MAC with context hdr */
  40 #define GSMTAP_TYPE_OSMOCORE_LOG        0x10    /* libosmocore logging */
  41 #define GSMTAP_TYPE_QC_DIAG             0x11    /* Qualcomm DIAG frame */
  42 #define GSMTAP_TYPE_LTE_NAS             0x12    /* LTE Non-Access Stratum */
  43 #define GSMTAP_TYPE_E1T1                0x13    /* E1/T1 line traces */
  44 #define GSMTAP_TYPE_GSM_RLP             0x14    /* GSM RLP as per 3GPP TS 24.022 */
  45
  46 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
  47 #define GSMTAP_BURST_UNKNOWN            0x00
  48 #define GSMTAP_BURST_FCCH               0x01
  49 #define GSMTAP_BURST_PARTIAL_SCH        0x02
  50 #define GSMTAP_BURST_SCH                0x03
  51 #define GSMTAP_BURST_CTS_SCH            0x04
  52 #define GSMTAP_BURST_COMPACT_SCH        0x05
  53 #define GSMTAP_BURST_NORMAL             0x06
  54 #define GSMTAP_BURST_DUMMY              0x07
  55 #define GSMTAP_BURST_ACCESS             0x08
  56 #define GSMTAP_BURST_NONE               0x09
  57 /* WiMAX bursts */
  58 #define GSMTAP_BURST_CDMA_CODE          0x10    /* WiMAX CDMA Code Attribute burst */
  59 #define GSMTAP_BURST_FCH                0x11    /* WiMAX FCH burst */
  60 #define GSMTAP_BURST_FFB                0x12    /* WiMAX Fast Feedback burst */
  61 #define GSMTAP_BURST_PDU                0x13    /* WiMAX PDU burst */
  62 #define GSMTAP_BURST_HACK               0x14    /* WiMAX HARQ ACK burst */
  63 #define GSMTAP_BURST_PHY_ATTRIBUTES     0x15    /* WiMAX PHY Attributes burst */
  64
  65 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
  66 /* sub-types for TYPE_UM */
  67 #define GSMTAP_CHANNEL_UNKNOWN          0x00
  68 #define GSMTAP_CHANNEL_BCCH             0x01
  69 #define GSMTAP_CHANNEL_CCCH             0x02
  70 #define GSMTAP_CHANNEL_RACH             0x03
  71 #define GSMTAP_CHANNEL_AGCH             0x04
  72 #define GSMTAP_CHANNEL_PCH              0x05
  73 #define GSMTAP_CHANNEL_SDCCH            0x06
  74 #define GSMTAP_CHANNEL_SDCCH4           0x07
  75 #define GSMTAP_CHANNEL_SDCCH8           0x08
  76 #define GSMTAP_CHANNEL_TCH_F            0x09
  77 #define GSMTAP_CHANNEL_TCH_H            0x0a
  78 #define GSMTAP_CHANNEL_PACCH            0x0b
  79 #define GSMTAP_CHANNEL_CBCH52           0x0c
  80 #define GSMTAP_CHANNEL_PDTCH            0x0d
  81 #define GSMTAP_CHANNEL_PTCCH            0x0e
  82 #define GSMTAP_CHANNEL_CBCH51           0x0f
  83 #define GSMTAP_CHANNEL_VOICE_F          0x10
  84 #define GSMTAP_CHANNEL_VOICE_H          0x11
  85
  86 /* GPRS Coding Scheme CS1..4 */
  87 #define GSMTAP_GPRS_CS_BASE     0x20
  88 #define GSMTAP_GPRS_CS(N)       (GSMTAP_GPRS_CS_BASE + N)
  89 /* (E) GPRS Coding Scheme MCS0..9 */
  90 #define GSMTAP_GPRS_MCS_BASE    0x30
  91 #define GSMTAP_GPRS_MCS(N)      (GSMTAP_GPRS_MCS_BASE + N)
  92
  93 #define GSMTAP_CHANNEL_ACCH     0x80
  94
  95 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
  96 /* sub-types for GSMTAP_TYPE_SIM */
  97 #define GSMTAP_SIM_APDU         0x00 /* APDU data (complete APDU) */
  98 #define GSMTAP_SIM_ATR                  0x01 /* card ATR data */
  99 #define GSMTAP_SIM_PPS_REQ              0x02 /* PPS request data */
 100 #define GSMTAP_SIM_PPS_RSP              0x03 /* PPS response data */
 101 #define GSMTAP_SIM_TPDU_HDR             0x04 /* TPDU command header */
 102 #define GSMTAP_SIM_TPDU_CMD             0x05 /* TPDU command body */
 103 #define GSMTAP_SIM_TPDU_RSP             0x06 /* TPDU response body */
 104 #define GSMTAP_SIM_TPDU_SW              0x07 /* TPDU response trailer */
 105
 106 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
 107 /* sub-types for TYPE_TETRA_AIR */
 108 #define GSMTAP_TETRA_BSCH                       0x01
 109 #define GSMTAP_TETRA_AACH                       0x02
 110 #define GSMTAP_TETRA_SCH_HU                     0x03
 111 #define GSMTAP_TETRA_SCH_HD                     0x04
 112 #define GSMTAP_TETRA_SCH_F                      0x05
 113 #define GSMTAP_TETRA_BNCH                       0x06
 114 #define GSMTAP_TETRA_STCH                       0x07
 115 #define GSMTAP_TETRA_TCH_F                      0x08
 116
 117 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
 118 /* sub-types for TYPE_GMR1 */
 119 #define GSMTAP_GMR1_UNKNOWN                     0x00
 120 #define GSMTAP_GMR1_BCCH                        0x01
 121 #define GSMTAP_GMR1_CCCH                        0x02    /* either AGCH or PCH */
 122 #define GSMTAP_GMR1_PCH                         0x03
 123 #define GSMTAP_GMR1_AGCH                        0x04
 124 #define GSMTAP_GMR1_BACH                        0x05
 125 #define GSMTAP_GMR1_RACH                        0x06
 126 #define GSMTAP_GMR1_CBCH                        0x07
 127 #define GSMTAP_GMR1_SDCCH                       0x08
 128 #define GSMTAP_GMR1_TACCH                       0x09
 129 #define GSMTAP_GMR1_GBCH                        0x0a
 130
 131 #define GSMTAP_GMR1_SACCH                       0x01    /* to be combined with _TCH{6,9}   */
 132 #define GSMTAP_GMR1_FACCH                       0x02    /* to be combines with _TCH{3,6,9} */
 133 #define GSMTAP_GMR1_DKAB                        0x03    /* to be combined with _TCH3 */
 134 #define GSMTAP_GMR1_TCH3                        0x10
 135 #define GSMTAP_GMR1_TCH6                        0x14
 136 #define GSMTAP_GMR1_TCH9                        0x18
 137
 138 /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */
 139 /* sub-types for TYPE_E1T1 */
 140 #define GSMTAP_E1T1_LAPD                        0x01    /* Q.921 LAPD */
 141 #define GSMTAP_E1T1_FR                          0x02    /* Frame Relay */
 142 #define GSMTAP_E1T1_RAW                         0x03    /* raw/transparent B-channel */
 143 #define GSMTAP_E1T1_TRAU16                      0x04    /* 16k TRAU frames; sub-slot 0-3 */
 144 #define GSMTAP_E1T1_TRAU8                       0x05    /* 8k TRAU frames; sub-slot 0-7 */
 145 #define GSMTAP_E1T1_V5EF                        0x06    /* V5 Envelope Function */
 146 #define GSMTAP_E1T1_X75                         0x07    /* X.75 B-channel data */
 147 #define GSMTAP_E1T1_V120                        0x08    /* V.120 B-channel data */
 148 #define GSMTAP_E1T1_V110                        0x09    /* V.110 B-channel data */
 149 #define GSMTAP_E1T1_H221                        0x0a    /* H.221 B-channel data */
 150 #define GSMTAP_E1T1_PPP                         0x0b    /* PPP */
 151
 152 #define GSMTAP_ARFCN_F_PCS                      0x8000
 153 #define GSMTAP_ARFCN_F_UPLINK                   0x4000
 154 #define GSMTAP_ARFCN_MASK                       0x3fff
 155
 156 #define GSMTAP_UDP_PORT                         4729
 157
 158 /* This is the header as it is used by gsmtap-generating software.
 159  * It is not used by the wireshark dissector and provided for reference only.
 160 struct gsmtap_hdr {
 161         uint8_t version;                // version, set to 0x01 currently
 162         uint8_t hdr_len;                // length in number of 32bit words
 163         uint8_t type;           // see GSMTAP_TYPE_*
 164         uint8_t timeslot;       // timeslot (0..7 on Um)
 165
 166         uint16_t arfcn;         // ARFCN (frequency)
 167         int8_t signal_dbm;      // signal level in dBm
 168         int8_t snr_db;          // signal/noise ratio in dB
 169
 170         uint32_t frame_number;  // GSM Frame Number (FN)
 171
 172         uint8_t sub_type;       // Type of burst/channel, see above
 173         uint8_t antenna_nr;     // Antenna Number
 174         uint8_t sub_slot;       // sub-slot within timeslot
 175         uint8_t res;            // reserved for future use (RFU)
 176 }
 177  */
 178
 179 #endif /* _PACKET_GSMTAP_H */
 180
 181 /*
 182  * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 183  *
 184  * Local variables:
 185  * c-basic-offset: 8
 186  * tab-width: 8
 187  * indent-tabs-mode: t
 188  * End:
 189  *
 190  * vi: set shiftwidth=8 tabstop=8 noexpandtab:
 191  * :indentSize=8:tabSize=8:noTabs=false:
 192  */