1 /*******************************************************************************
3 * Module Name: rsutils - Utilities for the resource manager
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2006, 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.
44 #include <acpi/acpi.h>
45 #include <acpi/acnamesp.h>
46 #include <acpi/acresrc.h>
48 #define _COMPONENT ACPI_RESOURCES
49 ACPI_MODULE_NAME("rsutils")
51 /*******************************************************************************
53 * FUNCTION: acpi_rs_decode_bitmask
55 * PARAMETERS: Mask - Bitmask to decode
56 * List - Where the converted list is returned
58 * RETURN: Count of bits set (length of list)
60 * DESCRIPTION: Convert a bit mask into a list of values
62 ******************************************************************************/
63 u8 acpi_rs_decode_bitmask(u16 mask, u8 * list)
68 ACPI_FUNCTION_ENTRY();
70 /* Decode the mask bits */
72 for (i = 0, bit_count = 0; mask; i++) {
74 list[bit_count] = (u8) i;
84 /*******************************************************************************
86 * FUNCTION: acpi_rs_encode_bitmask
88 * PARAMETERS: List - List of values to encode
89 * Count - Length of list
91 * RETURN: Encoded bitmask
93 * DESCRIPTION: Convert a list of values to an encoded bitmask
95 ******************************************************************************/
97 u16 acpi_rs_encode_bitmask(u8 * list, u8 count)
102 ACPI_FUNCTION_ENTRY();
104 /* Encode the list into a single bitmask */
106 for (i = 0, mask = 0; i < count; i++) {
107 mask |= (0x0001 << list[i]);
113 /*******************************************************************************
115 * FUNCTION: acpi_rs_move_data
117 * PARAMETERS: Destination - Pointer to the destination descriptor
118 * Source - Pointer to the source descriptor
119 * item_count - How many items to move
120 * move_type - Byte width
124 * DESCRIPTION: Move multiple data items from one descriptor to another. Handles
125 * alignment issues and endian issues if necessary, as configured
126 * via the ACPI_MOVE_* macros. (This is why a memcpy is not used)
128 ******************************************************************************/
131 acpi_rs_move_data(void *destination, void *source, u16 item_count, u8 move_type)
135 ACPI_FUNCTION_ENTRY();
137 /* One move per item */
139 for (i = 0; i < item_count; i++) {
142 * For the 8-bit case, we can perform the move all at once
143 * since there are no alignment or endian issues
146 ACPI_MEMCPY(destination, source, item_count);
150 * 16-, 32-, and 64-bit cases must use the move macros that perform
151 * endian conversion and/or accomodate hardware that cannot perform
152 * misaligned memory transfers
154 case ACPI_RSC_MOVE16:
155 ACPI_MOVE_16_TO_16(&ACPI_CAST_PTR(u16, destination)[i],
156 &ACPI_CAST_PTR(u16, source)[i]);
159 case ACPI_RSC_MOVE32:
160 ACPI_MOVE_32_TO_32(&ACPI_CAST_PTR(u32, destination)[i],
161 &ACPI_CAST_PTR(u32, source)[i]);
164 case ACPI_RSC_MOVE64:
165 ACPI_MOVE_64_TO_64(&ACPI_CAST_PTR(u64, destination)[i],
166 &ACPI_CAST_PTR(u64, source)[i]);
175 /*******************************************************************************
177 * FUNCTION: acpi_rs_set_resource_length
179 * PARAMETERS: total_length - Length of the AML descriptor, including
180 * the header and length fields.
181 * Aml - Pointer to the raw AML descriptor
185 * DESCRIPTION: Set the resource_length field of an AML
186 * resource descriptor, both Large and Small descriptors are
187 * supported automatically. Note: Descriptor Type field must
190 ******************************************************************************/
193 acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
194 union aml_resource *aml)
196 acpi_rs_length resource_length;
198 ACPI_FUNCTION_ENTRY();
200 /* Length is the total descriptor length minus the header length */
202 resource_length = (acpi_rs_length)
203 (total_length - acpi_ut_get_resource_header_length(aml));
205 /* Length is stored differently for large and small descriptors */
207 if (aml->small_header.descriptor_type & ACPI_RESOURCE_NAME_LARGE) {
209 /* Large descriptor -- bytes 1-2 contain the 16-bit length */
211 ACPI_MOVE_16_TO_16(&aml->large_header.resource_length,
214 /* Small descriptor -- bits 2:0 of byte 0 contain the length */
216 aml->small_header.descriptor_type = (u8)
218 /* Clear any existing length, preserving descriptor type bits */
220 descriptor_type & ~ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK)
226 /*******************************************************************************
228 * FUNCTION: acpi_rs_set_resource_header
230 * PARAMETERS: descriptor_type - Byte to be inserted as the type
231 * total_length - Length of the AML descriptor, including
232 * the header and length fields.
233 * Aml - Pointer to the raw AML descriptor
237 * DESCRIPTION: Set the descriptor_type and resource_length fields of an AML
238 * resource descriptor, both Large and Small descriptors are
239 * supported automatically
241 ******************************************************************************/
244 acpi_rs_set_resource_header(u8 descriptor_type,
245 acpi_rsdesc_size total_length,
246 union aml_resource *aml)
248 ACPI_FUNCTION_ENTRY();
250 /* Set the Resource Type */
252 aml->small_header.descriptor_type = descriptor_type;
254 /* Set the Resource Length */
256 acpi_rs_set_resource_length(total_length, aml);
259 /*******************************************************************************
261 * FUNCTION: acpi_rs_strcpy
263 * PARAMETERS: Destination - Pointer to the destination string
264 * Source - Pointer to the source string
266 * RETURN: String length, including NULL terminator
268 * DESCRIPTION: Local string copy that returns the string length, saving a
269 * strcpy followed by a strlen.
271 ******************************************************************************/
273 static u16 acpi_rs_strcpy(char *destination, char *source)
277 ACPI_FUNCTION_ENTRY();
279 for (i = 0; source[i]; i++) {
280 destination[i] = source[i];
285 /* Return string length including the NULL terminator */
287 return ((u16) (i + 1));
290 /*******************************************************************************
292 * FUNCTION: acpi_rs_get_resource_source
294 * PARAMETERS: resource_length - Length field of the descriptor
295 * minimum_length - Minimum length of the descriptor (minus
296 * any optional fields)
297 * resource_source - Where the resource_source is returned
298 * Aml - Pointer to the raw AML descriptor
299 * string_ptr - (optional) where to store the actual
300 * resource_source string
302 * RETURN: Length of the string plus NULL terminator, rounded up to native
305 * DESCRIPTION: Copy the optional resource_source data from a raw AML descriptor
306 * to an internal resource descriptor
308 ******************************************************************************/
311 acpi_rs_get_resource_source(acpi_rs_length resource_length,
312 acpi_rs_length minimum_length,
313 struct acpi_resource_source * resource_source,
314 union aml_resource * aml, char *string_ptr)
316 acpi_rsdesc_size total_length;
317 u8 *aml_resource_source;
319 ACPI_FUNCTION_ENTRY();
322 resource_length + sizeof(struct aml_resource_large_header);
323 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
326 * resource_source is present if the length of the descriptor is longer than
327 * the minimum length.
329 * Note: Some resource descriptors will have an additional null, so
330 * we add 1 to the minimum length.
332 if (total_length > (acpi_rsdesc_size) (minimum_length + 1)) {
334 /* Get the resource_source_index */
336 resource_source->index = aml_resource_source[0];
338 resource_source->string_ptr = string_ptr;
341 * String destination pointer is not specified; Set the String
342 * pointer to the end of the current resource_source structure.
344 resource_source->string_ptr =
345 ACPI_ADD_PTR(char, resource_source,
346 sizeof(struct acpi_resource_source));
350 * In order for the Resource length to be a multiple of the native
351 * word, calculate the length of the string (+1 for NULL terminator)
352 * and expand to the next word multiple.
354 * Zero the entire area of the buffer.
357 ACPI_STRLEN(ACPI_CAST_PTR(char, &aml_resource_source[1])) +
359 total_length = (u32) ACPI_ROUND_UP_TO_NATIVE_WORD(total_length);
361 ACPI_MEMSET(resource_source->string_ptr, 0, total_length);
363 /* Copy the resource_source string to the destination */
365 resource_source->string_length =
366 acpi_rs_strcpy(resource_source->string_ptr,
368 &aml_resource_source[1]));
370 return ((acpi_rs_length) total_length);
373 /* resource_source is not present */
375 resource_source->index = 0;
376 resource_source->string_length = 0;
377 resource_source->string_ptr = NULL;
381 /*******************************************************************************
383 * FUNCTION: acpi_rs_set_resource_source
385 * PARAMETERS: Aml - Pointer to the raw AML descriptor
386 * minimum_length - Minimum length of the descriptor (minus
387 * any optional fields)
388 * resource_source - Internal resource_source
391 * RETURN: Total length of the AML descriptor
393 * DESCRIPTION: Convert an optional resource_source from internal format to a
394 * raw AML resource descriptor
396 ******************************************************************************/
399 acpi_rs_set_resource_source(union aml_resource * aml,
400 acpi_rs_length minimum_length,
401 struct acpi_resource_source * resource_source)
403 u8 *aml_resource_source;
404 acpi_rsdesc_size descriptor_length;
406 ACPI_FUNCTION_ENTRY();
408 descriptor_length = minimum_length;
410 /* Non-zero string length indicates presence of a resource_source */
412 if (resource_source->string_length) {
414 /* Point to the end of the AML descriptor */
416 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
418 /* Copy the resource_source_index */
420 aml_resource_source[0] = (u8) resource_source->index;
422 /* Copy the resource_source string */
424 ACPI_STRCPY(ACPI_CAST_PTR(char, &aml_resource_source[1]),
425 resource_source->string_ptr);
428 * Add the length of the string (+ 1 for null terminator) to the
429 * final descriptor length
432 ((acpi_rsdesc_size) resource_source->string_length + 1);
435 /* Return the new total length of the AML descriptor */
437 return (descriptor_length);
440 /*******************************************************************************
442 * FUNCTION: acpi_rs_get_prt_method_data
444 * PARAMETERS: Handle - Handle to the containing object
445 * ret_buffer - Pointer to a buffer structure for the
450 * DESCRIPTION: This function is called to get the _PRT value of an object
451 * contained in an object specified by the handle passed in
453 * If the function fails an appropriate status will be returned
454 * and the contents of the callers buffer is undefined.
456 ******************************************************************************/
459 acpi_rs_get_prt_method_data(acpi_handle handle, struct acpi_buffer * ret_buffer)
461 union acpi_operand_object *obj_desc;
464 ACPI_FUNCTION_TRACE("rs_get_prt_method_data");
466 /* Parameters guaranteed valid by caller */
468 /* Execute the method, no parameters */
470 status = acpi_ut_evaluate_object(handle, METHOD_NAME__PRT,
471 ACPI_BTYPE_PACKAGE, &obj_desc);
472 if (ACPI_FAILURE(status)) {
473 return_ACPI_STATUS(status);
477 * Create a resource linked list from the byte stream buffer that comes
478 * back from the _CRS method execution.
480 status = acpi_rs_create_pci_routing_table(obj_desc, ret_buffer);
482 /* On exit, we must delete the object returned by evaluate_object */
484 acpi_ut_remove_reference(obj_desc);
485 return_ACPI_STATUS(status);
488 /*******************************************************************************
490 * FUNCTION: acpi_rs_get_crs_method_data
492 * PARAMETERS: Handle - Handle to the containing object
493 * ret_buffer - Pointer to a buffer structure for the
498 * DESCRIPTION: This function is called to get the _CRS value of an object
499 * contained in an object specified by the handle passed in
501 * If the function fails an appropriate status will be returned
502 * and the contents of the callers buffer is undefined.
504 ******************************************************************************/
507 acpi_rs_get_crs_method_data(acpi_handle handle, struct acpi_buffer *ret_buffer)
509 union acpi_operand_object *obj_desc;
512 ACPI_FUNCTION_TRACE("rs_get_crs_method_data");
514 /* Parameters guaranteed valid by caller */
516 /* Execute the method, no parameters */
518 status = acpi_ut_evaluate_object(handle, METHOD_NAME__CRS,
519 ACPI_BTYPE_BUFFER, &obj_desc);
520 if (ACPI_FAILURE(status)) {
521 return_ACPI_STATUS(status);
525 * Make the call to create a resource linked list from the
526 * byte stream buffer that comes back from the _CRS method
529 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
531 /* on exit, we must delete the object returned by evaluate_object */
533 acpi_ut_remove_reference(obj_desc);
534 return_ACPI_STATUS(status);
537 /*******************************************************************************
539 * FUNCTION: acpi_rs_get_prs_method_data
541 * PARAMETERS: Handle - Handle to the containing object
542 * ret_buffer - Pointer to a buffer structure for the
547 * DESCRIPTION: This function is called to get the _PRS value of an object
548 * contained in an object specified by the handle passed in
550 * If the function fails an appropriate status will be returned
551 * and the contents of the callers buffer is undefined.
553 ******************************************************************************/
555 #ifdef ACPI_FUTURE_USAGE
557 acpi_rs_get_prs_method_data(acpi_handle handle, struct acpi_buffer *ret_buffer)
559 union acpi_operand_object *obj_desc;
562 ACPI_FUNCTION_TRACE("rs_get_prs_method_data");
564 /* Parameters guaranteed valid by caller */
566 /* Execute the method, no parameters */
568 status = acpi_ut_evaluate_object(handle, METHOD_NAME__PRS,
569 ACPI_BTYPE_BUFFER, &obj_desc);
570 if (ACPI_FAILURE(status)) {
571 return_ACPI_STATUS(status);
575 * Make the call to create a resource linked list from the
576 * byte stream buffer that comes back from the _CRS method
579 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
581 /* on exit, we must delete the object returned by evaluate_object */
583 acpi_ut_remove_reference(obj_desc);
584 return_ACPI_STATUS(status);
586 #endif /* ACPI_FUTURE_USAGE */
588 /*******************************************************************************
590 * FUNCTION: acpi_rs_get_method_data
592 * PARAMETERS: Handle - Handle to the containing object
593 * Path - Path to method, relative to Handle
594 * ret_buffer - Pointer to a buffer structure for the
599 * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
600 * object contained in an object specified by the handle passed in
602 * If the function fails an appropriate status will be returned
603 * and the contents of the callers buffer is undefined.
605 ******************************************************************************/
608 acpi_rs_get_method_data(acpi_handle handle,
609 char *path, struct acpi_buffer *ret_buffer)
611 union acpi_operand_object *obj_desc;
614 ACPI_FUNCTION_TRACE("rs_get_method_data");
616 /* Parameters guaranteed valid by caller */
618 /* Execute the method, no parameters */
621 acpi_ut_evaluate_object(handle, path, ACPI_BTYPE_BUFFER, &obj_desc);
622 if (ACPI_FAILURE(status)) {
623 return_ACPI_STATUS(status);
627 * Make the call to create a resource linked list from the
628 * byte stream buffer that comes back from the method
631 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
633 /* On exit, we must delete the object returned by evaluate_object */
635 acpi_ut_remove_reference(obj_desc);
636 return_ACPI_STATUS(status);
639 /*******************************************************************************
641 * FUNCTION: acpi_rs_set_srs_method_data
643 * PARAMETERS: Handle - Handle to the containing object
644 * in_buffer - Pointer to a buffer structure of the
649 * DESCRIPTION: This function is called to set the _SRS of an object contained
650 * in an object specified by the handle passed in
652 * If the function fails an appropriate status will be returned
653 * and the contents of the callers buffer is undefined.
655 ******************************************************************************/
658 acpi_rs_set_srs_method_data(acpi_handle handle, struct acpi_buffer *in_buffer)
660 struct acpi_parameter_info info;
661 union acpi_operand_object *params[2];
663 struct acpi_buffer buffer;
665 ACPI_FUNCTION_TRACE("rs_set_srs_method_data");
667 /* Parameters guaranteed valid by caller */
670 * The in_buffer parameter will point to a linked list of
671 * resource parameters. It needs to be formatted into a
672 * byte stream to be sent in as an input parameter to _SRS
674 * Convert the linked list into a byte stream
676 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
677 status = acpi_rs_create_aml_resources(in_buffer->pointer, &buffer);
678 if (ACPI_FAILURE(status)) {
679 return_ACPI_STATUS(status);
682 /* Init the param object */
684 params[0] = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
686 acpi_os_free(buffer.pointer);
687 return_ACPI_STATUS(AE_NO_MEMORY);
690 /* Set up the parameter object */
692 params[0]->buffer.length = (u32) buffer.length;
693 params[0]->buffer.pointer = buffer.pointer;
694 params[0]->common.flags = AOPOBJ_DATA_VALID;
698 info.parameters = params;
699 info.parameter_type = ACPI_PARAM_ARGS;
701 /* Execute the method, no return value */
703 status = acpi_ns_evaluate_relative(METHOD_NAME__SRS, &info);
704 if (ACPI_SUCCESS(status)) {
706 /* Delete any return object (especially if implicit_return is enabled) */
708 if (info.return_object) {
709 acpi_ut_remove_reference(info.return_object);
713 /* Clean up and return the status from acpi_ns_evaluate_relative */
715 acpi_ut_remove_reference(params[0]);
716 return_ACPI_STATUS(status);