]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Bus/Pci/UndiRuntimeDxe/Undi32.h
Fixed potential issues to release resources when error occurs.
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / UndiRuntimeDxe / Undi32.h
CommitLineData
40834173 1\r
2/*++\r
3\r
41057d77 4Copyright (c) 2006 - 2007, Intel Corporation.\r
68246fa8 5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
40834173 12\r
13Module Name:\r
14\r
15 undi32.h\r
16\r
17Abstract:\r
18\r
19 EFI internal structures for the EFI UNDI driver\r
20\r
21\r
22\r
23Revision History\r
24\r
25--*/\r
26\r
27#ifndef _UNDI_32_H_\r
28#define _UNDI_32_H_\r
29\r
30#include <PiDxe.h>\r
31\r
32#include <Guid/EventGroup.h>\r
33#include <Protocol/PciIo.h>\r
34#include <Protocol/NetworkInterfaceIdentifier.h>\r
35#include <Protocol/DevicePath.h>\r
36\r
37#include <Library/UefiDriverEntryPoint.h>\r
38#include <Library/UefiRuntimeLib.h>\r
39#include <Library/DebugLib.h>\r
40#include <Library/BaseMemoryLib.h>\r
41#include <Library/UefiBootServicesTableLib.h>\r
42#include <Library/UefiLib.h>\r
43\r
44#include <IndustryStandard/Pci.h>\r
45\r
46\r
47#include "E100b.h"\r
48\r
49#define MAX_NIC_INTERFACES 16\r
50\r
51#define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION_31 0x00010001\r
52#define PXE_ROMID_MINORVER_31 0x10\r
53#define PXE_STATFLAGS_DB_WRITE_TRUNCATED 0x2000\r
54\r
55//\r
56// UNDI_CALL_TABLE.state can have the following values\r
57//\r
58#define DONT_CHECK -1\r
59#define ANY_STATE -1\r
60#define MUST_BE_STARTED 1\r
61#define MUST_BE_INITIALIZED 2\r
62\r
63#define UNDI_DEV_SIGNATURE EFI_SIGNATURE_32('u','n','d','i')\r
41057d77 64#define UNDI_DEV_FROM_THIS(a) CR(a, UNDI32_DEV, NIIProtocol_31, UNDI_DEV_SIGNATURE)\r
40834173 65#define UNDI_DEV_FROM_NIC(a) CR(a, UNDI32_DEV, NicInfo, UNDI_DEV_SIGNATURE)\r
66\r
67typedef struct {\r
68 UINTN Signature;\r
40834173 69 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol_31;\r
70 EFI_HANDLE DeviceHandle;\r
71 EFI_DEVICE_PATH_PROTOCOL *Undi32BaseDevPath;\r
72 EFI_DEVICE_PATH_PROTOCOL *Undi32DevPath;\r
73 NIC_DATA_INSTANCE NicInfo;\r
74} UNDI32_DEV;\r
75\r
76typedef struct {\r
77 UINT16 cpbsize;\r
78 UINT16 dbsize;\r
79 UINT16 opflags;\r
80 UINT16 state;\r
81 VOID (*api_ptr)();\r
82} UNDI_CALL_TABLE;\r
83\r
84typedef struct {\r
85 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL *InterfacePointer;\r
86 EFI_DEVICE_PATH_PROTOCOL *DevicePathPointer;\r
87} NII_ENTRY;\r
88\r
89typedef struct NII_CONFIG_ENTRY {\r
90 UINT32 NumEntries;\r
91 UINT32 Reserved; // padding for alignment\r
92 struct NII_CONFIG_ENTRY *NextLink;\r
93 NII_ENTRY NiiEntry[1];\r
94} NII_TABLE;\r
95\r
96typedef VOID (*ptr)(VOID);\r
97typedef VOID (*bsptr_30)(UINTN);\r
98typedef VOID (*virtphys_30)(UINT64, UINT64);\r
99typedef VOID (*block_30)(UINT32);\r
100typedef VOID (*mem_io_30)(UINT8, UINT8, UINT64, UINT64);\r
101\r
102typedef VOID (*bsptr)(UINT64, UINTN);\r
103typedef VOID (*virtphys)(UINT64, UINT64, UINT64);\r
104typedef VOID (*block)(UINT64, UINT32);\r
105typedef VOID (*mem_io)(UINT64, UINT8, UINT8, UINT64, UINT64);\r
106\r
107typedef VOID (*map_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
108typedef VOID (*unmap_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
109typedef VOID (*sync_mem)(UINT64, UINT64, UINT32, UINT32, UINT64);\r
110\r
111extern UNDI_CALL_TABLE api_table[];\r
40834173 112extern PXE_SW_UNDI *pxe_31; // !pxe structure for 3.1 drivers\r
113extern UNDI32_DEV *UNDI32DeviceList[MAX_NIC_INTERFACES];\r
114\r
115//\r
116// functions defined in e100b.c\r
117//\r
118UINT8 InByte (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
119UINT16 InWord (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
120UINT32 InLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Port);\r
121VOID OutByte (NIC_DATA_INSTANCE *AdapterInfo, UINT8 Data, UINT32 Port);\r
122VOID OutWord (NIC_DATA_INSTANCE *AdapterInfo, UINT16 Data, UINT32 Port);\r
123VOID OutLong (NIC_DATA_INSTANCE *AdapterInfo, UINT32 Data, UINT32 Port);\r
124\r
125UINTN E100bInit (NIC_DATA_INSTANCE *AdapterInfo);\r
126UINTN E100bReset (NIC_DATA_INSTANCE *AdapterInfo, INT32 OpFlags);\r
127UINTN E100bShutdown (NIC_DATA_INSTANCE *AdapterInfo);\r
128UINTN E100bTransmit (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT16 opflags);\r
129UINTN E100bReceive (NIC_DATA_INSTANCE *AdapterInfo, UINT64 cpb, UINT64 db);\r
130UINTN E100bSetfilter (NIC_DATA_INSTANCE *AdapterInfo, UINT16 New_filter,\r
131 UINT64 cpb, UINT32 cpbsize);\r
132UINTN E100bStatistics(NIC_DATA_INSTANCE *AdapterInfo, UINT64 db, UINT16 dbsize);\r
133UINT8 E100bSetupIAAddr (NIC_DATA_INSTANCE *AdapterInfo);\r
134UINT8 E100bSetInterruptState (NIC_DATA_INSTANCE *AdapterInfo);\r
135\r
136UINT8 E100bGetEepromAddrLen (NIC_DATA_INSTANCE *AdapterInfo);\r
137UINT16 E100bReadEeprom (NIC_DATA_INSTANCE *AdapterInfo, INT32 Location, UINT8 address_len);\r
138INT16 E100bReadEepromAndStationAddress (NIC_DATA_INSTANCE *AdapterInfo);\r
139\r
140UINT16 next(UINT16);\r
141UINT8 SetupCBlink (NIC_DATA_INSTANCE *AdapterInfo);\r
142VOID SetFreeCB (NIC_DATA_INSTANCE *AdapterInfo,TxCB *);\r
143TxCB *GetFreeCB (NIC_DATA_INSTANCE *AdapterInfo);\r
144UINT16 CheckCBList (NIC_DATA_INSTANCE *AdapterInfo);\r
145\r
146UINT8 SelectiveReset (NIC_DATA_INSTANCE *AdapterInfo);\r
147UINT16 InitializeChip (NIC_DATA_INSTANCE *AdapterInfo);\r
148UINT8 SetupReceiveQueues (NIC_DATA_INSTANCE *AdapterInfo);\r
149VOID Recycle_RFD (NIC_DATA_INSTANCE *AdapterInfo, UINT16);\r
150VOID XmitWaitForCompletion (NIC_DATA_INSTANCE *AdapterInfo);\r
151INT8 CommandWaitForCompletion (TxCB *cmd_ptr, NIC_DATA_INSTANCE *AdapterInfo);\r
152\r
153BOOLEAN PhyDetect (NIC_DATA_INSTANCE *AdapterInfo);\r
154VOID PhyReset (NIC_DATA_INSTANCE *AdapterInfo);\r
155VOID\r
156MdiWrite (\r
157 IN NIC_DATA_INSTANCE *AdapterInfo,\r
68246fa8 158 IN UINT8 RegAddress,\r
40834173 159 IN UINT8 PhyAddress,\r
160 IN UINT16 DataValue\r
161 );\r
162\r
163VOID\r
164MdiRead(\r
165 IN NIC_DATA_INSTANCE *AdapterInfo,\r
68246fa8 166 IN UINT8 RegAddress,\r
40834173 167 IN UINT8 PhyAddress,\r
168 IN OUT UINT16 *DataValue\r
169 );\r
170\r
171BOOLEAN SetupPhy (NIC_DATA_INSTANCE *AdapterInfo);\r
172VOID FindPhySpeedAndDpx (NIC_DATA_INSTANCE *AdapterInfo, UINT32 PhyId);\r
173\r
174\r
175\r
176//\r
177// functions defined in init.c\r
178//\r
179EFI_STATUS\r
180InstallConfigTable (\r
181 IN VOID\r
182 );\r
183\r
184EFI_STATUS\r
185EFIAPI\r
186InitializeUNDIDriver (\r
187 IN EFI_HANDLE ImageHandle,\r
188 IN EFI_SYSTEM_TABLE *SystemTable\r
189 );\r
190\r
191VOID\r
192UNDI_notify_virtual (\r
193 EFI_EVENT event,\r
194 VOID *context\r
195 );\r
196\r
197VOID\r
198EFIAPI\r
199UndiNotifyExitBs (\r
200 EFI_EVENT Event,\r
201 VOID *Context\r
202 );\r
203\r
204EFI_STATUS\r
205EFIAPI\r
206UndiDriverSupported (\r
207 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
208 IN EFI_HANDLE Controller,\r
209 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
210 );\r
211\r
212EFI_STATUS\r
213EFIAPI\r
214UndiDriverStart (\r
215 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
216 IN EFI_HANDLE Controller,\r
217 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
218 );\r
219\r
220EFI_STATUS\r
221EFIAPI\r
222UndiDriverStop (\r
223 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
224 IN EFI_HANDLE Controller,\r
225 IN UINTN NumberOfChildren,\r
226 IN EFI_HANDLE *ChildHandleBuffer\r
227 );\r
228\r
229EFI_STATUS\r
230AppendMac2DevPath (\r
231 IN OUT EFI_DEVICE_PATH_PROTOCOL **DevPtr,\r
232 IN EFI_DEVICE_PATH_PROTOCOL *BaseDevPtr,\r
233 IN NIC_DATA_INSTANCE *AdapterInfo\r
234 );\r
235\r
236VOID\r
237TmpDelay (\r
238 IN UINT64 UnqId,\r
239 IN UINTN MicroSeconds\r
240 );\r
241\r
242VOID\r
243TmpMemIo (\r
244 IN UINT64 UnqId,\r
245 IN UINT8 ReadWrite,\r
246 IN UINT8 Len,\r
247 IN UINT64 Port,\r
248 IN UINT64 BufAddr\r
249 );\r
250\r
251//\r
252// functions defined in decode.c\r
253//\r
254VOID\r
255UNDI_GetState (\r
256 IN PXE_CDB *CdbPtr,\r
257 IN NIC_DATA_INSTANCE *AdapterInfo\r
258 );\r
259\r
260VOID\r
261UNDI_Start (\r
262 IN PXE_CDB *CdbPtr,\r
263 IN NIC_DATA_INSTANCE *AdapterInfo\r
264 );\r
265\r
266VOID\r
267UNDI_Stop (\r
268 IN PXE_CDB *CdbPtr,\r
269 IN NIC_DATA_INSTANCE *AdapterInfo\r
270 );\r
271\r
272VOID\r
273UNDI_GetInitInfo (\r
274 IN PXE_CDB *CdbPtr,\r
275 IN NIC_DATA_INSTANCE *AdapterInfo\r
276 );\r
277\r
278VOID\r
279UNDI_GetConfigInfo (\r
280 IN PXE_CDB *CdbPtr,\r
281 IN NIC_DATA_INSTANCE *AdapterInfo\r
282 );\r
283\r
284VOID\r
285UNDI_Initialize (\r
286 IN PXE_CDB *CdbPtr,\r
287 NIC_DATA_INSTANCE *AdapterInfo\r
288 );\r
289\r
290VOID\r
291UNDI_Reset (\r
292 IN PXE_CDB *CdbPtr,\r
293 IN NIC_DATA_INSTANCE *AdapterInfo\r
294 );\r
295\r
296VOID\r
297UNDI_Shutdown (\r
298 IN PXE_CDB *CdbPtr,\r
299 IN NIC_DATA_INSTANCE *AdapterInfo\r
300 );\r
301\r
302VOID\r
303UNDI_Interrupt (\r
304 IN PXE_CDB *CdbPtr,\r
305 IN NIC_DATA_INSTANCE *AdapterInfo\r
306 );\r
307\r
308VOID\r
309UNDI_RecFilter (\r
310 IN PXE_CDB *CdbPtr,\r
311 IN NIC_DATA_INSTANCE *AdapterInfo\r
312 );\r
313\r
314VOID\r
315UNDI_StnAddr (\r
316 IN PXE_CDB *CdbPtr,\r
317 IN NIC_DATA_INSTANCE *AdapterInfo\r
318 );\r
319\r
320VOID\r
321UNDI_Statistics (\r
322 IN PXE_CDB *CdbPtr,\r
323 IN NIC_DATA_INSTANCE *AdapterInfo\r
324 );\r
325\r
326VOID\r
327UNDI_ip2mac (\r
328 IN PXE_CDB *CdbPtr,\r
329 IN NIC_DATA_INSTANCE *AdapterInfo\r
330 );\r
331\r
332VOID\r
333UNDI_NVData (\r
334 IN PXE_CDB *CdbPtr,\r
335 IN NIC_DATA_INSTANCE *AdapterInfo\r
336 );\r
337\r
338VOID\r
339UNDI_Status (\r
340 IN PXE_CDB *CdbPtr,\r
341 IN NIC_DATA_INSTANCE *AdapterInfo\r
342 );\r
343\r
344VOID\r
345UNDI_FillHeader (\r
346 IN PXE_CDB *CdbPtr,\r
347 IN NIC_DATA_INSTANCE *AdapterInfo\r
348 );\r
349\r
350VOID\r
351UNDI_Transmit (\r
352 IN PXE_CDB *CdbPtr,\r
353 IN NIC_DATA_INSTANCE *AdapterInfo\r
354 );\r
355\r
356VOID\r
357UNDI_Receive (\r
358 IN PXE_CDB *CdbPtr,\r
359 IN NIC_DATA_INSTANCE *AdapterInfo\r
360 );\r
361\r
362VOID UNDI_APIEntry_new(UINT64);\r
40834173 363VOID UNDI_APIEntry_Common(UINT64);\r
364\r
365PXE_IPV4 convert_mcip(PXE_MAC_ADDR *);\r
366INT32 validate_mcip (PXE_MAC_ADDR *MCastAddr);\r
367\r
41057d77 368VOID PxeStructInit (PXE_SW_UNDI *PxePtr);\r
40834173 369VOID PxeUpdate (NIC_DATA_INSTANCE *NicPtr, PXE_SW_UNDI *PxePtr);\r
370\r
371#endif\r