1 /* 2 * SPDX-FileCopyrightText: Copyright (c) 2006-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. 3 * SPDX-License-Identifier: MIT 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining a 6 * copy of this software and associated documentation files (the "Software"), 7 * to deal in the Software without restriction, including without limitation 8 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 9 * and/or sell copies of the Software, and to permit persons to whom the 10 * Software is furnished to do so, subject to the following conditions: 11 * 12 * The above copyright notice and this permission notice shall be included in 13 * all copies or substantial portions of the Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 21 * DEALINGS IN THE SOFTWARE. 22 */ 23 #pragma once 24 25 #include <nvtypes.h> 26 27 // 28 // This file was generated with FINN, an NVIDIA coding tool. 29 // Source file: ctrl/ctrl0000/ctrl0000client.finn 30 // 31 32 #include "ctrl/ctrl0000/ctrl0000base.h" 33 34 #include "ctrl/ctrlxxxx.h" 35 #include "class/cl0000.h" 36 #include "rs_access.h" 37 38 /* 39 * NV0000_CTRL_CMD_CLIENT_GET_ADDR_SPACE_TYPE 40 * 41 * This command may be used to query memory address space type associated with an object 42 * 43 * Parameters: 44 * hObject[IN] 45 * handle of the object to look up 46 * addrSpaceType[OUT] 47 * addrSpaceType with associated memory descriptor 48 * 49 * Possible status values are: 50 * NV_OK 51 * NV_ERR_INVALID_OBJECT_HANDLE 52 * NV_ERR_INVALID_OBJECT 53 * NV_ERR_INVALID_ARGUMENT 54 * NV_ERR_NOT_SUPPORTED 55 */ 56 #define NV0000_CTRL_CMD_CLIENT_GET_ADDR_SPACE_TYPE (0xd01) /* finn: Evaluated from "(FINN_NV01_ROOT_CLIENT_INTERFACE_ID << 8) | NV0000_CTRL_CLIENT_GET_ADDR_SPACE_TYPE_PARAMS_MESSAGE_ID" */ 57 58 #define NV0000_CTRL_CLIENT_GET_ADDR_SPACE_TYPE_PARAMS_MESSAGE_ID (0x1U) 59 60 typedef struct NV0000_CTRL_CLIENT_GET_ADDR_SPACE_TYPE_PARAMS { 61 NvHandle hObject; /* [in] - Handle of object to look up */ 62 NvU32 mapFlags; /* [in] - Flags that will be used when mapping the object */ 63 NvU32 addrSpaceType; /* [out] - Memory Address Space Type */ 64 } NV0000_CTRL_CLIENT_GET_ADDR_SPACE_TYPE_PARAMS; 65 66 #define NV0000_CTRL_CMD_CLIENT_GET_ADDR_SPACE_TYPE_INVALID 0x00000000 67 #define NV0000_CTRL_CMD_CLIENT_GET_ADDR_SPACE_TYPE_SYSMEM 0x00000001 68 #define NV0000_CTRL_CMD_CLIENT_GET_ADDR_SPACE_TYPE_VIDMEM 0x00000002 69 #define NV0000_CTRL_CMD_CLIENT_GET_ADDR_SPACE_TYPE_REGMEM 0x00000003 70 #define NV0000_CTRL_CMD_CLIENT_GET_ADDR_SPACE_TYPE_FABRIC 0x00000004 71 72 73 74 /* 75 * NV0000_CTRL_CMD_CLIENT_GET_HANDLE_INFO 76 * 77 * This command may be used to query information on a handle 78 */ 79 #define NV0000_CTRL_CMD_CLIENT_GET_HANDLE_INFO (0xd02) /* finn: Evaluated from "(FINN_NV01_ROOT_CLIENT_INTERFACE_ID << 8) | NV0000_CTRL_CLIENT_GET_HANDLE_INFO_PARAMS_MESSAGE_ID" */ 80 81 #define NV0000_CTRL_CLIENT_GET_HANDLE_INFO_PARAMS_MESSAGE_ID (0x2U) 82 83 typedef struct NV0000_CTRL_CLIENT_GET_HANDLE_INFO_PARAMS { 84 NvHandle hObject; /* [in] - Handle of object to look up */ 85 NvU32 index; /* [in] - Type of lookup */ 86 87 union { 88 NvHandle hResult; /* [out] - Result of lookup when result is a handle type */ 89 NV_DECLARE_ALIGNED(NvU64 iResult, 8); /* [out] - Result of lookup when result is a integer */ 90 } data; 91 } NV0000_CTRL_CLIENT_GET_HANDLE_INFO_PARAMS; 92 93 #define NV0000_CTRL_CMD_CLIENT_GET_HANDLE_INFO_INDEX_INVALID 0x00000000 94 #define NV0000_CTRL_CMD_CLIENT_GET_HANDLE_INFO_INDEX_PARENT 0x00000001 95 #define NV0000_CTRL_CMD_CLIENT_GET_HANDLE_INFO_INDEX_CLASSID 0x00000002 96 97 /* 98 * NV0000_CTRL_CMD_CLIENT_GET_ACCESS_RIGHTS 99 * 100 * This command may be used to get this client's access rights for an object 101 * The object to which access rights are checked does not have to be owned by 102 * the client calling the command, it is owned by the hClient parameter 103 */ 104 #define NV0000_CTRL_CMD_CLIENT_GET_ACCESS_RIGHTS (0xd03) /* finn: Evaluated from "(FINN_NV01_ROOT_CLIENT_INTERFACE_ID << 8) | NV0000_CTRL_CLIENT_GET_ACCESS_RIGHTS_PARAMS_MESSAGE_ID" */ 105 106 #define NV0000_CTRL_CLIENT_GET_ACCESS_RIGHTS_PARAMS_MESSAGE_ID (0x3U) 107 108 typedef struct NV0000_CTRL_CLIENT_GET_ACCESS_RIGHTS_PARAMS { 109 NvHandle hObject; /* [in] - Handle of object to look up */ 110 NvHandle hClient; /* [in] - Handle of client which owns hObject */ 111 RS_ACCESS_MASK maskResult; /* [out] - Result of lookup */ 112 } NV0000_CTRL_CLIENT_GET_ACCESS_RIGHTS_PARAMS; 113 114 /* 115 * NV0000_CTRL_CMD_CLIENT_SET_INHERITED_SHARE_POLICY 116 * 117 * DEPRECATED: Calls NV0000_CTRL_CMD_CLIENT_SHARE_OBJECT with hObject=hClient 118 * 119 * This command will modify a client's inherited share policy list 120 * The policy is applied in the same way that NvRmShare applies policies, 121 * except to the client's inherited policy list instead of an object's policy list 122 */ 123 #define NV0000_CTRL_CMD_CLIENT_SET_INHERITED_SHARE_POLICY (0xd04) /* finn: Evaluated from "(FINN_NV01_ROOT_CLIENT_INTERFACE_ID << 8) | NV0000_CTRL_CLIENT_SET_INHERITED_SHARE_POLICY_PARAMS_MESSAGE_ID" */ 124 125 #define NV0000_CTRL_CLIENT_SET_INHERITED_SHARE_POLICY_PARAMS_MESSAGE_ID (0x4U) 126 127 typedef struct NV0000_CTRL_CLIENT_SET_INHERITED_SHARE_POLICY_PARAMS { 128 RS_SHARE_POLICY sharePolicy; /* [in] - Share Policy to apply */ 129 } NV0000_CTRL_CLIENT_SET_INHERITED_SHARE_POLICY_PARAMS; 130 131 /* 132 * NV0000_CTRL_CMD_CLIENT_GET_CHILD_HANDLE 133 * 134 * This command may be used to get a handle of a child of a given type 135 */ 136 #define NV0000_CTRL_CMD_CLIENT_GET_CHILD_HANDLE (0xd05) /* finn: Evaluated from "(FINN_NV01_ROOT_CLIENT_INTERFACE_ID << 8) | NV0000_CTRL_CMD_CLIENT_GET_CHILD_HANDLE_PARAMS_MESSAGE_ID" */ 137 138 #define NV0000_CTRL_CMD_CLIENT_GET_CHILD_HANDLE_PARAMS_MESSAGE_ID (0x5U) 139 140 typedef struct NV0000_CTRL_CMD_CLIENT_GET_CHILD_HANDLE_PARAMS { 141 NvHandle hParent; /* [in] - Handle of parent object */ 142 NvU32 classId; /* [in] - Class ID of the child object */ 143 NvHandle hObject; /* [out] - Handle of the child object (0 if not found) */ 144 } NV0000_CTRL_CMD_CLIENT_GET_CHILD_HANDLE_PARAMS; 145 146 /* 147 * NV0000_CTRL_CMD_CLIENT_SHARE_OBJECT 148 * 149 * This command is meant to imitate the NvRmShare API. 150 * Applies a share policy to an object, which should be owned by the caller's client. 151 * The policy is applied in the same way that NvRmShare applies policies. 152 * 153 * This ctrl command is only meant to be used in older branches. For releases after R450, 154 * use NvRmShare directly instead. 155 */ 156 #define NV0000_CTRL_CMD_CLIENT_SHARE_OBJECT (0xd06) /* finn: Evaluated from "(FINN_NV01_ROOT_CLIENT_INTERFACE_ID << 8) | NV0000_CTRL_CLIENT_SHARE_OBJECT_PARAMS_MESSAGE_ID" */ 157 158 #define NV0000_CTRL_CLIENT_SHARE_OBJECT_PARAMS_MESSAGE_ID (0x6U) 159 160 typedef struct NV0000_CTRL_CLIENT_SHARE_OBJECT_PARAMS { 161 NvHandle hObject; /* [in] - Handle of object to share */ 162 RS_SHARE_POLICY sharePolicy; /* [in] - Share Policy to apply */ 163 } NV0000_CTRL_CLIENT_SHARE_OBJECT_PARAMS; 164 165 /* 166 * NV0000_CTRL_CMD_CLIENT_OBJECTS_ARE_DUPLICATES 167 * 168 * This command returns true if the objects are duplicates. 169 * 170 * Currently supported only for memory objects. 171 */ 172 #define NV0000_CTRL_CMD_CLIENT_OBJECTS_ARE_DUPLICATES (0xd07) /* finn: Evaluated from "(FINN_NV01_ROOT_CLIENT_INTERFACE_ID << 8) | NV0000_CTRL_CLIENT_OBJECTS_ARE_DUPLICATES_PARAMS_MESSAGE_ID" */ 173 174 #define NV0000_CTRL_CLIENT_OBJECTS_ARE_DUPLICATES_PARAMS_MESSAGE_ID (0x7U) 175 176 typedef struct NV0000_CTRL_CLIENT_OBJECTS_ARE_DUPLICATES_PARAMS { 177 NvHandle hObject1; /* [in] - Handle of object to be checked */ 178 NvHandle hObject2; /* [in] - Handle of object to be checked */ 179 NvBool bDuplicates; /* [out] - Returns true if duplicates */ 180 } NV0000_CTRL_CLIENT_OBJECTS_ARE_DUPLICATES_PARAMS; 181 182 183 184 /* _ctrl0000client_h_ */ 185 186