BaseTools:Change the path of the file that Binary Cache
[mirror_edk2.git] / MdeModulePkg / Universal / Network / SnpDxe / Snp.h
1 /** @file\r
2     Declaration of strctures and functions for SnpDxe driver.\r
3 \r
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r
5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
6 \r
7 **/\r
8 #ifndef _SNP_H_\r
9 #define _SNP_H_\r
10 \r
11 \r
12 #include <Uefi.h>\r
13 \r
14 #include <Protocol/SimpleNetwork.h>\r
15 #include <Protocol/PciIo.h>\r
16 #include <Protocol/NetworkInterfaceIdentifier.h>\r
17 #include <Protocol/DevicePath.h>\r
18 \r
19 #include <Guid/EventGroup.h>\r
20 \r
21 #include <Library/DebugLib.h>\r
22 #include <Library/BaseMemoryLib.h>\r
23 #include <Library/UefiDriverEntryPoint.h>\r
24 #include <Library/UefiBootServicesTableLib.h>\r
25 #include <Library/BaseLib.h>\r
26 #include <Library/UefiLib.h>\r
27 #include <Library/MemoryAllocationLib.h>\r
28 #include <Library/PrintLib.h>\r
29 \r
30 #include <IndustryStandard/Pci.h>\r
31 #include <IndustryStandard/Acpi.h>\r
32 \r
33 #define FOUR_GIGABYTES  (UINT64) 0x100000000ULL\r
34 \r
35 \r
36 #define SNP_DRIVER_SIGNATURE  SIGNATURE_32 ('s', 'n', 'd', 's')\r
37 #define MAX_MAP_LENGTH        100\r
38 \r
39 #define PCI_BAR_IO_MASK       0x00000003\r
40 #define PCI_BAR_IO_MODE       0x00000001\r
41 \r
42 #define PCI_BAR_MEM_MASK      0x0000000F\r
43 #define PCI_BAR_MEM_MODE      0x00000000\r
44 #define PCI_BAR_MEM_64BIT     0x00000004\r
45 \r
46 #define SNP_TX_BUFFER_INCREASEMENT    MAX_XMIT_BUFFERS\r
47 #define SNP_MAX_TX_BUFFER_NUM         65536\r
48 \r
49 typedef\r
50 EFI_STATUS\r
51 (EFIAPI *ISSUE_UNDI32_COMMAND) (\r
52   UINT64         Cdb\r
53   );\r
54 \r
55 typedef struct {\r
56   UINT32                      Signature;\r
57   EFI_LOCK                    Lock;\r
58 \r
59   EFI_SIMPLE_NETWORK_PROTOCOL Snp;\r
60   EFI_SIMPLE_NETWORK_MODE     Mode;\r
61 \r
62   EFI_HANDLE                  DeviceHandle;\r
63   EFI_DEVICE_PATH_PROTOCOL    *DevicePath;\r
64 \r
65   //\r
66   //  Local instance data needed by SNP driver\r
67   //\r
68   //  Pointer to S/W UNDI API entry point\r
69   //  This will be NULL for H/W UNDI\r
70   //\r
71   ISSUE_UNDI32_COMMAND  IssueUndi32Command;\r
72 \r
73   BOOLEAN               IsSwUndi;\r
74 \r
75   //\r
76   // undi interface number, if one undi manages more nics\r
77   //\r
78   PXE_IFNUM             IfNum;\r
79 \r
80   //\r
81   //  Allocated tx/rx buffer that was passed to UNDI Initialize.\r
82   //\r
83   UINT32                TxRxBufferSize;\r
84   VOID                  *TxRxBuffer;\r
85   //\r
86   // mappable buffers for receive and fill header for undi3.0\r
87   // these will be used if the user buffers are above 4GB limit (instead of\r
88   // mapping the user buffers)\r
89   //\r
90   UINT8                 *ReceiveBufffer;\r
91   VOID                  *ReceiveBufferUnmap;\r
92   UINT8                 *FillHeaderBuffer;\r
93   VOID                  *FillHeaderBufferUnmap;\r
94 \r
95   EFI_PCI_IO_PROTOCOL   *PciIo;\r
96   UINT8                 IoBarIndex;\r
97   UINT8                 MemoryBarIndex;\r
98 \r
99   //\r
100   // Buffers for command descriptor block, command parameter block\r
101   // and data block.\r
102   //\r
103   PXE_CDB               Cdb;\r
104   VOID                  *Cpb;\r
105   VOID                  *CpbUnmap;\r
106   VOID                  *Db;\r
107 \r
108   //\r
109   // UNDI structure, we need to remember the init info for a long time!\r
110   //\r
111   PXE_DB_GET_INIT_INFO  InitInfo;\r
112 \r
113   VOID                  *SnpDriverUnmap;\r
114   //\r
115   // when ever we map an address, we must remember it's address and the un-map\r
116   // cookie so that we can unmap later\r
117   //\r
118   struct MAP_LIST {\r
119     EFI_PHYSICAL_ADDRESS  VirtualAddress;\r
120     VOID                  *MapCookie;\r
121   } MapList[MAX_MAP_LENGTH];\r
122 \r
123   EFI_EVENT              ExitBootServicesEvent;\r
124 \r
125   //\r
126   // Whether UNDI support reporting media status from GET_STATUS command,\r
127   // i.e. PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED or\r
128   //      PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED\r
129   //\r
130   BOOLEAN                MediaStatusSupported;\r
131 \r
132   //\r
133   // Whether UNDI support cable detect for INITIALIZE command,\r
134   // i.e. PXE_STATFLAGS_CABLE_DETECT_SUPPORTED or\r
135   //      PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED\r
136   //\r
137   BOOLEAN                CableDetectSupported;\r
138 \r
139   //\r
140   // Array of the recycled transmit buffer address from UNDI.\r
141   //\r
142   UINT64                 *RecycledTxBuf;\r
143   //\r
144   // The maximum number of recycled buffer pointers in RecycledTxBuf.\r
145   //\r
146   UINT32                 MaxRecycledTxBuf;\r
147   //\r
148   // Current number of recycled buffer pointers in RecycledTxBuf.\r
149   //\r
150   UINT32                 RecycledTxBufCount;\r
151 } SNP_DRIVER;\r
152 \r
153 #define EFI_SIMPLE_NETWORK_DEV_FROM_THIS(a) CR (a, SNP_DRIVER, Snp, SNP_DRIVER_SIGNATURE)\r
154 \r
155 //\r
156 // Global Variables\r
157 //\r
158 extern EFI_DRIVER_BINDING_PROTOCOL    gSimpleNetworkDriverBinding;\r
159 extern EFI_COMPONENT_NAME_PROTOCOL    gSimpleNetworkComponentName;\r
160 extern EFI_COMPONENT_NAME2_PROTOCOL   gSimpleNetworkComponentName2;\r
161 \r
162 /**\r
163   this routine calls undi to start the interface and changes the snp state.\r
164 \r
165   @param  Snp                    pointer to snp driver structure\r
166 \r
167   @retval EFI_DEVICE_ERROR       UNDI could not be started\r
168   @retval EFI_SUCCESS            UNDI is started successfully\r
169 \r
170 **/\r
171 EFI_STATUS\r
172 PxeStart (\r
173   IN SNP_DRIVER *Snp\r
174   );\r
175 \r
176 /**\r
177   this routine calls undi to stop the interface and changes the snp state.\r
178 \r
179   @param  Snp   pointer to snp driver structure\r
180 \r
181   @retval EFI_INVALID_PARAMETER  invalid parameter\r
182   @retval EFI_NOT_STARTED        SNP is not started\r
183   @retval EFI_DEVICE_ERROR       SNP is not initialized\r
184   @retval EFI_UNSUPPORTED        operation unsupported\r
185 \r
186 **/\r
187 EFI_STATUS\r
188 PxeStop (\r
189   SNP_DRIVER *Snp\r
190   );\r
191 \r
192 /**\r
193   this routine calls undi to initialize the interface.\r
194 \r
195   @param  Snp                   pointer to snp driver structure\r
196   @param  CableDetectFlag       Do/don't detect the cable (depending on what undi supports)\r
197 \r
198   @retval EFI_SUCCESS           UNDI is initialized successfully\r
199   @retval EFI_DEVICE_ERROR      UNDI could not be initialized\r
200   @retval Other                 other errors\r
201 \r
202 **/\r
203 EFI_STATUS\r
204 PxeInit (\r
205   SNP_DRIVER *Snp,\r
206   UINT16     CableDetectFlag\r
207   );\r
208 \r
209 /**\r
210   this routine calls undi to shut down the interface.\r
211 \r
212   @param  Snp   pointer to snp driver structure\r
213 \r
214   @retval EFI_SUCCESS        UNDI is shut down successfully\r
215   @retval EFI_DEVICE_ERROR   UNDI could not be shut down\r
216 \r
217 **/\r
218 EFI_STATUS\r
219 PxeShutdown (\r
220   IN SNP_DRIVER *Snp\r
221   );\r
222 \r
223 /**\r
224   this routine calls undi to read the MAC address of the NIC and updates the\r
225   mode structure with the address.\r
226 \r
227   @param  Snp         pointer to snp driver structure.\r
228 \r
229   @retval EFI_SUCCESS       the MAC address of the NIC is read successfully.\r
230   @retval EFI_DEVICE_ERROR  failed to read the MAC address of the NIC.\r
231 \r
232 **/\r
233 EFI_STATUS\r
234 PxeGetStnAddr (\r
235   SNP_DRIVER *Snp\r
236   );\r
237 \r
238 /**\r
239   Call undi to get the status of the interrupts, get the list of recycled transmit\r
240   buffers that completed transmitting. The recycled transmit buffer address will\r
241   be saved into Snp->RecycledTxBuf. This function will also update the MediaPresent\r
242   field of EFI_SIMPLE_NETWORK_MODE if UNDI support it.\r
243 \r
244   @param[in]   Snp                     Pointer to snp driver structure.\r
245   @param[out]  InterruptStatusPtr      A non null pointer to contain the interrupt\r
246                                        status.\r
247   @param[in]   GetTransmittedBuf       Set to TRUE to retrieve the recycled transmit\r
248                                        buffer address.\r
249 \r
250   @retval      EFI_SUCCESS             The status of the network interface was retrieved.\r
251   @retval      EFI_DEVICE_ERROR        The command could not be sent to the network\r
252                                        interface.\r
253 \r
254 **/\r
255 EFI_STATUS\r
256 PxeGetStatus (\r
257   IN     SNP_DRIVER *Snp,\r
258      OUT UINT32     *InterruptStatusPtr,\r
259   IN     BOOLEAN    GetTransmittedBuf\r
260   );\r
261 \r
262 /**\r
263   This is a callback routine supplied to UNDI3.1 at undi_start time.\r
264   UNDI call this routine when it wants to have exclusive access to a critical\r
265   section of the code/data.\r
266   New callbacks for 3.1:\r
267   there won't be a virtual2physical callback for UNDI 3.1 because undi3.1 uses\r
268   the MemMap call to map the required address by itself!\r
269 \r
270   @param UniqueId  This was supplied to UNDI at Undi_Start, SNP uses this to\r
271                    store Undi interface context (Undi does not read or write\r
272                    this variable)\r
273   @param Enable    non-zero indicates acquire\r
274                    zero indicates release\r
275 **/\r
276 VOID\r
277 EFIAPI\r
278 SnpUndi32CallbackBlock (\r
279   IN UINT64 UniqueId,\r
280   IN UINT32 Enable\r
281   );\r
282 \r
283 /**\r
284   This is a callback routine supplied to UNDI at undi_start time.\r
285   UNDI call this routine with the number of micro seconds when it wants to\r
286   pause.\r
287 \r
288   @param UniqueId      This was supplied to UNDI at Undi_Start, SNP uses this to\r
289                        store Undi interface context (Undi does not read or write\r
290                        this variable)\r
291   @param MicroSeconds  number of micro seconds to pause, ususlly multiple of 10.\r
292 **/\r
293 VOID\r
294 EFIAPI\r
295 SnpUndi32CallbackDelay (\r
296   IN UINT64 UniqueId,\r
297   IN UINT64 MicroSeconds\r
298   );\r
299 \r
300 /**\r
301   This is a callback routine supplied to UNDI at undi_start time.\r
302   This is the IO routine for UNDI3.1 to start CPB.\r
303 \r
304   @param UniqueId       This was supplied to UNDI at Undi_Start, SNP uses this\r
305                         to store Undi interface context (Undi does not read or\r
306                         write this variable)\r
307   @param ReadOrWrite    indicates read or write, IO or Memory.\r
308   @param NumBytes       number of bytes to read or write.\r
309   @param MemOrPortAddr  IO or memory address to read from or write to.\r
310   @param BufferPtr      memory location to read into or that contains the bytes\r
311                         to write.\r
312 **/\r
313 VOID\r
314 EFIAPI\r
315 SnpUndi32CallbackMemio (\r
316   IN UINT64     UniqueId,\r
317   IN UINT8      ReadOrWrite,\r
318   IN UINT8      NumBytes,\r
319   IN UINT64     MemOrPortAddr,\r
320   IN OUT UINT64 BufferPtr\r
321   );\r
322 \r
323 /**\r
324   This is a callback routine supplied to UNDI at undi_start time.\r
325   UNDI call this routine when it has to map a CPU address to a device\r
326   address.\r
327 \r
328   @param UniqueId      - This was supplied to UNDI at Undi_Start, SNP uses this to store\r
329                          Undi interface context (Undi does not read or write this variable)\r
330   @param CpuAddr       - Virtual address to be mapped!\r
331   @param NumBytes      - size of memory to be mapped\r
332   @param Direction     - direction of data flow for this memory's usage:\r
333                          cpu->device, device->cpu or both ways\r
334   @param DeviceAddrPtr - pointer to return the mapped device address\r
335 \r
336 **/\r
337 VOID\r
338 EFIAPI\r
339 SnpUndi32CallbackMap (\r
340   IN UINT64     UniqueId,\r
341   IN UINT64     CpuAddr,\r
342   IN UINT32     NumBytes,\r
343   IN UINT32     Direction,\r
344   IN OUT UINT64 DeviceAddrPtr\r
345   );\r
346 \r
347 /**\r
348   This is a callback routine supplied to UNDI at undi_start time.\r
349   UNDI call this routine when it wants to unmap an address that was previously\r
350   mapped using map callback.\r
351 \r
352   @param UniqueId    This was supplied to UNDI at Undi_Start, SNP uses this to store.\r
353                      Undi interface context (Undi does not read or write this variable)\r
354   @param CpuAddr     Virtual address that was mapped!\r
355   @param NumBytes    size of memory mapped\r
356   @param Direction   direction of data flow for this memory's usage:\r
357                      cpu->device, device->cpu or both ways\r
358   @param DeviceAddr  the mapped device address\r
359 \r
360 **/\r
361 VOID\r
362 EFIAPI\r
363 SnpUndi32CallbackUnmap (\r
364   IN UINT64             UniqueId,\r
365   IN UINT64             CpuAddr,\r
366   IN UINT32             NumBytes,\r
367   IN UINT32             Direction,\r
368   IN UINT64             DeviceAddr\r
369   );\r
370 \r
371 /**\r
372   This is a callback routine supplied to UNDI at undi_start time.\r
373   UNDI call this routine when it wants synchronize the virtual buffer contents\r
374   with the mapped buffer contents. The virtual and mapped buffers need not\r
375   correspond to the same physical memory (especially if the virtual address is\r
376   > 4GB). Depending on the direction for which the buffer is mapped, undi will\r
377   need to synchronize their contents whenever it writes to/reads from the buffer\r
378   using either the cpu address or the device address.\r
379 \r
380   EFI does not provide a sync call, since virt=physical, we sould just do\r
381   the synchronization ourself here!\r
382 \r
383   @param UniqueId    This was supplied to UNDI at Undi_Start, SNP uses this to store\r
384                      Undi interface context (Undi does not read or write this variable)\r
385   @param CpuAddr     Virtual address that was mapped!\r
386   @param NumBytes    size of memory mapped.\r
387   @param Direction   direction of data flow for this memory's usage:\r
388                      cpu->device, device->cpu or both ways.\r
389   @param DeviceAddr  the mapped device address.\r
390 \r
391 **/\r
392 VOID\r
393 EFIAPI\r
394 SnpUndi32CallbackSync (\r
395   IN UINT64             UniqueId,\r
396   IN UINT64             CpuAddr,\r
397   IN UINT32             NumBytes,\r
398   IN UINT32             Direction,\r
399   IN UINT64             DeviceAddr\r
400   );\r
401 \r
402 /**\r
403   Changes the state of a network interface from "stopped" to "started".\r
404 \r
405   This function starts a network interface. If the network interface successfully\r
406   starts, then EFI_SUCCESS will be returned.\r
407 \r
408   @param  This                   A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
409 \r
410   @retval EFI_SUCCESS            The network interface was started.\r
411   @retval EFI_ALREADY_STARTED    The network interface is already in the started state.\r
412   @retval EFI_INVALID_PARAMETER  This parameter was NULL or did not point to a valid\r
413                                  EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
414   @retval EFI_DEVICE_ERROR       The command could not be sent to the network interface.\r
415   @retval EFI_UNSUPPORTED        This function is not supported by the network interface.\r
416 \r
417 **/\r
418 EFI_STATUS\r
419 EFIAPI\r
420 SnpUndi32Start (\r
421   IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r
422   );\r
423 \r
424 /**\r
425   Changes the state of a network interface from "started" to "stopped".\r
426 \r
427   This function stops a network interface. This call is only valid if the network\r
428   interface is in the started state. If the network interface was successfully\r
429   stopped, then EFI_SUCCESS will be returned.\r
430 \r
431   @param  This                    A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
432 \r
433 \r
434   @retval EFI_SUCCESS             The network interface was stopped.\r
435   @retval EFI_NOT_STARTED         The network interface has not been started.\r
436   @retval EFI_INVALID_PARAMETER   This parameter was NULL or did not point to a valid\r
437                                   EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
438   @retval EFI_DEVICE_ERROR        The command could not be sent to the network interface.\r
439   @retval EFI_UNSUPPORTED         This function is not supported by the network interface.\r
440 \r
441 **/\r
442 EFI_STATUS\r
443 EFIAPI\r
444 SnpUndi32Stop (\r
445   IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r
446   );\r
447 \r
448 /**\r
449   Resets a network adapter and allocates the transmit and receive buffers\r
450   required by the network interface; optionally, also requests allocation of\r
451   additional transmit and receive buffers.\r
452 \r
453   This function allocates the transmit and receive buffers required by the network\r
454   interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned.\r
455   If the allocation succeeds and the network interface is successfully initialized,\r
456   then EFI_SUCCESS will be returned.\r
457 \r
458   @param This               A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
459 \r
460   @param ExtraRxBufferSize  The size, in bytes, of the extra receive buffer space\r
461                             that the driver should allocate for the network interface.\r
462                             Some network interfaces will not be able to use the\r
463                             extra buffer, and the caller will not know if it is\r
464                             actually being used.\r
465   @param ExtraTxBufferSize  The size, in bytes, of the extra transmit buffer space\r
466                             that the driver should allocate for the network interface.\r
467                             Some network interfaces will not be able to use the\r
468                             extra buffer, and the caller will not know if it is\r
469                             actually being used.\r
470 \r
471   @retval EFI_SUCCESS           The network interface was initialized.\r
472   @retval EFI_NOT_STARTED       The network interface has not been started.\r
473   @retval EFI_OUT_OF_RESOURCES  There was not enough memory for the transmit and\r
474                                 receive buffers.\r
475   @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid\r
476                                 EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
477   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.\r
478   @retval EFI_UNSUPPORTED       The increased buffer size feature is not supported.\r
479 \r
480 **/\r
481 EFI_STATUS\r
482 EFIAPI\r
483 SnpUndi32Initialize (\r
484   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
485   IN UINTN                       ExtraRxBufferSize OPTIONAL,\r
486   IN UINTN                       ExtraTxBufferSize OPTIONAL\r
487   );\r
488 \r
489 /**\r
490   Resets a network adapter and reinitializes it with the parameters that were\r
491   provided in the previous call to Initialize().\r
492 \r
493   This function resets a network adapter and reinitializes it with the parameters\r
494   that were provided in the previous call to Initialize(). The transmit and\r
495   receive queues are emptied and all pending interrupts are cleared.\r
496   Receive filters, the station address, the statistics, and the multicast-IP-to-HW\r
497   MAC addresses are not reset by this call. If the network interface was\r
498   successfully reset, then EFI_SUCCESS will be returned. If the driver has not\r
499   been initialized, EFI_DEVICE_ERROR will be returned.\r
500 \r
501   @param This                 A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
502   @param ExtendedVerification Indicates that the driver may perform a more\r
503                               exhaustive verification operation of the device\r
504                               during reset.\r
505 \r
506   @retval EFI_SUCCESS           The network interface was reset.\r
507   @retval EFI_NOT_STARTED       The network interface has not been started.\r
508   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported value.\r
509   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.\r
510   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.\r
511 \r
512 **/\r
513 EFI_STATUS\r
514 EFIAPI\r
515 SnpUndi32Reset (\r
516   IN EFI_SIMPLE_NETWORK_PROTOCOL  *This,\r
517   IN BOOLEAN                      ExtendedVerification\r
518   );\r
519 \r
520 /**\r
521   Resets a network adapter and leaves it in a state that is safe for another\r
522   driver to initialize.\r
523 \r
524   This function releases the memory buffers assigned in the Initialize() call.\r
525   Pending transmits and receives are lost, and interrupts are cleared and disabled.\r
526   After this call, only the Initialize() and Stop() calls may be used. If the\r
527   network interface was successfully shutdown, then EFI_SUCCESS will be returned.\r
528   If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.\r
529 \r
530   @param  This  A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
531 \r
532   @retval EFI_SUCCESS           The network interface was shutdown.\r
533   @retval EFI_NOT_STARTED       The network interface has not been started.\r
534   @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid\r
535                                 EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
536   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.\r
537 \r
538 **/\r
539 EFI_STATUS\r
540 EFIAPI\r
541 SnpUndi32Shutdown (\r
542   IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r
543   );\r
544 \r
545 /**\r
546   Manages the multicast receive filters of a network interface.\r
547 \r
548   This function is used enable and disable the hardware and software receive\r
549   filters for the underlying network device.\r
550   The receive filter change is broken down into three steps:\r
551   * The filter mask bits that are set (ON) in the Enable parameter are added to\r
552     the current receive filter settings.\r
553   * The filter mask bits that are set (ON) in the Disable parameter are subtracted\r
554     from the updated receive filter settings.\r
555   * If the resulting receive filter setting is not supported by the hardware a\r
556     more liberal setting is selected.\r
557   If the same bits are set in the Enable and Disable parameters, then the bits\r
558   in the Disable parameter takes precedence.\r
559   If the ResetMCastFilter parameter is TRUE, then the multicast address list\r
560   filter is disabled (irregardless of what other multicast bits are set in the\r
561   Enable and Disable parameters). The SNP->Mode->MCastFilterCount field is set\r
562   to zero. The Snp->Mode->MCastFilter contents are undefined.\r
563   After enabling or disabling receive filter settings, software should verify\r
564   the new settings by checking the Snp->Mode->ReceiveFilterSettings,\r
565   Snp->Mode->MCastFilterCount and Snp->Mode->MCastFilter fields.\r
566   Note: Some network drivers and/or devices will automatically promote receive\r
567     filter settings if the requested setting can not be honored. For example, if\r
568     a request for four multicast addresses is made and the underlying hardware\r
569     only supports two multicast addresses the driver might set the promiscuous\r
570     or promiscuous multicast receive filters instead. The receiving software is\r
571     responsible for discarding any extra packets that get through the hardware\r
572     receive filters.\r
573     Note: Note: To disable all receive filter hardware, the network driver must\r
574       be Shutdown() and Stopped(). Calling ReceiveFilters() with Disable set to\r
575       Snp->Mode->ReceiveFilterSettings will make it so no more packets are\r
576       returned by the Receive() function, but the receive hardware may still be\r
577       moving packets into system memory before inspecting and discarding them.\r
578       Unexpected system errors, reboots and hangs can occur if an OS is loaded\r
579       and the network devices are not Shutdown() and Stopped().\r
580   If ResetMCastFilter is TRUE, then the multicast receive filter list on the\r
581   network interface will be reset to the default multicast receive filter list.\r
582   If ResetMCastFilter is FALSE, and this network interface allows the multicast\r
583   receive filter list to be modified, then the MCastFilterCnt and MCastFilter\r
584   are used to update the current multicast receive filter list. The modified\r
585   receive filter list settings can be found in the MCastFilter field of\r
586   EFI_SIMPLE_NETWORK_MODE. If the network interface does not allow the multicast\r
587   receive filter list to be modified, then EFI_INVALID_PARAMETER will be returned.\r
588   If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.\r
589   If the receive filter mask and multicast receive filter list have been\r
590   successfully updated on the network interface, EFI_SUCCESS will be returned.\r
591 \r
592   @param This             A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
593   @param Enable           A bit mask of receive filters to enable on the network\r
594                           interface.\r
595   @param Disable          A bit mask of receive filters to disable on the network\r
596                           interface. For backward compatibility with EFI 1.1\r
597                           platforms, the EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit\r
598                           must be set when the ResetMCastFilter parameter is TRUE.\r
599   @param ResetMCastFilter Set to TRUE to reset the contents of the multicast\r
600                           receive filters on the network interface to their\r
601                           default values.\r
602   @param MCastFilterCnt   Number of multicast HW MAC addresses in the new MCastFilter\r
603                           list. This value must be less than or equal to the\r
604                           MCastFilterCnt field of EFI_SIMPLE_NETWORK_MODE.\r
605                           This field is optional if ResetMCastFilter is TRUE.\r
606   @param MCastFilter      A pointer to a list of new multicast receive filter HW\r
607                           MAC addresses. This list will replace any existing\r
608                           multicast HW MAC address list. This field is optional\r
609                           if ResetMCastFilter is TRUE.\r
610 \r
611   @retval EFI_SUCCESS            The multicast receive filter list was updated.\r
612   @retval EFI_NOT_STARTED        The network interface has not been started.\r
613   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is TRUE:\r
614                                  * This is NULL\r
615                                  * There are bits set in Enable that are not set\r
616                                    in Snp->Mode->ReceiveFilterMask\r
617                                  * There are bits set in Disable that are not set\r
618                                    in Snp->Mode->ReceiveFilterMask\r
619                                  * Multicast is being enabled (the\r
620                                    EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST bit is\r
621                                    set in Enable, it is not set in Disable, and\r
622                                    ResetMCastFilter is FALSE) and MCastFilterCount\r
623                                    is zero\r
624                                  * Multicast is being enabled and MCastFilterCount\r
625                                    is greater than Snp->Mode->MaxMCastFilterCount\r
626                                  * Multicast is being enabled and MCastFilter is NULL\r
627                                  * Multicast is being enabled and one or more of\r
628                                    the addresses in the MCastFilter list are not\r
629                                    valid multicast MAC addresses\r
630   @retval EFI_DEVICE_ERROR       One or more of the following conditions is TRUE:\r
631                                  * The network interface has been started but has\r
632                                    not been initialized\r
633                                  * An unexpected error was returned by the\r
634                                    underlying network driver or device\r
635   @retval EFI_UNSUPPORTED        This function is not supported by the network\r
636                                  interface.\r
637 \r
638 **/\r
639 EFI_STATUS\r
640 EFIAPI\r
641 SnpUndi32ReceiveFilters (\r
642   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
643   IN UINT32                      Enable,\r
644   IN UINT32                      Disable,\r
645   IN BOOLEAN                     ResetMCastFilter,\r
646   IN UINTN                       MCastFilterCnt,  OPTIONAL\r
647   IN EFI_MAC_ADDRESS             *MCastFilter     OPTIONAL\r
648   );\r
649 \r
650 /**\r
651   Modifies or resets the current station address, if supported.\r
652 \r
653   This function modifies or resets the current station address of a network\r
654   interface, if supported. If Reset is TRUE, then the current station address is\r
655   set to the network interface's permanent address. If Reset is FALSE, and the\r
656   network interface allows its station address to be modified, then the current\r
657   station address is changed to the address specified by New. If the network\r
658   interface does not allow its station address to be modified, then\r
659   EFI_INVALID_PARAMETER will be returned. If the station address is successfully\r
660   updated on the network interface, EFI_SUCCESS will be returned. If the driver\r
661   has not been initialized, EFI_DEVICE_ERROR will be returned.\r
662 \r
663   @param This  A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
664   @param Reset Flag used to reset the station address to the network interface's\r
665                permanent address.\r
666   @param New   New station address to be used for the network interface.\r
667 \r
668 \r
669   @retval EFI_SUCCESS           The network interface's station address was updated.\r
670   @retval EFI_NOT_STARTED       The Simple Network Protocol interface has not been\r
671                                 started by calling Start().\r
672   @retval EFI_INVALID_PARAMETER The New station address was not accepted by the NIC.\r
673   @retval EFI_INVALID_PARAMETER Reset is FALSE and New is NULL.\r
674   @retval EFI_DEVICE_ERROR      The Simple Network Protocol interface has not\r
675                                 been initialized by calling Initialize().\r
676   @retval EFI_DEVICE_ERROR      An error occurred attempting to set the new\r
677                                 station address.\r
678   @retval EFI_UNSUPPORTED       The NIC does not support changing the network\r
679                                 interface's station address.\r
680 \r
681 **/\r
682 EFI_STATUS\r
683 EFIAPI\r
684 SnpUndi32StationAddress (\r
685   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
686   IN BOOLEAN                     Reset,\r
687   IN EFI_MAC_ADDRESS             *New  OPTIONAL\r
688   );\r
689 \r
690 /**\r
691   Resets or collects the statistics on a network interface.\r
692 \r
693   This function resets or collects the statistics on a network interface. If the\r
694   size of the statistics table specified by StatisticsSize is not big enough for\r
695   all the statistics that are collected by the network interface, then a partial\r
696   buffer of statistics is returned in StatisticsTable, StatisticsSize is set to\r
697   the size required to collect all the available statistics, and\r
698   EFI_BUFFER_TOO_SMALL is returned.\r
699   If StatisticsSize is big enough for all the statistics, then StatisticsTable\r
700   will be filled, StatisticsSize will be set to the size of the returned\r
701   StatisticsTable structure, and EFI_SUCCESS is returned.\r
702   If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.\r
703   If Reset is FALSE, and both StatisticsSize and StatisticsTable are NULL, then\r
704   no operations will be performed, and EFI_SUCCESS will be returned.\r
705   If Reset is TRUE, then all of the supported statistics counters on this network\r
706   interface will be reset to zero.\r
707 \r
708   @param This            A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
709   @param Reset           Set to TRUE to reset the statistics for the network interface.\r
710   @param StatisticsSize  On input the size, in bytes, of StatisticsTable. On output\r
711                          the size, in bytes, of the resulting table of statistics.\r
712   @param StatisticsTable A pointer to the EFI_NETWORK_STATISTICS structure that\r
713                          contains the statistics. Type EFI_NETWORK_STATISTICS is\r
714                          defined in "Related Definitions" below.\r
715 \r
716   @retval EFI_SUCCESS           The requested operation succeeded.\r
717   @retval EFI_NOT_STARTED       The Simple Network Protocol interface has not been\r
718                                 started by calling Start().\r
719   @retval EFI_BUFFER_TOO_SMALL  StatisticsSize is not NULL and StatisticsTable is\r
720                                 NULL. The current buffer size that is needed to\r
721                                 hold all the statistics is returned in StatisticsSize.\r
722   @retval EFI_BUFFER_TOO_SMALL  StatisticsSize is not NULL and StatisticsTable is\r
723                                 not NULL. The current buffer size that is needed\r
724                                 to hold all the statistics is returned in\r
725                                 StatisticsSize. A partial set of statistics is\r
726                                 returned in StatisticsTable.\r
727   @retval EFI_INVALID_PARAMETER StatisticsSize is NULL and StatisticsTable is not\r
728                                 NULL.\r
729   @retval EFI_DEVICE_ERROR      The Simple Network Protocol interface has not\r
730                                 been initialized by calling Initialize().\r
731   @retval EFI_DEVICE_ERROR      An error was encountered collecting statistics\r
732                                 from the NIC.\r
733   @retval EFI_UNSUPPORTED       The NIC does not support collecting statistics\r
734                                 from the network interface.\r
735 \r
736 **/\r
737 EFI_STATUS\r
738 EFIAPI\r
739 SnpUndi32Statistics (\r
740   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
741   IN BOOLEAN                     Reset,\r
742   IN OUT UINTN                   *StatisticsSize,  OPTIONAL\r
743   IN OUT EFI_NETWORK_STATISTICS  *StatisticsTable  OPTIONAL\r
744   );\r
745 \r
746 /**\r
747   Converts a multicast IP address to a multicast HW MAC address.\r
748 \r
749   This function converts a multicast IP address to a multicast HW MAC address\r
750   for all packet transactions. If the mapping is accepted, then EFI_SUCCESS will\r
751   be returned.\r
752 \r
753   @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
754   @param IPv6 Set to TRUE if the multicast IP address is IPv6 [RFC 2460].\r
755               Set to FALSE if the multicast IP address is IPv4 [RFC 791].\r
756   @param IP   The multicast IP address that is to be converted to a multicast\r
757               HW MAC address.\r
758   @param MAC  The multicast HW MAC address that is to be generated from IP.\r
759 \r
760   @retval EFI_SUCCESS           The multicast IP address was mapped to the\r
761                                 multicast HW MAC address.\r
762   @retval EFI_NOT_STARTED       The Simple Network Protocol interface has not\r
763                                 been started by calling Start().\r
764   @retval EFI_INVALID_PARAMETER IP is NULL.\r
765   @retval EFI_INVALID_PARAMETER MAC is NULL.\r
766   @retval EFI_INVALID_PARAMETER IP does not point to a valid IPv4 or IPv6\r
767                                 multicast address.\r
768   @retval EFI_DEVICE_ERROR      The Simple Network Protocol interface has not\r
769                                 been initialized by calling Initialize().\r
770   @retval EFI_UNSUPPORTED       IPv6 is TRUE and the implementation does not\r
771                                 support IPv6 multicast to MAC address conversion.\r
772 \r
773 **/\r
774 EFI_STATUS\r
775 EFIAPI\r
776 SnpUndi32McastIpToMac (\r
777   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
778   IN BOOLEAN                     IPv6,\r
779   IN EFI_IP_ADDRESS              *IP,\r
780   OUT EFI_MAC_ADDRESS            *MAC\r
781   );\r
782 \r
783 /**\r
784   Performs read and write operations on the NVRAM device attached to a network\r
785   interface.\r
786 \r
787   This function performs read and write operations on the NVRAM device attached\r
788   to a network interface. If ReadWrite is TRUE, a read operation is performed.\r
789   If ReadWrite is FALSE, a write operation is performed. Offset specifies the\r
790   byte offset at which to start either operation. Offset must be a multiple of\r
791   NvRamAccessSize , and it must have a value between zero and NvRamSize.\r
792   BufferSize specifies the length of the read or write operation. BufferSize must\r
793   also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed\r
794   NvRamSize.\r
795   If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be\r
796   returned.\r
797   If all the conditions are met and the operation is "read," the NVRAM device\r
798   attached to the network interface will be read into Buffer and EFI_SUCCESS\r
799   will be returned. If this is a write operation, the contents of Buffer will be\r
800   used to update the contents of the NVRAM device attached to the network\r
801   interface and EFI_SUCCESS will be returned.\r
802 \r
803   It does the basic checking on the input parameters and retrieves snp structure\r
804   and then calls the read_nvdata() call which does the actual reading\r
805 \r
806   @param This       A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
807   @param ReadWrite  TRUE for read operations, FALSE for write operations.\r
808   @param Offset     Byte offset in the NVRAM device at which to start the read or\r
809                     write operation. This must be a multiple of NvRamAccessSize\r
810                     and less than NvRamSize. (See EFI_SIMPLE_NETWORK_MODE)\r
811   @param BufferSize The number of bytes to read or write from the NVRAM device.\r
812                     This must also be a multiple of NvramAccessSize.\r
813   @param Buffer     A pointer to the data buffer.\r
814 \r
815   @retval EFI_SUCCESS           The NVRAM access was performed.\r
816   @retval EFI_NOT_STARTED       The network interface has not been started.\r
817   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
818                                 * The This parameter is NULL\r
819                                 * The This parameter does not point to a valid\r
820                                   EFI_SIMPLE_NETWORK_PROTOCOL  structure\r
821                                 * The Offset parameter is not a multiple of\r
822                                   EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize\r
823                                 * The Offset parameter is not less than\r
824                                   EFI_SIMPLE_NETWORK_MODE.NvRamSize\r
825                                 * The BufferSize parameter is not a multiple of\r
826                                   EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize\r
827                                 * The Buffer parameter is NULL\r
828   @retval EFI_DEVICE_ERROR      The command could not be sent to the network\r
829                                 interface.\r
830   @retval EFI_UNSUPPORTED       This function is not supported by the network\r
831                                 interface.\r
832 \r
833 **/\r
834 EFI_STATUS\r
835 EFIAPI\r
836 SnpUndi32NvData (\r
837   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
838   IN BOOLEAN                     ReadWrite,\r
839   IN UINTN                       Offset,\r
840   IN UINTN                       BufferSize,\r
841   IN OUT VOID                    *Buffer\r
842   );\r
843 \r
844 /**\r
845   Reads the current interrupt status and recycled transmit buffer status from a\r
846   network interface.\r
847 \r
848   This function gets the current interrupt and recycled transmit buffer status\r
849   from the network interface. The interrupt status is returned as a bit mask in\r
850   InterruptStatus. If InterruptStatus is NULL, the interrupt status will not be\r
851   read. If TxBuf is not NULL, a recycled transmit buffer address will be retrieved.\r
852   If a recycled transmit buffer address is returned in TxBuf, then the buffer has\r
853   been successfully transmitted, and the status for that buffer is cleared. If\r
854   the status of the network interface is successfully collected, EFI_SUCCESS\r
855   will be returned. If the driver has not been initialized, EFI_DEVICE_ERROR will\r
856   be returned.\r
857 \r
858   @param This            A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
859   @param InterruptStatus A pointer to the bit mask of the currently active\r
860                          interrupts (see "Related Definitions"). If this is NULL,\r
861                          the interrupt status will not be read from the device.\r
862                          If this is not NULL, the interrupt status will be read\r
863                          from the device. When the interrupt status is read, it\r
864                          will also be cleared. Clearing the transmit interrupt does\r
865                          not empty the recycled transmit buffer array.\r
866   @param TxBuf           Recycled transmit buffer address. The network interface\r
867                          will not transmit if its internal recycled transmit\r
868                          buffer array is full. Reading the transmit buffer does\r
869                          not clear the transmit interrupt. If this is NULL, then\r
870                          the transmit buffer status will not be read. If there\r
871                          are no transmit buffers to recycle and TxBuf is not NULL,\r
872                          TxBuf will be set to NULL.\r
873 \r
874   @retval EFI_SUCCESS           The status of the network interface was retrieved.\r
875   @retval EFI_NOT_STARTED       The network interface has not been started.\r
876   @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid\r
877                                 EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
878   @retval EFI_DEVICE_ERROR      The command could not be sent to the network\r
879                                 interface.\r
880 \r
881 **/\r
882 EFI_STATUS\r
883 EFIAPI\r
884 SnpUndi32GetStatus (\r
885   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
886   OUT UINT32                     *InterruptStatus, OPTIONAL\r
887   OUT VOID                       **TxBuf           OPTIONAL\r
888   );\r
889 \r
890 /**\r
891   Places a packet in the transmit queue of a network interface.\r
892 \r
893   This function places the packet specified by Header and Buffer on the transmit\r
894   queue. If HeaderSize is nonzero and HeaderSize is not equal to\r
895   This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If\r
896   BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL\r
897   will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be\r
898   returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then\r
899   EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network\r
900   interface is busy, then EFI_NOT_READY will be returned. If this packet can be\r
901   accepted by the transmit engine of the network interface, the packet contents\r
902   specified by Buffer will be placed on the transmit queue of the network\r
903   interface, and EFI_SUCCESS will be returned. GetStatus() can be used to\r
904   determine when the packet has actually been transmitted. The contents of the\r
905   Buffer must not be modified until the packet has actually been transmitted.\r
906   The Transmit() function performs nonblocking I/O. A caller who wants to perform\r
907   blocking I/O, should call Transmit(), and then GetStatus() until the\r
908   transmitted buffer shows up in the recycled transmit buffer.\r
909   If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.\r
910 \r
911   @param This       A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
912   @param HeaderSize The size, in bytes, of the media header to be filled in by the\r
913                     Transmit() function. If HeaderSize is nonzero, then it must\r
914                     be equal to This->Mode->MediaHeaderSize and the DestAddr and\r
915                     Protocol parameters must not be NULL.\r
916   @param BufferSize The size, in bytes, of the entire packet (media header and\r
917                     data) to be transmitted through the network interface.\r
918   @param Buffer     A pointer to the packet (media header followed by data) to be\r
919                     transmitted. This parameter cannot be NULL. If HeaderSize is\r
920                     zero, then the media header in Buffer must already be filled\r
921                     in by the caller. If HeaderSize is nonzero, then the media\r
922                     header will be filled in by the Transmit() function.\r
923   @param SrcAddr    The source HW MAC address. If HeaderSize is zero, then this\r
924                     parameter is ignored. If HeaderSize is nonzero and SrcAddr\r
925                     is NULL, then This->Mode->CurrentAddress is used for the\r
926                     source HW MAC address.\r
927   @param DestAddr   The destination HW MAC address. If HeaderSize is zero, then\r
928                     this parameter is ignored.\r
929   @param Protocol   The type of header to build. If HeaderSize is zero, then this\r
930                     parameter is ignored. See RFC 1700, section "Ether Types,"\r
931                     for examples.\r
932 \r
933   @retval EFI_SUCCESS           The packet was placed on the transmit queue.\r
934   @retval EFI_NOT_STARTED       The network interface has not been started.\r
935   @retval EFI_NOT_READY         The network interface is too busy to accept this\r
936                                 transmit request.\r
937   @retval EFI_BUFFER_TOO_SMALL  The BufferSize parameter is too small.\r
938   @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported\r
939                                 value.\r
940   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.\r
941   @retval EFI_UNSUPPORTED       This function is not supported by the network interface.\r
942 \r
943 **/\r
944 EFI_STATUS\r
945 EFIAPI\r
946 SnpUndi32Transmit (\r
947   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
948   IN UINTN                       HeaderSize,\r
949   IN UINTN                       BufferSize,\r
950   IN VOID                        *Buffer,\r
951   IN EFI_MAC_ADDRESS             *SrcAddr,  OPTIONAL\r
952   IN EFI_MAC_ADDRESS             *DestAddr, OPTIONAL\r
953   IN UINT16                      *Protocol  OPTIONAL\r
954   );\r
955 \r
956 /**\r
957   Receives a packet from a network interface.\r
958 \r
959   This function retrieves one packet from the receive queue of a network interface.\r
960   If there are no packets on the receive queue, then EFI_NOT_READY will be\r
961   returned. If there is a packet on the receive queue, and the size of the packet\r
962   is smaller than BufferSize, then the contents of the packet will be placed in\r
963   Buffer, and BufferSize will be updated with the actual size of the packet.\r
964   In addition, if SrcAddr, DestAddr, and Protocol are not NULL, then these values\r
965   will be extracted from the media header and returned. EFI_SUCCESS will be\r
966   returned if a packet was successfully received.\r
967   If BufferSize is smaller than the received packet, then the size of the receive\r
968   packet will be placed in BufferSize and EFI_BUFFER_TOO_SMALL will be returned.\r
969   If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.\r
970 \r
971   @param This       A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
972   @param HeaderSize The size, in bytes, of the media header received on the network\r
973                     interface. If this parameter is NULL, then the media header size\r
974                     will not be returned.\r
975   @param BufferSize On entry, the size, in bytes, of Buffer. On exit, the size, in\r
976                     bytes, of the packet that was received on the network interface.\r
977   @param Buffer     A pointer to the data buffer to receive both the media\r
978                     header and the data.\r
979   @param SrcAddr    The source HW MAC address. If this parameter is NULL, the HW\r
980                     MAC source address will not be extracted from the media header.\r
981   @param DestAddr   The destination HW MAC address. If this parameter is NULL,\r
982                     the HW MAC destination address will not be extracted from\r
983                     the media header.\r
984   @param Protocol   The media header type. If this parameter is NULL, then the\r
985                     protocol will not be extracted from the media header. See\r
986                     RFC 1700 section "Ether Types" for examples.\r
987 \r
988   @retval EFI_SUCCESS           The received data was stored in Buffer, and\r
989                                 BufferSize has been updated to the number of\r
990                                 bytes received.\r
991   @retval EFI_NOT_STARTED       The network interface has not been started.\r
992   @retval EFI_NOT_READY         No packets have been received on the network interface.\r
993   @retval EFI_BUFFER_TOO_SMALL  BufferSize is too small for the received packets.\r
994                                 BufferSize has been updated to the required size.\r
995   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
996                                 * The This parameter is NULL\r
997                                 * The This parameter does not point to a valid\r
998                                   EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
999                                 * The BufferSize parameter is NULL\r
1000                                 * The Buffer parameter is NULL\r
1001   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.\r
1002 \r
1003 **/\r
1004 EFI_STATUS\r
1005 EFIAPI\r
1006 SnpUndi32Receive (\r
1007   IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
1008   OUT UINTN                      *HeaderSize OPTIONAL,\r
1009   IN OUT UINTN                   *BufferSize,\r
1010   OUT VOID                       *Buffer,\r
1011   OUT EFI_MAC_ADDRESS            *SrcAddr OPTIONAL,\r
1012   OUT EFI_MAC_ADDRESS            *DestAddr OPTIONAL,\r
1013   OUT UINT16                     *Protocol OPTIONAL\r
1014   );\r
1015 \r
1016 /**\r
1017   Nofication call back function for WaitForPacket event.\r
1018 \r
1019   @param  Event       EFI Event.\r
1020   @param  SnpPtr      Pointer to SNP_DRIVER structure.\r
1021 \r
1022 **/\r
1023 VOID\r
1024 EFIAPI\r
1025 SnpWaitForPacketNotify (\r
1026   EFI_EVENT Event,\r
1027   VOID      *SnpPtr\r
1028   );\r
1029 \r
1030 #define SNP_MEM_PAGES(x)  (((x) - 1) / 4096 + 1)\r
1031 \r
1032 \r
1033 #endif /*  _SNP_H_  */\r