Gitiles
Code Review Sign In
gerrit.osmocom.org / libosmocore / 26ea7068e70bbfee9fb2117431ce8593e9df4e2a / . / include / osmocom / gsm / protocol / gsm_08_08.h
blob: bf408eb65c8da31fbb1af23e8c483f6fbb3f2866 [file] [log] [blame]
Holger Hans Peter Freytherebaed742010-04-15 03:14:51 +0200[diff] [blame]1/* From GSM08.08 */
2
Sylvain Munaut12ba7782014-06-16 10:13:40 +0200[diff] [blame]3#pragma once
Holger Hans Peter Freytherebaed742010-04-15 03:14:51 +0200[diff] [blame]4
5#include <stdlib.h>
6
Holger Hans Peter Freytherebaed742010-04-15 03:14:51 +0200[diff] [blame]7/*
8 * this is from GSM 03.03 CGI but is copied in GSM 08.08
9 * in § 3.2.2.27 for Cell Identifier List
10 */
11enum CELL_IDENT {
12 CELL_IDENT_WHOLE_GLOBAL = 0,
13 CELL_IDENT_LAC_AND_CI = 1,
14 CELL_IDENT_CI = 2,
15 CELL_IDENT_NO_CELL = 3,
16 CELL_IDENT_LAI_AND_LAC = 4,
17 CELL_IDENT_LAC = 5,
18 CELL_IDENT_BSS = 6,
19 CELL_IDENT_UTRAN_PLMN_LAC_RNC = 8,
20 CELL_IDENT_UTRAN_RNC = 9,
21 CELL_IDENT_UTRAN_LAC_RNC = 10,
22};
23
24
25/* GSM 08.06 § 6.3 */
26enum BSSAP_MSG_TYPE {
27 BSSAP_MSG_BSS_MANAGEMENT = 0x0,
28 BSSAP_MSG_DTAP = 0x1,
29};
30
31struct bssmap_header {
Sylvain Munauta074ec42010-04-28 10:05:29 +0200[diff] [blame]32 uint8_t type;
33 uint8_t length;
Holger Hans Peter Freytherebaed742010-04-15 03:14:51 +0200[diff] [blame]34} __attribute__((packed));
35
36struct dtap_header {
Sylvain Munauta074ec42010-04-28 10:05:29 +0200[diff] [blame]37 uint8_t type;
38 uint8_t link_id;
39 uint8_t length;
Holger Hans Peter Freytherebaed742010-04-15 03:14:51 +0200[diff] [blame]40} __attribute__((packed));
41
42
43enum BSS_MAP_MSG_TYPE {
44 BSS_MAP_MSG_RESERVED_0 = 0,
45
46 /* ASSIGNMENT MESSAGES */
47 BSS_MAP_MSG_ASSIGMENT_RQST = 1,
48 BSS_MAP_MSG_ASSIGMENT_COMPLETE = 2,
49 BSS_MAP_MSG_ASSIGMENT_FAILURE = 3,
50
51 /* HANDOVER MESSAGES */
52 BSS_MAP_MSG_HANDOVER_RQST = 16,
53 BSS_MAP_MSG_HANDOVER_REQUIRED = 17,
54 BSS_MAP_MSG_HANDOVER_RQST_ACKNOWLEDGE= 18,
55 BSS_MAP_MSG_HANDOVER_CMD = 19,
56 BSS_MAP_MSG_HANDOVER_COMPLETE = 20,
57 BSS_MAP_MSG_HANDOVER_SUCCEEDED = 21,
58 BSS_MAP_MSG_HANDOVER_FAILURE = 22,
59 BSS_MAP_MSG_HANDOVER_PERFORMED = 23,
60 BSS_MAP_MSG_HANDOVER_CANDIDATE_ENQUIRE = 24,
61 BSS_MAP_MSG_HANDOVER_CANDIDATE_RESPONSE = 25,
62 BSS_MAP_MSG_HANDOVER_REQUIRED_REJECT = 26,
63 BSS_MAP_MSG_HANDOVER_DETECT = 27,
64
65 /* RELEASE MESSAGES */
66 BSS_MAP_MSG_CLEAR_CMD = 32,
67 BSS_MAP_MSG_CLEAR_COMPLETE = 33,
68 BSS_MAP_MSG_CLEAR_RQST = 34,
69 BSS_MAP_MSG_RESERVED_1 = 35,
70 BSS_MAP_MSG_RESERVED_2 = 36,
71 BSS_MAP_MSG_SAPI_N_REJECT = 37,
72 BSS_MAP_MSG_CONFUSION = 38,
73
74 /* OTHER CONNECTION RELATED MESSAGES */
75 BSS_MAP_MSG_SUSPEND = 40,
76 BSS_MAP_MSG_RESUME = 41,
77 BSS_MAP_MSG_CONNECTION_ORIENTED_INFORMATION = 42,
78 BSS_MAP_MSG_PERFORM_LOCATION_RQST = 43,
79 BSS_MAP_MSG_LSA_INFORMATION = 44,
80 BSS_MAP_MSG_PERFORM_LOCATION_RESPONSE = 45,
81 BSS_MAP_MSG_PERFORM_LOCATION_ABORT = 46,
82 BSS_MAP_MSG_COMMON_ID = 47,
83
84 /* GENERAL MESSAGES */
85 BSS_MAP_MSG_RESET = 48,
86 BSS_MAP_MSG_RESET_ACKNOWLEDGE = 49,
87 BSS_MAP_MSG_OVERLOAD = 50,
88 BSS_MAP_MSG_RESERVED_3 = 51,
89 BSS_MAP_MSG_RESET_CIRCUIT = 52,
90 BSS_MAP_MSG_RESET_CIRCUIT_ACKNOWLEDGE = 53,
91 BSS_MAP_MSG_MSC_INVOKE_TRACE = 54,
92 BSS_MAP_MSG_BSS_INVOKE_TRACE = 55,
93 BSS_MAP_MSG_CONNECTIONLESS_INFORMATION = 58,
94
95 /* TERRESTRIAL RESOURCE MESSAGES */
96 BSS_MAP_MSG_BLOCK = 64,
97 BSS_MAP_MSG_BLOCKING_ACKNOWLEDGE = 65,
98 BSS_MAP_MSG_UNBLOCK = 66,
99 BSS_MAP_MSG_UNBLOCKING_ACKNOWLEDGE = 67,
100 BSS_MAP_MSG_CIRCUIT_GROUP_BLOCK = 68,
101 BSS_MAP_MSG_CIRCUIT_GROUP_BLOCKING_ACKNOWLEDGE = 69,
102 BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCK = 70,
103 BSS_MAP_MSG_CIRCUIT_GROUP_UNBLOCKING_ACKNOWLEDGE = 71,
104 BSS_MAP_MSG_UNEQUIPPED_CIRCUIT = 72,
105 BSS_MAP_MSG_CHANGE_CIRCUIT = 78,
106 BSS_MAP_MSG_CHANGE_CIRCUIT_ACKNOWLEDGE = 79,
107
108 /* RADIO RESOURCE MESSAGES */
109 BSS_MAP_MSG_RESOURCE_RQST = 80,
110 BSS_MAP_MSG_RESOURCE_INDICATION = 81,
111 BSS_MAP_MSG_PAGING = 82,
112 BSS_MAP_MSG_CIPHER_MODE_CMD = 83,
113 BSS_MAP_MSG_CLASSMARK_UPDATE = 84,
114 BSS_MAP_MSG_CIPHER_MODE_COMPLETE = 85,
115 BSS_MAP_MSG_QUEUING_INDICATION = 86,
116 BSS_MAP_MSG_COMPLETE_LAYER_3 = 87,
117 BSS_MAP_MSG_CLASSMARK_RQST = 88,
118 BSS_MAP_MSG_CIPHER_MODE_REJECT = 89,
119 BSS_MAP_MSG_LOAD_INDICATION = 90,
120
121 /* VGCS/VBS */
122 BSS_MAP_MSG_VGCS_VBS_SETUP = 4,
123 BSS_MAP_MSG_VGCS_VBS_SETUP_ACK = 5,
124 BSS_MAP_MSG_VGCS_VBS_SETUP_REFUSE = 6,
125 BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RQST = 7,
126 BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_RESULT = 28,
127 BSS_MAP_MSG_VGCS_VBS_ASSIGNMENT_FAILURE = 29,
128 BSS_MAP_MSG_VGCS_VBS_QUEUING_INDICATION = 30,
129 BSS_MAP_MSG_UPLINK_RQST = 31,
130 BSS_MAP_MSG_UPLINK_RQST_ACKNOWLEDGE = 39,
131 BSS_MAP_MSG_UPLINK_RQST_CONFIRMATION = 73,
132 BSS_MAP_MSG_UPLINK_RELEASE_INDICATION = 74,
133 BSS_MAP_MSG_UPLINK_REJECT_CMD = 75,
134 BSS_MAP_MSG_UPLINK_RELEASE_CMD = 76,
135 BSS_MAP_MSG_UPLINK_SEIZED_CMD = 77,
136};
137
138enum GSM0808_IE_CODING {
139 GSM0808_IE_CIRCUIT_IDENTITY_CODE = 1,
140 GSM0808_IE_RESERVED_0 = 2,
141 GSM0808_IE_RESOURCE_AVAILABLE = 3,
142 GSM0808_IE_CAUSE = 4,
143 GSM0808_IE_CELL_IDENTIFIER = 5,
144 GSM0808_IE_PRIORITY = 6,
145 GSM0808_IE_LAYER_3_HEADER_INFORMATION = 7,
146 GSM0808_IE_IMSI = 8,
147 GSM0808_IE_TMSI = 9,
148 GSM0808_IE_ENCRYPTION_INFORMATION = 10,
149 GSM0808_IE_CHANNEL_TYPE = 11,
150 GSM0808_IE_PERIODICITY = 12,
151 GSM0808_IE_EXTENDED_RESOURCE_INDICATOR = 13,
152 GSM0808_IE_NUMBER_OF_MSS = 14,
153 GSM0808_IE_RESERVED_1 = 15,
154 GSM0808_IE_RESERVED_2 = 16,
155 GSM0808_IE_RESERVED_3 = 17,
156 GSM0808_IE_CLASSMARK_INFORMATION_T2 = 18,
157 GSM0808_IE_CLASSMARK_INFORMATION_T3 = 19,
158 GSM0808_IE_INTERFERENCE_BAND_TO_USE = 20,
159 GSM0808_IE_RR_CAUSE = 21,
160 GSM0808_IE_RESERVED_4 = 22,
161 GSM0808_IE_LAYER_3_INFORMATION = 23,
162 GSM0808_IE_DLCI = 24,
163 GSM0808_IE_DOWNLINK_DTX_FLAG = 25,
164 GSM0808_IE_CELL_IDENTIFIER_LIST = 26,
165 GSM0808_IE_RESPONSE_RQST = 27,
166 GSM0808_IE_RESOURCE_INDICATION_METHOD = 28,
167 GSM0808_IE_CLASSMARK_INFORMATION_TYPE_1 = 29,
168 GSM0808_IE_CIRCUIT_IDENTITY_CODE_LIST = 30,
169 GSM0808_IE_DIAGNOSTIC = 31,
170 GSM0808_IE_LAYER_3_MESSAGE_CONTENTS = 32,
171 GSM0808_IE_CHOSEN_CHANNEL = 33,
172 GSM0808_IE_TOTAL_RESOURCE_ACCESSIBLE = 34,
173 GSM0808_IE_CIPHER_RESPONSE_MODE = 35,
174 GSM0808_IE_CHANNEL_NEEDED = 36,
175 GSM0808_IE_TRACE_TYPE = 37,
176 GSM0808_IE_TRIGGERID = 38,
177 GSM0808_IE_TRACE_REFERENCE = 39,
178 GSM0808_IE_TRANSACTIONID = 40,
179 GSM0808_IE_MOBILE_IDENTITY = 41,
180 GSM0808_IE_OMCID = 42,
181 GSM0808_IE_FORWARD_INDICATOR = 43,
182 GSM0808_IE_CHOSEN_ENCR_ALG = 44,
183 GSM0808_IE_CIRCUIT_POOL = 45,
184 GSM0808_IE_CIRCUIT_POOL_LIST = 46,
185 GSM0808_IE_TIME_INDICATION = 47,
186 GSM0808_IE_RESOURCE_SITUATION = 48,
187 GSM0808_IE_CURRENT_CHANNEL_TYPE_1 = 49,
188 GSM0808_IE_QUEUEING_INDICATOR = 50,
189 GSM0808_IE_SPEECH_VERSION = 64,
190 GSM0808_IE_ASSIGNMENT_REQUIREMENT = 51,
191 GSM0808_IE_TALKER_FLAG = 53,
192 GSM0808_IE_CONNECTION_RELEASE_RQSTED = 54,
193 GSM0808_IE_GROUP_CALL_REFERENCE = 55,
194 GSM0808_IE_EMLPP_PRIORITY = 56,
195 GSM0808_IE_CONFIG_EVO_INDI = 57,
196 GSM0808_IE_OLD_BSS_TO_NEW_BSS_INFORMATION = 58,
197 GSM0808_IE_LSA_IDENTIFIER = 59,
198 GSM0808_IE_LSA_IDENTIFIER_LIST = 60,
199 GSM0808_IE_LSA_INFORMATION = 61,
200 GSM0808_IE_LCS_QOS = 62,
201 GSM0808_IE_LSA_ACCESS_CTRL_SUPPR = 63,
202 GSM0808_IE_LCS_PRIORITY = 67,
203 GSM0808_IE_LOCATION_TYPE = 68,
204 GSM0808_IE_LOCATION_ESTIMATE = 69,
205 GSM0808_IE_POSITIONING_DATA = 70,
206 GSM0808_IE_LCS_CAUSE = 71,
207 GSM0808_IE_LCS_CLIENT_TYPE = 72,
208 GSM0808_IE_APDU = 73,
209 GSM0808_IE_NETWORK_ELEMENT_IDENTITY = 74,
210 GSM0808_IE_GPS_ASSISTANCE_DATA = 75,
211 GSM0808_IE_DECIPHERING_KEYS = 76,
212 GSM0808_IE_RETURN_ERROR_RQST = 77,
213 GSM0808_IE_RETURN_ERROR_CAUSE = 78,
214 GSM0808_IE_SEGMENTATION = 79,
215 GSM0808_IE_SERVICE_HANDOVER = 80,
216 GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_UMTS = 81,
217 GSM0808_IE_SOURCE_RNC_TO_TARGET_RNC_TRANSPARENT_CDMA2000= 82,
218 GSM0808_IE_RESERVED_5 = 65,
219 GSM0808_IE_RESERVED_6 = 66,
220};
221
222enum gsm0808_cause {
223 GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE = 0,
224 GSM0808_CAUSE_RADIO_INTERFACE_FAILURE = 1,
225 GSM0808_CAUSE_UPLINK_QUALITY = 2,
226 GSM0808_CAUSE_UPLINK_STRENGTH = 3,
227 GSM0808_CAUSE_DOWNLINK_QUALITY = 4,
228 GSM0808_CAUSE_DOWNLINK_STRENGTH = 5,
229 GSM0808_CAUSE_DISTANCE = 6,
230 GSM0808_CAUSE_O_AND_M_INTERVENTION = 7,
231 GSM0808_CAUSE_RESPONSE_TO_MSC_INVOCATION = 8,
232 GSM0808_CAUSE_CALL_CONTROL = 9,
233 GSM0808_CAUSE_RADIO_INTERFACE_FAILURE_REVERSION = 10,
234 GSM0808_CAUSE_HANDOVER_SUCCESSFUL = 11,
235 GSM0808_CAUSE_BETTER_CELL = 12,
236 GSM0808_CAUSE_DIRECTED_RETRY = 13,
237 GSM0808_CAUSE_JOINED_GROUP_CALL_CHANNEL = 14,
238 GSM0808_CAUSE_TRAFFIC = 15,
239 GSM0808_CAUSE_EQUIPMENT_FAILURE = 32,
240 GSM0808_CAUSE_NO_RADIO_RESOURCE_AVAILABLE = 33,
241 GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE = 34,
242 GSM0808_CAUSE_CCCH_OVERLOAD = 35,
243 GSM0808_CAUSE_PROCESSOR_OVERLOAD = 36,
244 GSM0808_CAUSE_BSS_NOT_EQUIPPED = 37,
245 GSM0808_CAUSE_MS_NOT_EQUIPPED = 38,
246 GSM0808_CAUSE_INVALID_CELL = 39,
247 GSM0808_CAUSE_TRAFFIC_LOAD = 40,
248 GSM0808_CAUSE_PREEMPTION = 41,
249 GSM0808_CAUSE_RQSTED_TRANSCODING_RATE_ADAPTION_UNAVAILABLE = 48,
250 GSM0808_CAUSE_CIRCUIT_POOL_MISMATCH = 49,
251 GSM0808_CAUSE_SWITCH_CIRCUIT_POOL = 50,
252 GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE = 51,
253 GSM0808_CAUSE_LSA_NOT_ALLOWED = 52,
254 GSM0808_CAUSE_CIPHERING_ALGORITHM_NOT_SUPPORTED = 64,
255 GSM0808_CAUSE_TERRESTRIAL_CIRCUIT_ALREADY_ALLOCATED = 80,
256 GSM0808_CAUSE_INVALID_MESSAGE_CONTENTS = 81,
257 GSM0808_CAUSE_INFORMATION_ELEMENT_OR_FIELD_MISSING = 82,
258 GSM0808_CAUSE_INCORRECT_VALUE = 83,
259 GSM0808_CAUSE_UNKNOWN_MESSAGE_TYPE = 84,
260 GSM0808_CAUSE_UNKNOWN_INFORMATION_ELEMENT = 85,
261 GSM0808_CAUSE_PROTOCOL_ERROR_BETWEEN_BSS_AND_MSC = 96,
262};
263
264/* GSM 08.08 3.2.2.11 Channel Type */
265enum gsm0808_chan_indicator {
266 GSM0808_CHAN_SPEECH = 1,
267 GSM0808_CHAN_DATA = 2,
268 GSM0808_CHAN_SIGN = 3,
269};
270
271enum gsm0808_chan_rate_type_data {
272 GSM0808_DATA_FULL_BM = 0x8,
273 GSM0808_DATA_HALF_LM = 0x9,
274 GSM0808_DATA_FULL_RPREF = 0xa,
275 GSM0808_DATA_HALF_PREF = 0xb,
276 GSM0808_DATA_FULL_PREF_NO_CHANGE = 0x1a,
277 GSM0808_DATA_HALF_PREF_NO_CHANGE = 0x1b,
278 GSM0808_DATA_MULTI_MASK = 0x20,
279 GSM0808_DATA_MULTI_MASK_NO_CHANGE = 0x30,
280};
281
282enum gsm0808_chan_rate_type_speech {
283 GSM0808_SPEECH_FULL_BM = 0x8,
284 GSM0808_SPEECH_HALF_LM = 0x9,
285 GSM0808_SPEECH_FULL_PREF= 0xa,
286 GSM0808_SPEECH_HALF_PREF= 0xb,
287 GSM0808_SPEECH_FULL_PREF_NO_CHANGE = 0x1a,
288 GSM0808_SPEECH_HALF_PREF_NO_CHANGE = 0x1b,
289 GSM0808_SPEECH_PERM = 0xf,
290 GSM0808_SPEECH_PERM_NO_CHANGE = 0x1f,
291};
292
293enum gsm0808_permitted_speech {
294 GSM0808_PERM_FR1 = 0x01,
295 GSM0808_PERM_FR2 = 0x11,
296 GSM0808_PERM_FR3 = 0x21,
297 GSM0808_PERM_HR1 = GSM0808_PERM_FR1 | 0x4,
298 GSM0808_PERM_HR2 = GSM0808_PERM_FR2 | 0x4,
299 GSM0808_PERM_HR3 = GSM0808_PERM_FR3 | 0x4,
300};