Commit | Line | Data |
---|---|---|
046d9ce6 RW |
1 | /* |
2 | * drivers/acpi/resource.c - ACPI device resources interpretation. | |
3 | * | |
4 | * Copyright (C) 2012, Intel Corp. | |
5 | * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> | |
6 | * | |
7 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
8 | * | |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License version 2 as published | |
11 | * by the Free Software Foundation. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, but | |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | * General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License along | |
19 | * with this program; if not, write to the Free Software Foundation, Inc., | |
20 | * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. | |
21 | * | |
22 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
23 | */ | |
24 | ||
25 | #include <linux/acpi.h> | |
26 | #include <linux/device.h> | |
27 | #include <linux/export.h> | |
28 | #include <linux/ioport.h> | |
8e345c99 | 29 | #include <linux/slab.h> |
046d9ce6 RW |
30 | |
31 | #ifdef CONFIG_X86 | |
32 | #define valid_IRQ(i) (((i) != 0) && ((i) != 2)) | |
33 | #else | |
34 | #define valid_IRQ(i) (true) | |
35 | #endif | |
36 | ||
37 | static unsigned long acpi_dev_memresource_flags(u64 len, u8 write_protect, | |
38 | bool window) | |
39 | { | |
40 | unsigned long flags = IORESOURCE_MEM; | |
41 | ||
42 | if (len == 0) | |
43 | flags |= IORESOURCE_DISABLED; | |
44 | ||
45 | if (write_protect == ACPI_READ_WRITE_MEMORY) | |
46 | flags |= IORESOURCE_MEM_WRITEABLE; | |
47 | ||
48 | if (window) | |
49 | flags |= IORESOURCE_WINDOW; | |
50 | ||
51 | return flags; | |
52 | } | |
53 | ||
54 | static void acpi_dev_get_memresource(struct resource *res, u64 start, u64 len, | |
55 | u8 write_protect) | |
56 | { | |
57 | res->start = start; | |
58 | res->end = start + len - 1; | |
59 | res->flags = acpi_dev_memresource_flags(len, write_protect, false); | |
60 | } | |
61 | ||
62 | /** | |
63 | * acpi_dev_resource_memory - Extract ACPI memory resource information. | |
64 | * @ares: Input ACPI resource object. | |
65 | * @res: Output generic resource object. | |
66 | * | |
67 | * Check if the given ACPI resource object represents a memory resource and | |
68 | * if that's the case, use the information in it to populate the generic | |
69 | * resource object pointed to by @res. | |
70 | */ | |
71 | bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res) | |
72 | { | |
73 | struct acpi_resource_memory24 *memory24; | |
74 | struct acpi_resource_memory32 *memory32; | |
75 | struct acpi_resource_fixed_memory32 *fixed_memory32; | |
76 | ||
77 | switch (ares->type) { | |
78 | case ACPI_RESOURCE_TYPE_MEMORY24: | |
79 | memory24 = &ares->data.memory24; | |
867f9d46 | 80 | if (!memory24->minimum && !memory24->address_length) |
b355cee8 | 81 | return false; |
046d9ce6 RW |
82 | acpi_dev_get_memresource(res, memory24->minimum, |
83 | memory24->address_length, | |
84 | memory24->write_protect); | |
85 | break; | |
86 | case ACPI_RESOURCE_TYPE_MEMORY32: | |
87 | memory32 = &ares->data.memory32; | |
867f9d46 | 88 | if (!memory32->minimum && !memory32->address_length) |
b355cee8 | 89 | return false; |
046d9ce6 RW |
90 | acpi_dev_get_memresource(res, memory32->minimum, |
91 | memory32->address_length, | |
92 | memory32->write_protect); | |
93 | break; | |
94 | case ACPI_RESOURCE_TYPE_FIXED_MEMORY32: | |
95 | fixed_memory32 = &ares->data.fixed_memory32; | |
867f9d46 | 96 | if (!fixed_memory32->address && !fixed_memory32->address_length) |
b355cee8 | 97 | return false; |
046d9ce6 RW |
98 | acpi_dev_get_memresource(res, fixed_memory32->address, |
99 | fixed_memory32->address_length, | |
100 | fixed_memory32->write_protect); | |
101 | break; | |
102 | default: | |
103 | return false; | |
104 | } | |
105 | return true; | |
106 | } | |
107 | EXPORT_SYMBOL_GPL(acpi_dev_resource_memory); | |
108 | ||
109 | static unsigned int acpi_dev_ioresource_flags(u64 start, u64 end, u8 io_decode, | |
110 | bool window) | |
111 | { | |
112 | int flags = IORESOURCE_IO; | |
113 | ||
114 | if (io_decode == ACPI_DECODE_16) | |
115 | flags |= IORESOURCE_IO_16BIT_ADDR; | |
116 | ||
117 | if (start > end || end >= 0x10003) | |
118 | flags |= IORESOURCE_DISABLED; | |
119 | ||
120 | if (window) | |
121 | flags |= IORESOURCE_WINDOW; | |
122 | ||
123 | return flags; | |
124 | } | |
125 | ||
126 | static void acpi_dev_get_ioresource(struct resource *res, u64 start, u64 len, | |
127 | u8 io_decode) | |
128 | { | |
129 | u64 end = start + len - 1; | |
130 | ||
131 | res->start = start; | |
132 | res->end = end; | |
133 | res->flags = acpi_dev_ioresource_flags(start, end, io_decode, false); | |
134 | } | |
135 | ||
136 | /** | |
137 | * acpi_dev_resource_io - Extract ACPI I/O resource information. | |
138 | * @ares: Input ACPI resource object. | |
139 | * @res: Output generic resource object. | |
140 | * | |
141 | * Check if the given ACPI resource object represents an I/O resource and | |
142 | * if that's the case, use the information in it to populate the generic | |
143 | * resource object pointed to by @res. | |
144 | */ | |
145 | bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res) | |
146 | { | |
147 | struct acpi_resource_io *io; | |
148 | struct acpi_resource_fixed_io *fixed_io; | |
149 | ||
150 | switch (ares->type) { | |
151 | case ACPI_RESOURCE_TYPE_IO: | |
152 | io = &ares->data.io; | |
867f9d46 | 153 | if (!io->minimum && !io->address_length) |
b355cee8 | 154 | return false; |
046d9ce6 RW |
155 | acpi_dev_get_ioresource(res, io->minimum, |
156 | io->address_length, | |
157 | io->io_decode); | |
158 | break; | |
159 | case ACPI_RESOURCE_TYPE_FIXED_IO: | |
160 | fixed_io = &ares->data.fixed_io; | |
867f9d46 | 161 | if (!fixed_io->address && !fixed_io->address_length) |
b355cee8 | 162 | return false; |
046d9ce6 RW |
163 | acpi_dev_get_ioresource(res, fixed_io->address, |
164 | fixed_io->address_length, | |
165 | ACPI_DECODE_10); | |
166 | break; | |
167 | default: | |
168 | return false; | |
169 | } | |
170 | return true; | |
171 | } | |
172 | EXPORT_SYMBOL_GPL(acpi_dev_resource_io); | |
173 | ||
174 | /** | |
175 | * acpi_dev_resource_address_space - Extract ACPI address space information. | |
176 | * @ares: Input ACPI resource object. | |
177 | * @res: Output generic resource object. | |
178 | * | |
179 | * Check if the given ACPI resource object represents an address space resource | |
180 | * and if that's the case, use the information in it to populate the generic | |
181 | * resource object pointed to by @res. | |
182 | */ | |
183 | bool acpi_dev_resource_address_space(struct acpi_resource *ares, | |
184 | struct resource *res) | |
185 | { | |
186 | acpi_status status; | |
187 | struct acpi_resource_address64 addr; | |
188 | bool window; | |
189 | u64 len; | |
190 | u8 io_decode; | |
191 | ||
192 | switch (ares->type) { | |
193 | case ACPI_RESOURCE_TYPE_ADDRESS16: | |
194 | case ACPI_RESOURCE_TYPE_ADDRESS32: | |
195 | case ACPI_RESOURCE_TYPE_ADDRESS64: | |
196 | break; | |
197 | default: | |
198 | return false; | |
199 | } | |
200 | ||
201 | status = acpi_resource_to_address64(ares, &addr); | |
202 | if (ACPI_FAILURE(status)) | |
203 | return true; | |
204 | ||
205 | res->start = addr.minimum; | |
206 | res->end = addr.maximum; | |
207 | window = addr.producer_consumer == ACPI_PRODUCER; | |
208 | ||
209 | switch(addr.resource_type) { | |
210 | case ACPI_MEMORY_RANGE: | |
211 | len = addr.maximum - addr.minimum + 1; | |
212 | res->flags = acpi_dev_memresource_flags(len, | |
213 | addr.info.mem.write_protect, | |
214 | window); | |
215 | break; | |
216 | case ACPI_IO_RANGE: | |
217 | io_decode = addr.granularity == 0xfff ? | |
218 | ACPI_DECODE_10 : ACPI_DECODE_16; | |
219 | res->flags = acpi_dev_ioresource_flags(addr.minimum, | |
220 | addr.maximum, | |
221 | io_decode, window); | |
222 | break; | |
223 | case ACPI_BUS_NUMBER_RANGE: | |
224 | res->flags = IORESOURCE_BUS; | |
225 | break; | |
226 | default: | |
227 | res->flags = 0; | |
228 | } | |
229 | ||
230 | return true; | |
231 | } | |
232 | EXPORT_SYMBOL_GPL(acpi_dev_resource_address_space); | |
233 | ||
234 | /** | |
235 | * acpi_dev_resource_ext_address_space - Extract ACPI address space information. | |
236 | * @ares: Input ACPI resource object. | |
237 | * @res: Output generic resource object. | |
238 | * | |
239 | * Check if the given ACPI resource object represents an extended address space | |
240 | * resource and if that's the case, use the information in it to populate the | |
241 | * generic resource object pointed to by @res. | |
242 | */ | |
243 | bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares, | |
244 | struct resource *res) | |
245 | { | |
246 | struct acpi_resource_extended_address64 *ext_addr; | |
247 | bool window; | |
248 | u64 len; | |
249 | u8 io_decode; | |
250 | ||
251 | if (ares->type != ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64) | |
252 | return false; | |
253 | ||
254 | ext_addr = &ares->data.ext_address64; | |
255 | ||
256 | res->start = ext_addr->minimum; | |
257 | res->end = ext_addr->maximum; | |
258 | window = ext_addr->producer_consumer == ACPI_PRODUCER; | |
259 | ||
260 | switch(ext_addr->resource_type) { | |
261 | case ACPI_MEMORY_RANGE: | |
262 | len = ext_addr->maximum - ext_addr->minimum + 1; | |
263 | res->flags = acpi_dev_memresource_flags(len, | |
264 | ext_addr->info.mem.write_protect, | |
265 | window); | |
266 | break; | |
267 | case ACPI_IO_RANGE: | |
268 | io_decode = ext_addr->granularity == 0xfff ? | |
269 | ACPI_DECODE_10 : ACPI_DECODE_16; | |
270 | res->flags = acpi_dev_ioresource_flags(ext_addr->minimum, | |
271 | ext_addr->maximum, | |
272 | io_decode, window); | |
273 | break; | |
274 | case ACPI_BUS_NUMBER_RANGE: | |
275 | res->flags = IORESOURCE_BUS; | |
276 | break; | |
277 | default: | |
278 | res->flags = 0; | |
279 | } | |
280 | ||
281 | return true; | |
282 | } | |
283 | EXPORT_SYMBOL_GPL(acpi_dev_resource_ext_address_space); | |
284 | ||
285 | /** | |
286 | * acpi_dev_irq_flags - Determine IRQ resource flags. | |
287 | * @triggering: Triggering type as provided by ACPI. | |
288 | * @polarity: Interrupt polarity as provided by ACPI. | |
289 | * @shareable: Whether or not the interrupt is shareable. | |
290 | */ | |
291 | unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable) | |
292 | { | |
293 | unsigned long flags; | |
294 | ||
295 | if (triggering == ACPI_LEVEL_SENSITIVE) | |
296 | flags = polarity == ACPI_ACTIVE_LOW ? | |
297 | IORESOURCE_IRQ_LOWLEVEL : IORESOURCE_IRQ_HIGHLEVEL; | |
298 | else | |
299 | flags = polarity == ACPI_ACTIVE_LOW ? | |
300 | IORESOURCE_IRQ_LOWEDGE : IORESOURCE_IRQ_HIGHEDGE; | |
301 | ||
302 | if (shareable == ACPI_SHARED) | |
303 | flags |= IORESOURCE_IRQ_SHAREABLE; | |
304 | ||
305 | return flags | IORESOURCE_IRQ; | |
306 | } | |
307 | EXPORT_SYMBOL_GPL(acpi_dev_irq_flags); | |
308 | ||
309 | static void acpi_dev_irqresource_disabled(struct resource *res, u32 gsi) | |
310 | { | |
311 | res->start = gsi; | |
312 | res->end = gsi; | |
313 | res->flags = IORESOURCE_IRQ | IORESOURCE_DISABLED; | |
314 | } | |
315 | ||
316 | static void acpi_dev_get_irqresource(struct resource *res, u32 gsi, | |
204ebc0a MW |
317 | u8 triggering, u8 polarity, u8 shareable, |
318 | bool legacy) | |
046d9ce6 RW |
319 | { |
320 | int irq, p, t; | |
321 | ||
322 | if (!valid_IRQ(gsi)) { | |
323 | acpi_dev_irqresource_disabled(res, gsi); | |
324 | return; | |
325 | } | |
326 | ||
327 | /* | |
328 | * In IO-APIC mode, use overrided attribute. Two reasons: | |
329 | * 1. BIOS bug in DSDT | |
330 | * 2. BIOS uses IO-APIC mode Interrupt Source Override | |
204ebc0a MW |
331 | * |
332 | * We do this only if we are dealing with IRQ() or IRQNoFlags() | |
333 | * resource (the legacy ISA resources). With modern ACPI 5 devices | |
334 | * using extended IRQ descriptors we take the IRQ configuration | |
335 | * from _CRS directly. | |
046d9ce6 | 336 | */ |
204ebc0a | 337 | if (legacy && !acpi_get_override_irq(gsi, &t, &p)) { |
046d9ce6 RW |
338 | u8 trig = t ? ACPI_LEVEL_SENSITIVE : ACPI_EDGE_SENSITIVE; |
339 | u8 pol = p ? ACPI_ACTIVE_LOW : ACPI_ACTIVE_HIGH; | |
340 | ||
341 | if (triggering != trig || polarity != pol) { | |
342 | pr_warning("ACPI: IRQ %d override to %s, %s\n", gsi, | |
204ebc0a | 343 | t ? "level" : "edge", p ? "low" : "high"); |
046d9ce6 RW |
344 | triggering = trig; |
345 | polarity = pol; | |
346 | } | |
347 | } | |
348 | ||
349 | res->flags = acpi_dev_irq_flags(triggering, polarity, shareable); | |
350 | irq = acpi_register_gsi(NULL, gsi, triggering, polarity); | |
351 | if (irq >= 0) { | |
352 | res->start = irq; | |
353 | res->end = irq; | |
354 | } else { | |
355 | acpi_dev_irqresource_disabled(res, gsi); | |
356 | } | |
357 | } | |
358 | ||
359 | /** | |
360 | * acpi_dev_resource_interrupt - Extract ACPI interrupt resource information. | |
361 | * @ares: Input ACPI resource object. | |
362 | * @index: Index into the array of GSIs represented by the resource. | |
363 | * @res: Output generic resource object. | |
364 | * | |
365 | * Check if the given ACPI resource object represents an interrupt resource | |
366 | * and @index does not exceed the resource's interrupt count (true is returned | |
367 | * in that case regardless of the results of the other checks)). If that's the | |
368 | * case, register the GSI corresponding to @index from the array of interrupts | |
369 | * represented by the resource and populate the generic resource object pointed | |
370 | * to by @res accordingly. If the registration of the GSI is not successful, | |
371 | * IORESOURCE_DISABLED will be set it that object's flags. | |
372 | */ | |
373 | bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index, | |
374 | struct resource *res) | |
375 | { | |
376 | struct acpi_resource_irq *irq; | |
377 | struct acpi_resource_extended_irq *ext_irq; | |
378 | ||
379 | switch (ares->type) { | |
380 | case ACPI_RESOURCE_TYPE_IRQ: | |
381 | /* | |
382 | * Per spec, only one interrupt per descriptor is allowed in | |
383 | * _CRS, but some firmware violates this, so parse them all. | |
384 | */ | |
385 | irq = &ares->data.irq; | |
386 | if (index >= irq->interrupt_count) { | |
387 | acpi_dev_irqresource_disabled(res, 0); | |
388 | return false; | |
389 | } | |
390 | acpi_dev_get_irqresource(res, irq->interrupts[index], | |
391 | irq->triggering, irq->polarity, | |
204ebc0a | 392 | irq->sharable, true); |
046d9ce6 RW |
393 | break; |
394 | case ACPI_RESOURCE_TYPE_EXTENDED_IRQ: | |
395 | ext_irq = &ares->data.extended_irq; | |
396 | if (index >= ext_irq->interrupt_count) { | |
397 | acpi_dev_irqresource_disabled(res, 0); | |
398 | return false; | |
399 | } | |
400 | acpi_dev_get_irqresource(res, ext_irq->interrupts[index], | |
401 | ext_irq->triggering, ext_irq->polarity, | |
204ebc0a | 402 | ext_irq->sharable, false); |
046d9ce6 RW |
403 | break; |
404 | default: | |
405 | return false; | |
406 | } | |
407 | ||
408 | return true; | |
409 | } | |
410 | EXPORT_SYMBOL_GPL(acpi_dev_resource_interrupt); | |
8e345c99 RW |
411 | |
412 | /** | |
413 | * acpi_dev_free_resource_list - Free resource from %acpi_dev_get_resources(). | |
414 | * @list: The head of the resource list to free. | |
415 | */ | |
416 | void acpi_dev_free_resource_list(struct list_head *list) | |
417 | { | |
418 | struct resource_list_entry *rentry, *re; | |
419 | ||
420 | list_for_each_entry_safe(rentry, re, list, node) { | |
421 | list_del(&rentry->node); | |
422 | kfree(rentry); | |
423 | } | |
424 | } | |
425 | EXPORT_SYMBOL_GPL(acpi_dev_free_resource_list); | |
426 | ||
427 | struct res_proc_context { | |
428 | struct list_head *list; | |
429 | int (*preproc)(struct acpi_resource *, void *); | |
430 | void *preproc_data; | |
431 | int count; | |
432 | int error; | |
433 | }; | |
434 | ||
435 | static acpi_status acpi_dev_new_resource_entry(struct resource *r, | |
436 | struct res_proc_context *c) | |
437 | { | |
438 | struct resource_list_entry *rentry; | |
439 | ||
440 | rentry = kmalloc(sizeof(*rentry), GFP_KERNEL); | |
441 | if (!rentry) { | |
442 | c->error = -ENOMEM; | |
443 | return AE_NO_MEMORY; | |
444 | } | |
8e345c99 RW |
445 | rentry->res = *r; |
446 | list_add_tail(&rentry->node, c->list); | |
447 | c->count++; | |
448 | return AE_OK; | |
449 | } | |
450 | ||
451 | static acpi_status acpi_dev_process_resource(struct acpi_resource *ares, | |
452 | void *context) | |
453 | { | |
454 | struct res_proc_context *c = context; | |
455 | struct resource r; | |
456 | int i; | |
457 | ||
458 | if (c->preproc) { | |
459 | int ret; | |
460 | ||
461 | ret = c->preproc(ares, c->preproc_data); | |
462 | if (ret < 0) { | |
463 | c->error = ret; | |
8a66790b | 464 | return AE_CTRL_TERMINATE; |
8e345c99 RW |
465 | } else if (ret > 0) { |
466 | return AE_OK; | |
467 | } | |
468 | } | |
469 | ||
470 | memset(&r, 0, sizeof(r)); | |
471 | ||
472 | if (acpi_dev_resource_memory(ares, &r) | |
473 | || acpi_dev_resource_io(ares, &r) | |
474 | || acpi_dev_resource_address_space(ares, &r) | |
475 | || acpi_dev_resource_ext_address_space(ares, &r)) | |
476 | return acpi_dev_new_resource_entry(&r, c); | |
477 | ||
478 | for (i = 0; acpi_dev_resource_interrupt(ares, i, &r); i++) { | |
479 | acpi_status status; | |
480 | ||
481 | status = acpi_dev_new_resource_entry(&r, c); | |
482 | if (ACPI_FAILURE(status)) | |
483 | return status; | |
484 | } | |
485 | ||
486 | return AE_OK; | |
487 | } | |
488 | ||
489 | /** | |
490 | * acpi_dev_get_resources - Get current resources of a device. | |
491 | * @adev: ACPI device node to get the resources for. | |
492 | * @list: Head of the resultant list of resources (must be empty). | |
493 | * @preproc: The caller's preprocessing routine. | |
494 | * @preproc_data: Pointer passed to the caller's preprocessing routine. | |
495 | * | |
496 | * Evaluate the _CRS method for the given device node and process its output by | |
497 | * (1) executing the @preproc() rountine provided by the caller, passing the | |
498 | * resource pointer and @preproc_data to it as arguments, for each ACPI resource | |
499 | * returned and (2) converting all of the returned ACPI resources into struct | |
500 | * resource objects if possible. If the return value of @preproc() in step (1) | |
501 | * is different from 0, step (2) is not applied to the given ACPI resource and | |
502 | * if that value is negative, the whole processing is aborted and that value is | |
503 | * returned as the final error code. | |
504 | * | |
505 | * The resultant struct resource objects are put on the list pointed to by | |
506 | * @list, that must be empty initially, as members of struct resource_list_entry | |
507 | * objects. Callers of this routine should use %acpi_dev_free_resource_list() to | |
508 | * free that list. | |
509 | * | |
510 | * The number of resources in the output list is returned on success, an error | |
511 | * code reflecting the error condition is returned otherwise. | |
512 | */ | |
513 | int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list, | |
514 | int (*preproc)(struct acpi_resource *, void *), | |
515 | void *preproc_data) | |
516 | { | |
517 | struct res_proc_context c; | |
8e345c99 RW |
518 | acpi_status status; |
519 | ||
520 | if (!adev || !adev->handle || !list_empty(list)) | |
521 | return -EINVAL; | |
522 | ||
952c63e9 | 523 | if (!acpi_has_method(adev->handle, METHOD_NAME__CRS)) |
8e345c99 RW |
524 | return 0; |
525 | ||
526 | c.list = list; | |
527 | c.preproc = preproc; | |
528 | c.preproc_data = preproc_data; | |
529 | c.count = 0; | |
530 | c.error = 0; | |
531 | status = acpi_walk_resources(adev->handle, METHOD_NAME__CRS, | |
532 | acpi_dev_process_resource, &c); | |
533 | if (ACPI_FAILURE(status)) { | |
534 | acpi_dev_free_resource_list(list); | |
535 | return c.error ? c.error : -EIO; | |
536 | } | |
537 | ||
538 | return c.count; | |
539 | } | |
540 | EXPORT_SYMBOL_GPL(acpi_dev_get_resources); |