aboutsummaryrefslogtreecommitdiffstats
path: root/gr-iio/include/gnuradio/iio/fmcomms5_source.h
blob: 0bcac4d647488d028e597657c9332d5165082c19 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
/* -*- c++ -*- */
/*
 * Copyright 2014 Analog Devices Inc.
 * Author: Paul Cercueil <paul.cercueil@analog.com>
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */


#ifndef INCLUDED_IIO_FMCOMMS5_SOURCE_H
#define INCLUDED_IIO_FMCOMMS5_SOURCE_H

#include <gnuradio/hier_block2.h>
#include <gnuradio/iio/api.h>
#include <gnuradio/sync_block.h>

#include "device_source.h"

namespace gr {
namespace iio {

/*!
 * \brief Device specific source for the FMComms5 evaluation card
 * \ingroup iio
 *
 * \details
 * This block is a source specifically designed for FMComms5 evaluation
 * card. The FMComms5 is a dual AD9361 FMC card which enables 4x4
 * applications.
 */
class IIO_API fmcomms5_source : virtual public gr::sync_block
{
public:
    typedef std::shared_ptr<fmcomms5_source> sptr;

    /*!
     * \brief Return a shared_ptr to a new instance of iio::device.
     *
     * \param uri  String of the context uri
     * \param frequency1  Long long of LO frequency in Hz of chip A
     * \param frequency2  Long long of LO frequency in Hz of chip A
     * \param samplerate  Long of sample rate in samples per second
     * \param bandwidth  Long of bandwidth of front-end analog filter  in
     *                   in Hz
     * \param ch1_en  Boolean enable channel 1
     * \param ch2_en  Boolean enable channel 2
     * \param ch3_en  Boolean enable channel 3
     * \param ch4_en  Boolean enable channel 4
     * \param ch5_en  Boolean enable channel 5
     * \param ch6_en  Boolean enable channel 6
     * \param ch7_en  Boolean enable channel 7
     * \param ch8_en  Boolean enable channel 8
     * \param quadrature  Boolean enable RX quadrature tracking
     * \param rfdc  Boolean enable RX RF DC tracking
     * \param bbdc  Boolean enable RX Baseband DC tracking
     * \param buffer_size  Long of number of samples in buffer to send to device
     * \param rf_port_select  String of name of port to use for TX output mux
     *        with options:
     *        - 'A_BALANCED'
     *        - 'B_BALANCED'
     *        - 'C_BALANCED'
     *        - 'A_N'
     *        - 'A_P'
     *        - 'B_N'
     *        - 'B_P'
     *        - 'C_N'
     *        - 'C_P'
     *        - 'TX_MONITOR1'
     *        - 'TX_MONITOR2'
     *        - 'TX_MONITOR1_2'
     * \param gain1  String of gain mode for channel 1 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain1_value  Double of RX channel 1 gain in dB [0, 76]
     * \param gain2  String of gain mode for channel 2 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain2_value  Double of RX channel 2 gain in dB [0, 76]
     * \param gain3  String of gain mode for channel 3 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain3_value  Double of RX channel 3 gain in dB [0, 76]
     * \param gain4  String of gain mode for channel 4 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain4_value  Double of RX channel 4 gain in dB [0, 76]
     * \param filter_source  String which selects filter configuration with
     *        options:
     *        - 'Off': Disable filter
     *        - 'Auto': Use auto-generated filters
     *        - 'File': Use provide filter filter in filter_filename input
     *        - 'Design': Create filter from Fpass, Fstop, samplerate, and
     *                  bandwidth parameters
     * \param filter_filename  String of path to filter file
     * \param Fpass Float of edge of passband frequency in Hz for designed FIR
     * \param Fstop Float of edge of stopband frequency in Hz for designed FIR
     */
    static sptr make(const std::string& uri,
                     unsigned long long frequency1,
                     unsigned long long frequency2,
                     unsigned long samplerate,
                     unsigned long bandwidth,
                     bool ch1_en,
                     bool ch2_en,
                     bool ch3_en,
                     bool ch4_en,
                     bool ch5_en,
                     bool ch6_en,
                     bool ch7_en,
                     bool ch8_en,
                     unsigned long buffer_size,
                     bool quadrature,
                     bool rfdc,
                     bool bbdc,
                     const char* gain1,
                     double gain1_value,
                     const char* gain2,
                     double gain2_value,
                     const char* gain3,
                     double gain3_value,
                     const char* gain4,
                     double gain4_value,
                     const char* rf_port_select,
                     const char* filter_source = "",
                     const char* filter_filename = "",
                     float Fpass = 0.0,
                     float Fstop = 0.0);

    static sptr make_from(iio_context* ctx,
                          unsigned long long frequency1,
                          unsigned long long frequency2,
                          unsigned long samplerate,
                          unsigned long bandwidth,
                          bool ch1_en,
                          bool ch2_en,
                          bool ch3_en,
                          bool ch4_en,
                          bool ch5_en,
                          bool ch6_en,
                          bool ch7_en,
                          bool ch8_en,
                          unsigned long buffer_size,
                          bool quadrature,
                          bool rfdc,
                          bool bbdc,
                          const char* gain1,
                          double gain1_value,
                          const char* gain2,
                          double gain2_value,
                          const char* gain3,
                          double gain3_value,
                          const char* gain4,
                          double gain4_value,
                          const char* rf_port_select,
                          const char* filter_source = "",
                          const char* filter_filename = "",
                          float Fpass = 0.0,
                          float Fstop = 0.0);

    virtual void set_params(unsigned long long frequency1,
                            unsigned long long frequency2,
                            unsigned long samplerate,
                            unsigned long bandwidth,
                            bool quadrature,
                            bool rfdc,
                            bool bbdc,
                            const char* gain1,
                            double gain1_value,
                            const char* gain2,
                            double gain2_value,
                            const char* gain3,
                            double gain3_value,
                            const char* gain4,
                            double gain4_value,
                            const char* rf_port_select,
                            const char* filter_source,
                            const char* filter_filename,
                            float Fpass,
                            float Fstop) = 0;
};

/*!
 * \brief Device specific source for the FMComms5 evaluation card
 * \ingroup iio
 *
 * \details
 * This block is a source specifically designed for FMComms5 evaluation
 * card. The FMComms5 is a dual AD9361 FMC card which enables 4x4
 * applications.
 */
class IIO_API fmcomms5_source_f32c : virtual public gr::hier_block2
{
public:
    typedef std::shared_ptr<fmcomms5_source_f32c> sptr;

    /*!
     * \brief Return a shared_ptr to a new instance of iio::device.
     *
     * \param uri  String of the context uri
     * \param frequency1  Long long of LO frequency in Hz of chip A
     * \param frequency2  Long long of LO frequency in Hz of chip A
     * \param samplerate  Long of sample rate in samples per second
     * \param bandwidth  Long of bandwidth of front-end analog filter  in
     *                   in Hz
     * \param rx1_en  Boolean enable channel 1
     * \param rx2_en  Boolean enable channel 2
     * \param rx3_en  Boolean enable channel 3
     * \param rx4_en  Boolean enable channel 4
     * \param quadrature  Boolean enable RX quadrature tracking
     * \param rfdc  Boolean enable RX RF DC tracking
     * \param bbdc  Boolean enable RX Baseband DC tracking
     * \param buffer_size  Long of number of samples in buffer to send to device
     * \param rf_port_select  String of name of port to use for TX output mux
     *        with options:
     *        - 'A_BALANCED'
     *        - 'B_BALANCED'
     *        - 'C_BALANCED'
     *        - 'A_N'
     *        - 'A_P'
     *        - 'B_N'
     *        - 'B_P'
     *        - 'C_N'
     *        - 'C_P'
     *        - 'TX_MONITOR1'
     *        - 'TX_MONITOR2'
     *        - 'TX_MONITOR1_2'
     * \param gain1  String of gain mode for channel 1 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain1_value  Double of RX channel 1 gain in dB [0, 76]
     * \param gain2  String of gain mode for channel 2 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain2_value  Double of RX channel 2 gain in dB [0, 76]
     * \param gain3  String of gain mode for channel 3 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain3_value  Double of RX channel 3 gain in dB [0, 76]
     * \param gain4  String of gain mode for channel 4 with options:
     *        - 'manual'
     *        - 'slow_attack'
     *        - 'fast_attack'
     *        - 'hybrid'
     * \param gain4_value  Double of RX channel 4 gain in dB [0, 76]
     * \param filter_source  String which selects filter configuration with
     *        options:
     *        - 'Off': Disable filter
     *        - 'Auto': Use auto-generated filters
     *        - 'File': Use provide filter filter in filter_filename input
     *        - 'Design': Create filter from Fpass, Fstop, samplerate, and
     *                  bandwidth parameters
     * \param filter_filename  String of path to filter file
     * \param Fpass Float of edge of passband frequency in Hz for designed FIR
     * \param Fstop Float of edge of stopband frequency in Hz for designed FIR
     */
    static sptr make(const std::string& uri,
                     unsigned long long frequency1,
                     unsigned long long frequency2,
                     unsigned long samplerate,
                     unsigned long bandwidth,
                     bool rx1_en,
                     bool rx2_en,
                     bool rx3_en,
                     bool rx4_en,
                     unsigned long buffer_size,
                     bool quadrature,
                     bool rfdc,
                     bool bbdc,
                     const char* gain1,
                     double gain1_value,
                     const char* gain2,
                     double gain2_value,
                     const char* gain3,
                     double gain3_value,
                     const char* gain4,
                     double gain4_value,
                     const char* rf_port_select,
                     const char* filter_source = "",
                     const char* filter_filename = "",
                     float Fpass = 0.0,
                     float Fstop = 0.0)
    {
        fmcomms5_source::sptr block = fmcomms5_source::make(uri,
                                                            frequency1,
                                                            frequency2,
                                                            samplerate,
                                                            bandwidth,
                                                            rx1_en,
                                                            rx1_en,
                                                            rx2_en,
                                                            rx2_en,
                                                            rx3_en,
                                                            rx3_en,
                                                            rx4_en,
                                                            rx4_en,
                                                            buffer_size,
                                                            quadrature,
                                                            rfdc,
                                                            bbdc,
                                                            gain1,
                                                            gain1_value,
                                                            gain2,
                                                            gain2_value,
                                                            gain3,
                                                            gain3_value,
                                                            gain4,
                                                            gain4_value,
                                                            rf_port_select,
                                                            filter_source,
                                                            filter_filename,
                                                            Fpass,
                                                            Fstop);

        return gnuradio::get_initial_sptr(
            new fmcomms5_source_f32c(rx1_en, rx2_en, rx3_en, rx4_en, block));
    }

    void set_params(unsigned long long frequency1,
                    unsigned long long frequency2,
                    unsigned long samplerate,
                    unsigned long bandwidth,
                    bool quadrature,
                    bool rfdc,
                    bool bbdc,
                    const char* gain1,
                    double gain1_value,
                    const char* gain2,
                    double gain2_value,
                    const char* gain3,
                    double gain3_value,
                    const char* gain4,
                    double gain4_value,
                    const char* rf_port_select,
                    const char* filter_source,
                    const char* filter_filename,
                    float Fpass,
                    float Fstop)
    {
        fmcomms5_block->set_params(frequency1,
                                   frequency2,
                                   samplerate,
                                   bandwidth,
                                   quadrature,
                                   rfdc,
                                   bbdc,
                                   gain1,
                                   gain1_value,
                                   gain2,
                                   gain2_value,
                                   gain3,
                                   gain3_value,
                                   gain4,
                                   gain4_value,
                                   rf_port_select,
                                   filter_source,
                                   filter_filename,
                                   Fpass,
                                   Fstop);
    }

private:
    fmcomms5_source::sptr fmcomms5_block;

protected:
    explicit fmcomms5_source_f32c(
        bool rx1_en, bool rx2_en, bool rx3_en, bool rx4_en, fmcomms5_source::sptr block);
};

} // namespace iio
} // namespace gr

#endif /* INCLUDED_IIO_FMCOMMS5_SOURCE_H */