AM275 FreeRTOS SDK  11.01.00
aasrc_types.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2025 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 
47 #ifndef AASRC_TYPES_H_
48 #define AASRC_TYPES_H_
49 
50 /* ========================================================================== */
51 /* Include Files */
52 /* ========================================================================== */
53 
54 /* None */
55 
56 #ifdef __cplusplus
57 extern "C" {
58 #endif
59 
60 /* ========================================================================== */
61 /* Macros & Typedefs */
62 /* ========================================================================== */
63 
65 typedef void *AASRC_Handle;
66 
68 typedef void *AASRC_ClkZoneHandle;
69 
71 typedef void *AASRC_ChHandle;
72 
74 typedef void *AASRC_DmaHandle;
75 
85 #define AASRC_SOK ( (int32_t) (0))
86 
88 #define AASRC_EFAIL (-(int32_t) (1))
89 
91 #define AASRC_EBADARGS (-(int32_t) (2))
92 
94 #define AASRC_EINVALID_PARAMS (-(int32_t) (3))
95 
98 #define AASRC_ETIMEOUT (-(int32_t) (4))
99 
100 #define AASRC_EALLOC (-(int32_t) (5))
101 
115 #define AASRC_MONO (0U)
116 #define AASRC_STEREO (1U)
117 #define AASRC_GROUP (2U)
118 
120 /* ========================================================================== */
121 /* Structure Declarations */
122 /* ========================================================================== */
123 
124 /* None */
125 
126 /* ========================================================================== */
127 /* Function Declarations */
128 /* ========================================================================== */
129 
130 /* None */
131 
132 /* ========================================================================== */
133 /* Static Function Definitions */
134 /* ========================================================================== */
135 
136 /* None */
137 
138 #ifdef __cplusplus
139 }
140 #endif
141 
142 #endif /* #ifndef AASRC_TYPES_H_ */
143 
AASRC_ClkZoneHandle
void * AASRC_ClkZoneHandle
AASRC clock zone handle whic points to clk_zone structure.
Definition: aasrc_types.h:68
AASRC_ChHandle
void * AASRC_ChHandle
AASRC channel handle which points to AASRC channnel status and configs.
Definition: aasrc_types.h:71
AASRC_Handle
void * AASRC_Handle
A handle that is returned from a AASRC_open() call.
Definition: aasrc_types.h:65
AASRC_DmaHandle
void * AASRC_DmaHandle
AASRC udma handle which points to udma instance.
Definition: aasrc_types.h:74