summaryrefslogtreecommitdiff
path: root/hid-dials/Drivers/CMSIS/DSP/DSP_Lib_TestSuite/Common/src/filtering_tests/correlate_tests.c
blob: 689b07572b95d5d1cff35ad9bbf0cc3a3dc73780 (plain)
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
#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"

/*--------------------------------------------------------------------------------*/
/* Header Stuff */
/*--------------------------------------------------------------------------------*/

#define CORRELATE_MAX_INPUT_ELTS  32
#define CORRELATE_MAX_OUTPUT_ELTS (CORRELATE_MAX_INPUT_ELTS * 2)

/*--------------------------------------------------------------------------------*/
/* Input Interfaces */
/*--------------------------------------------------------------------------------*/
/*
 *  General:
 *  Input interfaces provide inputs to functions inside test templates.  They
 *  ONLY provide the inputs.  The output variables should be hard coded.
 *
 *  The input interfaces must have the following format:
 *
 *  ARM_xxx_INPUT_INTERFACE() or
 *  REF_xxx_INPUT_INTERFACE()
 *
 *  The xxx must be lowercase, and is intended to be the indentifying substring
 *  in the function's name.  Acceptable values are 'sub' or 'add' from the
 *  functions arm_add_q31.
 */

#define CORRELATE_arm_correlate_INPUT_INTERFACE(input_a, input_a_len, input_b, input_b_len) \
    PAREN(input_a, input_a_len, input_b, input_b_len, (void*)filtering_output_fut)

#define CORRELATE_ref_correlate_INPUT_INTERFACE(input_a, input_a_len, input_b, input_b_len) \
    PAREN(input_a, input_a_len, input_b, input_b_len, (void*)filtering_output_ref)

#define CORRELATE_arm_correlate_opt_INPUT_INTERFACE(    \
    input_a, input_a_len,                               \
    input_b, input_b_len)                               \
    PAREN(input_a, input_a_len, input_b, input_b_len,   \
          (void*) filtering_output_fut,                 \
          (void*) filtering_scratch)

#define CORRELATE_arm_correlate_opt_q7_INPUT_INTERFACE(  \
    input_a, input_a_len,                                \
    input_b, input_b_len)                                \
    PAREN(input_a, input_a_len, input_b, input_b_len,    \
          (void*) filtering_output_fut,                  \
          (void*) filtering_scratch,                     \
          (void*) filtering_scratch2)

#define CORRELATE_ref_correlate_opt_INPUT_INTERFACE(    \
    input_a, input_a_len,                               \
    input_b, input_b_len)                               \
    PAREN(input_a, input_a_len, input_b, input_b_len,   \
          (void*) filtering_output_ref,                 \
          (void*) filtering_scratch)

#define CORRELATE_ref_correlate_opt_q7_INPUT_INTERFACE( \
    input_a, input_a_len,                               \
    input_b, input_b_len)                               \
    PAREN(input_a, input_a_len, input_b, input_b_len,   \
          (void*) filtering_output_ref,                 \
          (void*) filtering_scratch,                    \
          (void*) filtering_scratch2)

#define CORRELATE_arm_correlate_fast_INPUT_INTERFACE(input_a, input_a_len,          \
                                           input_b, input_b_len)                    \
    PAREN(input_a, input_a_len, input_b, input_b_len, (void*)filtering_output_fut)

#define CORRELATE_ref_correlate_fast_INPUT_INTERFACE(input_a, input_a_len,          \
                                           input_b, input_b_len)                    \
    PAREN(input_a, input_a_len, input_b, input_b_len, (void*)filtering_output_ref)

#define CORRELATE_arm_correlate_fast_opt_INPUT_INTERFACE(   \
    input_a, input_a_len,                                   \
    input_b, input_b_len)                                   \
    PAREN(input_a, input_a_len, input_b, input_b_len,       \
          (void*) filtering_output_fut,                     \
          (void*) filtering_scratch)

#define CORRELATE_ref_correlate_fast_opt_INPUT_INTERFACE(   \
    input_a, input_a_len,                                   \
    input_b, input_b_len)                                   \
    PAREN(input_a, input_a_len, input_b, input_b_len,       \
          (void*) filtering_output_ref,                     \
          (void*) filtering_scratch)

/*--------------------------------------------------------------------------------*/
/* Convolution Inputs */
/*--------------------------------------------------------------------------------*/

/* The following symbols alias the filtering_q31_inputs array:
 *
 * - filtering_q15_inputs
 * - filtering_q7_inputs
 *
 * The aliasing conflicts with the instantiation of #ARR_DESC_t structs.
 *
 * These macro-level aliases allow the #CORRELATE_DEFINE_RAND_INPUT_ARR_DESCS() macro
 * to correctly select the filtering_q31_input or filtering_f32_input array,
 * within a template, by type_suffix.
 *
 */
#define CORRELATE_f32_INPUTS filtering_f32_inputs
#define CORRELATE_q31_INPUTS filtering_q31_inputs
#define CORRELATE_q15_INPUTS filtering_q31_inputs
#define CORRELATE_q7_INPUTS  filtering_q31_inputs

/**
 *  Defines #ARR_DESC_t objects that wrap existing, type-specific, common
 *  inputs.
 */
#define CORRELATE_DEFINE_RAND_INPUT_ARR_DESCS(type_suffix)      \
    ARR_DESC_DEFINE_USING_ARR(                                  \
        TYPE_FROM_ABBREV(type_suffix),                          \
        correlate_input_rand1_##type_suffix,                    \
        CORRELATE_##type_suffix##_INPUTS,                       \
        0,                                                      \
        CORRELATE_MAX_INPUT_ELTS);                              \
                                                                \
    ARR_DESC_DEFINE_USING_ARR(                                  \
        TYPE_FROM_ABBREV(type_suffix),                          \
        correlate_input_rand2_##type_suffix,                    \
        CORRELATE_##type_suffix##_INPUTS,                       \
        1,                                                      \
        CORRELATE_MAX_INPUT_ELTS)  /* Note the lacking semicolon */

CORRELATE_DEFINE_RAND_INPUT_ARR_DESCS(f32);
CORRELATE_DEFINE_RAND_INPUT_ARR_DESCS(q31);
CORRELATE_DEFINE_RAND_INPUT_ARR_DESCS(q15);
CORRELATE_DEFINE_RAND_INPUT_ARR_DESCS(q7);
ARR_DESC_DEFINE(float32_t, correlate_input_zeros, CORRELATE_MAX_INPUT_ELTS, CURLY(0));

/**
 *  Define Input #ARR_DESC_t arrays by type suffix.
 *
 *  Taking inputs in parallel from the 'a' and 'b' arrays yields the following
 *  test cases (star is correlate):
 *
 *  - zero_array   * zero_array
 *  - zero_array   * random_array
 *  - random_array * zero_array
 *  - random_array * different_random_arary
 */
#define CORRELATE_DEFINE_ALL_INPUTS(type_suffix)                  \
    ARR_DESC_DEFINE(ARR_DESC_t *,                                 \
                    correlate_##type_suffix##_a_inputs,           \
                    4,                                            \
                    CURLY(                                        \
                        &correlate_input_zeros,                   \
                        &correlate_input_zeros,                   \
                        &correlate_input_rand1_##type_suffix,     \
                        &correlate_input_rand1_##type_suffix      \
                        ));                                       \
    ARR_DESC_DEFINE(ARR_DESC_t *,                                 \
                    correlate_##type_suffix##_b_inputs,           \
                    4,                                            \
                    CURLY(                                        \
                        &correlate_input_zeros,                   \
                        &correlate_input_rand1_##type_suffix,     \
                        &correlate_input_zeros,                   \
                        &correlate_input_rand2_##type_suffix      \
                        )) /* Note the lacking semicolon */

CORRELATE_DEFINE_ALL_INPUTS(f32);
CORRELATE_DEFINE_ALL_INPUTS(q31);
CORRELATE_DEFINE_ALL_INPUTS(q15);
CORRELATE_DEFINE_ALL_INPUTS(q7);

/*--------------------------------------------------------------------------------*/
/* Convolution Lengths */
/*--------------------------------------------------------------------------------*/

/*
 *  The correlate_lens_a and correlate_lens_b #ARR_DESC_t objects are accessed in parallel
 *  to provide correlate-length pairs. Taken in parallel they provide the
 *  following cases:
 *
 *  - 1 * 1    : Shortest correlate possible.
 *  - 1 * 2    : Short correlate , one side is degenerate.
 *  - 17 * 1   : Medium correlate, one side is degenerate.
 *  - 15 * MAX : Longest correlate.
 *  MAX * MAX  : Longest correlate.
 */
ARR_DESC_DEFINE(uint32_t,
                correlate_lens_a,
                5,
                CURLY(
                    1,
                    1,
                    17,
                    15,
                    CORRELATE_MAX_INPUT_ELTS
                    ));

ARR_DESC_DEFINE(uint32_t,
                correlate_lens_b,
                5,
                CURLY(
                    1,
                    2,
                    1,
                    CORRELATE_MAX_INPUT_ELTS,
                    CORRELATE_MAX_INPUT_ELTS
                    ));

/*--------------------------------------------------------------------------------*/
/* Convolution Tests */
/*--------------------------------------------------------------------------------*/

#define CORRELATE_TEST_TEMPLATE(fut, fut_arg_interface,                                \
                           ref, ref_arg_interface,                                     \
                           suffix, output_type)                                        \
    JTEST_DEFINE_TEST(fut##_tests, fut)                                                \
    {                                                                                  \
        TEMPLATE_DO_ARR_DESC(                                                          \
            input_idx, ARR_DESC_t *, input_ptr, correlate_##suffix##_a_inputs          \
            ,                                                                          \
            void * input_a_ptr = input_ptr->data_ptr;                                  \
            void * input_b_ptr = ARR_DESC_ELT(                                         \
                ARR_DESC_t *, input_idx,                                               \
                &(correlate_##suffix##_b_inputs))->data_ptr;                           \
                                                                                       \
            TEMPLATE_DO_ARR_DESC(                                                      \
                correlate_len_idx, uint32_t, correlate_len_a, correlate_lens_a         \
                ,                                                                      \
                uint32_t correlate_len_b = ARR_DESC_ELT(                               \
                    uint32_t, correlate_len_idx, &(correlate_lens_b));                 \
                                                                                       \
                /* Display test parameter values */                                    \
                 JTEST_DUMP_STRF("Input A Length: %d\n"                                \
                                 "Input B Length: %d\n",                               \
                                (int)correlate_len_a,                                  \
                                (int)correlate_len_b);                                 \
                                                                                       \
                memset(filtering_output_ref,0,                                         \
                      (2*CORRELATE_MAX_INPUT_ELTS)*sizeof(output_type));               \
                memset(filtering_output_fut,0,                                         \
                      (2*CORRELATE_MAX_INPUT_ELTS)*sizeof(output_type));               \
                                                                                       \
                TEST_CALL_FUT_AND_REF(                                                 \
                    fut, fut_arg_interface(                                            \
                        input_a_ptr, correlate_len_a, input_b_ptr, correlate_len_b),   \
                    ref, ref_arg_interface(                                            \
                        input_a_ptr, correlate_len_a, input_b_ptr, correlate_len_b));  \
                                                                                       \
                FILTERING_SNR_COMPARE_INTERFACE(                                       \
                    correlate_len_a + correlate_len_b - 2,                             \
                    output_type)));                                                    \
                                                                                       \
        return JTEST_TEST_PASSED;                                                      \
    }

#define CORRELATE_DEFINE_TEST(fn_name, suffix, output_type, test_template)    \
    test_template(                                                            \
        arm_##fn_name##_##suffix,                                             \
        CORRELATE_arm_##fn_name##_INPUT_INTERFACE,                            \
        ref_##fn_name##_##suffix,                                             \
        CORRELATE_ref_##fn_name##_INPUT_INTERFACE,                            \
        suffix,                                                               \
        output_type                                                           \
        ) /* Note the lacking semicolon*/

/* Tests on functions without partial outputs */
CORRELATE_DEFINE_TEST(correlate          , f32, float32_t, CORRELATE_TEST_TEMPLATE);
CORRELATE_DEFINE_TEST(correlate          , q31, q31_t    , CORRELATE_TEST_TEMPLATE);
CORRELATE_DEFINE_TEST(correlate          , q15, q15_t    , CORRELATE_TEST_TEMPLATE);
CORRELATE_DEFINE_TEST(correlate          , q7 , q7_t     , CORRELATE_TEST_TEMPLATE);
CORRELATE_DEFINE_TEST(correlate_opt      , q15, q15_t    , CORRELATE_TEST_TEMPLATE);

CORRELATE_TEST_TEMPLATE(
   arm_correlate_opt_q7,
   CORRELATE_arm_correlate_opt_q7_INPUT_INTERFACE,
   ref_correlate_opt_q7,
   CORRELATE_ref_correlate_opt_q7_INPUT_INTERFACE,
   q7,
   q7_t
   );

CORRELATE_DEFINE_TEST(correlate_fast     , q31, q31_t    , CORRELATE_TEST_TEMPLATE);
CORRELATE_DEFINE_TEST(correlate_fast     , q15, q15_t    , CORRELATE_TEST_TEMPLATE);
CORRELATE_DEFINE_TEST(correlate_fast_opt , q15, q15_t    , CORRELATE_TEST_TEMPLATE);

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

JTEST_DEFINE_GROUP(correlate_tests)
{
    /*
      To skip a test, comment it out.
    */
    JTEST_TEST_CALL(arm_correlate_f32_tests);
    JTEST_TEST_CALL(arm_correlate_q31_tests);
    JTEST_TEST_CALL(arm_correlate_q15_tests);
    JTEST_TEST_CALL(arm_correlate_q7_tests);

    JTEST_TEST_CALL(arm_correlate_opt_q15_tests);
    JTEST_TEST_CALL(arm_correlate_opt_q7_tests);

    JTEST_TEST_CALL(arm_correlate_fast_q31_tests);
    JTEST_TEST_CALL(arm_correlate_fast_q15_tests);

    JTEST_TEST_CALL(arm_correlate_fast_opt_q15_tests);
}