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
This commit is contained in:
Harald Welte 2017-05-27 13:18:50 +02:00
parent 5f72f6fccc
commit 0de69a2501
2 changed files with 7 additions and 2 deletions

View File

@ -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

View File

@ -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;