Logo
MSP DSP Library
Utility

Data Structures

struct  msp_copy_q15_params
 Parameters for Q15 vector copy function. More...
 
struct  msp_copy_iq31_params
 Parameters for IQ31 vector copy function. More...
 
struct  msp_fill_q15_params
 Parameters for Q15 real vector fill. More...
 
struct  msp_fill_iq31_params
 Parameters for IQ31 real vector fill. More...
 
struct  msp_cmplx_fill_q15_params
 Parameters for Q15 complex vector fill. More...
 
struct  msp_cmplx_fill_iq31_params
 Parameters for IQ31 complex vector fill. More...
 
struct  msp_deinterleave_q15_params
 Parameters for Q15 vector deinterleave. More...
 
struct  msp_deinterleave_iq31_params
 Parameters for IQ31 vector deinterleave. More...
 

Functions

msp_status msp_copy_q15 (const msp_copy_q15_params *params, const _q15 *src, _q15 *dst)
 Real Q15 vector copy. More...
 
msp_status msp_copy_iq31 (const msp_copy_iq31_params *params, const _iq31 *src, _iq31 *dst)
 Real IQ31 vector copy. More...
 
msp_status msp_fill_q15 (const msp_fill_q15_params *params, _q15 *dst)
 Real Q15 vector fill with constant. More...
 
msp_status msp_fill_iq31 (const msp_fill_iq31_params *params, _iq31 *dst)
 Real IQ31 vector fill with constant. More...
 
msp_status msp_cmplx_fill_q15 (const msp_cmplx_fill_q15_params *params, _q15 *dst)
 Complex Q15 vector fill with constant. More...
 
msp_status msp_cmplx_fill_iq31 (const msp_cmplx_fill_iq31_params *params, _iq31 *dst)
 Complex IQ31 vector fill with constant. More...
 
msp_status msp_deinterleave_q15 (const msp_deinterleave_q15_params *params, _q15 *src, _q15 *dst)
 Extract a single channel from multiple-channel source. More...
 
msp_status msp_deinterleave_iq31 (const msp_deinterleave_iq31_params *params, _iq31 *src, _iq31 *dst)
 Extract a single channel from multiple-channel source. More...
 

Detailed Description

This file provides utility functions for operations such as data copy, array fill and deinterleaving of channel data.

Function Documentation

msp_status msp_cmplx_fill_iq31 ( const msp_cmplx_fill_iq31_params params,
_iq31 dst 
)

Complex IQ31 vector fill with constant.

Details
Fill of complex IQ31 destination vector with constant real and imaginary components.
Parameters
paramsPointer to the complex fill parameter structure.
dstPointer to the destination vector.
Returns
none.
msp_status msp_cmplx_fill_q15 ( const msp_cmplx_fill_q15_params params,
_q15 dst 
)

Complex Q15 vector fill with constant.

Details
Fill of complex Q15 destination vector with constant real and imaginary components.
Parameters
paramsPointer to the complex fill parameter structure.
dstPointer to the destination vector.
Returns
none.
msp_status msp_copy_iq31 ( const msp_copy_iq31_params params,
const _iq31 src,
_iq31 dst 
)

Real IQ31 vector copy.

Details
Copy of real IQ31 source vector to destination vector.
Parameters
paramsPointer to the vector copy parameter structure.
srcPointer to the source data to copy.
dstPointer to the destination vector.
Returns
none.
msp_status msp_copy_q15 ( const msp_copy_q15_params params,
const _q15 src,
_q15 dst 
)

Real Q15 vector copy.

Details
Copy of real Q15 source vector to destination vector.
Parameters
paramsPointer to the vector copy parameter structure.
srcPointer to the source data to copy.
dstPointer to the destination vector.
Returns
none.
msp_status msp_deinterleave_iq31 ( const msp_deinterleave_iq31_params params,
_iq31 src,
_iq31 dst 
)

Extract a single channel from multiple-channel source.

Details
A single IQ31 vector is extracted from multiple interleaved vectors. For example, a deinterleave operation to extract channel one from a four channel source vector x[] with channel length 4 will extract the following data:
x[1], x[5], x[9], x[13]
Parameters
paramsPointer to the deinterleave parameter structure.
srcPointer to the source data to filter.
Returns
none.
msp_status msp_deinterleave_q15 ( const msp_deinterleave_q15_params params,
_q15 src,
_q15 dst 
)

Extract a single channel from multiple-channel source.

Details
A single Q15 vector is extracted from multiple interleaved vectors. For example, a deinterleave operation to extract channel one from a four channel source vector x[] with channel length 4 will extract the following data:
x[1], x[5], x[9], x[13]
Parameters
paramsPointer to the deinterleave parameter structure.
srcPointer to the source data to filter.
Returns
none.
msp_status msp_fill_iq31 ( const msp_fill_iq31_params params,
_iq31 dst 
)

Real IQ31 vector fill with constant.

Details
Fill of real IQ31 destination vector with constant.
Parameters
paramsPointer to the vector copy parameter structure.
dstPointer to the destination vector.
Returns
none.
msp_status msp_fill_q15 ( const msp_fill_q15_params params,
_q15 dst 
)

Real Q15 vector fill with constant.

Details
Fill of real Q15 destination vector with constant.
Parameters
paramsPointer to the vector copy parameter structure.
dstPointer to the destination vector.
Returns
none.