2 EFI internal structures for the EFI UNDI driver.
4 Copyright (c) 2006 - 2007, Intel Corporation.
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
20 #include <Guid/EventGroup.h>
21 #include <Protocol/PciIo.h>
22 #include <Protocol/NetworkInterfaceIdentifier.h>
23 #include <Protocol/DevicePath.h>
25 #include <Library/UefiDriverEntryPoint.h>
26 #include <Library/UefiRuntimeLib.h>
27 #include <Library/DebugLib.h>
28 #include <Library/BaseMemoryLib.h>
29 #include <Library/UefiBootServicesTableLib.h>
30 #include <Library/UefiLib.h>
31 #include <Library/DevicePathLib.h>
33 #include <IndustryStandard/Pci.h>
38 #define MAX_NIC_INTERFACES 16
40 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION_31 0x00010001
41 #define PXE_ROMID_MINORVER_31 0x10
42 #define PXE_STATFLAGS_DB_WRITE_TRUNCATED 0x2000
45 // UNDI_CALL_TABLE.state can have the following values
49 #define MUST_BE_STARTED 1
50 #define MUST_BE_INITIALIZED 2
52 #define UNDI_DEV_SIGNATURE EFI_SIGNATURE_32('u','n','d','i')
53 #define UNDI_DEV_FROM_THIS(a) CR(a, UNDI32_DEV, NIIProtocol_31, UNDI_DEV_SIGNATURE)
54 #define UNDI_DEV_FROM_NIC(a) CR(a, UNDI32_DEV, NicInfo, UNDI_DEV_SIGNATURE)
58 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL NIIProtocol_31
;
59 EFI_HANDLE DeviceHandle
;
60 EFI_DEVICE_PATH_PROTOCOL
*Undi32BaseDevPath
;
61 EFI_DEVICE_PATH_PROTOCOL
*Undi32DevPath
;
62 NIC_DATA_INSTANCE NicInfo
;
74 EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL
*InterfacePointer
;
75 EFI_DEVICE_PATH_PROTOCOL
*DevicePathPointer
;
78 typedef struct NII_CONFIG_ENTRY
{
80 UINT32 Reserved
; // padding for alignment
81 struct NII_CONFIG_ENTRY
*NextLink
;
82 NII_ENTRY NiiEntry
[1];
85 typedef VOID (*ptr
)(VOID
);
86 typedef VOID (*bsptr_30
)(UINTN
);
87 typedef VOID (*virtphys_30
)(UINT64
, UINT64
);
88 typedef VOID (*block_30
)(UINT32
);
89 typedef VOID (*mem_io_30
)(UINT8
, UINT8
, UINT64
, UINT64
);
91 typedef VOID (*bsptr
)(UINT64
, UINTN
);
92 typedef VOID (*virtphys
)(UINT64
, UINT64
, UINT64
);
93 typedef VOID (*block
)(UINT64
, UINT32
);
94 typedef VOID (*mem_io
)(UINT64
, UINT8
, UINT8
, UINT64
, UINT64
);
96 typedef VOID (*map_mem
)(UINT64
, UINT64
, UINT32
, UINT32
, UINT64
);
97 typedef VOID (*unmap_mem
)(UINT64
, UINT64
, UINT32
, UINT32
, UINT64
);
98 typedef VOID (*sync_mem
)(UINT64
, UINT64
, UINT32
, UINT32
, UINT64
);
100 extern UNDI_CALL_TABLE api_table
[];
101 extern PXE_SW_UNDI
*pxe_31
; // !pxe structure for 3.1 drivers
102 extern UNDI32_DEV
*UNDI32DeviceList
[MAX_NIC_INTERFACES
];
105 // functions defined in e100b.c
107 UINT8
InByte (NIC_DATA_INSTANCE
*AdapterInfo
, UINT32 Port
);
108 UINT16
InWord (NIC_DATA_INSTANCE
*AdapterInfo
, UINT32 Port
);
109 UINT32
InLong (NIC_DATA_INSTANCE
*AdapterInfo
, UINT32 Port
);
110 VOID
OutByte (NIC_DATA_INSTANCE
*AdapterInfo
, UINT8 Data
, UINT32 Port
);
111 VOID
OutWord (NIC_DATA_INSTANCE
*AdapterInfo
, UINT16 Data
, UINT32 Port
);
112 VOID
OutLong (NIC_DATA_INSTANCE
*AdapterInfo
, UINT32 Data
, UINT32 Port
);
114 UINTN
E100bInit (NIC_DATA_INSTANCE
*AdapterInfo
);
115 UINTN
E100bReset (NIC_DATA_INSTANCE
*AdapterInfo
, INT32 OpFlags
);
116 UINTN
E100bShutdown (NIC_DATA_INSTANCE
*AdapterInfo
);
117 UINTN
E100bTransmit (NIC_DATA_INSTANCE
*AdapterInfo
, UINT64 cpb
, UINT16 opflags
);
118 UINTN
E100bReceive (NIC_DATA_INSTANCE
*AdapterInfo
, UINT64 cpb
, UINT64 db
);
119 UINTN
E100bSetfilter (NIC_DATA_INSTANCE
*AdapterInfo
, UINT16 New_filter
,
120 UINT64 cpb
, UINT32 cpbsize
);
121 UINTN
E100bStatistics(NIC_DATA_INSTANCE
*AdapterInfo
, UINT64 db
, UINT16 dbsize
);
122 UINT8
E100bSetupIAAddr (NIC_DATA_INSTANCE
*AdapterInfo
);
123 UINT8
E100bSetInterruptState (NIC_DATA_INSTANCE
*AdapterInfo
);
125 UINT8
E100bGetEepromAddrLen (NIC_DATA_INSTANCE
*AdapterInfo
);
126 UINT16
E100bReadEeprom (NIC_DATA_INSTANCE
*AdapterInfo
, INT32 Location
, UINT8 address_len
);
127 INT16
E100bReadEepromAndStationAddress (NIC_DATA_INSTANCE
*AdapterInfo
);
130 UINT8
SetupCBlink (NIC_DATA_INSTANCE
*AdapterInfo
);
131 VOID
SetFreeCB (NIC_DATA_INSTANCE
*AdapterInfo
,TxCB
*);
132 TxCB
*GetFreeCB (NIC_DATA_INSTANCE
*AdapterInfo
);
133 UINT16
CheckCBList (NIC_DATA_INSTANCE
*AdapterInfo
);
135 UINT8
SelectiveReset (NIC_DATA_INSTANCE
*AdapterInfo
);
136 UINT16
InitializeChip (NIC_DATA_INSTANCE
*AdapterInfo
);
137 UINT8
SetupReceiveQueues (NIC_DATA_INSTANCE
*AdapterInfo
);
138 VOID
Recycle_RFD (NIC_DATA_INSTANCE
*AdapterInfo
, UINT16
);
139 VOID
XmitWaitForCompletion (NIC_DATA_INSTANCE
*AdapterInfo
);
140 INT8
CommandWaitForCompletion (TxCB
*cmd_ptr
, NIC_DATA_INSTANCE
*AdapterInfo
);
142 BOOLEAN
PhyDetect (NIC_DATA_INSTANCE
*AdapterInfo
);
143 VOID
PhyReset (NIC_DATA_INSTANCE
*AdapterInfo
);
146 IN NIC_DATA_INSTANCE
*AdapterInfo
,
154 IN NIC_DATA_INSTANCE
*AdapterInfo
,
157 IN OUT UINT16
*DataValue
160 BOOLEAN
SetupPhy (NIC_DATA_INSTANCE
*AdapterInfo
);
161 VOID
FindPhySpeedAndDpx (NIC_DATA_INSTANCE
*AdapterInfo
, UINT32 PhyId
);
166 // functions defined in init.c
175 InitializeUNDIDriver (
176 IN EFI_HANDLE ImageHandle
,
177 IN EFI_SYSTEM_TABLE
*SystemTable
181 UNDI_notify_virtual (
195 UndiDriverSupported (
196 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
197 IN EFI_HANDLE Controller
,
198 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
204 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
205 IN EFI_HANDLE Controller
,
206 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
212 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
213 IN EFI_HANDLE Controller
,
214 IN UINTN NumberOfChildren
,
215 IN EFI_HANDLE
*ChildHandleBuffer
220 IN OUT EFI_DEVICE_PATH_PROTOCOL
**DevPtr
,
221 IN EFI_DEVICE_PATH_PROTOCOL
*BaseDevPtr
,
222 IN NIC_DATA_INSTANCE
*AdapterInfo
228 IN UINTN MicroSeconds
241 // functions defined in decode.c
246 IN NIC_DATA_INSTANCE
*AdapterInfo
252 IN NIC_DATA_INSTANCE
*AdapterInfo
258 IN NIC_DATA_INSTANCE
*AdapterInfo
264 IN NIC_DATA_INSTANCE
*AdapterInfo
270 IN NIC_DATA_INSTANCE
*AdapterInfo
276 NIC_DATA_INSTANCE
*AdapterInfo
282 IN NIC_DATA_INSTANCE
*AdapterInfo
288 IN NIC_DATA_INSTANCE
*AdapterInfo
294 IN NIC_DATA_INSTANCE
*AdapterInfo
300 IN NIC_DATA_INSTANCE
*AdapterInfo
306 IN NIC_DATA_INSTANCE
*AdapterInfo
312 IN NIC_DATA_INSTANCE
*AdapterInfo
318 IN NIC_DATA_INSTANCE
*AdapterInfo
324 IN NIC_DATA_INSTANCE
*AdapterInfo
330 IN NIC_DATA_INSTANCE
*AdapterInfo
336 IN NIC_DATA_INSTANCE
*AdapterInfo
342 IN NIC_DATA_INSTANCE
*AdapterInfo
348 IN NIC_DATA_INSTANCE
*AdapterInfo
351 VOID
UNDI_APIEntry_new(UINT64
);
352 VOID
UNDI_APIEntry_Common(UINT64
);
354 PXE_IPV4
convert_mcip(PXE_MAC_ADDR
*);
355 INT32
validate_mcip (PXE_MAC_ADDR
*MCastAddr
);
357 VOID
PxeStructInit (PXE_SW_UNDI
*PxePtr
);
358 VOID
PxeUpdate (NIC_DATA_INSTANCE
*NicPtr
, PXE_SW_UNDI
*PxePtr
);