USRP Hardware Driver and USRP Manual  Version: 003.008.000-0-gfd61f0cc
UHD and USRP Manual
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
uhd::niusrprio::niriok_proxy Class Referenceabstract

#include <uhd/transport/nirio/niriok_proxy.h>

Inheritance diagram for uhd::niusrprio::niriok_proxy:
uhd::niusrprio::niriok_proxy_impl_v1 uhd::niusrprio::niriok_proxy_impl_v2

Classes

struct  nirio_ioctl_packet_t
 

Public Types

typedef boost::shared_ptr< niriok_proxy > sptr
 

Public Member Functions

 niriok_proxy ()
 
virtual ~niriok_proxy ()
 
virtual nirio_status open (const std::string &interface_path)=0
 
virtual void close (void)=0
 
virtual nirio_status reset ()=0
 
uint32_t get_interface_num ()
 
virtual nirio_status get_cached_session (uint32_t &session)=0
 
virtual nirio_status get_version (nirio_version_t type, uint32_t &major, uint32_t &upgrade, uint32_t &maintenance, char &phase, uint32_t &build)=0
 
virtual nirio_status get_attribute (const nirio_device_attribute32_t attribute, uint32_t &attrValue)=0
 
virtual nirio_status set_attribute (const nirio_device_attribute32_t attribute, const uint32_t value)=0
 
virtual nirio_status peek (uint32_t offset, uint32_t &value)=0
 
virtual nirio_status peek (uint32_t offset, uint64_t &value)=0
 
virtual nirio_status poke (uint32_t offset, const uint32_t &value)=0
 
virtual nirio_status poke (uint32_t offset, const uint64_t &value)=0
 
virtual nirio_status map_fifo_memory (uint32_t fifo_instance, size_t size, nirio_driver_iface::rio_mmap_t &map)=0
 
virtual nirio_status unmap_fifo_memory (nirio_driver_iface::rio_mmap_t &map)=0
 
virtual nirio_status stop_all_fifos ()=0
 
nirio_quirks & get_rio_quirks ()
 
virtual nirio_status add_fifo_resource (const nirio_fifo_info_t &fifo_info)=0
 
virtual nirio_status set_device_config ()=0
 
virtual nirio_status start_fifo (uint32_t channel)=0
 
virtual nirio_status stop_fifo (uint32_t channel)=0
 
virtual nirio_status configure_fifo (uint32_t channel, uint32_t requested_depth, uint8_t requires_actuals, uint32_t &actual_depth, uint32_t &actual_size)=0
 
virtual nirio_status wait_on_fifo (uint32_t channel, uint32_t elements_requested, uint32_t scalar_type, uint32_t bit_width, uint32_t timeout, uint8_t output, void *&data_pointer, uint32_t &elements_acquired, uint32_t &elements_remaining)=0
 
virtual nirio_status grant_fifo (uint32_t channel, uint32_t elements_to_grant)=0
 
virtual nirio_status read_fifo (uint32_t channel, uint32_t elements_to_read, void *buffer, uint32_t buffer_datatype_width, uint32_t scalar_type, uint32_t bit_width, uint32_t timeout, uint32_t &number_read, uint32_t &number_remaining)=0
 
virtual nirio_status write_fifo (uint32_t channel, uint32_t elements_to_write, void *buffer, uint32_t buffer_datatype_width, uint32_t scalar_type, uint32_t bit_width, uint32_t timeout, uint32_t &number_remaining)=0
 

Static Public Member Functions

static sptr make_and_open (const std::string &interface_path)
 

Protected Member Functions

virtual void _close ()=0
 

Protected Attributes

nirio_driver_iface::rio_dev_handle_t _device_handle
 
uint32_t _interface_num
 
nirio_quirks _rio_quirks
 

Static Protected Attributes

static boost::shared_mutex _synchronization
 

Member Typedef Documentation

◆ sptr

typedef boost::shared_ptr<niriok_proxy> uhd::niusrprio::niriok_proxy::sptr

Constructor & Destructor Documentation

◆ niriok_proxy()

uhd::niusrprio::niriok_proxy::niriok_proxy ( )

◆ ~niriok_proxy()

virtual uhd::niusrprio::niriok_proxy::~niriok_proxy ( )
virtual

Member Function Documentation

◆ _close()

virtual void uhd::niusrprio::niriok_proxy::_close ( )
protectedpure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ add_fifo_resource()

virtual nirio_status uhd::niusrprio::niriok_proxy::add_fifo_resource ( const nirio_fifo_info_t &  fifo_info)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ close()

virtual void uhd::niusrprio::niriok_proxy::close ( void  )
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ configure_fifo()

virtual nirio_status uhd::niusrprio::niriok_proxy::configure_fifo ( uint32_t  channel,
uint32_t  requested_depth,
uint8_t  requires_actuals,
uint32_t &  actual_depth,
uint32_t &  actual_size 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ get_attribute()

virtual nirio_status uhd::niusrprio::niriok_proxy::get_attribute ( const nirio_device_attribute32_t  attribute,
uint32_t &  attrValue 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ get_cached_session()

virtual nirio_status uhd::niusrprio::niriok_proxy::get_cached_session ( uint32_t &  session)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ get_interface_num()

uint32_t uhd::niusrprio::niriok_proxy::get_interface_num ( )
inline

◆ get_rio_quirks()

nirio_quirks& uhd::niusrprio::niriok_proxy::get_rio_quirks ( )
inline

◆ get_version()

virtual nirio_status uhd::niusrprio::niriok_proxy::get_version ( nirio_version_t  type,
uint32_t &  major,
uint32_t &  upgrade,
uint32_t &  maintenance,
char &  phase,
uint32_t &  build 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ grant_fifo()

virtual nirio_status uhd::niusrprio::niriok_proxy::grant_fifo ( uint32_t  channel,
uint32_t  elements_to_grant 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ make_and_open()

static sptr uhd::niusrprio::niriok_proxy::make_and_open ( const std::string &  interface_path)
static

◆ map_fifo_memory()

virtual nirio_status uhd::niusrprio::niriok_proxy::map_fifo_memory ( uint32_t  fifo_instance,
size_t  size,
nirio_driver_iface::rio_mmap_t &  map 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ open()

virtual nirio_status uhd::niusrprio::niriok_proxy::open ( const std::string &  interface_path)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ peek() [1/2]

virtual nirio_status uhd::niusrprio::niriok_proxy::peek ( uint32_t  offset,
uint32_t &  value 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ peek() [2/2]

virtual nirio_status uhd::niusrprio::niriok_proxy::peek ( uint32_t  offset,
uint64_t &  value 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ poke() [1/2]

virtual nirio_status uhd::niusrprio::niriok_proxy::poke ( uint32_t  offset,
const uint32_t &  value 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ poke() [2/2]

virtual nirio_status uhd::niusrprio::niriok_proxy::poke ( uint32_t  offset,
const uint64_t &  value 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ read_fifo()

virtual nirio_status uhd::niusrprio::niriok_proxy::read_fifo ( uint32_t  channel,
uint32_t  elements_to_read,
void *  buffer,
uint32_t  buffer_datatype_width,
uint32_t  scalar_type,
uint32_t  bit_width,
uint32_t  timeout,
uint32_t &  number_read,
uint32_t &  number_remaining 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ reset()

virtual nirio_status uhd::niusrprio::niriok_proxy::reset ( )
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ set_attribute()

virtual nirio_status uhd::niusrprio::niriok_proxy::set_attribute ( const nirio_device_attribute32_t  attribute,
const uint32_t  value 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ set_device_config()

virtual nirio_status uhd::niusrprio::niriok_proxy::set_device_config ( )
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ start_fifo()

virtual nirio_status uhd::niusrprio::niriok_proxy::start_fifo ( uint32_t  channel)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ stop_all_fifos()

virtual nirio_status uhd::niusrprio::niriok_proxy::stop_all_fifos ( )
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ stop_fifo()

virtual nirio_status uhd::niusrprio::niriok_proxy::stop_fifo ( uint32_t  channel)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ unmap_fifo_memory()

virtual nirio_status uhd::niusrprio::niriok_proxy::unmap_fifo_memory ( nirio_driver_iface::rio_mmap_t &  map)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ wait_on_fifo()

virtual nirio_status uhd::niusrprio::niriok_proxy::wait_on_fifo ( uint32_t  channel,
uint32_t  elements_requested,
uint32_t  scalar_type,
uint32_t  bit_width,
uint32_t  timeout,
uint8_t  output,
void *&  data_pointer,
uint32_t &  elements_acquired,
uint32_t &  elements_remaining 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

◆ write_fifo()

virtual nirio_status uhd::niusrprio::niriok_proxy::write_fifo ( uint32_t  channel,
uint32_t  elements_to_write,
void *  buffer,
uint32_t  buffer_datatype_width,
uint32_t  scalar_type,
uint32_t  bit_width,
uint32_t  timeout,
uint32_t &  number_remaining 
)
pure virtual

Implemented in uhd::niusrprio::niriok_proxy_impl_v1, and uhd::niusrprio::niriok_proxy_impl_v2.

Member Data Documentation

◆ _device_handle

nirio_driver_iface::rio_dev_handle_t uhd::niusrprio::niriok_proxy::_device_handle
protected

◆ _interface_num

uint32_t uhd::niusrprio::niriok_proxy::_interface_num
protected

◆ _rio_quirks

nirio_quirks uhd::niusrprio::niriok_proxy::_rio_quirks
protected

◆ _synchronization

boost::shared_mutex uhd::niusrprio::niriok_proxy::_synchronization
staticprotected
The documentation for this class was generated from the following file: