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::GmmCachePolicyIsUsagePTECached
43 /// @see           GmmLib::GmmCachePolicyCommon::CachePolicyIsUsagePTECached()
44 ///
45 /// @param[in]     pLibContext: pGmmLibContext
46 /// @param[in]     Usage: type of usage
47 ///
48 /// @return        1 if the usage PTE entry is set for cached, 0 otherwise.
49 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyIsUsagePTECached(void * pLibContext,GMM_RESOURCE_USAGE_TYPE Usage)50 uint8_t GMM_STDCALL GmmCachePolicyIsUsagePTECached(void *pLibContext, GMM_RESOURCE_USAGE_TYPE Usage)
51 {
52     GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
53     return pGmmLibContext->GetCachePolicyObj()->CachePolicyIsUsagePTECached(Usage);
54 }
55 /////////////////////////////////////////////////////////////////////////////////////
56 /// C Wrapper function to return L1 Cache Control on DG2 for a given resource type
57 ///
58 /// @param[in]     pLibContext: pGmmLibContext
59 /// @param[in]     Usage: type of usage
60 ///
61 /// @return         Value of L1 Cache control.
62 /////////////////////////////////////////////////////////////////////////////////////
GmmGetSurfaceStateL1CachePolicy(void * pLibContext,GMM_RESOURCE_USAGE_TYPE Usage)63 uint8_t GMM_STDCALL GmmGetSurfaceStateL1CachePolicy(void *pLibContext, GMM_RESOURCE_USAGE_TYPE Usage)
64 {
65     GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
66     return pGmmLibContext->GetCachePolicyElement(Usage).L1CC;
67 }
68 
69 /////////////////////////////////////////////////////////////////////////////////////
70 /// C wrapper for GmmLib::GmmResourceInfoCommon::GetCachePolicyUsage.
71 /// @see        GmmLib::GmmResourceInfoCommon::GetCachePolicyUsage()
72 ///
73 /// @param[in]      pGmmResource: Pointer to the GmmResourceInfo class
74 /// @return         Cache policy usage
75 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetResourceUsage(GMM_RESOURCE_INFO * pResInfo)76 GMM_RESOURCE_USAGE_TYPE GMM_STDCALL GmmCachePolicyGetResourceUsage(GMM_RESOURCE_INFO *pResInfo)
77 {
78     __GMM_ASSERT(pResInfo);
79     return pResInfo->GetCachePolicyUsage();
80 }
81 
82 /////////////////////////////////////////////////////////////////////////////////////
83 /// C wrapper for GmmLib::GmmResourceInfoCommon::OverrideCachePolicyUsage.
84 /// @see        GmmLib::GmmResourceInfoCommon::OverrideCachePolicyUsage()
85 ///
86 /// @param[in]      pGmmResource: Pointer to the GmmResourceInfo class
87 /// @param[in]      Cache policy usage
88 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyOverrideResourceUsage(GMM_RESOURCE_INFO * pResInfo,GMM_RESOURCE_USAGE_TYPE Usage)89 void GMM_STDCALL GmmCachePolicyOverrideResourceUsage(GMM_RESOURCE_INFO *pResInfo, GMM_RESOURCE_USAGE_TYPE Usage)
90 {
91     pResInfo->OverrideCachePolicyUsage(Usage);
92 }
93 
94 /////////////////////////////////////////////////////////////////////////////////////
95 /// C Wrapper function for GmmLib::GmmCachePolicyGetMemoryObject
96 /// @see           GmmLib::GmmCachePolicyCommon::CachePolicyGetMemoryObject()
97 ///
98 /// param[in]      pResInfo: Resource info for resource, can be NULL.
99 /// param[in]      Usage: Current usage for resource.
100 ///
101 /// @return        MEMORY_OBJECT_CONTROL_STATE: Gen adjusted MOCS structure (cache
102 ///                                             policy) for the given buffer use.
103 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMemoryObject(void * pLibContext,GMM_RESOURCE_INFO * pResInfo,GMM_RESOURCE_USAGE_TYPE Usage)104 MEMORY_OBJECT_CONTROL_STATE GMM_STDCALL GmmCachePolicyGetMemoryObject(void *pLibContext, GMM_RESOURCE_INFO *pResInfo, GMM_RESOURCE_USAGE_TYPE Usage)
105 {
106     GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
107     return pGmmLibContext->GetCachePolicyObj()->CachePolicyGetMemoryObject(pResInfo, Usage);
108 }
109 
110 /////////////////////////////////////////////////////////////////////////////////////
111 /// C Wrapper function for GmmLib::GmmCachePolicyGetOriginalMemoryObject
112 ///  @see           GmmLib::GmmCachePolicyCommon::CachePolicyGetOriginalMemoryObject()
113 ///
114 ///  @param[in]     pResInfo: Resource info for resource , can be null
115 ///  @param[in]     Usage: Current usage for resource
116 ///
117 ///  @return        MEMORY_OBJECT_CONTROL_STATE: Populated memory object
118 ///
119 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetOriginalMemoryObject(void * pLibContext,GMM_RESOURCE_INFO * pResInfo)120 MEMORY_OBJECT_CONTROL_STATE GMM_STDCALL GmmCachePolicyGetOriginalMemoryObject(void *pLibContext, GMM_RESOURCE_INFO *pResInfo)
121 {
122     GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
123     return pGmmLibContext->GetCachePolicyObj()->CachePolicyGetOriginalMemoryObject(pResInfo);
124 }
125 /////////////////////////////////////////////////////////////////////////////////////
126 /// C Wrapper function for GmmCachePolicy::GmmGetWantedMemoryType.
127 /// @see            GmmLib::GmmCachePolicy::GetWantedMemoryType()
128 ///
129 /// @param[in]     pLibContext: pGmmLibContext
130 /// @param[in]     CachePolicy:cache policy for a usage
131 ///
132 /// @return         wanted memory type
133 /////////////////////////////////////////////////////////////////////////////////////
GmmGetWantedMemoryType(void * pLibContext,GMM_CACHE_POLICY_ELEMENT CachePolicy)134 GMM_GFX_MEMORY_TYPE GmmGetWantedMemoryType(void *pLibContext, GMM_CACHE_POLICY_ELEMENT CachePolicy)
135 {
136     GMM_LIB_CONTEXT *pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
137     return pGmmLibContext->GetCachePolicyObj()->GetWantedMemoryType(CachePolicy);
138 }
139 /////////////////////////////////////////////////////////////////////////////////////
140 /// Returns count of current MOCS values for MOCS Table programming at GMM boot
141 ///
142 /// @param[in]     pLibContext: pGmmLibContext
143 /// @return     uint32_t  no of mocs register required to program
144 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMaxMocsIndex(void * pLibContext)145 uint32_t GMM_STDCALL GmmCachePolicyGetMaxMocsIndex(void *pLibContext)
146 {
147     GMM_LIB_CONTEXT *           pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
148     GMM_CACHE_POLICY *          pCachePolicy   = pGmmLibContext->GetCachePolicyObj();
149     GmmLib::GmmGen9CachePolicy *ptr            = static_cast<GmmLib::GmmGen9CachePolicy *>(pCachePolicy);
150     return ptr->CurrentMaxMocsIndex;
151 }
152 /////////////////////////////////////////////////////////////////////////////////////
153 /// Returns count of current L1 HDC MOCS values for MOCS Table programming at GMM boot
154 ///
155 /// @param[in]     pLibContext: pGmmLibContext
156 /// @return     uint32_t  max L1 hdc mocs index needed to program
157 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMaxL1HdcMocsIndex(void * pLibContext)158 uint32_t GMM_STDCALL GmmCachePolicyGetMaxL1HdcMocsIndex(void *pLibContext)
159 {
160     GMM_LIB_CONTEXT *           pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
161     GMM_CACHE_POLICY *          pCachePolicy   = pGmmLibContext->GetCachePolicyObj();
162     GmmLib::GmmGen9CachePolicy *ptr            = static_cast<GmmLib::GmmGen9CachePolicy *>(pCachePolicy);
163     return ptr->CurrentMaxL1HdcMocsIndex;
164 }
165 
166 /////////////////////////////////////////////////////////////////////////////////////
167 /// Returns count of current Special MOCS values for MOCS Table programming at GMM boot
168 ///
169 /// @param[in]     pLibContext: pGmmLibContext
170 /// @return     uint32_t  max special mocs index needed to program
171 /////////////////////////////////////////////////////////////////////////////////////
GmmCachePolicyGetMaxSpecialMocsIndex(void * pLibContext)172 uint32_t GMM_STDCALL GmmCachePolicyGetMaxSpecialMocsIndex(void *pLibContext)
173 {
174     GMM_LIB_CONTEXT * pGmmLibContext = (GMM_LIB_CONTEXT *)pLibContext;
175     GMM_CACHE_POLICY *pCachePolicy   = pGmmLibContext->GetCachePolicyObj();
176     return pCachePolicy->GetMaxSpecialMocsIndex();
177 }
178