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