1 /*******************************************************************************
3 * Module Name: rscalc - Calculate stream and list lengths
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acresrc.h>
47 #include <acpi/amlcode.h>
48 #include <acpi/acnamesp.h>
50 #define _COMPONENT ACPI_RESOURCES
51 ACPI_MODULE_NAME ("rscalc")
54 /*******************************************************************************
56 * FUNCTION: acpi_rs_get_byte_stream_length
58 * PARAMETERS: linked_list - Pointer to the resource linked list
59 * size_needed - u32 pointer of the size buffer needed
60 * to properly return the parsed data
64 * DESCRIPTION: Takes the resource byte stream and parses it once, calculating
65 * the size buffer needed to hold the linked list that conveys
68 ******************************************************************************/
71 acpi_rs_get_byte_stream_length (
72 struct acpi_resource *linked_list,
73 acpi_size *size_needed)
75 acpi_size byte_stream_size_needed = 0;
76 acpi_size segment_size;
80 ACPI_FUNCTION_TRACE ("rs_get_byte_stream_length");
85 * Init the variable that will hold the size to add to the total.
89 switch (linked_list->id) {
93 * For an IRQ Resource, Byte 3, although optional, will always be
94 * created - it holds IRQ information.
102 * For this resource the size is static
107 case ACPI_RSTYPE_START_DPF:
109 * Start Dependent Functions Resource
110 * For a start_dependent_functions Resource, Byte 1, although
111 * optional, will always be created.
116 case ACPI_RSTYPE_END_DPF:
118 * End Dependent Functions Resource
119 * For this resource the size is static
127 * For this resource the size is static
132 case ACPI_RSTYPE_FIXED_IO:
134 * Fixed IO Port Resource
135 * For this resource the size is static
140 case ACPI_RSTYPE_VENDOR:
142 * Vendor Defined Resource
143 * For a Vendor Specific resource, if the Length is between 1 and 7
144 * it will be created as a Small Resource data type, otherwise it
145 * is a Large Resource data type.
147 if (linked_list->data.vendor_specific.length > 7) {
153 segment_size += linked_list->data.vendor_specific.length;
156 case ACPI_RSTYPE_END_TAG:
159 * For this resource the size is static
165 case ACPI_RSTYPE_MEM24:
167 * 24-Bit Memory Resource
168 * For this resource the size is static
173 case ACPI_RSTYPE_MEM32:
175 * 32-Bit Memory Range Resource
176 * For this resource the size is static
181 case ACPI_RSTYPE_FIXED_MEM32:
183 * 32-Bit Fixed Memory Resource
184 * For this resource the size is static
189 case ACPI_RSTYPE_ADDRESS16:
191 * 16-Bit Address Resource
192 * The base size of this byte stream is 16. If a Resource Source
193 * string is not NULL, add 1 for the Index + the length of the null
194 * terminated string Resource Source + 1 for the null.
198 if (linked_list->data.address16.resource_source.string_ptr) {
199 segment_size += linked_list->data.address16.resource_source.string_length;
204 case ACPI_RSTYPE_ADDRESS32:
206 * 32-Bit Address Resource
207 * The base size of this byte stream is 26. If a Resource
208 * Source string is not NULL, add 1 for the Index + the
209 * length of the null terminated string Resource Source +
214 if (linked_list->data.address32.resource_source.string_ptr) {
215 segment_size += linked_list->data.address32.resource_source.string_length;
220 case ACPI_RSTYPE_ADDRESS64:
222 * 64-Bit Address Resource
223 * The base size of this byte stream is 46. If a resource_source
224 * string is not NULL, add 1 for the Index + the length of the null
225 * terminated string Resource Source + 1 for the null.
229 if (linked_list->data.address64.resource_source.string_ptr) {
230 segment_size += linked_list->data.address64.resource_source.string_length;
235 case ACPI_RSTYPE_EXT_IRQ:
237 * Extended IRQ Resource
238 * The base size of this byte stream is 9. This is for an Interrupt
239 * table length of 1. For each additional interrupt, add 4.
240 * If a Resource Source string is not NULL, add 1 for the
241 * Index + the length of the null terminated string
242 * Resource Source + 1 for the null.
245 (((acpi_size) linked_list->data.extended_irq.number_of_interrupts - 1) * 4);
247 if (linked_list->data.extended_irq.resource_source.string_ptr) {
248 segment_size += linked_list->data.extended_irq.resource_source.string_length;
255 * If we get here, everything is out of sync, exit with error
257 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
259 } /* switch (linked_list->Id) */
264 byte_stream_size_needed += segment_size;
267 * Point to the next object
269 linked_list = ACPI_PTR_ADD (struct acpi_resource,
270 linked_list, linked_list->length);
274 * This is the data the caller needs
276 *size_needed = byte_stream_size_needed;
277 return_ACPI_STATUS (AE_OK);
281 /*******************************************************************************
283 * FUNCTION: acpi_rs_get_list_length
285 * PARAMETERS: byte_stream_buffer - Pointer to the resource byte stream
286 * byte_stream_buffer_length - Size of byte_stream_buffer
287 * size_needed - u32 pointer of the size buffer
288 * needed to properly return the
293 * DESCRIPTION: Takes the resource byte stream and parses it once, calculating
294 * the size buffer needed to hold the linked list that conveys
297 ******************************************************************************/
300 acpi_rs_get_list_length (
301 u8 *byte_stream_buffer,
302 u32 byte_stream_buffer_length,
303 acpi_size *size_needed)
306 u32 bytes_parsed = 0;
307 u8 number_of_interrupts = 0;
308 u8 number_of_channels = 0;
319 ACPI_FUNCTION_TRACE ("rs_get_list_length");
322 while (bytes_parsed < byte_stream_buffer_length) {
324 * The next byte in the stream is the resource type
326 resource_type = acpi_rs_get_resource_type (*byte_stream_buffer);
328 switch (resource_type) {
329 case ACPI_RDESC_TYPE_MEMORY_24:
331 * 24-Bit Memory Resource
335 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_mem24);
339 case ACPI_RDESC_TYPE_LARGE_VENDOR:
341 * Vendor Defined Resource
343 buffer = byte_stream_buffer;
346 ACPI_MOVE_16_TO_16 (&temp16, buffer);
347 bytes_consumed = temp16 + 3;
350 * Ensure a 32-bit boundary for the structure
352 temp16 = (u16) ACPI_ROUND_UP_to_32_bITS (temp16);
354 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_vendor) +
355 (temp16 * sizeof (u8));
359 case ACPI_RDESC_TYPE_MEMORY_32:
361 * 32-Bit Memory Range Resource
365 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_mem32);
369 case ACPI_RDESC_TYPE_FIXED_MEMORY_32:
371 * 32-Bit Fixed Memory Resource
375 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_fixed_mem32);
379 case ACPI_RDESC_TYPE_EXTENDED_ADDRESS_SPACE:
381 * 64-Bit Address Resource
383 buffer = byte_stream_buffer;
386 ACPI_MOVE_16_TO_16 (&temp16, buffer);
388 bytes_consumed = temp16 + 3;
389 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_address64);
393 case ACPI_RDESC_TYPE_QWORD_ADDRESS_SPACE:
395 * 64-Bit Address Resource
397 buffer = byte_stream_buffer;
400 ACPI_MOVE_16_TO_16 (&temp16, buffer);
402 bytes_consumed = temp16 + 3;
405 * Resource Source Index and Resource Source are optional elements.
406 * Check the length of the Bytestream. If it is greater than 43,
407 * that means that an Index exists and is followed by a null
408 * terminated string. Therefore, set the temp variable to the
409 * length minus the minimum byte stream length plus the byte for
410 * the Index to determine the size of the NULL terminated string.
413 temp8 = (u8) (temp16 - 44);
420 * Ensure a 64-bit boundary for the structure
422 temp8 = (u8) ACPI_ROUND_UP_to_64_bITS (temp8);
424 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_address64) +
425 (temp8 * sizeof (u8));
429 case ACPI_RDESC_TYPE_DWORD_ADDRESS_SPACE:
431 * 32-Bit Address Resource
433 buffer = byte_stream_buffer;
436 ACPI_MOVE_16_TO_16 (&temp16, buffer);
438 bytes_consumed = temp16 + 3;
441 * Resource Source Index and Resource Source are optional elements.
442 * Check the length of the Bytestream. If it is greater than 23,
443 * that means that an Index exists and is followed by a null
444 * terminated string. Therefore, set the temp variable to the
445 * length minus the minimum byte stream length plus the byte for
446 * the Index to determine the size of the NULL terminated string.
449 temp8 = (u8) (temp16 - 24);
456 * Ensure a 32-bit boundary for the structure
458 temp8 = (u8) ACPI_ROUND_UP_to_32_bITS (temp8);
460 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_address32) +
461 (temp8 * sizeof (u8));
465 case ACPI_RDESC_TYPE_WORD_ADDRESS_SPACE:
467 * 16-Bit Address Resource
469 buffer = byte_stream_buffer;
472 ACPI_MOVE_16_TO_16 (&temp16, buffer);
474 bytes_consumed = temp16 + 3;
477 * Resource Source Index and Resource Source are optional elements.
478 * Check the length of the Bytestream. If it is greater than 13,
479 * that means that an Index exists and is followed by a null
480 * terminated string. Therefore, set the temp variable to the
481 * length minus the minimum byte stream length plus the byte for
482 * the Index to determine the size of the NULL terminated string.
485 temp8 = (u8) (temp16 - 14);
492 * Ensure a 32-bit boundary for the structure
494 temp8 = (u8) ACPI_ROUND_UP_to_32_bITS (temp8);
496 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_address16) +
497 (temp8 * sizeof (u8));
501 case ACPI_RDESC_TYPE_EXTENDED_XRUPT:
505 buffer = byte_stream_buffer;
508 ACPI_MOVE_16_TO_16 (&temp16, buffer);
510 bytes_consumed = temp16 + 3;
513 * Point past the length field and the Interrupt vector flags to
514 * save off the Interrupt table length to the Temp8 variable.
520 * To compensate for multiple interrupt numbers, add 4 bytes for
521 * each additional interrupts greater than 1
523 additional_bytes = (u8) ((temp8 - 1) * 4);
526 * Resource Source Index and Resource Source are optional elements.
527 * Check the length of the Bytestream. If it is greater than 9,
528 * that means that an Index exists and is followed by a null
529 * terminated string. Therefore, set the temp variable to the
530 * length minus the minimum byte stream length plus the byte for
531 * the Index to determine the size of the NULL terminated string.
533 if (9 + additional_bytes < temp16) {
534 temp8 = (u8) (temp16 - (9 + additional_bytes));
541 * Ensure a 32-bit boundary for the structure
543 temp8 = (u8) ACPI_ROUND_UP_to_32_bITS (temp8);
545 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_ext_irq) +
546 (additional_bytes * sizeof (u8)) +
547 (temp8 * sizeof (u8));
551 case ACPI_RDESC_TYPE_IRQ_FORMAT:
554 * Determine if it there are two or three trailing bytes
556 buffer = byte_stream_buffer;
566 /* Point past the descriptor */
571 * Look at the number of bits set
573 ACPI_MOVE_16_TO_16 (&temp16, buffer);
575 for (index = 0; index < 16; index++) {
577 ++number_of_interrupts;
583 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_io) +
584 (number_of_interrupts * sizeof (u32));
588 case ACPI_RDESC_TYPE_DMA_FORMAT:
592 buffer = byte_stream_buffer;
595 /* Point past the descriptor */
600 * Look at the number of bits set
604 for(index = 0; index < 8; index++) {
606 ++number_of_channels;
612 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_dma) +
613 (number_of_channels * sizeof (u32));
617 case ACPI_RDESC_TYPE_START_DEPENDENT:
619 * Start Dependent Functions Resource
620 * Determine if it there are two or three trailing bytes
622 buffer = byte_stream_buffer;
632 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_start_dpf);
636 case ACPI_RDESC_TYPE_END_DEPENDENT:
638 * End Dependent Functions Resource
641 structure_size = ACPI_RESOURCE_LENGTH;
645 case ACPI_RDESC_TYPE_IO_PORT:
650 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_io);
654 case ACPI_RDESC_TYPE_FIXED_IO_PORT:
656 * Fixed IO Port Resource
659 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_fixed_io);
663 case ACPI_RDESC_TYPE_SMALL_VENDOR:
665 * Vendor Specific Resource
667 buffer = byte_stream_buffer;
670 temp8 = (u8) (temp8 & 0x7);
671 bytes_consumed = temp8 + 1;
674 * Ensure a 32-bit boundary for the structure
676 temp8 = (u8) ACPI_ROUND_UP_to_32_bITS (temp8);
677 structure_size = ACPI_SIZEOF_RESOURCE (struct acpi_resource_vendor) +
678 (temp8 * sizeof (u8));
682 case ACPI_RDESC_TYPE_END_TAG:
687 structure_size = ACPI_RESOURCE_LENGTH;
688 byte_stream_buffer_length = bytes_parsed;
694 * If we get here, everything is out of sync,
697 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
701 * Update the return value and counter
703 buffer_size += (u32) ACPI_ALIGN_RESOURCE_SIZE (structure_size);
704 bytes_parsed += bytes_consumed;
707 * Set the byte stream to point to the next resource
709 byte_stream_buffer += bytes_consumed;
713 * This is the data the caller needs
715 *size_needed = buffer_size;
716 return_ACPI_STATUS (AE_OK);
720 /*******************************************************************************
722 * FUNCTION: acpi_rs_get_pci_routing_table_length
724 * PARAMETERS: package_object - Pointer to the package object
725 * buffer_size_needed - u32 pointer of the size buffer
726 * needed to properly return the
731 * DESCRIPTION: Given a package representing a PCI routing table, this
732 * calculates the size of the corresponding linked list of
735 ******************************************************************************/
738 acpi_rs_get_pci_routing_table_length (
739 union acpi_operand_object *package_object,
740 acpi_size *buffer_size_needed)
742 u32 number_of_elements;
743 acpi_size temp_size_needed = 0;
744 union acpi_operand_object **top_object_list;
746 union acpi_operand_object *package_element;
747 union acpi_operand_object **sub_object_list;
752 ACPI_FUNCTION_TRACE ("rs_get_pci_routing_table_length");
755 number_of_elements = package_object->package.count;
758 * Calculate the size of the return buffer.
759 * The base size is the number of elements * the sizes of the
760 * structures. Additional space for the strings is added below.
761 * The minus one is to subtract the size of the u8 Source[1]
762 * member because it is added below.
764 * But each PRT_ENTRY structure has a pointer to a string and
765 * the size of that string must be found.
767 top_object_list = package_object->package.elements;
769 for (index = 0; index < number_of_elements; index++) {
771 * Dereference the sub-package
773 package_element = *top_object_list;
776 * The sub_object_list will now point to an array of the
777 * four IRQ elements: Address, Pin, Source and source_index
779 sub_object_list = package_element->package.elements;
782 * Scan the irq_table_elements for the Source Name String
786 for (table_index = 0; table_index < 4 && !name_found; table_index++) {
787 if ((ACPI_TYPE_STRING == ACPI_GET_OBJECT_TYPE (*sub_object_list)) ||
788 ((ACPI_TYPE_LOCAL_REFERENCE == ACPI_GET_OBJECT_TYPE (*sub_object_list)) &&
789 ((*sub_object_list)->reference.opcode == AML_INT_NAMEPATH_OP))) {
794 * Look at the next element
800 temp_size_needed += (sizeof (struct acpi_pci_routing_table) - 4);
803 * Was a String type found?
806 if (ACPI_GET_OBJECT_TYPE (*sub_object_list) == ACPI_TYPE_STRING) {
808 * The length String.Length field does not include the
809 * terminating NULL, add 1
811 temp_size_needed += ((acpi_size) (*sub_object_list)->string.length + 1);
814 temp_size_needed += acpi_ns_get_pathname_length (
815 (*sub_object_list)->reference.node);
820 * If no name was found, then this is a NULL, which is
821 * translated as a u32 zero.
823 temp_size_needed += sizeof (u32);
826 /* Round up the size since each element must be aligned */
828 temp_size_needed = ACPI_ROUND_UP_to_64_bITS (temp_size_needed);
831 * Point to the next union acpi_operand_object
837 * Adding an extra element to the end of the list, essentially a NULL terminator
839 *buffer_size_needed = temp_size_needed + sizeof (struct acpi_pci_routing_table);
840 return_ACPI_STATUS (AE_OK);