/** \r
@par Protocol Description:\r
The EFI_LOAD_FILE_PROTOCOL is a simple protocol used to obtain files from arbitrary devices.\r
- \r
- @param LoadFile \r
- Causes the driver to load the requested file.\r
-\r
**/\r
struct _EFI_LOAD_FILE_PROTOCOL {\r
EFI_LOAD_FILE LoadFile;\r
/** \r
@par Protocol Description:\r
Can be used on any image handle to obtain information about the loaded image.\r
-\r
- @param Revision\r
- Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. \r
- All future revisions will be backward compatible to the current revision.\r
-\r
- @param ParentHandle\r
- Parent image's image handle. NULL if the image is loaded directly from \r
- the firmware's boot manager. \r
-\r
- @param SystemTable\r
- The image's EFI system table pointer. \r
-\r
- @param DeviceHandle\r
- The device handle that the EFI Image was loaded from. \r
-\r
- @param FilePath\r
- A pointer to the file path portion specific to DeviceHandle \r
- that the EFI Image was loaded from. \r
-\r
- @param Reserved\r
- Reserved. DO NOT USE.\r
-\r
- @param LoadOptionsSize\r
- The size in bytes of LoadOptions.\r
-\r
- @param LoadOptions\r
- A pointer to the image's binary load options.\r
-\r
- @param ImageBase\r
- The base address at which the image was loaded.\r
-\r
- @param ImageSize\r
- The size in bytes of the loaded image.\r
-\r
- @param ImageCodeType\r
- The memory \r
-\r
- @param ImageDataType\r
- The memory \r
-\r
- @param Unload\r
- Function that unloads the image. \r
-\r
**/\r
typedef struct {\r
+ ///\r
+ /// Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. \r
+ /// All future revisions will be backward compatible to the current revision.\r
+ ///\r
UINT32 Revision;\r
+\r
+ ///\r
+ /// Parent image's image handle. NULL if the image is loaded directly from \r
+ /// the firmware's boot manager. \r
+ ///\r
EFI_HANDLE ParentHandle;\r
EFI_SYSTEM_TABLE *SystemTable;\r
\r
//\r
// Source location of image\r
//\r
+ ///\r
+ /// The device handle that the EFI Image was loaded from. \r
+ ///\r
EFI_HANDLE DeviceHandle;\r
+ \r
+ ///\r
+ /// A pointer to the file path portion specific to DeviceHandle \r
+ /// that the EFI Image was loaded from. \r
+ ///\r
EFI_DEVICE_PATH_PROTOCOL *FilePath;\r
- VOID *Reserved;\r
+ VOID *Reserved; ///< Reserved. DO NOT USE.\r
\r
//\r
// Images load options\r
//\r
+ ///\r
+ /// The size in bytes of LoadOptions.\r
+ ///\r
UINT32 LoadOptionsSize;\r
+ \r
+ ///\r
+ /// A pointer to the image's binary load options.\r
+ ///\r
VOID *LoadOptions;\r
\r
//\r
// Location of where image was loaded\r
//\r
+ ///\r
+ /// The base address at which the image was loaded.\r
+ ///\r
VOID *ImageBase;\r
+ \r
+ ///\r
+ /// The size in bytes of the loaded image.\r
+ ///\r
UINT64 ImageSize;\r
EFI_MEMORY_TYPE ImageCodeType;\r
EFI_MEMORY_TYPE ImageDataType;\r
@par Protocol Description:\r
The MNP is used by network applications (and drivers) to \r
perform raw (unformatted) asynchronous network packet I/O.\r
- \r
- @param GetModeData\r
- Returns the current MNP child driver operational parameters. \r
- May also support returning underlying Simple Network Protocol (SNP) driver mode data. \r
-\r
- @param Configure\r
- Sets and clears operational parameters for an MNP child driver. \r
-\r
- @param McastIpToMac\r
- Translates a software (IP) multicast address to a hardware (MAC) multicast address. \r
- This function may be unsupported in some MNP implementations. \r
-\r
- @param Groups\r
- Enables and disables receive filters for multicast addresses. \r
- This function may be unsupported in some MNP implementations. \r
-\r
- @param Transmit\r
- Places asynchronous outgoing data packets into the transmit queue. \r
-\r
- @param Receive\r
- Places an asynchronous receiving request into the receiving queue. \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
**/\r
struct _EFI_MANAGED_NETWORK_PROTOCOL {\r
EFI_MANAGED_NETWORK_GET_MODE_DATA GetModeData;\r
IN UINT32 TickNumber\r
);\r
\r
-//\r
-//\r
-\r
/**\r
Interface stucture for the Metronome Architectural Protocol.\r
\r
function and the first tick is between 0 and TickPeriod 100 nS \r
units. If you want to guarantee that at least TickPeriod time \r
has elapsed, wait for two ticks.\r
-\r
- @param TickPeriod\r
- The period of platform's known time source in 100 nS units. \r
- This value on any platform must be at least 10 uS, and must not \r
- exceed 200 uS. The value in this field is a constant that must \r
- not be modified after the Metronome architectural protocol is \r
- installed. All consumers must treat this as a read-only field.\r
-\r
**/\r
struct _EFI_METRONOME_ARCH_PROTOCOL {\r
EFI_METRONOME_WAIT_FOR_TICK WaitForTick;\r
+ \r
+ ///\r
+ /// The period of platform's known time source in 100 nS units. \r
+ /// This value on any platform must be at least 10 uS, and must not \r
+ /// exceed 200 uS. The value in this field is a constant that must \r
+ /// not be modified after the Metronome architectural protocol is \r
+ /// installed. All consumers must treat this as a read-only field. \r
+ ///\r
UINT32 TickPeriod;\r
};\r
\r
The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications \r
to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses \r
the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.\r
-\r
- @param GetModeData\r
- Reads the current operational settings. \r
-\r
- @param Configure\r
- Initializes, changes, or resets the operational settings for \r
- this instance of the EFI MTFTPv4 Protocol driver. \r
-\r
- @param GetInfo\r
- Retrieves information about a file from an MTFTPv4 server. \r
-\r
- @param ParseOptions\r
- Parses the options in an MTFTPv4 OACK (options acknowledgement) packet. \r
-\r
- @param ReadFile\r
- Downloads a file from an MTFTPv4 server. \r
-\r
- @param WriteFile\r
- Uploads a file to an MTFTPv4 server. This function may be unsupported \r
- in some EFI implementations. \r
-\r
- @param ReadDirectory\r
- Downloads a related file directory from an MTFTPv4 server. This function \r
- may be unsupported in some EFI implementations. \r
-\r
- @param Poll\r
- Polls for incoming data packets and processes outgoing data packets. \r
-\r
**/ \r
struct _EFI_MTFTP4_PROTOCOL {\r
EFI_MTFTP4_GET_MODE_DATA GetModeData;\r
@par Protocol Description:\r
An optional protocol that is used to describe details about the software \r
layer that is used to produce the Simple Network Protocol. \r
-\r
- @param Revision\r
- The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.\r
-\r
- @param Id\r
- Address of the first byte of the identifying structure for this network \r
- interface. This is only valid when the network interface is started \r
- (see Start()). When the network interface is not started, this field is set to zero.\r
-\r
- @param ImageAddr\r
- Address of the unrelocated network interface image.\r
-\r
- @param ImageSize\r
- Size of unrelocated network interface image.\r
-\r
- @param StringId\r
- A four-character ASCII string that is sent in the class identifier field of\r
- option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.\r
-\r
- @param Type\r
- Network interface type. This will be set to one of the values \r
- in EFI_NETWORK_INTERFACE_TYPE.\r
-\r
- @param MajorVer\r
- Major version number.\r
-\r
- @param MinorVer\r
- Minor version number.\r
-\r
- @param Ipv6Supported\r
- TRUE if the network interface supports IPv6; otherwise FALSE.\r
-\r
- @param IfNum\r
- The network interface number that is being identified by this Network \r
- Interface Identifier Protocol. This field must be less than or equal \r
- to the IFcnt field in the !PXE structure.\r
-\r
**/\r
struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL {\r
-\r
+ ///\r
+ /// The revision of the EFI_NETWORK_INTERFACE_IDENTIFIER protocol.\r
+ ///\r
UINT64 Revision;\r
- //\r
- // Revision of the network interface identifier protocol interface.\r
- //\r
+ \r
+ ///\r
+ /// Address of the first byte of the identifying structure for this network \r
+ /// interface. This is only valid when the network interface is started \r
+ /// (see Start()). When the network interface is not started, this field is set to zero.\r
+ ///\r
UINT64 ID;\r
- //\r
- // Address of the first byte of the identifying structure for this\r
- // network interface. This is set to zero if there is no structure.\r
- //\r
- // For PXE/UNDI this is the first byte of the !PXE structure.\r
- //\r
+ \r
+ ///\r
+ /// Address of the first byte of the identifying structure for this\r
+ /// network interface. This is set to zero if there is no structure.\r
+ ///\r
+ /// For PXE/UNDI this is the first byte of the !PXE structure.\r
+ ///\r
UINT64 ImageAddr;\r
- //\r
- // Address of the UNrelocated driver/ROM image. This is set\r
- // to zero if there is no driver/ROM image.\r
- //\r
- // For 16-bit UNDI, this is the first byte of the option ROM in\r
- // upper memory.\r
- //\r
- // For 32/64-bit S/W UNDI, this is the first byte of the EFI ROM\r
- // image.\r
- //\r
- // For H/W UNDI, this is set to zero.\r
- //\r
+ \r
+ ///\r
+ /// Size of unrelocated network interface image.\r
+ ///\r
UINT32 ImageSize;\r
- //\r
- // Size of the UNrelocated driver/ROM image of this network interface.\r
- // This is set to zero if there is no driver/ROM image.\r
- //\r
+ \r
+ ///\r
+ /// A four-character ASCII string that is sent in the class identifier field of\r
+ /// option 60 in DHCP. For a Type of EfiNetworkInterfaceUndi, this field is UNDI.\r
+ ///\r
CHAR8 StringId[4];\r
- //\r
- // 4 char ASCII string to go in class identifier (option 60) in DHCP\r
- // and Boot Server discover packets.\r
- // For EfiNetworkInterfaceUndi this field is "UNDI".\r
- // For EfiNetworkInterfaceSnp this field is "SNPN".\r
- //\r
+ \r
+ ///\r
+ /// Network interface type. This will be set to one of the values \r
+ /// in EFI_NETWORK_INTERFACE_TYPE.\r
+ ///\r
UINT8 Type;\r
- UINT8 MajorVer;\r
- UINT8 MinorVer;\r
- //\r
- // Information to be placed into the PXE DHCP and Discover packets.\r
- // This is the network interface type and version number that will\r
- // be placed into DHCP option 94 (client network interface identifier).\r
- //\r
+ \r
+ UINT8 MajorVer; ///< Major version number.\r
+ UINT8 MinorVer; ///< Minor version number.\r
+ \r
+ ///\r
+ /// TRUE if the network interface supports IPv6; otherwise FALSE.\\r
+ ///\r
BOOLEAN Ipv6Supported;\r
- UINT8 IfNum; // interface number to be used with pxeid structure\r
+\r
+ ///\r
+ /// The network interface number that is being identified by this Network \r
+ /// Interface Identifier Protocol. This field must be less than or equal \r
+ /// to the IFcnt field in the !PXE structure.\r
+ ///\r
+ UINT8 IfNum;\r
};\r
\r
extern EFI_GUID gEfiNetworkInterfaceIdentifierProtocolGuid;\r
/**\r
@par Protocol Description:\r
This service abstracts the ability to set/get Platform Configuration Database (PCD).\r
-\r
- @param SetSku\r
- Sets the SKU value for subsequent calls to set or get PCD token values.\r
- \r
- @param Get8\r
- Retrieves an 8-bit value for a given PCD token.\r
-\r
- @param Get16\r
- Retrieves an 16-bit value for a given PCD token.\r
-\r
- @param Get32\r
- Retrieves an 32-bit value for a given PCD token.\r
-\r
- @param Get64\r
- Retrieves an 64-bit value for a given PCD token.\r
-\r
- @param GetPtr\r
- Retrieves a pointer to a value for a given PCD token.\r
-\r
- @param GetBool\r
- Retrieves an Boolean value for a given PCD token.\r
-\r
- @param GetSize\r
- Retrieves the size of the value for a given PCD token.\r
-\r
- @param Get8Ex\r
- Retrieves an 8-bit value for a given PCD token and token space.\r
-\r
- @param Get16Ex\r
- Retrieves an 16-bit value for a given PCD token and token space.\r
-\r
- @param Get32Ex\r
- Retrieves an 32-bit value for a given PCD token and token space.\r
-\r
- @param Get64Ex\r
- Retrieves an 64-bit value for a given PCD token and token space.\r
-\r
- @param GetPtrEx\r
- Retrieves a pointer to a value for a given PCD token and token space.\r
-\r
- @param GetBoolEx\r
- Retrieves an Boolean value for a given PCD token and token space.\r
-\r
- @param GetSizeEx\r
- Retrieves the size of the value for a given PCD token and token space.\r
-\r
- @param Set8\r
- Sets an 8-bit value for a given PCD token.\r
-\r
- @param Set16\r
- Sets an 16-bit value for a given PCD token.\r
-\r
- @param Set32\r
- Sets an 32-bit value for a given PCD token.\r
-\r
- @param Set64\r
- Sets an 64-bit value for a given PCD token.\r
-\r
- @param SetPtr\r
- Sets the buffer of a specified size for a given PCD token.\r
-\r
- @param SetBool\r
- Sets an Boolean value for a given PCD token.\r
-\r
- @param Set8Ex\r
- Sets an 8-bit value for a given PCD token and token space.\r
-\r
- @param Set16Ex\r
- Sets an 16-bit value for a given PCD token and token space.\r
-\r
- @param Set32Ex\r
- Sets an 32-bit value for a given PCD token and token space.\r
-\r
- @param Set64Ex\r
- Sets an 64-bit value for a given PCD token and token space.\r
-\r
- @param SetPtrEx\r
- Sets the buffer of a specified size for a given PCD token and token space.\r
-\r
- @param SetBoolEx\r
- Sets an Boolean value for a given PCD token and token space.\r
- \r
- @param CallbackOnSet\r
- Specifies a function to be called anytime the value of a designated token is changed.\r
- \r
- @param CancelCallback\r
- Cancels a previously set callback function for a particular PCD token number.\r
- \r
- @param GetNextToken\r
- Retrieves the next valid PCD token for a given namespace.\r
- \r
- @param GetNextTokenSpace\r
- Retrieves the next valid PCD token namespace for a given namespace.\r
- \r
**/\r
typedef struct {\r
PCD_PROTOCOL_SET_SKU SetSku;\r
//\r
// Complete PCI address generater\r
//\r
-#define EFI_PCI_IO_PASS_THROUGH_BAR 0xff // Special BAR that passes a memory or I/O cycle through unchanged\r
-#define EFI_PCI_IO_ATTRIBUTE_MASK 0x077f // All the following I/O and Memory cycles\r
-#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001 // I/O cycles 0x0000-0x00FF (10 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002 // I/O cycles 0x0100-0x03FF or greater (10 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004 // I/O cycles 0x3C6, 0x3C8, 0x3C9 (10 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008 // MEM cycles 0xA0000-0xBFFFF (24 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010 // I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (10 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020 // I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040 // I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 // Map a memory range so write are combined\r
-#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100 // Enable the I/O decode bit in the PCI Config Header\r
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200 // Enable the Memory decode bit in the PCI Config Header\r
-#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400 // Enable the DMA bit in the PCI Config Header\r
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800 // Map a memory range so all r/w accesses are cached\r
-#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 // Disable a memory range\r
-#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000 // Clear for an add-in PCI Device\r
-#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000 // Clear for a physical PCI Option ROM accessed through ROM BAR\r
-#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000 // Clear for PCI controllers that can not genrate a DAC\r
-#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000 // I/O cycles 0x0100-0x03FF or greater (16 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000 // I/O cycles 0x3C6, 0x3C8, 0x3C9 (16 bit decode)\r
-#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x30000 // I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (16 bit decode)\r
+#define EFI_PCI_IO_PASS_THROUGH_BAR 0xff ///< Special BAR that passes a memory or I/O cycle through unchanged\r
+#define EFI_PCI_IO_ATTRIBUTE_MASK 0x077f ///< All the following I/O and Memory cycles\r
+#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001 ///< I/O cycles 0x0000-0x00FF (10 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002 ///< I/O cycles 0x0100-0x03FF or greater (10 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004 ///< I/O cycles 0x3C6, 0x3C8, 0x3C9 (10 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008 ///< MEM cycles 0xA0000-0xBFFFF (24 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010 ///< I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (10 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020 ///< I/O cycles 0x1F0-0x1F7, 0x3F6, 0x3F7 (10 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040 ///< I/O cycles 0x170-0x177, 0x376, 0x377 (10 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 ///< Map a memory range so write are combined\r
+#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100 ///< Enable the I/O decode bit in the PCI Config Header\r
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200 ///< Enable the Memory decode bit in the PCI Config Header\r
+#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400 ///< Enable the DMA bit in the PCI Config Header\r
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800 ///< Map a memory range so all r/w accesses are cached\r
+#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 ///< Disable a memory range\r
+#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000 ///< Clear for an add-in PCI Device\r
+#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000 ///< Clear for a physical PCI Option ROM accessed through ROM BAR\r
+#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000 ///< Clear for PCI controllers that can not genrate a DAC\r
+#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000 ///< I/O cycles 0x0100-0x03FF or greater (16 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000 ///< I/O cycles 0x3C6, 0x3C8, 0x3C9 (16 bit decode)\r
+#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x30000 ///< I/O cycles 0x3B0-0x3BB and 0x3C0-0x3DF (16 bit decode)\r
\r
#define EFI_PCI_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER)\r
#define EFI_VGA_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO | EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY | EFI_PCI_IO_ATTRIBUTE_VGA_IO | EFI_PCI_IO_ATTRIBUTE_IO)\r
There is one EFI_PCI_IO_PROTOCOL instance for each PCI controller on a PCI bus. \r
A device driver that wishes to manage a PCI controller in a system will have to \r
retrieve the EFI_PCI_IO_PROTOCOL instance that is associated with the PCI controller. \r
-\r
- @param PollMem\r
- Polls an address in PCI memory space until an exit condition is met, or a timeout occurs. \r
-\r
- @param PollIo\r
- Polls an address in PCI I/O space until an exit condition is met, or a timeout occurs. \r
-\r
- @param Mem.Read\r
- Allows BAR relative reads to PCI memory space. \r
-\r
- @param Mem.Write\r
- Allows BAR relative writes to PCI memory space. \r
-\r
- @param Io.Read\r
- Allows BAR relative reads to PCI I/O space. \r
-\r
- @param Io.Write\r
- Allows BAR relative writes to PCI I/O space. \r
-\r
- @param Pci.Read\r
- Allows PCI controller relative reads to PCI configuration space. \r
-\r
- @param Pci.Write\r
- Allows PCI controller relative writes to PCI configuration space. \r
-\r
- @param CopyMem\r
- Allows one region of PCI memory space to be copied to another region of PCI memory space. \r
-\r
- @param Map\r
- Provides the PCI controller's specific address needed to access system memory for DMA. \r
-\r
- @param Unmap\r
- Releases any resources allocated by Map(). \r
-\r
- @param AllocateBuffer\r
- Allocates pages that are suitable for a common buffer mapping. \r
-\r
- @param FreeBuffer\r
- Frees pages that were allocated with AllocateBuffer(). \r
-\r
- @param Flush\r
- Flushes all PCI posted write transactions to system memory. \r
-\r
- @param GetLocation\r
- Retrieves this PCI controller's current PCI bus number, device number, and function number. \r
-\r
- @param Attributes\r
- Performs an operation on the attributes that this PCI controller supports. \r
- The operations include getting the set of supported attributes, retrieving \r
- the current attributes, setting the current\r
- attributes, enabling attributes, and disabling attributes. \r
-\r
- @param GetBarAttributes\r
- Gets the attributes that this PCI controller supports setting on a BAR using \r
- SetBarAttributes(), and retrieves the list of resource descriptors for a BAR. \r
-\r
- @param SetBarAttributes\r
- Sets the attributes for a range of a BAR on a PCI controller. \r
-\r
- @param RomSize\r
- The size, in bytes, of the ROM image.\r
-\r
- @param RomImage\r
- A pointer to the in memory copy of the ROM image. The PCI Bus Driver is responsible \r
- for allocating memory for the ROM image, and copying the contents of the ROM to memory. \r
- The contents of this buffer are either from the PCI option ROM that can be accessed \r
- through the ROM BAR of the PCI controller, or it is from a platform-specific location. \r
- The Attributes() function can be used to determine from which of these two sources \r
- the RomImage buffer was initialized.\r
-\r
**/\r
struct _EFI_PCI_IO_PROTOCOL {\r
EFI_PCI_IO_PROTOCOL_POLL_IO_MEM PollMem;\r
EFI_PCI_IO_PROTOCOL_ATTRIBUTES Attributes;\r
EFI_PCI_IO_PROTOCOL_GET_BAR_ATTRIBUTES GetBarAttributes;\r
EFI_PCI_IO_PROTOCOL_SET_BAR_ATTRIBUTES SetBarAttributes;\r
+ \r
+ ///\r
+ /// The size, in bytes, of the ROM image.\r
+ ///\r
UINT64 RomSize;\r
+\r
+ ///\r
+ /// A pointer to the in memory copy of the ROM image. The PCI Bus Driver is responsible \r
+ /// for allocating memory for the ROM image, and copying the contents of the ROM to memory. \r
+ /// The contents of this buffer are either from the PCI option ROM that can be accessed \r
+ /// through the ROM BAR of the PCI controller, or it is from a platform-specific location. \r
+ /// The Attributes() function can be used to determine from which of these two sources \r
+ /// the RomImage buffer was initialized.\r
+ /// \r
VOID *RomImage;\r
};\r
\r
@par Protocol Description:\r
Provides the basic Memory, I/O, PCI configuration, and DMA interfaces that are \r
used to abstract accesses to PCI controllers behind a PCI Root Bridge Controller. \r
- \r
- @param ParentHandle\r
- The EFI_HANDLE of the PCI Host Bridge of which this PCI Root Bridge is a member.\r
-\r
- @param PollMem\r
- Polls an address in memory mapped I/O space until an exit condition is met, \r
- or a timeout occurs. \r
-\r
- @param PollIo\r
- Polls an address in I/O space until an exit condition is met, or a timeout occurs. \r
-\r
- @param Mem.Read\r
- Allows reads from memory mapped I/O space. \r
-\r
- @param Mem.Write\r
- Allows writes to memory mapped I/O space. \r
-\r
- @param Io.Read\r
- Allows reads from I/O space. \r
-\r
- @param Io.Write\r
- Allows writes to I/O space. \r
-\r
- @param Pci.Read\r
- Allows reads from PCI configuration space. \r
-\r
- @param Pci.Write\r
- Allows writes to PCI configuration space. \r
-\r
- @param CopyMem\r
- Allows one region of PCI root bridge memory space to be copied to another \r
- region of PCI root bridge memory space. \r
-\r
- @param Map\r
- Provides the PCI controller's specific addresses needed to access system memory for DMA. \r
-\r
- @param Unmap\r
- Releases any resources allocated by Map(). \r
-\r
- @param AllocateBuffer\r
- Allocates pages that are suitable for a common buffer mapping. \r
-\r
- @param FreeBuffer\r
- Free pages that were allocated with AllocateBuffer(). \r
-\r
- @param Flush\r
- Flushes all PCI posted write transactions to system memory. \r
-\r
- @param GetAttributes\r
- Gets the attributes that a PCI root bridge supports setting with SetAttributes(), \r
- and the attributes that a PCI root bridge is currently using. \r
-\r
- @param SetAttributes\r
- Sets attributes for a resource range on a PCI root bridge. \r
-\r
- @param Configuration\r
- Gets the current resource settings for this PCI root bridge. \r
-\r
- @param SegmentNumber\r
- The segment number that this PCI root bridge resides.\r
-\r
**/\r
struct _EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL {\r
+ ///\r
+ /// The EFI_HANDLE of the PCI Host Bridge of which this PCI Root Bridge is a member.\r
+ ///\r
EFI_HANDLE ParentHandle;\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM PollMem;\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_POLL_IO_MEM PollIo;\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_GET_ATTRIBUTES GetAttributes;\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_SET_ATTRIBUTES SetAttributes;\r
EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_CONFIGURATION Configuration;\r
+ \r
+ ///\r
+ /// The segment number that this PCI root bridge resides.\r
+ ///\r
UINT32 SegmentNumber;\r
};\r
\r
or drivers found from the general UEFI driver Binding search algorithm. If more \r
than one driver is returned by this protocol, then the drivers are returned in \r
order from highest precedence to lowest precedence.\r
-\r
- @param GetDriver\r
- Retrieves the image handle of a platform override driver for a controller in the system. \r
-\r
- @param GetDriverPath\r
- Retrieves the device path of a platform override driver for a controller in the system. \r
-\r
- @param DriverLoaded\r
- This function is used after a driver has been loaded using a device path returned \r
- by GetDriverPath(). This function associates a device path to an image handle, \r
- so the image handle can be returned the next time that GetDriver() is called for \r
- the same controller. \r
-\r
**/\r
struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL {\r
EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER GetDriver;\r
IN OUT UINTN *ParameterBlockSize\r
);\r
\r
-/**\r
-\r
- @param EfiPlatformConfigurationActionNone\r
- The controller specified by ControllerHandle is still\r
- in a usable state, it's configuration has been updated\r
- via parsing the ParameterBlock. If required by the\r
- parameter block and the module supports an NVRAM store\r
- the configuration information from PB was successfully\r
- saved to the NVRAM. No actions are required before\r
- this controller can be used again with the updated\r
- configuration settings.\r
-\r
-\r
- @param EfiPlatformConfigurationStopController \r
- The driver has detected that the controller specified\r
- by ControllerHandle is not in a usable state, and it\r
- needs to be stopped. The calling agent can use the\r
- DisconnectControservice to perform this operation, and\r
- it should be performed as soon as possible.\r
-\r
- @param EfiPlatformConfigurationRestartController\r
- This controller specified by ControllerHandle needs to\r
- be stopped and restarted before it can be used again.\r
- The calling agent can use the DisconnectController()\r
- and ConnectController() services to perform this\r
- operation. The restart operation can be delayed until\r
- all of the configuratiooptions have been set.\r
-\r
-\r
- @param EfiPlatformConfigurationRestartPlatform\r
- A configuration change has been made that requires the\r
- platform to be restarted before the controller\r
- specified by ControllerHandle can be used again. The\r
- calling agent can use the ResetSystem() services to\r
- perform this operation. The restart operation can be\r
- delayed until all of the configuration options have\r
- been set.\r
-\r
- @param EfiPlatformConfigurationActionNvramFailed \r
- The controller specified by ControllerHandle is still\r
- in a usable state; its configuration has been updated\r
- via parsing the ParameterBlock. The driver tried to\r
- update the driver's private NVRAM store with\r
- information from ParameterBlock and failed. No actions\r
- are required before this controller can be used again\r
- with the updated configuration settings, but these\r
- configuration settings are not guaranteed to persist\r
- after ControllerHandle is stopped.\r
-\r
-**/\r
typedef enum {\r
+ ///\r
+ /// The controller specified by ControllerHandle is still\r
+ /// in a usable state, it's configuration has been updated\r
+ /// via parsing the ParameterBlock. If required by the\r
+ /// parameter block and the module supports an NVRAM store\r
+ /// the configuration information from PB was successfully\r
+ /// saved to the NVRAM. No actions are required before\r
+ /// this controller can be used again with the updated\r
+ /// configuration settings.\r
+ ///\r
EfiPlatformConfigurationActionNone = 0,\r
+ \r
+ ///\r
+ /// The driver has detected that the controller specified\r
+ /// by ControllerHandle is not in a usable state, and it\r
+ /// needs to be stopped. The calling agent can use the\r
+ /// DisconnectControservice to perform this operation, and\r
+ /// it should be performed as soon as possible. \r
+ ///\r
EfiPlatformConfigurationActionStopController = 1,\r
+ \r
+ ///\r
+ /// This controller specified by ControllerHandle needs to\r
+ /// be stopped and restarted before it can be used again.\r
+ /// The calling agent can use the DisconnectController()\r
+ /// and ConnectController() services to perform this\r
+ /// operation. The restart operation can be delayed until\r
+ /// all of the configuratiooptions have been set. \r
+ ///\r
EfiPlatformConfigurationActionRestartController = 2,\r
+ \r
+ ///\r
+ /// A configuration change has been made that requires the\r
+ /// platform to be restarted before the controller\r
+ /// specified by ControllerHandle can be used again. The\r
+ /// calling agent can use the ResetSystem() services to\r
+ /// perform this operation. The restart operation can be\r
+ /// delayed until all of the configuration options have\r
+ /// been set. \r
+ ///\r
EfiPlatformConfigurationActionRestartPlatform = 3,\r
+\r
+ ///\r
+ /// The controller specified by ControllerHandle is still\r
+ /// in a usable state; its configuration has been updated\r
+ /// via parsing the ParameterBlock. The driver tried to\r
+ /// update the driver's private NVRAM store with\r
+ /// information from ParameterBlock and failed. No actions\r
+ /// are required before this controller can be used again\r
+ /// with the updated configuration settings, but these\r
+ /// configuration settings are not guaranteed to persist\r
+ /// after ControllerHandle is stopped. \r
+ /// \r
EfiPlatformConfigurationActionNvramFailed = 4,\r
EfiPlatformConfigurationActionMaximum\r
} EFI_PLATFORM_CONFIGURATION_ACTION;\r
versions of the DMTF SM CLP Specification require changes to the\r
parameter block definition, newer ParameterTypeGuid will be\r
used.\r
-\r
- @param CLPCommand A pointer to the DMTF SM CLP command line\r
- null-terminated string that the driver is\r
- required to parse and process when this\r
- EFI_SUCCESS The platform return parameter\r
- information for ControllerHandle.\r
- EFI_NOT_FOUND Instance was not found.\r
- EFI_INVALID_PARAMETER ControllerHandle is\r
- not a valid EFI_HANDLE.\r
- EFI_INVALID_PARAMETER Instance is zero.\r
- function is called. See the DMTF SM CLP\r
- Specification 1.0 Final Standard for\r
- details on the format and syntax of the\r
- CLP command line string. CLPCommand buffer\r
- is allocated by the producer of the\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
-\r
- @param CLPCommandLength The length of the CLP Command in bytes.\r
-\r
- @param CLPReturnString A pointer to the CLP return status\r
- string that the driver is required to\r
- provide to the calling agent. The\r
- calling agent may parse and/ or pass\r
- this for processing and user feedback.\r
- The SM CLP Command Response string\r
- buffer is filled in by the UEFI driver\r
- in the "keyword=value" format\r
- described in the SM CLP Specification,\r
- unless otherwise requested via the SM\r
- CLP Coutput option in the Command Line\r
- string buffer. UEFI driver's support\r
- for this default "keyword=value"\r
- output format is required if the UEFI\r
- driver supports this protocol, while\r
- support for other SM CLP output\r
- formats is optional (the UEFI Driver\r
- should return an EFI_UNSUPPORTED if\r
- the SM CLP Coutput option requested by\r
- the caller is not supported by the\r
- UEFI Driver). CLPReturnString buffer\r
- is allocated by the consumer of the\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC\r
- OL and undefined prior to the call to\r
- Response().\r
-\r
- @param CLPReturnStringLength The length of the CLP return\r
- status string in bytes.\r
-\r
- @param CLPReturnStatus SM CLP Command Status (see DMTF SM CLP\r
- Specification 1.0 Final Standard -\r
- Table 4) CLPErrorValue SM CLP\r
- Processing Error Value (see DMTF SM\r
- CLP Specification 1.0 Final Standard -\r
- Table 6). This field is filled in by\r
- the consumer of the\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC \r
- OL and undefined prior to the call to\r
- Response().\r
-\r
- @param CLPMessageCode Bit 15: OEM Message Code Flag 0 =\r
- Message Code is an SM CLP Probable\r
- Cause Value. (see SM CLP Specification\r
- Table 11) 1 = Message Code is OEM\r
- Specific Bits 14-0: Message Code This\r
- field is filled in by the consumer of\r
- the\r
- EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC\r
- OL and undefined prior to the call to\r
- Response().\r
-\r
**/\r
typedef struct {\r
+ ///\r
+ /// A pointer to the DMTF SM CLP command line null-terminated string that the \r
+ /// driver is required to parse and process when this EFI_SUCCESS The platform \r
+ /// return parameter information for ControllerHandle. EFI_NOT_FOUND Instance \r
+ /// was not found. EFI_INVALID_PARAMETER ControllerHandle is not a valid \r
+ /// EFI_HANDLE. EFI_INVALID_PARAMETER Instance is zero. function is called. \r
+ /// See the DMTF SM CLP Specification 1.0 Final Standard for details on the \r
+ /// format and syntax of the CLP command line string. CLPCommand buffer\r
+ /// is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.\r
+ ///\r
CHAR8 *CLPCommand;\r
+ \r
+ ///\r
+ /// The length of the CLP Command in bytes.\r
+ ///\r
UINT32 CLPCommandLength;\r
+ \r
+ ///\r
+ /// A pointer to the CLP return status string that the driver is required to\r
+ /// provide to the calling agent. The calling agent may parse and/ or pass\r
+ /// this for processing and user feedback. The SM CLP Command Response string\r
+ /// buffer is filled in by the UEFI driver in the "keyword=value" format\r
+ /// described in the SM CLP Specification, unless otherwise requested via the SM\r
+ /// CLP Coutput option in the Command Line string buffer. UEFI driver's support\r
+ /// for this default "keyword=value" output format is required if the UEFI\r
+ /// driver supports this protocol, while support for other SM CLP output\r
+ /// formats is optional (the UEFI Driver should return an EFI_UNSUPPORTED if\r
+ /// the SM CLP Coutput option requested by the caller is not supported by the\r
+ /// UEFI Driver). CLPReturnString buffer is allocated by the consumer of the\r
+ /// EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
+ /// Response(). \r
+ ///\r
CHAR8 *CLPReturnString;\r
+ \r
+ ///\r
+ /// The length of the CLP return status string in bytes.\r
+ ///\r
UINT32 CLPReturnStringLength;\r
+ \r
+ ///\r
+ /// SM CLP Command Status (see DMTF SM CLP Specification 1.0 Final Standard -\r
+ /// Table 4) CLPErrorValue SM CLP Processing Error Value (see DMTF SM\r
+ /// CLP Specification 1.0 Final Standard - Table 6). This field is filled in by\r
+ /// the consumer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC \r
+ /// OL and undefined prior to the call to Response(). \r
+ ///\r
UINT8 CLPCmdStatus;\r
UINT8 CLPErrorValue;\r
+ \r
+ ///\r
+ /// Bit 15: OEM Message Code Flag 0 = Message Code is an SM CLP Probable\r
+ /// Cause Value. (see SM CLP Specification Table 11) 1 = Message Code is OEM\r
+ /// Specific Bits 14-0: Message Code This field is filled in by the consumer of\r
+ /// the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOC OL and undefined prior to the call to\r
+ /// Response(). \r
+ /// \r
UINT16 CLPMsgCode;\r
} EFI_CONFIGURE_CLP_PARAMETER_BLK;\r
\r
projects / mirror_edk2.git / commitdiff