From 442f95ee8b56c40f8fcc76ac6f0358d709bea711 Mon Sep 17 00:00:00 2001 From: dvdgrgrtt Date: Mon, 13 Dec 2021 12:19:55 +0100 Subject: [PATCH] Document PUSCH NR BLER test --- lib/src/phy/phch/test/pusch_nr_bler_test.c | 28 ++++++++++++++++++---- 1 file changed, 24 insertions(+), 4 deletions(-) diff --git a/lib/src/phy/phch/test/pusch_nr_bler_test.c b/lib/src/phy/phch/test/pusch_nr_bler_test.c index 5fb1af667..8b042a7bb 100644 --- a/lib/src/phy/phch/test/pusch_nr_bler_test.c +++ b/lib/src/phy/phch/test/pusch_nr_bler_test.c @@ -1,10 +1,30 @@ /** + * \file pusch_nr_bler_test.c + * \brief BLER and throughput test for PUSCH NR. * - * \section COPYRIGHT + * This program simulates several PUSCH transmissions in order to estimate its performance in terms of the receiver BLER + * and throughput (expressed as a percentage of the transmitted one). Specifically, the simulation runs until 100 + * transmissions fail (or after 2,000,000 transmitted transport blocks). Failures are detected by CRC verification. * - * Copyright 2013-2021 Software Radio Systems Limited + * The simulation setup can be controlled by means of the following arguments. + * - -p num: sets the number of granted PUSCH PRBs to \c num. + * - -T tab: sets the modulation and coding scheme table (valid options: \c 64qam, \c 256qam, \c 64qamLowSE). + * - -m mcs: sets the modulation and coding scheme index to \c mcs. + * - -L num: sets the number of transmission layers to \c num. + * - -A num: sets the number of HARQ-ACK bits to \c num. + * - -C num: sets the number of CSI bits to \c num. + * - -s val: sets the nominal SNR to \c val (in dB). + * - -f : activates full BLER simulations (Tx--Rx comparison as opposed to CRC-verification only). + * - -v : activates verbose output. * - * By using this file, you agree to the terms and conditions set + * Example: + * \code{.cpp} + * pusch_nr_bler_test -p 52 -m 2 -T 64qam -s -1.8 -f + * \endcode + * + * \copyright Copyright 2013-2021 Software Radio Systems Limited + * + * \copyright By using this file, you agree to the terms and conditions set * forth in the LICENSE file which can be found at the top level of * the distribution. * @@ -31,7 +51,7 @@ static bool full_check = false; void usage(char* prog) { - printf("Usage: %s [pmTLACsv] \n", prog); + printf("Usage: %s [pmTLACsfv] \n", prog); printf("\t-p Number of grant PRB, set to 0 for steering [Default %d]\n", n_prb); printf("\t-m MCS PRB, set to >28 for steering [Default %d]\n", mcs); printf("\t-T Provide MCS table (64qam, 256qam, 64qamLowSE) [Default %s]\n",