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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
|
/** @file
AML Core Interface.
Copyright (c) 2019 - 2020, Arm Limited. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef AML_CORE_INTERFACE_H_
#define AML_CORE_INTERFACE_H_
/* This header file does not include internal Node definition,
i.e. AML_ROOT_NODE, AML_OBJECT_NODE, etc. The node definitions
must be included by the caller file. The function prototypes must
only expose AML_NODE_HANDLE, AML_ROOT_NODE_HANDLE, etc. node
definitions.
This allows to keep the functions defined here both internal and
potentially external. If necessary, any function of this file can
be exposed externally.
The Api folder is internal to the AmlLib, but should only use these
functions. They provide a "safe" way to interact with the AmlLib.
*/
#include <AmlDefines.h>
#include <Include/Library/AmlLib/AmlLib.h>
#include <ResourceData/AmlResourceData.h>
/**
@defgroup CoreApis Core APIs
@ingroup AMLLib
@{
Core APIs are the main APIs of the library. They allow to:
- Create an AML tree;
- Delete an AML tree;
- Clone an AML tree/node;
- Serialize an AML tree (convert the tree to a DSDT/SSDT table).
@}
*/
/** Serialize a tree to create a DSDT/SSDT table.
If:
- the content of BufferSize is >= to the size needed to serialize the
definition block;
- Buffer is not NULL;
first serialize the ACPI DSDT/SSDT header from the root node,
then serialize the AML blob from the rest of the tree.
The content of BufferSize is always updated to the size needed to
serialize the definition block.
@ingroup CoreApis
@param [in] RootNode Pointer to a root node.
@param [in] Buffer Buffer to write the DSDT/SSDT table to.
If Buffer is NULL, the size needed to
serialize the DSDT/SSDT table is returned
in BufferSize.
@param [in, out] BufferSize Pointer holding the size of the Buffer.
Its content is always updated to the size
needed to serialize the DSDT/SSDT table.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_BUFFER_TOO_SMALL No space left in the buffer.
**/
EFI_STATUS
EFIAPI
AmlSerializeTree (
IN AML_ROOT_NODE_HANDLE RootNode,
IN UINT8 * Buffer, OPTIONAL
IN OUT UINT32 * BufferSize
);
/** Clone a node.
This function does not clone the children nodes.
The cloned node returned is not attached to any tree.
@ingroup CoreApis
@param [in] Node Pointer to a node.
@param [out] ClonedNode Pointer holding the cloned node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Could not allocate memory.
**/
EFI_STATUS
EFIAPI
AmlCloneNode (
IN AML_NODE_HANDLE Node,
OUT AML_NODE_HANDLE * ClonedNode
);
/**
@defgroup TreeModificationApis Tree modification APIs
@ingroup AMLLib
@{
Tree modification APIs allow to add/remove/replace nodes that are in a
variable list of arguments.
No interface is provided to add/remove/replace nodes that are in a fixed
list of arguments. Indeed, these nodes are the spine of the tree and a
mismanipulation would make the tree inconsistent.
It is however possible to modify the content of fixed argument nodes via
@ref NodeInterfaceApis APIs.
@}
*/
/** Remove the Node from its parent's variable list of arguments.
The function will fail if the Node is in its parent's fixed
argument list.
The Node is not deleted. The deletion is done separately
from the removal.
@ingroup TreeModificationApis
@param [in] Node Pointer to a Node.
Must be a data node or an object node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlRemoveNodeFromVarArgList (
IN AML_NODE_HANDLE Node
);
/** Add the NewNode to the head of the variable list of arguments
of the ParentNode.
@ingroup TreeModificationApis
@param [in] ParentNode Pointer to the parent node.
Must be a root or an object node.
@param [in] NewNode Pointer to the node to add.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlVarListAddHead (
IN AML_NODE_HANDLE ParentNode,
IN AML_NODE_HANDLE NewNode
);
/** Add the NewNode to the tail of the variable list of arguments
of the ParentNode.
@ingroup TreeModificationApis
@param [in] ParentNode Pointer to the parent node.
Must be a root or an object node.
@param [in] NewNode Pointer to the node to add.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlVarListAddTail (
IN AML_NODE_HANDLE ParentNode,
IN AML_NODE_HANDLE NewNode
);
/** Add the NewNode before the Node in the list of variable
arguments of the Node's parent.
@ingroup TreeModificationApis
@param [in] Node Pointer to a node.
Must be a root or an object node.
@param [in] NewNode Pointer to the node to add.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlVarListAddBefore (
IN AML_NODE_HANDLE Node,
IN AML_NODE_HANDLE NewNode
);
/** Add the NewNode after the Node in the variable list of arguments
of the Node's parent.
@ingroup TreeModificationApis
@param [in] Node Pointer to a node.
Must be a root or an object node.
@param [in] NewNode Pointer to the node to add.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlVarListAddAfter (
IN AML_NODE_HANDLE Node,
IN AML_NODE_HANDLE NewNode
);
/** Append a Resource Data node to the BufferOpNode.
The Resource Data node is added at the end of the variable
list of arguments of the BufferOpNode, but before the End Tag.
If no End Tag is found, the function returns an error.
@param [in] BufferOpNode Buffer node containing resource data elements.
@param [in] NewRdNode The new Resource Data node to add.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlAppendRdNode (
IN AML_OBJECT_NODE_HANDLE BufferOpNode,
IN AML_DATA_NODE_HANDLE NewRdNode
);
/** Replace the OldNode, which is in a variable list of arguments,
with the NewNode.
Note: This function unlinks the OldNode from the tree. It is the callers
responsibility to delete the OldNode if needed.
@ingroup TreeModificationApis
@param [in] OldNode Pointer to the node to replace.
Must be a data node or an object node.
@param [in] NewNode The new node to insert.
Must be a data node or an object node.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlReplaceVariableArgument (
IN AML_NODE_HANDLE OldNode,
IN AML_NODE_HANDLE NewNode
);
/**
@defgroup NodeInterfaceApis Node Interface APIs
@ingroup AMLLib
@{
Node Interface APIs allow to query information from a node. Some functions
expect a specific node type among the root/object/data node types.
For instance, AmlGetRootNodeInfo expects to receive a root node.
E.g.: Query the node type, the ACPI header stored in the root node,
the OpCode/SubOpCode/PkgLen of an object node, the type of data
stored in a data node, etc.
These APIs also allow to update some information.
E.g.: The ACPI header stored in the root node, the buffer of a data node.
The information of object nodes and the data type of data nodes cannot be
modified. This prevents the creation of an inconsistent tree.
It is however possible to remove a node from a variable list of arguments
and replace it. Use the @ref TreeModificationApis APIs for this.
@}
*/
/** Returns the tree node type (Root/Object/Data).
@ingroup NodeInterfaceApis
@param [in] Node Pointer to a Node.
@return The node type.
EAmlNodeUnknown if invalid parameter.
**/
EAML_NODE_TYPE
EFIAPI
AmlGetNodeType (
IN AML_NODE_HANDLE Node
);
/** Get the RootNode information.
The Node must be a root node.
@ingroup NodeInterfaceApis
@param [in] RootNode Pointer to a root node.
@param [out] SdtHeaderBuffer Buffer to copy the ACPI DSDT/SSDT header to.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlGetRootNodeInfo (
IN AML_ROOT_NODE_HANDLE RootNode,
OUT EFI_ACPI_DESCRIPTION_HEADER * SdtHeaderBuffer
);
/** Get the ObjectNode information.
The Node must be an object node.
@ingroup NodeInterfaceApis
@param [in] ObjectNode Pointer to an object node.
@param [out] OpCode Pointer holding the OpCode.
Optional, can be NULL.
@param [out] SubOpCode Pointer holding the SubOpCode.
Optional, can be NULL.
@param [out] PkgLen Pointer holding the PkgLen.
The PkgLen is 0 for nodes
not having the Pkglen attribute.
Optional, can be NULL.
@param [out] IsNameSpaceNode Pointer holding TRUE if the node is defining
or changing the NameSpace scope.
E.g.: The "Name ()" and "Scope ()" ASL
statements add/modify the NameSpace scope.
Their corresponding node are NameSpace nodes.
Optional, can be NULL.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlGetObjectNodeInfo (
IN AML_OBJECT_NODE_HANDLE ObjectNode,
OUT UINT8 * OpCode, OPTIONAL
OUT UINT8 * SubOpCode, OPTIONAL
OUT UINT32 * PkgLen, OPTIONAL
OUT BOOLEAN * IsNameSpaceNode OPTIONAL
);
/** Returns the count of the fixed arguments for the input Node.
@ingroup NodeInterfaceApis
@param [in] Node Pointer to an object node.
@return Number of fixed arguments of the object node.
Return 0 if the node is not an object node.
**/
UINT8
AmlGetFixedArgumentCount (
IN AML_OBJECT_NODE_HANDLE Node
);
/** Get the data type of the DataNode.
The Node must be a data node.
@ingroup NodeInterfaceApis
@param [in] DataNode Pointer to a data node.
@param [out] DataType Pointer holding the data type of the data buffer.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlGetNodeDataType (
IN AML_DATA_NODE_HANDLE DataNode,
OUT EAML_NODE_DATA_TYPE * DataType
);
/** Get the descriptor Id of the resource data element
contained in the DataNode.
The Node must be a data node.
The Node must have the resource data type, i.e. have the
EAmlNodeDataTypeResourceData data type.
@ingroup NodeInterfaceApis
@param [in] DataNode Pointer to a data node containing a
resource data element.
@param [out] ResourceDataType Pointer holding the descriptor Id of
the resource data.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlGetResourceDataType (
IN AML_DATA_NODE_HANDLE DataNode,
OUT AML_RD_HEADER * ResourceDataType
);
/** Get the data buffer and size of the DataNode.
The Node must be a data node.
BufferSize is always updated to the size of buffer of the DataNode.
If:
- the content of BufferSize is >= to the DataNode's buffer size;
- Buffer is not NULL;
then copy the content of the DataNode's buffer in Buffer.
@ingroup NodeInterfaceApis
@param [in] DataNode Pointer to a data node.
@param [out] Buffer Buffer to write the data to.
Optional, if NULL, only update BufferSize.
@param [in, out] BufferSize Pointer holding:
- At entry, the size of the Buffer;
- At exit, the size of the DataNode's
buffer size.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlGetDataNodeBuffer (
IN AML_DATA_NODE_HANDLE DataNode,
OUT UINT8 * Buffer, OPTIONAL
IN OUT UINT32 * BufferSize
);
/** Update the ACPI DSDT/SSDT table header.
The input SdtHeader information is copied to the tree RootNode.
The table Length field is automatically updated.
The checksum field is only updated when serializing the tree.
@ingroup NodeInterfaceApis
@param [in] RootNode Pointer to a root node.
@param [in] SdtHeader Pointer to an ACPI DSDT/SSDT table header.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlUpdateRootNode (
IN AML_ROOT_NODE_HANDLE RootNode,
IN CONST EFI_ACPI_DESCRIPTION_HEADER * SdtHeader
);
/** Update an object node representing an integer with a new value.
The object node must have one of the following OpCodes:
- AML_BYTE_PREFIX
- AML_WORD_PREFIX
- AML_DWORD_PREFIX
- AML_QWORD_PREFIX
- AML_ZERO_OP
- AML_ONE_OP
The following OpCode is not supported:
- AML_ONES_OP
@param [in] IntegerOpNode Pointer an object node containing an integer.
Must not be an object node with an AML_ONES_OP
OpCode.
@param [in] NewInteger New integer value to set.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
**/
EFI_STATUS
EFIAPI
AmlUpdateInteger (
IN AML_OBJECT_NODE_HANDLE IntegerOpNode,
IN UINT64 NewInteger
);
/** Update the buffer of a data node.
Note: The data type of the buffer's content must match the data type of the
DataNode. This is a hard restriction to prevent undesired behaviour.
@ingroup NodeInterfaceApis
@param [in] DataNode Pointer to a data node.
@param [in] DataType Data type of the Buffer's content.
@param [in] Buffer Buffer containing the new data. The content of
the Buffer is copied.
@param [in] Size Size of the Buffer.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_UNSUPPORTED Operation not supporter.
**/
EFI_STATUS
EFIAPI
AmlUpdateDataNode (
IN AML_DATA_NODE_HANDLE DataNode,
IN EAML_NODE_DATA_TYPE DataType,
IN UINT8 * Buffer,
IN UINT32 Size
);
/**
@defgroup NavigationApis Navigation APIs
@ingroup AMLLib
@{
Navigation APIs allow to navigate in the AML tree. There are different
ways to navigate in the tree by:
- Direct relation (@ref CoreNavigationApis);
- Enumeration: enumerate all the nodes and call a callback function
(@ref EnumerationApis);
- Iteration: instantiate an iterator and use it to navigate
(@ref IteratorApis);
- NameSpace path: use the AML namespace to navigate the tree
(@ref NameSpaceApis).
@}
*/
/**
@defgroup CoreNavigationApis Core Navigation APIs
@ingroup NavigationApis
@{
Core Navigation APIs allow to get a node by specifying a relation.
E.g.: Get the parent, the n-th fixed argument, the next variable
argument, etc.
@}
*/
/** Get the parent node of the input Node.
@ingroup CoreNavigationApis
@param [in] Node Pointer to a node.
@return The parent node of the input Node.
NULL otherwise.
**/
AML_NODE_HANDLE
EFIAPI
AmlGetParent (
IN AML_NODE_HANDLE Node
);
/** Get the node at the input Index in the fixed argument list of the input
ObjectNode.
@ingroup CoreNavigationApis
@param [in] ObjectNode Pointer to an object node.
@param [in] Index The Index of the fixed argument to get.
@return The node at the input Index in the fixed argument list
of the input ObjectNode.
NULL otherwise, e.g. if the node is not an object node, or no
node is available at this Index.
**/
AML_NODE_HANDLE
EFIAPI
AmlGetFixedArgument (
IN AML_OBJECT_NODE_HANDLE ObjectNode,
IN EAML_PARSE_INDEX Index
);
/** Get the sibling node among the nodes being in
the same variable argument list.
(ParentNode) /-i # Child of fixed argument b
\ /
|- [a][b][c][d] # Fixed Arguments
|- {(VarArgNode)->(f)->(g)} # Variable Arguments
\
\-h # Child of variable argument e
Node must be in a variable list of arguments.
Traversal Order: VarArgNode, f, g, NULL
@ingroup CoreNavigationApis
@param [in] VarArgNode Pointer to a node.
Must be in a variable list of arguments.
@return The next node after VarArgNode in the variable list of arguments.
Return NULL if
- VarArgNode is the last node of the list, or
- VarArgNode is not part of a variable list of arguments.
**/
AML_NODE_HANDLE
EFIAPI
AmlGetSiblingVariableArgument (
IN AML_NODE_HANDLE VarArgNode
);
/** Get the next variable argument.
(Node) /-i # Child of fixed argument b
\ /
|- [a][b][c][d] # Fixed Arguments
|- {(e)->(f)->(g)} # Variable Arguments
\
\-h # Child of variable argument e
Traversal Order: e, f, g, NULL
@ingroup CoreNavigationApis
@param [in] Node Pointer to a Root node or Object Node.
@param [in] CurrVarArg Pointer to the Current Variable Argument.
@return The node after the CurrVarArg in the variable list of arguments.
If CurrVarArg is NULL, return the first node of the
variable argument list.
Return NULL if
- CurrVarArg is the last node of the list, or
- Node does not have a variable list of arguments.
**/
AML_NODE_HANDLE
EFIAPI
AmlGetNextVariableArgument (
IN AML_NODE_HANDLE Node,
IN AML_NODE_HANDLE CurrVarArg
);
/** Get the previous variable argument.
(Node) /-i # Child of fixed argument b
\ /
|- [a][b][c][d] # Fixed Arguments
|- {(e)->(f)->(g)} # Variable Arguments
\
\-h # Child of variable argument e
Traversal Order: g, f, e, NULL
@ingroup CoreNavigationApis
@param [in] Node Pointer to a root node or an object node.
@param [in] CurrVarArg Pointer to the Current Variable Argument.
@return The node before the CurrVarArg in the variable list of
arguments.
If CurrVarArg is NULL, return the last node of the
variable list of arguments.
Return NULL if:
- CurrVarArg is the first node of the list, or
- Node doesn't have a variable list of arguments.
**/
AML_NODE_HANDLE
EFIAPI
AmlGetPreviousVariableArgument (
IN AML_NODE_HANDLE Node,
IN AML_NODE_HANDLE CurrVarArg
);
/**
@defgroup EnumerationApis Enumeration APIs
@ingroup NavigationApis
@{
Enumeration APIs are navigation APIs, allowing to call a callback function
on each node enumerated. Nodes are enumerated in the AML bytestream order,
i.e. in a depth first order.
@}
*/
/**
Callback function prototype used when iterating through the tree.
@ingroup EnumerationApis
@param [in] Node The Node currently being processed.
@param [in, out] Context A context for the callback function.
Can be optional.
@param [in, out] Status End the enumeration if pointing to a value
evaluated to TRUE.
Can be optional.
@retval TRUE if the enumeration can continue or has finished without
interruption.
@retval FALSE if the enumeration needs to stopped or has stopped.
**/
typedef
BOOLEAN
(EFIAPI * EDKII_AML_TREE_ENUM_CALLBACK) (
IN AML_NODE_HANDLE Node,
IN OUT VOID * Context, OPTIONAL
IN OUT EFI_STATUS * Status OPTIONAL
);
/** Enumerate all nodes of the subtree under the input Node in the AML
bytestream order (i.e. in a depth first order), and call the CallBack
function with the input Context.
The prototype of the Callback function is EDKII_AML_TREE_ENUM_CALLBACK.
@ingroup EnumerationApis
@param [in] Node Enumerate nodes of the subtree under this Node.
Must be a valid node.
@param [in] CallBack Callback function to call on each node.
@param [in, out] Context Void pointer used to pass some information
to the Callback function.
Optional, can be NULL.
@param [out] Status Optional parameter that can be used to get
the status of the Callback function.
If used, need to be init to EFI_SUCCESS.
@retval TRUE if the enumeration can continue or has finished without
interruption.
@retval FALSE if the enumeration needs to stopped or has stopped.
**/
BOOLEAN
EFIAPI
AmlEnumTree (
IN AML_NODE_HANDLE Node,
IN EDKII_AML_TREE_ENUM_CALLBACK CallBack,
IN OUT VOID * Context, OPTIONAL
OUT EFI_STATUS * Status OPTIONAL
);
/**
@defgroup NameSpaceApis NameSpace APIs
@ingroup NavigationApis
@{
NameSpace APIs allow to find a node from an AML path, and reciprocally
get the AML path of a node.
These APIs only operate on "NameSpace nodes", i.e. nodes that are
part of the AML namespace. These are the root node and object nodes
acknowledged by AmlGetObjectNodeInfo in @ref NodeInterfaceApis.
@}
*/
/** Build the absolute ASL pathname to Node.
BufferSize is always updated to the size of the pathname.
If:
- the content of BufferSize is >= to the size of the pathname AND;
- Buffer is not NULL;
then copy the pathname in the Buffer. A buffer of the size
MAX_ASL_NAMESTRING_SIZE is big enough to receive any ASL pathname.
@ingroup NameSpaceApis
@param [in] Node Node to build the absolute path to.
Must be a root node, or a namespace node.
@param [out] Buffer Buffer to write the path to.
If NULL, only update *BufferSize.
@param [in, out] BufferSize Pointer holding:
- At entry, the size of the Buffer;
- At exit, the size of the pathname.
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_BUFFER_TOO_SMALL No space left in the buffer.
@retval EFI_INVALID_PARAMETER Invalid parameter.
@retval EFI_OUT_OF_RESOURCES Out of memory.
**/
EFI_STATUS
EFIAPI
AmlGetAslPathName (
IN AML_NODE_HANDLE Node,
OUT CHAR8 * Buffer,
IN OUT UINT32 * BufferSize
);
#endif // AML_CORE_INTERFACE_H_
|