<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/11577">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Harald Welte: Looks good to me, approved
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Update 3GPP TS 08.08 Cause handling<br><br>* add Class definitions<br>* add helper to check for extended bit<br>* add helper to get Cause's Class<br>* use enum in gsm0808_cause_name() and gsm0808_create_cipher_reject() to<br> avoid confusion between class and cause<br>* update gsm0808_create_cipher_reject() comments<br><br>Change-Id: I31b31dfc22eb4b6b07089e1255246ac458125340<br>Related: OS#3187<br>---<br>M TODO-RELEASE<br>M include/osmocom/gsm/gsm0808.h<br>M include/osmocom/gsm/gsm0808_utils.h<br>M include/osmocom/gsm/protocol/gsm_08_08.h<br>M src/gsm/gsm0808.c<br>M src/gsm/libosmogsm.map<br>6 files changed, 59 insertions(+), 9 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/TODO-RELEASE b/TODO-RELEASE</span><br><span>index 5222ec9..00720f6 100644</span><br><span>--- a/TODO-RELEASE</span><br><span>+++ b/TODO-RELEASE</span><br><span>@@ -11,3 +11,8 @@</span><br><span> libosmogsm gsm48_push_l3hdr() (re)introduced in gsm/gsm48.h (GSM 04.08 API)</span><br><span> libosmogsm gsm48_push_l3hdr_tid() a wrapper around gsm48_push_l3hdr()</span><br><span> libosmocore msgb_l4len new symbol (exposed as 'static inline' in msgb.h)</span><br><span style="color: hsl(120, 100%, 40%);">+libosmogsm gsm0808_cause_class_name() getter for class description</span><br><span style="color: hsl(120, 100%, 40%);">+libosmogsm gsm0808_cause_class() getter for cause class</span><br><span style="color: hsl(120, 100%, 40%);">+libosmogsm gsm0808_cause_ext() check for cause extended bit</span><br><span style="color: hsl(120, 100%, 40%);">+libosmogsm gsm0808_cause_name() use enum as parameter</span><br><span style="color: hsl(120, 100%, 40%);">+libosmogsm gsm0808_create_cipher_reject() use enum as parameter</span><br><span>diff --git a/include/osmocom/gsm/gsm0808.h b/include/osmocom/gsm/gsm0808.h</span><br><span>index 652aae9..66f7c27 100644</span><br><span>--- a/include/osmocom/gsm/gsm0808.h</span><br><span>+++ b/include/osmocom/gsm/gsm0808.h</span><br><span>@@ -50,7 +50,7 @@</span><br><span> struct msgb *gsm0808_create_cipher(const struct gsm0808_encrypt_info *ei,</span><br><span> const uint8_t *cipher_response_mode);</span><br><span> struct msgb *gsm0808_create_cipher_complete(struct msgb *layer3, uint8_t alg_id);</span><br><span style="color: hsl(0, 100%, 40%);">-struct msgb *gsm0808_create_cipher_reject(uint8_t cause);</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause);</span><br><span> struct msgb *gsm0808_create_classmark_request();</span><br><span> struct msgb *gsm0808_create_classmark_update(const uint8_t *cm2, uint8_t cm2_len,</span><br><span> const uint8_t *cm3, uint8_t cm3_len);</span><br><span>@@ -178,7 +178,8 @@</span><br><span> </span><br><span> const char *gsm0808_bssmap_name(uint8_t msg_type);</span><br><span> const char *gsm0808_bssap_name(uint8_t msg_type);</span><br><span style="color: hsl(0, 100%, 40%);">-const char *gsm0808_cause_name(uint8_t cause);</span><br><span style="color: hsl(120, 100%, 40%);">+const char *gsm0808_cause_name(enum gsm0808_cause cause);</span><br><span style="color: hsl(120, 100%, 40%);">+const char *gsm0808_cause_class_name(enum gsm0808_cause_class class);</span><br><span> </span><br><span> extern const struct value_string gsm0808_lcls_config_names[];</span><br><span> extern const struct value_string gsm0808_lcls_control_names[];</span><br><span>diff --git a/include/osmocom/gsm/gsm0808_utils.h b/include/osmocom/gsm/gsm0808_utils.h</span><br><span>index f70dbdb..b56e263 100644</span><br><span>--- a/include/osmocom/gsm/gsm0808_utils.h</span><br><span>+++ b/include/osmocom/gsm/gsm0808_utils.h</span><br><span>@@ -107,7 +107,20 @@</span><br><span> uint16_t gsm0808_sc_cfg_from_gsm48_mr_cfg(const struct gsm48_multi_rate_conf *cfg, bool fr);</span><br><span> void gsm48_mr_cfg_from_gsm0808_sc_cfg(struct gsm48_multi_rate_conf *cfg, uint16_t s15_s0);</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! Return 3GPP TS 48.008 3.2.2.49 Current Channel Type 1 from enum gsm_chan_t. */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \returns 3GPP TS 08.08 §3.2.2.5 Class of a given Cause */</span><br><span style="color: hsl(120, 100%, 40%);">+static inline enum gsm0808_cause_class gsm0808_cause_class(enum gsm0808_cause cause)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return (cause << 1) >> 4;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \returns true if 3GPP TS 08.08 §3.2.2.5 Class has extended bit set */</span><br><span style="color: hsl(120, 100%, 40%);">+static inline bool gsm0808_cause_ext(enum gsm0808_cause cause)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ /* check that cause looks like 1XXX0000 where XXX represent class */</span><br><span style="color: hsl(120, 100%, 40%);">+ return (cause & 0x80) && !(cause & 0x0F);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \returns 3GPP TS 48.008 3.2.2.49 Current Channel Type 1 from enum gsm_chan_t. */</span><br><span> static inline uint8_t gsm0808_current_channel_type_1(enum gsm_chan_t type)</span><br><span> {</span><br><span> switch (type) {</span><br><span>diff --git a/include/osmocom/gsm/protocol/gsm_08_08.h b/include/osmocom/gsm/protocol/gsm_08_08.h</span><br><span>index 8431ace..2317e78 100644</span><br><span>--- a/include/osmocom/gsm/protocol/gsm_08_08.h</span><br><span>+++ b/include/osmocom/gsm/protocol/gsm_08_08.h</span><br><span>@@ -384,6 +384,18 @@</span><br><span> GSM0808_CAUSE_DTM_HO_TIMER_EXPIRY = 0x62,</span><br><span> };</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/* 3GPP TS 08.08 §3.2.2.5 Cause Class */</span><br><span style="color: hsl(120, 100%, 40%);">+enum gsm0808_cause_class {</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_NORM0 = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_NORM1 = 1,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_RES_UNAVAIL = 2,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_SRV_OPT_NA = 3,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_SRV_OPT_NIMPL = 4,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_INVAL = 5,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_PERR = 6,</span><br><span style="color: hsl(120, 100%, 40%);">+ GSM0808_CAUSE_CLASS_INTW = 7,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /* GSM 08.08 3.2.2.11 Channel Type */</span><br><span> enum gsm0808_chan_indicator {</span><br><span> GSM0808_CHAN_SPEECH = 1,</span><br><span>diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c</span><br><span>index e5c3e30..791ebc2 100644</span><br><span>--- a/src/gsm/gsm0808.c</span><br><span>+++ b/src/gsm/gsm0808.c</span><br><span>@@ -265,18 +265,18 @@</span><br><span> }</span><br><span> </span><br><span> /*! Create BSSMAP Cipher Mode Reject message</span><br><span style="color: hsl(0, 100%, 40%);">- * \param[in] cause TS 08.08 cause value</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] cause 3GPP TS 08.08 §3.2.2.5 cause value</span><br><span> * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */</span><br><span style="color: hsl(0, 100%, 40%);">-struct msgb *gsm0808_create_cipher_reject(uint8_t cause)</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause)</span><br><span> {</span><br><span> struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,</span><br><span style="color: hsl(0, 100%, 40%);">- "bssmap: clear complete");</span><br><span style="color: hsl(120, 100%, 40%);">+ "bssmap: cipher mode reject");</span><br><span> if (!msg)</span><br><span> return NULL;</span><br><span> </span><br><span> msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);</span><br><span style="color: hsl(0, 100%, 40%);">- /* FIXME: support 2-byte cause value as per 3GPP TS 08.08 §3.2.2.5 */</span><br><span style="color: hsl(0, 100%, 40%);">- msgb_tlv_put(msg, GSM0808_IE_CAUSE, 1, &cause);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_tlv_put(msg, GSM0808_IE_CAUSE, 1, (const uint8_t *)&cause);</span><br><span> </span><br><span> msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));</span><br><span> </span><br><span>@@ -1271,8 +1271,26 @@</span><br><span> { 0, NULL }</span><br><span> };</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+static const struct value_string gsm0808_cause_class_names[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_NORM0, "Normal event" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_NORM1, "Normal event" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_RES_UNAVAIL, "Resource unavailable" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_SRV_OPT_NA, "Service or option not available" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_SRV_OPT_NIMPL, "Service or option not implemented" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_INVAL, "Invalid message" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_PERR, "Protocol error" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { GSM0808_CAUSE_CLASS_INTW, "Interworking" },</span><br><span style="color: hsl(120, 100%, 40%);">+ { 0, NULL }</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! Return string name of BSSMAP Cause Class name */</span><br><span style="color: hsl(120, 100%, 40%);">+const char *gsm0808_cause_class_name(enum gsm0808_cause_class class)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return get_value_string(gsm0808_cause_class_names, class);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! Return string name of BSSMAP Cause name */</span><br><span style="color: hsl(0, 100%, 40%);">-const char *gsm0808_cause_name(uint8_t cause)</span><br><span style="color: hsl(120, 100%, 40%);">+const char *gsm0808_cause_name(enum gsm0808_cause cause)</span><br><span> {</span><br><span> return get_value_string(gsm0808_cause_names, cause);</span><br><span> }</span><br><span>diff --git a/src/gsm/libosmogsm.map b/src/gsm/libosmogsm.map</span><br><span>index 6234d94..32e4ce9 100644</span><br><span>--- a/src/gsm/libosmogsm.map</span><br><span>+++ b/src/gsm/libosmogsm.map</span><br><span>@@ -148,6 +148,7 @@</span><br><span> gsm0808_bssap_name;</span><br><span> gsm0808_bssmap_name;</span><br><span> gsm0808_cause_name;</span><br><span style="color: hsl(120, 100%, 40%);">+gsm0808_cause_class_name;</span><br><span> gsm0808_create_ass;</span><br><span> gsm0808_create_assignment_completed;</span><br><span> gsm0808_create_ass_compl;</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/11577">change 11577</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/11577"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I31b31dfc22eb4b6b07089e1255246ac458125340 </div>
<div style="display:none"> Gerrit-Change-Number: 11577 </div>
<div style="display:none"> Gerrit-PatchSet: 9 </div>
<div style="display:none"> Gerrit-Owner: Max <msuraev@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Max <msuraev@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>