PASDK-516:Add updates for PCE
[processor-sdk/performance-audio-sr.git] / pasdk / test_dsp / framework / audioStreamOutIo.h
2 /*
3 Copyright (c) 2018, Texas Instruments Incorporated - http://www.ti.com/
4 All rights reserved.
6 * Redistribution and use in source and binary forms, with or without 
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the
16 * distribution.
17 *
18 * Neither the name of Texas Instruments Incorporated nor the names of
19 * its contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
36 /*
37  *  ======== audioStreamOutIo.h ========
38  */
40 #ifndef _ASOP_IO_H_
41 #define _ASOP_IO_H_
43 #include <xdc/std.h>
45 #include "audioStreamOutProc.h"
48 // Select Output devices
49 Int asopSelectDevices(
50     PAF_AST_IoOut *pOut
51 );
53 // Check if Output device SIO selection changed
54 Int checkOutDevSioSelUpdate(
55     const PAF_ASOT_Params *pP, 
56     PAF_ASOT_Config *pAsotCfg,
57     Int z, 
58     Bool *pOutDevSelUpdate
59 );
61 // Check if any Output device SIO selection changed
62 Int checkAnyOutDevSioSelUpdate(
63     const PAF_ASOT_Params *pP, 
64     PAF_ASOT_Config *pAsotCfg,
65     Bool *pOutDevSelUpdate
66 );
68 // Re-initiate Output
69 Int asopSetCheckRateX(
70     const PAF_ASOT_Params *pP, 
71     const PAF_ASOT_Patchs *pQ, 
72     PAF_ASOT_Config *pAsotCfg, 
73     Int check);
75 // Initiate Output
76 Int asopStartOutput(
77     const PAF_ASOT_Params *pP,
78     const PAF_ASOT_Patchs *pQ,
79     PAF_ASOT_Config *pAsotCfg
80 );
82 // Terminate Output
83 Int asopStopOutput(
84     const PAF_ASOT_Params *pP, 
85     const PAF_ASOT_Patchs *pQ, 
86     PAF_ASOT_Config *pAsotCfg
87 );
89 // Initialize I/O components for output processing
90 Int asopIoCompsInit(
91     PAF_AST_OutBuf *pOutBuf, 
92     PAF_AST_IoOut *pOutIo
93 );
95 // Check I/O physical layer initialized
96 Bool asopIoPhyCheckInit(Void);
98 // I/O physical layer prime operation required by McASP LLD
99 Void asopIoPhyPrime(
100     PAF_AST_IoOut *pOut
101 );
103 // Initialize Output buffer configuration
104 Int asopInitOutBufConfig(
105     PAF_AST_OutBuf *pOutBuf, 
106     PAF_AST_IoOut *pOutIo
107 );
109 // Update Output buffer configuration
110 Int asopUpdateOutBufConfig(
111     PAF_AST_OutBuf *pOutBuf, 
112     PAF_AST_IoOut *pOutIo
113 );
115 // Mark Output buffers write complete
116 Int asopMarkOutBuffsWriteComplete(
117     PAF_AST_OutBuf *pOutBuf, 
118     PAF_AST_IoOut *pOutIo
119 );
121 // This function starts an I/O PHY transfer for output 
122 Void asopPhyTransferStart(
123     PAF_AST_IoOut *pOut
124 );
127 #endif /* _ASOP_IO_H_ */