// // Copyright 2017 Ettus Research, a National Instruments Company // // SPDX-License-Identifier: GPL-3.0-or-later // // // Driver for the N310/N300 daughterboard ("Magnesium") // #ifndef INCLUDED_LIBUHD_RFNOC_MAGNESIUM_RADIO_CTRL_IMPL_HPP #define INCLUDED_LIBUHD_RFNOC_MAGNESIUM_RADIO_CTRL_IMPL_HPP #include "magnesium_ad9371_iface.hpp" #include "magnesium_cpld_ctrl.hpp" #include "magnesium_cpld_regs.hpp" #include #include #include #include #include #include #include #include #include #include namespace uhd { namespace rfnoc { /*! \brief RFNoC block / daughterboard driver for a "Magnesium" daughterboard. * * This daughterboard is used on the USRP N310 and N300. */ class magnesium_radio_control_impl : public radio_control_impl { public: //! Frequency bands for RX. Bands are a function of the analog filter banks enum class rx_band { INVALID_BAND, LOWBAND, BAND0, BAND1, BAND2, BAND3, BAND4, BAND5, BAND6 }; //! Frequency bands for TX. Bands are a function of the analog filter banks enum class tx_band { INVALID_BAND, LOWBAND, BAND0, BAND1, BAND2, BAND3 }; typedef std::unordered_map band_map_t; band_map_t rx_band_map_dflt = {{0, 0.0}, {1, 430e6}, {2, 600e6}, {3, 1050e6}, {4, 1600e6}, {5, 2100e6}, {6, 2700e6}}; band_map_t tx_band_map_dflt = { {0, 0.0}, {1, 723.17e6}, {2, 1623.17e6}, {3, 3323.17e6}}; /************************************************************************ * Structors ***********************************************************************/ magnesium_radio_control_impl(make_args_ptr make_args); virtual ~magnesium_radio_control_impl(); /************************************************************************ * RF API calls ***********************************************************************/ // Note: We use the cached values in radio_ctrl_impl, so most getters are // not reimplemented here double set_rate(double rate); // Setters void set_tx_antenna(const std::string &ant, const size_t chan); void set_rx_antenna(const std::string &ant, const size_t chan); double set_tx_frequency(const double freq, const size_t chan); double set_rx_frequency(const double freq, const size_t chan); double set_tx_gain(const double gain, const size_t chan); double set_tx_gain(const double gain, const std::string& name, const size_t chan); double set_rx_gain(const double gain, const size_t chan); double set_rx_gain(const double gain, const std::string& name, const size_t chan); double set_tx_bandwidth(const double bandwidth, const size_t chan); double set_rx_bandwidth(const double bandwidth, const size_t chan); void set_tx_gain_profile(const std::string& profile, const size_t chan); void set_rx_gain_profile(const std::string& profile, const size_t chan); // Getters std::vector get_tx_antennas(const size_t chan) const; std::vector get_rx_antennas(const size_t chan) const; uhd::freq_range_t get_tx_frequency_range(const size_t chan) const; uhd::freq_range_t get_rx_frequency_range(const size_t chan) const; std::vector get_tx_gain_names(const size_t) const; std::vector get_rx_gain_names(const size_t) const; double get_tx_gain(const std::string&, size_t); double get_rx_gain(const std::string&, size_t); uhd::gain_range_t get_tx_gain_range(const size_t) const; uhd::gain_range_t get_tx_gain_range(const std::string&, const size_t) const; uhd::gain_range_t get_rx_gain_range(const size_t) const; uhd::gain_range_t get_rx_gain_range(const std::string&, const size_t) const; std::vector get_tx_gain_profile_names(const size_t chan) const; std::vector get_rx_gain_profile_names(const size_t chan) const; std::string get_tx_gain_profile(const size_t chan) const; std::string get_rx_gain_profile(const size_t chan) const; uhd::meta_range_t get_tx_bandwidth_range(size_t chan) const; uhd::meta_range_t get_rx_bandwidth_range(size_t chan) const; /************************************************************************** * LO Controls *************************************************************************/ std::vector get_rx_lo_names(const size_t chan) const; std::vector get_rx_lo_sources( const std::string& name, const size_t chan) const; freq_range_t get_rx_lo_freq_range(const std::string& name, const size_t chan) const; void set_rx_lo_source( const std::string& src, const std::string& name, const size_t chan); const std::string get_rx_lo_source(const std::string& name, const size_t chan) const; double set_rx_lo_freq(double freq, const std::string& name, const size_t chan); double get_rx_lo_freq(const std::string& name, const size_t chan); std::vector get_tx_lo_names(const size_t chan) const; std::vector get_tx_lo_sources( const std::string& name, const size_t chan) const; freq_range_t get_tx_lo_freq_range(const std::string& name, const size_t chan); void set_tx_lo_source( const std::string& src, const std::string& name, const size_t chan); const std::string get_tx_lo_source(const std::string& name, const size_t chan); double set_tx_lo_freq(const double freq, const std::string& name, const size_t chan); double get_tx_lo_freq(const std::string& name, const size_t chan); /************************************************************************** * GPIO Controls *************************************************************************/ std::vector get_gpio_banks() const; void set_gpio_attr( const std::string& bank, const std::string& attr, const uint32_t value); uint32_t get_gpio_attr(const std::string& bank, const std::string& attr); /************************************************************************** * EEPROM API *************************************************************************/ void set_db_eeprom(const uhd::eeprom_map_t& db_eeprom); uhd::eeprom_map_t get_db_eeprom(); /************************************************************************** * Sensor API *************************************************************************/ std::vector get_rx_sensor_names(size_t chan); uhd::sensor_value_t get_rx_sensor(const std::string& name, size_t chan); std::vector get_tx_sensor_names(size_t chan); uhd::sensor_value_t get_tx_sensor(const std::string& name, size_t chan); /************************************************************************** * Radio Identification API Calls *************************************************************************/ std::string get_slot_name() const { return _radio_slot; } size_t get_chan_from_dboard_fe( const std::string& fe, const uhd::direction_t direction) const; std::string get_dboard_fe_from_chan( const size_t chan, const uhd::direction_t direction) const; std::string get_fe_name( const size_t chan, const uhd::direction_t direction) const; /************************************************************************** * node_t API Calls *************************************************************************/ void set_command_time(uhd::time_spec_t time, const size_t chan); private: /************************************************************************** * Helpers *************************************************************************/ //! Set tx gain on each gain element double _set_tx_gain(const std::string& name, const double gain, const size_t chan); //! Set rx gain on each gain element double _set_rx_gain(const std::string& name, const double gain, const size_t chan); //! Get tx gain on each gain element double _get_tx_gain(const std::string& name, const size_t chan); //! Get rx gain on each gain element double _get_rx_gain(const std::string& name, const size_t chan); //! Initialize all the peripherals connected to this block void _init_peripherals(); //! Set state of this class to sensible defaults void _init_defaults(); //! Init a subtree for the RF frontends void _init_frontend_subtree(uhd::property_tree::sptr subtree, const size_t chan_idx); //! Initialize property tree void _init_prop_tree(); //! Init RPC interaction void _init_mpm(); //! Set up sensor property nodes void _init_mpm_sensors(const direction_t dir, const size_t chan_idx); //! Map a frequency in Hz to an rx_band value. Will return // rx_band::INVALID_BAND if the frequency is out of range. rx_band _map_freq_to_rx_band(const band_map_t band_map, const double freq); //! Map a frequency in Hz to an tx_band value. Will return // tx_band::INVALID_BAND if the frequency is out of range. tx_band _map_freq_to_tx_band(const band_map_t band_map, const double freq); /************************************************************************** * Sensors *************************************************************************/ //! Return LO lock status. Factors in current band (low/high) and // direction (TX/RX) bool get_lo_lock_status(const direction_t dir); /************************************************************************** * Gain Controls (implemented in magnesium_radio_ctrl_gain.cpp) *************************************************************************/ //! Set the attenuation of the DSA double _dsa_set_att(const double att, const size_t chan, const direction_t dir); double _dsa_get_att(const size_t chan, const direction_t dir); //! Write the DSA word void _set_dsa_val(const size_t chan, const direction_t dir, const uint32_t dsa_val); double _set_all_gain( const double gain, const double freq, const size_t chan, const direction_t dir); double _get_all_gain(const size_t chan, const direction_t dir); void _update_gain(const size_t chan, direction_t dir); void _update_freq(const size_t chan, const uhd::direction_t dir); void _remap_band_limits(const std::string band_map, const uhd::direction_t dir); /************************************************************************** * CPLD Controls (implemented in magnesium_radio_ctrl_cpld.cpp) *************************************************************************/ //! Blink the front-panel LEDs for \p identify_duration, then reset CPLD // and resume normal operation. void _identify_with_leds(const int identify_duration); void _update_rx_freq_switches(const double freq, const bool bypass_lnas, const magnesium_cpld_ctrl::chan_sel_t chan_sel); void _update_tx_freq_switches(const double freq, const bool bypass_amps, const magnesium_cpld_ctrl::chan_sel_t chan_sel); void _update_atr_switches(const magnesium_cpld_ctrl::chan_sel_t chan, const direction_t dir, const std::string& ant); double _set_rx_lo_freq(const std::string source, const std::string name, const double freq, const size_t chan); double _set_tx_lo_freq(const std::string source, const std::string name, const double freq, const size_t chan); /************************************************************************** * Private attributes *************************************************************************/ //! Locks access to setter APIs std::recursive_mutex _set_lock; //! Letter representation of the radio we're currently running std::string _radio_slot; //! Prepended for all dboard RPC calls std::string _rpc_prefix; //! Additional block args; gets set during set_rpc_client() uhd::device_addr_t _block_args; //! Reference to the MB controller mpmd_mb_controller::sptr _n310_mb_control; //! Reference to the MB timekeeper uhd::rfnoc::mpmd_mb_controller::mpmd_timekeeper::sptr _n3xx_timekeeper; //! Reference to the RPC client uhd::rpc_client::sptr _rpcc; //! Reference to the SPI core uhd::spi_iface::sptr _spi; //! Reference to wb_iface compat adapters (one per channel) std::vector _wb_ifaces; //! Reference to the TX LO adf435x_iface::sptr _tx_lo; //! Reference to the RX LO adf435x_iface::sptr _rx_lo; //! Reference to the CPLD controls. Even if there's multiple radios, // there's only one CPLD control. std::shared_ptr _cpld; //! Reference to the AD9371 controls magnesium_ad9371_iface::uptr _ad9371; //! ATR controls. These control the external DSA and the AD9371 gain // up/down bits. They do *not* control the ATR state of the CPLD, the // tx/rx run states are hooked up directly to the CPLD. // // Every radio channel gets its own ATR state register. std::vector _gpio; //! Front panel GPIO controller. Note that only one radio block per // module can be the FP-GPIO master. usrp::gpio_atr::gpio_atr_3000::sptr _fp_gpio; //! Sampling rate, and also ref clock frequency for the lowband LOs. double _master_clock_rate = 1.0; //! Desired RF frequency std::map _desired_rf_freq = { {RX_DIRECTION, 2.44e9}, {TX_DIRECTION, 2.44e9}}; //! Coerced adf4351 frequency //! Coerced ad9371 frequency std::map _ad9371_freq = { {RX_DIRECTION, 2.44e9}, {TX_DIRECTION, 2.44e9}}; //! Coerced adf4351 frequency std::map _adf4351_freq = { {RX_DIRECTION, 2.44e9}, {TX_DIRECTION, 2.44e9}}; //! Low band enable std::map _is_low_band = { {RX_DIRECTION, false}, {TX_DIRECTION, false}}; //! AD9371 gain double _ad9371_rx_gain = 0.0; double _ad9371_tx_gain = 0.0; std::map _ad9371_att = { {RX_DIRECTION, 0.0}, {TX_DIRECTION, 0.0}}; //! DSA attenuation double _dsa_rx_att = 0.0; double _dsa_tx_att = 0.0; std::map _dsa_att = {{RX_DIRECTION, 0.0}, {TX_DIRECTION, 0.0}}; //! amp gain std::map _amp_bypass = { {RX_DIRECTION, true}, {TX_DIRECTION, true}}; //! All gain double _all_rx_gain = 0.0; double _all_tx_gain = 0.0; //! Gain profile std::map _gain_profile = { {RX_DIRECTION, "default"}, {TX_DIRECTION, "default"}}; bool _rx_bypass_lnas = true; bool _tx_bypass_amp = true; band_map_t _rx_band_map = rx_band_map_dflt; band_map_t _tx_band_map = tx_band_map_dflt; //! TRX switch state of 2 channels std::map _sw_trx = { {magnesium_cpld_ctrl::CHAN1, magnesium_cpld_ctrl::SW_TRX_FROMLOWERFILTERBANKTXSW1}, {magnesium_cpld_ctrl::CHAN2, magnesium_cpld_ctrl::SW_TRX_FROMLOWERFILTERBANKTXSW1}}; //! RX LO SOURCE // NOTE for magnesium only ad9371 LO that can be connected to the external LO so we // only need one var here std::string _rx_lo_source = "internal"; }; /* class radio_ctrl_impl */ }} /* namespace uhd::rfnoc */ #endif /* INCLUDED_LIBUHD_RFNOC_MAGNESIUM_RADIO_CTRL_IMPL_HPP */