fw/hid-dials/Drivers/CMSIS/DSP/DSP_Lib_TestSuite/Common/src/filtering_tests/fir_tests.c


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

#include "jtest.h"
#include "filtering_test_data.h"
#include "arr_desc.h"
#include "arm_math.h"           /* FUTs */
#include "ref.h"                /* Reference Functions */
#include "test_templates.h"
#include "filtering_templates.h"
#include "type_abbrev.h"

#define FIR_DEFINE_TEST(suffix, config_suffix, output_type)             \
   JTEST_DEFINE_TEST(arm_fir##config_suffix##_##suffix##_test,          \
         arm_fir##config_suffix##_##suffix)                             \
   {                                                                    \
      arm_fir_instance_##suffix fir_inst_fut = { 0 };                   \
      arm_fir_instance_##suffix fir_inst_ref = { 0 };                   \
                                                                        \
      TEMPLATE_DO_ARR_DESC(                                             \
            blocksize_idx, uint32_t, blockSize, filtering_blocksizes    \
            ,                                                           \
         TEMPLATE_DO_ARR_DESC(                                          \
               numtaps_idx, uint16_t, numTaps, filtering_numtaps        \
               ,                                                        \
               /* Initialize the FIR Instances */                       \
               arm_fir_init_##suffix(                                   \
                     &fir_inst_fut, numTaps,                            \
                     (output_type*)filtering_coeffs_##suffix,           \
                     (void *) filtering_pState, blockSize);             \
                                                                        \
              /* Display test parameter values */                       \
              JTEST_DUMP_STRF("Block Size: %d\n"                        \
                              "Number of Taps: %d\n",                   \
                         (int)blockSize,                                \
                         (int)numTaps);                                 \
                                                                        \
               JTEST_COUNT_CYCLES(                                      \
                     arm_fir##config_suffix##_##suffix(                 \
                           &fir_inst_fut,                               \
                           (void *) filtering_##suffix##_inputs,        \
                           (void *) filtering_output_fut,               \
                           blockSize));                                 \
                                                                        \
               arm_fir_init_##suffix(                                   \
                     &fir_inst_ref, numTaps,                            \
                     (output_type*)filtering_coeffs_##suffix,           \
                     (void *) filtering_pState, blockSize);             \
                                                                        \
               ref_fir##config_suffix##_##suffix(                       \
                     &fir_inst_ref,                                     \
                     (void *) filtering_##suffix##_inputs,              \
                     (void *) filtering_output_ref,                     \
                     blockSize);                                        \
                                                                        \
               FILTERING_SNR_COMPARE_INTERFACE(                         \
                     blockSize,                                         \
                     output_type)));                                    \
                                                                        \
            return JTEST_TEST_PASSED;                                   \
   }

#define FIR_INTERPOLATE_DEFINE_TEST(suffix, output_type)                      \
   JTEST_DEFINE_TEST(arm_fir_interpolate_##suffix##_test,                     \
         arm_fir_interpolate_##suffix)                                        \
   {                                                                          \
      arm_fir_interpolate_instance_##suffix fir_inst_fut = { 0 };             \
      arm_fir_interpolate_instance_##suffix fir_inst_ref = { 0 };             \
                                                                              \
      TEMPLATE_DO_ARR_DESC(                                                   \
            blocksize_idx, uint32_t, blockSize, filtering_blocksizes          \
            ,                                                                 \
         TEMPLATE_DO_ARR_DESC(                                                \
               numtaps_idx, uint16_t, numTaps, filtering_numtaps2             \
               ,                                                              \
            TEMPLATE_DO_ARR_DESC(                                             \
                  L_idx, uint8_t, L, filtering_Ls                             \
                  ,                                                           \
                  /* Display test parameter values */                         \
                  JTEST_DUMP_STRF("Block Size: %d\n"                          \
                                 "Number of Taps: %d\n"                       \
                                 "Upsample factor: %d\n",                     \
                                (int)blockSize,                               \
                                (int)numTaps,                                 \
                                (int)L);                                      \
                                                                              \
                  /* Initialize the FIR Instances */                          \
                  arm_fir_interpolate_init_##suffix(                          \
                        &fir_inst_fut, L, numTaps,                            \
                        (output_type*)filtering_coeffs_##suffix,              \
                        (void *) filtering_pState, blockSize);                \
                                                                              \
                  JTEST_COUNT_CYCLES(                                         \
                        arm_fir_interpolate_##suffix(                         \
                              &fir_inst_fut,                                  \
                              (void *) filtering_##suffix##_inputs,           \
                              (void *) filtering_output_fut,                  \
                              blockSize));                                    \
                                                                              \
                  arm_fir_interpolate_init_##suffix(                          \
                        &fir_inst_ref, L, numTaps,                            \
                        (output_type*)filtering_coeffs_##suffix,              \
                        (void *) filtering_pState, blockSize);                \
                                                                              \
                  ref_fir_interpolate_##suffix(                               \
                        &fir_inst_ref,                                        \
                        (void *) filtering_##suffix##_inputs,                 \
                        (void *) filtering_output_ref,                        \
                        blockSize);                                           \
                                                                              \
                  FILTERING_SNR_COMPARE_INTERFACE(                            \
                        blockSize * (uint32_t)L,                              \
                        output_type))));                                      \
                                                                              \
            return JTEST_TEST_PASSED;                                         \
   }

#define FIR_DECIMATE_DEFINE_TEST(suffix, config_suffix, output_type)       \
   JTEST_DEFINE_TEST(arm_fir_decimate##config_suffix##_##suffix##_test,    \
         arm_fir_decimate##config_suffix##_##suffix)                       \
   {                                                                       \
      arm_fir_decimate_instance_##suffix fir_inst_fut = { 0 };             \
      arm_fir_decimate_instance_##suffix fir_inst_ref = { 0 };             \
                                                                           \
      TEMPLATE_DO_ARR_DESC(                                                \
            blocksize_idx, uint32_t, blockSize, filtering_blocksizes       \
            ,                                                              \
         TEMPLATE_DO_ARR_DESC(                                             \
               numtaps_idx, uint16_t, numTaps, filtering_numtaps           \
               ,                                                           \
            TEMPLATE_DO_ARR_DESC(                                          \
                  M_idx, uint8_t, M, filtering_Ms                          \
                  ,                                                        \
                  if (blockSize % M == 0)                                   \
                  {                                                        \
                     /* Display test parameter values */                   \
                     JTEST_DUMP_STRF("Block Size: %d\n"                    \
                                     "Number of Taps: %d\n"                \
                                     "Decimation Factor: %d\n",            \
                                     (int)blockSize,                       \
                                     (int)numTaps,                         \
                                     (int)M);                              \
                                                                           \
                     /* Initialize the FIR Instances */                    \
                     arm_fir_decimate_init_##suffix(                       \
                           &fir_inst_fut, numTaps, M,                      \
                           (output_type*)filtering_coeffs_##suffix,        \
                           (void *) filtering_pState, blockSize);          \
                                                                           \
                     JTEST_COUNT_CYCLES(                                   \
                           arm_fir_decimate##config_suffix##_##suffix(     \
                                 &fir_inst_fut,                            \
                                 (void *) filtering_##suffix##_inputs,     \
                                 (void *) filtering_output_fut,            \
                                 blockSize));                              \
                                                                           \
                     arm_fir_decimate_init_##suffix(                       \
                           &fir_inst_ref, numTaps, M,                      \
                           (output_type*)filtering_coeffs_##suffix,        \
                           (void *) filtering_pState, blockSize);          \
                                                                           \
                     ref_fir_decimate##config_suffix##_##suffix(           \
                           &fir_inst_ref,                                  \
                           (void *) filtering_##suffix##_inputs,           \
                           (void *) filtering_output_ref,                  \
                           blockSize);                                     \
                                                                           \
                     FILTERING_SNR_COMPARE_INTERFACE(                      \
                           blockSize / M,                                  \
                           output_type);                                   \
                  })));                                                    \
                                                                           \
            return JTEST_TEST_PASSED;                                      \
   }

#define FIR_LATTICE_DEFINE_TEST(suffix, output_type)                       \
   JTEST_DEFINE_TEST(arm_fir_lattice_##suffix##_test,                      \
         arm_fir_lattice_##suffix)                                         \
   {                                                                       \
      arm_fir_lattice_instance_##suffix fir_inst_fut = { 0 };              \
      arm_fir_lattice_instance_##suffix fir_inst_ref = { 0 };              \
                                                                           \
      TEMPLATE_DO_ARR_DESC(                                                \
            blocksize_idx, uint32_t, blockSize, filtering_blocksizes       \
            ,                                                              \
         TEMPLATE_DO_ARR_DESC(                                             \
               numstages_idx, uint16_t, numStages, filtering_numstages     \
               ,                                                           \
               /* Display test parameter values */                         \
               JTEST_DUMP_STRF("Block Size: %d\n"                          \
                               "Number of Stages: %d\n",                   \
                               (int)blockSize,                             \
                               (int)numStages);                            \
                                                                           \
               /* Initialize the FIR Instances */                          \
               arm_fir_lattice_init_##suffix(                              \
                     &fir_inst_fut, numStages,                             \
                     (output_type*)filtering_coeffs_##suffix,              \
                     (void *) filtering_pState);                           \
                                                                           \
               JTEST_COUNT_CYCLES(                                         \
                     arm_fir_lattice_##suffix(                             \
                           &fir_inst_fut,                                  \
                           (void *) filtering_##suffix##_inputs,           \
                           (void *) filtering_output_fut,                  \
                           blockSize));                                    \
                                                                           \
               arm_fir_lattice_init_##suffix(                              \
                     &fir_inst_ref, numStages,                             \
                     (output_type*)filtering_coeffs_##suffix,              \
                     (void *) filtering_pState);                           \
                                                                           \
               ref_fir_lattice_##suffix(                                   \
                     &fir_inst_ref,                                        \
                     (void *) filtering_##suffix##_inputs,                 \
                     (void *) filtering_output_ref,                        \
                     blockSize);                                           \
                                                                           \
               FILTERING_SNR_COMPARE_INTERFACE(                            \
                     blockSize,                                            \
                     output_type)));                                       \
                                                                           \
            return JTEST_TEST_PASSED;                                      \
   }


#define FIR_SPARSE_DEFINE_TEST(suffix, output_type)                     \
   JTEST_DEFINE_TEST(arm_fir_sparse_##suffix##_test,                    \
         arm_fir_sparse_##suffix)                                       \
   {                                                                    \
      arm_fir_sparse_instance_##suffix fir_inst_fut = { 0 };            \
      arm_fir_sparse_instance_##suffix fir_inst_ref = { 0 };            \
                                                                        \
      TEMPLATE_DO_ARR_DESC(                                             \
            blocksize_idx, uint32_t, blockSize, filtering_blocksizes    \
            ,                                                           \
         TEMPLATE_DO_ARR_DESC(                                          \
               numtaps_idx, uint16_t, numTaps, filtering_numtaps        \
               ,                                                        \
               /* Display test parameter values */                      \
               JTEST_DUMP_STRF("Block Size: %d\n"                       \
                               "Number of Taps: %d\n"                   \
                               "Tap Delay: %d\n",                       \
                               (int)blockSize,                          \
                               (int)numTaps,                            \
                               (int)FILTERING_MAX_TAP_DELAY);           \
                                                                        \
               /* Initialize the FIR Instances */                       \
               arm_fir_sparse_init_##suffix(                            \
                     &fir_inst_fut, numTaps,                            \
                     (output_type*)filtering_coeffs_##suffix,           \
                     (void *) filtering_pState,                         \
                     (int32_t*)filtering_tap_delay,                     \
                     FILTERING_MAX_TAP_DELAY, blockSize);               \
                                                                        \
               JTEST_COUNT_CYCLES(                                      \
                     arm_fir_sparse_##suffix(                           \
                           &fir_inst_fut,                               \
                           (void *) filtering_##suffix##_inputs,        \
                           (void *) filtering_output_fut,               \
                           (void *) filtering_scratch,                  \
                           blockSize));                                 \
                                                                        \
               arm_fir_sparse_init_##suffix(                            \
                     &fir_inst_ref, numTaps,                            \
                     (output_type*)filtering_coeffs_##suffix,           \
                     (void *) filtering_pState,                         \
                     (int32_t*)filtering_tap_delay,                     \
                     FILTERING_MAX_TAP_DELAY, blockSize);               \
                                                                        \
               ref_fir_sparse_##suffix(                                 \
                     &fir_inst_ref,                                     \
                     (void *) filtering_##suffix##_inputs,              \
                     (void *) filtering_output_ref,                     \
                     (void *) filtering_scratch,                        \
                     blockSize);                                        \
                                                                        \
               FILTERING_SNR_COMPARE_INTERFACE(                         \
                     blockSize,                                         \
                     output_type)));                                    \
                                                                        \
            return JTEST_TEST_PASSED;                                   \
   }

#define FIR_SPARSE2_DEFINE_TEST(suffix, output_type)                    \
   JTEST_DEFINE_TEST(arm_fir_sparse_##suffix##_test,                    \
         arm_fir_sparse_##suffix)                                       \
   {                                                                    \
      arm_fir_sparse_instance_##suffix fir_inst_fut = { 0 };            \
      arm_fir_sparse_instance_##suffix fir_inst_ref = { 0 };            \
                                                                        \
      TEMPLATE_DO_ARR_DESC(                                             \
            blocksize_idx, uint32_t, blockSize, filtering_blocksizes    \
            ,                                                           \
         TEMPLATE_DO_ARR_DESC(                                          \
               numtaps_idx, uint16_t, numTaps, filtering_numtaps        \
               ,                                                        \
              /* Display test parameter values */                       \
              JTEST_DUMP_STRF("Block Size: %d\n"                        \
                              "Number of Taps: %d\n"                    \
                              "Tap Delay: %d\n",                        \
                              (int)blockSize,                           \
                              (int)numTaps,                             \
                              (int)FILTERING_MAX_TAP_DELAY);            \
                                                                        \
               /* Initialize the FIR Instances */                       \
               arm_fir_sparse_init_##suffix(                            \
                     &fir_inst_fut, numTaps,                            \
                     (output_type*)filtering_coeffs_##suffix,           \
                     (void *) filtering_pState,                         \
                     (int32_t*)filtering_tap_delay,                     \
                     FILTERING_MAX_TAP_DELAY, blockSize);               \
                                                                        \
               JTEST_COUNT_CYCLES(                                      \
                     arm_fir_sparse_##suffix(                           \
                           &fir_inst_fut,                               \
                           (void *) filtering_##suffix##_inputs,        \
                           (void *) filtering_output_fut,               \
                           (void *) filtering_scratch,                  \
                           (void *) filtering_scratch2,                 \
                           blockSize));                                 \
                                                                        \
               arm_fir_sparse_init_##suffix(                            \
                     &fir_inst_ref, numTaps,                            \
                     (output_type*)filtering_coeffs_##suffix,           \
                     (void *) filtering_pState,                         \
                     (int32_t*)filtering_tap_delay,                     \
                     FILTERING_MAX_TAP_DELAY, blockSize);               \
                                                                        \
               ref_fir_sparse_##suffix(                                 \
                     &fir_inst_ref,                                     \
                     (void *) filtering_##suffix##_inputs,              \
                     (void *) filtering_output_ref,                     \
                     (void *) filtering_scratch,                        \
                     (void *) filtering_scratch2,                       \
                     blockSize);                                        \
                                                                        \
               FILTERING_SNR_COMPARE_INTERFACE(                         \
                     blockSize,                                         \
                     output_type)));                                    \
                                                                        \
            return JTEST_TEST_PASSED;                                   \
   }

FIR_DEFINE_TEST(f32,,float32_t);
FIR_DEFINE_TEST(q31,,q31_t);
FIR_DEFINE_TEST(q15,,q15_t);
FIR_DEFINE_TEST(q31,_fast,q31_t);
FIR_DEFINE_TEST(q15,_fast,q15_t);
FIR_DEFINE_TEST(q7,,q7_t);

FIR_LATTICE_DEFINE_TEST(f32,float32_t);
FIR_LATTICE_DEFINE_TEST(q31,q31_t);
FIR_LATTICE_DEFINE_TEST(q15,q15_t);

FIR_INTERPOLATE_DEFINE_TEST(f32,float32_t);
FIR_INTERPOLATE_DEFINE_TEST(q31,q31_t);
FIR_INTERPOLATE_DEFINE_TEST(q15,q15_t);

FIR_DECIMATE_DEFINE_TEST(f32,,float32_t);
FIR_DECIMATE_DEFINE_TEST(q31,,q31_t);
FIR_DECIMATE_DEFINE_TEST(q15,,q15_t);
FIR_DECIMATE_DEFINE_TEST(q31,_fast,q31_t);
FIR_DECIMATE_DEFINE_TEST(q15,_fast,q15_t);

FIR_SPARSE_DEFINE_TEST(f32,float32_t);
FIR_SPARSE_DEFINE_TEST(q31,q31_t);
FIR_SPARSE2_DEFINE_TEST(q15,q15_t);
FIR_SPARSE2_DEFINE_TEST(q7,q7_t);

/*--------------------------------------------------------------------------------*/
/* Collect all tests in a group. */
/*--------------------------------------------------------------------------------*/

JTEST_DEFINE_GROUP(fir_tests)
{
    /*
      To skip a test, comment it out.
    */
   JTEST_TEST_CALL(arm_fir_f32_test);
   JTEST_TEST_CALL(arm_fir_q31_test);
   JTEST_TEST_CALL(arm_fir_q15_test);
   JTEST_TEST_CALL(arm_fir_q7_test);
   JTEST_TEST_CALL(arm_fir_fast_q31_test);
   JTEST_TEST_CALL(arm_fir_fast_q15_test);

   JTEST_TEST_CALL(arm_fir_lattice_f32_test);
   JTEST_TEST_CALL(arm_fir_lattice_q31_test);
   JTEST_TEST_CALL(arm_fir_lattice_q15_test);

   JTEST_TEST_CALL(arm_fir_interpolate_f32_test);
   JTEST_TEST_CALL(arm_fir_interpolate_q31_test);
   JTEST_TEST_CALL(arm_fir_interpolate_q15_test);

   JTEST_TEST_CALL(arm_fir_decimate_f32_test);
   JTEST_TEST_CALL(arm_fir_decimate_q31_test);
   JTEST_TEST_CALL(arm_fir_decimate_q15_test);
   JTEST_TEST_CALL(arm_fir_decimate_fast_q31_test);
   JTEST_TEST_CALL(arm_fir_decimate_fast_q15_test);

   JTEST_TEST_CALL(arm_fir_sparse_f32_test);
   JTEST_TEST_CALL(arm_fir_sparse_q31_test);
   JTEST_TEST_CALL(arm_fir_sparse_q15_test);
   JTEST_TEST_CALL(arm_fir_sparse_q7_test);
}