1 #ifndef _G_GPU_MGMT_API_NVOC_H_
2 #define _G_GPU_MGMT_API_NVOC_H_
3 #include "nvoc/runtime.h"
4 
5 #ifdef __cplusplus
6 extern "C" {
7 #endif
8 
9 /*
10  * SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
11  * SPDX-License-Identifier: MIT
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice and this permission notice shall be included in
21  * all copies or substantial portions of the Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29  * DEALINGS IN THE SOFTWARE.
30  */
31 #include "g_gpu_mgmt_api_nvoc.h"
32 
33 #ifndef GPU_MGMT_API_H
34 #define GPU_MGMT_API_H
35 
36 #include "rmapi/resource.h"
37 #include "ctrl/ctrl0020.h"
38 
39 // ****************************************************************************
40 //                          Type Definitions
41 // ****************************************************************************
42 
43 //
44 // GpuManagementApi class information
45 //
46 // This is a global GPU class will help us to route IOCTLs to probed
47 // and persistent GPU state
48 //
49 
50 
51 // Private field names are wrapped in PRIVATE_FIELD, which does nothing for
52 // the matching C source file, but causes diagnostics to be issued if another
53 // source file references the field.
54 #ifdef NVOC_GPU_MGMT_API_H_PRIVATE_ACCESS_ALLOWED
55 #define PRIVATE_FIELD(x) x
56 #else
57 #define PRIVATE_FIELD(x) NVOC_PRIVATE_FIELD(x)
58 #endif
59 
60 struct GpuManagementApi {
61     const struct NVOC_RTTI *__nvoc_rtti;
62     struct RmResource __nvoc_base_RmResource;
63     struct Object *__nvoc_pbase_Object;
64     struct RsResource *__nvoc_pbase_RsResource;
65     struct RmResourceCommon *__nvoc_pbase_RmResourceCommon;
66     struct RmResource *__nvoc_pbase_RmResource;
67     struct GpuManagementApi *__nvoc_pbase_GpuManagementApi;
68     NV_STATUS (*__gpumgmtapiCtrlCmdSetShutdownState__)(struct GpuManagementApi *, NV0020_CTRL_GPU_MGMT_SET_SHUTDOWN_STATE_PARAMS *);
69     NvBool (*__gpumgmtapiShareCallback__)(struct GpuManagementApi *, struct RsClient *, struct RsResourceRef *, RS_SHARE_POLICY *);
70     NV_STATUS (*__gpumgmtapiCheckMemInterUnmap__)(struct GpuManagementApi *, NvBool);
71     NV_STATUS (*__gpumgmtapiControl__)(struct GpuManagementApi *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
72     NV_STATUS (*__gpumgmtapiGetMemInterMapParams__)(struct GpuManagementApi *, RMRES_MEM_INTER_MAP_PARAMS *);
73     NV_STATUS (*__gpumgmtapiGetMemoryMappingDescriptor__)(struct GpuManagementApi *, struct MEMORY_DESCRIPTOR **);
74     NvU32 (*__gpumgmtapiGetRefCount__)(struct GpuManagementApi *);
75     NV_STATUS (*__gpumgmtapiControlFilter__)(struct GpuManagementApi *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
76     void (*__gpumgmtapiAddAdditionalDependants__)(struct RsClient *, struct GpuManagementApi *, RsResourceRef *);
77     NV_STATUS (*__gpumgmtapiControlSerialization_Prologue__)(struct GpuManagementApi *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
78     NV_STATUS (*__gpumgmtapiControl_Prologue__)(struct GpuManagementApi *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
79     NvBool (*__gpumgmtapiCanCopy__)(struct GpuManagementApi *);
80     NV_STATUS (*__gpumgmtapiUnmap__)(struct GpuManagementApi *, struct CALL_CONTEXT *, RsCpuMapping *);
81     NvBool (*__gpumgmtapiIsPartialUnmapSupported__)(struct GpuManagementApi *);
82     void (*__gpumgmtapiPreDestruct__)(struct GpuManagementApi *);
83     NV_STATUS (*__gpumgmtapiMapTo__)(struct GpuManagementApi *, RS_RES_MAP_TO_PARAMS *);
84     NV_STATUS (*__gpumgmtapiIsDuplicate__)(struct GpuManagementApi *, NvHandle, NvBool *);
85     void (*__gpumgmtapiControlSerialization_Epilogue__)(struct GpuManagementApi *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
86     void (*__gpumgmtapiControl_Epilogue__)(struct GpuManagementApi *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *);
87     NV_STATUS (*__gpumgmtapiUnmapFrom__)(struct GpuManagementApi *, RS_RES_UNMAP_FROM_PARAMS *);
88     NV_STATUS (*__gpumgmtapiMap__)(struct GpuManagementApi *, struct CALL_CONTEXT *, RS_CPU_MAP_PARAMS *, RsCpuMapping *);
89     NvBool (*__gpumgmtapiAccessCallback__)(struct GpuManagementApi *, struct RsClient *, void *, RsAccessRight);
90 };
91 
92 #ifndef __NVOC_CLASS_GpuManagementApi_TYPEDEF__
93 #define __NVOC_CLASS_GpuManagementApi_TYPEDEF__
94 typedef struct GpuManagementApi GpuManagementApi;
95 #endif /* __NVOC_CLASS_GpuManagementApi_TYPEDEF__ */
96 
97 #ifndef __nvoc_class_id_GpuManagementApi
98 #define __nvoc_class_id_GpuManagementApi 0x376305
99 #endif /* __nvoc_class_id_GpuManagementApi */
100 
101 extern const struct NVOC_CLASS_DEF __nvoc_class_def_GpuManagementApi;
102 
103 #define __staticCast_GpuManagementApi(pThis) \
104     ((pThis)->__nvoc_pbase_GpuManagementApi)
105 
106 #ifdef __nvoc_gpu_mgmt_api_h_disabled
107 #define __dynamicCast_GpuManagementApi(pThis) ((GpuManagementApi*)NULL)
108 #else //__nvoc_gpu_mgmt_api_h_disabled
109 #define __dynamicCast_GpuManagementApi(pThis) \
110     ((GpuManagementApi*)__nvoc_dynamicCast(staticCast((pThis), Dynamic), classInfo(GpuManagementApi)))
111 #endif //__nvoc_gpu_mgmt_api_h_disabled
112 
113 
114 NV_STATUS __nvoc_objCreateDynamic_GpuManagementApi(GpuManagementApi**, Dynamic*, NvU32, va_list);
115 
116 NV_STATUS __nvoc_objCreate_GpuManagementApi(GpuManagementApi**, Dynamic*, NvU32, struct CALL_CONTEXT * arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL * arg_pParams);
117 #define __objCreate_GpuManagementApi(ppNewObj, pParent, createFlags, arg_pCallContext, arg_pParams) \
118     __nvoc_objCreate_GpuManagementApi((ppNewObj), staticCast((pParent), Dynamic), (createFlags), arg_pCallContext, arg_pParams)
119 
120 #define gpumgmtapiCtrlCmdSetShutdownState(pGpuMgmt, pParams) gpumgmtapiCtrlCmdSetShutdownState_DISPATCH(pGpuMgmt, pParams)
121 #define gpumgmtapiShareCallback(pResource, pInvokingClient, pParentRef, pSharePolicy) gpumgmtapiShareCallback_DISPATCH(pResource, pInvokingClient, pParentRef, pSharePolicy)
122 #define gpumgmtapiCheckMemInterUnmap(pRmResource, bSubdeviceHandleProvided) gpumgmtapiCheckMemInterUnmap_DISPATCH(pRmResource, bSubdeviceHandleProvided)
123 #define gpumgmtapiControl(pResource, pCallContext, pParams) gpumgmtapiControl_DISPATCH(pResource, pCallContext, pParams)
124 #define gpumgmtapiGetMemInterMapParams(pRmResource, pParams) gpumgmtapiGetMemInterMapParams_DISPATCH(pRmResource, pParams)
125 #define gpumgmtapiGetMemoryMappingDescriptor(pRmResource, ppMemDesc) gpumgmtapiGetMemoryMappingDescriptor_DISPATCH(pRmResource, ppMemDesc)
126 #define gpumgmtapiGetRefCount(pResource) gpumgmtapiGetRefCount_DISPATCH(pResource)
127 #define gpumgmtapiControlFilter(pResource, pCallContext, pParams) gpumgmtapiControlFilter_DISPATCH(pResource, pCallContext, pParams)
128 #define gpumgmtapiAddAdditionalDependants(pClient, pResource, pReference) gpumgmtapiAddAdditionalDependants_DISPATCH(pClient, pResource, pReference)
129 #define gpumgmtapiControlSerialization_Prologue(pResource, pCallContext, pParams) gpumgmtapiControlSerialization_Prologue_DISPATCH(pResource, pCallContext, pParams)
130 #define gpumgmtapiControl_Prologue(pResource, pCallContext, pParams) gpumgmtapiControl_Prologue_DISPATCH(pResource, pCallContext, pParams)
131 #define gpumgmtapiCanCopy(pResource) gpumgmtapiCanCopy_DISPATCH(pResource)
132 #define gpumgmtapiUnmap(pResource, pCallContext, pCpuMapping) gpumgmtapiUnmap_DISPATCH(pResource, pCallContext, pCpuMapping)
133 #define gpumgmtapiIsPartialUnmapSupported(pResource) gpumgmtapiIsPartialUnmapSupported_DISPATCH(pResource)
134 #define gpumgmtapiPreDestruct(pResource) gpumgmtapiPreDestruct_DISPATCH(pResource)
135 #define gpumgmtapiMapTo(pResource, pParams) gpumgmtapiMapTo_DISPATCH(pResource, pParams)
136 #define gpumgmtapiIsDuplicate(pResource, hMemory, pDuplicate) gpumgmtapiIsDuplicate_DISPATCH(pResource, hMemory, pDuplicate)
137 #define gpumgmtapiControlSerialization_Epilogue(pResource, pCallContext, pParams) gpumgmtapiControlSerialization_Epilogue_DISPATCH(pResource, pCallContext, pParams)
138 #define gpumgmtapiControl_Epilogue(pResource, pCallContext, pParams) gpumgmtapiControl_Epilogue_DISPATCH(pResource, pCallContext, pParams)
139 #define gpumgmtapiUnmapFrom(pResource, pParams) gpumgmtapiUnmapFrom_DISPATCH(pResource, pParams)
140 #define gpumgmtapiMap(pResource, pCallContext, pParams, pCpuMapping) gpumgmtapiMap_DISPATCH(pResource, pCallContext, pParams, pCpuMapping)
141 #define gpumgmtapiAccessCallback(pResource, pInvokingClient, pAllocParams, accessRight) gpumgmtapiAccessCallback_DISPATCH(pResource, pInvokingClient, pAllocParams, accessRight)
142 NV_STATUS gpumgmtapiCtrlCmdSetShutdownState_IMPL(struct GpuManagementApi *pGpuMgmt, NV0020_CTRL_GPU_MGMT_SET_SHUTDOWN_STATE_PARAMS *pParams);
143 
gpumgmtapiCtrlCmdSetShutdownState_DISPATCH(struct GpuManagementApi * pGpuMgmt,NV0020_CTRL_GPU_MGMT_SET_SHUTDOWN_STATE_PARAMS * pParams)144 static inline NV_STATUS gpumgmtapiCtrlCmdSetShutdownState_DISPATCH(struct GpuManagementApi *pGpuMgmt, NV0020_CTRL_GPU_MGMT_SET_SHUTDOWN_STATE_PARAMS *pParams) {
145     return pGpuMgmt->__gpumgmtapiCtrlCmdSetShutdownState__(pGpuMgmt, pParams);
146 }
147 
gpumgmtapiShareCallback_DISPATCH(struct GpuManagementApi * pResource,struct RsClient * pInvokingClient,struct RsResourceRef * pParentRef,RS_SHARE_POLICY * pSharePolicy)148 static inline NvBool gpumgmtapiShareCallback_DISPATCH(struct GpuManagementApi *pResource, struct RsClient *pInvokingClient, struct RsResourceRef *pParentRef, RS_SHARE_POLICY *pSharePolicy) {
149     return pResource->__gpumgmtapiShareCallback__(pResource, pInvokingClient, pParentRef, pSharePolicy);
150 }
151 
gpumgmtapiCheckMemInterUnmap_DISPATCH(struct GpuManagementApi * pRmResource,NvBool bSubdeviceHandleProvided)152 static inline NV_STATUS gpumgmtapiCheckMemInterUnmap_DISPATCH(struct GpuManagementApi *pRmResource, NvBool bSubdeviceHandleProvided) {
153     return pRmResource->__gpumgmtapiCheckMemInterUnmap__(pRmResource, bSubdeviceHandleProvided);
154 }
155 
gpumgmtapiControl_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)156 static inline NV_STATUS gpumgmtapiControl_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
157     return pResource->__gpumgmtapiControl__(pResource, pCallContext, pParams);
158 }
159 
gpumgmtapiGetMemInterMapParams_DISPATCH(struct GpuManagementApi * pRmResource,RMRES_MEM_INTER_MAP_PARAMS * pParams)160 static inline NV_STATUS gpumgmtapiGetMemInterMapParams_DISPATCH(struct GpuManagementApi *pRmResource, RMRES_MEM_INTER_MAP_PARAMS *pParams) {
161     return pRmResource->__gpumgmtapiGetMemInterMapParams__(pRmResource, pParams);
162 }
163 
gpumgmtapiGetMemoryMappingDescriptor_DISPATCH(struct GpuManagementApi * pRmResource,struct MEMORY_DESCRIPTOR ** ppMemDesc)164 static inline NV_STATUS gpumgmtapiGetMemoryMappingDescriptor_DISPATCH(struct GpuManagementApi *pRmResource, struct MEMORY_DESCRIPTOR **ppMemDesc) {
165     return pRmResource->__gpumgmtapiGetMemoryMappingDescriptor__(pRmResource, ppMemDesc);
166 }
167 
gpumgmtapiGetRefCount_DISPATCH(struct GpuManagementApi * pResource)168 static inline NvU32 gpumgmtapiGetRefCount_DISPATCH(struct GpuManagementApi *pResource) {
169     return pResource->__gpumgmtapiGetRefCount__(pResource);
170 }
171 
gpumgmtapiControlFilter_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)172 static inline NV_STATUS gpumgmtapiControlFilter_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
173     return pResource->__gpumgmtapiControlFilter__(pResource, pCallContext, pParams);
174 }
175 
gpumgmtapiAddAdditionalDependants_DISPATCH(struct RsClient * pClient,struct GpuManagementApi * pResource,RsResourceRef * pReference)176 static inline void gpumgmtapiAddAdditionalDependants_DISPATCH(struct RsClient *pClient, struct GpuManagementApi *pResource, RsResourceRef *pReference) {
177     pResource->__gpumgmtapiAddAdditionalDependants__(pClient, pResource, pReference);
178 }
179 
gpumgmtapiControlSerialization_Prologue_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)180 static inline NV_STATUS gpumgmtapiControlSerialization_Prologue_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
181     return pResource->__gpumgmtapiControlSerialization_Prologue__(pResource, pCallContext, pParams);
182 }
183 
gpumgmtapiControl_Prologue_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)184 static inline NV_STATUS gpumgmtapiControl_Prologue_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
185     return pResource->__gpumgmtapiControl_Prologue__(pResource, pCallContext, pParams);
186 }
187 
gpumgmtapiCanCopy_DISPATCH(struct GpuManagementApi * pResource)188 static inline NvBool gpumgmtapiCanCopy_DISPATCH(struct GpuManagementApi *pResource) {
189     return pResource->__gpumgmtapiCanCopy__(pResource);
190 }
191 
gpumgmtapiUnmap_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,RsCpuMapping * pCpuMapping)192 static inline NV_STATUS gpumgmtapiUnmap_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, RsCpuMapping *pCpuMapping) {
193     return pResource->__gpumgmtapiUnmap__(pResource, pCallContext, pCpuMapping);
194 }
195 
gpumgmtapiIsPartialUnmapSupported_DISPATCH(struct GpuManagementApi * pResource)196 static inline NvBool gpumgmtapiIsPartialUnmapSupported_DISPATCH(struct GpuManagementApi *pResource) {
197     return pResource->__gpumgmtapiIsPartialUnmapSupported__(pResource);
198 }
199 
gpumgmtapiPreDestruct_DISPATCH(struct GpuManagementApi * pResource)200 static inline void gpumgmtapiPreDestruct_DISPATCH(struct GpuManagementApi *pResource) {
201     pResource->__gpumgmtapiPreDestruct__(pResource);
202 }
203 
gpumgmtapiMapTo_DISPATCH(struct GpuManagementApi * pResource,RS_RES_MAP_TO_PARAMS * pParams)204 static inline NV_STATUS gpumgmtapiMapTo_DISPATCH(struct GpuManagementApi *pResource, RS_RES_MAP_TO_PARAMS *pParams) {
205     return pResource->__gpumgmtapiMapTo__(pResource, pParams);
206 }
207 
gpumgmtapiIsDuplicate_DISPATCH(struct GpuManagementApi * pResource,NvHandle hMemory,NvBool * pDuplicate)208 static inline NV_STATUS gpumgmtapiIsDuplicate_DISPATCH(struct GpuManagementApi *pResource, NvHandle hMemory, NvBool *pDuplicate) {
209     return pResource->__gpumgmtapiIsDuplicate__(pResource, hMemory, pDuplicate);
210 }
211 
gpumgmtapiControlSerialization_Epilogue_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)212 static inline void gpumgmtapiControlSerialization_Epilogue_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
213     pResource->__gpumgmtapiControlSerialization_Epilogue__(pResource, pCallContext, pParams);
214 }
215 
gpumgmtapiControl_Epilogue_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,struct RS_RES_CONTROL_PARAMS_INTERNAL * pParams)216 static inline void gpumgmtapiControl_Epilogue_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) {
217     pResource->__gpumgmtapiControl_Epilogue__(pResource, pCallContext, pParams);
218 }
219 
gpumgmtapiUnmapFrom_DISPATCH(struct GpuManagementApi * pResource,RS_RES_UNMAP_FROM_PARAMS * pParams)220 static inline NV_STATUS gpumgmtapiUnmapFrom_DISPATCH(struct GpuManagementApi *pResource, RS_RES_UNMAP_FROM_PARAMS *pParams) {
221     return pResource->__gpumgmtapiUnmapFrom__(pResource, pParams);
222 }
223 
gpumgmtapiMap_DISPATCH(struct GpuManagementApi * pResource,struct CALL_CONTEXT * pCallContext,RS_CPU_MAP_PARAMS * pParams,RsCpuMapping * pCpuMapping)224 static inline NV_STATUS gpumgmtapiMap_DISPATCH(struct GpuManagementApi *pResource, struct CALL_CONTEXT *pCallContext, RS_CPU_MAP_PARAMS *pParams, RsCpuMapping *pCpuMapping) {
225     return pResource->__gpumgmtapiMap__(pResource, pCallContext, pParams, pCpuMapping);
226 }
227 
gpumgmtapiAccessCallback_DISPATCH(struct GpuManagementApi * pResource,struct RsClient * pInvokingClient,void * pAllocParams,RsAccessRight accessRight)228 static inline NvBool gpumgmtapiAccessCallback_DISPATCH(struct GpuManagementApi *pResource, struct RsClient *pInvokingClient, void *pAllocParams, RsAccessRight accessRight) {
229     return pResource->__gpumgmtapiAccessCallback__(pResource, pInvokingClient, pAllocParams, accessRight);
230 }
231 
232 NV_STATUS gpumgmtapiConstruct_IMPL(struct GpuManagementApi *arg_pGpuMgmt, struct CALL_CONTEXT *arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL *arg_pParams);
233 
234 #define __nvoc_gpumgmtapiConstruct(arg_pGpuMgmt, arg_pCallContext, arg_pParams) gpumgmtapiConstruct_IMPL(arg_pGpuMgmt, arg_pCallContext, arg_pParams)
235 void gpumgmtapiDestruct_IMPL(struct GpuManagementApi *pGpuMgmt);
236 
237 #define __nvoc_gpumgmtapiDestruct(pGpuMgmt) gpumgmtapiDestruct_IMPL(pGpuMgmt)
238 #undef PRIVATE_FIELD
239 
240 
241 #endif // GPU_MGMT_API_H
242 
243 #ifdef __cplusplus
244 } // extern "C"
245 #endif
246 
247 #endif // _G_GPU_MGMT_API_NVOC_H_
248