mirror of
https://github.com/acidanthera/audk.git
synced 2025-04-08 17:05:09 +02:00
Fix doxygen comment for structure and macro
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6098 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
parent
1f08a15903
commit
258cce1382
@ -224,23 +224,6 @@ EFI_STATUS
|
||||
Per this specification, a boot application uses the services of this protocol
|
||||
to load the bootloader image from tape.
|
||||
|
||||
@param TapeRead
|
||||
Read a block of data from the tape.
|
||||
|
||||
@param TapeWrite
|
||||
Write a block of data to the tape.
|
||||
|
||||
@param TapeRewind
|
||||
Rewind the tape.
|
||||
|
||||
@param TapeSpace
|
||||
Position the tape.
|
||||
|
||||
@param TapeWriteFM
|
||||
Write filemarks to the tape.
|
||||
|
||||
@param TapeReset
|
||||
Reset the tape device or its parent bus.
|
||||
**/
|
||||
struct _EFI_TAPE_IO_PROTOCOL {
|
||||
EFI_TAPE_READ TapeRead;
|
||||
|
||||
@ -201,17 +201,6 @@ EFI_STATUS
|
||||
@par Protocol Description:
|
||||
The EFI_TCG Protocol abstracts TCG activity.
|
||||
|
||||
@param StatusCheck This service provides information on the TPM.
|
||||
@param HashAll This service abstracts the capability to do a hash
|
||||
operation on a data buffer.
|
||||
@param LogEvent This service abstracts the capability to add
|
||||
an entry to the Event Log.
|
||||
@param PassThroughToTPM This service provides a pass-through capability
|
||||
from the caller to the system's TPM.
|
||||
@param HashLogExtendEvent This service abstracts the capability to do a hash
|
||||
operation on a data buffer, extend a specific TPM PCR
|
||||
with the hash result, and add an entry to the Event Log.
|
||||
|
||||
**/
|
||||
struct _EFI_TCG_PROTOCOL {
|
||||
EFI_TCG_STATUS_CHECK StatusCheck;
|
||||
|
||||
@ -482,40 +482,6 @@ EFI_STATUS
|
||||
It can either listen on a specified port as a service or actively connected
|
||||
to remote peer as a client. Each instance has its own independent settings,
|
||||
such as the routing table.
|
||||
|
||||
@param GetModeData
|
||||
Get the current operational status.
|
||||
|
||||
@param Configure
|
||||
Initialize, change, or brutally reset operational settings of the EFI TCPv4 Protocol.
|
||||
|
||||
@param Routes
|
||||
Add or delete routing entries for this TCP4 instance.
|
||||
|
||||
@param Connect
|
||||
Initiate the TCP three-way handshake to connect to the remote peer
|
||||
configured in this TCP instance. The function is a nonblocking operation.
|
||||
|
||||
@param Accept
|
||||
Listen for incoming TCP connection request. This function is a nonblocking operation.
|
||||
|
||||
@param Transmit
|
||||
Queue outgoing data to the transmit queue. This function is a nonblocking operation.
|
||||
|
||||
@param Receive
|
||||
Queue a receiving request token to the receive queue. This function is
|
||||
a nonblocking operation.
|
||||
|
||||
@param Close
|
||||
Gracefully disconnecting a TCP connection follow RFC 793 or reset a TCP
|
||||
connection. This function is a nonblocking operation.
|
||||
|
||||
@param Cancel
|
||||
Abort a pending connect, listen, transmit or receive request.
|
||||
|
||||
@param Poll
|
||||
Poll to receive incoming data and transmit outgoing TCP segments.
|
||||
|
||||
**/
|
||||
struct _EFI_TCP4_PROTOCOL {
|
||||
EFI_TCP4_GET_MODE_DATA GetModeData;
|
||||
|
||||
@ -170,29 +170,6 @@ EFI_STATUS
|
||||
periodic timer interrupt. When a timer interrupt occurs, the handler is
|
||||
passed the amount of time that has passed since the previous timer
|
||||
interrupt.
|
||||
|
||||
@param RegisterHandler
|
||||
Registers a handler that will be called each time the
|
||||
timer interrupt fires. TimerPeriod defines the minimum
|
||||
time between timer interrupts, so TimerPeriod will also
|
||||
be the minimum time between calls to the registered
|
||||
handler.
|
||||
|
||||
@param SetTimerPeriod
|
||||
Sets the period of the timer interrupt in 100 nS units.
|
||||
This function is optional, and may return EFI_UNSUPPORTED.
|
||||
If this function is supported, then the timer period will
|
||||
be rounded up to the nearest supported timer period.
|
||||
|
||||
@param GetTimerPeriod
|
||||
Retrieves the period of the timer interrupt in 100 nS units.
|
||||
|
||||
@param GenerateSoftInterrupt
|
||||
Generates a soft timer interrupt that simulates the firing of
|
||||
the timer interrupt. This service can be used to invoke the
|
||||
registered handler if the timer interrupt has been masked for
|
||||
a period of time.
|
||||
|
||||
**/
|
||||
struct _EFI_TIMER_ARCH_PROTOCOL {
|
||||
EFI_TIMER_REGISTER_HANDLER RegisterHandler;
|
||||
|
||||
@ -349,30 +349,6 @@ EFI_STATUS
|
||||
This protocol instance can either be bound to a specified port as a service or
|
||||
connected to some remote peer as an active client. Each instance has its own settings,
|
||||
such as the routing table and group table, which are independent from each other.
|
||||
|
||||
@param GetModeData
|
||||
Reads the current operational settings.
|
||||
|
||||
@param Configure
|
||||
Initializes, changes, or resets operational settings for the EFI UDPv4 Protocol.
|
||||
|
||||
@param Groups
|
||||
Joins and leaves multicast groups.
|
||||
|
||||
@param Routes
|
||||
Add and deletes routing table entries.
|
||||
|
||||
@param Transmit
|
||||
Queues outgoing data packets into the transmit queue. This function is a nonblocked operation.
|
||||
|
||||
@param Receive
|
||||
Places a receiving request token into the receiving queue. This function is a nonblocked operation.
|
||||
|
||||
@param Cancel
|
||||
Aborts a pending transmit or receive request.
|
||||
|
||||
@param Poll
|
||||
Polls for incoming data packets and processes outgoing data packets.
|
||||
**/
|
||||
struct _EFI_UDP4_PROTOCOL {
|
||||
EFI_UDP4_GET_MODE_DATA GetModeData;
|
||||
|
||||
@ -160,15 +160,6 @@ EFI_STATUS
|
||||
directly to the frame buffer. The EFI_UGA_DRAW_PROTOCOL is designed to be lightweight and
|
||||
to support the basic needs of graphics output prior to Operating System boot.
|
||||
|
||||
@param GetMode
|
||||
Returns information about the geometry and configuration of the
|
||||
graphics controller's current frame buffer configuration.
|
||||
|
||||
@param SetMode
|
||||
Set the graphics device into a given mode and clears the frame buffer to black.
|
||||
|
||||
@param Blt
|
||||
Software abstraction to draw on the video device's frame buffer.
|
||||
**/
|
||||
struct _EFI_UGA_DRAW_PROTOCOL {
|
||||
EFI_UGA_DRAW_PROTOCOL_GET_MODE GetMode;
|
||||
|
||||
@ -165,15 +165,6 @@ typedef UGA_STATUS
|
||||
/**
|
||||
@par Protocol Description:
|
||||
Provides a basic abstraction to send I/O requests to the graphics device and any of its children.
|
||||
|
||||
@param CreateDevice
|
||||
Create a UGA_DEVICE object for a child device of a given parent UGA_DEVICE.
|
||||
|
||||
@param DeleteDevice
|
||||
Delete the UGA_DEVICE returned from CreateDevice().
|
||||
|
||||
@param DispatchService
|
||||
Dispatches I/O requests to the display device and its associate child devices.
|
||||
**/
|
||||
struct _EFI_UGA_IO_PROTOCOL {
|
||||
EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice;
|
||||
|
||||
@ -168,35 +168,6 @@ BOOLEAN
|
||||
@par Protocol Description:
|
||||
The EFI_UNICODE_COLLATION_PROTOCOL is used to perform case-insensitive
|
||||
comparisons of Unicode strings.
|
||||
|
||||
@param StriColl
|
||||
Performs a case-insensitive comparison of two Null-terminated Unicode strings.
|
||||
|
||||
@param MetaiMatch
|
||||
Performs a case-insensitive comparison between a Null-terminated Unicode
|
||||
pattern string and a Null-terminated Unicode string. The pattern string
|
||||
can use the '?' wildcard to match any character, and the '*' wildcard to
|
||||
match any substring.
|
||||
|
||||
@param StrLwr
|
||||
Converts all the Unicode characters in a Null-terminated Unicode string to
|
||||
lowercase Unicode characters.
|
||||
|
||||
@param StrUpr
|
||||
Converts all the Unicode characters in a Null-terminated Unicode string to
|
||||
uppercase Unicode characters.
|
||||
|
||||
@param FatToStr
|
||||
Converts an 8.3 FAT file name using an OEM character set to a Null-terminated
|
||||
Unicode string.
|
||||
|
||||
@param StrToFat
|
||||
Converts a Null-terminated Unicode string to legal characters in a FAT
|
||||
filename using an OEM character set.
|
||||
|
||||
@param Supported
|
||||
LanguagesA Null-terminated ASCII string array that contains one or more
|
||||
language codes. This array is specified in RFC 4646 format.
|
||||
**/
|
||||
struct _EFI_UNICODE_COLLATION_PROTOCOL {
|
||||
//
|
||||
@ -212,7 +183,11 @@ struct _EFI_UNICODE_COLLATION_PROTOCOL {
|
||||
//
|
||||
EFI_UNICODE_COLLATION_FATTOSTR FatToStr;
|
||||
EFI_UNICODE_COLLATION_STRTOFAT StrToFat;
|
||||
|
||||
|
||||
///
|
||||
/// LanguagesA Null-terminated ASCII string array that contains one or more
|
||||
/// language codes. This array is specified in RFC 4646 format.
|
||||
///
|
||||
CHAR8 *SupportedLanguages;
|
||||
};
|
||||
|
||||
|
||||
@ -562,54 +562,6 @@ EFI_STATUS
|
||||
for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL
|
||||
instance, and an EFI_USB2_HC_PROTOCOL instance.
|
||||
|
||||
@param GetCapability
|
||||
Retrieves the capabilities of the USB host controller.
|
||||
|
||||
@param Reset
|
||||
Software reset of USB.
|
||||
|
||||
@param GetState
|
||||
Retrieves the current state of the USB host controller.
|
||||
|
||||
@param SetState
|
||||
Sets the USB host controller to a specific state.
|
||||
|
||||
@param ControlTransfer
|
||||
Submits a control transfer to a target USB device.
|
||||
|
||||
@param BulkTransfer
|
||||
Submits a bulk transfer to a bulk endpoint of a USB device.
|
||||
|
||||
@param AsyncInterruptTransfer
|
||||
Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
|
||||
|
||||
@param SyncInterruptTransfer
|
||||
Submits a synchronous interrupt transfer to an interrupt endpoint of a USB device.
|
||||
|
||||
@param IsochronousTransfer
|
||||
Submits isochronous transfer to an isochronous endpoint of a USB device.
|
||||
|
||||
@param AsyncIsochronousTransfer
|
||||
Submits nonblocking USB isochronous transfer.
|
||||
|
||||
@param GetRootHubPortStatus
|
||||
Retrieves the status of the specified root hub port.
|
||||
|
||||
@param SetRootHubPortFeature
|
||||
Sets the feature for the specified root hub port.
|
||||
|
||||
@param ClearRootHubPortFeature
|
||||
Clears the feature for the specified root hub port.
|
||||
|
||||
@param MajorRevision
|
||||
The major revision number of the USB host controller. The revision information
|
||||
indicates the release of the Universal Serial Bus Specification with which the
|
||||
host controller is compliant.
|
||||
|
||||
@param MinorRevision
|
||||
The minor revision number of the USB host controller. The revision information
|
||||
indicates the release of the Universal Serial Bus Specification with which the
|
||||
host controller is compliant.
|
||||
**/
|
||||
struct _EFI_USB2_HC_PROTOCOL {
|
||||
EFI_USB2_HC_PROTOCOL_GET_CAPABILITY GetCapability;
|
||||
@ -625,7 +577,19 @@ struct _EFI_USB2_HC_PROTOCOL {
|
||||
EFI_USB2_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS GetRootHubPortStatus;
|
||||
EFI_USB2_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE SetRootHubPortFeature;
|
||||
EFI_USB2_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE ClearRootHubPortFeature;
|
||||
|
||||
///
|
||||
/// The major revision number of the USB host controller. The revision information
|
||||
/// indicates the release of the Universal Serial Bus Specification with which the
|
||||
/// host controller is compliant.
|
||||
///
|
||||
UINT16 MajorRevision;
|
||||
|
||||
///
|
||||
/// The minor revision number of the USB host controller. The revision information
|
||||
/// indicates the release of the Universal Serial Bus Specification with which the
|
||||
/// host controller is compliant.
|
||||
///
|
||||
UINT16 MinorRevision;
|
||||
};
|
||||
|
||||
|
||||
@ -475,59 +475,7 @@ EFI_STATUS
|
||||
system retrieves the EFI_USB_HC_PROTOCOL instance that is associated with the USB bus to be
|
||||
managed. A device handle for a USB host controller will minimally contain an
|
||||
EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance.
|
||||
|
||||
@param Reset
|
||||
Software reset of USB.
|
||||
|
||||
@param GetState
|
||||
Retrieves the current state of the USB host controller.
|
||||
|
||||
@param SetState
|
||||
Sets the USB host controller to a specific state.
|
||||
|
||||
@param ControlTransfer
|
||||
Submits a control transfer to a target USB device.
|
||||
|
||||
@param BulkTransfer
|
||||
Submits a bulk transfer to a bulk endpoint of a USB device.
|
||||
|
||||
@param AsyncInterruptTransfer
|
||||
Submits an asynchronous interrupt transfer to an interrupt endpoint
|
||||
of a USB device.
|
||||
|
||||
@param SyncInterruptTransfer
|
||||
Submits a synchronous interrupt transfer to an interrupt endpoint
|
||||
of a USB device.
|
||||
|
||||
@param IsochronousTransfer
|
||||
Submits isochronous transfer to an isochronous endpoint of a USB device.
|
||||
|
||||
@param AsyncIsochronousTransfer
|
||||
Submits nonblocking USB isochronous transfer.
|
||||
|
||||
@param GetRootHubPortNumber
|
||||
Retrieves the number of root hub ports that are produced by the
|
||||
USB host controller.
|
||||
|
||||
@param GetRootHubPortStatus
|
||||
Retrieves the status of the specified root hub port.
|
||||
|
||||
@param SetRootHubPortFeature
|
||||
Sets the feature for the specified root hub port.
|
||||
|
||||
@param ClearRootHubPortFeature
|
||||
Clears the feature for the specified root hub port.
|
||||
|
||||
@param MajorRevision
|
||||
The major revision number of the USB host controller. The
|
||||
revision information indicates the release of the Universal Serial
|
||||
Bus Specification with which the host controller is compliant.
|
||||
|
||||
@param MinorRevision
|
||||
The minor revision number of the USB host controller. The
|
||||
revision information indicates the release of the Universal Serial
|
||||
Bus Specification with which the host controller is compliant.
|
||||
|
||||
**/
|
||||
struct _EFI_USB_HC_PROTOCOL {
|
||||
EFI_USB_HC_PROTOCOL_RESET Reset;
|
||||
@ -543,7 +491,17 @@ struct _EFI_USB_HC_PROTOCOL {
|
||||
EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS GetRootHubPortStatus;
|
||||
EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE SetRootHubPortFeature;
|
||||
EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE ClearRootHubPortFeature;
|
||||
///
|
||||
/// The major revision number of the USB host controller. The revision information
|
||||
/// indicates the release of the Universal Serial Bus Specification with which the
|
||||
/// host controller is compliant.
|
||||
///
|
||||
UINT16 MajorRevision;
|
||||
///
|
||||
/// The minor revision number of the USB host controller. The revision information
|
||||
/// indicates the release of the Universal Serial Bus Specification with which the
|
||||
/// host controller is compliant.
|
||||
///
|
||||
UINT16 MinorRevision;
|
||||
};
|
||||
|
||||
|
||||
@ -480,46 +480,6 @@ EFI_STATUS
|
||||
transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL
|
||||
also provides some basic USB device/controller management and configuration
|
||||
interfaces. A USB device driver uses the services of this protocol to manage USB devices.
|
||||
|
||||
@param UsbControlTransfer
|
||||
Accesses the USB Device through USB Control Transfer Pipe.
|
||||
|
||||
@param UsbBulkTransfer
|
||||
Accesses the USB Device through USB Bulk Transfer Pipe.
|
||||
|
||||
@param UsbAsyncInterruptTransfer
|
||||
Non-block USB interrupt transfer.
|
||||
|
||||
@param UsbSyncInterruptTransfer
|
||||
Accesses the USB Device through USB Synchronous
|
||||
Interrupt Transfer Pipe.
|
||||
|
||||
@param UsbIsochronousTransfer
|
||||
Accesses the USB Device through USB Isochronous Transfer Pipe.
|
||||
|
||||
@param UsbAsyncIsochronousTransfer
|
||||
Nonblock USB isochronous transfer.
|
||||
|
||||
@param UsbGetDeviceDescriptor
|
||||
Retrieves the device descriptor of a USB device.
|
||||
|
||||
@param UsbGetConfigDescriptor
|
||||
Retrieves the activated configuration descriptor of a USB device.
|
||||
|
||||
@param UsbGetInterfaceDescriptor
|
||||
Retrieves the interface descriptor of a USB Controller.
|
||||
|
||||
@param UsbGetEndpointDescriptor
|
||||
Retrieves the endpoint descriptor of a USB Controller.
|
||||
|
||||
@param UsbGetStringDescriptor
|
||||
Retrieves the string descriptor inside a USB Device.
|
||||
|
||||
@param UsbGetSupportedLanguages
|
||||
Retrieves the array of languages that the USB device supports.
|
||||
|
||||
@param UsbPortReset
|
||||
Resets and reconfigures the USB controller.
|
||||
**/
|
||||
struct _EFI_USB_IO_PROTOCOL {
|
||||
//
|
||||
|
||||
@ -134,18 +134,6 @@ EFI_STATUS
|
||||
will be passed to a handler if one has been registered. If no handler has
|
||||
been registered, or the registered handler returns, then the system will be
|
||||
reset by calling the Runtime Service ResetSystem().
|
||||
|
||||
@param RegisterHandler Registers a handler that is invoked when the watchdog
|
||||
timer fires.
|
||||
|
||||
@param SetTimerPeriod Sets the amount of time in 100 ns units to wait before the
|
||||
watchdog timer is fired. If this function is supported,
|
||||
then the watchdog timer period will be rounded up to the
|
||||
nearest supported watchdog timer period.
|
||||
|
||||
@param GetTimerPeriod Retrieves the amount of time in 100 ns units that the
|
||||
system will wait before the watchdog timer is fired.
|
||||
|
||||
**/
|
||||
struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {
|
||||
EFI_WATCHDOG_TIMER_REGISTER_HANDLER RegisterHandler;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user