1 /*******************************************************************************
3 * Module Name: rsutils - Utilities for the resource manager
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2015, 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("rsutils")
52 /*******************************************************************************
54 * FUNCTION: acpi_rs_decode_bitmask
56 * PARAMETERS: mask - Bitmask to decode
57 * list - Where the converted list is returned
59 * RETURN: Count of bits set (length of list)
61 * DESCRIPTION: Convert a bit mask into a list of values
63 ******************************************************************************/
64 u8 acpi_rs_decode_bitmask(u16 mask, u8 * list)
69 ACPI_FUNCTION_ENTRY();
71 /* Decode the mask bits */
73 for (i = 0, bit_count = 0; mask; i++) {
85 /*******************************************************************************
87 * FUNCTION: acpi_rs_encode_bitmask
89 * PARAMETERS: list - List of values to encode
90 * count - Length of list
92 * RETURN: Encoded bitmask
94 * DESCRIPTION: Convert a list of values to an encoded bitmask
96 ******************************************************************************/
98 u16 acpi_rs_encode_bitmask(u8 * list, u8 count)
103 ACPI_FUNCTION_ENTRY();
105 /* Encode the list into a single bitmask */
107 for (i = 0, mask = 0; i < count; i++) {
108 mask |= (0x1 << list[i]);
114 /*******************************************************************************
116 * FUNCTION: acpi_rs_move_data
118 * PARAMETERS: destination - Pointer to the destination descriptor
119 * source - Pointer to the source descriptor
120 * item_count - How many items to move
121 * move_type - Byte width
125 * DESCRIPTION: Move multiple data items from one descriptor to another. Handles
126 * alignment issues and endian issues if necessary, as configured
127 * via the ACPI_MOVE_* macros. (This is why a memcpy is not used)
129 ******************************************************************************/
132 acpi_rs_move_data(void *destination, void *source, u16 item_count, u8 move_type)
136 ACPI_FUNCTION_ENTRY();
138 /* One move per item */
140 for (i = 0; i < item_count; i++) {
143 * For the 8-bit case, we can perform the move all at once
144 * since there are no alignment or endian issues
147 case ACPI_RSC_MOVE_GPIO_RES:
148 case ACPI_RSC_MOVE_SERIAL_VEN:
149 case ACPI_RSC_MOVE_SERIAL_RES:
151 memcpy(destination, source, item_count);
155 * 16-, 32-, and 64-bit cases must use the move macros that perform
156 * endian conversion and/or accommodate hardware that cannot perform
157 * misaligned memory transfers
159 case ACPI_RSC_MOVE16:
160 case ACPI_RSC_MOVE_GPIO_PIN:
162 ACPI_MOVE_16_TO_16(&ACPI_CAST_PTR(u16, destination)[i],
163 &ACPI_CAST_PTR(u16, source)[i]);
166 case ACPI_RSC_MOVE32:
168 ACPI_MOVE_32_TO_32(&ACPI_CAST_PTR(u32, destination)[i],
169 &ACPI_CAST_PTR(u32, source)[i]);
172 case ACPI_RSC_MOVE64:
174 ACPI_MOVE_64_TO_64(&ACPI_CAST_PTR(u64, destination)[i],
175 &ACPI_CAST_PTR(u64, source)[i]);
185 /*******************************************************************************
187 * FUNCTION: acpi_rs_set_resource_length
189 * PARAMETERS: total_length - Length of the AML descriptor, including
190 * the header and length fields.
191 * aml - Pointer to the raw AML descriptor
195 * DESCRIPTION: Set the resource_length field of an AML
196 * resource descriptor, both Large and Small descriptors are
197 * supported automatically. Note: Descriptor Type field must
200 ******************************************************************************/
203 acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
204 union aml_resource *aml)
206 acpi_rs_length resource_length;
208 ACPI_FUNCTION_ENTRY();
210 /* Length is the total descriptor length minus the header length */
212 resource_length = (acpi_rs_length)
213 (total_length - acpi_ut_get_resource_header_length(aml));
215 /* Length is stored differently for large and small descriptors */
217 if (aml->small_header.descriptor_type & ACPI_RESOURCE_NAME_LARGE) {
219 /* Large descriptor -- bytes 1-2 contain the 16-bit length */
221 ACPI_MOVE_16_TO_16(&aml->large_header.resource_length,
224 /* Small descriptor -- bits 2:0 of byte 0 contain the length */
226 aml->small_header.descriptor_type = (u8)
228 /* Clear any existing length, preserving descriptor type bits */
230 descriptor_type & ~ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK)
236 /*******************************************************************************
238 * FUNCTION: acpi_rs_set_resource_header
240 * PARAMETERS: descriptor_type - Byte to be inserted as the type
241 * total_length - Length of the AML descriptor, including
242 * the header and length fields.
243 * aml - Pointer to the raw AML descriptor
247 * DESCRIPTION: Set the descriptor_type and resource_length fields of an AML
248 * resource descriptor, both Large and Small descriptors are
249 * supported automatically
251 ******************************************************************************/
254 acpi_rs_set_resource_header(u8 descriptor_type,
255 acpi_rsdesc_size total_length,
256 union aml_resource *aml)
258 ACPI_FUNCTION_ENTRY();
260 /* Set the Resource Type */
262 aml->small_header.descriptor_type = descriptor_type;
264 /* Set the Resource Length */
266 acpi_rs_set_resource_length(total_length, aml);
269 /*******************************************************************************
271 * FUNCTION: acpi_rs_strcpy
273 * PARAMETERS: destination - Pointer to the destination string
274 * source - Pointer to the source string
276 * RETURN: String length, including NULL terminator
278 * DESCRIPTION: Local string copy that returns the string length, saving a
279 * strcpy followed by a strlen.
281 ******************************************************************************/
283 static u16 acpi_rs_strcpy(char *destination, char *source)
287 ACPI_FUNCTION_ENTRY();
289 for (i = 0; source[i]; i++) {
290 destination[i] = source[i];
295 /* Return string length including the NULL terminator */
297 return ((u16) (i + 1));
300 /*******************************************************************************
302 * FUNCTION: acpi_rs_get_resource_source
304 * PARAMETERS: resource_length - Length field of the descriptor
305 * minimum_length - Minimum length of the descriptor (minus
306 * any optional fields)
307 * resource_source - Where the resource_source is returned
308 * aml - Pointer to the raw AML descriptor
309 * string_ptr - (optional) where to store the actual
310 * resource_source string
312 * RETURN: Length of the string plus NULL terminator, rounded up to native
315 * DESCRIPTION: Copy the optional resource_source data from a raw AML descriptor
316 * to an internal resource descriptor
318 ******************************************************************************/
321 acpi_rs_get_resource_source(acpi_rs_length resource_length,
322 acpi_rs_length minimum_length,
323 struct acpi_resource_source * resource_source,
324 union aml_resource * aml, char *string_ptr)
326 acpi_rsdesc_size total_length;
327 u8 *aml_resource_source;
329 ACPI_FUNCTION_ENTRY();
332 resource_length + sizeof(struct aml_resource_large_header);
333 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
336 * resource_source is present if the length of the descriptor is longer than
337 * the minimum length.
339 * Note: Some resource descriptors will have an additional null, so
340 * we add 1 to the minimum length.
342 if (total_length > (acpi_rsdesc_size) (minimum_length + 1)) {
344 /* Get the resource_source_index */
346 resource_source->index = aml_resource_source[0];
348 resource_source->string_ptr = string_ptr;
351 * String destination pointer is not specified; Set the String
352 * pointer to the end of the current resource_source structure.
354 resource_source->string_ptr =
355 ACPI_ADD_PTR(char, resource_source,
356 sizeof(struct acpi_resource_source));
360 * In order for the Resource length to be a multiple of the native
361 * word, calculate the length of the string (+1 for NULL terminator)
362 * and expand to the next word multiple.
364 * Zero the entire area of the buffer.
367 (u32)strlen(ACPI_CAST_PTR(char, &aml_resource_source[1])) +
369 total_length = (u32)ACPI_ROUND_UP_TO_NATIVE_WORD(total_length);
371 memset(resource_source->string_ptr, 0, total_length);
373 /* Copy the resource_source string to the destination */
375 resource_source->string_length =
376 acpi_rs_strcpy(resource_source->string_ptr,
378 &aml_resource_source[1]));
380 return ((acpi_rs_length) total_length);
383 /* resource_source is not present */
385 resource_source->index = 0;
386 resource_source->string_length = 0;
387 resource_source->string_ptr = NULL;
391 /*******************************************************************************
393 * FUNCTION: acpi_rs_set_resource_source
395 * PARAMETERS: aml - Pointer to the raw AML descriptor
396 * minimum_length - Minimum length of the descriptor (minus
397 * any optional fields)
398 * resource_source - Internal resource_source
401 * RETURN: Total length of the AML descriptor
403 * DESCRIPTION: Convert an optional resource_source from internal format to a
404 * raw AML resource descriptor
406 ******************************************************************************/
409 acpi_rs_set_resource_source(union aml_resource * aml,
410 acpi_rs_length minimum_length,
411 struct acpi_resource_source * resource_source)
413 u8 *aml_resource_source;
414 acpi_rsdesc_size descriptor_length;
416 ACPI_FUNCTION_ENTRY();
418 descriptor_length = minimum_length;
420 /* Non-zero string length indicates presence of a resource_source */
422 if (resource_source->string_length) {
424 /* Point to the end of the AML descriptor */
426 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
428 /* Copy the resource_source_index */
430 aml_resource_source[0] = (u8) resource_source->index;
432 /* Copy the resource_source string */
434 strcpy(ACPI_CAST_PTR(char, &aml_resource_source[1]),
435 resource_source->string_ptr);
438 * Add the length of the string (+ 1 for null terminator) to the
439 * final descriptor length
442 ((acpi_rsdesc_size) resource_source->string_length + 1);
445 /* Return the new total length of the AML descriptor */
447 return (descriptor_length);
450 /*******************************************************************************
452 * FUNCTION: acpi_rs_get_prt_method_data
454 * PARAMETERS: node - Device node
455 * ret_buffer - Pointer to a buffer structure for the
460 * DESCRIPTION: This function is called to get the _PRT value of an object
461 * contained in an object specified by the handle passed in
463 * If the function fails an appropriate status will be returned
464 * and the contents of the callers buffer is undefined.
466 ******************************************************************************/
469 acpi_rs_get_prt_method_data(struct acpi_namespace_node * node,
470 struct acpi_buffer * ret_buffer)
472 union acpi_operand_object *obj_desc;
475 ACPI_FUNCTION_TRACE(rs_get_prt_method_data);
477 /* Parameters guaranteed valid by caller */
479 /* Execute the method, no parameters */
481 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRT,
482 ACPI_BTYPE_PACKAGE, &obj_desc);
483 if (ACPI_FAILURE(status)) {
484 return_ACPI_STATUS(status);
488 * Create a resource linked list from the byte stream buffer that comes
489 * back from the _CRS method execution.
491 status = acpi_rs_create_pci_routing_table(obj_desc, ret_buffer);
493 /* On exit, we must delete the object returned by evaluate_object */
495 acpi_ut_remove_reference(obj_desc);
496 return_ACPI_STATUS(status);
499 /*******************************************************************************
501 * FUNCTION: acpi_rs_get_crs_method_data
503 * PARAMETERS: node - Device node
504 * ret_buffer - Pointer to a buffer structure for the
509 * DESCRIPTION: This function is called to get the _CRS value of an object
510 * contained in an object specified by the handle passed in
512 * If the function fails an appropriate status will be returned
513 * and the contents of the callers buffer is undefined.
515 ******************************************************************************/
518 acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
519 struct acpi_buffer *ret_buffer)
521 union acpi_operand_object *obj_desc;
524 ACPI_FUNCTION_TRACE(rs_get_crs_method_data);
526 /* Parameters guaranteed valid by caller */
528 /* Execute the method, no parameters */
530 status = acpi_ut_evaluate_object(node, METHOD_NAME__CRS,
531 ACPI_BTYPE_BUFFER, &obj_desc);
532 if (ACPI_FAILURE(status)) {
533 return_ACPI_STATUS(status);
537 * Make the call to create a resource linked list from the
538 * byte stream buffer that comes back from the _CRS method
541 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
543 /* On exit, we must delete the object returned by evaluateObject */
545 acpi_ut_remove_reference(obj_desc);
546 return_ACPI_STATUS(status);
549 /*******************************************************************************
551 * FUNCTION: acpi_rs_get_prs_method_data
553 * PARAMETERS: node - Device node
554 * ret_buffer - Pointer to a buffer structure for the
559 * DESCRIPTION: This function is called to get the _PRS value of an object
560 * contained in an object specified by the handle passed in
562 * If the function fails an appropriate status will be returned
563 * and the contents of the callers buffer is undefined.
565 ******************************************************************************/
567 #ifdef ACPI_FUTURE_USAGE
569 acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
570 struct acpi_buffer *ret_buffer)
572 union acpi_operand_object *obj_desc;
575 ACPI_FUNCTION_TRACE(rs_get_prs_method_data);
577 /* Parameters guaranteed valid by caller */
579 /* Execute the method, no parameters */
581 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRS,
582 ACPI_BTYPE_BUFFER, &obj_desc);
583 if (ACPI_FAILURE(status)) {
584 return_ACPI_STATUS(status);
588 * Make the call to create a resource linked list from the
589 * byte stream buffer that comes back from the _CRS method
592 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
594 /* On exit, we must delete the object returned by evaluateObject */
596 acpi_ut_remove_reference(obj_desc);
597 return_ACPI_STATUS(status);
599 #endif /* ACPI_FUTURE_USAGE */
601 /*******************************************************************************
603 * FUNCTION: acpi_rs_get_aei_method_data
605 * PARAMETERS: node - Device node
606 * ret_buffer - Pointer to a buffer structure for the
611 * DESCRIPTION: This function is called to get the _AEI value of an object
612 * contained in an object specified by the handle passed in
614 * If the function fails an appropriate status will be returned
615 * and the contents of the callers buffer is undefined.
617 ******************************************************************************/
620 acpi_rs_get_aei_method_data(struct acpi_namespace_node *node,
621 struct acpi_buffer *ret_buffer)
623 union acpi_operand_object *obj_desc;
626 ACPI_FUNCTION_TRACE(rs_get_aei_method_data);
628 /* Parameters guaranteed valid by caller */
630 /* Execute the method, no parameters */
632 status = acpi_ut_evaluate_object(node, METHOD_NAME__AEI,
633 ACPI_BTYPE_BUFFER, &obj_desc);
634 if (ACPI_FAILURE(status)) {
635 return_ACPI_STATUS(status);
639 * Make the call to create a resource linked list from the
640 * byte stream buffer that comes back from the _CRS method
643 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
645 /* On exit, we must delete the object returned by evaluateObject */
647 acpi_ut_remove_reference(obj_desc);
648 return_ACPI_STATUS(status);
651 /*******************************************************************************
653 * FUNCTION: acpi_rs_get_method_data
655 * PARAMETERS: handle - Handle to the containing object
656 * path - Path to method, relative to Handle
657 * ret_buffer - Pointer to a buffer structure for the
662 * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
663 * object contained in an object specified by the handle passed in
665 * If the function fails an appropriate status will be returned
666 * and the contents of the callers buffer is undefined.
668 ******************************************************************************/
671 acpi_rs_get_method_data(acpi_handle handle,
672 char *path, struct acpi_buffer *ret_buffer)
674 union acpi_operand_object *obj_desc;
677 ACPI_FUNCTION_TRACE(rs_get_method_data);
679 /* Parameters guaranteed valid by caller */
681 /* Execute the method, no parameters */
684 acpi_ut_evaluate_object(ACPI_CAST_PTR
685 (struct acpi_namespace_node, handle), path,
686 ACPI_BTYPE_BUFFER, &obj_desc);
687 if (ACPI_FAILURE(status)) {
688 return_ACPI_STATUS(status);
692 * Make the call to create a resource linked list from the
693 * byte stream buffer that comes back from the method
696 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
698 /* On exit, we must delete the object returned by evaluate_object */
700 acpi_ut_remove_reference(obj_desc);
701 return_ACPI_STATUS(status);
704 /*******************************************************************************
706 * FUNCTION: acpi_rs_set_srs_method_data
708 * PARAMETERS: node - Device node
709 * in_buffer - Pointer to a buffer structure of the
714 * DESCRIPTION: This function is called to set the _SRS of an object contained
715 * in an object specified by the handle passed in
717 * If the function fails an appropriate status will be returned
718 * and the contents of the callers buffer is undefined.
720 * Note: Parameters guaranteed valid by caller
722 ******************************************************************************/
725 acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
726 struct acpi_buffer *in_buffer)
728 struct acpi_evaluate_info *info;
729 union acpi_operand_object *args[2];
731 struct acpi_buffer buffer;
733 ACPI_FUNCTION_TRACE(rs_set_srs_method_data);
735 /* Allocate and initialize the evaluation information block */
737 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
739 return_ACPI_STATUS(AE_NO_MEMORY);
742 info->prefix_node = node;
743 info->relative_pathname = METHOD_NAME__SRS;
744 info->parameters = args;
745 info->flags = ACPI_IGNORE_RETURN_VALUE;
748 * The in_buffer parameter will point to a linked list of
749 * resource parameters. It needs to be formatted into a
750 * byte stream to be sent in as an input parameter to _SRS
752 * Convert the linked list into a byte stream
754 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
755 status = acpi_rs_create_aml_resources(in_buffer, &buffer);
756 if (ACPI_FAILURE(status)) {
760 /* Create and initialize the method parameter object */
762 args[0] = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
765 * Must free the buffer allocated above (otherwise it is freed
768 ACPI_FREE(buffer.pointer);
769 status = AE_NO_MEMORY;
773 args[0]->buffer.length = (u32) buffer.length;
774 args[0]->buffer.pointer = buffer.pointer;
775 args[0]->common.flags = AOPOBJ_DATA_VALID;
778 /* Execute the method, no return value is expected */
780 status = acpi_ns_evaluate(info);
782 /* Clean up and return the status from acpi_ns_evaluate */
784 acpi_ut_remove_reference(args[0]);
788 return_ACPI_STATUS(status);