From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.remote-ip=209.85.216.69 ARC-Seal: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; cv=none; t=1793633837; b=xcglG0x9Gr0Wc3BuxWJ1dNG1+Is3M7EwAYNSlhhqpMkNABkho/AW1d5b9wmHcl7X1a35 mGwJbUER4pl0THtzKxjlfPPclwuxhNPAwkDAmK0QAQR2G+0kcSPJSYzV4w1RP83Dw9z5u PQ8Ikxlu0ddGm8vtSJywSET/2UJmudqM00TGQ6EfTrWZNEXDeXR3BCf0/scfuFFcokqys BvYZH920ktgKIFnel81B0nONnGzB6P/eR8/SRK9piPwcMEBfGtEhbVoy/v2Fko0I2dYq3 SMJ6HlApbVlxkIk5FMMmACo8Il8TB9CtkjA6ocYJCD0FCL9+kicKpxKdB+3zOrUrN2A== ARC-Message-Signature: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; c=relaxed/relaxed; t=1793633837; h=DMARC-Filter:Received:DKIM-Signature:X-Google-DKIM-Signature: X-Forwarded-Encrypted:X-Gm-Message-State:X-Received:Date:In-Reply-To: Mime-Version:References:X-Mailer:Message-ID:Subject:From:To:Cc: Content-Type; bh=WePLvWtT/WZKO7Unx2RTF+SOz/N+MuUr8ckMVHiMFxQ=; b=k6Yfr4HbKbJROzKRCeMImyJPT2DuBF261FOMEigxVYuAnCDhBDhfyEmrQL6RBuQ5Ckqn V/rVnhLbWsD1hZuK4skQgwnDjHMbchSeUsZ7BaUOfeMTl+28w/Du5xCh2r9H6RojjQDrW 3GE6s3tBRn+iPajBzsgaNwurnfFxb/ol0HA3NFENlV7hzxRjJlOaCawja87qjr5GYRdEr 9apnW2nl1hv+xPy5Cq4fHqe6ifZIDF8PdXv7jbsVc+xi7b/uJs3OGW975Outz+TIGE2eV 4c8A8rROEH2l37SLQMMGjtrJ3Z9GdySj+FDT9D5qFih9Uachhie8uosZwjAv1pOFWtA== ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass header.from=google.com; spf=pass smtp.mailfrom=flex--vipinsh.bounces.google.com; dkim=pass header.d=google.com header.i=@google.com header.a=rsa-sha256 header.s=20260707 header.b=Bnp2TJZB; arc=none smtp.remote-ip=209.85.216.69 Received: from mail-pj1-f69.google.com (mail-pj1-f69.google.com [209.85.216.69]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B207060E7EF5 for ; Mon, 2 Nov 2026 15:37:16 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.2 smtp.subspace.kernel.org B207060E7EF5 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--vipinsh.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key, unprotected) header.d=google.com header.i=@google.com header.a=rsa-sha256 header.s=20260707 header.b=Bnp2TJZB Received: by mail-pj1-f69.google.com with SMTP id 98e67ed59e1d1-3ac8f449d1bso2538986a91.3 for ; Mon, 02 Nov 2026 07:37:16 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20260707; t=1793633836; x=1794238636; darn=vger.kernel.org; h=content-type:cc:to:from:subject:message-id:references:mime-version :in-reply-to:date:from:to:cc:subject:date:message-id:reply-to :content-type; bh=WePLvWtT/WZKO7Unx2RTF+SOz/N+MuUr8ckMVHiMFxQ=; b=Bnp2TJZBhnZ3Fomnoglqh4+l87hRvNmKBCiTZ6jAjRxWpXxYXsMgUH/cOuHl2dUEDC wJ28FoKeqWp3KhY3kQlFAu+HbXoVoKpftFYkfXzXm+aF5o8Yxg5mtJZ1b0uFCxMBxDgm KFvTzBa3lyHrYP+mRgVoI+h7ot0pIJHFTheHL5nZjIDui8mUz6RHgdkN1TSB/BqCPeqi xhJKJ+mimCLZP0IRb9FUgMCvIugwFwsw6AR1wrMrfwro8rW1hqu/148Rc/p7atFwmIRe ZtvNYcFiobuA1Z5LTkhQZGhi14HkwUC/IuKyXu15Eajkx7JixVLOz31OkOV9Cyb4Hcko IIXQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1793633836; x=1794238636; h=content-type: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:content-type; bh=WePLvWtT/WZKO7Unx2RTF+SOz/N+MuUr8ckMVHiMFxQ=; b=xesC8Ct/pWm4zR0HTxO+Tq/nuKcQJIFxfWa4RylEMqFi0Pk4Wgrfe4raFXeLKWcVf8 +k6QG91sRJYpgTInLiA0q331AeR14wHfawCFqJ2i5OVBmrTBVm8WOj+2zakPdrUWHKpU KKUmipxJvqM9dz94WRVg2Yxydchi/xuLBvfs+tiPl7M6VNpftOomn6joBCW7GtAGp7JC L77EWgkf4JiOlwbxWbJcjh2tLydNZLMS/csX0G8OXFKtLFrG1Nb/yIuofpkpyL3NrW0e hS7T+j58N7CcOXqwkKotdgiWodYxVR8IunW5i53wnyARQswYKH2COXMJDVku++D/NRlM 1z+A== X-Forwarded-Encrypted: i=1; AKwUvBzDws2EkzPe8XBrjs6VpSaeDHFD/gteFTczOxFNK2hQ6ynqCc0ETsT9AfHrrKD5N7+dW5ml+CpgJn4xR8w=@vger.kernel.org X-Gm-Message-State: APuU4Z+eLrYXyFVISi9n3gV7Rmt2vlNYTaUSuaktnvYxn7qBOtzLu4e7 ZQUtMjYgFbXNXoCvqAiGwKnAOSnuwgIXuiXWAjYbZj32zK1rUP3xEtp/cZAJGBNcXHCe4SyUOYn g9hMC0jgIqA== X-Received: from pjbcm14.prod.google.com ([2002:a17:90a:fa0e:b0:3a6:f87a:f3e1]) (user=vipinsh job=prod-delivery.src-stubby-dispatcher) by 2002:a17:90b:3807:b0:3ad:a232:403f with SMTP id 98e67ed59e1d1-3ae897aa79emr9013104a91.56.1793633835815; Mon, 02 Nov 2026 07:37:15 -0800 (PST) Date: Mon, 2 Nov 2026 07:36:44 -0800 In-Reply-To: <20261102153656.1431701-1-vipinsh@google.com> X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list Mime-Version: 1.0 References: <20261102153656.1431701-1-vipinsh@google.com> X-Mailer: git-send-email 2.56.0.317.g454f8302e1-goog Message-ID: <20261102153656.1431701-16-vipinsh@google.com> Subject: [PATCH v6 15/27] docs: liveupdate: Add documentation for VFIO PCI From: Vipin Sharma To: kexec@lists.infradead.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, kvm@vger.kernel.org, linux-mm@kvack.org, linux-kselftest@vger.kernel.org, linux-pci@vger.kernel.org Cc: ajayachandra@nvidia.com, alex@shazbot.org, amastro@fb.com, ankita@nvidia.com, apopple@nvidia.com, bhelgaas@google.com, chrisl@kernel.org, christian.koenig@amd.com, corbet@lwn.net, dmatlack@google.com, graf@amazon.com, jacob.pan@linux.microsoft.com, jgg@nvidia.com, jgg@ziepe.ca, jrhilke@google.com, julianr@linux.ibm.com, kees@kernel.org, kevin.tian@intel.com, leon@kernel.org, leonro@nvidia.com, lukas@wunner.de, mattev@meta.com, michal.winiarski@intel.com, parav@nvidia.com, pasha.tatashin@soleen.com, praan@google.com, pratyush@kernel.org, rananta@google.com, rdunlap@infradead.org, rientjes@google.com, rodrigo.vivi@intel.com, rppt@kernel.org, saeedm@nvidia.com, schnelle@linux.ibm.com, skhan@linuxfoundation.org, skhawaja@google.com, vipinsh@google.com, vivek.kasireddy@intel.com, witu@nvidia.com, yanjun.zhu@linux.dev, yi.l.liu@intel.com Content-Type: text/plain; charset="UTF-8" From: David Matlack 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 Signed-off-by: Vipin Sharma --- Documentation/core-api/liveupdate.rst | 1 + .../driver-api/vfio_pci_liveupdate.rst | 25 +++++++++++++++++++ MAINTAINERS | 1 + 3 files changed, 27 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 2bce2644eba2..20f1d2e20508 100644 --- a/Documentation/core-api/liveupdate.rst +++ b/Documentation/core-api/liveupdate.rst @@ -38,6 +38,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..81077ea173d1 --- /dev/null +++ b/Documentation/driver-api/vfio_pci_liveupdate.rst @@ -0,0 +1,25 @@ +.. 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` +- :doc:`/PCI/liveupdate` +- :doc:`/driver-api/vfio` diff --git a/MAINTAINERS b/MAINTAINERS index 167aa9d66ce8..2b62a0b8a48c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -28661,6 +28661,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.56.0.317.g454f8302e1-goog