-/** @file \r
- Wrapper routines that use a PXE-enabled NIC option ROM to \r
- supply internal routines for an EFI SNI (Simple Network \r
+/** @file\r
+ Wrapper routines that use a PXE-enabled NIC option ROM to\r
+ supply internal routines for an EFI SNI (Simple Network\r
Interface) Protocol.\r
\r
This file relies upon the existence of a PXE-compliant ROM\r
- in memory, as defined by the Preboot Execution Environment \r
+ in memory, as defined by the Preboot Execution Environment\r
Specification (PXE), Version 2.1, located at\r
\r
http://developer.intel.com/ial/wfm/wfmspecs.htm\r
\r
-Copyright (c) 1999 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 1999 - 2018, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
#include "BiosSnp16.h"\r
\r
/**\r
- PXE \r
+ PXE\r
START UNDI\r
Op-Code: PXENV_START_UNDI (0000h)\r
Input: Far pointer to a PXENV_START_UNDI_T parameter structure that has been initialized by the caller.\r
contents of these registers can be found in the [PnP], [PCI] and\r
[BBS] specifications.\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants. \r
+ Status: See the PXENV_STATUS_xxx constants.\r
\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeStartUndi (\r
}\r
\r
/**\r
- PXE \r
- UNDI STARTUP \r
+ PXE\r
+ UNDI STARTUP\r
Op-Code: PXENV_UNDI_STARTUP (0001h)\r
Input: Far pointer to a PXENV_UNDI_STARTUP_T parameter structure that has been initialized by the\r
caller.\r
chaining interrupt 1Ah. This must be done by the PXENV_START_UNDI and\r
PXENV_STOP_UNDI API calls.\r
This service cannot be used in protected mode.\r
- typedef struct \r
+ typedef struct\r
{\r
PXENV_STATUS Status;\r
} PXENV_UNDI_STARTUP_T;\r
Status: See the PXENV_STATUS_xxx constants.\r
\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiStartup (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI CLEANUP\r
Op-Code: PXENV_UNDI_CLEANUP (0002h)\r
Input: Far pointer to a PXENV_UNDI_CLEANUP_T parameter structure.\r
Status: See the PXENV_STATUS_xxx constants.\r
\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiCleanup (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI INITIALIZE\r
Op-Code: PXENV_UNDI_INITIALIZE (0003h)\r
Input: Far pointer to a PXENV_UNDI_INITIALIZE_T parameter structure that has been initialized by the\r
protocol.ini file was done by NDIS.) This value can be NULL for any\r
other application interfacing to the universal NIC driver\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants. \r
- \r
+ Status: See the PXENV_STATUS_xxx constants.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiInitialize (\r
\r
/**\r
Wrapper routine for reset adapter.\r
- \r
- PXE \r
+\r
+ PXE\r
UNDI RESET ADAPTER\r
Op-Code: PXENV_UNDI_RESET_ADAPTER (0004h)\r
Input: Far pointer to a PXENV_UNDI_RESET_ADAPTER_t parameter structure that has been initialized\r
addresses.\r
Returned from API service\r
Status: See the PXENV_STATUS_xxx constants.\r
- \r
+\r
@param SimpleNetworkDevice Device instance.\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- @param RxFilter Filter setting mask value for PXE recive . \r
- \r
- @return Return value of PXE option ROM far call. \r
+ @param RxFilter Filter setting mask value for PXE recive .\r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiResetNic (\r
&Open.McastBuffer,\r
&PxeUndiTable->R_Mcast_Buf,\r
sizeof (PXENV_UNDI_MCAST_ADDR_T)\r
- ); \r
- \r
+ );\r
+\r
\r
Status = MakePxeCall (\r
SimpleNetworkDevice,\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI SHUTDOWN\r
Op-Code: PXENV_UNDI_SHUTDOWN (0005h)\r
Input: Far pointer to a PXENV_UNDI_SHUTDOWN_T parameter.\r
Description: This call resets the network adapter and leaves it in a safe state for another driver to program it.\r
Note: The contents of the PXENV_UNDI_STARTUP parameter structure need to be saved by the\r
Universal NIC Driver in case PXENV_UNDI_INITIALIZE is called again.\r
- typedef struct \r
+ typedef struct\r
{\r
PXENV_STATUS Status;\r
} PXENV_UNDI_SHUTDOWN_T;\r
N/A\r
Returned from API service\r
Status: See the PXENV_STATUS_xxx constants.\r
- \r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiShutdown (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI OPEN\r
Op-Code: PXENV_UNDI_OPEN (0006h)\r
Input: Far pointer to a PXENV_UNDI_OPEN_T parameter structure that has been initialized by the caller.\r
R_Mcast_Buf: See definition in UNDI RESET ADAPTER (0004h).\r
Returned from API service\r
Status: See the PXENV_STATUS_xxx constants.\r
- \r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiOpen (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI CLOSE\r
Op-Code: PXENV_UNDI_CLOSE (0007h)\r
Input: Far pointer to a PXENV_UNDI_CLOSE_T parameter.\r
N/A\r
Returned from API service\r
Status: See the PXENV_STATUS_xxx constants.\r
- \r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiClose (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI TRANSMIT PACKET\r
Op-Code: PXENV_UNDI_TRANSMIT (0008h)\r
Input: Far pointer to a PXENV_UNDI_TRANSMIT_T parameter structure that\r
TDDataPtr: Segment:Offset of the transmit block.\r
DataBlock: Array of transmit data blocks.\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants \r
- \r
+ Status: See the PXENV_STATUS_xxx constants\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiTransmit (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI SET MULTICAST ADDRESS\r
Op-Code: PXENV_UNDI_SET_MCAST_ADDRESS (0009h)\r
Input: Far pointer to a PXENV_TFTP_SET_MCAST_ADDRESS_t parameter structure that has been\r
R_Mcast_Buf: See description in the UNDI RESET ADAPTER\r
(0004h) API.\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants \r
- \r
+ Status: See the PXENV_STATUS_xxx constants\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiSetMcastAddr (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI SET STATION ADDRESS\r
Op-Code: PXENV_UNDI_SET_STATION_ADDRESS (000Ah)\r
Input: Far pointer to a PXENV_UNDI_SET_STATION_ADDRESS_t parameter structure that has been\r
StationAddress: Temporary MAC address to be used for\r
transmit and receive.\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants. \r
- \r
+ Status: See the PXENV_STATUS_xxx constants.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiSetStationAddr (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI SET PACKET FILTER\r
Op-Code: PXENV_UNDI_SET_PACKET_FILTER (000Bh)\r
Input: Far pointer to a PXENV_UNDI_SET_PACKET_FILTER_T parameter structure that has been\r
Filter: See the receive filter values in the UNDI OPEN\r
(0006h) API description.\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants. \r
- \r
+ Status: See the PXENV_STATUS_xxx constants.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiSetPacketFilter (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI GET INFORMATION\r
Op-Code: PXENV_UNDI_GET_INFORMATION (000Ch)\r
Input: Far pointer to a PXENV_UNDI_GET_INFORMATION_T parameter structure that has been\r
PermNodeAddress: Permanent hardware address.\r
ROMAddress: Real mode ROM segment address.\r
RxBufCnt: Receive queue length.\r
- TxBufCnt: Transmit queue length. \r
- \r
+ TxBufCnt: Transmit queue length.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiGetInformation (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI GET STATISTICS\r
Op-Code: PXENV_UNDI_GET_STATISTICS (000Dh)\r
Input: Far pointer to a PXENV_UNDI_GET_STATISTICS_T parameter structure that has been initialized\r
error.\r
RcvResourceErrors: Number of frames discarded\r
because receive queue was full.\r
- \r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiGetStatistics (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI CLEAR STATISTICS\r
Op-Code: PXENV_UNDI_CLEAR_STATISTICS (000Eh)\r
Input: Far pointer to a PXENV_UNDI_CLEAR_STATISTICS_T parameter.\r
N/A\r
Returned from API service\r
Status: See the PXENV_STATUS_xxx constants.\r
- \r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiClearStatistics (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI INITIATE DIAGS\r
Op-Code: PXENV_UNDI_INITIATE_DIAGS (000Fh)\r
Input: Far pointer to a PXENV_UNDI_INITIATE_DIAGS_T parameter.\r
Set before calling API service\r
N/A\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants. \r
- \r
+ Status: See the PXENV_STATUS_xxx constants.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiInitiateDiags (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI FORCE INTERRUPT\r
Op-Code: PXENV_UNDI_FORCE_INTERRUPT (0010h)\r
Input: Far pointer to a PXENV_UNDI_FORCE_INTERRUPT_T parameter structure that has been\r
Set before calling API service\r
N/A\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants. \r
- \r
+ Status: See the PXENV_STATUS_xxx constants.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiForceInterrupt (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI GET MULTICAST ADDRESS\r
Op-Code: PXENV_UNDI_GET_MCAST_ADDRESS (0011h)\r
Input: Far pointer to a PXENV_GET_MCAST_ADDRESS_t parameter structure that has been initialized\r
Returned from API service\r
Status: See the PXENV_STATUS_xxx constants.\r
MediaAddr: MAC multicast address.\r
- \r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiGetMcastAddr (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI GET NIC TYPE\r
Op-Code: PXENV_UNDI_GET_NIC_TYPE (0012h)\r
Input: Far pointer to a PXENV_UNDI_GET_NIC_TYPE parameter structure that has been initialized by\r
NICType: Type of NIC information stored in the parameter\r
structure.\r
Info: Information about the fields in this union can be found\r
- in the [PnP] and [PCI] specifications \r
- \r
+ in the [PnP] and [PCI] specifications\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiGetNicType (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI GET IFACE INFO\r
Op-Code: PXENV_UNDI_GET_IFACE_INFO (0013h)\r
Input: Far pointer to a PXENV_UNDI_GET_IFACE_INFO_t parameter structure that has been initialized\r
to the protocol driver.\r
LinkSpeed: Defined in the NDIS 2.0 specification.\r
ServiceFlags: Defined in the NDIS 2.0 specification.\r
- Reserved: Must be zero. \r
- \r
+ Reserved: Must be zero.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiGetNdisInfo (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI ISR\r
Op-Code: PXENV_UNDI_ISR (0014h)\r
Input: Far pointer to a PXENV_UNDI_ISR_T parameter structure that has been initialized by the caller.\r
if there is no other interrupt status to be processed, UNDI re-enables the interrupt at the\r
NETWORK INTERFACE level and returns PXENV_UNDI_ISR_OUT_DONE in the FuncFlag.\r
IMPORTANT: It is possible for the protocol driver to be interrupted again while in the\r
- strategy routine when the UNDI re-enables interrupts. \r
- \r
+ strategy routine when the UNDI re-enables interrupts.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiIsr (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
STOP UNDI\r
Op-Code: PXENV_STOP_UNDI (0015h)\r
Input: Far pointer to a PXENV_STOP_UNDI_T parameter structure that has been initialized by the caller.\r
Set before calling API service\r
N/A\r
Returned from API service\r
- Status: See the PXENV_STATUS_xxx constants. \r
- \r
+ Status: See the PXENV_STATUS_xxx constants.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiStop (\r
}\r
\r
/**\r
- PXE \r
+ PXE\r
UNDI GET STATE\r
Op-Code: PXENV_UNDI_GET_STATE (0015h)\r
Input: Far pointer to a PXENV_UNDI_GET_STATE_T parameter.\r
constants.\r
Description: This API function will be called at different levels of processing the interrupt. The FuncFlag field in\r
the parameter block indicates the operation to be performed for the call. This field is filled with the\r
- status of that operation on return. \r
- \r
+ status of that operation on return.\r
+\r
@param SimpleNetworkDevice Device instance\r
- @param PxeUndiTable Point to structure which hold parameter and return value \r
+ @param PxeUndiTable Point to structure which hold parameter and return value\r
for option ROM call.\r
- \r
- @return Return value of PXE option ROM far call. \r
+\r
+ @return Return value of PXE option ROM far call.\r
**/\r
EFI_STATUS\r
PxeUndiGetState (\r
projects / mirror_edk2.git / blobdiff