From 0de69a2501e1d49a8202daaeb9cdd7bfee62effa Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Sat, 27 May 2017 13:18:50 +0200 Subject: costmetic: Document gsm48_multirate_config() + const-ify input We generally use const pointers for input arguments. Also, document input/output arguments of function and add spec reference. Change-Id: I2532cde69a18e3b021f7371e68f67a28a43d8b5f --- openbsc/include/openbsc/gsm_04_08.h | 2 +- openbsc/src/libbsc/gsm_04_08_utils.c | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/openbsc/include/openbsc/gsm_04_08.h b/openbsc/include/openbsc/gsm_04_08.h index bdf4ed2a6..fe19ff441 100644 --- a/openbsc/include/openbsc/gsm_04_08.h +++ b/openbsc/include/openbsc/gsm_04_08.h @@ -94,6 +94,6 @@ void gsm48_lchan2chan_desc(struct gsm48_chan_desc *cd, void release_security_operation(struct gsm_subscriber_connection *conn); void allocate_security_operation(struct gsm_subscriber_connection *conn); -int gsm48_multirate_config(uint8_t *lv, struct amr_multirate_conf *mr, struct amr_mode *modes); +int gsm48_multirate_config(uint8_t *lv, const struct amr_multirate_conf *mr, const struct amr_mode *modes); #endif diff --git a/openbsc/src/libbsc/gsm_04_08_utils.c b/openbsc/src/libbsc/gsm_04_08_utils.c index db9dabb25..3447d27cb 100644 --- a/openbsc/src/libbsc/gsm_04_08_utils.c +++ b/openbsc/src/libbsc/gsm_04_08_utils.c @@ -378,7 +378,12 @@ void gsm48_lchan2chan_desc(struct gsm48_chan_desc *cd, } } -int gsm48_multirate_config(uint8_t *lv, struct amr_multirate_conf *mr, struct amr_mode *modes) +/*! \brief Encode a TS 04.08 multirate config LV according to 10.5.2.21aa + * \param[out] lv caller-allocated buffer of 7 bytes. First octet is IS length + * \param[in] mr multi-rate configuration to encode + * \param[in] modes array describing the AMR modes + * \returns 0 on success */ +int gsm48_multirate_config(uint8_t *lv, const struct amr_multirate_conf *mr, const struct amr_mode *modes) { int num = 0, i; -- cgit v1.2.3