-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathbladeRF_MIMO_Simulink.m
611 lines (511 loc) · 22.3 KB
/
bladeRF_MIMO_Simulink.m
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
% This class implements a bladeRF MATLAB System Simulink block.
%
% The bladeRF_Simulink block interfaces with a single bladeRF device and is
% capable of utilizing both the transmit and receive paths on the device. The
% block properties may be used to enable and use RX, TX, or both.
%
% To use this block, place a "MATLAB System" block in your Simulink Model and
% specify "bladeRF_Simulink" for the system object name.
%
% Next, configure the device by double clicking on the block. Here, a few
% groups of settings are presented:
% * Device Device selection and device-wide settings
% * RX Configuration RX-specific settings
% * TX Configuration TX-specific settings
% * Miscellaneous Other library-specific options
%
% Currently only "Interpreted Execution" is supported. Be sure to select
% this in the first tab.
%
% In the "Device" tab, the "Device Specification String" allows one to specify
% which device to use if multiple bladeRFs are connected. For example, to use
% a device with a serial number starting with a3f..., a valid device
% specification string would be:
%
% "*:serial=a3f"
%
% Alternatively, one can specify the "Nth" device if the block<->device
% assignments do not matter. For two devices, one could use:
% "*:instance=0" and "*:instance=1"
%
% If left blank, this string will select the first available device.
%
% To enable the receive output port, check the "Enable Receiver" checkbox in
% the "RX Configuration" tab. Similarly to enable the transmit input port,
% check the "Enable Transmitter" checkbox in the "TX Configuration" tab.
%
% See also: bladeRF
% Copyright (c) 2015 Nuand LLC
%
% Permission is hereby granted, free of charge, to any person obtaining a copy
% of this software and associated documentation files (the "Software"), to deal
% in the Software without restriction, including without limitation the rights
% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
% copies of the Software, and to permit persons to whom the Software is
% furnished to do so, subject to the following conditions:
%
% The above copyright notice and this permission notice shall be included in
% all copies or substantial portions of the Software.
%
% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
% THE SOFTWARE.
%
classdef bladeRF_MIMO_Simulink < matlab.System & ...
matlab.system.mixin.Propagates & ...
matlab.system.mixin.CustomIcon
%% Properties
properties
verbosity = 'Info' % libbladeRF verbosity
rx_frequency = 890e6; % Frequency (Hz)
rx_gain = [60 60]; % RX Gain [-10, 90]
rx_agc = 'SLOW'; % AGC mode
tx_frequency = 890e6; % Frequency (Hz)
tx_gain = [60 60]; % TX Gain [-10, 60]
end
properties(Nontunable)
device_string = ''; % Device specification string
loopback_mode = 'None' % Active loopback mode
rx_bandwidth = '1.5'; % LPF Bandwidth (MHz)
rx_samplerate = 1e6; % Sample rate
rx_num_buffers = 64; % Number of stream buffers to use
rx_num_transfers = 16; % Number of USB transfers to use
rx_buf_size = 1024*10; % Size of each stream buffer, in samples (must be multiple of 1024)
rx_step_size = 10000; % Number of samples to RX during each simulation step
rx_timeout_ms = 5000; % Stream timeout (ms)
tx_bandwidth = '1.5'; % LPF Bandwidth (MHz)
tx_samplerate = 1e6; % Sample rate
tx_num_buffers = 64; % Number of stream buffers to use
tx_num_transfers = 16; % Number of USB transfers to use
tx_buf_size = 16384; % Size of each stream buffer, in samples (must be multiple of 1024)
tx_step_size = 1024*10; % Number of samples to TX during each simulation step
tx_timeout_ms = 5000; % Stream timeout (ms)
end
properties(Logical, Nontunable)
enable_rx = true; % Enable Receiver
enable_rx_biastee = false; % Enable RX Biastee
enable_overrun = false; % Enable Overrun output
enable_tx = true; % Enable Transmitter
enable_tx_biastee = false; % Enable TX Biastee
enable_underrun = false; % Enable Underrun output (for future use)
xb200 = false % Enable use of XB-200 (must be attached)
end
properties(Hidden, Transient)
rx_bandwidthSet = matlab.system.StringSet({ ...
'1.5', '1.75', '2.5', '2.75', ...
'3', '3.84', '5', '5.5', ...
'6', '7', '8.75', '10', ...
'12', '14', '20', '28', ...
'30', '32', '34', '36', ...
'38', '40', '42', '44', ...
'46', '48', '50', '52', ...
'54', '56', '58', '60', ...
'62', '64', '64.11' ...
});
tx_bandwidthSet = matlab.system.StringSet({ ...
'1.5', '1.75', '2.5', '2.75', ...
'3', '3.84', '5', '5.5', ...
'6', '7', '8.75', '10', ...
'12', '14', '20', '28', ...
'30', '32', '34', '36', ...
'38', '40', '42', '44', ...
'46', '48', '50', '52', ...
'54', '56', '58', '60', ...
'62', '64', '64.11' ...
});
rx_agcSet = matlab.system.StringSet({
'AUTO', 'MANUAL', ...
'SLOW', 'FAST', 'HYBRID' ...
});
loopback_modeSet = matlab.system.StringSet({
'None', ...
'BB_TXLPF_RXVGA2', 'BB_TXVGA1_RXVGA2', 'BB_TXLPF_RXLPF', ...
'BB_TXVGA1_RXLPF', 'RF_LNA1', 'RF_LNA2', 'RF_LNA3', ...
'Firmware'
});
verbositySet = matlab.system.StringSet({
'Verbose', 'Debug', 'Info', 'Warning', 'Critical', 'Silent' ...
});
end
properties (Access = private)
device = []
% Cache previously set tunable values to avoid querying the device
% for all properties when only one changes.
curr_rx_frequency
curr_rx_lna
curr_rx_vga1
curr_rx_vga2
curr_rx_gain
curr_rx_agc
curr_rx_biastee
curr_tx_frequency
curr_tx_vga1
curr_tx_vga2
curr_tx_gain
curr_tx_biastee
end
%% Static Methods
methods (Static, Access = protected)
function groups = getPropertyGroupsImpl
device_section_group = matlab.system.display.SectionGroup(...
'Title', 'Device', ...
'PropertyList', {'device_string', 'loopback_mode', 'xb200' } ...
);
rx_gain_section = matlab.system.display.Section(...
'Title', 'Gain', ...
'PropertyList', { 'rx_gain', 'enable_rx_biastee', 'rx_agc' } ...
);
rx_stream_section = matlab.system.display.Section(...
'Title', 'Stream', ...
'PropertyList', {'rx_num_buffers', 'rx_num_transfers', 'rx_buf_size', 'rx_timeout_ms', 'rx_step_size', } ...
);
rx_section_group = matlab.system.display.SectionGroup(...
'Title', 'RX Configuration', ...
'PropertyList', { 'enable_rx', 'enable_overrun', 'rx_frequency', 'rx_samplerate', 'rx_bandwidth' }, ...
'Sections', [ rx_gain_section, rx_stream_section ] ...
);
tx_gain_section = matlab.system.display.Section(...
'Title', 'Gain', ...
'PropertyList', { 'tx_gain', 'enable_tx_biastee' } ...
);
tx_stream_section = matlab.system.display.Section(...
'Title', 'Stream', ...
'PropertyList', {'tx_num_buffers', 'tx_num_transfers', 'tx_buf_size', 'tx_timeout_ms', 'tx_step_size', } ...
);
tx_section_group = matlab.system.display.SectionGroup(...
'Title', 'TX Configuration', ...
'PropertyList', { 'enable_tx', 'enable_underrun', 'tx_frequency', 'tx_samplerate', 'tx_bandwidth' }, ...
'Sections', [ tx_gain_section, tx_stream_section ] ...
);
misc_section_group = matlab.system.display.SectionGroup(...
'Title', 'Miscellaneous', ...
'PropertyList', {'verbosity'} ...
);
groups = [ device_section_group, rx_section_group, tx_section_group, misc_section_group ];
end
function header = getHeaderImpl
text = 'This block provides access to a Nuand bladeRF device via libbladeRF MATLAB bindings.';
header = matlab.system.display.Header('bladeRF_Simulink', ...
'Title', 'bladeRF', 'Text', text ...
);
end
end
methods (Access = protected)
%% Output setup
function count = getNumOutputsImpl(obj)
if obj.enable_rx == true
if obj.enable_overrun == true
count = 2;
else
count = 1;
end
else
count = 0;
end
if obj.enable_tx == true && obj.enable_underrun == true
count = count + 1;
end
end
function varargout = getOutputNamesImpl(obj)
if obj.enable_rx == true
varargout{1} = 'RX Samples';
n = 2;
if obj.enable_overrun == true
varargout{n} = 'RX Overrun';
n = n + 1;
end
else
n = 1;
end
if obj.enable_tx == true && obj.enable_underrun == true
varargout{n} = 'TX Underrun';
end
end
function varargout = getOutputDataTypeImpl(obj)
if obj.enable_rx == true
varargout{1} = 'double'; % RX Samples
n = 2;
if obj.enable_overrun == true
varargout{n} = 'logical'; % RX Overrun
n = n + 1;
end
else
n = 1;
end
if obj.enable_tx == true && obj.enable_underrun == true
varargout{n} = 'logical'; % TX Underrun
end
end
function varargout = getOutputSizeImpl(obj)
if obj.enable_rx == true
varargout{1} = [obj.rx_step_size 2]; % RX Samples
n = 2;
if obj.enable_overrun == true
varargout{n} = [1 1]; % RX Overrun
n = n + 1;
end
else
n = 1;
end
if obj.enable_tx == true && obj.enable_underrun == true
varargout{n} = [1 1]; % TX Underrun
end
end
function varargout = isOutputComplexImpl(obj)
if obj.enable_rx == true
varargout{1} = true; % RX Samples
n = 2;
else
n = 1;
end
if obj.enable_overrun == true
varargout{n} = false; % RX Overrun
n = n + 1;
end
if obj.enable_tx == true && obj.enable_underrun == true
varargout{n} = false; % TX Underrun
end
end
function varargout = isOutputFixedSizeImpl(obj)
if obj.enable_rx == true
varargout{1} = true; % RX Samples
varargout{2} = true; % RX Overrun
n = 3;
else
n = 1;
end
if obj.enable_overrun == true
end
if obj.enable_tx == true && obj.enable_underrun == true
varargout{n} = true; % TX Underrun
end
end
%% Input setup
function count = getNumInputsImpl(obj)
if obj.enable_tx == true
count = 1;
else
count = 0;
end
end
function varargout = getInputNamesImpl(obj)
if obj.enable_tx == true
varargout{1} = 'TX Samples';
else
varargout = {};
end
end
%% Property and Execution Handlers
function icon = getIconImpl(~)
icon = sprintf('Nuand\nbladeRF 2.0\nMIMO');
end
function setupImpl(obj)
%% Library setup
bladeRF_MIMO.log_level(obj.verbosity);
%% Device setup
if obj.xb200 == true
xb = 'XB200';
else
xb = [];
end
obj.device = bladeRF_MIMO(obj.device_string, [], xb);
obj.device.loopback = obj.loopback_mode;
%% RX Setup
obj.device.rx.config.num_buffers = obj.rx_num_buffers;
obj.device.rx.config.buffer_size = obj.rx_buf_size;
obj.device.rx.config.num_transfers = obj.rx_num_transfers;
obj.device.rx.config.timeout_ms = obj.rx_timeout_ms;
obj.device.rx.frequency = obj.rx_frequency;
%obj.rx_frequency = obj.device.rx.frequency;
obj.curr_rx_frequency = obj.device.rx.frequency;
obj.device.rx.samplerate = obj.rx_samplerate;
obj.device.rx.bandwidth = str2double(obj.rx_bandwidth) * 1e6;
obj.device.rx.biastee = obj.enable_rx_biastee;
obj.curr_rx_biastee = obj.device.rx.biastee;
obj.device.rx.agc = obj.rx_agc;
%obj.rx_agc = obj.device.rx.agc;
obj.curr_rx_agc = obj.device.rx.agc;
if strcmpi(obj.curr_rx_agc, 'manual')
obj.device.rx.gain = obj.rx_gain;
%obj.rx_gain = obj.device.rx.gain;
obj.curr_rx_gain = obj.device.rx.gain;
else
warning([ 'Cannot set RX gain because AGC is set to ' (obj.curr_rx_agc) ' mode'])
end
%% TX Setup
obj.device.tx.config.num_buffers = obj.tx_num_buffers;
obj.device.tx.config.buffer_size = obj.tx_buf_size;
obj.device.tx.config.num_transfers = obj.tx_num_transfers;
obj.device.tx.config.timeout_ms = obj.tx_timeout_ms;
obj.device.tx.samplerate = obj.tx_samplerate;
obj.device.tx.bandwidth = str2double(obj.tx_bandwidth) * 1e6;
obj.device.tx.frequency = obj.tx_frequency;
%obj.tx_frequency = obj.device.tx.frequency;
obj.curr_tx_frequency = obj.device.tx.frequency;
obj.device.tx.biastee = obj.enable_tx_biastee;
obj.curr_tx_biastee = obj.device.tx.biastee;
obj.device.tx.gain = obj.tx_gain;
%obj.tx_gain = obj.device.tx.gain;
obj.curr_tx_gain = obj.device.tx.gain;
end
function releaseImpl(obj)
delete(obj.device);
end
function resetImpl(obj)
obj.device.rx.stop();
obj.device.tx.stop();
end
% Perform a read of received samples and an 'overrun' array that denotes whether
% the associated samples is invalid due to a detected overrun.
function varargout = stepImpl(obj, varargin)
varargout = {};
if obj.enable_rx == true
if obj.device.rx.running == false
obj.device.rx.start();
end
[rx_samples, ~, ~, rx_overrun] = obj.device.receive(obj.rx_step_size, obj.rx_timeout_ms);
varargout{1} = rx_samples;
varargout{2} = rx_overrun;
out_idx = 3;
else
out_idx = 1;
end
if obj.enable_tx == true
if obj.device.tx.running == false
obj.device.tx.start();
end
obj.device.transmit(varargin{1});
% Detecting TX Underrun is not yet supported by libbladeRF.
% This is for future use.
varargout{out_idx} = false;
else
if obj.device.tx.running
obj.device.tx.stop();
end
end
end
function processTunedPropertiesImpl(obj)
%% RX Properties
if isChangedProperty(obj, 'rx_frequency') && obj.rx_frequency ~= obj.curr_rx_frequency
obj.device.rx.frequency = obj.rx_frequency;
%obj.rx_frequency = obj.device.rx.frequency;
obj.curr_rx_frequency = obj.device.rx.frequency;
%disp('Updated RX frequency');
end
if isChangedProperty(obj, 'rx_gain') && obj.rx_gain ~= obj.curr_rx_gain
obj.device.rx.gain = obj.rx_gain;
%obj.rx_gain = obj.device.rx.gain;
obj.curr_rx_gain = obj.device.rx.gain;
%disp('Updated RX gain');
end
if isChangedProperty(obj, 'rx_agc') && obj.rx_agc ~= obj.curr_rx_agc
obj.device.rx.agc = obj.rx_agc;
%obj.rx_agc = obj.device.rx.agc;
obj.curr_rx_agc = obj.device.rx.agc;
%disp('Updated RX AGC gain');
end
%% TX Properties
if isChangedProperty(obj, 'tx_frequency') && obj.tx_frequency ~= obj.curr_tx_frequency
obj.device.tx.frequency = obj.tx_frequency;
obj.curr_tx_frequency = obj.device.rx.frequency;
%disp('Updated TX frequency');
end
if isChangedProperty(obj, 'tx_gain') && obj.tx_gain ~= obj.curr_tx_gain
obj.device.tx.gain = obj.tx_gain;
obj.curr_tx_gain = obj.device.tx.gain;
%disp('Updated TX gain');
end
end
function validatePropertiesImpl(obj)
if obj.enable_rx == false && obj.enable_tx == false
warning('Neither bladeRF RX or TX is enabled. One or both should be enabled.');
end
if isempty(obj.device)
tx_min_freq = 0;
tx_max_freq = 0;
tx_min_sampling = 0;
tx_max_sampling = 0;
rx_min_freq = 0;
rx_max_freq = 0;
rx_min_sampling = 0;
rx_max_sampling = 0;
return
else
tx_min_freq = obj.device.tx.min_frequency;
tx_max_freq = obj.device.tx.max_frequency;
tx_min_sampling = obj.device.tx.min_sampling;
tx_max_sampling = obj.device.tx.max_sampling;
rx_min_freq = obj.device.rx.min_frequency;
rx_max_freq = obj.device.rx.max_frequency;
rx_min_sampling = obj.device.rx.min_sampling;
rx_max_sampling = obj.device.rx.max_sampling;
end
%% Validate RX properties
if obj.rx_num_buffers < 1
error('rx_num_buffers must be > 0.');
end
if obj.rx_num_transfers >= obj.rx_num_buffers
error('rx_num_transfers must be < rx_num_buffers.');
end
if obj.rx_buf_size < 1024 || mod(obj.rx_buf_size, 1024) ~= 0
error('rx_buf_size must be a multiple of 1024.');
end
if obj.rx_timeout_ms < 0
error('rx_timeout_ms must be >= 0.');
end
if obj.rx_step_size <= 0
error('rx_step_size must be > 0.');
end
if obj.rx_samplerate < rx_min_sampling
error(['rx_samplerate must be >= ' (num2str(rx_min_sampling)/1e6) ' MHz.']);
elseif obj.rx_samplerate > 40e6
error(['rx_samplerate must be <= ' (num2str(rx_max_sampling)/1e6) ' MHz.']);
end
if obj.rx_frequency < rx_min_freq
error(['rx_frequency must be >= ' (num2str(rx_min_freq)/1e6) ' MHz.']);
elseif obj.rx_frequency > rx_max_freq
error(['rx_frequency must be <= ' (num2str(rx_max_freq)/1e6) ' MHz.']);
end
if length(obj.rx_gain) ~= 2
error ('Gain must be a 2-element array.')
elseif max(obj.rx_gain) > 90 || min(obj.rx_gain) < -10
error('Invalid Gain value. Must be between -10 and 90.')
end
%% Validate TX Properties
if obj.tx_num_buffers < 1
error('tx_num_buffers must be > 0.');
end
if obj.tx_num_transfers >= obj.tx_num_buffers
error('tx_num_transfers must be < tx_num_transfers');
end
if obj.tx_buf_size < 1024 || mod(obj.tx_buf_size, 1024) ~= 0
error('tx_buf_size must be a multiple of 1024.');
end
if obj.tx_timeout_ms < 0
error('tx_timeout_ms must be >= 0.');
end
if obj.tx_step_size <= 0
error('tx_step_size must be > 0.');
end
if obj.tx_samplerate < 160.0e3
error('tx_samplerate must be >= 160 kHz.');
elseif obj.tx_samplerate > 40e6
error('tx_samplerate must be <= 40 MHz.')
end
if obj.tx_frequency < tx_min_freq
error(['tx_frequency must be >= ' num2str(tx_min_freq) '.']);
elseif obj.tx_frequency > 3.8e9
error('tx_frequency must be <= 3.8 GHz.');
end
if length(obj.tx_gain) ~= 2
error ('Gain must be a 2-element array.')
elseif max(obj.tx_gain) > 60 || min(obj.rx_gain) < -10
error('Invalid Gain value. Must be between -10 and 60.')
end
end
end
end