AM275 FreeRTOS SDK  11.01.00
aasrc_clocking.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 
48 #ifndef AASRC_CLOCKING_H_
49 #define AASRC_CLOCKING_H_
50 
51 /* ========================================================================== */
52 /* Include Files */
53 /* ========================================================================== */
54 #include <drivers/aasrc/v0/aasrc.h>
55 
56 /* None */
57 
58 #ifdef __cplusplus
59 extern "C" {
60 #endif
61 
62 /* ========================================================================== */
63 /* Macros & Typedefs */
64 /* ========================================================================== */
65 
67 #define AASRC_RXSYNC_PIN_COUNT (4U)
68 
69 #define AASRC_TXSYNC_PIN_COUNT (4U)
70 
79 #define AASRC_RXSYNC0_IDX (0U)
80 #define AASRC_RXSYNC1_IDX (1U)
81 #define AASRC_RXSYNC2_IDX (2U)
82 #define AASRC_RXSYNC3_IDX (3U)
83 
93 #define AASRC_TXSYNC0_IDX (0U)
94 #define AASRC_TXSYNC1_IDX (1U)
95 #define AASRC_TXSYNC2_IDX (2U)
96 #define AASRC_TXSYNC3_IDX (3U)
97 
100 #define AASRC_INPUT_CLOCK_ZONE_COUNT (4U)
101 #define AASRC_OUTPUT_CLOCK_ZONE_COUNT (4U)
102 
111 #define AASRC_INPUT_CLOCK_ZONE0_IDX (0U)
112 #define AASRC_INPUT_CLOCK_ZONE1_IDX (1U)
113 #define AASRC_INPUT_CLOCK_ZONE2_IDX (2U)
114 #define AASRC_INPUT_CLOCK_ZONE3_IDX (3U)
115 
125 #define AASRC_OUTPUT_CLOCK_ZONE0_IDX (0U)
126 #define AASRC_OUTPUT_CLOCK_ZONE1_IDX (1U)
127 #define AASRC_OUTPUT_CLOCK_ZONE2_IDX (2U)
128 #define AASRC_OUTPUT_CLOCK_ZONE3_IDX (3U)
129 
132 #define AASRC_INTERNAL_CLOCK_DIVISOR_MAX_VAL (1U << 14U)
133 
135 #define AASRC_AUDIO_CLK_FREQUENCY_MAX (216U) // number is in KHz
136 
138 #define AASRC_CLK_RATIO_MAX (16U)
139 
141 #define AASRC_CLK_SRC_MAX_FOR_DIVIDER (96U) // number is in MHz
142 
144 #define AASRC_CLOCKZONE_CONTROL_REG_OFFSET (0x00000080U)
145 
146 #define AASRC_INPUT_CLOCKZONE_CONTROL(x) ((uint32_t) CSL_AASRC_CFG_INPUT_CLOCKZONE_CONTROL_0 + \
147  (uint32_t) ((uint32_t) AASRC_CLOCKZONE_CONTROL_REG_OFFSET * \
148  (uint32_t) (x)))
149 
150 #define AASRC_OUTPUT_CLOCKZONE_CONTROL(x) ((uint32_t) CSL_AASRC_CFG_OUTPUT_CLOCKZONE_CONTROL_0 + \
151  (uint32_t) ((uint32_t) AASRC_CLOCKZONE_CONTROL_REG_OFFSET * \
152  (uint32_t) (x)))
153 
155 #define AASRC_CLOCK_RECOVERY_LOOP_RATE_REG_OFFSET (0x00000080U)
156 
157 #define AASRC_INPUT_CLOCK_RECOVERY_LOOP_RATE_LO(x) ((uint32_t) CSL_AASRC_CFG_INPUT_CLOCK_RECOVERY_LOOP_RATE_LO_0 + \
158  (uint32_t) ((uint32_t) AASRC_CLOCK_RECOVERY_LOOP_RATE_REG_OFFSET * \
159  (uint32_t) (x)))
160 
161 #define AASRC_INPUT_CLOCK_RECOVERY_LOOP_RATE_HI(x) ((uint32_t) CSL_AASRC_CFG_INPUT_CLOCK_RECOVERY_LOOP_RATE_HI_0 + \
162  (uint32_t) ((uint32_t) AASRC_CLOCK_RECOVERY_LOOP_RATE_REG_OFFSET * \
163  (uint32_t) (x)))
164 
165 #define AASRC_OUTPUT_CLOCK_RECOVERY_LOOP_RATE_LO(x) ((uint32_t) CSL_AASRC_CFG_OUTPUT_CLOCK_RECOVERY_LOOP_RATE_LO_0 + \
166  (uint32_t) ((uint32_t) AASRC_CLOCK_RECOVERY_LOOP_RATE_REG_OFFSET * \
167  (uint32_t) (x)))
168 
169 #define AASRC_OUTPUT_CLOCK_RECOVERY_LOOP_RATE_HI(x) ((uint32_t) CSL_AASRC_CFG_OUTPUT_CLOCK_RECOVERY_LOOP_RATE_HI_0 + \
170  (uint32_t) ((uint32_t) AASRC_CLOCK_RECOVERY_LOOP_RATE_REG_OFFSET * \
171  (uint32_t) (x)))
172 
173 /* ========================================================================== */
174 /* Structure Declarations */
175 /* ========================================================================== */
176 
177 /* ========================================================================== */
178 /* API Function Declarations */
179 /* ========================================================================== */
180 
193 int32_t AASRC_ClkZoneRxConfig(uint8_t clockZoneIdx, AASRC_Handle drvHandle);
194 
207 int32_t AASRC_ClkZoneTxConfig(uint8_t clockZoneIdx, AASRC_Handle drvHandle);
208 
226 int32_t AASRC_IsClockZoneRxSettled(AASRC_ChHandle chHandle, bool *isClkSettled);
227 
245 int32_t AASRC_IsClockZoneTxSettled(AASRC_ChHandle chHandle, bool *isClkSettled);
246 
264 int32_t AASRC_GetClkZoneRxFrequency(AASRC_ChHandle chHandle,float *clkFrequency);
265 
266 
284 int32_t AASRC_GetClkZoneTxFrequency(AASRC_ChHandle chHandle,float *clkFrequency);
285 
286 
287 /* ========================================================================== */
288 /* Static Function Definitions */
289 /* ========================================================================== */
290 
291 /* None */
292 
293 #ifdef __cplusplus
294 }
295 #endif
296 
297 #endif /* #ifndef AASRC_CLOCKING_H_ */
298 
AASRC_ChHandle
void * AASRC_ChHandle
AASRC channel handle which points to AASRC channnel status and configs.
Definition: aasrc_types.h:71
AASRC_IsClockZoneRxSettled
int32_t AASRC_IsClockZoneRxSettled(AASRC_ChHandle chHandle, bool *isClkSettled)
Check if the queried AASRC input clock zone is settled.
AASRC_GetClkZoneTxFrequency
int32_t AASRC_GetClkZoneTxFrequency(AASRC_ChHandle chHandle, float *clkFrequency)
Reads AASRC output clock frequency for a given clock zone.
aasrc.h
AASRC Driver API/interface file.
AASRC_ClkZoneRxConfig
int32_t AASRC_ClkZoneRxConfig(uint8_t clockZoneIdx, AASRC_Handle drvHandle)
AASRC input clock zone configuration.
AASRC_GetClkZoneRxFrequency
int32_t AASRC_GetClkZoneRxFrequency(AASRC_ChHandle chHandle, float *clkFrequency)
Reads AASRC input clock frequency for a given clock zone.
AASRC_Handle
void * AASRC_Handle
A handle that is returned from a AASRC_open() call.
Definition: aasrc_types.h:65
AASRC_ClkZoneTxConfig
int32_t AASRC_ClkZoneTxConfig(uint8_t clockZoneIdx, AASRC_Handle drvHandle)
AASRC output clock zone configuration.
AASRC_IsClockZoneTxSettled
int32_t AASRC_IsClockZoneTxSettled(AASRC_ChHandle chHandle, bool *isClkSettled)
Check if the queried AASRC output clock zone is settled.