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