diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
| commit | 0647c9adf92c6a8712091607a73b2768327a865d (patch) | |
| tree | 41c00f087dea23a35388100f5b9895753555ac3c /MdePkg/Include/Protocol | |
| parent | 151c1ccdcd6960c550fa491bd0ed467416bb2b74 (diff) | |
| download | edk2-platforms-0647c9adf92c6a8712091607a73b2768327a865d.tar.xz | |
Remove BugBug in comments and adjust function header according to code style doc.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1055 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol')
39 files changed, 1370 insertions, 1674 deletions
diff --git a/MdePkg/Include/Protocol/AcpiSupport.h b/MdePkg/Include/Protocol/AcpiSupport.h index 790cdf2b3e..5702cb4d65 100644 --- a/MdePkg/Include/Protocol/AcpiSupport.h +++ b/MdePkg/Include/Protocol/AcpiSupport.h @@ -64,19 +64,14 @@ typedef struct _EFI_ACPI_SUPPORT_PROTOCOL EFI_ACPI_SUPPORT_PROTOCOL; /**
Returns a requested ACPI table.
- @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
-
- @param Index The zero-based index of the table to retrieve.
-
- @param Table Pointer for returning the table buffer.
-
- @param Version Updated with the ACPI versions to which this table belongs.
-
- @param Handle Pointer for identifying the table.
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
+ @param Index The zero-based index of the table to retrieve.
+ @param Table Pointer for returning the table buffer.
+ @param Version Updated with the ACPI versions to which this table belongs.
+ @param Handle Pointer for identifying the table.
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The requested index is too large and a table was not found.
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The requested index is too large and a table was not found.
**/
typedef
@@ -92,22 +87,16 @@ EFI_STATUS /**
Used to add, remove, or update ACPI tables.
- @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
-
- @param Table Pointer to the new table to add or update.
-
- @param Checksum If TRUE, indicates that the checksum should be
- calculated for this table.
-
- @param Version Indicates to which version(s) of ACPI the table should be added.
-
- @param Pointer to the handle of the table to remove or update.
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
+ @param Table Pointer to the new table to add or update.
+ @param Checksum If TRUE, indicates that the checksum should be
+ calculated for this table.
+ @param Version Indicates to which version(s) of ACPI the table should be added.
+ @param Pointer to the handle of the table to remove or update.
- @retval EFI_SUCCESS The function completed successfully.
-
+ @retval EFI_SUCCESS The function completed successfully.
@retval EFI_INVALID_PARAMETER *Handle was zero and Table was NULL.
-
- @retval EFI_ABORTED Could not complete the desired action.
+ @retval EFI_ABORTED Could not complete the desired action.
**/
typedef
@@ -124,13 +113,11 @@ EFI_STATUS Causes one or more versions of the ACPI tables to be published in
the EFI system configuration tables.
- @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
-
- @param Version Indicates to which version(s) of ACPI that the table should be published.
+ @param This A pointer to the EFI_ACPI_SUPPORT_PROTOCOL instance.
+ @param Version Indicates to which version(s) of ACPI that the table should be published.
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_ABORTED An error occurred and the function could not complete successfully.
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_ABORTED An error occurred and the function could not complete successfully.
**/
typedef
diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h index ffc66f622a..138a3270fa 100644 --- a/MdePkg/Include/Protocol/Bis.h +++ b/MdePkg/Include/Protocol/Bis.h @@ -136,7 +136,7 @@ typedef struct { version numbers are updated with the major and minor version
numbers of the interface
@param TargetAddress Indicates a network or device address of the BIS platform to connect to.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_INCOMPATIBLE_VERSION The InterfaceVersion.Major requested by the
caller was not compatible with the interface version of the
@@ -164,7 +164,7 @@ EFI_STATUS @param AppHandle An opaque handle that identifies the caller¡¯s instance of initialization
of the BIS service.
@param ToFree An EFI_BIS_DATA* and associated memory block to be freed.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
application instance handle associated with the EFI_BIS protocol.
@@ -186,7 +186,7 @@ EFI_STATUS @param AppHandle An opaque handle that identifies the caller¡¯s instance of initialization
of the BIS service.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
application instance handle associated with the EFI_BIS protocol.
@@ -208,7 +208,7 @@ EFI_STATUS of the BIS service.
@param Certificate The function writes an allocated EFI_BIS_DATA* containing the Boot
Object Authorization Certificate object.
-
+
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_NO_MAPPING The AppHandle parameter is not or is no longer a valid
application instance handle associated with the EFI_BIS protocol.
diff --git a/MdePkg/Include/Protocol/BootScriptSave.h b/MdePkg/Include/Protocol/BootScriptSave.h index 4dff3a9b0a..ae4d862cc4 100644 --- a/MdePkg/Include/Protocol/BootScriptSave.h +++ b/MdePkg/Include/Protocol/BootScriptSave.h @@ -36,20 +36,15 @@ typedef struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL EFI_BOOT_SCRIPT_SAVE_PROTOCOL; /**
Adds a record into a specified Framework boot script table.
- @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
-
- @param TableName Name of the script table.Currently, the only meaningful
- value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.
-
- @param OpCode The operation code (opcode) number.
-
- @param ... Argument list that is specific to each opcode.
-
- @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.
-
+ @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
+ @param TableName Name of the script table.Currently, the only meaningful
+ value is EFI_ACPI_S3_RESUME_SCRIPT_TABLE.
+ @param OpCode The operation code (opcode) number.
+ @param ... Argument list that is specific to each opcode.
+
+ @retval EFI_SUCCESS The operation succeeded. A record was added into the specified script table.
@retval EFI_INVALID_PARAMETER The parameter is illegal or the given boot script is not supported.
-
- @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
+ @retval EFI_OUT_OF_RESOURCES There is insufficient memory to store the boot script.
**/
typedef
@@ -64,17 +59,13 @@ EFI_STATUS /**
Closes the specified script table.
- @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
-
- @param TableName Name of the script table.
-
- @param Address A pointer to the physical address where the table begins.
-
- @retval EFI_SUCCESS The table was successfully returned.
-
- @retval EFI_NOT_FOUND The specified table was not created previously.
-
- @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.
+ @param This A pointer to the EFI_BOOT_SCRIPT_SAVE_PROTOCOL instance.
+ @param TableName Name of the script table.
+ @param Address A pointer to the physical address where the table begins.
+
+ @retval EFI_SUCCESS The table was successfully returned.
+ @retval EFI_NOT_FOUND The specified table was not created previously.
+ @retval EFI_OUT_OF_RESOURCES Memory is insufficient to hold the reorganized boot script table.
**/
typedef
diff --git a/MdePkg/Include/Protocol/CpuIo.h b/MdePkg/Include/Protocol/CpuIo.h index 619878c042..d7fce60415 100644 --- a/MdePkg/Include/Protocol/CpuIo.h +++ b/MdePkg/Include/Protocol/CpuIo.h @@ -58,24 +58,18 @@ typedef enum { Enables a driver to access memory-mapped registers in the EFI system memory space.
Or, Enables a driver to access registers in the EFI CPU I/O space.
- @param This A pointer to the EFI_CPU_IO_PROTOCOL instance.
-
- @param Width Signifies the width of the I/O or Memory operation.
-
- @param Address The base address of the I/O or Memoryoperation.
-
- @param Count The number of I/O or Memory operations to perform.
- The number of bytes moved is Width size * Count, starting at Address.
-
- @param Buffer For read operations, the destination buffer to store the results.
- For write operations, the source buffer from which to write data.
-
- @retval EFI_SUCCESS The data was read from or written to the EFI system.
-
+ @param This A pointer to the EFI_CPU_IO_PROTOCOL instance.
+ @param Width Signifies the width of the I/O or Memory operation.
+ @param Address The base address of the I/O or Memoryoperation.
+ @param Count The number of I/O or Memory operations to perform.
+ The number of bytes moved is Width size * Count, starting at Address.
+ @param Buffer For read operations, the destination buffer to store the results.
+ For write operations, the source buffer from which to write data.
+
+ @retval EFI_SUCCESS The data was read from or written to the EFI system.
@retval EFI_INVALID_PARAMETER Width is invalid for this EFI system.Or Buffer is NULL.
-
- @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.
- Or,The address range specified by Address, Width, and Count is not valid for this EFI system.
+ @retval EFI_UNSUPPORTED The Buffer is not aligned for the given Width.
+ Or,The address range specified by Address, Width, and Count is not valid for this EFI system.
**/
typedef
diff --git a/MdePkg/Include/Protocol/DataHub.h b/MdePkg/Include/Protocol/DataHub.h index 15d3cc618e..affe4b870a 100644 --- a/MdePkg/Include/Protocol/DataHub.h +++ b/MdePkg/Include/Protocol/DataHub.h @@ -78,22 +78,15 @@ typedef struct _EFI_DATA_HUB_PROTOCOL EFI_DATA_HUB_PROTOCOL; /**
Logs a data record to the system event log.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
@param description
-
- @param DataRecordGuid A GUID that indicates the format of the data passed into RawData.
-
- @param ProducerName A GUID that indicates the identity of the caller to this API.
-
- @param DataRecordClass This class indicates the generic type of the data record.
-
- @param RawData The DataRecordGuid-defined data to be logged.
-
- @param RawDataSize The size in bytes of RawData.
-
- @retval EFI_SUCCESS Data was logged.
-
+ @param DataRecordGuid A GUID that indicates the format of the data passed into RawData.
+ @param ProducerName A GUID that indicates the identity of the caller to this API.
+ @param DataRecordClass This class indicates the generic type of the data record.
+ @param RawData The DataRecordGuid-defined data to be logged.
+ @param RawDataSize The size in bytes of RawData.
+
+ @retval EFI_SUCCESS Data was logged.
@retval EFI_OUT_OF_RESOURCES Data was not logged due to lack of system resources.
**/
@@ -111,29 +104,23 @@ EFI_STATUS /**
Allows the system data log to be searched.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
- @param MonotonicCount On input, it specifies the Record to return.
- An input of zero means to return the first record.
-
- @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero,
- it means to return the first data record. If FilterDriver is passed in,
- then a MonotonicCount of zero means to return the first data not yet read
- by FilterDriver.
-
- @param Record Returns a dynamically allocated memory buffer with a data
- record that matches MonotonicCount.
-
- @retval EFI_SUCCESS Data was returned in Record.
-
- @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.
-
- @retval EFI_NOT_FOUND MonotonicCount does not match any data record
- in the system. If a MonotonicCount of zero was passed in, then no
- data records exist in the system.
-
- @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack
- of system resources.
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
+ @param MonotonicCount On input, it specifies the Record to return.
+ An input of zero means to return the first record.
+ @param FilterDriver If FilterDriver is not passed in a MonotonicCount of zero,
+ it means to return the first data record. If FilterDriver is passed in,
+ then a MonotonicCount of zero means to return the first data not yet read
+ by FilterDriver.
+ @param Record Returns a dynamically allocated memory buffer with a data
+ record that matches MonotonicCount.
+
+ @retval EFI_SUCCESS Data was returned in Record.
+ @retval EFI_INVALID_PARAMETER FilterDriver was passed in but does not exist.
+ @retval EFI_NOT_FOUND MonotonicCount does not match any data record
+ in the system. If a MonotonicCount of zero was passed in, then no
+ data records exist in the system.
+ @retval EFI_OUT_OF_RESOURCES Record was not returned due to lack
+ of system resources.
**/
typedef
@@ -148,28 +135,22 @@ EFI_STATUS /**
Registers an event to be signaled every time a data record is logged in the system.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
- @param FilterEvent The EFI_EVENT to signal whenever data that matches
- FilterClass is logged in the system.
-
- @param FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled.
- It is strongly recommended that you use the lowest EFI_TPL possible.
-
- @param FilterClass FilterEvent will be signaled whenever a bit
- in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass.
- If FilterClass is zero, no class-based filtering will be performed.
-
- @param FilterDataRecordGuid FilterEvent will be signaled whenever
- FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid.
- If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed.
-
- @retval EFI_SUCCESS The filter driver event was registered
-
- @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again.
-
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
+ @param FilterEvent The EFI_EVENT to signal whenever data that matches
+ FilterClass is logged in the system.
+ @param FilterTpl The maximum EFI_TPL at which FilterEvent can be signaled.
+ It is strongly recommended that you use the lowest EFI_TPL possible.
+ @param FilterClass FilterEvent will be signaled whenever a bit
+ in EFI_DATA_RECORD_HEADER.DataRecordClass is also set in FilterClass.
+ If FilterClass is zero, no class-based filtering will be performed.
+ @param FilterDataRecordGuid FilterEvent will be signaled whenever
+ FilterDataRecordGuid matches EFI_DATA_RECORD_HEADER.DataRecordGuid.
+ If FilterDataRecordGuid is NULL, then no GUID-based filtering will be performed.
+
+ @retval EFI_SUCCESS The filter driver event was registered
+ @retval EFI_ALREADY_STARTED FilterEvent was previously registered and cannot be registered again.
@retval EFI_OUT_OF_RESOURCES The filter driver event was not registered
- due to lack of system resources.
+ due to lack of system resources.
**/
typedef
@@ -185,14 +166,12 @@ EFI_STATUS /**
Stops a filter driver from being notified when data records are logged.
- @param This The EFI_DATA_HUB_PROTOCOL instance.
-
- @param FilterEvent The EFI_EVENT to remove from the list of events to be
- signaled every time errors are logged.
+ @param This The EFI_DATA_HUB_PROTOCOL instance.
+ @param FilterEvent The EFI_EVENT to remove from the list of events to be
+ signaled every time errors are logged.
- @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.
-
- @retval EFI_NOT_FOUND FilterEvent did not exist.
+ @retval EFI_SUCCESS The filter driver represented by FilterEvent was shut off.
+ @retval EFI_NOT_FOUND FilterEvent did not exist.
**/
typedef
diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h index 0d70632fd9..643c810a34 100644 --- a/MdePkg/Include/Protocol/DeviceIo.h +++ b/MdePkg/Include/Protocol/DeviceIo.h @@ -47,7 +47,7 @@ typedef enum { @param Count The number of I/O operations to perform.
@param Buffer For read operations, the destination buffer to store the results. For write
operations, the source buffer to write data from.
-
+
@retval EFI_SUCCESS The data was read from or written to the device.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_INVALID_PARAMETER Width is invalid.
@@ -76,7 +76,7 @@ typedef struct { is going to be returned.
@param PciDevicePath A pointer to the pointer for the EFI Device Path for PciAddress.
Memory for the Device Path is allocated from the pool.
-
+
@retval EFI_SUCCESS The PciDevicePath returns a pointer to a valid EFI Device Path.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_UNSUPPORTED The PciAddress does not map to a valid EFI Device Path.
@@ -106,7 +106,7 @@ typedef enum { @param DeviceAddress The resulting map address for the bus master device to use to access the
hosts HostAddress.
@param Mapping A resulting value to pass to Unmap().
-
+
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_UNSUPPORTED The HostAddress cannot be mapped as a common buffer.
@@ -130,7 +130,7 @@ EFI_STATUS @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
@param Mapping A resulting value to pass to Unmap().
-
+
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@retval EFI_DEVICE_ERROR The system hardware could not map the requested address.
@@ -151,7 +151,7 @@ EFI_STATUS EfiRuntimeServicesData.
@param Pages The number of pages to allocate.
@param HostAddress A pointer to store the base address of the allocated range.
-
+
@retval EFI_SUCCESS The requested memory pages were allocated.
@retval EFI_OUT_OF_RESOURCES The memory pages could not be allocated.
@retval EFI_INVALID_PARAMETER The requested memory type is invalid.
@@ -173,7 +173,7 @@ EFI_STATUS Flushes any posted write data to the device.
@param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
-
+
@retval EFI_SUCCESS The buffers were flushed.
@retval EFI_DEVICE_ERROR The buffers were not flushed due to a hardware error.
@@ -190,7 +190,7 @@ EFI_STATUS @param This A pointer to the EFI_DEVICE_IO_INTERFACE instance.
@param Pages The number of pages to free.
@param HostAddress The base address of the range to free.
-
+
@retval EFI_SUCCESS The requested memory pages were allocated.
@retval EFI_NOT_FOUND The requested memory pages were not allocated with
AllocateBuffer().
diff --git a/MdePkg/Include/Protocol/FirmwareVolume.h b/MdePkg/Include/Protocol/FirmwareVolume.h index 7f86dbb853..310ea83138 100644 --- a/MdePkg/Include/Protocol/FirmwareVolume.h +++ b/MdePkg/Include/Protocol/FirmwareVolume.h @@ -82,8 +82,8 @@ typedef UINT64 EFI_FV_ATTRIBUTES; Retrieves attributes, insures positive polarity of attribute bits, returns
resulting attributes in output parameter
- @param This Calling context
- @param Attributes output buffer which contains attributes
+ @param This Calling context
+ @param Attributes output buffer which contains attributes
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -99,8 +99,8 @@ EFI_STATUS /**
Sets volume attributes
- @param This Calling context
- @param Attributes Buffer which contains attributes
+ @param This Calling context
+ @param Attributes Buffer which contains attributes
@retval EFI_INVALID_PARAMETER
@retval EFI_DEVICE_ERROR
@@ -121,24 +121,23 @@ typedef UINT32 EFI_FV_FILE_ATTRIBUTES; /**
Read the requested file (NameGuid) and returns data in Buffer.
- @param This Calling context
- @param NameGuid Filename identifying which file to read
- @param Buffer Pointer to pointer to buffer in which contents of file are returned.
- <br>
- If Buffer is NULL, only type, attributes, and size are returned as
- there is no output buffer.
- <br>
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
- from BS pool by ReadFile
- <br>
- If Buffer != NULL and *Buffer != NULL, the output buffer has been
- allocated by the caller and is being passed in.
-
- @param BufferSize Indicates the buffer size passed in, and on output the size
- required to complete the read
- @param FoundType Indicates the type of the file who's data is returned
- @param FileAttributes Indicates the attributes of the file who's data is resturned
- @param AuthenticationStatus Indicates the authentication status of the data
+ @param This Calling context
+ @param NameGuid Filename identifying which file to read
+ @param Buffer Pointer to pointer to buffer in which contents of file are returned.
+ <br>
+ If Buffer is NULL, only type, attributes, and size are returned as
+ there is no output buffer.
+ <br>
+ If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
+ from BS pool by ReadFile
+ <br>
+ If Buffer != NULL and *Buffer != NULL, the output buffer has been
+ allocated by the caller and is being passed in.
+ @param BufferSize Indicates the buffer size passed in, and on output the size
+ required to complete the read
+ @param FoundType Indicates the type of the file who's data is returned
+ @param FileAttributes Indicates the attributes of the file who's data is resturned
+ @param AuthenticationStatus Indicates the authentication status of the data
@retval EFI_SUCCESS
@retval EFI_WARN_BUFFER_TOO_SMALL
@@ -162,24 +161,23 @@ EFI_STATUS /**
Read the requested section from the specified file and returns data in Buffer.
- @param This Calling context
- @param NameGuid Filename identifying the file from which to read
- @param SectionType Indicates what section type to retrieve
- @param SectionInstance Indicates which instance of SectionType to retrieve
- @param Buffer Pointer to pointer to buffer in which contents of file are returned.
- <br>
- If Buffer is NULL, only type, attributes, and size are returned as
- there is no output buffer.
- <br>
- If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
- from BS pool by ReadFile
- <br>
- If Buffer != NULL and *Buffer != NULL, the output buffer has been
- allocated by the caller and is being passed in.
-
- @param BufferSize Indicates the buffer size passed in, and on output the size
- required to complete the read
- @param AuthenticationStatus Indicates the authentication status of the data
+ @param This Calling context
+ @param NameGuid Filename identifying the file from which to read
+ @param SectionType Indicates what section type to retrieve
+ @param SectionInstance Indicates which instance of SectionType to retrieve
+ @param Buffer Pointer to pointer to buffer in which contents of file are returned.
+ <br>
+ If Buffer is NULL, only type, attributes, and size are returned as
+ there is no output buffer.
+ <br>
+ If Buffer != NULL and *Buffer == NULL, the output buffer is allocated
+ from BS pool by ReadFile
+ <br>
+ If Buffer != NULL and *Buffer != NULL, the output buffer has been
+ allocated by the caller and is being passed in.
+ @param BufferSize Indicates the buffer size passed in, and on output the size
+ required to complete the read
+ @param AuthenticationStatus Indicates the authentication status of the data
@retval EFI_SUCCESS
@retval EFI_WARN_BUFFER_TOO_SMALL
@@ -217,13 +215,13 @@ typedef struct { /**
Write the supplied file (NameGuid) to the FV.
- @param This Calling context
- @param NumberOfFiles Indicates the number of file records pointed to by FileData
- @param WritePolicy Indicates the level of reliability of the write with respect to
- things like power failure events.
- @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each
- element in the array indicates a file to write, and there are
- NumberOfFiles elements in the input array.
+ @param This Calling context
+ @param NumberOfFiles Indicates the number of file records pointed to by FileData
+ @param WritePolicy Indicates the level of reliability of the write with respect to
+ things like power failure events.
+ @param FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each
+ element in the array indicates a file to write, and there are
+ NumberOfFiles elements in the input array.
@retval EFI_SUCCESS
@retval EFI_OUT_OF_RESOURCES
@@ -245,14 +243,14 @@ EFI_STATUS /**
Given the input key, search for the next matching file in the volume.
- @param This Calling context
- @param Key Pointer to a caller allocated buffer that contains an implementation
- specific key that is used to track where to begin searching on
- successive calls.
- @param FileType Indicates the file type to filter for
- @param NameGuid Guid filename of the file found
- @param Attributes Attributes of the file found
- @param Size Size in bytes of the file found
+ @param This Calling context
+ @param Key Pointer to a caller allocated buffer that contains an implementation
+ specific key that is used to track where to begin searching on
+ successive calls.
+ @param FileType Indicates the file type to filter for
+ @param NameGuid Guid filename of the file found
+ @param Attributes Attributes of the file found
+ @param Size Size in bytes of the file found
@retval EFI_SUCCESS
@retval EFI_NOT_FOUND
diff --git a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h index ee849a141e..0c3d03276b 100644 --- a/MdePkg/Include/Protocol/FirmwareVolumeBlock.h +++ b/MdePkg/Include/Protocol/FirmwareVolumeBlock.h @@ -35,8 +35,8 @@ typedef struct _EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL EFI_FIRMWARE_VOLUME_BLOCK_PR /**
Retrieves Volume attributes. No polarity translations are done.
- @param This Calling context
- @param Attributes output buffer which contains attributes
+ @param This Calling context
+ @param Attributes output buffer which contains attributes
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -53,9 +53,9 @@ EFI_STATUS /**
Sets Volume attributes. No polarity translations are done.
- @param This Calling context
- @param Attributes On input: contains new attributes
- On output: contains current attributes of FV
+ @param This Calling context
+ @param Attributes On input: contains new attributes
+ On output: contains current attributes of FV
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -72,10 +72,10 @@ EFI_STATUS /**
Retrieves the physical address of a memory mapped FV.
- @param This Calling context
- @param Attributes Address is a pointer to a caller allocated EFI_PHYSICAL_ADDRESS
- that on successful return from GetPhysicalAddress() contains the
- base address of the firmware volume.
+ @param This Calling context
+ @param Attributes Address is a pointer to a caller allocated EFI_PHYSICAL_ADDRESS
+ that on successful return from GetPhysicalAddress() contains the
+ base address of the firmware volume.
@retval EFI_UNSUPPORTED
@retval EFI_SUCCESS
@@ -92,14 +92,14 @@ EFI_STATUS /**
Retrieves the size in bytes of a specific block within an FV.
- @param This Calling context.
- @param Lba Indicates which block to return the size for.
- @param BlockSize BlockSize is a pointer to a caller allocated
- UINTN in which the size of the block is returned.
- @param NumberOfBlocks NumberOfBlocks is a pointer to a caller allocated
- UINTN in which the number of consecutive blocks
- starting with Lba is returned. All blocks in this
- range have a size of BlockSize.
+ @param This Calling context.
+ @param Lba Indicates which block to return the size for.
+ @param BlockSize BlockSize is a pointer to a caller allocated
+ UINTN in which the size of the block is returned.
+ @param NumberOfBlocks NumberOfBlocks is a pointer to a caller allocated
+ UINTN in which the number of consecutive blocks
+ starting with Lba is returned. All blocks in this
+ range have a size of BlockSize.
@retval EFI_INVALID_PARAMETER
@retval EFI_SUCCESS
@@ -121,12 +121,12 @@ EFI_STATUS a block boundary is reached. *NumBytes is updated to reflect the actual
number of bytes read.
- @param This Calling context
- @param Lba Block in which to begin read
- @param Offset Offset in the block at which to begin read
- @param NumBytes At input, indicates the requested read size. At output, indicates
- the actual number of bytes read.
- @param Buffer Data buffer in which to place data read.
+ @param This Calling context
+ @param Lba Block in which to begin read
+ @param Offset Offset in the block at which to begin read
+ @param NumBytes At input, indicates the requested read size. At output, indicates
+ the actual number of bytes read.
+ @param Buffer Data buffer in which to place data read.
@retval EFI_INVALID_PARAMETER
@retval EFI_NOT_FOUND
@@ -151,12 +151,12 @@ EFI_STATUS reached. *NumBytes is updated to reflect the actual number of bytes
written.
- @param This Calling context
- @param Lba Block in which to begin write
- @param Offset Offset in the block at which to begin write
- @param NumBytes At input, indicates the requested write size. At output, indicates
- the actual number of bytes written.
- @param Buffer Buffer containing source data for the write.
+ @param This Calling context
+ @param Lba Block in which to begin write
+ @param Offset Offset in the block at which to begin write
+ @param NumBytes At input, indicates the requested write size. At output, indicates
+ the actual number of bytes written.
+ @param Buffer Buffer containing source data for the write.
@retval EFI_INVALID_PARAMETER
@retval EFI_NOT_FOUND
@@ -185,9 +185,9 @@ EFI_STATUS block of the firmware volume), the EraseBlock() function must return
EFI_INVALID_PARAMETER without modifying the contents of the firmware volume.
- @param This Calling context
- @param ... Starting LBA followed by Number of Lba to erase. a -1 to terminate
- the list.
+ @param This Calling context
+ @param ... Starting LBA followed by Number of Lba to erase. a -1 to terminate
+ the list.
@retval EFI_INVALID_PARAMETER
@retval EFI_DEVICE_ERROR
diff --git a/MdePkg/Include/Protocol/FormBrowser.h b/MdePkg/Include/Protocol/FormBrowser.h index c0ee94ad65..0e52f1edaa 100644 --- a/MdePkg/Include/Protocol/FormBrowser.h +++ b/MdePkg/Include/Protocol/FormBrowser.h @@ -55,48 +55,36 @@ typedef struct { database or a passed-in set of data. This function also establishes a
pointer to the calling driver¡¯s callback interface.
- @param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.
-
- @param UseDatabase Determines whether the HII database is to be
- used to gather information. If the value is FALSE, the configuration
- driver will get the information provided in the passed-in Packet parameters.
-
- @param Handle A pointer to an array of HII handles to display. This value
- should correspond to the value of the HII form package that is required to
- be displayed.
-
- @param HandleCount The number of handles in the array specified by Handle.
-
- @param Packet A pointer to a set of data containing pointers to IFR
- and/or string data.
-
- @param CallbackHandle The handle to the driver¡¯s callback interface.
- This parameter is used only when the UseDatabase parameter is FALSE
- and an application wants to register a callback with the browser
-
- @param NvMapOverride This buffer is used only when there is no NV variable
- to define the current settings and the caller needs to provide to the browser
- the current settings for the "fake" NV variable.
-
- @param ScreenDimensions Allows the browser to be called so that it occupies
- a portion of the physical screen instead of dynamically determining the
- screen dimensions.
-
- @param ResetRequired This BOOLEAN value will tell the caller if a reset
- is required based on the data that might have been changed. The ResetRequired
- parameter is primarily applicable for configuration applications, and is an
- optional parameter.
-
- @retval EFI_SUCCESS The function completed successfully
-
- @retval EFI_NOT_FOUND The variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
- DataSize has been updated with the size needed to complete the request.
-
+ @param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.
+ @param UseDatabase Determines whether the HII database is to be
+ used to gather information. If the value is FALSE, the configuration
+ driver will get the information provided in the passed-in Packet parameters.
+ @param Handle A pointer to an array of HII handles to display. This value
+ should correspond to the value of the HII form package that is required to
+ be displayed.
+ @param HandleCount The number of handles in the array specified by Handle.
+ @param Packet A pointer to a set of data containing pointers to IFR
+ and/or string data.
+ @param CallbackHandle The handle to the driver¡¯s callback interface.
+ This parameter is used only when the UseDatabase parameter is FALSE
+ and an application wants to register a callback with the browser
+ @param NvMapOverride This buffer is used only when there is no NV variable
+ to define the current settings and the caller needs to provide to the browser
+ the current settings for the "fake" NV variable.
+ @param ScreenDimensions Allows the browser to be called so that it occupies
+ a portion of the physical screen instead of dynamically determining the
+ screen dimensions.
+ @param ResetRequired This BOOLEAN value will tell the caller if a reset
+ is required based on the data that might have been changed. The ResetRequired
+ parameter is primarily applicable for configuration applications, and is an
+ optional parameter.
+
+ @retval EFI_SUCCESS The function completed successfully
+ @retval EFI_NOT_FOUND The variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
+ DataSize has been updated with the size needed to complete the request.
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
**/
typedef
@@ -117,29 +105,21 @@ EFI_STATUS Routine used to abstract a generic dialog interface and return the selected
key or string.
- @param NumberOfLines The number of lines for the dialog box.
-
- @param HotKey Defines whether a single character is parsed (TRUE)
- and returned in KeyValue or if a string is returned in StringBuffer.
-
- @param MaximumStringSize The maximum size in bytes of a typed-in string.
- Because each character is a CHAR16, the minimum string returned is two bytes.
-
- @param StringBuffer The passed-in pointer to the buffer that will hold
- the typed in string if HotKey is FALSE.
-
- @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.
-
- @param String The pointer to the first string in the list of strings
- that comprise the dialog box.
-
- @param ... A series of NumberOfLines text strings that will be used
- to construct the dialog box.
-
- @retval EFI_SUCCESS The dialog was displayed and user interaction was received.
-
- @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.
-
+ @param NumberOfLines The number of lines for the dialog box.
+ @param HotKey Defines whether a single character is parsed (TRUE)
+ and returned in KeyValue or if a string is returned in StringBuffer.
+ @param MaximumStringSize The maximum size in bytes of a typed-in string.
+ Because each character is a CHAR16, the minimum string returned is two bytes.
+ @param StringBuffer The passed-in pointer to the buffer that will hold
+ the typed in string if HotKey is FALSE.
+ @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.
+ @param String The pointer to the first string in the list of strings
+ that comprise the dialog box.
+ @param ... A series of NumberOfLines text strings that will be used
+ to construct the dialog box.
+
+ @retval EFI_SUCCESS The dialog was displayed and user interaction was received.
+ @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.
@retval EFI_INVALID_PARAMETER One of the parameters was invalid
**/
diff --git a/MdePkg/Include/Protocol/FormCallback.h b/MdePkg/Include/Protocol/FormCallback.h index 7a1c5398b8..2f3a527873 100644 --- a/MdePkg/Include/Protocol/FormCallback.h +++ b/MdePkg/Include/Protocol/FormCallback.h @@ -88,31 +88,22 @@ typedef struct { /**
Returns the value of a variable.
- @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
-
- @param VariableName A NULL-terminated Unicode string that is the
- name of the vendor¡¯s variable.
-
- @param VendorGuid A unique identifier for the vendor.
-
- @param Attributes If not NULL, a pointer to the memory location to
- return the attribute's bit-mask for the variable.
-
- @param DataSize The size in bytes of the Buffer. A size of zero causes
- the variable to be deleted.
-
- @param Buffer The buffer to return the contents of the variable.
-
- @retval EFI_SUCCESS The function completed successfully.
-
- @retval EFI_NOT_FOUND The variable was not found.
-
- @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
- DataSize has been updated with the size needed to complete the request.
-
- @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
-
- @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
+ @param VariableName A NULL-terminated Unicode string that is the
+ name of the vendor¡¯s variable.
+ @param VendorGuid A unique identifier for the vendor.
+ @param Attributes If not NULL, a pointer to the memory location to
+ return the attribute's bit-mask for the variable.
+ @param DataSize The size in bytes of the Buffer. A size of zero causes
+ the variable to be deleted.
+ @param Buffer The buffer to return the contents of the variable.
+
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_NOT_FOUND The variable was not found.
+ @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
+ DataSize has been updated with the size needed to complete the request.
+ @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
**/
typedef
@@ -129,35 +120,26 @@ EFI_STATUS /**
Sets the value of a variable.
- @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
-
- @param VariableName A NULL-terminated Unicode string that is the
- name of the vendor's variable. Each VariableName is unique for each VendorGuid.
-
- @param VendorGuid A unique identifier for the vendor.
-
- @param Attributes Attributes bit-mask to set for the variable.
-
- @param DataSize The size in bytes of the Buffer. A size of zero causes
- the variable to be deleted.
-
- @param Buffer The buffer containing the contents of the variable.
-
- @param ResetRequired Returns a value from the driver that abstracts
- this information and will enable a system to know if a system reset
- is required to achieve the configuration changes being enabled through
- this function.
-
- @retval EFI_SUCCESS The firmware has successfully stored the variable and
- its data as defined by the Attributes.
-
- @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold
- the variable and its data.
-
- @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits
- was supplied, or the DataSize exceeds the maximum allowed.
-
- @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
+ @param VariableName A NULL-terminated Unicode string that is the
+ name of the vendor's variable. Each VariableName is unique for each VendorGuid.
+ @param VendorGuid A unique identifier for the vendor.
+ @param Attributes Attributes bit-mask to set for the variable.
+ @param DataSize The size in bytes of the Buffer. A size of zero causes
+ the variable to be deleted.
+ @param Buffer The buffer containing the contents of the variable.
+ @param ResetRequired Returns a value from the driver that abstracts
+ this information and will enable a system to know if a system reset
+ is required to achieve the configuration changes being enabled through
+ this function.
+
+ @retval EFI_SUCCESS The firmware has successfully stored the variable and
+ its data as defined by the Attributes.
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold
+ the variable and its data.
+ @retval EFI_INVALID_PARAMETER An invalid combination of Attributes bits
+ was supplied, or the DataSize exceeds the maximum allowed.
+ @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
**/
typedef
@@ -175,16 +157,13 @@ EFI_STATUS /**
This function is called to provide results data to the driver.
- @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
-
- @param KeyValue A unique value which is sent to the original exporting
- driver so that it can identify the type of data to expect. The format of
- the data tends to vary based on the opcode that generated the callback.
-
- @param Data A pointer to the data being sent to the original exporting driver.
-
- @param Packet A pointer to a packet of information which a driver passes
- back to the browser.
+ @param This A pointer to the EFI_FORM_CALLBACK_PROTOCOL instance.
+ @param KeyValue A unique value which is sent to the original exporting
+ driver so that it can identify the type of data to expect. The format of
+ the data tends to vary based on the opcode that generated the callback.
+ @param Data A pointer to the data being sent to the original exporting driver.
+ @param Packet A pointer to a packet of information which a driver passes
+ back to the browser.
@return Status Code
diff --git a/MdePkg/Include/Protocol/GuidedSectionExtraction.h b/MdePkg/Include/Protocol/GuidedSectionExtraction.h index d98c56a7bc..8368e281a8 100644 --- a/MdePkg/Include/Protocol/GuidedSectionExtraction.h +++ b/MdePkg/Include/Protocol/GuidedSectionExtraction.h @@ -49,20 +49,20 @@ typedef struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL EFI_GUIDED_SECTION_EXTRA Processes the input section and returns the data contained therein along
with the authentication status.
- @param This Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.
- @param InputSection Buffer containing the input GUIDed section to be processed.
- @param OutputBuffer *OutputBuffer is allocated from boot services pool memory
- and contains the new section stream.
- @param OutputSize A pointer to a caller-allocated UINTN in which the size
- of *OutputBuffer allocation is stored.
- @param AuthenticationStatus A pointer to a caller-allocated UINT32 that
+ @param This Indicates the EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL instance.
+ @param InputSection Buffer containing the input GUIDed section to be processed.
+ @param OutputBuffer *OutputBuffer is allocated from boot services pool memory
+ and contains the new section stream.
+ @param OutputSize A pointer to a caller-allocated UINTN in which the size
+ of *OutputBuffer allocation is stored.
+ @param AuthenticationStatus A pointer to a caller-allocated UINT32 that
indicates the authentication status of the output buffer.
- @retval EFI_SUCCESS The InputSection was successfully processed and the
+ @retval EFI_SUCCESS The InputSection was successfully processed and the
section contents were returned.
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
process the request.
- @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match
+ @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match
this instance of the GUIDed Section Extraction Protocol.
**/
diff --git a/MdePkg/Include/Protocol/Hii.h b/MdePkg/Include/Protocol/Hii.h index ceeba1c7fb..bb213d8d57 100644 --- a/MdePkg/Include/Protocol/Hii.h +++ b/MdePkg/Include/Protocol/Hii.h @@ -412,16 +412,13 @@ typedef struct _EFI_HII_VARIABLE_PACK_LIST { /**
Registers the various packs that are passed in via the Packages parameter.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Packages A pointer to an EFI_HII_PACKAGES package instance.
-
- @param Handle A pointer to the EFI_HII_HANDLE instance.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Packages A pointer to an EFI_HII_PACKAGES package instance.
+ @param Handle A pointer to the EFI_HII_HANDLE instance.
- @retval EFI_SUCCESS Data was extracted from Packages, the database
- was updated with the data, and Handle returned successfully.
-
- @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
+ @retval EFI_SUCCESS Data was extracted from Packages, the database
+ was updated with the data, and Handle returned successfully.
+ @retval EFI_INVALID_PARAMETER The content of Packages was invalid.
**/
typedef
@@ -435,15 +432,13 @@ EFI_STATUS /**
Removes a package from the HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle that was registered to the data that is requested
- for removal.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle that was registered to the data that is requested
+ for removal.
- @retval EFI_SUCCESS The data associated with the Handle was removed
- from the HII database.
-
- @retval EFI_INVALID_PARAMETER The Handle was not valid.
+ @retval EFI_SUCCESS The data associated with the Handle was removed
+ from the HII database.
+ @retval EFI_INVALID_PARAMETER The Handle was not valid.
**/
typedef
@@ -456,18 +451,15 @@ EFI_STATUS /**
Determines the handles that are currently active in the database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param HandleBufferLength On input, a pointer to the length of the handle
- buffer. On output, the length of the handle buffer that is required
- for the handles found.
-
- @param Handle An array of EFI_HII_HANDLE instances returned.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param HandleBufferLength On input, a pointer to the length of the handle
+ buffer. On output, the length of the handle buffer that is required
+ for the handles found.
+ @param Handle An array of EFI_HII_HANDLE instances returned.
- @retval EFI_SUCCESS Handle was updated successfully.
-
- @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
- that Handle is too small to support the number of handles.
+ @retval EFI_SUCCESS Handle was updated successfully.
+ @retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter indicates
+ that Handle is too small to support the number of handles.
**/
typedef
@@ -481,22 +473,18 @@ EFI_STATUS /**
Exports the contents of the database into a buffer.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle An EFI_HII_HANDLE that corresponds to the desired
- handle to export. If the value is 0, the entire database will be exported.
- In either case, the data will be exported in a format described by the
- structure definition of EFI_HII_EXPORT_TABLE.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle An EFI_HII_HANDLE that corresponds to the desired
+ handle to export. If the value is 0, the entire database will be exported.
+ In either case, the data will be exported in a format described by the
+ structure definition of EFI_HII_EXPORT_TABLE.
@param BufferSize
On input, a pointer to the length of the buffer. On output, the length
of the buffer that is required for the export data.
-
- @param Buffer A pointer to a buffer that will contain the results of the export function.
+ @param Buffer A pointer to a buffer that will contain the results of the export function.
- @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
-
- @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
+ @retval EFI_SUCCESS The buffer was successfully filled with BufferSize amount of data.
+ @retval EFI_BUFFER_TOO_SMALL The value in BufferSize was too small to contain the export data.
**/
typedef
@@ -512,12 +500,10 @@ EFI_STATUS Remove any new strings that were added after the initial string export
for this handle.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the string resides.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the string resides.
- @retval EFI_SUCCESS Remove strings from the handle successfully.
-
+ @retval EFI_SUCCESS Remove strings from the handle successfully.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -531,24 +517,20 @@ EFI_STATUS /**
Tests if all of the characters in a string have corresponding font characters.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param StringToTest A pointer to a Unicode string.
-
- @param FirstMissing A pointer to an index into the string. On input,
- the index of the first character in the StringToTest to examine. On exit,
- the index of the first character encountered for which a glyph is unavailable.
- If all glyphs in the string are available, the index is the index of the
- terminator of the string.
-
- @param GlyphBufferSize A pointer to a value. On output, if the function
- returns EFI_SUCCESS, it contains the amount of memory that is required to
- store the string¡¯s glyph equivalent.
-
- @retval EFI_SUCCESS All glyphs are available. Note that an empty string
- always returns this value.
-
- @retval EFI_NOT_FOUND A glyph was not found for a character.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param StringToTest A pointer to a Unicode string.
+ @param FirstMissing A pointer to an index into the string. On input,
+ the index of the first character in the StringToTest to examine. On exit,
+ the index of the first character encountered for which a glyph is unavailable.
+ If all glyphs in the string are available, the index is the index of the
+ terminator of the string.
+ @param GlyphBufferSize A pointer to a value. On output, if the function
+ returns EFI_SUCCESS, it contains the amount of memory that is required to
+ store the string¡¯s glyph equivalent.
+
+ @retval EFI_SUCCESS All glyphs are available. Note that an empty string
+ always returns this value.
+ @retval EFI_NOT_FOUND A glyph was not found for a character.
**/
typedef
@@ -563,28 +545,22 @@ EFI_STATUS /**
Translates a Unicode character into the corresponding font glyph.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Source A pointer to a Unicode string.
-
- @param Index On input, the offset into the string from which to fetch
- the character.On successful completion, the index is updated to the first
- character past the character(s) making up the just extracted glyph.
-
- @param GlyphBuffer Pointer to an array where the glyphs corresponding
- to the characters in the source may be stored. GlyphBuffer is assumed
- to be wide enough to accept a wide glyph character.
-
- @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
- this value is filled with the length of the glyph in pixels. It is unchanged
- if the call was unsuccessful.
-
- @param InternalStatus The cell pointed to by this parameter must be
- initialized to zero prior to invoking the call the first time for any string.
-
- @retval EFI_SUCCESS It worked.
-
- @retval EFI_NOT_FOUND A glyph for a character was not found.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Source A pointer to a Unicode string.
+ @param Index On input, the offset into the string from which to fetch
+ the character.On successful completion, the index is updated to the first
+ character past the character(s) making up the just extracted glyph.
+ @param GlyphBuffer Pointer to an array where the glyphs corresponding
+ to the characters in the source may be stored. GlyphBuffer is assumed
+ to be wide enough to accept a wide glyph character.
+ @param BitWidth If EFI_SUCCESS was returned, the UINT16 pointed to by
+ this value is filled with the length of the glyph in pixels. It is unchanged
+ if the call was unsuccessful.
+ @param InternalStatus The cell pointed to by this parameter must be
+ initialized to zero prior to invoking the call the first time for any string.
+
+ @retval EFI_SUCCESS It worked.
+ @retval EFI_NOT_FOUND A glyph for a character was not found.
**/
typedef
@@ -602,28 +578,20 @@ EFI_STATUS Translates a glyph into the format required for input to the Universal
Graphics Adapter (UGA) Block Transfer (BLT) routines.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param GlyphBuffer A pointer to the buffer that contains glyph data.
-
- @param Foreground The foreground setting requested to be used for the
- generated BltBuffer data.
-
- @param Background The background setting requested to be used for the
- generated BltBuffer data.
-
- @param Count The entry in the BltBuffer upon which to act.
-
- @param Width The width in bits of the glyph being converted.
-
- @param Height The height in bits of the glyph being converted
-
- @param BltBuffer A pointer to the buffer that contains the data that is
- ready to be used by the UGA BLT routines.
-
- @retval EFI_SUCCESS It worked.
-
- @retval EFI_NOT_FOUND A glyph for a character was not found.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param GlyphBuffer A pointer to the buffer that contains glyph data.
+ @param Foreground The foreground setting requested to be used for the
+ generated BltBuffer data.
+ @param Background The background setting requested to be used for the
+ generated BltBuffer data.
+ @param Count The entry in the BltBuffer upon which to act.
+ @param Width The width in bits of the glyph being converted.
+ @param Height The height in bits of the glyph being converted
+ @param BltBuffer A pointer to the buffer that contains the data that is
+ ready to be used by the UGA BLT routines.
+
+ @retval EFI_SUCCESS It worked.
+ @retval EFI_NOT_FOUND A glyph for a character was not found.
**/
typedef
@@ -642,22 +610,17 @@ EFI_STATUS /**
Allows a new string to be added to an already existing string package.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Pointer to a NULL-terminated string containing a single ISO 639-2
- language identifier, indicating the language in which the string is translated.
-
- @param Handle The handle of the language pack to which the string is to be added.
-
- @param Reference The identifier of the string to be added. If the reference
- value is zero, then the string will be assigned a new identifier on that
- handle for the language specified. Otherwise, the string will be updated
- with the NewString Value.
-
- @param NewString The string to be added.
-
- @retval EFI_SUCCESS The string was effectively registered.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Pointer to a NULL-terminated string containing a single ISO 639-2
+ language identifier, indicating the language in which the string is translated.
+ @param Handle The handle of the language pack to which the string is to be added.
+ @param Reference The identifier of the string to be added. If the reference
+ value is zero, then the string will be assigned a new identifier on that
+ handle for the language specified. Otherwise, the string will be updated
+ with the NewString Value.
+ @param NewString The string to be added.
+
+ @retval EFI_SUCCESS The string was effectively registered.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -675,15 +638,12 @@ EFI_STATUS Allows a program to determine the primary languages that are supported
on a given handle.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the strings reside.
-
- @param LanguageString A string allocated by GetPrimaryLanguages() that
- contains a list of all primary languages registered on the handle.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the strings reside.
+ @param LanguageString A string allocated by GetPrimaryLanguages() that
+ contains a list of all primary languages registered on the handle.
- @retval EFI_SUCCESS LanguageString was correctly returned.
-
+ @retval EFI_SUCCESS LanguageString was correctly returned.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -699,18 +659,14 @@ EFI_STATUS Allows a program to determine which secondary languages are supported
on a given handle for a given primary language.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the strings reside.
-
- @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
- ISO 639-2 language identifier, indicating the primary language.
-
- @param LanguageString A string allocated by GetSecondaryLanguages()
- containing a list of all secondary languages registered on the handle.
-
- @retval EFI_SUCCESS LanguageString was correctly returned.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the strings reside.
+ @param PrimaryLanguage Pointer to a NULL-terminated string containing a single
+ ISO 639-2 language identifier, indicating the primary language.
+ @param LanguageString A string allocated by GetSecondaryLanguages()
+ containing a list of all secondary languages registered on the handle.
+
+ @retval EFI_SUCCESS LanguageString was correctly returned.
@retval EFI_INVALID_PARAMETER The Handle was unknown.
**/
@@ -726,32 +682,24 @@ EFI_STATUS /**
Extracts a string from a package already registered with the EFI HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the string resides.
-
- @param Token The string token assigned to the string.
-
- @param Raw If TRUE, the string is returned unedited in the internal
- storage format described above. If false, the string returned is edited
- by replacing <cr> with <space> and by removing special characters such
- as the <wide> prefix.
-
- @param LanguageString Pointer to a NULL-terminated string containing a
- single ISO 639-2 language identifier, indicating the language to print.
- If the LanguageString is empty (starts with a NULL), the default system
- language will be used to determine the language.
-
- @param BufferLength Length of the StringBuffer.
-
- @param StringBuffer The buffer designed to receive the characters in the string.
-
- @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the string resides.
+ @param Token The string token assigned to the string.
+ @param Raw If TRUE, the string is returned unedited in the internal
+ storage format described above. If false, the string returned is edited
+ by replacing <cr> with <space> and by removing special characters such
+ as the <wide> prefix.
+ @param LanguageString Pointer to a NULL-terminated string containing a
+ single ISO 639-2 language identifier, indicating the language to print.
+ If the LanguageString is empty (starts with a NULL), the default system
+ language will be used to determine the language.
+ @param BufferLength Length of the StringBuffer.
+ @param StringBuffer The buffer designed to receive the characters in the string.
+
+ @retval EFI_SUCCESS StringBuffer is filled with a NULL-terminated string.
@retval EFI_INVALID_PARAMETER The handle or string token is unknown.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
- allow the entire string to be stored.
+ @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough to
+ allow the entire string to be stored.
**/
typedef
@@ -769,32 +717,23 @@ EFI_STATUS /**
Allows a program to extract a part of a string of not more than a given width.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The handle on which the string resides.
-
- @param Token The string token assigned to the string.
-
- @param Index On input, the offset into the string where the line is to start.
- On output, the index is updated to point to beyond the last character returned
- in the call.
-
- @param LineWidth The maximum width of the line in units of narrow glyphs.
-
- @param LanguageString Pointer to a NULL-terminated string containing a
- single ISO 639-2 language identifier, indicating the language to print.
-
- @param BufferLength Pointer to the length of the StringBuffer.
-
- @param StringBuffer The buffer designed to receive the characters in the string.
-
- @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
-
- @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
- the string is not in the font database.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
- to allow the entire string to be stored.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The handle on which the string resides.
+ @param Token The string token assigned to the string.
+ @param Index On input, the offset into the string where the line is to start.
+ On output, the index is updated to point to beyond the last character returned
+ in the call.
+ @param LineWidth The maximum width of the line in units of narrow glyphs.
+ @param LanguageString Pointer to a NULL-terminated string containing a
+ single ISO 639-2 language identifier, indicating the language to print.
+ @param BufferLength Pointer to the length of the StringBuffer.
+ @param StringBuffer The buffer designed to receive the characters in the string.
+
+ @retval EFI_SUCCESS StringBuffer filled with characters that will fit on the line.
+ @retval EFI_NOT_FOUND The font glyph for at least one of the characters in
+ the string is not in the font database.
+ @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
+ to allow the entire string to be stored.
**/
typedef
@@ -814,28 +753,21 @@ EFI_STATUS Allows a program to extract a form or form package that has previously
been registered with the HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle Handle on which the form resides.
-
- @param FormId The ID of the form to return. If the ID is zero,
- the entire form package is returned.
-
- @param BufferLength On input, the length of the Buffer. On output,
- the length of the returned buffer,
-
- @param Buffer The buffer designed to receive the form(s).
-
- @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
- was updated.
-
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle Handle on which the form resides.
+ @param FormId The ID of the form to return. If the ID is zero,
+ the entire form package is returned.
+ @param BufferLength On input, the length of the Buffer. On output,
+ the length of the returned buffer,
+ @param Buffer The buffer designed to receive the form(s).
+
+ @retval EFI_SUCCESS Buffer filled with the requested forms. BufferLength
+ was updated.
@retval EFI_INVALID_PARAMETER The handle is unknown.
-
- @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
- the requested FormId.
-
- @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
- to allow the form to be stored.
+ @retval EFI_NOT_FOUND A form on the requested handle cannot be found with
+ the requested FormId.
+ @retval EFI_BUFFER_TOO_SMALL The buffer provided was not large enough
+ to allow the form to be stored.
**/
typedef
@@ -851,23 +783,18 @@ EFI_STATUS /**
Extracts the defaults that are associated with a given handle in the HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle The HII handle from which will have default data retrieved.
-
- @param DefaultMask The mask used to specify some type of default override when extracting
- the default image data.
-
- @param VariablePackList A indirect pointer to the first entry of a link list with
- type EFI_HII_VARIABLE_PACK_LIST.
-
- @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
- default setting data.
-
- @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
-
- @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
- contain invalid data.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle The HII handle from which will have default data retrieved.
+ @param DefaultMask The mask used to specify some type of default override when extracting
+ the default image data.
+ @param VariablePackList A indirect pointer to the first entry of a link list with
+ type EFI_HII_VARIABLE_PACK_LIST.
+
+ @retval EFI_SUCCESS The VariablePackList was populated with the appropriate
+ default setting data.
+ @retval EFI_NOT_FOUND The IFR does not have any explicit or default map(s).
+ @retval EFI_INVALID_PARAMETER The HII database entry associated with Handle
+ contain invalid data.
**/
typedef
@@ -883,23 +810,17 @@ EFI_STATUS Allows the caller to update a form or form package that has previously been
registered with the EFI HII database.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param Handle Handle of the package where the form to be updated resides.
-
- @param Label The label inside the form package where the update is to take place.
-
- @param AddData If TRUE, adding data at a given Label; otherwise,
- if FALSE, removing data at a given Label.
-
- @param Data The buffer containing the new tags to insert after the Label
-
- @retval EFI_SUCCESS The form was updated with the new tags.
-
- @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
- contain an integral number of tags.
-
- @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param Handle Handle of the package where the form to be updated resides.
+ @param Label The label inside the form package where the update is to take place.
+ @param AddData If TRUE, adding data at a given Label; otherwise,
+ if FALSE, removing data at a given Label.
+ @param Data The buffer containing the new tags to insert after the Label
+
+ @retval EFI_SUCCESS The form was updated with the new tags.
+ @retval EFI_INVALID_PARAMETER The buffer for the buffer length does not
+ contain an integral number of tags.
+ @retval EFI_NOT_FOUND The Handle, Label, or FormId was not found.
**/
typedef
@@ -915,15 +836,13 @@ EFI_STATUS /**
Retrieves the current keyboard layout.
- @param This A pointer to the EFI_HII_PROTOCOL instance.
-
- @param DescriptorCount A pointer to the number of Descriptor entries being
- described in the keyboard layout being retrieved.
-
- @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
- entries. Each entry will reflect the definition of a specific physical key.
+ @param This A pointer to the EFI_HII_PROTOCOL instance.
+ @param DescriptorCount A pointer to the number of Descriptor entries being
+ described in the keyboard layout being retrieved.
+ @param Descriptor A pointer to a buffer containing an array of EFI_KEY_DESCRIPTOR
+ entries. Each entry will reflect the definition of a specific physical key.
- @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
+ @retval EFI_SUCCESS The keyboard layout was retrieved successfully.
**/
typedef
diff --git a/MdePkg/Include/Protocol/IdeControllerInit.h b/MdePkg/Include/Protocol/IdeControllerInit.h index beaac30e5f..0249055bc5 100644 --- a/MdePkg/Include/Protocol/IdeControllerInit.h +++ b/MdePkg/Include/Protocol/IdeControllerInit.h @@ -263,18 +263,14 @@ typedef union { /**
Returns the information about the specified IDE channel.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Enabled TRUE if this channel is enabled. Disabled channels are not scanned
- to see if any devices are present.
-
- @param MaxDevices The maximum number of IDE devices that the bus driver
- can expect on this channel.
-
- @retval EFI_SUCCESS Information was returned without any errors.
-
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Enabled TRUE if this channel is enabled. Disabled channels are not scanned
+ to see if any devices are present.
+ @param MaxDevices The maximum number of IDE devices that the bus driver
+ can expect on this channel.
+
+ @retval EFI_SUCCESS Information was returned without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
**/
@@ -291,19 +287,14 @@ EFI_STATUS The notifications from the IDE bus driver that it is about to enter a certain
phase of the IDE channel enumeration process.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Phase The phase during enumeration.
-
- @param Channel Zero-based channel number.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Phase The phase during enumeration.
+ @param Channel Zero-based channel number.
- @retval EFI_SUCCESS The notification was accepted without any errors.
-
- @retval EFI_NOT_SUPPORTED Phase is not supported.
-
+ @retval EFI_SUCCESS The notification was accepted without any errors.
+ @retval EFI_NOT_SUPPORTED Phase is not supported.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
-
- @retval EFI_NOT_READY This phase cannot be entered at this time.
+ @retval EFI_NOT_READY This phase cannot be entered at this time.
**/
typedef
@@ -317,18 +308,14 @@ EFI_STATUS /**
Submits the device information to the IDE controller driver.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param IdentifyData The device¡¯s response to the ATA IDENTIFY_DEVICE command.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param IdentifyData The device¡¯s response to the ATA IDENTIFY_DEVICE command.
- @retval EFI_SUCCESS The information was accepted without any errors.
-
+ @retval EFI_SUCCESS The information was accepted without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid.
+ Or Device is invalid.
**/
typedef
@@ -343,19 +330,15 @@ EFI_STATUS /**
Disqualifies specific modes for an IDE device.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param BadModes The modes that the device does not support and that
- should be disqualified.
-
- @retval EFI_SUCCESS The modes were accepted without any errors.
-
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param BadModes The modes that the device does not support and that
+ should be disqualified.
+
+ @retval EFI_SUCCESS The modes were accepted without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid.
+ Or Device is invalid.
**/
typedef
@@ -370,20 +353,15 @@ EFI_STATUS /**
Returns the information about the optimum modes for the specified IDE device.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param SupportedModes The optimum modes for the device.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param SupportedModes The optimum modes for the device.
- @retval EFI_SUCCESS SupportedModes was returned.
-
+ @retval EFI_SUCCESS SupportedModes was returned.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid. Or SupportedModes is NULL.
-
- @retval EFI_NOT_READY Modes cannot be calculated due to a lack of data.
+ Or Device is invalid. Or SupportedModes is NULL.
+ @retval EFI_NOT_READY Modes cannot be calculated due to a lack of data.
**/
typedef
@@ -399,23 +377,17 @@ EFI_STATUS Commands the IDE controller driver to program the IDE controller hardware
so that the specified device can operate at the specified mode.
- @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
-
- @param Channel Zero-based channel number.
-
- @param Device Zero-based device number on the Channel.
-
- @param Modes The modes to set.
+ @param This Pointer to the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
+ @param Channel Zero-based channel number.
+ @param Device Zero-based device number on the Channel.
+ @param Modes The modes to set.
- @retval EFI_SUCCESS The command was accepted without any errors.
-
+ @retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_INVALID_PARAMETER Channel is invalid (Channel >= ChannelCount).
- Or Device is invalid.
-
- @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.
-
- @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.
- The IDE bus driver should not use this device.
+ Or Device is invalid.
+ @retval EFI_NOT_READY Modes cannot be set at this time due to lack of data.
+ @retval EFI_DEVICE_ERROR Modes cannot be set due to hardware failure.
+ The IDE bus driver should not use this device.
**/
typedef
diff --git a/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h b/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h index 03a5b2ec08..7357212664 100644 --- a/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h +++ b/MdePkg/Include/Protocol/IncompatiblePciDeviceSupport.h @@ -30,22 +30,16 @@ typedef struct _EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL EFI_INCOMPATIBLE_PC Returns a list of ACPI resource descriptors that detail the special
resource configuration requirements for an incompatible PCI device.
- @param This Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance.
-
- @param VendorID A unique ID to identify the manufacturer of the PCI device.
-
- @param DeviceID A unique ID to identify the particular PCI device.
-
- @param RevisionID A PCI device-specific revision identifier.
-
- @param SubsystemVendorId Specifies the subsystem vendor ID.
-
- @param SubsystemDeviceId Specifies the subsystem device ID.
-
- @param Configuration A list of ACPI resource descriptors that detail
- the configuration requirement.
-
- @retval EFI_SUCCESS The function always returns EFI_SUCCESS.
+ @param This Pointer to the EFI_INCOMPATIBLE_PCI_DEVICE_SUPPORT_PROTOCOL instance.
+ @param VendorID A unique ID to identify the manufacturer of the PCI device.
+ @param DeviceID A unique ID to identify the particular PCI device.
+ @param RevisionID A PCI device-specific revision identifier.
+ @param SubsystemVendorId Specifies the subsystem vendor ID.
+ @param SubsystemDeviceId Specifies the subsystem device ID.
+ @param Configuration A list of ACPI resource descriptors that detail
+ the configuration requirement.
+
+ @retval EFI_SUCCESS The function always returns EFI_SUCCESS.
**/
typedef
diff --git a/MdePkg/Include/Protocol/Legacy8259.h b/MdePkg/Include/Protocol/Legacy8259.h index c30a5e519c..6be8f89d5b 100644 --- a/MdePkg/Include/Protocol/Legacy8259.h +++ b/MdePkg/Include/Protocol/Legacy8259.h @@ -60,12 +60,12 @@ typedef enum { the legacy mode mask and the protected mode mask. The base address for the 8259
is different for legacy and protected mode, so two masks are required.
- @param This Protocol instance pointer.
- @param MasterBase The base vector for the Master PIC in the 8259 controller
- @param Slavebase The base vector for the Master PIC in the 8259 controller
+ @param This Protocol instance pointer.
+ @param MasterBase The base vector for the Master PIC in the 8259 controller
+ @param Slavebase The base vector for the Master PIC in the 8259 controller
- @retval EFI_SUCCESS The new bases were programmed
- @retval EFI_DEVICE_ERROR A device erro occured programming the vector bases
+ @retval EFI_SUCCESS The new bases were programmed
+ @retval EFI_DEVICE_ERROR A device erro occured programming the vector bases
**/
typedef
@@ -82,14 +82,14 @@ EFI_STATUS the legacy mode mask and the protected mode mask. The base address for the 8259
is different for legacy and protected mode, so two masks are required.
- @param This Protocol instance pointer.
- @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param This Protocol instance pointer.
+ @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @retval EFI_SUCCESS 8259 status returned
- @retval EFI_DEVICE_ERROR Error reading 8259
+ @retval EFI_SUCCESS 8259 status returned
+ @retval EFI_DEVICE_ERROR Error reading 8259
**/
typedef
@@ -109,14 +109,14 @@ EFI_STATUS is different for legacy and protected mode, so two masks are required.
Also set the edge/level masks.
- @param This Protocol instance pointer.
- @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
- @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param This Protocol instance pointer.
+ @param LegacyMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param LegacyEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedMask Bit 0 is Irq0 - Bit 15 is Irq15
+ @param ProtectedEdgeLevel Bit 0 is Irq0 - Bit 15 is Irq15
- @retval EFI_SUCCESS 8259 status returned
- @retval EFI_DEVICE_ERROR Error reading 8259
+ @retval EFI_SUCCESS 8259 status returned
+ @retval EFI_DEVICE_ERROR Error reading 8259
**/
typedef
@@ -139,13 +139,13 @@ EFI_STATUS mask for the new mode is Mask, or if Mask does not exist the previously saved
mask is used.
- @param This Protocol instance pointer.
- @param Mode Mode of operation. i.e. real mode or protected mode
- @param Mask Optional interupt mask for the new mode.
- @param EdgeLevel Optional trigger mask for the new mode.
+ @param This Protocol instance pointer.
+ @param Mode Mode of operation. i.e. real mode or protected mode
+ @param Mask Optional interupt mask for the new mode.
+ @param EdgeLevel Optional trigger mask for the new mode.
- @retval EFI_SUCCESS 8259 programmed
- @retval EFI_DEVICE_ERROR Error writting to 8259
+ @retval EFI_SUCCESS 8259 programmed
+ @retval EFI_DEVICE_ERROR Error writting to 8259
**/
typedef
@@ -161,12 +161,12 @@ EFI_STATUS /**
Convert from IRQ to processor interrupt vector number.
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
- @param Vector Processor vector number that matches Irq
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
+ @param Vector Processor vector number that matches Irq
- @retval EFI_SUCCESS The Vector matching Irq is returned
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS The Vector matching Irq is returned
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
@@ -181,12 +181,12 @@ EFI_STATUS /**
Enable Irq by unmasking interrupt in 8259
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
- @param LevelTriggered TRUE if level triggered. FALSE if edge triggered.
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
+ @param LevelTriggered TRUE if level triggered. FALSE if edge triggered.
- @retval EFI_SUCCESS Irq enabled on 8259
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS Irq enabled on 8259
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
@@ -201,11 +201,11 @@ EFI_STATUS /**
Disable Irq by masking interrupt in 8259
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
- @retval EFI_SUCCESS Irq disabled on 8259
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS Irq disabled on 8259
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
@@ -222,12 +222,12 @@ EFI_STATUS that is programmed into the Interrupt Line (from the PCI config space)
register.
- @param This Protocol instance pointer.
- @param PciHandle PCI function to return vector for
- @param Vector Vector for fucntion that matches
+ @param This Protocol instance pointer.
+ @param PciHandle PCI function to return vector for
+ @param Vector Vector for fucntion that matches
- @retval EFI_SUCCESS A valid Vector is returned
- @retval EFI_INVALID_PARAMETER PciHandle not valid
+ @retval EFI_SUCCESS A valid Vector is returned
+ @retval EFI_INVALID_PARAMETER PciHandle not valid
**/
typedef
@@ -242,11 +242,11 @@ EFI_STATUS /**
Send an EOI to 8259
- @param This Protocol instance pointer.
- @param Irq 8259 IRQ0 - IRQ15
+ @param This Protocol instance pointer.
+ @param Irq 8259 IRQ0 - IRQ15
- @retval EFI_SUCCESS EOI successfully sent to 8259
- @retval EFI_INVALID_PARAMETER Irq not valid
+ @retval EFI_SUCCESS EOI successfully sent to 8259
+ @retval EFI_INVALID_PARAMETER Irq not valid
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyBios.h b/MdePkg/Include/Protocol/LegacyBios.h index aa94cfb74f..c508009b9b 100644 --- a/MdePkg/Include/Protocol/LegacyBios.h +++ b/MdePkg/Include/Protocol/LegacyBios.h @@ -343,14 +343,14 @@ typedef struct { of BiosInt. Regs will contain the 16-bit register context on entry and
exit.
- @param This Protocol instance pointer.
- @param BiosInt Processor interrupt vector to invoke
- @param Reg Register contexted passed into (and returned) from thunk to
- 16-bit mode
+ @param This Protocol instance pointer.
+ @param BiosInt Processor interrupt vector to invoke
+ @param Reg Register contexted passed into (and returned) from thunk to
+ 16-bit mode
- @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
- See Regs for status.
- @retval TRUE There was a BIOS erro in the target code.
+ @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
+ See Regs for status.
+ @retval TRUE There was a BIOS erro in the target code.
**/
typedef
@@ -367,17 +367,17 @@ BOOLEAN 16-bit register context on entry and exit. Arguments can be passed on
the Stack argument
- @param This Protocol instance pointer.
- @param Segment Segemnt of 16-bit mode call
- @param Offset Offset of 16-bit mdoe call
- @param Reg Register contexted passed into (and returned) from thunk to
- 16-bit mode
- @param Stack Caller allocated stack used to pass arguments
- @param StackSize Size of Stack in bytes
+ @param This Protocol instance pointer.
+ @param Segment Segemnt of 16-bit mode call
+ @param Offset Offset of 16-bit mdoe call
+ @param Reg Register contexted passed into (and returned) from thunk to
+ 16-bit mode
+ @param Stack Caller allocated stack used to pass arguments
+ @param StackSize Size of Stack in bytes
- @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
- See Regs for status.
- @retval TRUE There was a BIOS erro in the target code.
+ @retval FALSE Thunk completed, and there were no BIOS errors in the target code.
+ See Regs for status.
+ @retval TRUE There was a BIOS erro in the target code.
**/
typedef
@@ -405,14 +405,14 @@ EFI_STATUS Test to see if a legacy PCI ROM exists for this device. Optionally return
the Legacy ROM instance for this PCI device.
- @param This Protocol instance pointer.
- @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
- @param RomImage Return the legacy PCI ROM for this device
- @param RomSize Size of ROM Image
- @param Flags Indicates if ROM found and if PC-AT.
+ @param This Protocol instance pointer.
+ @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded
+ @param RomImage Return the legacy PCI ROM for this device
+ @param RomSize Size of ROM Image
+ @param Flags Indicates if ROM found and if PC-AT.
- @retval EFI_SUCCESS Legacy Option ROM availible for this device
- @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
+ @retval EFI_SUCCESS Legacy Option ROM availible for this device
+ @retval EFI_UNSUPPORTED Legacy Option ROM not supported.
**/
)
@@ -423,23 +423,23 @@ EFI_STATUS about how many disks were added by the OPROM and the shadow address and
size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
- @param This Protocol instance pointer.
- @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.
- This value is NULL if RomImage is non-NULL. This is the normal
- case.
- @param RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is
- no hardware associated with the ROM and thus no PciHandle,
- otherwise is must be NULL.
- Example is PXE base code.
- @param Flags Return Status if ROM was found and if was Legacy OPROM.
- @param DiskStart Disk number of first device hooked by the ROM. If DiskStart
- is the same as DiskEnd no disked were hooked.
- @param DiskEnd Disk number of the last device hooked by the ROM.
- @param RomShadowAddress Shadow address of PC-AT ROM
- @param RomShadowSize Size of RomShadowAddress in bytes
-
- @retval EFI_SUCCESS Thunk completed, see Regs for status.
- @retval EFI_INVALID_PARAMETER PciHandle not found
+ @param This Protocol instance pointer.
+ @param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.
+ This value is NULL if RomImage is non-NULL. This is the normal
+ case.
+ @param RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is
+ no hardware associated with the ROM and thus no PciHandle,
+ otherwise is must be NULL.
+ Example is PXE base code.
+ @param Flags Return Status if ROM was found and if was Legacy OPROM.
+ @param DiskStart Disk number of first device hooked by the ROM. If DiskStart
+ is the same as DiskEnd no disked were hooked.
+ @param DiskEnd Disk number of the last device hooked by the ROM.
+ @param RomShadowAddress Shadow address of PC-AT ROM
+ @param RomShadowSize Size of RomShadowAddress in bytes
+
+ @retval EFI_SUCCESS Thunk completed, see Regs for status.
+ @retval EFI_INVALID_PARAMETER PciHandle not found
**/
typedef
@@ -460,24 +460,24 @@ EFI_STATUS Attempt to legacy boot the BootOption. If the EFI contexted has been
compromised this function will not return.
- @param This Protocol instance pointer.
- @param BootOption EFI Device Path from BootXXXX variable.
- @param LoadOptionSize Size of LoadOption in size.
- @param LoadOption LoadOption from BootXXXX variable
+ @param This Protocol instance pointer.
+ @param BootOption EFI Device Path from BootXXXX variable.
+ @param LoadOptionSize Size of LoadOption in size.
+ @param LoadOption LoadOption from BootXXXX variable
- @retval EFI_SUCCESS Removable media not present
+ @retval EFI_SUCCESS Removable media not present
**/
/**
Update BDA with current Scroll, Num & Cap lock LEDS
- @param This Protocol instance pointer.
- @param Leds Status of current Scroll, Num & Cap lock LEDS
- Bit 0 is Scroll Lock 0 = Not locked
- Bit 1 is Num Lock
- Bit 2 is Caps Lock
+ @param This Protocol instance pointer.
+ @param Leds Status of current Scroll, Num & Cap lock LEDS
+ Bit 0 is Scroll Lock 0 = Not locked
+ Bit 1 is Num Lock
+ Bit 2 is Caps Lock
- @retval EFI_SUCCESS Removable media not present
+ @retval EFI_SUCCESS Removable media not present
**/
typedef
@@ -500,13 +500,13 @@ EFI_STATUS /**
Retrieve legacy BBS info and assign boot priority.
- @param This Protocol instance pointer.
- @param HddCount Number of HDD_INFO structures
- @param HddInfo Onboard IDE controller information
- @param BbsCount Number of BBS_TABLE structures
- @param BbsTable List BBS entries
+ @param This Protocol instance pointer.
+ @param HddCount Number of HDD_INFO structures
+ @param HddInfo Onboard IDE controller information
+ @param BbsCount Number of BBS_TABLE structures
+ @param BbsTable List BBS entries
- @retval EFI_SUCCESS Tables returned
+ @retval EFI_SUCCESS Tables returned
**/
typedef
@@ -524,11 +524,11 @@ EFI_STATUS Assign drive number to legacy HDD drives prior to booting an EFI
aware OS so the OS can access drives without an EFI driver.
- @param This Protocol instance pointer.
- @param BbsCount Number of BBS_TABLE structures
- @param BbsTable List BBS entries
+ @param This Protocol instance pointer.
+ @param BbsCount Number of BBS_TABLE structures
+ @param BbsTable List BBS entries
- @retval EFI_SUCCESS Drive numbers assigned
+ @retval EFI_SUCCESS Drive numbers assigned
**/
typedef
@@ -544,14 +544,14 @@ EFI_STATUS To boot from an unconventional device like parties and/or execute
HDD diagnostics.
- @param This Protocol instance pointer.
- @param Attributes How to interpret the other input parameters
- @param BbsEntry The 0-based index into the BbsTable for the parent
- device.
- @param BeerData Pointer to the 128 bytes of ram BEER data.
- @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The
- caller must provide a pointer to the specific Service
- Area and not the start all Service Areas.
+ @param This Protocol instance pointer.
+ @param Attributes How to interpret the other input parameters
+ @param BbsEntry The 0-based index into the BbsTable for the parent
+ device.
+ @param BeerData Pointer to the 128 bytes of ram BEER data.
+ @param ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The
+ caller must provide a pointer to the specific Service
+ Area and not the start all Service Areas.
EFI_INVALID_PARAMETER if error. Does NOT return if no error.
@@ -573,7 +573,7 @@ EFI_STATUS drivers. If used externally then caller must re-connect EFI
drivers.
- @retval EFI_SUCCESS OPROMs shadowed
+ @retval EFI_SUCCESS OPROMs shadowed
**/
typedef
@@ -586,19 +586,18 @@ EFI_STATUS /**
Get a region from the LegacyBios for S3 usage.
- @param This Protocol instance pointer.
- @param LegacyMemorySize Size of required region
- @param Region Region to use.
- 00 = Either 0xE0000 or 0xF0000 block
- Bit0 = 1 0xF0000 block
- Bit1 = 1 0xE0000 block
- @param Alignment Address alignment. Bit mapped. First non-zero
- bit from right is alignment.
- @param LegacyMemoryAddress Region Assigned
+ @param This Protocol instance pointer.
+ @param LegacyMemorySize Size of required region
+ @param Region Region to use.
+ 00 = Either 0xE0000 or 0xF0000 block
+ Bit0 = 1 0xF0000 block
+ Bit1 = 1 0xE0000 block
+ @param Alignment Address alignment. Bit mapped. First non-zero
+ bit from right is alignment.
+ @param LegacyMemoryAddress Region Assigned
- @retval EFI_SUCCESS Region assigned
-
- @retval Other Region not assigned
+ @retval EFI_SUCCESS Region assigned
+ @retval Other Region not assigned
**/
typedef
@@ -615,15 +614,16 @@ EFI_STATUS /**
Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
- @param This Protocol instance pointer.
- @param LegacyMemorySize Size of data to copy
- @param LegacyMemoryAddress Legacy Region destination address
- Note: must be in region assigned by
- LegacyBiosGetLegacyRegion
- @param LegacyMemorySourceAddress Source of data
+ @param This Protocol instance pointer.
+ @param LegacyMemorySize Size of data to copy
+ @param LegacyMemoryAddress Legacy Region destination address
+ Note: must be in region assigned by
+ LegacyBiosGetLegacyRegion
+ @param LegacyMemorySourceAddress
+ Source of data
- @retval EFI_SUCCESS Region assigned
- @retval EFI_ACCESS_DENIED Destination outside assigned region
+ @retval EFI_SUCCESS Region assigned
+ @retval EFI_ACCESS_DENIED Destination outside assigned region
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyBiosPlatform.h b/MdePkg/Include/Protocol/LegacyBiosPlatform.h index 56d6724180..8a0604f5d0 100644 --- a/MdePkg/Include/Protocol/LegacyBiosPlatform.h +++ b/MdePkg/Include/Protocol/LegacyBiosPlatform.h @@ -79,24 +79,24 @@ typedef enum { /**
Finds the binary data or other platform information.
- @param This Protocol instance pointer.
- @param Mode Specifies what data to return
- @param Table Pointer to MP table.
- @param TableSize Size in bytes of table.
- @param Location Legacy region requested
- 0x00 = Any location
- Bit 0 = 0xF0000 region
- Bit 1 = 0xE0000 region
- Multiple bits can be set
- @param Alignment Address alignment for allocation.
- Bit mapped. First non-zero bit from right
- is alignment.
- @param LegacySegment Segment in LegacyBios where Table is stored
- @param LegacyOffset Offset in LegacyBios where Table is stored
-
- @retval EFI_SUCCESS Data was returned successfully.
- @retval EFI_UNSUPPORTED Mode is not supported on the platform.
- @retval EFI_NOT_FOUND Binary image or table not found.
+ @param This Protocol instance pointer.
+ @param Mode Specifies what data to return
+ @param Table Pointer to MP table.
+ @param TableSize Size in bytes of table.
+ @param Location Legacy region requested
+ 0x00 = Any location
+ Bit 0 = 0xF0000 region
+ Bit 1 = 0xE0000 region
+ Multiple bits can be set
+ @param Alignment Address alignment for allocation.
+ Bit mapped. First non-zero bit from right
+ is alignment.
+ @param LegacySegment Segment in LegacyBios where Table is stored
+ @param LegacyOffset Offset in LegacyBios where Table is stored
+
+ @retval EFI_SUCCESS Data was returned successfully.
+ @retval EFI_UNSUPPORTED Mode is not supported on the platform.
+ @retval EFI_NOT_FOUND Binary image or table not found.
**/
typedef
@@ -116,17 +116,17 @@ EFI_STATUS /**
Returns a buffer of handles for the requested sub-function.
- @param This Protocol instance pointer.
- @param Mode Specifies what handle to return.
- @param Type Type from Device Path for Handle to represent.
- @param HandleBuffer Handles of the device/controller in priority order
- with HandleBuffer[0] highest priority.
- @param HandleCount Number of handles in the buffer.
- @param AdditionalData Mode specific.
+ @param This Protocol instance pointer.
+ @param Mode Specifies what handle to return.
+ @param Type Type from Device Path for Handle to represent.
+ @param HandleBuffer Handles of the device/controller in priority order
+ with HandleBuffer[0] highest priority.
+ @param HandleCount Number of handles in the buffer.
+ @param AdditionalData Mode specific.
- @retval EFI_SUCCESS Handle is valid
- @retval EFI_UNSUPPORTED Mode is not supported on the platform.
- @retval EFI_NOT_FOUND Handle is not known
+ @retval EFI_SUCCESS Handle is valid
+ @retval EFI_UNSUPPORTED Mode is not supported on the platform.
+ @retval EFI_NOT_FOUND Handle is not known
**/
typedef
@@ -144,11 +144,11 @@ EFI_STATUS /**
Load and initialize the Legacy BIOS SMM handler.
- @param This Protocol instance pointer.
+ @param This Protocol instance pointer.
@param EfiToLegacy16BootTable Pointer to Legacy16 boot table.
- @retval EFI_SUCCESS SMM code loaded.
- @retval EFI_DEVICE_ERROR SMM code failed to load
+ @retval EFI_SUCCESS SMM code loaded.
+ @retval EFI_DEVICE_ERROR SMM code failed to load
**/
typedef
@@ -162,16 +162,16 @@ EFI_STATUS /**
Allows platform to perform any required action after a LegacyBios operation.
- @param This Protocol instance pointer.
- @param Mode Specifies what handle to return.
- @param Type Mode specific.
- @param DeviceHandle List of PCI devices in the system.
- @param ShadowAddress First free OpROM area, after other OpROMs have been dispatched.
- @param Compatibility16Table Pointer to Compatibility16Table.
- @param AdditionalData Mode specific Pointer to additional data returned ¨C mode specific.
+ @param This Protocol instance pointer.
+ @param Mode Specifies what handle to return.
+ @param Type Mode specific.
+ @param DeviceHandle List of PCI devices in the system.
+ @param ShadowAddress First free OpROM area, after other OpROMs have been dispatched.
+ @param Compatibility16Table Pointer to Compatibility16Table.
+ @param AdditionalData Mode specific Pointer to additional data returned ¨C mode specific.
- @retval EFI_SUCCESS RomImage is valid
- @retval EFI_UNSUPPORTED Mode is not supported on the platform.
+ @retval EFI_SUCCESS RomImage is valid
+ @retval EFI_UNSUPPORTED Mode is not supported on the platform.
**/
typedef
@@ -190,15 +190,15 @@ EFI_STATUS /**
Returns information associated with PCI IRQ routing.
- @param This Protocol instance pointer.
- @param RoutingTable Pointer to PCI IRQ Routing table.
- @param RoutingTableEntries Number of entries in table.
- @param LocalPirqTable $PIR table
- @param PirqTableSize $PIR table size
- @param LocalIrqPriorityTable List of interrupts in priority order to assign
- @param IrqPriorityTableEntries- Number of entries in priority table
+ @param This Protocol instance pointer.
+ @param RoutingTable Pointer to PCI IRQ Routing table.
+ @param RoutingTableEntries Number of entries in table.
+ @param LocalPirqTable $PIR table
+ @param PirqTableSize $PIR table size
+ @param LocalIrqPriorityTable List of interrupts in priority order to assign
+ @param IrqPriorityTableEntries Number of entries in priority table
- @retval EFI_SUCCESS Data was successfully returned.
+ @retval EFI_SUCCESS Data was successfully returned.
**/
typedef
@@ -217,15 +217,15 @@ EFI_STATUS /**
Translates the given PIRQ accounting for bridge
- @param This Protocol instance pointer.
- @param PciBus PCI bus number for this device.
- @param PciDevice PCI device number for this device.
- @param PciFunction PCI function number for this device.
- @param Pirq Input is PIRQ reported by device, output is true PIRQ.
- @param PciIrq The IRQ already assigned to the PIRQ or the IRQ to be
- assigned to the PIRQ.
+ @param This Protocol instance pointer.
+ @param PciBus PCI bus number for this device.
+ @param PciDevice PCI device number for this device.
+ @param PciFunction PCI function number for this device.
+ @param Pirq Input is PIRQ reported by device, output is true PIRQ.
+ @param PciIrq The IRQ already assigned to the PIRQ or the IRQ to be
+ assigned to the PIRQ.
- @retval EFI_SUCCESS The PIRQ was translated.
+ @retval EFI_SUCCESS The PIRQ was translated.
**/
typedef
@@ -244,14 +244,14 @@ EFI_STATUS Attempt to legacy boot the BootOption. If the EFI contexted has been
compromised this function will not return.
- @param This Protocol instance pointer.
- @param BbsDevicePath EFI Device Path from BootXXXX variable.
- @param BbsTable Internal BBS table.
- @param LoadOptionSize Size of LoadOption in size.
- @param LoadOption LoadOption from BootXXXX variable
+ @param This Protocol instance pointer.
+ @param BbsDevicePath EFI Device Path from BootXXXX variable.
+ @param BbsTable Internal BBS table.
+ @param LoadOptionSize Size of LoadOption in size.
+ @param LoadOption LoadOption from BootXXXX variable
@param EfiToLegacy16BootTable Pointer to BootTable structure
- @retval EFI_SUCCESS Ready to boot.
+ @retval EFI_SUCCESS Ready to boot.
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyInterrupt.h b/MdePkg/Include/Protocol/LegacyInterrupt.h index 54dc9aaa9b..9f69808bd7 100644 --- a/MdePkg/Include/Protocol/LegacyInterrupt.h +++ b/MdePkg/Include/Protocol/LegacyInterrupt.h @@ -31,10 +31,10 @@ typedef struct _EFI_LEGACY_INTERRUPT_PROTOCOL EFI_LEGACY_INTERRUPT_PROTOCOL; /**
Get the number of PIRQs this hardware supports.
- @param This Protocol instance pointer.
- @param NumberPirsq Number of PIRQs.
+ @param This Protocol instance pointer.
+ @param NumberPirsq Number of PIRQs.
- @retval EFI_SUCCESS Number of PIRQs returned.
+ @retval EFI_SUCCESS Number of PIRQs returned.
**/
typedef
@@ -47,12 +47,12 @@ EFI_STATUS /**
Gets the PCI location associated with this protocol.
- @param This Protocol instance pointer.
- @param Bus PCI Bus
- @param Device PCI Device
- @param Function PCI Function
+ @param This Protocol instance pointer.
+ @param Bus PCI Bus
+ @param Device PCI Device
+ @param Function PCI Function
- @retval EFI_SUCCESS Bus/Device/Function returned
+ @retval EFI_SUCCESS Bus/Device/Function returned
**/
typedef
@@ -67,12 +67,12 @@ EFI_STATUS /**
Read the PIRQ register and return the data
- @param This Protocol instance pointer.
- @param PirqNumber PIRQ register to read
- @param PirqData Data read
+ @param This Protocol instance pointer.
+ @param PirqNumber PIRQ register to read
+ @param PirqData Data read
- @retval EFI_SUCCESS Data was read
- @retval EFI_INVALID_PARAMETER Invalid PIRQ number
+ @retval EFI_SUCCESS Data was read
+ @retval EFI_INVALID_PARAMETER Invalid PIRQ number
**/
typedef
@@ -86,12 +86,12 @@ EFI_STATUS /**
Write the specified PIRQ register with the given data.
- @param This Protocol instance pointer.
- @param PirqNumber PIRQ register to read.
- @param PirqData Data written.
+ @param This Protocol instance pointer.
+ @param PirqNumber PIRQ register to read.
+ @param PirqData Data written.
- @retval EFI_SUCCESS Table pointer returned
- @retval EFI_INVALID_PARAMETER Invalid PIRQ number
+ @retval EFI_SUCCESS Table pointer returned
+ @retval EFI_INVALID_PARAMETER Invalid PIRQ number
**/
typedef
diff --git a/MdePkg/Include/Protocol/LegacyRegion.h b/MdePkg/Include/Protocol/LegacyRegion.h index db7d346186..9016ecbf32 100644 --- a/MdePkg/Include/Protocol/LegacyRegion.h +++ b/MdePkg/Include/Protocol/LegacyRegion.h @@ -31,15 +31,12 @@ typedef struct _EFI_LEGACY_REGION_PROTOCOL EFI_LEGACY_REGION_PROTOCOL; /**
Sets hardware to decode or not decode a region.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to decode.
-
- @param Length Size in bytes of the region.
-
- @param On Decode/nondecode flag.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to decode.
+ @param Length Size in bytes of the region.
+ @param On Decode/nondecode flag.
- @retval EFI_SUCCESS Decode range successfully changed.
+ @retval EFI_SUCCESS Decode range successfully changed.
**/
typedef
@@ -54,15 +51,12 @@ EFI_STATUS /**
Sets a region to read only.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to lock.
-
- @param Length Size in bytes of the region.
-
- @param Granularity Lock attribute affects this granularity in bytes.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to lock.
+ @param Length Size in bytes of the region.
+ @param Granularity Lock attribute affects this granularity in bytes.
- @retval EFI_SUCCESS The region was made read only.
+ @retval EFI_SUCCESS The region was made read only.
**/
typedef
@@ -78,15 +72,12 @@ EFI_STATUS Sets a region to read only and ensures that flash is locked from being
inadvertently modified.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to lock.
-
- @param Length Size in bytes of the region.
-
- @param Granularity Lock attribute affects this granularity in bytes.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to lock.
+ @param Length Size in bytes of the region.
+ @param Granularity Lock attribute affects this granularity in bytes.
- @retval EFI_SUCCESS The region was made read only and flash is locked.
+ @retval EFI_SUCCESS The region was made read only and flash is locked.
**/
typedef
@@ -101,15 +92,12 @@ EFI_STATUS /**
Sets a region to read-write.
- @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
-
- @param Start Start of region to lock.
-
- @param Length Size in bytes of the region.
-
- @param Granularity Lock attribute affects this granularity in bytes.
+ @param This Indicates the EFI_LEGACY_REGION_PROTOCOL instance
+ @param Start Start of region to lock.
+ @param Length Size in bytes of the region.
+ @param Granularity Lock attribute affects this granularity in bytes.
- @retval EFI_SUCCESS The region was successfully made read-write.
+ @retval EFI_SUCCESS The region was successfully made read-write.
**/
typedef
diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h index 840e04b4f3..cb2f3f5451 100644 --- a/MdePkg/Include/Protocol/Mtftp4.h +++ b/MdePkg/Include/Protocol/Mtftp4.h @@ -303,7 +303,6 @@ EFI_STATUS @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
@retval EFI_UNSUPPORTED One or more options in the OptionList are in the
unsupported list of structure EFI_MTFTP4_MODE_DATA.
-
@retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
@retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
RARP, etc.) has not finished yet.
@@ -395,9 +394,9 @@ EFI_STATUS /**
Sends a file to an MTFTPv4 server.
- @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
+ @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.
@param Token Pointer to the token structure to provide the parameters that are
- used in this operation.
+ used in this operation.
@retval EFI_SUCCESS The upload session has started.
@retval EFI_UNSUPPORTED The operation is not supported by this implementation.
diff --git a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h index 9d83c5aedb..147d07c8f7 100644 --- a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h +++ b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h @@ -128,13 +128,13 @@ typedef enum { /**
Enter a certain phase of the PCI enumeration process
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance
- @param Phase The phase during enumeration
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance
+ @param Phase The phase during enumeration
- @retval EFI_SUCCESS Success
- @retval EFI_OUT_OF_RESOURCES If SubmitResources ( ) could not allocate resources
- @retval EFI_NOT_READY This phase cannot be entered at this time
- @retval EFI_DEVICE_ERROR SetResources failed due to HW error.
+ @retval EFI_SUCCESS Success
+ @retval EFI_OUT_OF_RESOURCES If SubmitResources ( ) could not allocate resources
+ @retval EFI_NOT_READY This phase cannot be entered at this time
+ @retval EFI_DEVICE_ERROR SetResources failed due to HW error.
**/
typedef
@@ -149,14 +149,14 @@ EFI_STATUS Return the device handle of the next PCI root bridge that is associated with
this Host Bridge
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle Returns the device handle of the next PCI Root Bridge.
- On input, it holds the RootBridgeHandle returned by the most
- recent call to GetNextRootBridge().The handle for the first
- PCI Root Bridge is returned if RootBridgeHandle is NULL on input
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle Returns the device handle of the next PCI Root Bridge.
+ On input, it holds the RootBridgeHandle returned by the most
+ recent call to GetNextRootBridge().The handle for the first
+ PCI Root Bridge is returned if RootBridgeHandle is NULL on input
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
**/
typedef
@@ -170,14 +170,14 @@ EFI_STATUS /**
Returns the attributes of a PCI Root Bridge.
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The device handle of the PCI Root Bridge
- that the caller is interested in
- @param Attribute The pointer to attributes of the PCI Root Bridge
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The device handle of the PCI Root Bridge
+ that the caller is interested in
+ @param Attribute The pointer to attributes of the PCI Root Bridge
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_INVALID_PARAMETER Attributes is NULL
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_INVALID_PARAMETER Attributes is NULL
**/
typedef
@@ -193,14 +193,14 @@ EFI_STATUS This is the request from the PCI enumerator to set up
the specified PCI Root Bridge for bus enumeration process.
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge to be set up
- @param Configuration Pointer to the pointer to the PCI bus resource descriptor
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge to be set up
+ @param Configuration Pointer to the pointer to the PCI bus resource descriptor
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_DEVICE_ERROR Request failed due to hardware error
- @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_DEVICE_ERROR Request failed due to hardware error
+ @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
**/
typedef
@@ -216,20 +216,20 @@ EFI_STATUS This function programs the PCI Root Bridge hardware so that
it decodes the specified PCI bus range
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed
- @param Configuration The pointer to the PCI bus resource descriptor
-
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_INVALID_PARAMETER Configuration is NULL
- @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
- @retval EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor
- @retval EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration
- are invalid for this Root Bridge.
- @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor
- @retval EFI_DEVICE_ERROR Request failed due to hardware error
- @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed
+ @param Configuration The pointer to the PCI bus resource descriptor
+
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_INVALID_PARAMETER Configuration is NULL
+ @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
+ @retval EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor
+ @retval EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration
+ are invalid for this Root Bridge.
+ @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor
+ @retval EFI_DEVICE_ERROR Request failed due to hardware error
+ @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
**/
typedef
@@ -244,16 +244,16 @@ EFI_STATUS /**
Submits the I/O and memory resource requirements for the specified PCI Root Bridge
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge whose I/O and memory resource requirements
- are being submitted
- @param Configuration The pointer to the PCI I/O and PCI memory resource descriptor
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge whose I/O and memory resource requirements
+ are being submitted
+ @param Configuration The pointer to the PCI I/O and PCI memory resource descriptor
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_INVALID_PARAMETER Configuration is NULL
- @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
- @retval EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_INVALID_PARAMETER Configuration is NULL
+ @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor
+ @retval EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type
**/
typedef
@@ -269,15 +269,15 @@ EFI_STATUS This function returns the proposed resource settings for the specified
PCI Root Bridge
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge handle
- @param Configuration The pointer to the pointer to the PCI I/O
- and memory resource descriptor
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge handle
+ @param Configuration The pointer to the pointer to the PCI I/O
+ and memory resource descriptor
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_DEVICE_ERROR Request failed due to hardware error
- @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_DEVICE_ERROR Request failed due to hardware error
+ @retval EFI_OUT_OF_RESOURCES Request failed due to lack of resources
**/
typedef
@@ -294,14 +294,14 @@ EFI_STATUS This function is called for all the PCI controllers that the PCI
bus driver finds. Can be used to Preprogram the controller.
- @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
- @param RootBridgeHandle The PCI Root Bridge handle
- @param PciBusAddress Address of the controller on the PCI bus
- @param Phase The Phase during resource allocation
+ @param This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance
+ @param RootBridgeHandle The PCI Root Bridge handle
+ @param PciBusAddress Address of the controller on the PCI bus
+ @param Phase The Phase during resource allocation
- @retval EFI_SUCCESS Success
- @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
- @retval EFI_DEVICE_ERROR Device pre-initialization failed due to hardware error.
+ @retval EFI_SUCCESS Success
+ @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid
+ @retval EFI_DEVICE_ERROR Device pre-initialization failed due to hardware error.
**/
typedef
diff --git a/MdePkg/Include/Protocol/PciHotPlugInit.h b/MdePkg/Include/Protocol/PciHotPlugInit.h index b4b5a3d4b9..efd4c454a6 100644 --- a/MdePkg/Include/Protocol/PciHotPlugInit.h +++ b/MdePkg/Include/Protocol/PciHotPlugInit.h @@ -51,17 +51,13 @@ typedef enum{ Returns a list of root Hot Plug Controllers (HPCs) that require initialization
during the boot process.
- @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
-
- @param HpcCount The number of root HPCs that were returned.
-
- @param HpcList The list of root HPCs. HpcCount defines the number of
- elements in this list.
+ @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
+ @param HpcCount The number of root HPCs that were returned.
+ @param HpcList The list of root HPCs. HpcCount defines the number of
+ elements in this list.
- @retval EFI_SUCCESS HpcList was returned.
-
- @retval EFI_OUT_OF_RESOURCES HpcList was not returned due to insufficient resources.
-
+ @retval EFI_SUCCESS HpcList was returned.
+ @retval EFI_OUT_OF_RESOURCES HpcList was not returned due to insufficient resources.
@retval EFI_INVALID_PARAMETER HpcCount is NULL or HpcList is NULL.
**/
@@ -77,27 +73,20 @@ EFI_STATUS Initializes one root Hot Plug Controller (HPC). This process may causes
initialization of its subordinate buses.
- @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
-
- @param HpcDevicePath The device path to the HPC that is being initialized.
-
- @param HpcPciAddress The address of the HPC function on the PCI bus.
-
- @param Event The event that should be signaled when the HPC initialization
- is complete.
-
- @param HpcState The state of the HPC hardware.
-
- @retval EFI_SUCCESS If Event is NULL, the specific HPC was successfully
- initialized. If Event is not NULL, Event will be signaled at a later time
- when initialization is complete.
-
- @retval EFI_UNSUPPORTED This instance of EFI_PCI_HOT_PLUG_INIT_PROTOCOL
- does not support the specified HPC.
-
- @retval EFI_OUT_OF_RESOURCES Initialization failed due to insufficient
- resources.
-
+ @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
+ @param HpcDevicePath The device path to the HPC that is being initialized.
+ @param HpcPciAddress The address of the HPC function on the PCI bus.
+ @param Event The event that should be signaled when the HPC initialization
+ is complete.
+ @param HpcState The state of the HPC hardware.
+
+ @retval EFI_SUCCESS If Event is NULL, the specific HPC was successfully
+ initialized. If Event is not NULL, Event will be signaled at a later time
+ when initialization is complete.
+ @retval EFI_UNSUPPORTED This instance of EFI_PCI_HOT_PLUG_INIT_PROTOCOL
+ does not support the specified HPC.
+ @retval EFI_OUT_OF_RESOURCES Initialization failed due to insufficient
+ resources.
@retval EFI_INVALID_PARAMETER HpcState is NULL.
**/
@@ -115,31 +104,22 @@ EFI_STATUS Returns the resource padding that is required by the PCI bus that is controlled
by the specified Hot Plug Controller (HPC).
- @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
-
- @param HpcDevicePath The device path to the HPC.
-
- @param HpcPciAddress The address of the HPC function on the PCI bus.
-
- @param HpcState The state of the HPC hardware.
-
- @param Padding The amount of resource padding that is required by the
- PCI bus under the control of the specified HPC.
-
- @param Attributes Describes how padding is accounted for. The padding
- is returned in the form of ACPI 2.0 resource descriptors.
-
- @retval EFI_SUCCESS The resource padding was successfully returned.
-
- @retval EFI_UNSUPPORTED This instance of the EFI_PCI_HOT_PLUG_INIT_PROTOCOL
- does not support the specified HPC.
-
- @retval EFI_NOT_READY This function was called before HPC initialization is complete.
-
- @retval EFI_INVALID_PARAMETER HpcState or Padding or Attributes is NULL.
-
- @retval EFI_OUT_OF_RESOURCES ACPI 2.0 resource descriptors for Padding
- cannot be allocated due to insufficient resources.
+ @param This Pointer to the EFI_PCI_HOT_PLUG_INIT_PROTOCOL instance.
+ @param HpcDevicePath The device path to the HPC.
+ @param HpcPciAddress The address of the HPC function on the PCI bus.
+ @param HpcState The state of the HPC hardware.
+ @param Padding The amount of resource padding that is required by the
+ PCI bus under the control of the specified HPC.
+ @param Attributes Describes how padding is accounted for. The padding
+ is returned in the form of ACPI 2.0 resource descriptors.
+
+ @retval EFI_SUCCESS The resource padding was successfully returned.
+ @retval EFI_UNSUPPORTED This instance of the EFI_PCI_HOT_PLUG_INIT_PROTOCOL
+ does not support the specified HPC.
+ @retval EFI_NOT_READY This function was called before HPC initialization is complete.
+ @retval EFI_INVALID_PARAMETER HpcState or Padding or Attributes is NULL.
+ @retval EFI_OUT_OF_RESOURCES ACPI 2.0 resource descriptors for Padding
+ cannot be allocated due to insufficient resources.
**/
typedef
diff --git a/MdePkg/Include/Protocol/PciPlatform.h b/MdePkg/Include/Protocol/PciPlatform.h index 5b0add1ea7..c9491097e3 100644 --- a/MdePkg/Include/Protocol/PciPlatform.h +++ b/MdePkg/Include/Protocol/PciPlatform.h @@ -60,12 +60,12 @@ typedef enum { it needs to handle those errors on its own because there is no way to surface any
errors to the caller.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param HostBridge The handle of the host bridge controller.
- @param Phase The phase of the PCI bus enumeration.
- @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param HostBridge The handle of the host bridge controller.
+ @param Phase The phase of the PCI bus enumeration.
+ @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
- @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_SUCCESS The function completed successfully.
**/
typedef
@@ -92,14 +92,14 @@ EFI_STATUS needs to handle those errors on its own because there is no way to surface any errors to
the caller.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param HostBridge The associated PCI host bridge handle.
- @param RootBridge The associated PCI root bridge handle.
- @param PciAddress The address of the PCI device on the PCI bus.
- @param Phase The phase of the PCI controller enumeration.
- @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param HostBridge The associated PCI host bridge handle.
+ @param RootBridge The associated PCI root bridge handle.
+ @param PciAddress The address of the PCI device on the PCI bus.
+ @param Phase The phase of the PCI controller enumeration.
+ @param ChipsetPhase Defines the execution phase of the PCI chipset driver.
- @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_SUCCESS The function completed successfully.
**/
typedef
@@ -120,11 +120,11 @@ EFI_STATUS enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol
driver can call this member function to retrieve the policy.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param PciPolicy The platform policy with respect to VGA and ISA aliasing.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param PciPolicy The platform policy with respect to VGA and ISA aliasing.
- @retval EFI_SUCCESS The function completed successfully.
- @retval EFI_INVALID_PARAMETER PciPolicy is NULL.
+ @retval EFI_SUCCESS The function completed successfully.
+ @retval EFI_INVALID_PARAMETER PciPolicy is NULL.
**/
typedef
@@ -147,20 +147,20 @@ EFI_STATUS scanning the ROM that is attached to any controller, which allows a platform to specify a ROM
image that is different from the ROM image on a PCI card.
- @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
- @param PciHandle The handle of the PCI device.
- @param RomImage If the call succeeds, the pointer to the pointer to the option ROM image.
- Otherwise, this field is undefined. The memory for RomImage is allocated
- by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().
- It is the caller's responsibility to free the memory using the EFI Boot Service
- FreePool(), when the caller is done with the option ROM.
- @param RomSize If the call succeeds, a pointer to the size of the option ROM size. Otherwise,
- this field is undefined.
-
- @retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.
- @retval EFI_NOT_FOUND No option ROM was available for this device.
- @retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.
- @retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.
+ @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.
+ @param PciHandle The handle of the PCI device.
+ @param RomImage If the call succeeds, the pointer to the pointer to the option ROM image.
+ Otherwise, this field is undefined. The memory for RomImage is allocated
+ by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().
+ It is the caller's responsibility to free the memory using the EFI Boot Service
+ FreePool(), when the caller is done with the option ROM.
+ @param RomSize If the call succeeds, a pointer to the size of the option ROM size. Otherwise,
+ this field is undefined.
+
+ @retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.
+ @retval EFI_NOT_FOUND No option ROM was available for this device.
+ @retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.
+ @retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.
**/
typedef
diff --git a/MdePkg/Include/Protocol/ScsiPassThruExt.h b/MdePkg/Include/Protocol/ScsiPassThruExt.h index b522792848..a59b61ec17 100644 --- a/MdePkg/Include/Protocol/ScsiPassThruExt.h +++ b/MdePkg/Include/Protocol/ScsiPassThruExt.h @@ -185,7 +185,6 @@ EFI_STATUS FC target.
@param Lun The LUN of the SCSI device for which a device path node is to be
allocated and built.
-
@param DevicePath A pointer to a single device path node that describes the SCSI device
specified by Target and Lun. This function is responsible for
allocating the buffer DevicePath with the boot service
diff --git a/MdePkg/Include/Protocol/SectionExtraction.h b/MdePkg/Include/Protocol/SectionExtraction.h index 9200f8a444..adc03f5985 100644 --- a/MdePkg/Include/Protocol/SectionExtraction.h +++ b/MdePkg/Include/Protocol/SectionExtraction.h @@ -41,17 +41,17 @@ typedef struct _EFI_SECTION_EXTRACTION_PROTOCOL EFI_SECTION_EXTRACTION_PROTOCOL; /**
Creates and returns a new section stream handle to represent the new section stream.
- @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
- @param SectionStreamLength Size in bytes of the section stream.
- @param SectionStream Buffer containing the new section stream.
- @param SectionStreamHandle A pointer to a caller-allocated UINTN that,
+ @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
+ @param SectionStreamLength Size in bytes of the section stream.
+ @param SectionStream Buffer containing the new section stream.
+ @param SectionStreamHandle A pointer to a caller-allocated UINTN that,
on output, contains the new section stream handle.
- @retval EFI_SUCCESS The SectionStream was successfully processed and
- the section stream handle was returned.
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
- process the request.
- @retval EFI_INVALID_PARAMETER The section stream may be corrupt or the value
+ @retval EFI_SUCCESS The SectionStream was successfully processed and
+ the section stream handle was returned.
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to
+ process the request.
+ @retval EFI_INVALID_PARAMETER The section stream may be corrupt or the value
of SectionStreamLength may be incorrect.
**/
@@ -67,36 +67,36 @@ EFI_STATUS /**
Reads and returns a single section from a section stream.
- @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
- @param SectionStreamHandle Indicates from which section stream to read.
- @param SectionType Pointer to an EFI_SECTION_TYPE.
- @param SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==
- EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID
- to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then
- SectionDefinitionGuid is unused and is ignored.
- @param SectionInstance Indicates which instance of the requested section
- type to return when SectionType is not NULL.
+ @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
+ @param SectionStreamHandle Indicates from which section stream to read.
+ @param SectionType Pointer to an EFI_SECTION_TYPE.
+ @param SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==
+ EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID
+ to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then
+ SectionDefinitionGuid is unused and is ignored.
+ @param SectionInstance Indicates which instance of the requested section
+ type to return when SectionType is not NULL.
@param SectionStreamHandle A pointer to a caller-allocated UINTN that, on output,
- contains the new section stream handle.
- @param Buffer Pointer to a pointer to a buffer in which the section
- contents are returned.
- @param BufferSize Pointer to a caller-allocated UINTN.
- @param AuthenticationStatus Pointer to a caller-allocated UINT32 in
+ contains the new section stream handle.
+ @param Buffer Pointer to a pointer to a buffer in which the section
+ contents are returned.
+ @param BufferSize Pointer to a caller-allocated UINTN.
+ @param AuthenticationStatus Pointer to a caller-allocated UINT32 in
which any meta-data from encapsulation GUID-defined sections is returned.
- @retval EFI_SUCCESS The SectionStream was successfully processed and
- the section contents were returned in Buffer.
- @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
- the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,
- but there was no corresponding GUIDed Section Extraction Protocol in
- the handle database.
- @retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream,
+ @retval EFI_SUCCESS The SectionStream was successfully processed and
+ the section contents were returned in Buffer.
+ @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in
+ the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,
+ but there was no corresponding GUIDed Section Extraction Protocol in
+ the handle database.
+ @retval EFI_NOT_FOUND An error was encountered when parsing the SectionStream,
which indicates that the SectionStream is not correctly formatted.
- Or The requested section does not exist.
- @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
- the request.
- @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
- @retval EFI_BUFFER_TOO_SMALL The size of the input buffer is insufficient to
+ Or The requested section does not exist.
+ @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
+ the request.
+ @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
+ @retval EFI_BUFFER_TOO_SMALL The size of the input buffer is insufficient to
contain the requested section.
**/
@@ -116,12 +116,10 @@ EFI_STATUS /**
Deletes a section stream handle and returns all associated resources to the system.
- @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
+ @param This Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.
@param SectionStreamHandle Indicates the section stream to close.
-
- @retval EFI_SUCCESS The SectionStream was successfully processed and
+ @retval EFI_SUCCESS The SectionStream was successfully processed and
the section stream handle was returned.
-
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
**/
diff --git a/MdePkg/Include/Protocol/Smbus.h b/MdePkg/Include/Protocol/Smbus.h index 8fe37b17d3..1150933541 100644 --- a/MdePkg/Include/Protocol/Smbus.h +++ b/MdePkg/Include/Protocol/Smbus.h @@ -31,45 +31,32 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; /**
Executes an SMBus operation to an SMBus controller.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param SlaveAddress The SMBus slave address of the device with which to communicate.
-
- @param Command This command is transmitted by the SMBus host
- controller to the SMBus slave device and the interpretation is
- SMBus slave device specific.
-
- @param Operation Signifies which particular SMBus hardware protocol
- instance that it will use to execute the SMBus transactions.
-
- @param PecCheck Defines if Packet Error Code (PEC) checking is required
- for this operation.
-
- @param Length Signifies the number of bytes that this operation will do.
-
- @param Buffer Contains the value of data to execute to the SMBus slave device.
-
- @retval EFI_SUCCESS The last data that was returned from the access
- matched the poll exit criteria.
-
- @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
-
- @retval EFI_TIMEOUT Timeout expired before the operation was completed.
- Timeout is determined by the SMBus host controller device.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_DEVICE_ERROR The request was not completed because
- a failure reflected in the Host Status Register bit.
-
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param SlaveAddress The SMBus slave address of the device with which to communicate.
+ @param Command This command is transmitted by the SMBus host
+ controller to the SMBus slave device and the interpretation is
+ SMBus slave device specific.
+ @param Operation Signifies which particular SMBus hardware protocol
+ instance that it will use to execute the SMBus transactions.
+ @param PecCheck Defines if Packet Error Code (PEC) checking is required
+ for this operation.
+ @param Length Signifies the number of bytes that this operation will do.
+ @param Buffer Contains the value of data to execute to the SMBus slave device.
+
+ @retval EFI_SUCCESS The last data that was returned from the access
+ matched the poll exit criteria.
+ @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
+ @retval EFI_TIMEOUT Timeout expired before the operation was completed.
+ Timeout is determined by the SMBus host controller device.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_DEVICE_ERROR The request was not completed because
+ a failure reflected in the Host Status Register bit.
@retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.
- Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
- EfiSmbusQuickWrite. Length is outside the range of valid values.
-
- @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
-
- @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
+ Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
+ EfiSmbusQuickWrite. Length is outside the range of valid values.
+ @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
+ @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
**/
typedef
@@ -98,11 +85,10 @@ typedef struct { /**
CallBack function can be registered in EFI_SMBUS_HC_PROTOCOL_NOTIFY.
- @param SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
-
- @param Data Data of the SMBus host notify command that
- the caller wants to be called.
+ @param SlaveAddress The SMBUS hardware address to which the SMBUS
+ device is preassigned or allocated.
+ @param Data Data of the SMBus host notify command that
+ the caller wants to be called.
@return Status Code
@@ -118,29 +104,22 @@ EFI_STATUS Sets the SMBus slave device addresses for the device with a given unique ID
or enumerates the entire bus.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param ArpAll A Boolean expression that indicates if the host drivers need
- to enumerate all the devices or enumerate only the device that is identified
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
- If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
- will be at SlaveAddress.
-
- @param SmbusUdid The Unique Device Identifier (UDID) that is associated
- with this device.
-
- @param SlaveAddress The SMBus slave address that is associated with an SMBus UDID.
-
- @retval EFI_SUCCESS The SMBus slave device address was set.
-
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param ArpAll A Boolean expression that indicates if the host drivers need
+ to enumerate all the devices or enumerate only the device that is identified
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
+ If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
+ will be at SlaveAddress.
+ @param SmbusUdid The Unique Device Identifier (UDID) that is associated
+ with this device.
+ @param SlaveAddress The SMBus slave address that is associated with an SMBus UDID.
+
+ @retval EFI_SUCCESS The SMBus slave device address was set.
@retval EFI_INVALID_PARAMETER SlaveAddress is NULL.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_TIMEOUT The SMBus slave device did not respond.
-
- @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_TIMEOUT The SMBus slave device did not respond.
+ @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
**/
typedef
@@ -161,14 +140,12 @@ typedef struct { The GetArpMap() function returns the mapping of all the SMBus devices
that are enumerated by the SMBus host driver.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param Length Size of the buffer that contains the SMBus device map.
-
- @param SmbusDeviceMap The pointer to the device map as enumerated
- by the SMBus controller driver.
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param Length Size of the buffer that contains the SMBus device map.
+ @param SmbusDeviceMap The pointer to the device map as enumerated
+ by the SMBus controller driver.
- @retval EFI_SUCCESS The device map was returned correctly in the buffer.
+ @retval EFI_SUCCESS The device map was returned correctly in the buffer.
**/
typedef
@@ -183,18 +160,15 @@ EFI_STATUS The Notify() function registers all the callback functions to allow the
bus driver to call these functions when the SlaveAddress/Data pair happens.
- @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
- @param SlaveAddress Address that the host controller detects as
- sending a message and calls all the registered functions.
-
- @param Data Data that the host controller detects as sending a message
- and calls all the registered functions.
-
- @param NotifyFunction The function to call when the bus driver
- detects the SlaveAddress and Data pair.
-
- @retval EFI_SUCCESS NotifyFunction was registered.
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ @param SlaveAddress Address that the host controller detects as
+ sending a message and calls all the registered functions.
+ @param Data Data that the host controller detects as sending a message
+ and calls all the registered functions.
+ @param NotifyFunction The function to call when the bus driver
+ detects the SlaveAddress and Data pair.
+
+ @retval EFI_SUCCESS NotifyFunction was registered.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmAccess.h b/MdePkg/Include/Protocol/SmmAccess.h index f405c8f13f..3f17787539 100644 --- a/MdePkg/Include/Protocol/SmmAccess.h +++ b/MdePkg/Include/Protocol/SmmAccess.h @@ -46,16 +46,13 @@ typedef struct _EFI_SMM_ACCESS_PROTOCOL EFI_SMM_ACCESS_PROTOCOL; /**
Opens the SMRAM area to be accessible by a boot-service driver.
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param DescriptorIndex Indicates that the driver wishes to open
- the memory tagged by this index.
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param DescriptorIndex Indicates that the driver wishes to open
+ the memory tagged by this index.
- @retval EFI_SUCCESS The operation was successful.
-
+ @retval EFI_SUCCESS The operation was successful.
@retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -68,18 +65,14 @@ EFI_STATUS /**
Inhibits access to the SMRAM.
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param DescriptorIndex Indicates that the driver wishes to open
- the memory tagged by this index.
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param DescriptorIndex Indicates that the driver wishes to open
+ the memory tagged by this index.
- @retval EFI_SUCCESS The operation was successful.
-
- @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
-
+ @retval EFI_SUCCESS The operation was successful.
+ @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
@retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -91,19 +84,14 @@ EFI_STATUS /**
Inhibits access to the SMRAM.
-
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param DescriptorIndex Indicates that the driver wishes to open
- the memory tagged by this index.
-
- @retval EFI_SUCCESS The operation was successful.
-
- @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
-
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param DescriptorIndex Indicates that the driver wishes to open
+ the memory tagged by this index.
+
+ @retval EFI_SUCCESS The operation was successful.
+ @retval EFI_DEVICE_ERROR The given DescriptorIndex is not open.
@retval EFI_INVALID_PARAMETER The given DescriptorIndex is not supported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -116,15 +104,12 @@ EFI_STATUS /**
Queries the memory controller for the possible regions that will support SMRAM.
- @param This The EFI_SMM_ACCESS_PROTOCOL instance.
-
- @param SmramMapSize A pointer to the size, in bytes, of the SmramMemoryMap buffer.
-
- @param SmramMap A pointer to the buffer in which firmware places the current memory map.
+ @param This The EFI_SMM_ACCESS_PROTOCOL instance.
+ @param SmramMapSize A pointer to the size, in bytes, of the SmramMemoryMap buffer.
+ @param SmramMap A pointer to the buffer in which firmware places the current memory map.
- @retval EFI_SUCCESS The chipset supported the given resource.
-
- @retval EFI_BUFFER_TOO_SMALL The SmramMap parameter was too small.
+ @retval EFI_SUCCESS The chipset supported the given resource.
+ @retval EFI_BUFFER_TOO_SMALL The SmramMap parameter was too small.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmBase.h b/MdePkg/Include/Protocol/SmmBase.h index 6dd3a5dd57..664e34c9e6 100644 --- a/MdePkg/Include/Protocol/SmmBase.h +++ b/MdePkg/Include/Protocol/SmmBase.h @@ -40,14 +40,12 @@ typedef struct _EFI_SMM_BASE_PROTOCOL EFI_SMM_BASE_PROTOCOL; /**
Entry Point to Callback service
- @param SmmImageHandle A handle allocated by the SMM infrastructure code
- to uniquely designate a specific DXE SMM driver.
-
- @param CommunicationBuffer A pointer to a collection of data in memory
- that will be conveyed from a non-SMM environment into an SMM environment.
- The buffer must be contiguous, physically mapped, and be a physical address.
-
- @param SourceSize The size of the CommunicationBuffer.
+ @param SmmImageHandle A handle allocated by the SMM infrastructure code
+ to uniquely designate a specific DXE SMM driver.
+ @param CommunicationBuffer A pointer to a collection of data in memory
+ that will be conveyed from a non-SMM environment into an SMM environment.
+ The buffer must be contiguous, physically mapped, and be a physical address.
+ @param SourceSize The size of the CommunicationBuffer.
@return Status code
@@ -67,20 +65,20 @@ EFI_STATUS Register a given driver into SMRAM.This is the equivalent of performing
the LoadImage/StartImage into System Management Mode.
- @param This Protocol instance pointer.
- @param FilePath Location of the image to be installed as the handler.
- @param SourceBuffer Optional source buffer in case of the image file
- being in memory.
- @param SourceSize Size of the source image file, if in memory.
- @param ImageHandle Pointer to the handle that reflects the driver
- loaded into SMM.
- @param LegacyIA32Binary The binary image to load is legacy 16 bit code.
-
- @retval EFI_SUCCESS The operation was successful.
- @retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler
- @retval EFI_UNSUPPORTED This platform does not support 16-bit handlers.
- @retval EFI_UNSUPPORTED In runtime.
- @retval EFI_INVALID_PARAMETER The handlers was not the correct image type
+ @param This Protocol instance pointer.
+ @param FilePath Location of the image to be installed as the handler.
+ @param SourceBuffer Optional source buffer in case of the image file
+ being in memory.
+ @param SourceSize Size of the source image file, if in memory.
+ @param ImageHandle Pointer to the handle that reflects the driver
+ loaded into SMM.
+ @param LegacyIA32Binary The binary image to load is legacy 16 bit code.
+
+ @retval EFI_SUCCESS The operation was successful.
+ @retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler
+ @retval EFI_UNSUPPORTED This platform does not support 16-bit handlers.
+ @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_INVALID_PARAMETER The handlers was not the correct image type
**/
typedef
@@ -99,13 +97,13 @@ EFI_STATUS Remove a given driver SMRAM. This is the equivalent of performing
the UnloadImage System Management Mode.
- @param This Protocol instance pointer.
- @param ImageHandle Pointer to the handle that reflects the driver
- loaded into SMM.
+ @param This Protocol instance pointer.
+ @param ImageHandle Pointer to the handle that reflects the driver
+ loaded into SMM.
- @retval EFI_SUCCESS The operation was successful
- @retval EFI_INVALID_PARAMETER The handler did not exist
- @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_SUCCESS The operation was successful
+ @retval EFI_INVALID_PARAMETER The handler did not exist
+ @retval EFI_UNSUPPORTED In runtime.
**/
typedef
@@ -122,14 +120,14 @@ EFI_STATUS EFI service. The BASE protocol driver is responsible for doing
any of the copies such that the data lives in boot-service accessible RAM.
- @param This Protocol instance pointer.
- @param ImageHandle Pointer to the handle that reflects the driver
- loaded into SMM.
- @param CommunicationBuffer Pointer to the buffer to convey into SMRAM.
- @param SourceSize Size of the contents of buffer..
+ @param This Protocol instance pointer.
+ @param ImageHandle Pointer to the handle that reflects the driver
+ loaded into SMM.
+ @param CommunicationBuffer Pointer to the buffer to convey into SMRAM.
+ @param SourceSize Size of the contents of buffer..
- @retval EFI_SUCCESS The message was successfully posted
- @retval EFI_INVALID_PARAMETER The buffer was NULL
+ @retval EFI_SUCCESS The message was successfully posted
+ @retval EFI_INVALID_PARAMETER The buffer was NULL
**/
typedef
@@ -146,21 +144,21 @@ EFI_STATUS Register a callback to execute within SMM.
This allows receipt of messages created with the Boot Service COMMUNICATE.
- @param This Protocol instance pointer.
- @param CallbackAddress Address of the callback service
- @param MakeFirst If present, will stipulate that the handler is posted
- to be the first module executed in the dispatch table.
- @param MakeLast If present, will stipulate that the handler is posted
- to be last executed in the dispatch table.
- @param FloatingPointSave This is an optional parameter which informs the
- EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
- the floating point register state. If any of the handlers
- require this, then the state will be saved for all of the handlers.
-
- @retval EFI_SUCCESS The operation was successful
- @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue
- @retval EFI_UNSUPPORTED In runtime.
- @retval EFI_UNSUPPORTED Not in SMM.
+ @param This Protocol instance pointer.
+ @param CallbackAddress Address of the callback service
+ @param MakeFirst If present, will stipulate that the handler is posted
+ to be the first module executed in the dispatch table.
+ @param MakeLast If present, will stipulate that the handler is posted
+ to be last executed in the dispatch table.
+ @param FloatingPointSave This is an optional parameter which informs the
+ EFI_SMM_ACCESS_PROTOCOL Driver core if it needs to save
+ the floating point register state. If any of the handlers
+ require this, then the state will be saved for all of the handlers.
+
+ @retval EFI_SUCCESS The operation was successful
+ @retval EFI_OUT_OF_RESOURCES Not enough space in the dispatch queue
+ @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_UNSUPPORTED Not in SMM.
**/
typedef
@@ -180,18 +178,18 @@ EFI_STATUS by Buffer. This function allocates pages from EFI SMRAM Memory as needed to grow the
requested pool type. All allocations are eight-byte aligned.
- @param This Protocol instance pointer.
- @param PoolType The type of pool to allocate.
- The only supported type is EfiRuntimeServicesData;
- the interface will internally map this runtime request to SMRAM.
- @param Size The number of bytes to allocate from the pool.
- @param Buffer A pointer to a pointer to the allocated buffer if the call
- succeeds; undefined otherwise.
+ @param This Protocol instance pointer.
+ @param PoolType The type of pool to allocate.
+ The only supported type is EfiRuntimeServicesData;
+ the interface will internally map this runtime request to SMRAM.
+ @param Size The number of bytes to allocate from the pool.
+ @param Buffer A pointer to a pointer to the allocated buffer if the call
+ succeeds; undefined otherwise.
- @retval EFI_SUCCESS The requested number of bytes was allocated.
- @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
- @retval EFI_INVALID_PARAMETER PoolType was invalid.
- @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_SUCCESS The requested number of bytes was allocated.
+ @retval EFI_OUT_OF_RESOURCES The pool requested could not be allocated.
+ @retval EFI_INVALID_PARAMETER PoolType was invalid.
+ @retval EFI_UNSUPPORTED In runtime.
**/
typedef
@@ -209,12 +207,12 @@ EFI_STATUS On return, the memory's type is EFI SMRAM Memory. The Buffer that is freed must
have been allocated by SmmAllocatePool().
- @param This Protocol instance pointer.
- @param Buffer Pointer to the buffer allocation.
+ @param This Protocol instance pointer.
+ @param Buffer Pointer to the buffer allocation.
- @retval EFI_SUCCESS The memory was returned to the system.
- @retval EFI_INVALID_PARAMETER Buffer was invalid.
- @retval EFI_UNSUPPORTED In runtime.
+ @retval EFI_SUCCESS The memory was returned to the system.
+ @retval EFI_INVALID_PARAMETER Buffer was invalid.
+ @retval EFI_UNSUPPORTED In runtime.
**/
typedef
@@ -228,10 +226,10 @@ EFI_STATUS /**
This routine tells caller if execution context is SMM or not.
- @param This Protocol instance pointer.
- @param InSmm Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family.
+ @param This Protocol instance pointer.
+ @param InSmm Whether the caller is inside SMM for IA-32 or servicing a PMI for the Itanium processor family.
- @retval EFI_SUCCESS The operation was successful
+ @retval EFI_SUCCESS The operation was successful
**/
typedef
@@ -248,12 +246,12 @@ EFI_STATUS location of the SMST in its entry point and then cache it in some driver
global variable so that the SMST can be invoked in subsequent callbacks.
- @param This Protocol instance pointer.
- @param Smst Pointer to the SMST.
+ @param This Protocol instance pointer.
+ @param Smst Pointer to the SMST.
- @retval EFI_SUCCESS The operation was successful
- @retval EFI_INVALID_PARAMETER Smst was invalid.
- @retval EFI_UNSUPPORTED Not in SMM.
+ @retval EFI_SUCCESS The operation was successful
+ @retval EFI_INVALID_PARAMETER Smst was invalid.
+ @retval EFI_UNSUPPORTED Not in SMM.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmControl.h b/MdePkg/Include/Protocol/SmmControl.h index 3bcd0f772e..a83d25bf85 100644 --- a/MdePkg/Include/Protocol/SmmControl.h +++ b/MdePkg/Include/Protocol/SmmControl.h @@ -41,24 +41,17 @@ typedef struct { /**
Invokes SMI activation from either the preboot or runtime environment.
- @param This The EFI_SMM_CONTROL_PROTOCOL instance.
-
- @param ArgumentBuffer Optional sized data to pass into the protocol activation.
-
- @param ArgumentBufferSize Optional size of the data.
-
- @param Periodic Optional mechanism to engender a periodic stream.
-
- @param ActivationInterval Optional parameter to repeat at this period one
- time or, if the Periodic Boolean is set, periodically.
-
- @retval EFI_SUCCESS The SMI/PMI has been engendered.
-
- @retval EFI_DEVICE_ERROR The timing is unsupported.
-
- @retval EFI_INVALID_PARAMETER The activation period is unsupported.
-
- @retval EFI_NOT_STARTED The SMM base service has not been initialized.
+ @param This The EFI_SMM_CONTROL_PROTOCOL instance.
+ @param ArgumentBuffer Optional sized data to pass into the protocol activation.
+ @param ArgumentBufferSize Optional size of the data.
+ @param Periodic Optional mechanism to engender a periodic stream.
+ @param ActivationInterval Optional parameter to repeat at this period one
+ time or, if the Periodic Boolean is set, periodically.
+
+ @retval EFI_SUCCESS The SMI/PMI has been engendered.
+ @retval EFI_DEVICE_ERROR The timing is unsupported.
+ @retval EFI_INVALID_PARAMETER The activation period is unsupported.
+ @retval EFI_NOT_STARTED The SMM base service has not been initialized.
**/
typedef
@@ -74,15 +67,12 @@ EFI_STATUS /**
Clears any system state that was created in response to the Active call.
- @param This The EFI_SMM_CONTROL_PROTOCOL instance.
-
- @param Periodic Optional parameter to repeat at this period one time
+ @param This The EFI_SMM_CONTROL_PROTOCOL instance.
+ @param Periodic Optional parameter to repeat at this period one time
- @retval EFI_SUCCESS The SMI/PMI has been engendered.
-
- @retval EFI_DEVICE_ERROR The source could not be cleared.
-
- @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.
+ @retval EFI_SUCCESS The SMI/PMI has been engendered.
+ @retval EFI_DEVICE_ERROR The source could not be cleared.
+ @retval EFI_INVALID_PARAMETER The service did not support the Periodic input argument.
**/
typedef
@@ -95,11 +85,10 @@ EFI_STATUS /**
Provides information on the source register used to generate the SMI.
- @param This The EFI_SMM_CONTROL_PROTOCOL instance.
-
- @param SmiRegister Pointer to the SMI register description structure
+ @param This The EFI_SMM_CONTROL_PROTOCOL instance.
+ @param SmiRegister Pointer to the SMI register description structure
- @retval EFI_SUCCESS The register structure has been returned.
+ @retval EFI_SUCCESS The register structure has been returned.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmGpiDispatch.h b/MdePkg/Include/Protocol/SmmGpiDispatch.h index b472e92c5a..8173fe540f 100644 --- a/MdePkg/Include/Protocol/SmmGpiDispatch.h +++ b/MdePkg/Include/Protocol/SmmGpiDispatch.h @@ -52,10 +52,10 @@ typedef struct { /**
Dispatch function for a GPI SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in by the dispatching driver prior to
+ invoking this dispatch function.
@return None
@@ -70,24 +70,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the GPI(s) for which the dispatch function
- should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The GPI input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the GPI(s) for which the dispatch function
+ should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The GPI input value
+ is not within valid range.
**/
typedef
@@ -102,15 +102,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmIchnDispatch.h b/MdePkg/Include/Protocol/SmmIchnDispatch.h index 8829f85489..a2bc84c341 100644 --- a/MdePkg/Include/Protocol/SmmIchnDispatch.h +++ b/MdePkg/Include/Protocol/SmmIchnDispatch.h @@ -100,11 +100,11 @@ typedef struct { /**
Dispatch function for a ICH n specific SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -119,24 +119,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the ICHN SMI source for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the ICHN SMI source for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
+ is not within valid range.
**/
typedef
@@ -151,15 +151,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h index c94843fcca..75f3e80b9c 100644 --- a/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h +++ b/MdePkg/Include/Protocol/SmmPeriodicTimerDispatch.h @@ -76,11 +76,11 @@ typedef struct { /**
Dispatch function for a Periodic Timer SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -96,15 +96,15 @@ VOID Returns the next SMI tick period supported by the chipset. The order
returned is from longest to shortest interval period.
- @param This Protocol instance pointer.
- @param SmiTickInterval Pointer to pointer of next shorter SMI interval
- period supported by the child. This parameter works as a get-first,
- get-next field.The first time this function is called, *SmiTickInterval
- should be set to NULL to get the longest SMI interval.The returned
- *SmiTickInterval should be passed in on subsequent calls to get the
- next shorter interval period until *SmiTickInterval = NULL.
+ @param This Protocol instance pointer.
+ @param SmiTickInterval Pointer to pointer of next shorter SMI interval
+ period supported by the child. This parameter works as a get-first,
+ get-next field.The first time this function is called, *SmiTickInterval
+ should be set to NULL to get the longest SMI interval.The returned
+ *SmiTickInterval should be passed in on subsequent calls to get the
+ next shorter interval period until *SmiTickInterval = NULL.
- @retval EFI_SUCCESS The service returned successfully.
+ @retval EFI_SUCCESS The service returned successfully.
**/
typedef
@@ -117,24 +117,24 @@ EFI_STATUS /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the period at which the dispatch function
- should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the period at which the dispatch function
+ should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The period input value
+ is not within valid range.
**/
typedef
@@ -149,14 +149,14 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h b/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h index 065d85f09e..891a1fd2b3 100644 --- a/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h +++ b/MdePkg/Include/Protocol/SmmPowerButtonDispatch.h @@ -54,11 +54,11 @@ typedef struct { /**
Dispatch function for a Power Button SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -73,24 +73,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the Power Button SMI phase for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI
- phase is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the Power Button SMI phase for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Power Button SMI
+ phase is not within valid range.
**/
typedef
@@ -105,15 +105,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h b/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h index 7c52eb1808..79b0602a03 100644 --- a/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h +++ b/MdePkg/Include/Protocol/SmmStandbyButtonDispatch.h @@ -54,11 +54,11 @@ typedef struct { /**
Dispatch function for a Standby Button SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
@return Nothing
@@ -73,24 +73,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the Standby Button SMI phase for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Standby Button SMI
- phase is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the Standby Button SMI phase for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The Standby Button SMI
+ phase is not within valid range.
**/
typedef
@@ -105,15 +105,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmStatusCode.h b/MdePkg/Include/Protocol/SmmStatusCode.h index 660871548b..73f26d4c76 100644 --- a/MdePkg/Include/Protocol/SmmStatusCode.h +++ b/MdePkg/Include/Protocol/SmmStatusCode.h @@ -36,26 +36,20 @@ typedef struct _EFI_SMM_STATUS_CODE_PROTOCOL EFI_SMM_STATUS_CODE_PROTOCOL; /**
Service to emit the status code in SMM.
- @param This Pointer to EFI_SMM_STATUS_CODE_PROTOCOL instance.
-
- @param CodeType Indicates the type of status code being reported.
-
- @param Value Describes the current status of a hardware or software entity.
- This included information about the class and subclass that is used to
- classify the entity as well as an operation.
-
- @param Instance The enumeration of a hardware or software entity within
- the system. 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.
-
- @param Data This optional parameter may be used to pass additional data.
-
- @retval EFI_SUCCESS The function completed successfully
-
- @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
+ @param This Pointer to EFI_SMM_STATUS_CODE_PROTOCOL instance.
+ @param CodeType Indicates the type of status code being reported.
+ @param Value Describes the current status of a hardware or software entity.
+ This included information about the class and subclass that is used to
+ classify the entity as well as an operation.
+ @param Instance The enumeration of a hardware or software entity within
+ the system. 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.
+ @param Data This optional parameter may be used to pass additional data.
+
+ @retval EFI_SUCCESS The function completed successfully
+ @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmSwDispatch.h b/MdePkg/Include/Protocol/SmmSwDispatch.h index bc456cb5f2..2f4fecffb0 100644 --- a/MdePkg/Include/Protocol/SmmSwDispatch.h +++ b/MdePkg/Include/Protocol/SmmSwDispatch.h @@ -49,13 +49,13 @@ typedef struct { /**
Dispatch function for a Software SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The SwSmiInputValue field is filled in
- by the software dispatch driver prior to
- invoking this dispatch function.
- The dispatch function will only be called
- for input values for which it is registered.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The SwSmiInputValue field is filled in
+ by the software dispatch driver prior to
+ invoking this dispatch function.
+ The dispatch function will only be called
+ for input values for which it is registered.
Nothing
@@ -70,24 +70,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function which Software SMI input value the
- dispatch function should be invoked for.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The SW driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The SW SMI input value
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function which Software SMI input value the
+ dispatch function should be invoked for.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The SW driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The SW SMI input value
+ is not within valid range.
**/
typedef
@@ -102,15 +102,15 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmSxDispatch.h b/MdePkg/Include/Protocol/SmmSxDispatch.h index dcbc6a9b98..4d6811f3fc 100644 --- a/MdePkg/Include/Protocol/SmmSxDispatch.h +++ b/MdePkg/Include/Protocol/SmmSxDispatch.h @@ -60,13 +60,13 @@ typedef struct { /**
Dispatch function for a Sx state SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function¡¯s context.
- The Type and Phase fields are filled in by the Sx dispatch driver
- prior to invoking this dispatch function. For this interface,
- the Sx driver will call the dispatch function for all Sx type
- and phases, so the Sx state handler(s) must check the Type and
- Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function¡¯s context.
+ The Type and Phase fields are filled in by the Sx dispatch driver
+ prior to invoking this dispatch function. For this interface,
+ the Sx driver will call the dispatch function for all Sx type
+ and phases, so the Sx state handler(s) must check the Type and
+ Phase field of EFI_SMM_SX_DISPATCH_CONTEXT and act accordingly.
Nothing
@@ -81,30 +81,30 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function which Sx state type and phase the caller
- wishes to be called back on. For this intertace,
- the Sx driver will call the registered handlers for
- all Sx type and phases, so the Sx state handler(s)
- must check the Type and Phase field of the Dispatch
- context and act accordingly.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_UNSUPPORTED The Sx driver or hardware does not support that
- Sx Type/Phase.
- @retval EFI_DEVICE_ERROR The Sx driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not
- within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function which Sx state type and phase the caller
+ wishes to be called back on. For this intertace,
+ the Sx driver will call the registered handlers for
+ all Sx type and phases, so the Sx state handler(s)
+ must check the Type and Phase field of the Dispatch
+ context and act accordingly.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_UNSUPPORTED The Sx driver or hardware does not support that
+ Sx Type/Phase.
+ @retval EFI_DEVICE_ERROR The Sx driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. Type & Phase are not
+ within valid range.
**/
typedef
@@ -119,14 +119,14 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully unregistered and the
- SMI source has been disabled if there are no other registered child
- dispatch functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
- @retval other TBD
+ @retval EFI_SUCCESS The dispatch function has been successfully unregistered and the
+ SMI source has been disabled if there are no other registered child
+ dispatch functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval other TBD
**/
typedef
diff --git a/MdePkg/Include/Protocol/SmmUsbDispatch.h b/MdePkg/Include/Protocol/SmmUsbDispatch.h index f036171c49..de48f941f0 100644 --- a/MdePkg/Include/Protocol/SmmUsbDispatch.h +++ b/MdePkg/Include/Protocol/SmmUsbDispatch.h @@ -49,11 +49,11 @@ typedef struct { /**
Dispatch function for a USB SMI handler.
- @param DispatchHandle Handle of this dispatch function.
- @param DispatchContext Pointer to the dispatch function's context.
- The DispatchContext fields are filled in
- by the dispatching driver prior to
- invoking this dispatch function.
+ @param DispatchHandle Handle of this dispatch function.
+ @param DispatchContext Pointer to the dispatch function's context.
+ The DispatchContext fields are filled in
+ by the dispatching driver prior to
+ invoking this dispatch function.
Nothing
@@ -68,24 +68,24 @@ VOID /**
Register a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchFunction Pointer to dispatch function to be invoked for
- this SMI source
- @param DispatchContext Pointer to the dispatch function's context.
- The caller fills this context in before calling
- the register function to indicate to the register
- function the USB SMI types for which the dispatch
- function should be invoked.
- @param DispatchHandle Handle of dispatch function, for when interfacing
- with the parent Sx state SMM driver.
-
- @retval EFI_SUCCESS The dispatch function has been successfully
- registered and the SMI source has been enabled.
- @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
- @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
- child.
- @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The USB SMI type
- is not within valid range.
+ @param This Protocol instance pointer.
+ @param DispatchFunction Pointer to dispatch function to be invoked for
+ this SMI source
+ @param DispatchContext Pointer to the dispatch function's context.
+ The caller fills this context in before calling
+ the register function to indicate to the register
+ function the USB SMI types for which the dispatch
+ function should be invoked.
+ @param DispatchHandle Handle of dispatch function, for when interfacing
+ with the parent Sx state SMM driver.
+
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ registered and the SMI source has been enabled.
+ @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
+ child.
+ @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The USB SMI type
+ is not within valid range.
**/
typedef
@@ -100,14 +100,14 @@ EFI_STATUS /**
Unregister a child SMI source dispatch function with a parent SMM driver
- @param This Protocol instance pointer.
- @param DispatchHandle Handle of dispatch function to deregister.
+ @param This Protocol instance pointer.
+ @param DispatchHandle Handle of dispatch function to deregister.
- @retval EFI_SUCCESS The dispatch function has been successfully
- unregistered and the SMI source has been disabled
- if there are no other registered child dispatch
- functions for this SMI source.
- @retval EFI_INVALID_PARAMETER Handle is invalid.
+ @retval EFI_SUCCESS The dispatch function has been successfully
+ unregistered and the SMI source has been disabled
+ if there are no other registered child dispatch
+ functions for this SMI source.
+ @retval EFI_INVALID_PARAMETER Handle is invalid.
**/
typedef
diff --git a/MdePkg/Include/Protocol/UsbHostController.h b/MdePkg/Include/Protocol/UsbHostController.h index f816d73002..cab9bcdd45 100644 --- a/MdePkg/Include/Protocol/UsbHostController.h +++ b/MdePkg/Include/Protocol/UsbHostController.h @@ -190,7 +190,6 @@ EFI_STATUS transfer endpoint is capable of sending or receiving.
@param IsNewTransfer If TRUE, an asynchronous interrupt pipe is built between the host
and the target interrupt endpoint. If FALSE, the specified
-
@param DataToggle A pointer to the data toggle value.
@param PollingInterval Indicates the interval, in milliseconds, that the asynchronous
interrupt transfer is polled. asynchronous interrupt pipe is canceled.
|