1 /*******************************************************************************
2 *
3 * Module Name: utresrc - Resource management utilities
4 *
5 ******************************************************************************/
6
7 /******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************
115 *
116 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acresrc.h"
155
156
157 #define _COMPONENT ACPI_UTILITIES
158 ACPI_MODULE_NAME ("utresrc")
159
160
161 /*
162 * Base sizes of the raw AML resource descriptors, indexed by resource type.
163 * Zero indicates a reserved (and therefore invalid) resource type.
164 */
165 const UINT8 AcpiGbl_ResourceAmlSizes[] =
166 {
167 /* Small descriptors */
168
169 0,
170 0,
171 0,
172 0,
173 ACPI_AML_SIZE_SMALL (AML_RESOURCE_IRQ),
174 ACPI_AML_SIZE_SMALL (AML_RESOURCE_DMA),
175 ACPI_AML_SIZE_SMALL (AML_RESOURCE_START_DEPENDENT),
176 ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_DEPENDENT),
177 ACPI_AML_SIZE_SMALL (AML_RESOURCE_IO),
178 ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_IO),
179 ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_DMA),
180 0,
181 0,
182 0,
183 ACPI_AML_SIZE_SMALL (AML_RESOURCE_VENDOR_SMALL),
184 ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_TAG),
185
186 /* Large descriptors */
187
188 0,
189 ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY24),
190 ACPI_AML_SIZE_LARGE (AML_RESOURCE_GENERIC_REGISTER),
191 0,
192 ACPI_AML_SIZE_LARGE (AML_RESOURCE_VENDOR_LARGE),
193 ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY32),
194 ACPI_AML_SIZE_LARGE (AML_RESOURCE_FIXED_MEMORY32),
195 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS32),
196 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS16),
197 ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_IRQ),
198 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS64),
199 ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_ADDRESS64),
200 ACPI_AML_SIZE_LARGE (AML_RESOURCE_GPIO),
201 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_FUNCTION),
202 ACPI_AML_SIZE_LARGE (AML_RESOURCE_COMMON_SERIALBUS),
203 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_CONFIG),
204 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP),
205 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP_FUNCTION),
206 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP_CONFIG),
207 };
208
209 const UINT8 AcpiGbl_ResourceAmlSerialBusSizes[] =
210 {
211 0,
212 ACPI_AML_SIZE_LARGE (AML_RESOURCE_I2C_SERIALBUS),
213 ACPI_AML_SIZE_LARGE (AML_RESOURCE_SPI_SERIALBUS),
214 ACPI_AML_SIZE_LARGE (AML_RESOURCE_UART_SERIALBUS),
215 };
216
217
218 /*
219 * Resource types, used to validate the resource length field.
220 * The length of fixed-length types must match exactly, variable
221 * lengths must meet the minimum required length, etc.
222 * Zero indicates a reserved (and therefore invalid) resource type.
223 */
224 static const UINT8 AcpiGbl_ResourceTypes[] =
225 {
226 /* Small descriptors */
227
228 0,
229 0,
230 0,
231 0,
232 ACPI_SMALL_VARIABLE_LENGTH, /* 04 IRQ */
233 ACPI_FIXED_LENGTH, /* 05 DMA */
234 ACPI_SMALL_VARIABLE_LENGTH, /* 06 StartDependentFunctions */
235 ACPI_FIXED_LENGTH, /* 07 EndDependentFunctions */
236 ACPI_FIXED_LENGTH, /* 08 IO */
237 ACPI_FIXED_LENGTH, /* 09 FixedIO */
238 ACPI_FIXED_LENGTH, /* 0A FixedDMA */
239 0,
240 0,
241 0,
242 ACPI_VARIABLE_LENGTH, /* 0E VendorShort */
243 ACPI_FIXED_LENGTH, /* 0F EndTag */
244
245 /* Large descriptors */
246
247 0,
248 ACPI_FIXED_LENGTH, /* 01 Memory24 */
249 ACPI_FIXED_LENGTH, /* 02 GenericRegister */
250 0,
251 ACPI_VARIABLE_LENGTH, /* 04 VendorLong */
252 ACPI_FIXED_LENGTH, /* 05 Memory32 */
253 ACPI_FIXED_LENGTH, /* 06 Memory32Fixed */
254 ACPI_VARIABLE_LENGTH, /* 07 Dword* address */
255 ACPI_VARIABLE_LENGTH, /* 08 Word* address */
256 ACPI_VARIABLE_LENGTH, /* 09 ExtendedIRQ */
257 ACPI_VARIABLE_LENGTH, /* 0A Qword* address */
258 ACPI_FIXED_LENGTH, /* 0B Extended* address */
259 ACPI_VARIABLE_LENGTH, /* 0C Gpio* */
260 ACPI_VARIABLE_LENGTH, /* 0D PinFunction */
261 ACPI_VARIABLE_LENGTH, /* 0E *SerialBus */
262 ACPI_VARIABLE_LENGTH, /* 0F PinConfig */
263 ACPI_VARIABLE_LENGTH, /* 10 PinGroup */
264 ACPI_VARIABLE_LENGTH, /* 11 PinGroupFunction */
265 ACPI_VARIABLE_LENGTH, /* 12 PinGroupConfig */
266 };
267
268
269 /*******************************************************************************
270 *
271 * FUNCTION: AcpiUtWalkAmlResources
272 *
273 * PARAMETERS: WalkState - Current walk info
274 * PARAMETERS: Aml - Pointer to the raw AML resource template
275 * AmlLength - Length of the entire template
276 * UserFunction - Called once for each descriptor found. If
277 * NULL, a pointer to the EndTag is returned
278 * Context - Passed to UserFunction
279 *
280 * RETURN: Status
281 *
282 * DESCRIPTION: Walk a raw AML resource list(buffer). User function called
283 * once for each resource found.
284 *
285 ******************************************************************************/
286
287 ACPI_STATUS
AcpiUtWalkAmlResources(ACPI_WALK_STATE * WalkState,UINT8 * Aml,ACPI_SIZE AmlLength,ACPI_WALK_AML_CALLBACK UserFunction,void ** Context)288 AcpiUtWalkAmlResources (
289 ACPI_WALK_STATE *WalkState,
290 UINT8 *Aml,
291 ACPI_SIZE AmlLength,
292 ACPI_WALK_AML_CALLBACK UserFunction,
293 void **Context)
294 {
295 ACPI_STATUS Status;
296 UINT8 *EndAml;
297 UINT8 ResourceIndex;
298 UINT32 Length;
299 UINT32 Offset = 0;
300 UINT8 EndTag[2] = {0x79, 0x00};
301
302
303 ACPI_FUNCTION_TRACE (UtWalkAmlResources);
304
305
306 /* The absolute minimum resource template is one EndTag descriptor */
307
308 if (AmlLength < sizeof (AML_RESOURCE_END_TAG))
309 {
310 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
311 }
312
313 /* Point to the end of the resource template buffer */
314
315 EndAml = Aml + AmlLength;
316
317 /* Walk the byte list, abort on any invalid descriptor type or length */
318
319 while (Aml < EndAml)
320 {
321 /* Validate the Resource Type and Resource Length */
322
323 Status = AcpiUtValidateResource (WalkState, Aml, &ResourceIndex);
324 if (ACPI_FAILURE (Status))
325 {
326 /*
327 * Exit on failure. Cannot continue because the descriptor
328 * length may be bogus also.
329 */
330 return_ACPI_STATUS (Status);
331 }
332
333 /* Get the length of this descriptor */
334
335 Length = AcpiUtGetDescriptorLength (Aml);
336
337 /* Invoke the user function */
338
339 if (UserFunction)
340 {
341 Status = UserFunction (
342 Aml, Length, Offset, ResourceIndex, Context);
343 if (ACPI_FAILURE (Status))
344 {
345 return_ACPI_STATUS (Status);
346 }
347 }
348
349 /* An EndTag descriptor terminates this resource template */
350
351 if (AcpiUtGetResourceType (Aml) == ACPI_RESOURCE_NAME_END_TAG)
352 {
353 /*
354 * There must be at least one more byte in the buffer for
355 * the 2nd byte of the EndTag
356 */
357 if ((Aml + 1) >= EndAml)
358 {
359 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
360 }
361
362 /*
363 * Don't attempt to perform any validation on the 2nd byte.
364 * Although all known ASL compilers insert a zero for the 2nd
365 * byte, it can also be a checksum (as per the ACPI spec),
366 * and this is occasionally seen in the field. July 2017.
367 */
368
369 /* Return the pointer to the EndTag if requested */
370
371 if (!UserFunction)
372 {
373 *Context = Aml;
374 }
375
376 /* Normal exit */
377
378 return_ACPI_STATUS (AE_OK);
379 }
380
381 Aml += Length;
382 Offset += Length;
383 }
384
385 /* Did not find an EndTag descriptor */
386
387 if (UserFunction)
388 {
389 /* Insert an EndTag anyway. AcpiRsGetListLength always leaves room */
390
391 (void) AcpiUtValidateResource (WalkState, EndTag, &ResourceIndex);
392 Status = UserFunction (EndTag, 2, Offset, ResourceIndex, Context);
393 if (ACPI_FAILURE (Status))
394 {
395 return_ACPI_STATUS (Status);
396 }
397 }
398
399 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
400 }
401
402
403 /*******************************************************************************
404 *
405 * FUNCTION: AcpiUtValidateResource
406 *
407 * PARAMETERS: WalkState - Current walk info
408 * Aml - Pointer to the raw AML resource descriptor
409 * ReturnIndex - Where the resource index is returned. NULL
410 * if the index is not required.
411 *
412 * RETURN: Status, and optionally the Index into the global resource tables
413 *
414 * DESCRIPTION: Validate an AML resource descriptor by checking the Resource
415 * Type and Resource Length. Returns an index into the global
416 * resource information/dispatch tables for later use.
417 *
418 ******************************************************************************/
419
420 ACPI_STATUS
AcpiUtValidateResource(ACPI_WALK_STATE * WalkState,void * Aml,UINT8 * ReturnIndex)421 AcpiUtValidateResource (
422 ACPI_WALK_STATE *WalkState,
423 void *Aml,
424 UINT8 *ReturnIndex)
425 {
426 AML_RESOURCE *AmlResource;
427 UINT8 ResourceType;
428 UINT8 ResourceIndex;
429 ACPI_RS_LENGTH ResourceLength;
430 ACPI_RS_LENGTH MinimumResourceLength;
431
432
433 ACPI_FUNCTION_ENTRY ();
434
435
436 /*
437 * 1) Validate the ResourceType field (Byte 0)
438 */
439 ResourceType = ACPI_GET8 (Aml);
440
441 /*
442 * Byte 0 contains the descriptor name (Resource Type)
443 * Examine the large/small bit in the resource header
444 */
445 if (ResourceType & ACPI_RESOURCE_NAME_LARGE)
446 {
447 /* Verify the large resource type (name) against the max */
448
449 if (ResourceType > ACPI_RESOURCE_NAME_LARGE_MAX)
450 {
451 goto InvalidResource;
452 }
453
454 /*
455 * Large Resource Type -- bits 6:0 contain the name
456 * Translate range 0x80-0x8B to index range 0x10-0x1B
457 */
458 ResourceIndex = (UINT8) (ResourceType - 0x70);
459 }
460 else
461 {
462 /*
463 * Small Resource Type -- bits 6:3 contain the name
464 * Shift range to index range 0x00-0x0F
465 */
466 ResourceIndex = (UINT8)
467 ((ResourceType & ACPI_RESOURCE_NAME_SMALL_MASK) >> 3);
468 }
469
470 /*
471 * Check validity of the resource type, via AcpiGbl_ResourceTypes.
472 * Zero indicates an invalid resource.
473 */
474 if (!AcpiGbl_ResourceTypes[ResourceIndex])
475 {
476 goto InvalidResource;
477 }
478
479 /*
480 * Validate the ResourceLength field. This ensures that the length
481 * is at least reasonable, and guarantees that it is non-zero.
482 */
483 ResourceLength = AcpiUtGetResourceLength (Aml);
484 MinimumResourceLength = AcpiGbl_ResourceAmlSizes[ResourceIndex];
485
486 /* Validate based upon the type of resource - fixed length or variable */
487
488 switch (AcpiGbl_ResourceTypes[ResourceIndex])
489 {
490 case ACPI_FIXED_LENGTH:
491
492 /* Fixed length resource, length must match exactly */
493
494 if (ResourceLength != MinimumResourceLength)
495 {
496 goto BadResourceLength;
497 }
498 break;
499
500 case ACPI_VARIABLE_LENGTH:
501
502 /* Variable length resource, length must be at least the minimum */
503
504 if (ResourceLength < MinimumResourceLength)
505 {
506 goto BadResourceLength;
507 }
508 break;
509
510 case ACPI_SMALL_VARIABLE_LENGTH:
511
512 /* Small variable length resource, length can be (Min) or (Min-1) */
513
514 if ((ResourceLength > MinimumResourceLength) ||
515 (ResourceLength < (MinimumResourceLength - 1)))
516 {
517 goto BadResourceLength;
518 }
519 break;
520
521 default:
522
523 /* Shouldn't happen (because of validation earlier), but be sure */
524
525 goto InvalidResource;
526 }
527
528 AmlResource = ACPI_CAST_PTR (AML_RESOURCE, Aml);
529 if (ResourceType == ACPI_RESOURCE_NAME_SERIAL_BUS)
530 {
531 /* Validate the BusType field */
532
533 if ((AmlResource->CommonSerialBus.Type == 0) ||
534 (AmlResource->CommonSerialBus.Type > AML_RESOURCE_MAX_SERIALBUSTYPE))
535 {
536 if (WalkState)
537 {
538 ACPI_ERROR ((AE_INFO,
539 "Invalid/unsupported SerialBus resource descriptor: BusType 0x%2.2X",
540 AmlResource->CommonSerialBus.Type));
541 }
542 return (AE_AML_INVALID_RESOURCE_TYPE);
543 }
544 }
545
546 /* Optionally return the resource table index */
547
548 if (ReturnIndex)
549 {
550 *ReturnIndex = ResourceIndex;
551 }
552
553 return (AE_OK);
554
555
556 InvalidResource:
557
558 if (WalkState)
559 {
560 ACPI_ERROR ((AE_INFO,
561 "Invalid/unsupported resource descriptor: Type 0x%2.2X",
562 ResourceType));
563 }
564 return (AE_AML_INVALID_RESOURCE_TYPE);
565
566 BadResourceLength:
567
568 if (WalkState)
569 {
570 ACPI_ERROR ((AE_INFO,
571 "Invalid resource descriptor length: Type "
572 "0x%2.2X, Length 0x%4.4X, MinLength 0x%4.4X",
573 ResourceType, ResourceLength, MinimumResourceLength));
574 }
575 return (AE_AML_BAD_RESOURCE_LENGTH);
576 }
577
578
579 /*******************************************************************************
580 *
581 * FUNCTION: AcpiUtGetResourceType
582 *
583 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
584 *
585 * RETURN: The Resource Type with no extraneous bits (except the
586 * Large/Small descriptor bit -- this is left alone)
587 *
588 * DESCRIPTION: Extract the Resource Type/Name from the first byte of
589 * a resource descriptor.
590 *
591 ******************************************************************************/
592
593 UINT8
AcpiUtGetResourceType(void * Aml)594 AcpiUtGetResourceType (
595 void *Aml)
596 {
597 ACPI_FUNCTION_ENTRY ();
598
599
600 /*
601 * Byte 0 contains the descriptor name (Resource Type)
602 * Examine the large/small bit in the resource header
603 */
604 if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
605 {
606 /* Large Resource Type -- bits 6:0 contain the name */
607
608 return (ACPI_GET8 (Aml));
609 }
610 else
611 {
612 /* Small Resource Type -- bits 6:3 contain the name */
613
614 return ((UINT8) (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_SMALL_MASK));
615 }
616 }
617
618
619 /*******************************************************************************
620 *
621 * FUNCTION: AcpiUtGetResourceLength
622 *
623 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
624 *
625 * RETURN: Byte Length
626 *
627 * DESCRIPTION: Get the "Resource Length" of a raw AML descriptor. By
628 * definition, this does not include the size of the descriptor
629 * header or the length field itself.
630 *
631 ******************************************************************************/
632
633 UINT16
AcpiUtGetResourceLength(void * Aml)634 AcpiUtGetResourceLength (
635 void *Aml)
636 {
637 ACPI_RS_LENGTH ResourceLength;
638
639
640 ACPI_FUNCTION_ENTRY ();
641
642
643 /*
644 * Byte 0 contains the descriptor name (Resource Type)
645 * Examine the large/small bit in the resource header
646 */
647 if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
648 {
649 /* Large Resource type -- bytes 1-2 contain the 16-bit length */
650
651 ACPI_MOVE_16_TO_16 (&ResourceLength, ACPI_ADD_PTR (UINT8, Aml, 1));
652
653 }
654 else
655 {
656 /* Small Resource type -- bits 2:0 of byte 0 contain the length */
657
658 ResourceLength = (UINT16) (ACPI_GET8 (Aml) &
659 ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK);
660 }
661
662 return (ResourceLength);
663 }
664
665
666 /*******************************************************************************
667 *
668 * FUNCTION: AcpiUtGetResourceHeaderLength
669 *
670 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
671 *
672 * RETURN: Length of the AML header (depends on large/small descriptor)
673 *
674 * DESCRIPTION: Get the length of the header for this resource.
675 *
676 ******************************************************************************/
677
678 UINT8
AcpiUtGetResourceHeaderLength(void * Aml)679 AcpiUtGetResourceHeaderLength (
680 void *Aml)
681 {
682 ACPI_FUNCTION_ENTRY ();
683
684
685 /* Examine the large/small bit in the resource header */
686
687 if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE)
688 {
689 return (sizeof (AML_RESOURCE_LARGE_HEADER));
690 }
691 else
692 {
693 return (sizeof (AML_RESOURCE_SMALL_HEADER));
694 }
695 }
696
697
698 /*******************************************************************************
699 *
700 * FUNCTION: AcpiUtGetDescriptorLength
701 *
702 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
703 *
704 * RETURN: Byte length
705 *
706 * DESCRIPTION: Get the total byte length of a raw AML descriptor, including the
707 * length of the descriptor header and the length field itself.
708 * Used to walk descriptor lists.
709 *
710 ******************************************************************************/
711
712 UINT32
AcpiUtGetDescriptorLength(void * Aml)713 AcpiUtGetDescriptorLength (
714 void *Aml)
715 {
716 ACPI_FUNCTION_ENTRY ();
717
718
719 /*
720 * Get the Resource Length (does not include header length) and add
721 * the header length (depends on if this is a small or large resource)
722 */
723 return (AcpiUtGetResourceLength (Aml) +
724 AcpiUtGetResourceHeaderLength (Aml));
725 }
726
727
728 /*******************************************************************************
729 *
730 * FUNCTION: AcpiUtGetResourceEndTag
731 *
732 * PARAMETERS: ObjDesc - The resource template buffer object
733 * EndTag - Where the pointer to the EndTag is returned
734 *
735 * RETURN: Status, pointer to the end tag
736 *
737 * DESCRIPTION: Find the EndTag resource descriptor in an AML resource template
738 * Note: allows a buffer length of zero.
739 *
740 ******************************************************************************/
741
742 ACPI_STATUS
AcpiUtGetResourceEndTag(ACPI_OPERAND_OBJECT * ObjDesc,UINT8 ** EndTag)743 AcpiUtGetResourceEndTag (
744 ACPI_OPERAND_OBJECT *ObjDesc,
745 UINT8 **EndTag)
746 {
747 ACPI_STATUS Status;
748
749
750 ACPI_FUNCTION_TRACE (UtGetResourceEndTag);
751
752
753 /* Allow a buffer length of zero */
754
755 if (!ObjDesc->Buffer.Length)
756 {
757 *EndTag = ObjDesc->Buffer.Pointer;
758 return_ACPI_STATUS (AE_OK);
759 }
760
761 /* Validate the template and get a pointer to the EndTag */
762
763 Status = AcpiUtWalkAmlResources (NULL, ObjDesc->Buffer.Pointer,
764 ObjDesc->Buffer.Length, NULL, (void **) EndTag);
765
766 return_ACPI_STATUS (Status);
767 }
768