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
|
/* ----------------------------------------------------------------------
* Project: CMSIS DSP Library
* Title: arm_rfft_init_q31.c
* Description: RFFT & RIFFT Q31 initialisation function
*
* $Date: 23 April 2021
* $Revision: V1.9.0
*
* Target Processor: Cortex-M and Cortex-A cores
* -------------------------------------------------------------------- */
/*
* Copyright (C) 2010-2021 ARM Limited or its affiliates. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed under the Apache License, Version 2.0 (the License); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "arm_compiler_specific.h"
#include "dsp/transform_functions.h"
#include "arm_common_tables.h"
#include "arm_const_structs.h"
/**
@ingroup RealFFT
*/
/**
@defgroup RealFFTQ31 Real FFT Q31 Functions
*/
/**
@addtogroup RealFFTQ31
@{
*/
#if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE)
#define RFFTINIT_Q31(LEN,CFFTLEN,TWIDMOD) \
ARM_DSP_ATTRIBUTE arm_status arm_rfft_init_##LEN##_q31( arm_rfft_instance_q31 * S, \
uint32_t ifftFlagR, \
uint32_t bitReverseFlag ) \
{ \
/* Initialise the default arm status */ \
arm_status status = ARM_MATH_ARGUMENT_ERROR; \
\
/* Initialize the Real FFT length */ \
S->fftLenReal = (uint16_t) LEN; \
\
/* Initialize the Twiddle coefficientA pointer */ \
S->pTwiddleAReal = (q31_t *) realCoefAQ31; \
\
/* Initialize the Twiddle coefficientB pointer */ \
S->pTwiddleBReal = (q31_t *) realCoefBQ31; \
\
/* Initialize the Flag for selection of RFFT or RIFFT */ \
S->ifftFlagR = (uint8_t) ifftFlagR; \
\
/* Initialize the Flag for calculation Bit reversal or not */\
S->bitReverseFlagR = (uint8_t) bitReverseFlag; \
\
S->twidCoefRModifier = TWIDMOD; \
\
status=arm_cfft_init_##CFFTLEN##_q31(&(S->cfftInst)); \
\
/* return the status of RFFT Init function */ \
return (status); \
}
#elif defined(ARM_MATH_NEON)
#define RFFTINIT_Q31(LEN,CFFTLEN,TWIDMOD) \
ARM_DSP_ATTRIBUTE arm_status arm_rfft_init_##LEN##_q31( arm_rfft_instance_q31 * S )\
{ \
/* Initialise the default arm status */ \
arm_status status = ARM_MATH_SUCCESS; \
S->nfft = LEN; \
S->ncfft = LEN >> 1; \
\
S->twiddles = arm_neon_rfft_twiddles_##LEN##_q31; \
S->factors = arm_neon_rfft_factors_##LEN##_q31; \
\
S->super_twiddles = arm_neon_rfft_super_twiddles_neon_##LEN##_q31; \
\
/* return the status of RFFT Init function */ \
return (status); \
}
#include "arm_neon_tables.h"
#else
#define RFFTINIT_Q31(LEN,CFFTLEN,TWIDMOD) \
ARM_DSP_ATTRIBUTE arm_status arm_rfft_init_##LEN##_q31( arm_rfft_instance_q31 * S, \
uint32_t ifftFlagR, \
uint32_t bitReverseFlag ) \
{ \
/* Initialize the Real FFT length */ \
S->fftLenReal = (uint16_t) LEN; \
\
/* Initialize the Twiddle coefficientA pointer */ \
S->pTwiddleAReal = (q31_t *) realCoefAQ31; \
\
/* Initialize the Twiddle coefficientB pointer */ \
S->pTwiddleBReal = (q31_t *) realCoefBQ31; \
\
/* Initialize the Flag for selection of RFFT or RIFFT */ \
S->ifftFlagR = (uint8_t) ifftFlagR; \
\
/* Initialize the Flag for calculation Bit reversal or not */\
S->bitReverseFlagR = (uint8_t) bitReverseFlag; \
\
S->twidCoefRModifier = TWIDMOD; \
\
S->pCfft = &arm_cfft_sR_q31_len##CFFTLEN; \
\
/* return the status of RFFT Init function */ \
return (ARM_MATH_SUCCESS); \
}
#endif
/**
@brief Initialization function for the 8192 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(8192,4096,1)
/**
@brief Initialization function for the 4096 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(4096,2048,2)
/**
@brief Initialization function for the 2048 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(2048,1024,4)
/**
@brief Initialization function for the 1024 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(1024,512,8)
/**
@brief Initialization function for the 512 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(512,256,16)
/**
@brief Initialization function for the 256 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(256,128,32)
/**
@brief Initialization function for the 128 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(128,64,64)
/**
@brief Initialization function for the 64 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(64,32,128)
/**
@brief Initialization function for the 32 pt Q31 real FFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
*/
RFFTINIT_Q31(32,16,256)
/**
@brief Generic initialization function for the Q31 RFFT/RIFFT.
@param[in,out] S points to an instance of the Q31 RFFT/RIFFT structure
@param[in] fftLenReal length of the FFT
@param[in] ifftFlagR flag that selects transform direction
- value = 0: forward transform
- value = 1: inverse transform
@param[in] bitReverseFlag flag that enables / disables bit reversal of output
- value = 0: disables bit reversal of output
- value = 1: enables bit reversal of output
@return execution status
- \ref ARM_MATH_SUCCESS : Operation successful
- \ref ARM_MATH_ARGUMENT_ERROR : <code>fftLenReal</code> is not a supported length
@par Details
The parameter <code>fftLenReal</code> specifies length of RFFT/RIFFT Process.
Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192.
@par
The parameter <code>ifftFlagR</code> controls whether a forward or inverse transform is computed.
Set(=1) ifftFlagR to calculate RIFFT, otherwise RFFT is calculated.
@par
The parameter <code>bitReverseFlag</code> controls whether output is in normal order or bit reversed order.
Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order.
@par
This function also initializes Twiddle factor table.
@par
This function should be used only if you don't know the FFT sizes that
you'll need at build time. The use of this function will prevent the
linker from removing the FFT tables that are not needed and the library
code size will be bigger than needed.
@par
If you use CMSIS-DSP as a static library, and if you know the FFT sizes
that you need at build time, then it is better to use the initialization
functions defined for each FFT size.
*/
#if defined(ARM_MATH_NEON)
ARM_DSP_ATTRIBUTE arm_status arm_rfft_init_q31(
arm_rfft_instance_q31 * S,
uint32_t fftLenReal)
{
/* Initialise the default arm status */
arm_status status = ARM_MATH_ARGUMENT_ERROR;
/* Initialization of coef modifier depending on the FFT length */
switch (fftLenReal)
{
case 8192U:
status = arm_rfft_init_8192_q31( S );
break;
case 4096U:
status = arm_rfft_init_4096_q31( S );
break;
case 2048U:
status = arm_rfft_init_2048_q31( S );
break;
case 1024U:
status = arm_rfft_init_1024_q31( S );
break;
case 512U:
status = arm_rfft_init_512_q31( S );
break;
case 256U:
status = arm_rfft_init_256_q31( S );
break;
case 128U:
status = arm_rfft_init_128_q31( S );
break;
case 64U:
status = arm_rfft_init_64_q31( S );
break;
case 32U:
status = arm_rfft_init_32_q31( S );
break;
default:
/* Reporting argument error if rfftSize is not valid value */
status = ARM_MATH_ARGUMENT_ERROR;
break;
}
/* return the status of RFFT Init function */
return (status);
}
#else
ARM_DSP_ATTRIBUTE arm_status arm_rfft_init_q31(
arm_rfft_instance_q31 * S,
uint32_t fftLenReal,
uint32_t ifftFlagR,
uint32_t bitReverseFlag)
{
/* Initialise the default arm status */
arm_status status = ARM_MATH_ARGUMENT_ERROR;
/* Initialization of coef modifier depending on the FFT length */
switch (fftLenReal)
{
case 8192U:
status = arm_rfft_init_8192_q31( S,ifftFlagR,bitReverseFlag );
break;
case 4096U:
status = arm_rfft_init_4096_q31( S,ifftFlagR,bitReverseFlag );
break;
case 2048U:
status = arm_rfft_init_2048_q31( S,ifftFlagR,bitReverseFlag );
break;
case 1024U:
status = arm_rfft_init_1024_q31( S,ifftFlagR,bitReverseFlag );
break;
case 512U:
status = arm_rfft_init_512_q31( S,ifftFlagR,bitReverseFlag );
break;
case 256U:
status = arm_rfft_init_256_q31( S,ifftFlagR,bitReverseFlag );
break;
case 128U:
status = arm_rfft_init_128_q31( S,ifftFlagR,bitReverseFlag );
break;
case 64U:
status = arm_rfft_init_64_q31( S,ifftFlagR,bitReverseFlag );
break;
case 32U:
status = arm_rfft_init_32_q31( S,ifftFlagR,bitReverseFlag );
break;
default:
/* Reporting argument error if rfftSize is not valid value */
status = ARM_MATH_ARGUMENT_ERROR;
break;
}
/* return the status of RFFT Init function */
return (status);
}
#endif /* neon */
/**
@} end of RealFFTQ31 group
*/
|
