[PATCH] osmo-pcu[master]: encoding: add doxygen for rlc_data_to_dl_append*

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/OpenBSC@lists.osmocom.org/.

lynxis lazus gerrit-no-reply at lists.osmocom.org
Tue May 31 11:25:37 UTC 2016


Review at  https://gerrit.osmocom.org/141

encoding: add doxygen for rlc_data_to_dl_append*

Change-Id: I6ead0f1d14a91c657448227e17438b49a54e6c4a
---
M src/encoding.cpp
1 file changed, 31 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-pcu refs/changes/41/141/1

diff --git a/src/encoding.cpp b/src/encoding.cpp
index 6c50abe..9dba4f6 100644
--- a/src/encoding.cpp
+++ b/src/encoding.cpp
@@ -891,6 +891,16 @@
 	return rdbi->data_len;
 }
 
+/*!
+ * \brief (GPRS) put llc pdu into an rlc/mac block. fragment the llc pdu if needed
+ * \param rdbi rlc/mac block info
+ * \param llc llc pdu
+ * \param offset given offset within the rlc/mac block
+ * \param num_chunks count the chunks (llc pdu data) within rlc/mac
+ * \param data_block buffer holds rlc/mac data
+ * \param is_final if this is the last rlc/mac within a TBF
+ * \return the state of the rlc/mac like if there is more space for another chunk
+ */
 static Encoding::AppendResult rlc_data_to_dl_append_gprs(
 	struct gprs_rlc_data_block_info *rdbi,
 	gprs_llc *llc, int *offset, int *num_chunks,
@@ -1012,6 +1022,16 @@
 	return Encoding::AR_COMPLETED_BLOCK_FILLED;
 }
 
+/*!
+ * \brief (EGPRS) put llc pdu into an rlc/mac block. fragment the llc pdu if needed
+ * \param rdbi rlc/mac block info
+ * \param llc llc pdu
+ * \param offset given offset within the rlc/mac block
+ * \param num_chunks count the chunks (llc pdu data) within rlc/mac
+ * \param data_block buffer holds rlc/mac data
+ * \param is_final if this is the last rlc/mac within a TBF
+ * \return the state of the rlc/mac like if there is more space for another chunk
+ */
 static Encoding::AppendResult rlc_data_to_dl_append_egprs(
 	struct gprs_rlc_data_block_info *rdbi,
 	gprs_llc *llc, int *offset, int *num_chunks,
@@ -1154,6 +1174,17 @@
 	return Encoding::AR_COMPLETED_BLOCK_FILLED;
 }
 
+/*!
+ * \brief Encoding::rlc_data_to_dl_append
+ * \param rdbi rlc/mac block info
+ * \param cs the coding scheme to use
+ * \param llc llc pdu
+ * \param offset given offset within the rlc/mac block
+ * \param num_chunks count the chunks (llc pdu data) within rlc/mac
+ * \param data_block buffer holds rlc/mac data
+ * \param is_final if this is the last rlc/mac within a TBF
+ * \return the state of the rlc/mac like if there is more space for another chunk
+ */
 Encoding::AppendResult Encoding::rlc_data_to_dl_append(
 	struct gprs_rlc_data_block_info *rdbi, GprsCodingScheme cs,
 	gprs_llc *llc, int *offset, int *num_chunks,

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

Gerrit-MessageType: newchange
Gerrit-Change-Id: I6ead0f1d14a91c657448227e17438b49a54e6c4a
Gerrit-PatchSet: 1
Gerrit-Project: osmo-pcu
Gerrit-Branch: master
Gerrit-Owner: lynxis lazus <lynxis at fe80.eu>



More information about the OpenBSC mailing list