1 /*******************************************************************************
3 * Module Name: rsutils - Utilities for the resource manager
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2008, 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 ACPI_MEMCPY(destination, source, item_count);
151 * 16-, 32-, and 64-bit cases must use the move macros that perform
152 * endian conversion and/or accomodate hardware that cannot perform
153 * misaligned memory transfers
155 case ACPI_RSC_MOVE16:
156 ACPI_MOVE_16_TO_16(&ACPI_CAST_PTR(u16, destination)[i],
157 &ACPI_CAST_PTR(u16, source)[i]);
160 case ACPI_RSC_MOVE32:
161 ACPI_MOVE_32_TO_32(&ACPI_CAST_PTR(u32, destination)[i],
162 &ACPI_CAST_PTR(u32, source)[i]);
165 case ACPI_RSC_MOVE64:
166 ACPI_MOVE_64_TO_64(&ACPI_CAST_PTR(u64, destination)[i],
167 &ACPI_CAST_PTR(u64, source)[i]);
176 /*******************************************************************************
178 * FUNCTION: acpi_rs_set_resource_length
180 * PARAMETERS: total_length - Length of the AML descriptor, including
181 * the header and length fields.
182 * Aml - Pointer to the raw AML descriptor
186 * DESCRIPTION: Set the resource_length field of an AML
187 * resource descriptor, both Large and Small descriptors are
188 * supported automatically. Note: Descriptor Type field must
191 ******************************************************************************/
194 acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
195 union aml_resource *aml)
197 acpi_rs_length resource_length;
199 ACPI_FUNCTION_ENTRY();
201 /* Length is the total descriptor length minus the header length */
203 resource_length = (acpi_rs_length)
204 (total_length - acpi_ut_get_resource_header_length(aml));
206 /* Length is stored differently for large and small descriptors */
208 if (aml->small_header.descriptor_type & ACPI_RESOURCE_NAME_LARGE) {
210 /* Large descriptor -- bytes 1-2 contain the 16-bit length */
212 ACPI_MOVE_16_TO_16(&aml->large_header.resource_length,
215 /* Small descriptor -- bits 2:0 of byte 0 contain the length */
217 aml->small_header.descriptor_type = (u8)
219 /* Clear any existing length, preserving descriptor type bits */
221 descriptor_type & ~ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK)
227 /*******************************************************************************
229 * FUNCTION: acpi_rs_set_resource_header
231 * PARAMETERS: descriptor_type - Byte to be inserted as the type
232 * total_length - Length of the AML descriptor, including
233 * the header and length fields.
234 * Aml - Pointer to the raw AML descriptor
238 * DESCRIPTION: Set the descriptor_type and resource_length fields of an AML
239 * resource descriptor, both Large and Small descriptors are
240 * supported automatically
242 ******************************************************************************/
245 acpi_rs_set_resource_header(u8 descriptor_type,
246 acpi_rsdesc_size total_length,
247 union aml_resource *aml)
249 ACPI_FUNCTION_ENTRY();
251 /* Set the Resource Type */
253 aml->small_header.descriptor_type = descriptor_type;
255 /* Set the Resource Length */
257 acpi_rs_set_resource_length(total_length, aml);
260 /*******************************************************************************
262 * FUNCTION: acpi_rs_strcpy
264 * PARAMETERS: Destination - Pointer to the destination string
265 * Source - Pointer to the source string
267 * RETURN: String length, including NULL terminator
269 * DESCRIPTION: Local string copy that returns the string length, saving a
270 * strcpy followed by a strlen.
272 ******************************************************************************/
274 static u16 acpi_rs_strcpy(char *destination, char *source)
278 ACPI_FUNCTION_ENTRY();
280 for (i = 0; source[i]; i++) {
281 destination[i] = source[i];
286 /* Return string length including the NULL terminator */
288 return ((u16) (i + 1));
291 /*******************************************************************************
293 * FUNCTION: acpi_rs_get_resource_source
295 * PARAMETERS: resource_length - Length field of the descriptor
296 * minimum_length - Minimum length of the descriptor (minus
297 * any optional fields)
298 * resource_source - Where the resource_source is returned
299 * Aml - Pointer to the raw AML descriptor
300 * string_ptr - (optional) where to store the actual
301 * resource_source string
303 * RETURN: Length of the string plus NULL terminator, rounded up to native
306 * DESCRIPTION: Copy the optional resource_source data from a raw AML descriptor
307 * to an internal resource descriptor
309 ******************************************************************************/
312 acpi_rs_get_resource_source(acpi_rs_length resource_length,
313 acpi_rs_length minimum_length,
314 struct acpi_resource_source * resource_source,
315 union aml_resource * aml, char *string_ptr)
317 acpi_rsdesc_size total_length;
318 u8 *aml_resource_source;
320 ACPI_FUNCTION_ENTRY();
323 resource_length + sizeof(struct aml_resource_large_header);
324 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
327 * resource_source is present if the length of the descriptor is longer than
328 * the minimum length.
330 * Note: Some resource descriptors will have an additional null, so
331 * we add 1 to the minimum length.
333 if (total_length > (acpi_rsdesc_size) (minimum_length + 1)) {
335 /* Get the resource_source_index */
337 resource_source->index = aml_resource_source[0];
339 resource_source->string_ptr = string_ptr;
342 * String destination pointer is not specified; Set the String
343 * pointer to the end of the current resource_source structure.
345 resource_source->string_ptr =
346 ACPI_ADD_PTR(char, resource_source,
347 sizeof(struct acpi_resource_source));
351 * In order for the Resource length to be a multiple of the native
352 * word, calculate the length of the string (+1 for NULL terminator)
353 * and expand to the next word multiple.
355 * Zero the entire area of the buffer.
358 ACPI_STRLEN(ACPI_CAST_PTR(char, &aml_resource_source[1])) + 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: Node - Device node
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(struct acpi_namespace_node * node,
460 struct acpi_buffer * ret_buffer)
462 union acpi_operand_object *obj_desc;
465 ACPI_FUNCTION_TRACE(rs_get_prt_method_data);
467 /* Parameters guaranteed valid by caller */
469 /* Execute the method, no parameters */
471 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRT,
472 ACPI_BTYPE_PACKAGE, &obj_desc);
473 if (ACPI_FAILURE(status)) {
474 return_ACPI_STATUS(status);
478 * Create a resource linked list from the byte stream buffer that comes
479 * back from the _CRS method execution.
481 status = acpi_rs_create_pci_routing_table(obj_desc, ret_buffer);
483 /* On exit, we must delete the object returned by evaluate_object */
485 acpi_ut_remove_reference(obj_desc);
486 return_ACPI_STATUS(status);
489 /*******************************************************************************
491 * FUNCTION: acpi_rs_get_crs_method_data
493 * PARAMETERS: Node - Device node
494 * ret_buffer - Pointer to a buffer structure for the
499 * DESCRIPTION: This function is called to get the _CRS value of an object
500 * contained in an object specified by the handle passed in
502 * If the function fails an appropriate status will be returned
503 * and the contents of the callers buffer is undefined.
505 ******************************************************************************/
508 acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
509 struct acpi_buffer *ret_buffer)
511 union acpi_operand_object *obj_desc;
514 ACPI_FUNCTION_TRACE(rs_get_crs_method_data);
516 /* Parameters guaranteed valid by caller */
518 /* Execute the method, no parameters */
520 status = acpi_ut_evaluate_object(node, METHOD_NAME__CRS,
521 ACPI_BTYPE_BUFFER, &obj_desc);
522 if (ACPI_FAILURE(status)) {
523 return_ACPI_STATUS(status);
527 * Make the call to create a resource linked list from the
528 * byte stream buffer that comes back from the _CRS method
531 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
533 /* On exit, we must delete the object returned by evaluate_object */
535 acpi_ut_remove_reference(obj_desc);
536 return_ACPI_STATUS(status);
539 /*******************************************************************************
541 * FUNCTION: acpi_rs_get_prs_method_data
543 * PARAMETERS: Node - Device node
544 * ret_buffer - Pointer to a buffer structure for the
549 * DESCRIPTION: This function is called to get the _PRS value of an object
550 * contained in an object specified by the handle passed in
552 * If the function fails an appropriate status will be returned
553 * and the contents of the callers buffer is undefined.
555 ******************************************************************************/
557 #ifdef ACPI_FUTURE_USAGE
559 acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
560 struct acpi_buffer *ret_buffer)
562 union acpi_operand_object *obj_desc;
565 ACPI_FUNCTION_TRACE(rs_get_prs_method_data);
567 /* Parameters guaranteed valid by caller */
569 /* Execute the method, no parameters */
571 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRS,
572 ACPI_BTYPE_BUFFER, &obj_desc);
573 if (ACPI_FAILURE(status)) {
574 return_ACPI_STATUS(status);
578 * Make the call to create a resource linked list from the
579 * byte stream buffer that comes back from the _CRS method
582 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
584 /* On exit, we must delete the object returned by evaluate_object */
586 acpi_ut_remove_reference(obj_desc);
587 return_ACPI_STATUS(status);
589 #endif /* ACPI_FUTURE_USAGE */
591 /*******************************************************************************
593 * FUNCTION: acpi_rs_get_method_data
595 * PARAMETERS: Handle - Handle to the containing object
596 * Path - Path to method, relative to Handle
597 * ret_buffer - Pointer to a buffer structure for the
602 * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
603 * object contained in an object specified by the handle passed in
605 * If the function fails an appropriate status will be returned
606 * and the contents of the callers buffer is undefined.
608 ******************************************************************************/
611 acpi_rs_get_method_data(acpi_handle handle,
612 char *path, struct acpi_buffer *ret_buffer)
614 union acpi_operand_object *obj_desc;
617 ACPI_FUNCTION_TRACE(rs_get_method_data);
619 /* Parameters guaranteed valid by caller */
621 /* Execute the method, no parameters */
624 acpi_ut_evaluate_object(handle, path, ACPI_BTYPE_BUFFER, &obj_desc);
625 if (ACPI_FAILURE(status)) {
626 return_ACPI_STATUS(status);
630 * Make the call to create a resource linked list from the
631 * byte stream buffer that comes back from the method
634 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
636 /* On exit, we must delete the object returned by evaluate_object */
638 acpi_ut_remove_reference(obj_desc);
639 return_ACPI_STATUS(status);
642 /*******************************************************************************
644 * FUNCTION: acpi_rs_set_srs_method_data
646 * PARAMETERS: Node - Device node
647 * in_buffer - Pointer to a buffer structure of the
652 * DESCRIPTION: This function is called to set the _SRS of an object contained
653 * in an object specified by the handle passed in
655 * If the function fails an appropriate status will be returned
656 * and the contents of the callers buffer is undefined.
658 * Note: Parameters guaranteed valid by caller
660 ******************************************************************************/
663 acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
664 struct acpi_buffer *in_buffer)
666 struct acpi_evaluate_info *info;
667 union acpi_operand_object *args[2];
669 struct acpi_buffer buffer;
671 ACPI_FUNCTION_TRACE(rs_set_srs_method_data);
673 /* Allocate and initialize the evaluation information block */
675 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
677 return_ACPI_STATUS(AE_NO_MEMORY);
680 info->prefix_node = node;
681 info->pathname = METHOD_NAME__SRS;
682 info->parameters = args;
683 info->flags = ACPI_IGNORE_RETURN_VALUE;
686 * The in_buffer parameter will point to a linked list of
687 * resource parameters. It needs to be formatted into a
688 * byte stream to be sent in as an input parameter to _SRS
690 * Convert the linked list into a byte stream
692 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
693 status = acpi_rs_create_aml_resources(in_buffer->pointer, &buffer);
694 if (ACPI_FAILURE(status)) {
698 /* Create and initialize the method parameter object */
700 args[0] = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
703 * Must free the buffer allocated above (otherwise it is freed
706 ACPI_FREE(buffer.pointer);
707 status = AE_NO_MEMORY;
711 args[0]->buffer.length = (u32) buffer.length;
712 args[0]->buffer.pointer = buffer.pointer;
713 args[0]->common.flags = AOPOBJ_DATA_VALID;
716 /* Execute the method, no return value is expected */
718 status = acpi_ns_evaluate(info);
720 /* Clean up and return the status from acpi_ns_evaluate */
722 acpi_ut_remove_reference(args[0]);
726 return_ACPI_STATUS(status);