Hello Neels Hofmeyr, Jenkins Builder,

I'd like you to reexamine a change.  Please visit

    https://gerrit.osmocom.org/2938

to look at the new patch set (#5).

cosmetic: Add info about corespondig codecs to permitted speech

The constants in enum gsm0808_permitted_speech are not very
expressive. This patch adds a comment which tells to which
codec the constant is coresponding to.

Change-Id: I9734f7c261becffe38ffd41c304d006d08530c1a
---
M include/osmocom/gsm/protocol/gsm_08_08.h
1 file changed, 8 insertions(+), 7 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/38/2938/5

diff --git a/include/osmocom/gsm/protocol/gsm_08_08.h 
b/include/osmocom/gsm/protocol/gsm_08_08.h
index e5e7e1e..5916823 100644
--- a/include/osmocom/gsm/protocol/gsm_08_08.h
+++ b/include/osmocom/gsm/protocol/gsm_08_08.h
@@ -391,14 +391,15 @@
        GSM0808_SPEECH_PERM_NO_CHANGE = 0x1f,
 };
 
-/* GSM 08.08 3.2.2.11 Channel Type */
+/*! \brief GSM 08.08 3.2.2.11 Channel Type
+ *  (see also 3GPP TS 48.008, section 3.2.2.11) */
 enum gsm0808_permitted_speech {
-       GSM0808_PERM_FR1        = 0x01,
-       GSM0808_PERM_FR2        = 0x11,
-       GSM0808_PERM_FR3        = 0x21,
-       GSM0808_PERM_HR1        = GSM0808_PERM_FR1 | 0x4,
-       GSM0808_PERM_HR2        = GSM0808_PERM_FR2 | 0x4,
-       GSM0808_PERM_HR3        = GSM0808_PERM_FR3 | 0x4,
+       GSM0808_PERM_FR1        = 0x01, /*!< GSM FR */
+       GSM0808_PERM_FR2        = 0x11, /*!< GSM EFR */
+       GSM0808_PERM_FR3        = 0x21, /*!< FR AMR */
+       GSM0808_PERM_HR1        = GSM0808_PERM_FR1 | 0x4, /*!< GSM HR */
+       GSM0808_PERM_HR2        = GSM0808_PERM_FR2 | 0x4, /*!< (deprecated) */
+       GSM0808_PERM_HR3        = GSM0808_PERM_FR3 | 0x4, /*!< HR AMR */
 };
 
 /* GSM 08.08 3.2.2.44 Chosen Encryption Algorithm */

-- 
To view, visit https://gerrit.osmocom.org/2938
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I9734f7c261becffe38ffd41c304d006d08530c1a
Gerrit-PatchSet: 5
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: dexter <pma...@sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: Neels Hofmeyr <nhofm...@sysmocom.de>

Reply via email to