[processor-sdk/performance-audio-sr.git] / psdk_cust / pdk_k2g_1_0_1_1_eng / packages / ti / csl / csl_msmc.h
1 /**
2 * @file csl_msmc.h
3 *
4 * @brief
5 * This is the main header file for the MSMC Module which defines
6 * all the data structures and exported API.
7 *
8 * \par
9 * ============================================================================
10 * @n (C) Copyright 2008, 2009, Texas Instruments, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 *
16 * Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the
22 * distribution.
23 *
24 * Neither the name of Texas Instruments Incorporated nor the names of
25 * its contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 */
42 /** @defgroup CSL_MSMC_API MSMC
43 *
44 * @section Introduction
45 *
46 * @subsection xxx Overview
47 * The MSMC is a module designed to manage traffic between multiple processor cores, other
48 * mastering peripherals or DMA and the EMIF in a multi-core SoC. The MSMC provides a shared
49 * on-chip memory that can be used either as a shared on-chip SRAM or a cache for external
50 * memory traffic. It is part of the compute infrastructure for CGEM 0.5 and hence is designed to
51 * work with the CGEM 0.5 processor cores.
52 *
53 * @subsection References
54 * -# MSMC User's Guide
55 *
56 * @subsection Assumptions
57 * The abbreviations MSMC, msmc and Msmc have been used throughout this
58 * document to refer to Multi-Core Shared Memory Controller
59 */
61 #ifndef CSL_MSMC_H
62 #define CSL_MSMC_H
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
68 #include <ti/csl/soc.h>
69 #include <ti/csl/csl.h>
70 #include <ti/csl/cslr_msmc.h>
72 /**
73 @defgroup CSL_MSMC_SYMBOL MSMC Symbols Defined
74 @ingroup CSL_MSMC_API
75 */
76 /**
77 @defgroup CSL_MSMC_DATASTRUCT MSMC Data Structures
78 @ingroup CSL_MSMC_API
79 */
80 /**
81 @defgroup CSL_MSMC_FUNCTION MSMC Functions
82 @ingroup CSL_MSMC_API
83 */
85 /**
86 @addtogroup CSL_MSMC_SYMBOL
87 @{
88 */
90 /**
91 * Handle to access MSMC registers accessible through config bus.
92 */
93 #define hMsmc ((CSL_MsmcRegs*)CSL_MSMC_CFG_REGS)
95 /**
96 @}
97 */
99 /** @addtogroup CSL_MSMC_DATASTRUCT
100 @{ */
102 typedef struct {
103 Uint16 baddr;
104 Uint8 segSz;
105 }CSL_MSMC_SMSMPAXH;
107 typedef struct {
108 Uint16 raddr;
109 Uint32 sr;
110 Uint32 sw;
111 Uint32 sx;
112 Uint32 ur;
113 Uint32 uw;
114 Uint32 ux;
115 }CSL_MSMC_SMSMPAXL;
117 typedef struct {
118 Uint32 baddr;
119 Uint32 be;
120 Uint32 ai;
121 Uint8 segSz;
122 }CSL_MSMC_SESMPAXH;
124 typedef struct {
125 Uint32 raddr;
126 Uint32 sr;
127 Uint32 sw;
128 Uint32 sx;
129 Uint32 ur;
130 Uint32 uw;
131 Uint32 ux;
132 }CSL_MSMC_SESMPAXL;
134 /* @} */
136 /** @addtogroup CSL_MSMC_FUNCTION
137 @{ */
139 /* @} */
142 #ifdef __cplusplus
143 }
144 #endif
145 #endif /* CSL_MSMC_H */