?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
[ACPI] ACPICA 20051021
[linux-2.6/cjktty.git] / drivers / acpi / resources / rscalc.c
blobc29d3a447278c2ab59e6d00a103cb76f4c46278e
1 /*******************************************************************************
2 *
3 * Module Name: rscalc - Calculate stream and list lengths
4 *
5 ******************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2005, R. Byron Moore
9 * All rights reserved.
10 *
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.
25 *
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.
29 *
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.
42 */
43
44 #include <acpi/acpi.h>
45 #include <acpi/acresrc.h>
46 #include <acpi/amlcode.h>
47 #include <acpi/acnamesp.h>
48
49 #define _COMPONENT ACPI_RESOURCES
50 ACPI_MODULE_NAME("rscalc")
51
52 /* Local prototypes */
53 static u8 acpi_rs_count_set_bits(u16 bit_field);
54
55 static acpi_rs_length
56 acpi_rs_struct_option_length(struct acpi_resource_source *resource_source);
57
58 static u32
59 acpi_rs_stream_option_length(u32 resource_length, u32 minimum_total_length);
60
61 /*******************************************************************************
62 *
63 * FUNCTION: acpi_rs_count_set_bits
64 *
65 * PARAMETERS: bit_field - Field in which to count bits
66 *
67 * RETURN: Number of bits set within the field
68 *
69 * DESCRIPTION: Count the number of bits set in a resource field. Used for
70 * (Short descriptor) interrupt and DMA lists.
71 *
72 ******************************************************************************/
73
74 static u8 acpi_rs_count_set_bits(u16 bit_field)
75 {
76 u8 bits_set;
77
78 ACPI_FUNCTION_ENTRY();
79
80 for (bits_set = 0; bit_field; bits_set++) {
81 /* Zero the least significant bit that is set */
82
83 bit_field &= (bit_field - 1);
84 }
85
86 return (bits_set);
87 }
88
89 /*******************************************************************************
90 *
91 * FUNCTION: acpi_rs_struct_option_length
92 *
93 * PARAMETERS: resource_source - Pointer to optional descriptor field
94 *
95 * RETURN: Status
96 *
97 * DESCRIPTION: Common code to handle optional resource_source_index and
98 * resource_source fields in some Large descriptors. Used during
99 * list-to-stream conversion
100 *
101 ******************************************************************************/
102
103 static acpi_rs_length
104 acpi_rs_struct_option_length(struct acpi_resource_source *resource_source)
105 {
106 ACPI_FUNCTION_ENTRY();
107
108 /*
109 * If the resource_source string is valid, return the size of the string
110 * (string_length includes the NULL terminator) plus the size of the
111 * resource_source_index (1).
112 */
113 if (resource_source->string_ptr) {
114 return ((acpi_rs_length) (resource_source->string_length + 1));
115 }
116
117 return (0);
118 }
119
120 /*******************************************************************************
121 *
122 * FUNCTION: acpi_rs_stream_option_length
123 *
124 * PARAMETERS: resource_length - Length from the resource header
125 * minimum_total_length - Minimum length of this resource, before
126 * any optional fields. Includes header size
127 *
128 * RETURN: Length of optional string (0 if no string present)
129 *
130 * DESCRIPTION: Common code to handle optional resource_source_index and
131 * resource_source fields in some Large descriptors. Used during
132 * stream-to-list conversion
133 *
134 ******************************************************************************/
135
136 static u32
137 acpi_rs_stream_option_length(u32 resource_length,
138 u32 minimum_aml_resource_length)
139 {
140 u32 string_length = 0;
141
142 ACPI_FUNCTION_ENTRY();
143
144 /*
145 * The resource_source_index and resource_source are optional elements of some
146 * Large-type resource descriptors.
147 */
148
149 /*
150 * If the length of the actual resource descriptor is greater than the ACPI
151 * spec-defined minimum length, it means that a resource_source_index exists
152 * and is followed by a (required) null terminated string. The string length
153 * (including the null terminator) is the resource length minus the minimum
154 * length, minus one byte for the resource_source_index itself.
155 */
156 if (resource_length > minimum_aml_resource_length) {
157 /* Compute the length of the optional string */
158
159 string_length =
160 resource_length - minimum_aml_resource_length - 1;
161 }
162
163 /* Round up length to 32 bits for internal structure alignment */
164
165 return (ACPI_ROUND_UP_to_32_bITS(string_length));
166 }
167
168 /*******************************************************************************
169 *
170 * FUNCTION: acpi_rs_get_aml_length
171 *
172 * PARAMETERS: Resource - Pointer to the resource linked list
173 * size_needed - Where the required size is returned
174 *
175 * RETURN: Status
176 *
177 * DESCRIPTION: Takes a linked list of internal resource descriptors and
178 * calculates the size buffer needed to hold the corresponding
179 * external resource byte stream.
180 *
181 ******************************************************************************/
182
183 acpi_status
184 acpi_rs_get_aml_length(struct acpi_resource * resource, acpi_size * size_needed)
185 {
186 acpi_size aml_size_needed = 0;
187 acpi_rs_length total_size;
188
189 ACPI_FUNCTION_TRACE("rs_get_aml_length");
190
191 /* Traverse entire list of internal resource descriptors */
192
193 while (resource) {
194 /* Validate the descriptor type */
195
196 if (resource->type > ACPI_RESOURCE_TYPE_MAX) {
197 return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
198 }
199
200 /* Get the base size of the (external stream) resource descriptor */
201
202 total_size = acpi_gbl_aml_resource_sizes[resource->type];
203
204 /*
205 * Augment the base size for descriptors with optional and/or
206 * variable-length fields
207 */
208 switch (resource->type) {
209 case ACPI_RESOURCE_TYPE_VENDOR:
210 /*
211 * Vendor Defined Resource:
212 * For a Vendor Specific resource, if the Length is between 1 and 7
213 * it will be created as a Small Resource data type, otherwise it
214 * is a Large Resource data type.
215 */
216 if (resource->data.vendor.byte_length > 7) {
217 /* Base size of a Large resource descriptor */
218
219 total_size =
220 sizeof(struct aml_resource_large_header);
221 }
222
223 /* Add the size of the vendor-specific data */
224
225 total_size = (acpi_rs_length)
226 (total_size + resource->data.vendor.byte_length);
227 break;
228
229 case ACPI_RESOURCE_TYPE_END_TAG:
230 /*
231 * End Tag:
232 * We are done -- return the accumulated total size.
233 */
234 *size_needed = aml_size_needed + total_size;
235
236 /* Normal exit */
237
238 return_ACPI_STATUS(AE_OK);
239
240 case ACPI_RESOURCE_TYPE_ADDRESS16:
241 /*
242 * 16-Bit Address Resource:
243 * Add the size of the optional resource_source info
244 */
245 total_size = (acpi_rs_length)
246 (total_size +
247 acpi_rs_struct_option_length(&resource->data.
248 address16.
249 resource_source));
250 break;
251
252 case ACPI_RESOURCE_TYPE_ADDRESS32:
253 /*
254 * 32-Bit Address Resource:
255 * Add the size of the optional resource_source info
256 */
257 total_size = (acpi_rs_length)
258 (total_size +
259 acpi_rs_struct_option_length(&resource->data.
260 address32.
261 resource_source));
262 break;
263
264 case ACPI_RESOURCE_TYPE_ADDRESS64:
265 /*
266 * 64-Bit Address Resource:
267 * Add the size of the optional resource_source info
268 */
269 total_size = (acpi_rs_length)
270 (total_size +
271 acpi_rs_struct_option_length(&resource->data.
272 address64.
273 resource_source));
274 break;
275
276 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
277 /*
278 * Extended IRQ Resource:
279 * Add the size of each additional optional interrupt beyond the
280 * required 1 (4 bytes for each u32 interrupt number)
281 */
282 total_size = (acpi_rs_length)
283 (total_size +
284 ((resource->data.extended_irq.interrupt_count -
285 1) * 4) +
286 /* Add the size of the optional resource_source info */
287 acpi_rs_struct_option_length(&resource->data.
288 extended_irq.
289 resource_source));
290 break;
291
292 default:
293 break;
294 }
295
296 /* Update the total */
297
298 aml_size_needed += total_size;
299
300 /* Point to the next object */
301
302 resource = ACPI_PTR_ADD(struct acpi_resource,
303 resource, resource->length);
304 }
305
306 /* Did not find an END_TAG descriptor */
307
308 return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
309 }
310
311 /*******************************************************************************
312 *
313 * FUNCTION: acpi_rs_get_list_length
314 *
315 * PARAMETERS: aml_buffer - Pointer to the resource byte stream
316 * aml_buffer_length - Size of aml_buffer
317 * size_needed - Where the size needed is returned
318 *
319 * RETURN: Status
320 *
321 * DESCRIPTION: Takes an external resource byte stream and calculates the size
322 * buffer needed to hold the corresponding internal resource
323 * descriptor linked list.
324 *
325 ******************************************************************************/
326
327 acpi_status
328 acpi_rs_get_list_length(u8 * aml_buffer,
329 u32 aml_buffer_length, acpi_size * size_needed)
330 {
331 u8 *buffer;
332 struct acpi_resource_info *resource_info;
333 u32 buffer_size = 0;
334 u32 bytes_parsed = 0;
335 u8 resource_type;
336 u16 temp16;
337 u16 resource_length;
338 u16 header_length;
339 u32 extra_struct_bytes;
340
341 ACPI_FUNCTION_TRACE("rs_get_list_length");
342
343 while (bytes_parsed < aml_buffer_length) {
344 /* The next byte in the stream is the resource descriptor type */
345
346 resource_type = acpi_ut_get_resource_type(aml_buffer);
347
348 /* Get the base stream size and structure sizes for the descriptor */
349
350 resource_info = acpi_rs_get_resource_info(resource_type);
351 if (!resource_info) {
352 return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
353 }
354
355 /* Get the Length field from the input resource descriptor */
356
357 resource_length = acpi_ut_get_resource_length(aml_buffer);
358
359 /* Augment the size for descriptors with optional fields */
360
361 extra_struct_bytes = 0;
362
363 if (!(resource_type & ACPI_RESOURCE_NAME_LARGE)) {
364 /*
365 * Small resource descriptors
366 */
367 header_length =
368 sizeof(struct aml_resource_small_header);
369 buffer = aml_buffer + header_length;
370
371 switch (resource_type) {
372 case ACPI_RESOURCE_NAME_IRQ:
373 /*
374 * IRQ Resource:
375 * Get the number of bits set in the IRQ word
376 */
377 ACPI_MOVE_16_TO_16(&temp16, buffer);
378 extra_struct_bytes =
379 (acpi_rs_count_set_bits(temp16) *
380 sizeof(u32));
381 break;
382
383 case ACPI_RESOURCE_NAME_DMA:
384 /*
385 * DMA Resource:
386 * Get the number of bits set in the DMA channels byte
387 */
388 ACPI_MOVE_16_TO_16(&temp16, buffer);
389 extra_struct_bytes =
390 (acpi_rs_count_set_bits(temp16) *
391 sizeof(u32));
392 break;
393
394 case ACPI_RESOURCE_NAME_VENDOR_SMALL:
395 /*
396 * Vendor Specific Resource:
397 * Ensure a 32-bit boundary for the structure
398 */
399 extra_struct_bytes =
400 ACPI_ROUND_UP_to_32_bITS(resource_length);
401 break;
402
403 case ACPI_RESOURCE_NAME_END_TAG:
404 /*
405 * End Tag:
406 * Terminate the loop now
407 */
408 aml_buffer_length = bytes_parsed;
409 break;
410
411 default:
412 break;
413 }
414 } else {
415 /*
416 * Large resource descriptors
417 */
418 header_length =
419 sizeof(struct aml_resource_large_header);
420 buffer = aml_buffer + header_length;
421
422 switch (resource_type) {
423 case ACPI_RESOURCE_NAME_VENDOR_LARGE:
424 /*
425 * Vendor Defined Resource:
426 * Add vendor data and ensure a 32-bit boundary for the structure
427 */
428 extra_struct_bytes =
429 ACPI_ROUND_UP_to_32_bITS(resource_length);
430 break;
431
432 case ACPI_RESOURCE_NAME_ADDRESS32:
433 case ACPI_RESOURCE_NAME_ADDRESS16:
434 /*
435 * 32-Bit or 16-bit Address Resource:
436 * Add the size of any optional data (resource_source)
437 */
438 extra_struct_bytes =
439 acpi_rs_stream_option_length
440 (resource_length,
441 resource_info->
442 minimum_aml_resource_length);
443 break;
444
445 case ACPI_RESOURCE_NAME_EXTENDED_IRQ:
446 /*
447 * Extended IRQ:
448 * Point past the interrupt_vector_flags to get the
449 * interrupt_table_length.
450 */
451 buffer++;
452
453 /*
454 * Add 4 bytes for each additional interrupt. Note: at least one
455 * interrupt is required and is included in the minimum
456 * descriptor size
457 */
458 extra_struct_bytes =
459 ((*buffer - 1) * sizeof(u32));
460
461 /* Add the size of any optional data (resource_source) */
462
463 extra_struct_bytes +=
464 acpi_rs_stream_option_length(resource_length
465 -
466 extra_struct_bytes,
467 resource_info->
468 minimum_aml_resource_length);
469 break;
470
471 case ACPI_RESOURCE_NAME_ADDRESS64:
472 /*
473 * 64-Bit Address Resource:
474 * Add the size of any optional data (resource_source)
475 * Ensure a 64-bit boundary for the structure
476 */
477 extra_struct_bytes =
478 ACPI_ROUND_UP_to_64_bITS
479 (acpi_rs_stream_option_length
480 (resource_length,
481 resource_info->
482 minimum_aml_resource_length));
483 break;
484
485 default:
486 break;
487 }
488 }
489
490 /* Update the required buffer size for the internal descriptor structs */
491
492 temp16 =
493 (u16) (resource_info->minimum_internal_struct_length +
494 extra_struct_bytes);
495 buffer_size += (u32) ACPI_ALIGN_RESOURCE_SIZE(temp16);
496
497 /*
498 * Update byte count and point to the next resource within the stream
499 * using the size of the header plus the length contained in the header
500 */
501 temp16 = (u16) (header_length + resource_length);
502 bytes_parsed += temp16;
503 aml_buffer += temp16;
504 }
505
506 /* This is the data the caller needs */
507
508 *size_needed = buffer_size;
509 return_ACPI_STATUS(AE_OK);
510 }
511
512 /*******************************************************************************
513 *
514 * FUNCTION: acpi_rs_get_pci_routing_table_length
515 *
516 * PARAMETERS: package_object - Pointer to the package object
517 * buffer_size_needed - u32 pointer of the size buffer
518 * needed to properly return the
519 * parsed data
520 *
521 * RETURN: Status
522 *
523 * DESCRIPTION: Given a package representing a PCI routing table, this
524 * calculates the size of the corresponding linked list of
525 * descriptions.
526 *
527 ******************************************************************************/
528
529 acpi_status
530 acpi_rs_get_pci_routing_table_length(union acpi_operand_object *package_object,
531 acpi_size * buffer_size_needed)
532 {
533 u32 number_of_elements;
534 acpi_size temp_size_needed = 0;
535 union acpi_operand_object **top_object_list;
536 u32 index;
537 union acpi_operand_object *package_element;
538 union acpi_operand_object **sub_object_list;
539 u8 name_found;
540 u32 table_index;
541
542 ACPI_FUNCTION_TRACE("rs_get_pci_routing_table_length");
543
544 number_of_elements = package_object->package.count;
545
546 /*
547 * Calculate the size of the return buffer.
548 * The base size is the number of elements * the sizes of the
549 * structures. Additional space for the strings is added below.
550 * The minus one is to subtract the size of the u8 Source[1]
551 * member because it is added below.
552 *
553 * But each PRT_ENTRY structure has a pointer to a string and
554 * the size of that string must be found.
555 */
556 top_object_list = package_object->package.elements;
557
558 for (index = 0; index < number_of_elements; index++) {
559 /* Dereference the sub-package */
560
561 package_element = *top_object_list;
562
563 /*
564 * The sub_object_list will now point to an array of the
565 * four IRQ elements: Address, Pin, Source and source_index
566 */
567 sub_object_list = package_element->package.elements;
568
569 /* Scan the irq_table_elements for the Source Name String */
570
571 name_found = FALSE;
572
573 for (table_index = 0; table_index < 4 && !name_found;
574 table_index++) {
575 if ((ACPI_TYPE_STRING ==
576 ACPI_GET_OBJECT_TYPE(*sub_object_list))
577 ||
578 ((ACPI_TYPE_LOCAL_REFERENCE ==
579 ACPI_GET_OBJECT_TYPE(*sub_object_list))
580 && ((*sub_object_list)->reference.opcode ==
581 AML_INT_NAMEPATH_OP))) {
582 name_found = TRUE;
583 } else {
584 /* Look at the next element */
585
586 sub_object_list++;
587 }
588 }
589
590 temp_size_needed += (sizeof(struct acpi_pci_routing_table) - 4);
591
592 /* Was a String type found? */
593
594 if (name_found) {
595 if (ACPI_GET_OBJECT_TYPE(*sub_object_list) ==
596 ACPI_TYPE_STRING) {
597 /*
598 * The length String.Length field does not include the
599 * terminating NULL, add 1
600 */
601 temp_size_needed += ((acpi_size)
602 (*sub_object_list)->string.
603 length + 1);
604 } else {
605 temp_size_needed += acpi_ns_get_pathname_length((*sub_object_list)->reference.node);
606 }
607 } else {
608 /*
609 * If no name was found, then this is a NULL, which is
610 * translated as a u32 zero.
611 */
612 temp_size_needed += sizeof(u32);
613 }
614
615 /* Round up the size since each element must be aligned */
616
617 temp_size_needed = ACPI_ROUND_UP_to_64_bITS(temp_size_needed);
618
619 /* Point to the next union acpi_operand_object */
620
621 top_object_list++;
622 }
623
624 /*
625 * Adding an extra element to the end of the list, essentially a
626 * NULL terminator
627 */
628 *buffer_size_needed =
629 temp_size_needed + sizeof(struct acpi_pci_routing_table);
630 return_ACPI_STATUS(AE_OK);
631 }
CJK support for tty framebuffer vt