sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DynamicTablesPkg: Change OPTIONAL keyword usage style

Browse Source 
REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3760

Update all use of ', OPTIONAL' to ' OPTIONAL,' for function params.

Cc: Andrew Fish <afish@apple.com>
Cc: Leif Lindholm <leif@nuviainc.com>
Cc: Michael Kubacki <michael.kubacki@microsoft.com>
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
This commit is contained in:
Michael D Kinney
2021-12-02 18:00:40 -08:00
committed by mergify[bot]
parent c8f46130f8
commit fe2d81892f
8 changed files with 53 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
DynamicTablesPkg/Include/Library/AmlLib/AmlLib.h
View File

@ -462,7 +462,7 @@ AmlCodeGenRdInterrupt (
IN BOOLEAN Shared, IN BOOLEAN Shared,
IN UINT32 *IrqList, IN UINT32 *IrqList,
IN UINT8 IrqCount, IN UINT8 IrqCount,
IN AML_OBJECT_NODE_HANDLE NameOpNode, OPTIONAL IN AML_OBJECT_NODE_HANDLE NameOpNode OPTIONAL,
OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL
); );
@ -529,7 +529,7 @@ EFIAPI
AmlCodeGenNameString ( AmlCodeGenNameString (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN CHAR8 * String, IN CHAR8 * String,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
); );
@ -559,7 +559,7 @@ EFIAPI
AmlCodeGenNameInteger ( AmlCodeGenNameInteger (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN UINT64 Integer, IN UINT64 Integer,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
); );
@ -587,7 +587,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenDevice ( AmlCodeGenDevice (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
); );
@ -615,7 +615,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenScope ( AmlCodeGenScope (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
); );
@ -664,11 +664,11 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenMethodRetNameString ( AmlCodeGenMethodRetNameString (
IN CONST CHAR8 * MethodNameString, IN CONST CHAR8 * MethodNameString,
IN CONST CHAR8 * ReturnedNameString, OPTIONAL IN CONST CHAR8 * ReturnedNameString OPTIONAL,
IN UINT8 NumArgs, IN UINT8 NumArgs,
IN BOOLEAN IsSerialized, IN BOOLEAN IsSerialized,
IN UINT8 SyncLevel, IN UINT8 SyncLevel,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
); );
@ -712,7 +712,7 @@ AmlCreateLpiNode (
IN CONST CHAR8 * LpiNameString, IN CONST CHAR8 * LpiNameString,
IN UINT16 Revision, IN UINT16 Revision,
IN UINT64 LevelId, IN UINT64 LevelId,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewLpiNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewLpiNode OPTIONAL
); );
@ -779,11 +779,11 @@ AmlAddLpiState (
IN UINT32 ArchFlags, IN UINT32 ArchFlags,
IN UINT32 ResCntFreq, IN UINT32 ResCntFreq,
IN UINT32 EnableParentState, IN UINT32 EnableParentState,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * GenericRegisterDescriptor, OPTIONAL IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * GenericRegisterDescriptor OPTIONAL,
IN UINT64 Integer, OPTIONAL IN UINT64 Integer OPTIONAL,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * ResidencyCounterRegister, OPTIONAL IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * ResidencyCounterRegister OPTIONAL,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * UsageCounterRegister, OPTIONAL IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * UsageCounterRegister OPTIONAL,
IN CHAR8 * StateName, OPTIONAL IN CHAR8 * StateName OPTIONAL,
IN AML_OBJECT_NODE_HANDLE LpiNode IN AML_OBJECT_NODE_HANDLE LpiNode
); );

14
DynamicTablesPkg/Library/Common/AmlLib/AmlCoreInterface.h
View File

@ -68,7 +68,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlSerializeTree ( AmlSerializeTree (
IN AML_ROOT_NODE_HANDLE RootNode, IN AML_ROOT_NODE_HANDLE RootNode,
IN UINT8 * Buffer, OPTIONAL IN UINT8 * Buffer OPTIONAL,
IN OUT UINT32 * BufferSize IN OUT UINT32 * BufferSize
); );
@ -334,9 +334,9 @@ EFI_STATUS
EFIAPI EFIAPI
AmlGetObjectNodeInfo ( AmlGetObjectNodeInfo (
IN AML_OBJECT_NODE_HANDLE ObjectNode, IN AML_OBJECT_NODE_HANDLE ObjectNode,
OUT UINT8 * OpCode, OPTIONAL OUT UINT8 * OpCode OPTIONAL,
OUT UINT8 * SubOpCode, OPTIONAL OUT UINT8 * SubOpCode OPTIONAL,
OUT UINT32 * PkgLen, OPTIONAL OUT UINT32 * PkgLen OPTIONAL,
OUT BOOLEAN * IsNameSpaceNode OPTIONAL OUT BOOLEAN * IsNameSpaceNode OPTIONAL
); );
@ -423,7 +423,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlGetDataNodeBuffer ( AmlGetDataNodeBuffer (
IN AML_DATA_NODE_HANDLE DataNode, IN AML_DATA_NODE_HANDLE DataNode,
OUT UINT8 * Buffer, OPTIONAL OUT UINT8 * Buffer OPTIONAL,
IN OUT UINT32 * BufferSize IN OUT UINT32 * BufferSize
); );
@ -684,7 +684,7 @@ typedef
BOOLEAN BOOLEAN
(EFIAPI * EDKII_AML_TREE_ENUM_CALLBACK) ( (EFIAPI * EDKII_AML_TREE_ENUM_CALLBACK) (
IN AML_NODE_HANDLE Node, IN AML_NODE_HANDLE Node,
IN OUT VOID * Context, OPTIONAL IN OUT VOID * Context OPTIONAL,
IN OUT EFI_STATUS * Status OPTIONAL IN OUT EFI_STATUS * Status OPTIONAL
); );
@ -714,7 +714,7 @@ EFIAPI
AmlEnumTree ( AmlEnumTree (
IN AML_NODE_HANDLE Node, IN AML_NODE_HANDLE Node,
IN EDKII_AML_TREE_ENUM_CALLBACK CallBack, IN EDKII_AML_TREE_ENUM_CALLBACK CallBack,
IN OUT VOID * Context, OPTIONAL IN OUT VOID * Context OPTIONAL,
OUT EFI_STATUS * Status OPTIONAL OUT EFI_STATUS * Status OPTIONAL
); );

36
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlCodeGen.c
View File

@ -341,8 +341,8 @@ STATIC
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenBuffer ( AmlCodeGenBuffer (
IN CONST UINT8 * Buffer, OPTIONAL IN CONST UINT8 * Buffer OPTIONAL,
IN UINT32 BufferSize, OPTIONAL IN UINT32 BufferSize OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OUT AML_OBJECT_NODE ** NewObjectNode
) )
{ {
@ -528,7 +528,7 @@ EFIAPI
AmlCodeGenName ( AmlCodeGenName (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN AML_OBJECT_NODE * Object, IN AML_OBJECT_NODE * Object,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -655,7 +655,7 @@ EFIAPI
AmlCodeGenNameString ( AmlCodeGenNameString (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN CHAR8 * String, IN CHAR8 * String,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -713,7 +713,7 @@ EFIAPI
AmlCodeGenNameInteger ( AmlCodeGenNameInteger (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN UINT64 Integer, IN UINT64 Integer,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -768,7 +768,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenDevice ( AmlCodeGenDevice (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -881,7 +881,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenScope ( AmlCodeGenScope (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -1013,7 +1013,7 @@ AmlCodeGenMethod (
IN UINT8 NumArgs, IN UINT8 NumArgs,
IN BOOLEAN IsSerialized, IN BOOLEAN IsSerialized,
IN UINT8 SyncLevel, IN UINT8 SyncLevel,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -1190,7 +1190,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenReturn ( AmlCodeGenReturn (
IN AML_NODE_HEADER * ReturnNode, IN AML_NODE_HEADER * ReturnNode,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -1288,7 +1288,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenReturnNameString ( AmlCodeGenReturnNameString (
IN CONST CHAR8 * NameString, IN CONST CHAR8 * NameString,
IN AML_NODE_HEADER * ParentNode, OPTIONAL IN AML_NODE_HEADER * ParentNode OPTIONAL,
OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL OUT AML_OBJECT_NODE ** NewObjectNode OPTIONAL
) )
{ {
@ -1380,11 +1380,11 @@ EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenMethodRetNameString ( AmlCodeGenMethodRetNameString (
IN CONST CHAR8 * MethodNameString, IN CONST CHAR8 * MethodNameString,
IN CONST CHAR8 * ReturnedNameString, OPTIONAL IN CONST CHAR8 * ReturnedNameString OPTIONAL,
IN UINT8 NumArgs, IN UINT8 NumArgs,
IN BOOLEAN IsSerialized, IN BOOLEAN IsSerialized,
IN UINT8 SyncLevel, IN UINT8 SyncLevel,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewObjectNode OPTIONAL
) )
{ {
@ -1481,7 +1481,7 @@ AmlCreateLpiNode (
IN CONST CHAR8 * LpiNameString, IN CONST CHAR8 * LpiNameString,
IN UINT16 Revision, IN UINT16 Revision,
IN UINT64 LevelId, IN UINT64 LevelId,
IN AML_NODE_HANDLE ParentNode, OPTIONAL IN AML_NODE_HANDLE ParentNode OPTIONAL,
OUT AML_OBJECT_NODE_HANDLE * NewLpiNode OPTIONAL OUT AML_OBJECT_NODE_HANDLE * NewLpiNode OPTIONAL
) )
{ {
@ -1637,11 +1637,11 @@ AmlAddLpiState (
IN UINT32 ArchFlags, IN UINT32 ArchFlags,
IN UINT32 ResCntFreq, IN UINT32 ResCntFreq,
IN UINT32 EnableParentState, IN UINT32 EnableParentState,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * GenericRegisterDescriptor, OPTIONAL IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * GenericRegisterDescriptor OPTIONAL,
IN UINT64 Integer, OPTIONAL IN UINT64 Integer OPTIONAL,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * ResidencyCounterRegister, OPTIONAL IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * ResidencyCounterRegister OPTIONAL,
IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * UsageCounterRegister, OPTIONAL IN EFI_ACPI_6_3_GENERIC_ADDRESS_STRUCTURE * UsageCounterRegister OPTIONAL,
IN CHAR8 * StateName, OPTIONAL IN CHAR8 * StateName OPTIONAL,
IN AML_OBJECT_NODE_HANDLE LpiNode IN AML_OBJECT_NODE_HANDLE LpiNode
) )
{ {

8
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.c
View File

@ -142,7 +142,7 @@ AmlCodeGenRdInterrupt (
IN BOOLEAN Shared, IN BOOLEAN Shared,
IN UINT32 *IrqList, IN UINT32 *IrqList,
IN UINT8 IrqCount, IN UINT8 IrqCount,
IN AML_OBJECT_NODE_HANDLE NameOpNode, OPTIONAL IN AML_OBJECT_NODE_HANDLE NameOpNode OPTIONAL,
OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL
) )
{ {
@ -238,7 +238,7 @@ AmlCodeGenRdRegister (
IN UINT8 BitOffset, IN UINT8 BitOffset,
IN UINT64 Address, IN UINT64 Address,
IN UINT8 AccessSize, IN UINT8 AccessSize,
IN AML_OBJECT_NODE_HANDLE NameOpNode, OPTIONAL IN AML_OBJECT_NODE_HANDLE NameOpNode OPTIONAL,
OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL
) )
{ {
@ -318,8 +318,8 @@ AmlCodeGenRdRegister (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenEndTag ( AmlCodeGenEndTag (
IN UINT8 CheckSum, OPTIONAL IN UINT8 CheckSum OPTIONAL,
IN AML_OBJECT_NODE * ParentNode, OPTIONAL IN AML_OBJECT_NODE * ParentNode OPTIONAL,
OUT AML_DATA_NODE ** NewRdNode OPTIONAL OUT AML_DATA_NODE ** NewRdNode OPTIONAL
) )
{ {

8
DynamicTablesPkg/Library/Common/AmlLib/CodeGen/AmlResourceDataCodeGen.h
View File

@ -51,7 +51,7 @@ AmlCodeGenRdInterrupt (
IN BOOLEAN Shared, IN BOOLEAN Shared,
IN UINT32 *IrqList, IN UINT32 *IrqList,
IN UINT8 IrqCount, IN UINT8 IrqCount,
IN AML_OBJECT_NODE_HANDLE NameOpNode, OPTIONAL IN AML_OBJECT_NODE_HANDLE NameOpNode OPTIONAL,
OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL
); );
@ -100,7 +100,7 @@ AmlCodeGenRdRegister (
IN UINT8 BitOffset, IN UINT8 BitOffset,
IN UINT64 Address, IN UINT64 Address,
IN UINT8 AccessSize, IN UINT8 AccessSize,
IN AML_OBJECT_NODE_HANDLE NameOpNode, OPTIONAL IN AML_OBJECT_NODE_HANDLE NameOpNode OPTIONAL,
OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL OUT AML_DATA_NODE_HANDLE *NewRdNode OPTIONAL
); );
@ -142,8 +142,8 @@ AmlCodeGenRdRegister (
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
AmlCodeGenEndTag ( AmlCodeGenEndTag (
IN UINT8 CheckSum, OPTIONAL IN UINT8 CheckSum OPTIONAL,
IN AML_OBJECT_NODE * ParentNode, OPTIONAL IN AML_OBJECT_NODE * ParentNode OPTIONAL,
OUT AML_DATA_NODE ** NewRdNode OPTIONAL OUT AML_DATA_NODE ** NewRdNode OPTIONAL
); );

4
DynamicTablesPkg/Library/Common/AmlLib/Serialize/AmlSerialize.c
View File

@ -39,7 +39,7 @@ BOOLEAN
EFIAPI EFIAPI
AmlSerializeNodeCallback ( AmlSerializeNodeCallback (
IN AML_NODE_HEADER * Node, IN AML_NODE_HEADER * Node,
IN OUT VOID * Context, OPTIONAL IN OUT VOID * Context OPTIONAL,
IN OUT EFI_STATUS * Status OPTIONAL IN OUT EFI_STATUS * Status OPTIONAL
) )
{ {
@ -170,7 +170,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlSerializeTree ( AmlSerializeTree (
IN AML_ROOT_NODE * RootNode, IN AML_ROOT_NODE * RootNode,
IN UINT8 * Buffer, OPTIONAL IN UINT8 * Buffer OPTIONAL,
IN OUT UINT32 * BufferSize IN OUT UINT32 * BufferSize
) )
{ {

8
DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlNodeInterface.c
View File

@ -95,9 +95,9 @@ EFI_STATUS
EFIAPI EFIAPI
AmlGetObjectNodeInfo ( AmlGetObjectNodeInfo (
IN AML_OBJECT_NODE * ObjectNode, IN AML_OBJECT_NODE * ObjectNode,
OUT UINT8 * OpCode, OPTIONAL OUT UINT8 * OpCode OPTIONAL,
OUT UINT8 * SubOpCode, OPTIONAL OUT UINT8 * SubOpCode OPTIONAL,
OUT UINT32 * PkgLen, OPTIONAL OUT UINT32 * PkgLen OPTIONAL,
OUT BOOLEAN * IsNameSpaceNode OPTIONAL OUT BOOLEAN * IsNameSpaceNode OPTIONAL
) )
{ {
@ -228,7 +228,7 @@ EFI_STATUS
EFIAPI EFIAPI
AmlGetDataNodeBuffer ( AmlGetDataNodeBuffer (
IN AML_DATA_NODE * DataNode, IN AML_DATA_NODE * DataNode,
OUT UINT8 * Buffer, OPTIONAL OUT UINT8 * Buffer OPTIONAL,
IN OUT UINT32 * BufferSize IN OUT UINT32 * BufferSize
) )
{ {

2
DynamicTablesPkg/Library/Common/AmlLib/Tree/AmlTreeEnumerator.c
View File

@ -35,7 +35,7 @@ EFIAPI
AmlEnumTree ( AmlEnumTree (
IN AML_NODE_HEADER * Node, IN AML_NODE_HEADER * Node,
IN EDKII_AML_TREE_ENUM_CALLBACK CallBack, IN EDKII_AML_TREE_ENUM_CALLBACK CallBack,
IN OUT VOID * Context, OPTIONAL IN OUT VOID * Context OPTIONAL,
OUT EFI_STATUS * Status OPTIONAL OUT EFI_STATUS * Status OPTIONAL
) )
{ {