GNU Radio's TEST Package

bladerf_sink_c.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2013-2017 Nuand LLC
4 * Copyright 2013 Dimitri Stolnikov <horiz0n@gmx.net>
5 *
6 * GNU Radio is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3, or (at your option)
9 * any later version.
10 *
11 * GNU Radio is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with GNU Radio; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street,
19 * Boston, MA 02110-1301, USA.
20 */
21#ifndef INCLUDED_BLADERF_SINK_C_H
22#define INCLUDED_BLADERF_SINK_C_H
23
24#include <gnuradio/sync_block.h>
25#include "sink_iface.h"
26#include "bladerf_common.h"
27
28#include "osmosdr/ranges.h"
29
30 class bladerf_sink_c;
31
32/*
33 * We use std::shared_ptr's instead of raw pointers for all access
34 * to gr_blocks (and many other data structures). The shared_ptr gets
35 * us transparent reference counting, which greatly simplifies storage
36 * management issues. This is especially helpful in our hybrid
37 * C++ / Python system.
38 *
39 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
40 *
41 * As a convention, the _sptr suffix indicates a std::shared_ptr
42 */
43 typedef std::shared_ptr<bladerf_sink_c> bladerf_sink_c_sptr;
44
45/*!
46 * \brief Return a shared_ptr to a new instance of bladerf_sink_c.
47 *
48 * To avoid accidental use of raw pointers, bladerf_sink_c's
49 * constructor is private. make_bladerf_sink_c is the public
50 * interface for creating new instances.
51 */
52bladerf_sink_c_sptr make_bladerf_sink_c(const std::string &args = "");
53
54 class bladerf_sink_c :
55 public gr::sync_block,
56 public sink_iface,
57 protected bladerf_common
58{
59 private:
60 // The friend declaration allows bladerf_make_sink_c to
61 // access the private constructor.
62 friend bladerf_sink_c_sptr make_bladerf_sink_c(const std::string &args);
63
64 bladerf_sink_c(const std::string &args);
65
66 bool is_antenna_valid(const std::string &antenna);
67
68 public:
69 std::string name();
70
71 static std::vector<std::string> get_devices();
72
73 size_t get_max_channels(void);
74 size_t get_num_channels(void);
75
76 bool start();
77 bool stop();
78
79 int work(int noutput_items,
80 gr_vector_const_void_star &input_items,
81 gr_vector_void_star &output_items);
82
83 osmosdr::meta_range_t get_sample_rates(void);
84 double set_sample_rate(double rate);
85 double get_sample_rate(void);
86
87 osmosdr::freq_range_t get_freq_range(size_t chan = 0);
88 double set_center_freq(double freq, size_t chan = 0);
89 double get_center_freq(size_t chan = 0);
90
91 double set_freq_corr(double ppm, size_t chan = 0);
92 double get_freq_corr(size_t chan = 0);
93
94 std::vector<std::string> get_gain_names(size_t chan = 0);
95 osmosdr::gain_range_t get_gain_range(size_t chan = 0);
96 osmosdr::gain_range_t get_gain_range(const std::string &name,
97 size_t chan = 0);
98 bool set_gain_mode(bool automatic, size_t chan = 0);
99 bool get_gain_mode(size_t chan = 0);
100 double set_gain(double gain, size_t chan = 0);
101 double set_gain(double gain, const std::string &name, size_t chan = 0);
102 double get_gain(size_t chan = 0);
103 double get_gain(const std::string &name, size_t chan = 0);
104
105 std::vector<std::string> get_antennas(size_t chan = 0);
106 std::string set_antenna(const std::string &antenna, size_t chan = 0);
107 std::string get_antenna(size_t chan = 0);
108
109 void set_dc_offset(const std::complex<double> &offset, size_t chan);
110 void set_iq_balance(const std::complex<double> &balance, size_t chan);
111
112 osmosdr::freq_range_t get_bandwidth_range(size_t chan = 0);
113 double set_bandwidth(double bandwidth, size_t chan = 0);
114 double get_bandwidth(size_t chan = 0);
115
116 std::vector<std::string> get_clock_sources(size_t mboard);
117 void set_clock_source(const std::string &source, size_t mboard = 0);
118 std::string get_clock_source(size_t mboard);
119
120 void set_biastee_mode(const std::string &mode);
121
122 private:
123 int transmit_with_tags(int16_t const *samples, int noutput_items);
124
125 // Sample-handling buffers
126 int16_t *_16icbuf; /**< raw samples to bladeRF */
127 gr_complex *_32fcbuf; /**< intermediate buffer for conversions */
128
129 bool _in_burst; /**< are we currently in a burst? */
130 bool _running; /**< is the sink running? */
131 bladerf_channel_layout _layout; /**< channel layout */
132
133 gr::thread::mutex d_mutex; /**< mutex to protect set/work access */
134
135 /* Scaling factor used when converting from float to int16_t */
136 const float SCALING_FACTOR = 2048.0f;
137};
138
139#endif // INCLUDED_BLADERF_SINK_C_H
bladerf_common.h
make_bladerf_sink_c
bladerf_sink_c_sptr make_bladerf_sink_c(const std::string &args="")
Return a shared_ptr to a new instance of bladerf_sink_c.
bladerf_common
Definition: bladerf_common.h:104
bladerf_sink_c
Definition: bladerf_sink_c.h:58
bladerf_sink_c::name
std::string name()
bladerf_sink_c::get_num_channels
size_t get_num_channels(void)
bladerf_sink_c::set_gain
double set_gain(double gain, size_t chan=0)
bladerf_sink_c::get_clock_sources
std::vector< std::string > get_clock_sources(size_t mboard)
bladerf_sink_c::set_gain_mode
bool set_gain_mode(bool automatic, size_t chan=0)
bladerf_sink_c::get_bandwidth_range
osmosdr::freq_range_t get_bandwidth_range(size_t chan=0)
bladerf_sink_c::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
bladerf_sink_c::get_gain_names
std::vector< std::string > get_gain_names(size_t chan=0)
bladerf_sink_c::set_clock_source
void set_clock_source(const std::string &source, size_t mboard=0)
bladerf_sink_c::get_gain
double get_gain(const std::string &name, size_t chan=0)
bladerf_sink_c::get_devices
static std::vector< std::string > get_devices()
bladerf_sink_c::set_biastee_mode
void set_biastee_mode(const std::string &mode)
bladerf_sink_c::stop
bool stop()
bladerf_sink_c::get_bandwidth
double get_bandwidth(size_t chan=0)
bladerf_sink_c::get_clock_source
std::string get_clock_source(size_t mboard)
bladerf_sink_c::get_freq_corr
double get_freq_corr(size_t chan=0)
bladerf_sink_c::get_antennas
std::vector< std::string > get_antennas(size_t chan=0)
bladerf_sink_c::get_sample_rates
osmosdr::meta_range_t get_sample_rates(void)
bladerf_sink_c::set_gain
double set_gain(double gain, const std::string &name, size_t chan=0)
bladerf_sink_c::get_gain_range
osmosdr::gain_range_t get_gain_range(size_t chan=0)
bladerf_sink_c::get_gain
double get_gain(size_t chan=0)
bladerf_sink_c::set_sample_rate
double set_sample_rate(double rate)
bladerf_sink_c::set_dc_offset
void set_dc_offset(const std::complex< double > &offset, size_t chan)
bladerf_sink_c::get_max_channels
size_t get_max_channels(void)
bladerf_sink_c::get_sample_rate
double get_sample_rate(void)
bladerf_sink_c::get_gain_range
osmosdr::gain_range_t get_gain_range(const std::string &name, size_t chan=0)
bladerf_sink_c::set_freq_corr
double set_freq_corr(double ppm, size_t chan=0)
bladerf_sink_c::set_bandwidth
double set_bandwidth(double bandwidth, size_t chan=0)
bladerf_sink_c::get_antenna
std::string get_antenna(size_t chan=0)
bladerf_sink_c::get_gain_mode
bool get_gain_mode(size_t chan=0)
bladerf_sink_c::set_center_freq
double set_center_freq(double freq, size_t chan=0)
bladerf_sink_c::make_bladerf_sink_c
friend bladerf_sink_c_sptr make_bladerf_sink_c(const std::string &args)
Return a shared_ptr to a new instance of bladerf_sink_c.
bladerf_sink_c::start
bool start()
bladerf_sink_c::set_antenna
std::string set_antenna(const std::string &antenna, size_t chan=0)
bladerf_sink_c::get_center_freq
double get_center_freq(size_t chan=0)
bladerf_sink_c::get_freq_range
osmosdr::freq_range_t get_freq_range(size_t chan=0)
bladerf_sink_c::set_iq_balance
void set_iq_balance(const std::complex< double > &balance, size_t chan)
sink_iface
Definition: sink_iface.h:33
ranges.h
sink_iface.h
osmosdr::meta_range_t
Definition: ranges.h:75