]>
Commit | Line | Data |
---|---|---|
057d744e | 1 | /** @file\r |
2 | \r | |
a2cc5fea | 3 | Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r |
8f2a5f80 | 4 | This program and the accompanying materials\r |
057d744e | 5 | are licensed and made available under the terms and conditions of the BSD License\r |
6 | which accompanies this distribution. The full text of the license may be found at\r | |
7 | http://opensource.org/licenses/bsd-license.php\r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | SnpNt32.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | -**/\r | |
19 | \r | |
20 | #ifndef _SNP_NT32_H_\r | |
21 | #define _SNP_NT32_H_\r | |
593a8308 | 22 | \r |
60c93673 | 23 | #include <Uefi.h>\r |
593a8308 | 24 | \r |
25 | #include <Protocol/SimpleNetwork.h>\r | |
057d744e | 26 | #include <Protocol/DevicePath.h>\r |
593a8308 | 27 | #include <Protocol/WinNtThunk.h>\r |
057d744e | 28 | \r |
593a8308 | 29 | #include <Library/BaseLib.h>\r |
30 | #include <Library/DebugLib.h>\r | |
31 | #include <Library/BaseMemoryLib.h>\r | |
32 | #include <Library/UefiBootServicesTableLib.h>\r | |
33 | #include <Library/UefiLib.h>\r | |
057d744e | 34 | #include <Library/DevicePathLib.h>\r |
35 | #include <Library/NetLib.h>\r | |
36 | #include <Library/MemoryAllocationLib.h>\r | |
37 | \r | |
38 | typedef struct _SNPNT32_GLOBAL_DATA SNPNT32_GLOBAL_DATA;\r | |
39 | typedef struct _SNPNT32_INSTANCE_DATA SNPNT32_INSTANCE_DATA;\r | |
40 | \r | |
41 | #define NETWORK_LIBRARY_NAME_U L"SnpNt32Io.dll"\r | |
42 | \r | |
43 | #define NETWORK_LIBRARY_INITIALIZE "SnpInitialize"\r | |
44 | #define NETWORK_LIBRARY_FINALIZE "SnpFinalize"\r | |
45 | #define NETWORK_LIBRARY_SET_RCV_FILTER "SnpSetReceiveFilter"\r | |
46 | #define NETWORK_LIBRARY_RECEIVE "SnpReceive"\r | |
47 | #define NETWORK_LIBRARY_TRANSMIT "SnpTransmit"\r | |
48 | \r | |
49 | #pragma pack(1)\r | |
50 | typedef struct _NT_NET_INTERFACE_INFO {\r | |
51 | UINT32 InterfaceIndex;\r | |
52 | EFI_MAC_ADDRESS MacAddr;\r | |
53 | } NT_NET_INTERFACE_INFO;\r | |
54 | #pragma pack()\r | |
55 | \r | |
56 | #define NET_ETHER_HEADER_SIZE 14\r | |
57 | \r | |
58 | #define MAX_INTERFACE_INFO_NUMBER 16\r | |
59 | #define MAX_FILE_NAME_LENGTH 280\r | |
60 | \r | |
a2cc5fea ZL |
61 | #define SNP_MAX_TX_BUFFER_NUM 65536\r |
62 | #define SNP_TX_BUFFER_INCREASEMENT 32\r | |
63 | \r | |
64 | \r | |
65 | \r | |
66 | \r | |
057d744e | 67 | //\r |
68 | // Functions in Net Library\r | |
69 | //\r | |
70 | typedef\r | |
71 | INT32\r | |
72 | (*NT_NET_INITIALIZE) (\r | |
73 | IN OUT UINT32 *InterfaceCount,\r | |
74 | IN OUT NT_NET_INTERFACE_INFO * InterfaceInfoBuffer\r | |
75 | );\r | |
76 | \r | |
77 | typedef\r | |
78 | INT32\r | |
79 | (*NT_NET_FINALIZE) (\r | |
80 | VOID\r | |
81 | );\r | |
82 | \r | |
83 | typedef\r | |
84 | INT32\r | |
85 | (*NT_NET_SET_RECEIVE_FILTER) (\r | |
86 | IN UINT32 Index,\r | |
87 | IN UINT32 EnableFilter,\r | |
88 | IN UINT32 MCastFilterCnt,\r | |
89 | IN EFI_MAC_ADDRESS * MCastFilter\r | |
90 | );\r | |
91 | \r | |
92 | typedef\r | |
93 | INT32\r | |
94 | (*NT_NET_RECEIVE) (\r | |
95 | IN UINT32 Index,\r | |
96 | IN OUT UINT32 *BufferSize,\r | |
97 | OUT VOID *Buffer\r | |
98 | );\r | |
99 | \r | |
100 | typedef\r | |
101 | INT32\r | |
102 | (*NT_NET_TRANSMIT) (\r | |
103 | IN UINT32 Index,\r | |
104 | IN UINT32 HeaderSize,\r | |
105 | IN UINT32 BufferSize,\r | |
106 | IN VOID *Buffer,\r | |
107 | IN EFI_MAC_ADDRESS * SrcAddr,\r | |
108 | IN EFI_MAC_ADDRESS * DestAddr,\r | |
109 | IN UINT16 *Protocol\r | |
110 | );\r | |
111 | \r | |
112 | typedef struct _NT_NET_UTILITY_TABLE {\r | |
113 | NT_NET_INITIALIZE Initialize;\r | |
114 | NT_NET_FINALIZE Finalize;\r | |
115 | NT_NET_SET_RECEIVE_FILTER SetReceiveFilter;\r | |
116 | NT_NET_RECEIVE Receive;\r | |
117 | NT_NET_TRANSMIT Transmit;\r | |
118 | } NT_NET_UTILITY_TABLE;\r | |
119 | \r | |
120 | //\r | |
121 | // Private functions\r | |
122 | //\r | |
123 | typedef\r | |
124 | EFI_STATUS\r | |
125 | (*SNPNT32_INITIALIZE_GLOBAL_DATA) (\r | |
126 | IN SNPNT32_GLOBAL_DATA * This\r | |
127 | );\r | |
128 | \r | |
129 | typedef\r | |
130 | EFI_STATUS\r | |
131 | (*SNPNT32_INITIALIZE_INSTANCE_DATA) (\r | |
132 | IN SNPNT32_GLOBAL_DATA * This,\r | |
133 | IN SNPNT32_INSTANCE_DATA * Instance\r | |
134 | );\r | |
135 | \r | |
136 | typedef\r | |
137 | EFI_STATUS\r | |
138 | (*SNPNT32_CLOSE_INSTANCE) (\r | |
139 | IN SNPNT32_GLOBAL_DATA * This,\r | |
140 | IN SNPNT32_INSTANCE_DATA * Instance\r | |
141 | );\r | |
142 | \r | |
143 | //\r | |
144 | // Global data for this driver\r | |
145 | //\r | |
99e1dd89 | 146 | #define SNP_NT32_DRIVER_SIGNATURE SIGNATURE_32 ('W', 'S', 'N', 'P')\r |
057d744e | 147 | \r |
a00ec39b | 148 | struct _SNPNT32_GLOBAL_DATA {\r |
057d744e | 149 | UINT32 Signature;\r |
150 | \r | |
151 | //\r | |
152 | // List for all the fake SNP instance\r | |
153 | //\r | |
e90e8777 | 154 | LIST_ENTRY InstanceList;\r |
057d744e | 155 | \r |
156 | EFI_WIN_NT_THUNK_PROTOCOL *WinNtThunk;\r | |
157 | HMODULE NetworkLibraryHandle;\r | |
158 | \r | |
159 | NT_NET_UTILITY_TABLE NtNetUtilityTable;\r | |
160 | \r | |
e90e8777 | 161 | EFI_LOCK Lock;\r |
057d744e | 162 | \r |
a2cc5fea ZL |
163 | //\r |
164 | // Array of the recycled transmit buffer address.\r | |
165 | //\r | |
166 | UINT64 *RecycledTxBuf;\r | |
167 | \r | |
168 | //\r | |
169 | // Current number of recycled buffer pointers in RecycledTxBuf.\r | |
170 | //\r | |
171 | UINT32 RecycledTxBufCount;\r | |
172 | \r | |
173 | // The maximum number of recycled buffer pointers in RecycledTxBuf.\r | |
174 | //\r | |
175 | UINT32 MaxRecycledTxBuf;\r | |
176 | \r | |
057d744e | 177 | //\r |
178 | // Private functions\r | |
179 | //\r | |
180 | SNPNT32_INITIALIZE_GLOBAL_DATA InitializeGlobalData;\r | |
181 | SNPNT32_INITIALIZE_INSTANCE_DATA InitializeInstanceData;\r | |
182 | SNPNT32_CLOSE_INSTANCE CloseInstance;\r | |
a00ec39b | 183 | };\r |
057d744e | 184 | \r |
185 | //\r | |
186 | // Instance data for each fake SNP instance\r | |
187 | //\r | |
99e1dd89 | 188 | #define SNP_NT32_INSTANCE_SIGNATURE SIGNATURE_32 ('w', 'S', 'N', 'P')\r |
057d744e | 189 | \r |
a00ec39b | 190 | struct _SNPNT32_INSTANCE_DATA {\r |
057d744e | 191 | UINT32 Signature;\r |
192 | \r | |
193 | //\r | |
194 | // List entry use for linking with other instance\r | |
195 | //\r | |
e90e8777 | 196 | LIST_ENTRY Entry;\r |
057d744e | 197 | \r |
198 | SNPNT32_GLOBAL_DATA *GlobalData;\r | |
199 | \r | |
200 | EFI_HANDLE DeviceHandle;\r | |
201 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
202 | \r | |
203 | EFI_SIMPLE_NETWORK_PROTOCOL Snp;\r | |
204 | EFI_SIMPLE_NETWORK_MODE Mode;\r | |
205 | \r | |
206 | NT_NET_INTERFACE_INFO InterfaceInfo;\r | |
207 | \r | |
208 | //\r | |
209 | // Private functions\r | |
210 | //\r | |
a00ec39b | 211 | };\r |
057d744e | 212 | \r |
213 | #define SNP_NT32_INSTANCE_DATA_FROM_SNP_THIS(a) \\r | |
214 | CR ( \\r | |
215 | a, \\r | |
216 | SNPNT32_INSTANCE_DATA, \\r | |
217 | Snp, \\r | |
218 | SNP_NT32_INSTANCE_SIGNATURE \\r | |
219 | )\r | |
220 | \r | |
531237a5 | 221 | extern EFI_DRIVER_BINDING_PROTOCOL gSnpNt32DriverBinding;\r |
057d744e | 222 | extern EFI_COMPONENT_NAME_PROTOCOL gSnpNt32DriverComponentName;\r |
223 | extern EFI_COMPONENT_NAME2_PROTOCOL gSnpNt32DriverComponentName2;\r | |
224 | \r | |
531237a5 | 225 | /**\r |
226 | Test to see if this driver supports ControllerHandle. This service\r | |
227 | is called by the EFI boot service ConnectController(). In\r | |
228 | order to make drivers as small as possible, there are a few calling\r | |
229 | restrictions for this service. ConnectController() must\r | |
230 | follow these calling restrictions. If any other agent wishes to call\r | |
231 | Supported() it must also follow these calling restrictions.\r | |
232 | \r | |
233 | @param This Protocol instance pointer.\r | |
234 | @param ControllerHandle Handle of device to test\r | |
235 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
236 | device to start.\r | |
237 | \r | |
238 | @retval EFI_SUCCESS This driver supports this device\r | |
239 | @retval EFI_UNSUPPORTED This driver does not support this device\r | |
240 | \r | |
241 | **/\r | |
057d744e | 242 | EFI_STATUS\r |
243 | EFIAPI\r | |
244 | SnpNt32DriverBindingSupported (\r | |
245 | IN EFI_DRIVER_BINDING_PROTOCOL * This,\r | |
246 | IN EFI_HANDLE ControllerHandle,\r | |
247 | IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r | |
248 | );\r | |
249 | \r | |
531237a5 | 250 | /**\r |
251 | Start this driver on ControllerHandle. This service is called by the\r | |
252 | EFI boot service ConnectController(). In order to make\r | |
253 | drivers as small as possible, there are a few calling restrictions for\r | |
254 | this service. ConnectController() must follow these\r | |
255 | calling restrictions. If any other agent wishes to call Start() it\r | |
256 | must also follow these calling restrictions.\r | |
257 | \r | |
258 | @param This Protocol instance pointer.\r | |
259 | @param ControllerHandle Handle of device to bind driver to\r | |
260 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
261 | device to start.\r | |
262 | \r | |
263 | @retval EFI_SUCCESS Always succeeds.\r | |
264 | \r | |
265 | **/\r | |
057d744e | 266 | EFI_STATUS\r |
267 | EFIAPI\r | |
268 | SnpNt32DriverBindingStart (\r | |
269 | IN EFI_DRIVER_BINDING_PROTOCOL * This,\r | |
270 | IN EFI_HANDLE ControllerHandle,\r | |
271 | IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r | |
272 | );\r | |
273 | \r | |
531237a5 | 274 | /**\r |
275 | Stop this driver on ControllerHandle. This service is called by the\r | |
276 | EFI boot service DisconnectController(). In order to\r | |
277 | make drivers as small as possible, there are a few calling\r | |
278 | restrictions for this service. DisconnectController()\r | |
279 | must follow these calling restrictions. If any other agent wishes\r | |
280 | to call Stop() it must also follow these calling restrictions.\r | |
281 | \r | |
282 | @param This Protocol instance pointer.\r | |
283 | @param ControllerHandle Handle of device to stop driver on\r | |
284 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
285 | children is zero stop the entire bus driver.\r | |
286 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
287 | \r | |
288 | @retval EFI_SUCCESS Always succeeds.\r | |
289 | \r | |
290 | **/\r | |
057d744e | 291 | EFI_STATUS\r |
292 | EFIAPI\r | |
293 | SnpNt32DriverBindingStop (\r | |
294 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
295 | IN EFI_HANDLE ControllerHandle,\r | |
296 | IN UINTN NumberOfChildren,\r | |
297 | IN EFI_HANDLE *ChildHandleBuffer\r | |
298 | );\r | |
299 | \r | |
531237a5 | 300 | /**\r |
301 | Initialize the driver's global data.\r | |
302 | \r | |
303 | @param This Pointer to the global context data.\r | |
304 | \r | |
305 | @retval EFI_SUCCESS The global data is initialized.\r | |
306 | @retval EFI_NOT_FOUND The required DLL is not found.\r | |
307 | @retval EFI_DEVICE_ERROR Error initialize network utility library.\r | |
308 | @retval EFI_OUT_OF_RESOURCES Out of resource.\r | |
309 | @retval other Other errors.\r | |
310 | \r | |
311 | **/\r | |
057d744e | 312 | EFI_STATUS\r |
313 | SnpNt32InitializeGlobalData (\r | |
531237a5 | 314 | IN OUT SNPNT32_GLOBAL_DATA *This\r |
057d744e | 315 | );\r |
316 | \r | |
531237a5 | 317 | /**\r |
318 | Initialize the snpnt32 driver instance.\r | |
319 | \r | |
320 | @param This Pointer to the SnpNt32 global data.\r | |
321 | @param Instance Pointer to the instance context data.\r | |
322 | \r | |
323 | @retval EFI_SUCCESS The driver instance is initialized.\r | |
324 | @retval other Initialization errors.\r | |
325 | \r | |
326 | **/\r | |
057d744e | 327 | EFI_STATUS\r |
328 | SnpNt32InitializeInstanceData (\r | |
531237a5 | 329 | IN SNPNT32_GLOBAL_DATA *This,\r |
330 | IN OUT SNPNT32_INSTANCE_DATA *Instance\r | |
057d744e | 331 | );\r |
332 | \r | |
531237a5 | 333 | /**\r |
334 | Close the SnpNt32 driver instance.\r | |
335 | \r | |
336 | @param This Pointer to the SnpNt32 global data.\r | |
337 | @param Instance Pointer to the instance context data.\r | |
338 | \r | |
339 | @retval EFI_SUCCESS The instance is closed.\r | |
340 | \r | |
341 | **/\r | |
057d744e | 342 | EFI_STATUS\r |
343 | SnpNt32CloseInstance (\r | |
531237a5 | 344 | IN SNPNT32_GLOBAL_DATA *This,\r |
345 | IN OUT SNPNT32_INSTANCE_DATA *Instance\r | |
057d744e | 346 | );\r |
347 | \r | |
348 | #endif\r |