Initial code package commit.
[apps/c55x-digital-mic-decimation.git] / include / pick_bits_cic.h
1 /* ============================================================================
2  * Copyright (c) 2016 Texas Instruments Incorporated.
3  *
4  *  Redistribution and use in source and binary forms, with or without
5  *  modification, are permitted provided that the following conditions
6  *  are met:
7  *
8  *    Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *
11  *    Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the
14  *    distribution.
15  *
16  *    Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32   ===============================================================================*/
34 #ifndef __PICK_BITS_CIC_H__
35 #define __PICK_BITS_CIC_H__
37 //#include "data_types.h"
39 #define CIC_DF  ( 16 )  /* decimation factor for CIC */
40 #define CIC_NS  ( 4 )   /* number of stages for CIC */
42 /* Unpacks "left" and "right" 32-bit packed DMA buffers containing output from digital mic. */
43 /* Performs CIC on unpacked data, DS = 16 & NS = 4. */
44 void pickBitsCic(
45     Uint32 *lData,          /* "left" channel 32-bit packed input data */
46     Uint32 *rData,          /* "right" channel 32-bit packed input data */
47     Uint16 inDataLen,       /* length of "left" or "right" input data in 32-bit words */
48     Int32 *cicState,        /* CIC state. First NS values are integrator state, next NS values are differentiator delay buffer */
49     Int32 *outSamps,        /* CIC output samples */
50     Uint16 *pNumOutSamps    /* CIC number of output samples */
51 );
53 #endif  
55 /* __PICK_BITS_CIC_H__ */