1 #ifndef _G_MEM_MAPPER_NVOC_H_ 2 #define _G_MEM_MAPPER_NVOC_H_ 3 #include "nvoc/runtime.h" 4 5 #ifdef __cplusplus 6 extern "C" { 7 #endif 8 9 /* 10 * SPDX-FileCopyrightText: Copyright (c) 2022 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 32 #include "g_mem_mapper_nvoc.h" 33 34 #ifndef MEMORY_MAPPER_H 35 #define MEMORY_MAPPER_H 36 37 #include "core/core.h" 38 #include "rmapi/rmapi.h" 39 #include "rmapi/resource.h" 40 #include "gpu/gpu_resource.h" 41 42 #include "class/cl00fe.h" 43 #include "ctrl/ctrl00fe.h" 44 45 struct Subdevice; 46 47 #ifndef __NVOC_CLASS_Subdevice_TYPEDEF__ 48 #define __NVOC_CLASS_Subdevice_TYPEDEF__ 49 typedef struct Subdevice Subdevice; 50 #endif /* __NVOC_CLASS_Subdevice_TYPEDEF__ */ 51 52 #ifndef __nvoc_class_id_Subdevice 53 #define __nvoc_class_id_Subdevice 0x4b01b3 54 #endif /* __nvoc_class_id_Subdevice */ 55 56 57 struct OBJGPU; 58 59 #ifndef __NVOC_CLASS_OBJGPU_TYPEDEF__ 60 #define __NVOC_CLASS_OBJGPU_TYPEDEF__ 61 typedef struct OBJGPU OBJGPU; 62 #endif /* __NVOC_CLASS_OBJGPU_TYPEDEF__ */ 63 64 #ifndef __nvoc_class_id_OBJGPU 65 #define __nvoc_class_id_OBJGPU 0x7ef3cb 66 #endif /* __nvoc_class_id_OBJGPU */ 67 68 69 70 /*! 71 * MemoryMapper provides paging operations channel interface to userspace clients. 72 */ 73 #ifdef NVOC_MEM_MAPPER_H_PRIVATE_ACCESS_ALLOWED 74 #define PRIVATE_FIELD(x) x 75 #else 76 #define PRIVATE_FIELD(x) NVOC_PRIVATE_FIELD(x) 77 #endif 78 struct MemoryMapper { 79 const struct NVOC_RTTI *__nvoc_rtti; 80 struct GpuResource __nvoc_base_GpuResource; 81 struct Object *__nvoc_pbase_Object; 82 struct RsResource *__nvoc_pbase_RsResource; 83 struct RmResourceCommon *__nvoc_pbase_RmResourceCommon; 84 struct RmResource *__nvoc_pbase_RmResource; 85 struct GpuResource *__nvoc_pbase_GpuResource; 86 struct MemoryMapper *__nvoc_pbase_MemoryMapper; 87 NV_STATUS (*__memmapperCtrlCmdSubmitPagingOperations__)(struct MemoryMapper *, NV00FE_CTRL_SUBMIT_PAGING_OPERATIONS_PARAMS *); 88 NvBool (*__memmapperShareCallback__)(struct MemoryMapper *, struct RsClient *, struct RsResourceRef *, RS_SHARE_POLICY *); 89 NV_STATUS (*__memmapperCheckMemInterUnmap__)(struct MemoryMapper *, NvBool); 90 NV_STATUS (*__memmapperMapTo__)(struct MemoryMapper *, RS_RES_MAP_TO_PARAMS *); 91 NV_STATUS (*__memmapperGetMapAddrSpace__)(struct MemoryMapper *, struct CALL_CONTEXT *, NvU32, NV_ADDRESS_SPACE *); 92 NvU32 (*__memmapperGetRefCount__)(struct MemoryMapper *); 93 void (*__memmapperAddAdditionalDependants__)(struct RsClient *, struct MemoryMapper *, RsResourceRef *); 94 NV_STATUS (*__memmapperControl_Prologue__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 95 NV_STATUS (*__memmapperGetRegBaseOffsetAndSize__)(struct MemoryMapper *, struct OBJGPU *, NvU32 *, NvU32 *); 96 NV_STATUS (*__memmapperInternalControlForward__)(struct MemoryMapper *, NvU32, void *, NvU32); 97 NV_STATUS (*__memmapperUnmapFrom__)(struct MemoryMapper *, RS_RES_UNMAP_FROM_PARAMS *); 98 void (*__memmapperControl_Epilogue__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 99 NV_STATUS (*__memmapperControlLookup__)(struct MemoryMapper *, struct RS_RES_CONTROL_PARAMS_INTERNAL *, const struct NVOC_EXPORTED_METHOD_DEF **); 100 NvHandle (*__memmapperGetInternalObjectHandle__)(struct MemoryMapper *); 101 NV_STATUS (*__memmapperControl__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 102 NV_STATUS (*__memmapperUnmap__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RsCpuMapping *); 103 NV_STATUS (*__memmapperGetMemInterMapParams__)(struct MemoryMapper *, RMRES_MEM_INTER_MAP_PARAMS *); 104 NV_STATUS (*__memmapperGetMemoryMappingDescriptor__)(struct MemoryMapper *, struct MEMORY_DESCRIPTOR **); 105 NV_STATUS (*__memmapperControlFilter__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 106 NV_STATUS (*__memmapperControlSerialization_Prologue__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 107 NvBool (*__memmapperCanCopy__)(struct MemoryMapper *); 108 void (*__memmapperPreDestruct__)(struct MemoryMapper *); 109 NV_STATUS (*__memmapperIsDuplicate__)(struct MemoryMapper *, NvHandle, NvBool *); 110 void (*__memmapperControlSerialization_Epilogue__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RS_RES_CONTROL_PARAMS_INTERNAL *); 111 NV_STATUS (*__memmapperMap__)(struct MemoryMapper *, struct CALL_CONTEXT *, struct RS_CPU_MAP_PARAMS *, struct RsCpuMapping *); 112 NvBool (*__memmapperAccessCallback__)(struct MemoryMapper *, struct RsClient *, void *, RsAccessRight); 113 struct Subdevice *pSubDevice; 114 }; 115 116 #ifndef __NVOC_CLASS_MemoryMapper_TYPEDEF__ 117 #define __NVOC_CLASS_MemoryMapper_TYPEDEF__ 118 typedef struct MemoryMapper MemoryMapper; 119 #endif /* __NVOC_CLASS_MemoryMapper_TYPEDEF__ */ 120 121 #ifndef __nvoc_class_id_MemoryMapper 122 #define __nvoc_class_id_MemoryMapper 0xb8e4a2 123 #endif /* __nvoc_class_id_MemoryMapper */ 124 125 extern const struct NVOC_CLASS_DEF __nvoc_class_def_MemoryMapper; 126 127 #define __staticCast_MemoryMapper(pThis) \ 128 ((pThis)->__nvoc_pbase_MemoryMapper) 129 130 #ifdef __nvoc_mem_mapper_h_disabled 131 #define __dynamicCast_MemoryMapper(pThis) ((MemoryMapper*)NULL) 132 #else //__nvoc_mem_mapper_h_disabled 133 #define __dynamicCast_MemoryMapper(pThis) \ 134 ((MemoryMapper*)__nvoc_dynamicCast(staticCast((pThis), Dynamic), classInfo(MemoryMapper))) 135 #endif //__nvoc_mem_mapper_h_disabled 136 137 138 NV_STATUS __nvoc_objCreateDynamic_MemoryMapper(MemoryMapper**, Dynamic*, NvU32, va_list); 139 140 NV_STATUS __nvoc_objCreate_MemoryMapper(MemoryMapper**, Dynamic*, NvU32, struct CALL_CONTEXT * arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL * arg_pParams); 141 #define __objCreate_MemoryMapper(ppNewObj, pParent, createFlags, arg_pCallContext, arg_pParams) \ 142 __nvoc_objCreate_MemoryMapper((ppNewObj), staticCast((pParent), Dynamic), (createFlags), arg_pCallContext, arg_pParams) 143 144 #define memmapperCtrlCmdSubmitPagingOperations(pMemoryMapper, pParams) memmapperCtrlCmdSubmitPagingOperations_DISPATCH(pMemoryMapper, pParams) 145 #define memmapperShareCallback(pGpuResource, pInvokingClient, pParentRef, pSharePolicy) memmapperShareCallback_DISPATCH(pGpuResource, pInvokingClient, pParentRef, pSharePolicy) 146 #define memmapperCheckMemInterUnmap(pRmResource, bSubdeviceHandleProvided) memmapperCheckMemInterUnmap_DISPATCH(pRmResource, bSubdeviceHandleProvided) 147 #define memmapperMapTo(pResource, pParams) memmapperMapTo_DISPATCH(pResource, pParams) 148 #define memmapperGetMapAddrSpace(pGpuResource, pCallContext, mapFlags, pAddrSpace) memmapperGetMapAddrSpace_DISPATCH(pGpuResource, pCallContext, mapFlags, pAddrSpace) 149 #define memmapperGetRefCount(pResource) memmapperGetRefCount_DISPATCH(pResource) 150 #define memmapperAddAdditionalDependants(pClient, pResource, pReference) memmapperAddAdditionalDependants_DISPATCH(pClient, pResource, pReference) 151 #define memmapperControl_Prologue(pResource, pCallContext, pParams) memmapperControl_Prologue_DISPATCH(pResource, pCallContext, pParams) 152 #define memmapperGetRegBaseOffsetAndSize(pGpuResource, pGpu, pOffset, pSize) memmapperGetRegBaseOffsetAndSize_DISPATCH(pGpuResource, pGpu, pOffset, pSize) 153 #define memmapperInternalControlForward(pGpuResource, command, pParams, size) memmapperInternalControlForward_DISPATCH(pGpuResource, command, pParams, size) 154 #define memmapperUnmapFrom(pResource, pParams) memmapperUnmapFrom_DISPATCH(pResource, pParams) 155 #define memmapperControl_Epilogue(pResource, pCallContext, pParams) memmapperControl_Epilogue_DISPATCH(pResource, pCallContext, pParams) 156 #define memmapperControlLookup(pResource, pParams, ppEntry) memmapperControlLookup_DISPATCH(pResource, pParams, ppEntry) 157 #define memmapperGetInternalObjectHandle(pGpuResource) memmapperGetInternalObjectHandle_DISPATCH(pGpuResource) 158 #define memmapperControl(pGpuResource, pCallContext, pParams) memmapperControl_DISPATCH(pGpuResource, pCallContext, pParams) 159 #define memmapperUnmap(pGpuResource, pCallContext, pCpuMapping) memmapperUnmap_DISPATCH(pGpuResource, pCallContext, pCpuMapping) 160 #define memmapperGetMemInterMapParams(pRmResource, pParams) memmapperGetMemInterMapParams_DISPATCH(pRmResource, pParams) 161 #define memmapperGetMemoryMappingDescriptor(pRmResource, ppMemDesc) memmapperGetMemoryMappingDescriptor_DISPATCH(pRmResource, ppMemDesc) 162 #define memmapperControlFilter(pResource, pCallContext, pParams) memmapperControlFilter_DISPATCH(pResource, pCallContext, pParams) 163 #define memmapperControlSerialization_Prologue(pResource, pCallContext, pParams) memmapperControlSerialization_Prologue_DISPATCH(pResource, pCallContext, pParams) 164 #define memmapperCanCopy(pResource) memmapperCanCopy_DISPATCH(pResource) 165 #define memmapperPreDestruct(pResource) memmapperPreDestruct_DISPATCH(pResource) 166 #define memmapperIsDuplicate(pResource, hMemory, pDuplicate) memmapperIsDuplicate_DISPATCH(pResource, hMemory, pDuplicate) 167 #define memmapperControlSerialization_Epilogue(pResource, pCallContext, pParams) memmapperControlSerialization_Epilogue_DISPATCH(pResource, pCallContext, pParams) 168 #define memmapperMap(pGpuResource, pCallContext, pParams, pCpuMapping) memmapperMap_DISPATCH(pGpuResource, pCallContext, pParams, pCpuMapping) 169 #define memmapperAccessCallback(pResource, pInvokingClient, pAllocParams, accessRight) memmapperAccessCallback_DISPATCH(pResource, pInvokingClient, pAllocParams, accessRight) 170 NV_STATUS memmapperCtrlCmdSubmitPagingOperations_IMPL(struct MemoryMapper *pMemoryMapper, NV00FE_CTRL_SUBMIT_PAGING_OPERATIONS_PARAMS *pParams); 171 172 static inline NV_STATUS memmapperCtrlCmdSubmitPagingOperations_DISPATCH(struct MemoryMapper *pMemoryMapper, NV00FE_CTRL_SUBMIT_PAGING_OPERATIONS_PARAMS *pParams) { 173 return pMemoryMapper->__memmapperCtrlCmdSubmitPagingOperations__(pMemoryMapper, pParams); 174 } 175 176 static inline NvBool memmapperShareCallback_DISPATCH(struct MemoryMapper *pGpuResource, struct RsClient *pInvokingClient, struct RsResourceRef *pParentRef, RS_SHARE_POLICY *pSharePolicy) { 177 return pGpuResource->__memmapperShareCallback__(pGpuResource, pInvokingClient, pParentRef, pSharePolicy); 178 } 179 180 static inline NV_STATUS memmapperCheckMemInterUnmap_DISPATCH(struct MemoryMapper *pRmResource, NvBool bSubdeviceHandleProvided) { 181 return pRmResource->__memmapperCheckMemInterUnmap__(pRmResource, bSubdeviceHandleProvided); 182 } 183 184 static inline NV_STATUS memmapperMapTo_DISPATCH(struct MemoryMapper *pResource, RS_RES_MAP_TO_PARAMS *pParams) { 185 return pResource->__memmapperMapTo__(pResource, pParams); 186 } 187 188 static inline NV_STATUS memmapperGetMapAddrSpace_DISPATCH(struct MemoryMapper *pGpuResource, struct CALL_CONTEXT *pCallContext, NvU32 mapFlags, NV_ADDRESS_SPACE *pAddrSpace) { 189 return pGpuResource->__memmapperGetMapAddrSpace__(pGpuResource, pCallContext, mapFlags, pAddrSpace); 190 } 191 192 static inline NvU32 memmapperGetRefCount_DISPATCH(struct MemoryMapper *pResource) { 193 return pResource->__memmapperGetRefCount__(pResource); 194 } 195 196 static inline void memmapperAddAdditionalDependants_DISPATCH(struct RsClient *pClient, struct MemoryMapper *pResource, RsResourceRef *pReference) { 197 pResource->__memmapperAddAdditionalDependants__(pClient, pResource, pReference); 198 } 199 200 static inline NV_STATUS memmapperControl_Prologue_DISPATCH(struct MemoryMapper *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 201 return pResource->__memmapperControl_Prologue__(pResource, pCallContext, pParams); 202 } 203 204 static inline NV_STATUS memmapperGetRegBaseOffsetAndSize_DISPATCH(struct MemoryMapper *pGpuResource, struct OBJGPU *pGpu, NvU32 *pOffset, NvU32 *pSize) { 205 return pGpuResource->__memmapperGetRegBaseOffsetAndSize__(pGpuResource, pGpu, pOffset, pSize); 206 } 207 208 static inline NV_STATUS memmapperInternalControlForward_DISPATCH(struct MemoryMapper *pGpuResource, NvU32 command, void *pParams, NvU32 size) { 209 return pGpuResource->__memmapperInternalControlForward__(pGpuResource, command, pParams, size); 210 } 211 212 static inline NV_STATUS memmapperUnmapFrom_DISPATCH(struct MemoryMapper *pResource, RS_RES_UNMAP_FROM_PARAMS *pParams) { 213 return pResource->__memmapperUnmapFrom__(pResource, pParams); 214 } 215 216 static inline void memmapperControl_Epilogue_DISPATCH(struct MemoryMapper *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 217 pResource->__memmapperControl_Epilogue__(pResource, pCallContext, pParams); 218 } 219 220 static inline NV_STATUS memmapperControlLookup_DISPATCH(struct MemoryMapper *pResource, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams, const struct NVOC_EXPORTED_METHOD_DEF **ppEntry) { 221 return pResource->__memmapperControlLookup__(pResource, pParams, ppEntry); 222 } 223 224 static inline NvHandle memmapperGetInternalObjectHandle_DISPATCH(struct MemoryMapper *pGpuResource) { 225 return pGpuResource->__memmapperGetInternalObjectHandle__(pGpuResource); 226 } 227 228 static inline NV_STATUS memmapperControl_DISPATCH(struct MemoryMapper *pGpuResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 229 return pGpuResource->__memmapperControl__(pGpuResource, pCallContext, pParams); 230 } 231 232 static inline NV_STATUS memmapperUnmap_DISPATCH(struct MemoryMapper *pGpuResource, struct CALL_CONTEXT *pCallContext, struct RsCpuMapping *pCpuMapping) { 233 return pGpuResource->__memmapperUnmap__(pGpuResource, pCallContext, pCpuMapping); 234 } 235 236 static inline NV_STATUS memmapperGetMemInterMapParams_DISPATCH(struct MemoryMapper *pRmResource, RMRES_MEM_INTER_MAP_PARAMS *pParams) { 237 return pRmResource->__memmapperGetMemInterMapParams__(pRmResource, pParams); 238 } 239 240 static inline NV_STATUS memmapperGetMemoryMappingDescriptor_DISPATCH(struct MemoryMapper *pRmResource, struct MEMORY_DESCRIPTOR **ppMemDesc) { 241 return pRmResource->__memmapperGetMemoryMappingDescriptor__(pRmResource, ppMemDesc); 242 } 243 244 static inline NV_STATUS memmapperControlFilter_DISPATCH(struct MemoryMapper *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 245 return pResource->__memmapperControlFilter__(pResource, pCallContext, pParams); 246 } 247 248 static inline NV_STATUS memmapperControlSerialization_Prologue_DISPATCH(struct MemoryMapper *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 249 return pResource->__memmapperControlSerialization_Prologue__(pResource, pCallContext, pParams); 250 } 251 252 static inline NvBool memmapperCanCopy_DISPATCH(struct MemoryMapper *pResource) { 253 return pResource->__memmapperCanCopy__(pResource); 254 } 255 256 static inline void memmapperPreDestruct_DISPATCH(struct MemoryMapper *pResource) { 257 pResource->__memmapperPreDestruct__(pResource); 258 } 259 260 static inline NV_STATUS memmapperIsDuplicate_DISPATCH(struct MemoryMapper *pResource, NvHandle hMemory, NvBool *pDuplicate) { 261 return pResource->__memmapperIsDuplicate__(pResource, hMemory, pDuplicate); 262 } 263 264 static inline void memmapperControlSerialization_Epilogue_DISPATCH(struct MemoryMapper *pResource, struct CALL_CONTEXT *pCallContext, struct RS_RES_CONTROL_PARAMS_INTERNAL *pParams) { 265 pResource->__memmapperControlSerialization_Epilogue__(pResource, pCallContext, pParams); 266 } 267 268 static inline NV_STATUS memmapperMap_DISPATCH(struct MemoryMapper *pGpuResource, struct CALL_CONTEXT *pCallContext, struct RS_CPU_MAP_PARAMS *pParams, struct RsCpuMapping *pCpuMapping) { 269 return pGpuResource->__memmapperMap__(pGpuResource, pCallContext, pParams, pCpuMapping); 270 } 271 272 static inline NvBool memmapperAccessCallback_DISPATCH(struct MemoryMapper *pResource, struct RsClient *pInvokingClient, void *pAllocParams, RsAccessRight accessRight) { 273 return pResource->__memmapperAccessCallback__(pResource, pInvokingClient, pAllocParams, accessRight); 274 } 275 276 NV_STATUS memmapperConstruct_IMPL(struct MemoryMapper *arg_pMemoryMapper, struct CALL_CONTEXT *arg_pCallContext, struct RS_RES_ALLOC_PARAMS_INTERNAL *arg_pParams); 277 278 #define __nvoc_memmapperConstruct(arg_pMemoryMapper, arg_pCallContext, arg_pParams) memmapperConstruct_IMPL(arg_pMemoryMapper, arg_pCallContext, arg_pParams) 279 #undef PRIVATE_FIELD 280 281 282 #endif // MEMORY_MAPPER_H 283 284 285 #ifdef __cplusplus 286 } // extern "C" 287 #endif 288 289 #endif // _G_MEM_MAPPER_NVOC_H_ 290