1 /** @file
2   Header file for ACPI parser
3 
4   Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.
5   SPDX-License-Identifier: BSD-2-Clause-Patent
6 **/
7 
8 #ifndef ACPIPARSER_H_
9 #define ACPIPARSER_H_
10 
11 #define OUTPUT_FIELD_COLUMN_WIDTH  36
12 
13 /// The RSDP table signature is "RSD PTR " (8 bytes)
14 /// However The signature for ACPI tables is 4 bytes.
15 /// To work around this oddity define a signature type
16 /// that allows us to process the log options.
17 #define RSDP_TABLE_INFO  SIGNATURE_32('R', 'S', 'D', 'P')
18 
19 /**
20   This function increments the ACPI table error counter.
21 **/
22 VOID
23 EFIAPI
24 IncrementErrorCount (
25   VOID
26   );
27 
28 /**
29   This function increments the ACPI table warning counter.
30 **/
31 VOID
32 EFIAPI
33 IncrementWarningCount (
34   VOID
35   );
36 
37 /**
38   This function verifies the ACPI table checksum.
39 
40   This function verifies the checksum for the ACPI table and optionally
41   prints the status.
42 
43   @param [in] Log     If TRUE log the status of the checksum.
44   @param [in] Ptr     Pointer to the start of the table buffer.
45   @param [in] Length  The length of the buffer.
46 
47   @retval TRUE         The checksum is OK.
48   @retval FALSE        The checksum failed.
49 **/
50 BOOLEAN
51 EFIAPI
52 VerifyChecksum (
53   IN BOOLEAN Log,
54   IN UINT8*  Ptr,
55   IN UINT32  Length
56   );
57 
58 /**
59   This function performs a raw data dump of the ACPI table.
60 
61   @param [in] Ptr     Pointer to the start of the table buffer.
62   @param [in] Length  The length of the buffer.
63 **/
64 VOID
65 EFIAPI
66 DumpRaw (
67   IN UINT8* Ptr,
68   IN UINT32 Length
69   );
70 
71 /**
72   This function traces 1 byte of datum as specified in the format string.
73 
74   @param [in] Format  The format string for tracing the data.
75   @param [in] Ptr     Pointer to the start of the buffer.
76 **/
77 VOID
78 EFIAPI
79 DumpUint8 (
80   IN CONST CHAR16* Format,
81   IN UINT8*        Ptr
82   );
83 
84 /**
85   This function traces 2 bytes of data as specified in the format string.
86 
87   @param [in] Format  The format string for tracing the data.
88   @param [in] Ptr     Pointer to the start of the buffer.
89 **/
90 VOID
91 EFIAPI
92 DumpUint16 (
93   IN CONST CHAR16* Format,
94   IN UINT8*        Ptr
95   );
96 
97 /**
98   This function traces 4 bytes of data as specified in the format string.
99 
100   @param [in] Format  The format string for tracing the data.
101   @param [in] Ptr     Pointer to the start of the buffer.
102 **/
103 VOID
104 EFIAPI
105 DumpUint32 (
106   IN CONST CHAR16* Format,
107   IN UINT8*        Ptr
108   );
109 
110 /**
111   This function traces 8 bytes of data as specified by the format string.
112 
113   @param [in] Format  The format string for tracing the data.
114   @param [in] Ptr     Pointer to the start of the buffer.
115 **/
116 VOID
117 EFIAPI
118 DumpUint64 (
119   IN CONST CHAR16* Format,
120   IN UINT8*        Ptr
121   );
122 
123 /**
124   This function traces 3 characters which can be optionally
125   formated using the format string if specified.
126 
127   If no format string is specified the Format must be NULL.
128 
129   @param [in] Format  Optional format string for tracing the data.
130   @param [in] Ptr     Pointer to the start of the buffer.
131 **/
132 VOID
133 EFIAPI
134 Dump3Chars (
135   IN CONST CHAR16* Format OPTIONAL,
136   IN UINT8*        Ptr
137   );
138 
139 /**
140   This function traces 4 characters which can be optionally
141   formated using the format string if specified.
142 
143   If no format string is specified the Format must be NULL.
144 
145   @param [in] Format  Optional format string for tracing the data.
146   @param [in] Ptr     Pointer to the start of the buffer.
147 **/
148 VOID
149 EFIAPI
150 Dump4Chars (
151   IN CONST CHAR16* Format OPTIONAL,
152   IN UINT8*        Ptr
153   );
154 
155 /**
156   This function traces 6 characters which can be optionally
157   formated using the format string if specified.
158 
159   If no format string is specified the Format must be NULL.
160 
161   @param [in] Format  Optional format string for tracing the data.
162   @param [in] Ptr     Pointer to the start of the buffer.
163 **/
164 VOID
165 EFIAPI
166 Dump6Chars (
167   IN CONST CHAR16* Format OPTIONAL,
168   IN UINT8*        Ptr
169   );
170 
171 /**
172   This function traces 8 characters which can be optionally
173   formated using the format string if specified.
174 
175   If no format string is specified the Format must be NULL.
176 
177   @param [in] Format  Optional format string for tracing the data.
178   @param [in] Ptr     Pointer to the start of the buffer.
179 **/
180 VOID
181 EFIAPI
182 Dump8Chars (
183   IN CONST CHAR16* Format OPTIONAL,
184   IN UINT8*        Ptr
185   );
186 
187 /**
188   This function indents and prints the ACPI table Field Name.
189 
190   @param [in] Indent      Number of spaces to add to the global table
191                           indent. The global table indent is 0 by default;
192                           however this value is updated on entry to the
193                           ParseAcpi() by adding the indent value provided to
194                           ParseAcpi() and restored back on exit. Therefore
195                           the total indent in the output is dependent on from
196                           where this function is called.
197   @param [in] FieldName   Pointer to the Field Name.
198 **/
199 VOID
200 EFIAPI
201 PrintFieldName (
202   IN UINT32         Indent,
203   IN CONST CHAR16*  FieldName
204   );
205 
206 /**
207   This function pointer is the template for customizing the trace output
208 
209   @param [in] Format  Format string for tracing the data as specified by
210                       the 'Format' member of ACPI_PARSER.
211   @param [in] Ptr     Pointer to the start of the buffer.
212 **/
213 typedef VOID (EFIAPI *FNPTR_PRINT_FORMATTER)(CONST CHAR16* Format, UINT8* Ptr);
214 
215 /**
216   This function pointer is the template for validating an ACPI table field.
217 
218   @param [in] Ptr     Pointer to the start of the field data.
219   @param [in] Context Pointer to context specific information as specified by
220                       the 'Context' member of the ACPI_PARSER.
221                       e.g. this could be a pointer to the ACPI table header.
222 **/
223 typedef VOID (EFIAPI *FNPTR_FIELD_VALIDATOR)(UINT8* Ptr, VOID* Context);
224 
225 /**
226   The ACPI_PARSER structure describes the fields of an ACPI table and
227   provides means for the parser to interpret and trace appropriately.
228 
229   The first three members are populated based on information present in
230   in the ACPI table specifications. The remaining members describe how
231   the parser should report the field information, validate the field data
232   and/or update an external pointer to the field (ItemPtr).
233 
234   ParseAcpi() uses the format string specified by 'Format' for tracing
235   the field data. If the field is more complex and requires additional
236   processing for formatting and representation a print formatter function
237   can be specified in 'PrintFormatter'.
238   The PrintFormatter function may choose to use the format string
239   specified by 'Format' or use its own internal format string.
240 
241   The 'Format' and 'PrintFormatter' members allow flexibility for
242   representing the field data.
243 **/
244 typedef struct AcpiParser {
245 
246   /// String describing the ACPI table field
247   /// (Field column from ACPI table spec)
248   CONST CHAR16*         NameStr;
249 
250   /// The length of the field.
251   /// (Byte Length column from ACPI table spec)
252   UINT32                Length;
253 
254   /// The offset of the field from the start of the table.
255   /// (Byte Offset column from ACPI table spec)
256   UINT32                Offset;
257 
258   /// Optional Print() style format string for tracing the data. If not
259   /// used this must be set to NULL.
260   CONST CHAR16*         Format;
261 
262   /// Optional pointer to a print formatter function which
263   /// is typically used to trace complex field information.
264   /// If not used this must be set to NULL.
265   /// The Format string is passed to the PrintFormatter function
266   /// but may be ignored by the implementation code.
267   FNPTR_PRINT_FORMATTER PrintFormatter;
268 
269   /// Optional pointer which may be set to request the parser to update
270   /// a pointer to the field data. If unused this must be set to NULL.
271   VOID**                ItemPtr;
272 
273   /// Optional pointer to a field validator function.
274   /// The function should directly report any appropriate error or warning
275   /// and invoke the appropriate counter update function.
276   /// If not used this parameter must be set to NULL.
277   FNPTR_FIELD_VALIDATOR FieldValidator;
278 
279   /// Optional pointer to context specific information,
280   /// which the Field Validator function can use to determine
281   /// additional information about the ACPI table and make
282   /// decisions about the field being validated.
283   /// e.g. this could be a pointer to the ACPI table header
284   VOID*                 Context;
285 } ACPI_PARSER;
286 
287 /**
288   A structure used to store the pointers to the members of the
289   ACPI description header structure that was parsed.
290 **/
291 typedef struct AcpiDescriptionHeaderInfo {
292   /// ACPI table signature
293   UINT32* Signature;
294   /// Length of the ACPI table
295   UINT32* Length;
296   /// Revision
297   UINT8*  Revision;
298   /// Checksum
299   UINT8*  Checksum;
300   /// OEM Id - length is 6 bytes
301   UINT8*  OemId;
302   /// OEM table Id
303   UINT64* OemTableId;
304   /// OEM revision Id
305   UINT32* OemRevision;
306   /// Creator Id
307   UINT32* CreatorId;
308   /// Creator revision
309   UINT32* CreatorRevision;
310 } ACPI_DESCRIPTION_HEADER_INFO;
311 
312 /**
313   This function is used to parse an ACPI table buffer.
314 
315   The ACPI table buffer is parsed using the ACPI table parser information
316   specified by a pointer to an array of ACPI_PARSER elements. This parser
317   function iterates through each item on the ACPI_PARSER array and logs the
318   ACPI table fields.
319 
320   This function can optionally be used to parse ACPI tables and fetch specific
321   field values. The ItemPtr member of the ACPI_PARSER structure (where used)
322   is updated by this parser function to point to the selected field data
323   (e.g. useful for variable length nested fields).
324 
325   @param [in] Trace        Trace the ACPI fields TRUE else only parse the
326                            table.
327   @param [in] Indent       Number of spaces to indent the output.
328   @param [in] AsciiName    Optional pointer to an ASCII string that describes
329                            the table being parsed.
330   @param [in] Ptr          Pointer to the start of the buffer.
331   @param [in] Length       Length of the buffer pointed by Ptr.
332   @param [in] Parser       Pointer to an array of ACPI_PARSER structure that
333                            describes the table being parsed.
334   @param [in] ParserItems  Number of items in the ACPI_PARSER array.
335 
336   @retval Number of bytes parsed.
337 **/
338 UINT32
339 EFIAPI
340 ParseAcpi (
341   IN BOOLEAN            Trace,
342   IN UINT32             Indent,
343   IN CONST CHAR8*       AsciiName OPTIONAL,
344   IN UINT8*             Ptr,
345   IN UINT32             Length,
346   IN CONST ACPI_PARSER* Parser,
347   IN UINT32             ParserItems
348   );
349 
350 /**
351    This is a helper macro to pass parameters to the Parser functions.
352 
353   @param [in] Parser The name of the ACPI_PARSER array describing the
354               ACPI table fields.
355 **/
356 #define PARSER_PARAMS(Parser) Parser, sizeof (Parser) / sizeof (Parser[0])
357 
358 /**
359   This is a helper macro for describing the ACPI header fields.
360 
361   @param [out] Info  Pointer to retrieve the ACPI table header information.
362 **/
363 #define PARSE_ACPI_HEADER(Info)                   \
364   { L"Signature", 4, 0, NULL, Dump4Chars,         \
365     (VOID**)&(Info)->Signature , NULL, NULL },    \
366   { L"Length", 4, 4, L"%d", NULL,                 \
367     (VOID**)&(Info)->Length, NULL, NULL },        \
368   { L"Revision", 1, 8, L"%d", NULL,               \
369     (VOID**)&(Info)->Revision, NULL, NULL },      \
370   { L"Checksum", 1, 9, L"0x%X", NULL,             \
371     (VOID**)&(Info)->Checksum, NULL, NULL },      \
372   { L"Oem ID", 6, 10, NULL, Dump6Chars,           \
373     (VOID**)&(Info)->OemId, NULL, NULL },         \
374   { L"Oem Table ID", 8, 16, NULL, Dump8Chars,     \
375     (VOID**)&(Info)->OemTableId, NULL, NULL },    \
376   { L"Oem Revision", 4, 24, L"0x%X", NULL,        \
377     (VOID**)&(Info)->OemRevision, NULL, NULL },   \
378   { L"Creator ID", 4, 28, NULL, Dump4Chars,       \
379     (VOID**)&(Info)->CreatorId, NULL, NULL },     \
380   { L"Creator Revision", 4, 32, L"0x%X", NULL,    \
381     (VOID**)&(Info)->CreatorRevision, NULL, NULL }
382 
383 /**
384   Length of the ACPI GAS structure.
385 
386   NOTE: This might normally be defined as
387         sizeof (EFI_ACPI_6_2_GENERIC_ADDRESS_STRUCTURE).
388         However, we deliberately minimise any reference to the EDK2 ACPI
389         headers in an attempt to provide cross checking.
390 **/
391 #define GAS_LENGTH                     12
392 
393 /**
394   Length of the ACPI Header structure.
395 
396   NOTE: This might normally be defined as
397         sizeof (EFI_ACPI_DESCRIPTION_HEADER).
398         However, we deliberately minimise any reference to the EDK2 ACPI
399         headers in an attempt to provide cross checking.
400 **/
401 #define ACPI_DESCRIPTION_HEADER_LENGTH  36
402 
403 /**
404   This function indents and traces the GAS structure as described by the GasParser.
405 
406   @param [in] Ptr     Pointer to the start of the buffer.
407   @param [in] Indent  Number of spaces to indent the output.
408   @param [in] Length  Length of the GAS structure buffer.
409 
410   @retval Number of bytes parsed.
411 **/
412 UINT32
413 EFIAPI
414 DumpGasStruct (
415   IN UINT8*        Ptr,
416   IN UINT32        Indent,
417   IN UINT32        Length
418   );
419 
420 /**
421   This function traces the GAS structure as described by the GasParser.
422 
423   @param [in] Format  Optional format string for tracing the data.
424   @param [in] Ptr     Pointer to the start of the buffer.
425 **/
426 VOID
427 EFIAPI
428 DumpGas (
429   IN CONST CHAR16* Format OPTIONAL,
430   IN UINT8*        Ptr
431   );
432 
433 /**
434   This function traces the ACPI header as described by the AcpiHeaderParser.
435 
436   @param [in] Ptr          Pointer to the start of the buffer.
437 
438   @retval Number of bytes parsed.
439 **/
440 UINT32
441 EFIAPI
442 DumpAcpiHeader (
443   IN UINT8* Ptr
444   );
445 
446 /**
447   This function parses the ACPI header as described by the AcpiHeaderParser.
448 
449   This function optionally returns the Signature, Length and revision of the
450   ACPI table.
451 
452   @param [in]  Ptr        Pointer to the start of the buffer.
453   @param [out] Signature  Gets location of the ACPI table signature.
454   @param [out] Length     Gets location of the length of the ACPI table.
455   @param [out] Revision   Gets location of the revision of the ACPI table.
456 
457   @retval Number of bytes parsed.
458 **/
459 UINT32
460 EFIAPI
461 ParseAcpiHeader (
462   IN  UINT8*         Ptr,
463   OUT CONST UINT32** Signature,
464   OUT CONST UINT32** Length,
465   OUT CONST UINT8**  Revision
466   );
467 
468 /**
469   This function parses the ACPI BGRT table.
470   When trace is enabled this function parses the BGRT table and
471   traces the ACPI table fields.
472 
473   This function also performs validation of the ACPI table fields.
474 
475   @param [in] Trace              If TRUE, trace the ACPI fields.
476   @param [in] Ptr                Pointer to the start of the buffer.
477   @param [in] AcpiTableLength    Length of the ACPI table.
478   @param [in] AcpiTableRevision  Revision of the ACPI table.
479 **/
480 VOID
481 EFIAPI
482 ParseAcpiBgrt (
483   IN BOOLEAN Trace,
484   IN UINT8*  Ptr,
485   IN UINT32  AcpiTableLength,
486   IN UINT8   AcpiTableRevision
487   );
488 
489 /**
490   This function parses the ACPI DBG2 table.
491   When trace is enabled this function parses the DBG2 table and
492   traces the ACPI table fields.
493 
494   This function also performs validation of the ACPI table fields.
495 
496   @param [in] Trace              If TRUE, trace the ACPI fields.
497   @param [in] Ptr                Pointer to the start of the buffer.
498   @param [in] AcpiTableLength    Length of the ACPI table.
499   @param [in] AcpiTableRevision  Revision of the ACPI table.
500 **/
501 VOID
502 EFIAPI
503 ParseAcpiDbg2 (
504   IN BOOLEAN Trace,
505   IN UINT8*  Ptr,
506   IN UINT32  AcpiTableLength,
507   IN UINT8   AcpiTableRevision
508   );
509 
510 /**
511   This function parses the ACPI DSDT table.
512   When trace is enabled this function parses the DSDT table and
513   traces the ACPI table fields.
514   For the DSDT table only the ACPI header fields are parsed and
515   traced.
516 
517   @param [in] Trace              If TRUE, trace the ACPI fields.
518   @param [in] Ptr                Pointer to the start of the buffer.
519   @param [in] AcpiTableLength    Length of the ACPI table.
520   @param [in] AcpiTableRevision  Revision of the ACPI table.
521 **/
522 VOID
523 EFIAPI
524 ParseAcpiDsdt (
525   IN BOOLEAN Trace,
526   IN UINT8*  Ptr,
527   IN UINT32  AcpiTableLength,
528   IN UINT8   AcpiTableRevision
529   );
530 
531 /**
532   This function parses the ACPI FADT table.
533   This function parses the FADT table and optionally traces the ACPI
534   table fields.
535 
536   This function also performs validation of the ACPI table fields.
537 
538   @param [in] Trace              If TRUE, trace the ACPI fields.
539   @param [in] Ptr                Pointer to the start of the buffer.
540   @param [in] AcpiTableLength    Length of the ACPI table.
541   @param [in] AcpiTableRevision  Revision of the ACPI table.
542 **/
543 VOID
544 EFIAPI
545 ParseAcpiFadt (
546   IN BOOLEAN Trace,
547   IN UINT8*  Ptr,
548   IN UINT32  AcpiTableLength,
549   IN UINT8   AcpiTableRevision
550   );
551 
552 /**
553   This function parses the ACPI GTDT table.
554   When trace is enabled this function parses the GTDT table and
555   traces the ACPI table fields.
556 
557   This function also parses the following platform timer structures:
558     - GT Block timer
559     - Watchdog timer
560 
561   This function also performs validation of the ACPI table fields.
562 
563   @param [in] Trace              If TRUE, trace the ACPI fields.
564   @param [in] Ptr                Pointer to the start of the buffer.
565   @param [in] AcpiTableLength    Length of the ACPI table.
566   @param [in] AcpiTableRevision  Revision of the ACPI table.
567 **/
568 VOID
569 EFIAPI
570 ParseAcpiGtdt (
571   IN BOOLEAN Trace,
572   IN UINT8*  Ptr,
573   IN UINT32  AcpiTableLength,
574   IN UINT8   AcpiTableRevision
575   );
576 
577 /**
578   This function parses the ACPI IORT table.
579   When trace is enabled this function parses the IORT table and
580   traces the ACPI fields.
581 
582   This function also parses the following nodes:
583     - ITS Group
584     - Named Component
585     - Root Complex
586     - SMMUv1/2
587     - SMMUv3
588     - PMCG
589 
590   This function also performs validation of the ACPI table fields.
591 
592   @param [in] Trace              If TRUE, trace the ACPI fields.
593   @param [in] Ptr                Pointer to the start of the buffer.
594   @param [in] AcpiTableLength    Length of the ACPI table.
595   @param [in] AcpiTableRevision  Revision of the ACPI table.
596 **/
597 VOID
598 EFIAPI
599 ParseAcpiIort (
600   IN BOOLEAN Trace,
601   IN UINT8*  Ptr,
602   IN UINT32  AcpiTableLength,
603   IN UINT8   AcpiTableRevision
604   );
605 
606 /**
607   This function parses the ACPI MADT table.
608   When trace is enabled this function parses the MADT table and
609   traces the ACPI table fields.
610 
611   This function currently parses the following Interrupt Controller
612   Structures:
613     - GICC
614     - GICD
615     - GIC MSI Frame
616     - GICR
617     - GIC ITS
618 
619   This function also performs validation of the ACPI table fields.
620 
621   @param [in] Trace              If TRUE, trace the ACPI fields.
622   @param [in] Ptr                Pointer to the start of the buffer.
623   @param [in] AcpiTableLength    Length of the ACPI table.
624   @param [in] AcpiTableRevision  Revision of the ACPI table.
625 **/
626 VOID
627 EFIAPI
628 ParseAcpiMadt (
629   IN BOOLEAN Trace,
630   IN UINT8*  Ptr,
631   IN UINT32  AcpiTableLength,
632   IN UINT8   AcpiTableRevision
633   );
634 
635 /**
636   This function parses the ACPI MCFG table.
637   When trace is enabled this function parses the MCFG table and
638   traces the ACPI table fields.
639 
640   This function also performs validation of the ACPI table fields.
641 
642   @param [in] Trace              If TRUE, trace the ACPI fields.
643   @param [in] Ptr                Pointer to the start of the buffer.
644   @param [in] AcpiTableLength    Length of the ACPI table.
645   @param [in] AcpiTableRevision  Revision of the ACPI table.
646 **/
647 VOID
648 EFIAPI
649 ParseAcpiMcfg (
650   IN BOOLEAN Trace,
651   IN UINT8*  Ptr,
652   IN UINT32  AcpiTableLength,
653   IN UINT8   AcpiTableRevision
654   );
655 
656 /**
657   This function parses the ACPI PPTT table.
658   When trace is enabled this function parses the PPTT table and
659   traces the ACPI table fields.
660 
661   This function also performs validation of the ACPI table fields.
662 
663   @param [in] Trace              If TRUE, trace the ACPI fields.
664   @param [in] Ptr                Pointer to the start of the buffer.
665   @param [in] AcpiTableLength    Length of the ACPI table.
666   @param [in] AcpiTableRevision  Revision of the ACPI table.
667 **/
668 VOID
669 EFIAPI
670 ParseAcpiPptt (
671   IN BOOLEAN Trace,
672   IN UINT8*  Ptr,
673   IN UINT32  AcpiTableLength,
674   IN UINT8   AcpiTableRevision
675   );
676 
677 /**
678   This function parses the ACPI RSDP table.
679 
680   This function invokes the parser for the XSDT table.
681   * Note - This function does not support parsing of RSDT table.
682 
683   This function also performs a RAW dump of the ACPI table and
684   validates the checksum.
685 
686   @param [in] Trace              If TRUE, trace the ACPI fields.
687   @param [in] Ptr                Pointer to the start of the buffer.
688   @param [in] AcpiTableLength    Length of the ACPI table.
689   @param [in] AcpiTableRevision  Revision of the ACPI table.
690 **/
691 VOID
692 EFIAPI
693 ParseAcpiRsdp (
694   IN BOOLEAN Trace,
695   IN UINT8*  Ptr,
696   IN UINT32  AcpiTableLength,
697   IN UINT8   AcpiTableRevision
698   );
699 
700 /**
701   This function parses the ACPI SLIT table.
702   When trace is enabled this function parses the SLIT table and
703   traces the ACPI table fields.
704 
705   This function also validates System Localities for the following:
706     - Diagonal elements have a normalized value of 10
707     - Relative distance from System Locality at i*N+j is same as
708       j*N+i
709 
710   @param [in] Trace              If TRUE, trace the ACPI fields.
711   @param [in] Ptr                Pointer to the start of the buffer.
712   @param [in] AcpiTableLength    Length of the ACPI table.
713   @param [in] AcpiTableRevision  Revision of the ACPI table.
714 **/
715 VOID
716 EFIAPI
717 ParseAcpiSlit (
718   IN BOOLEAN Trace,
719   IN UINT8*  Ptr,
720   IN UINT32  AcpiTableLength,
721   IN UINT8   AcpiTableRevision
722   );
723 
724 /**
725   This function parses the ACPI SPCR table.
726   When trace is enabled this function parses the SPCR table and
727   traces the ACPI table fields.
728 
729   This function also performs validations of the ACPI table fields.
730 
731   @param [in] Trace              If TRUE, trace the ACPI fields.
732   @param [in] Ptr                Pointer to the start of the buffer.
733   @param [in] AcpiTableLength    Length of the ACPI table.
734   @param [in] AcpiTableRevision  Revision of the ACPI table.
735 **/
736 VOID
737 EFIAPI
738 ParseAcpiSpcr (
739   IN BOOLEAN Trace,
740   IN UINT8*  Ptr,
741   IN UINT32  AcpiTableLength,
742   IN UINT8   AcpiTableRevision
743   );
744 
745 /**
746   This function parses the ACPI SRAT table.
747   When trace is enabled this function parses the SRAT table and
748   traces the ACPI table fields.
749 
750   This function parses the following Resource Allocation Structures:
751     - Processor Local APIC/SAPIC Affinity Structure
752     - Memory Affinity Structure
753     - Processor Local x2APIC Affinity Structure
754     - GICC Affinity Structure
755 
756   This function also performs validation of the ACPI table fields.
757 
758   @param [in] Trace              If TRUE, trace the ACPI fields.
759   @param [in] Ptr                Pointer to the start of the buffer.
760   @param [in] AcpiTableLength    Length of the ACPI table.
761   @param [in] AcpiTableRevision  Revision of the ACPI table.
762 **/
763 VOID
764 EFIAPI
765 ParseAcpiSrat (
766   IN BOOLEAN Trace,
767   IN UINT8*  Ptr,
768   IN UINT32  AcpiTableLength,
769   IN UINT8   AcpiTableRevision
770   );
771 
772 /**
773   This function parses the ACPI SSDT table.
774   When trace is enabled this function parses the SSDT table and
775   traces the ACPI table fields.
776   For the SSDT table only the ACPI header fields are
777   parsed and traced.
778 
779   @param [in] Trace              If TRUE, trace the ACPI fields.
780   @param [in] Ptr                Pointer to the start of the buffer.
781   @param [in] AcpiTableLength    Length of the ACPI table.
782   @param [in] AcpiTableRevision  Revision of the ACPI table.
783 **/
784 VOID
785 EFIAPI
786 ParseAcpiSsdt (
787   IN BOOLEAN Trace,
788   IN UINT8*  Ptr,
789   IN UINT32  AcpiTableLength,
790   IN UINT8   AcpiTableRevision
791   );
792 
793 /**
794   This function parses the ACPI XSDT table
795   and optionally traces the ACPI table fields.
796 
797   This function also performs validation of the XSDT table.
798 
799   @param [in] Trace              If TRUE, trace the ACPI fields.
800   @param [in] Ptr                Pointer to the start of the buffer.
801   @param [in] AcpiTableLength    Length of the ACPI table.
802   @param [in] AcpiTableRevision  Revision of the ACPI table.
803 **/
804 VOID
805 EFIAPI
806 ParseAcpiXsdt (
807   IN BOOLEAN Trace,
808   IN UINT8*  Ptr,
809   IN UINT32  AcpiTableLength,
810   IN UINT8   AcpiTableRevision
811   );
812 
813 #endif // ACPIPARSER_H_
814