MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c

   1 /** @file
   2   Implement IP4 pesudo interface.
   3
   4 Copyright (c) 2005 - 2016, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include "Ip4Impl.h"
  16
  17 //
  18 // Mac address with all zero, used to determine whethter the ARP
  19 // resolve succeeded. Failed ARP requests zero the MAC address buffer.
  20 //
  21 EFI_MAC_ADDRESS  mZeroMacAddress;
  22
  23 /**
  24   Callback funtion when frame transmission is finished. It will
  25   call the frame owner's callback function to tell it the result.
  26
  27   @param[in]  Context            Context which is point to the token.
  28
  29 **/
  30 VOID
  31 EFIAPI
  32 Ip4OnFrameSentDpc (
  33   IN VOID                    *Context
  34   );
  35
  36 /**
  37   Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.
  38
  39   @param[in]  Event              The transmit token's event.
  40   @param[in]  Context            Context which is point to the token.
  41
  42 **/
  43 VOID
  44 EFIAPI
  45 Ip4OnFrameSent (
  46   IN EFI_EVENT               Event,
  47   IN VOID                    *Context
  48   );
  49
  50 /**
  51   Callback function when ARP request are finished. It will cancelled
  52   all the queued frame if the ARP requests failed. Or transmit them
  53   if the request succeed.
  54
  55   @param[in]  Context           The context of the callback, a point to the ARP
  56                                 queue
  57
  58 **/
  59 VOID
  60 EFIAPI
  61 Ip4OnArpResolvedDpc (
  62   IN VOID                   *Context
  63   );
  64
  65 /**
  66   Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.
  67
  68   @param  Event             The Arp request event.
  69   @param  Context           The context of the callback, a point to the ARP
  70                             queue.
  71
  72 **/
  73 VOID
  74 EFIAPI
  75 Ip4OnArpResolved (
  76   IN EFI_EVENT              Event,
  77   IN VOID                   *Context
  78   );
  79
  80 /**
  81   Received a frame from MNP, wrap it in net buffer then deliver
  82   it to IP's input function. The ownship of the packet also
  83   transferred to IP. When Ip is finished with this packet, it
  84   will call NetbufFree to release the packet, NetbufFree will
  85   again call the Ip4RecycleFrame to signal MNP's event and free
  86   the token used.
  87
  88   @param  Context               Context for the callback.
  89
  90 **/
  91 VOID
  92 EFIAPI
  93 Ip4OnFrameReceivedDpc (
  94   IN VOID                     *Context
  95   );
  96
  97 /**
  98   Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
  99
 100   @param Event      The receive event delivered to MNP for receive.
 101   @param Context    Context for the callback.
 102
 103 **/
 104 VOID
 105 EFIAPI
 106 Ip4OnFrameReceived (
 107   IN EFI_EVENT                Event,
 108   IN VOID                     *Context
 109   );
 110
 111 /**
 112   Remove all the frames on the ARP queue that pass the FrameToCancel,
 113   that is, either FrameToCancel is NULL or it returns true for the frame.
 114
 115   @param[in]  ArpQue            ARP frame to remove the frames from.
 116   @param[in]  IoStatus          The status returned to the cancelled frames'
 117                                 callback function.
 118   @param[in]  FrameToCancel     Function to select which frame to cancel.
 119   @param[in]  Context           Opaque parameter to the FrameToCancel.
 120
 121 **/
 122 VOID
 123 Ip4CancelFrameArp (
 124   IN IP4_ARP_QUE            *ArpQue,
 125   IN EFI_STATUS             IoStatus,
 126   IN IP4_FRAME_TO_CANCEL    FrameToCancel  OPTIONAL,
 127   IN VOID                   *Context
 128   );
 129
 130
 131 /**
 132   Wrap a transmit request into a newly allocated IP4_LINK_TX_TOKEN.
 133
 134   @param[in]  Interface         The interface to send out to.
 135   @param[in]  IpInstance        The IpInstance that transmit the packet.  NULL if
 136                                 the packet is sent by the IP4 driver itself.
 137   @param[in]  Packet            The packet to transmit
 138   @param[in]  CallBack          Call back function to execute if transmission
 139                                 finished.
 140   @param[in]  Context           Opaque parameter to the call back.
 141
 142   @retval   Token               The wrapped token if succeed
 143   @retval   NULL                The wrapped token if NULL
 144
 145 **/
 146 IP4_LINK_TX_TOKEN *
 147 Ip4WrapLinkTxToken (
 148   IN IP4_INTERFACE          *Interface,
 149   IN IP4_PROTOCOL           *IpInstance     OPTIONAL,
 150   IN NET_BUF                *Packet,
 151   IN IP4_FRAME_CALLBACK     CallBack,
 152   IN VOID                   *Context
 153   )
 154 {
 155   EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *MnpToken;
 156   EFI_MANAGED_NETWORK_TRANSMIT_DATA     *MnpTxData;
 157   IP4_LINK_TX_TOKEN                     *Token;
 158   EFI_STATUS                            Status;
 159   UINT32                                Count;
 160
 161   Token = AllocatePool (sizeof (IP4_LINK_TX_TOKEN) + \
 162             (Packet->BlockOpNum - 1) * sizeof (EFI_MANAGED_NETWORK_FRAGMENT_DATA));
 163
 164   if (Token == NULL) {
 165     return NULL;
 166   }
 167
 168   Token->Signature = IP4_FRAME_TX_SIGNATURE;
 169   InitializeListHead (&Token->Link);
 170
 171   Token->Interface  = Interface;
 172   Token->IpInstance = IpInstance;
 173   Token->CallBack   = CallBack;
 174   Token->Packet     = Packet;
 175   Token->Context    = Context;
 176   CopyMem (&Token->DstMac, &mZeroMacAddress, sizeof (Token->DstMac));
 177   CopyMem (&Token->SrcMac, &Interface->Mac, sizeof (Token->SrcMac));
 178
 179   MnpToken          = &(Token->MnpToken);
 180   MnpToken->Status  = EFI_NOT_READY;
 181
 182   Status = gBS->CreateEvent (
 183                   EVT_NOTIFY_SIGNAL,
 184                   TPL_NOTIFY,
 185                   Ip4OnFrameSent,
 186                   Token,
 187                   &MnpToken->Event
 188                   );
 189
 190   if (EFI_ERROR (Status)) {
 191     FreePool (Token);
 192     return NULL;
 193   }
 194
 195   MnpTxData                     = &Token->MnpTxData;
 196   MnpToken->Packet.TxData       = MnpTxData;
 197
 198   MnpTxData->DestinationAddress = &Token->DstMac;
 199   MnpTxData->SourceAddress      = &Token->SrcMac;
 200   MnpTxData->ProtocolType       = IP4_ETHER_PROTO;
 201   MnpTxData->DataLength         = Packet->TotalSize;
 202   MnpTxData->HeaderLength       = 0;
 203
 204   Count                         = Packet->BlockOpNum;
 205
 206   NetbufBuildExt (Packet, (NET_FRAGMENT *) MnpTxData->FragmentTable, &Count);
 207   MnpTxData->FragmentCount      = (UINT16)Count;
 208
 209   return Token;
 210 }
 211
 212
 213 /**
 214   Free the link layer transmit token. It will close the event
 215   then free the memory used.
 216
 217   @param[in]  Token                 Token to free
 218
 219 **/
 220 VOID
 221 Ip4FreeLinkTxToken (
 222   IN IP4_LINK_TX_TOKEN      *Token
 223   )
 224 {
 225   NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE);
 226
 227   gBS->CloseEvent (Token->MnpToken.Event);
 228   FreePool (Token);
 229 }
 230
 231
 232 /**
 233   Create an IP_ARP_QUE structure to request ARP service.
 234
 235   @param[in]  Interface         The interface to send ARP from.
 236   @param[in]  DestIp            The destination IP (host byte order) to request MAC
 237                                 for
 238
 239   @return Point to newly created IP4_ARP_QUE if succeed, otherwise NULL.
 240
 241 **/
 242 IP4_ARP_QUE *
 243 Ip4CreateArpQue (
 244   IN IP4_INTERFACE          *Interface,
 245   IN IP4_ADDR               DestIp
 246   )
 247 {
 248   IP4_ARP_QUE               *ArpQue;
 249   EFI_STATUS                Status;
 250
 251   ArpQue = AllocatePool (sizeof (IP4_ARP_QUE));
 252
 253   if (ArpQue == NULL) {
 254     return NULL;
 255   }
 256
 257   ArpQue->Signature = IP4_FRAME_ARP_SIGNATURE;
 258   InitializeListHead (&ArpQue->Link);
 259
 260   InitializeListHead (&ArpQue->Frames);
 261   ArpQue->Interface = Interface;
 262
 263   Status = gBS->CreateEvent (
 264                   EVT_NOTIFY_SIGNAL,
 265                   TPL_NOTIFY,
 266                   Ip4OnArpResolved,
 267                   ArpQue,
 268                   &ArpQue->OnResolved
 269                   );
 270
 271   if (EFI_ERROR (Status)) {
 272     FreePool (ArpQue);
 273     return NULL;
 274   }
 275
 276   ArpQue->Ip  = DestIp;
 277   CopyMem (&ArpQue->Mac, &mZeroMacAddress, sizeof (ArpQue->Mac));
 278
 279   return ArpQue;
 280 }
 281
 282
 283 /**
 284   Remove all the transmit requests queued on the ARP queue, then free it.
 285
 286   @param[in]  ArpQue            Arp queue to free
 287   @param[in]  IoStatus          The transmit status returned to transmit requests'
 288                                 callback.
 289
 290 **/
 291 VOID
 292 Ip4FreeArpQue (
 293   IN IP4_ARP_QUE            *ArpQue,
 294   IN EFI_STATUS             IoStatus
 295   )
 296 {
 297   NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE);
 298
 299   //
 300   // Remove all the frame waiting the ARP response
 301   //
 302   Ip4CancelFrameArp (ArpQue, IoStatus, NULL, NULL);
 303
 304   gBS->CloseEvent (ArpQue->OnResolved);
 305   FreePool (ArpQue);
 306 }
 307
 308
 309 /**
 310   Create a link layer receive token to wrap the receive request
 311
 312   @param[in]  Interface         The interface to receive from
 313   @param[in]  IpInstance        The instance that request the receive (NULL for IP4
 314                                 driver itself)
 315   @param[in]  CallBack          Call back function to execute when finished.
 316   @param[in]  Context           Opaque parameters to the callback
 317
 318   @return Point to created IP4_LINK_RX_TOKEN if succeed, otherwise NULL.
 319
 320 **/
 321 IP4_LINK_RX_TOKEN *
 322 Ip4CreateLinkRxToken (
 323   IN IP4_INTERFACE          *Interface,
 324   IN IP4_PROTOCOL           *IpInstance,
 325   IN IP4_FRAME_CALLBACK     CallBack,
 326   IN VOID                   *Context
 327   )
 328 {
 329   EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *MnpToken;
 330   IP4_LINK_RX_TOKEN                     *Token;
 331   EFI_STATUS                            Status;
 332
 333   Token = AllocatePool (sizeof (IP4_LINK_RX_TOKEN));
 334   if (Token == NULL) {
 335     return NULL;
 336   }
 337
 338   Token->Signature  = IP4_FRAME_RX_SIGNATURE;
 339   Token->Interface  = Interface;
 340   Token->IpInstance = IpInstance;
 341   Token->CallBack   = CallBack;
 342   Token->Context    = Context;
 343
 344   MnpToken          = &Token->MnpToken;
 345   MnpToken->Status  = EFI_NOT_READY;
 346
 347   Status = gBS->CreateEvent (
 348                   EVT_NOTIFY_SIGNAL,
 349                   TPL_NOTIFY,
 350                   Ip4OnFrameReceived,
 351                   Token,
 352                   &MnpToken->Event
 353                   );
 354
 355   if (EFI_ERROR (Status)) {
 356     FreePool (Token);
 357     return NULL;
 358   }
 359
 360   MnpToken->Packet.RxData = NULL;
 361   return Token;
 362 }
 363
 364
 365 /**
 366   Free the link layer request token. It will close the event
 367   then free the memory used.
 368
 369   @param[in]  Token                 Request token to free.
 370
 371 **/
 372 VOID
 373 Ip4FreeFrameRxToken (
 374   IN IP4_LINK_RX_TOKEN      *Token
 375   )
 376 {
 377
 378   NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE);
 379
 380   gBS->CloseEvent (Token->MnpToken.Event);
 381   FreePool (Token);
 382 }
 383
 384
 385 /**
 386   Remove all the frames on the ARP queue that pass the FrameToCancel,
 387   that is, either FrameToCancel is NULL or it returns true for the frame.
 388
 389   @param[in]  ArpQue            ARP frame to remove the frames from.
 390   @param[in]  IoStatus          The status returned to the cancelled frames'
 391                                 callback function.
 392   @param[in]  FrameToCancel     Function to select which frame to cancel.
 393   @param[in]  Context           Opaque parameter to the FrameToCancel.
 394
 395 **/
 396 VOID
 397 Ip4CancelFrameArp (
 398   IN IP4_ARP_QUE            *ArpQue,
 399   IN EFI_STATUS             IoStatus,
 400   IN IP4_FRAME_TO_CANCEL    FrameToCancel  OPTIONAL,
 401   IN VOID                   *Context
 402   )
 403 {
 404   LIST_ENTRY                *Entry;
 405   LIST_ENTRY                *Next;
 406   IP4_LINK_TX_TOKEN         *Token;
 407
 408   NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {
 409     Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);
 410
 411     if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) {
 412       RemoveEntryList (Entry);
 413
 414       Token->CallBack (Token->IpInstance, Token->Packet, IoStatus, 0, Token->Context);
 415       Ip4FreeLinkTxToken (Token);
 416     }
 417   }
 418 }
 419
 420
 421 /**
 422   Remove all the frames on the interface that pass the FrameToCancel,
 423   either queued on ARP queues or that have already been delivered to
 424   MNP and not yet recycled.
 425
 426   @param[in]  Interface         Interface to remove the frames from.
 427   @param[in]  IoStatus          The transmit status returned to the frames'
 428                                 callback.
 429   @param[in]  FrameToCancel     Function to select the frame to cancel, NULL to
 430                                 select all.
 431   @param[in]  Context           Opaque parameters passed to FrameToCancel.
 432
 433 **/
 434 VOID
 435 Ip4CancelFrames (
 436   IN IP4_INTERFACE          *Interface,
 437   IN EFI_STATUS             IoStatus,
 438   IN IP4_FRAME_TO_CANCEL    FrameToCancel    OPTIONAL,
 439   IN VOID                   *Context
 440   )
 441 {
 442   LIST_ENTRY                *Entry;
 443   LIST_ENTRY                *Next;
 444   IP4_ARP_QUE               *ArpQue;
 445   IP4_LINK_TX_TOKEN         *Token;
 446
 447   //
 448   // Cancel all the pending frames on ARP requests
 449   //
 450   NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->ArpQues) {
 451     ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link);
 452
 453     Ip4CancelFrameArp (ArpQue, IoStatus, FrameToCancel, Context);
 454
 455     if (IsListEmpty (&ArpQue->Frames)) {
 456       Interface->Arp->Cancel (Interface->Arp, &ArpQue->Ip, ArpQue->OnResolved);
 457     }
 458   }
 459
 460   //
 461   // Cancel all the frames that have been delivered to MNP
 462   // but not yet recycled.
 463   //
 464   NET_LIST_FOR_EACH_SAFE (Entry, Next, &Interface->SentFrames) {
 465     Token = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);
 466
 467     if ((FrameToCancel == NULL) || FrameToCancel (Token, Context)) {
 468       Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken);
 469     }
 470   }
 471 }
 472
 473
 474 /**
 475   Create an IP4_INTERFACE. Delay the creation of ARP instance until
 476   the interface is configured.
 477
 478   @param[in]  Mnp               The shared MNP child of this IP4 service binding
 479                                 instance.
 480   @param[in]  Controller        The controller this IP4 service binding instance
 481                                 is installed. Most like the UNDI handle.
 482   @param[in]  ImageHandle       This driver's image handle.
 483
 484   @return Point to the created IP4_INTERFACE, otherwise NULL.
 485
 486 **/
 487 IP4_INTERFACE *
 488 Ip4CreateInterface (
 489   IN  EFI_MANAGED_NETWORK_PROTOCOL  *Mnp,
 490   IN  EFI_HANDLE                    Controller,
 491   IN  EFI_HANDLE                    ImageHandle
 492   )
 493 {
 494   IP4_INTERFACE             *Interface;
 495   EFI_SIMPLE_NETWORK_MODE   SnpMode;
 496
 497   Interface = AllocatePool (sizeof (IP4_INTERFACE));
 498
 499   if ((Interface == NULL) || (Mnp == NULL)) {
 500     return NULL;
 501   }
 502
 503   Interface->Signature = IP4_INTERFACE_SIGNATURE;
 504   InitializeListHead (&Interface->Link);
 505   Interface->RefCnt     = 1;
 506
 507   Interface->Ip         = IP4_ALLZERO_ADDRESS;
 508   Interface->SubnetMask = IP4_ALLZERO_ADDRESS;
 509   Interface->Configured = FALSE;
 510
 511   Interface->Controller = Controller;
 512   Interface->Image      = ImageHandle;
 513   Interface->Mnp        = Mnp;
 514   Interface->Arp        = NULL;
 515   Interface->ArpHandle  = NULL;
 516
 517   InitializeListHead (&Interface->ArpQues);
 518   InitializeListHead (&Interface->SentFrames);
 519
 520   Interface->RecvRequest = NULL;
 521
 522   //
 523   // Get the interface's Mac address and broadcast mac address from SNP
 524   //
 525   if (EFI_ERROR (Mnp->GetModeData (Mnp, NULL, &SnpMode))) {
 526     FreePool (Interface);
 527     return NULL;
 528   }
 529
 530   CopyMem (&Interface->Mac, &SnpMode.CurrentAddress, sizeof (Interface->Mac));
 531   CopyMem (&Interface->BroadcastMac, &SnpMode.BroadcastAddress, sizeof (Interface->BroadcastMac));
 532   Interface->HwaddrLen    = SnpMode.HwAddressSize;
 533
 534   InitializeListHead (&Interface->IpInstances);
 535   Interface->PromiscRecv = FALSE;
 536
 537   return Interface;
 538 }
 539
 540
 541 /**
 542   Set the interface's address, create and configure
 543   the ARP child if necessary.
 544
 545   @param  Interface         The interface to set the address.
 546   @param  IpAddr            The interface's IP address.
 547   @param  SubnetMask        The interface's netmask.
 548
 549   @retval EFI_SUCCESS           The interface is configured with Ip/netmask pair,
 550                                 and a ARP is created for it.
 551   @retval Others                Failed to set the interface's address.
 552
 553 **/
 554 EFI_STATUS
 555 Ip4SetAddress (
 556   IN OUT IP4_INTERFACE      *Interface,
 557   IN     IP4_ADDR           IpAddr,
 558   IN     IP4_ADDR           SubnetMask
 559   )
 560 {
 561   EFI_ARP_CONFIG_DATA       ArpConfig;
 562   EFI_STATUS                Status;
 563   INTN                      Len;
 564
 565   NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);
 566
 567   //
 568   // Set the ip/netmask, then compute the subnet broadcast
 569   // and network broadcast for easy access. When computing
 570   // nework broadcast, the subnet mask is most like longer
 571   // than the default netmask (not subneted) as defined in
 572   // RFC793. If that isn't the case, we are aggregating the
 573   // networks, use the subnet's mask instead.
 574   //
 575   Interface->Ip             = IpAddr;
 576   Interface->SubnetMask     = SubnetMask;
 577   Interface->SubnetBrdcast  = (IpAddr | ~SubnetMask);
 578
 579   Len                       = NetGetMaskLength (SubnetMask);
 580   ASSERT (Len <= IP4_MASK_MAX);
 581   Interface->NetBrdcast     = (IpAddr | ~SubnetMask);
 582
 583   //
 584   // Do clean up for Arp child
 585   //
 586   if (Interface->ArpHandle != NULL) {
 587     if (Interface->Arp != NULL) {
 588       gBS->CloseProtocol (
 589              Interface->ArpHandle,
 590              &gEfiArpProtocolGuid,
 591              Interface->Image,
 592              Interface->Controller
 593              );
 594
 595       Interface->Arp = NULL;
 596     }
 597
 598     NetLibDestroyServiceChild (
 599       Interface->Controller,
 600       Interface->Image,
 601       &gEfiArpServiceBindingProtocolGuid,
 602       &Interface->ArpHandle
 603       );
 604
 605     Interface->ArpHandle = NULL;
 606   }
 607
 608   //
 609   // If the address is NOT all zero, create then configure an ARP child.
 610   // Pay attention: DHCP configures its station address as 0.0.0.0/0
 611   //
 612   if (IpAddr != IP4_ALLZERO_ADDRESS) {
 613     Status = NetLibCreateServiceChild (
 614                Interface->Controller,
 615                Interface->Image,
 616                &gEfiArpServiceBindingProtocolGuid,
 617                &Interface->ArpHandle
 618                );
 619
 620     if (EFI_ERROR (Status)) {
 621       return Status;
 622     }
 623
 624     Status = gBS->OpenProtocol (
 625                     Interface->ArpHandle,
 626                     &gEfiArpProtocolGuid,
 627                     (VOID **) &Interface->Arp,
 628                     Interface->Image,
 629                     Interface->Controller,
 630                     EFI_OPEN_PROTOCOL_BY_DRIVER
 631                     );
 632
 633     if (EFI_ERROR (Status)) {
 634       goto ON_ERROR;
 635     }
 636
 637     IpAddr                    = HTONL (IpAddr);
 638     ArpConfig.SwAddressType   = IP4_ETHER_PROTO;
 639     ArpConfig.SwAddressLength = 4;
 640     ArpConfig.StationAddress  = &IpAddr;
 641     ArpConfig.EntryTimeOut    = 0;
 642     ArpConfig.RetryCount      = 0;
 643     ArpConfig.RetryTimeOut    = 0;
 644
 645     Status = Interface->Arp->Configure (Interface->Arp, &ArpConfig);
 646
 647     if (EFI_ERROR (Status)) {
 648       gBS->CloseProtocol (
 649              Interface->ArpHandle,
 650              &gEfiArpProtocolGuid,
 651              Interface->Image,
 652              Interface->Controller
 653              );
 654
 655       goto ON_ERROR;
 656     }
 657   }
 658
 659   Interface->Configured = TRUE;
 660   return EFI_SUCCESS;
 661
 662 ON_ERROR:
 663   NetLibDestroyServiceChild (
 664     Interface->Controller,
 665     Interface->Image,
 666     &gEfiArpServiceBindingProtocolGuid,
 667     &Interface->ArpHandle
 668     );
 669
 670   return Status;
 671 }
 672
 673
 674 /**
 675   Filter function to cancel all the frame related to an IP instance.
 676
 677   @param[in]  Frame             The transmit request to test whether to cancel
 678   @param[in]  Context           The context which is the Ip instance that issued
 679                                 the transmit.
 680
 681   @retval TRUE                  The frame belongs to this instance and is to be
 682                                 removed
 683   @retval FALSE                 The frame doesn't belong to this instance.
 684
 685 **/
 686 BOOLEAN
 687 Ip4CancelInstanceFrame (
 688   IN IP4_LINK_TX_TOKEN *Frame,
 689   IN VOID              *Context
 690   )
 691 {
 692   if (Frame->IpInstance == (IP4_PROTOCOL *) Context) {
 693     return TRUE;
 694   }
 695
 696   return FALSE;
 697 }
 698
 699
 700
 701 /**
 702   If there is a pending receive request, cancel it. Don't call
 703   the receive request's callback because this function can be only
 704   called if the instance or driver is tearing itself down. It
 705   doesn't make sense to call it back. But it is necessary to call
 706   the transmit token's callback to give it a chance to free the
 707   packet and update the upper layer's transmit request status, say
 708   that from the UDP.
 709
 710   @param[in]  Interface         The interface used by the IpInstance
 711
 712 **/
 713 VOID
 714 Ip4CancelReceive (
 715   IN IP4_INTERFACE          *Interface
 716   )
 717 {
 718   EFI_TPL                   OldTpl;
 719   IP4_LINK_RX_TOKEN         *Token;
 720
 721   if ((Token = Interface->RecvRequest) != NULL) {
 722     OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 723
 724     Interface->RecvRequest = NULL;
 725     Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken);
 726
 727     gBS->RestoreTPL (OldTpl);
 728   }
 729 }
 730
 731
 732 /**
 733   Free the interface used by IpInstance. All the IP instance with
 734   the same Ip/Netmask pair share the same interface. It is reference
 735   counted. All the frames haven't been sent will be cancelled.
 736   Because the IpInstance is optional, the caller must remove
 737   IpInstance from the interface's instance list itself.
 738
 739   @param[in]  Interface         The interface used by the IpInstance.
 740   @param[in]  IpInstance        The Ip instance that free the interface. NULL if
 741                                 the Ip driver is releasing the default interface.
 742
 743   @retval EFI_SUCCESS           The interface use IpInstance is freed.
 744
 745 **/
 746 EFI_STATUS
 747 Ip4FreeInterface (
 748   IN  IP4_INTERFACE         *Interface,
 749   IN  IP4_PROTOCOL          *IpInstance           OPTIONAL
 750   )
 751 {
 752   NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);
 753   ASSERT (Interface->RefCnt > 0);
 754
 755   //
 756   // Remove all the pending transmit token related to this IP instance.
 757   //
 758   Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, IpInstance);
 759
 760   if (--Interface->RefCnt > 0) {
 761     return EFI_SUCCESS;
 762   }
 763
 764   //
 765   // Destroy the interface if this is the last IP instance that
 766   // has the address. Remove all the system transmitted packets
 767   // from this interface, cancel the receive request if there is
 768   // one, and destroy the ARP requests.
 769   //
 770   Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, NULL);
 771   Ip4CancelReceive (Interface);
 772
 773   ASSERT (IsListEmpty (&Interface->IpInstances));
 774   ASSERT (IsListEmpty (&Interface->ArpQues));
 775   ASSERT (IsListEmpty (&Interface->SentFrames));
 776
 777   if (Interface->Arp != NULL) {
 778     gBS->CloseProtocol (
 779           Interface->ArpHandle,
 780           &gEfiArpProtocolGuid,
 781           Interface->Image,
 782           Interface->Controller
 783           );
 784
 785     NetLibDestroyServiceChild (
 786       Interface->Controller,
 787       Interface->Image,
 788       &gEfiArpServiceBindingProtocolGuid,
 789       Interface->ArpHandle
 790       );
 791   }
 792
 793   RemoveEntryList (&Interface->Link);
 794   FreePool (Interface);
 795
 796   return EFI_SUCCESS;
 797 }
 798
 799
 800 /**
 801   Callback function when ARP request are finished. It will cancelled
 802   all the queued frame if the ARP requests failed. Or transmit them
 803   if the request succeed.
 804
 805   @param[in]  Context           The context of the callback, a point to the ARP
 806                                 queue
 807
 808 **/
 809 VOID
 810 EFIAPI
 811 Ip4OnArpResolvedDpc (
 812   IN VOID                   *Context
 813   )
 814 {
 815   LIST_ENTRY                *Entry;
 816   LIST_ENTRY                *Next;
 817   IP4_ARP_QUE               *ArpQue;
 818   IP4_INTERFACE             *Interface;
 819   IP4_LINK_TX_TOKEN         *Token;
 820   EFI_STATUS                Status;
 821
 822   ArpQue = (IP4_ARP_QUE *) Context;
 823   NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE);
 824
 825   RemoveEntryList (&ArpQue->Link);
 826
 827   //
 828   // ARP resolve failed for some reason. Release all the frame
 829   // and ARP queue itself. Ip4FreeArpQue will call the frame's
 830   // owner back.
 831   //
 832   if (NET_MAC_EQUAL (&ArpQue->Mac, &mZeroMacAddress, ArpQue->Interface->HwaddrLen)) {
 833     Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);
 834
 835     return ;
 836   }
 837
 838   //
 839   // ARP resolve succeeded, Transmit all the frame. Release the ARP
 840   // queue. It isn't necessary for us to cache the ARP binding because
 841   // we always check the ARP cache first before transmit.
 842   //
 843   Interface = ArpQue->Interface;
 844
 845   NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {
 846     RemoveEntryList (Entry);
 847
 848     Token         = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);
 849     CopyMem (&Token->DstMac, &ArpQue->Mac, sizeof (Token->DstMac));
 850
 851     //
 852     // Insert the tx token before transmitting it via MNP as the FrameSentDpc
 853     // may be called before Mnp->Transmit returns which will remove this tx
 854     // token from the SentFrames list. Remove it from the list if the returned
 855     // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the
 856     // FrameSentDpc won't be queued.
 857     //
 858     InsertTailList (&Interface->SentFrames, &Token->Link);
 859
 860     Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);
 861     if (EFI_ERROR (Status)) {
 862       RemoveEntryList (Entry);
 863       Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context);
 864
 865       Ip4FreeLinkTxToken (Token);
 866       continue;
 867     }
 868   }
 869
 870   Ip4FreeArpQue (ArpQue, EFI_SUCCESS);
 871 }
 872
 873 /**
 874   Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.
 875
 876   @param  Event             The Arp request event.
 877   @param  Context           The context of the callback, a point to the ARP
 878                             queue.
 879
 880 **/
 881 VOID
 882 EFIAPI
 883 Ip4OnArpResolved (
 884   IN EFI_EVENT              Event,
 885   IN VOID                   *Context
 886   )
 887 {
 888   //
 889   // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK
 890   //
 891   QueueDpc (TPL_CALLBACK, Ip4OnArpResolvedDpc, Context);
 892 }
 893
 894
 895
 896 /**
 897   Callback funtion when frame transmission is finished. It will
 898   call the frame owner's callback function to tell it the result.
 899
 900   @param[in]  Context            Context which is point to the token.
 901
 902 **/
 903 VOID
 904 EFIAPI
 905 Ip4OnFrameSentDpc (
 906   IN VOID                    *Context
 907   )
 908 {
 909   IP4_LINK_TX_TOKEN         *Token;
 910
 911   Token = (IP4_LINK_TX_TOKEN *) Context;
 912   NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE);
 913
 914   RemoveEntryList (&Token->Link);
 915
 916   Token->CallBack (
 917           Token->IpInstance,
 918           Token->Packet,
 919           Token->MnpToken.Status,
 920           0,
 921           Token->Context
 922           );
 923
 924   Ip4FreeLinkTxToken (Token);
 925 }
 926
 927 /**
 928   Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.
 929
 930   @param[in]  Event              The transmit token's event.
 931   @param[in]  Context            Context which is point to the token.
 932
 933 **/
 934 VOID
 935 EFIAPI
 936 Ip4OnFrameSent (
 937   IN EFI_EVENT               Event,
 938   IN VOID                    *Context
 939   )
 940 {
 941   //
 942   // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK
 943   //
 944   QueueDpc (TPL_CALLBACK, Ip4OnFrameSentDpc, Context);
 945 }
 946
 947
 948
 949 /**
 950   Send a frame from the interface. If the next hop is broadcast or
 951   multicast address, it is transmitted immediately. If the next hop
 952   is a unicast, it will consult ARP to resolve the NextHop's MAC.
 953   If some error happened, the CallBack won't be called. So, the caller
 954   must test the return value, and take action when there is an error.
 955
 956   @param[in]  Interface         The interface to send the frame from
 957   @param[in]  IpInstance        The IP child that request the transmission.  NULL
 958                                 if it is the IP4 driver itself.
 959   @param[in]  Packet            The packet to transmit.
 960   @param[in]  NextHop           The immediate destination to transmit the packet
 961                                 to.
 962   @param[in]  CallBack          Function to call back when transmit finished.
 963   @param[in]  Context           Opaque parameter to the call back.
 964
 965   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to send the frame
 966   @retval EFI_NO_MAPPING        Can't resolve the MAC for the nexthop
 967   @retval EFI_SUCCESS           The packet is successfully transmitted.
 968   @retval other                 Other error occurs.
 969
 970 **/
 971 EFI_STATUS
 972 Ip4SendFrame (
 973   IN  IP4_INTERFACE         *Interface,
 974   IN  IP4_PROTOCOL          *IpInstance       OPTIONAL,
 975   IN  NET_BUF               *Packet,
 976   IN  IP4_ADDR              NextHop,
 977   IN  IP4_FRAME_CALLBACK    CallBack,
 978   IN  VOID                  *Context
 979   )
 980 {
 981   IP4_LINK_TX_TOKEN         *Token;
 982   LIST_ENTRY                *Entry;
 983   IP4_ARP_QUE               *ArpQue;
 984   EFI_ARP_PROTOCOL          *Arp;
 985   EFI_STATUS                Status;
 986
 987   ASSERT (Interface->Configured);
 988
 989   Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context);
 990
 991   if (Token == NULL) {
 992     return EFI_OUT_OF_RESOURCES;
 993   }
 994
 995   //
 996   // Get the destination MAC address for multicast and broadcasts.
 997   // Don't depend on ARP to solve the address since there maybe no
 998   // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for
 999   // all the broadcasts.
1000   //
1001   if (NextHop == IP4_ALLONE_ADDRESS) {
1002     CopyMem (&Token->DstMac, &Interface->BroadcastMac, sizeof (Token->DstMac));
1003     goto SEND_NOW;
1004
1005   } else if (IP4_IS_MULTICAST (NextHop)) {
1006
1007     Status = Ip4GetMulticastMac (Interface->Mnp, NextHop, &Token->DstMac);
1008
1009     if (EFI_ERROR (Status)) {
1010       goto ON_ERROR;
1011     }
1012
1013     goto SEND_NOW;
1014   }
1015
1016   //
1017   // Can only send out multicast/broadcast if the IP address is zero
1018   //
1019   if ((Arp = Interface->Arp) == NULL) {
1020     Status = EFI_NO_MAPPING;
1021     goto ON_ERROR;
1022   }
1023
1024   //
1025   // First check whether this binding is in the ARP cache.
1026   //
1027   NextHop = HTONL (NextHop);
1028   Status  = Arp->Request (Arp, &NextHop, NULL, &Token->DstMac);
1029
1030   if (Status == EFI_SUCCESS) {
1031     goto SEND_NOW;
1032
1033   } else if (Status != EFI_NOT_READY) {
1034     goto ON_ERROR;
1035   }
1036
1037   //
1038   // Have to do asynchronous ARP resolution. First check
1039   // whether there is already a pending request.
1040   //
1041   ArpQue = NULL;
1042
1043   NET_LIST_FOR_EACH (Entry, &Interface->ArpQues) {
1044     ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link);
1045
1046     if (ArpQue->Ip == NextHop) {
1047       break;
1048     }
1049   }
1050
1051   //
1052   // Found a pending ARP request, enqueue the frame then return
1053   //
1054   if (Entry != &Interface->ArpQues) {
1055     InsertTailList (&ArpQue->Frames, &Token->Link);
1056     return EFI_SUCCESS;
1057   }
1058
1059   //
1060   // First frame to NextHop, issue an asynchronous ARP requests
1061   //
1062   ArpQue = Ip4CreateArpQue (Interface, NextHop);
1063
1064   if (ArpQue == NULL) {
1065     Status = EFI_OUT_OF_RESOURCES;
1066     goto ON_ERROR;
1067   }
1068
1069   Status = Arp->Request (Arp, &ArpQue->Ip, ArpQue->OnResolved, ArpQue->Mac.Addr);
1070
1071   if (EFI_ERROR (Status) && (Status != EFI_NOT_READY)) {
1072     Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);
1073     goto ON_ERROR;
1074   }
1075
1076   InsertHeadList (&ArpQue->Frames, &Token->Link);
1077   InsertHeadList (&Interface->ArpQues, &ArpQue->Link);
1078   return EFI_SUCCESS;
1079
1080 SEND_NOW:
1081   //
1082   // Insert the tx token into the SentFrames list before calling Mnp->Transmit.
1083   // Remove it if the returned status is not EFI_SUCCESS.
1084   //
1085   InsertTailList (&Interface->SentFrames, &Token->Link);
1086   Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);
1087   if (EFI_ERROR (Status)) {
1088     RemoveEntryList (&Interface->SentFrames);
1089     goto ON_ERROR;
1090   }
1091
1092   return EFI_SUCCESS;
1093
1094 ON_ERROR:
1095   Ip4FreeLinkTxToken (Token);
1096   return Status;
1097 }
1098
1099
1100 /**
1101   Call back function when the received packet is freed.
1102   Check Ip4OnFrameReceived for information.
1103
1104   @param  Context          Context, which is the IP4_LINK_RX_TOKEN.
1105
1106 **/
1107 VOID
1108 EFIAPI
1109 Ip4RecycleFrame (
1110   IN VOID                   *Context
1111   )
1112 {
1113   IP4_LINK_RX_TOKEN         *Frame;
1114
1115   Frame = (IP4_LINK_RX_TOKEN *) Context;
1116   NET_CHECK_SIGNATURE (Frame, IP4_FRAME_RX_SIGNATURE);
1117
1118   gBS->SignalEvent (Frame->MnpToken.Packet.RxData->RecycleEvent);
1119   Ip4FreeFrameRxToken (Frame);
1120 }
1121
1122
1123 /**
1124   Received a frame from MNP, wrap it in net buffer then deliver
1125   it to IP's input function. The ownship of the packet also
1126   transferred to IP. When Ip is finished with this packet, it
1127   will call NetbufFree to release the packet, NetbufFree will
1128   again call the Ip4RecycleFrame to signal MNP's event and free
1129   the token used.
1130
1131   @param  Context               Context for the callback.
1132
1133 **/
1134 VOID
1135 EFIAPI
1136 Ip4OnFrameReceivedDpc (
1137   IN VOID                     *Context
1138   )
1139 {
1140   EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *MnpToken;
1141   EFI_MANAGED_NETWORK_RECEIVE_DATA      *MnpRxData;
1142   IP4_LINK_RX_TOKEN                     *Token;
1143   NET_FRAGMENT                          Netfrag;
1144   NET_BUF                               *Packet;
1145   UINT32                                Flag;
1146
1147   Token = (IP4_LINK_RX_TOKEN *) Context;
1148   NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE);
1149
1150   //
1151   // First clear the interface's receive request in case the
1152   // caller wants to call Ip4ReceiveFrame in the callback.
1153   //
1154   Token->Interface->RecvRequest = NULL;
1155
1156   MnpToken  = &Token->MnpToken;
1157   MnpRxData = MnpToken->Packet.RxData;
1158
1159   if (EFI_ERROR (MnpToken->Status) || (MnpRxData == NULL)) {
1160     Token->CallBack (Token->IpInstance, NULL, MnpToken->Status, 0, Token->Context);
1161     Ip4FreeFrameRxToken (Token);
1162
1163     return ;
1164   }
1165
1166   //
1167   // Wrap the frame in a net buffer then deliever it to IP input.
1168   // IP will reassemble the packet, and deliver it to upper layer
1169   //
1170   Netfrag.Len  = MnpRxData->DataLength;
1171   Netfrag.Bulk = MnpRxData->PacketData;
1172
1173   Packet = NetbufFromExt (&Netfrag, 1, 0, IP4_MAX_HEADLEN, Ip4RecycleFrame, Token);
1174
1175   if (Packet == NULL) {
1176     gBS->SignalEvent (MnpRxData->RecycleEvent);
1177
1178     Token->CallBack (Token->IpInstance, NULL, EFI_OUT_OF_RESOURCES, 0, Token->Context);
1179     Ip4FreeFrameRxToken (Token);
1180
1181     return ;
1182   }
1183
1184   Flag  = (MnpRxData->BroadcastFlag ? IP4_LINK_BROADCAST : 0);
1185   Flag |= (MnpRxData->MulticastFlag ? IP4_LINK_MULTICAST : 0);
1186   Flag |= (MnpRxData->PromiscuousFlag ? IP4_LINK_PROMISC : 0);
1187
1188   Token->CallBack (Token->IpInstance, Packet, EFI_SUCCESS, Flag, Token->Context);
1189 }
1190
1191 /**
1192   Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
1193
1194   @param Event      The receive event delivered to MNP for receive.
1195   @param Context    Context for the callback.
1196
1197 **/
1198 VOID
1199 EFIAPI
1200 Ip4OnFrameReceived (
1201   IN EFI_EVENT                Event,
1202   IN VOID                     *Context
1203   )
1204 {
1205   //
1206   // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK
1207   //
1208   QueueDpc (TPL_CALLBACK, Ip4OnFrameReceivedDpc, Context);
1209 }
1210
1211
1212 /**
1213   Request to receive the packet from the interface.
1214
1215   @param[in]  Interface         The interface to receive the frames from.
1216   @param[in]  IpInstance        The instance that requests the receive. NULL for
1217                                 the driver itself.
1218   @param[in]  CallBack          Function to call when receive finished.
1219   @param[in]  Context           Opaque parameter to the callback.
1220
1221   @retval EFI_ALREADY_STARTED   There is already a pending receive request.
1222   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to receive.
1223   @retval EFI_SUCCESS           The recieve request has been started.
1224   @retval other                 Other error occurs.
1225
1226 **/
1227 EFI_STATUS
1228 Ip4ReceiveFrame (
1229   IN  IP4_INTERFACE         *Interface,
1230   IN  IP4_PROTOCOL          *IpInstance       OPTIONAL,
1231   IN  IP4_FRAME_CALLBACK    CallBack,
1232   IN  VOID                  *Context
1233   )
1234 {
1235   IP4_LINK_RX_TOKEN *Token;
1236   EFI_STATUS        Status;
1237
1238   NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);
1239
1240   if (Interface->RecvRequest != NULL) {
1241     return EFI_ALREADY_STARTED;
1242   }
1243
1244   Token = Ip4CreateLinkRxToken (Interface, IpInstance, CallBack, Context);
1245
1246   if (Token == NULL) {
1247     return EFI_OUT_OF_RESOURCES;
1248   }
1249
1250   Interface->RecvRequest = Token;
1251   Status = Interface->Mnp->Receive (Interface->Mnp, &Token->MnpToken);
1252   if (EFI_ERROR (Status)) {
1253     Interface->RecvRequest = NULL;
1254     Ip4FreeFrameRxToken (Token);
1255     return Status;
1256   }
1257   return EFI_SUCCESS;
1258 }