diff --git a/openair1/PHY/impl_defs_top.h b/openair1/PHY/impl_defs_top.h
index c84b7d3ece8544bb34e0c5b8b3134ea0e025bb66..5fe559b80d38dbaf06fe91786edff615b4ceda7e 100755
--- a/openair1/PHY/impl_defs_top.h
+++ b/openair1/PHY/impl_defs_top.h
@@ -44,7 +44,14 @@
/** @defgroup _ref_implementation_ OpenAirInterface LTE Implementation
* @{
- * @defgroup _PHY_RF_INTERFACE_ Generic PHY - RF Interface
+ * @defgroup _PHY_RF_INTERFACE_ PHY - RF Interface
+ * @ingroup _PHY_RF_INTERFACE_
+ * @{
+ * @defgroup _GENERIC_PHY_RF_INTERFACE_ Generic PHY - RF Interface
+ * @defgroup _USRP_PHY_RF_INTERFACE_ PHY - USRP RF Interface
+ * @defgroup _BLADERF_PHY_RF_INTERFACE_ PHY - BLADERF RF Interface
+ * @}
+ *
* @ingroup _ref_implementation_
* @{
* This module is responsible for defining the generic interface between PHY and RF Target
diff --git a/targets/ARCH/COMMON/common_lib.h b/targets/ARCH/COMMON/common_lib.h
index 552611882880ed2a95dd0a5672bf44566f5024f7..6f8864180349c5d1cb5b7c4923f4b6513250a282 100644
--- a/targets/ARCH/COMMON/common_lib.h
+++ b/targets/ARCH/COMMON/common_lib.h
@@ -65,7 +65,7 @@ typedef enum {
} duplex_mode_t;
-/** @addtogroup _PHY_RF_INTERFACE_
+/** @addtogroup _GENERIC_PHY_RF_INTERFACE_
* @{
*/
@@ -299,15 +299,15 @@ extern "C"
*/
int openair0_device_init(openair0_device* device, openair0_config_t *openair0_cfg);
- //USRP
- /*! \brief Get the current timestamp of USRP
+ /*! \brief Get current timestamp of USRP
* \param device the hardware to use
*/
openair0_timestamp get_usrp_time(openair0_device *device);
- /*! \brief Set the RX frequency of USRP RF TARGET
+ /*! \brief Set RX frequencies
* \param device the hardware to use
* \param openair0_cfg RF frontend parameters set by application
+ * \returns 0 in success
*/
int openair0_set_rx_frequencies(openair0_device* device, openair0_config_t *openair0_cfg);
diff --git a/targets/ARCH/USRP/USERSPACE/LIB/usrp_lib.cpp b/targets/ARCH/USRP/USERSPACE/LIB/usrp_lib.cpp
index b12f7397f01160dafd9b3fbff8c43410b381f2e4..e9671b0770b4a9b7b94d94266e699633e66b0e57 100644
--- a/targets/ARCH/USRP/USERSPACE/LIB/usrp_lib.cpp
+++ b/targets/ARCH/USRP/USERSPACE/LIB/usrp_lib.cpp
@@ -29,7 +29,7 @@
/** usrp_lib.cpp
*
- * Author: HongliangXU : hong-liang-xu@agilent.com
+ * \author: HongliangXU : hong-liang-xu@agilent.com
*/
#include <string.h>
@@ -54,47 +54,71 @@
# include <immintrin.h>
#endif
+/** @addtogroup _USRP_PHY_RF_INTERFACE_
+ * @{
+ */
+
+/*! \brief USRP Configuration */
typedef struct
{
// --------------------------------
// variables for USRP configuration
// --------------------------------
+ //! USRP device pointer
uhd::usrp::multi_usrp::sptr usrp;
//uhd::usrp::multi_usrp::sptr rx_usrp;
//create a send streamer and a receive streamer
+ //! USRP TX Stream
uhd::tx_streamer::sptr tx_stream;
+ //! USRP RX Stream
uhd::rx_streamer::sptr rx_stream;
+ //! USRP TX Metadata
uhd::tx_metadata_t tx_md;
+ //! USRP RX Metadata
uhd::rx_metadata_t rx_md;
+ //! USRP Timestamp Information
uhd::time_spec_t tm_spec;
+
//setup variables and allocate buffer
+ //! USRP Metadata
uhd::async_metadata_t async_md;
+ //! Sampling rate
double sample_rate;
- // time offset between transmiter timestamp and receiver timestamp;
+
+ //! time offset between transmiter timestamp and receiver timestamp;
double tdiff;
- // use usrp_time_offset to get this value
+
+ //! TX forward samples. We use usrp_time_offset to get this value
int tx_forward_nsamps; //166 for 20Mhz
// --------------------------------
// Debug and output control
// --------------------------------
+ //! Number of underflows
int num_underflows;
+ //! Number of overflows
int num_overflows;
+
+ //! Number of sequential errors
int num_seq_errors;
-
+ //! tx count
int64_t tx_count;
+ //! rx count
int64_t rx_count;
+ //! timestamp of RX packet
openair0_timestamp rx_timestamp;
} usrp_state_t;
-
+/*! \brief Called to start the USRP transceiver. Return 0 if OK, < 0 if error
+ @param device pointer to the device structure specific to the RF hardware target
+*/
static int trx_usrp_start(openair0_device *device)
{
usrp_state_t *s = (usrp_state_t*)device->priv;
@@ -117,7 +141,9 @@ static int trx_usrp_start(openair0_device *device)
return 0;
}
-
+/*! \brief Terminate operation of the USRP transceiver -- free all associated resources
+ * \param device the hardware to use
+ */
static void trx_usrp_end(openair0_device *device)
{
usrp_state_t *s = (usrp_state_t*)device->priv;
@@ -131,6 +157,14 @@ static void trx_usrp_end(openair0_device *device)
}
+/*! \brief Called to send samples to the USRP RF target
+ @param device pointer to the device structure specific to the RF hardware target
+ @param timestamp The timestamp at whicch the first sample MUST be sent
+ @param buff Buffer which holds the samples
+ @param nsamps number of samples to be sent
+ @param antenna_id index of the antenna if the device has multiple anteannas
+ @param flags flags must be set to TRUE if timestamp parameter needs to be applied
+*/
static int trx_usrp_write(openair0_device *device, openair0_timestamp timestamp, void **buff, int nsamps, int cc, int flags)
{
usrp_state_t *s = (usrp_state_t*)device->priv;
@@ -152,6 +186,17 @@ static int trx_usrp_write(openair0_device *device, openair0_timestamp timestamp,
return 0;
}
+/*! \brief Receive samples from hardware.
+ * Read \ref nsamps samples from each channel to buffers. buff[0] is the array for
+ * the first channel. *ptimestamp is the time at which the first sample
+ * was received.
+ * \param device the hardware to use
+ * \param[out] ptimestamp the time at which the first sample was received.
+ * \param[out] buff An array of pointers to buffers for received samples. The buffers must be large enough to hold the number of samples \ref nsamps.
+ * \param nsamps Number of samples. One sample is 2 byte I + 2 byte Q => 4 byte.
+ * \param antenna_id Index of antenna for which to receive samples
+ * \returns the number of sample read
+*/
static int trx_usrp_read(openair0_device *device, openair0_timestamp *ptimestamp, void **buff, int nsamps, int cc)
{
usrp_state_t *s = (usrp_state_t*)device->priv;
@@ -237,6 +282,9 @@ static int trx_usrp_read(openair0_device *device, openair0_timestamp *ptimestamp
return samples_received;
}
+/*! \brief Get current timestamp of USRP
+ * \param device the hardware to use
+*/
openair0_timestamp get_usrp_time(openair0_device *device)
{
@@ -245,11 +293,21 @@ openair0_timestamp get_usrp_time(openair0_device *device)
return s->usrp->get_time_now().to_ticks(s->sample_rate);
}
+/*! \brief Compares two variables within precision
+ * \param a first variable
+ * \param b second variable
+*/
static bool is_equal(double a, double b)
{
return std::fabs(a-b) < std::numeric_limits<double>::epsilon();
}
+/*! \brief Set frequencies (TX/RX)
+ * \param device the hardware to use
+ * \param openair0_cfg RF frontend parameters set by application
+ * \param dummy dummy variable not used
+ * \returns 0 in success
+ */
int trx_usrp_set_freq(openair0_device* device, openair0_config_t *openair0_cfg, int dummy) {
usrp_state_t *s = (usrp_state_t*)device->priv;
@@ -261,6 +319,11 @@ int trx_usrp_set_freq(openair0_device* device, openair0_config_t *openair0_cfg,
}
+/*! \brief Set RX frequencies
+ * \param device the hardware to use
+ * \param openair0_cfg RF frontend parameters set by application
+ * \returns 0 in success
+ */
int openair0_set_rx_frequencies(openair0_device* device, openair0_config_t *openair0_cfg) {
usrp_state_t *s = (usrp_state_t*)device->priv;
@@ -278,6 +341,11 @@ int openair0_set_rx_frequencies(openair0_device* device, openair0_config_t *open
}
+/*! \brief Set Gains (TX/RX)
+ * \param device the hardware to use
+ * \param openair0_cfg RF frontend parameters set by application
+ * \returns 0 in success
+ */
int trx_usrp_set_gains(openair0_device* device,
openair0_config_t *openair0_cfg) {
@@ -298,11 +366,14 @@ int trx_usrp_set_gains(openair0_device* device,
return(0);
}
+/*! \brief Stop USRP
+ * \param card refers to the hardware index to use
+ */
int trx_usrp_stop(int card) {
return(0);
}
-
+/*! \brief USRPB210 RX calibration table */
rx_gain_calib_table_t calib_table_b210[] = {
{3500000000.0,46.0},
{2660000000.0,53.0},
@@ -311,6 +382,7 @@ rx_gain_calib_table_t calib_table_b210[] = {
{816000000.0,62.0},
{-1,0}};
+/*! \brief USRPx310 RX calibration table */
rx_gain_calib_table_t calib_table_x310[] = {
{3500000000.0,77.0},
{2660000000.0,80.0},
@@ -319,6 +391,11 @@ rx_gain_calib_table_t calib_table_x310[] = {
{816000000.0,85.0},
{-1,0}};
+/*! \brief Set RX gain offset
+ * \param openair0_cfg RF frontend parameters set by application
+ * \param chain_index RF chain to apply settings to
+ * \returns 0 in success
+ */
void set_rx_gain_offset(openair0_config_t *openair0_cfg, int chain_index) {
int i=0;
@@ -340,19 +417,30 @@ void set_rx_gain_offset(openair0_config_t *openair0_cfg, int chain_index) {
}
-
+/*! \brief print the USRP statistics
+* \param device the hardware to use
+* \returns 0 on success
+*/
int trx_usrp_get_stats(openair0_device* device) {
return(0);
}
+
+/*! \brief Reset the USRP statistics
+* \param device the hardware to use
+* \returns 0 on success
+*/
int trx_usrp_reset_stats(openair0_device* device) {
return(0);
}
-
+/*! \brief Initialize Openair USRP target. It returns 0 if OK
+* \param device the hardware to use
+* \param openair0_cfg RF frontend parameters set by application
+*/
int openair0_dev_init_usrp(openair0_device* device, openair0_config_t *openair0_cfg)
{
uhd::set_thread_priority_safe(1.0);
@@ -584,3 +672,4 @@ int openair0_dev_init_usrp(openair0_device* device, openair0_config_t *openair0_
s->tx_forward_nsamps = 50;
return 0;
}
+/*@}*/
diff --git a/targets/DOCS/Doxyfile b/targets/DOCS/Doxyfile
index 0d32a3ffad73ffc7d69b0870a28f2fd394979ef9..7ebc15f6746733865f011e6149a0d5f4e99012d2 100644
--- a/targets/DOCS/Doxyfile
+++ b/targets/DOCS/Doxyfile
@@ -793,7 +793,10 @@ INPUT = $(OPENAIR1_DIR)/PHY/defs.h \
$(OPENAIR2_DIR)/LAYER2/RLC/UM_v9.3.0/rlc_um.h \
$(OPENAIR2_DIR)/LAYER2/RLC/UM_v9.3.0/rlc_um_entity.h \
$(OPENAIR2_DIR)/NETWORK_DRIVER/MESH/proto_extern.h \
- $(OPENAIR_TARGETS)/ARCH/COMMON/common_lib.h
+ $(OPENAIR_TARGETS)/ARCH/COMMON/common_lib.h \
+ $(OPENAIR_TARGETS)/ARCH/USRP/USERSPACE/LIB/usrp_lib.cpp \
+ $(OPENAIR_TARGETS)/ARCH/USRP/USERSPACE/LIB/usrp_lib.cpp \
+ $(OPENAIR_TARGETS)/ARCH/USRP/USERSPACE/LIB/usrp_lib.cpp
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses