]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/acpi/acpica/rsdump.c
ACPICA: Update Resource descriptor dump module.
[mirror_ubuntu-artful-kernel.git] / drivers / acpi / acpica / rsdump.c
CommitLineData
1da177e4
LT
1/*******************************************************************************
2 *
39239fed 3 * Module Name: rsdump - AML debugger support for resource structures.
1da177e4
LT
4 *
5 ******************************************************************************/
6
7/*
82a80941 8 * Copyright (C) 2000 - 2015, Intel Corp.
1da177e4
LT
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
1da177e4 44#include <acpi/acpi.h>
e2f7a777
LB
45#include "accommon.h"
46#include "acresrc.h"
1da177e4
LT
47
48#define _COMPONENT ACPI_RESOURCES
4be44fcd 49ACPI_MODULE_NAME("rsdump")
3334861b 50
39239fed
BM
51/*
52 * All functions in this module are used by the AML Debugger only
53 */
54#if defined(ACPI_DEBUGGER)
44f6c012 55/* Local prototypes */
bda663d3
RM
56static void acpi_rs_out_string(char *title, char *value);
57
58static void acpi_rs_out_integer8(char *title, u8 value);
59
60static void acpi_rs_out_integer16(char *title, u16 value);
61
62static void acpi_rs_out_integer32(char *title, u32 value);
63
64static void acpi_rs_out_integer64(char *title, u64 value);
65
66static void acpi_rs_out_title(char *title);
67
e0fe0a8d 68static void acpi_rs_dump_byte_list(u16 length, u8 *data);
bda663d3 69
e0fe0a8d 70static void acpi_rs_dump_word_list(u16 length, u16 *data);
bda663d3 71
e0fe0a8d
LM
72static void acpi_rs_dump_dword_list(u8 length, u32 *data);
73
74static void acpi_rs_dump_short_byte_list(u8 length, u8 *data);
bda663d3
RM
75
76static void
77acpi_rs_dump_resource_source(struct acpi_resource_source *resource_source);
78
79static void acpi_rs_dump_address_common(union acpi_resource_data *resource);
80
0897831b
BM
81static void
82acpi_rs_dump_descriptor(void *resource, struct acpi_rsdump_info *table);
83
39239fed
BM
84/*******************************************************************************
85 *
86 * FUNCTION: acpi_rs_dump_resource_list
87 *
88 * PARAMETERS: resource_list - Pointer to a resource descriptor list
89 *
90 * RETURN: None
91 *
92 * DESCRIPTION: Dispatches the structure to the correct dump routine.
93 *
94 ******************************************************************************/
95
96void acpi_rs_dump_resource_list(struct acpi_resource *resource_list)
97{
98 u32 count = 0;
99 u32 type;
100
101 ACPI_FUNCTION_ENTRY();
102
103 /* Check if debug output enabled */
104
105 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_RESOURCES, _COMPONENT)) {
106 return;
107 }
108
109 /* Walk list and dump all resource descriptors (END_TAG terminates) */
110
111 do {
112 acpi_os_printf("\n[%02X] ", count);
113 count++;
114
115 /* Validate Type before dispatch */
116
117 type = resource_list->type;
118 if (type > ACPI_RESOURCE_TYPE_MAX) {
119 acpi_os_printf
120 ("Invalid descriptor type (%X) in resource list\n",
121 resource_list->type);
122 return;
123 }
124
125 /* Sanity check the length. It must not be zero, or we loop forever */
126
127 if (!resource_list->length) {
128 acpi_os_printf
129 ("Invalid zero length descriptor in resource list\n");
130 return;
131 }
132
133 /* Dump the resource descriptor */
134
135 if (type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
136 acpi_rs_dump_descriptor(&resource_list->data,
137 acpi_gbl_dump_serial_bus_dispatch
138 [resource_list->data.
139 common_serial_bus.type]);
140 } else {
141 acpi_rs_dump_descriptor(&resource_list->data,
142 acpi_gbl_dump_resource_dispatch
143 [type]);
144 }
145
146 /* Point to the next resource structure */
147
148 resource_list = ACPI_NEXT_RESOURCE(resource_list);
149
150 /* Exit when END_TAG descriptor is reached */
151
152 } while (type != ACPI_RESOURCE_TYPE_END_TAG);
153}
154
155/*******************************************************************************
156 *
157 * FUNCTION: acpi_rs_dump_irq_list
158 *
159 * PARAMETERS: route_table - Pointer to the routing table to dump.
160 *
161 * RETURN: None
162 *
163 * DESCRIPTION: Print IRQ routing table
164 *
165 ******************************************************************************/
166
167void acpi_rs_dump_irq_list(u8 *route_table)
168{
169 struct acpi_pci_routing_table *prt_element;
170 u8 count;
171
172 ACPI_FUNCTION_ENTRY();
173
174 /* Check if debug output enabled */
175
176 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_RESOURCES, _COMPONENT)) {
177 return;
178 }
179
180 prt_element = ACPI_CAST_PTR(struct acpi_pci_routing_table, route_table);
181
182 /* Dump all table elements, Exit on zero length element */
183
184 for (count = 0; prt_element->length; count++) {
185 acpi_os_printf("\n[%02X] PCI IRQ Routing Table Package\n",
186 count);
187 acpi_rs_dump_descriptor(prt_element, acpi_rs_dump_prt);
188
189 prt_element = ACPI_ADD_PTR(struct acpi_pci_routing_table,
190 prt_element, prt_element->length);
191 }
192}
193
bda663d3
RM
194/*******************************************************************************
195 *
0897831b 196 * FUNCTION: acpi_rs_dump_descriptor
bda663d3 197 *
42f8fb75
BM
198 * PARAMETERS: resource - Buffer containing the resource
199 * table - Table entry to decode the resource
bda663d3
RM
200 *
201 * RETURN: None
202 *
42f8fb75 203 * DESCRIPTION: Dump a resource descriptor based on a dump table entry.
bda663d3
RM
204 *
205 ******************************************************************************/
206
0897831b
BM
207static void
208acpi_rs_dump_descriptor(void *resource, struct acpi_rsdump_info *table)
bda663d3 209{
96db255c
BM
210 u8 *target = NULL;
211 u8 *previous_target;
0897831b
BM
212 char *name;
213 u8 count;
214
215 /* First table entry must contain the table length (# of table entries) */
216
217 count = table->offset;
218
219 while (count) {
220 previous_target = target;
c51a4de8 221 target = ACPI_ADD_PTR(u8, resource, table->offset);
0897831b
BM
222 name = table->name;
223
224 switch (table->opcode) {
225 case ACPI_RSD_TITLE:
226 /*
227 * Optional resource title
228 */
229 if (table->name) {
230 acpi_os_printf("%s Resource\n", name);
231 }
232 break;
bda663d3 233
0897831b 234 /* Strings */
bda663d3 235
0897831b 236 case ACPI_RSD_LITERAL:
1d1ea1b7 237
96db255c
BM
238 acpi_rs_out_string(name,
239 ACPI_CAST_PTR(char, table->pointer));
0897831b 240 break;
bda663d3 241
0897831b 242 case ACPI_RSD_STRING:
1d1ea1b7 243
96db255c 244 acpi_rs_out_string(name, ACPI_CAST_PTR(char, target));
0897831b 245 break;
bda663d3 246
0897831b 247 /* Data items, 8/16/32/64 bit */
bda663d3 248
0897831b 249 case ACPI_RSD_UINT8:
1d1ea1b7 250
e0fe0a8d
LM
251 if (table->pointer) {
252 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
253 table->
254 pointer
255 [*target]));
256 } else {
257 acpi_rs_out_integer8(name, ACPI_GET8(target));
258 }
0897831b 259 break;
bda663d3 260
0897831b 261 case ACPI_RSD_UINT16:
1d1ea1b7 262
c51a4de8 263 acpi_rs_out_integer16(name, ACPI_GET16(target));
0897831b
BM
264 break;
265
266 case ACPI_RSD_UINT32:
1d1ea1b7 267
c51a4de8 268 acpi_rs_out_integer32(name, ACPI_GET32(target));
0897831b 269 break;
50eca3eb 270
0897831b 271 case ACPI_RSD_UINT64:
1d1ea1b7 272
c51a4de8 273 acpi_rs_out_integer64(name, ACPI_GET64(target));
0897831b
BM
274 break;
275
276 /* Flags: 1-bit and 2-bit flags supported */
277
278 case ACPI_RSD_1BITFLAG:
1d1ea1b7 279
96db255c
BM
280 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
281 table->
282 pointer[*target &
283 0x01]));
0897831b
BM
284 break;
285
286 case ACPI_RSD_2BITFLAG:
1d1ea1b7 287
96db255c
BM
288 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
289 table->
290 pointer[*target &
291 0x03]));
0897831b
BM
292 break;
293
e0fe0a8d 294 case ACPI_RSD_3BITFLAG:
1d1ea1b7 295
e0fe0a8d
LM
296 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
297 table->
298 pointer[*target &
299 0x07]));
300 break;
301
0897831b
BM
302 case ACPI_RSD_SHORTLIST:
303 /*
304 * Short byte list (single line output) for DMA and IRQ resources
305 * Note: The list length is obtained from the previous table entry
306 */
307 if (previous_target) {
308 acpi_rs_out_title(name);
96db255c
BM
309 acpi_rs_dump_short_byte_list(*previous_target,
310 target);
0897831b
BM
311 }
312 break;
313
e0fe0a8d
LM
314 case ACPI_RSD_SHORTLISTX:
315 /*
316 * Short byte list (single line output) for GPIO vendor data
317 * Note: The list length is obtained from the previous table entry
318 */
319 if (previous_target) {
320 acpi_rs_out_title(name);
321 acpi_rs_dump_short_byte_list(*previous_target,
322 *
323 (ACPI_CAST_INDIRECT_PTR
324 (u8, target)));
325 }
326 break;
327
0897831b
BM
328 case ACPI_RSD_LONGLIST:
329 /*
330 * Long byte list for Vendor resource data
331 * Note: The list length is obtained from the previous table entry
332 */
333 if (previous_target) {
c51a4de8
BM
334 acpi_rs_dump_byte_list(ACPI_GET16
335 (previous_target),
96db255c 336 target);
0897831b
BM
337 }
338 break;
339
340 case ACPI_RSD_DWORDLIST:
341 /*
342 * Dword list for Extended Interrupt resources
343 * Note: The list length is obtained from the previous table entry
344 */
345 if (previous_target) {
96db255c
BM
346 acpi_rs_dump_dword_list(*previous_target,
347 ACPI_CAST_PTR(u32,
348 target));
0897831b
BM
349 }
350 break;
351
e0fe0a8d
LM
352 case ACPI_RSD_WORDLIST:
353 /*
354 * Word list for GPIO Pin Table
355 * Note: The list length is obtained from the previous table entry
356 */
357 if (previous_target) {
358 acpi_rs_dump_word_list(*previous_target,
359 *(ACPI_CAST_INDIRECT_PTR
360 (u16, target)));
361 }
362 break;
363
0897831b
BM
364 case ACPI_RSD_ADDRESS:
365 /*
366 * Common flags for all Address resources
367 */
96db255c
BM
368 acpi_rs_dump_address_common(ACPI_CAST_PTR
369 (union acpi_resource_data,
370 target));
0897831b
BM
371 break;
372
373 case ACPI_RSD_SOURCE:
374 /*
375 * Optional resource_source for Address resources
376 */
3e8214e5
LZ
377 acpi_rs_dump_resource_source(ACPI_CAST_PTR
378 (struct
fd350943
LB
379 acpi_resource_source,
380 target));
0897831b
BM
381 break;
382
383 default:
1d1ea1b7 384
0897831b
BM
385 acpi_os_printf("**** Invalid table opcode [%X] ****\n",
386 table->opcode);
387 return;
388 }
389
390 table++;
391 count--;
392 }
50eca3eb
BM
393}
394
bda663d3
RM
395/*******************************************************************************
396 *
397 * FUNCTION: acpi_rs_dump_resource_source
1da177e4 398 *
bda663d3 399 * PARAMETERS: resource_source - Pointer to a Resource Source struct
1da177e4
LT
400 *
401 * RETURN: None
402 *
bda663d3
RM
403 * DESCRIPTION: Common routine for dumping the optional resource_source and the
404 * corresponding resource_source_index.
1da177e4
LT
405 *
406 ******************************************************************************/
407
bda663d3
RM
408static void
409acpi_rs_dump_resource_source(struct acpi_resource_source *resource_source)
1da177e4 410{
50eca3eb 411 ACPI_FUNCTION_ENTRY();
1da177e4 412
bda663d3
RM
413 if (resource_source->index == 0xFF) {
414 return;
415 }
416
0897831b 417 acpi_rs_out_integer8("Resource Source Index", resource_source->index);
bda663d3
RM
418
419 acpi_rs_out_string("Resource Source",
420 resource_source->string_ptr ?
421 resource_source->string_ptr : "[Not Specified]");
422}
423
424/*******************************************************************************
425 *
426 * FUNCTION: acpi_rs_dump_address_common
427 *
ba494bee 428 * PARAMETERS: resource - Pointer to an internal resource descriptor
bda663d3
RM
429 *
430 * RETURN: None
431 *
432 * DESCRIPTION: Dump the fields that are common to all Address resource
433 * descriptors
434 *
435 ******************************************************************************/
436
437static void acpi_rs_dump_address_common(union acpi_resource_data *resource)
438{
4be44fcd 439 ACPI_FUNCTION_ENTRY();
1da177e4 440
bda663d3
RM
441 /* Decode the type-specific flags */
442
443 switch (resource->address.resource_type) {
444 case ACPI_MEMORY_RANGE:
1da177e4 445
0897831b 446 acpi_rs_dump_descriptor(resource, acpi_rs_dump_memory_flags);
bda663d3
RM
447 break;
448
449 case ACPI_IO_RANGE:
450
0897831b 451 acpi_rs_dump_descriptor(resource, acpi_rs_dump_io_flags);
bda663d3
RM
452 break;
453
454 case ACPI_BUS_NUMBER_RANGE:
455
456 acpi_rs_out_string("Resource Type", "Bus Number Range");
457 break;
458
459 default:
460
461 acpi_rs_out_integer8("Resource Type",
462 (u8) resource->address.resource_type);
463 break;
1da177e4
LT
464 }
465
bda663d3
RM
466 /* Decode the general flags */
467
0897831b 468 acpi_rs_dump_descriptor(resource, acpi_rs_dump_general_flags);
1da177e4
LT
469}
470
1da177e4
LT
471/*******************************************************************************
472 *
0897831b 473 * FUNCTION: acpi_rs_out*
1da177e4 474 *
ba494bee
BM
475 * PARAMETERS: title - Name of the resource field
476 * value - Value of the resource field
1da177e4
LT
477 *
478 * RETURN: None
479 *
0897831b
BM
480 * DESCRIPTION: Miscellaneous helper functions to consistently format the
481 * output of the resource dump routines
1da177e4
LT
482 *
483 ******************************************************************************/
484
0897831b 485static void acpi_rs_out_string(char *title, char *value)
1da177e4 486{
b8e4d893
BM
487 acpi_os_printf("%27s : %s", title, value);
488 if (!*value) {
489 acpi_os_printf("[NULL NAMESTRING]");
490 }
491 acpi_os_printf("\n");
1da177e4
LT
492}
493
0897831b 494static void acpi_rs_out_integer8(char *title, u8 value)
1da177e4 495{
0897831b 496 acpi_os_printf("%27s : %2.2X\n", title, value);
1da177e4
LT
497}
498
0897831b 499static void acpi_rs_out_integer16(char *title, u16 value)
1da177e4 500{
0897831b 501 acpi_os_printf("%27s : %4.4X\n", title, value);
1da177e4
LT
502}
503
0897831b 504static void acpi_rs_out_integer32(char *title, u32 value)
50eca3eb 505{
0897831b 506 acpi_os_printf("%27s : %8.8X\n", title, value);
50eca3eb
BM
507}
508
0897831b 509static void acpi_rs_out_integer64(char *title, u64 value)
1da177e4 510{
0897831b 511 acpi_os_printf("%27s : %8.8X%8.8X\n", title, ACPI_FORMAT_UINT64(value));
1da177e4
LT
512}
513
0897831b 514static void acpi_rs_out_title(char *title)
1da177e4 515{
0897831b 516 acpi_os_printf("%27s : ", title);
bda663d3 517}
1da177e4 518
bda663d3
RM
519/*******************************************************************************
520 *
0897831b 521 * FUNCTION: acpi_rs_dump*List
bda663d3 522 *
ba494bee
BM
523 * PARAMETERS: length - Number of elements in the list
524 * data - Start of the list
bda663d3
RM
525 *
526 * RETURN: None
527 *
0897831b 528 * DESCRIPTION: Miscellaneous functions to dump lists of raw data
bda663d3
RM
529 *
530 ******************************************************************************/
1da177e4 531
0897831b 532static void acpi_rs_dump_byte_list(u16 length, u8 * data)
bda663d3 533{
0897831b 534 u8 i;
1da177e4 535
0897831b
BM
536 for (i = 0; i < length; i++) {
537 acpi_os_printf("%25s%2.2X : %2.2X\n", "Byte", i, data[i]);
538 }
bda663d3 539}
1da177e4 540
0897831b 541static void acpi_rs_dump_short_byte_list(u8 length, u8 * data)
bda663d3 542{
0897831b 543 u8 i;
1da177e4 544
0897831b
BM
545 for (i = 0; i < length; i++) {
546 acpi_os_printf("%X ", data[i]);
547 }
548 acpi_os_printf("\n");
1da177e4
LT
549}
550
0897831b 551static void acpi_rs_dump_dword_list(u8 length, u32 * data)
1da177e4 552{
0897831b 553 u8 i;
1da177e4 554
0897831b
BM
555 for (i = 0; i < length; i++) {
556 acpi_os_printf("%25s%2.2X : %8.8X\n", "Dword", i, data[i]);
1da177e4 557 }
1da177e4
LT
558}
559
e0fe0a8d
LM
560static void acpi_rs_dump_word_list(u16 length, u16 *data)
561{
562 u16 i;
563
564 for (i = 0; i < length; i++) {
565 acpi_os_printf("%25s%2.2X : %4.4X\n", "Word", i, data[i]);
566 }
567}
568
1da177e4 569#endif