[mirror_edk2.git] / EdkModulePkg / Bus / Pci / Undi / RuntimeDxe / Undi32.h

\r
/*++\r
\r
Copyright (c) 2006, Intel Corporation.\r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
    undi32.h\r
\r
Abstract:\r
\r
    EFI internal structures for the EFI UNDI driver\r
\r
\r
\r
Revision History\r
\r
--*/\r
\r
#ifndef _UNDI_32_H_\r
#define _UNDI_32_H_\r
\r
\r
#include "E100b.h"\r
#include <IndustryStandard/pci22.h>\r
\r
#define MAX_NIC_INTERFACES 16\r
\r
#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION_31 0x00010001\r
#define PXE_ROMID_MINORVER_31 0x10\r
#define PXE_STATFLAGS_DB_WRITE_TRUNCATED  0x2000\r
\r
//\r
// UNDI_CALL_TABLE.state can have the following values\r
//\r
#define DONT_CHECK -1\r
#define ANY_STATE -1\r
#define MUST_BE_STARTED 1\r
#define MUST_BE_INITIALIZED 2\r
\r
#define UNDI_DEV_SIGNATURE   EFI_SIGNATURE_32('u','n','d','i')\r
#define UNDI_DEV_FROM_THIS(a) CR(a, UNDI32_DEV, NIIProtocol, UNDI_DEV_SIGNATURE)\r
#define UNDI_DEV_FROM_NIC(a) CR(a, UNDI32_DEV, NicInfo, UNDI_DEV_SIGNATURE)\r
\r
typedef struct {\r
  UINTN                                     Signature;\r
  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol;\r
  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol_31;\r
  EFI_HANDLE                                DeviceHandle;\r
  EFI_DEVICE_PATH_PROTOCOL                  *Undi32BaseDevPath;\r
  EFI_DEVICE_PATH_PROTOCOL                  *Undi32DevPath;\r
  NIC_DATA_INSTANCE                         NicInfo;\r
} UNDI32_DEV;\r
\r
typedef struct {\r
  UINT16 cpbsize;\r
  UINT16 dbsize;\r
  UINT16 opflags;\r
  UINT16 state;\r
  VOID (*api_ptr)();\r
} UNDI_CALL_TABLE;\r
\r
typedef struct {\r
  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *InterfacePointer;\r
  EFI_DEVICE_PATH_PROTOCOL                  *DevicePathPointer;\r
} NII_ENTRY;\r
\r
typedef struct NII_CONFIG_ENTRY {\r
  UINT32                   NumEntries;\r
  UINT32                   Reserved;              // padding for alignment\r
  struct NII_CONFIG_ENTRY  *NextLink;\r
  NII_ENTRY                NiiEntry[1];\r
} NII_TABLE;\r
\r
typedef VOID (*ptr)(VOID);\r
typedef VOID (*bsptr_30)(UINTN);\r
typedef VOID (*virtphys_30)(UINT64, UINT64);\r
typedef VOID (*block_30)(UINT32);\r
typedef VOID (*mem_io_30)(UINT8, UINT8, UINT64, UINT64);\r
\r
typedef VOID (*bsptr)(UINT64, UINTN);\r
typedef VOID (*virtphys)(UINT64, UINT64, UINT64);\r
typedef VOID (*block)(UINT64, UINT32);\r
typedef VOID (*mem_io)(UINT64, UINT8, UINT8, UINT64, UINT64);\r
\r
typedef VOID (*map_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
typedef VOID (*unmap_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
typedef VOID (*sync_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
\r
//\r
// functions defined in e100b.c\r
//\r
UINT8 InByte (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
UINT16 InWord (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
UINT32 InLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
VOID  OutByte (NIC_DATA_INSTANCE *AdapterInfo, UINT8 Data, UINT32 Port);\r
VOID  OutWord (NIC_DATA_INSTANCE *AdapterInfo, UINT16 Data, UINT32 Port);\r
VOID  OutLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Data, UINT32 Port);\r
\r
UINTN E100bInit (NIC_DATA_INSTANCE *AdapterInfo);\r
UINTN E100bReset (NIC_DATA_INSTANCE *AdapterInfo, INT32 OpFlags);\r
UINTN E100bShutdown (NIC_DATA_INSTANCE *AdapterInfo);\r
UINTN E100bTransmit (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT16 opflags);\r
UINTN E100bReceive (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT64 db);\r
UINTN E100bSetfilter (NIC_DATA_INSTANCE *AdapterInfo, UINT16 New_filter,\r
                      UINT64 cpb, UINT32 cpbsize);\r
UINTN E100bStatistics(NIC_DATA_INSTANCE *AdapterInfo, UINT64 db, UINT16 dbsize);\r
UINT8 E100bSetupIAAddr (NIC_DATA_INSTANCE *AdapterInfo);\r
UINT8 E100bSetInterruptState (NIC_DATA_INSTANCE *AdapterInfo);\r
\r
UINT8 E100bGetEepromAddrLen (NIC_DATA_INSTANCE *AdapterInfo);\r
UINT16 E100bReadEeprom (NIC_DATA_INSTANCE *AdapterInfo, INT32 Location, UINT8 address_len);\r
INT16 E100bReadEepromAndStationAddress (NIC_DATA_INSTANCE *AdapterInfo);\r
\r
UINT16 next(UINT16);\r
UINT8 SetupCBlink (NIC_DATA_INSTANCE *AdapterInfo);\r
VOID SetFreeCB (NIC_DATA_INSTANCE *AdapterInfo,TxCB *);\r
TxCB *GetFreeCB (NIC_DATA_INSTANCE *AdapterInfo);\r
UINT16 CheckCBList (NIC_DATA_INSTANCE *AdapterInfo);\r
\r
UINT8 SelectiveReset (NIC_DATA_INSTANCE *AdapterInfo);\r
UINT16 InitializeChip (NIC_DATA_INSTANCE *AdapterInfo);\r
UINT8 SetupReceiveQueues (NIC_DATA_INSTANCE *AdapterInfo);\r
VOID  Recycle_RFD (NIC_DATA_INSTANCE *AdapterInfo, UINT16);\r
VOID XmitWaitForCompletion (NIC_DATA_INSTANCE *AdapterInfo);\r
INT8 CommandWaitForCompletion (TxCB *cmd_ptr, NIC_DATA_INSTANCE *AdapterInfo);\r
\r
BOOLEAN PhyDetect (NIC_DATA_INSTANCE *AdapterInfo);\r
VOID PhyReset (NIC_DATA_INSTANCE *AdapterInfo);\r
VOID\r
MdiWrite (\r
  IN NIC_DATA_INSTANCE *AdapterInfo,\r
  IN UINT8 RegAddress, \r
  IN UINT8 PhyAddress,\r
  IN UINT16 DataValue\r
  );\r
\r
VOID\r
MdiRead(\r
  IN NIC_DATA_INSTANCE *AdapterInfo,\r
  IN UINT8 RegAddress, \r
  IN UINT8 PhyAddress,\r
  IN OUT UINT16 *DataValue\r
  );\r
\r
BOOLEAN SetupPhy (NIC_DATA_INSTANCE *AdapterInfo);\r
VOID FindPhySpeedAndDpx (NIC_DATA_INSTANCE *AdapterInfo, UINT32 PhyId);\r
\r
\r
\r
//\r
// functions defined in init.c\r
//\r
VOID\r
TmpDelay (\r
  IN UINT64 UnqId,\r
  IN UINTN MicroSeconds\r
  );\r
\r
VOID\r
TmpMemIo (\r
  IN UINT64 UnqId,\r
  IN UINT8 ReadWrite,\r
  IN UINT8 Len,\r
  IN UINT64 Port,\r
  IN UINT64 BufAddr\r
  );\r
\r
//\r
// functions defined in decode.c\r
//\r
VOID UNDI_GetState();\r
VOID UNDI_Start();\r
VOID UNDI_Stop();\r
VOID UNDI_GetInitInfo();\r
VOID UNDI_GetConfigInfo();\r
VOID UNDI_Initialize();\r
VOID UNDI_Reset();\r
VOID UNDI_Shutdown();\r
VOID UNDI_Interrupt();\r
VOID UNDI_RecFilter();\r
VOID UNDI_StnAddr();\r
VOID UNDI_Statistics();\r
VOID UNDI_ip2mac();\r
VOID UNDI_NVData();\r
VOID UNDI_Status();\r
VOID UNDI_FillHeader();\r
VOID UNDI_Transmit();\r
VOID UNDI_Receive();\r
\r
VOID UNDI_APIEntry_new(UINT64);\r
VOID UNDI_APIEntry_old(UINT64);\r
VOID UNDI_APIEntry_Common(UINT64);\r
\r
PXE_IPV4 convert_mcip(PXE_MAC_ADDR *);\r
INT32 validate_mcip (PXE_MAC_ADDR *MCastAddr);\r
\r
VOID PxeStructInit (PXE_SW_UNDI *PxePtr, UINTN VersionFlag);\r
VOID PxeUpdate (NIC_DATA_INSTANCE *NicPtr, PXE_SW_UNDI *PxePtr);\r
\r
#endif\r
Commit	Line	Data
878ddf1f	1	\r
	2	/*++\r
	3	\r
abf537ea	4	Copyright (c) 2006, Intel Corporation.\r
878ddf1f	5	All rights reserved. This program and the accompanying materials \r
	6	are licensed and made available under the terms and conditions of the BSD License \r
	7	which accompanies this distribution. The full text of the license may be found at \r
	8	http://opensource.org/licenses/bsd-license.php \r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	12	\r
	13	Module Name:\r
	14	\r
	15	undi32.h\r
	16	\r
	17	Abstract:\r
	18	\r
	19	EFI internal structures for the EFI UNDI driver\r
	20	\r
	21	\r
	22	\r
	23	Revision History\r
	24	\r
	25	--*/\r
	26	\r
	27	#ifndef _UNDI_32_H_\r
	28	#define _UNDI_32_H_\r
	29	\r
	30	\r
	31	#include "E100b.h"\r
f0ec738d	32	#include <IndustryStandard/pci22.h>\r
878ddf1f	33	\r
	34	#define MAX_NIC_INTERFACES 16\r
	35	\r
	36	#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION_31 0x00010001\r
	37	#define PXE_ROMID_MINORVER_31 0x10\r
	38	#define PXE_STATFLAGS_DB_WRITE_TRUNCATED 0x2000\r
	39	\r
	40	//\r
	41	// UNDI_CALL_TABLE.state can have the following values\r
	42	//\r
	43	#define DONT_CHECK -1\r
	44	#define ANY_STATE -1\r
	45	#define MUST_BE_STARTED 1\r
	46	#define MUST_BE_INITIALIZED 2\r
	47	\r
	48	#define UNDI_DEV_SIGNATURE EFI_SIGNATURE_32('u','n','d','i')\r
	49	#define UNDI_DEV_FROM_THIS(a) CR(a, UNDI32_DEV, NIIProtocol, UNDI_DEV_SIGNATURE)\r
	50	#define UNDI_DEV_FROM_NIC(a) CR(a, UNDI32_DEV, NicInfo, UNDI_DEV_SIGNATURE)\r
	51	\r
	52	typedef struct {\r
	53	UINTN Signature;\r
	54	EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol;\r
	55	EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol_31;\r
	56	EFI_HANDLE DeviceHandle;\r
	57	EFI_DEVICE_PATH_PROTOCOL *Undi32BaseDevPath;\r
	58	EFI_DEVICE_PATH_PROTOCOL *Undi32DevPath;\r
	59	NIC_DATA_INSTANCE NicInfo;\r
	60	} UNDI32_DEV;\r
	61	\r
	62	typedef struct {\r
	63	UINT16 cpbsize;\r
	64	UINT16 dbsize;\r
	65	UINT16 opflags;\r
	66	UINT16 state;\r
	67	VOID (*api_ptr)();\r
	68	} UNDI_CALL_TABLE;\r
	69	\r
	70	typedef struct {\r
	71	EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *InterfacePointer;\r
	72	EFI_DEVICE_PATH_PROTOCOL *DevicePathPointer;\r
	73	} NII_ENTRY;\r
	74	\r
	75	typedef struct NII_CONFIG_ENTRY {\r
	76	UINT32 NumEntries;\r
	77	UINT32 Reserved; // padding for alignment\r
	78	struct NII_CONFIG_ENTRY *NextLink;\r
	79	NII_ENTRY NiiEntry[1];\r
	80	} NII_TABLE;\r
	81	\r
	82	typedef VOID (*ptr)(VOID);\r
	83	typedef VOID (*bsptr_30)(UINTN);\r
	84	typedef VOID (*virtphys_30)(UINT64, UINT64);\r
	85	typedef VOID (*block_30)(UINT32);\r
	86	typedef VOID (*mem_io_30)(UINT8, UINT8, UINT64, UINT64);\r
	87	\r
	88	typedef VOID (*bsptr)(UINT64, UINTN);\r
	89	typedef VOID (*virtphys)(UINT64, UINT64, UINT64);\r
	90	typedef VOID (*block)(UINT64, UINT32);\r
	91	typedef VOID (*mem_io)(UINT64, UINT8, UINT8, UINT64, UINT64);\r
	92	\r
	93	typedef VOID (*map_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
	94	typedef VOID (*unmap_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
	95	typedef VOID (*sync_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
	96	\r
97	//\r
98	// functions defined in e100b.c\r
99	//\r
100	UINT8 InByte (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
101	UINT16 InWord (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
102	UINT32 InLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
103	VOID OutByte (NIC_DATA_INSTANCE *AdapterInfo, UINT8 Data, UINT32 Port);\r
104	VOID OutWord (NIC_DATA_INSTANCE *AdapterInfo, UINT16 Data, UINT32 Port);\r
105	VOID OutLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Data, UINT32 Port);\r
106	\r
107	UINTN E100bInit (NIC_DATA_INSTANCE *AdapterInfo);\r
108	UINTN E100bReset (NIC_DATA_INSTANCE *AdapterInfo, INT32 OpFlags);\r
109	UINTN E100bShutdown (NIC_DATA_INSTANCE *AdapterInfo);\r
110	UINTN E100bTransmit (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT16 opflags);\r
111	UINTN E100bReceive (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT64 db);\r
112	UINTN E100bSetfilter (NIC_DATA_INSTANCE *AdapterInfo, UINT16 New_filter,\r
113	UINT64 cpb, UINT32 cpbsize);\r
114	UINTN E100bStatistics(NIC_DATA_INSTANCE *AdapterInfo, UINT64 db, UINT16 dbsize);\r
115	UINT8 E100bSetupIAAddr (NIC_DATA_INSTANCE *AdapterInfo);\r
116	UINT8 E100bSetInterruptState (NIC_DATA_INSTANCE *AdapterInfo);\r
117	\r
118	UINT8 E100bGetEepromAddrLen (NIC_DATA_INSTANCE *AdapterInfo);\r
119	UINT16 E100bReadEeprom (NIC_DATA_INSTANCE *AdapterInfo, INT32 Location, UINT8 address_len);\r
120	INT16 E100bReadEepromAndStationAddress (NIC_DATA_INSTANCE *AdapterInfo);\r
121	\r
122	UINT16 next(UINT16);\r
123	UINT8 SetupCBlink (NIC_DATA_INSTANCE *AdapterInfo);\r
124	VOID SetFreeCB (NIC_DATA_INSTANCE AdapterInfo,TxCB );\r
125	TxCB GetFreeCB (NIC_DATA_INSTANCE AdapterInfo);\r
126	UINT16 CheckCBList (NIC_DATA_INSTANCE *AdapterInfo);\r
127	\r
128	UINT8 SelectiveReset (NIC_DATA_INSTANCE *AdapterInfo);\r
129	UINT16 InitializeChip (NIC_DATA_INSTANCE *AdapterInfo);\r
130	UINT8 SetupReceiveQueues (NIC_DATA_INSTANCE *AdapterInfo);\r
131	VOID Recycle_RFD (NIC_DATA_INSTANCE *AdapterInfo, UINT16);\r
132	VOID XmitWaitForCompletion (NIC_DATA_INSTANCE *AdapterInfo);\r
133	INT8 CommandWaitForCompletion (TxCB cmd_ptr, NIC_DATA_INSTANCE AdapterInfo);\r
134	\r
135	BOOLEAN PhyDetect (NIC_DATA_INSTANCE *AdapterInfo);\r
136	VOID PhyReset (NIC_DATA_INSTANCE *AdapterInfo);\r
137	VOID\r
138	MdiWrite (\r
139	IN NIC_DATA_INSTANCE *AdapterInfo,\r
140	IN UINT8 RegAddress, \r
141	IN UINT8 PhyAddress,\r
142	IN UINT16 DataValue\r
143	);\r
144	\r
145	VOID\r
146	MdiRead(\r
147	IN NIC_DATA_INSTANCE *AdapterInfo,\r
148	IN UINT8 RegAddress, \r
149	IN UINT8 PhyAddress,\r
150	IN OUT UINT16 *DataValue\r
151	);\r
152	\r
153	BOOLEAN SetupPhy (NIC_DATA_INSTANCE *AdapterInfo);\r
154	VOID FindPhySpeedAndDpx (NIC_DATA_INSTANCE *AdapterInfo, UINT32 PhyId);\r
155	\r
156	\r
157	\r
158	//\r
159	// functions defined in init.c\r
160	//\r
161	VOID\r
162	TmpDelay (\r
163	IN UINT64 UnqId,\r
164	IN UINTN MicroSeconds\r
165	);\r
166	\r
167	VOID\r
168	TmpMemIo (\r
169	IN UINT64 UnqId,\r
170	IN UINT8 ReadWrite,\r
171	IN UINT8 Len,\r
172	IN UINT64 Port,\r
173	IN UINT64 BufAddr\r
174	);\r
175	\r
176	//\r
177	// functions defined in decode.c\r
178	//\r
179	VOID UNDI_GetState();\r
180	VOID UNDI_Start();\r
181	VOID UNDI_Stop();\r
182	VOID UNDI_GetInitInfo();\r
183	VOID UNDI_GetConfigInfo();\r
184	VOID UNDI_Initialize();\r
185	VOID UNDI_Reset();\r
186	VOID UNDI_Shutdown();\r
187	VOID UNDI_Interrupt();\r
188	VOID UNDI_RecFilter();\r
189	VOID UNDI_StnAddr();\r
190	VOID UNDI_Statistics();\r
191	VOID UNDI_ip2mac();\r
192	VOID UNDI_NVData();\r
193	VOID UNDI_Status();\r
194	VOID UNDI_FillHeader();\r
195	VOID UNDI_Transmit();\r
196	VOID UNDI_Receive();\r
197	\r
198	VOID UNDI_APIEntry_new(UINT64);\r
199	VOID UNDI_APIEntry_old(UINT64);\r
200	VOID UNDI_APIEntry_Common(UINT64);\r
201	\r
202	PXE_IPV4 convert_mcip(PXE_MAC_ADDR *);\r
203	INT32 validate_mcip (PXE_MAC_ADDR *MCastAddr);\r
204	\r
205	VOID PxeStructInit (PXE_SW_UNDI *PxePtr, UINTN VersionFlag);\r
206	VOID PxeUpdate (NIC_DATA_INSTANCE NicPtr, PXE_SW_UNDI PxePtr);\r
207	\r
208	#endif\r