* Intel ACPI 20030228 distribution with local DragonFly changes.
[dragonfly.git] / sys / contrib / dev / acpica / rsmisc.c
1 /*******************************************************************************
2  *
3  * Module Name: rsmisc - Miscellaneous resource descriptors
4  *              $Revision: 25 $
5  *
6  ******************************************************************************/
7
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13  * All rights reserved.
14  *
15  * 2. License
16  *
17  * 2.1. This is your license from Intel Corp. under its intellectual property
18  * rights.  You may have additional license terms from the party that provided
19  * you this software, covering your right to use that party's intellectual
20  * property rights.
21  *
22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23  * copy of the source code appearing in this file ("Covered Code") an
24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25  * base code distributed originally by Intel ("Original Intel Code") to copy,
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code.  No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision.  In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change.  Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee.  Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution.  In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government.  In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/rsmisc.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
117
118 #define __RSMISC_C__
119
120 #include "acpi.h"
121 #include "acresrc.h"
122
123 #define _COMPONENT          ACPI_RESOURCES
124         ACPI_MODULE_NAME    ("rsmisc")
125
126
127 /*******************************************************************************
128  *
129  * FUNCTION:    AcpiRsEndTagResource
130  *
131  * PARAMETERS:  ByteStreamBuffer        - Pointer to the resource input byte
132  *                                        stream
133  *              BytesConsumed           - Pointer to where the number of bytes
134  *                                        consumed the ByteStreamBuffer is
135  *                                        returned
136  *              OutputBuffer            - Pointer to the return data buffer
137  *              StructureSize           - Pointer to where the number of bytes
138  *                                        in the return data struct is returned
139  *
140  * RETURN:      Status
141  *
142  * DESCRIPTION: Take the resource byte stream and fill out the appropriate
143  *              structure pointed to by the OutputBuffer.  Return the
144  *              number of bytes consumed from the byte stream.
145  *
146  ******************************************************************************/
147
148 ACPI_STATUS
149 AcpiRsEndTagResource (
150     UINT8                   *ByteStreamBuffer,
151     ACPI_SIZE               *BytesConsumed,
152     UINT8                   **OutputBuffer,
153     ACPI_SIZE               *StructureSize)
154 {
155     ACPI_RESOURCE           *OutputStruct = (void *) *OutputBuffer;
156     ACPI_SIZE               StructSize = ACPI_RESOURCE_LENGTH;
157
158
159     ACPI_FUNCTION_TRACE ("RsEndTagResource");
160
161
162     /*
163      * The number of bytes consumed is static
164      */
165     *BytesConsumed = 2;
166
167     /*
168      *  Fill out the structure
169      */
170     OutputStruct->Id = ACPI_RSTYPE_END_TAG;
171
172     /*
173      * Set the Length parameter
174      */
175     OutputStruct->Length = 0;
176
177     /*
178      * Return the final size of the structure
179      */
180     *StructureSize = StructSize;
181     return_ACPI_STATUS (AE_OK);
182 }
183
184
185 /*******************************************************************************
186  *
187  * FUNCTION:    AcpiRsEndTagStream
188  *
189  * PARAMETERS:  LinkedList              - Pointer to the resource linked list
190  *              OutputBuffer            - Pointer to the user's return buffer
191  *              BytesConsumed           - Pointer to where the number of bytes
192  *                                        used in the OutputBuffer is returned
193  *
194  * RETURN:      Status
195  *
196  * DESCRIPTION: Take the linked list resource structure and fills in the
197  *              the appropriate bytes in a byte stream
198  *
199  ******************************************************************************/
200
201 ACPI_STATUS
202 AcpiRsEndTagStream (
203     ACPI_RESOURCE           *LinkedList,
204     UINT8                   **OutputBuffer,
205     ACPI_SIZE               *BytesConsumed)
206 {
207     UINT8                   *Buffer = *OutputBuffer;
208     UINT8                   Temp8 = 0;
209
210
211     ACPI_FUNCTION_TRACE ("RsEndTagStream");
212
213
214     /*
215      * The descriptor field is static
216      */
217     *Buffer = 0x79;
218     Buffer += 1;
219
220     /*
221      * Set the Checksum - zero means that the resource data is treated as if
222      * the checksum operation succeeded (ACPI Spec 1.0b Section 6.4.2.8)
223      */
224     Temp8 = 0;
225
226     *Buffer = Temp8;
227     Buffer += 1;
228
229     /*
230      * Return the number of bytes consumed in this operation
231      */
232     *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
233     return_ACPI_STATUS (AE_OK);
234 }
235
236
237 /*******************************************************************************
238  *
239  * FUNCTION:    AcpiRsVendorResource
240  *
241  * PARAMETERS:  ByteStreamBuffer        - Pointer to the resource input byte
242  *                                        stream
243  *              BytesConsumed           - Pointer to where the number of bytes
244  *                                        consumed the ByteStreamBuffer is
245  *                                        returned
246  *              OutputBuffer            - Pointer to the return data buffer
247  *              StructureSize           - Pointer to where the number of bytes
248  *                                        in the return data struct is returned
249  *
250  * RETURN:      Status
251  *
252  * DESCRIPTION: Take the resource byte stream and fill out the appropriate
253  *              structure pointed to by the OutputBuffer.  Return the
254  *              number of bytes consumed from the byte stream.
255  *
256  ******************************************************************************/
257
258 ACPI_STATUS
259 AcpiRsVendorResource (
260     UINT8                   *ByteStreamBuffer,
261     ACPI_SIZE               *BytesConsumed,
262     UINT8                   **OutputBuffer,
263     ACPI_SIZE               *StructureSize)
264 {
265     UINT8                   *Buffer = ByteStreamBuffer;
266     ACPI_RESOURCE           *OutputStruct = (void *) *OutputBuffer;
267     UINT16                  Temp16 = 0;
268     UINT8                   Temp8 = 0;
269     UINT8                   Index;
270     ACPI_SIZE               StructSize = ACPI_SIZEOF_RESOURCE (ACPI_RESOURCE_VENDOR);
271
272
273     ACPI_FUNCTION_TRACE ("RsVendorResource");
274
275
276     /*
277      * Dereference the Descriptor to find if this is a large or small item.
278      */
279     Temp8 = *Buffer;
280
281     if (Temp8 & 0x80)
282     {
283         /*
284          * Large Item, point to the length field
285          */
286         Buffer += 1;
287
288         /* Dereference */
289
290         ACPI_MOVE_UNALIGNED16_TO_16 (&Temp16, Buffer);
291
292         /* Calculate bytes consumed */
293
294         *BytesConsumed = (ACPI_SIZE) Temp16 + 3;
295
296         /* Point to the first vendor byte */
297
298         Buffer += 2;
299     }
300     else
301     {
302         /*
303          * Small Item, dereference the size
304          */
305         Temp16 = (UINT8)(*Buffer & 0x07);
306
307         /* Calculate bytes consumed */
308
309         *BytesConsumed = (ACPI_SIZE) Temp16 + 1;
310
311         /* Point to the first vendor byte */
312
313         Buffer += 1;
314     }
315
316     OutputStruct->Id = ACPI_RSTYPE_VENDOR;
317     OutputStruct->Data.VendorSpecific.Length = Temp16;
318
319     for (Index = 0; Index < Temp16; Index++)
320     {
321         OutputStruct->Data.VendorSpecific.Reserved[Index] = *Buffer;
322         Buffer += 1;
323     }
324
325     /*
326      * In order for the StructSize to fall on a 32-bit boundary,
327      * calculate the length of the vendor string and expand the
328      * StructSize to the next 32-bit boundary.
329      */
330     StructSize += ACPI_ROUND_UP_TO_32BITS (Temp16);
331
332     /*
333      * Set the Length parameter
334      */
335     OutputStruct->Length = (UINT32) StructSize;
336
337     /*
338      * Return the final size of the structure
339      */
340     *StructureSize = StructSize;
341     return_ACPI_STATUS (AE_OK);
342 }
343
344
345 /*******************************************************************************
346  *
347  * FUNCTION:    AcpiRsVendorStream
348  *
349  * PARAMETERS:  LinkedList              - Pointer to the resource linked list
350  *              OutputBuffer            - Pointer to the user's return buffer
351  *              BytesConsumed           - Pointer to where the number of bytes
352  *                                        used in the OutputBuffer is returned
353  *
354  * RETURN:      Status
355  *
356  * DESCRIPTION: Take the linked list resource structure and fills in the
357  *              the appropriate bytes in a byte stream
358  *
359  ******************************************************************************/
360
361 ACPI_STATUS
362 AcpiRsVendorStream (
363     ACPI_RESOURCE           *LinkedList,
364     UINT8                   **OutputBuffer,
365     ACPI_SIZE               *BytesConsumed)
366 {
367     UINT8                   *Buffer = *OutputBuffer;
368     UINT16                  Temp16 = 0;
369     UINT8                   Temp8 = 0;
370     UINT8                   Index;
371
372
373     ACPI_FUNCTION_TRACE ("RsVendorStream");
374
375
376     /*
377      * Dereference the length to find if this is a large or small item.
378      */
379     if(LinkedList->Data.VendorSpecific.Length > 7)
380     {
381         /*
382          * Large Item, Set the descriptor field and length bytes
383          */
384         *Buffer = 0x84;
385         Buffer += 1;
386
387         Temp16 = (UINT16) LinkedList->Data.VendorSpecific.Length;
388
389         ACPI_MOVE_UNALIGNED16_TO_16 (Buffer, &Temp16);
390         Buffer += 2;
391     }
392     else
393     {
394         /*
395          * Small Item, Set the descriptor field
396          */
397         Temp8 = 0x70;
398         Temp8 |= (UINT8) LinkedList->Data.VendorSpecific.Length;
399
400         *Buffer = Temp8;
401         Buffer += 1;
402     }
403
404     /*
405      * Loop through all of the Vendor Specific fields
406      */
407     for (Index = 0; Index < LinkedList->Data.VendorSpecific.Length; Index++)
408     {
409         Temp8 = LinkedList->Data.VendorSpecific.Reserved[Index];
410
411         *Buffer = Temp8;
412         Buffer += 1;
413     }
414
415     /*
416      * Return the number of bytes consumed in this operation
417      */
418     *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
419     return_ACPI_STATUS (AE_OK);
420 }
421
422
423 /*******************************************************************************
424  *
425  * FUNCTION:    AcpiRsStartDependFnsResource
426  *
427  * PARAMETERS:  ByteStreamBuffer        - Pointer to the resource input byte
428  *                                        stream
429  *              BytesConsumed           - Pointer to where the number of bytes
430  *                                        consumed the ByteStreamBuffer is
431  *                                        returned
432  *              OutputBuffer            - Pointer to the return data buffer
433  *              StructureSize           - Pointer to where the number of bytes
434  *                                        in the return data struct is returned
435  *
436  * RETURN:      Status
437  *
438  * DESCRIPTION: Take the resource byte stream and fill out the appropriate
439  *              structure pointed to by the OutputBuffer.  Return the
440  *              number of bytes consumed from the byte stream.
441  *
442  ******************************************************************************/
443
444 ACPI_STATUS
445 AcpiRsStartDependFnsResource (
446     UINT8                   *ByteStreamBuffer,
447     ACPI_SIZE               *BytesConsumed,
448     UINT8                   **OutputBuffer,
449     ACPI_SIZE               *StructureSize)
450 {
451     UINT8                   *Buffer = ByteStreamBuffer;
452     ACPI_RESOURCE           *OutputStruct = (void *) *OutputBuffer;
453     UINT8                   Temp8 = 0;
454     ACPI_SIZE               StructSize = ACPI_SIZEOF_RESOURCE (ACPI_RESOURCE_START_DPF);
455
456
457     ACPI_FUNCTION_TRACE ("RsStartDependFnsResource");
458
459
460     /*
461      * The number of bytes consumed are contained in the descriptor (Bits:0-1)
462      */
463     Temp8 = *Buffer;
464
465     *BytesConsumed = (Temp8 & 0x01) + 1;
466
467     OutputStruct->Id = ACPI_RSTYPE_START_DPF;
468
469     /*
470      * Point to Byte 1 if it is used
471      */
472     if (2 == *BytesConsumed)
473     {
474         Buffer += 1;
475         Temp8 = *Buffer;
476
477         /*
478          * Check Compatibility priority
479          */
480         OutputStruct->Data.StartDpf.CompatibilityPriority = Temp8 & 0x03;
481
482         if (3 == OutputStruct->Data.StartDpf.CompatibilityPriority)
483         {
484             return_ACPI_STATUS (AE_AML_BAD_RESOURCE_VALUE);
485         }
486
487         /*
488          * Check Performance/Robustness preference
489          */
490         OutputStruct->Data.StartDpf.PerformanceRobustness = (Temp8 >> 2) & 0x03;
491
492         if (3 == OutputStruct->Data.StartDpf.PerformanceRobustness)
493         {
494             return_ACPI_STATUS (AE_AML_BAD_RESOURCE_VALUE);
495         }
496     }
497     else
498     {
499         OutputStruct->Data.StartDpf.CompatibilityPriority =
500                 ACPI_ACCEPTABLE_CONFIGURATION;
501
502         OutputStruct->Data.StartDpf.PerformanceRobustness =
503                 ACPI_ACCEPTABLE_CONFIGURATION;
504     }
505
506     /*
507      * Set the Length parameter
508      */
509     OutputStruct->Length = (UINT32) StructSize;
510
511     /*
512      * Return the final size of the structure
513      */
514     *StructureSize = StructSize;
515     return_ACPI_STATUS (AE_OK);
516 }
517
518
519 /*******************************************************************************
520  *
521  * FUNCTION:    AcpiRsEndDependFnsResource
522  *
523  * PARAMETERS:  ByteStreamBuffer        - Pointer to the resource input byte
524  *                                        stream
525  *              BytesConsumed           - Pointer to where the number of bytes
526  *                                        consumed the ByteStreamBuffer is
527  *                                        returned
528  *              OutputBuffer            - Pointer to the return data buffer
529  *              StructureSize           - Pointer to where the number of bytes
530  *                                        in the return data struct is returned
531  *
532  * RETURN:      Status
533  *
534  * DESCRIPTION: Take the resource byte stream and fill out the appropriate
535  *              structure pointed to by the OutputBuffer.  Return the
536  *              number of bytes consumed from the byte stream.
537  *
538  ******************************************************************************/
539
540 ACPI_STATUS
541 AcpiRsEndDependFnsResource (
542     UINT8                   *ByteStreamBuffer,
543     ACPI_SIZE               *BytesConsumed,
544     UINT8                   **OutputBuffer,
545     ACPI_SIZE               *StructureSize)
546 {
547     ACPI_RESOURCE           *OutputStruct = (void *) *OutputBuffer;
548     ACPI_SIZE               StructSize = ACPI_RESOURCE_LENGTH;
549
550
551     ACPI_FUNCTION_TRACE ("RsEndDependFnsResource");
552
553
554     /*
555      * The number of bytes consumed is static
556      */
557     *BytesConsumed = 1;
558
559     /*
560      *  Fill out the structure
561      */
562     OutputStruct->Id = ACPI_RSTYPE_END_DPF;
563
564     /*
565      * Set the Length parameter
566      */
567     OutputStruct->Length = (UINT32) StructSize;
568
569     /*
570      * Return the final size of the structure
571      */
572     *StructureSize = StructSize;
573     return_ACPI_STATUS (AE_OK);
574 }
575
576
577 /*******************************************************************************
578  *
579  * FUNCTION:    AcpiRsStartDependFnsStream
580  *
581  * PARAMETERS:  LinkedList              - Pointer to the resource linked list
582  *              OutputBuffer            - Pointer to the user's return buffer
583  *              BytesConsumed           - UINT32 pointer that is filled with
584  *                                        the number of bytes of the
585  *                                        OutputBuffer used
586  *
587  * RETURN:      Status
588  *
589  * DESCRIPTION: Take the linked list resource structure and fills in the
590  *              the appropriate bytes in a byte stream
591  *
592  ******************************************************************************/
593
594 ACPI_STATUS
595 AcpiRsStartDependFnsStream (
596     ACPI_RESOURCE           *LinkedList,
597     UINT8                   **OutputBuffer,
598     ACPI_SIZE               *BytesConsumed)
599 {
600     UINT8                   *Buffer = *OutputBuffer;
601     UINT8                   Temp8 = 0;
602
603
604     ACPI_FUNCTION_TRACE ("RsStartDependFnsStream");
605
606
607     /*
608      * The descriptor field is set based upon whether a byte is needed
609      * to contain Priority data.
610      */
611     if (ACPI_ACCEPTABLE_CONFIGURATION ==
612             LinkedList->Data.StartDpf.CompatibilityPriority &&
613         ACPI_ACCEPTABLE_CONFIGURATION ==
614             LinkedList->Data.StartDpf.PerformanceRobustness)
615     {
616         *Buffer = 0x30;
617     }
618     else
619     {
620         *Buffer = 0x31;
621         Buffer += 1;
622
623         /*
624          * Set the Priority Byte Definition
625          */
626         Temp8 = 0;
627         Temp8 = (UINT8) ((LinkedList->Data.StartDpf.PerformanceRobustness &
628                             0x03) << 2);
629         Temp8 |= (LinkedList->Data.StartDpf.CompatibilityPriority &
630                             0x03);
631         *Buffer = Temp8;
632     }
633
634     Buffer += 1;
635
636     /*
637      * Return the number of bytes consumed in this operation
638      */
639     *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
640     return_ACPI_STATUS (AE_OK);
641 }
642
643
644 /*******************************************************************************
645  *
646  * FUNCTION:    AcpiRsEndDependFnsStream
647  *
648  * PARAMETERS:  LinkedList              - Pointer to the resource linked list
649  *              OutputBuffer            - Pointer to the user's return buffer
650  *              BytesConsumed           - Pointer to where the number of bytes
651  *                                        used in the OutputBuffer is returned
652  *
653  * RETURN:      Status
654  *
655  * DESCRIPTION: Take the linked list resource structure and fills in the
656  *              the appropriate bytes in a byte stream
657  *
658  ******************************************************************************/
659
660 ACPI_STATUS
661 AcpiRsEndDependFnsStream (
662     ACPI_RESOURCE           *LinkedList,
663     UINT8                   **OutputBuffer,
664     ACPI_SIZE               *BytesConsumed)
665 {
666     UINT8                   *Buffer = *OutputBuffer;
667
668
669     ACPI_FUNCTION_TRACE ("RsEndDependFnsStream");
670
671
672     /*
673      * The descriptor field is static
674      */
675     *Buffer = 0x38;
676     Buffer += 1;
677
678     /*
679      * Return the number of bytes consumed in this operation
680      */
681     *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
682     return_ACPI_STATUS (AE_OK);
683 }
684