[MERGED] osmo-bts[master]: cosmetic: Document some SI scheduling related function API

[Harald Welte]

Harald Welte has submitted this change and it was merged.

Change subject: cosmetic: Document some SI scheduling related function API
......................................................................


cosmetic: Document some SI scheduling related function API

Change-Id: I7e61639349deda28846810c4f52dbea78dccda38
---
M src/common/rsl.c
M src/common/sysinfo.c
2 files changed, 17 insertions(+), 1 deletion(-)

Approvals:
  Harald Welte: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/src/common/rsl.c b/src/common/rsl.c
index 47f59d8..669a39b 100644
--- a/src/common/rsl.c
+++ b/src/common/rsl.c
@@ -496,7 +496,12 @@
 				     TLVP_VAL(&tp, RSL_IE_SMSCB_MSG));
 }
 
-/* 'buf' must be caller-allocated and hold at least len + 2 or sizeof(sysinfo_buf_t) bytes */
+/*! Prefix a given SACCH frame with a L2/LAPDm UI header and store it in given output buffer.
+ *  \param[out] buf Output buffer, must be caller-allocated and hold at least len + 2 or sizeof(sysinfo_buf_t) bytes
+ *  \param[out] valid pointer to bit-mask of 'valid' System information types
+ *  \param[in] current input data (L3 without L2/L1 header)
+ *  \param[in] osmo_si Sytstem Infrormation Type (SYSINFO_TYPE_*)
+ *  \param[in] len length of \a current in octets */
 static inline void lapdm_ui_prefix(uint8_t *buf, uint32_t *valid, const uint8_t *current, uint8_t osmo_si, uint16_t len)
 {
 	/* We have to pre-fix with the two-byte LAPDM UI header */
@@ -514,11 +519,21 @@
 	memcpy(buf + 2, current, len);
 }
 
+/*! Prefix a given SACCH frame with a L2/LAPDm UI header and store it in given BTS SACCH buffer
+ *  \param[out] bts BTS in whose System Information State we shall store
+ *  \param[in] current input data (L3 without L2/L1 header)
+ *  \param[in] osmo_si Sytstem Infrormation Type (SYSINFO_TYPE_*)
+ *  \param[in] len length of \a current in octets */
 static inline void lapdm_ui_prefix_bts(struct gsm_bts *bts, const uint8_t *current, uint8_t osmo_si, uint16_t len)
 {
 	lapdm_ui_prefix(GSM_BTS_SI(bts, osmo_si), &bts->si_valid, current, osmo_si, len);
 }
 
+/*! Prefix a given SACCH frame with a L2/LAPDm UI header and store it in given lchan SACCH buffer
+ *  \param[out] lchan Logical Channel in whose System Information State we shall store
+ *  \param[in] current input data (L3 without L2/L1 header)
+ *  \param[in] osmo_si Sytstem Infrormation Type (SYSINFO_TYPE_*)
+ *  \param[in] len length of \a current in octets */
 static inline void lapdm_ui_prefix_lchan(struct gsm_lchan *lchan, const uint8_t *current, uint8_t osmo_si, uint16_t len)
 {
 	lapdm_ui_prefix(GSM_LCHAN_SI(lchan, osmo_si), &lchan->si.valid, current, osmo_si, len);
diff --git a/src/common/sysinfo.c b/src/common/sysinfo.c
index 6f7a387..3582027 100644
--- a/src/common/sysinfo.c
+++ b/src/common/sysinfo.c
@@ -160,6 +160,7 @@
 	return 1;
 }
 
+/* obtain the next to-be transmitted dowlink SACCH frame (L2 hdr + L3); returns pointer to lchan->si buffer */
 uint8_t *lchan_sacch_get(struct gsm_lchan *lchan)
 {
 	uint32_t tmp;

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I7e61639349deda28846810c4f52dbea78dccda38
Gerrit-PatchSet: 1
Gerrit-Project: osmo-bts
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder