diff options
author | Harald Welte <laforge@gnumonks.org> | 2016-04-25 16:01:15 +0200 |
---|---|---|
committer | Harald Welte <laforge@gnumonks.org> | 2016-04-29 13:10:37 +0200 |
commit | eff215a8bb766e62a02bcc0f4334470a53475001 (patch) | |
tree | 4a0b46f5009098e76958aa99f63997778c968ddb /openbsc/include | |
parent | 7ca035decaaed460e66286868b1f14ccd3e00013 (diff) |
osmo_gsup_messge.[ch] documentation update (doxygen)
Diffstat (limited to 'openbsc/include')
-rw-r--r-- | openbsc/include/openbsc/osmo_gsup_messages.h | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/openbsc/include/openbsc/osmo_gsup_messages.h b/openbsc/include/openbsc/osmo_gsup_messages.h index 4ccc029fc..8156b739b 100644 --- a/openbsc/include/openbsc/osmo_gsup_messages.h +++ b/openbsc/include/openbsc/osmo_gsup_messages.h @@ -1,11 +1,9 @@ /* Osmocom Subscriber Update Protocol message encoder/decoder */ -/* (C) 2014 by Sysmocom s.f.m.c. GmbH +/* (C) 2014 by Sysmocom s.f.m.c. GmbH, Author: Jacob Erlbeck * (C) 2016 by Harald Welte <laforge@gnumonks.org> * All Rights Reserved * - * Author: Jacob Erlbeck - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by * the Free Software Foundation; either version 3 of the License, or @@ -28,12 +26,16 @@ #include <osmocom/gsm/protocol/gsm_04_08_gprs.h> #include <osmocom/crypt/auth.h> +/*! Maximum nubmer of PDP inside \ref osmo_gsup_message */ #define OSMO_GSUP_MAX_NUM_PDP_INFO 10 /* GSM 09.02 limits this to 50 */ +/*! Maximum number of auth info inside \ref osmo_gsup_message */ #define OSMO_GSUP_MAX_NUM_AUTH_INFO 5 +/*! Maximum number of octets encoding MSISDN in BCD format */ #define OSMO_GSUP_MAX_MSISDN_LEN 9 #define OSMO_GSUP_PDP_TYPE_SIZE 2 +/*! Information Element Identifiers for GSUP IEs */ enum osmo_gsup_iei { OSMO_GSUP_IMSI_IE = 0x01, OSMO_GSUP_CAUSE_IE = 0x02, @@ -59,6 +61,7 @@ enum osmo_gsup_iei { OSMO_GSUP_RES_IE = 0x27, }; +/*! GSUP message type */ enum osmo_gsup_message_type { OSMO_GSUP_MSGT_UPDATE_LOCATION_REQUEST = 0b00000100, OSMO_GSUP_MSGT_UPDATE_LOCATION_ERROR = 0b00000101, @@ -94,16 +97,25 @@ enum osmo_gsup_cancel_type { OSMO_GSUP_CANCEL_TYPE_WITHDRAW = 2, /* on wire: 1 */ }; +/*! parsed/decoded PDP context information */ struct osmo_gsup_pdp_info { unsigned int context_id; int have_info; + /*! Type of PDP context */ uint16_t pdp_type; + /*! APN information, still in encoded form. Can be NULL if no + * APN information included */ const uint8_t *apn_enc; + /*! length (in octets) of apn_enc */ size_t apn_enc_len; + /*! QoS information, still in encoded form. Can be NULL if no + * QoS information included */ const uint8_t *qos_enc; + /*! length (in octets) of qos_enc */ size_t qos_enc_len; }; +/*! parsed/decoded GSUP protocol message */ struct osmo_gsup_message { enum osmo_gsup_message_type message_type; char imsi[GSM23003_IMSI_MAX_DIGITS+2]; |