From patchwork Fri May 1 15:37:51 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 220070 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.1 required=3.0 tests=DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING, SIGNED_OFF_BY, SPF_HELO_NONE, SPF_PASS, URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 79EC2C4725C for ; Fri, 1 May 2020 15:38:07 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 558C224957 for ; Fri, 1 May 2020 15:38:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588347487; bh=DqV5tt7bHxzmhEDH0R92jdv94glyuDJHK0UGYQwwLAQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=d6CM26s/4ii9W3fyoD9m9de7IGAuDOfJZyYpQ8lCHaX07FdIg48a42O6xeT/15isP efHAmTTHmTcL3/GGpiic02dOKNMBXR/2NwTX5924IsEtnuoyohkPX93lk2xS8sDt73 K+wMDfL3ZXmATa//eAyQ8vV7I+QCdTGAUIwXUXO4= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729909AbgEAPiG (ORCPT ); Fri, 1 May 2020 11:38:06 -0400 Received: from mail.kernel.org ([198.145.29.99]:52468 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1729835AbgEAPiF (ORCPT ); Fri, 1 May 2020 11:38:05 -0400 Received: from mail.kernel.org (ip5f5ad5c5.dynamic.kabel-deutschland.de [95.90.213.197]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 0DFCC24963; Fri, 1 May 2020 15:38:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588347483; bh=DqV5tt7bHxzmhEDH0R92jdv94glyuDJHK0UGYQwwLAQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=iVenbniXkCZCXAgoaKy3+95cQPpeXNYFzXl423hKovJnmAWcKoasW02KFDTBQOuUF NQTydk3YFUafOo3MPmZhuVwDQ0u8/YZbKS8lP93tYTWydmtuwu0KiYZAVJ5bQPA0HT 8gS89dSuJFLr+Qz0NY85QxHtYjoXCI1PytwvodXo= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jUXjl-00FE4r-4b; Fri, 01 May 2020 17:38:01 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Marc Zyngier , Tony Luck , Fenghua Yu , "David S. Miller" , Jakub Kicinski , Harry Wei , Alex Shi , Tejun Heo , Alexandre Belloni , Bartlomiej Zolnierkiewicz , Guenter Roeck , Marcos Paulo de Souza , Zenghui Yu , Daniel Jordan , Mike Rapoport , Masahiro Yamada , Rob Herring , Greg Kroah-Hartman , linux-ia64@vger.kernel.org, netdev@vger.kernel.org Subject: [PATCH 07/14] docs: add IRQ documentation at the core-api book Date: Fri, 1 May 2020 17:37:51 +0200 Message-Id: <2da7485c3718e1442e6b4c2dd66857b776e8899b.1588345503.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org There are 4 IRQ documentation files under Documentation/*.txt. Move them into a new directory (core-api/irq) and add a new index file for it. While here, use a title markup for the Debugging section of the irq-domain.rst file. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- Documentation/admin-guide/kernel-per-CPU-kthreads.rst | 2 +- Documentation/core-api/index.rst | 1 + Documentation/{IRQ.txt => core-api/irq/concepts.rst} | 0 Documentation/core-api/irq/index.rst | 11 +++++++++++ .../irq/irq-affinity.rst} | 0 .../{IRQ-domain.txt => core-api/irq/irq-domain.rst} | 3 ++- .../irq/irqflags-tracing.rst} | 0 Documentation/ia64/irq-redir.rst | 2 +- Documentation/networking/scaling.rst | 4 ++-- Documentation/translations/zh_CN/IRQ.txt | 4 ++-- MAINTAINERS | 2 +- 12 files changed, 22 insertions(+), 9 deletions(-) rename Documentation/{IRQ.txt => core-api/irq/concepts.rst} (100%) create mode 100644 Documentation/core-api/irq/index.rst rename Documentation/{IRQ-affinity.txt => core-api/irq/irq-affinity.rst} (100%) rename Documentation/{IRQ-domain.txt => core-api/irq/irq-domain.rst} (99%) rename Documentation/{irqflags-tracing.txt => core-api/irq/irqflags-tracing.rst} (100%) diff --git a/Documentation/admin-guide/hw-vuln/l1tf.rst b/Documentation/admin-guide/hw-vuln/l1tf.rst index f83212fae4d5..3eeeb488d955 100644 --- a/Documentation/admin-guide/hw-vuln/l1tf.rst +++ b/Documentation/admin-guide/hw-vuln/l1tf.rst @@ -268,7 +268,7 @@ Guest mitigation mechanisms /proc/irq/$NR/smp_affinity[_list] files. Limited documentation is available at: - https://www.kernel.org/doc/Documentation/IRQ-affinity.txt + https://www.kernel.org/doc/Documentation/core-api/irq/irq-affinity.rst .. _smt_control: diff --git a/Documentation/admin-guide/kernel-per-CPU-kthreads.rst b/Documentation/admin-guide/kernel-per-CPU-kthreads.rst index 21818aca4708..dc36aeb65d0a 100644 --- a/Documentation/admin-guide/kernel-per-CPU-kthreads.rst +++ b/Documentation/admin-guide/kernel-per-CPU-kthreads.rst @@ -10,7 +10,7 @@ them to a "housekeeping" CPU dedicated to such work. References ========== -- Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs. +- Documentation/core-api/irq/irq-affinity.rst: Binding interrupts to sets of CPUs. - Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst index ab056b3626f4..49a885e83a55 100644 --- a/Documentation/core-api/index.rst +++ b/Documentation/core-api/index.rst @@ -52,6 +52,7 @@ How Linux keeps everything from happening at the same time. See atomic_ops refcount-vs-atomic + irq/index local_ops padata ../RCU/index diff --git a/Documentation/IRQ.txt b/Documentation/core-api/irq/concepts.rst similarity index 100% rename from Documentation/IRQ.txt rename to Documentation/core-api/irq/concepts.rst diff --git a/Documentation/core-api/irq/index.rst b/Documentation/core-api/irq/index.rst new file mode 100644 index 000000000000..0d65d11e5420 --- /dev/null +++ b/Documentation/core-api/irq/index.rst @@ -0,0 +1,11 @@ +==== +IRQs +==== + +.. toctree:: + :maxdepth: 1 + + concepts + irq-affinity + irq-domain + irqflags-tracing diff --git a/Documentation/IRQ-affinity.txt b/Documentation/core-api/irq/irq-affinity.rst similarity index 100% rename from Documentation/IRQ-affinity.txt rename to Documentation/core-api/irq/irq-affinity.rst diff --git a/Documentation/IRQ-domain.txt b/Documentation/core-api/irq/irq-domain.rst similarity index 99% rename from Documentation/IRQ-domain.txt rename to Documentation/core-api/irq/irq-domain.rst index 507775cce753..096db12f32d5 100644 --- a/Documentation/IRQ-domain.txt +++ b/Documentation/core-api/irq/irq-domain.rst @@ -263,7 +263,8 @@ needs to: Hierarchy irq_domain is in no way x86 specific, and is heavily used to support other architectures, such as ARM, ARM64 etc. -=== Debugging === +Debugging +========= Most of the internals of the IRQ subsystem are exposed in debugfs by turning CONFIG_GENERIC_IRQ_DEBUGFS on. diff --git a/Documentation/irqflags-tracing.txt b/Documentation/core-api/irq/irqflags-tracing.rst similarity index 100% rename from Documentation/irqflags-tracing.txt rename to Documentation/core-api/irq/irqflags-tracing.rst diff --git a/Documentation/ia64/irq-redir.rst b/Documentation/ia64/irq-redir.rst index 39bf94484a15..6bbbbe4f73ef 100644 --- a/Documentation/ia64/irq-redir.rst +++ b/Documentation/ia64/irq-redir.rst @@ -7,7 +7,7 @@ IRQ affinity on IA64 platforms By writing to /proc/irq/IRQ#/smp_affinity the interrupt routing can be controlled. The behavior on IA64 platforms is slightly different from -that described in Documentation/IRQ-affinity.txt for i386 systems. +that described in Documentation/core-api/irq/irq-affinity.rst for i386 systems. Because of the usage of SAPIC mode and physical destination mode the IRQ target is one particular CPU and cannot be a mask of several diff --git a/Documentation/networking/scaling.rst b/Documentation/networking/scaling.rst index f78d7bf27ff5..8f0347b9fb3d 100644 --- a/Documentation/networking/scaling.rst +++ b/Documentation/networking/scaling.rst @@ -81,7 +81,7 @@ of queues to IRQs can be determined from /proc/interrupts. By default, an IRQ may be handled on any CPU. Because a non-negligible part of packet processing takes place in receive interrupt handling, it is advantageous to spread receive interrupts between CPUs. To manually adjust the IRQ -affinity of each interrupt see Documentation/IRQ-affinity.txt. Some systems +affinity of each interrupt see Documentation/core-api/irq/irq-affinity.rst. Some systems will be running irqbalance, a daemon that dynamically optimizes IRQ assignments and as a result may override any manual settings. @@ -160,7 +160,7 @@ can be configured for each receive queue using a sysfs file entry:: This file implements a bitmap of CPUs. RPS is disabled when it is zero (the default), in which case packets are processed on the interrupting -CPU. Documentation/IRQ-affinity.txt explains how CPUs are assigned to +CPU. Documentation/core-api/irq/irq-affinity.rst explains how CPUs are assigned to the bitmap. diff --git a/Documentation/translations/zh_CN/IRQ.txt b/Documentation/translations/zh_CN/IRQ.txt index 956026d5cf82..9aec8dca4fcf 100644 --- a/Documentation/translations/zh_CN/IRQ.txt +++ b/Documentation/translations/zh_CN/IRQ.txt @@ -1,4 +1,4 @@ -Chinese translated version of Documentation/IRQ.txt +Chinese translated version of Documentation/core-api/irq/index.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem @@ -9,7 +9,7 @@ or if there is a problem with the translation. Maintainer: Eric W. Biederman Chinese maintainer: Fu Wei --------------------------------------------------------------------- -Documentation/IRQ.txt 的中文翻译 +Documentation/core-api/irq/index.rst 的中文翻译 如果想评论或更新本文的内容，请直接联系原文档的维护者。如果你使用英文 交流有困难的话，也可以向中文版维护者求助。如果本翻译更新不及时或者翻 diff --git a/MAINTAINERS b/MAINTAINERS index a1d7af532950..6eb3d85a646f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8974,7 +8974,7 @@ IRQ DOMAINS (IRQ NUMBER MAPPING LIBRARY) M: Marc Zyngier S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip.git irq/core -F: Documentation/IRQ-domain.txt +F: Documentation/core-api/irq/irq-domain.rst F: include/linux/irqdomain.h F: kernel/irq/irqdomain.c F: kernel/irq/msi.c