1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
/*
* DECT Mobility Management (MM) NWK <-> IWU interface
*
* Copyright (c) 2009-2010 Patrick McHardy <kaber@trash.net>
*/
#ifndef _LIBDECT_DECT_MM_H
#define _LIBDECT_DECT_MM_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup mm
* @{
**/
#include <dect/ie.h>
/**
* @addtogroup mm_access_rights
* @{
*/
/** MM_ACCESS_RIGHTS primitive parameters. */
struct dect_mm_access_rights_param {
struct dect_ie_collection common;
struct dect_ie_portable_identity *portable_identity;
struct dect_ie_list fixed_identity;
struct dect_ie_location_area *location_area;
struct dect_ie_auth_type *auth_type;
struct dect_ie_cipher_info *cipher_info;
struct dect_ie_zap_field *zap_field;
struct dect_ie_setup_capability *setup_capability;
struct dect_ie_terminal_capability *terminal_capability;
struct dect_ie_service_class *service_class;
struct dect_ie_model_identifier *model_identifier;
struct dect_ie_reject_reason *reject_reason;
struct dect_ie_duration *duration;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
struct dect_ie_codec_list *codec_list;
};
/**
* @}
* @addtogroup mm_access_rights_terminate
* @{
*/
/** MM_ACCESS_RIGHTS_TERMINATE primitive parameters. */
struct dect_mm_access_rights_terminate_param {
struct dect_ie_collection common;
struct dect_ie_portable_identity *portable_identity;
struct dect_ie_list fixed_identity;
struct dect_ie_reject_reason *reject_reason;
struct dect_ie_duration *duration;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_key_allocation
* @{
*/
/** MM_KEY_ALLOCATE primitive parameters. */
struct dect_mm_key_allocate_param {
struct dect_ie_collection common;
struct dect_ie_allocation_type *allocation_type;
struct dect_ie_auth_value *rand;
struct dect_ie_auth_value *rs;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_auth
* @{
*/
/** MM_AUTHENTICATE primitive parameters. */
struct dect_mm_authenticate_param {
struct dect_ie_collection common;
struct dect_ie_auth_type *auth_type;
struct dect_ie_auth_value *rand;
struct dect_ie_auth_res *res;
struct dect_ie_auth_value *rs;
struct dect_ie_cipher_info *cipher_info;
struct dect_ie_zap_field *zap_field;
struct dect_ie_service_class *service_class;
struct dect_ie_key *key;
struct dect_ie_reject_reason *reject_reason;
struct dect_ie_list iwu_to_iwu;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_cipher
* @{
*/
/** MM_CIPHER primitive parameters. */
struct dect_mm_cipher_param {
struct dect_ie_collection common;
struct dect_ie_cipher_info *cipher_info;
struct dect_ie_call_identity *call_identity;
struct dect_ie_connection_identity *connection_identity;
struct dect_ie_reject_reason *reject_reason;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_location_registration
* @{
*/
/** MM_LOCATE primitive parameters. */
struct dect_mm_locate_param {
struct dect_ie_collection common;
struct dect_ie_portable_identity *portable_identity;
struct dect_ie_fixed_identity *fixed_identity;
struct dect_ie_location_area *location_area;
struct dect_ie_nwk_assigned_identity *nwk_assigned_identity;
struct dect_ie_cipher_info *cipher_info;
struct dect_ie_reject_reason *reject_reason;
struct dect_ie_setup_capability *setup_capability;
struct dect_ie_terminal_capability *terminal_capability;
struct dect_ie_duration *duration;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_model_identifier *model_identifier;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
struct dect_ie_codec_list *codec_list;
};
/**
* @}
* @addtogroup mm_detach
* @{
*/
/** MM_DETACH primitive parameters. */
struct dect_mm_detach_param {
struct dect_ie_collection common;
struct dect_ie_portable_identity *portable_identity;
struct dect_ie_nwk_assigned_identity *nwk_assigned_identity;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_identification
* @{
*/
/** MM_IDENTITY primitive parameters */
struct dect_mm_identity_param {
struct dect_ie_collection common;
struct dect_ie_list identity_type;
struct dect_ie_network_parameter *network_parameter;
struct dect_ie_list portable_identity;
struct dect_ie_list fixed_identity;
struct dect_ie_list nwk_assigned_identity;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_model_identifier *model_identifier;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_temporary_identity_assignment
* @{
*/
/** MM_IDENTITY_ASSIGN primitive parameters. */
struct dect_mm_identity_assign_param {
struct dect_ie_collection common;
struct dect_ie_portable_identity *portable_identity;
struct dect_ie_location_area *location_area;
struct dect_ie_nwk_assigned_identity *nwk_assigned_identity;
struct dect_ie_duration *duration;
struct dect_ie_network_parameter *network_parameter;
struct dect_ie_reject_reason *reject_reason;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_parameter_retrieval
* @{
*/
/** MM_INFO primitive parameters. */
struct dect_mm_info_param {
struct dect_ie_collection common;
struct dect_ie_info_type *info_type;
struct dect_ie_call_identity *call_identity;
struct dect_ie_portable_identity *portable_identity;
struct dect_ie_list fixed_identity;
struct dect_ie_location_area *location_area;
struct dect_ie_nwk_assigned_identity *nwk_assigned_identity;
struct dect_ie_network_parameter *network_parameter;
struct dect_ie_reject_reason *reject_reason;
struct dect_ie_duration *duration;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/**
* @}
* @addtogroup mm_external_protocol_information
* @{
*/
/** MM_IWU primitive parameters. */
struct dect_mm_iwu_param {
struct dect_ie_collection common;
struct dect_ie_iwu_to_iwu *iwu_to_iwu;
struct dect_ie_iwu_packet *iwu_packet;
struct dect_ie_escape_to_proprietary *escape_to_proprietary;
};
/** @} */
struct dect_mm_endpoint;
extern struct dect_mm_endpoint *dect_mm_endpoint_alloc(struct dect_handle *dh,
struct dect_data_link *ddl);
extern void dect_mm_endpoint_destroy(struct dect_handle *dh,
struct dect_mm_endpoint *mme);
extern void *dect_mm_priv(struct dect_mm_endpoint *mme);
/**
* Mobility Management Ops.
*
* The MM ops are used to register callback functions for the MM primitives
* invoked by libdect.
*/
struct dect_mm_ops {
size_t priv_size;
/**< Size of the private storage area of an MM endpoint */
void (*mm_access_rights_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_access_rights_param *param);
/**< MM_ACCESS_RIGHTS-ind primitive */
void (*mm_access_rights_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme, bool accept,
struct dect_mm_access_rights_param *param);
/**< MM_ACCESS_RIGHTS-cfm primitive */
void (*mm_access_rights_terminate_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_access_rights_terminate_param *param);
/**< MM_ACCESS_RIGHTS_TERMINATE-ind primitive */
void (*mm_access_rights_terminate_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme, bool accept,
struct dect_mm_access_rights_terminate_param *param);
/**< MM_ACCESS_RIGHTS_TERMINATE-cfm primitive */
void (*mm_key_allocate_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_key_allocate_param *param);
/**< MM_KEY_ALLOCATE-ind primitive */
void (*mm_authenticate_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_authenticate_param *param);
/**< MM_AUTHENTICATE-ind primitive */
void (*mm_authenticate_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme, bool accept,
struct dect_mm_authenticate_param *param);
/**< MM_AUTHENTICATE-cfm primitive */
void (*mm_cipher_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_cipher_param *param);
/**< MM_CIPHER-ind primitive */
void (*mm_cipher_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme, bool accept,
struct dect_mm_cipher_param *param);
/**< MM_CIPHER-cfm primitive */
void (*mm_locate_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_locate_param *param);
/**< MM_LOCATE-ind primitive */
void (*mm_locate_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme, bool accept,
struct dect_mm_locate_param *param);
/**< MM_LOCATE-cfm primitive */
void (*mm_detach_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_detach_param *param);
/**< MM_DETACH-ind primitive */
void (*mm_identity_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_identity_param *param);
/**< MM_IDENTITY-ind primitive */
void (*mm_identity_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_identity_param *param);
/**< MM_IDENTITY-cfm primitive */
void (*mm_identity_assign_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_identity_assign_param *param);
/**< MM_IDENTITY_ASSIGN-ind primitive */
void (*mm_identity_assign_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme, bool accept,
struct dect_mm_identity_assign_param *param);
/**< MM_IDENTITY_ASSIGN-cfm primitive */
void (*mm_info_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_info_param *param);
/**< MM_INFO-ind primitive */
void (*mm_info_cfm)(struct dect_handle *dh,
struct dect_mm_endpoint *mme, bool accept,
struct dect_mm_info_param *param);
/**< MM_INFO-cfm primitive */
void (*mm_iwu_ind)(struct dect_handle *dh,
struct dect_mm_endpoint *mme,
struct dect_mm_iwu_param *param);
/**< MM_IWU-ind primitive */
};
extern int dect_mm_access_rights_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_access_rights_param *param);
extern void dect_mm_access_rights_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
bool accept, const struct dect_mm_access_rights_param *param);
extern int dect_mm_access_rights_terminate_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_access_rights_terminate_param *param);
extern void dect_mm_access_rights_terminate_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
bool accept, const struct dect_mm_access_rights_terminate_param *param);
extern int dect_mm_key_allocate_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_key_allocate_param *param);
extern int dect_mm_authenticate_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_authenticate_param *param);
extern void dect_mm_authenticate_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
bool accept, const struct dect_mm_authenticate_param *param);
extern int dect_mm_cipher_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_cipher_param *param,
const uint8_t ck[]);
extern void dect_mm_cipher_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
bool accept, const struct dect_mm_cipher_param *param,
const uint8_t ck[]);
extern int dect_mm_locate_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_locate_param *param);
extern void dect_mm_locate_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
bool accept, const struct dect_mm_locate_param *param);
extern int dect_mm_detach_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
struct dect_mm_detach_param *param);
extern int dect_mm_identity_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_identity_param *param);
extern void dect_mm_identity_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_identity_param *param);
extern int dect_mm_identity_assign_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_identity_assign_param *param);
extern void dect_mm_identity_assign_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
bool accept, const struct dect_mm_identity_assign_param *param);
extern int dect_mm_info_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
struct dect_mm_info_param *param);
extern void dect_mm_info_res(struct dect_handle *dh, struct dect_mm_endpoint *mme,
bool accept, struct dect_mm_info_param *param);
extern int dect_mm_iwu_req(struct dect_handle *dh, struct dect_mm_endpoint *mme,
const struct dect_mm_iwu_param *param);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* _LIBDECT_DECT_MM_H */
|
