tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adjust doxygen comment style for structure. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6178 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-10-21 18:35:06 +00:00
parent 1544a668ad
commit 11f2f87e5c
2 changed files with 46 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
MdePkg/Include/Protocol/PlatformToDriverConfiguration.h
View File

@ -288,63 +288,42 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
used. used.
**/ **/
typedef struct { typedef struct {
/// CHAR8 *CLPCommand; ///< A pointer to the DMTF SM CLP command line null-terminated string that the
/// A pointer to the DMTF SM CLP command line null-terminated string that the ///< driver is required to parse and process when this EFI_SUCCESS The platform
/// driver is required to parse and process when this EFI_SUCCESS The platform ///< return parameter information for ControllerHandle. EFI_NOT_FOUND Instance
/// return parameter information for ControllerHandle. EFI_NOT_FOUND Instance ///< was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid
/// was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid ///< EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called.
/// EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. ///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the
/// See the DMTF SM CLP Specification 1.0 Final Standard for details on the ///< format and syntax of the CLP command line string. CLPCommand buffer
/// format and syntax of the CLP command line string. CLPCommand buffer ///< is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.
/// is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL. UINT32 CLPCommandLength; ///< The length of the CLP Command in bytes.
/// CHAR8 *CLPReturnString; ///< A pointer to the CLP return status string that the driver is required to
CHAR8 *CLPCommand; ///< provide to the calling agent. The calling agent may parse and/ or pass
///< this for processing and user feedback. The SM CLP Command Response string
///< buffer is filled in by the UEFI driver in the "keyword=value" format
///< described in the SM CLP Specification, unless otherwise requested via the SM
///< CLP Coutput option in the Command Line string buffer. UEFI driver's support
///< for this default "keyword=value" output format is required if the UEFI
///< driver supports this protocol, while support for other SM CLP output
///< formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if
///< the SM CLP Coutput option requested by the caller is not supported by the
///< UEFI Driver). CLPReturnString buffer is allocated by the consumer of the
///< EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to
///< Response().
UINT32 CLPReturnStringLength; ///< The length of the CLP return status string in bytes.
UINT8 CLPCmdStatus; ///< SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -
///< Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM
///< CLP Specification 1.0 Final Standard - Table 6). This field is filled in by
///< the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC
///< OL and undefined prior to the call to Response().
UINT8 CLPErrorValue; ///< SM CLP Processing Error Value (see DMTF SM CLP Specification 1.0 Final Standard - Table 6).
///< This field is filled in by the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL and undefined prior to the call to Response().
UINT16 CLPMsgCode; ///< Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable
///< Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM
///< Specific Bits 14-0: Message Code This field is filled in by the consumer of
///< the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to
///< Response().
///
/// The length of the CLP Command in bytes.
///
UINT32 CLPCommandLength;
///
/// A pointer to the CLP return status string that the driver is required to
/// provide to the calling agent. The calling agent may parse and/ or pass
/// this for processing and user feedback. The SM CLP Command Response string
/// buffer is filled in by the UEFI driver in the "keyword=value" format
/// described in the SM CLP Specification, unless otherwise requested via the SM
/// CLP Coutput option in the Command Line string buffer. UEFI driver's support
/// for this default "keyword=value" output format is required if the UEFI
/// driver supports this protocol, while support for other SM CLP output
/// formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if
/// the SM CLP Coutput option requested by the caller is not supported by the
/// UEFI Driver). CLPReturnString buffer is allocated by the consumer of the
/// EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to
/// Response().
///
CHAR8 *CLPReturnString;
///
/// The length of the CLP return status string in bytes.
///
UINT32 CLPReturnStringLength;
///
/// SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -
/// Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM
/// CLP Specification 1.0 Final Standard - Table 6). This field is filled in by
/// the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC
/// OL and undefined prior to the call to Response().
///
UINT8 CLPCmdStatus;
UINT8 CLPErrorValue;
///
/// Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable
/// Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM
/// Specific Bits 14-0: Message Code This field is filled in by the consumer of
/// the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to
/// Response().
///
UINT16 CLPMsgCode;
} EFI_CONFIGURE_CLP_PARAMETER_BLK; } EFI_CONFIGURE_CLP_PARAMETER_BLK;

55
MdePkg/Include/Protocol/Runtime.h
View File

@ -72,51 +72,16 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
/// by a runtime DXE driver and may only be consumed by the DXE Foundation. /// by a runtime DXE driver and may only be consumed by the DXE Foundation.
/// ///
struct _EFI_RUNTIME_ARCH_PROTOCOL { struct _EFI_RUNTIME_ARCH_PROTOCOL {
/// EFI_LIST_ENTRY ImageHead; ///< A list of type EFI_RUNTIME_IMAGE_ENTRY.
/// A list of type EFI_RUNTIME_IMAGE_ENTRY. EFI_LIST_ENTRY EventHead; ///< A list of type EFI_RUNTIME_EVENT_ENTRY.
/// UINTN MemoryDescriptorSize; ///< Size of a memory descriptor that is return by GetMemoryMap().
EFI_LIST_ENTRY ImageHead; UINT32 MemoryDesciptorVersion; ///< Version of a memory descriptor that is return by GetMemoryMap().
UINTN MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
/// EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical; ///< Pointer to a runtime buffer that contains a copy of
/// A list of type EFI_RUNTIME_EVENT_ENTRY. ///< the memory map returned via GetMemoryMap().
/// EFI_MEMORY_DESCRIPTOR *MemoryMapVirtual; ///< Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
EFI_LIST_ENTRY EventHead; BOOLEAN VirtualMode; ///< Boolean that is TRUE if SetVirtualAddressMap() has been called.
BOOLEAN AtRuntime; ///< Boolean that is TRUE if ExitBootServices () has been called.
///
/// Size of a memory descriptor that is return by GetMemoryMap().
///
UINTN MemoryDescriptorSize;
///
/// Version of a memory descriptor that is return by GetMemoryMap().
///
UINT32 MemoryDesciptorVersion;
///
/// Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
///
UINTN MemoryMapSize;
///
/// Pointer to a runtime buffer that contains a copy of
/// the memory map returned via GetMemoryMap().
///
EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical;
///
/// Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
///
EFI_MEMORY_DESCRIPTOR *MemoryMapVirtual;
///
/// Boolean that is TRUE if SetVirtualAddressMap() has been called.
///
BOOLEAN VirtualMode;
///
/// Boolean that is TRUE if ExitBootServices () has been called.
///
BOOLEAN AtRuntime;
}; };
extern EFI_GUID gEfiRuntimeArchProtocolGuid; extern EFI_GUID gEfiRuntimeArchProtocolGuid;