-
Notifications
You must be signed in to change notification settings - Fork 14
/
srsPUSCHdmrsUnittest.m
389 lines (341 loc) · 17 KB
/
srsPUSCHdmrsUnittest.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
%srsPUSCHdmrsUnittest Unit tests for PUSCH DMRS processor functions.
% This class implements unit tests for the PUSCH DMRS processor functions using the
% matlab.unittest framework. The simplest use consists in creating an object with
% testCase = srsPUSCHdmrsUnittest
% and then running all the tests with
% testResults = testCase.run
%
% srsPUSCHdmrsUnittest Properties (Constant):
%
% srsBlock - The tested block (i.e., 'dmrs_pusch_estimator').
% srsBlockType - The type of the tested block, including layer
% (i.e., 'phy/upper/signal_processors').
%
% srsPUSCHdmrsUnittest Properties (ClassSetupParameter):
%
% outputPath - Path to the folder where the test results are stored.
%
% srsPUSCHdmrsUnittest Properties (TestParameter):
%
% numerology - Defines the subcarrier spacing (0, 1).
% NumLayers - Number of transmission layers (1, 2, 4, 8).
% DMRSTypeAPosition - Position of the first DMRS OFDM symbol (2, 3).
% DMRSAdditionalPosition - Maximum number of DMRS additional positions (0, 1, 2, 3).
% DMRSLength - Number of consecutive front-loaded DMRS OFDM symbols (1, 2).
% DMRSConfigurationType - DMRS configuration type (1, 2).
% testLabel - Test label ('dmrs_creation' or 'ch_estimation').
%
% srsPUSCHdmrsUnittest Methods (TestTags = {'testvector'}):
%
% testvectorGenerationCases - Generates a test vector according to the provided
% parameters.
%
% srsPUSCHdmrsUnittest Methods (Access = protected):
%
% addTestIncludesToHeaderFile - Adds include directives to the test header file.
% addTestDefinitionToHeaderFile - Adds details (e.g., type/variable declarations)
% to the test header file.
%
% See also matlab.unittest.
% Copyright 2021-2024 Software Radio Systems Limited
%
% This file is part of srsRAN-matlab.
%
% srsRAN-matlab is free software: you can redistribute it and/or
% modify it under the terms of the BSD 2-Clause License.
%
% srsRAN-matlab is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% BSD 2-Clause License for more details.
%
% A copy of the BSD 2-Clause License can be found in the LICENSE
% file in the top-level directory of this distribution.
classdef srsPUSCHdmrsUnittest < srsTest.srsBlockUnittest
properties (Constant)
%Name of the tested block.
srsBlock = 'dmrs_pusch_estimator'
%Type of the tested block.
srsBlockType = 'phy/upper/signal_processors'
%Valid number of RB that accept transform precoding.
ValidNumPRB = [...
1, 2, 3, 4, 5, 6, 8, 9, 10, 12, 15, 16,...
18, 20, 24, 25, 27, 30, 32, 36, 40, 45, 48, 50,...
54, 60, 64, 72, 75, 80, 81, 90, 96, 100, 108, 120,...
125, 128, 135, 144, 150, 160, 162, 180, 192, 200, 216, 225,...
240, 243, 250, 256, 270]
end
properties (Hidden)
randomizeTestvector
end
properties (ClassSetupParameter)
%Path to results folder (old 'dmrs_pusch_estimator' tests will be erased).
outputPath = {['testPUSCHdmrs', char(datetime('now', 'Format', 'yyyyMMdd''T''HHmmss'))]}
end
properties (TestParameter)
%Defines the subcarrier spacing (0, 1).
numerology = {0, 1}
%Number of transmission layers (1, 2, 4).
NumLayers = {1, 2, 4}
%Position of the first DMRS OFDM symbol (2, 3).
DMRSTypeAPosition = {2, 3}
%Maximum number of DMRS additional positions (0, 1, 2, 3).
DMRSAdditionalPosition = {0, 1, 2, 3}
%Number of consecutive front-loaded DMRS OFDM symbols (1, 2).
DMRSLength = {1, 2}
%DMRS configuration type (1, 2).
DMRSConfigurationType = {1, 2}
%Test label ('dmrs_creation' or 'ch_estimation').
% 'dmrs_creation' tests only check that the DM-RS pilots are generated correctly
% and placed in the correct location in the resource grid.
% 'ch_estimation' also check that the channel is estimated correctly.
testLabel = {'dmrs_creation', 'ch_estimation'}
end
methods (Access = protected)
function addTestIncludesToHeaderFile(~, fileID)
%addTestIncludesToHeaderFile Adds include directives to the test header file.
fprintf(fileID, '#include "../../support/resource_grid_test_doubles.h"\n');
fprintf(fileID, '#include "srsran/phy/upper/signal_processors/dmrs_pusch_estimator.h"\n');
fprintf(fileID, '#include "srsran/support/file_vector.h"\n');
end
function addTestDefinitionToHeaderFile(~, fileID)
%addTestDetailsToHeaderFile Adds details (e.g., type/variable declarations) to the test header file.
fprintf(fileID, 'enum class test_label {dmrs_creation, ch_estimation};\n\n');
fprintf(fileID, 'struct test_case_t {\n');
fprintf(fileID, ' test_label label;\n');
fprintf(fileID, ' dmrs_pusch_estimator::configuration config;\n');
fprintf(fileID, ' float est_noise_var;\n');
fprintf(fileID, ' float est_rsrp;\n');
fprintf(fileID, ' file_vector<resource_grid_reader_spy::expected_entry_t> rx_symbols;\n');
fprintf(fileID, ' file_vector<resource_grid_reader_spy::expected_entry_t> ch_estimates;\n');
fprintf(fileID, '};\n');
end
function initializeClassImpl(obj)
obj.randomizeTestvector = randperm(1008);
end
end % of methods (Access = protected)
methods (Test, TestTags = {'testvector'})
function testvectorGenerationCases(testCase, numerology, NumLayers, ...
DMRSTypeAPosition, DMRSAdditionalPosition, DMRSLength, ...
DMRSConfigurationType, testLabel)
%testvectorGenerationCases Generates a test vector for the given numerology,
% NumLayers, DMRSTypeAPosition, DMRSAdditionalPosition, DMRSLength,
% DMRSConfigurationType and testLabel. NCellID, NSlot and PRB are randomly generated.
import srsTest.helpers.cellarray2str
import srsLib.phy.upper.signal_processors.srsPUSCHdmrs
import srsLib.phy.upper.signal_processors.srsChannelEstimator
import srsLib.ran.utils.scs2cps
import srsTest.helpers.approxbf16
import srsTest.helpers.cellarray2str
import srsTest.helpers.writeResourceGridEntryFile
import srsTest.helpers.symbolAllocationMask2string
import srsTest.helpers.RBallocationMask2string
% Skip those invalid configuration cases.
isDMRSLengthOK = (DMRSLength == 1 || DMRSAdditionalPosition < 2);
isChEstimationOK = strcmp(testLabel, 'dmrs_creation') || (NumLayers == 1);
if ~(isDMRSLengthOK && isChEstimationOK)
return;
end
% Generate a unique test ID.
testID = testCase.generateTestID;
% Limit the resource grid size.
nSizeGrid = 275;
% Use a unique NCellID, NSlot, scrambling ID and PRB allocation for each test.
nCellID = testCase.randomizeTestvector(testID + 1) - 1;
if numerology == 0
nSlot = randi([0, 9]);
else
nSlot = randi([0, 19]);
end
NSCID = randi([0, 1]);
% Select a random PRB allocation.
NumPRB = testCase.ValidNumPRB(randi([1, numel(testCase.ValidNumPRB)]));
PRBstart = randi([0, nSizeGrid - NumPRB]);
PRBend = PRBstart + NumPRB - 1;
% Current fixed parameter values (e.g., number of CDM groups without data).
nStartGrid = 0;
nFrame = 0;
cyclicPrefix = 'normal';
RNTI = 0;
nStartBWP = 0;
nSizeBWP = nSizeGrid;
NIDNSCID = nCellID;
nID = nCellID;
NRSID = nCellID;
modulation = '16QAM';
mappingType = 'A';
symbolAllocation = [1 13];
PRBSet = PRBstart:PRBend;
amplitude = sqrt(2);
PUSCHports = 0:(NumLayers-1);
% Select randomly transform precoding if only one layer and
% configuration type 1.
transformPrecoding = 0;
if (NumLayers == 1) && (DMRSConfigurationType == 1)
transformPrecoding = randi([0, 1]);
end
% Configure the carrier according to the test parameters.
subcarrierSpacing = 15 * (2 .^ numerology);
carrier = nrCarrierConfig( ...
NCellID=nCellID, ...
SubcarrierSpacing=subcarrierSpacing, ...
NSizeGrid=nSizeGrid, ...
NStartGrid=nStartGrid, ...
NSlot=nSlot, ...
NFrame=nFrame, ...
CyclicPrefix=cyclicPrefix ...
);
% Configure the PUSCH DM-RS symbols according to the test parameters.
DMRS = nrPUSCHDMRSConfig( ...
DMRSConfigurationType=DMRSConfigurationType, ...
DMRSTypeAPosition=DMRSTypeAPosition, ...
DMRSAdditionalPosition=DMRSAdditionalPosition, ...
DMRSLength=DMRSLength, ...
NIDNSCID=NIDNSCID, ...
NSCID=NSCID, ...
NRSID=NRSID ...
);
% Configure the PUSCH according to the test parameters.
pusch = nrPUSCHConfig( ...
DMRS=DMRS, ...
NStartBWP=nStartBWP, ...
NSizeBWP=nSizeBWP, ...
NID=nID, ...
RNTI=RNTI, ...
Modulation=modulation, ...
NumLayers=NumLayers, ...
MappingType=mappingType, ...
SymbolAllocation=symbolAllocation, ...
PRBSet=PRBSet, ...
TransformPrecoding=transformPrecoding ...
);
% Call the PUSCH DM-RS symbol processor MATLAB functions.
[DMRSsymbols, symbolIndices] = srsPUSCHdmrs(carrier, pusch);
% If 'dmrs-creation' test, write each complex symbol and their
% associated indices into a binary file, and an empty channel
% coefficients file.
if strcmp(testLabel, 'dmrs_creation')
testCase.saveDataFile('_test_output', testID, ...
@writeResourceGridEntryFile, DMRSsymbols * amplitude, symbolIndices);
testCase.saveDataFile('_ch_estimates', testID, ...
@writeResourceGridEntryFile, [], uint32.empty(0,3));
estRSRP = 0;
estNoiseVar = 0;
else
% Ensure we are transmitting on a single layer.
assert(all(symbolIndices(:, 3) == 0), 'srsran_matlab:srsPUSCHdmrsUnittest', ...
'Multi-layer channel estimation not enabled yet.');
channel = createChannel(carrier);
sizeRG = [nSizeGrid * 12, 14];
symbolIndicesLinear = sub2ind(sizeRG, symbolIndices(:, 1) + 1, ...
symbolIndices(:, 2) + 1);
receivedRG = channel;
receivedRG(symbolIndicesLinear) = receivedRG(symbolIndicesLinear) ...
.* DMRSsymbols * amplitude;
noiseVar = 0.1; % 10 dB
noiseRG = randn(sizeRG) + 1j * randn(sizeRG) * sqrt(noiseVar / 2);
receivedRG = receivedRG + noiseRG;
hop = configureHop();
% Empty second hop.
hop2.DMRSsymbols = [];
nOFDMSymbols = sum(hop.DMRSsymbols);
pilots = reshape(DMRSsymbols, [], nOFDMSymbols);
cfg.DMRSSymbolMask = hop.DMRSsymbols;
cfg.DMRSREmask = hop.DMRSREmask;
cfg.scs = subcarrierSpacing * 1000;
cfg.CyclicPrefixDurations = scs2cps(subcarrierSpacing);
receivedRG = approxbf16(receivedRG);
[estChannel, estNoiseVar, estRSRP] = srsChannelEstimator(receivedRG, ...
pilots, amplitude, hop, hop2, cfg);
% Write simulation data.
testCase.saveDataFile('_test_output', testID, ...
@writeResourceGridEntryFile, receivedRG(symbolIndicesLinear), symbolIndices);
[subcarriers, syms, vals] = find(estChannel);
testCase.saveDataFile('_ch_estimates', testID, ...
@writeResourceGridEntryFile, approxbf16(vals), [subcarriers, syms, zeros(length(subcarriers), 1)] - 1);
end
% Generate a 'slot_point' configuration string.
slotPointConfig = cellarray2str({numerology, nFrame, ...
floor(nSlot / carrier.SlotsPerSubframe), ...
rem(nSlot, carrier.SlotsPerSubframe)}, true);
% DMRS type
DmrsTypeStr = ['dmrs_type::TYPE', num2str(DMRSConfigurationType)];
% Cyclic Prefix.
cyclicPrefixStr = 'cyclic_prefix::NORMAL';
% generate a symbol allocation mask string
symbolAllocationMask = symbolAllocationMask2string(symbolIndices);
% generate a RB allocation mask string
rbAllocationMask = RBallocationMask2string(PRBstart, PRBend);
if transformPrecoding == 0
SequenceConfig = {...
DmrsTypeStr, ... % type
NumLayers, ... % nof_tx_layers
pusch.DMRS.NIDNSCID, ... % scrambling_id
pusch.DMRS.NSCID, ... % n_scid
};
SequenceDescr = ['dmrs_pusch_estimator::pseudo_random_sequence_configuration('...
cellarray2str(SequenceConfig, true)...
')'];
else
SequenceConfig = {...
pusch.DMRS.NRSID, ... % n_rs_id
};
SequenceDescr = ['dmrs_pusch_estimator::low_papr_sequence_configuration('...
cellarray2str(SequenceConfig, true)...
')'];
end
% Prepare DMRS configuration cell
dmrsConfigCell = { ...
slotPointConfig, ... % slot
SequenceDescr, ... % sequence_config
amplitude, ... % scaling
cyclicPrefixStr, ... % c_prefix
symbolAllocationMask, ... % symbol_mask
rbAllocationMask, ... % rb_mask
pusch.SymbolAllocation(1), ... % first_symbol
pusch.SymbolAllocation(2), ... % nof_symbols
{PUSCHports}, ... % rx_ports
};
testCell = {['test_label::' testLabel], dmrsConfigCell, estNoiseVar, estRSRP};
% generate the test case entry
testCaseString = testCase.testCaseToString(testID, testCell, ...
false, '_test_output', '_ch_estimates');
% add the test to the file header
testCase.addTestToHeaderFile(testCase.headerFileID, testCaseString);
% Nested functions
%%%%%%%%%%%%%%%%%%%%%%%%%%%
function hop_ = configureHop
ofdmSymIndices = unique(symbolIndices(:, 2) + 1);
hop_.DMRSsymbols = false(14, 1);
hop_.DMRSsymbols(ofdmSymIndices) = true;
hop_.DMRSREmask = false(12, 1);
if DMRSConfigurationType == 1
hop_.DMRSREmask(1:2:end) = true;
else
hop_.DMRSREmask([1, 2, 7, 8]) = true;
end
hop_.PRBstart = PRBstart;
hop_.nPRBs = length(PRBSet);
hop_.maskPRBs = false(nSizeGrid, 1);
hop_.maskPRBs(PRBSet + 1) = true;
hop_.startSymbol = symbolAllocation(1);
hop_.nAllocatedSymbols = symbolAllocation(2);
hop_.CHsymbols = false(14, 1);
hop_.CHsymbols((1:symbolAllocation(2)) + symbolAllocation(1)) = true;
end
end % of function testvectorGenerationCases
end % of methods (Test, TestTags = {'testvector'})
end % of classdef srsPUSCHdmrsUnittest
function channel = createChannel(carrier)
%Generates the frequency-response of single-tap channel that is consistent with
% the simulation setup.
nSubcarriers = carrier.NSizeGrid * 12;
nOFDMSymbols = 14;
% Compute maximum delay (1/4 CP length) in number of samples.
maxDelay = floor(0.7 * 0.25 * nSubcarriers);
% Random delay and random gain.
delay = randi(maxDelay);
gain = randn(1, 2) * [1; 1j] / sqrt(2);
channel = repmat(gain * exp(-2j * pi / nSubcarriers * delay ...
* (-nSubcarriers/2:nSubcarriers/2-1).'), 1, nOFDMSymbols);
end