Complex FFT Q31

Functions
arm_status	arm_cfft_init_4096_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 4096 samples. More...
arm_status	arm_cfft_init_2048_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 2048 samples. More...
arm_status	arm_cfft_init_1024_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 1024 samples. More...
arm_status	arm_cfft_init_512_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 512 samples. More...
arm_status	arm_cfft_init_256_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 256 samples. More...
arm_status	arm_cfft_init_128_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 128 samples. More...
arm_status	arm_cfft_init_64_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 64 samples. More...
arm_status	arm_cfft_init_32_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 32 samples. More...
arm_status	arm_cfft_init_16_q31 (arm_cfft_instance_q31 *S)
	Initialization function for the cfft q31 function for 16 samples. More...
arm_status	arm_cfft_init_q31 (arm_cfft_instance_q31 *S, uint16_t fftLen)
	Generic initialization function for the cfft q31 function. More...
void	arm_cfft_q31 (const arm_cfft_instance_q31 *S, q31_t *p1, uint8_t ifftFlag, uint8_t bitReverseFlag)
	Processing function for the Q31 complex FFT. More...

Description

Function Documentation

arm_cfft_init_1024_q31()

arm_status arm_cfft_init_1024_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_128_q31()

arm_status arm_cfft_init_128_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_16_q31()

arm_status arm_cfft_init_16_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_2048_q31()

arm_status arm_cfft_init_2048_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_256_q31()

arm_status arm_cfft_init_256_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_32_q31()

arm_status arm_cfft_init_32_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_4096_q31()

arm_status arm_cfft_init_4096_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_512_q31()

arm_status arm_cfft_init_512_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_64_q31()

arm_status arm_cfft_init_64_q31

(

arm_cfft_instance_q31 *

S

)

Parameters

[in,out]

S

points to an instance of the floating-point CFFT structure

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

arm_cfft_init_q31()

arm_status arm_cfft_init_q31	(	arm_cfft_instance_q31 *	S,
		uint16_t	fftLen
	)

Parameters

[in,out]	S	points to an instance of the floating-point CFFT structure
[in]	fftLen	fft length (number of complex samples)

Returns

execution status

• ARM_MATH_SUCCESS : Operation successful
• ARM_MATH_ARGUMENT_ERROR : an error is detected

Use of this function is mandatory only for the MVE version of the FFT.

Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h

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.

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.

arm_cfft_q31()

void arm_cfft_q31	(	const arm_cfft_instance_q31 *	S,
		q31_t *	p1,
		uint8_t	ifftFlag,
		uint8_t	bitReverseFlag
	)

Parameters

[in]	S	points to an instance of the fixed-point CFFT structure
[in,out]	p1	points to the complex data buffer of size 2*fftLen. Processing occurs in-place
[in]	ifftFlag	flag that selects transform direction value = 0: forward transform value = 1: inverse transform
[in]	bitReverseFlag	flag that enables / disables bit reversal of output value = 0: disables bit reversal of output value = 1: enables bit reversal of output

Returns

none