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/>.

//

#ifndef INCLUDED_USRP1_CODEC_CTRL_HPP

#define INCLUDED_USRP1_CODEC_CTRL_HPP

#include "usrp1_iface.hpp"

#include <uhd/types/ranges.hpp>

#include <boost/shared_ptr.hpp>

#include <boost/utility.hpp>

/*!

 * The usrp1 codec control:

 * - Init/power down codec.

 * - Read aux adc, write aux dac.

 */

class usrp1_codec_ctrl : boost::noncopyable{

public:

    typedef boost::shared_ptr<usrp1_codec_ctrl> sptr;

    static const uhd::gain_range_t tx_pga_gain_range;

    static const uhd::gain_range_t rx_pga_gain_range;

    /*!

     * Make a new clock control object.

     * \param iface the usrp1 iface object

     * \param spi_slave which spi device

     * \return the clock control object

     */

    static sptr make(usrp1_iface::sptr iface, int spi_slave);

    //! aux adc identifier constants

    enum aux_adc_t{

        AUX_ADC_A2 = 0xA2,

        AUX_ADC_A1 = 0xA1,

        AUX_ADC_B2 = 0xB2,

        AUX_ADC_B1 = 0xB1

    };

    /*!

     * Read an auxiliary adc:

     * The internals remember which aux adc was read last.

     * Therefore, the aux adc switch is only changed as needed.

     * \param which which of the 4 adcs

     * \return a value in volts

     */

    virtual float read_aux_adc(aux_adc_t which) = 0;

    //! aux dac identifier constants

    enum aux_dac_t{

        AUX_DAC_A = 0xA,

        AUX_DAC_B = 0xB,

        AUX_DAC_C = 0xC,

        AUX_DAC_D = 0xD

    };

    /*!

     * Write an auxiliary dac.

     * \param which which of the 4 dacs

     * \param volts the level in in volts

     */

    virtual void write_aux_dac(aux_dac_t which, float volts) = 0;

    //! Set the TX PGA gain

    virtual void set_tx_pga_gain(float gain) = 0;

    //! Get the TX PGA gain

    virtual float get_tx_pga_gain(void) = 0;

    //! Set the RX PGA gain ('A' or 'B')

    virtual void set_rx_pga_gain(float gain, char which) = 0;

    //! Get the RX PGA gain ('A' or 'B')

    virtual float get_rx_pga_gain(char which) = 0;

    virtual bool set_duc_freq(double freq) = 0;

};

#endif /* INCLUDED_USRP1_CODEC_CTRL_HPP */