1 /*******************************************************************************
3 * Module Name: utresrc - Resource management utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2017, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
48 #define _COMPONENT ACPI_UTILITIES
49 ACPI_MODULE_NAME("utresrc")
51 #if defined(ACPI_DEBUG_OUTPUT) || defined (ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
53 * Strings used to decode resource descriptors.
54 * Used by both the disassembler and the debugger resource dump routines
56 const char *acpi_gbl_bm_decode[] = {
61 const char *acpi_gbl_config_decode[] = {
62 "0 - Good Configuration",
63 "1 - Acceptable Configuration",
64 "2 - Suboptimal Configuration",
65 "3 - ***Invalid Configuration***",
68 const char *acpi_gbl_consume_decode[] = {
73 const char *acpi_gbl_dec_decode[] = {
78 const char *acpi_gbl_he_decode[] = {
83 const char *acpi_gbl_io_decode[] = {
88 const char *acpi_gbl_ll_decode[] = {
95 const char *acpi_gbl_max_decode[] = {
100 const char *acpi_gbl_mem_decode[] = {
107 const char *acpi_gbl_min_decode[] = {
112 const char *acpi_gbl_mtp_decode[] = {
113 "AddressRangeMemory",
114 "AddressRangeReserved",
119 const char *acpi_gbl_rng_decode[] = {
126 const char *acpi_gbl_rw_decode[] = {
131 const char *acpi_gbl_shr_decode[] = {
134 "ExclusiveAndWake", /* ACPI 5.0 */
135 "SharedAndWake" /* ACPI 5.0 */
138 const char *acpi_gbl_siz_decode[] = {
145 const char *acpi_gbl_trs_decode[] = {
150 const char *acpi_gbl_ttp_decode[] = {
155 const char *acpi_gbl_typ_decode[] = {
162 const char *acpi_gbl_ppc_decode[] = {
169 const char *acpi_gbl_ior_decode[] = {
171 "IoRestrictionInputOnly",
172 "IoRestrictionOutputOnly",
173 "IoRestrictionNoneAndPreserve"
176 const char *acpi_gbl_dts_decode[] = {
185 /* GPIO connection type */
187 const char *acpi_gbl_ct_decode[] = {
192 /* Serial bus type */
194 const char *acpi_gbl_sbt_decode[] = {
195 "/* UNKNOWN serial bus type */",
201 /* I2C serial bus access mode */
203 const char *acpi_gbl_am_decode[] = {
204 "AddressingMode7Bit",
205 "AddressingMode10Bit"
208 /* I2C serial bus slave mode */
210 const char *acpi_gbl_sm_decode[] = {
211 "ControllerInitiated",
215 /* SPI serial bus wire mode */
217 const char *acpi_gbl_wm_decode[] = {
222 /* SPI serial clock phase */
224 const char *acpi_gbl_cph_decode[] = {
229 /* SPI serial bus clock polarity */
231 const char *acpi_gbl_cpo_decode[] = {
236 /* SPI serial bus device polarity */
238 const char *acpi_gbl_dp_decode[] = {
243 /* UART serial bus endian */
245 const char *acpi_gbl_ed_decode[] = {
250 /* UART serial bus bits per byte */
252 const char *acpi_gbl_bpb_decode[] = {
258 "/* UNKNOWN Bits per byte */",
259 "/* UNKNOWN Bits per byte */",
260 "/* UNKNOWN Bits per byte */"
263 /* UART serial bus stop bits */
265 const char *acpi_gbl_sb_decode[] = {
268 "StopBitsOnePlusHalf",
272 /* UART serial bus flow control */
274 const char *acpi_gbl_fc_decode[] = {
276 "FlowControlHardware",
278 "/* UNKNOWN flow control keyword */"
281 /* UART serial bus parity type */
283 const char *acpi_gbl_pt_decode[] = {
289 "/* UNKNOWN parity keyword */",
290 "/* UNKNOWN parity keyword */",
291 "/* UNKNOWN parity keyword */"
297 * Base sizes of the raw AML resource descriptors, indexed by resource type.
298 * Zero indicates a reserved (and therefore invalid) resource type.
300 const u8 acpi_gbl_resource_aml_sizes[] = {
301 /* Small descriptors */
307 ACPI_AML_SIZE_SMALL(struct aml_resource_irq),
308 ACPI_AML_SIZE_SMALL(struct aml_resource_dma),
309 ACPI_AML_SIZE_SMALL(struct aml_resource_start_dependent),
310 ACPI_AML_SIZE_SMALL(struct aml_resource_end_dependent),
311 ACPI_AML_SIZE_SMALL(struct aml_resource_io),
312 ACPI_AML_SIZE_SMALL(struct aml_resource_fixed_io),
313 ACPI_AML_SIZE_SMALL(struct aml_resource_fixed_dma),
317 ACPI_AML_SIZE_SMALL(struct aml_resource_vendor_small),
318 ACPI_AML_SIZE_SMALL(struct aml_resource_end_tag),
320 /* Large descriptors */
323 ACPI_AML_SIZE_LARGE(struct aml_resource_memory24),
324 ACPI_AML_SIZE_LARGE(struct aml_resource_generic_register),
326 ACPI_AML_SIZE_LARGE(struct aml_resource_vendor_large),
327 ACPI_AML_SIZE_LARGE(struct aml_resource_memory32),
328 ACPI_AML_SIZE_LARGE(struct aml_resource_fixed_memory32),
329 ACPI_AML_SIZE_LARGE(struct aml_resource_address32),
330 ACPI_AML_SIZE_LARGE(struct aml_resource_address16),
331 ACPI_AML_SIZE_LARGE(struct aml_resource_extended_irq),
332 ACPI_AML_SIZE_LARGE(struct aml_resource_address64),
333 ACPI_AML_SIZE_LARGE(struct aml_resource_extended_address64),
334 ACPI_AML_SIZE_LARGE(struct aml_resource_gpio),
336 ACPI_AML_SIZE_LARGE(struct aml_resource_common_serialbus),
339 const u8 acpi_gbl_resource_aml_serial_bus_sizes[] = {
341 ACPI_AML_SIZE_LARGE(struct aml_resource_i2c_serialbus),
342 ACPI_AML_SIZE_LARGE(struct aml_resource_spi_serialbus),
343 ACPI_AML_SIZE_LARGE(struct aml_resource_uart_serialbus),
347 * Resource types, used to validate the resource length field.
348 * The length of fixed-length types must match exactly, variable
349 * lengths must meet the minimum required length, etc.
350 * Zero indicates a reserved (and therefore invalid) resource type.
352 static const u8 acpi_gbl_resource_types[] = {
353 /* Small descriptors */
359 ACPI_SMALL_VARIABLE_LENGTH, /* 04 IRQ */
360 ACPI_FIXED_LENGTH, /* 05 DMA */
361 ACPI_SMALL_VARIABLE_LENGTH, /* 06 start_dependent_functions */
362 ACPI_FIXED_LENGTH, /* 07 end_dependent_functions */
363 ACPI_FIXED_LENGTH, /* 08 IO */
364 ACPI_FIXED_LENGTH, /* 09 fixed_IO */
365 ACPI_FIXED_LENGTH, /* 0A fixed_DMA */
369 ACPI_VARIABLE_LENGTH, /* 0E vendor_short */
370 ACPI_FIXED_LENGTH, /* 0F end_tag */
372 /* Large descriptors */
375 ACPI_FIXED_LENGTH, /* 01 Memory24 */
376 ACPI_FIXED_LENGTH, /* 02 generic_register */
378 ACPI_VARIABLE_LENGTH, /* 04 vendor_long */
379 ACPI_FIXED_LENGTH, /* 05 Memory32 */
380 ACPI_FIXED_LENGTH, /* 06 memory32_fixed */
381 ACPI_VARIABLE_LENGTH, /* 07 Dword* address */
382 ACPI_VARIABLE_LENGTH, /* 08 Word* address */
383 ACPI_VARIABLE_LENGTH, /* 09 extended_IRQ */
384 ACPI_VARIABLE_LENGTH, /* 0A Qword* address */
385 ACPI_FIXED_LENGTH, /* 0B Extended* address */
386 ACPI_VARIABLE_LENGTH, /* 0C Gpio* */
388 ACPI_VARIABLE_LENGTH /* 0E *serial_bus */
391 /*******************************************************************************
393 * FUNCTION: acpi_ut_walk_aml_resources
395 * PARAMETERS: walk_state - Current walk info
396 * PARAMETERS: aml - Pointer to the raw AML resource template
397 * aml_length - Length of the entire template
398 * user_function - Called once for each descriptor found. If
399 * NULL, a pointer to the end_tag is returned
400 * context - Passed to user_function
404 * DESCRIPTION: Walk a raw AML resource list(buffer). User function called
405 * once for each resource found.
407 ******************************************************************************/
410 acpi_ut_walk_aml_resources(struct acpi_walk_state *walk_state,
412 acpi_size aml_length,
413 acpi_walk_aml_callback user_function, void **context)
420 u8 end_tag[2] = { 0x79, 0x00 };
422 ACPI_FUNCTION_TRACE(ut_walk_aml_resources);
425 * The absolute minimum resource template is one end_tag descriptor.
426 * However, we will treat a lone end_tag as just a simple buffer.
428 if (aml_length < sizeof(struct aml_resource_end_tag)) {
429 return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG);
432 /* Point to the end of the resource template buffer */
434 end_aml = aml + aml_length;
436 /* Walk the byte list, abort on any invalid descriptor type or length */
438 while (aml < end_aml) {
440 /* Validate the Resource Type and Resource Length */
443 acpi_ut_validate_resource(walk_state, aml, &resource_index);
444 if (ACPI_FAILURE(status)) {
446 * Exit on failure. Cannot continue because the descriptor
447 * length may be bogus also.
449 return_ACPI_STATUS(status);
452 /* Get the length of this descriptor */
454 length = acpi_ut_get_descriptor_length(aml);
456 /* Invoke the user function */
459 status = user_function(aml, length, offset,
460 resource_index, context);
461 if (ACPI_FAILURE(status)) {
462 return_ACPI_STATUS(status);
466 /* An end_tag descriptor terminates this resource template */
468 if (acpi_ut_get_resource_type(aml) ==
469 ACPI_RESOURCE_NAME_END_TAG) {
471 * There must be at least one more byte in the buffer for
472 * the 2nd byte of the end_tag
474 if ((aml + 1) >= end_aml) {
475 return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG);
478 /* Return the pointer to the end_tag if requested */
480 if (!user_function) {
484 /* Check if buffer is defined to be longer than the resource length */
486 if (aml_length > (offset + length)) {
487 return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG);
492 return_ACPI_STATUS(AE_OK);
499 /* Did not find an end_tag descriptor */
503 /* Insert an end_tag anyway. acpi_rs_get_list_length always leaves room */
505 (void)acpi_ut_validate_resource(walk_state, end_tag,
508 user_function(end_tag, 2, offset, resource_index, context);
509 if (ACPI_FAILURE(status)) {
510 return_ACPI_STATUS(status);
514 return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG);
517 /*******************************************************************************
519 * FUNCTION: acpi_ut_validate_resource
521 * PARAMETERS: walk_state - Current walk info
522 * aml - Pointer to the raw AML resource descriptor
523 * return_index - Where the resource index is returned. NULL
524 * if the index is not required.
526 * RETURN: Status, and optionally the Index into the global resource tables
528 * DESCRIPTION: Validate an AML resource descriptor by checking the Resource
529 * Type and Resource Length. Returns an index into the global
530 * resource information/dispatch tables for later use.
532 ******************************************************************************/
535 acpi_ut_validate_resource(struct acpi_walk_state *walk_state,
536 void *aml, u8 *return_index)
538 union aml_resource *aml_resource;
541 acpi_rs_length resource_length;
542 acpi_rs_length minimum_resource_length;
544 ACPI_FUNCTION_ENTRY();
547 * 1) Validate the resource_type field (Byte 0)
549 resource_type = ACPI_GET8(aml);
552 * Byte 0 contains the descriptor name (Resource Type)
553 * Examine the large/small bit in the resource header
555 if (resource_type & ACPI_RESOURCE_NAME_LARGE) {
557 /* Verify the large resource type (name) against the max */
559 if (resource_type > ACPI_RESOURCE_NAME_LARGE_MAX) {
560 goto invalid_resource;
564 * Large Resource Type -- bits 6:0 contain the name
565 * Translate range 0x80-0x8B to index range 0x10-0x1B
567 resource_index = (u8) (resource_type - 0x70);
570 * Small Resource Type -- bits 6:3 contain the name
571 * Shift range to index range 0x00-0x0F
573 resource_index = (u8)
574 ((resource_type & ACPI_RESOURCE_NAME_SMALL_MASK) >> 3);
578 * Check validity of the resource type, via acpi_gbl_resource_types.
579 * Zero indicates an invalid resource.
581 if (!acpi_gbl_resource_types[resource_index]) {
582 goto invalid_resource;
586 * Validate the resource_length field. This ensures that the length
587 * is at least reasonable, and guarantees that it is non-zero.
589 resource_length = acpi_ut_get_resource_length(aml);
590 minimum_resource_length = acpi_gbl_resource_aml_sizes[resource_index];
592 /* Validate based upon the type of resource - fixed length or variable */
594 switch (acpi_gbl_resource_types[resource_index]) {
595 case ACPI_FIXED_LENGTH:
597 /* Fixed length resource, length must match exactly */
599 if (resource_length != minimum_resource_length) {
600 goto bad_resource_length;
604 case ACPI_VARIABLE_LENGTH:
606 /* Variable length resource, length must be at least the minimum */
608 if (resource_length < minimum_resource_length) {
609 goto bad_resource_length;
613 case ACPI_SMALL_VARIABLE_LENGTH:
615 /* Small variable length resource, length can be (Min) or (Min-1) */
617 if ((resource_length > minimum_resource_length) ||
618 (resource_length < (minimum_resource_length - 1))) {
619 goto bad_resource_length;
625 /* Shouldn't happen (because of validation earlier), but be sure */
627 goto invalid_resource;
630 aml_resource = ACPI_CAST_PTR(union aml_resource, aml);
631 if (resource_type == ACPI_RESOURCE_NAME_SERIAL_BUS) {
633 /* Validate the bus_type field */
635 if ((aml_resource->common_serial_bus.type == 0) ||
636 (aml_resource->common_serial_bus.type >
637 AML_RESOURCE_MAX_SERIALBUSTYPE)) {
640 "Invalid/unsupported SerialBus resource descriptor: BusType 0x%2.2X",
641 aml_resource->common_serial_bus.
644 return (AE_AML_INVALID_RESOURCE_TYPE);
648 /* Optionally return the resource table index */
651 *return_index = resource_index;
660 "Invalid/unsupported resource descriptor: Type 0x%2.2X",
663 return (AE_AML_INVALID_RESOURCE_TYPE);
669 "Invalid resource descriptor length: Type "
670 "0x%2.2X, Length 0x%4.4X, MinLength 0x%4.4X",
671 resource_type, resource_length,
672 minimum_resource_length));
674 return (AE_AML_BAD_RESOURCE_LENGTH);
677 /*******************************************************************************
679 * FUNCTION: acpi_ut_get_resource_type
681 * PARAMETERS: aml - Pointer to the raw AML resource descriptor
683 * RETURN: The Resource Type with no extraneous bits (except the
684 * Large/Small descriptor bit -- this is left alone)
686 * DESCRIPTION: Extract the Resource Type/Name from the first byte of
687 * a resource descriptor.
689 ******************************************************************************/
691 u8 acpi_ut_get_resource_type(void *aml)
693 ACPI_FUNCTION_ENTRY();
696 * Byte 0 contains the descriptor name (Resource Type)
697 * Examine the large/small bit in the resource header
699 if (ACPI_GET8(aml) & ACPI_RESOURCE_NAME_LARGE) {
701 /* Large Resource Type -- bits 6:0 contain the name */
703 return (ACPI_GET8(aml));
705 /* Small Resource Type -- bits 6:3 contain the name */
707 return ((u8) (ACPI_GET8(aml) & ACPI_RESOURCE_NAME_SMALL_MASK));
711 /*******************************************************************************
713 * FUNCTION: acpi_ut_get_resource_length
715 * PARAMETERS: aml - Pointer to the raw AML resource descriptor
717 * RETURN: Byte Length
719 * DESCRIPTION: Get the "Resource Length" of a raw AML descriptor. By
720 * definition, this does not include the size of the descriptor
721 * header or the length field itself.
723 ******************************************************************************/
725 u16 acpi_ut_get_resource_length(void *aml)
727 acpi_rs_length resource_length;
729 ACPI_FUNCTION_ENTRY();
732 * Byte 0 contains the descriptor name (Resource Type)
733 * Examine the large/small bit in the resource header
735 if (ACPI_GET8(aml) & ACPI_RESOURCE_NAME_LARGE) {
737 /* Large Resource type -- bytes 1-2 contain the 16-bit length */
739 ACPI_MOVE_16_TO_16(&resource_length, ACPI_ADD_PTR(u8, aml, 1));
742 /* Small Resource type -- bits 2:0 of byte 0 contain the length */
744 resource_length = (u16) (ACPI_GET8(aml) &
745 ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK);
748 return (resource_length);
751 /*******************************************************************************
753 * FUNCTION: acpi_ut_get_resource_header_length
755 * PARAMETERS: aml - Pointer to the raw AML resource descriptor
757 * RETURN: Length of the AML header (depends on large/small descriptor)
759 * DESCRIPTION: Get the length of the header for this resource.
761 ******************************************************************************/
763 u8 acpi_ut_get_resource_header_length(void *aml)
765 ACPI_FUNCTION_ENTRY();
767 /* Examine the large/small bit in the resource header */
769 if (ACPI_GET8(aml) & ACPI_RESOURCE_NAME_LARGE) {
770 return (sizeof(struct aml_resource_large_header));
772 return (sizeof(struct aml_resource_small_header));
776 /*******************************************************************************
778 * FUNCTION: acpi_ut_get_descriptor_length
780 * PARAMETERS: aml - Pointer to the raw AML resource descriptor
782 * RETURN: Byte length
784 * DESCRIPTION: Get the total byte length of a raw AML descriptor, including the
785 * length of the descriptor header and the length field itself.
786 * Used to walk descriptor lists.
788 ******************************************************************************/
790 u32 acpi_ut_get_descriptor_length(void *aml)
792 ACPI_FUNCTION_ENTRY();
795 * Get the Resource Length (does not include header length) and add
796 * the header length (depends on if this is a small or large resource)
798 return (acpi_ut_get_resource_length(aml) +
799 acpi_ut_get_resource_header_length(aml));
802 /*******************************************************************************
804 * FUNCTION: acpi_ut_get_resource_end_tag
806 * PARAMETERS: obj_desc - The resource template buffer object
807 * end_tag - Where the pointer to the end_tag is returned
809 * RETURN: Status, pointer to the end tag
811 * DESCRIPTION: Find the end_tag resource descriptor in an AML resource template
812 * Note: allows a buffer length of zero.
814 ******************************************************************************/
817 acpi_ut_get_resource_end_tag(union acpi_operand_object *obj_desc, u8 **end_tag)
821 ACPI_FUNCTION_TRACE(ut_get_resource_end_tag);
823 /* Allow a buffer length of zero */
825 if (!obj_desc->buffer.length) {
826 *end_tag = obj_desc->buffer.pointer;
827 return_ACPI_STATUS(AE_OK);
830 /* Validate the template and get a pointer to the end_tag */
832 status = acpi_ut_walk_aml_resources(NULL, obj_desc->buffer.pointer,
833 obj_desc->buffer.length, NULL,
836 return_ACPI_STATUS(status);