1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/** @file
Configuration Manager Object parser.
Copyright (c) 2021, ARM Limited. All rights reserved.<BR>
Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef CONFIGURATION_MANAGER_OBJECT_PARSER_H_
#define CONFIGURATION_MANAGER_OBJECT_PARSER_H_
#define OUTPUT_FIELD_COLUMN_WIDTH 32
/** A helper macro for populating the Reserved objects
like EArmObjReserved, EArmObjMax, etc. in the CM_OBJ_PARSER_ARRAY.
**/
#define CM_PARSER_ADD_OBJECT_RESERVED(ObjectId) \
{ObjectId, #ObjectId, NULL, 0}
/** A helper macro for populating the Cm Arm objects
in the CM_OBJ_PARSER_ARRAY.
**/
#define CM_PARSER_ADD_OBJECT(ObjectId, Parser) \
{ObjectId, #ObjectId, Parser, ARRAY_SIZE(Parser) }
/** Function prototype to format a field print.
@param [in] Format Format string for tracing the data as specified by
the 'Format' member of ACPI_PARSER.
@param [in] Ptr Pointer to the start of the buffer.
@param [in] Length Length of the field
**/
typedef VOID (EFIAPI *FNPTR_PRINT_FORMATTER)(CONST CHAR8 *Format, UINT8 *Ptr, UINT32 Length);
/**
The CM_OBJ_PARSER structure describes the fields of an CmObject and
provides means for the parser to interpret and trace appropriately.
ParseAcpi() uses the format string specified by 'Format' for tracing
the field data.
*/
typedef struct CmObjParser CM_OBJ_PARSER;
struct CmObjParser {
/// String describing the Cm Object
CONST CHAR8 *NameStr;
/// The length of the field.
UINT32 Length;
/// Optional Print() style format string for tracing the data. If not
/// used this must be set to NULL.
CONST CHAR8 *Format;
/// Optional pointer to a print formatter function which
/// is typically used to trace complex field information.
/// If not used this must be set to NULL.
/// The Format string is passed to the PrintFormatter function
/// but may be ignored by the implementation code.
FNPTR_PRINT_FORMATTER PrintFormatter;
/// Optional pointer to print the fields of another CM_OBJ_PARSER
/// structure. This is useful to print sub-structures.
CONST CM_OBJ_PARSER *SubObjParser;
/// Count of items in the SubObj.
UINTN SubObjItemCount;
};
/**
A structure mapping an array of Configuration Manager Object parsers
with their object names.
*/
typedef struct CmObjParserArray {
/// Object ID
CONST UINTN ObjectId;
/// Object name
CONST CHAR8 *ObjectName;
/// Function pointer to the parser
CONST CM_OBJ_PARSER *Parser;
/// Count of items
UINTN ItemCount;
} CM_OBJ_PARSER_ARRAY;
#endif // CONFIGURATION_MANAGER_OBJECT_PARSER_H_
|
