From patchwork Sat Oct 28 07:54:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: liulongfang X-Patchwork-Id: 159237 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:d641:0:b0:403:3b70:6f57 with SMTP id cy1csp1094563vqb; Sat, 28 Oct 2023 00:59:14 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGe7OLG4WnVniYFcEfincNd924voWym9qIdQTeWjDiC7vvLMPGrLvdRJ0S4nx/ceYFegVLe X-Received: by 2002:aa7:881a:0:b0:690:9a5a:e34e with SMTP id c26-20020aa7881a000000b006909a5ae34emr9619809pfo.12.1698479954118; Sat, 28 Oct 2023 00:59:14 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698479954; cv=none; d=google.com; s=arc-20160816; b=rmiN2p78N3bjw00qG/cNr8QjeZSHKkNYdN4y9c3he8P1piIEwmgi4kH4gFtDraUWfs 2tZkc0n9sgJOdrOxIlwjbIs1zPAqCuMp2UDjsuw9RdR4QWTdIavGX9NUnD3+lO/tU8Xd uVcAQJehfrd84qLzaYNWp+adNdnchC+5gu9pnNZaqzM5dO8hBwCVCdab9HY2lv1ML5WT 6LtCc5gHvnv4uFWD+WesBP5AIz8XJPSxh7S5fi8b1G/M/G2IeZ3Pds8mv+E8Ez/oTF1T K3uJmTiqllJPZU84+h4+3zEl92nLFYOQfLnTTG5Fg6RGmgLU6/dGSie9aW43BvCJkKfp ta6w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=rBsnfoElNo0NEKZGGKyZ/pnTT2rK3NKKZA6ZyN0cK3g=; fh=6RjYAQ34uDeYKm0rLOoNcFiQikSk6+SaiM0Axnq7aoY=; b=pzBIcJPr+bz8dugagUctro3LGCRo26oe90SZzsSlO6yJBwCKsOEoDXSYzalrgS9V1u 8n75Y/Di00zmicB0P1B8JDfzJ/Z5kJ1TZ2ahuBormpqLLfu33UP5UdlsZ7xyjEz0/0Z0 B3cfKFQ62WT9xZaP4fVUVf8xFblblAykBN2755dcGtCqGNwhg4jKJumNLi0RP2P0zV1i Ofvgxyumo/JKZWr8GVoinaeyqcTUdpCiOGzETLeCOqxYElgmAaXmkrfazT+BCB0A3xAw gPMOeMgND+X3mpqrtQ1VdcfmYKfNFIi/9zzA9uQrTPoQsTqXUAEscAtugUw9+Z465mAR 8U8Q== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=huawei.com Received: from howler.vger.email (howler.vger.email. [23.128.96.34]) by mx.google.com with ESMTPS id b22-20020a656696000000b00578d08489a8si2107840pgw.832.2023.10.28.00.59.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 28 Oct 2023 00:59:14 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) client-ip=23.128.96.34; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=huawei.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by howler.vger.email (Postfix) with ESMTP id C2082836E5EE; Sat, 28 Oct 2023 00:59:11 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at howler.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233099AbjJ1H64 (ORCPT + 27 others); Sat, 28 Oct 2023 03:58:56 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53762 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229458AbjJ1H6z (ORCPT ); Sat, 28 Oct 2023 03:58:55 -0400 Received: from szxga08-in.huawei.com (szxga08-in.huawei.com [45.249.212.255]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BD384F2; Sat, 28 Oct 2023 00:58:52 -0700 (PDT) Received: from kwepemm000005.china.huawei.com (unknown [172.30.72.54]) by szxga08-in.huawei.com (SkyGuard) with ESMTP id 4SHX0B567Jz1L9L1; Sat, 28 Oct 2023 15:55:54 +0800 (CST) Received: from huawei.com (10.50.163.32) by kwepemm000005.china.huawei.com (7.193.23.27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.31; Sat, 28 Oct 2023 15:58:50 +0800 From: Longfang Liu To: , , , CC: , , , , Subject: [PATCH v18 2/2] Documentation: add debugfs description for vfio Date: Sat, 28 Oct 2023 15:54:47 +0800 Message-ID: <20231028075447.41939-3-liulongfang@huawei.com> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20231028075447.41939-1-liulongfang@huawei.com> References: <20231028075447.41939-1-liulongfang@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.50.163.32] X-ClientProxiedBy: dggems706-chm.china.huawei.com (10.3.19.183) To kwepemm000005.china.huawei.com (7.193.23.27) X-CFilter-Loop: Reflected X-Spam-Status: No, score=-0.8 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on howler.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (howler.vger.email [0.0.0.0]); Sat, 28 Oct 2023 00:59:11 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780985316375197699 X-GMAIL-MSGID: 1780985316375197699 1.Add an debugfs document description file to help users understand how to use the accelerator live migration driver's debugfs. 2.Update the file paths that need to be maintained in MAINTAINERS Signed-off-by: Longfang Liu Reviewed-by: Cédric Le Goater --- Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++++++++++++ MAINTAINERS | 1 + 2 files changed, 26 insertions(+) create mode 100644 Documentation/ABI/testing/debugfs-vfio diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio new file mode 100644 index 000000000000..445e9f58f924 --- /dev/null +++ b/Documentation/ABI/testing/debugfs-vfio @@ -0,0 +1,25 @@ +What: /sys/kernel/debug/vfio +Date: Oct 2023 +KernelVersion: 6.7 +Contact: Longfang Liu +Description: This debugfs file directory is used for debugging + of vfio devices, it's a common directory for all vfio devices. + Vfio core will create a device subdirectory under this + directory. + +What: /sys/kernel/debug/vfio//migration +Date: Oct 2023 +KernelVersion: 6.7 +Contact: Longfang Liu +Description: This debugfs file directory is used for debugging + of vfio devices that support live migration. + The debugfs of each vfio device that supports live migration + could be created under this directory. + +What: /sys/kernel/debug/vfio//migration/state +Date: Oct 2023 +KernelVersion: 6.7 +Contact: Longfang Liu +Description: Read the live migration status of the vfio device. + The contents of the state file reflects the migration state + relative to those defined in the vfio_device_mig_state enum diff --git a/MAINTAINERS b/MAINTAINERS index b19995690904..a6be3b4219c7 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -22591,6 +22591,7 @@ L: kvm@vger.kernel.org S: Maintained T: git https://github.com/awilliam/linux-vfio.git F: Documentation/ABI/testing/sysfs-devices-vfio-dev +F: Documentation/ABI/testing/debugfs-vfio F: Documentation/driver-api/vfio.rst F: drivers/vfio/ F: include/linux/vfio.h