1 /*******************************************************************************
3 * Module Name: rsmisc - Miscellaneous resource descriptors
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/rsmisc.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
123 #define _COMPONENT ACPI_RESOURCES
124 ACPI_MODULE_NAME ("rsmisc")
127 /*******************************************************************************
129 * FUNCTION: AcpiRsEndTagResource
131 * PARAMETERS: ByteStreamBuffer - Pointer to the resource input byte
133 * BytesConsumed - Pointer to where the number of bytes
134 * consumed the ByteStreamBuffer is
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
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.
146 ******************************************************************************/
149 AcpiRsEndTagResource (
150 UINT8 *ByteStreamBuffer,
151 ACPI_SIZE *BytesConsumed,
152 UINT8 **OutputBuffer,
153 ACPI_SIZE *StructureSize)
155 ACPI_RESOURCE *OutputStruct = (void *) *OutputBuffer;
156 ACPI_SIZE StructSize = ACPI_RESOURCE_LENGTH;
159 ACPI_FUNCTION_TRACE ("RsEndTagResource");
163 * The number of bytes consumed is static
168 * Fill out the structure
170 OutputStruct->Id = ACPI_RSTYPE_END_TAG;
173 * Set the Length parameter
175 OutputStruct->Length = 0;
178 * Return the final size of the structure
180 *StructureSize = StructSize;
181 return_ACPI_STATUS (AE_OK);
185 /*******************************************************************************
187 * FUNCTION: AcpiRsEndTagStream
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
196 * DESCRIPTION: Take the linked list resource structure and fills in the
197 * the appropriate bytes in a byte stream
199 ******************************************************************************/
203 ACPI_RESOURCE *LinkedList,
204 UINT8 **OutputBuffer,
205 ACPI_SIZE *BytesConsumed)
207 UINT8 *Buffer = *OutputBuffer;
211 ACPI_FUNCTION_TRACE ("RsEndTagStream");
215 * The descriptor field is static
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)
230 * Return the number of bytes consumed in this operation
232 *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
233 return_ACPI_STATUS (AE_OK);
237 /*******************************************************************************
239 * FUNCTION: AcpiRsVendorResource
241 * PARAMETERS: ByteStreamBuffer - Pointer to the resource input byte
243 * BytesConsumed - Pointer to where the number of bytes
244 * consumed the ByteStreamBuffer is
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
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.
256 ******************************************************************************/
259 AcpiRsVendorResource (
260 UINT8 *ByteStreamBuffer,
261 ACPI_SIZE *BytesConsumed,
262 UINT8 **OutputBuffer,
263 ACPI_SIZE *StructureSize)
265 UINT8 *Buffer = ByteStreamBuffer;
266 ACPI_RESOURCE *OutputStruct = (void *) *OutputBuffer;
270 ACPI_SIZE StructSize = ACPI_SIZEOF_RESOURCE (ACPI_RESOURCE_VENDOR);
273 ACPI_FUNCTION_TRACE ("RsVendorResource");
277 * Dereference the Descriptor to find if this is a large or small item.
284 * Large Item, point to the length field
290 ACPI_MOVE_UNALIGNED16_TO_16 (&Temp16, Buffer);
292 /* Calculate bytes consumed */
294 *BytesConsumed = (ACPI_SIZE) Temp16 + 3;
296 /* Point to the first vendor byte */
303 * Small Item, dereference the size
305 Temp16 = (UINT8)(*Buffer & 0x07);
307 /* Calculate bytes consumed */
309 *BytesConsumed = (ACPI_SIZE) Temp16 + 1;
311 /* Point to the first vendor byte */
316 OutputStruct->Id = ACPI_RSTYPE_VENDOR;
317 OutputStruct->Data.VendorSpecific.Length = Temp16;
319 for (Index = 0; Index < Temp16; Index++)
321 OutputStruct->Data.VendorSpecific.Reserved[Index] = *Buffer;
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.
330 StructSize += ACPI_ROUND_UP_TO_32BITS (Temp16);
333 * Set the Length parameter
335 OutputStruct->Length = (UINT32) StructSize;
338 * Return the final size of the structure
340 *StructureSize = StructSize;
341 return_ACPI_STATUS (AE_OK);
345 /*******************************************************************************
347 * FUNCTION: AcpiRsVendorStream
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
356 * DESCRIPTION: Take the linked list resource structure and fills in the
357 * the appropriate bytes in a byte stream
359 ******************************************************************************/
363 ACPI_RESOURCE *LinkedList,
364 UINT8 **OutputBuffer,
365 ACPI_SIZE *BytesConsumed)
367 UINT8 *Buffer = *OutputBuffer;
373 ACPI_FUNCTION_TRACE ("RsVendorStream");
377 * Dereference the length to find if this is a large or small item.
379 if(LinkedList->Data.VendorSpecific.Length > 7)
382 * Large Item, Set the descriptor field and length bytes
387 Temp16 = (UINT16) LinkedList->Data.VendorSpecific.Length;
389 ACPI_MOVE_UNALIGNED16_TO_16 (Buffer, &Temp16);
395 * Small Item, Set the descriptor field
398 Temp8 |= (UINT8) LinkedList->Data.VendorSpecific.Length;
405 * Loop through all of the Vendor Specific fields
407 for (Index = 0; Index < LinkedList->Data.VendorSpecific.Length; Index++)
409 Temp8 = LinkedList->Data.VendorSpecific.Reserved[Index];
416 * Return the number of bytes consumed in this operation
418 *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
419 return_ACPI_STATUS (AE_OK);
423 /*******************************************************************************
425 * FUNCTION: AcpiRsStartDependFnsResource
427 * PARAMETERS: ByteStreamBuffer - Pointer to the resource input byte
429 * BytesConsumed - Pointer to where the number of bytes
430 * consumed the ByteStreamBuffer is
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
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.
442 ******************************************************************************/
445 AcpiRsStartDependFnsResource (
446 UINT8 *ByteStreamBuffer,
447 ACPI_SIZE *BytesConsumed,
448 UINT8 **OutputBuffer,
449 ACPI_SIZE *StructureSize)
451 UINT8 *Buffer = ByteStreamBuffer;
452 ACPI_RESOURCE *OutputStruct = (void *) *OutputBuffer;
454 ACPI_SIZE StructSize = ACPI_SIZEOF_RESOURCE (ACPI_RESOURCE_START_DPF);
457 ACPI_FUNCTION_TRACE ("RsStartDependFnsResource");
461 * The number of bytes consumed are contained in the descriptor (Bits:0-1)
465 *BytesConsumed = (Temp8 & 0x01) + 1;
467 OutputStruct->Id = ACPI_RSTYPE_START_DPF;
470 * Point to Byte 1 if it is used
472 if (2 == *BytesConsumed)
478 * Check Compatibility priority
480 OutputStruct->Data.StartDpf.CompatibilityPriority = Temp8 & 0x03;
482 if (3 == OutputStruct->Data.StartDpf.CompatibilityPriority)
484 return_ACPI_STATUS (AE_AML_BAD_RESOURCE_VALUE);
488 * Check Performance/Robustness preference
490 OutputStruct->Data.StartDpf.PerformanceRobustness = (Temp8 >> 2) & 0x03;
492 if (3 == OutputStruct->Data.StartDpf.PerformanceRobustness)
494 return_ACPI_STATUS (AE_AML_BAD_RESOURCE_VALUE);
499 OutputStruct->Data.StartDpf.CompatibilityPriority =
500 ACPI_ACCEPTABLE_CONFIGURATION;
502 OutputStruct->Data.StartDpf.PerformanceRobustness =
503 ACPI_ACCEPTABLE_CONFIGURATION;
507 * Set the Length parameter
509 OutputStruct->Length = (UINT32) StructSize;
512 * Return the final size of the structure
514 *StructureSize = StructSize;
515 return_ACPI_STATUS (AE_OK);
519 /*******************************************************************************
521 * FUNCTION: AcpiRsEndDependFnsResource
523 * PARAMETERS: ByteStreamBuffer - Pointer to the resource input byte
525 * BytesConsumed - Pointer to where the number of bytes
526 * consumed the ByteStreamBuffer is
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
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.
538 ******************************************************************************/
541 AcpiRsEndDependFnsResource (
542 UINT8 *ByteStreamBuffer,
543 ACPI_SIZE *BytesConsumed,
544 UINT8 **OutputBuffer,
545 ACPI_SIZE *StructureSize)
547 ACPI_RESOURCE *OutputStruct = (void *) *OutputBuffer;
548 ACPI_SIZE StructSize = ACPI_RESOURCE_LENGTH;
551 ACPI_FUNCTION_TRACE ("RsEndDependFnsResource");
555 * The number of bytes consumed is static
560 * Fill out the structure
562 OutputStruct->Id = ACPI_RSTYPE_END_DPF;
565 * Set the Length parameter
567 OutputStruct->Length = (UINT32) StructSize;
570 * Return the final size of the structure
572 *StructureSize = StructSize;
573 return_ACPI_STATUS (AE_OK);
577 /*******************************************************************************
579 * FUNCTION: AcpiRsStartDependFnsStream
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
589 * DESCRIPTION: Take the linked list resource structure and fills in the
590 * the appropriate bytes in a byte stream
592 ******************************************************************************/
595 AcpiRsStartDependFnsStream (
596 ACPI_RESOURCE *LinkedList,
597 UINT8 **OutputBuffer,
598 ACPI_SIZE *BytesConsumed)
600 UINT8 *Buffer = *OutputBuffer;
604 ACPI_FUNCTION_TRACE ("RsStartDependFnsStream");
608 * The descriptor field is set based upon whether a byte is needed
609 * to contain Priority data.
611 if (ACPI_ACCEPTABLE_CONFIGURATION ==
612 LinkedList->Data.StartDpf.CompatibilityPriority &&
613 ACPI_ACCEPTABLE_CONFIGURATION ==
614 LinkedList->Data.StartDpf.PerformanceRobustness)
624 * Set the Priority Byte Definition
627 Temp8 = (UINT8) ((LinkedList->Data.StartDpf.PerformanceRobustness &
629 Temp8 |= (LinkedList->Data.StartDpf.CompatibilityPriority &
637 * Return the number of bytes consumed in this operation
639 *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
640 return_ACPI_STATUS (AE_OK);
644 /*******************************************************************************
646 * FUNCTION: AcpiRsEndDependFnsStream
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
655 * DESCRIPTION: Take the linked list resource structure and fills in the
656 * the appropriate bytes in a byte stream
658 ******************************************************************************/
661 AcpiRsEndDependFnsStream (
662 ACPI_RESOURCE *LinkedList,
663 UINT8 **OutputBuffer,
664 ACPI_SIZE *BytesConsumed)
666 UINT8 *Buffer = *OutputBuffer;
669 ACPI_FUNCTION_TRACE ("RsEndDependFnsStream");
673 * The descriptor field is static
679 * Return the number of bytes consumed in this operation
681 *BytesConsumed = ACPI_PTR_DIFF (Buffer, *OutputBuffer);
682 return_ACPI_STATUS (AE_OK);