1 /*******************************************************************************
3 * Module Name: rsutils - Utilities for the resource manager
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2013, 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:
150 ACPI_MEMCPY(destination, source, item_count);
154 * 16-, 32-, and 64-bit cases must use the move macros that perform
155 * endian conversion and/or accommodate hardware that cannot perform
156 * misaligned memory transfers
158 case ACPI_RSC_MOVE16:
159 case ACPI_RSC_MOVE_GPIO_PIN:
160 ACPI_MOVE_16_TO_16(&ACPI_CAST_PTR(u16, destination)[i],
161 &ACPI_CAST_PTR(u16, source)[i]);
164 case ACPI_RSC_MOVE32:
165 ACPI_MOVE_32_TO_32(&ACPI_CAST_PTR(u32, destination)[i],
166 &ACPI_CAST_PTR(u32, source)[i]);
169 case ACPI_RSC_MOVE64:
170 ACPI_MOVE_64_TO_64(&ACPI_CAST_PTR(u64, destination)[i],
171 &ACPI_CAST_PTR(u64, source)[i]);
180 /*******************************************************************************
182 * FUNCTION: acpi_rs_set_resource_length
184 * PARAMETERS: total_length - Length of the AML descriptor, including
185 * the header and length fields.
186 * aml - Pointer to the raw AML descriptor
190 * DESCRIPTION: Set the resource_length field of an AML
191 * resource descriptor, both Large and Small descriptors are
192 * supported automatically. Note: Descriptor Type field must
195 ******************************************************************************/
198 acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
199 union aml_resource *aml)
201 acpi_rs_length resource_length;
203 ACPI_FUNCTION_ENTRY();
205 /* Length is the total descriptor length minus the header length */
207 resource_length = (acpi_rs_length)
208 (total_length - acpi_ut_get_resource_header_length(aml));
210 /* Length is stored differently for large and small descriptors */
212 if (aml->small_header.descriptor_type & ACPI_RESOURCE_NAME_LARGE) {
214 /* Large descriptor -- bytes 1-2 contain the 16-bit length */
216 ACPI_MOVE_16_TO_16(&aml->large_header.resource_length,
219 /* Small descriptor -- bits 2:0 of byte 0 contain the length */
221 aml->small_header.descriptor_type = (u8)
223 /* Clear any existing length, preserving descriptor type bits */
225 descriptor_type & ~ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK)
231 /*******************************************************************************
233 * FUNCTION: acpi_rs_set_resource_header
235 * PARAMETERS: descriptor_type - Byte to be inserted as the type
236 * total_length - Length of the AML descriptor, including
237 * the header and length fields.
238 * aml - Pointer to the raw AML descriptor
242 * DESCRIPTION: Set the descriptor_type and resource_length fields of an AML
243 * resource descriptor, both Large and Small descriptors are
244 * supported automatically
246 ******************************************************************************/
249 acpi_rs_set_resource_header(u8 descriptor_type,
250 acpi_rsdesc_size total_length,
251 union aml_resource *aml)
253 ACPI_FUNCTION_ENTRY();
255 /* Set the Resource Type */
257 aml->small_header.descriptor_type = descriptor_type;
259 /* Set the Resource Length */
261 acpi_rs_set_resource_length(total_length, aml);
264 /*******************************************************************************
266 * FUNCTION: acpi_rs_strcpy
268 * PARAMETERS: destination - Pointer to the destination string
269 * source - Pointer to the source string
271 * RETURN: String length, including NULL terminator
273 * DESCRIPTION: Local string copy that returns the string length, saving a
274 * strcpy followed by a strlen.
276 ******************************************************************************/
278 static u16 acpi_rs_strcpy(char *destination, char *source)
282 ACPI_FUNCTION_ENTRY();
284 for (i = 0; source[i]; i++) {
285 destination[i] = source[i];
290 /* Return string length including the NULL terminator */
292 return ((u16) (i + 1));
295 /*******************************************************************************
297 * FUNCTION: acpi_rs_get_resource_source
299 * PARAMETERS: resource_length - Length field of the descriptor
300 * minimum_length - Minimum length of the descriptor (minus
301 * any optional fields)
302 * resource_source - Where the resource_source is returned
303 * aml - Pointer to the raw AML descriptor
304 * string_ptr - (optional) where to store the actual
305 * resource_source string
307 * RETURN: Length of the string plus NULL terminator, rounded up to native
310 * DESCRIPTION: Copy the optional resource_source data from a raw AML descriptor
311 * to an internal resource descriptor
313 ******************************************************************************/
316 acpi_rs_get_resource_source(acpi_rs_length resource_length,
317 acpi_rs_length minimum_length,
318 struct acpi_resource_source * resource_source,
319 union aml_resource * aml, char *string_ptr)
321 acpi_rsdesc_size total_length;
322 u8 *aml_resource_source;
324 ACPI_FUNCTION_ENTRY();
327 resource_length + sizeof(struct aml_resource_large_header);
328 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
331 * resource_source is present if the length of the descriptor is longer than
332 * the minimum length.
334 * Note: Some resource descriptors will have an additional null, so
335 * we add 1 to the minimum length.
337 if (total_length > (acpi_rsdesc_size) (minimum_length + 1)) {
339 /* Get the resource_source_index */
341 resource_source->index = aml_resource_source[0];
343 resource_source->string_ptr = string_ptr;
346 * String destination pointer is not specified; Set the String
347 * pointer to the end of the current resource_source structure.
349 resource_source->string_ptr =
350 ACPI_ADD_PTR(char, resource_source,
351 sizeof(struct acpi_resource_source));
355 * In order for the Resource length to be a multiple of the native
356 * word, calculate the length of the string (+1 for NULL terminator)
357 * and expand to the next word multiple.
359 * Zero the entire area of the buffer.
363 ACPI_STRLEN(ACPI_CAST_PTR(char, &aml_resource_source[1])) +
365 total_length = (u32) ACPI_ROUND_UP_TO_NATIVE_WORD(total_length);
367 ACPI_MEMSET(resource_source->string_ptr, 0, total_length);
369 /* Copy the resource_source string to the destination */
371 resource_source->string_length =
372 acpi_rs_strcpy(resource_source->string_ptr,
374 &aml_resource_source[1]));
376 return ((acpi_rs_length) total_length);
379 /* resource_source is not present */
381 resource_source->index = 0;
382 resource_source->string_length = 0;
383 resource_source->string_ptr = NULL;
387 /*******************************************************************************
389 * FUNCTION: acpi_rs_set_resource_source
391 * PARAMETERS: aml - Pointer to the raw AML descriptor
392 * minimum_length - Minimum length of the descriptor (minus
393 * any optional fields)
394 * resource_source - Internal resource_source
397 * RETURN: Total length of the AML descriptor
399 * DESCRIPTION: Convert an optional resource_source from internal format to a
400 * raw AML resource descriptor
402 ******************************************************************************/
405 acpi_rs_set_resource_source(union aml_resource * aml,
406 acpi_rs_length minimum_length,
407 struct acpi_resource_source * resource_source)
409 u8 *aml_resource_source;
410 acpi_rsdesc_size descriptor_length;
412 ACPI_FUNCTION_ENTRY();
414 descriptor_length = minimum_length;
416 /* Non-zero string length indicates presence of a resource_source */
418 if (resource_source->string_length) {
420 /* Point to the end of the AML descriptor */
422 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
424 /* Copy the resource_source_index */
426 aml_resource_source[0] = (u8) resource_source->index;
428 /* Copy the resource_source string */
430 ACPI_STRCPY(ACPI_CAST_PTR(char, &aml_resource_source[1]),
431 resource_source->string_ptr);
434 * Add the length of the string (+ 1 for null terminator) to the
435 * final descriptor length
438 ((acpi_rsdesc_size) resource_source->string_length + 1);
441 /* Return the new total length of the AML descriptor */
443 return (descriptor_length);
446 /*******************************************************************************
448 * FUNCTION: acpi_rs_get_prt_method_data
450 * PARAMETERS: node - Device node
451 * ret_buffer - Pointer to a buffer structure for the
456 * DESCRIPTION: This function is called to get the _PRT value of an object
457 * contained in an object specified by the handle passed in
459 * If the function fails an appropriate status will be returned
460 * and the contents of the callers buffer is undefined.
462 ******************************************************************************/
465 acpi_rs_get_prt_method_data(struct acpi_namespace_node * node,
466 struct acpi_buffer * ret_buffer)
468 union acpi_operand_object *obj_desc;
471 ACPI_FUNCTION_TRACE(rs_get_prt_method_data);
473 /* Parameters guaranteed valid by caller */
475 /* Execute the method, no parameters */
477 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRT,
478 ACPI_BTYPE_PACKAGE, &obj_desc);
479 if (ACPI_FAILURE(status)) {
480 return_ACPI_STATUS(status);
484 * Create a resource linked list from the byte stream buffer that comes
485 * back from the _CRS method execution.
487 status = acpi_rs_create_pci_routing_table(obj_desc, ret_buffer);
489 /* On exit, we must delete the object returned by evaluate_object */
491 acpi_ut_remove_reference(obj_desc);
492 return_ACPI_STATUS(status);
495 /*******************************************************************************
497 * FUNCTION: acpi_rs_get_crs_method_data
499 * PARAMETERS: node - Device node
500 * ret_buffer - Pointer to a buffer structure for the
505 * DESCRIPTION: This function is called to get the _CRS value of an object
506 * contained in an object specified by the handle passed in
508 * If the function fails an appropriate status will be returned
509 * and the contents of the callers buffer is undefined.
511 ******************************************************************************/
514 acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
515 struct acpi_buffer *ret_buffer)
517 union acpi_operand_object *obj_desc;
520 ACPI_FUNCTION_TRACE(rs_get_crs_method_data);
522 /* Parameters guaranteed valid by caller */
524 /* Execute the method, no parameters */
526 status = acpi_ut_evaluate_object(node, METHOD_NAME__CRS,
527 ACPI_BTYPE_BUFFER, &obj_desc);
528 if (ACPI_FAILURE(status)) {
529 return_ACPI_STATUS(status);
533 * Make the call to create a resource linked list from the
534 * byte stream buffer that comes back from the _CRS method
537 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
539 /* On exit, we must delete the object returned by evaluateObject */
541 acpi_ut_remove_reference(obj_desc);
542 return_ACPI_STATUS(status);
545 /*******************************************************************************
547 * FUNCTION: acpi_rs_get_prs_method_data
549 * PARAMETERS: node - Device node
550 * ret_buffer - Pointer to a buffer structure for the
555 * DESCRIPTION: This function is called to get the _PRS value of an object
556 * contained in an object specified by the handle passed in
558 * If the function fails an appropriate status will be returned
559 * and the contents of the callers buffer is undefined.
561 ******************************************************************************/
563 #ifdef ACPI_FUTURE_USAGE
565 acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
566 struct acpi_buffer *ret_buffer)
568 union acpi_operand_object *obj_desc;
571 ACPI_FUNCTION_TRACE(rs_get_prs_method_data);
573 /* Parameters guaranteed valid by caller */
575 /* Execute the method, no parameters */
577 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRS,
578 ACPI_BTYPE_BUFFER, &obj_desc);
579 if (ACPI_FAILURE(status)) {
580 return_ACPI_STATUS(status);
584 * Make the call to create a resource linked list from the
585 * byte stream buffer that comes back from the _CRS method
588 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
590 /* On exit, we must delete the object returned by evaluateObject */
592 acpi_ut_remove_reference(obj_desc);
593 return_ACPI_STATUS(status);
595 #endif /* ACPI_FUTURE_USAGE */
597 /*******************************************************************************
599 * FUNCTION: acpi_rs_get_aei_method_data
601 * PARAMETERS: node - Device node
602 * ret_buffer - Pointer to a buffer structure for the
607 * DESCRIPTION: This function is called to get the _AEI value of an object
608 * contained in an object specified by the handle passed in
610 * If the function fails an appropriate status will be returned
611 * and the contents of the callers buffer is undefined.
613 ******************************************************************************/
616 acpi_rs_get_aei_method_data(struct acpi_namespace_node *node,
617 struct acpi_buffer *ret_buffer)
619 union acpi_operand_object *obj_desc;
622 ACPI_FUNCTION_TRACE(rs_get_aei_method_data);
624 /* Parameters guaranteed valid by caller */
626 /* Execute the method, no parameters */
628 status = acpi_ut_evaluate_object(node, METHOD_NAME__AEI,
629 ACPI_BTYPE_BUFFER, &obj_desc);
630 if (ACPI_FAILURE(status)) {
631 return_ACPI_STATUS(status);
635 * Make the call to create a resource linked list from the
636 * byte stream buffer that comes back from the _CRS method
639 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
641 /* On exit, we must delete the object returned by evaluateObject */
643 acpi_ut_remove_reference(obj_desc);
644 return_ACPI_STATUS(status);
647 /*******************************************************************************
649 * FUNCTION: acpi_rs_get_method_data
651 * PARAMETERS: handle - Handle to the containing object
652 * path - Path to method, relative to Handle
653 * ret_buffer - Pointer to a buffer structure for the
658 * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
659 * object contained in an object specified by the handle passed in
661 * If the function fails an appropriate status will be returned
662 * and the contents of the callers buffer is undefined.
664 ******************************************************************************/
667 acpi_rs_get_method_data(acpi_handle handle,
668 char *path, struct acpi_buffer *ret_buffer)
670 union acpi_operand_object *obj_desc;
673 ACPI_FUNCTION_TRACE(rs_get_method_data);
675 /* Parameters guaranteed valid by caller */
677 /* Execute the method, no parameters */
680 acpi_ut_evaluate_object(ACPI_CAST_PTR
681 (struct acpi_namespace_node, handle), path,
682 ACPI_BTYPE_BUFFER, &obj_desc);
683 if (ACPI_FAILURE(status)) {
684 return_ACPI_STATUS(status);
688 * Make the call to create a resource linked list from the
689 * byte stream buffer that comes back from the method
692 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
694 /* On exit, we must delete the object returned by evaluate_object */
696 acpi_ut_remove_reference(obj_desc);
697 return_ACPI_STATUS(status);
700 /*******************************************************************************
702 * FUNCTION: acpi_rs_set_srs_method_data
704 * PARAMETERS: node - Device node
705 * in_buffer - Pointer to a buffer structure of the
710 * DESCRIPTION: This function is called to set the _SRS of an object contained
711 * in an object specified by the handle passed in
713 * If the function fails an appropriate status will be returned
714 * and the contents of the callers buffer is undefined.
716 * Note: Parameters guaranteed valid by caller
718 ******************************************************************************/
721 acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
722 struct acpi_buffer *in_buffer)
724 struct acpi_evaluate_info *info;
725 union acpi_operand_object *args[2];
727 struct acpi_buffer buffer;
729 ACPI_FUNCTION_TRACE(rs_set_srs_method_data);
731 /* Allocate and initialize the evaluation information block */
733 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
735 return_ACPI_STATUS(AE_NO_MEMORY);
738 info->prefix_node = node;
739 info->pathname = METHOD_NAME__SRS;
740 info->parameters = args;
741 info->flags = ACPI_IGNORE_RETURN_VALUE;
744 * The in_buffer parameter will point to a linked list of
745 * resource parameters. It needs to be formatted into a
746 * byte stream to be sent in as an input parameter to _SRS
748 * Convert the linked list into a byte stream
750 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
751 status = acpi_rs_create_aml_resources(in_buffer->pointer, &buffer);
752 if (ACPI_FAILURE(status)) {
756 /* Create and initialize the method parameter object */
758 args[0] = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
761 * Must free the buffer allocated above (otherwise it is freed
764 ACPI_FREE(buffer.pointer);
765 status = AE_NO_MEMORY;
769 args[0]->buffer.length = (u32) buffer.length;
770 args[0]->buffer.pointer = buffer.pointer;
771 args[0]->common.flags = AOPOBJ_DATA_VALID;
774 /* Execute the method, no return value is expected */
776 status = acpi_ns_evaluate(info);
778 /* Clean up and return the status from acpi_ns_evaluate */
780 acpi_ut_remove_reference(args[0]);
784 return_ACPI_STATUS(status);