Initial commit: Open-IOV vGPU-IO complete stack

- Firmware decompilation: GSP 570.144W (28.5MB ELF, RV64IMAC), 132 decompiled C files
- Kernel modules: nvidia.ko (34MB, OpenRM), open-iov-vfio.ko (2.8MB, VFIO mdev), gsp-vgpu.ko (1.8MB, guest driver)
- Userspace: libiov.so/libvgpu.so (76KB), example_vgpu (28KB), rpc_emulator.c
- PCI config space emulation (256B with PM, MSI, MSI-X, PCIe caps)
- 12 RPC types fully mapped from firmware decompilation
- BAR trap, WPR, scheduling, notification, migration emulation
- Helper scripts: load_vgpu_stack, create_mdev, launch_qemu_vgpu, test_vgpu_stack, setup_guest_driver, unload_vgpu_stack
- Architecture documentation
- Wiki: 10 technical documents
- Git LFS for large binaries (.ko, .bin, .iso, .img, .o, ghidra repos)
- nvidia-open-gpu-kernel-modules as submodule

1 files changed, 258 insertions, 0 deletions

diff --git a/userspace/sdks/nv570/inc/ctrl/ctrl00da.h b/userspace/sdks/nv570/inc/ctrl/ctrl00da.h
new file mode 100644
index 0000000..d404f06
--- /dev/null
+++ b/userspace/sdks/nv570/inc/ctrl/ctrl00da.h
@@ -0,0 +1,258 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+#pragma once
+
+#include <nvtypes.h>
+
+//
+// This file was generated with FINN, an NVIDIA coding tool.
+// Source file:      ctrl/ctrl00da.finn
+//
+
+
+
+/* NV_SEMAPHORE_SURFACE control commands and parameters */
+
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD(cat,idx)       NVXXXX_CTRL_CMD(0x00DA, NV00DA_CTRL_##cat, idx)
+
+/*
+* NV_SEMAPHORE_SURFACE_CTRL_CMD_REF_MEMORY
+*   Duplicate the memory object(s) bound to the semaphore surface into the RM
+*   client of the caller.
+*
+*   The handle values are generated and returned by resource manager if the
+*   client specified a handle value of zero.
+*
+*   If the semaphore surface has a valid max submitted value memory object, but
+*   the GPU + system do not require separate max submitted value and semaphore
+*   value surfaces, the handles provided by the client must be equal, and the
+*   handles returned by resource manager will also be equal. In such cases, the
+*   client must recognize that both handles correspond to a single reference to
+*   a single object, and hence the handle must be freed only once by the client.
+*
+*   If the GPU does not require a max submitted value memory object, the handle
+*   value must be set to zero and the returned handle will always be zero as
+*   well.
+*
+* RETURNS:
+*   NVOS_STATUS_SUCCESS if the memory object(s) were successfully duplicated
+*       into the calling client.
+*   NVOS_STATUS_ERROR_INVALID_PARAMETER if any of the rules regarding the
+*       max submitted value handle value were violated.
+*   An error code forwarded from NvRmDupObject for any other failures.
+*/
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD_REF_MEMORY (0xda0001) /* finn: Evaluated from "(FINN_NV_SEMAPHORE_SURFACE_INTERFACE_ID << 8) | NV_SEMAPHORE_SURFACE_CTRL_REF_MEMORY_PARAMS_MESSAGE_ID" */
+
+#define NV_SEMAPHORE_SURFACE_CTRL_REF_MEMORY_PARAMS_MESSAGE_ID (0x01U)
+
+typedef struct NV_SEMAPHORE_SURFACE_CTRL_REF_MEMORY_PARAMS {
+    NvHandle hSemaphoreMem;
+    NvHandle hMaxSubmittedMem;
+} NV_SEMAPHORE_SURFACE_CTRL_REF_MEMORY_PARAMS;
+
+/*
+* Currently no known usages that require more than two indices per channel:
+*
+* 1) The channel's associated backend engine's TRAP interrupt.
+* 2) The frontend/GPFIFO's non-stall interrupt.
+*
+* The remaining slots are for futureproofing purposes only.
+*/
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD_BIND_CHANNEL_MAX_INDICES 8
+
+/*
+* NV_SEMAPHORE_SURFACE_CTRL_CMD_BIND_CHANNEL
+*   Associates a channel with the semaphore surface.  All channels which will
+*   wait on or signal semaphores in a semaphore surface should first register
+*   with it to ensure proper event delivery and error handling.
+*
+*   numNotifyIndices is the number of valid entries in notifyIndices.
+*
+*   notifyIndices is an array of notifier indices corresponding to the engines
+*   the caller may use to signal a semaphore in the semaphore surface.  See
+*   cl2080_notifiers.h for a list of notifier indices.  For example, this would
+*   indicate a channel using the GR0(graphics/compute) and FIFO TRAP method
+*   (GPFIFO) notifiers to signal semaphores.
+*
+*     params.hChannel = myChannelHandle;
+*     params.numNotifyIndices = 2;
+*     params.notifyIndex[0] = NV2080_NOTIFIERS_GR0;
+*     params.notifyIndex[1] = NV2080_NOTIFIERS_FIFO_EVENT_MTHD;
+*
+*   If the specified channel will only be used to wait for semaphores, set
+*   numNotifyIndices to 0.
+*
+* RETURNS:
+*   NVOS_STATUS_SUCCESS if the channel and notification indices were
+*       successfully bound.
+*   NVOS_STATUS_ERROR_INVALID_OBJECT_HANDLE if hChannel does not refer an object
+*       in the client.
+*   NVOS_STATUS_ERROR_INVALID_OBJECT_ERROR if hChannel does not refer to a valid
+*       channel object.
+*   NVOS_STATUS_ERROR_INVALID_PARAMETER if numNotifyIndices is greater than
+*       NV_SEMAPHORE_SURFACE_CTRL_CMD_BIND_CHANNEL_MAX_INDICES.
+*   NVOS_STATUS_ERROR_NOT_SUPPORTED if the notifyIndex is not a valid
+*       notification index.
+*   NVOS_STATUS_ERROR_INVALID_STATE if an internal inconsistency is found in the
+*       binding tracking logic.
+*   NV_ERR_NO_MEMORY if memory could not be allocated for internal tracking
+*       structures.
+*/
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD_BIND_CHANNEL             (0xda0002) /* finn: Evaluated from "(FINN_NV_SEMAPHORE_SURFACE_INTERFACE_ID << 8) | NV_SEMAPHORE_SURFACE_CTRL_BIND_CHANNEL_PARAMS_MESSAGE_ID" */
+
+#define NV_SEMAPHORE_SURFACE_CTRL_BIND_CHANNEL_PARAMS_MESSAGE_ID (0x02U)
+
+typedef struct NV_SEMAPHORE_SURFACE_CTRL_BIND_CHANNEL_PARAMS {
+    NvHandle hChannel;
+    NvU32    numNotifyIndices;
+    NvU32    notifyIndices[NV_SEMAPHORE_SURFACE_CTRL_CMD_BIND_CHANNEL_MAX_INDICES];
+} NV_SEMAPHORE_SURFACE_CTRL_BIND_CHANNEL_PARAMS;
+
+/*
+* NV_SEMAPHORE_SURFACE_CTRL_CMD_UNBIND_CHANNEL
+*   Dissociate a channel and a semaphore surface.  Before freeing a channel
+*   object, it should be dissociated from all semaphore surfaces to which it has
+*   been bound.
+*
+*   hChannel is a valid channel object handle which has previously been bound
+*   to the semaphore surface.
+*
+*   numNotifyIndices is the number of valid entries in the notifyIndices array.
+*   the hChannel handle.
+*
+*   notifyIndices is the array of notifier indices that was bound to the
+*   semaphore surface with the hChannel handle.
+
+* RETURNS:
+*   NVOS_STATUS_SUCCESS if the channel and notification indices were
+*       successfully unbound.
+*   NVOS_STATUS_ERROR_INVALID_OBJECT_HANDLE if hChannel does not refer an object
+*       in the client.
+*   NVOS_STATUS_ERROR_INVALID_OBJECT_ERROR if hChannel does not refer to a valid
+*       channel object.
+*   NVOS_STATUS_ERROR_INVALID_PARAMETER if numNotifyIndices is greater than
+*       NV_SEMAPHORE_SURFACE_CTRL_CMD_BIND_CHANNEL_MAX_INDICES.
+*   NVOS_STATUS_ERROR_INVALID_STATE if no binding associated with the specified
+*       channel and notification indices is found.
+*/
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD_UNBIND_CHANNEL (0xda0006) /* finn: Evaluated from "(FINN_NV_SEMAPHORE_SURFACE_INTERFACE_ID << 8) | NV_SEMAPHORE_SURFACE_CTRL_UNBIND_CHANNEL_PARAMS_MESSAGE_ID" */
+
+#define NV_SEMAPHORE_SURFACE_CTRL_UNBIND_CHANNEL_PARAMS_MESSAGE_ID (0x06U)
+
+typedef struct NV_SEMAPHORE_SURFACE_CTRL_UNBIND_CHANNEL_PARAMS {
+    NvHandle hChannel;
+    NvU32    numNotifyIndices;
+    NvU32    notifyIndices[NV_SEMAPHORE_SURFACE_CTRL_CMD_BIND_CHANNEL_MAX_INDICES];
+} NV_SEMAPHORE_SURFACE_CTRL_UNBIND_CHANNEL_PARAMS;
+
+/*
+* NV_SEMAPHORE_SURFACE_CTRL_CMD_REGISTER_WAITER
+*   Ask RM to signal the specified OS event and/or set the semaphore to a new
+*   value when the value at the specified index is >= a desired value.
+*
+*   index - Specifies the semaphore slot within the surface to which the the wait
+*       applies.
+*   waitValue - The value to wait for.
+*   newValue - Specifies a value to set the semaphore to automatically when the
+*       specified semaphore slot reaches waitValue. "0" means the semaphore
+*       value is not altered by this waiter.
+*   notificationHandle - The OS event (kernel callback or userspace event
+*       handle) to notify when the value is reached, or 0 if no notification
+*       is required.
+*
+*   The waiter must specify at least one action.
+*
+* RETURNS:
+*   NVOS_STATUS_SUCCESS if the waitValue has not been reached and a waiter was
+*       successfully registered
+*   NVOS_STATUS_SUCCESS if the waitValue has been reached, newValue was applied,
+*       and notificationHandle was 0 (No notification was requested).
+*   NVOS_STATUS_ERROR_ALREADY_SIGNALLED if the waitValue has been reached and
+*       newValue was applied if it was not 0, but no notification was registered
+*       or generated on notificationHandle. Other notifications generated as a
+*       side effect of newValue being applied, if any, were generated.
+*   NVOS_STATUS_ERROR_STATE_IN_USE if newValue is not 0 and the specified index
+*       already has an auto-update value registered. No waiter is registered.
+*   NVOS_STATUS_ERROR_STATE_IN_USE if the specified notification handle is
+*       already registered as a waiter for the specified wait_value at the
+*       specified index.
+*       already has an auto-update value registered. No waiter is registered.
+*   NVOS_STATUS_ERROR_* miscelaneous internal errors. No waiter is registered.
+*/
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD_REGISTER_WAITER (0xda0003) /* finn: Evaluated from "(FINN_NV_SEMAPHORE_SURFACE_INTERFACE_ID << 8) | NV_SEMAPHORE_SURFACE_CTRL_REGISTER_WAITER_PARAMS_MESSAGE_ID" */
+
+#define NV_SEMAPHORE_SURFACE_CTRL_REGISTER_WAITER_PARAMS_MESSAGE_ID (0x03U)
+
+typedef struct NV_SEMAPHORE_SURFACE_CTRL_REGISTER_WAITER_PARAMS {
+    NV_DECLARE_ALIGNED(NvU64 index, 8);
+    NV_DECLARE_ALIGNED(NvU64 waitValue, 8);
+    NV_DECLARE_ALIGNED(NvU64 newValue, 8);
+    NV_DECLARE_ALIGNED(NvU64 notificationHandle, 8);
+} NV_SEMAPHORE_SURFACE_CTRL_REGISTER_WAITER_PARAMS;
+
+/*
+* NV_SEMAPHORE_SURFACE_CTRL_CMD_SET_VALUE
+*   Modify a semaphore surface semaphore value, awakening any CPU waiters in
+*   the process. newValue must be >= the current value at the specified index.
+*/
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD_SET_VALUE (0xda0004) /* finn: Evaluated from "(FINN_NV_SEMAPHORE_SURFACE_INTERFACE_ID << 8) | NV_SEMAPHORE_SURFACE_CTRL_SET_VALUE_PARAMS_MESSAGE_ID" */
+
+#define NV_SEMAPHORE_SURFACE_CTRL_SET_VALUE_PARAMS_MESSAGE_ID (0x04U)
+
+typedef struct NV_SEMAPHORE_SURFACE_CTRL_SET_VALUE_PARAMS {
+    NV_DECLARE_ALIGNED(NvU64 index, 8);
+    NV_DECLARE_ALIGNED(NvU64 newValue, 8);
+} NV_SEMAPHORE_SURFACE_CTRL_SET_VALUE_PARAMS;
+
+/*
+* NV_SEMAPHORE_SURFACE_CTRL_CMD_UNREGISTER_WAITER
+*   Remove a previously registered notification handle from an index + value
+*   tuple's list of waiters.
+*
+*   index - Specifies the semaphore slot within the surface on which the waiter
+*       was previously registered.
+*   waitValue - The value the wait was registered for.
+*   notificationHandle - The OS event (kernel callback or userspace event
+*       handle) registered as a waiter.
+*
+* RETURNS:
+*   NVOS_STATUS_SUCCESS the waiter was successfully removed from the list of
+*       pending waiters.
+*   NVOS_STATUS_ERROR_* miscelaneous internal errors, or the waiter was not
+*       found in the list of pending waiters. The waiter may have already been
+*       called, or may be in a list of imminent notifications the RM is
+*       processing.
+*/
+#define NV_SEMAPHORE_SURFACE_CTRL_CMD_UNREGISTER_WAITER (0xda0005) /* finn: Evaluated from "(FINN_NV_SEMAPHORE_SURFACE_INTERFACE_ID << 8) | NV_SEMAPHORE_SURFACE_CTRL_UNREGISTER_WAITER_PARAMS_MESSAGE_ID" */
+
+#define NV_SEMAPHORE_SURFACE_CTRL_UNREGISTER_WAITER_PARAMS_MESSAGE_ID (0x05U)
+
+typedef struct NV_SEMAPHORE_SURFACE_CTRL_UNREGISTER_WAITER_PARAMS {
+    NV_DECLARE_ALIGNED(NvU64 index, 8);
+    NV_DECLARE_ALIGNED(NvU64 waitValue, 8);
+    NV_DECLARE_ALIGNED(NvU64 notificationHandle, 8);
+} NV_SEMAPHORE_SURFACE_CTRL_UNREGISTER_WAITER_PARAMS;
+
+/* _ctrl00da_h_ */
+