<p>Neels Hofmeyr has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/9672">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add and tweak inter-BSC HO API<br><br>Add:<br>gsm0808_create_handover_detect()<br>gsm0808_create_handover_complete()<br>gsm0808_create_handover_failure()<br><br>To existing structs gsm0808_old_bss_to_new_bss_info and<br>gsm0808_handover_required, add a final 'more_items' flag that makes future<br>extensions API and ABI compatible.<br><br>Fix the msgb string for Handover Request Ack.<br><br>Extend some API doc comments.<br><br>Related: OS#2283 (inter-BSC Handover, BSC side, MT)<br>Change-Id: I03ee7ce840ecfa0b6a33358e7385528aabd4873f<br>---<br>M include/osmocom/gsm/gsm0808.h<br>M include/osmocom/gsm/gsm_utils.h<br>M src/gsm/gsm0808.c<br>M src/gsm/libosmogsm.map<br>4 files changed, 129 insertions(+), 2 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/72/9672/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/gsm/gsm0808.h b/include/osmocom/gsm/gsm0808.h</span><br><span>index d704aa9..5ae0af8 100644</span><br><span>--- a/include/osmocom/gsm/gsm0808.h</span><br><span>+++ b/include/osmocom/gsm/gsm0808.h</span><br><span>@@ -103,6 +103,7 @@</span><br><span> } current_channel_type_2;</span><br><span> </span><br><span> /* more items are defined in the spec and may be added later */</span><br><span style="color: hsl(120, 100%, 40%);">+ bool more_items; /*< always set this to false */</span><br><span> };</span><br><span> </span><br><span> /*! 3GPP TS 48.008 ยง3.2.1.9 HANDOVER REQUIRED */</span><br><span>@@ -120,6 +121,7 @@</span><br><span> struct gsm0808_old_bss_to_new_bss_info old_bss_to_new_bss_info;</span><br><span> </span><br><span> /* more items are defined in the spec and may be added later */</span><br><span style="color: hsl(120, 100%, 40%);">+ bool more_items; /*< always set this to false */</span><br><span> };</span><br><span> struct msgb *gsm0808_create_handover_required(const struct gsm0808_handover_required *params);</span><br><span> </span><br><span>@@ -127,6 +129,44 @@</span><br><span> uint8_t chosen_channel, uint8_t chosen_encr_alg,</span><br><span> uint8_t chosen_speech_version);</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_handover_detect();</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct gsm0808_handover_complete {</span><br><span style="color: hsl(120, 100%, 40%);">+ bool rr_cause_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t rr_cause;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ bool speech_codec_chosen_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsm0808_speech_codec speech_codec_chosen;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsm0808_speech_codec_list codec_list_bss_supported; /*< omit when .len == 0 */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ bool chosen_encr_alg_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t chosen_encr_alg;</span><br><span style="color: hsl(120, 100%, 40%);">+ </span><br><span style="color: hsl(120, 100%, 40%);">+ bool chosen_channel_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t chosen_channel;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ bool lcls_bss_status_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ enum gsm0808_lcls_status lcls_bss_status;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* more items are defined in the spec and may be added later */</span><br><span style="color: hsl(120, 100%, 40%);">+ bool more_items; /*< always set this to false */</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_handover_complete(const struct gsm0808_handover_complete *params);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct gsm0808_handover_failure {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint16_t cause;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ bool rr_cause_present;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t rr_cause;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ struct gsm0808_speech_codec_list codec_list_bss_supported; /*< omit when .len == 0 */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* more items are defined in the spec and may be added later */</span><br><span style="color: hsl(120, 100%, 40%);">+ bool more_items; /*< always set this to false */</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_handover_failure(const struct gsm0808_handover_failure *params);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> struct msgb *gsm0808_create_dtap(struct msgb *msg, uint8_t link_id);</span><br><span> void gsm0808_prepend_dtap_header(struct msgb *msg, uint8_t link_id);</span><br><span> </span><br><span>diff --git a/include/osmocom/gsm/gsm_utils.h b/include/osmocom/gsm/gsm_utils.h</span><br><span>index 83e29ca..6ff4459 100644</span><br><span>--- a/include/osmocom/gsm/gsm_utils.h</span><br><span>+++ b/include/osmocom/gsm/gsm_utils.h</span><br><span>@@ -30,6 +30,8 @@</span><br><span> </span><br><span> #include <osmocom/core/defs.h></span><br><span> #include <osmocom/core/utils.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsm/protocol/gsm_08_08.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/gsm/protocol/gsm_04_08.h></span><br><span> </span><br><span> #define ADD_MODULO(sum, delta, modulo) do { \</span><br><span> if ((sum += delta) >= modulo) \</span><br><span>diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c</span><br><span>index 3a63137..625de81 100644</span><br><span>--- a/src/gsm/gsm0808.c</span><br><span>+++ b/src/gsm/gsm0808.c</span><br><span>@@ -739,14 +739,16 @@</span><br><span> return msg;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! Create BSSMAP HANDOVER REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.10. */</span><br><span style="color: hsl(120, 100%, 40%);">+/*! Create BSSMAP HANDOVER REQUEST ACKNOWLEDGE message, 3GPP TS 48.008 3.2.1.10.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Sent from the MT BSC back to the MSC when it has allocated an lchan to handover to.</span><br><span style="color: hsl(120, 100%, 40%);">+ * l3_info is the RR Handover Command that the MO BSC sends to the MS to move over. */</span><br><span> struct msgb *gsm0808_create_handover_request_ack(const uint8_t *l3_info, uint8_t l3_info_len,</span><br><span> uint8_t chosen_channel, uint8_t chosen_encr_alg,</span><br><span> uint8_t chosen_speech_version)</span><br><span> {</span><br><span> struct msgb *msg;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-ACCEPT-ACK");</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-REQUEST-ACK");</span><br><span> if (!msg)</span><br><span> return NULL;</span><br><span> </span><br><span>@@ -764,6 +766,86 @@</span><br><span> return msg;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Create BSSMAP HANDOVER DETECT message, 3GPP TS 48.008 3.2.1.40.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Sent from the MT BSC back to the MSC when the MS has sent a handover RACH request and the MT BSC has</span><br><span style="color: hsl(120, 100%, 40%);">+ * received the Handover Detect message. */</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_handover_detect()</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-DETECT");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!msg)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Message Type, 3.2.2.1 */</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_DETECT);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return msg;</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%);">+/*! Create BSSMAP HANDOVER COMPLETE message, 3GPP TS 48.008 3.2.1.12.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Sent from the MT BSC back to the MSC when the MS has fully settled into the new lchan. */</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_handover_complete(const struct gsm0808_handover_complete *params)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-COMPLETE");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!msg)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Message Type, 3.2.2.1 */</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_COMPLETE);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* RR Cause, 3.2.2.22 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (params->rr_cause_present)</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, ¶ms->rr_cause);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* AoIP: Speech Codec (Chosen) 3.2.2.104 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (params->speech_codec_chosen_present)</span><br><span style="color: hsl(120, 100%, 40%);">+ gsm0808_enc_speech_codec(msg, ¶ms->speech_codec_chosen);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (params->codec_list_bss_supported.len)</span><br><span style="color: hsl(120, 100%, 40%);">+ gsm0808_enc_speech_codec_list(msg, ¶ms->codec_list_bss_supported);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Chosen Encryption Algorithm 3.2.2.44 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (params->chosen_encr_alg_present)</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_tv_put(msg, GSM0808_IE_CHOSEN_ENCR_ALG, params->chosen_encr_alg);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* LCLS-BSS-Status 3.2.2.119 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (params->lcls_bss_status_present)</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_tv_put(msg, GSM0808_IE_LCLS_BSS_STATUS, params->lcls_bss_status);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return msg;</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%);">+/*! Create BSSMAP HANDOVER FAILURE message, 3GPP TS 48.008 3.2.1.16.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Sent from the MT BSC back to the MSC when the handover has failed. */</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_handover_failure(const struct gsm0808_handover_failure *params)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM, "BSSMAP-HANDOVER-FAILURE");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!msg)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Message Type, 3.2.2.1 */</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_v_put(msg, BSS_MAP_MSG_HANDOVER_FAILURE);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Cause, 3.2.2.5 */</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_tlv_put(msg, GSM0808_IE_CAUSE, params->cause & 0x80? 2 : 1, (const uint8_t*)¶ms->cause);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* RR Cause, 3.2.2.22 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (params->rr_cause_present)</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_tlv_put(msg, GSM0808_IE_RR_CAUSE, 1, ¶ms->rr_cause);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* AoIP: add Codec List (BSS Supported) 3.2.2.103 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (params->codec_list_bss_supported.len)</span><br><span style="color: hsl(120, 100%, 40%);">+ gsm0808_enc_speech_codec_list(msg, ¶ms->codec_list_bss_supported);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return msg;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! Prepend a DTAP header to given Message Buffer</span><br><span> * \param[in] msgb Message Buffer</span><br><span> * \param[in] link_id Link Identifier */</span><br><span>diff --git a/src/gsm/libosmogsm.map b/src/gsm/libosmogsm.map</span><br><span>index 4d9811b..69fb24a 100644</span><br><span>--- a/src/gsm/libosmogsm.map</span><br><span>+++ b/src/gsm/libosmogsm.map</span><br><span>@@ -168,6 +168,9 @@</span><br><span> gsm0808_create_sapi_reject;</span><br><span> gsm0808_create_handover_required;</span><br><span> gsm0808_create_handover_request_ack;</span><br><span style="color: hsl(120, 100%, 40%);">+gsm0808_create_handover_detect;</span><br><span style="color: hsl(120, 100%, 40%);">+gsm0808_create_handover_complete;</span><br><span style="color: hsl(120, 100%, 40%);">+gsm0808_create_handover_failure;</span><br><span> gsm0808_prepend_dtap_header;</span><br><span> gsm0808_enc_aoip_trasp_addr;</span><br><span> gsm0808_dec_aoip_trasp_addr;</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/9672">change 9672</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/9672"/><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: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I03ee7ce840ecfa0b6a33358e7385528aabd4873f </div>
<div style="display:none"> Gerrit-Change-Number: 9672 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>