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

Fix doxygen comment for structure and macro 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6097 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-10-09 19:17:35 +00:00
parent cce6f7aa66
commit 1f08a15903
17 changed files with 80 additions and 387 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
MdePkg/Include/Protocol/PxeBaseCode.h
View File

@ -616,56 +616,13 @@ EFI_STATUS
The EFI_PXE_BASE_CODE_PROTOCOL handle also supports the
EFI_LOAD_FILE_PROTOCOL protocol. This provides a clean way to obtain control from the
boot manager if the boot path is from the remote device.
@param Revision
The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
be backwards compatible. If a future version is not backwards compatible
it is not the same GUID.
@param Start
Starts the PXE Base Code Protocol. Mode structure information is not valid and
no other Base Code Protocol functions will operate until the Base Code is started.
@param Stop
Stops the PXE Base Code Protocol. Mode structure information is unchanged by this function.
No Base Code Protocol functions will operate until the Base Code is restarted.
@param Dhcp
Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge)
or DHCPv6 S.A.R.R (solicit / advertise / request / reply) sequence.
@param Discover
Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
@param Mtftp
Performs TFTP and MTFTP services.
@param UdpWrite
Writes a UDP packet to the network interface.
@param UdpRead
Reads a UDP packet from the network interface.
@param SetIpFilter
Updates the IP receive filters of the network device.
@param Arp
Uses the ARP protocol to resolve a MAC address.
@param SetParameters
Updates the parameters that affect the operation of the PXE Base Code Protocol.
@param SetStationIp
Updates the station IP address and subnet mask values.
@param SetPackets
Updates the contents of the cached DHCP and Discover packets.
@param Mode
Pointer to the EFI_PXE_BASE_CODE_MODE data for this device.
**/
struct _EFI_PXE_BASE_CODE_PROTOCOL {
///
/// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
/// be backwards compatible. If a future version is not backwards compatible
/// it is not the same GUID.
///
UINT64 Revision;
EFI_PXE_BASE_CODE_START Start;
EFI_PXE_BASE_CODE_STOP Stop;

14
MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
View File

@ -93,17 +93,13 @@ EFI_PXE_BASE_CODE_CALLBACK_STATUS
Protocol that is invoked when the PXE Base Code Protocol is about
to transmit, has received, or is waiting to receive a packet.
@param Revision
The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
be backwards compatible. If a future version is not backwards compatible
it is not the same GUID.
@param Callback
Callback routine used by the PXE Base Code Dhcp(), Discover(), Mtftp(),
UdpWrite(), and Arp() functions.
**/
struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {
///
/// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must
/// be backwards compatible. If a future version is not backwards compatible
/// it is not the same GUID.
///
UINT64 Revision;
EFI_PXE_CALLBACK Callback;
};

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

@ -74,45 +74,52 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
SetVirtualAddressMap() and ConvertPointer(), have been registered into the
EFI Runtime Table in the EFI System Partition. This protocol must be produced
by a runtime DXE driver and may only be consumed by the DXE Foundation.
@param ImageHead
A list of type EFI_RUNTIME_IMAGE_ENTRY.
@param EventHead
A list of type EFI_RUNTIME_EVENT_ENTRY.
@param MemoryDescriptorSize
Size of a memory descriptor that is return by GetMemoryMap().
@param MemoryDescriptorVersion
Version of a memory descriptor that is return by GetMemoryMap().
@param MemoryMapSize
Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
@param MemoryMapPhysical
Pointer to a runtime buffer that contains a copy of
the memory map returned via GetMemoryMap().
@param MemoryMapVirtual
Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
@param VirtualMode
Boolean that is TRUE if SetVirtualAddressMap() has been called.
@param AtRuntime
Boolean that is TRUE if ExitBootServices () has been called.
**/
struct _EFI_RUNTIME_ARCH_PROTOCOL {
///
/// A list of type EFI_RUNTIME_IMAGE_ENTRY.
///
EFI_LIST_ENTRY ImageHead;
///
/// A list of type EFI_RUNTIME_EVENT_ENTRY.
///
EFI_LIST_ENTRY EventHead;
///
/// 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;
};

31
MdePkg/Include/Protocol/ScsiIo.h
View File

@ -218,30 +218,6 @@ EFI_STATUS
/**
@par Protocol Description:
Provides services to manage and communicate with SCSI devices.
@param GetDeviceType
Retrieves the information of the device type which the SCSI device belongs to.
@param GetDeviceLocation
Retrieves the device location information in the SCSI bus.
@param ResetBus
Resets the entire SCSI bus the SCSI device attaches to.
@param ResetDevice
Resets the SCSI Device that is specified by the device handle the SCSI I/O
protocol attaches.
@param ExecuteScsiCommand
Sends a SCSI command to the SCSI device and waits for the execution completion
until an exit condition is met, or a timeout occurs.
@param IoAlign
Supplies the alignment requirement for any buffer used in a data transfer.
IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory.
Otherwise, IoAlign must be a power of 2, and the requirement is that the
start address of a buffer must be evenly divisible by IoAlign with no remainder.
**/
struct _EFI_SCSI_IO_PROTOCOL {
EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE GetDeviceType;
@ -249,6 +225,13 @@ struct _EFI_SCSI_IO_PROTOCOL {
EFI_SCSI_IO_PROTOCOL_RESET_BUS ResetBus;
EFI_SCSI_IO_PROTOCOL_RESET_DEVICE ResetDevice;
EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND ExecuteScsiCommand;
///
/// Supplies the alignment requirement for any buffer used in a data transfer.
/// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory.
/// Otherwise, IoAlign must be a power of 2, and the requirement is that the
/// start address of a buffer must be evenly divisible by IoAlign with no remainder.
///
UINT32 IoAlign;
};

23
MdePkg/Include/Protocol/ScsiPassThru.h
View File

@ -303,29 +303,6 @@ EFI_STATUS
information includes the Target ID of the host controller on the SCSI channel, the attributes of
the SCSI channel, the printable name for the SCSI controller, and the printable name of the
SCSI channel.
@param Mode
A pointer to the EFI_SCSI_PASS_THRU_MODE data for this SCSI channel.
@param PassThru
Sends a SCSI Request Packet to a SCSI device that is connected to the SCSI channel.
@param GetNextDevice
Used to retrieve the list of legal Target IDs and LUNs for the
SCSI devices on a SCSI channel.
@param BuildDevicePath
Used to allocate and build a device path node for a SCSI device on a SCSI channel.
@param GetTargetLun
Used to translate a device path node to a Target ID and LUN.
@param ResetChannel
Resets the SCSI channel. This operation resets all the SCSI
devices connected to the SCSI channel.
@param ResetTarget
Resets a SCSI device that is connected to the SCSI channel.
**/
struct _EFI_SCSI_PASS_THRU_PROTOCOL {
EFI_SCSI_PASS_THRU_MODE *Mode;

24
MdePkg/Include/Protocol/ScsiPassThruExt.h
View File

@ -314,30 +314,6 @@ EFI_STATUS
and the ability to send SCI Request Packets to any SCSI device attached to
that SCSI channel. The information includes the Target ID of the host controller
on the SCSI channel and the attributes of the SCSI channel.
@param Mode
A pointer to the EFI_EXT_SCSI_PASS_THRU_MODE data for this SCSI channel.
@param PassThru
Sends a SCSI Request Packet to a SCSI device that is Connected to the SCSI channel.
@param GetNextTargetLun
Retrieves the list of legal Target IDs and LUNs for the SCSI devices on a SCSI channel.
@param BuildDevicePath
Allocates and builds a device path node for a SCSI Device on a SCSI channel.
@param GetTargetLun
Translates a device path node to a Target ID and LUN.
@param ResetChannel
Resets the SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel.
@param ResetTargetLun
Resets a SCSI device that is connected to the SCSI channel.
@param GetNextTartget
Retrieves the list of legal Target IDs for the SCSI devices on a SCSI channel.
**/
struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL {
EFI_EXT_SCSI_PASS_THRU_MODE *Mode;

5
MdePkg/Include/Protocol/Security.h
View File

@ -110,11 +110,6 @@ EFI_STATUS
wrapped in an Authentication Section. See the Firmware File System
Specification for details on the GUIDed Section Extraction Protocol and
Authentication Sections.
@param FileAuthenticationState
This service is called upon fault with respect to
the authentication of a section of a file.
**/
struct _EFI_SECURITY_ARCH_PROTOCOL {
EFI_SECURITY_FILE_AUTHENTICATION_STATE FileAuthenticationState;

36
MdePkg/Include/Protocol/SerialIo.h
View File

@ -271,39 +271,13 @@ typedef struct {
The Serial I/O protocol is used to communicate with UART-style serial devices.
These can be standard UART serial ports in PC-AT systems, serial ports attached
to a USB interface, or potentially any character-based I/O device.
@param Revision
The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions
must be backwards compatible. If a future version is not back wards compatible,
it is not the same GUID.
@param Reset
Resets the hardware device.
@param SetAttributes
Sets communication parameters for a serial device. These include
the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits,
and stop bit attributes.
@param SetControl
Sets the control bits on a serial device. These include Request to
Send and Data Terminal Ready.
@param GetControl
Reads the status of the control bits on a serial device. These include
Clear to Send, Data Set Ready, Ring Indicator, and Carrier Detect.
@param Write
Sends a buffer of characters to a serial device.
@param Read
Receives a buffer of characters from a serial device.
@param Mode
Pointer to SERIAL_IO_MODE data.
**/
struct _EFI_SERIAL_IO_PROTOCOL {
///
/// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions
/// must be backwards compatible. If a future version is not back wards compatible,
/// it is not the same GUID.
///
UINT32 Revision;
EFI_SERIAL_RESET Reset;
EFI_SERIAL_SET_ATTRIBUTES SetAttributes;

6
MdePkg/Include/Protocol/ServiceBinding.h
View File

@ -78,12 +78,6 @@ EFI_STATUS
required behavior, not to specify the required implementation. Each consumer of
a software protocol is responsible for calling CreateChild() when it requires the
protocol and calling DestroyChild() when it is finished with that protocol.
@param CreateChild
Creates a child handle and installs a protocol.
@param DestroyChild
Destroys a child handle with a protocol installed on it.
**/
struct _EFI_SERVICE_BINDING_PROTOCOL {
EFI_SERVICE_BINDING_CREATE_CHILD CreateChild;

40
MdePkg/Include/Protocol/SimpleFileSystem.h
View File

@ -321,43 +321,13 @@ EFI_STATUS
and is also a reference to a location in the directory tree of the file system
in which the file resides. With any given file handle, other files may be opened
relative to this file's location, yielding new file handles.
@param Revision
The version of the EFI_FILE_PROTOCOL interface. The version specified
by this specification is 0x00010000. Future versions are required
to be backward compatible to version 1.0.
@param Open
Opens or creates a new file.
@param Close
Closes the current file handle.
@param Delete
Deletes a file.
@param Read
Reads bytes from a file.
@param Write
Writes bytes to a file.
@param GetPosition
Returns the current file position.
@param SetPosition
Sets the current file position.
@param GetInfo
Gets the requested file or volume information.
@param SetInfo
Sets the requested file information.
@param Flush
Flushes all modified data associated with the file to the device.
**/
struct _EFI_FILE_PROTOCOL {
///
/// The version of the EFI_FILE_PROTOCOL interface. The version specified
/// by this specification is 0x00010000. Future versions are required
/// to be backward compatible to version 1.0.
///
UINT64 Revision;
EFI_FILE_OPEN Open;
EFI_FILE_CLOSE Close;

70
MdePkg/Include/Protocol/SimpleNetwork.h
View File

@ -558,70 +558,13 @@ EFI_STATUS
to a network adapter. Once the network adapter initializes,
the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that
allow packets to be transmitted and received.
@param Revision
Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must
be backwards compatible. If a future version is not backwards compatible
it is not the same GUID.
@param Start
Prepares the network interface for further command operations.
No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate
until this call is made.
@param Stop
Stops further network interface command processing.
No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate
after this call is made until another Start() call is made.
@param Initialize
Resets the network adapter and allocates the transmit and receive buffers.
@param Reset
Resets the network adapter and reinitializes it with the parameters
provided in the previous call to Initialize().
@param Shutdown
Resets the network adapter and leaves it in a state safe for another driver
to initialize. The memory buffers assigned in the Initialize() call are released.
After this call, only the Initialize() or Stop() calls may be used.
@param ReceiveFilters
Enables and disables the receive filters for the network interface and,
if supported, manages the filtered multicast
HW MAC (Hardware Media Access Control) address list.
@param StationAddress
Modifies or resets the current station address, if supported.
@param Statistics
Collects statistics from the network interface and allows the statistics to be reset.
@param MCastIpToMac
Maps a multicast IP address to a multicast HW MAC address.
@param NvData
Reads and writes the contents of the NVRAM devices attached to the network interface.
@param GetStatus
Reads the current interrupt status and the list of recycled transmit
buffers from the network interface.
@param Transmit
Places a packet in the transmit queue.
@param Receive
Retrieves a packet from the receive queue, along with the status
flags that describe the packet type.
@param WaitForPacket
Event used with WaitForEvent() to wait for a packet to be received.
@param Mode
Pointer to the EFI_SIMPLE_NETWORK_MODE data for the device.
**/
struct _EFI_SIMPLE_NETWORK_PROTOCOL {
///
/// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must
/// be backwards compatible. If a future version is not backwards compatible
/// it is not the same GUID.
///
UINT64 Revision;
EFI_SIMPLE_NETWORK_START Start;
EFI_SIMPLE_NETWORK_STOP Stop;
@ -636,6 +579,9 @@ struct _EFI_SIMPLE_NETWORK_PROTOCOL {
EFI_SIMPLE_NETWORK_GET_STATUS GetStatus;
EFI_SIMPLE_NETWORK_TRANSMIT Transmit;
EFI_SIMPLE_NETWORK_RECEIVE Receive;
///
/// Event used with WaitForEvent() to wait for a packet to be received.
///
EFI_EVENT WaitForPacket;
EFI_SIMPLE_NETWORK_MODE *Mode;
};

15
MdePkg/Include/Protocol/SimplePointer.h
View File

@ -90,22 +90,13 @@ EFI_STATUS
to this specification. The services include the ability to reset the
pointer device, retrieve get the state of the pointer device, and
retrieve the capabilities of the pointer device.
@param Reset
Resets the pointer device.
@param GetState
Retrieves the current state of the pointer device.
@param WaitForInput
Event to use with WaitForEvent() to wait for input from the pointer device.
@param Mode
Pointer to EFI_SIMPLE_POINTER_MODE data.
**/
struct _EFI_SIMPLE_POINTER_PROTOCOL {
EFI_SIMPLE_POINTER_RESET Reset;
EFI_SIMPLE_POINTER_GET_STATE GetState;
///
/// Event to use with WaitForEvent() to wait for input from the pointer device.
///
EFI_EVENT WaitForInput;
EFI_SIMPLE_POINTER_MODE *Mode;
};

14
MdePkg/Include/Protocol/SimpleTextIn.h
View File

@ -122,21 +122,13 @@ EFI_STATUS
@par Protocol Description:
The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device.
It is the minimum required protocol for ConsoleIn.
@param Reset
Reset the ConsoleIn device.
@param ReadKeyStroke
Returns the next input character.
@param WaitForKey
Event to use with WaitForEvent() to wait for a key to be available.
**/
struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {
EFI_INPUT_RESET Reset;
EFI_INPUT_READ_KEY ReadKeyStroke;
///
/// Event to use with WaitForEvent() to wait for a key to be available
///
EFI_EVENT WaitForKey;
};

22
MdePkg/Include/Protocol/SimpleTextInEx.h
View File

@ -305,29 +305,13 @@ EFI_STATUS
device. It is an extension to the Simple Text Input protocol
which allows a variety of extended shift state information to be
returned.
@param Reset
Reset the ConsoleIn device. See Reset().
@param ReadKeyStrokeEx
Returns the next input character.
@param WaitForKeyEx
Event to use with WaitForEvent() to wait for a key to be available.
@param SetState
Set the EFI_KEY_TOGGLE_STATE state settings for the input device.
@param RegisterKeyNotify
Register a notification function to be called when a given key sequence is hit.
@param UnregisterKeyNotifyRemoves
A specific notification function.
**/
struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL{
EFI_INPUT_RESET_EX Reset;
EFI_INPUT_READ_KEY_EX ReadKeyStrokeEx;
///
/// Event to use with WaitForEvent() to wait for a key to be available.
///
EFI_EVENT WaitForKeyEx;
EFI_SET_STATE SetState;
EFI_REGISTER_KEYSTROKE_NOTIFY RegisterKeyNotify;

30
MdePkg/Include/Protocol/SimpleTextOut.h
View File

@ -379,36 +379,6 @@ typedef struct {
It is the minimum required protocol for any handle supplied as the ConsoleOut
or StandardError device. In addition, the minimum supported text mode of such
devices is at least 80 x 25 characters.
@param Reset
Reset the ConsoleOut device.
@param OutputString
Displays the Unicode string on the device at the current cursor location.
@param TestString
Tests to see if the ConsoleOut device supports this Unicode string.
@param QueryMode
Queries information concerning the output device's supported text mode.
@param SetMode
Sets the current mode of the output device.
@param SetAttribute
Sets the foreground and background color of the text that is output.
@param ClearScreen
Clears the screen with the currently set background color.
@param SetCursorPosition
Sets the current cursor position.
@param EnableCursor
Turns the visibility of the cursor on/off.
@param Mode
Pointer to SIMPLE_TEXT_OUTPUT_MODE data.
**/
struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {
EFI_TEXT_RESET Reset;

17
MdePkg/Include/Protocol/SmbusHc.h
View File

@ -279,23 +279,6 @@ EFI_STATUS
The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data
transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus
host controller.
@param Execute Executes the SMBus operation to an SMBus slave
device. See the Execute() function description.
@param ArpDevice Allows an SMBus 2.0 device(s) to be Address
Resolution Protocol (ARP).
@param GetArpMap Allows a driver to retrieve the address that
was allocated by the SMBus host controller
during enumeration/ARP. See the GetArpMap()
function description.
@param Notify Allows a driver to register for a callback
to the SMBus host controller driver when the
bus issues a notification to the bus
controller driver. See the Notify() function
description.
**/
struct _EFI_SMBUS_HC_PROTOCOL {
EFI_SMBUS_HC_EXECUTE_OPERATION Execute;

2
MdePkg/Include/Protocol/StatusCode.h
View File

@ -62,8 +62,6 @@ EFI_STATUS
This protocol must be produced by a runtime DXE driver and may be consumed
only by the DXE Foundation.
@param ReportStatusCode Emit a status code.
**/
typedef struct _EFI_STATUS_CODE_PROTOCOL {
EFI_REPORT_STATUS_CODE ReportStatusCode;