uhd/host/lib/include/uhdlib/usrp/common/fx2_ctrl.hpp
Lane Kolbly 5802a362f8 uhd: Replace include guards with pragma once
Pragma once is the more modern version of include guards, eliminating
any potential problems with mistyping include guards. Let's use those.
2020-04-08 15:16:06 -05:00

131 lines
3.6 KiB
C++

//
// Copyright 2010-2012 Ettus Research LLC
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#pragma once
#include <uhd/transport/usb_control.hpp>
#include <uhd/types/serial.hpp> //i2c iface
#include <uhd/utils/noncopyable.hpp>
#include <memory>
#define FL_BEGIN 0
#define FL_END 2
#define FL_XFER 1
#define USRP_HASH_SLOT_0_ADDR 0xe1e0
#define USRP_HASH_SLOT_1_ADDR 0xe1f0
#define VRQ_FPGA_LOAD 0x02
#define VRQ_FPGA_SET_RESET 0x04
#define VRQ_FPGA_SET_TX_ENABLE 0x05
#define VRQ_FPGA_SET_RX_ENABLE 0x06
#define VRQ_FPGA_SET_TX_RESET 0x0a
#define VRQ_FPGA_SET_RX_RESET 0x0b
#define VRQ_I2C_READ 0x81
#define VRQ_I2C_WRITE 0x08
#define VRQ_SET_LED 0x01
#define VRT_VENDOR_IN 0xC0
#define VRT_VENDOR_OUT 0x40
namespace uhd { namespace usrp {
class fx2_ctrl : uhd::noncopyable, public uhd::i2c_iface
{
public:
typedef std::shared_ptr<fx2_ctrl> sptr;
/*!
* Make a usrp control object from a control transport
* \param ctrl_transport a USB control transport
* \return a new usrp control object
*/
static sptr make(uhd::transport::usb_control::sptr ctrl_transport);
//! Call init after the fpga is loaded
virtual void usrp_init(void) = 0;
//! For emergency situations
virtual void usrp_fx2_reset(void) = 0;
/*!
* Load firmware in Intel HEX Format onto device
* \param filename name of firmware file
* \param force reload firmware if already loaded
*/
virtual void usrp_load_firmware(std::string filename, bool force = false) = 0;
/*!
* Load fpga file onto usrp
* \param filename name of fpga image
*/
virtual void usrp_load_fpga(std::string filename) = 0;
/*!
* Load USB descriptor file in Intel HEX format into EEPROM
* \param filestring name of EEPROM image
*/
virtual void usrp_load_eeprom(std::string filestring) = 0;
/*!
* Submit an IN transfer
* \param request device specific request
* \param value device specific field
* \param index device specific field
* \param buff buffer to place data
* \param length length of buffer
* \return number of bytes read or error
*/
virtual int usrp_control_read(uint8_t request,
uint16_t value,
uint16_t index,
unsigned char* buff,
uint16_t length) = 0;
/*!
* Submit an OUT transfer
* \param request device specific request
* \param value device specific field
* \param index device specific field
* \param buff buffer of data to be sent
* \param length length of buffer
* \return number of bytes written or error
*/
virtual int usrp_control_write(uint8_t request,
uint16_t value,
uint16_t index,
unsigned char* buff,
uint16_t length) = 0;
/*!
* Perform an I2C write
* \param i2c_addr I2C device address
* \param buf data to be written
* \param len length of data in bytes
* \return number of bytes written or error
*/
virtual int usrp_i2c_write(uint16_t i2c_addr, unsigned char* buf, uint16_t len) = 0;
/*!
* Perform an I2C read
* \param i2c_addr I2C device address
* \param buf data to be read
* \param len length of data in bytes
* \return number of bytes read or error
*/
virtual int usrp_i2c_read(uint16_t i2c_addr, unsigned char* buf, uint16_t len) = 0;
//! enable/disable the rx path
virtual void usrp_rx_enable(bool on) = 0;
//! enable/disable the tx path
virtual void usrp_tx_enable(bool on) = 0;
//! reset the fpga
virtual void usrp_fpga_reset(bool on) = 0;
};
}} // namespace uhd::usrp