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 <uhd/utils.hpp>

#include "dboard_interface.hpp"

#include "usrp2_impl.hpp"

using namespace uhd::usrp::dboard;

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

 * Structors

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

dboard_interface::dboard_interface(usrp2_impl *impl){

    _impl = impl;

}

dboard_interface::~dboard_interface(void){

    /* NOP */

}

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

 * Clock Rates

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

double dboard_interface::get_rx_clock_rate(void){

    return _impl->get_master_clock_freq();

}

double dboard_interface::get_tx_clock_rate(void){

    return _impl->get_master_clock_freq();

}

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

 * GPIO

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

/*!

 * Static function to convert a gpio bank enum

 * to an over-the-wire value for the usrp2 control.

 * \param bank the dboard interface gpio bank enum

 * \return an over the wire representation

 */

static uint8_t gpio_bank_to_otw(interface::gpio_bank_t bank){

    switch(bank){

    case uhd::usrp::dboard::interface::GPIO_TX_BANK: return USRP2_DIR_TX;

    case uhd::usrp::dboard::interface::GPIO_RX_BANK: return USRP2_DIR_RX;

    }

    throw std::invalid_argument("unknown gpio bank type");

}

void dboard_interface::set_gpio_ddr(gpio_bank_t bank, uint16_t value, uint16_t mask){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_USE_THESE_GPIO_DDR_SETTINGS_BRO);

    out_data.data.gpio_config.bank = gpio_bank_to_otw(bank);

    out_data.data.gpio_config.value = htons(value);

    out_data.data.gpio_config.mask = htons(mask);

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_GOT_THE_GPIO_DDR_SETTINGS_DUDE);

}

void dboard_interface::write_gpio(gpio_bank_t bank, uint16_t value, uint16_t mask){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_SET_YOUR_GPIO_PIN_OUTS_BRO);

    out_data.data.gpio_config.bank = gpio_bank_to_otw(bank);

    out_data.data.gpio_config.value = htons(value);

    out_data.data.gpio_config.mask = htons(mask);

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_I_SET_THE_GPIO_PIN_OUTS_DUDE);

}

uint16_t dboard_interface::read_gpio(gpio_bank_t bank){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_GIVE_ME_YOUR_GPIO_PIN_VALS_BRO);

    out_data.data.gpio_config.bank = gpio_bank_to_otw(bank);

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_HERE_IS_YOUR_GPIO_PIN_VALS_DUDE);

    return ntohs(in_data.data.gpio_config.value);

}

void dboard_interface::set_atr_reg(gpio_bank_t bank, uint16_t tx_value, uint16_t rx_value, uint16_t mask){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_USE_THESE_ATR_SETTINGS_BRO);

    out_data.data.atr_config.bank = gpio_bank_to_otw(bank);

    out_data.data.atr_config.tx_value = htons(tx_value);

    out_data.data.atr_config.rx_value = htons(rx_value);

    out_data.data.atr_config.mask = htons(mask);

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_GOT_THE_ATR_SETTINGS_DUDE);

}

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

 * SPI

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

/*!

 * Static function to convert a spi dev enum

 * to an over-the-wire value for the usrp2 control.

 * \param dev the dboard interface spi dev enum

 * \return an over the wire representation

 */

static uint8_t spi_dev_to_otw(interface::spi_dev_t dev){

    switch(dev){

    case uhd::usrp::dboard::interface::SPI_TX_DEV: return USRP2_DIR_TX;

    case uhd::usrp::dboard::interface::SPI_RX_DEV: return USRP2_DIR_RX;

    }

    throw std::invalid_argument("unknown spi device type");

}

/*!

 * Static function to convert a spi latch enum

 * to an over-the-wire value for the usrp2 control.

 * \param latch the dboard interface spi latch enum

 * \return an over the wire representation

 */

static uint8_t spi_latch_to_otw(interface::spi_latch_t latch){

    switch(latch){

    case uhd::usrp::dboard::interface::SPI_LATCH_RISE: return USRP2_CLK_EDGE_RISE;

    case uhd::usrp::dboard::interface::SPI_LATCH_FALL: return USRP2_CLK_EDGE_FALL;

    }

    throw std::invalid_argument("unknown spi latch type");

}

/*!

 * Static function to convert a spi push enum

 * to an over-the-wire value for the usrp2 control.

 * \param push the dboard interface spi push enum

 * \return an over the wire representation

 */

static uint8_t spi_push_to_otw(interface::spi_push_t push){

    switch(push){

    case uhd::usrp::dboard::interface::SPI_PUSH_RISE: return USRP2_CLK_EDGE_RISE;

    case uhd::usrp::dboard::interface::SPI_PUSH_FALL: return USRP2_CLK_EDGE_FALL;

    }

    throw std::invalid_argument("unknown spi push type");

}

interface::byte_vector_t dboard_interface::transact_spi(

    spi_dev_t dev,

    spi_latch_t latch,

    spi_push_t push,

    const byte_vector_t &buf,

    bool readback

){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_TRANSACT_ME_SOME_SPI_BRO);

    out_data.data.spi_args.dev = spi_dev_to_otw(dev);

    out_data.data.spi_args.latch = spi_latch_to_otw(latch);

    out_data.data.spi_args.push = spi_push_to_otw(push);

    out_data.data.spi_args.readback = (readback)? 1 : 0;

    out_data.data.spi_args.bytes = buf.size();

    //limitation of spi transaction size

    ASSERT_THROW(buf.size() <= sizeof(out_data.data.spi_args.data));

    //copy in the data

    for (size_t i = 0; i < buf.size(); i++){

        out_data.data.spi_args.data[i] = buf[i];

    }

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_OMG_TRANSACTED_SPI_DUDE);

    ASSERT_THROW(in_data.data.spi_args.bytes == buf.size());

    //copy out the data

    byte_vector_t result;

    for (size_t i = 0; i < buf.size(); i++){

        result.push_back(in_data.data.spi_args.data[i]);

    }

    return result;

}

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

 * I2C

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

void dboard_interface::write_i2c(int i2c_addr, const byte_vector_t &buf){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_WRITE_THESE_I2C_VALUES_BRO);

    out_data.data.i2c_args.addr = i2c_addr;

    out_data.data.i2c_args.bytes = buf.size();

    //limitation of i2c transaction size

    ASSERT_THROW(buf.size() <= sizeof(out_data.data.i2c_args.data));

    //copy in the data

    for (size_t i = 0; i < buf.size(); i++){

        out_data.data.i2c_args.data[i] = buf[i];

    }

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_COOL_IM_DONE_I2C_WRITE_DUDE);

}

interface::byte_vector_t dboard_interface::read_i2c(int i2c_addr, size_t num_bytes){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_DO_AN_I2C_READ_FOR_ME_BRO);

    out_data.data.i2c_args.addr = i2c_addr;

    out_data.data.i2c_args.bytes = num_bytes;

    //limitation of i2c transaction size

    ASSERT_THROW(num_bytes <= sizeof(out_data.data.i2c_args.data));

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_HERES_THE_I2C_DATA_DUDE);

    ASSERT_THROW(in_data.data.i2c_args.addr = num_bytes);

    //copy out the data

    byte_vector_t result;

    for (size_t i = 0; i < num_bytes; i++){

        result.push_back(in_data.data.i2c_args.data[i]);

    }

    return result;

}

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

 * Aux DAX/ADC

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

/*!

 * Static function to convert a unit type enum

 * to an over-the-wire value for the usrp2 control.

 * \param unit the dboard interface unit type enum

 * \return an over the wire representation

 */

static uint8_t spi_dev_to_otw(interface::unit_type_t unit){

    switch(unit){

    case uhd::usrp::dboard::interface::UNIT_TYPE_TX: return USRP2_DIR_TX;

    case uhd::usrp::dboard::interface::UNIT_TYPE_RX: return USRP2_DIR_RX;

    }

    throw std::invalid_argument("unknown unit type type");

}

void dboard_interface::write_aux_dac(interface::unit_type_t unit, int which, int value){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_WRITE_THIS_TO_THE_AUX_DAC_BRO);

    out_data.data.aux_args.dir = spi_dev_to_otw(unit);

    out_data.data.aux_args.which = which;

    out_data.data.aux_args.dir = htonl(value);

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_DONE_WITH_THAT_AUX_DAC_DUDE);

}

int dboard_interface::read_aux_adc(interface::unit_type_t unit, int which){

    //setup the out data

    usrp2_ctrl_data_t out_data;

    out_data.id = htonl(USRP2_CTRL_ID_READ_FROM_THIS_AUX_ADC_BRO);

    out_data.data.aux_args.dir = spi_dev_to_otw(unit);

    out_data.data.aux_args.which = which;

    //send and recv

    usrp2_ctrl_data_t in_data = _impl->ctrl_send_and_recv(out_data);

    ASSERT_THROW(htonl(in_data.id) == USRP2_CTRL_ID_DONE_WITH_THAT_AUX_ADC_DUDE);

    return ntohl(in_data.data.aux_args.value);

}