path: root/host/lib/usrp/usrp2/usrp2_impl.cpp

//
// 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 <boost/format.hpp>
#include <boost/bind.hpp>
#include <uhd/utils.hpp>
#include <iostream>
#include "usrp2_impl.hpp"

using namespace uhd;
using namespace uhd::usrp;

/***********************************************************************
 * Discovery over the udp transport
 **********************************************************************/
uhd::device_addrs_t usrp2::discover(const device_addr_t &hint){
    device_addrs_t usrp2_addrs;

    //create a udp transport to communicate
    //TODO if an addr is not provided, search all interfaces?
    std::string ctrl_port = boost::lexical_cast<std::string>(USRP2_UDP_CTRL_PORT);
    transport::udp::sptr udp_transport = \
        transport::udp::make(hint["addr"], ctrl_port, true);

    //send a hello control packet
    usrp2_ctrl_data_t ctrl_data_out;
    ctrl_data_out.id = htonl(USRP2_CTRL_ID_GIVE_ME_YOUR_IP_ADDR_BRO);
    udp_transport->send(boost::asio::buffer(&ctrl_data_out, sizeof(ctrl_data_out)));

    //loop and recieve until the time is up
    size_t num_timeouts = 0;
    while(true){
        uhd::shared_iovec iov = udp_transport->recv();
        //std::cout << boost::asio::buffer_size(buff) << "\n";
        if (iov.len < sizeof(usrp2_ctrl_data_t)){
            //sleep a little so we dont burn cpu
            if (num_timeouts++ > 50) break;
            boost::this_thread::sleep(boost::posix_time::milliseconds(1));
        }else{
            //handle the received data
            const usrp2_ctrl_data_t *ctrl_data_in = reinterpret_cast<const usrp2_ctrl_data_t *>(iov.base);
            switch(ntohl(ctrl_data_in->id)){
            case USRP2_CTRL_ID_THIS_IS_MY_IP_ADDR_DUDE:
                //make a boost asio ipv4 with the raw addr in host byte order
                boost::asio::ip::address_v4 ip_addr(ntohl(ctrl_data_in->data.ip_addr));
                device_addr_t new_addr;
                new_addr["name"] = "USRP2";
                new_addr["type"] = "udp";
                new_addr["addr"] = ip_addr.to_string();
                usrp2_addrs.push_back(new_addr);
                break;
            }
        }
    }

    return usrp2_addrs;
}

/***********************************************************************
 * Make
 **********************************************************************/
#define num2str(num) (boost::lexical_cast<std::string>(num))

device::sptr usrp2::make(const device_addr_t &device_addr){
    //create a control transport
    transport::udp::sptr ctrl_transport = transport::udp::make(
        device_addr["addr"], num2str(USRP2_UDP_CTRL_PORT)
    );

    //create a data transport
    transport::udp::sptr data_transport = transport::udp::make(
        device_addr["addr"], num2str(USRP2_UDP_DATA_PORT)
    );

    //create the usrp2 implementation guts
    return device::sptr(
        new usrp2_impl(ctrl_transport, data_transport)
    );
}

/***********************************************************************
 * Structors
 **********************************************************************/
usrp2_impl::usrp2_impl(
    transport::udp::sptr ctrl_transport,
    transport::udp::sptr data_transport
){
    _ctrl_transport = ctrl_transport;
    _data_transport = data_transport;

    //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);
    }

    //init the mboard
    mboard_init();

    //init the ddc
    init_ddc_config();

    //init the duc
    init_duc_config();

    //initialize the clock configuration
    init_clock_config();

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

    //send a small data packet so the usrp2 knows the udp source port
    uint32_t zero_data = 0;
    _data_transport->send(boost::asio::buffer(&zero_data, sizeof(zero_data)));

}

usrp2_impl::~usrp2_impl(void){
    /* NOP */
}

/***********************************************************************
 * Misc Access Methods
 **********************************************************************/
double usrp2_impl::get_master_clock_freq(void){
    return 100e6;
}

/***********************************************************************
 * Control Send/Recv
 **********************************************************************/
usrp2_ctrl_data_t usrp2_impl::ctrl_send_and_recv(const usrp2_ctrl_data_t &out_data){
    boost::mutex::scoped_lock lock(_ctrl_mutex);

    //fill in the seq number and send
    usrp2_ctrl_data_t out_copy = out_data;
    out_copy.seq = htonl(++_ctrl_seq_num);
    _ctrl_transport->send(boost::asio::buffer(&out_copy, sizeof(usrp2_ctrl_data_t)));

    //loop and recieve until the time is up
    size_t num_timeouts = 0;
    while(true){
        uhd::shared_iovec iov = _ctrl_transport->recv();
        if (iov.len < sizeof(usrp2_ctrl_data_t)){
            //sleep a little so we dont burn cpu
            if (num_timeouts++ > 50) break;
            boost::this_thread::sleep(boost::posix_time::milliseconds(1));
        }else{
            //handle the received data
            usrp2_ctrl_data_t in_data = *reinterpret_cast<const usrp2_ctrl_data_t *>(iov.base);
            if (ntohl(in_data.seq) == _ctrl_seq_num){
                return in_data;
            }
            //didnt get seq, continue on...
        }
    }
    throw std::runtime_error("usrp2 no control response");
}

/***********************************************************************
 * Device Properties
 **********************************************************************/
void usrp2_impl::get(const wax::obj &key_, wax::obj &val){
    wax::obj key; std::string name;
    boost::tie(key, name) = extract_named_prop(key_);

    //handle the get request conditioned on the key
    switch(wax::cast<device_prop_t>(key)){
    case DEVICE_PROP_NAME:
        val = std::string("usrp2 device");
        return;

    case DEVICE_PROP_MBOARD:
        val = _mboards[name].get_link();
        return;

    case DEVICE_PROP_MBOARD_NAMES:
        val = prop_names_t(_mboards.get_keys());
        return;
    }
}

void usrp2_impl::set(const wax::obj &, const wax::obj &){
    throw std::runtime_error("Cannot set in usrp2 device");
}

/***********************************************************************
 * IO Interface
 **********************************************************************/
static const float float_scale_factor = pow(2.0, 15);

size_t usrp2_impl::send(
    const boost::asio::const_buffer &buff,
    const uhd::metadata_t &metadata,
    const std::string &type
){
    if (type == "fc32"){
        //extract the buffer elements
        const float *float_buff = boost::asio::buffer_cast<const float*>(buff);
        const size_t buff_len = boost::asio::buffer_size(buff)/sizeof(float);

        //convert floats into the shorts buffer
        int16_t *shorts_buff = new int16_t[buff_len];
        for (size_t i = 0; i < buff_len; i++){
            shorts_buff[i] = float_buff[i]*float_scale_factor;
        }

        //send from a buffer of shorts
        size_t bytes_sent = send(
            boost::asio::buffer(shorts_buff, buff_len*sizeof(int16_t)),
            metadata, "sc16"
        );

        //cleanup
        delete [] shorts_buff;
        return bytes_sent;
    }

    if (type == "sc16"){
        throw std::runtime_error("not implemented");
    }

    throw std::runtime_error(str(boost::format("usrp2 send: cannot handle type \"%s\"") % type));
}

size_t usrp2_impl::recv(
    const boost::asio::mutable_buffer &buff,
    uhd::metadata_t &metadata,
    const std::string &type
){
    if (type == "fc32"){
        //extract the buffer elements
        float *float_buff = boost::asio::buffer_cast<float*>(buff);
        const size_t buff_len = boost::asio::buffer_size(buff)/sizeof(float);

        //receive into a buffer of shorts
        int16_t *shorts_buff = new int16_t[buff_len];
        size_t bytes_received = recv(
            boost::asio::buffer(shorts_buff, buff_len*sizeof(int16_t)),
            metadata, "sc16"
        );

        //convert floats into the shorts buffer
        for (size_t i = 0; i < bytes_received/sizeof(int16_t); i++){
            float_buff[i] = shorts_buff[i]/float_scale_factor;
        }

        //cleanup
        delete [] shorts_buff;
        return bytes_received;
    }

    if (type == "sc16"){
        throw std::runtime_error("not implemented");
    }

    throw std::runtime_error(str(boost::format("usrp2 recv: cannot handle type \"%s\"") % type));
}