Base block implementation for SDR devices. More...
#include </build/gnuradio-oiF80q/gnuradio-3.9.2.0/gr-soapy/lib/block_impl.h>
Public Member Functions | |
bool | start () override |
Called to enable drivers, etc for i/o devices. More... | |
bool | stop () override |
Called to disable drivers, etc for i/o devices. More... | |
std::string | get_driver_key () const override |
std::string | get_hardware_key () const override |
kwargs_t | get_hardware_info () const override |
void | set_frontend_mapping (const std::string &frontend_mapping) override |
std::string | get_frontend_mapping () const override |
kwargs_t | get_channel_info (size_t channel) const override |
void | set_sample_rate (size_t channel, double sample_rate) override |
double | get_sample_rate (size_t channel) const override |
range_list_t | get_sample_rate_range (size_t channel) const override |
void | set_frequency (size_t channel, double frequency) override |
void | set_frequency (size_t channel, const std::string &name, double frequency) override |
double | get_frequency (size_t channel) const override |
double | get_frequency (size_t channel, const std::string &name) const override |
std::vector< std::string > | list_frequencies (size_t channel) const override |
range_list_t | get_frequency_range (size_t channel) const override |
range_list_t | get_frequency_range (size_t channel, const std::string &name) const override |
arginfo_list_t | get_frequency_args_info (size_t channel) const override |
void | set_bandwidth (size_t channel, double bandwidth) override |
double | get_bandwidth (size_t channel) const override |
range_list_t | get_bandwidth_range (size_t channel) const override |
std::vector< std::string > | list_antennas (int channel) const override |
void | set_antenna (size_t channel, const std::string &name) override |
std::string | get_antenna (size_t channel) const override |
bool | has_gain_mode (size_t channel) const override |
void | set_gain_mode (size_t channel, bool enable) override |
bool | get_gain_mode (size_t channel) const override |
std::vector< std::string > | list_gains (size_t channel) const override |
void | set_gain (size_t channel, double gain) override |
void | set_gain (size_t channel, const std::string &name, double gain) override |
double | get_gain (size_t channel) const override |
double | get_gain (size_t channel, const std::string &name) const override |
range_t | get_gain_range (size_t channel) const override |
range_t | get_gain_range (size_t channel, const std::string &name) const override |
bool | has_frequency_correction (size_t channel) const override |
void | set_frequency_correction (size_t channel, double freq_correction) override |
double | get_frequency_correction (size_t channel) const override |
bool | has_dc_offset_mode (size_t channel) const override |
void | set_dc_offset_mode (size_t channel, bool automatic) override |
bool | get_dc_offset_mode (size_t channel) const override |
bool | has_dc_offset (size_t channel) const override |
void | set_dc_offset (size_t channel, const gr_complexd &dc_offset) override |
gr_complexd | get_dc_offset (size_t channel) const override |
bool | has_iq_balance (size_t channel) const override |
void | set_iq_balance (size_t channel, const gr_complexd &iq_balance) override |
gr_complexd | get_iq_balance (size_t channel) const override |
bool | has_iq_balance_mode (size_t channel) const override |
void | set_iq_balance_mode (size_t channel, bool automatic) override |
bool | get_iq_balance_mode (size_t channel) const override |
void | set_master_clock_rate (double clock_rate) override |
double | get_master_clock_rate () const override |
range_list_t | get_master_clock_rates () const override |
void | set_reference_clock_rate (double rate) override |
double | get_reference_clock_rate () const override |
range_list_t | get_reference_clock_rates () const override |
std::vector< std::string > | list_clock_sources () const override |
void | set_clock_source (const std::string &clock_source) override |
std::string | get_clock_source () const override |
std::vector< std::string > | list_time_sources () const override |
void | set_time_source (const std::string &source) override |
std::string | get_time_source () const override |
bool | has_hardware_time (const std::string &what) const override |
long long | get_hardware_time (const std::string &what) const override |
void | set_hardware_time (long long timeNs, const std::string &what) override |
std::vector< std::string > | list_sensors () const override |
arginfo_t | get_sensor_info (const std::string &key) const override |
std::string | read_sensor (const std::string &key) const override |
std::vector< std::string > | list_sensors (size_t channel) const override |
arginfo_t | get_sensor_info (size_t channel, const std::string &key) const override |
std::string | read_sensor (size_t channel, const std::string &key) const override |
std::vector< std::string > | list_register_interfaces () const override |
void | write_register (const std::string &name, unsigned addr, unsigned value) override |
unsigned | read_register (const std::string &name, unsigned addr) const override |
void | write_registers (const std::string &name, unsigned addr, const std::vector< unsigned > &value) override |
std::vector< unsigned > | read_registers (const std::string &name, unsigned addr, size_t length) const override |
virtual arginfo_list_t | get_setting_info () const override |
virtual void | write_setting (const std::string &key, const std::string &value) override |
virtual std::string | read_setting (const std::string &key) const override |
virtual arginfo_list_t | get_setting_info (size_t channel) const override |
virtual void | write_setting (size_t channel, const std::string &key, const std::string &value) override |
virtual std::string | read_setting (size_t channel, const std::string &key) const override |
std::vector< std::string > | list_gpio_banks () const override |
void | write_gpio (const std::string &bank, unsigned value) override |
void | write_gpio (const std::string &bank, unsigned value, unsigned mask) override |
unsigned | read_gpio (const std::string &bank) const override |
void | write_gpio_dir (const std::string &bank, unsigned dir) override |
void | write_gpio_dir (const std::string &bank, unsigned dir, unsigned mask) override |
unsigned | read_gpio_dir (const std::string &bank) const override |
void | write_i2c (int addr, const std::string &data) override |
std::string | read_i2c (int addr, size_t num_bytes) override |
unsigned | transact_spi (int addr, unsigned data, size_t num_bits) override |
std::vector< std::string > | list_uarts () const override |
void | write_uart (const std::string &which, const std::string &data) override |
std::string | read_uart (const std::string &which, long timeout_us) const override |
![]() | |
~block () override | |
unsigned | history () const |
void | set_history (unsigned history) |
void | declare_sample_delay (int which, unsigned delay) |
void | declare_sample_delay (unsigned delay) |
unsigned | sample_delay (int which) const |
bool | fixed_rate () const |
Return true if this block has a fixed input to output rate. More... | |
virtual void | forecast (int noutput_items, gr_vector_int &ninput_items_required) |
Estimate input requirements given output request. More... | |
virtual int | general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) |
compute output items from input items More... | |
void | set_output_multiple (int multiple) |
Constrain the noutput_items argument passed to forecast and general_work. More... | |
int | output_multiple () const |
bool | output_multiple_set () const |
void | set_alignment (int multiple) |
Constrains buffers to work on a set item alignment (for SIMD) More... | |
int | alignment () const |
void | set_unaligned (int na) |
int | unaligned () const |
void | set_is_unaligned (bool u) |
bool | is_unaligned () const |
void | consume (int which_input, int how_many_items) |
Tell the scheduler how_many_items of input stream which_input were consumed. More... | |
void | consume_each (int how_many_items) |
Tell the scheduler how_many_items were consumed on each input stream. More... | |
void | produce (int which_output, int how_many_items) |
Tell the scheduler how_many_items were produced on output stream which_output . More... | |
void | set_relative_rate (double relative_rate) |
Set the approximate output rate / input rate. More... | |
void | set_inverse_relative_rate (double inverse_relative_rate) |
Set the approximate output rate / input rate using its reciprocal. More... | |
void | set_relative_rate (uint64_t interpolation, uint64_t decimation) |
Set the approximate output rate / input rate as an integer ratio. More... | |
double | relative_rate () const |
return the approximate output rate / input rate More... | |
uint64_t | relative_rate_i () const |
return the numerator, or interpolation rate, of the approximate output rate / input rate More... | |
uint64_t | relative_rate_d () const |
return the denominator, or decimation rate, of the approximate output rate / input rate More... | |
mpq_class & | mp_relative_rate () |
return a reference to the multiple precision rational representation of the approximate output rate / input rate More... | |
virtual int | fixed_rate_ninput_to_noutput (int ninput) |
Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More... | |
virtual int | fixed_rate_noutput_to_ninput (int noutput) |
Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this. More... | |
uint64_t | nitems_read (unsigned int which_input) |
Return the number of items read on input stream which_input. More... | |
uint64_t | nitems_written (unsigned int which_output) |
Return the number of items written on output stream which_output. More... | |
tag_propagation_policy_t | tag_propagation_policy () |
Asks for the policy used by the scheduler to moved tags downstream. More... | |
void | set_tag_propagation_policy (tag_propagation_policy_t p) |
Set the policy by the scheduler to determine how tags are moved downstream. More... | |
int | min_noutput_items () const |
Return the minimum number of output items this block can produce during a call to work. More... | |
void | set_min_noutput_items (int m) |
Set the minimum number of output items this block can produce during a call to work. More... | |
int | max_noutput_items () |
Return the maximum number of output items this block will handle during a call to work. More... | |
void | set_max_noutput_items (int m) |
Set the maximum number of output items this block will handle during a call to work. More... | |
void | unset_max_noutput_items () |
Clear the switch for using the max_noutput_items value of this block. More... | |
bool | is_set_max_noutput_items () |
Ask the block if the flag is or is not set to use the internal value of max_noutput_items during a call to work. More... | |
void | expand_minmax_buffer (int port) |
long | max_output_buffer (size_t i) |
Returns max buffer size on output port i . More... | |
void | set_max_output_buffer (long max_output_buffer) |
Request limit on max buffer size on all output ports. More... | |
void | set_max_output_buffer (int port, long max_output_buffer) |
Request limit on max buffer size on output port port . More... | |
long | min_output_buffer (size_t i) |
Returns min buffer size on output port i . More... | |
void | set_min_output_buffer (long min_output_buffer) |
Request limit on the minimum buffer size on all output ports. More... | |
void | set_min_output_buffer (int port, long min_output_buffer) |
Request limit on min buffer size on output port port . More... | |
float | pc_noutput_items () |
Gets instantaneous noutput_items performance counter. More... | |
float | pc_noutput_items_avg () |
Gets average noutput_items performance counter. More... | |
float | pc_noutput_items_var () |
Gets variance of noutput_items performance counter. More... | |
float | pc_nproduced () |
Gets instantaneous num items produced performance counter. More... | |
float | pc_nproduced_avg () |
Gets average num items produced performance counter. More... | |
float | pc_nproduced_var () |
Gets variance of num items produced performance counter. More... | |
float | pc_input_buffers_full (int which) |
Gets instantaneous fullness of which input buffer. More... | |
float | pc_input_buffers_full_avg (int which) |
Gets average fullness of which input buffer. More... | |
float | pc_input_buffers_full_var (int which) |
Gets variance of fullness of which input buffer. More... | |
std::vector< float > | pc_input_buffers_full () |
Gets instantaneous fullness of all input buffers. More... | |
std::vector< float > | pc_input_buffers_full_avg () |
Gets average fullness of all input buffers. More... | |
std::vector< float > | pc_input_buffers_full_var () |
Gets variance of fullness of all input buffers. More... | |
float | pc_output_buffers_full (int which) |
Gets instantaneous fullness of which output buffer. More... | |
float | pc_output_buffers_full_avg (int which) |
Gets average fullness of which output buffer. More... | |
float | pc_output_buffers_full_var (int which) |
Gets variance of fullness of which output buffer. More... | |
std::vector< float > | pc_output_buffers_full () |
Gets instantaneous fullness of all output buffers. More... | |
std::vector< float > | pc_output_buffers_full_avg () |
Gets average fullness of all output buffers. More... | |
std::vector< float > | pc_output_buffers_full_var () |
Gets variance of fullness of all output buffers. More... | |
float | pc_work_time () |
Gets instantaneous clock cycles spent in work. More... | |
float | pc_work_time_avg () |
Gets average clock cycles spent in work. More... | |
float | pc_work_time_var () |
Gets average clock cycles spent in work. More... | |
float | pc_work_time_total () |
Gets total clock cycles spent in work. More... | |
float | pc_throughput_avg () |
Gets average throughput. More... | |
void | reset_perf_counters () |
Resets the performance counters. More... | |
void | setup_pc_rpc () |
Sets up export of perf. counters to ControlPort. Only called by the scheduler. More... | |
bool | is_pc_rpc_set () |
Checks if this block is already exporting perf. counters to ControlPort. More... | |
void | no_pc_rpc () |
If the block calls this in its constructor, it's perf. counters will not be exported. More... | |
void | set_processor_affinity (const std::vector< int > &mask) override |
Set the thread's affinity to processor core n . More... | |
void | unset_processor_affinity () override |
Remove processor affinity to a specific core. More... | |
std::vector< int > | processor_affinity () override |
Get the current processor affinity. More... | |
int | active_thread_priority () |
Get the current thread priority in use. More... | |
int | thread_priority () |
Get the current thread priority stored. More... | |
int | set_thread_priority (int priority) |
Set the current thread priority. More... | |
bool | update_rate () const |
void | system_handler (pmt::pmt_t msg) |
the system message handler More... | |
void | set_log_level (std::string level) override |
Set the logger's output level. More... | |
std::string | log_level () override |
Get the logger's output level. More... | |
bool | finished () |
returns true when execution has completed due to a message connection More... | |
block_detail_sptr | detail () const |
void | set_detail (block_detail_sptr detail) |
void | notify_msg_neighbors () |
Tell msg neighbors we are finished. More... | |
void | clear_finished () |
Make sure we don't think we are finished. More... | |
std::string | identifier () const |
![]() | |
pmt::pmt_t | message_subscribers (pmt::pmt_t port) |
~basic_block () override | |
long | unique_id () const |
long | symbolic_id () const |
std::string | name () const |
std::string | symbol_name () const |
std::string | identifier () const |
gr::io_signature::sptr | input_signature () const |
gr::io_signature::sptr | output_signature () const |
basic_block_sptr | to_basic_block () |
bool | alias_set () const |
std::string | alias () const |
pmt::pmt_t | alias_pmt () const |
void | set_block_alias (std::string name) |
void | message_port_register_in (pmt::pmt_t port_id) |
void | message_port_register_out (pmt::pmt_t port_id) |
void | message_port_pub (pmt::pmt_t port_id, pmt::pmt_t msg) |
void | message_port_sub (pmt::pmt_t port_id, pmt::pmt_t target) |
void | message_port_unsub (pmt::pmt_t port_id, pmt::pmt_t target) |
virtual bool | message_port_is_hier (pmt::pmt_t port_id) |
virtual bool | message_port_is_hier_in (pmt::pmt_t port_id) |
virtual bool | message_port_is_hier_out (pmt::pmt_t port_id) |
pmt::pmt_t | message_ports_in () |
Get input message port names. More... | |
pmt::pmt_t | message_ports_out () |
Get output message port names. More... | |
void | _post (pmt::pmt_t which_port, pmt::pmt_t msg) |
bool | empty_p (pmt::pmt_t which_port) |
is the queue empty? More... | |
bool | empty_p () |
bool | empty_handled_p (pmt::pmt_t which_port) |
are all msg ports with handlers empty? More... | |
bool | empty_handled_p () |
size_t | nmsgs (pmt::pmt_t which_port) |
How many messages in the queue? More... | |
void | insert_tail (pmt::pmt_t which_port, pmt::pmt_t msg) |
pmt::pmt_t | delete_head_nowait (pmt::pmt_t which_port) |
msg_queue_t::iterator | get_iterator (pmt::pmt_t which_port) |
void | erase_msg (pmt::pmt_t which_port, msg_queue_t::iterator it) |
virtual bool | has_msg_port (pmt::pmt_t which_port) |
const msg_queue_map_t & | get_msg_map (void) const |
virtual void | setup_rpc () |
Set up the RPC registered variables. More... | |
bool | is_rpc_set () |
Ask if this block has been registered to the RPC. More... | |
void | rpc_set () |
When the block is registered with the RPC, set this. More... | |
virtual bool | check_topology (int ninputs, int noutputs) |
Confirm that ninputs and noutputs is an acceptable combination. More... | |
template<typename T > | |
void | set_msg_handler (pmt::pmt_t which_port, T msg_handler) |
Set the callback that is fired when messages are available. More... | |
![]() | |
msg_accepter () | |
~msg_accepter () override | |
void | post (pmt::pmt_t which_port, pmt::pmt_t msg) override |
send msg to msg_accepter on port which_port More... | |
Protected Member Functions | |
block_impl (int direction, const std::string &device, const std::string &type, size_t nchan, const std::string &dev_args, const std::string &stream_args, const std::vector< std::string > &tune_args, const std::vector< std::string > &other_settings) | |
block_impl (const block_impl &)=delete | |
block_impl (block_impl &&)=delete | |
block_impl & | operator= (const block_impl &)=delete |
block_impl & | operator= (block_impl &&)=delete |
virtual | ~block_impl () |
void | msg_handler_cmd (pmt::pmt_t msg) |
void | cmd_handler_frequency (pmt::pmt_t val, size_t channel) |
void | cmd_handler_gain (pmt::pmt_t val, size_t channel) |
void | cmd_handler_samp_rate (pmt::pmt_t val, size_t channel) |
void | cmd_handler_bw (pmt::pmt_t val, size_t channel) |
void | cmd_handler_antenna (pmt::pmt_t val, size_t channel) |
![]() | |
block (void) | |
block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
void | set_fixed_rate (bool fixed_rate) |
void | add_item_tag (unsigned int which_output, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F) |
Adds a new tag onto the given output buffer. More... | |
void | add_item_tag (unsigned int which_output, const tag_t &tag) |
Adds a new tag onto the given output buffer. More... | |
void | remove_item_tag (unsigned int which_input, uint64_t abs_offset, const pmt::pmt_t &key, const pmt::pmt_t &value, const pmt::pmt_t &srcid=pmt::PMT_F) |
DEPRECATED. Will be removed in 3.8. More... | |
void | remove_item_tag (unsigned int which_input, const tag_t &tag) |
DEPRECATED. Will be removed in 3.8. More... | |
void | get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end) |
Given a [start,end), returns a vector of all tags in the range. More... | |
void | get_tags_in_range (std::vector< tag_t > &v, unsigned int which_input, uint64_t abs_start, uint64_t abs_end, const pmt::pmt_t &key) |
Given a [start,end), returns a vector of all tags in the range with a given key. More... | |
void | get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end) |
Gets all tags within the relative window of the current call to work. More... | |
void | get_tags_in_window (std::vector< tag_t > &v, unsigned int which_input, uint64_t rel_start, uint64_t rel_end, const pmt::pmt_t &key) |
Operates like gr::block::get_tags_in_window with the ability to only return tags with the specified key . More... | |
void | enable_update_rate (bool en) |
![]() | |
basic_block (void) | |
basic_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature) | |
Protected constructor prevents instantiation by non-derived classes. More... | |
void | set_input_signature (gr::io_signature::sptr iosig) |
may only be called during constructor More... | |
void | set_output_signature (gr::io_signature::sptr iosig) |
may only be called during constructor More... | |
void | set_color (vcolor color) |
Allow the flowgraph to set for sorting and partitioning. More... | |
vcolor | color () const |
virtual bool | has_msg_handler (pmt::pmt_t which_port) |
Tests if there is a handler attached to port which_port . More... | |
virtual void | dispatch_msg (pmt::pmt_t which_port, pmt::pmt_t msg) |
Static Protected Member Functions | |
static io_signature::sptr | args_to_io_sig (const std::string &type, size_t nchan) |
Protected Attributes | |
std::mutex | d_device_mutex |
device_ptr_t | d_device |
SoapySDR::Stream * | d_stream = nullptr |
![]() | |
std::vector< long > | d_max_output_buffer |
std::vector< long > | d_min_output_buffer |
gr::thread::mutex | d_setlock |
const pmt::pmt_t | d_pmt_done |
const pmt::pmt_t | d_system_port |
![]() | |
std::string | d_name |
gr::io_signature::sptr | d_input_signature |
gr::io_signature::sptr | d_output_signature |
long | d_unique_id |
long | d_symbolic_id |
std::string | d_symbol_name |
std::string | d_symbol_alias |
vcolor | d_color |
bool | d_rpc_set |
gr::logger_ptr | d_logger |
gr::logger_ptr | d_debug_logger |
Default logger. More... | |
msg_queue_map_t | msg_queue |
Verbose logger. More... | |
std::vector< rpcbasic_sptr > | d_rpc_vars |
pmt::pmt_t | d_message_subscribers |
Additional Inherited Members | |
![]() | |
enum | work_return_t { WORK_CALLED_PRODUCE = -2 , WORK_DONE = -1 } |
Magic return values from general_work. More... | |
enum | tag_propagation_policy_t { TPP_DONT = 0 , TPP_ALL_TO_ALL = 1 , TPP_ONE_TO_ONE = 2 , TPP_CUSTOM = 3 } |
enum to represent different tag propagation policies. More... | |
![]() | |
enum | vcolor { WHITE , GREY , BLACK } |
Base block implementation for SDR devices.
|
protected |
|
protecteddelete |
|
protecteddelete |
|
protectedvirtual |
|
inlinestaticprotected |
References gr::io_signature::make().
|
protected |
Set the anntena element for the RX chain.
val | name of the anntena |
channel | an available channel on the device |
|
protected |
Set the baseband filter width for the RX chain.
val | baseband filter width in Hz |
channel | an available channel on the device |
|
protected |
Set the center frequency of the RX chain.
val | center frequency in Hz |
channel | an available channel on the device |
|
protected |
Set the overall gain for the specified chain. The gain will be distributed automatically across available elements according to Soapy API.
val | the new amplification value in dB |
channel | an avalaible channel on the device |
|
protected |
Set the baseband sample rate for the RX chain.
val | the sample rate samples per second |
channel | an available channel on the device |
|
overridevirtual |
Get the selected antenna on RX chain.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get baseband filter width of the RX chain.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the range of possible baseband filter widths.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Query a dictionary of available channel information. This dictionary can any number of values like decoder type, version, available functions... This information can be displayed to the user to help identify the instantiated channel.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
|
overridevirtual |
Get the DC offset correction.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the automatic DC offset correction mode.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
A key that uniquely identifies the device driver. This key identifies the underlying implementation. Several variants of a product may share a driver.
Implements gr::soapy::block.
|
overridevirtual |
Get the down conversion frequency of the chain.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the frequency of a tunable element in the chain.
channel | an available channel on the device |
name | the name of a tunable element |
Implements gr::soapy::block.
|
overridevirtual |
Query the argument info description for stream args.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the frequency correction value.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the range of overall frequency values.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the range of tunable values for the specified element.
channel | an available channel on the device |
name | the name of a tunable element |
Implements gr::soapy::block.
|
overridevirtual |
Get the frontend mapping of available DSP units to RF frontends. This mapping describes channel mapping and channel availability.
Implements gr::soapy::block.
|
overridevirtual |
Get the overall value of the gain elements in a chain
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the value of an individual amplification element in a chain.
channel | an available channel on the device |
name | the name of an amplification element |
Implements gr::soapy::block.
|
overridevirtual |
Get the automatic gain mode on the RX chain.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the overall range of possible gain values.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the range of possible gain values for a specific element.
channel | an available channel on the device |
name | the name of an amplification element |
Implements gr::soapy::block.
|
overridevirtual |
Query a dictionary of available device information. This dictionary can any number of values like vendor name, product name, revisions, serials... This information can be displayed to the user to help identify the instantiated device.
Implements gr::soapy::block.
|
overridevirtual |
A key that uniquely identifies the hardware. This key should be meaningful to the user to optimize for the underlying hardware.
Implements gr::soapy::block.
|
overridevirtual |
Read the time from the hardware clock on the device. The what argument can refer to a specific time counter.
what | optional argument |
Implements gr::soapy::block.
|
overridevirtual |
Get the IQ balance correction.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the automatic IQ balance corrections mode.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
|
overridevirtual |
Get the range of available master clock rates.
Implements gr::soapy::block.
|
overridevirtual |
Get the reference clock rate of the device.
Implements gr::soapy::block.
|
overridevirtual |
Get the range of available reference clock rates.
Implements gr::soapy::block.
|
overridevirtual |
Get the baseband sample rate of the RX chain.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the range of possible baseband sample rates.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get meta-information about a sensor. Example: displayable name, type, range.
key | the ID name of an available sensor |
Implements gr::soapy::block.
|
overridevirtual |
Get meta-information about a channel sensor. Example: displayable name, type, range.
channel | an available channel on the device |
key | the ID name of an available sensor |
Implements gr::soapy::block.
|
overridevirtual |
Describe the allowed keys and values used for settings.
Implements gr::soapy::block.
|
overridevirtual |
Describe the allowed keys and values used for channel settings.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
|
overridevirtual |
Return whether manual dc offset correction is supported
channel | an available channel |
Implements gr::soapy::block.
|
overridevirtual |
Return whether DC offset mode can be set
channel | an available channel |
Implements gr::soapy::block.
|
overridevirtual |
Return whether frequency correction is supported
channel | an available channel |
Implements gr::soapy::block.
|
overridevirtual |
Return whether automatic gain control (AGC) is supported
channel | an available channel |
Implements gr::soapy::block.
|
overridevirtual |
Does this device have a hardware clock?
what | optional argument |
Implements gr::soapy::block.
|
overridevirtual |
Return whether manual IQ balance correction is supported
channel | an available channel |
Implements gr::soapy::block.
|
overridevirtual |
Does the device support automatic frontend IQ balance correction?
direction | the channel direction RX or TX |
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
List available antennas for a channel
channel | channel index |
Implements gr::soapy::block.
|
overridevirtual |
Get the list of available clock sources.
Implements gr::soapy::block.
|
overridevirtual |
List available tunable elements in the chain. Elements should be in order RF to baseband.
channel | an available channel |
Implements gr::soapy::block.
|
overridevirtual |
List available amplification elements. Elements should be in order RF to baseband.
channel | an available channel |
Implements gr::soapy::block.
|
overridevirtual |
Get a list of available GPIO banks by name.
Implements gr::soapy::block.
|
overridevirtual |
Get a list of available register interfaces by name.
Implements gr::soapy::block.
|
overridevirtual |
List the available global readback sensors. A sensor can represent a reference lock, RSSI, temperature.
Implements gr::soapy::block.
|
overridevirtual |
List the available channel readback sensors. A sensor can represent a reference lock, RSSI, temperature.
channel | an available channel on the device |
Implements gr::soapy::block.
|
overridevirtual |
Get the list of available time sources.
Implements gr::soapy::block.
|
overridevirtual |
Enumerate the available UART devices.
Implements gr::soapy::block.
|
protected |
Calls the correct message handler according to the received message symbol. A dictionary with key the handler name is used in order to call the corresponding handler.
msg | a PMT dictionary |
|
protecteddelete |
|
protecteddelete |
|
overridevirtual |
Readback the value of a GPIO bank.
bank | the name of an available bank |
Implements gr::soapy::block.
|
overridevirtual |
Read the data direction of a GPIO bank. 1 bits represent outputs, 0 bits represent inputs.
bank | the name of an available bank |
Implements gr::soapy::block.
|
overridevirtual |
Read from an available I2C slave. If the device contains multiple I2C masters, the address bits can encode which master.
addr | the address of the slave |
num_bytes | the number of bytes to read |
Implements gr::soapy::block.
|
overridevirtual |
Read a register on the device given the interface name.
name | the name of a available register interface |
addr | the register address |
Implements gr::soapy::block.
|
overridevirtual |
Read a memory block on the device given the interface name.
name | the name of a available memory block interface |
addr | the memory block start address |
length | number of words to be read from memory block |
Implements gr::soapy::block.
|
overridevirtual |
Readback a global sensor given the name. The value returned is a string which can represent a boolean ("true"/"false"), an integer, or float.
key | the ID name of an available sensor |
Implements gr::soapy::block.
|
overridevirtual |
Readback a channel sensor given the name. The value returned is a string which can represent a boolean ("true"/"false"), an integer, or float.
channel | an available channel on the device |
key | the ID name of an available sensor |
Implements gr::soapy::block.
|
overridevirtual |
Read an arbitrary setting on the device.
key | the setting identifier |
Implements gr::soapy::block.
|
overridevirtual |
Read an arbitrary channel setting on the device.
channel | an available channel on the device |
key | the setting identifier |
Implements gr::soapy::block.
|
overridevirtual |
Read bytes from a UART until timeout or newline. Its up to the implementation to set the baud rate, carriage return settings, flushing on newline.
which | the name of an available UART |
timeout_us | a timeout in microseconds |
Implements gr::soapy::block.
|
overridevirtual |
Set antenna for channel
channel | an available channel |
name | an available antenna string name |
Implements gr::soapy::block.
|
overridevirtual |
Set filter bandwidth
channel | an available channel |
bandwidth | filter width in Hz |
Implements gr::soapy::block.
|
overridevirtual |
|
overridevirtual |
Set dc offset correction
channel | an available channel |
dc_offset | complex dc offset correction |
Implements gr::soapy::block.
|
overridevirtual |
Set DC offset mode
channel | an available channel |
automatic | true to set automatic DC removal |
Implements gr::soapy::block.
|
overridevirtual |
Set center frequency of a tunable element
channel | an available channel |
name | an available element name |
freq | frequency in Hz |
Implements gr::soapy::block.
|
overridevirtual |
Set device center frequency
channel | an available channel |
freq | frequency in Hz |
Implements gr::soapy::block.
|
overridevirtual |
Set frequency correction
channel | an available channel |
freq_correction | in PPM |
Implements gr::soapy::block.
|
overridevirtual |
Set the frontend mapping of available DSP units to RF frontends. This mapping controls channel mapping and channel availability.
frontend_mapping | a vendor-specific mapping string |
Implements gr::soapy::block.
|
overridevirtual |
Set specific gain value
channel | an available channel |
name | gain name to set |
gain | gain value |
Implements gr::soapy::block.
|
overridevirtual |
Set overall gain The gain will be distributed automatically across available elements according to Soapy API.
channel | an available channel |
gain | overall gain value |
Implements gr::soapy::block.
|
overridevirtual |
Set automatic gain control (AGC)
channel | an available channel |
enable | true to enable AGC |
Implements gr::soapy::block.
|
overridevirtual |
Write the time to the hardware clock on the device. The what argument can refer to a specific time counter.
timeNs | time in nanoseconds |
what | optional argument |
Implements gr::soapy::block.
|
overridevirtual |
Set IQ balance correction
channel | an available channel |
iq_balance | complex iq balance correction |
Implements gr::soapy::block.
|
overridevirtual |
Set the automatic frontend IQ balance correction.
channel | an available channel on the device |
automatic | true for automatic correction |
Implements gr::soapy::block.
|
overridevirtual |
|
overridevirtual |
Set the reference clock rate of the device.
rate | the clock rate in Hz |
Implements gr::soapy::block.
|
overridevirtual |
Set sample rate
channel | an available channel |
sample_rate | samples per second |
Implements gr::soapy::block.
|
overridevirtual |
Set the time source on the device
source | the name of a time source |
Implements gr::soapy::block.
|
overridevirtual |
Called to enable drivers, etc for i/o devices.
This allows a block to enable an associated driver to begin transferring data just before we start to execute the scheduler. The end result is that this reduces latency in the pipeline when dealing with audio devices, usrps, etc.
Reimplemented from gr::block.
|
overridevirtual |
Called to disable drivers, etc for i/o devices.
Reimplemented from gr::block.
|
overridevirtual |
Perform a SPI transaction and return the result. Its up to the implementation to set the clock rate, and read edge, and the write edge of the SPI core. SPI slaves without a readback pin will return 0.
If the device contains multiple SPI masters, the address bits can encode which master.
addr | an address of an available SPI slave |
data | the SPI data, num_bits-1 is first out |
num_bits | the number of bits to clock out |
Implements gr::soapy::block.
|
overridevirtual |
Write the value of a GPIO bank.
bank | the name of an available bank |
value | an integer representing GPIO bits |
Implements gr::soapy::block.
|
overridevirtual |
Write the value of a GPIO bank with modification mask.
bank | the name of an available bank |
value | an integer representing GPIO bits |
mask | a modification mask where 1 = modify |
Implements gr::soapy::block.
|
overridevirtual |
Write the data direction of a GPIO bank. 1 bits represent outputs, 0 bits represent inputs.
bank | the name of an available bank |
dir | an integer representing data direction bits |
Implements gr::soapy::block.
|
overridevirtual |
Write the data direction of a GPIO bank with modification mask. 1 bits represent outputs, 0 bits represent inputs.
bank | the name of an available bank |
dir | an integer representing data direction bits |
mask | a modification mask where 1 = modify |
Implements gr::soapy::block.
|
overridevirtual |
Write to an available I2C slave. If the device contains multiple I2C masters, the address bits can encode which master.
addr | the address of the slave |
data | an array of bytes write out |
Implements gr::soapy::block.
|
overridevirtual |
Write a register on the device given the interface name. This can represent a register on a soft CPU, FPGA, IC; the interpretation is up the implementation to decide.
name | the name of a available register interface |
addr | the register address |
value | the register value |
Implements gr::soapy::block.
|
overridevirtual |
Write a memory block on the device given the interface name. This can represent a memory block on a soft CPU, FPGA, IC; the interpretation is up the implementation to decide.
name | the name of a available memory block interface |
addr | the memory block start address |
value | the memory block content |
Implements gr::soapy::block.
|
overridevirtual |
Write an arbitrary setting on the device. The interpretation is up the implementation.
key | the setting identifier |
value | the setting value |
Implements gr::soapy::block.
|
overridevirtual |
Write an arbitrary channel setting on the device. The interpretation is up the implementation.
channel | an available channel on the device |
key | the setting identifier |
value | the setting value |
Implements gr::soapy::block.
|
overridevirtual |
Write data to a UART device. Its up to the implementation to set the baud rate, carriage return settings, flushing on newline.
which | the name of an available UART |
data | an array of bytes to write out |
Implements gr::soapy::block.
|
protected |
|
protected |
|
protected |