AM273x MCU+ SDK  09.02.00
soc.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021-2023 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_AM273X_H_
34 #define SOC_AM273X_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/am273x/cslr_soc_baseaddress.h>
55 #include <drivers/hw_include/cslr_soc.h>
56 
62 #define SOC_DOMAIN_ID_MSS_TOP_RCM (0U)
63 #define SOC_DOMAIN_ID_MSS_RCM (1U)
64 #define SOC_DOMAIN_ID_DSS_RCM (2U)
65 #define SOC_DOMAIN_ID_RCSS_RCM (3U)
66 #define SOC_DOMAIN_ID_MSS_CTRL (4U)
67 #define SOC_DOMAIN_ID_DSS_CTRL (5U)
68 #define SOC_DOMAIN_ID_RCSS_CTRL (6U)
69 #define SOC_DOMAIN_ID_MSS_IOMUX (7U)
70 
73 #define IS_QSPI_BASE_ADDR_VALID(baseAddr) (baseAddr == CSL_MSS_QSPI_U_BASE)
74 
76 #define IS_QSPI_MEMORY_MAP_ADDR_VALID(baseAddr) (baseAddr == CSL_EXT_FLASH_U_BASE)
77 
78 #define IS_I2C_BASE_ADDR_VALID(baseAddr) ((baseAddr == CSL_MSS_I2C_U_BASE) || \
79  (baseAddr == CSL_RCSS_I2CA_U_BASE) || \
80  (baseAddr == CSL_RCSS_I2CB_U_BASE))
81 
82 
92 int32_t SOC_moduleClockEnable(uint32_t moduleId, uint32_t enable);
93 
104 int32_t SOC_moduleSetClockFrequency(uint32_t moduleId, uint32_t clkId, uint64_t clkRate);
105 
113 const char *SOC_getCoreName(uint16_t coreId);
114 
120 uint64_t SOC_getSelfCpuClk(void);
121 
128 void SOC_controlModuleLockMMR(uint32_t domainId, uint32_t partition);
129 
136 void SOC_controlModuleUnlockMMR(uint32_t domainId, uint32_t partition);
137 
144 void SOC_setEpwmTbClk(uint32_t epwmInstance, uint32_t enable);
145 
153 uint64_t SOC_virtToPhy(void *virtAddr);
154 
162 void *SOC_phyToVirt(uint64_t phyAddr);
163 
167 void SOC_logAllClockHz(void);
168 
175 
178 #ifdef __cplusplus
179 }
180 #endif
181 
182 #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_getFlashDataBaseAddr
uint32_t SOC_getFlashDataBaseAddr(void)
This function gets the SOC mapped data base address of the flash.
soc_rcm.h
SOC_logAllClockHz
void SOC_logAllClockHz(void)
Print's module clock info to the console.
SOC_phyToVirt
void * SOC_phyToVirt(uint64_t phyAddr)
Physical to Virtual (CPU) address translation function.
SOC_getSelfCpuClk
uint64_t SOC_getSelfCpuClk(void)
Get the clock frequency in Hz of the CPU on which the driver is running.
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_getCoreName
const char * SOC_getCoreName(uint16_t coreId)
Convert a core ID to a user readable name.
SOC_setEpwmTbClk
void SOC_setEpwmTbClk(uint32_t epwmInstance, uint32_t enable)
Enable or disable ePWM time base clock from Control MMR.