1 /*******************************************************************************
3 * Module Name: rscalc - Calculate stream and list lengths
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2018, 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>
49 #define _COMPONENT ACPI_RESOURCES
50 ACPI_MODULE_NAME("rscalc")
52 /* Local prototypes */
53 static u8
acpi_rs_count_set_bits(u16 bit_field
);
56 acpi_rs_struct_option_length(struct acpi_resource_source
*resource_source
);
59 acpi_rs_stream_option_length(u32 resource_length
, u32 minimum_total_length
);
61 /*******************************************************************************
63 * FUNCTION: acpi_rs_count_set_bits
65 * PARAMETERS: bit_field - Field in which to count bits
67 * RETURN: Number of bits set within the field
69 * DESCRIPTION: Count the number of bits set in a resource field. Used for
70 * (Short descriptor) interrupt and DMA lists.
72 ******************************************************************************/
74 static u8
acpi_rs_count_set_bits(u16 bit_field
)
78 ACPI_FUNCTION_ENTRY();
80 for (bits_set
= 0; bit_field
; bits_set
++) {
82 /* Zero the least significant bit that is set */
84 bit_field
&= (u16
) (bit_field
- 1);
90 /*******************************************************************************
92 * FUNCTION: acpi_rs_struct_option_length
94 * PARAMETERS: resource_source - Pointer to optional descriptor field
98 * DESCRIPTION: Common code to handle optional resource_source_index and
99 * resource_source fields in some Large descriptors. Used during
100 * list-to-stream conversion
102 ******************************************************************************/
104 static acpi_rs_length
105 acpi_rs_struct_option_length(struct acpi_resource_source
*resource_source
)
107 ACPI_FUNCTION_ENTRY();
110 * If the resource_source string is valid, return the size of the string
111 * (string_length includes the NULL terminator) plus the size of the
112 * resource_source_index (1).
114 if (resource_source
->string_ptr
) {
115 return ((acpi_rs_length
)(resource_source
->string_length
+ 1));
121 /*******************************************************************************
123 * FUNCTION: acpi_rs_stream_option_length
125 * PARAMETERS: resource_length - Length from the resource header
126 * minimum_total_length - Minimum length of this resource, before
127 * any optional fields. Includes header size
129 * RETURN: Length of optional string (0 if no string present)
131 * DESCRIPTION: Common code to handle optional resource_source_index and
132 * resource_source fields in some Large descriptors. Used during
133 * stream-to-list conversion
135 ******************************************************************************/
138 acpi_rs_stream_option_length(u32 resource_length
,
139 u32 minimum_aml_resource_length
)
141 u32 string_length
= 0;
143 ACPI_FUNCTION_ENTRY();
146 * The resource_source_index and resource_source are optional elements of
147 * some Large-type resource descriptors.
151 * If the length of the actual resource descriptor is greater than the
152 * ACPI spec-defined minimum length, it means that a resource_source_index
153 * exists and is followed by a (required) null terminated string. The
154 * string length (including the null terminator) is the resource length
155 * minus the minimum length, minus one byte for the resource_source_index
158 if (resource_length
> minimum_aml_resource_length
) {
160 /* Compute the length of the optional string */
163 resource_length
- minimum_aml_resource_length
- 1;
167 * Round the length up to a multiple of the native word in order to
168 * guarantee that the entire resource descriptor is native word aligned
170 return ((u32
) ACPI_ROUND_UP_TO_NATIVE_WORD(string_length
));
173 /*******************************************************************************
175 * FUNCTION: acpi_rs_get_aml_length
177 * PARAMETERS: resource - Pointer to the resource linked list
178 * resource_list_size - Size of the resource linked list
179 * size_needed - Where the required size is returned
183 * DESCRIPTION: Takes a linked list of internal resource descriptors and
184 * calculates the size buffer needed to hold the corresponding
185 * external resource byte stream.
187 ******************************************************************************/
190 acpi_rs_get_aml_length(struct acpi_resource
*resource
,
191 acpi_size resource_list_size
, acpi_size
*size_needed
)
193 acpi_size aml_size_needed
= 0;
194 struct acpi_resource
*resource_end
;
195 acpi_rs_length total_size
;
197 ACPI_FUNCTION_TRACE(rs_get_aml_length
);
199 /* Traverse entire list of internal resource descriptors */
202 ACPI_ADD_PTR(struct acpi_resource
, resource
, resource_list_size
);
203 while (resource
< resource_end
) {
205 /* Validate the descriptor type */
207 if (resource
->type
> ACPI_RESOURCE_TYPE_MAX
) {
208 return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE
);
211 /* Sanity check the length. It must not be zero, or we loop forever */
213 if (!resource
->length
) {
214 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH
);
217 /* Get the base size of the (external stream) resource descriptor */
219 total_size
= acpi_gbl_aml_resource_sizes
[resource
->type
];
222 * Augment the base size for descriptors with optional and/or
223 * variable-length fields
225 switch (resource
->type
) {
226 case ACPI_RESOURCE_TYPE_IRQ
:
228 /* Length can be 3 or 2 */
230 if (resource
->data
.irq
.descriptor_length
== 2) {
235 case ACPI_RESOURCE_TYPE_START_DEPENDENT
:
237 /* Length can be 1 or 0 */
239 if (resource
->data
.irq
.descriptor_length
== 0) {
244 case ACPI_RESOURCE_TYPE_VENDOR
:
246 * Vendor Defined Resource:
247 * For a Vendor Specific resource, if the Length is between 1 and 7
248 * it will be created as a Small Resource data type, otherwise it
249 * is a Large Resource data type.
251 if (resource
->data
.vendor
.byte_length
> 7) {
253 /* Base size of a Large resource descriptor */
256 sizeof(struct aml_resource_large_header
);
259 /* Add the size of the vendor-specific data */
261 total_size
= (acpi_rs_length
)
262 (total_size
+ resource
->data
.vendor
.byte_length
);
265 case ACPI_RESOURCE_TYPE_END_TAG
:
268 * We are done -- return the accumulated total size.
270 *size_needed
= aml_size_needed
+ total_size
;
274 return_ACPI_STATUS(AE_OK
);
276 case ACPI_RESOURCE_TYPE_ADDRESS16
:
278 * 16-Bit Address Resource:
279 * Add the size of the optional resource_source info
281 total_size
= (acpi_rs_length
)(total_size
+
282 acpi_rs_struct_option_length
288 case ACPI_RESOURCE_TYPE_ADDRESS32
:
290 * 32-Bit Address Resource:
291 * Add the size of the optional resource_source info
293 total_size
= (acpi_rs_length
)(total_size
+
294 acpi_rs_struct_option_length
300 case ACPI_RESOURCE_TYPE_ADDRESS64
:
302 * 64-Bit Address Resource:
303 * Add the size of the optional resource_source info
305 total_size
= (acpi_rs_length
)(total_size
+
306 acpi_rs_struct_option_length
312 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ
:
314 * Extended IRQ Resource:
315 * Add the size of each additional optional interrupt beyond the
316 * required 1 (4 bytes for each u32 interrupt number)
318 total_size
= (acpi_rs_length
)(total_size
+
323 /* Add the size of the optional resource_source info */
324 acpi_rs_struct_option_length
330 case ACPI_RESOURCE_TYPE_GPIO
:
332 total_size
= (acpi_rs_length
)(total_size
+
333 (resource
->data
.gpio
.
334 pin_table_length
* 2) +
343 case ACPI_RESOURCE_TYPE_PIN_FUNCTION
:
345 total_size
= (acpi_rs_length
)(total_size
+
348 pin_table_length
* 2) +
359 case ACPI_RESOURCE_TYPE_SERIAL_BUS
:
362 acpi_gbl_aml_resource_serial_bus_sizes
[resource
->
367 total_size
= (acpi_rs_length
)(total_size
+
378 case ACPI_RESOURCE_TYPE_PIN_CONFIG
:
380 total_size
= (acpi_rs_length
)(total_size
+
383 pin_table_length
* 2) +
384 resource
->data
.pin_config
.
387 resource
->data
.pin_config
.
392 case ACPI_RESOURCE_TYPE_PIN_GROUP
:
394 total_size
= (acpi_rs_length
)(total_size
+
395 (resource
->data
.pin_group
.
396 pin_table_length
* 2) +
397 resource
->data
.pin_group
.
400 resource
->data
.pin_group
.
405 case ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION
:
407 total_size
= (acpi_rs_length
)(total_size
+
414 resource_source_label
.
422 case ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG
:
424 total_size
= (acpi_rs_length
)(total_size
+
431 resource_source_label
.
444 /* Update the total */
446 aml_size_needed
+= total_size
;
448 /* Point to the next object */
451 ACPI_ADD_PTR(struct acpi_resource
, resource
,
455 /* Did not find an end_tag resource descriptor */
457 return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG
);
460 /*******************************************************************************
462 * FUNCTION: acpi_rs_get_list_length
464 * PARAMETERS: aml_buffer - Pointer to the resource byte stream
465 * aml_buffer_length - Size of aml_buffer
466 * size_needed - Where the size needed is returned
470 * DESCRIPTION: Takes an external resource byte stream and calculates the size
471 * buffer needed to hold the corresponding internal resource
472 * descriptor linked list.
474 ******************************************************************************/
477 acpi_rs_get_list_length(u8
*aml_buffer
,
478 u32 aml_buffer_length
, acpi_size
*size_needed
)
486 u32 extra_struct_bytes
;
488 u8 minimum_aml_resource_length
;
489 union aml_resource
*aml_resource
;
491 ACPI_FUNCTION_TRACE(rs_get_list_length
);
493 *size_needed
= ACPI_RS_SIZE_MIN
; /* Minimum size is one end_tag */
494 end_aml
= aml_buffer
+ aml_buffer_length
;
496 /* Walk the list of AML resource descriptors */
498 while (aml_buffer
< end_aml
) {
500 /* Validate the Resource Type and Resource Length */
503 acpi_ut_validate_resource(NULL
, aml_buffer
,
505 if (ACPI_FAILURE(status
)) {
507 * Exit on failure. Cannot continue because the descriptor length
510 return_ACPI_STATUS(status
);
513 aml_resource
= (void *)aml_buffer
;
515 /* Get the resource length and base (minimum) AML size */
517 resource_length
= acpi_ut_get_resource_length(aml_buffer
);
518 minimum_aml_resource_length
=
519 acpi_gbl_resource_aml_sizes
[resource_index
];
522 * Augment the size for descriptors with optional
523 * and/or variable length fields
525 extra_struct_bytes
= 0;
527 aml_buffer
+ acpi_ut_get_resource_header_length(aml_buffer
);
529 switch (acpi_ut_get_resource_type(aml_buffer
)) {
530 case ACPI_RESOURCE_NAME_IRQ
:
533 * Get the number of bits set in the 16-bit IRQ mask
535 ACPI_MOVE_16_TO_16(&temp16
, buffer
);
536 extra_struct_bytes
= acpi_rs_count_set_bits(temp16
);
539 case ACPI_RESOURCE_NAME_DMA
:
542 * Get the number of bits set in the 8-bit DMA mask
544 extra_struct_bytes
= acpi_rs_count_set_bits(*buffer
);
547 case ACPI_RESOURCE_NAME_VENDOR_SMALL
:
548 case ACPI_RESOURCE_NAME_VENDOR_LARGE
:
551 * Get the number of vendor data bytes
553 extra_struct_bytes
= resource_length
;
556 * There is already one byte included in the minimum
557 * descriptor size. If there are extra struct bytes,
558 * subtract one from the count.
560 if (extra_struct_bytes
) {
561 extra_struct_bytes
--;
565 case ACPI_RESOURCE_NAME_END_TAG
:
567 * End Tag: This is the normal exit
569 return_ACPI_STATUS(AE_OK
);
571 case ACPI_RESOURCE_NAME_ADDRESS32
:
572 case ACPI_RESOURCE_NAME_ADDRESS16
:
573 case ACPI_RESOURCE_NAME_ADDRESS64
:
576 * Add the size of the optional resource_source
579 acpi_rs_stream_option_length(resource_length
,
580 minimum_aml_resource_length
);
583 case ACPI_RESOURCE_NAME_EXTENDED_IRQ
:
585 * Extended IRQ Resource:
586 * Using the interrupt_table_length, add 4 bytes for each additional
587 * interrupt. Note: at least one interrupt is required and is
588 * included in the minimum descriptor size (reason for the -1)
590 extra_struct_bytes
= (buffer
[1] - 1) * sizeof(u32
);
592 /* Add the size of the optional resource_source */
594 extra_struct_bytes
+=
595 acpi_rs_stream_option_length(resource_length
-
597 minimum_aml_resource_length
);
600 case ACPI_RESOURCE_NAME_GPIO
:
602 /* Vendor data is optional */
604 if (aml_resource
->gpio
.vendor_length
) {
605 extra_struct_bytes
+=
606 aml_resource
->gpio
.vendor_offset
-
607 aml_resource
->gpio
.pin_table_offset
+
608 aml_resource
->gpio
.vendor_length
;
610 extra_struct_bytes
+=
611 aml_resource
->large_header
.resource_length
+
612 sizeof(struct aml_resource_large_header
) -
613 aml_resource
->gpio
.pin_table_offset
;
617 case ACPI_RESOURCE_NAME_PIN_FUNCTION
:
619 /* Vendor data is optional */
621 if (aml_resource
->pin_function
.vendor_length
) {
622 extra_struct_bytes
+=
623 aml_resource
->pin_function
.vendor_offset
-
624 aml_resource
->pin_function
.
626 aml_resource
->pin_function
.vendor_length
;
628 extra_struct_bytes
+=
629 aml_resource
->large_header
.resource_length
+
630 sizeof(struct aml_resource_large_header
) -
631 aml_resource
->pin_function
.pin_table_offset
;
635 case ACPI_RESOURCE_NAME_SERIAL_BUS
:
637 minimum_aml_resource_length
=
638 acpi_gbl_resource_aml_serial_bus_sizes
639 [aml_resource
->common_serial_bus
.type
];
640 extra_struct_bytes
+=
641 aml_resource
->common_serial_bus
.resource_length
-
642 minimum_aml_resource_length
;
645 case ACPI_RESOURCE_NAME_PIN_CONFIG
:
647 /* Vendor data is optional */
649 if (aml_resource
->pin_config
.vendor_length
) {
650 extra_struct_bytes
+=
651 aml_resource
->pin_config
.vendor_offset
-
652 aml_resource
->pin_config
.pin_table_offset
+
653 aml_resource
->pin_config
.vendor_length
;
655 extra_struct_bytes
+=
656 aml_resource
->large_header
.resource_length
+
657 sizeof(struct aml_resource_large_header
) -
658 aml_resource
->pin_config
.pin_table_offset
;
662 case ACPI_RESOURCE_NAME_PIN_GROUP
:
664 extra_struct_bytes
+=
665 aml_resource
->pin_group
.vendor_offset
-
666 aml_resource
->pin_group
.pin_table_offset
+
667 aml_resource
->pin_group
.vendor_length
;
671 case ACPI_RESOURCE_NAME_PIN_GROUP_FUNCTION
:
673 extra_struct_bytes
+=
674 aml_resource
->pin_group_function
.vendor_offset
-
675 aml_resource
->pin_group_function
.res_source_offset
+
676 aml_resource
->pin_group_function
.vendor_length
;
680 case ACPI_RESOURCE_NAME_PIN_GROUP_CONFIG
:
682 extra_struct_bytes
+=
683 aml_resource
->pin_group_config
.vendor_offset
-
684 aml_resource
->pin_group_config
.res_source_offset
+
685 aml_resource
->pin_group_config
.vendor_length
;
695 * Update the required buffer size for the internal descriptor structs
697 * Important: Round the size up for the appropriate alignment. This
698 * is a requirement on IA64.
700 if (acpi_ut_get_resource_type(aml_buffer
) ==
701 ACPI_RESOURCE_NAME_SERIAL_BUS
) {
703 acpi_gbl_resource_struct_serial_bus_sizes
704 [aml_resource
->common_serial_bus
.type
] +
708 acpi_gbl_resource_struct_sizes
[resource_index
] +
712 buffer_size
= (u32
)ACPI_ROUND_UP_TO_NATIVE_WORD(buffer_size
);
713 *size_needed
+= buffer_size
;
715 ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES
,
716 "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
717 acpi_ut_get_resource_type(aml_buffer
),
718 acpi_ut_get_descriptor_length(aml_buffer
),
722 * Point to the next resource within the AML stream using the length
723 * contained in the resource descriptor header
725 aml_buffer
+= acpi_ut_get_descriptor_length(aml_buffer
);
728 /* Did not find an end_tag resource descriptor */
730 return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG
);
733 /*******************************************************************************
735 * FUNCTION: acpi_rs_get_pci_routing_table_length
737 * PARAMETERS: package_object - Pointer to the package object
738 * buffer_size_needed - u32 pointer of the size buffer
739 * needed to properly return the
744 * DESCRIPTION: Given a package representing a PCI routing table, this
745 * calculates the size of the corresponding linked list of
748 ******************************************************************************/
751 acpi_rs_get_pci_routing_table_length(union acpi_operand_object
*package_object
,
752 acpi_size
*buffer_size_needed
)
754 u32 number_of_elements
;
755 acpi_size temp_size_needed
= 0;
756 union acpi_operand_object
**top_object_list
;
758 union acpi_operand_object
*package_element
;
759 union acpi_operand_object
**sub_object_list
;
763 ACPI_FUNCTION_TRACE(rs_get_pci_routing_table_length
);
765 number_of_elements
= package_object
->package
.count
;
768 * Calculate the size of the return buffer.
769 * The base size is the number of elements * the sizes of the
770 * structures. Additional space for the strings is added below.
771 * The minus one is to subtract the size of the u8 Source[1]
772 * member because it is added below.
774 * But each PRT_ENTRY structure has a pointer to a string and
775 * the size of that string must be found.
777 top_object_list
= package_object
->package
.elements
;
779 for (index
= 0; index
< number_of_elements
; index
++) {
781 /* Dereference the subpackage */
783 package_element
= *top_object_list
;
785 /* We must have a valid Package object */
787 if (!package_element
||
788 (package_element
->common
.type
!= ACPI_TYPE_PACKAGE
)) {
789 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
793 * The sub_object_list will now point to an array of the
794 * four IRQ elements: Address, Pin, Source and source_index
796 sub_object_list
= package_element
->package
.elements
;
798 /* Scan the irq_table_elements for the Source Name String */
802 for (table_index
= 0;
803 table_index
< package_element
->package
.count
804 && !name_found
; table_index
++) {
805 if (*sub_object_list
&& /* Null object allowed */
806 ((ACPI_TYPE_STRING
==
807 (*sub_object_list
)->common
.type
) ||
808 ((ACPI_TYPE_LOCAL_REFERENCE
==
809 (*sub_object_list
)->common
.type
) &&
810 ((*sub_object_list
)->reference
.class ==
811 ACPI_REFCLASS_NAME
)))) {
814 /* Look at the next element */
820 temp_size_needed
+= (sizeof(struct acpi_pci_routing_table
) - 4);
822 /* Was a String type found? */
825 if ((*sub_object_list
)->common
.type
== ACPI_TYPE_STRING
) {
827 * The length String.Length field does not include the
828 * terminating NULL, add 1
830 temp_size_needed
+= ((acpi_size
)
831 (*sub_object_list
)->string
.
834 temp_size_needed
+= acpi_ns_get_pathname_length((*sub_object_list
)->reference
.node
);
838 * If no name was found, then this is a NULL, which is
839 * translated as a u32 zero.
841 temp_size_needed
+= sizeof(u32
);
844 /* Round up the size since each element must be aligned */
846 temp_size_needed
= ACPI_ROUND_UP_TO_64BIT(temp_size_needed
);
848 /* Point to the next union acpi_operand_object */
854 * Add an extra element to the end of the list, essentially a
857 *buffer_size_needed
=
858 temp_size_needed
+ sizeof(struct acpi_pci_routing_table
);
859 return_ACPI_STATUS(AE_OK
);