From nobody Mon Dec 15 21:43:06 2025 Received: from galois.linutronix.de (Galois.linutronix.de [193.142.43.55]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 3193225487E; Fri, 16 May 2025 19:37:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=193.142.43.55 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1747424243; cv=none; b=QIMtoFGCE+/5Chc7Oxza/UGIDh6JFXYhZGQPhox8zoz25Vxm4sirKCRLqyqSBGxDkkxqHFp3cgIjIhiNRAV23qmQMWp2EliZ7lnFCIpXzGAvBu53WbcmbbBaoNZjqd6hYoxjr7bVmO+FNkt5ugSmMUsQGZVi7m+6lM5vg6nd7vU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1747424243; c=relaxed/simple; bh=XV7Mabx0jkOSQtW787IXpNREQcKfD0MsTIxPgW53hYI=; h=Date:From:To:Subject:Cc:In-Reply-To:References:MIME-Version: Message-ID:Content-Type; b=MWnETpJZ0b0uPCi9wL+FNFV6f8rSETUcJXqWvv12VtWIYmeNMhGoXy34tVM9woqJf/bOlgxklDPgU65K+zHIF4ICIJqEEUxbkC3KSKCB46jsGOWh57kuwwmsFhoCPQHxwxYUkwjqJtopVJI6kz7KWDeVFWbSQBFQn+4eMM8flnY= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de; spf=pass smtp.mailfrom=linutronix.de; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=1JeeU5G1; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b=WscY0PJN; arc=none smtp.client-ip=193.142.43.55 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linutronix.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=linutronix.de Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="1JeeU5G1"; dkim=permerror (0-bit key) header.d=linutronix.de header.i=@linutronix.de header.b="WscY0PJN" Date: Fri, 16 May 2025 19:37:18 -0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020; t=1747424239; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=5DvGvRGEXV4wavQ4C9VcZbknik/DEl+/lFAuTtCtG+c=; b=1JeeU5G19A/XGus05gNeYZs8hxKgoV+/h1Yn7sBcq6WGbuoDslh8+ca6k8meodL2UE6Abs StgzI5rHg4qeUinGZLURz3AUAOZUSxsymiyCBLAYqV299qaS4QUPPv8bHWJjJ1Kn6JE4Uu nWWAS14VXJwD0z61gCU+zspBbpiyrDoaNbg2W/p+TsS167G+SGJf+SqbVqdRe+0qFYWr8W V/Oy8inZMz6aDOwhThYdk8j7EOVmc+dofS+EwZxD/NP0qAbKD95o39fNhh9/7DvjxM7X/2 o+ktsJwPJyIEgfoLhQe6QRM4Fzo7OqEoysrvKYQTy2z/Lvre9cflxH8ztlZ3pw== DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=linutronix.de; s=2020e; t=1747424239; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=5DvGvRGEXV4wavQ4C9VcZbknik/DEl+/lFAuTtCtG+c=; b=WscY0PJNs1+iw5u0si/GvpiYfqtqXWSWd/L4yH0Ma9Sxy55GoBjzYPuaW1wRuexF0j0dSA YsI+e3uhTRvFvnDQ== From: "tip-bot2 for Jiri Slaby (SUSE)" Sender: tip-bot2@linutronix.de Reply-to: linux-kernel@vger.kernel.org To: linux-tip-commits@vger.kernel.org Subject: [tip: irq/cleanups] Documentation: irq-domain.rst: Simple improvements Cc: "Jiri Slaby (SUSE)" , Thomas Gleixner , x86@kernel.org, linux-kernel@vger.kernel.org In-Reply-To: <20250319092951.37667-56-jirislaby@kernel.org> References: <20250319092951.37667-56-jirislaby@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Message-ID: <174742423852.406.17027324675833018836.tip-bot2@tip-bot2> Robot-ID: Robot-Unsubscribe: Contact to get blacklisted from these emails Precedence: bulk Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable The following commit has been merged into the irq/cleanups branch of tip: Commit-ID: 95cfac1b2f85ed883b1748d7955e00f0980c1bb3 Gitweb: https://git.kernel.org/tip/95cfac1b2f85ed883b1748d7955e00f09= 80c1bb3 Author: Jiri Slaby (SUSE) AuthorDate: Wed, 19 Mar 2025 10:29:48 +01:00 Committer: Thomas Gleixner CommitterDate: Fri, 16 May 2025 21:06:13 +02:00 Documentation: irq-domain.rst: Simple improvements The improvements include: * Capitals in headlines. * Add commas: for easier reading, it is always desired to add commas at some places in text. Like before adverbs or after fronted sentences. * 3rd person -> add 's' to verbs. * End some sentences with period and start a new one. Avoid thus heavy sentences. [ tglx: Fix up subject prefix ] Signed-off-by: Jiri Slaby (SUSE) Signed-off-by: Thomas Gleixner Link: https://lore.kernel.org/all/20250319092951.37667-56-jirislaby@kernel.= org --- Documentation/core-api/irq/irq-domain.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/core-api/irq/irq-domain.rst b/Documentation/core= -api/irq/irq-domain.rst index c365c3e..cb25649 100644 --- a/Documentation/core-api/irq/irq-domain.rst +++ b/Documentation/core-api/irq/irq-domain.rst @@ -1,19 +1,19 @@ =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D -The irq_domain interrupt number mapping library +The irq_domain Interrupt Number Mapping Library =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 The current design of the Linux kernel uses a single large number space where each separate IRQ source is assigned a different number. This is simple when there is only one interrupt controller, but in -systems with multiple interrupt controllers the kernel must ensure +systems with multiple interrupt controllers, the kernel must ensure that each one gets assigned non-overlapping allocations of Linux IRQ numbers. =20 The number of interrupt controllers registered as unique irqchips -show a rising tendency: for example subdrivers of different kinds +shows a rising tendency. For example, subdrivers of different kinds such as GPIO controllers avoid reimplementing identical callback mechanisms as the IRQ core system by modelling their interrupt -handlers as irqchips, i.e. in effect cascading interrupt controllers. +handlers as irqchips. I.e. in effect cascading interrupt controllers. =20 Here the interrupt number loose all kind of correspondence to hardware interrupt numbers: whereas in the past, IRQ numbers could @@ -21,15 +21,15 @@ be chosen so they matched the hardware IRQ line into th= e root interrupt controller (i.e. the component actually fireing the interrupt line to the CPU) nowadays this number is just a number. =20 -For this reason we need a mechanism to separate controller-local -interrupt numbers, called hardware irq's, from Linux IRQ numbers. +For this reason, we need a mechanism to separate controller-local +interrupt numbers, called hardware IRQs, from Linux IRQ numbers. =20 The irq_alloc_desc*() and irq_free_desc*() APIs provide allocation of irq numbers, but they don't provide any support for reverse mapping of the controller-local IRQ (hwirq) number into the Linux IRQ number space. =20 -The irq_domain library adds mapping between hwirq and IRQ numbers on +The irq_domain library adds a mapping between hwirq and IRQ numbers on top of the irq_alloc_desc*() API. An irq_domain to manage mapping is preferred over interrupt controller drivers open coding their own reverse mapping scheme. @@ -38,7 +38,7 @@ irq_domain also implements translation from an abstract i= rq_fwspec structure to hwirq numbers (Device Tree and ACPI GSI so far), and can be easily extended to support other IRQ topology data sources. =20 -irq_domain usage +irq_domain Usage =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 An interrupt controller driver creates and registers an irq_domain by @@ -76,7 +76,7 @@ If the driver has the Linux IRQ number or the irq_data po= inter, and needs to know the associated hwirq number (such as in the irq_chip callbacks) then it can be directly obtained from irq_data->hwirq. =20 -Types of irq_domain mappings +Types of irq_domain Mappings =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D =20 There are several mechanisms available for reverse mapping from hwirq @@ -101,7 +101,7 @@ map are fixed time lookup for IRQ numbers, and irq_desc= s are only allocated for in-use IRQs. The disadvantage is that the table must be as large as the largest possible hwirq number. =20 -The majority of drivers should use the linear map. +The majority of drivers should use the Linear map. =20 Tree ---- @@ -189,7 +189,7 @@ that the driver using the simple domain call irq_create= _mapping() before any irq_find_mapping() since the latter will actually work for the static IRQ assignment case. =20 -Hierarchy IRQ domain +Hierarchy IRQ Domain -------------------- =20 On some architectures, there may be multiple interrupt controllers