Merge branch 'enable-devices' into omap-for-v4.5/fixes
[deliverable/linux.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/*
c8100dc4 8 * Copyright (C) 2000 - 2016, 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 */
44f6c012 54/* Local prototypes */
bda663d3
RM
55static void acpi_rs_out_string(char *title, char *value);
56
57static void acpi_rs_out_integer8(char *title, u8 value);
58
59static void acpi_rs_out_integer16(char *title, u16 value);
60
61static void acpi_rs_out_integer32(char *title, u32 value);
62
63static void acpi_rs_out_integer64(char *title, u64 value);
64
65static void acpi_rs_out_title(char *title);
66
e0fe0a8d 67static void acpi_rs_dump_byte_list(u16 length, u8 *data);
bda663d3 68
e0fe0a8d 69static void acpi_rs_dump_word_list(u16 length, u16 *data);
bda663d3 70
e0fe0a8d
LM
71static void acpi_rs_dump_dword_list(u8 length, u32 *data);
72
73static void acpi_rs_dump_short_byte_list(u8 length, u8 *data);
bda663d3
RM
74
75static void
76acpi_rs_dump_resource_source(struct acpi_resource_source *resource_source);
77
78static void acpi_rs_dump_address_common(union acpi_resource_data *resource);
79
0897831b
BM
80static void
81acpi_rs_dump_descriptor(void *resource, struct acpi_rsdump_info *table);
82
39239fed
BM
83/*******************************************************************************
84 *
85 * FUNCTION: acpi_rs_dump_resource_list
86 *
87 * PARAMETERS: resource_list - Pointer to a resource descriptor list
88 *
89 * RETURN: None
90 *
91 * DESCRIPTION: Dispatches the structure to the correct dump routine.
92 *
93 ******************************************************************************/
94
95void acpi_rs_dump_resource_list(struct acpi_resource *resource_list)
96{
97 u32 count = 0;
98 u32 type;
99
100 ACPI_FUNCTION_ENTRY();
101
102 /* Check if debug output enabled */
103
104 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_RESOURCES, _COMPONENT)) {
105 return;
106 }
107
108 /* Walk list and dump all resource descriptors (END_TAG terminates) */
109
110 do {
111 acpi_os_printf("\n[%02X] ", count);
112 count++;
113
114 /* Validate Type before dispatch */
115
116 type = resource_list->type;
117 if (type > ACPI_RESOURCE_TYPE_MAX) {
118 acpi_os_printf
119 ("Invalid descriptor type (%X) in resource list\n",
120 resource_list->type);
121 return;
122 }
123
124 /* Sanity check the length. It must not be zero, or we loop forever */
125
126 if (!resource_list->length) {
127 acpi_os_printf
128 ("Invalid zero length descriptor in resource list\n");
129 return;
130 }
131
132 /* Dump the resource descriptor */
133
134 if (type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
135 acpi_rs_dump_descriptor(&resource_list->data,
136 acpi_gbl_dump_serial_bus_dispatch
137 [resource_list->data.
138 common_serial_bus.type]);
139 } else {
140 acpi_rs_dump_descriptor(&resource_list->data,
141 acpi_gbl_dump_resource_dispatch
142 [type]);
143 }
144
145 /* Point to the next resource structure */
146
147 resource_list = ACPI_NEXT_RESOURCE(resource_list);
148
149 /* Exit when END_TAG descriptor is reached */
150
151 } while (type != ACPI_RESOURCE_TYPE_END_TAG);
152}
153
154/*******************************************************************************
155 *
156 * FUNCTION: acpi_rs_dump_irq_list
157 *
158 * PARAMETERS: route_table - Pointer to the routing table to dump.
159 *
160 * RETURN: None
161 *
162 * DESCRIPTION: Print IRQ routing table
163 *
164 ******************************************************************************/
165
166void acpi_rs_dump_irq_list(u8 *route_table)
167{
168 struct acpi_pci_routing_table *prt_element;
169 u8 count;
170
171 ACPI_FUNCTION_ENTRY();
172
173 /* Check if debug output enabled */
174
175 if (!ACPI_IS_DEBUG_ENABLED(ACPI_LV_RESOURCES, _COMPONENT)) {
176 return;
177 }
178
179 prt_element = ACPI_CAST_PTR(struct acpi_pci_routing_table, route_table);
180
181 /* Dump all table elements, Exit on zero length element */
182
183 for (count = 0; prt_element->length; count++) {
184 acpi_os_printf("\n[%02X] PCI IRQ Routing Table Package\n",
185 count);
186 acpi_rs_dump_descriptor(prt_element, acpi_rs_dump_prt);
187
188 prt_element = ACPI_ADD_PTR(struct acpi_pci_routing_table,
189 prt_element, prt_element->length);
190 }
191}
192
bda663d3
RM
193/*******************************************************************************
194 *
0897831b 195 * FUNCTION: acpi_rs_dump_descriptor
bda663d3 196 *
42f8fb75
BM
197 * PARAMETERS: resource - Buffer containing the resource
198 * table - Table entry to decode the resource
bda663d3
RM
199 *
200 * RETURN: None
201 *
42f8fb75 202 * DESCRIPTION: Dump a resource descriptor based on a dump table entry.
bda663d3
RM
203 *
204 ******************************************************************************/
205
0897831b
BM
206static void
207acpi_rs_dump_descriptor(void *resource, struct acpi_rsdump_info *table)
bda663d3 208{
96db255c
BM
209 u8 *target = NULL;
210 u8 *previous_target;
0897831b
BM
211 char *name;
212 u8 count;
213
214 /* First table entry must contain the table length (# of table entries) */
215
216 count = table->offset;
217
218 while (count) {
219 previous_target = target;
c51a4de8 220 target = ACPI_ADD_PTR(u8, resource, table->offset);
0897831b
BM
221 name = table->name;
222
223 switch (table->opcode) {
224 case ACPI_RSD_TITLE:
225 /*
226 * Optional resource title
227 */
228 if (table->name) {
229 acpi_os_printf("%s Resource\n", name);
230 }
231 break;
bda663d3 232
0897831b 233 /* Strings */
bda663d3 234
0897831b 235 case ACPI_RSD_LITERAL:
1d1ea1b7 236
96db255c
BM
237 acpi_rs_out_string(name,
238 ACPI_CAST_PTR(char, table->pointer));
0897831b 239 break;
bda663d3 240
0897831b 241 case ACPI_RSD_STRING:
1d1ea1b7 242
96db255c 243 acpi_rs_out_string(name, ACPI_CAST_PTR(char, target));
0897831b 244 break;
bda663d3 245
0897831b 246 /* Data items, 8/16/32/64 bit */
bda663d3 247
0897831b 248 case ACPI_RSD_UINT8:
1d1ea1b7 249
e0fe0a8d
LM
250 if (table->pointer) {
251 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
252 table->
253 pointer
254 [*target]));
255 } else {
256 acpi_rs_out_integer8(name, ACPI_GET8(target));
257 }
0897831b 258 break;
bda663d3 259
0897831b 260 case ACPI_RSD_UINT16:
1d1ea1b7 261
c51a4de8 262 acpi_rs_out_integer16(name, ACPI_GET16(target));
0897831b
BM
263 break;
264
265 case ACPI_RSD_UINT32:
1d1ea1b7 266
c51a4de8 267 acpi_rs_out_integer32(name, ACPI_GET32(target));
0897831b 268 break;
50eca3eb 269
0897831b 270 case ACPI_RSD_UINT64:
1d1ea1b7 271
c51a4de8 272 acpi_rs_out_integer64(name, ACPI_GET64(target));
0897831b
BM
273 break;
274
275 /* Flags: 1-bit and 2-bit flags supported */
276
277 case ACPI_RSD_1BITFLAG:
1d1ea1b7 278
96db255c
BM
279 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
280 table->
281 pointer[*target &
282 0x01]));
0897831b
BM
283 break;
284
285 case ACPI_RSD_2BITFLAG:
1d1ea1b7 286
96db255c
BM
287 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
288 table->
289 pointer[*target &
290 0x03]));
0897831b
BM
291 break;
292
e0fe0a8d 293 case ACPI_RSD_3BITFLAG:
1d1ea1b7 294
e0fe0a8d
LM
295 acpi_rs_out_string(name, ACPI_CAST_PTR(char,
296 table->
297 pointer[*target &
298 0x07]));
299 break;
300
0897831b
BM
301 case ACPI_RSD_SHORTLIST:
302 /*
303 * Short byte list (single line output) for DMA and IRQ resources
304 * Note: The list length is obtained from the previous table entry
305 */
306 if (previous_target) {
307 acpi_rs_out_title(name);
96db255c
BM
308 acpi_rs_dump_short_byte_list(*previous_target,
309 target);
0897831b
BM
310 }
311 break;
312
e0fe0a8d
LM
313 case ACPI_RSD_SHORTLISTX:
314 /*
315 * Short byte list (single line output) for GPIO vendor data
316 * Note: The list length is obtained from the previous table entry
317 */
318 if (previous_target) {
319 acpi_rs_out_title(name);
320 acpi_rs_dump_short_byte_list(*previous_target,
321 *
322 (ACPI_CAST_INDIRECT_PTR
323 (u8, target)));
324 }
325 break;
326
0897831b
BM
327 case ACPI_RSD_LONGLIST:
328 /*
329 * Long byte list for Vendor resource data
330 * Note: The list length is obtained from the previous table entry
331 */
332 if (previous_target) {
c51a4de8
BM
333 acpi_rs_dump_byte_list(ACPI_GET16
334 (previous_target),
96db255c 335 target);
0897831b
BM
336 }
337 break;
338
339 case ACPI_RSD_DWORDLIST:
340 /*
341 * Dword list for Extended Interrupt resources
342 * Note: The list length is obtained from the previous table entry
343 */
344 if (previous_target) {
96db255c
BM
345 acpi_rs_dump_dword_list(*previous_target,
346 ACPI_CAST_PTR(u32,
347 target));
0897831b
BM
348 }
349 break;
350
e0fe0a8d
LM
351 case ACPI_RSD_WORDLIST:
352 /*
353 * Word list for GPIO Pin Table
354 * Note: The list length is obtained from the previous table entry
355 */
356 if (previous_target) {
357 acpi_rs_dump_word_list(*previous_target,
358 *(ACPI_CAST_INDIRECT_PTR
359 (u16, target)));
360 }
361 break;
362
0897831b
BM
363 case ACPI_RSD_ADDRESS:
364 /*
365 * Common flags for all Address resources
366 */
96db255c
BM
367 acpi_rs_dump_address_common(ACPI_CAST_PTR
368 (union acpi_resource_data,
369 target));
0897831b
BM
370 break;
371
372 case ACPI_RSD_SOURCE:
373 /*
374 * Optional resource_source for Address resources
375 */
3e8214e5
LZ
376 acpi_rs_dump_resource_source(ACPI_CAST_PTR
377 (struct
fd350943
LB
378 acpi_resource_source,
379 target));
0897831b
BM
380 break;
381
382 default:
1d1ea1b7 383
0897831b
BM
384 acpi_os_printf("**** Invalid table opcode [%X] ****\n",
385 table->opcode);
386 return;
387 }
388
389 table++;
390 count--;
391 }
50eca3eb
BM
392}
393
bda663d3
RM
394/*******************************************************************************
395 *
396 * FUNCTION: acpi_rs_dump_resource_source
1da177e4 397 *
bda663d3 398 * PARAMETERS: resource_source - Pointer to a Resource Source struct
1da177e4
LT
399 *
400 * RETURN: None
401 *
bda663d3
RM
402 * DESCRIPTION: Common routine for dumping the optional resource_source and the
403 * corresponding resource_source_index.
1da177e4
LT
404 *
405 ******************************************************************************/
406
bda663d3
RM
407static void
408acpi_rs_dump_resource_source(struct acpi_resource_source *resource_source)
1da177e4 409{
50eca3eb 410 ACPI_FUNCTION_ENTRY();
1da177e4 411
bda663d3
RM
412 if (resource_source->index == 0xFF) {
413 return;
414 }
415
0897831b 416 acpi_rs_out_integer8("Resource Source Index", resource_source->index);
bda663d3
RM
417
418 acpi_rs_out_string("Resource Source",
419 resource_source->string_ptr ?
420 resource_source->string_ptr : "[Not Specified]");
421}
422
423/*******************************************************************************
424 *
425 * FUNCTION: acpi_rs_dump_address_common
426 *
ba494bee 427 * PARAMETERS: resource - Pointer to an internal resource descriptor
bda663d3
RM
428 *
429 * RETURN: None
430 *
431 * DESCRIPTION: Dump the fields that are common to all Address resource
432 * descriptors
433 *
434 ******************************************************************************/
435
436static void acpi_rs_dump_address_common(union acpi_resource_data *resource)
437{
4be44fcd 438 ACPI_FUNCTION_ENTRY();
1da177e4 439
bda663d3
RM
440 /* Decode the type-specific flags */
441
442 switch (resource->address.resource_type) {
443 case ACPI_MEMORY_RANGE:
1da177e4 444
0897831b 445 acpi_rs_dump_descriptor(resource, acpi_rs_dump_memory_flags);
bda663d3
RM
446 break;
447
448 case ACPI_IO_RANGE:
449
0897831b 450 acpi_rs_dump_descriptor(resource, acpi_rs_dump_io_flags);
bda663d3
RM
451 break;
452
453 case ACPI_BUS_NUMBER_RANGE:
454
455 acpi_rs_out_string("Resource Type", "Bus Number Range");
456 break;
457
458 default:
459
460 acpi_rs_out_integer8("Resource Type",
461 (u8) resource->address.resource_type);
462 break;
1da177e4
LT
463 }
464
bda663d3
RM
465 /* Decode the general flags */
466
0897831b 467 acpi_rs_dump_descriptor(resource, acpi_rs_dump_general_flags);
1da177e4
LT
468}
469
1da177e4
LT
470/*******************************************************************************
471 *
0897831b 472 * FUNCTION: acpi_rs_out*
1da177e4 473 *
ba494bee
BM
474 * PARAMETERS: title - Name of the resource field
475 * value - Value of the resource field
1da177e4
LT
476 *
477 * RETURN: None
478 *
0897831b
BM
479 * DESCRIPTION: Miscellaneous helper functions to consistently format the
480 * output of the resource dump routines
1da177e4
LT
481 *
482 ******************************************************************************/
483
0897831b 484static void acpi_rs_out_string(char *title, char *value)
1da177e4 485{
1fad8738 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{
1fad8738 501
0897831b 502 acpi_os_printf("%27s : %4.4X\n", title, value);
1da177e4
LT
503}
504
0897831b 505static void acpi_rs_out_integer32(char *title, u32 value)
50eca3eb 506{
1fad8738 507
0897831b 508 acpi_os_printf("%27s : %8.8X\n", title, value);
50eca3eb
BM
509}
510
0897831b 511static void acpi_rs_out_integer64(char *title, u64 value)
1da177e4 512{
1fad8738 513
0897831b 514 acpi_os_printf("%27s : %8.8X%8.8X\n", title, ACPI_FORMAT_UINT64(value));
1da177e4
LT
515}
516
0897831b 517static void acpi_rs_out_title(char *title)
1da177e4 518{
1fad8738 519
0897831b 520 acpi_os_printf("%27s : ", title);
bda663d3 521}
1da177e4 522
bda663d3
RM
523/*******************************************************************************
524 *
0897831b 525 * FUNCTION: acpi_rs_dump*List
bda663d3 526 *
ba494bee
BM
527 * PARAMETERS: length - Number of elements in the list
528 * data - Start of the list
bda663d3
RM
529 *
530 * RETURN: None
531 *
0897831b 532 * DESCRIPTION: Miscellaneous functions to dump lists of raw data
bda663d3
RM
533 *
534 ******************************************************************************/
1da177e4 535
0897831b 536static void acpi_rs_dump_byte_list(u16 length, u8 * data)
bda663d3 537{
0897831b 538 u8 i;
1da177e4 539
0897831b
BM
540 for (i = 0; i < length; i++) {
541 acpi_os_printf("%25s%2.2X : %2.2X\n", "Byte", i, data[i]);
542 }
bda663d3 543}
1da177e4 544
0897831b 545static void acpi_rs_dump_short_byte_list(u8 length, u8 * data)
bda663d3 546{
0897831b 547 u8 i;
1da177e4 548
0897831b
BM
549 for (i = 0; i < length; i++) {
550 acpi_os_printf("%X ", data[i]);
551 }
1fad8738 552
0897831b 553 acpi_os_printf("\n");
1da177e4
LT
554}
555
0897831b 556static void acpi_rs_dump_dword_list(u8 length, u32 * data)
1da177e4 557{
0897831b 558 u8 i;
1da177e4 559
0897831b
BM
560 for (i = 0; i < length; i++) {
561 acpi_os_printf("%25s%2.2X : %8.8X\n", "Dword", i, data[i]);
1da177e4 562 }
1da177e4
LT
563}
564
e0fe0a8d
LM
565static void acpi_rs_dump_word_list(u16 length, u16 *data)
566{
567 u16 i;
568
569 for (i = 0; i < length; i++) {
570 acpi_os_printf("%25s%2.2X : %4.4X\n", "Word", i, data[i]);
571 }
572}
This page took 1.164538 seconds and 5 git commands to generate.