| #ifndef _GSMTAP_H |
| #define _GSMTAP_H |
| |
| /* gsmtap header, pseudo-header in front of the actua GSM payload */ |
| |
| /* GSMTAP is a generic header format for GSM protocol captures, |
| * it uses the IANA-assigned UDP port number 4729 and carries |
| * payload in various formats of GSM interfaces such as Um MAC |
| * blocks or Um bursts. |
| * |
| * Example programs generating GSMTAP data are airprobe |
| * (http://airprobe.org/) or OsmocomBB (http://bb.osmocom.org/) |
| */ |
| |
| #include <stdint.h> |
| |
| /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ |
| |
| /* The GSMTAP format definition is maintained in libosmocore, |
| * specifically the latest version can always be obtained from |
| * http://cgit.osmocom.org/cgit/libosmocore/tree/include/osmocom/core/gsmtap.h |
| * |
| * If you want to introduce new protocol/burst/channel types or extend |
| * GSMTAP in any way, please contact the GSMTAP maintainer at either the |
| * public openbsc@lists.osmocom.org mailing list, or privately at |
| * Harald Welte <laforge@gnumonks.org>. |
| * |
| * Your cooperation ensures that all projects will use the same GSMTAP |
| * definitions and remain compatible with each other. |
| */ |
| |
| #define GSMTAP_VERSION 0x02 |
| |
| #define GSMTAP_TYPE_UM 0x01 |
| #define GSMTAP_TYPE_ABIS 0x02 |
| #define GSMTAP_TYPE_UM_BURST 0x03 /* raw burst bits */ |
| #define GSMTAP_TYPE_SIM 0x04 |
| #define GSMTAP_TYPE_TETRA_I1 0x05 /* tetra air interface */ |
| #define GSMTAP_TYPE_TETRA_I1_BURST 0x06 /* tetra air interface */ |
| #define GSMTAP_TYPE_WMX_BURST 0x07 /* WiMAX burst */ |
| #define GSMTAP_TYPE_GB_LLC 0x08 /* GPRS Gb interface: LLC */ |
| #define GSMTAP_TYPE_GB_SNDCP 0x09 /* GPRS Gb interface: SNDCP */ |
| #define GSMTAP_TYPE_GMR1_UM 0x0a /* GMR-1 L2 packets */ |
| #define GSMTAP_TYPE_UMTS_RLC_MAC 0x0b |
| #define GSMTAP_TYPE_UMTS_RRC 0x0c |
| |
| |
| /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ |
| |
| /* sub-types for TYPE_UM_BURST */ |
| #define GSMTAP_BURST_UNKNOWN 0x00 |
| #define GSMTAP_BURST_FCCH 0x01 |
| #define GSMTAP_BURST_PARTIAL_SCH 0x02 |
| #define GSMTAP_BURST_SCH 0x03 |
| #define GSMTAP_BURST_CTS_SCH 0x04 |
| #define GSMTAP_BURST_COMPACT_SCH 0x05 |
| #define GSMTAP_BURST_NORMAL 0x06 |
| #define GSMTAP_BURST_DUMMY 0x07 |
| #define GSMTAP_BURST_ACCESS 0x08 |
| #define GSMTAP_BURST_NONE 0x09 |
| /* WiMAX bursts */ |
| #define GSMTAP_BURST_CDMA_CODE 0x10 /* WiMAX CDMA Code Attribute burst */ |
| #define GSMTAP_BURST_FCH 0x11 /* WiMAX FCH burst */ |
| #define GSMTAP_BURST_FFB 0x12 /* WiMAX Fast Feedback burst */ |
| #define GSMTAP_BURST_PDU 0x13 /* WiMAX PDU burst */ |
| #define GSMTAP_BURST_HACK 0x14 /* WiMAX HARQ ACK burst */ |
| #define GSMTAP_BURST_PHY_ATTRIBUTES 0x15 /* WiMAX PHY Attributes burst */ |
| |
| /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ |
| |
| /* sub-types for TYPE_UM */ |
| #define GSMTAP_CHANNEL_UNKNOWN 0x00 |
| #define GSMTAP_CHANNEL_BCCH 0x01 |
| #define GSMTAP_CHANNEL_CCCH 0x02 |
| #define GSMTAP_CHANNEL_RACH 0x03 |
| #define GSMTAP_CHANNEL_AGCH 0x04 |
| #define GSMTAP_CHANNEL_PCH 0x05 |
| #define GSMTAP_CHANNEL_SDCCH 0x06 |
| #define GSMTAP_CHANNEL_SDCCH4 0x07 |
| #define GSMTAP_CHANNEL_SDCCH8 0x08 |
| #define GSMTAP_CHANNEL_TCH_F 0x09 |
| #define GSMTAP_CHANNEL_TCH_H 0x0a |
| #define GSMTAP_CHANNEL_PACCH 0x0b |
| #define GSMTAP_CHANNEL_CBCH52 0x0c |
| #define GSMTAP_CHANNEL_PDCH 0x0d |
| #define GSMTAP_CHANNEL_PTCCH 0x0e |
| #define GSMTAP_CHANNEL_CBCH51 0x0f |
| |
| /* GPRS Coding Scheme CS1..4 */ |
| #define GSMTAP_GPRS_CS_BASE 0x20 |
| #define GSMTAP_GPRS_CS(N) (GSMTAP_GPRS_CS_BASE + N) |
| /* (E) GPRS Coding Scheme MCS0..9 */ |
| #define GSMTAP_GPRS_MCS_BASE 0x30 |
| #define GSMTAP_GPRS_MCS(N) (GSMTAP_GPRS_MCS_BASE + N) |
| |
| #define GSMTAP_CHANNEL_ACCH 0x80 |
| |
| /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ |
| |
| /* sub-types for TYPE_TETRA_AIR */ |
| #define GSMTAP_TETRA_BSCH 0x01 |
| #define GSMTAP_TETRA_AACH 0x02 |
| #define GSMTAP_TETRA_SCH_HU 0x03 |
| #define GSMTAP_TETRA_SCH_HD 0x04 |
| #define GSMTAP_TETRA_SCH_F 0x05 |
| #define GSMTAP_TETRA_BNCH 0x06 |
| #define GSMTAP_TETRA_STCH 0x07 |
| #define GSMTAP_TETRA_TCH_F 0x08 |
| |
| /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ |
| |
| /* sub-types for TYPE_GMR1_UM */ |
| #define GSMTAP_GMR1_UNKNOWN 0x00 |
| #define GSMTAP_GMR1_BCCH 0x01 |
| #define GSMTAP_GMR1_CCCH 0x02 /* either AGCH or PCH */ |
| #define GSMTAP_GMR1_PCH 0x03 |
| #define GSMTAP_GMR1_AGCH 0x04 |
| #define GSMTAP_GMR1_BACH 0x05 |
| #define GSMTAP_GMR1_RACH 0x06 |
| #define GSMTAP_GMR1_CBCH 0x07 |
| #define GSMTAP_GMR1_SDCCH 0x08 |
| #define GSMTAP_GMR1_TACCH 0x09 |
| #define GSMTAP_GMR1_GBCH 0x0a |
| |
| #define GSMTAP_GMR1_SACCH 0x01 /* to be combined with _TCH{6,9} */ |
| #define GSMTAP_GMR1_FACCH 0x02 /* to be combines with _TCH{3,6,9} */ |
| #define GSMTAP_GMR1_DKAB 0x03 /* to be combined with _TCH3 */ |
| #define GSMTAP_GMR1_TCH3 0x10 |
| #define GSMTAP_GMR1_TCH6 0x14 |
| #define GSMTAP_GMR1_TCH9 0x18 |
| |
| /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ |
| |
| #define GSMTAP_UMTS_CH_PCCH 0x01 |
| #define GSMTAP_UMTS_CH_CCCH 0x02 |
| #define GSMTAP_UMTS_CH_DCCH 0x03 |
| |
| /* flags for the ARFCN */ |
| #define GSMTAP_ARFCN_F_PCS 0x8000 |
| #define GSMTAP_ARFCN_F_UPLINK 0x4000 |
| #define GSMTAP_ARFCN_MASK 0x3fff |
| |
| /* IANA-assigned well-known UDP port for GSMTAP messages */ |
| #define GSMTAP_UDP_PORT 4729 |
| |
| /* ====== DO NOT MAKE UNAPPROVED MODIFICATIONS HERE ===== */ |
| struct gsmtap_hdr { |
| uint8_t version; /* version, set to 0x01 currently */ |
| uint8_t hdr_len; /* length in number of 32bit words */ |
| uint8_t type; /* see GSMTAP_TYPE_* */ |
| uint8_t timeslot; /* timeslot (0..7 on Um) */ |
| |
| uint16_t arfcn; /* ARFCN (frequency) */ |
| int8_t signal_dbm; /* signal level in dBm */ |
| int8_t snr_db; /* signal/noise ratio in dB */ |
| |
| uint32_t frame_number; /* GSM Frame Number (FN) */ |
| |
| uint8_t sub_type; /* Type of burst/channel, see above */ |
| uint8_t antenna_nr; /* Antenna Number */ |
| uint8_t sub_slot; /* sub-slot within timeslot */ |
| uint8_t res; /* reserved for future use (RFU) */ |
| |
| } __attribute__((packed)); |
| |
| #endif /* _GSMTAP_H */ |