The EFI_PXE_BASE_CODE_PROTOCOL handle also supports the\r
EFI_LOAD_FILE_PROTOCOL protocol. This provides a clean way to obtain control from the\r
boot manager if the boot path is from the remote device.\r
-\r
- @param Revision\r
- The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
- be backwards compatible. If a future version is not backwards compatible \r
- it is not the same GUID.\r
-\r
- @param Start\r
- Starts the PXE Base Code Protocol. Mode structure information is not valid and \r
- no other Base Code Protocol functions will operate until the Base Code is started. \r
-\r
- @param Stop\r
- Stops the PXE Base Code Protocol. Mode structure information is unchanged by this function. \r
- No Base Code Protocol functions will operate until the Base Code is restarted. \r
-\r
- @param Dhcp\r
- Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) \r
- or DHCPv6 S.A.R.R (solicit / advertise / request / reply) sequence. \r
-\r
- @param Discover\r
- Attempts to complete the PXE Boot Server and/or boot image discovery sequence. \r
-\r
- @param Mtftp\r
- Performs TFTP and MTFTP services. \r
-\r
- @param UdpWrite\r
- Writes a UDP packet to the network interface. \r
-\r
- @param UdpRead\r
- Reads a UDP packet from the network interface. \r
-\r
- @param SetIpFilter\r
- Updates the IP receive filters of the network device. \r
-\r
- @param Arp\r
- Uses the ARP protocol to resolve a MAC address. \r
-\r
- @param SetParameters\r
- Updates the parameters that affect the operation of the PXE Base Code Protocol. \r
-\r
- @param SetStationIp\r
- Updates the station IP address and subnet mask values. \r
-\r
- @param SetPackets\r
- Updates the contents of the cached DHCP and Discover packets. \r
-\r
- @param Mode\r
- Pointer to the EFI_PXE_BASE_CODE_MODE data for this device. \r
-\r
**/\r
struct _EFI_PXE_BASE_CODE_PROTOCOL {\r
+ ///\r
+ /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
+ /// be backwards compatible. If a future version is not backwards compatible \r
+ /// it is not the same GUID.\r
+ ///\r
UINT64 Revision;\r
EFI_PXE_BASE_CODE_START Start;\r
EFI_PXE_BASE_CODE_STOP Stop;\r
Protocol that is invoked when the PXE Base Code Protocol is about \r
to transmit, has received, or is waiting to receive a packet.\r
\r
- @param Revision\r
- The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
- be backwards compatible. If a future version is not backwards compatible \r
- it is not the same GUID.\r
-\r
- @param Callback\r
- Callback routine used by the PXE Base Code Dhcp(), Discover(), Mtftp(), \r
- UdpWrite(), and Arp() functions.\r
-\r
**/\r
struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL {\r
+ ///\r
+ /// The revision of the EFI_PXE_BASE_CODE_PROTOCOL. All future revisions must \r
+ /// be backwards compatible. If a future version is not backwards compatible \r
+ /// it is not the same GUID.\r
+ ///\r
UINT64 Revision;\r
EFI_PXE_CALLBACK Callback;\r
};\r
SetVirtualAddressMap() and ConvertPointer(), have been registered into the \r
EFI Runtime Table in the EFI System Partition. This protocol must be produced \r
by a runtime DXE driver and may only be consumed by the DXE Foundation.\r
-\r
- @param ImageHead\r
- A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
-\r
- @param EventHead\r
- A list of type EFI_RUNTIME_EVENT_ENTRY.\r
-\r
- @param MemoryDescriptorSize\r
- Size of a memory descriptor that is return by GetMemoryMap().\r
-\r
- @param MemoryDescriptorVersion\r
- Version of a memory descriptor that is return by GetMemoryMap().\r
-\r
- @param MemoryMapSize \r
- Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
-\r
- @param MemoryMapPhysical\r
- Pointer to a runtime buffer that contains a copy of \r
- the memory map returned via GetMemoryMap().\r
-\r
- @param MemoryMapVirtual\r
- Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().\r
-\r
- @param VirtualMode\r
- Boolean that is TRUE if SetVirtualAddressMap() has been called.\r
-\r
- @param AtRuntime\r
- Boolean that is TRUE if ExitBootServices () has been called.\r
-\r
**/\r
struct _EFI_RUNTIME_ARCH_PROTOCOL {\r
+ ///\r
+ /// A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
+ ///\r
EFI_LIST_ENTRY ImageHead;\r
+ \r
+ ///\r
+ /// A list of type EFI_RUNTIME_EVENT_ENTRY.\r
+ ///\r
EFI_LIST_ENTRY EventHead;\r
+ \r
+ ///\r
+ /// Size of a memory descriptor that is return by GetMemoryMap().\r
+ ///\r
UINTN MemoryDescriptorSize;\r
+ \r
+ ///\r
+ /// Version of a memory descriptor that is return by GetMemoryMap().\r
+ ///\r
UINT32 MemoryDesciptorVersion;\r
+ \r
+ ///\r
+ /// Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
+ ///\r
UINTN MemoryMapSize;\r
+ \r
+ ///\r
+ /// Pointer to a runtime buffer that contains a copy of \r
+ /// the memory map returned via GetMemoryMap().\r
+ ///\r
EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical;\r
+ \r
+ ///\r
+ /// Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().\r
+ ///\r
EFI_MEMORY_DESCRIPTOR *MemoryMapVirtual;\r
+ \r
+ ///\r
+ /// Boolean that is TRUE if SetVirtualAddressMap() has been called.\r
+ ///\r
BOOLEAN VirtualMode;\r
+ \r
+ ///\r
+ /// Boolean that is TRUE if ExitBootServices () has been called.\r
+ ///\r
BOOLEAN AtRuntime;\r
};\r
\r
/** \r
@par Protocol Description:\r
Provides services to manage and communicate with SCSI devices.\r
-\r
- @param GetDeviceType\r
- Retrieves the information of the device type which the SCSI device belongs to. \r
-\r
- @param GetDeviceLocation\r
- Retrieves the device location information in the SCSI bus. \r
-\r
- @param ResetBus\r
- Resets the entire SCSI bus the SCSI device attaches to. \r
-\r
- @param ResetDevice\r
- Resets the SCSI Device that is specified by the device handle the SCSI I/O \r
- protocol attaches. \r
-\r
- @param ExecuteScsiCommand\r
- Sends a SCSI command to the SCSI device and waits for the execution completion \r
- until an exit condition is met, or a timeout occurs. \r
-\r
- @param IoAlign\r
- Supplies the alignment requirement for any buffer used in a data transfer. \r
- IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory. \r
- Otherwise, IoAlign must be a power of 2, and the requirement is that the \r
- start address of a buffer must be evenly divisible by IoAlign with no remainder.\r
-\r
**/\r
struct _EFI_SCSI_IO_PROTOCOL {\r
EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE GetDeviceType;\r
EFI_SCSI_IO_PROTOCOL_RESET_BUS ResetBus;\r
EFI_SCSI_IO_PROTOCOL_RESET_DEVICE ResetDevice;\r
EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND ExecuteScsiCommand; \r
+\r
+ ///\r
+ /// Supplies the alignment requirement for any buffer used in a data transfer. \r
+ /// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory. \r
+ /// Otherwise, IoAlign must be a power of 2, and the requirement is that the \r
+ /// start address of a buffer must be evenly divisible by IoAlign with no remainder.\r
+ ///\r
UINT32 IoAlign;\r
};\r
\r
information includes the Target ID of the host controller on the SCSI channel, the attributes of\r
the SCSI channel, the printable name for the SCSI controller, and the printable name of the\r
SCSI channel.\r
-\r
- @param Mode \r
- A pointer to the EFI_SCSI_PASS_THRU_MODE data for this SCSI channel.\r
-\r
- @param PassThru \r
- Sends a SCSI Request Packet to a SCSI device that is connected to the SCSI channel.\r
-\r
- @param GetNextDevice \r
- Used to retrieve the list of legal Target IDs and LUNs for the\r
- SCSI devices on a SCSI channel. \r
-\r
- @param BuildDevicePath \r
- Used to allocate and build a device path node for a SCSI device on a SCSI channel.\r
-\r
- @param GetTargetLun \r
- Used to translate a device path node to a Target ID and LUN.\r
-\r
- @param ResetChannel \r
- Resets the SCSI channel. This operation resets all the SCSI\r
- devices connected to the SCSI channel.\r
-\r
- @param ResetTarget \r
- Resets a SCSI device that is connected to the SCSI channel. \r
**/\r
struct _EFI_SCSI_PASS_THRU_PROTOCOL {\r
EFI_SCSI_PASS_THRU_MODE *Mode;\r
and the ability to send SCI Request Packets to any SCSI device attached to \r
that SCSI channel. The information includes the Target ID of the host controller \r
on the SCSI channel and the attributes of the SCSI channel.\r
-\r
- @param Mode \r
- A pointer to the EFI_EXT_SCSI_PASS_THRU_MODE data for this SCSI channel. \r
-\r
- @param PassThru \r
- Sends a SCSI Request Packet to a SCSI device that is Connected to the SCSI channel. \r
-\r
- @param GetNextTargetLun \r
- Retrieves the list of legal Target IDs and LUNs for the SCSI devices on a SCSI channel. \r
-\r
- @param BuildDevicePath \r
- Allocates and builds a device path node for a SCSI Device on a SCSI channel. \r
-\r
- @param GetTargetLun\r
- Translates a device path node to a Target ID and LUN. \r
-\r
- @param ResetChannel\r
- Resets the SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel. \r
-\r
- @param ResetTargetLun\r
- Resets a SCSI device that is connected to the SCSI channel. \r
-\r
- @param GetNextTartget \r
- Retrieves the list of legal Target IDs for the SCSI devices on a SCSI channel. \r
**/ \r
struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL {\r
EFI_EXT_SCSI_PASS_THRU_MODE *Mode;\r
wrapped in an Authentication Section. See the Firmware File System \r
Specification for details on the GUIDed Section Extraction Protocol and \r
Authentication Sections.\r
-\r
- @param FileAuthenticationState\r
- This service is called upon fault with respect to \r
- the authentication of a section of a file.\r
-\r
**/\r
struct _EFI_SECURITY_ARCH_PROTOCOL {\r
EFI_SECURITY_FILE_AUTHENTICATION_STATE FileAuthenticationState;\r
The Serial I/O protocol is used to communicate with UART-style serial devices. \r
These can be standard UART serial ports in PC-AT systems, serial ports attached \r
to a USB interface, or potentially any character-based I/O device.\r
-\r
- @param Revision\r
- The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions \r
- must be backwards compatible. If a future version is not back wards compatible, \r
- it is not the same GUID.\r
-\r
- @param Reset\r
- Resets the hardware device.\r
-\r
- @param SetAttributes\r
- Sets communication parameters for a serial device. These include \r
- the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits, \r
- and stop bit attributes.\r
-\r
- @param SetControl\r
- Sets the control bits on a serial device. These include Request to \r
- Send and Data Terminal Ready.\r
-\r
- @param GetControl\r
- Reads the status of the control bits on a serial device. These include \r
- Clear to Send, Data Set Ready, Ring Indicator, and Carrier Detect.\r
-\r
- @param Write\r
- Sends a buffer of characters to a serial device.\r
-\r
- @param Read\r
- Receives a buffer of characters from a serial device.\r
-\r
- @param Mode\r
- Pointer to SERIAL_IO_MODE data. \r
- \r
**/\r
struct _EFI_SERIAL_IO_PROTOCOL {\r
+ ///\r
+ /// The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions \r
+ /// must be backwards compatible. If a future version is not back wards compatible, \r
+ /// it is not the same GUID.\r
+ ///\r
UINT32 Revision;\r
EFI_SERIAL_RESET Reset;\r
EFI_SERIAL_SET_ATTRIBUTES SetAttributes;\r
required behavior, not to specify the required implementation. Each consumer of \r
a software protocol is responsible for calling CreateChild() when it requires the \r
protocol and calling DestroyChild() when it is finished with that protocol.\r
-\r
- @param CreateChild\r
- Creates a child handle and installs a protocol.\r
-\r
- @param DestroyChild\r
- Destroys a child handle with a protocol installed on it.\r
**/\r
struct _EFI_SERVICE_BINDING_PROTOCOL {\r
EFI_SERVICE_BINDING_CREATE_CHILD CreateChild;\r
and is also a reference to a location in the directory tree of the file system \r
in which the file resides. With any given file handle, other files may be opened \r
relative to this file's location, yielding new file handles.\r
-\r
- @param Revision\r
- The version of the EFI_FILE_PROTOCOL interface. The version specified \r
- by this specification is 0x00010000. Future versions are required \r
- to be backward compatible to version 1.0.\r
-\r
- @param Open\r
- Opens or creates a new file. \r
-\r
- @param Close\r
- Closes the current file handle. \r
-\r
- @param Delete\r
- Deletes a file. \r
-\r
- @param Read\r
- Reads bytes from a file. \r
-\r
- @param Write\r
- Writes bytes to a file. \r
-\r
- @param GetPosition\r
- Returns the current file position. \r
-\r
- @param SetPosition\r
- Sets the current file position. \r
-\r
- @param GetInfo\r
- Gets the requested file or volume information. \r
-\r
- @param SetInfo\r
- Sets the requested file information. \r
-\r
- @param Flush\r
- Flushes all modified data associated with the file to the device. \r
**/\r
struct _EFI_FILE_PROTOCOL {\r
+ ///\r
+ /// The version of the EFI_FILE_PROTOCOL interface. The version specified \r
+ /// by this specification is 0x00010000. Future versions are required \r
+ /// to be backward compatible to version 1.0.\r
+ ///\r
UINT64 Revision;\r
EFI_FILE_OPEN Open;\r
EFI_FILE_CLOSE Close;\r
to a network adapter. Once the network adapter initializes, \r
the EFI_SIMPLE_NETWORK_PROTOCOL protocol provides services that \r
allow packets to be transmitted and received.\r
- \r
- @param Revision\r
- Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must \r
- be backwards compatible. If a future version is not backwards compatible \r
- it is not the same GUID.\r
-\r
- @param Start\r
- Prepares the network interface for further command operations. \r
- No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate \r
- until this call is made. \r
-\r
- @param Stop\r
- Stops further network interface command processing. \r
- No other EFI_SIMPLE_NETWORK_PROTOCOL interface functions will operate \r
- after this call is made until another Start() call is made. \r
-\r
- @param Initialize\r
- Resets the network adapter and allocates the transmit and receive buffers. \r
-\r
- @param Reset\r
- Resets the network adapter and reinitializes it with the parameters \r
- provided in the previous call to Initialize(). \r
-\r
- @param Shutdown\r
- Resets the network adapter and leaves it in a state safe for another driver \r
- to initialize. The memory buffers assigned in the Initialize() call are released. \r
- After this call, only the Initialize() or Stop() calls may be used. \r
-\r
- @param ReceiveFilters\r
- Enables and disables the receive filters for the network interface and, \r
- if supported, manages the filtered multicast \r
- HW MAC (Hardware Media Access Control) address list. \r
-\r
- @param StationAddress\r
- Modifies or resets the current station address, if supported. \r
-\r
- @param Statistics\r
- Collects statistics from the network interface and allows the statistics to be reset. \r
-\r
- @param MCastIpToMac\r
- Maps a multicast IP address to a multicast HW MAC address. \r
-\r
- @param NvData\r
- Reads and writes the contents of the NVRAM devices attached to the network interface. \r
-\r
- @param GetStatus\r
- Reads the current interrupt status and the list of recycled transmit \r
- buffers from the network interface. \r
-\r
- @param Transmit\r
- Places a packet in the transmit queue. \r
-\r
- @param Receive\r
- Retrieves a packet from the receive queue, along with the status \r
- flags that describe the packet type. \r
-\r
- @param WaitForPacket\r
- Event used with WaitForEvent() to wait for a packet to be received.\r
-\r
- @param Mode\r
- Pointer to the EFI_SIMPLE_NETWORK_MODE data for the device. \r
-\r
**/\r
struct _EFI_SIMPLE_NETWORK_PROTOCOL {\r
+ ///\r
+ /// Revision of the EFI_SIMPLE_NETWORK_PROTOCOL. All future revisions must \r
+ /// be backwards compatible. If a future version is not backwards compatible \r
+ /// it is not the same GUID.\r
+ ///\r
UINT64 Revision;\r
EFI_SIMPLE_NETWORK_START Start;\r
EFI_SIMPLE_NETWORK_STOP Stop;\r
EFI_SIMPLE_NETWORK_GET_STATUS GetStatus;\r
EFI_SIMPLE_NETWORK_TRANSMIT Transmit;\r
EFI_SIMPLE_NETWORK_RECEIVE Receive;\r
+ ///\r
+ /// Event used with WaitForEvent() to wait for a packet to be received.\r
+ ///\r
EFI_EVENT WaitForPacket;\r
EFI_SIMPLE_NETWORK_MODE *Mode;\r
};\r
to this specification. The services include the ability to reset the \r
pointer device, retrieve get the state of the pointer device, and \r
retrieve the capabilities of the pointer device.\r
-\r
- @param Reset\r
- Resets the pointer device. \r
-\r
- @param GetState\r
- Retrieves the current state of the pointer device. \r
-\r
- @param WaitForInput\r
- Event to use with WaitForEvent() to wait for input from the pointer device.\r
-\r
- @param Mode\r
- Pointer to EFI_SIMPLE_POINTER_MODE data. \r
**/\r
struct _EFI_SIMPLE_POINTER_PROTOCOL {\r
EFI_SIMPLE_POINTER_RESET Reset;\r
EFI_SIMPLE_POINTER_GET_STATE GetState;\r
+ ///\r
+ /// Event to use with WaitForEvent() to wait for input from the pointer device.\r
+ ///\r
EFI_EVENT WaitForInput;\r
EFI_SIMPLE_POINTER_MODE *Mode;\r
};\r
@par Protocol Description:\r
The EFI_SIMPLE_TEXT_INPUT_PROTOCOL is used on the ConsoleIn device. \r
It is the minimum required protocol for ConsoleIn.\r
-\r
- @param Reset\r
- Reset the ConsoleIn device.\r
-\r
- @param ReadKeyStroke\r
- Returns the next input character.\r
-\r
- @param WaitForKey\r
- Event to use with WaitForEvent() to wait for a key to be available.\r
-\r
**/\r
-\r
struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL {\r
EFI_INPUT_RESET Reset;\r
EFI_INPUT_READ_KEY ReadKeyStroke;\r
+ ///\r
+ /// Event to use with WaitForEvent() to wait for a key to be available\r
+ ///\r
EFI_EVENT WaitForKey;\r
};\r
\r
device. It is an extension to the Simple Text Input protocol\r
which allows a variety of extended shift state information to be\r
returned.\r
-\r
- @param Reset \r
- Reset the ConsoleIn device. See Reset().\r
-\r
- @param ReadKeyStrokeEx \r
- Returns the next input character.\r
-\r
- @param WaitForKeyEx \r
- Event to use with WaitForEvent() to wait for a key to be available.\r
-\r
- @param SetState \r
- Set the EFI_KEY_TOGGLE_STATE state settings for the input device.\r
-\r
- @param RegisterKeyNotify \r
- Register a notification function to be called when a given key sequence is hit.\r
-\r
- @param UnregisterKeyNotifyRemoves \r
- A specific notification function.\r
-\r
**/\r
struct _EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL{\r
EFI_INPUT_RESET_EX Reset;\r
EFI_INPUT_READ_KEY_EX ReadKeyStrokeEx;\r
+ ///\r
+ /// Event to use with WaitForEvent() to wait for a key to be available.\r
+ ///\r
EFI_EVENT WaitForKeyEx;\r
EFI_SET_STATE SetState;\r
EFI_REGISTER_KEYSTROKE_NOTIFY RegisterKeyNotify;\r
It is the minimum required protocol for any handle supplied as the ConsoleOut \r
or StandardError device. In addition, the minimum supported text mode of such \r
devices is at least 80 x 25 characters.\r
-\r
- @param Reset\r
- Reset the ConsoleOut device. \r
-\r
- @param OutputString\r
- Displays the Unicode string on the device at the current cursor location. \r
-\r
- @param TestString\r
- Tests to see if the ConsoleOut device supports this Unicode string.\r
-\r
- @param QueryMode\r
- Queries information concerning the output device's supported text mode. \r
-\r
- @param SetMode\r
- Sets the current mode of the output device. \r
-\r
- @param SetAttribute\r
- Sets the foreground and background color of the text that is output. \r
-\r
- @param ClearScreen\r
- Clears the screen with the currently set background color. \r
-\r
- @param SetCursorPosition\r
- Sets the current cursor position. \r
-\r
- @param EnableCursor\r
- Turns the visibility of the cursor on/off. \r
-\r
- @param Mode\r
- Pointer to SIMPLE_TEXT_OUTPUT_MODE data. \r
**/\r
struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {\r
EFI_TEXT_RESET Reset;\r
The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data\r
transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus\r
host controller.\r
-\r
- @param Execute Executes the SMBus operation to an SMBus slave\r
- device. See the Execute() function description.\r
- \r
- @param ArpDevice Allows an SMBus 2.0 device(s) to be Address\r
- Resolution Protocol (ARP).\r
- \r
- @param GetArpMap Allows a driver to retrieve the address that\r
- was allocated by the SMBus host controller\r
- during enumeration/ARP. See the GetArpMap()\r
- function description.\r
- \r
- @param Notify Allows a driver to register for a callback\r
- to the SMBus host controller driver when the\r
- bus issues a notification to the bus\r
- controller driver. See the Notify() function\r
- description.\r
**/\r
struct _EFI_SMBUS_HC_PROTOCOL {\r
EFI_SMBUS_HC_EXECUTE_OPERATION Execute;\r
This protocol must be produced by a runtime DXE driver and may be consumed \r
only by the DXE Foundation.\r
\r
- @param ReportStatusCode Emit a status code.\r
-\r
**/\r
typedef struct _EFI_STATUS_CODE_PROTOCOL {\r
EFI_REPORT_STATUS_CODE ReportStatusCode;\r
projects / mirror_edk2.git / commitdiff