1.. include:: ../../disclaimer-zh_CN.rst
2
3:Original: Documentation/core-api/irq/irq-domain.rst
4
5:翻译:
6
7 司延腾 Yanteng Si <siyanteng@loongson.cn>
8
9.. _cn_irq-domain.rst:
10
11=======================
12irq_domain 中断号映射库
13=======================
14
15目前Linux内核的设计使用了一个巨大的数字空间,每个独立的IRQ源都被分配了一个不
16同的数字。
17当只有一个中断控制器时,这很简单,但在有多个中断控制器的系统中,内核必须确保每
18个中断控制器都能得到非重复的Linux IRQ号(数字)分配。
19
20注册为唯一的irqchips的中断控制器编号呈现出上升的趋势:例如GPIO控制器等不同
21种类的子驱动程序通过将其中断处理程序建模为irqchips,即实际上是级联中断控制器,
22避免了重新实现与IRQ核心系统相同的回调机制。
23
24在这里,中断号与硬件中断号离散了所有种类的对应关系:而在过去,IRQ号可以选择,
25使它们与硬件IRQ线进入根中断控制器(即实际向CPU发射中断线的组件)相匹配,现
26在这个编号仅仅是一个数字。
27
28出于这个原因,我们需要一种机制将控制器本地中断号(即硬件irq编号)与Linux IRQ
29号分开。
30
31irq_alloc_desc*() 和 irq_free_desc*() API 提供了对irq号的分配,但它们不
32提供任何对控制器本地IRQ(hwirq)号到Linux IRQ号空间的反向映射的支持。
33
34irq_domain 库在 irq_alloc_desc*() API 的基础上增加了 hwirq 和 IRQ 号码
35之间的映射。 相比于中断控制器驱动开放编码自己的反向映射方案,我们更喜欢用
36irq_domain来管理映射。
37
38irq_domain还实现了从抽象的irq_fwspec结构体到hwirq号的转换(到目前为止是
39Device Tree和ACPI GSI),并且可以很容易地扩展以支持其它IRQ拓扑数据源。
40
41irq_domain的用法
42================
43
44中断控制器驱动程序通过以下方式创建并注册一个irq_domain。调用
45irq_domain_add_*() 或 irq_domain_create_*()函数之一(每个映射方法都有不
46同的分配器函数,后面会详细介绍)。 函数成功后会返回一个指向irq_domain的指针。
47调用者必须向分配器函数提供一个irq_domain_ops结构体。
48
49在大多数情况下,irq_domain在开始时是空的,没有任何hwirq和IRQ号之间的映射。
50通过调用irq_create_mapping()将映射添加到irq_domain中,该函数接受
51irq_domain和一个hwirq号作为参数。 如果hwirq的映射还不存在,那么它将分配
52一个新的Linux irq_desc,将其与hwirq关联起来,并调用.map()回调,这样驱动
53程序就可以执行任何必要的硬件设置。
54
55当接收到一个中断时,应该使用irq_find_mapping()函数从hwirq号中找到
56Linux IRQ号。
57
58在调用irq_find_mapping()之前,至少要调用一次irq_create_mapping()函数,
59以免描述符不能被分配。
60
61如果驱动程序有Linux的IRQ号或irq_data指针,并且需要知道相关的hwirq号(比
62如在irq_chip回调中),那么可以直接从irq_data->hwirq中获得。
63
64irq_domain映射的类型
65====================
66
67从hwirq到Linux irq的反向映射有几种机制,每种机制使用不同的分配函数。应该
68使用哪种反向映射类型取决于用例。 下面介绍每一种反向映射类型:
69
70线性映射
71--------
72
73::
74
75	irq_domain_add_linear()
76	irq_domain_create_linear()
77
78线性反向映射维护了一个固定大小的表,该表以hwirq号为索引。 当一个hwirq被映射
79时,会给hwirq分配一个irq_desc,并将irq号存储在表中。
80
81当最大的hwirq号固定且数量相对较少时,线性图是一个很好的选择(~<256)。 这种
82映射的优点是固定时间查找IRQ号,而且irq_descs只分配给在用的IRQ。 缺点是该表
83必须尽可能大的hwirq号。
84
85irq_domain_add_linear()和irq_domain_create_linear()在功能上是等价的,
86除了第一个参数不同--前者接受一个Open Firmware特定的 'struct device_node' 而
87后者接受一个更通用的抽象 'struct fwnode_handle' 。
88
89大多数驱动应该使用线性映射
90
91树状映射
92--------
93
94::
95
96	irq_domain_add_tree()
97	irq_domain_create_tree()
98
99irq_domain维护着从hwirq号到Linux IRQ的radix的树状映射。 当一个hwirq被映射时,
100一个irq_desc被分配,hwirq被用作radix树的查找键。
101
102如果hwirq号可以非常大,树状映射是一个很好的选择,因为它不需要分配一个和最大hwirq
103号一样大的表。 缺点是,hwirq到IRQ号的查找取决于表中有多少条目。
104
105irq_domain_add_tree()和irq_domain_create_tree()在功能上是等价的,除了第一
106个参数不同——前者接受一个Open Firmware特定的 'struct device_node' ,而后者接受
107一个更通用的抽象 'struct fwnode_handle' 。
108
109很少有驱动应该需要这个映射。
110
111无映射
112------
113
114::
115
116	irq_domain_add_nomap()
117
118当硬件中的hwirq号是可编程的时候,就可以采用无映射类型。 在这种情况下,最好将
119Linux IRQ号编入硬件本身,这样就不需要映射了。 调用irq_create_direct_mapping()
120会分配一个Linux IRQ号,并调用.map()回调,这样驱动就可以将Linux IRQ号编入硬件中。
121
122大多数驱动程序不能使用这个映射。
123
124传统映射类型
125------------
126
127::
128
129	irq_domain_add_simple()
130	irq_domain_add_legacy()
131	irq_domain_add_legacy_isa()
132	irq_domain_create_simple()
133	irq_domain_create_legacy()
134
135传统映射是已经为 hwirqs 分配了一系列 irq_descs 的驱动程序的特殊情况。 当驱动程
136序不能立即转换为使用线性映射时,就会使用它。 例如,许多嵌入式系统板卡支持文件使用
137一组用于IRQ号的定义(#define),这些定义被传递给struct设备注册。 在这种情况下,
138不能动态分配Linux IRQ号,应该使用传统映射。
139
140传统映射假设已经为控制器分配了一个连续的IRQ号范围,并且可以通过向hwirq号添加一
141个固定的偏移来计算IRQ号,反之亦然。 缺点是需要中断控制器管理IRQ分配,并且需要为每
142个hwirq分配一个irq_desc,即使它没有被使用。
143
144只有在必须支持固定的IRQ映射时,才应使用传统映射。 例如,ISA控制器将使用传统映射来
145映射Linux IRQ 0-15,这样现有的ISA驱动程序就能得到正确的IRQ号。
146
147大多数使用传统映射的用户应该使用irq_domain_add_simple()或
148irq_domain_create_simple(),只有在系统提供IRQ范围时才会使用传统域,否则将使用
149线性域映射。这个调用的语义是这样的:如果指定了一个IRQ范围,那么 描述符将被即时分配
150给它,如果没有范围被分配,它将不会执行 irq_domain_add_linear() 或
151irq_domain_create_linear(),这意味着 *no* irq 描述符将被分配。
152
153一个简单域的典型用例是,irqchip供应商同时支持动态和静态IRQ分配。
154
155为了避免最终出现使用线性域而没有描述符被分配的情况,确保使用简单域的驱动程序在任何
156irq_find_mapping()之前调用irq_create_mapping()是非常重要的,因为后者实际上
157将用于静态IRQ分配情况。
158
159irq_domain_add_simple()和irq_domain_create_simple()以及
160irq_domain_add_legacy()和irq_domain_create_legacy()在功能上是等价的,只
161是第一个参数不同--前者接受Open Firmware特定的 'struct device_node' ,而后者
162接受一个更通用的抽象 'struct fwnode_handle' 。
163
164IRQ域层级结构
165-------------
166
167在某些架构上,可能有多个中断控制器参与将一个中断从设备传送到目标CPU。
168让我们来看看x86平台上典型的中断传递路径吧
169::
170
171  Device --> IOAPIC -> Interrupt remapping Controller -> Local APIC -> CPU
172
173涉及到的中断控制器有三个:
174
1751) IOAPIC 控制器
1762) 中断重映射控制器
1773) Local APIC 控制器
178
179为了支持这样的硬件拓扑结构,使软件架构与硬件架构相匹配,为每个中断控制器建立一
180个irq_domain数据结构,并将这些irq_domain组织成层次结构。
181
182在建立irq_domain层次结构时,靠近设备的irq_domain为子域,靠近CPU的
183irq_domain为父域。所以在上面的例子中,将建立如下的层次结构。
184::
185
186	CPU Vector irq_domain (root irq_domain to manage CPU vectors)
187		^
188		|
189	Interrupt Remapping irq_domain (manage irq_remapping entries)
190		^
191		|
192	IOAPIC irq_domain (manage IOAPIC delivery entries/pins)
193
194使用irq_domain层次结构的主要接口有四个:
195
1961) irq_domain_alloc_irqs(): 分配IRQ描述符和与中断控制器相关的资源来传递这些中断。
1972) irq_domain_free_irqs(): 释放IRQ描述符和与这些中断相关的中断控制器资源。
1983) irq_domain_activate_irq(): 激活中断控制器硬件以传递中断。
1994) irq_domain_deactivate_irq(): 停用中断控制器硬件,停止传递中断。
200
201为了支持irq_domain层次结构,需要做如下修改:
202
2031) 一个新的字段 'parent' 被添加到irq_domain结构中;它用于维护irq_domain的层次信息。
2042) 一个新的字段 'parent_data' 被添加到irq_data结构中;它用于建立层次结构irq_data以
205   匹配irq_domain层次结构。irq_data用于存储irq_domain指针和硬件irq号。
2063) 新的回调被添加到irq_domain_ops结构中,以支持层次结构的irq_domain操作。
207
208在支持分层irq_domain和分层irq_data准备就绪后,为每个中断控制器建立一个irq_domain结
209构,并为每个与IRQ相关联的irq_domain分配一个irq_data结构。现在我们可以再进一步支持堆
210栈式(层次结构)的irq_chip。也就是说,一个irq_chip与层次结构中的每个irq_data相关联。
211一个子irq_chip可以自己或通过与它的父irq_chip合作来实现一个所需的操作。
212
213通过堆栈式的irq_chip,中断控制器驱动只需要处理自己管理的硬件,在需要的时候可以向其父
214irq_chip请求服务。所以我们可以实现更简洁的软件架构。
215
216为了让中断控制器驱动程序支持irq_domain层次结构,它需要做到以下几点:
217
2181) 实现 irq_domain_ops.allocirq_domain_ops.free
2192) 可选择地实现 irq_domain_ops.activateirq_domain_ops.deactivate.
2203) 可选择地实现一个irq_chip来管理中断控制器硬件。
2214) 不需要实现irq_domain_ops.mapirq_domain_ops.unmap,它们在层次结构
222   irq_domain中是不用的。
223
224irq_domain层次结构绝不是x86特有的,大量用于支持其他架构,如ARM、ARM64等。
225
226调试功能
227========
228
229打开CONFIG_GENERIC_IRQ_DEBUGFS,可让IRQ子系统的大部分内部结构都在debugfs中暴露出来。
230