xWRL6432 MMWAVE-L-SDK  05.01.00.04
soc.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 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 
33 #ifndef SOC_XWRL64XX_H_
34 #define SOC_XWRL64XX_H_
35 
36 #include <stdint.h>
37 
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42 
52 #include <kernel/dpl/SystemP.h>
54 #include <drivers/hw_include/cslr_soc.h>
55 
61 #define SOC_DOMAIN_ID_TOPSS_CTRL (0U)
62 #define SOC_DOMAIN_ID_APP_RCM (1U)
63 #define SOC_DOMAIN_ID_APP_CTRL (2U)
64 #define SOC_DOMAIN_ID_TOP_IO_MUX (3U)
65 
76 int32_t SOC_moduleClockEnable(uint32_t moduleId, uint32_t enable);
77 
84 int32_t SOC_clocksEnable(void);
95 int32_t SOC_moduleSetClockFrequency(uint32_t moduleId, uint32_t clkId, uint64_t clkRate);
96 
104 const char *SOC_getCoreName(uint16_t coreId);
105 
112 void SOC_controlModuleLockMMR(uint32_t domainId, uint32_t partition);
113 
120 void SOC_controlModuleUnlockMMR(uint32_t domainId, uint32_t partition);
121 
125 void SOC_logAllClockHz(void);
126 
134 uint64_t SOC_virtToPhy(void *virtAddr);
135 
139 void SOC_memoryInit(void);
140 
145 
148 #ifdef __cplusplus
149 }
150 #endif
151 
152 #endif
SOC_moduleSetClockFrequency
int32_t SOC_moduleSetClockFrequency(uint32_t moduleId, uint32_t clkId, uint64_t clkRate)
Set module clock to specified frequency.
SOC_controlModuleUnlockMMR
void SOC_controlModuleUnlockMMR(uint32_t domainId, uint32_t partition)
Unlock control module partition to allow writes into control MMRs.
SOC_virtToPhy
uint64_t SOC_virtToPhy(void *virtAddr)
SOC Virtual (CPU) to Physical address translation function.
SystemP.h
soc_rcm.h
SOC_memoryInit
void SOC_memoryInit(void)
Initializes HWA shared RAM0, RAM1.
SOC_logAllClockHz
void SOC_logAllClockHz(void)
Print's module clock info to the console.
SOC_controlModuleLockMMR
void SOC_controlModuleLockMMR(uint32_t domainId, uint32_t partition)
Lock control module partition to prevent writes into control MMRs.
SOC_moduleClockEnable
int32_t SOC_moduleClockEnable(uint32_t moduleId, uint32_t enable)
Enable clock to specified module.
SOC_enableMDLLClock
void SOC_enableMDLLClock(void)
Enables MDLL Clock.
SOC_getCoreName
const char * SOC_getCoreName(uint16_t coreId)
Convert a core ID to a user readable name.
SOC_clocksEnable
int32_t SOC_clocksEnable(void)
Enables ADPLL.