Documentation/core-api/irq/irq-domain.rst

   1 ===============================================
   2 The irq_domain interrupt number mapping library
   3 ===============================================
   4
   5 The current design of the Linux kernel uses a single large number
   6 space where each separate IRQ source is assigned a different number.
   7 This is simple when there is only one interrupt controller, but in
   8 systems with multiple interrupt controllers the kernel must ensure
   9 that each one gets assigned non-overlapping allocations of Linux
  10 IRQ numbers.
  11
  12 The number of interrupt controllers registered as unique irqchips
  13 show a rising tendency: for example subdrivers of different kinds
  14 such as GPIO controllers avoid reimplementing identical callback
  15 mechanisms as the IRQ core system by modelling their interrupt
  16 handlers as irqchips, i.e. in effect cascading interrupt controllers.
  17
  18 Here the interrupt number loose all kind of correspondence to
  19 hardware interrupt numbers: whereas in the past, IRQ numbers could
  20 be chosen so they matched the hardware IRQ line into the root
  21 interrupt controller (i.e. the component actually fireing the
  22 interrupt line to the CPU) nowadays this number is just a number.
  23
  24 For this reason we need a mechanism to separate controller-local
  25 interrupt numbers, called hardware irq's, from Linux IRQ numbers.
  26
  27 The irq_alloc_desc*() and irq_free_desc*() APIs provide allocation of
  28 irq numbers, but they don't provide any support for reverse mapping of
  29 the controller-local IRQ (hwirq) number into the Linux IRQ number
  30 space.
  31
  32 The irq_domain library adds mapping between hwirq and IRQ numbers on
  33 top of the irq_alloc_desc*() API.  An irq_domain to manage mapping is
  34 preferred over interrupt controller drivers open coding their own
  35 reverse mapping scheme.
  36
  37 irq_domain also implements translation from an abstract irq_fwspec
  38 structure to hwirq numbers (Device Tree and ACPI GSI so far), and can
  39 be easily extended to support other IRQ topology data sources.
  40
  41 irq_domain usage
  42 ================
  43
  44 An interrupt controller driver creates and registers an irq_domain by
  45 calling one of the irq_domain_add_*() or irq_domain_create_*() functions
  46 (each mapping method has a different allocator function, more on that later).
  47 The function will return a pointer to the irq_domain on success. The caller
  48 must provide the allocator function with an irq_domain_ops structure.
  49
  50 In most cases, the irq_domain will begin empty without any mappings
  51 between hwirq and IRQ numbers.  Mappings are added to the irq_domain
  52 by calling irq_create_mapping() which accepts the irq_domain and a
  53 hwirq number as arguments.  If a mapping for the hwirq doesn't already
  54 exist then it will allocate a new Linux irq_desc, associate it with
  55 the hwirq, and call the .map() callback so the driver can perform any
  56 required hardware setup.
  57
  58 Once a mapping has been established, it can be retrieved or used via a
  59 variety of methods:
  60
  61 - irq_resolve_mapping() returns a pointer to the irq_desc structure
  62   for a given domain and hwirq number, and NULL if there was no
  63   mapping.
  64 - irq_find_mapping() returns a Linux IRQ number for a given domain and
  65   hwirq number, and 0 if there was no mapping
  66 - irq_linear_revmap() is now identical to irq_find_mapping(), and is
  67   deprecated
  68 - generic_handle_domain_irq() handles an interrupt described by a
  69   domain and a hwirq number
  70 - handle_domain_irq() does the same thing for root interrupt
  71   controllers and deals with the set_irq_reg()/irq_enter() sequences
  72   that most architecture requires
  73
  74 Note that irq domain lookups must happen in contexts that are
  75 compatible with a RCU read-side critical section.
  76
  77 The irq_create_mapping() function must be called *atleast once*
  78 before any call to irq_find_mapping(), lest the descriptor will not
  79 be allocated.
  80
  81 If the driver has the Linux IRQ number or the irq_data pointer, and
  82 needs to know the associated hwirq number (such as in the irq_chip
  83 callbacks) then it can be directly obtained from irq_data->hwirq.
  84
  85 Types of irq_domain mappings
  86 ============================
  87
  88 There are several mechanisms available for reverse mapping from hwirq
  89 to Linux irq, and each mechanism uses a different allocation function.
  90 Which reverse map type should be used depends on the use case.  Each
  91 of the reverse map types are described below:
  92
  93 Linear
  94 ------
  95
  96 ::
  97
  98         irq_domain_add_linear()
  99         irq_domain_create_linear()
 100
 101 The linear reverse map maintains a fixed size table indexed by the
 102 hwirq number.  When a hwirq is mapped, an irq_desc is allocated for
 103 the hwirq, and the IRQ number is stored in the table.
 104
 105 The Linear map is a good choice when the maximum number of hwirqs is
 106 fixed and a relatively small number (~ < 256).  The advantages of this
 107 map are fixed time lookup for IRQ numbers, and irq_descs are only
 108 allocated for in-use IRQs.  The disadvantage is that the table must be
 109 as large as the largest possible hwirq number.
 110
 111 irq_domain_add_linear() and irq_domain_create_linear() are functionally
 112 equivalent, except for the first argument is different - the former
 113 accepts an Open Firmware specific 'struct device_node', while the latter
 114 accepts a more general abstraction 'struct fwnode_handle'.
 115
 116 The majority of drivers should use the linear map.
 117
 118 Tree
 119 ----
 120
 121 ::
 122
 123         irq_domain_add_tree()
 124         irq_domain_create_tree()
 125
 126 The irq_domain maintains a radix tree map from hwirq numbers to Linux
 127 IRQs.  When an hwirq is mapped, an irq_desc is allocated and the
 128 hwirq is used as the lookup key for the radix tree.
 129
 130 The tree map is a good choice if the hwirq number can be very large
 131 since it doesn't need to allocate a table as large as the largest
 132 hwirq number.  The disadvantage is that hwirq to IRQ number lookup is
 133 dependent on how many entries are in the table.
 134
 135 irq_domain_add_tree() and irq_domain_create_tree() are functionally
 136 equivalent, except for the first argument is different - the former
 137 accepts an Open Firmware specific 'struct device_node', while the latter
 138 accepts a more general abstraction 'struct fwnode_handle'.
 139
 140 Very few drivers should need this mapping.
 141
 142 No Map
 143 ------
 144
 145 ::
 146
 147         irq_domain_add_nomap()
 148
 149 The No Map mapping is to be used when the hwirq number is
 150 programmable in the hardware.  In this case it is best to program the
 151 Linux IRQ number into the hardware itself so that no mapping is
 152 required.  Calling irq_create_direct_mapping() will allocate a Linux
 153 IRQ number and call the .map() callback so that driver can program the
 154 Linux IRQ number into the hardware.
 155
 156 Most drivers cannot use this mapping, and it is now gated on the
 157 CONFIG_IRQ_DOMAIN_NOMAP option. Please refrain from introducing new
 158 users of this API.
 159
 160 Legacy
 161 ------
 162
 163 ::
 164
 165         irq_domain_add_simple()
 166         irq_domain_add_legacy()
 167         irq_domain_create_simple()
 168         irq_domain_create_legacy()
 169
 170 The Legacy mapping is a special case for drivers that already have a
 171 range of irq_descs allocated for the hwirqs.  It is used when the
 172 driver cannot be immediately converted to use the linear mapping.  For
 173 example, many embedded system board support files use a set of #defines
 174 for IRQ numbers that are passed to struct device registrations.  In that
 175 case the Linux IRQ numbers cannot be dynamically assigned and the legacy
 176 mapping should be used.
 177
 178 As the name implies, the *_legacy() functions are deprecated and only
 179 exist to ease the support of ancient platforms. No new users should be
 180 added.
 181
 182 The legacy map assumes a contiguous range of IRQ numbers has already
 183 been allocated for the controller and that the IRQ number can be
 184 calculated by adding a fixed offset to the hwirq number, and
 185 visa-versa.  The disadvantage is that it requires the interrupt
 186 controller to manage IRQ allocations and it requires an irq_desc to be
 187 allocated for every hwirq, even if it is unused.
 188
 189 The legacy map should only be used if fixed IRQ mappings must be
 190 supported.  For example, ISA controllers would use the legacy map for
 191 mapping Linux IRQs 0-15 so that existing ISA drivers get the correct IRQ
 192 numbers.
 193
 194 Most users of legacy mappings should use irq_domain_add_simple() or
 195 irq_domain_create_simple() which will use a legacy domain only if an IRQ range
 196 is supplied by the system and will otherwise use a linear domain mapping.
 197 The semantics of this call are such that if an IRQ range is specified then
 198 descriptors will be allocated on-the-fly for it, and if no range is
 199 specified it will fall through to irq_domain_add_linear() or
 200 irq_domain_create_linear() which means *no* irq descriptors will be allocated.
 201
 202 A typical use case for simple domains is where an irqchip provider
 203 is supporting both dynamic and static IRQ assignments.
 204
 205 In order to avoid ending up in a situation where a linear domain is
 206 used and no descriptor gets allocated it is very important to make sure
 207 that the driver using the simple domain call irq_create_mapping()
 208 before any irq_find_mapping() since the latter will actually work
 209 for the static IRQ assignment case.
 210
 211 irq_domain_add_simple() and irq_domain_create_simple() as well as
 212 irq_domain_add_legacy() and irq_domain_create_legacy() are functionally
 213 equivalent, except for the first argument is different - the former
 214 accepts an Open Firmware specific 'struct device_node', while the latter
 215 accepts a more general abstraction 'struct fwnode_handle'.
 216
 217 Hierarchy IRQ domain
 218 --------------------
 219
 220 On some architectures, there may be multiple interrupt controllers
 221 involved in delivering an interrupt from the device to the target CPU.
 222 Let's look at a typical interrupt delivering path on x86 platforms::
 223
 224   Device --> IOAPIC -> Interrupt remapping Controller -> Local APIC -> CPU
 225
 226 There are three interrupt controllers involved:
 227
 228 1) IOAPIC controller
 229 2) Interrupt remapping controller
 230 3) Local APIC controller
 231
 232 To support such a hardware topology and make software architecture match
 233 hardware architecture, an irq_domain data structure is built for each
 234 interrupt controller and those irq_domains are organized into hierarchy.
 235 When building irq_domain hierarchy, the irq_domain near to the device is
 236 child and the irq_domain near to CPU is parent. So a hierarchy structure
 237 as below will be built for the example above::
 238
 239         CPU Vector irq_domain (root irq_domain to manage CPU vectors)
 240                 ^
 241                 |
 242         Interrupt Remapping irq_domain (manage irq_remapping entries)
 243                 ^
 244                 |
 245         IOAPIC irq_domain (manage IOAPIC delivery entries/pins)
 246
 247 There are four major interfaces to use hierarchy irq_domain:
 248
 249 1) irq_domain_alloc_irqs(): allocate IRQ descriptors and interrupt
 250    controller related resources to deliver these interrupts.
 251 2) irq_domain_free_irqs(): free IRQ descriptors and interrupt controller
 252    related resources associated with these interrupts.
 253 3) irq_domain_activate_irq(): activate interrupt controller hardware to
 254    deliver the interrupt.
 255 4) irq_domain_deactivate_irq(): deactivate interrupt controller hardware
 256    to stop delivering the interrupt.
 257
 258 Following changes are needed to support hierarchy irq_domain:
 259
 260 1) a new field 'parent' is added to struct irq_domain; it's used to
 261    maintain irq_domain hierarchy information.
 262 2) a new field 'parent_data' is added to struct irq_data; it's used to
 263    build hierarchy irq_data to match hierarchy irq_domains. The irq_data
 264    is used to store irq_domain pointer and hardware irq number.
 265 3) new callbacks are added to struct irq_domain_ops to support hierarchy
 266    irq_domain operations.
 267
 268 With support of hierarchy irq_domain and hierarchy irq_data ready, an
 269 irq_domain structure is built for each interrupt controller, and an
 270 irq_data structure is allocated for each irq_domain associated with an
 271 IRQ. Now we could go one step further to support stacked(hierarchy)
 272 irq_chip. That is, an irq_chip is associated with each irq_data along
 273 the hierarchy. A child irq_chip may implement a required action by
 274 itself or by cooperating with its parent irq_chip.
 275
 276 With stacked irq_chip, interrupt controller driver only needs to deal
 277 with the hardware managed by itself and may ask for services from its
 278 parent irq_chip when needed. So we could achieve a much cleaner
 279 software architecture.
 280
 281 For an interrupt controller driver to support hierarchy irq_domain, it
 282 needs to:
 283
 284 1) Implement irq_domain_ops.alloc and irq_domain_ops.free
 285 2) Optionally implement irq_domain_ops.activate and
 286    irq_domain_ops.deactivate.
 287 3) Optionally implement an irq_chip to manage the interrupt controller
 288    hardware.
 289 4) No need to implement irq_domain_ops.map and irq_domain_ops.unmap,
 290    they are unused with hierarchy irq_domain.
 291
 292 Hierarchy irq_domain is in no way x86 specific, and is heavily used to
 293 support other architectures, such as ARM, ARM64 etc.
 294
 295 Debugging
 296 =========
 297
 298 Most of the internals of the IRQ subsystem are exposed in debugfs by
 299 turning CONFIG_GENERIC_IRQ_DEBUGFS on.