uhd

//

// Copyright 2010 Ettus Research LLC

//

// This program is free software: you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation, either version 3 of the License, or

// (at your option) any later version.

//

// This program is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License

// along with this program.  If not, see <http://www.gnu.org/licenses/>.

//

#include "usrp2_impl.hpp"

#include "usrp2_regs.hpp"

#include <uhd/usrp/misc_utils.hpp>

#include <uhd/usrp/dsp_utils.hpp>

#include <uhd/usrp/mboard_props.hpp>

#include <uhd/utils/assert.hpp>

#include <uhd/utils/algorithm.hpp>

#include <boost/bind.hpp>

#include <iostream>

using namespace uhd;

using namespace uhd::usrp;

/***********************************************************************

 * Structors

 **********************************************************************/

usrp2_mboard_impl::usrp2_mboard_impl(

    size_t index,

    transport::udp_simple::sptr ctrl_transport,

    size_t recv_frame_size

):

    _index(index),

    _recv_frame_size(recv_frame_size),

    _iface(usrp2_iface::make(ctrl_transport))

{

    //contruct the interfaces to mboard perifs

    _clock_ctrl = usrp2_clock_ctrl::make(_iface);

    _codec_ctrl = usrp2_codec_ctrl::make(_iface);

    _serdes_ctrl = usrp2_serdes_ctrl::make(_iface);

    //TODO move to dsp impl...

    //load the allowed decim/interp rates

    //_USRP2_RATES = range(4, 128+1, 1) + range(130, 256+1, 2) + range(260, 512+1, 4)

    _allowed_decim_and_interp_rates.clear();

    for (size_t i = 4; i <= 128; i+=1){

        _allowed_decim_and_interp_rates.push_back(i);

    }

    for (size_t i = 130; i <= 256; i+=2){

        _allowed_decim_and_interp_rates.push_back(i);

    }

    for (size_t i = 260; i <= 512; i+=4){

        _allowed_decim_and_interp_rates.push_back(i);

    }

    //Issue a stop streaming command (in case it was left running).

    //Since this command is issued before the networking is setup,

    //most if not all junk packets will never make it to the socket.

    this->issue_ddc_stream_cmd(stream_cmd_t::STREAM_MODE_STOP_CONTINUOUS);

    //init the rx control registers

    _iface->poke32(U2_REG_RX_CTRL_NSAMPS_PER_PKT, _recv_frame_size);

    _iface->poke32(U2_REG_RX_CTRL_NCHANNELS, 1);

    _iface->poke32(U2_REG_RX_CTRL_CLEAR_OVERRUN, 1); //reset

    _iface->poke32(U2_REG_RX_CTRL_VRT_HEADER, 0

        | (0x1 << 28) //if data with stream id

        | (0x1 << 26) //has trailer

        | (0x3 << 22) //integer time other

        | (0x1 << 20) //fractional time sample count

    );

    _iface->poke32(U2_REG_RX_CTRL_VRT_STREAM_ID, 0);

    _iface->poke32(U2_REG_RX_CTRL_VRT_TRAILER, 0);

    _iface->poke32(U2_REG_TIME64_TPS, size_t(get_master_clock_freq()));

    //init the tx control registers

    _iface->poke32(U2_REG_TX_CTRL_NUM_CHAN, 0);    //1 channel

    _iface->poke32(U2_REG_TX_CTRL_CLEAR_STATE, 1); //reset

    _iface->poke32(U2_REG_TX_CTRL_REPORT_SID, 1);  //sid 1 (different from rx)

    _iface->poke32(U2_REG_TX_CTRL_POLICY, U2_FLAG_TX_CTRL_POLICY_NEXT_PACKET);

    //init the ddc

    init_ddc_config();

    //init the duc

    init_duc_config();

    //initialize the clock configuration

    init_clock_config();

    //init the codec before the dboard

    codec_init();

    //init the tx and rx dboards (do last)

    dboard_init();

    //set default subdev specs

    (*this)[MBOARD_PROP_RX_SUBDEV_SPEC] = subdev_spec_t();

    (*this)[MBOARD_PROP_TX_SUBDEV_SPEC] = subdev_spec_t();

}

usrp2_mboard_impl::~usrp2_mboard_impl(void){

    /* NOP */

}

/***********************************************************************

 * Helper Methods

 **********************************************************************/

void usrp2_mboard_impl::init_clock_config(void){

    //setup the clock configuration settings

    _clock_config.ref_source = clock_config_t::REF_INT;

    _clock_config.pps_source = clock_config_t::PPS_SMA;

    _clock_config.pps_polarity = clock_config_t::PPS_NEG;

    //update the clock config (sends a control packet)

    update_clock_config();

}

void usrp2_mboard_impl::update_clock_config(void){

    boost::uint32_t pps_flags = 0;

    //translate pps source enums

    switch(_clock_config.pps_source){

    case clock_config_t::PPS_SMA:  pps_flags |= U2_FLAG_TIME64_PPS_SMA;  break;

    case clock_config_t::PPS_MIMO: pps_flags |= U2_FLAG_TIME64_PPS_MIMO; break;

    default: throw std::runtime_error("usrp2: unhandled clock configuration pps source");

    }

    //translate pps polarity enums

    switch(_clock_config.pps_polarity){

    case clock_config_t::PPS_POS: pps_flags |= U2_FLAG_TIME64_PPS_POSEDGE; break;

    case clock_config_t::PPS_NEG: pps_flags |= U2_FLAG_TIME64_PPS_NEGEDGE; break;

    default: throw std::runtime_error("usrp2: unhandled clock configuration pps polarity");

    }

    //set the pps flags

    _iface->poke32(U2_REG_TIME64_FLAGS, pps_flags);

    //clock source ref 10mhz

    switch(_clock_config.ref_source){

    case clock_config_t::REF_INT : _iface->poke32(U2_REG_MISC_CTRL_CLOCK, 0x10); break;

    case clock_config_t::REF_SMA : _iface->poke32(U2_REG_MISC_CTRL_CLOCK, 0x1C); break;

    case clock_config_t::REF_MIMO: _iface->poke32(U2_REG_MISC_CTRL_CLOCK, 0x15); break;

    default: throw std::runtime_error("usrp2: unhandled clock configuration reference source");

    }

    //clock source ref 10mhz

    bool use_external = _clock_config.ref_source != clock_config_t::REF_INT;

    _clock_ctrl->enable_external_ref(use_external);

}

void usrp2_mboard_impl::set_time_spec(const time_spec_t &time_spec, bool now){

    //set the ticks

    _iface->poke32(U2_REG_TIME64_TICKS, time_spec.get_tick_count(get_master_clock_freq()));

    //set the flags register

    boost::uint32_t imm_flags = (now)? U2_FLAG_TIME64_LATCH_NOW : U2_FLAG_TIME64_LATCH_NEXT_PPS;

    _iface->poke32(U2_REG_TIME64_IMM, imm_flags);

    //set the seconds (latches in all 3 registers)

    _iface->poke32(U2_REG_TIME64_SECS, boost::uint32_t(time_spec.get_full_secs()));

}

void usrp2_mboard_impl::handle_overflow(void){

    _iface->poke32(U2_REG_RX_CTRL_CLEAR_OVERRUN, 1);

    if (_continuous_streaming){ //re-issue the stream command if already continuous

        this->issue_ddc_stream_cmd(stream_cmd_t::STREAM_MODE_START_CONTINUOUS);

    }

}

void usrp2_mboard_impl::issue_ddc_stream_cmd(const stream_cmd_t &stream_cmd){

    _continuous_streaming = stream_cmd.stream_mode == stream_cmd_t::STREAM_MODE_START_CONTINUOUS;

    _iface->poke32(U2_REG_RX_CTRL_STREAM_CMD, dsp_type1::calc_stream_cmd_word(

        stream_cmd, _recv_frame_size

    ));

    _iface->poke32(U2_REG_RX_CTRL_TIME_SECS,  boost::uint32_t(stream_cmd.time_spec.get_full_secs()));

    _iface->poke32(U2_REG_RX_CTRL_TIME_TICKS, stream_cmd.time_spec.get_tick_count(get_master_clock_freq()));

}

/***********************************************************************

 * MBoard Get Properties

 **********************************************************************/

static const std::string dboard_name = "0";

void usrp2_mboard_impl::get(const wax::obj &key_, wax::obj &val){

    named_prop_t key = named_prop_t::extract(key_);

    //handle the get request conditioned on the key

    switch(key.as<mboard_prop_t>()){

    case MBOARD_PROP_NAME:

        val = str(boost::format("usrp2 mboard%d - rev %s") % _index % _iface->mb_eeprom["rev"]);

        return;

    case MBOARD_PROP_OTHERS:

        val = prop_names_t();

        return;

    case MBOARD_PROP_RX_DBOARD:

        UHD_ASSERT_THROW(key.name == dboard_name);

        val = _rx_dboard_proxy->get_link();

        return;

    case MBOARD_PROP_RX_DBOARD_NAMES:

        val = prop_names_t(1, dboard_name);

        return;

    case MBOARD_PROP_TX_DBOARD:

        UHD_ASSERT_THROW(key.name == dboard_name);

        val = _tx_dboard_proxy->get_link();

        return;

    case MBOARD_PROP_TX_DBOARD_NAMES:

        val = prop_names_t(1, dboard_name);

        return;

    case MBOARD_PROP_RX_DSP:

        UHD_ASSERT_THROW(key.name == "");

        val = _rx_dsp_proxy->get_link();

        return;

    case MBOARD_PROP_RX_DSP_NAMES:

        val = prop_names_t(1, "");

        return;

    case MBOARD_PROP_TX_DSP:

        UHD_ASSERT_THROW(key.name == "");

        val = _tx_dsp_proxy->get_link();

        return;

    case MBOARD_PROP_TX_DSP_NAMES:

        val = prop_names_t(1, "");

        return;

    case MBOARD_PROP_CLOCK_CONFIG:

        val = _clock_config;

        return;

    case MBOARD_PROP_TIME_NOW:{

            usrp2_iface::pair64 time64(

                _iface->peek64(U2_REG_TIME64_SECS_RB, U2_REG_TIME64_TICKS_RB)

            );

            val = time_spec_t(

                time64.first, time64.second, get_master_clock_freq()

            );

        }

        return;

    case MBOARD_PROP_RX_SUBDEV_SPEC:

        val = _rx_subdev_spec;

        return;

    case MBOARD_PROP_TX_SUBDEV_SPEC:

        val = _tx_subdev_spec;

        return;

    case MBOARD_PROP_EEPROM_MAP:

        val = _iface->mb_eeprom;

        return;

    default: UHD_THROW_PROP_GET_ERROR();

    }

}

/***********************************************************************

 * MBoard Set Properties

 **********************************************************************/

void usrp2_mboard_impl::set(const wax::obj &key, const wax::obj &val){

    //handle the get request conditioned on the key

    switch(key.as<mboard_prop_t>()){

    case MBOARD_PROP_CLOCK_CONFIG:

        _clock_config = val.as<clock_config_t>();

        update_clock_config();

        return;

    case MBOARD_PROP_TIME_NOW:

        set_time_spec(val.as<time_spec_t>(), true);

        return;

    case MBOARD_PROP_TIME_NEXT_PPS:

        set_time_spec(val.as<time_spec_t>(), false);

        return;

    case MBOARD_PROP_STREAM_CMD:

        issue_ddc_stream_cmd(val.as<stream_cmd_t>());

        return;

    case MBOARD_PROP_RX_SUBDEV_SPEC:

        _rx_subdev_spec = val.as<subdev_spec_t>();

        verify_rx_subdev_spec(_rx_subdev_spec, this->get_link());

        //sanity check

        UHD_ASSERT_THROW(_rx_subdev_spec.size() == 1);

        //set the mux

        _iface->poke32(U2_REG_DSP_RX_MUX, dsp_type1::calc_rx_mux_word(

            _dboard_manager->get_rx_subdev(_rx_subdev_spec.front().sd_name)[SUBDEV_PROP_CONNECTION].as<subdev_conn_t>()

        ));

        return;

    case MBOARD_PROP_TX_SUBDEV_SPEC:

        _tx_subdev_spec = val.as<subdev_spec_t>();

        verify_tx_subdev_spec(_tx_subdev_spec, this->get_link());

        //sanity check

        UHD_ASSERT_THROW(_tx_subdev_spec.size() == 1);

        //set the mux

        _iface->poke32(U2_REG_DSP_TX_MUX, dsp_type1::calc_tx_mux_word(

            _dboard_manager->get_tx_subdev(_tx_subdev_spec.front().sd_name)[SUBDEV_PROP_CONNECTION].as<subdev_conn_t>()

        ));

        return;

    case MBOARD_PROP_EEPROM_MAP:

        // Step1: commit the map, writing only those values set.

        // Step2: readback the entire eeprom map into the iface.

        val.as<mboard_eeprom_t>().commit(*_iface, mboard_eeprom_t::MAP_NXXX);

        _iface->mb_eeprom = mboard_eeprom_t(*_iface, mboard_eeprom_t::MAP_NXXX);

        return;

    default: UHD_THROW_PROP_SET_ERROR();

    }

}