NetworkPkg: Change OPTIONAL keyword usage style

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: Maciej Rabeda <maciej.rabeda@linux.intel.com>
This commit is contained in:
Michael D Kinney 2021-12-02 18:00:52 -08:00 committed by mergify[bot]
parent d0e2f8232a
commit 8874fa199d
26 changed files with 45 additions and 50 deletions

View File

@ -78,7 +78,7 @@ EFI_STATUS
DhcpCallUser ( DhcpCallUser (
IN DHCP_SERVICE *DhcpSb, IN DHCP_SERVICE *DhcpSb,
IN EFI_DHCP4_EVENT Event, IN EFI_DHCP4_EVENT Event,
IN EFI_DHCP4_PACKET *Packet, OPTIONAL IN EFI_DHCP4_PACKET *Packet OPTIONAL,
OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL
) )
{ {

View File

@ -296,7 +296,7 @@ EFI_STATUS
HttpBootLoadFile ( HttpBootLoadFile (
IN HTTP_BOOT_PRIVATE_DATA *Private, IN HTTP_BOOT_PRIVATE_DATA *Private,
IN OUT UINTN *BufferSize, IN OUT UINTN *BufferSize,
IN VOID *Buffer, OPTIONAL IN VOID *Buffer OPTIONAL,
OUT HTTP_BOOT_IMAGE_TYPE *ImageType OUT HTTP_BOOT_IMAGE_TYPE *ImageType
) )
{ {

View File

@ -72,11 +72,11 @@ EFIAPI
HttpUtilitiesBuild ( HttpUtilitiesBuild (
IN EFI_HTTP_UTILITIES_PROTOCOL *This, IN EFI_HTTP_UTILITIES_PROTOCOL *This,
IN UINTN SeedMessageSize, IN UINTN SeedMessageSize,
IN VOID *SeedMessage, OPTIONAL IN VOID *SeedMessage OPTIONAL,
IN UINTN DeleteCount, IN UINTN DeleteCount,
IN CHAR8 *DeleteList[], OPTIONAL IN CHAR8 *DeleteList[] OPTIONAL,
IN UINTN AppendCount, IN UINTN AppendCount,
IN EFI_HTTP_HEADER *AppendList[], OPTIONAL IN EFI_HTTP_HEADER *AppendList[] OPTIONAL,
OUT UINTN *NewMessageSize, OUT UINTN *NewMessageSize,
OUT VOID **NewMessage OUT VOID **NewMessage
); );

View File

@ -52,11 +52,11 @@ EFIAPI
HttpUtilitiesBuild ( HttpUtilitiesBuild (
IN EFI_HTTP_UTILITIES_PROTOCOL *This, IN EFI_HTTP_UTILITIES_PROTOCOL *This,
IN UINTN SeedMessageSize, IN UINTN SeedMessageSize,
IN VOID *SeedMessage, OPTIONAL IN VOID *SeedMessage OPTIONAL,
IN UINTN DeleteCount, IN UINTN DeleteCount,
IN CHAR8 *DeleteList[], OPTIONAL IN CHAR8 *DeleteList[] OPTIONAL,
IN UINTN AppendCount, IN UINTN AppendCount,
IN EFI_HTTP_HEADER *AppendList[], OPTIONAL IN EFI_HTTP_HEADER *AppendList[] OPTIONAL,
OUT UINTN *NewMessageSize, OUT UINTN *NewMessageSize,
OUT VOID **NewMessage OUT VOID **NewMessage
) )

View File

@ -216,7 +216,7 @@ IScsiDhcpSelectOffer (
IN VOID *Context, IN VOID *Context,
IN EFI_DHCP4_STATE CurrentState, IN EFI_DHCP4_STATE CurrentState,
IN EFI_DHCP4_EVENT Dhcp4Event, IN EFI_DHCP4_EVENT Dhcp4Event,
IN EFI_DHCP4_PACKET *Packet, OPTIONAL IN EFI_DHCP4_PACKET *Packet OPTIONAL,
OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL OUT EFI_DHCP4_PACKET **NewPacket OPTIONAL
) )
{ {

View File

@ -1304,7 +1304,7 @@ EFI_STATUS
IScsiReceivePdu ( IScsiReceivePdu (
IN ISCSI_CONNECTION *Conn, IN ISCSI_CONNECTION *Conn,
OUT NET_BUF **Pdu, OUT NET_BUF **Pdu,
IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL IN ISCSI_IN_BUFFER_CONTEXT *Context OPTIONAL,
IN BOOLEAN HeaderDigest, IN BOOLEAN HeaderDigest,
IN BOOLEAN DataDigest, IN BOOLEAN DataDigest,
IN EFI_EVENT TimeoutEvent OPTIONAL IN EFI_EVENT TimeoutEvent OPTIONAL

View File

@ -859,7 +859,7 @@ EFI_STATUS
IScsiReceivePdu ( IScsiReceivePdu (
IN ISCSI_CONNECTION *Conn, IN ISCSI_CONNECTION *Conn,
OUT NET_BUF **Pdu, OUT NET_BUF **Pdu,
IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL IN ISCSI_IN_BUFFER_CONTEXT *Context OPTIONAL,
IN BOOLEAN HeaderDigest, IN BOOLEAN HeaderDigest,
IN BOOLEAN DataDigest, IN BOOLEAN DataDigest,
IN EFI_EVENT TimeoutEvent OPTIONAL IN EFI_EVENT TimeoutEvent OPTIONAL

View File

@ -234,9 +234,9 @@ HttpIoCreateIo (
EFI_STATUS EFI_STATUS
HttpIoSendRequest ( HttpIoSendRequest (
IN HTTP_IO *HttpIo, IN HTTP_IO *HttpIo,
IN EFI_HTTP_REQUEST_DATA *Request, OPTIONAL IN EFI_HTTP_REQUEST_DATA *Request OPTIONAL,
IN UINTN HeaderCount, IN UINTN HeaderCount,
IN EFI_HTTP_HEADER *Headers, OPTIONAL IN EFI_HTTP_HEADER *Headers OPTIONAL,
IN UINTN BodyLength, IN UINTN BodyLength,
IN VOID *Body OPTIONAL IN VOID *Body OPTIONAL
); );

View File

@ -766,7 +766,7 @@ EFIAPI
NetDestroyLinkList ( NetDestroyLinkList (
IN LIST_ENTRY *List, IN LIST_ENTRY *List,
IN NET_DESTROY_LINK_LIST_CALLBACK CallBack, IN NET_DESTROY_LINK_LIST_CALLBACK CallBack,
IN VOID *Context, OPTIONAL IN VOID *Context OPTIONAL,
OUT UINTN *ListLength OPTIONAL OUT UINTN *ListLength OPTIONAL
); );
@ -1237,7 +1237,7 @@ EFI_STATUS
EFIAPI EFIAPI
NetLibGetMacString ( NetLibGetMacString (
IN EFI_HANDLE ServiceHandle, IN EFI_HANDLE ServiceHandle,
IN EFI_HANDLE ImageHandle, OPTIONAL IN EFI_HANDLE ImageHandle OPTIONAL,
OUT CHAR16 **MacString OUT CHAR16 **MacString
); );

View File

@ -207,7 +207,7 @@ EFIAPI
UdpIoCancelDgrams ( UdpIoCancelDgrams (
IN UDP_IO *UdpIo, IN UDP_IO *UdpIo,
IN EFI_STATUS IoStatus, IN EFI_STATUS IoStatus,
IN UDP_IO_TO_CANCEL ToCancel, OPTIONAL IN UDP_IO_TO_CANCEL ToCancel OPTIONAL,
IN VOID *Context OPTIONAL IN VOID *Context OPTIONAL
); );
@ -360,4 +360,3 @@ UdpIoRecvDatagram (
); );
#endif #endif

View File

@ -115,7 +115,7 @@ Ip4CopyOption (
IN UINT8 *Option, IN UINT8 *Option,
IN UINT32 OptionLen, IN UINT32 OptionLen,
IN BOOLEAN FirstFragment, IN BOOLEAN FirstFragment,
IN OUT UINT8 *Buf, OPTIONAL IN OUT UINT8 *Buf OPTIONAL,
IN OUT UINT32 *BufLen IN OUT UINT32 *BufLen
) )
{ {

View File

@ -60,7 +60,7 @@ Ip4CopyOption (
IN UINT8 *Option, IN UINT8 *Option,
IN UINT32 OptionLen, IN UINT32 OptionLen,
IN BOOLEAN FirstFragment, IN BOOLEAN FirstFragment,
IN OUT UINT8 *Buf, OPTIONAL IN OUT UINT8 *Buf OPTIONAL,
IN OUT UINT32 *BufLen IN OUT UINT32 *BufLen
); );
#endif #endif

View File

@ -131,7 +131,7 @@ HttpIoCreateIo (
IN EFI_HANDLE Image, IN EFI_HANDLE Image,
IN EFI_HANDLE Controller, IN EFI_HANDLE Controller,
IN UINT8 IpVersion, IN UINT8 IpVersion,
IN HTTP_IO_CONFIG_DATA *ConfigData, OPTIONAL IN HTTP_IO_CONFIG_DATA *ConfigData OPTIONAL,
IN HTTP_IO_CALLBACK Callback, IN HTTP_IO_CALLBACK Callback,
IN VOID *Context, IN VOID *Context,
OUT HTTP_IO *HttpIo OUT HTTP_IO *HttpIo

View File

@ -1147,7 +1147,7 @@ EFIAPI
NetDestroyLinkList ( NetDestroyLinkList (
IN LIST_ENTRY *List, IN LIST_ENTRY *List,
IN NET_DESTROY_LINK_LIST_CALLBACK CallBack, IN NET_DESTROY_LINK_LIST_CALLBACK CallBack,
IN VOID *Context, OPTIONAL IN VOID *Context OPTIONAL,
OUT UINTN *ListLength OPTIONAL OUT UINTN *ListLength OPTIONAL
) )
{ {
@ -2283,7 +2283,7 @@ EFI_STATUS
EFIAPI EFIAPI
NetLibGetMacString ( NetLibGetMacString (
IN EFI_HANDLE ServiceHandle, IN EFI_HANDLE ServiceHandle,
IN EFI_HANDLE ImageHandle, OPTIONAL IN EFI_HANDLE ImageHandle OPTIONAL,
OUT CHAR16 **MacString OUT CHAR16 **MacString
) )
{ {

View File

@ -765,7 +765,7 @@ EFIAPI
UdpIoCancelDgrams ( UdpIoCancelDgrams (
IN UDP_IO *UdpIo, IN UDP_IO *UdpIo,
IN EFI_STATUS IoStatus, IN EFI_STATUS IoStatus,
IN UDP_IO_TO_CANCEL ToCancel, OPTIONAL IN UDP_IO_TO_CANCEL ToCancel OPTIONAL,
IN VOID *Context OPTIONAL IN VOID *Context OPTIONAL
) )
{ {

View File

@ -195,7 +195,7 @@ EFI_STATUS
EFIAPI EFIAPI
SnpUndi32GetStatus ( SnpUndi32GetStatus (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
OUT UINT32 *InterruptStatus, OPTIONAL OUT UINT32 *InterruptStatus OPTIONAL,
OUT VOID **TxBuf OPTIONAL OUT VOID **TxBuf OPTIONAL
) )
{ {

View File

@ -384,7 +384,7 @@ SnpUndi32ReceiveFilters (
IN UINT32 Enable, IN UINT32 Enable,
IN UINT32 Disable, IN UINT32 Disable,
IN BOOLEAN ResetMCastFilter, IN BOOLEAN ResetMCastFilter,
IN UINTN MCastFilterCnt, OPTIONAL IN UINTN MCastFilterCnt OPTIONAL,
IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL
) )
{ {

View File

@ -644,7 +644,7 @@ SnpUndi32ReceiveFilters (
IN UINT32 Enable, IN UINT32 Enable,
IN UINT32 Disable, IN UINT32 Disable,
IN BOOLEAN ResetMCastFilter, IN BOOLEAN ResetMCastFilter,
IN UINTN MCastFilterCnt, OPTIONAL IN UINTN MCastFilterCnt OPTIONAL,
IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL IN EFI_MAC_ADDRESS *MCastFilter OPTIONAL
); );
@ -740,7 +740,7 @@ EFIAPI
SnpUndi32Statistics ( SnpUndi32Statistics (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN BOOLEAN Reset, IN BOOLEAN Reset,
IN OUT UINTN *StatisticsSize, OPTIONAL IN OUT UINTN *StatisticsSize OPTIONAL,
IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL
); );
@ -884,7 +884,7 @@ EFI_STATUS
EFIAPI EFIAPI
SnpUndi32GetStatus ( SnpUndi32GetStatus (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
OUT UINT32 *InterruptStatus, OPTIONAL OUT UINT32 *InterruptStatus OPTIONAL,
OUT VOID **TxBuf OPTIONAL OUT VOID **TxBuf OPTIONAL
); );
@ -949,8 +949,8 @@ SnpUndi32Transmit (
IN UINTN HeaderSize, IN UINTN HeaderSize,
IN UINTN BufferSize, IN UINTN BufferSize,
IN VOID *Buffer, IN VOID *Buffer,
IN EFI_MAC_ADDRESS *SrcAddr, OPTIONAL IN EFI_MAC_ADDRESS *SrcAddr OPTIONAL,
IN EFI_MAC_ADDRESS *DestAddr, OPTIONAL IN EFI_MAC_ADDRESS *DestAddr OPTIONAL,
IN UINT16 *Protocol OPTIONAL IN UINT16 *Protocol OPTIONAL
); );

View File

@ -62,7 +62,7 @@ EFIAPI
SnpUndi32Statistics ( SnpUndi32Statistics (
IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN EFI_SIMPLE_NETWORK_PROTOCOL *This,
IN BOOLEAN Reset, IN BOOLEAN Reset,
IN OUT UINTN *StatisticsSize, OPTIONAL IN OUT UINTN *StatisticsSize OPTIONAL,
IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL IN OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL
) )
{ {

View File

@ -274,8 +274,8 @@ SnpUndi32Transmit (
IN UINTN HeaderSize, IN UINTN HeaderSize,
IN UINTN BufferSize, IN UINTN BufferSize,
IN VOID *Buffer, IN VOID *Buffer,
IN EFI_MAC_ADDRESS *SrcAddr, OPTIONAL IN EFI_MAC_ADDRESS *SrcAddr OPTIONAL,
IN EFI_MAC_ADDRESS *DestAddr, OPTIONAL IN EFI_MAC_ADDRESS *DestAddr OPTIONAL,
IN UINT16 *Protocol OPTIONAL IN UINT16 *Protocol OPTIONAL
) )
{ {

View File

@ -411,7 +411,7 @@ TcpDestroyService (
IN EFI_HANDLE Controller, IN EFI_HANDLE Controller,
IN EFI_HANDLE ImageHandle, IN EFI_HANDLE ImageHandle,
IN UINTN NumberOfChildren, IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer, OPTIONAL IN EFI_HANDLE *ChildHandleBuffer OPTIONAL,
IN UINT8 IpVersion IN UINT8 IpVersion
) )
{ {

View File

@ -105,7 +105,7 @@ EFIAPI
TlsConfigurationGetData ( TlsConfigurationGetData (
IN EFI_TLS_CONFIGURATION_PROTOCOL *This, IN EFI_TLS_CONFIGURATION_PROTOCOL *This,
IN EFI_TLS_CONFIG_DATA_TYPE DataType, IN EFI_TLS_CONFIG_DATA_TYPE DataType,
IN OUT VOID *Data, OPTIONAL IN OUT VOID *Data OPTIONAL,
IN OUT UINTN *DataSize IN OUT UINTN *DataSize
) )
{ {
@ -144,4 +144,3 @@ TlsConfigurationGetData (
gBS->RestoreTPL (OldTpl); gBS->RestoreTPL (OldTpl);
return Status; return Status;
} }

View File

@ -148,7 +148,7 @@ EFIAPI
TlsGetSessionData ( TlsGetSessionData (
IN EFI_TLS_PROTOCOL *This, IN EFI_TLS_PROTOCOL *This,
IN EFI_TLS_SESSION_DATA_TYPE DataType, IN EFI_TLS_SESSION_DATA_TYPE DataType,
IN OUT VOID *Data, OPTIONAL IN OUT VOID *Data OPTIONAL,
IN OUT UINTN *DataSize IN OUT UINTN *DataSize
); );
@ -194,9 +194,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsBuildResponsePacket ( TlsBuildResponsePacket (
IN EFI_TLS_PROTOCOL *This, IN EFI_TLS_PROTOCOL *This,
IN UINT8 *RequestBuffer, OPTIONAL IN UINT8 *RequestBuffer OPTIONAL,
IN UINTN RequestSize, OPTIONAL IN UINTN RequestSize OPTIONAL,
OUT UINT8 *Buffer, OPTIONAL OUT UINT8 *Buffer OPTIONAL,
IN OUT UINTN *BufferSize IN OUT UINTN *BufferSize
); );
@ -298,9 +298,8 @@ EFIAPI
TlsConfigurationGetData ( TlsConfigurationGetData (
IN EFI_TLS_CONFIGURATION_PROTOCOL *This, IN EFI_TLS_CONFIGURATION_PROTOCOL *This,
IN EFI_TLS_CONFIG_DATA_TYPE DataType, IN EFI_TLS_CONFIG_DATA_TYPE DataType,
IN OUT VOID *Data, OPTIONAL IN OUT VOID *Data OPTIONAL,
IN OUT UINTN *DataSize IN OUT UINTN *DataSize
); );
#endif #endif

View File

@ -259,7 +259,7 @@ EFIAPI
TlsGetSessionData ( TlsGetSessionData (
IN EFI_TLS_PROTOCOL *This, IN EFI_TLS_PROTOCOL *This,
IN EFI_TLS_SESSION_DATA_TYPE DataType, IN EFI_TLS_SESSION_DATA_TYPE DataType,
IN OUT VOID *Data, OPTIONAL IN OUT VOID *Data OPTIONAL,
IN OUT UINTN *DataSize IN OUT UINTN *DataSize
) )
{ {
@ -444,9 +444,9 @@ EFI_STATUS
EFIAPI EFIAPI
TlsBuildResponsePacket ( TlsBuildResponsePacket (
IN EFI_TLS_PROTOCOL *This, IN EFI_TLS_PROTOCOL *This,
IN UINT8 *RequestBuffer, OPTIONAL IN UINT8 *RequestBuffer OPTIONAL,
IN UINTN RequestSize, OPTIONAL IN UINTN RequestSize OPTIONAL,
OUT UINT8 *Buffer, OPTIONAL OUT UINT8 *Buffer OPTIONAL,
IN OUT UINTN *BufferSize IN OUT UINTN *BufferSize
) )
{ {
@ -673,4 +673,3 @@ ON_EXIT:
gBS->RestoreTPL (OldTpl); gBS->RestoreTPL (OldTpl);
return Status; return Status;
} }

View File

@ -24,7 +24,7 @@
EFI_STATUS EFI_STATUS
PxeBcFlushStationIp ( PxeBcFlushStationIp (
PXEBC_PRIVATE_DATA *Private, PXEBC_PRIVATE_DATA *Private,
EFI_IP_ADDRESS *StationIp, OPTIONAL EFI_IP_ADDRESS *StationIp OPTIONAL,
EFI_IP_ADDRESS *SubnetMask OPTIONAL EFI_IP_ADDRESS *SubnetMask OPTIONAL
) )
{ {
@ -1535,4 +1535,3 @@ CalcElapsedTime (
Private->ElapsedTime = ElapsedTimeValue; Private->ElapsedTime = ElapsedTimeValue;
} }
} }

View File

@ -34,7 +34,7 @@
EFI_STATUS EFI_STATUS
PxeBcFlushStationIp ( PxeBcFlushStationIp (
PXEBC_PRIVATE_DATA *Private, PXEBC_PRIVATE_DATA *Private,
EFI_IP_ADDRESS *StationIp, OPTIONAL EFI_IP_ADDRESS *StationIp OPTIONAL,
EFI_IP_ADDRESS *SubnetMask OPTIONAL EFI_IP_ADDRESS *SubnetMask OPTIONAL
); );