GNU Radio's OsmoSDR Package
bladerf_sink_c.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2013 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/thread/thread.h>
25 #include <gnuradio/block.h>
26 #include <gnuradio/sync_block.h>
27 
28 #include "osmosdr/ranges.h"
29 #include "sink_iface.h"
30 #include "bladerf_common.h"
31 
32 class bladerf_sink_c;
33 
34 /*
35  * We use boost::shared_ptr's instead of raw pointers for all access
36  * to gr_blocks (and many other data structures). The shared_ptr gets
37  * us transparent reference counting, which greatly simplifies storage
38  * management issues. This is especially helpful in our hybrid
39  * C++ / Python system.
40  *
41  * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
42  *
43  * As a convention, the _sptr suffix indicates a boost::shared_ptr
44  */
45 typedef boost::shared_ptr<bladerf_sink_c> bladerf_sink_c_sptr;
46 
47 /*!
48  * \brief Return a shared_ptr to a new instance of bladerf_sink_c.
49  *
50  * To avoid accidental use of raw pointers, bladerf_sink_c's
51  * constructor is private. make_bladerf_sink_c is the public
52  * interface for creating new instances.
53  */
54 bladerf_sink_c_sptr make_bladerf_sink_c (const std::string & args = "");
55 
57  public gr::sync_block,
58  public sink_iface,
59  protected bladerf_common
60 {
61 private:
62  // The friend declaration allows bladerf_make_sink_c to
63  // access the private constructor.
64  friend bladerf_sink_c_sptr make_bladerf_sink_c (const std::string & args);
65 
66  bladerf_sink_c (const std::string & args); // private constructor
67 
68 public:
69  ~bladerf_sink_c (); // public destructor
70 
71  int work( int noutput_items,
72  gr_vector_const_void_star &input_items,
73  gr_vector_void_star &output_items );
74 
75  static std::vector< std::string > get_devices();
76 
77  size_t get_num_channels( void );
78 
80  double set_sample_rate( double rate );
81  double get_sample_rate( void );
82 
83  osmosdr::freq_range_t get_freq_range( size_t chan = 0 );
84  double set_center_freq( double freq, size_t chan = 0 );
85  double get_center_freq( size_t chan = 0 );
86  double set_freq_corr( double ppm, size_t chan = 0 );
87  double get_freq_corr( size_t chan = 0 );
88 
89  std::vector<std::string> get_gain_names( size_t chan = 0 );
90  osmosdr::gain_range_t get_gain_range( size_t chan = 0 );
91  osmosdr::gain_range_t get_gain_range( const std::string & name, size_t chan = 0 );
92  bool set_gain_mode( bool automatic, size_t chan = 0 );
93  bool get_gain_mode( size_t chan = 0 );
94  double set_gain( double gain, size_t chan = 0 );
95  double set_gain( double gain, const std::string & name, size_t chan = 0 );
96  double get_gain( size_t chan = 0 );
97  double get_gain( const std::string & name, size_t chan = 0 );
98 
99  double set_bb_gain( double gain, size_t chan = 0 );
100 
101  std::vector< std::string > get_antennas( size_t chan = 0 );
102  std::string set_antenna( const std::string & antenna, size_t chan = 0 );
103  std::string get_antenna( size_t chan = 0 );
104 
105  double set_bandwidth( double bandwidth, size_t chan = 0 );
106  double get_bandwidth( size_t chan = 0 );
107  osmosdr::freq_range_t get_bandwidth_range( size_t chan = 0 );
108 
109 private: /* functions */
110  static void *stream_callback( struct bladerf *_dev,
111  struct bladerf_stream *stream,
112  struct bladerf_metadata *metadata,
113  void *samples,
114  size_t num_samples,
115  void *user_data );
116 
117  void *get_next_buffer(void *samples, size_t num_samples);
118 
119  void write_task();
120 
121 private: /* members */
122 
123  /* Array denoting whether each buffer is filled with data and ready to TX */
124  bool *_filled;
125 
126  /* Acquire while updating _filled, and signalling/waiting on
127  * _buffer_emptied and _buffer_filled */
128  boost::mutex _buf_status_lock;
129 
130  /* work() may block waiting for the stream callback to empty (consume) a
131  * buffer. The callback uses this to signal when it has emptied a buffer. */
132  boost::condition_variable _buffer_emptied;
133 
134  /* The stream callback may block waiting for work() to fill (produce) a
135  * buffer. work() uses this to signal that it has filled a buffer. */
136  boost::condition_variable _buffer_filled;
137 
138  /* These values are only to be updated and accessed from within work() */
139  int16_t *_next_value; /* I/Q value insertion point in current buffer */
140  size_t _samples_left; /* # of samples left to fill in our current buffer */
141 
142  /* This should only be accessed and updated from TX callbacks */
143  size_t _next_to_tx; /* Next buffer to transmit */
144 };
145 
146 #endif /* INCLUDED_BLADERF_SINK_C_H */
bool set_gain_mode(bool automatic, size_t chan=0)
std::vector< std::string > get_antennas(size_t chan=0)
double set_bb_gain(double gain, size_t chan=0)
bladerf_sink_c_sptr make_bladerf_sink_c(const std::string &args="")
Return a shared_ptr to a new instance of bladerf_sink_c.
double set_bandwidth(double bandwidth, size_t chan=0)
double get_bandwidth(size_t chan=0)
osmosdr::freq_range_t get_bandwidth_range(size_t chan=0)
double set_freq_corr(double ppm, size_t chan=0)
osmosdr::gain_range_t get_gain_range(size_t chan=0)
std::vector< std::string > get_gain_names(size_t chan=0)
Definition: ranges.h:69
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
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.
Definition: sink_iface.h:31
static std::vector< std::string > get_devices()
double set_gain(double gain, size_t chan=0)
bool get_gain_mode(size_t chan=0)
osmosdr::freq_range_t get_freq_range(size_t chan=0)
Definition: bladerf_sink_c.h:56
std::string set_antenna(const std::string &antenna, size_t chan=0)
Definition: bladerf_common.h:48
std::string get_antenna(size_t chan=0)
double set_center_freq(double freq, size_t chan=0)
double get_center_freq(size_t chan=0)
double get_gain(size_t chan=0)
size_t get_num_channels(void)
bladerf_sptr _dev
Definition: bladerf_common.h:67
osmosdr::meta_range_t get_sample_rates(void)
double get_freq_corr(size_t chan=0)
double get_sample_rate(void)
double set_sample_rate(double rate)