MdePkg: Clean up source files
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>
This commit is contained in:
@@ -1,18 +1,18 @@
|
||||
/** @file
|
||||
The Firmware Volume Protocol provides file-level access to the firmware volume.
|
||||
Each firmware volume driver must produce an instance of the
|
||||
The Firmware Volume Protocol provides file-level access to the firmware volume.
|
||||
Each firmware volume driver must produce an instance of the
|
||||
Firmware Volume Protocol if the firmware volume is to be visible to
|
||||
the system during the DXE phase. The Firmware Volume Protocol also provides
|
||||
mechanisms for determining and modifying some attributes of the firmware volume.
|
||||
|
||||
Copyright (c) 2006 - 2008, 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) 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
|
||||
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.
|
||||
|
||||
@par Revision Reference: PI
|
||||
Version 1.00.
|
||||
@@ -98,7 +98,7 @@ typedef UINT64 EFI_FV_ATTRIBUTES;
|
||||
undefined.
|
||||
|
||||
@param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
|
||||
|
||||
|
||||
@param FvAttributes Pointer to an EFI_FV_ATTRIBUTES in which
|
||||
the attributes and current settings are
|
||||
returned.
|
||||
@@ -118,7 +118,7 @@ EFI_STATUS
|
||||
|
||||
/**
|
||||
Modifies the current settings of the firmware volume according to the input parameter.
|
||||
|
||||
|
||||
The SetVolumeAttributes() function is used to set configurable
|
||||
firmware volume attributes. Only EFI_FV_READ_STATUS,
|
||||
EFI_FV_WRITE_STATUS, and EFI_FV_LOCK_STATUS may be modified, and
|
||||
@@ -136,7 +136,7 @@ EFI_STATUS
|
||||
TPL_NOTIFY is undefined.
|
||||
|
||||
@param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
|
||||
|
||||
|
||||
@param FvAttributes On input, FvAttributes is a pointer to
|
||||
an EFI_FV_ATTRIBUTES containing the
|
||||
desired firmware volume settings. On
|
||||
@@ -145,7 +145,7 @@ EFI_STATUS
|
||||
unsuccessful return, FvAttributes is not
|
||||
modified and the firmware volume
|
||||
settings are not changed.
|
||||
|
||||
|
||||
@retval EFI_SUCCESS The requested firmware volume attributes
|
||||
were set and the resulting
|
||||
EFI_FV_ATTRIBUTES is returned in
|
||||
@@ -254,13 +254,13 @@ EFI_STATUS
|
||||
undefined.
|
||||
|
||||
@param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
|
||||
|
||||
|
||||
@param NameGuid Pointer to an EFI_GUID, which is the file
|
||||
name. All firmware file names are EFI_GUIDs.
|
||||
A single firmware volume must not have two
|
||||
valid files with the same file name
|
||||
EFI_GUID.
|
||||
|
||||
|
||||
@param Buffer Pointer to a pointer to a buffer in which the
|
||||
file contents are returned, not including the
|
||||
file header.
|
||||
@@ -268,19 +268,19 @@ EFI_STATUS
|
||||
@param BufferSize Pointer to a caller-allocated UINTN. It
|
||||
indicates the size of the memory
|
||||
represented by Buffer.
|
||||
|
||||
|
||||
@param FoundType Pointer to a caller-allocated EFI_FV_FILETYPE.
|
||||
|
||||
|
||||
@param FileAttributes Pointer to a caller-allocated
|
||||
EFI_FV_FILE_ATTRIBUTES.
|
||||
|
||||
|
||||
@param AuthenticationStatus Pointer to a caller-allocated
|
||||
UINT32 in which the
|
||||
authentication status is
|
||||
returned.
|
||||
|
||||
|
||||
@retval EFI_SUCCESS The call completed successfully.
|
||||
|
||||
|
||||
@retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to
|
||||
contain the requested
|
||||
output. The buffer is
|
||||
@@ -342,56 +342,56 @@ EFI_STATUS
|
||||
undefined.
|
||||
|
||||
@param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
|
||||
|
||||
|
||||
@param NameGuid Pointer to an EFI_GUID, which indicates the
|
||||
file name from which the requested section
|
||||
will be read.
|
||||
|
||||
|
||||
@param SectionType Indicates the section type to return.
|
||||
SectionType in conjunction with
|
||||
SectionInstance indicates which section to
|
||||
return.
|
||||
|
||||
|
||||
@param SectionInstance Indicates which instance of sections
|
||||
with a type of SectionType to return.
|
||||
SectionType in conjunction with
|
||||
SectionInstance indicates which
|
||||
section to return. SectionInstance is
|
||||
zero based.
|
||||
|
||||
|
||||
@param Buffer Pointer to a pointer to a buffer in which the
|
||||
section contents are returned, not including
|
||||
the section header.
|
||||
|
||||
|
||||
@param BufferSize Pointer to a caller-allocated UINTN. It
|
||||
indicates the size of the memory
|
||||
represented by Buffer.
|
||||
|
||||
|
||||
@param AuthenticationStatus Pointer to a caller-allocated
|
||||
UINT32 in which the authentication
|
||||
status is returned.
|
||||
|
||||
|
||||
|
||||
|
||||
@retval EFI_SUCCESS The call completed successfully.
|
||||
|
||||
|
||||
@retval EFI_WARN_BUFFER_TOO_SMALL The caller-allocated
|
||||
buffer is too small to
|
||||
contain the requested
|
||||
output. The buffer is
|
||||
filled and the output is
|
||||
truncated.
|
||||
|
||||
|
||||
@retval EFI_OUT_OF_RESOURCES An allocation failure occurred.
|
||||
|
||||
|
||||
@retval EFI_NOT_FOUND The requested file was not found in
|
||||
the firmware volume. EFI_NOT_FOUND The
|
||||
requested section was not found in the
|
||||
specified file.
|
||||
|
||||
|
||||
@retval EFI_DEVICE_ERROR A hardware error occurred when
|
||||
attempting to access the firmware
|
||||
volume.
|
||||
|
||||
|
||||
@retval EFI_ACCESS_DENIED The firmware volume is configured to
|
||||
disallow reads. EFI_PROTOCOL_ERROR
|
||||
The requested section was not found,
|
||||
@@ -472,7 +472,7 @@ typedef struct {
|
||||
Architectural Elements 84 August 21, 2006 Version 1.0
|
||||
WriteFile() is callable only from TPL_NOTIFY and below.
|
||||
Behavior of WriteFile() at any EFI_TPL above TPL_NOTIFY is
|
||||
undefined.
|
||||
undefined.
|
||||
|
||||
@param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
|
||||
|
||||
@@ -482,31 +482,31 @@ typedef struct {
|
||||
write in the event of a power failure or
|
||||
other system failure during the write
|
||||
operation.
|
||||
|
||||
|
||||
@param FileData Pointer to an array of
|
||||
EFI_FV_WRITE_FILE_DATA. Each element of
|
||||
FileData[] represents a file to be written.
|
||||
|
||||
|
||||
@retval EFI_SUCCESS The write completed successfully.
|
||||
|
||||
|
||||
@retval EFI_OUT_OF_RESOURCES The firmware volume does not
|
||||
have enough free space to
|
||||
storefile(s).
|
||||
|
||||
|
||||
@retval EFI_DEVICE_ERROR A hardware error occurred when
|
||||
attempting to access the firmware volume.
|
||||
|
||||
|
||||
@retval EFI_WRITE_PROTECTED The firmware volume is
|
||||
configured to disallow writes.
|
||||
|
||||
|
||||
@retval EFI_NOT_FOUND A delete was requested, but the
|
||||
requested file was not found in the
|
||||
firmware volume.
|
||||
|
||||
|
||||
@retval EFI_INVALID_PARAMETER A delete was requested with a
|
||||
multiple file write.
|
||||
|
||||
|
||||
@retval EFI_INVALID_PARAMETER An unsupported WritePolicy was
|
||||
requested.
|
||||
|
||||
@@ -515,10 +515,10 @@ typedef struct {
|
||||
|
||||
@retval EFI_INVALID_PARAMETER A file system specific error
|
||||
has occurred.
|
||||
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
EFI_STATUS
|
||||
(EFIAPI * EFI_FV_WRITE_FILE)(
|
||||
IN CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,
|
||||
IN UINT32 NumberOfFiles,
|
||||
@@ -528,7 +528,7 @@ EFI_STATUS
|
||||
|
||||
|
||||
/**
|
||||
Retrieves information about the next file in the firmware volume store
|
||||
Retrieves information about the next file in the firmware volume store
|
||||
that matches the search criteria.
|
||||
|
||||
GetNextFile() is the interface that is used to search a firmware
|
||||
@@ -547,7 +547,7 @@ EFI_STATUS
|
||||
implementation specific and no semantic content is implied.
|
||||
GetNextFile() is callable only from TPL_NOTIFY and below.
|
||||
Behavior of GetNextFile() at any EFI_TPL above TPL_NOTIFY is
|
||||
undefined.
|
||||
undefined.
|
||||
|
||||
@param This Indicates the EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
|
||||
|
||||
@@ -600,7 +600,7 @@ EFI_STATUS
|
||||
@retval EFI_ACCESS_DENIED The firmware volume is configured to
|
||||
disallow reads.
|
||||
|
||||
|
||||
|
||||
**/
|
||||
typedef
|
||||
EFI_STATUS
|
||||
@@ -629,29 +629,29 @@ EFI_STATUS
|
||||
@param This A pointer to the EFI_FIRMWARE_VOLUME2_PROTOCOL
|
||||
instance that is the file handle the requested
|
||||
information is for.
|
||||
|
||||
|
||||
@param InformationType The type identifier for the
|
||||
information being requested.
|
||||
|
||||
|
||||
@param BufferSize On input, the size of Buffer. On output,
|
||||
the amount of data returned in Buffer. In
|
||||
both cases, the size is measured in bytes.
|
||||
|
||||
|
||||
@param Buffer A pointer to the data buffer to return. The
|
||||
buffer's type is indicated by InformationType.
|
||||
|
||||
|
||||
|
||||
|
||||
@retval EFI_SUCCESS The information was retrieved.
|
||||
|
||||
|
||||
@retval EFI_UNSUPPORTED The InformationType is not known.
|
||||
|
||||
|
||||
@retval EFI_NO_MEDIA The device has no medium.
|
||||
|
||||
|
||||
@retval EFI_DEVICE_ERROR The device reported an error.
|
||||
|
||||
|
||||
@retval EFI_VOLUME_CORRUPTED The file system structures are
|
||||
corrupted.
|
||||
|
||||
|
||||
@retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to
|
||||
read the current directory
|
||||
entry. BufferSize has been
|
||||
@@ -740,14 +740,14 @@ struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {
|
||||
EFI_FV_READ_SECTION ReadSection;
|
||||
EFI_FV_WRITE_FILE WriteFile;
|
||||
EFI_FV_GET_NEXT_FILE GetNextFile;
|
||||
|
||||
|
||||
///
|
||||
/// Data field that indicates the size in bytes
|
||||
/// of the Key input buffer for the
|
||||
/// GetNextFile() API.
|
||||
/// GetNextFile() API.
|
||||
///
|
||||
UINT32 KeySize;
|
||||
|
||||
|
||||
///
|
||||
/// Handle of the parent firmware volume.
|
||||
///
|
||||
|
Reference in New Issue
Block a user