]>
Commit | Line | Data |
---|---|---|
572287f8 | 1 | /** @file\r |
2 | \r | |
3 | Copyright (c) 2010, Apple, Inc. All rights reserved.<BR>\r | |
d7dd9387 | 4 | Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r |
572287f8 | 5 | \r |
e3ba31da | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
572287f8 | 7 | \r |
8 | Module Name:\r | |
9 | \r | |
10 | EmuSnp.c\r | |
11 | \r | |
12 | Abstract:\r | |
13 | \r | |
14 | -**/\r | |
15 | \r | |
16 | #include "EmuSnpDxe.h"\r | |
17 | \r | |
18 | \r | |
19 | \r | |
20 | EFI_SIMPLE_NETWORK_PROTOCOL gEmuSnpTemplate = {\r | |
d18d8a1d | 21 | EFI_SIMPLE_NETWORK_PROTOCOL_REVISION,\r |
22 | EmuSnpStart,\r | |
23 | EmuSnpStop,\r | |
24 | EmuSnpInitialize,\r | |
25 | EmuSnpReset,\r | |
26 | EmuSnpShutdown,\r | |
27 | EmuSnpReceiveFilters,\r | |
28 | EmuSnpStationAddress,\r | |
29 | EmuSnpStatistics,\r | |
30 | EmuSnpMcastIptoMac,\r | |
31 | EmuSnpNvdata,\r | |
32 | EmuSnpGetStatus,\r | |
33 | EmuSnpTransmit,\r | |
34 | EmuSnpReceive,\r | |
572287f8 | 35 | NULL, // WaitForPacket\r |
36 | NULL // Mode\r | |
37 | };\r | |
38 | \r | |
79e4f2a5 | 39 | EFI_SIMPLE_NETWORK_MODE gEmuSnpModeTemplate = {\r |
f79fa76e | 40 | EfiSimpleNetworkStopped, // State\r |
41 | NET_ETHER_ADDR_LEN, // HwAddressSize\r | |
42 | NET_ETHER_HEADER_SIZE, // MediaHeaderSize\r | |
43 | 1500, // MaxPacketSize\r | |
44 | 0, // NvRamSize\r | |
45 | 0, // NvRamAccessSize\r | |
46 | 0, // ReceiveFilterMask\r | |
47 | 0, // ReceiveFilterSetting\r | |
48 | MAX_MCAST_FILTER_CNT, // MaxMCastFilterCount\r | |
49 | 0, // MCastFilterCount\r | |
50 | {\r | |
51 | { { 0 } }\r | |
52 | }, // MCastFilter\r | |
53 | {\r | |
54 | { 0 }\r | |
55 | }, // CurrentAddress\r | |
56 | {\r | |
57 | { 0 }\r | |
58 | }, // BroadcastAddress\r | |
59 | {\r | |
60 | { 0 }\r | |
61 | }, // PermanentAddress\r | |
62 | NET_IFTYPE_ETHERNET, // IfType\r | |
63 | FALSE, // MacAddressChangeable\r | |
64 | FALSE, // MultipleTxSupported\r | |
65 | FALSE, // MediaPresentSupported\r | |
66 | TRUE // MediaPresent\r | |
67 | };\r | |
572287f8 | 68 | \r |
69 | \r | |
70 | /**\r | |
71 | Changes the state of a network interface from "stopped" to "started".\r | |
72 | \r | |
73 | @param This Protocol instance pointer.\r | |
74 | \r | |
75 | @retval EFI_SUCCESS Always succeeds.\r | |
76 | \r | |
77 | **/\r | |
78 | EFI_STATUS\r | |
79 | EFIAPI\r | |
80 | EmuSnpStart(\r | |
81 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r | |
82 | )\r | |
83 | {\r | |
84 | EFI_STATUS Status;\r | |
85 | EMU_SNP_PRIVATE_DATA *Private;\r | |
86 | \r | |
87 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
88 | \r | |
89 | Status = Private->Io->Start (Private->Io);\r | |
90 | return Status;\r | |
91 | }\r | |
92 | \r | |
93 | \r | |
94 | /**\r | |
95 | Changes the state of a network interface from "started" to "stopped".\r | |
96 | \r | |
97 | @param This Protocol instance pointer.\r | |
98 | \r | |
99 | @retval EFI_SUCCESS Always succeeds.\r | |
100 | \r | |
101 | **/\r | |
102 | EFI_STATUS\r | |
103 | EFIAPI\r | |
104 | EmuSnpStop (\r | |
105 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r | |
106 | )\r | |
107 | {\r | |
108 | EFI_STATUS Status;\r | |
109 | EMU_SNP_PRIVATE_DATA *Private;\r | |
110 | \r | |
111 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
112 | \r | |
113 | Status = Private->Io->Stop (Private->Io);\r | |
114 | return Status;\r | |
115 | }\r | |
116 | \r | |
117 | \r | |
118 | /**\r | |
d18d8a1d | 119 | Resets a network adapter and allocates the transmit and receive buffers\r |
120 | required by the network interface; optionally, also requests allocation\r | |
572287f8 | 121 | of additional transmit and receive buffers.\r |
122 | \r | |
123 | @param This Protocol instance pointer.\r | |
124 | @param ExtraRxBufferSize The size, in bytes, of the extra receive buffer space\r | |
125 | that the driver should allocate for the network interface.\r | |
126 | Some network interfaces will not be able to use the extra\r | |
127 | buffer, and the caller will not know if it is actually\r | |
128 | being used.\r | |
129 | @param ExtraTxBufferSize The size, in bytes, of the extra transmit buffer space\r | |
130 | that the driver should allocate for the network interface.\r | |
131 | Some network interfaces will not be able to use the extra\r | |
132 | buffer, and the caller will not know if it is actually\r | |
133 | being used.\r | |
134 | \r | |
135 | @retval EFI_SUCCESS Always succeeds.\r | |
136 | \r | |
137 | **/\r | |
138 | EFI_STATUS\r | |
139 | EFIAPI\r | |
140 | EmuSnpInitialize (\r | |
141 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
142 | IN UINTN ExtraRxBufferSize OPTIONAL,\r | |
143 | IN UINTN ExtraTxBufferSize OPTIONAL\r | |
144 | )\r | |
145 | {\r | |
146 | EFI_STATUS Status;\r | |
147 | EMU_SNP_PRIVATE_DATA *Private;\r | |
148 | \r | |
149 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
150 | \r | |
151 | Status = Private->Io->Initialize (Private->Io, ExtraRxBufferSize, ExtraTxBufferSize);\r | |
152 | return Status;\r | |
153 | }\r | |
154 | \r | |
155 | /**\r | |
d18d8a1d | 156 | Resets a network adapter and re-initializes it with the parameters that were\r |
157 | provided in the previous call to Initialize().\r | |
572287f8 | 158 | \r |
159 | @param This Protocol instance pointer.\r | |
160 | @param ExtendedVerification Indicates that the driver may perform a more\r | |
161 | exhaustive verification operation of the device\r | |
162 | during reset.\r | |
163 | \r | |
164 | @retval EFI_SUCCESS Always succeeds.\r | |
165 | \r | |
166 | **/\r | |
167 | EFI_STATUS\r | |
168 | EFIAPI\r | |
169 | EmuSnpReset (\r | |
170 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
171 | IN BOOLEAN ExtendedVerification\r | |
172 | )\r | |
173 | {\r | |
174 | EFI_STATUS Status;\r | |
175 | EMU_SNP_PRIVATE_DATA *Private;\r | |
176 | \r | |
177 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
178 | \r | |
179 | Status = Private->Io->Reset (Private->Io, ExtendedVerification);\r | |
180 | return Status;\r | |
181 | }\r | |
182 | \r | |
183 | /**\r | |
d18d8a1d | 184 | Resets a network adapter and leaves it in a state that is safe for\r |
572287f8 | 185 | another driver to initialize.\r |
186 | \r | |
187 | @param This Protocol instance pointer.\r | |
188 | \r | |
189 | @retval EFI_SUCCESS Always succeeds.\r | |
190 | \r | |
191 | **/\r | |
192 | EFI_STATUS\r | |
193 | EFIAPI\r | |
194 | EmuSnpShutdown (\r | |
195 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r | |
196 | )\r | |
197 | {\r | |
198 | EFI_STATUS Status;\r | |
199 | EMU_SNP_PRIVATE_DATA *Private;\r | |
200 | \r | |
201 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
202 | \r | |
203 | Status = Private->Io->Shutdown (Private->Io);\r | |
204 | return Status;\r | |
205 | }\r | |
206 | \r | |
207 | /**\r | |
208 | Manages the multicast receive filters of a network interface.\r | |
209 | \r | |
210 | @param This Protocol instance pointer.\r | |
211 | @param EnableBits A bit mask of receive filters to enable on the network interface.\r | |
212 | @param DisableBits A bit mask of receive filters to disable on the network interface.\r | |
213 | @param ResetMcastFilter Set to TRUE to reset the contents of the multicast receive\r | |
214 | filters on the network interface to their default values.\r | |
215 | @param McastFilterCount Number of multicast HW MAC addresses in the new\r | |
216 | MCastFilter list. This value must be less than or equal to\r | |
217 | the MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE. This\r | |
218 | field is optional if ResetMCastFilter is TRUE.\r | |
219 | @param McastFilter A pointer to a list of new multicast receive filter HW MAC\r | |
220 | addresses. This list will replace any existing multicast\r | |
221 | HW MAC address list. This field is optional if\r | |
222 | ResetMCastFilter is TRUE.\r | |
223 | \r | |
224 | @retval EFI_SUCCESS The multicast receive filter list was updated.\r | |
225 | @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r | |
226 | \r | |
227 | **/\r | |
228 | EFI_STATUS\r | |
229 | EFIAPI\r | |
230 | EmuSnpReceiveFilters (\r | |
231 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
232 | IN UINT32 EnableBits,\r | |
233 | IN UINT32 DisableBits,\r | |
234 | IN BOOLEAN ResetMcastFilter,\r | |
235 | IN UINTN McastFilterCount OPTIONAL,\r | |
236 | IN EFI_MAC_ADDRESS *McastFilter OPTIONAL\r | |
237 | )\r | |
238 | {\r | |
239 | EFI_STATUS Status;\r | |
240 | EMU_SNP_PRIVATE_DATA *Private;\r | |
241 | \r | |
242 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
243 | \r | |
244 | Status = Private->Io->ReceiveFilters (\r | |
245 | Private->Io,\r | |
246 | EnableBits,\r | |
247 | DisableBits,\r | |
248 | ResetMcastFilter,\r | |
249 | McastFilterCount,\r | |
250 | McastFilter\r | |
251 | );\r | |
252 | return Status;\r | |
253 | }\r | |
254 | \r | |
255 | /**\r | |
256 | Modifies or resets the current station address, if supported.\r | |
257 | \r | |
258 | @param This Protocol instance pointer.\r | |
259 | @param Reset Flag used to reset the station address to the network interfaces\r | |
260 | permanent address.\r | |
261 | @param NewMacAddr New station address to be used for the network interface.\r | |
262 | \r | |
263 | @retval EFI_UNSUPPORTED Not supported yet.\r | |
264 | \r | |
265 | **/\r | |
266 | EFI_STATUS\r | |
267 | EFIAPI\r | |
268 | EmuSnpStationAddress (\r | |
269 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
270 | IN BOOLEAN Reset,\r | |
271 | IN EFI_MAC_ADDRESS *NewMacAddr OPTIONAL\r | |
272 | )\r | |
273 | {\r | |
274 | EFI_STATUS Status;\r | |
275 | EMU_SNP_PRIVATE_DATA *Private;\r | |
276 | \r | |
277 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
278 | \r | |
279 | Status = Private->Io->StationAddress (Private->Io, Reset, NewMacAddr);\r | |
280 | return Status;\r | |
281 | }\r | |
282 | \r | |
283 | /**\r | |
284 | Resets or collects the statistics on a network interface.\r | |
285 | \r | |
286 | @param This Protocol instance pointer.\r | |
287 | @param Reset Set to TRUE to reset the statistics for the network interface.\r | |
288 | @param StatisticsSize On input the size, in bytes, of StatisticsTable. On\r | |
289 | output the size, in bytes, of the resulting table of\r | |
290 | statistics.\r | |
291 | @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that\r | |
292 | contains the statistics.\r | |
293 | \r | |
294 | @retval EFI_SUCCESS The statistics were collected from the network interface.\r | |
295 | @retval EFI_NOT_STARTED The network interface has not been started.\r | |
296 | @retval EFI_BUFFER_TOO_SMALL The Statistics buffer was too small. The current buffer\r | |
297 | size needed to hold the statistics is returned in\r | |
298 | StatisticsSize.\r | |
299 | @retval EFI_UNSUPPORTED Not supported yet.\r | |
300 | \r | |
301 | **/\r | |
302 | EFI_STATUS\r | |
303 | EFIAPI\r | |
304 | EmuSnpStatistics (\r | |
305 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
306 | IN BOOLEAN Reset,\r | |
307 | IN OUT UINTN *StatisticsSize OPTIONAL,\r | |
308 | OUT EFI_NETWORK_STATISTICS *StatisticsTable OPTIONAL\r | |
309 | )\r | |
310 | {\r | |
311 | EFI_STATUS Status;\r | |
312 | EMU_SNP_PRIVATE_DATA *Private;\r | |
313 | \r | |
314 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
315 | \r | |
316 | Status = Private->Io->Statistics (Private->Io, Reset, StatisticsSize, StatisticsTable);\r | |
317 | return Status;\r | |
318 | }\r | |
319 | \r | |
320 | /**\r | |
321 | Converts a multicast IP address to a multicast HW MAC address.\r | |
322 | \r | |
323 | @param This Protocol instance pointer.\r | |
324 | @param Ipv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460]. Set\r | |
325 | to FALSE if the multicast IP address is IPv4 [RFC 791].\r | |
326 | @param Ip The multicast IP address that is to be converted to a multicast\r | |
327 | HW MAC address.\r | |
328 | @param Mac The multicast HW MAC address that is to be generated from IP.\r | |
329 | \r | |
330 | @retval EFI_SUCCESS The multicast IP address was mapped to the multicast\r | |
331 | HW MAC address.\r | |
332 | @retval EFI_NOT_STARTED The network interface has not been started.\r | |
333 | @retval EFI_BUFFER_TOO_SMALL The Statistics buffer was too small. The current buffer\r | |
334 | size needed to hold the statistics is returned in\r | |
335 | StatisticsSize.\r | |
336 | @retval EFI_UNSUPPORTED Not supported yet.\r | |
337 | \r | |
338 | **/\r | |
339 | EFI_STATUS\r | |
340 | EFIAPI\r | |
341 | EmuSnpMcastIptoMac (\r | |
342 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
343 | IN BOOLEAN Ipv6,\r | |
344 | IN EFI_IP_ADDRESS *Ip,\r | |
345 | OUT EFI_MAC_ADDRESS *Mac\r | |
346 | )\r | |
347 | {\r | |
348 | EFI_STATUS Status;\r | |
349 | EMU_SNP_PRIVATE_DATA *Private;\r | |
350 | \r | |
351 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
352 | \r | |
353 | Status = Private->Io->MCastIpToMac (Private->Io, Ipv6, Ip, Mac);\r | |
354 | return Status;\r | |
355 | }\r | |
356 | \r | |
357 | \r | |
358 | /**\r | |
d18d8a1d | 359 | Performs read and write operations on the NVRAM device attached to a\r |
572287f8 | 360 | network interface.\r |
361 | \r | |
362 | @param This Protocol instance pointer.\r | |
363 | @param ReadOrWrite TRUE for read operations, FALSE for write operations.\r | |
364 | @param Offset Byte offset in the NVRAM device at which to start the read or\r | |
365 | write operation. This must be a multiple of NvRamAccessSize and\r | |
366 | less than NvRamSize.\r | |
367 | @param BufferSize The number of bytes to read or write from the NVRAM device.\r | |
368 | This must also be a multiple of NvramAccessSize.\r | |
369 | @param Buffer A pointer to the data buffer.\r | |
370 | \r | |
371 | @retval EFI_UNSUPPORTED Not supported yet.\r | |
372 | \r | |
373 | **/\r | |
374 | EFI_STATUS\r | |
375 | EFIAPI\r | |
376 | EmuSnpNvdata (\r | |
377 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
378 | IN BOOLEAN ReadOrWrite,\r | |
379 | IN UINTN Offset,\r | |
380 | IN UINTN BufferSize,\r | |
381 | IN OUT VOID *Buffer\r | |
382 | )\r | |
383 | {\r | |
384 | EFI_STATUS Status;\r | |
385 | EMU_SNP_PRIVATE_DATA *Private;\r | |
386 | \r | |
387 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
388 | \r | |
389 | Status = Private->Io->NvData (Private->Io, ReadOrWrite, Offset, BufferSize, Buffer);\r | |
390 | return Status;\r | |
391 | }\r | |
392 | \r | |
393 | \r | |
394 | /**\r | |
d18d8a1d | 395 | Reads the current interrupt status and recycled transmit buffer status from\r |
572287f8 | 396 | a network interface.\r |
397 | \r | |
398 | @param This Protocol instance pointer.\r | |
399 | @param InterruptStatus A pointer to the bit mask of the currently active interrupts\r | |
400 | If this is NULL, the interrupt status will not be read from\r | |
401 | the device. If this is not NULL, the interrupt status will\r | |
402 | be read from the device. When the interrupt status is read,\r | |
403 | it will also be cleared. Clearing the transmit interrupt\r | |
404 | does not empty the recycled transmit buffer array.\r | |
405 | @param TxBuffer Recycled transmit buffer address. The network interface will\r | |
406 | not transmit if its internal recycled transmit buffer array\r | |
407 | is full. Reading the transmit buffer does not clear the\r | |
408 | transmit interrupt. If this is NULL, then the transmit buffer\r | |
409 | status will not be read. If there are no transmit buffers to\r | |
410 | recycle and TxBuf is not NULL, * TxBuf will be set to NULL.\r | |
411 | \r | |
412 | @retval EFI_SUCCESS Always succeeds.\r | |
413 | \r | |
414 | **/\r | |
415 | EFI_STATUS\r | |
416 | EFIAPI\r | |
417 | EmuSnpGetStatus (\r | |
418 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
419 | OUT UINT32 *InterruptStatus,\r | |
420 | OUT VOID **TxBuffer\r | |
421 | )\r | |
422 | {\r | |
423 | EFI_STATUS Status;\r | |
424 | EMU_SNP_PRIVATE_DATA *Private;\r | |
425 | \r | |
426 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
427 | \r | |
428 | Status = Private->Io->GetStatus (Private->Io, InterruptStatus, TxBuffer);\r | |
429 | return Status;\r | |
430 | }\r | |
431 | \r | |
432 | \r | |
433 | /**\r | |
434 | Places a packet in the transmit queue of a network interface.\r | |
435 | \r | |
436 | @param This Protocol instance pointer.\r | |
437 | @param HeaderSize The size, in bytes, of the media header to be filled in by\r | |
438 | the Transmit() function. If HeaderSize is non-zero, then it\r | |
439 | must be equal to This->Mode->MediaHeaderSize and the DestAddr\r | |
440 | and Protocol parameters must not be NULL.\r | |
441 | @param BufferSize The size, in bytes, of the entire packet (media header and\r | |
442 | data) to be transmitted through the network interface.\r | |
443 | @param Buffer A pointer to the packet (media header followed by data) to be\r | |
444 | transmitted. This parameter cannot be NULL. If HeaderSize is zero,\r | |
445 | then the media header in Buffer must already be filled in by the\r | |
446 | caller. If HeaderSize is non-zero, then the media header will be\r | |
447 | filled in by the Transmit() function.\r | |
448 | @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this parameter\r | |
449 | is ignored. If HeaderSize is non-zero and SrcAddr is NULL, then\r | |
450 | This->Mode->CurrentAddress is used for the source HW MAC address.\r | |
451 | @param DestAddr The destination HW MAC address. If HeaderSize is zero, then this\r | |
452 | parameter is ignored.\r | |
453 | @param Protocol The type of header to build. If HeaderSize is zero, then this\r | |
454 | parameter is ignored. See RFC 1700, section "Ether Types", for\r | |
455 | examples.\r | |
456 | \r | |
457 | @retval EFI_SUCCESS The packet was placed on the transmit queue.\r | |
458 | @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r | |
459 | @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r | |
460 | @retval EFI_NOT_STARTED The network interface has not been started.\r | |
461 | \r | |
462 | **/\r | |
463 | EFI_STATUS\r | |
464 | EFIAPI\r | |
465 | EmuSnpTransmit (\r | |
466 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
467 | IN UINTN HeaderSize,\r | |
468 | IN UINTN BufferSize,\r | |
469 | IN VOID* Buffer,\r | |
470 | IN EFI_MAC_ADDRESS *SrcAddr OPTIONAL,\r | |
471 | IN EFI_MAC_ADDRESS *DestAddr OPTIONAL,\r | |
472 | IN UINT16 *Protocol OPTIONAL\r | |
473 | )\r | |
474 | {\r | |
475 | EFI_STATUS Status;\r | |
476 | EMU_SNP_PRIVATE_DATA *Private;\r | |
477 | \r | |
478 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
479 | \r | |
480 | Status = Private->Io->Transmit (\r | |
481 | Private->Io,\r | |
482 | HeaderSize,\r | |
483 | BufferSize,\r | |
484 | Buffer,\r | |
485 | SrcAddr,\r | |
486 | DestAddr,\r | |
487 | Protocol\r | |
488 | );\r | |
489 | return Status;\r | |
490 | }\r | |
491 | \r | |
492 | /**\r | |
493 | Receives a packet from a network interface.\r | |
494 | \r | |
495 | @param This Protocol instance pointer.\r | |
496 | @param HeaderSize The size, in bytes, of the media header received on the network\r | |
497 | interface. If this parameter is NULL, then the media header size\r | |
498 | will not be returned.\r | |
499 | @param BuffSize On entry, the size, in bytes, of Buffer. On exit, the size, in\r | |
500 | bytes, of the packet that was received on the network interface.\r | |
501 | @param Buffer A pointer to the data buffer to receive both the media header and\r | |
502 | the data.\r | |
503 | @param SourceAddr The source HW MAC address. If this parameter is NULL, the\r | |
504 | HW MAC source address will not be extracted from the media\r | |
505 | header.\r | |
506 | @param DestinationAddr The destination HW MAC address. If this parameter is NULL,\r | |
507 | the HW MAC destination address will not be extracted from the\r | |
508 | media header.\r | |
509 | @param Protocol The media header type. If this parameter is NULL, then the\r | |
510 | protocol will not be extracted from the media header. See\r | |
511 | RFC 1700 section "Ether Types" for examples.\r | |
512 | \r | |
513 | @retval EFI_SUCCESS The received data was stored in Buffer, and BufferSize has\r | |
514 | been updated to the number of bytes received.\r | |
515 | @retval EFI_NOT_READY The network interface is too busy to accept this transmit\r | |
516 | request.\r | |
517 | @retval EFI_NOT_STARTED The network interface has not been started.\r | |
518 | @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small.\r | |
519 | @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.\r | |
520 | \r | |
521 | **/\r | |
522 | EFI_STATUS\r | |
523 | EFIAPI\r | |
524 | EmuSnpReceive (\r | |
525 | IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r | |
526 | OUT UINTN *HeaderSize OPTIONAL,\r | |
527 | IN OUT UINTN *BuffSize,\r | |
528 | OUT VOID *Buffer,\r | |
529 | OUT EFI_MAC_ADDRESS *SourceAddr OPTIONAL,\r | |
530 | OUT EFI_MAC_ADDRESS *DestinationAddr OPTIONAL,\r | |
531 | OUT UINT16 *Protocol OPTIONAL\r | |
532 | )\r | |
533 | {\r | |
534 | EFI_STATUS Status;\r | |
535 | EMU_SNP_PRIVATE_DATA *Private;\r | |
536 | \r | |
537 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (This);\r | |
538 | \r | |
539 | Status = Private->Io->Receive (\r | |
540 | Private->Io,\r | |
541 | HeaderSize,\r | |
542 | BuffSize,\r | |
543 | Buffer,\r | |
544 | SourceAddr,\r | |
545 | DestinationAddr,\r | |
546 | Protocol\r | |
547 | );\r | |
548 | return Status;\r | |
549 | }\r | |
550 | \r | |
551 | \r | |
552 | \r | |
553 | /**\r | |
554 | Test to see if this driver supports ControllerHandle. This service\r | |
555 | is called by the EFI boot service ConnectController(). In\r | |
556 | order to make drivers as small as possible, there are a few calling\r | |
557 | restrictions for this service. ConnectController() must\r | |
558 | follow these calling restrictions. If any other agent wishes to call\r | |
559 | Supported() it must also follow these calling restrictions.\r | |
560 | \r | |
561 | @param This Protocol instance pointer.\r | |
562 | @param ControllerHandle Handle of device to test\r | |
563 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
564 | device to start.\r | |
565 | \r | |
566 | @retval EFI_SUCCESS This driver supports this device\r | |
567 | @retval EFI_UNSUPPORTED This driver does not support this device\r | |
568 | \r | |
569 | **/\r | |
570 | EFI_STATUS\r | |
571 | EFIAPI\r | |
572 | EmuSnpDriverBindingSupported (\r | |
573 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
574 | IN EFI_HANDLE ControllerHandle,\r | |
575 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
576 | )\r | |
577 | {\r | |
578 | EFI_STATUS Status;\r | |
579 | EMU_IO_THUNK_PROTOCOL *EmuIoThunk;\r | |
580 | MAC_ADDR_DEVICE_PATH *Node;\r | |
581 | EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r | |
582 | \r | |
583 | if (RemainingDevicePath != NULL) {\r | |
584 | if (!IsDevicePathEnd (RemainingDevicePath)) {\r | |
585 | Node = (MAC_ADDR_DEVICE_PATH *)RemainingDevicePath;\r | |
586 | if (Node->Header.Type != MESSAGING_DEVICE_PATH ||\r | |
587 | Node->Header.SubType != MSG_MAC_ADDR_DP) {\r | |
588 | // If the remaining device path does not match we don't support the request\r | |
589 | return EFI_UNSUPPORTED;\r | |
590 | }\r | |
591 | }\r | |
592 | }\r | |
d18d8a1d | 593 | \r |
594 | \r | |
572287f8 | 595 | //\r |
596 | // Open the IO Abstraction(s) needed to perform the supported test\r | |
597 | //\r | |
598 | Status = gBS->OpenProtocol (\r | |
599 | ControllerHandle,\r | |
600 | &gEmuIoThunkProtocolGuid,\r | |
601 | (VOID **)&EmuIoThunk,\r | |
602 | This->DriverBindingHandle,\r | |
603 | ControllerHandle,\r | |
604 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
605 | );\r | |
606 | if (EFI_ERROR (Status)) {\r | |
607 | return Status;\r | |
608 | }\r | |
609 | \r | |
572287f8 | 610 | //\r |
611 | // Close the I/O Abstraction(s) used to perform the supported test\r | |
612 | //\r | |
613 | gBS->CloseProtocol (\r | |
614 | ControllerHandle,\r | |
615 | &gEmuIoThunkProtocolGuid,\r | |
616 | This->DriverBindingHandle,\r | |
617 | ControllerHandle\r | |
618 | );\r | |
d18d8a1d | 619 | \r |
620 | \r | |
572287f8 | 621 | //\r |
622 | // Open the EFI Device Path protocol needed to perform the supported test\r | |
623 | //\r | |
624 | Status = gBS->OpenProtocol (\r | |
625 | ControllerHandle,\r | |
626 | &gEfiDevicePathProtocolGuid,\r | |
627 | (VOID **) &ParentDevicePath,\r | |
628 | This->DriverBindingHandle,\r | |
629 | ControllerHandle,\r | |
630 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
631 | );\r | |
632 | if (Status == EFI_ALREADY_STARTED) {\r | |
633 | return EFI_SUCCESS;\r | |
634 | }\r | |
635 | \r | |
636 | if (EFI_ERROR (Status)) {\r | |
637 | return Status;\r | |
638 | }\r | |
639 | \r | |
f79fa76e | 640 | //\r |
641 | // Make sure GUID is for a SNP handle.\r | |
642 | //\r | |
643 | Status = EFI_UNSUPPORTED;\r | |
644 | if (CompareGuid (EmuIoThunk->Protocol, &gEmuSnpProtocolGuid)) {\r | |
645 | Status = EFI_SUCCESS;\r | |
646 | }\r | |
647 | \r | |
572287f8 | 648 | //\r |
649 | // Close protocol, don't use device path protocol in the Support() function\r | |
650 | //\r | |
651 | gBS->CloseProtocol (\r | |
652 | ControllerHandle,\r | |
653 | &gEfiDevicePathProtocolGuid,\r | |
654 | This->DriverBindingHandle,\r | |
655 | ControllerHandle\r | |
656 | );\r | |
657 | \r | |
658 | return Status;\r | |
659 | }\r | |
660 | \r | |
661 | \r | |
662 | /**\r | |
663 | Start this driver on ControllerHandle. This service is called by the\r | |
664 | EFI boot service ConnectController(). In order to make\r | |
665 | drivers as small as possible, there are a few calling restrictions for\r | |
666 | this service. ConnectController() must follow these\r | |
667 | calling restrictions. If any other agent wishes to call Start() it\r | |
668 | must also follow these calling restrictions.\r | |
669 | \r | |
670 | @param This Protocol instance pointer.\r | |
671 | @param ControllerHandle Handle of device to bind driver to\r | |
672 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
673 | device to start.\r | |
674 | \r | |
675 | @retval EFI_SUCCESS Always succeeds.\r | |
676 | \r | |
677 | **/\r | |
678 | EFI_STATUS\r | |
679 | EFIAPI\r | |
680 | EmuSnpDriverBindingStart (\r | |
681 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
682 | IN EFI_HANDLE ControllerHandle,\r | |
683 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
684 | )\r | |
685 | {\r | |
686 | EFI_STATUS Status;\r | |
687 | EMU_IO_THUNK_PROTOCOL *EmuIoThunk;\r | |
688 | EMU_SNP_PRIVATE_DATA *Private;\r | |
689 | MAC_ADDR_DEVICE_PATH Node;\r | |
690 | EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath;\r | |
691 | \r | |
54e0b04c | 692 | Private = NULL;\r |
693 | \r | |
572287f8 | 694 | //\r |
695 | // Grab the protocols we need\r | |
696 | //\r | |
572287f8 | 697 | Status = gBS->OpenProtocol(\r |
698 | ControllerHandle,\r | |
699 | &gEfiDevicePathProtocolGuid,\r | |
700 | ( VOID ** ) &ParentDevicePath,\r | |
701 | This->DriverBindingHandle,\r | |
702 | ControllerHandle,\r | |
703 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
704 | );\r | |
705 | if (EFI_ERROR (Status) && Status) {\r | |
706 | return Status;\r | |
707 | }\r | |
708 | \r | |
709 | Status = gBS->OpenProtocol (\r | |
710 | ControllerHandle,\r | |
711 | &gEmuIoThunkProtocolGuid,\r | |
712 | (VOID **)&EmuIoThunk,\r | |
713 | This->DriverBindingHandle,\r | |
714 | ControllerHandle,\r | |
715 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
716 | );\r | |
717 | if (EFI_ERROR (Status)) {\r | |
718 | return Status;\r | |
719 | }\r | |
720 | \r | |
721 | if (!CompareGuid (EmuIoThunk->Protocol, &gEmuSnpProtocolGuid)) {\r | |
722 | return EFI_UNSUPPORTED;\r | |
723 | }\r | |
724 | \r | |
725 | Status = EmuIoThunk->Open (EmuIoThunk);\r | |
726 | if (EFI_ERROR (Status)) {\r | |
727 | goto Done;\r | |
728 | }\r | |
729 | \r | |
730 | //\r | |
731 | // Allocate the private data.\r | |
732 | //\r | |
733 | Private = AllocateZeroPool (sizeof (EMU_SNP_PRIVATE_DATA));\r | |
734 | if (Private == NULL) {\r | |
735 | Status = EFI_OUT_OF_RESOURCES;\r | |
736 | goto Done;\r | |
737 | }\r | |
738 | \r | |
739 | CopyMem (&Private->Snp, &gEmuSnpTemplate, sizeof (EFI_SIMPLE_NETWORK_PROTOCOL));\r | |
f79fa76e | 740 | CopyMem (&Private->Mode, &gEmuSnpModeTemplate, sizeof (EFI_SIMPLE_NETWORK_MODE));\r |
572287f8 | 741 | \r |
742 | Private->Signature = EMU_SNP_PRIVATE_DATA_SIGNATURE;\r | |
743 | Private->IoThunk = EmuIoThunk;\r | |
744 | Private->Io = EmuIoThunk->Interface;\r | |
745 | Private->EfiHandle = ControllerHandle;\r | |
746 | Private->DeviceHandle = NULL;\r | |
747 | Private->Snp.Mode = &Private->Mode;\r | |
748 | Private->ControllerNameTable = NULL;\r | |
749 | \r | |
d18d8a1d | 750 | \r |
572287f8 | 751 | Status = Private->Io->CreateMapping (Private->Io, &Private->Mode);\r |
752 | if (EFI_ERROR (Status)) {\r | |
753 | goto Done;\r | |
754 | }\r | |
755 | \r | |
756 | //\r | |
757 | // Build the device path by appending the MAC node to the ParentDevicePath\r | |
758 | // from the EmuIo handle.\r | |
759 | //\r | |
760 | ZeroMem (&Node, sizeof (MAC_ADDR_DEVICE_PATH));\r | |
761 | \r | |
762 | Node.Header.Type = MESSAGING_DEVICE_PATH;\r | |
763 | Node.Header.SubType = MSG_MAC_ADDR_DP;\r | |
764 | Node.IfType = Private->Mode.IfType;\r | |
765 | \r | |
766 | SetDevicePathNodeLength ((EFI_DEVICE_PATH_PROTOCOL * )&Node, sizeof (MAC_ADDR_DEVICE_PATH));\r | |
767 | \r | |
768 | CopyMem (&Node.MacAddress, &Private->Mode.CurrentAddress, sizeof (EFI_MAC_ADDRESS));\r | |
769 | \r | |
770 | //\r | |
771 | // Build the device path by appending the MAC node to the ParentDevicePath from the EmuIo handle.\r | |
772 | //\r | |
773 | Private->DevicePath = AppendDevicePathNode (ParentDevicePath, (EFI_DEVICE_PATH_PROTOCOL *)&Node);\r | |
774 | if ( Private->DevicePath == NULL ) {\r | |
775 | Status = EFI_OUT_OF_RESOURCES;\r | |
776 | goto Done;\r | |
777 | }\r | |
778 | \r | |
779 | AddUnicodeString2 (\r | |
780 | "eng",\r | |
781 | gEmuSnpDriverComponentName.SupportedLanguages,\r | |
782 | &Private->ControllerNameTable,\r | |
783 | EmuIoThunk->ConfigString,\r | |
784 | TRUE\r | |
785 | );\r | |
d18d8a1d | 786 | \r |
572287f8 | 787 | AddUnicodeString2 (\r |
788 | "en",\r | |
789 | gEmuSnpDriverComponentName2.SupportedLanguages,\r | |
790 | &Private->ControllerNameTable,\r | |
791 | EmuIoThunk->ConfigString,\r | |
792 | FALSE\r | |
793 | );\r | |
794 | \r | |
795 | //\r | |
796 | // Create Child Handle\r | |
797 | //\r | |
798 | Status = gBS->InstallMultipleProtocolInterfaces(\r | |
799 | &Private->DeviceHandle,\r | |
800 | &gEfiSimpleNetworkProtocolGuid, &Private->Snp,\r | |
801 | &gEfiDevicePathProtocolGuid, Private->DevicePath,\r | |
802 | NULL\r | |
803 | );\r | |
804 | if (EFI_ERROR (Status)) {\r | |
805 | goto Done;\r | |
806 | }\r | |
807 | \r | |
808 | //\r | |
809 | // Open For Child Device\r | |
810 | //\r | |
811 | Status = gBS->OpenProtocol (\r | |
812 | ControllerHandle,\r | |
813 | &gEmuIoThunkProtocolGuid,\r | |
814 | (VOID **)&EmuIoThunk,\r | |
815 | This->DriverBindingHandle,\r | |
816 | Private->DeviceHandle,\r | |
817 | EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r | |
818 | );\r | |
819 | \r | |
820 | Done:\r | |
821 | if (EFI_ERROR (Status)) {\r | |
822 | if (Private != NULL) {\r | |
823 | FreePool (Private);\r | |
824 | }\r | |
825 | if (ParentDevicePath != NULL) {\r | |
826 | gBS->CloseProtocol(\r | |
827 | ControllerHandle,\r | |
828 | &gEfiDevicePathProtocolGuid,\r | |
829 | This->DriverBindingHandle,\r | |
830 | ControllerHandle\r | |
831 | );\r | |
832 | }\r | |
833 | }\r | |
834 | \r | |
835 | return Status;\r | |
836 | }\r | |
837 | \r | |
838 | /**\r | |
839 | Stop this driver on ControllerHandle. This service is called by the\r | |
840 | EFI boot service DisconnectController(). In order to\r | |
841 | make drivers as small as possible, there are a few calling\r | |
842 | restrictions for this service. DisconnectController()\r | |
843 | must follow these calling restrictions. If any other agent wishes\r | |
844 | to call Stop() it must also follow these calling restrictions.\r | |
d18d8a1d | 845 | \r |
572287f8 | 846 | @param This Protocol instance pointer.\r |
847 | @param ControllerHandle Handle of device to stop driver on\r | |
848 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
849 | children is zero stop the entire bus driver.\r | |
850 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
851 | \r | |
852 | @retval EFI_SUCCESS Always succeeds.\r | |
853 | \r | |
854 | **/\r | |
855 | EFI_STATUS\r | |
856 | EFIAPI\r | |
857 | EmuSnpDriverBindingStop (\r | |
858 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
859 | IN EFI_HANDLE ControllerHandle,\r | |
860 | IN UINTN NumberOfChildren,\r | |
861 | IN EFI_HANDLE *ChildHandleBuffer\r | |
862 | )\r | |
863 | {\r | |
864 | EFI_STATUS Status;\r | |
865 | EMU_SNP_PRIVATE_DATA *Private = NULL;\r | |
866 | EFI_SIMPLE_NETWORK_PROTOCOL *Snp;\r | |
1e571882 | 867 | VOID *EmuIoThunk;\r |
572287f8 | 868 | \r |
869 | //\r | |
870 | // Complete all outstanding transactions to Controller.\r | |
871 | // Don't allow any new transaction to Controller to be started.\r | |
872 | //\r | |
873 | if (NumberOfChildren == 0) {\r | |
874 | //\r | |
875 | // Close the bus driver\r | |
876 | //\r | |
877 | Status = gBS->CloseProtocol (\r | |
878 | ControllerHandle,\r | |
879 | &gEmuIoThunkProtocolGuid,\r | |
880 | This->DriverBindingHandle,\r | |
881 | ControllerHandle\r | |
882 | );\r | |
883 | \r | |
884 | Status = gBS->CloseProtocol (\r | |
885 | ControllerHandle,\r | |
886 | &gEfiDevicePathProtocolGuid,\r | |
887 | This->DriverBindingHandle,\r | |
888 | ControllerHandle\r | |
889 | );\r | |
890 | return Status;\r | |
891 | }\r | |
892 | \r | |
893 | ASSERT (NumberOfChildren == 1);\r | |
d18d8a1d | 894 | \r |
895 | \r | |
572287f8 | 896 | //\r |
897 | // Get our context back.\r | |
898 | //\r | |
899 | Status = gBS->OpenProtocol(\r | |
900 | ChildHandleBuffer[0],\r | |
901 | &gEfiSimpleNetworkProtocolGuid,\r | |
902 | ( VOID ** ) &Snp,\r | |
903 | This->DriverBindingHandle,\r | |
904 | ControllerHandle,\r | |
905 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
906 | );\r | |
907 | if (EFI_ERROR (Status)) {\r | |
908 | return EFI_DEVICE_ERROR;\r | |
909 | }\r | |
910 | \r | |
911 | Private = EMU_SNP_PRIVATE_DATA_FROM_SNP_THIS (Snp);\r | |
1e571882 RN |
912 | ASSERT (Private->DeviceHandle == ChildHandleBuffer[0]);\r |
913 | ASSERT (Private->EfiHandle == ControllerHandle);\r | |
572287f8 | 914 | \r |
915 | Status = gBS->CloseProtocol(\r | |
1e571882 | 916 | ControllerHandle,\r |
572287f8 | 917 | &gEmuIoThunkProtocolGuid,\r |
918 | This->DriverBindingHandle,\r | |
919 | Private->DeviceHandle\r | |
920 | );\r | |
1e571882 | 921 | ASSERT_EFI_ERROR (Status);\r |
572287f8 | 922 | \r |
923 | Status = gBS->UninstallMultipleProtocolInterfaces(\r | |
1e571882 | 924 | Private->DeviceHandle,\r |
572287f8 | 925 | &gEfiSimpleNetworkProtocolGuid, &Private->Snp,\r |
926 | &gEfiDevicePathProtocolGuid, Private->DevicePath,\r | |
927 | NULL\r | |
928 | );\r | |
1e571882 RN |
929 | if (EFI_ERROR (Status)) {\r |
930 | gBS->OpenProtocol (\r | |
931 | ControllerHandle,\r | |
932 | &gEmuIoThunkProtocolGuid,\r | |
933 | &EmuIoThunk,\r | |
934 | This->DriverBindingHandle,\r | |
935 | Private->DeviceHandle,\r | |
936 | EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r | |
937 | );\r | |
938 | } else {\r | |
939 | Status = Private->IoThunk->Close (Private->IoThunk);\r | |
940 | ASSERT_EFI_ERROR (Status);\r | |
941 | \r | |
942 | FreePool (Private->DevicePath);\r | |
943 | FreeUnicodeStringTable (Private->ControllerNameTable);\r | |
944 | FreePool (Private);\r | |
945 | }\r | |
572287f8 | 946 | \r |
1e571882 | 947 | return Status;\r |
572287f8 | 948 | }\r |
949 | \r | |
950 | \r | |
951 | EFI_DRIVER_BINDING_PROTOCOL gEmuSnpDriverBinding = {\r | |
952 | EmuSnpDriverBindingSupported,\r | |
953 | EmuSnpDriverBindingStart,\r | |
954 | EmuSnpDriverBindingStop,\r | |
955 | 0xA,\r | |
956 | NULL,\r | |
957 | NULL\r | |
958 | };\r | |
959 | \r | |
960 | \r | |
961 | \r | |
962 | /**\r | |
963 | This is the declaration of an EFI image entry point. This entry point is\r | |
964 | the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including\r | |
965 | both device drivers and bus drivers.\r | |
966 | \r | |
967 | @param ImageHandle The firmware allocated handle for the UEFI image.\r | |
968 | @param SystemTable A pointer to the EFI System Table.\r | |
969 | \r | |
970 | @retval EFI_SUCCESS The operation completed successfully.\r | |
971 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r | |
972 | \r | |
973 | **/\r | |
974 | EFI_STATUS\r | |
975 | EFIAPI\r | |
976 | InitializeEmuSnpDriver (\r | |
977 | IN EFI_HANDLE ImageHandle,\r | |
978 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
979 | )\r | |
980 | {\r | |
981 | EFI_STATUS Status;\r | |
982 | \r | |
983 | //\r | |
984 | // Install the Driver Protocols\r | |
985 | //\r | |
572287f8 | 986 | Status = EfiLibInstallDriverBindingComponentName2(\r |
987 | ImageHandle,\r | |
988 | SystemTable,\r | |
989 | &gEmuSnpDriverBinding,\r | |
990 | ImageHandle,\r | |
991 | &gEmuSnpDriverComponentName,\r | |
992 | &gEmuSnpDriverComponentName2\r | |
993 | );\r | |
994 | \r | |
995 | return Status;\r | |
996 | }\r |