From d1365e1a815c057947257c7342a1153476dc721f Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Mon, 18 Feb 2019 13:44:30 +0100 Subject: gsm0808: comment about difference of gsm0808_create_clear_command() This single function has a quite different behavior than the other gsm0808_ functions in terms of how the resulting msgb l3h pointers are set. Let's document that to avoid more confusion. Change-Id: I0367760a588fc968c5a2dea46001ef1ee7965c8c --- src/gsm/gsm0808.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'src/gsm') diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c index 86b6c058..48730766 100644 --- a/src/gsm/gsm0808.c +++ b/src/gsm/gsm0808.c @@ -178,7 +178,10 @@ struct msgb *gsm0808_create_clear_complete(void) return msg; } -/*! Create BSSMAP Clear Command message +/*! Create BSSMAP Clear Command message with BSSAP header *before* l3h and BSSMAP in l3h. + * This is quite different from most (all?) other gsm0808_create_* which have l3h + * point to the BSSAP header. However, we have to keep this for backwards compatibility. + * Use gsm0808_create_clear_command2() for a 'modern' implementation. * \param[in] cause TS 08.08 cause value * \returns callee-allocated msgb with BSSMAP Clear Command message */ struct msgb *gsm0808_create_clear_command(uint8_t cause) -- cgit v1.2.3