These are PXE Specification 2.1-compliant data structures and defines.\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
\r
//\r
// Status codes returned in the status word of PXENV API parameter structures.\r
-// \r
+//\r
// Generic API errors - these do not match up with the M0x or E0x messages\r
// that are reported by the loader.\r
//\r
\r
/* Driver errors (0x60 to 0x6F) */\r
\r
-// These errors are for UNDI compatible NIC drivers. \r
+// These errors are for UNDI compatible NIC drivers.\r
#define PXENV_STATUS_UNDI_INVALID_FUNCTION 0x60\r
#define PXENV_STATUS_UNDI_MEDIATEST_FAILED 0x61\r
#define PXENV_STATUS_UNDI_CANNOT_INIT_NIC_FOR_MCAST 0x62\r
\r
#define ADDR_LEN 16\r
#define MAXNUM_MCADDR 8\r
-#define IPLEN 4 ///< length of an IP address \r
+#define IPLEN 4 ///< length of an IP address\r
#define XMT_DESTADDR 0x0000 ///< destination address given\r
#define XMT_BROADCAST 0x0001 ///< use broadcast address\r
\r
IN UINT16 Ax; ///< In: These register fields must be\r
IN UINT16 Bx; ///< filled in with the same data\r
IN UINT16 Dx; ///< that was passed to the MLID\r
- IN UINT16 Di; ///< option ROM boot code by the \r
+ IN UINT16 Di; ///< option ROM boot code by the\r
IN UINT16 Es; ///< system BIOS.\r
} PXENV_START_UNDI_T;\r
\r
\r
typedef struct {\r
OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
- \r
+\r
///\r
/// This is an input parameter and is a 32-bit physical address of\r
/// a memory copy of the driver module in the protocol.ini file\r
/// itself.) This value can be NULL for for any other application\r
/// interfacing to the Universal NIC Driver.\r
///\r
- IN UINT32 ProtocolIni; \r
+ IN UINT32 ProtocolIni;\r
UINT8 Reserved[8];\r
} PXENV_UNDI_INITIALIZE_T;\r
\r
Note: The NIC driver does not remember the multicast\r
addresses provided in any call. So the application must\r
provide the multicast address list with all the calls that\r
- reset the receive unit of the adapter. \r
+ reset the receive unit of the adapter.\r
--*/\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
} PXENV_UNDI_SHUTDOWN_T;\r
\r
typedef struct {\r
OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
- \r
+\r
///\r
/// This is an input parameter and is adapter specific. This is\r
/// supported for Universal NDIS 2.0 driver to pass down the Open\r
/// flags provided by the protocol driver (See NDIS 2.0\r
- /// specifications). This can be zero. \r
- /// \r
- IN UINT16 OpenFlag; ///< In: See description below \r
- IN UINT16 PktFilter; ///< In: Filter for receiving \r
+ /// specifications). This can be zero.\r
+ ///\r
+ IN UINT16 OpenFlag; ///< In: See description below\r
+ IN UINT16 PktFilter; ///< In: Filter for receiving\r
\r
/* packet. It takes the following */\r
\r
#define FLTR_DIRECTED 0x0001 ///< directed/multicast\r
#define FLTR_BRDCST 0x0002 ///< broadcast packets\r
#define FLTR_PRMSCS 0x0004 ///< any packet on LAN\r
-#define FLTR_SRC_RTG 0x0008 ///< source routing packet \r
+#define FLTR_SRC_RTG 0x0008 ///< source routing packet\r
IN PXENV_UNDI_MCAST_ADDR_T McastBuffer; /* In: */\r
/* See t_PXENV_UNDI_MCAST_ADDR. */\r
} PXENV_UNDI_OPEN_T;\r
IN UINT16 ImmedLength; ///< In: Data buffer length in\r
\r
/* bytes. */\r
- UINT16 XmitOffset; ///< 16-bit segment & offset of the \r
- UINT16 XmitSegment; ///< immediate data buffer. \r
- UINT16 DataBlkCount; ///< In: Number of data blocks. \r
+ UINT16 XmitOffset; ///< 16-bit segment & offset of the\r
+ UINT16 XmitSegment; ///< immediate data buffer.\r
+ UINT16 DataBlkCount; ///< In: Number of data blocks.\r
struct DataBlk {\r
- UINT8 TDPtrType; ///< 0 => 32 bit Phys pointer in TDDataPtr, not supported in this version of LSA \r
+ UINT8 TDPtrType; ///< 0 => 32 bit Phys pointer in TDDataPtr, not supported in this version of LSA\r
///< 1 => seg:offser in TDDataPtr which can be a real mode or 16-bit protected mode pointer\r
- UINT8 TDRsvdByte; ///< Reserved, must be zero. \r
- UINT16 TDDataLen; ///< Data block length in bytes. \r
- UINT16 TDDataPtrOffset; ///< Far pointer to data buffer. \r
- UINT16 TDDataPtrSegment; ///< Far pointer to data buffer. \r
+ UINT8 TDRsvdByte; ///< Reserved, must be zero.\r
+ UINT16 TDDataLen; ///< Data block length in bytes.\r
+ UINT16 TDDataPtrOffset; ///< Far pointer to data buffer.\r
+ UINT16 TDDataPtrSegment; ///< Far pointer to data buffer.\r
} DataBlock[MAX_DATA_BLKS];\r
}\r
PXENV_UNDI_TBD_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
\r
///\r
/// This is the protocol of the upper layer that is calling\r
/// destination media address in the field DestMediaAddr. If 1,\r
/// the NIC driver fills the broadcast address for the\r
/// destination.\r
- /// \r
- IN UINT8 XmitFlag; \r
-#define XMT_DESTADDR 0x0000 ///< destination address given \r
+ ///\r
+ IN UINT8 XmitFlag;\r
+#define XMT_DESTADDR 0x0000 ///< destination address given\r
#define XMT_BROADCAST 0x0001 ///< use broadcast address\r
\r
///\r
/// media address must be obtained by the upper level protocol\r
/// (with Address Resolution Protocol) and NIC driver does not do\r
/// any address resolution.\r
- /// \r
+ ///\r
IN UINT16 DestAddrOffset; ///< 16-bit segment & offset of the\r
IN UINT16 DestAddrSegment; ///< destination media address\r
\r
- \r
- IN UINT16 TBDOffset; ///< 16-bit segment & offset of the \r
- IN UINT16 TBDSegment; ///< transmit buffer descriptor of type \r
\r
- /// XmitBufferDesc \r
+ IN UINT16 TBDOffset; ///< 16-bit segment & offset of the\r
+ IN UINT16 TBDSegment; ///< transmit buffer descriptor of type\r
+\r
+ /// XmitBufferDesc\r
IN UINT32 Reserved[2];\r
} PXENV_UNDI_TRANSMIT_T;\r
\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
- IN PXENV_UNDI_MCAST_ADDR_T McastBuffer; ///< In: \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
+ IN PXENV_UNDI_MCAST_ADDR_T McastBuffer; ///< In:\r
} PXENV_UNDI_SET_MCAST_ADDR_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
- IN UINT8 StationAddress[ADDR_LEN]; ///< new address to be set \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
+ IN UINT8 StationAddress[ADDR_LEN]; ///< new address to be set\r
} PXENV_UNDI_SET_STATION_ADDR_T;\r
\r
typedef struct s_PXENV_UNDI_SET_PACKET_FILTER {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
- IN UINT8 Filter; ///< In: Receive filter value. \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
+ IN UINT8 Filter; ///< In: Receive filter value.\r
} PXENV_UNDI_SET_PACKET_FILTER_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
- OUT UINT16 BaseIo; ///< Out: Adapter's Base IO \r
- OUT UINT16 IntNumber; ///< Out: IRQ number \r
- OUT UINT16 MaxTranUnit; ///< Out: MTU \r
- OUT UINT16 HwType; ///< Out: type of protocol at hardware level \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
+ OUT UINT16 BaseIo; ///< Out: Adapter's Base IO\r
+ OUT UINT16 IntNumber; ///< Out: IRQ number\r
+ OUT UINT16 MaxTranUnit; ///< Out: MTU\r
+ OUT UINT16 HwType; ///< Out: type of protocol at hardware level\r
\r
#define ETHER_TYPE 1\r
#define EXP_ETHER_TYPE 2\r
#define IEEE_TYPE 6\r
#define ARCNET_TYPE 7\r
- /*++ \r
+ /*++\r
other numbers can be obtained from rfc1010 for "Assigned\r
Numbers". This number may not be validated by the application\r
and hence adding new numbers to the list should be fine at any\r
- time. \r
+ time.\r
--*/\r
- OUT UINT16 HwAddrLen; ///< Out: actual length of hardware address \r
+ OUT UINT16 HwAddrLen; ///< Out: actual length of hardware address\r
OUT UINT8 CurrentNodeAddress[ADDR_LEN]; ///< Out: Current hardware address\r
OUT UINT8 PermNodeAddress[ADDR_LEN]; ///< Out: Permanent hardware address\r
- OUT UINT16 ROMAddress; ///< Out: ROM address \r
- OUT UINT16 RxBufCt; ///< Out: receive Queue length \r
- OUT UINT16 TxBufCt; ///< Out: Transmit Queue length \r
+ OUT UINT16 ROMAddress; ///< Out: ROM address\r
+ OUT UINT16 RxBufCt; ///< Out: receive Queue length\r
+ OUT UINT16 TxBufCt; ///< Out: Transmit Queue length\r
} PXENV_UNDI_GET_INFORMATION_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
- OUT UINT32 XmtGoodFrames; ///< Out: No. of good transmissions \r
- OUT UINT32 RcvGoodFrames; ///< Out: No. of good frames received \r
- OUT UINT32 RcvCRCErrors; ///< Out: No. of frames with CRC error \r
- OUT UINT32 RcvResourceErrors; ///< Out: no. of frames discarded \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
+ OUT UINT32 XmtGoodFrames; ///< Out: No. of good transmissions\r
+ OUT UINT32 RcvGoodFrames; ///< Out: No. of good frames received\r
+ OUT UINT32 RcvCRCErrors; ///< Out: No. of frames with CRC error\r
+ OUT UINT32 RcvResourceErrors; ///< Out: no. of frames discarded\r
/* Out: receive Queue full */\r
} PXENV_UNDI_GET_STATISTICS_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
} PXENV_UNDI_CLEAR_STATISTICS_T;\r
\r
typedef struct {\r
} PXENV_UNDI_FORCE_INTERRUPT_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
- IN UINT32 InetAddr; ///< In: IP Multicast Address \r
- OUT UINT8 MediaAddr[ADDR_LEN]; ///< Out: corresponding hardware \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
+ IN UINT32 InetAddr; ///< In: IP Multicast Address\r
+ OUT UINT8 MediaAddr[ADDR_LEN]; ///< Out: corresponding hardware\r
/* multicast address */\r
} PXENV_UNDI_GET_MCAST_ADDR_T;\r
\r
typedef struct {\r
- OUT UINT16 Vendor_ID; ///< OUT: \r
- OUT UINT16 Dev_ID; ///< OUT: \r
- OUT UINT8 Base_Class; ///< OUT: \r
- OUT UINT8 Sub_Class; ///< OUT: \r
- OUT UINT8 Prog_Intf; ///< OUT: program interface \r
- OUT UINT8 Rev; ///< OUT: Revision number \r
- OUT UINT16 BusDevFunc; ///< OUT: Bus, Device & Function numbers \r
- OUT UINT16 SubVendor_ID; ///< OUT: \r
- OUT UINT16 SubDevice_ID; ///< OUT: \r
+ OUT UINT16 Vendor_ID; ///< OUT:\r
+ OUT UINT16 Dev_ID; ///< OUT:\r
+ OUT UINT8 Base_Class; ///< OUT:\r
+ OUT UINT8 Sub_Class; ///< OUT:\r
+ OUT UINT8 Prog_Intf; ///< OUT: program interface\r
+ OUT UINT8 Rev; ///< OUT: Revision number\r
+ OUT UINT16 BusDevFunc; ///< OUT: Bus, Device & Function numbers\r
+ OUT UINT16 SubVendor_ID; ///< OUT:\r
+ OUT UINT16 SubDevice_ID; ///< OUT:\r
} PCI_INFO_T;\r
\r
typedef struct {\r
- OUT UINT32 EISA_Dev_ID; ///< Out: \r
- OUT UINT8 Base_Class; ///< OUT: \r
- OUT UINT8 Sub_Class; ///< OUT: \r
- OUT UINT8 Prog_Intf; ///< OUT: program interface \r
- OUT UINT16 CardSelNum; ///< OUT: Card Selector Number \r
- OUT UINT8 Reserved; ///< to make it 10 bytes \r
+ OUT UINT32 EISA_Dev_ID; ///< Out:\r
+ OUT UINT8 Base_Class; ///< OUT:\r
+ OUT UINT8 Sub_Class; ///< OUT:\r
+ OUT UINT8 Prog_Intf; ///< OUT: program interface\r
+ OUT UINT16 CardSelNum; ///< OUT: Card Selector Number\r
+ OUT UINT8 Reserved; ///< to make it 10 bytes\r
} PNP_INFO_T;\r
\r
\r
} PCI_PNP_INFO_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< OUT: PXENV_STATUS_xxx \r
- OUT UINT8 NicType; ///< OUT: 2=PCI, 3=PnP \r
+ OUT UINT16 Status; ///< OUT: PXENV_STATUS_xxx\r
+ OUT UINT8 NicType; ///< OUT: 2=PCI, 3=PnP\r
PCI_PNP_INFO_T PciPnpInfo;\r
} PXENV_UNDI_GET_NIC_TYPE_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< OUT: PXENV_STATUS_xxx \r
- OUT UINT8 IfaceType[16]; ///< OUT: Type name of MAC, AsciiZ \r
+ OUT UINT16 Status; ///< OUT: PXENV_STATUS_xxx\r
+ OUT UINT8 IfaceType[16]; ///< OUT: Type name of MAC, AsciiZ\r
\r
/* format. This is used by the */\r
\r
/* Service specific */\r
\r
/* characteristic table */\r
- OUT UINT32 LinkSpeed; ///< OUT: \r
- OUT UINT32 ServiceFlags; ///< OUT: as defined in NDIS Spec 2.0X \r
+ OUT UINT32 LinkSpeed; ///< OUT:\r
+ OUT UINT32 ServiceFlags; ///< OUT: as defined in NDIS Spec 2.0X\r
OUT UINT32 Reserved[4]; ///< OUT: will be filled with 0s till defined\r
} PXENV_UNDI_GET_NDIS_INFO_T;\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< OUT: PXENV_STATUS_xxx \r
- IN OUT UINT16 FuncFlag; ///< In: PXENV_UNDI_ISR_IN_xxx \r
+ OUT UINT16 Status; ///< OUT: PXENV_STATUS_xxx\r
+ IN OUT UINT16 FuncFlag; ///< In: PXENV_UNDI_ISR_IN_xxx\r
\r
/* Out: PXENV_UNDI_ISR_OUT_xxx */\r
OUT UINT16 BufferLength;\r
Possible responses from PXENV_UNDI_ISR_IN_START\r
\r
--*/\r
-#define PXENV_UNDI_ISR_OUT_OURS 0 ///< This is our interrupt. Deal with it. \r
+#define PXENV_UNDI_ISR_OUT_OURS 0 ///< This is our interrupt. Deal with it.\r
#define PXENV_UNDI_ISR_OUT_NOT_OURS 1 ///< This is not our interrupt.\r
\r
/*++\r
PXENV_UNDI_ISR_IN_PROCESS\r
\r
--*/\r
-#define PXENV_UNDI_ISR_OUT_DONE 0 ///< We are done processing this interrupt. \r
-#define PXENV_UNDI_ISR_OUT_TRANSMIT 2 ///< We completed a transmit interrupt. \r
-#define PXENV_UNDI_ISR_OUT_RECEIVE 3 ///< Get data from receive buffer. \r
+#define PXENV_UNDI_ISR_OUT_DONE 0 ///< We are done processing this interrupt.\r
+#define PXENV_UNDI_ISR_OUT_TRANSMIT 2 ///< We completed a transmit interrupt.\r
+#define PXENV_UNDI_ISR_OUT_RECEIVE 3 ///< Get data from receive buffer.\r
\r
#define PXENV_UNDI_ISR_OUT_BUSY 4 /* ? */\r
\r
typedef struct {\r
- UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
+ UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
} PXENV_STOP_UNDI_T;\r
\r
-#define PXENV_UNDI_STARTED 1 ///< not even initialized \r
-#define PXENV_UNDI_INITIALIZED 2 ///< initialized and closed (not opened) \r
-#define PXENV_UNDI_OPENED 3 ///< initialized & opened \r
+#define PXENV_UNDI_STARTED 1 ///< not even initialized\r
+#define PXENV_UNDI_INITIALIZED 2 ///< initialized and closed (not opened)\r
+#define PXENV_UNDI_OPENED 3 ///< initialized & opened\r
\r
typedef struct {\r
- OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx \r
+ OUT UINT16 Status; ///< Out: PXENV_STATUS_xxx\r
UINT16 UNDI_State;\r
} PXENV_UNDI_GET_STATE_T;\r
\r
projects / mirror_edk2.git / blobdiff