[PATCH] pcmcia: allow for four multifunction subdevices
[firewire-audio.git] / drivers / acpi / resources / rsutils.c
bloba9cbee8e8b44c3a12145c6be17ed36657e9ba1a5
1 /*******************************************************************************
3 * Module Name: rsutils - Utilities for the resource manager
5 ******************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2006, R. Byron Moore
9 * All rights reserved.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
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.
30 * NO WARRANTY
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)
65 acpi_native_uint i;
66 u8 bit_count;
68 ACPI_FUNCTION_ENTRY();
70 /* Decode the mask bits */
72 for (i = 0, bit_count = 0; mask; i++) {
73 if (mask & 0x0001) {
74 list[bit_count] = (u8) i;
75 bit_count++;
78 mask >>= 1;
81 return (bit_count);
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)
99 acpi_native_uint i;
100 u16 mask;
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]);
110 return (mask);
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
122 * RETURN: None
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 ******************************************************************************/
130 void
131 acpi_rs_move_data(void *destination, void *source, u16 item_count, u8 move_type)
133 acpi_native_uint i;
135 ACPI_FUNCTION_ENTRY();
137 /* One move per item */
139 for (i = 0; i < item_count; i++) {
140 switch (move_type) {
142 * For the 8-bit case, we can perform the move all at once
143 * since there are no alignment or endian issues
145 case ACPI_RSC_MOVE8:
146 ACPI_MEMCPY(destination, source, item_count);
147 return;
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]);
157 break;
159 case ACPI_RSC_MOVE32:
160 ACPI_MOVE_32_TO_32(&ACPI_CAST_PTR(u32, destination)[i],
161 &ACPI_CAST_PTR(u32, source)[i]);
162 break;
164 case ACPI_RSC_MOVE64:
165 ACPI_MOVE_64_TO_64(&ACPI_CAST_PTR(u64, destination)[i],
166 &ACPI_CAST_PTR(u64, source)[i]);
167 break;
169 default:
170 return;
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
183 * RETURN: None
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
188 * be valid.
190 ******************************************************************************/
192 void
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,
212 &resource_length);
213 } else {
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 */
219 ((aml->small_header.
220 descriptor_type & ~ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK)
222 | resource_length);
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
235 * RETURN: None
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 ******************************************************************************/
243 void
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)
275 u16 i;
277 ACPI_FUNCTION_ENTRY();
279 for (i = 0; source[i]; i++) {
280 destination[i] = source[i];
283 destination[i] = 0;
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
303 * word boundary
305 * DESCRIPTION: Copy the optional resource_source data from a raw AML descriptor
306 * to an internal resource descriptor
308 ******************************************************************************/
310 acpi_rs_length
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();
321 total_length =
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;
339 if (!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.
356 total_length =
357 (u32)
358 ACPI_STRLEN(ACPI_CAST_PTR(char, &aml_resource_source[1])) +
360 total_length = (u32) ACPI_ROUND_UP_TO_NATIVE_WORD(total_length);
362 ACPI_MEMSET(resource_source->string_ptr, 0, total_length);
364 /* Copy the resource_source string to the destination */
366 resource_source->string_length =
367 acpi_rs_strcpy(resource_source->string_ptr,
368 ACPI_CAST_PTR(char,
369 &aml_resource_source[1]));
371 return ((acpi_rs_length) total_length);
374 /* resource_source is not present */
376 resource_source->index = 0;
377 resource_source->string_length = 0;
378 resource_source->string_ptr = NULL;
379 return (0);
382 /*******************************************************************************
384 * FUNCTION: acpi_rs_set_resource_source
386 * PARAMETERS: Aml - Pointer to the raw AML descriptor
387 * minimum_length - Minimum length of the descriptor (minus
388 * any optional fields)
389 * resource_source - Internal resource_source
392 * RETURN: Total length of the AML descriptor
394 * DESCRIPTION: Convert an optional resource_source from internal format to a
395 * raw AML resource descriptor
397 ******************************************************************************/
399 acpi_rsdesc_size
400 acpi_rs_set_resource_source(union aml_resource * aml,
401 acpi_rs_length minimum_length,
402 struct acpi_resource_source * resource_source)
404 u8 *aml_resource_source;
405 acpi_rsdesc_size descriptor_length;
407 ACPI_FUNCTION_ENTRY();
409 descriptor_length = minimum_length;
411 /* Non-zero string length indicates presence of a resource_source */
413 if (resource_source->string_length) {
415 /* Point to the end of the AML descriptor */
417 aml_resource_source = ACPI_ADD_PTR(u8, aml, minimum_length);
419 /* Copy the resource_source_index */
421 aml_resource_source[0] = (u8) resource_source->index;
423 /* Copy the resource_source string */
425 ACPI_STRCPY(ACPI_CAST_PTR(char, &aml_resource_source[1]),
426 resource_source->string_ptr);
429 * Add the length of the string (+ 1 for null terminator) to the
430 * final descriptor length
432 descriptor_length +=
433 ((acpi_rsdesc_size) resource_source->string_length + 1);
436 /* Return the new total length of the AML descriptor */
438 return (descriptor_length);
441 /*******************************************************************************
443 * FUNCTION: acpi_rs_get_prt_method_data
445 * PARAMETERS: Node - Device node
446 * ret_buffer - Pointer to a buffer structure for the
447 * results
449 * RETURN: Status
451 * DESCRIPTION: This function is called to get the _PRT value of an object
452 * contained in an object specified by the handle passed in
454 * If the function fails an appropriate status will be returned
455 * and the contents of the callers buffer is undefined.
457 ******************************************************************************/
459 acpi_status
460 acpi_rs_get_prt_method_data(struct acpi_namespace_node * node,
461 struct acpi_buffer * ret_buffer)
463 union acpi_operand_object *obj_desc;
464 acpi_status status;
466 ACPI_FUNCTION_TRACE(rs_get_prt_method_data);
468 /* Parameters guaranteed valid by caller */
470 /* Execute the method, no parameters */
472 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRT,
473 ACPI_BTYPE_PACKAGE, &obj_desc);
474 if (ACPI_FAILURE(status)) {
475 return_ACPI_STATUS(status);
479 * Create a resource linked list from the byte stream buffer that comes
480 * back from the _CRS method execution.
482 status = acpi_rs_create_pci_routing_table(obj_desc, ret_buffer);
484 /* On exit, we must delete the object returned by evaluate_object */
486 acpi_ut_remove_reference(obj_desc);
487 return_ACPI_STATUS(status);
490 /*******************************************************************************
492 * FUNCTION: acpi_rs_get_crs_method_data
494 * PARAMETERS: Node - Device node
495 * ret_buffer - Pointer to a buffer structure for the
496 * results
498 * RETURN: Status
500 * DESCRIPTION: This function is called to get the _CRS value of an object
501 * contained in an object specified by the handle passed in
503 * If the function fails an appropriate status will be returned
504 * and the contents of the callers buffer is undefined.
506 ******************************************************************************/
508 acpi_status
509 acpi_rs_get_crs_method_data(struct acpi_namespace_node *node,
510 struct acpi_buffer *ret_buffer)
512 union acpi_operand_object *obj_desc;
513 acpi_status status;
515 ACPI_FUNCTION_TRACE(rs_get_crs_method_data);
517 /* Parameters guaranteed valid by caller */
519 /* Execute the method, no parameters */
521 status = acpi_ut_evaluate_object(node, METHOD_NAME__CRS,
522 ACPI_BTYPE_BUFFER, &obj_desc);
523 if (ACPI_FAILURE(status)) {
524 return_ACPI_STATUS(status);
528 * Make the call to create a resource linked list from the
529 * byte stream buffer that comes back from the _CRS method
530 * execution.
532 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
534 /* On exit, we must delete the object returned by evaluate_object */
536 acpi_ut_remove_reference(obj_desc);
537 return_ACPI_STATUS(status);
540 /*******************************************************************************
542 * FUNCTION: acpi_rs_get_prs_method_data
544 * PARAMETERS: Node - Device node
545 * ret_buffer - Pointer to a buffer structure for the
546 * results
548 * RETURN: Status
550 * DESCRIPTION: This function is called to get the _PRS value of an object
551 * contained in an object specified by the handle passed in
553 * If the function fails an appropriate status will be returned
554 * and the contents of the callers buffer is undefined.
556 ******************************************************************************/
558 #ifdef ACPI_FUTURE_USAGE
559 acpi_status
560 acpi_rs_get_prs_method_data(struct acpi_namespace_node *node,
561 struct acpi_buffer *ret_buffer)
563 union acpi_operand_object *obj_desc;
564 acpi_status status;
566 ACPI_FUNCTION_TRACE(rs_get_prs_method_data);
568 /* Parameters guaranteed valid by caller */
570 /* Execute the method, no parameters */
572 status = acpi_ut_evaluate_object(node, METHOD_NAME__PRS,
573 ACPI_BTYPE_BUFFER, &obj_desc);
574 if (ACPI_FAILURE(status)) {
575 return_ACPI_STATUS(status);
579 * Make the call to create a resource linked list from the
580 * byte stream buffer that comes back from the _CRS method
581 * execution.
583 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
585 /* On exit, we must delete the object returned by evaluate_object */
587 acpi_ut_remove_reference(obj_desc);
588 return_ACPI_STATUS(status);
590 #endif /* ACPI_FUTURE_USAGE */
592 /*******************************************************************************
594 * FUNCTION: acpi_rs_get_method_data
596 * PARAMETERS: Handle - Handle to the containing object
597 * Path - Path to method, relative to Handle
598 * ret_buffer - Pointer to a buffer structure for the
599 * results
601 * RETURN: Status
603 * DESCRIPTION: This function is called to get the _CRS or _PRS value of an
604 * object contained in an object specified by the handle passed in
606 * If the function fails an appropriate status will be returned
607 * and the contents of the callers buffer is undefined.
609 ******************************************************************************/
611 acpi_status
612 acpi_rs_get_method_data(acpi_handle handle,
613 char *path, struct acpi_buffer *ret_buffer)
615 union acpi_operand_object *obj_desc;
616 acpi_status status;
618 ACPI_FUNCTION_TRACE(rs_get_method_data);
620 /* Parameters guaranteed valid by caller */
622 /* Execute the method, no parameters */
624 status =
625 acpi_ut_evaluate_object(handle, path, ACPI_BTYPE_BUFFER, &obj_desc);
626 if (ACPI_FAILURE(status)) {
627 return_ACPI_STATUS(status);
631 * Make the call to create a resource linked list from the
632 * byte stream buffer that comes back from the method
633 * execution.
635 status = acpi_rs_create_resource_list(obj_desc, ret_buffer);
637 /* On exit, we must delete the object returned by evaluate_object */
639 acpi_ut_remove_reference(obj_desc);
640 return_ACPI_STATUS(status);
643 /*******************************************************************************
645 * FUNCTION: acpi_rs_set_srs_method_data
647 * PARAMETERS: Node - Device node
648 * in_buffer - Pointer to a buffer structure of the
649 * parameter
651 * RETURN: Status
653 * DESCRIPTION: This function is called to set the _SRS of an object contained
654 * in an object specified by the handle passed in
656 * If the function fails an appropriate status will be returned
657 * and the contents of the callers buffer is undefined.
659 * Note: Parameters guaranteed valid by caller
661 ******************************************************************************/
663 acpi_status
664 acpi_rs_set_srs_method_data(struct acpi_namespace_node *node,
665 struct acpi_buffer *in_buffer)
667 struct acpi_evaluate_info *info;
668 union acpi_operand_object *args[2];
669 acpi_status status;
670 struct acpi_buffer buffer;
672 ACPI_FUNCTION_TRACE(rs_set_srs_method_data);
674 /* Allocate and initialize the evaluation information block */
676 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
677 if (!info) {
678 return_ACPI_STATUS(AE_NO_MEMORY);
681 info->prefix_node = node;
682 info->pathname = METHOD_NAME__SRS;
683 info->parameters = args;
684 info->parameter_type = ACPI_PARAM_ARGS;
685 info->flags = ACPI_IGNORE_RETURN_VALUE;
688 * The in_buffer parameter will point to a linked list of
689 * resource parameters. It needs to be formatted into a
690 * byte stream to be sent in as an input parameter to _SRS
692 * Convert the linked list into a byte stream
694 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
695 status = acpi_rs_create_aml_resources(in_buffer->pointer, &buffer);
696 if (ACPI_FAILURE(status)) {
697 goto cleanup;
700 /* Create and initialize the method parameter object */
702 args[0] = acpi_ut_create_internal_object(ACPI_TYPE_BUFFER);
703 if (!args[0]) {
705 * Must free the buffer allocated above (otherwise it is freed
706 * later)
708 ACPI_FREE(buffer.pointer);
709 status = AE_NO_MEMORY;
710 goto cleanup;
713 args[0]->buffer.length = (u32) buffer.length;
714 args[0]->buffer.pointer = buffer.pointer;
715 args[0]->common.flags = AOPOBJ_DATA_VALID;
716 args[1] = NULL;
718 /* Execute the method, no return value is expected */
720 status = acpi_ns_evaluate(info);
722 /* Clean up and return the status from acpi_ns_evaluate */
724 acpi_ut_remove_reference(args[0]);
726 cleanup:
727 ACPI_FREE(info);
728 return_ACPI_STATUS(status);