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

MdeModulePkg: Clean up source files

Browse Source 
1. Do not use tab characters
2. No trailing white space in one line
3. All files must end with CRLF

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
This commit is contained in:
Liming Gao
2018-06-27 21:08:52 +08:00
parent ca79bab7af
commit d1102dba72
1010 changed files with 13588 additions and 13588 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
MdeModulePkg/Include/Library/BootLogoLib.h
View File

@@ -2,7 +2,7 @@
This library is only intended to be used by PlatformBootManagerLib
to show progress bar and LOGO.
Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
@@ -30,7 +30,7 @@ BootLogoEnableLogo (
/**
Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
Use SystemTable ConOut to turn on video based Simple Text Out consoles. The
Simple Text Out screens will now be synced up with all non-video output devices.
@retval EFI_SUCCESS UGA devices are back in text mode and synced up.

22
MdeModulePkg/Include/Library/CapsuleLib.h
View File

@@ -2,13 +2,13 @@
This library class defines a set of interfaces for how to process capsule image updates.
Copyright (c) 2007 - 2016, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -17,14 +17,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define __CAPSULE_LIB_H__
/**
The firmware checks whether the capsule image is supported
by the CapsuleGuid in CapsuleHeader or if there is other specific information in
The firmware checks whether the capsule image is supported
by the CapsuleGuid in CapsuleHeader or if there is other specific information in
the capsule image.
Caution: This function may receive untrusted input.
@param CapsuleHeader Pointer to the UEFI capsule image to be checked.
@retval EFI_SUCESS Input capsule is supported by firmware.
@retval EFI_UNSUPPORTED Input capsule is not supported by the firmware.
**/
@@ -40,9 +40,9 @@ SupportCapsuleImage (
Caution: This function may receive untrusted input.
@param CapsuleHeader Pointer to the UEFI capsule image to be processed.
@retval EFI_SUCESS Capsule Image processed successfully.
@param CapsuleHeader Pointer to the UEFI capsule image to be processed.
@retval EFI_SUCESS Capsule Image processed successfully.
@retval EFI_UNSUPPORTED Capsule image is not supported by the firmware.
**/
EFI_STATUS

26
MdeModulePkg/Include/Library/CpuExceptionHandlerLib.h
View File

@@ -2,7 +2,7 @@
CPU Exception library provides the default CPU interrupt/exception handler.
It also provides capability to register user interrupt/exception handler.
Copyright (c) 2012 - 2017, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -88,15 +88,15 @@ typedef union {
/**
Initializes all CPU exceptions entries and provides the default exception handlers.
Caller should try to get an array of interrupt and/or exception vectors that are in use and need to
persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.
If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.
If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.
If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.
@param[in] VectorInfo Pointer to reserved vector list.
@retval EFI_SUCCESS CPU Exception Entries have been successfully initialized
@retval EFI_SUCCESS CPU Exception Entries have been successfully initialized
with default exception handlers.
@retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.
@retval EFI_UNSUPPORTED This function is not supported.
@@ -140,15 +140,15 @@ InitializeCpuExceptionHandlersEx (
/**
Initializes all CPU interrupt/exceptions entries and provides the default interrupt/exception handlers.
Caller should try to get an array of interrupt and/or exception vectors that are in use and need to
persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.
If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.
If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.
If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.
@param[in] VectorInfo Pointer to reserved vector list.
@retval EFI_SUCCESS All CPU interrupt/exception entries have been successfully initialized
@retval EFI_SUCCESS All CPU interrupt/exception entries have been successfully initialized
with default interrupt/exception handlers.
@retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.
@retval EFI_UNSUPPORTED This function is not supported.
@@ -163,9 +163,9 @@ InitializeCpuInterruptHandlers (
/**
Registers a function to be called from the processor interrupt handler.
This function registers and enables the handler specified by InterruptHandler for a processor
interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the
handler for the processor interrupt or exception type specified by InterruptType is uninstalled.
This function registers and enables the handler specified by InterruptHandler for a processor
interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the
handler for the processor interrupt or exception type specified by InterruptType is uninstalled.
The installed handler is called once for each processor interrupt or exception.
NOTE: This function should be invoked after InitializeCpuExceptionHandlers() or
InitializeCpuInterruptHandlers() invoked, otherwise EFI_UNSUPPORTED returned.
@@ -202,5 +202,5 @@ DumpCpuContext (
IN EFI_EXCEPTION_TYPE ExceptionType,
IN EFI_SYSTEM_CONTEXT SystemContext
);
#endif

54
MdeModulePkg/Include/Library/CustomizedDisplayLib.h
View File

@@ -1,13 +1,13 @@
/** @file
This library class defines a set of interfaces to customize Display module
Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -38,14 +38,14 @@ Statement
**/
/**
This funtion defines Page Frame and Backgroud.
Based on the above layout, it will be responsible for HeaderHeight, FooterHeight,
StatusBarHeight and Backgroud. And, it will reserve Screen for Statement.
This funtion defines Page Frame and Backgroud.
Based on the above layout, it will be responsible for HeaderHeight, FooterHeight,
StatusBarHeight and Backgroud. And, it will reserve Screen for Statement.
@param[in] FormData Form Data to be shown in Page.
@param[out] ScreenForStatement Screen to be used for Statement. (Prompt, Value and Help)
@return Status
**/
EFI_STATUS
@@ -59,7 +59,7 @@ DisplayPageFrame (
Clear Screen to the initial state.
**/
VOID
EFIAPI
EFIAPI
ClearDisplayPage (
VOID
);
@@ -68,8 +68,8 @@ ClearDisplayPage (
This function updates customized key panel's help information.
The library will prepare those Strings for the basic key, ESC, Enter, Up/Down/Left/Right, +/-.
and arrange them in Footer panel.
@param[in] FormData Form Data to be shown in Page. FormData has the highlighted statement.
@param[in] FormData Form Data to be shown in Page. FormData has the highlighted statement.
@param[in] Statement The statement current selected.
@param[in] Selected Whether or not a tag be selected. TRUE means Enter has hit this question.
**/
@@ -84,10 +84,10 @@ RefreshKeyHelp (
/**
Update status bar.
This function updates the status bar on the bottom of menu screen. It just shows StatusBar.
This function updates the status bar on the bottom of menu screen. It just shows StatusBar.
Original logic in this function should be splitted out.
@param[in] MessageType The type of message to be shown. InputError or Configuration Changed.
@param[in] MessageType The type of message to be shown. InputError or Configuration Changed.
@param[in] State Show or Clear Message.
**/
VOID
@@ -98,13 +98,13 @@ UpdateStatusBar (
);
/**
Create popup window.
Create popup window.
This function draws OEM/Vendor specific pop up windows.
@param[out] Key User Input Key
@param ... String to be shown in Popup. The variable argument list is terminated by a NULL.
**/
VOID
EFIAPI
@@ -114,8 +114,8 @@ CreateDialog (
);
/**
Confirm how to handle the changed data.
Confirm how to handle the changed data.
@return Action BROWSER_ACTION_SUBMIT, BROWSER_ACTION_DISCARD or other values.
**/
UINTN
@@ -127,7 +127,7 @@ ConfirmDataChange (
/**
OEM specifies whether Setup exits Page by ESC key.
This function customized the behavior that whether Setup exits Page so that
This function customized the behavior that whether Setup exits Page so that
system able to boot when configuration is not changed.
@retval TRUE Exits FrontPage
@@ -140,14 +140,14 @@ FormExitPolicy (
);
/**
Set Timeout value for a ceratain Form to get user response.
Set Timeout value for a ceratain Form to get user response.
This function allows to set timeout value on a ceratain form if necessary.
If timeout is not zero, the form will exit if user has no response in timeout.
If timeout is not zero, the form will exit if user has no response in timeout.
@param[in] FormData Form Data to be shown in Page
@return 0 No timeout for this form.
@return 0 No timeout for this form.
@return > 0 Timeout value in 100 ns units.
**/
UINT64
@@ -186,8 +186,8 @@ PrintStringAt (
@param Column The cursor position to print the string at. When it is -1, use current Position.
@param Row The cursor position to print the string at. When it is -1, use current Position.
@param String String pointer.
@param Width Width for String to be printed. If the print length of String < Width,
Space char (L' ') will be used to append String.
@param Width Width for String to be printed. If the print length of String < Width,
Space char (L' ') will be used to append String.
@return Length of string printed to the console

14
MdeModulePkg/Include/Library/DpcLib.h
View File

@@ -1,13 +1,13 @@
/** @file
DpcLib.h.
Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/

12
MdeModulePkg/Include/Library/FileExplorerLib.h
View File

@@ -2,13 +2,13 @@
This library class defines a set of interfaces for how to do file explorer.
Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Protocol/FileExplorer.h>
/**
Choose a file in the specified directory.
Choose a file in the specified directory.
If user input NULL for the RootDirectory, will choose file in the system.

236
MdeModulePkg/Include/Library/HiiLib.h
View File

@@ -1,14 +1,14 @@
/** @file
Public include file for the HII Library
Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -29,7 +29,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
If an empty list of packages is passed in, then NULL is returned. If the size of
the list of package is 0, then NULL is returned.
The variable arguments are pointers that point to package headers defined
The variable arguments are pointers that point to package headers defined
by UEFI VFR compiler and StringGather tool.
#pragma pack (push, 1)
@@ -38,13 +38,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
EFI_HII_PACKAGE_HEADER PackageHeader;
} EDKII_AUTOGEN_PACKAGES_HEADER;
#pragma pack (pop)
@param[in] PackageListGuid The GUID of the package list.
@param[in] DeviceHandle If not NULL, the Device Handle on which
@param[in] DeviceHandle If not NULL, the Device Handle on which
an instance of DEVICE_PATH_PROTOCOL is installed.
This Device Handle uniquely defines the device that
This Device Handle uniquely defines the device that
the added packages are associated with.
@param[in] ... The variable argument list that contains pointers
@param[in] ... The variable argument list that contains pointers
to packages terminated by a NULL.
@retval NULL An HII Handle has already been registered in the HII Database with
@@ -81,37 +81,37 @@ HiiRemovePackages (
;
/**
This function creates a new string in String Package or updates an existing
This function creates a new string in String Package or updates an existing
string in a String Package. If StringId is 0, then a new string is added to
a String Package. If StringId is not zero, then a string in String Package is
updated. If SupportedLanguages is NULL, then the string is added or updated
for all the languages that the String Package supports. If SupportedLanguages
is not NULL, then the string is added or updated for the set of languages
is not NULL, then the string is added or updated for the set of languages
specified by SupportedLanguages.
If HiiHandle is NULL, then ASSERT().
If String is NULL, then ASSERT().
@param[in] HiiHandle A handle that was previously registered in the
@param[in] HiiHandle A handle that was previously registered in the
HII Database.
@param[in] StringId If zero, then a new string is created in the
String Package associated with HiiHandle. If
non-zero, then the string specified by StringId
is updated in the String Package associated
with HiiHandle.
@param[in] String A pointer to the Null-terminated Unicode string
to add or update in the String Package associated
@param[in] StringId If zero, then a new string is created in the
String Package associated with HiiHandle. If
non-zero, then the string specified by StringId
is updated in the String Package associated
with HiiHandle.
@param[in] SupportedLanguages A pointer to a Null-terminated ASCII string of
language codes. If this parameter is NULL, then
String is added or updated in the String Package
associated with HiiHandle for all the languages
that the String Package supports. If this
parameter is not NULL, then String is added
or updated in the String Package associated with
HiiHandle for the set of languages specified by
SupportedLanguages. The format of
SupportedLanguages must follow the language
@param[in] String A pointer to the Null-terminated Unicode string
to add or update in the String Package associated
with HiiHandle.
@param[in] SupportedLanguages A pointer to a Null-terminated ASCII string of
language codes. If this parameter is NULL, then
String is added or updated in the String Package
associated with HiiHandle for all the languages
that the String Package supports. If this
parameter is not NULL, then String is added
or updated in the String Package associated with
HiiHandle for the set of languages specified by
SupportedLanguages. The format of
SupportedLanguages must follow the language
format assumed in the HII Database.
@retval 0 The string could not be added or updated in the String Package.
@@ -130,21 +130,21 @@ HiiSetString (
/**
Retrieves a string from a string package in a specific language. If the language
is not specified, then a string from a string package in the current platform
language is retrieved. If the string cannot be retrieved using the specified
language or the current platform language, then the string is retrieved from
the string package in the first language the string package supports. The
returned string is allocated using AllocatePool(). The caller is responsible
is not specified, then a string from a string package in the current platform
language is retrieved. If the string cannot be retrieved using the specified
language or the current platform language, then the string is retrieved from
the string package in the first language the string package supports. The
returned string is allocated using AllocatePool(). The caller is responsible
for freeing the allocated buffer using FreePool().
If HiiHandle is NULL, then ASSERT().
If StringId is 0, then ASSERT().
@param[in] HiiHandle A handle that was previously registered in the HII Database.
@param[in] StringId The identifier of the string to retrieved from the string
@param[in] StringId The identifier of the string to retrieved from the string
package associated with HiiHandle.
@param[in] Language The language of the string to retrieve. If this parameter
is NULL, then the current platform language is used. The
@param[in] Language The language of the string to retrieve. If this parameter
is NULL, then the current platform language is used. The
format of Language must follow the language format assumed in
the HII Database.
@@ -162,24 +162,24 @@ HiiGetString (
;
/**
Retrieves a string from a string package named by GUID, in the specified language.
If the language is not specified, then a string from a string package in the
current platform language is retrieved. If the string cannot be retrieved
using the specified language or the current platform language, then the string
is retrieved from the string package in the first language the string package
supports. The returned string is allocated using AllocatePool(). The caller
Retrieves a string from a string package named by GUID, in the specified language.
If the language is not specified, then a string from a string package in the
current platform language is retrieved. If the string cannot be retrieved
using the specified language or the current platform language, then the string
is retrieved from the string package in the first language the string package
supports. The returned string is allocated using AllocatePool(). The caller
is responsible for freeing the allocated buffer using FreePool().
If PackageListGuid is NULL, then ASSERT().
If StringId is 0, then ASSERT().
@param[in] PackageListGuid The GUID of a package list that was previously
@param[in] PackageListGuid The GUID of a package list that was previously
registered in the HII Database.
@param[in] StringId The identifier of the string to retrieved from the
@param[in] StringId The identifier of the string to retrieved from the
string package associated with PackageListGuid.
@param[in] Language The language of the string to retrieve. If this
parameter is NULL, then the current platform
language is used. The format of Language must
@param[in] Language The language of the string to retrieve. If this
parameter is NULL, then the current platform
language is used. The format of Language must
follow the language format assumed in the HII Database.
@retval NULL The package list specified by PackageListGuid is not present in the
@@ -204,12 +204,12 @@ HiiGetPackageString (
This function allocates the returned array using AllocatePool().
The caller is responsible for freeing the array with FreePool().
@param[in] PackageListGuid An optional parameter that is used to request
@param[in] PackageListGuid An optional parameter that is used to request
HII Handles associated with a specific
Package List GUID. If this parameter is NULL,
then all the HII Handles in the HII Database
are returned. If this parameter is not NULL,
then zero or more HII Handles associated with
then zero or more HII Handles associated with
PackageListGuid are returned.
@retval NULL No HII handles were found in the HII database
@@ -226,7 +226,7 @@ HiiGetHiiHandles (
/**
This function allows a caller to extract the form set opcode form the Hii Handle.
The returned buffer is allocated using AllocatePool().The caller is responsible
The returned buffer is allocated using AllocatePool().The caller is responsible
for freeing the allocated buffer using FreePool().
@param Handle The HII handle.
@@ -248,12 +248,12 @@ HiiGetFormSetFromHiiHandle(
);
/**
Retrieves a pointer to a Null-terminated ASCII string containing the list
of languages that an HII handle in the HII Database supports. The returned
Retrieves a pointer to a Null-terminated ASCII string containing the list
of languages that an HII handle in the HII Database supports. The returned
string is allocated using AllocatePool(). The caller is responsible for freeing
the returned string using FreePool(). The format of the returned string follows
the language format assumed in the HII Database.
If HiiHandle is NULL, then ASSERT().
@param[in] HiiHandle A handle that was previously registered in the HII Database.
@@ -273,23 +273,23 @@ HiiGetSupportedLanguages (
;
/**
Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing
Allocates and returns a Null-terminated Unicode <ConfigHdr> string using routing
information that includes a GUID, an optional Unicode string name, and a device
path. The string returned is allocated with AllocatePool(). The caller is
path. The string returned is allocated with AllocatePool(). The caller is
responsible for freeing the allocated string with FreePool().
The format of a <ConfigHdr> is as follows:
GUID=<HexCh>32&NAME=<Char>NameLength&PATH=<HexChar>DevicePathSize<Null>
@param[in] Guid The pointer to an EFI_GUID that is the routing information
GUID. Each of the 16 bytes in Guid is converted to
GUID. Each of the 16 bytes in Guid is converted to
a 2 Unicode character hexadecimal string. This is
an optional parameter that may be NULL.
@param[in] Name The pointer to a Null-terminated Unicode string that is
the routing information NAME. This is an optional
parameter that may be NULL. Each 16-bit Unicode
character in Name is converted to a 4 character Unicode
@param[in] Name The pointer to a Null-terminated Unicode string that is
the routing information NAME. This is an optional
parameter that may be NULL. Each 16-bit Unicode
character in Name is converted to a 4 character Unicode
hexadecimal string.
@param[in] DriverHandle The driver handle that supports a Device Path Protocol
that is the routing information PATH. Each byte of
@@ -311,23 +311,23 @@ HiiConstructConfigHdr (
/**
Reset the default value specified by DefaultId to the driver
configuration specified by the Request string.
configuration specified by the Request string.
NULL request string support depends on the ExportConfig interface of
HiiConfigRouting protocol in UEFI specification.
@param Request A null-terminated Unicode string in
@param Request A null-terminated Unicode string in
<MultiConfigRequest> format. It can be NULL.
If it is NULL, all configurations for the
entirety of the current HII database will be reset.
@param DefaultId Specifies the type of defaults to retrieve.
@retval TRUE The default value was set successfully.
@retval FALSE The default value was not found.
**/
BOOLEAN
EFIAPI
HiiSetToDefaults (
EFIAPI
HiiSetToDefaults (
IN CONST EFI_STRING Request, OPTIONAL
IN UINT16 DefaultId
);
@@ -337,17 +337,17 @@ HiiSetToDefaults (
NULL request string support depends on the ExportConfig interface of
HiiConfigRouting protocol in the UEFI specification.
@param Request A null-terminated Unicode string in
@param Request A null-terminated Unicode string in
<MultiConfigRequest> format. It can be NULL.
If it is NULL, all current configurations for the
entirety of the current HII database will be validated.
@retval TRUE The current configuration is valid.
@retval FALSE The current configuration is invalid.
**/
BOOLEAN
EFIAPI
EFIAPI
HiiValidateSettings (
IN CONST EFI_STRING Request OPTIONAL
);
@@ -377,11 +377,11 @@ HiiIsConfigHdrMatch (
Retrieves uncommitted data from the Form Browser and converts it to a binary
buffer.
@param[in] VariableGuid The pointer to an EFI_GUID structure. This is an optional
@param[in] VariableGuid The pointer to an EFI_GUID structure. This is an optional
parameter that may be NULL.
@param[in] VariableName The pointer to a Null-terminated Unicode string. This
@param[in] VariableName The pointer to a Null-terminated Unicode string. This
is an optional parameter that may be NULL.
@param[in] BufferSize The length in bytes of buffer to hold retrieved data.
@param[in] BufferSize The length in bytes of buffer to hold retrieved data.
@param[out] Buffer The buffer of data to be updated.
@retval FALSE The uncommitted data could not be retrieved.
@@ -411,7 +411,7 @@ HiiGetBrowserData (
@param[in] RequestElement An optional field to specify which part of the
buffer data will be send back to Browser. If NULL,
the whole buffer of data will be committed to
Browser.
Browser.
<RequestElement> ::= &OFFSET=<Number>&WIDTH=<Number>*
@retval FALSE The uncommitted data could not be updated.
@@ -436,9 +436,9 @@ HiiSetBrowserData (
/**
Returns a UINT64 value that contains bitfields for Hour, Minute, and Second.
The lower 8-bits of Hour are placed in bits 0..7. The lower 8-bits of Minute
are placed in bits 8..15, and the lower 8-bits of Second are placed in bits
16..23. This format was selected because it can be easily translated to
The lower 8-bits of Hour are placed in bits 0..7. The lower 8-bits of Minute
are placed in bits 8..15, and the lower 8-bits of Second are placed in bits
16..23. This format was selected because it can be easily translated to
an EFI_HII_TIME structure in an EFI_IFR_TYPE_VALUE union.
@param Hour The hour value to be encoded.
@@ -452,9 +452,9 @@ HiiSetBrowserData (
/**
Returns a UINT64 value that contains bit fields for Year, Month, and Day.
The lower 16-bits of Year are placed in bits 0..15. The lower 8-bits of Month
are placed in bits 16..23, and the lower 8-bits of Day are placed in bits
24..31. This format was selected because it can be easily translated to
The lower 16-bits of Year are placed in bits 0..15. The lower 8-bits of Month
are placed in bits 16..23, and the lower 8-bits of Day are placed in bits
24..31. This format was selected because it can be easily translated to
an EFI_HII_DATE structure in an EFI_IFR_TYPE_VALUE union.
@param Year The year value to be encoded.
@@ -467,7 +467,7 @@ HiiSetBrowserData (
(UINT64)((Year & 0xffff) | ((Month & 0xff) << 16) | ((Day & 0xff) << 24))
/**
Allocates and returns a new OpCode Handle. OpCode Handles must be freed with
Allocates and returns a new OpCode Handle. OpCode Handles must be freed with
HiiFreeOpCodeHandle().
@retval NULL There are not enough resources to allocate a new OpCode Handle.
@@ -595,14 +595,14 @@ HiiCreateDefaultOpCode (
@param[in] OpCodeHandle The handle to the buffer of opcodes.
@param[in] Guid The pointer to EFI_GUID of this guided opcode.
@param[in] GuidOpCode The pointer to an EFI_IFR_GUID opcode. This is an
@param[in] GuidOpCode The pointer to an EFI_IFR_GUID opcode. This is an
optional parameter that may be NULL. If this
parameter is NULL, then the GUID extension
parameter is NULL, then the GUID extension
region of the created opcode is filled with zeros.
If this parameter is not NULL, then the GUID
extension region of GuidData will be copied to
If this parameter is not NULL, then the GUID
extension region of GuidData will be copied to
the GUID extension region of the created opcode.
@param[in] OpCodeSize The size, in bytes, of created opcode. This value
@param[in] OpCodeSize The size, in bytes, of created opcode. This value
must be >= sizeof(EFI_IFR_GUID).
@retval NULL There is not enough space left in Buffer to add the opcode.
@@ -705,7 +705,7 @@ HiiCreateGotoOpCode (
/**
Create EFI_IFR_REF_OP, EFI_IFR_REF2_OP, EFI_IFR_REF3_OP and EFI_IFR_REF4_OP opcode.
When RefDevicePath is not zero, EFI_IFR_REF4 opcode will be created.
When RefDevicePath is not zero, EFI_IFR_REF4 opcode will be created.
When RefDevicePath is zero and RefFormSetId is not NULL, EFI_IFR_REF3 opcode will be created.
When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is not zero, EFI_IFR_REF2 opcode will be created.
When RefDevicePath is zero, RefFormSetId is NULL and RefQuestionId is zero, EFI_IFR_REF opcode will be created.
@@ -719,11 +719,11 @@ HiiCreateGotoOpCode (
@param[in] Help The string ID for Help.
@param[in] QuestionFlags The flags in Question Header
@param[in] QuestionId Question ID.
@param[in] RefQuestionId The question on the form to which this link is referring.
@param[in] RefQuestionId The question on the form to which this link is referring.
If its value is zero, then the link refers to the top of the form.
@param[in] RefFormSetId The form set to which this link is referring. If its value is NULL, and RefDevicePath is
@param[in] RefFormSetId The form set to which this link is referring. If its value is NULL, and RefDevicePath is
zero, then the link is to the current form set.
@param[in] RefDevicePath The string identifier that specifies the string containing the text representation of
@param[in] RefDevicePath The string identifier that specifies the string containing the text representation of
the device path to which the form set containing the form specified by FormId.
If its value is zero, then the link refers to the current page.
@@ -1050,26 +1050,26 @@ HiiCreateTimeOpCode (
);
/**
This function updates a form that has previously been registered with the HII
This function updates a form that has previously been registered with the HII
Database. This function will perform at most one update operation.
The form to update is specified by Handle, FormSetGuid, and FormId. Binary
comparisons of IFR opcodes are performed from the beginning of the form being
updated until an IFR opcode is found that exactly matches the first IFR opcode
The form to update is specified by Handle, FormSetGuid, and FormId. Binary
comparisons of IFR opcodes are performed from the beginning of the form being
updated until an IFR opcode is found that exactly matches the first IFR opcode
specified by StartOpCodeHandle. The following rules are used to determine if
an insert, replace, or delete operation is performed:
1) If no matches are found, then NULL is returned.
1) If no matches are found, then NULL is returned.
2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes
from StartOpCodeHandle except the first opcode are inserted immediately after
from StartOpCodeHandle except the first opcode are inserted immediately after
the matching IFR opcode in the form to be updated.
3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made
from the matching IFR opcode until an IFR opcode exactly matches the first
3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made
from the matching IFR opcode until an IFR opcode exactly matches the first
IFR opcode specified by EndOpCodeHandle. If no match is found for the first
IFR opcode specified by EndOpCodeHandle, then NULL is returned. If a match
is found, then all of the IFR opcodes between the start match and the end
is found, then all of the IFR opcodes between the start match and the end
match are deleted from the form being updated and all of the IFR opcodes
from StartOpCodeHandle except the first opcode are inserted immediately after
from StartOpCodeHandle except the first opcode are inserted immediately after
the matching start IFR opcode. If StartOpCcodeHandle only contains one
IFR instruction, then the result of this operation will delete all of the IFR
opcodes between the start end matches.
@@ -1082,26 +1082,26 @@ HiiCreateTimeOpCode (
is an optional parameter that may be NULL.
If it is NULL, all FormSet will be updated.
@param[in] FormId The ID of the form to update.
@param[in] StartOpCodeHandle An OpCode Handle that contains the set of IFR
@param[in] StartOpCodeHandle An OpCode Handle that contains the set of IFR
opcodes to be inserted or replaced in the form.
The first IFR instruction in StartOpCodeHandle
is used to find matching IFR opcode in the
form.
The first IFR instruction in StartOpCodeHandle
is used to find matching IFR opcode in the
form.
@param[in] EndOpCodeHandle An OpCcode Handle that contains the IFR opcode
that marks the end of a replace operation in
the form. This is an optional parameter that
may be NULL. If it is NULL, then the IFR
opcodes specified by StartOpCodeHandle are
opcodes specified by StartOpCodeHandle are
inserted into the form.
@retval EFI_OUT_OF_RESOURCES Not enough memory resources are allocated.
@retval EFI_NOT_FOUND The following cases will return EFI_NOT_FOUND:
1) The form specified by HiiHandle, FormSetGuid,
1) The form specified by HiiHandle, FormSetGuid,
and FormId could not be found in the HII Database.
2) No IFR opcodes in the target form match the first
IFR opcode in StartOpCodeHandle.
3) EndOpCOde is not NULL, and no IFR opcodes in the
target form following a matching start opcode match
3) EndOpCOde is not NULL, and no IFR opcodes in the
target form following a matching start opcode match
the first IFR opcode in EndOpCodeHandle.
@retval EFI_SUCCESS The matched form is updated by StartOpcode.

32
MdeModulePkg/Include/Library/HttpLib.h
View File

@@ -2,7 +2,7 @@
This library is used to share code between UEFI network stack modules.
It provides the helper routines to parse the HTTP message byte stream.
Copyright (c) 2015 - 2016, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.<BR>
(C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@@ -22,10 +22,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Decode a percent-encoded URI component to the ASCII character.
Decode the input component in Buffer according to RFC 3986. The caller is responsible to make
Decode the input component in Buffer according to RFC 3986. The caller is responsible to make
sure ResultBuffer points to a buffer with size equal or greater than ((AsciiStrSize (Buffer))
in bytes.
in bytes.
@param[in] Buffer The pointer to a percent-encoded URI component.
@param[in] BufferLength Length of Buffer in bytes.
@@ -34,7 +34,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@retval EFI_SUCCESS Successfully decoded the URI.
@retval EFI_INVALID_PARAMETER Buffer is not a valid percent-encoded string.
**/
EFI_STATUS
EFIAPI
@@ -61,7 +61,7 @@ UriPercentDecode (
@retval EFI_SUCCESS Successfully dereferenced the HTTP URL.
@retval EFI_INVALID_PARAMETER UrlParser is NULL or Url is not a valid HTTP URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
@@ -86,7 +86,7 @@ HttpParseUrl (
@retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No hostName component in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
@@ -109,7 +109,7 @@ HttpUrlGetHostName (
@retval EFI_INVALID_PARAMETER Uri is NULL or Ip4Address is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No IPv4 address component in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
@@ -132,7 +132,7 @@ HttpUrlGetIp4 (
@retval EFI_INVALID_PARAMETER Uri is NULL or Ip6Address is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No IPv6 address component in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
@@ -155,7 +155,7 @@ HttpUrlGetIp6 (
@retval EFI_INVALID_PARAMETER Uri is NULL or Port is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No port number in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
@@ -179,7 +179,7 @@ HttpUrlGetPort (
@retval EFI_INVALID_PARAMETER Uri is NULL or HostName is NULL or UrlParser is invalid.
@retval EFI_NOT_FOUND No hostName component in the URL.
@retval EFI_OUT_OF_RESOURCES Could not allocate needed resources.
**/
EFI_STATUS
EFIAPI
@@ -193,7 +193,7 @@ HttpUrlGetPath (
Release the resource of the URL parser.
@param[in] UrlParser Pointer to the parser.
**/
VOID
EFIAPI
@@ -231,7 +231,7 @@ typedef enum {
@retval EFI_SUCCESS Continue to parser the message body.
@retval Others Abort the parse.
**/
typedef
EFI_STATUS
@@ -288,7 +288,7 @@ HttpInitMsgParser (
@retval EFI_INVALID_PARAMETER MsgParser is NULL or Body is NULL or BodyLength is 0.
@retval EFI_ABORTED Operation aborted.
@retval Other Error happened while parsing message body.
**/
EFI_STATUS
EFIAPI
@@ -324,7 +324,7 @@ HttpIsMessageComplete (
@retval EFI_SUCCESS Successfully to get the entity length.
@retval EFI_NOT_READY Entity length is not valid yet.
@retval EFI_INVALID_PARAMETER MsgParser is NULL or ContentLength is NULL.
**/
EFI_STATUS
EFIAPI
@@ -337,7 +337,7 @@ HttpGetEntityLength (
Release the resource of the message parser.
@param[in] MsgParser Pointer to the message parser.
**/
VOID
EFIAPI

94
MdeModulePkg/Include/Library/IpIoLib.h
View File

@@ -2,13 +2,13 @@
This library is only intended to be used by UEFI network stack modules.
It provides the combined IpIo layer on the EFI IP4 Protocol and EFI IP6 protocol.
Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Library/NetLib.h>
//
// type and code define for ICMP protocol error
// type and code define for ICMP protocol error
// from IP
//
#define ICMP_TYPE_UNREACH 3
@@ -48,20 +48,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Get the IP header length from the struct EFI_IP4_HEADER. HeaderLength is
Internet header length in 32-bit words, so HeaderLength<<2 is the real
length of IP header.
@param[out] HdrPtr A pointer to EFI_IP4_HEADER.
@return The IP header length.
**/
#define EFI_IP4_HEADER_LEN(HdrPtr) ((HdrPtr)->HeaderLength << 2)
/**
To types of ICMP error which consist of ICMP header, IP header and original
datagram's data, get length from sum of ICMP header length, IP header length
To types of ICMP error which consist of ICMP header, IP header and original
datagram's data, get length from sum of ICMP header length, IP header length
and first 64 bits of datagram's data length.
@param[in] IpHdr A pointer to EFI_IP4_HEADER.
@return The ICMP error length.
**/
#define ICMP_ERRLEN(IpHdr) \
@@ -69,15 +69,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Get the packet header from NET_BUF.
@param[out] Buf A pointer to NET_BUF.
@param[in] Type Header type.
@return The pointer to packet header.
**/
#define NET_PROTO_HDR(Buf, Type) ((Type *) ((Buf)->BlockOp[0].Head))
extern EFI_IP4_CONFIG_DATA mIp4IoDefaultIpConfigData;
extern EFI_IP6_CONFIG_DATA mIp6IoDefaultIpConfigData;
@@ -165,8 +165,8 @@ typedef struct _EFI_NET_SESSION_DATA {
EFI_IP_ADDRESS Source; ///< Source IP of the received packet.
EFI_IP_ADDRESS Dest; ///< Destination IP of the received packet.
IP_IO_IP_HEADER IpHdr; ///< IP header of the received packet.
UINT32 IpHdrLen; ///< IP header length of the received packet.
///< For IPv6, it includes the IP6 header
UINT32 IpHdrLen; ///< IP header length of the received packet.
///< For IPv6, it includes the IP6 header
///< length and extension header length. For
///< IPv4, it includes the IP4 header length
///< and options length.
@@ -175,19 +175,19 @@ typedef struct _EFI_NET_SESSION_DATA {
/**
The prototype is called back when an IP packet is received.
@param[in] Status The result of the receive request.
@param[in] IcmpErr Valid when Status is EFI_ICMP_ERROR.
@param[in] NetSession The IP session for the received packet.
@param[in] Pkt The packet received.
@param[in] Context The data provided by the user for the received packet when
the callback is registered in IP_IO_OPEN_DATA::RcvdContext.
**/
typedef
VOID
(EFIAPI *PKT_RCVD_NOTIFY) (
IN EFI_STATUS Status,
IN EFI_STATUS Status,
IN UINT8 IcmpErr,
IN EFI_NET_SESSION_DATA *NetSession,
IN NET_BUF *Pkt,
@@ -196,14 +196,14 @@ VOID
/**
The prototype is called back when an IP packet is sent.
@param[in] Status Result of the IP packet being sent.
@param[in] Context The data provided by user for the received packet when
the callback is registered in IP_IO_OPEN_DATA::SndContext.
@param[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL
@param[in] Sender A Union type to specify a pointer of EFI_IP4_PROTOCOL
or EFI_IP6_PROTOCOL.
@param[in] NotifyData The Context data specified when calling IpIoSend()
**/
typedef
VOID
@@ -228,7 +228,7 @@ typedef struct _IP_IO {
/// The list used to maintain the IP instance for different sending purpose.
///
LIST_ENTRY IpList;
EFI_HANDLE Controller;
EFI_HANDLE Image;
EFI_HANDLE ChildHandle;
@@ -246,7 +246,7 @@ typedef struct _IP_IO {
///
/// Token and event used to get data from IP.
///
IP_IO_IP_COMPLETION_TOKEN RcvToken;
IP_IO_IP_COMPLETION_TOKEN RcvToken;
///
/// List entry used to link the token passed to IP_IO.
@@ -312,7 +312,7 @@ typedef struct _IP_IO_IP_INFO {
Create a new IP_IO instance.
If IpVersion is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
This function uses IP4/IP6 service binding protocol in Controller to create
an IP4/IP6 child (aka IP4/IP6 instance).
@@ -321,7 +321,7 @@ typedef struct _IP_IO_IP_INFO {
@param[in] Controller The controller handle that has IP4 or IP6 service
binding protocol installed.
@param[in] IpVersion The version of the IP protocol to use, either
IPv4 or IPv6.
IPv4 or IPv6.
@return The pointer to a newly created IP_IO instance, or NULL if failed.
@@ -336,7 +336,7 @@ IpIoCreate (
/**
Destroy an IP_IO instance.
This function is paired with IpIoCreate(). The IP_IO will be closed first.
Resource will be freed afterwards. See IpIoClose().
@@ -357,7 +357,7 @@ IpIoDestroy (
Stop an IP_IO instance.
If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
This function is paired with IpIoOpen(). The IP_IO will be unconfigured, and all
pending send/receive tokens will be canceled.
@@ -390,7 +390,7 @@ IpIoStop (
@retval EFI_SUCCESS The IP_IO instance opened with OpenData
successfully.
@retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
@retval EFI_ACCESS_DENIED The IP_IO instance is configured, avoid to
reopen it.
@retval EFI_UNSUPPORTED IPv4 RawData mode is no supported.
@retval EFI_INVALID_PARAMETER Invalid input parameter.
@@ -406,7 +406,7 @@ IpIoOpen (
/**
Send out an IP packet.
This function is called after IpIoOpen(). The data to be sent is wrapped in
Pkt. The IP instance wrapped in IpIo is used for sending by default but can be
overriden by Sender. Other sending configs, like source address and gateway
@@ -464,7 +464,7 @@ IpIoCancelTxToken (
If IpIo is NULL, then ASSERT().
If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
The function is used to add the IP_IO to the IP_IO sending list. The caller
can later use IpIoFindSender() to get the IP_IO and call IpIoSend() to send
data.
@@ -488,7 +488,7 @@ IpIoAddIp (
If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
@param[in, out] IpInfo The pointer to the IP_IO_IP_INFO instance.
@param[in, out] IpConfigData The IP4 or IP6 configure data used to configure
@param[in, out] IpConfigData The IP4 or IP6 configure data used to configure
the IP instance. If NULL, the IP instance is reset.
If UseDefaultAddress is set to TRUE, and the configure
operation succeeds, the default address information
@@ -510,8 +510,8 @@ IpIoConfigIp (
Destroy an IP instance maintained in IpIo->IpList for
sending purpose.
If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
If Ip version is not IP_VERSION_4 or IP_VERSION_6, then ASSERT().
This function pairs with IpIoAddIp(). The IpInfo is previously created by
IpIoAddIp(). The IP_IO_IP_INFO::RefCnt is decremented and the IP instance
will be dstroyed if the RefCnt is zero.
@@ -530,7 +530,7 @@ IpIoRemoveIp (
/**
Find the first IP protocol maintained in IpIo whose local
address is the same as Src.
This function is called when the caller needs the IpIo to send data to the
specified Src. The IpIo was added previously by IpIoAddIp().
@@ -553,13 +553,13 @@ IpIoFindSender (
/**
Get the ICMP error map information.
The ErrorStatus will be returned. The IsHard and Notify are optional. If they
are not NULL, this routine will fill them.
@param[in] IcmpError IcmpError Type.
@param[in] IpVersion The version of the IP protocol to use,
either IPv4 or IPv6.
either IPv4 or IPv6.
@param[out] IsHard If TRUE, indicates that it is a hard error.
@param[out] Notify If TRUE, SockError needs to be notified.
@@ -580,23 +580,23 @@ IpIoGetIcmpErrStatus (
Refresh the remote peer's Neighbor Cache entries.
This function is called when the caller needs the IpIo to refresh the existing
IPv6 neighbor cache entries since the neighbor is considered reachable by the
node has recently received a confirmation that packets sent recently to the
neighbor were received by its IP layer.
IPv6 neighbor cache entries since the neighbor is considered reachable by the
node has recently received a confirmation that packets sent recently to the
neighbor were received by its IP layer.
@param[in] IpIo The pointer to an IP_IO instance
@param[in] Neighbor The IP address of the neighbor
@param[in] Timeout The time in 100-ns units that this entry will
remain in the neighbor cache. A value of
zero means that the entry is permanent.
A value of non-zero means that the entry is
remain in the neighbor cache. A value of
zero means that the entry is permanent.
A value of non-zero means that the entry is
dynamic and will be deleted after Timeout.
@retval EFI_SUCCESS The operation completed successfully.
@retval EFI_NOT_STARTED The IpIo is not configured.
@retval EFI_INVALID_PARAMETER The Neighbor Address is invalid.
@retval EFI_NOT_FOUND The neighbor cache entry is not in the
neighbor table.
@retval EFI_NOT_FOUND The neighbor cache entry is not in the
neighbor table.
@retval EFI_UNSUPPORTED IP version is IPv4, which doesn't support neighbor cache refresh.
@retval EFI_OUT_OF_RESOURCES Failed due to resource limitations.
@@ -606,7 +606,7 @@ EFIAPI
IpIoRefreshNeighbor (
IN IP_IO *IpIo,
IN EFI_IP_ADDRESS *Neighbor,
IN UINT32 Timeout
IN UINT32 Timeout
);
#endif

2
MdeModulePkg/Include/Library/LockBoxLib.h
View File

@@ -109,7 +109,7 @@ UpdateLockBox (
@retval RETURN_SUCCESS the information is restored successfully.
@retval RETURN_INVALID_PARAMETER the Guid is NULL, or one of Buffer and Length is NULL.
@retval RETURN_WRITE_PROTECTED Buffer and Length are NULL, but the LockBox has no
@retval RETURN_WRITE_PROTECTED Buffer and Length are NULL, but the LockBox has no
LOCK_BOX_ATTRIBUTE_RESTORE_IN_PLACE attribute.
@retval RETURN_BUFFER_TOO_SMALL the Length is too small to hold the confidential information.
@retval RETURN_NOT_FOUND the requested GUID not found.

14
MdeModulePkg/Include/Library/MemoryProfileLib.h
View File

@@ -1,14 +1,14 @@
/** @file
Provides services to record memory profile of multilevel caller.
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/

60
MdeModulePkg/Include/Library/NetLib.h
View File

@@ -52,7 +52,7 @@ typedef UINT16 TCP_PORTNO;
#define IP4_MASK_NUM 33
#define IP6_PREFIX_NUM 129
#define IP4_MASK_MAX 32
#define IP4_MASK_MAX 32
#define IP6_PREFIX_MAX 128
#define IP6_HOP_BY_HOP 0
@@ -416,14 +416,14 @@ NetGetIpClass (
/**
Check whether the IP is a valid unicast address according to
the netmask.
the netmask.
ASSERT if NetMask is zero.
If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,
except when the originator is one of the endpoints of a point-to-point link with a 31-bit
mask (RFC3021).
@param[in] Ip The IP to check against.
@param[in] NetMask The mask of the IP.
@@ -593,7 +593,7 @@ NetPutUint32 (
/**
Initialize a random seed using current time and monotonic count.
Get current time and monotonic count first. Then initialize a random seed
Get current time and monotonic count first. Then initialize a random seed
based on some basic mathematics operation on the hour, day, minute, second,
nanosecond and year of the current time and the monotonic count value.
@@ -729,7 +729,7 @@ NetListInsertBefore (
/**
Callback function which provided by user to remove one node in NetDestroyLinkList process.
@param[in] Entry The entry to be removed.
@param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
@@ -753,7 +753,7 @@ EFI_STATUS
If it has been removed, then restart the traversal from the head.
If it hasn't been removed, then continue with the next node directly.
This function will end the iterate and return the CallBack's last return value if error happens,
or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
@param[in] List The head of the list.
@param[in] CallBack Pointer to the callback function to destroy one node in the list.
@@ -1255,8 +1255,8 @@ NetLibGetMacString (
GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
will try to invoke Snp->GetStatus() to get the media status. If media is already
present, it returns directly. If media is not present, it will stop SNP and then
restart SNP to get the latest media status. This provides an opportunity to get
the correct media status for old UNDI driver, which doesn't support reporting
restart SNP to get the latest media status. This provides an opportunity to get
the correct media status for old UNDI driver, which doesn't support reporting
media status from GET_STATUS command.
Note: there are two limitations for the current algorithm:
1) For UNDI with this capability, when the cable is not attached, there will
@@ -1284,13 +1284,13 @@ NetLibDetectMedia (
);
/**
Detect media state for a network device. This routine will wait for a period of time at
a specified checking interval when a certain network is under connecting until connection
Detect media state for a network device. This routine will wait for a period of time at
a specified checking interval when a certain network is under connecting until connection
process finishes or timeout. If Aip protocol is supported by low layer drivers, three kinds
of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents
connected state, connecting state and no media state respectively. When function detects
the current state is EFI_NOT_READY, it will loop to wait for next time's check until state
turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will
connected state, connecting state and no media state respectively. When function detects
the current state is EFI_NOT_READY, it will loop to wait for next time's check until state
turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will
call NetLibDetectMedia() and return state directly.
@param[in] ServiceHandle The handle where network service binding protocols are
@@ -1301,7 +1301,7 @@ NetLibDetectMedia (
@param[out] MediaState The pointer to the detected media state.
@retval EFI_SUCCESS Media detection success.
@retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or
@retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or
MediaState pointer is NULL.
@retval EFI_DEVICE_ERROR A device error occurred.
@retval EFI_TIMEOUT Network is connecting but timeout.
@@ -1522,14 +1522,14 @@ NetLibStrToIp6andPrefix (
Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
The text representation of address is defined in RFC 4291.
@param[in] Ip6Address The pointer to the IPv6 address.
@param[out] String The buffer to return the converted string.
@param[in] StringSize The length in bytes of the input String.
@retval EFI_SUCCESS Convert to string successfully.
@retval EFI_INVALID_PARAMETER The input parameter is invalid.
@retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
@retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
updated with the size needed to complete the request.
**/
EFI_STATUS
@@ -1862,7 +1862,7 @@ NetbufAllocSpace (
@param[in, out] Nbuf The pointer to the net buffer.
@param[in] Len The length of the data to be trimmed.
@param[in] FromHead The flag to indicate whether trim data is from the
@param[in] FromHead The flag to indicate whether trim data is from the
head (TRUE) or the tail (FALSE).
@return The length of the actual trimmed data, which may be less
@@ -2213,11 +2213,11 @@ NetIp6PseudoHeadChecksum (
);
/**
The function frees the net buffer which allocated by the IP protocol. It releases
only the net buffer and doesn't call the external free function.
The function frees the net buffer which allocated by the IP protocol. It releases
only the net buffer and doesn't call the external free function.
This function should be called after finishing the process of mIpSec->ProcessExt()
for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
This function should be called after finishing the process of mIpSec->ProcessExt()
for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
buffer for the ESP, so there needs a function to free the old net buffer.
@param[in] Nbuf The network buffer to be freed.
@@ -2250,18 +2250,18 @@ NetLibGetSystemGuid (
If DomainName is NULL, then ASSERT().
QName is a domain name represented as a sequence of labels,
where each label consists of a length octet followed by that
number of octets. The QName terminates with the zero
length octet for the null label of the root. Caller should
QName is a domain name represented as a sequence of labels,
where each label consists of a length octet followed by that
number of octets. The QName terminates with the zero
length octet for the null label of the root. Caller should
take responsibility to free the buffer in returned pointer.
@param DomainName The pointer to the queried domain name string.
@param DomainName The pointer to the queried domain name string.
@retval NULL Failed to fill QName.
@return QName filled successfully.
**/
**/
CHAR8 *
EFIAPI
NetLibCreateDnsQName (

56
MdeModulePkg/Include/Library/OemHookStatusCodeLib.h
View File

@@ -1,14 +1,14 @@
/** @file
OEM hook status code library. Platform can implement an instance to
OEM hook status code library. Platform can implement an instance to
initialize the OEM devices to report status code information.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@return Status of initialization of OEM status code device.
**/
EFI_STATUS
EFIAPI
@@ -32,36 +32,36 @@ OemHookStatusCodeInitialize (
/**
Report status code to OEM device.
@param CodeType Indicates the type of status code being reported.
@param Value Describes the current status of a hardware or software entity.
This includes both an operation and classification information
@param CodeType Indicates the type of status code being reported.
@param Value Describes the current status of a hardware or software entity.
This includes both an operation and classification information
about the class and subclass.
For progress codes, the operation is the current activity.
For error codes, it is the exception. For debug codes,
it is not defined at this time.
Specific values are discussed in the Intel Platform Innovation
For progress codes, the operation is the current activity.
For error codes, it is the exception. For debug codes,
it is not defined at this time.
Specific values are discussed in the Intel Platform Innovation
Framework for EFI Status Code Specification.
@param Instance The enumeration of a hardware or software entity within the system.
A system may contain multiple entities that match a class/subclass
pairing.
The instance differentiates between them. An instance of 0
indicates that instance information is unavailable,
not meaningful, or not relevant. Valid instance numbers
@param Instance The enumeration of a hardware or software entity within the system.
A system may contain multiple entities that match a class/subclass
pairing.
The instance differentiates between them. An instance of 0
indicates that instance information is unavailable,
not meaningful, or not relevant. Valid instance numbers
start with 1.
@param CallerId This optional parameter may be used to identify the caller.
This parameter allows the status code driver to apply
different rules to different callers.
Type EFI_GUID is defined in InstallProtocolInterface()
@param CallerId This optional parameter may be used to identify the caller.
This parameter allows the status code driver to apply
different rules to different callers.
Type EFI_GUID is defined in InstallProtocolInterface()
in the UEFI 2.0 Specification.
@param Data This optional parameter may be used to pass additional data.
@return The function always returns EFI_SUCCESS.
**/

4
MdeModulePkg/Include/Library/PlatformBootManagerLib.h
View File

@@ -1,8 +1,8 @@
/** @file
Platform Boot Manager library definition. A platform can implement
Platform Boot Manager library definition. A platform can implement
instances to support platform-specific behavior.
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at

18
MdeModulePkg/Include/Library/PlatformHookLib.h
View File

@@ -1,15 +1,15 @@
/** @file
Platform hook library. Platform can provide an implementation of this
library class to provide hooks that may be required for some type of
library class to provide hooks that may be required for some type of
platform initialization.
Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -20,13 +20,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Performs platform specific initialization required for the CPU to access
the hardware associated with a SerialPortLib instance. This function does
not intiailzie the serial port hardware itself. Instead, it initializes
hardware devices that are required for the CPU to access the serial port
not intiailzie the serial port hardware itself. Instead, it initializes
hardware devices that are required for the CPU to access the serial port
hardware. This function may be called more than once.
@retval RETURN_SUCCESS The platform specific initialization succeeded.
@retval RETURN_DEVICE_ERROR The platform specific initialization could not be completed.
**/
RETURN_STATUS
EFIAPI

14
MdeModulePkg/Include/Library/RecoveryLib.h
View File

@@ -1,15 +1,15 @@
/** @file
Recovery library class defines a set of methods related recovery boot mode.
Recovery library class defines a set of methods related recovery boot mode.
This library class is no longer used and modules using this library should
directly locate EFI_PEI_RECOVERY_MODULE_PPI, defined in the PI 1.2 specification.
Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Calling this function causes the system to carry out a recovery boot path.
@retval EFI_SUCCESS Recovery boot path succeeded.
@retval Others Recovery boot path failure.

24
MdeModulePkg/Include/Library/ResetSystemLib.h
View File

@@ -2,13 +2,13 @@
System reset Library Services. This library class defines a set of
methods that reset the whole system.
Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -18,11 +18,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
This function causes a system-wide reset (cold reset), in which
all circuitry within the system returns to its initial state. This type of reset
is asynchronous to system operation and operates without regard to
all circuitry within the system returns to its initial state. This type of reset
is asynchronous to system operation and operates without regard to
cycle boundaries.
If this function returns, it means that the system does not support cold reset.
If this function returns, it means that the system does not support cold reset.
**/
VOID
EFIAPI
@@ -31,7 +31,7 @@ ResetCold (
);
/**
This function causes a system-wide initialization (warm reset), in which all processors
This function causes a system-wide initialization (warm reset), in which all processors
are set to their initial state. Pending cycles are not corrupted.
If this function returns, it means that the system does not support warm reset.
@@ -43,9 +43,9 @@ ResetWarm (
);
/**
This function causes the system to enter a power state equivalent
This function causes the system to enter a power state equivalent
to the ACPI G2/S5 or G3 states.
If this function returns, it means that the system does not support shutdown reset.
**/
VOID
@@ -56,7 +56,7 @@ ResetShutdown (
/**
This function causes the system to enter S3 and then wake up immediately.
If this function returns, it means that the system does not support S3 feature.
**/
VOID

4
MdeModulePkg/Include/Library/ResetUtilityLib.h
View File

@@ -41,7 +41,7 @@ ResetPlatformSpecificGuid (
/**
This function examines the DataSize and ResetData parameters passed to
to ResetSystem() and detemrines if the ResetData contains a Null-terminated
Unicode string followed by a GUID specific subtype. If the GUID specific
Unicode string followed by a GUID specific subtype. If the GUID specific
subtype is present, then a pointer to the GUID value in ResetData is returned.
@param[in] DataSize The size, in bytes, of ResetData.
@@ -64,7 +64,7 @@ GetResetPlatformSpecificGuid (
);
/**
This is a helper function that creates the reset data buffer that can be
This is a helper function that creates the reset data buffer that can be
passed into ResetSystem().
The reset data buffer is returned in ResetData and contains ResetString

12
MdeModulePkg/Include/Library/S3Lib.h
View File

@@ -3,13 +3,13 @@
This library class is no longer used and modules using this library should
directly locate EFI_PEI_S3_RESUME_PPI, defined in the PI 1.2 specification.
Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
This function is responsible for calling the S3 resume vector in the ACPI Tables.
@retval EFI_SUCCESS Successfully restored the configuration from S3.
@retval Others Failed to restore the configuration from S3.

82
MdeModulePkg/Include/Library/SecurityManagementLib.h
View File

@@ -1,15 +1,15 @@
/** @file
This library class defines a set of interfaces to abstract the policy of
This library class defines a set of interfaces to abstract the policy of
security measurement by managing the different security measurement services.
The library instances can be implemented according to the different security policy.
Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -36,33 +36,33 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define EFI_AUTH_OPERATION_IMAGE_REQUIRED 0x80000000
/**
The security handler is used to abstract platform-specific policy
from the DXE core response to an attempt to use a file that returns a
given status for the authentication check from the section extraction protocol.
The security handler is used to abstract platform-specific policy
from the DXE core response to an attempt to use a file that returns a
given status for the authentication check from the section extraction protocol.
The possible responses in a given SAP implementation may include locking
flash upon failure to authenticate, attestation logging for all signed drivers,
and other exception operations. The File parameter allows for possible logging
The possible responses in a given SAP implementation may include locking
flash upon failure to authenticate, attestation logging for all signed drivers,
and other exception operations. The File parameter allows for possible logging
within the SAP of the driver.
If File is NULL, then EFI_INVALID_PARAMETER is returned.
If the file specified by File with an authentication status specified by
If the file specified by File with an authentication status specified by
AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.
If the file specified by File with an authentication status specified by
AuthenticationStatus is not safe for the DXE Core to use under any circumstances,
If the file specified by File with an authentication status specified by
AuthenticationStatus is not safe for the DXE Core to use under any circumstances,
then EFI_ACCESS_DENIED is returned.
If the file specified by File with an authentication status specified by
AuthenticationStatus is not safe for the DXE Core to use at the time, but it
might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
If the file specified by File with an authentication status specified by
AuthenticationStatus is not safe for the DXE Core to use at the time, but it
might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
returned.
FileBuffer will be NULL and FileSize will be 0 if the handler being called
FileBuffer will be NULL and FileSize will be 0 if the handler being called
did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.
@param[in] AuthenticationStatus
@param[in] AuthenticationStatus
The authentication status returned from the security
measurement services for the input file.
@param[in] File The pointer to the device path of the file that is
@@ -83,7 +83,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
used for any purpose.
**/
typedef
typedef
EFI_STATUS
(EFIAPI *SECURITY_FILE_AUTHENTICATION_STATE_HANDLER)(
IN OUT UINT32 AuthenticationStatus,
@@ -117,12 +117,12 @@ RegisterSecurityHandler (
Execute registered handlers until one returns an error and that error is returned.
If none of the handlers return an error, then EFI_SUCCESS is returned.
Before exectue handler, get the image buffer by file device path if a handler
Before exectue handler, get the image buffer by file device path if a handler
requires the image file. And return the image buffer to each handler when exectue handler.
The handlers are executed in same order to their registered order.
@param[in] AuthenticationStatus
@param[in] AuthenticationStatus
This is the authentication type returned from the Section
Extraction protocol. See the Section Extraction Protocol
Specification for details on this type.
@@ -130,9 +130,9 @@ RegisterSecurityHandler (
being dispatched. This will optionally be used for logging.
@retval EFI_SUCCESS The file specified by File authenticated when more
than one security handler services were registered,
or the file did not authenticate when no security
handler service was registered. And the platform policy
than one security handler services were registered,
or the file did not authenticate when no security
handler service was registered. And the platform policy
dictates that the DXE Core may use File.
@retval EFI_INVALID_PARAMETER File is NULL.
@retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
@@ -152,13 +152,13 @@ ExecuteSecurityHandlers (
);
/**
The security handler is used to abstracts security-specific functions from the DXE
Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot,
User Identity policy for image loading and consoles, and for purposes of
handling GUIDed section encapsulations.
@param[in] AuthenticationStatus
The authentication status for the input file.
The security handler is used to abstracts security-specific functions from the DXE
Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot,
User Identity policy for image loading and consoles, and for purposes of
handling GUIDed section encapsulations.
@param[in] AuthenticationStatus
The authentication status for the input file.
@param[in] File The pointer to the device path of the file that is
being dispatched. This will optionally be used for logging.
@param[in] FileBuffer A pointer to the buffer with the UEFI file image
@@ -188,7 +188,7 @@ ExecuteSecurityHandlers (
drivers from the device path specified by DevicePath. The
image has been added into the list of the deferred images.
**/
typedef
typedef
EFI_STATUS
(EFIAPI *SECURITY2_FILE_AUTHENTICATION_HANDLER) (
IN UINT32 AuthenticationStatus,
@@ -221,16 +221,16 @@ RegisterSecurity2Handler (
);
/**
Execute registered handlers based on input AuthenticationOperation until
one returns an error and that error is returned.
Execute registered handlers based on input AuthenticationOperation until
one returns an error and that error is returned.
If none of the handlers return an error, then EFI_SUCCESS is returned.
The handlers those satisfy AuthenticationOperation will only be executed.
The handlers are executed in same order to their registered order.
@param[in] AuthenticationOperation
@param[in] AuthenticationOperation
The operation type specifies which handlers will be executed.
@param[in] AuthenticationStatus
@param[in] AuthenticationStatus
The authentication status for the input file.
@param[in] File This is a pointer to the device path of the file that is
being dispatched. This will optionally be used for logging.
@@ -260,7 +260,7 @@ RegisterSecurity2Handler (
@retval EFI_SECURITY_VIOLATION FileBuffer is not NULL and the user has no permission to load
drivers from the device path specified by DevicePath. The
image has been added into the list of the deferred images.
@retval EFI_INVALID_PARAMETER File and FileBuffer are both NULL.
@retval EFI_INVALID_PARAMETER File and FileBuffer are both NULL.
**/
EFI_STATUS
EFIAPI

20
MdeModulePkg/Include/Library/SmmCorePlatformHookLib.h
View File

@@ -2,13 +2,13 @@
Smm Core Platform Hook Library. This library class defines a set of platform
hooks called by the SMM Core.
Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -18,9 +18,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Performs platform specific tasks before invoking registered SMI handlers.
This function performs platform specific tasks before invoking registered SMI handlers.
@retval EFI_SUCCESS The platform hook completes successfully.
@retval Other values The paltform hook cannot complete due to some error.
@@ -34,9 +34,9 @@ PlatformHookBeforeSmmDispatch (
/**
Performs platform specific tasks after invoking registered SMI handlers.
This function performs platform specific tasks after invoking registered SMI handlers.
@retval EFI_SUCCESS The platform hook completes successfully.
@retval Other values The paltform hook cannot complete due to some error.
@@ -46,5 +46,5 @@ EFIAPI
PlatformHookAfterSmmDispatch (
VOID
);
#endif

20
MdeModulePkg/Include/Library/TcpIoLib.h
View File

@@ -2,7 +2,7 @@
This library is used to share code between UEFI network stack modules.
It provides the helper routines to access TCP service.
Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at<BR>
@@ -85,7 +85,7 @@ typedef struct {
EFI_HANDLE Image;
EFI_HANDLE Controller;
EFI_HANDLE Handle;
TCP_IO_PROTOCOL Tcp;
TCP_IO_PROTOCOL NewTcp;
TCP_IO_CONNECTION_TOKEN ConnToken;
@@ -93,7 +93,7 @@ typedef struct {
TCP_IO_IO_TOKEN RxToken;
TCP_IO_CLOSE_TOKEN CloseToken;
TCP_IO_LISTEN_TOKEN ListenToken;
BOOLEAN IsConnDone;
BOOLEAN IsTxDone;
BOOLEAN IsRxDone;
@@ -102,14 +102,14 @@ typedef struct {
} TCP_IO;
/**
Create a TCP socket with the specified configuration data.
Create a TCP socket with the specified configuration data.
@param[in] Image The handle of the driver image.
@param[in] Controller The handle of the controller.
@param[in] TcpVersion The version of Tcp, TCP_VERSION_4 or TCP_VERSION_6.
@param[in] ConfigData The Tcp configuration data.
@param[out] TcpIo The TcpIo.
@retval EFI_SUCCESS The TCP socket is created and configured.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_UNSUPPORTED One or more of the control options are not
@@ -129,7 +129,7 @@ TcpIoCreateSocket (
);
/**
Destroy the socket.
Destroy the socket.
@param[in] TcpIo The TcpIo which wraps the socket to be destroyed.
@@ -145,7 +145,7 @@ TcpIoDestroySocket (
@param[in, out] TcpIo The TcpIo wrapping the TCP socket.
@param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait.
@retval EFI_SUCCESS Connect to the other endpoint of the TCP socket
successfully.
@retval EFI_TIMEOUT Failed to connect to the other endpoint of the
@@ -169,7 +169,7 @@ TcpIoConnect (
@param[in, out] TcpIo The TcpIo wrapping the TCP socket.
@param[in] Timeout The time to wait for connection done. Set to NULL for infinite wait.
@retval EFI_SUCCESS Connect to the other endpoint of the TCP socket
successfully.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@@ -187,7 +187,7 @@ TcpIoAccept (
IN OUT TCP_IO *TcpIo,
IN EFI_EVENT Timeout OPTIONAL
);
/**
Reset the socket.
@@ -205,7 +205,7 @@ TcpIoReset (
@param[in] TcpIo The TcpIo wrapping the TCP socket.
@param[in] Packet The packet to transmit.
@retval EFI_SUCCESS The packet is trasmitted.
@retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_UNSUPPORTED One or more of the control options are not

4
MdeModulePkg/Include/Library/UdpIoLib.h
View File

@@ -49,7 +49,7 @@ typedef struct {
This prototype is used by both receive and sending when calling
UdpIoRecvDatagram() or UdpIoSendDatagram(). When receiving, Netbuf is allocated by the
UDP access point and released by the user. When sending, the user allocates the the NetBuf,
UDP access point and released by the user. When sending, the user allocates the the NetBuf,
which is then provided to the callback as a reference.
@param[in] Packet The packet received or sent.
@@ -97,7 +97,7 @@ typedef struct {
/// This structure is used internally by UdpIo Library.
///
/// Each transmit request is wrapped in an UDP_TX_TOKEN. Upon completion,
/// the CallBack will be called. There can be several transmit requests. All transmit
/// the CallBack will be called. There can be several transmit requests. All transmit
/// requests are linked in a list.
///

38
MdeModulePkg/Include/Library/UefiBootManagerLib.h
View File

@@ -1,7 +1,7 @@
/** @file
Provide Boot Manager related library APIs.
Copyright (c) 2011 - 2016, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>
(C) Copyright 2015-2016 Hewlett Packard Enterprise Development LP<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
@@ -60,14 +60,14 @@ typedef struct {
// Used at runtime
//
EFI_STATUS Status; // Status returned from boot attempt gBS->StartImage ()
CHAR16 *ExitData; // Exit data returned from gBS->StartImage ()
CHAR16 *ExitData; // Exit data returned from gBS->StartImage ()
UINTN ExitDataSize; // Size of ExitData
} EFI_BOOT_MANAGER_LOAD_OPTION;
/**
Returns an array of load options based on the EFI variable
L"BootOrder"/L"DriverOrder" and the L"Boot####"/L"Driver####" variables impled by it.
#### is the hex value of the UINT16 in each BootOrder/DriverOrder entry.
#### is the hex value of the UINT16 in each BootOrder/DriverOrder entry.
@param LoadOptionCount Returns number of entries in the array.
@param LoadOptionType The type of the load option.
@@ -163,7 +163,7 @@ EfiBootManagerVariableToLoadOption (
/**
Create the Boot#### or Driver#### variable from the load option.
@param LoadOption Pointer to the load option.
@retval EFI_SUCCESS The variable was created.
@@ -204,9 +204,9 @@ EfiBootManagerAddLoadOptionVariable (
/**
Delete the load option according to the OptionNumber and OptionType.
Only the BootOrder/DriverOrder is updated to remove the reference of the OptionNumber.
@param OptionNumber Option number of the load option.
@param OptionType Type of the load option.
@@ -221,7 +221,7 @@ EfiBootManagerDeleteLoadOptionVariable (
);
/**
Sort the load options. The DriverOrder/BootOrder variables will be re-created to
Sort the load options. The DriverOrder/BootOrder variables will be re-created to
reflect the new order.
@param OptionType The type of the load option.
@@ -237,7 +237,7 @@ EfiBootManagerSortLoadOptionVariable (
/**
Return the index of the load option in the load option array.
The function consider two load options are equal when the
The function consider two load options are equal when the
OptionType, Attributes, Description, FilePath and OptionalData are equal.
@param Key Pointer to the load option to be found.
@@ -292,7 +292,7 @@ typedef struct {
/**
Start the hot key service so that the key press can trigger the boot option.
@param HotkeyTriggered Return the waitable event and it will be signaled
@param HotkeyTriggered Return the waitable event and it will be signaled
when a valid hot key is pressed.
@retval EFI_SUCCESS The hot key service is started.
@@ -391,7 +391,7 @@ EfiBootManagerHotkeyBoot (
3. Non-BlockIo SimpleFileSystem - The boot option points to a device supporting
SimpleFileSystem Protocol, but not supporting BlockIo
protocol.
4. LoadFile - The boot option points to the media supporting
4. LoadFile - The boot option points to the media supporting
LoadFile protocol.
Reference: UEFI Spec chapter 3.3 Boot Option Variables Default Boot Behavior
@@ -407,9 +407,9 @@ EfiBootManagerRefreshAllBootOption (
Attempt to boot the EFI boot option. This routine sets L"BootCurent" and
signals the EFI ready to boot event. If the device path for the option starts
with a BBS device path a legacy boot is attempted. Short form device paths are
also supported via this rountine. A device path starting with
also supported via this rountine. A device path starting with
MEDIA_HARDDRIVE_DP, MSG_USB_WWID_DP, MSG_USB_CLASS_DP gets expaned out
to find the first device that matches. If the BootOption Device Path
to find the first device that matches. If the BootOption Device Path
fails the removable media boot algorithm is attempted (\EFI\BOOTIA32.EFI,
\EFI\BOOTX64.EFI,... only one file type is tried per processor type)
@@ -467,7 +467,7 @@ EfiBootManagerGetLoadOptionBuffer (
);
/**
The function enumerates all the legacy boot options, creates them and
The function enumerates all the legacy boot options, creates them and
registers them in the BootOrder variable.
**/
typedef
@@ -560,7 +560,7 @@ EfiBootManagerConnectAll (
@retval EFI_OUT_OF_RESOURCES There is no resource to create new handles.
@retval EFI_NOT_FOUND Create the handle associate with one device path
node failed.
@retval EFI_SECURITY_VIOLATION The user has no permission to start UEFI device
@retval EFI_SECURITY_VIOLATION The user has no permission to start UEFI device
drivers on the DevicePath.
**/
EFI_STATUS
@@ -571,8 +571,8 @@ EfiBootManagerConnectDevicePath (
);
/**
This function will disconnect all current system handles.
This function will disconnect all current system handles.
gBS->DisconnectController() is invoked for each handle exists in system handle buffer.
If handle is a bus type handle, all childrens also are disconnected recursively by
gBS->DisconnectController().
@@ -656,7 +656,7 @@ EfiBootManagerConnectConsoleVariable (
);
/**
Query all the children of VideoController and return the device paths of all the
Query all the children of VideoController and return the device paths of all the
children that support GraphicsOutput protocol.
@param VideoController PCI handle of video controller.
@@ -698,7 +698,7 @@ typedef struct {
EFI_HANDLE ChildHandle;
///
/// Driver health messages of the specify Driver
/// Driver health messages of the specify Driver
///
EFI_DRIVER_HEALTH_HII_MESSAGE *MessageList;
@@ -756,7 +756,7 @@ EfiBootManagerFreeDriverHealthInfo (
@param LoadOption Pointer to the load option.
@retval EFI_INVALID_PARAMETER The load option type is invalid,
@retval EFI_INVALID_PARAMETER The load option type is invalid,
or the load option file path doesn't point to a valid file.
@retval EFI_UNSUPPORTED The load option type is of LoadOptionTypeBoot.
@retval EFI_SUCCESS The load option is inactive, or successfully loaded and executed.

12
MdeModulePkg/Include/Library/UefiHiiServicesLib.h
View File

@@ -2,15 +2,15 @@
Provides global variables that are pointers to the UEFI HII related protocols.
All of the UEFI HII related protocols are optional, so the consumers of this
library class must verify that the global variable pointers are not NULL before
use.
use.
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/