1 /*==============================================================================
2 Copyright(c) 2017 Intel Corporation
3
4 Permission is hereby granted, free of charge, to any person obtaining a
5 copy of this software and associated documentation files(the "Software"),
6 to deal in the Software without restriction, including without limitation
7 the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 and / or sell copies of the Software, and to permit persons to whom the
9 Software is furnished to do so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included
12 in all copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 OTHER DEALINGS IN THE SOFTWARE.
21 ============================================================================*/
22
23 #include "Internal/Common/GmmLibInc.h"
24 #include "External/Common/GmmCachePolicy.h"
25
26 /////////////////////////////////////////////////////////////////////////////////////
27 /// C Wrapper function for GmmLib::GmmCachePolicyGetPteType
28 /// @see GmmLib::GmmCachePolicyCommon::CachePolicyGetPteType()
29 //
30 /// @param[in] pLibContext: pGmmLibContext
31 /// @param[in] Usage: type of usage
32 ///
33 /// @return GMM_PTE_CACHE_CONTROL_BITS:Populated PTE
34 ///
35 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetPteType(void * pLibContext,GMM_RESOURCE_USAGE_TYPE Usage)36 GMM_PTE_CACHE_CONTROL_BITS GMM_STDCALL GmmCachePolicyGetPteType(void *pLibContext, GMM_RESOURCE_USAGE_TYPE Usage)
37 {
38 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
39 return pGmmLibContext->GetCachePolicyObj()->CachePolicyGetPteType(Usage);
40 }
41 /////////////////////////////////////////////////////////////////////////////////////
42 /// C Wrapper function for GmmLib::GmmCachePolicyGetPATIndex
43 /// @see GmmLib::GmmCachePolicyCommon::CachePolicyGetPATIndex()
44 ///
45 /// @param[in] pLibContext: pGmmLibContext
46 /// @param[in] Usage: type of usage
47 /// @param[Optional] Usage: for Compression Enable
48 ///
49 /// @return uint32_t
50 ///
51 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetPATIndex(void * pLibContext,GMM_RESOURCE_USAGE_TYPE Usage,bool * pCompressionEnable,bool IsCpuCacheable)52 uint32_t GMM_STDCALL GmmCachePolicyGetPATIndex(void *pLibContext, GMM_RESOURCE_USAGE_TYPE Usage, bool *pCompressionEnable, bool IsCpuCacheable)
53 {
54 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
55 return pGmmLibContext->GetCachePolicyObj()->CachePolicyGetPATIndex(NULL, Usage, pCompressionEnable, IsCpuCacheable);
56 }
57
58 /////////////////////////////////////////////////////////////////////////////////////
59 /// C Wrapper function for GmmLib::GmmCachePolicyIsUsagePTECached
60 /// @see GmmLib::GmmCachePolicyCommon::CachePolicyIsUsagePTECached()
61 ///
62 /// @param[in] pLibContext: pGmmLibContext
63 /// @param[in] Usage: type of usage
64 ///
65 /// @return 1 if the usage PTE entry is set for cached, 0 otherwise.
66 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyIsUsagePTECached(void * pLibContext,GMM_RESOURCE_USAGE_TYPE Usage)67 uint8_t GMM_STDCALL GmmCachePolicyIsUsagePTECached(void *pLibContext, GMM_RESOURCE_USAGE_TYPE Usage)
68 {
69 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
70 return pGmmLibContext->GetCachePolicyObj()->CachePolicyIsUsagePTECached(Usage);
71 }
72 /////////////////////////////////////////////////////////////////////////////////////
73 /// C Wrapper function to return L1 Cache Control on DG2 for a given resource type
74 ///
75 /// @param[in] pLibContext: pGmmLibContext
76 /// @param[in] Usage: type of usage
77 ///
78 /// @return Value of L1 Cache control.
79 /////////////////////////////////////////////////////////////////////////////////////
GmmGetSurfaceStateL1CachePolicy(void * pLibContext,GMM_RESOURCE_USAGE_TYPE Usage)80 uint8_t GMM_STDCALL GmmGetSurfaceStateL1CachePolicy(void *pLibContext, GMM_RESOURCE_USAGE_TYPE Usage)
81 {
82 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
83 return (uint8_t)pGmmLibContext->GetCachePolicyObj()->GetSurfaceStateL1CachePolicy(Usage);
84 }
85
86 /////////////////////////////////////////////////////////////////////////////////////
87 /// C Wrapper function to return L2 Cache Control on MTL for a given resource type
88 ///
89 /// @param[in] pLibContext: pGmmLibContext
90 /// @param[in] Usage: type of usage
91 ///Value of L2 Cache support
92 /////////////////////////////////////////////////////////////////////////////////////
GmmGetSurfaceStateL2CachePolicy(void * pLibContext,GMM_RESOURCE_USAGE_TYPE Usage)93 uint8_t GMM_STDCALL GmmGetSurfaceStateL2CachePolicy(void *pLibContext, GMM_RESOURCE_USAGE_TYPE Usage)
94 {
95 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
96 return pGmmLibContext->GetCachePolicyElement(Usage).L2CC;
97 }
98 /////////////////////////////////////////////////////////////////////////////////////
99 /// C wrapper for GmmLib::GmmResourceInfoCommon::GetCachePolicyUsage.
100 /// @see GmmLib::GmmResourceInfoCommon::GetCachePolicyUsage()
101 ///
102 /// @param[in] pGmmResource: Pointer to the GmmResourceInfo class
103 /// @return Cache policy usage
104 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetResourceUsage(GMM_RESOURCE_INFO * pResInfo)105 GMM_RESOURCE_USAGE_TYPE GMM_STDCALL GmmCachePolicyGetResourceUsage(GMM_RESOURCE_INFO *pResInfo)
106 {
107 __GMM_ASSERT(pResInfo);
108 return pResInfo->GetCachePolicyUsage();
109 }
110
111 /////////////////////////////////////////////////////////////////////////////////////
112 /// C wrapper for GmmLib::GmmResourceInfoCommon::OverrideCachePolicyUsage.
113 /// @see GmmLib::GmmResourceInfoCommon::OverrideCachePolicyUsage()
114 ///
115 /// @param[in] pGmmResource: Pointer to the GmmResourceInfo class
116 /// @param[in] Cache policy usage
117 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyOverrideResourceUsage(GMM_RESOURCE_INFO * pResInfo,GMM_RESOURCE_USAGE_TYPE Usage)118 void GMM_STDCALL GmmCachePolicyOverrideResourceUsage(GMM_RESOURCE_INFO *pResInfo, GMM_RESOURCE_USAGE_TYPE Usage)
119 {
120 pResInfo->OverrideCachePolicyUsage(Usage);
121 }
122
123 /////////////////////////////////////////////////////////////////////////////////////
124 /// C Wrapper function for GmmLib::GmmCachePolicyGetMemoryObject
125 /// @see GmmLib::GmmCachePolicyCommon::CachePolicyGetMemoryObject()
126 ///
127 /// param[in] pResInfo: Resource info for resource, can be NULL.
128 /// param[in] Usage: Current usage for resource.
129 ///
130 /// @return MEMORY_OBJECT_CONTROL_STATE: Gen adjusted MOCS structure (cache
131 /// policy) for the given buffer use.
132 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMemoryObject(void * pLibContext,GMM_RESOURCE_INFO * pResInfo,GMM_RESOURCE_USAGE_TYPE Usage)133 MEMORY_OBJECT_CONTROL_STATE GMM_STDCALL GmmCachePolicyGetMemoryObject(void *pLibContext, GMM_RESOURCE_INFO *pResInfo, GMM_RESOURCE_USAGE_TYPE Usage)
134 {
135 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
136 return pGmmLibContext->GetCachePolicyObj()->CachePolicyGetMemoryObject(pResInfo, Usage);
137 }
138
139 /////////////////////////////////////////////////////////////////////////////////////
140 /// C Wrapper function for GmmLib::GmmCachePolicyGetOriginalMemoryObject
141 /// @see GmmLib::GmmCachePolicyCommon::CachePolicyGetOriginalMemoryObject()
142 ///
143 /// @param[in] pResInfo: Resource info for resource , can be null
144 /// @param[in] Usage: Current usage for resource
145 ///
146 /// @return MEMORY_OBJECT_CONTROL_STATE: Populated memory object
147 ///
148 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetOriginalMemoryObject(void * pLibContext,GMM_RESOURCE_INFO * pResInfo)149 MEMORY_OBJECT_CONTROL_STATE GMM_STDCALL GmmCachePolicyGetOriginalMemoryObject(void *pLibContext, GMM_RESOURCE_INFO *pResInfo)
150 {
151 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
152 return pGmmLibContext->GetCachePolicyObj()->CachePolicyGetOriginalMemoryObject(pResInfo);
153 }
154 /////////////////////////////////////////////////////////////////////////////////////
155 /// C Wrapper function for GmmCachePolicy::GmmGetWantedMemoryType.
156 /// @see GmmLib::GmmCachePolicy::GetWantedMemoryType()
157 ///
158 /// @param[in] pLibContext: pGmmLibContext
159 /// @param[in] CachePolicy:cache policy for a usage
160 ///
161 /// @return wanted memory type
162 /////////////////////////////////////////////////////////////////////////////////////
GmmGetWantedMemoryType(void * pLibContext,GMM_CACHE_POLICY_ELEMENT CachePolicy)163 GMM_GFX_MEMORY_TYPE GmmGetWantedMemoryType(void *pLibContext, GMM_CACHE_POLICY_ELEMENT CachePolicy)
164 {
165 GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
166 return pGmmLibContext->GetCachePolicyObj()->GetWantedMemoryType(CachePolicy);
167 }
168 /////////////////////////////////////////////////////////////////////////////////////
169 /// Returns count of current MOCS values for MOCS Table programming at GMM boot
170 ///
171 /// @param[in] pLibContext: pGmmLibContext
172 /// @return uint32_t no of mocs register required to program
173 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMaxMocsIndex(void * pLibContext)174 uint32_t GMM_STDCALL GmmCachePolicyGetMaxMocsIndex(void *pLibContext)
175 {
176 GMM_LIB_CONTEXT * pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
177 GMM_CACHE_POLICY * pCachePolicy = pGmmLibContext->GetCachePolicyObj();
178 GmmLib::GmmGen9CachePolicy *ptr = static_cast<GmmLib::GmmGen9CachePolicy *>(pCachePolicy);
179 return ptr->CurrentMaxMocsIndex;
180 }
181 /////////////////////////////////////////////////////////////////////////////////////
182 /// Returns count of current L1 HDC MOCS values for MOCS Table programming at GMM boot
183 ///
184 /// @param[in] pLibContext: pGmmLibContext
185 /// @return uint32_t max L1 hdc mocs index needed to program
186 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMaxL1HdcMocsIndex(void * pLibContext)187 uint32_t GMM_STDCALL GmmCachePolicyGetMaxL1HdcMocsIndex(void *pLibContext)
188 {
189 GMM_LIB_CONTEXT * pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
190 GMM_CACHE_POLICY * pCachePolicy = pGmmLibContext->GetCachePolicyObj();
191 GmmLib::GmmGen9CachePolicy *ptr = static_cast<GmmLib::GmmGen9CachePolicy *>(pCachePolicy);
192 return ptr->CurrentMaxL1HdcMocsIndex;
193 }
194
195 /////////////////////////////////////////////////////////////////////////////////////
196 /// Returns count of current Special MOCS values for MOCS Table programming at GMM boot
197 ///
198 /// @param[in] pLibContext: pGmmLibContext
199 /// @return uint32_t max special mocs index needed to program
200 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMaxSpecialMocsIndex(void * pLibContext)201 uint32_t GMM_STDCALL GmmCachePolicyGetMaxSpecialMocsIndex(void *pLibContext)
202 {
203 GMM_LIB_CONTEXT * pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
204 GMM_CACHE_POLICY *pCachePolicy = pGmmLibContext->GetCachePolicyObj();
205 return pCachePolicy->GetMaxSpecialMocsIndex();
206 }
207