From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 7B592C83F03 for ; Sat, 5 Jul 2025 02:02:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Type: Content-Transfer-Encoding:MIME-Version:References:In-Reply-To:Message-ID:Date :Subject:CC:To:From:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=vP4++gMVso6NJgCf4yKAKkzqkAKXxdKz2sTcPjJo/tU=; b=wiYSAOOqRTnCcYSxsvxGggBJTk eg3Ox6nHsKJWjhxS86MEimPvIK550/11W0H9IuPrYP8Ax+W+OgLr8LvQxkOh1Tgt4T6aGLXWvGTVI 0eQ7aarun+AW+KkzTJtoYmF4aNlJot8nppaQm66W9sToOicUQoB4xBD9namBLbBuEcgQZYlIxSlok cDbDwDknDc6v1RV6PRPGSrcyY7qkNwrkv7eFzNvzd6XyQQibF0D7yK6IqNeywBF1bp2jcpoGRaZkR EGPFK8zF7SXyhStL6I67twrtfVZc1qhX3BQiowGljSu7ywhbLSjMkfUJWc7FII+IuhmnLcfnNOpa/ Y796C5lQ==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98.2 #2 (Red Hat Linux)) id 1uXsEJ-0000000Fqwg-0dy9; Sat, 05 Jul 2025 02:02:15 +0000 Received: from mail-mw2nam12on2061c.outbound.protection.outlook.com ([2a01:111:f403:200a::61c] helo=NAM12-MW2-obe.outbound.protection.outlook.com) by bombadil.infradead.org with esmtps (Exim 4.98.2 #2 (Red Hat Linux)) id 1uXrUL-0000000FliO-2yp9 for linux-arm-kernel@lists.infradead.org; Sat, 05 Jul 2025 01:14:46 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=ZkqFGlS1mTXTjk5UiQuLRYSXuOAG5RTZoq9LkTpaUzGMR1gyY1f9UbltvJNVPnE5rf9qfxZpkT75GuUFBh837MJjAo/L/iYzKxViVbOhohx26TlffZrEmuYHz0a3ZsYH52c3vEdbLo9yQ6qf6OULGQCoYBWDzn8TOxwm4xdgL6nqv0qJ6KHly/mtmBuatOVyUJegoxvKDQ4tKqGnImLL3FJ+srH8vioG+/ksAxWRmi5SgGKazenonJ6e++tDH3HR7zd5e917WcYnlQqHUZbn1pCZE7mWLFWj/4osn/Af3mu27a+nReGodW6U5wn3adJ42rQd8RoNOhakJ2/2qqNmSA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=vP4++gMVso6NJgCf4yKAKkzqkAKXxdKz2sTcPjJo/tU=; b=TE/wJKBiiA7/zFqbjxjuezWnrprZ/a8a4jn+9VXYdHjG8fwt+uzpH68lyPrDxD85ALlgqaeHzUcVpTny//WOYsuWwFXXHEdPJqtGjh0uQkmhVgOyR5X094o4J/QCEhVQ295Uw5GdrHhOQih6MrDekQllWiP/xnE9QMCGq0fJKLGF+BcGeReDNV2ZMENh/N8heQd7SVfd11AMgGw6Z2gETuGGvSO+MlFWYlcNlBmIrouovMsZ9Fvd2DXvV8YLk8UakAMfb1S3aLSDXHZyWvVRaKhVcn6xnwCzDZypnwKe/nvLzaFO3yNH99031zOfB3KQezGm01vQJ2ntgyG/OENhYg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.118.232) smtp.rcpttodomain=amd.com smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=vP4++gMVso6NJgCf4yKAKkzqkAKXxdKz2sTcPjJo/tU=; b=TgmDvR7kXd/a5kR2dumKcOP8SGwx/Eqm5ri6GukRCJcU9hHLzzFHH+afZc7RcpNKLPgOS/B1MbtwjT9L+Gtk2yXIGEJqFshjV7g8MbdQCbw5p/iOUEzoCGr8fFxLA7Rf+asrg5cCs9t3ds/S7gemL9SmhAiwFYBPj+9QarXuCicrvG8+c4Sq4x4+5zSvBm56a7nZicLE8r2ugXWbEPcufst4Ip15XgIybm3omT9OO5t8jdKVCTMS/h3Yu4RZOjlOIjoyHJj8UiTnOhvpG//6h+olcLV1F8vqhs2vfHHX3uGLWhlfeDdtFfMCyjQzzs1eq/bObNFEATI67Z4r7mQbLw== Received: from SJ0PR03CA0018.namprd03.prod.outlook.com (2603:10b6:a03:33a::23) by CH3PR12MB9195.namprd12.prod.outlook.com (2603:10b6:610:1a3::6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8901.23; Sat, 5 Jul 2025 01:14:41 +0000 Received: from CO1PEPF000042AD.namprd03.prod.outlook.com (2603:10b6:a03:33a:cafe::41) by SJ0PR03CA0018.outlook.office365.com (2603:10b6:a03:33a::23) with Microsoft SMTP Server (version=TLS1_3, cipher=TLS_AES_256_GCM_SHA384) id 15.20.8901.24 via Frontend Transport; Sat, 5 Jul 2025 01:14:40 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.118.232) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.118.232 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.118.232; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.118.232) by CO1PEPF000042AD.mail.protection.outlook.com (10.167.243.42) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.8901.20 via Frontend Transport; Sat, 5 Jul 2025 01:14:40 +0000 Received: from drhqmail202.nvidia.com (10.126.190.181) by mail.nvidia.com (10.127.129.5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.4; Fri, 4 Jul 2025 18:14:25 -0700 Received: from drhqmail201.nvidia.com (10.126.190.180) by drhqmail202.nvidia.com (10.126.190.181) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.1544.14; Fri, 4 Jul 2025 18:14:25 -0700 Received: from Asurada-Nvidia.nvidia.com (10.127.8.12) by mail.nvidia.com (10.126.190.180) with Microsoft SMTP Server id 15.2.1544.14 via Frontend Transport; Fri, 4 Jul 2025 18:14:23 -0700 From: Nicolin Chen To: , , , CC: , , , , , , , , , , , , , , , , , , , , , , , , , Subject: [PATCH v8 19/29] Documentation: userspace-api: iommufd: Update HW QUEUE Date: Fri, 4 Jul 2025 18:13:35 -0700 Message-ID: X-Mailer: git-send-email 2.43.0 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-NV-OnPremToCloud: AnonymousSubmission X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1PEPF000042AD:EE_|CH3PR12MB9195:EE_ X-MS-Office365-Filtering-Correlation-Id: 15e550b2-082c-4766-c096-08ddbb615159 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|7416014|376014|82310400026|36860700013|1800799024; X-Microsoft-Antispam-Message-Info: =?us-ascii?Q?VrWzIKKMy1685a7I4Yh2NVWXAmlqdYKEBjVEUJzc0r/09gpO3+TBe3YZs32S?= =?us-ascii?Q?PbRaM5vV1K1eBtiX5PYksmOOyWxt7IhmYKWF/uJT5TPcQUzpwYiRrMmT9V0R?= =?us-ascii?Q?n2RobhDVWw45djyrNVRDVJezH3lRHGrs363jNnn2bptk27VR1Jk1PdHr2W/t?= =?us-ascii?Q?0M2yo9synTlTWQk6TW93yx5Q8DOTKctcflnXnIk//PhdipIlK3/kzEC+AcZ3?= =?us-ascii?Q?kIASleQ7wXgHrV9kPzFcs5kUasGSZzqzfAbjWuiPuwU7L3aVytworoBofs4/?= =?us-ascii?Q?tRdPh8J9sJcRnCALv63Rx/8ilPZdpHNgRBQcK3ct2yBZ2/eNIthAPS57ZYAU?= =?us-ascii?Q?Zd/eH2WRPbpXrehd1WQf9CLhX60LHPrS/W1QhnstAox5I3+0TAn95CHwEk0X?= =?us-ascii?Q?riXodsTccP5arnHhO6goZHktALzQHoiulIvJb4HuquU2dCEUw5hH0MF4zPxf?= =?us-ascii?Q?reouXkl39Im+jXOCfy/pbLAGTgGbnr0MF9+2sj19E1anSs+esyB9mZ1rqGkz?= =?us-ascii?Q?sWbK0/orkwQ8xlqBn8RrJlCsbaRVZjOkUXPwKcZH05bxc86ZBY7IyAqQZMrr?= =?us-ascii?Q?C36PSvpyGw78dndHdE8qly2VCE2u2GXaYy7WMdmJnejic6jNwt7qyl7NMStL?= =?us-ascii?Q?zM8rfBxGIGr2WiJVuyHphBkgn7c1jsA58TMjSLTZCUarv0dOwwqy8HBhFM36?= =?us-ascii?Q?+eUY8IdrApaDZc8GuB8nFNx9/ftG/tJhiIBinxlWVElpbDyf3NSuJ4v18jD2?= =?us-ascii?Q?cEWXKWj3FduCbit66YUx5dEoVJyF4pHTToUq6B7Sce3iXqJwDlIcPuLj1qbA?= =?us-ascii?Q?GECkvpUu+BFB0f+EJGxi41h5NHXKB7D3SQTtqF7C5iwy4D8FfmyxbBOhWHVs?= =?us-ascii?Q?ji8T7ZMVYGZdlMFmF7m5gy9MHdTT1KypLyWKu9lBAo2nIcFR5RljbM4S+JCY?= =?us-ascii?Q?x+pkE6jRzK/ikoR76p/RSo90ooZKT20IwB6Xvz4czIEJIpAA3l+gYDT3CZ6C?= =?us-ascii?Q?aGz3eHyJmlSs081ahJEpyCZLLOQFvUUUw0VYKNU/IzKH2RAu6Sw6CBXv65OK?= =?us-ascii?Q?7iW8JBWiVOcJXm06mLYVKBpRk1/pONbZHBBUEOjTrP4KjGt1VDiDZw0+JkcK?= =?us-ascii?Q?OIv4A1HULyNs2v7O3AkydfMt7M3HmBYROcZ4RuwuUheATeFsdAPWNPBTLpZH?= =?us-ascii?Q?jJ1558uSfNT/ljljZcgvTQIQ63uQYQbaYD7qS+SCQKAA7fJ7JEdhSYrFzmve?= =?us-ascii?Q?DB1WTdHBmOa9t0A0abkbmFWtDuiIwfwPxUcwX46JQiAH9h9YNUNYONw/aw6K?= =?us-ascii?Q?n2Gt3Ycgcv8cgA2GR9x+4PDin8LsYbrAdkITilMpyRzUPbyMrm1P5Va8/hkj?= =?us-ascii?Q?5Ji16HEJPLepWKYEO+wDKtOlpje/MxPrQr0rIy2wmQhRWVMHvP2qf+GBUmWJ?= =?us-ascii?Q?XJpFbYsEwB80bXsL+8T13cP0+jLnrAaI6dN5yym1Yp+G6y/eoiF1faNVOnnK?= =?us-ascii?Q?dELM/Z63OZ5ZwcbotIFcxqIIajdBYfE9ILMc?= X-Forefront-Antispam-Report: CIP:216.228.118.232;CTRY:US;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:mail.nvidia.com;PTR:dc7edge1.nvidia.com;CAT:NONE;SFS:(13230040)(7416014)(376014)(82310400026)(36860700013)(1800799024);DIR:OUT;SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jul 2025 01:14:40.6520 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 15e550b2-082c-4766-c096-08ddbb615159 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a;Ip=[216.228.118.232];Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: CO1PEPF000042AD.namprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH3PR12MB9195 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20250704_181445_751815_C8E42002 X-CRM114-Status: GOOD ( 10.78 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org With the introduction of the new object and its infrastructure, update the doc to reflect that. Reviewed-by: Jason Gunthorpe Reviewed-by: Kevin Tian Reviewed-by: Lu Baolu Signed-off-by: Nicolin Chen --- Documentation/userspace-api/iommufd.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/userspace-api/iommufd.rst b/Documentation/userspace-api/iommufd.rst index b0df15865dec..03f7510384d2 100644 --- a/Documentation/userspace-api/iommufd.rst +++ b/Documentation/userspace-api/iommufd.rst @@ -124,6 +124,17 @@ Following IOMMUFD objects are exposed to userspace: used to allocate a vEVENTQ. Each vIOMMU can support multiple types of vEVENTS, but is confined to one vEVENTQ per vEVENTQ type. +- IOMMUFD_OBJ_HW_QUEUE, representing a hardware accelerated queue, as a subset + of IOMMU's virtualization features, for the IOMMU HW to directly read or write + the virtual queue memory owned by a guest OS. This HW-acceleration feature can + allow VM to work with the IOMMU HW directly without a VM Exit, so as to reduce + overhead from the hypercalls. Along with the HW QUEUE object, iommufd provides + user space an mmap interface for VMM to mmap a physical MMIO region from the + host physical address space to the guest physical address space, allowing the + guest OS to directly control the allocated HW QUEUE. Thus, when allocating a + HW QUEUE, the VMM must request a pair of mmap info (offset/length) and pass in + exactly to an mmap syscall via its offset and length arguments. + All user-visible objects are destroyed via the IOMMU_DESTROY uAPI. The diagrams below show relationships between user-visible objects and kernel @@ -270,6 +281,7 @@ User visible objects are backed by following datastructures: - iommufd_viommu for IOMMUFD_OBJ_VIOMMU. - iommufd_vdevice for IOMMUFD_OBJ_VDEVICE. - iommufd_veventq for IOMMUFD_OBJ_VEVENTQ. +- iommufd_hw_queue for IOMMUFD_OBJ_HW_QUEUE. Several terminologies when looking at these datastructures: -- 2.43.0