aboutsummaryrefslogtreecommitdiffstats
path: root/src/l1
diff options
context:
space:
mode:
authorSylvain Munaut <tnt@246tNt.com>2011-12-14 22:23:59 +0100
committerSylvain Munaut <tnt@246tNt.com>2011-12-14 22:25:22 +0100
commit88ad4a48fc336397f7207dc99757bf5fc5ff2413 (patch)
treed5c6085b900871c6e43a085e9ec3911900773b07 /src/l1
parent330d7ce0af210de8def37beffcb69839946546af (diff)
l1/{bcch,ccch}: Add missing doc for conv_rv parameter and return value
Signed-off-by: Sylvain Munaut <tnt@246tNt.com>
Diffstat (limited to 'src/l1')
-rw-r--r--src/l1/bcch.c2
-rw-r--r--src/l1/ccch.c2
2 files changed, 4 insertions, 0 deletions
diff --git a/src/l1/bcch.c b/src/l1/bcch.c
index 16dc2fb..d5d7fb8 100644
--- a/src/l1/bcch.c
+++ b/src/l1/bcch.c
@@ -70,6 +70,8 @@ gmr1_bcch_encode(ubit_t *bits_e, const uint8_t *l2)
/*! \brief Stateless GMR-1 BCCH channel decoder
* \param[out] l2 L2 packet data
* \param[in] bits_e Data bits of a burst
+ * \param[out] conv_rv Return of the convolutional decode (can be NULL)
+ * \return 0 if CRC check pass, any other value for fail.
*
* L2 data is 24 byte long, and bits_e is a 424 hard bit array
* unmapped from a burst.
diff --git a/src/l1/ccch.c b/src/l1/ccch.c
index be7fc0d..ebb9661 100644
--- a/src/l1/ccch.c
+++ b/src/l1/ccch.c
@@ -74,6 +74,8 @@ gmr1_ccch_encode(ubit_t *bits_e, const uint8_t *l2)
/*! \brief Stateless GMR-1 CCCH channel decoder
* \param[out] l2 L2 packet data
* \param[in] bits_e Data bits of a burst
+ * \param[out] conv_rv Return of the convolutional decode (can be NULL)
+ * \return 0 if CRC check pass, any other value for fail.
*
* L2 data is 24 byte long, and bits_e is a 432 hard bit array
* unmapped from a burst.