From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f74.google.com (mail-pj1-f74.google.com [209.85.216.74]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1FDA438F64B for ; Mon, 23 Mar 2026 23:59:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.74 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1774310342; cv=none; b=hiMtbqPpYg+au3b1BtRopkezikGEJsYfEKhskpCMYPtZARk9V7WZbiebcoWk6uYzRUfJZRdtDvVHc4JeO/iQQWzf1ovr56mw0U4PqUf9wFZ61xKiRvikru9HzmX2UI84UlvAKOWX/Z0N34vc5yjUMUPfKr+Z4AnZctQKO6EobCw= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1774310342; c=relaxed/simple; bh=+70kIpVyn2x8kiDDC1PyFViZ/JQI+XUMMGbOcdpeoO4=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=PjpcY/yJ9SHFSVcrpRas574mxpvglf/5ytc4EyEwTjxIheNaXNTtJdzo0Yhr6Q3bY5SkPZtsL2SIC8HQP1fpc3XYqsOWuKTeXR9u99j5TlEK/flbnINAfcb9N4B4YOwcbMqSHnjPsl5mDyTv5EmUpGkCkFkTLqey72aSHx6I7mc= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--dmatlack.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=KonaVZOw; arc=none smtp.client-ip=209.85.216.74 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--dmatlack.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="KonaVZOw" Received: by mail-pj1-f74.google.com with SMTP id 98e67ed59e1d1-35b93be1227so4036238a91.0 for ; Mon, 23 Mar 2026 16:59:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20251104; t=1774310340; x=1774915140; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=aeeFxLRNeEzMbfk8m3pX/GNMnylfMV1s3l1hGn54HBA=; b=KonaVZOwrYOL3fHMUF+ukavBeIxBBYT0e1WJa4WvMJ1RSBuLqVV3Mk00Rrky5dagLx fSp009YFXfhs6YpR64ZSDt9o0Gx5tFeW2h8hSdMd5p07DR2H5BzGHf1Rh0VlayyCtHuo cS518Ky3jhHGrVUdoZ4eViVu5rsz+zFMmEtG+ZA4p0bDqxs1LHfaxv7Y8d9A5+gvkxE8 /xZml+WaebaztMPMViWBzVXwvU3k0br3vM8z0hkLDstZ0y1LUjnOQLE1ICpDqg8Gq0zJ f+v5z6k6SeaDg7+6dKEkku3vtwTz71tCrVxXoc9R0K0tf2MJlFH/InQhQtIhzviMKipW ukfw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20251104; t=1774310340; x=1774915140; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=aeeFxLRNeEzMbfk8m3pX/GNMnylfMV1s3l1hGn54HBA=; b=OUu4PK3x4r1i2TznvgzhEFDMU9pIMm+KlwNFfZWmeYA77/FbONehxmv9iLSuz/DFES wotIAgpNFAbHWHE8MZoLC4ydY4+WC76xTwiCZrVU0QrAU2ZTu3hkrjhWiFpcMGBqAcbw I0yr73kJPjhQU/04fFHfsvAZDto6xSCtedyomQwlehwnNkrGdNElNf34nMg/HigHJ7a9 77EwXNyUphyF4J02vGag5cJ0URcyq0nOWYUMg7AhsonCo41G5ekkhsqKx5k9mTO8TJdM PhsRuG7NvAvsoz1I5tCCKNTc6axqIsyuLywITUsDTOLLPoGJX1ijlAa+l2+Lxak5nLbC 1YDA== X-Forwarded-Encrypted: i=1; AJvYcCWtpHbimieIzhky5OUWp74s8UYR/095dZ1bHLG8JiX9b1zI0PfZ8Ll38tkO/2CLf1QrN0MS1rX9lwI=@vger.kernel.org X-Gm-Message-State: AOJu0Yw2e8Mhv0lpzNSlMzUH2HUPbX5rn1Sz4qVDief6GSxOF+Y9hSrW pkNrbVFF7rvahHigFyTH68nJDXbXz0SeWS5izWi5hK/GhPhJWqPiR7kZhUJUMJBqnH9Z6xauNLh ay0On83j593vWaQ== X-Received: from pgbcl21.prod.google.com ([2002:a05:6a02:995:b0:c73:90cf:9638]) (user=dmatlack job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a21:3286:b0:398:7ca0:43a9 with SMTP id adf61e73a8af0-39bceb46904mr12137508637.36.1774310340303; Mon, 23 Mar 2026 16:59:00 -0700 (PDT) Date: Mon, 23 Mar 2026 23:58:05 +0000 In-Reply-To: <20260323235817.1960573-1-dmatlack@google.com> Precedence: bulk X-Mailing-List: linux-doc@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20260323235817.1960573-1-dmatlack@google.com> X-Mailer: git-send-email 2.53.0.983.g0bb29b3bc5-goog Message-ID: <20260323235817.1960573-14-dmatlack@google.com> Subject: [PATCH v3 13/24] docs: liveupdate: Add documentation for VFIO PCI From: David Matlack To: Alex Williamson , Bjorn Helgaas Cc: Adithya Jayachandran , Alexander Graf , Alex Mastro , Andrew Morton , Ankit Agrawal , Arnd Bergmann , Askar Safin , "Borislav Petkov (AMD)" , Chris Li , Dapeng Mi , David Matlack , David Rientjes , Feng Tang , Jacob Pan , Jason Gunthorpe , Jason Gunthorpe , Jonathan Corbet , Josh Hilke , Kees Cook , Kevin Tian , kexec@lists.infradead.org, kvm@vger.kernel.org, Leon Romanovsky , Leon Romanovsky , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-mm@kvack.org, linux-pci@vger.kernel.org, Li RongQing , Lukas Wunner , Marco Elver , "=?UTF-8?q?Micha=C5=82=20Winiarski?=" , Mike Rapoport , Parav Pandit , Pasha Tatashin , "Paul E. McKenney" , Pawan Gupta , "Peter Zijlstra (Intel)" , Pranjal Shrivastava , Pratyush Yadav , Raghavendra Rao Ananta , Randy Dunlap , Rodrigo Vivi , Saeed Mahameed , Samiullah Khawaja , Shuah Khan , Vipin Sharma , Vivek Kasireddy , William Tu , Yi Liu , Zhu Yanjun Content-Type: text/plain; charset="UTF-8" Add documentation for preserving VFIO device files across a Live Update, generated from the kernel-doc comments in the code. Signed-off-by: David Matlack --- Documentation/core-api/liveupdate.rst | 1 + .../driver-api/vfio_pci_liveupdate.rst | 23 +++++++++++++++++++ MAINTAINERS | 1 + 3 files changed, 25 insertions(+) create mode 100644 Documentation/driver-api/vfio_pci_liveupdate.rst diff --git a/Documentation/core-api/liveupdate.rst b/Documentation/core-api/liveupdate.rst index d56a7760978a..c55d0d9d1d3b 100644 --- a/Documentation/core-api/liveupdate.rst +++ b/Documentation/core-api/liveupdate.rst @@ -34,6 +34,7 @@ The following types of file descriptors can be preserved :maxdepth: 1 ../mm/memfd_preservation + ../driver-api/vfio_pci_liveupdate Public API ========== diff --git a/Documentation/driver-api/vfio_pci_liveupdate.rst b/Documentation/driver-api/vfio_pci_liveupdate.rst new file mode 100644 index 000000000000..1098b84e5ecd --- /dev/null +++ b/Documentation/driver-api/vfio_pci_liveupdate.rst @@ -0,0 +1,23 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +==================================== +VFIO PCI Device Preservation via LUO +==================================== + +.. kernel-doc:: drivers/vfio/pci/vfio_pci_liveupdate.c + :doc: VFIO PCI Preservation via LUO + +VFIO PCI Preservation ABI +========================= + +.. kernel-doc:: include/linux/kho/abi/vfio_pci.h + :doc: VFIO PCI Live Update ABI + +.. kernel-doc:: include/linux/kho/abi/vfio_pci.h + :internal: + +See Also +======== + +- :doc:`/core-api/liveupdate` +- :doc:`/core-api/kho/index` diff --git a/MAINTAINERS b/MAINTAINERS index a16a7ecc67a4..a6a31b94a4e8 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -27684,6 +27684,7 @@ T: git https://github.com/awilliam/linux-vfio.git F: Documentation/ABI/testing/debugfs-vfio F: Documentation/ABI/testing/sysfs-devices-vfio-dev F: Documentation/driver-api/vfio.rst +F: Documentation/driver-api/vfio_pci_liveupdate.rst F: drivers/vfio/ F: include/linux/kho/abi/vfio_pci.h F: include/linux/vfio.h -- 2.53.0.983.g0bb29b3bc5-goog