MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c

   1 /** @file
   2   Implement IP4 pesudo interface.
   3
   4 Copyright (c) 2005 - 2014, 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                      Type;
 564   INTN                      Len;
 565   IP4_ADDR                  Netmask;
 566
 567   NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);
 568
 569   ASSERT (!Interface->Configured);
 570
 571   //
 572   // Set the ip/netmask, then compute the subnet broadcast
 573   // and network broadcast for easy access. When computing
 574   // nework broadcast, the subnet mask is most like longer
 575   // than the default netmask (not subneted) as defined in
 576   // RFC793. If that isn't the case, we are aggregating the
 577   // networks, use the subnet's mask instead.
 578   //
 579   Interface->Ip             = IpAddr;
 580   Interface->SubnetMask     = SubnetMask;
 581   Interface->SubnetBrdcast  = (IpAddr | ~SubnetMask);
 582
 583   Type                      = NetGetIpClass (IpAddr);
 584   Len                       = NetGetMaskLength (SubnetMask);
 585   ASSERT (Len >= 1);
 586   Netmask                   = gIp4AllMasks[MIN ((Len - 1), Type << 3)];
 587   Interface->NetBrdcast     = (IpAddr | ~Netmask);
 588
 589   //
 590   // If the address is NOT all zero, create then configure an ARP child.
 591   // Pay attention: DHCP configures its station address as 0.0.0.0/0
 592   //
 593   Interface->Arp            = NULL;
 594   Interface->ArpHandle      = NULL;
 595
 596   if (IpAddr != IP4_ALLZERO_ADDRESS) {
 597     Status = NetLibCreateServiceChild (
 598                Interface->Controller,
 599                Interface->Image,
 600                &gEfiArpServiceBindingProtocolGuid,
 601                &Interface->ArpHandle
 602                );
 603
 604     if (EFI_ERROR (Status)) {
 605       return Status;;
 606     }
 607
 608     Status = gBS->OpenProtocol (
 609                     Interface->ArpHandle,
 610                     &gEfiArpProtocolGuid,
 611                     (VOID **) &Interface->Arp,
 612                     Interface->Image,
 613                     Interface->Controller,
 614                     EFI_OPEN_PROTOCOL_BY_DRIVER
 615                     );
 616
 617     if (EFI_ERROR (Status)) {
 618       goto ON_ERROR;
 619     }
 620
 621     IpAddr                    = HTONL (IpAddr);
 622     ArpConfig.SwAddressType   = IP4_ETHER_PROTO;
 623     ArpConfig.SwAddressLength = 4;
 624     ArpConfig.StationAddress  = &IpAddr;
 625     ArpConfig.EntryTimeOut    = 0;
 626     ArpConfig.RetryCount      = 0;
 627     ArpConfig.RetryTimeOut    = 0;
 628
 629     Status = Interface->Arp->Configure (Interface->Arp, &ArpConfig);
 630
 631     if (EFI_ERROR (Status)) {
 632       gBS->CloseProtocol (
 633             Interface->ArpHandle,
 634             &gEfiArpProtocolGuid,
 635             Interface->Image,
 636             Interface->Controller
 637             );
 638
 639       goto ON_ERROR;
 640     }
 641   }
 642
 643   Interface->Configured = TRUE;
 644   return EFI_SUCCESS;
 645
 646 ON_ERROR:
 647   NetLibDestroyServiceChild (
 648     Interface->Controller,
 649     Interface->Image,
 650     &gEfiArpServiceBindingProtocolGuid,
 651     &Interface->ArpHandle
 652     );
 653
 654   return Status;
 655 }
 656
 657
 658 /**
 659   Filter function to cancel all the frame related to an IP instance.
 660
 661   @param[in]  Frame             The transmit request to test whether to cancel
 662   @param[in]  Context           The context which is the Ip instance that issued
 663                                 the transmit.
 664
 665   @retval TRUE                  The frame belongs to this instance and is to be
 666                                 removed
 667   @retval FALSE                 The frame doesn't belong to this instance.
 668
 669 **/
 670 BOOLEAN
 671 Ip4CancelInstanceFrame (
 672   IN IP4_LINK_TX_TOKEN *Frame,
 673   IN VOID              *Context
 674   )
 675 {
 676   if (Frame->IpInstance == (IP4_PROTOCOL *) Context) {
 677     return TRUE;
 678   }
 679
 680   return FALSE;
 681 }
 682
 683
 684
 685 /**
 686   If there is a pending receive request, cancel it. Don't call
 687   the receive request's callback because this function can be only
 688   called if the instance or driver is tearing itself down. It
 689   doesn't make sense to call it back. But it is necessary to call
 690   the transmit token's callback to give it a chance to free the
 691   packet and update the upper layer's transmit request status, say
 692   that from the UDP.
 693
 694   @param[in]  Interface         The interface used by the IpInstance
 695
 696 **/
 697 VOID
 698 Ip4CancelReceive (
 699   IN IP4_INTERFACE          *Interface
 700   )
 701 {
 702   EFI_TPL                   OldTpl;
 703   IP4_LINK_RX_TOKEN         *Token;
 704
 705   if ((Token = Interface->RecvRequest) != NULL) {
 706     OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 707
 708     Interface->RecvRequest = NULL;
 709     Interface->Mnp->Cancel (Interface->Mnp, &Token->MnpToken);
 710
 711     gBS->RestoreTPL (OldTpl);
 712   }
 713 }
 714
 715
 716 /**
 717   Free the interface used by IpInstance. All the IP instance with
 718   the same Ip/Netmask pair share the same interface. It is reference
 719   counted. All the frames haven't been sent will be cancelled.
 720   Because the IpInstance is optional, the caller must remove
 721   IpInstance from the interface's instance list itself.
 722
 723   @param[in]  Interface         The interface used by the IpInstance
 724   @param[in]  IpInstance        The Ip instance that free the interface. NULL if
 725                                 the Ip driver is releasing the default interface.
 726
 727   @retval EFI_SUCCESS           The interface use IpInstance is freed.
 728
 729 **/
 730 EFI_STATUS
 731 Ip4FreeInterface (
 732   IN  IP4_INTERFACE         *Interface,
 733   IN  IP4_PROTOCOL          *IpInstance           OPTIONAL
 734   )
 735 {
 736   NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);
 737   ASSERT (Interface->RefCnt > 0);
 738
 739   //
 740   // Remove all the pending transmit token related to this IP instance.
 741   //
 742   Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, IpInstance);
 743
 744   if (--Interface->RefCnt > 0) {
 745     return EFI_SUCCESS;
 746   }
 747
 748   //
 749   // Destroy the interface if this is the last IP instance that
 750   // has the address. Remove all the system transmitted packets
 751   // from this interface, cancel the receive request if there is
 752   // one, and destroy the ARP requests.
 753   //
 754   Ip4CancelFrames (Interface, EFI_ABORTED, Ip4CancelInstanceFrame, NULL);
 755   Ip4CancelReceive (Interface);
 756
 757   ASSERT (IsListEmpty (&Interface->IpInstances));
 758   ASSERT (IsListEmpty (&Interface->ArpQues));
 759   ASSERT (IsListEmpty (&Interface->SentFrames));
 760
 761   if (Interface->Arp != NULL) {
 762     gBS->CloseProtocol (
 763           Interface->ArpHandle,
 764           &gEfiArpProtocolGuid,
 765           Interface->Image,
 766           Interface->Controller
 767           );
 768
 769     NetLibDestroyServiceChild (
 770       Interface->Controller,
 771       Interface->Image,
 772       &gEfiArpServiceBindingProtocolGuid,
 773       Interface->ArpHandle
 774       );
 775   }
 776
 777   RemoveEntryList (&Interface->Link);
 778   FreePool (Interface);
 779
 780   return EFI_SUCCESS;
 781 }
 782
 783
 784 /**
 785   Callback function when ARP request are finished. It will cancelled
 786   all the queued frame if the ARP requests failed. Or transmit them
 787   if the request succeed.
 788
 789   @param[in]  Context           The context of the callback, a point to the ARP
 790                                 queue
 791
 792 **/
 793 VOID
 794 EFIAPI
 795 Ip4OnArpResolvedDpc (
 796   IN VOID                   *Context
 797   )
 798 {
 799   LIST_ENTRY                *Entry;
 800   LIST_ENTRY                *Next;
 801   IP4_ARP_QUE               *ArpQue;
 802   IP4_INTERFACE             *Interface;
 803   IP4_LINK_TX_TOKEN         *Token;
 804   EFI_STATUS                Status;
 805
 806   ArpQue = (IP4_ARP_QUE *) Context;
 807   NET_CHECK_SIGNATURE (ArpQue, IP4_FRAME_ARP_SIGNATURE);
 808
 809   RemoveEntryList (&ArpQue->Link);
 810
 811   //
 812   // ARP resolve failed for some reason. Release all the frame
 813   // and ARP queue itself. Ip4FreeArpQue will call the frame's
 814   // owner back.
 815   //
 816   if (NET_MAC_EQUAL (&ArpQue->Mac, &mZeroMacAddress, ArpQue->Interface->HwaddrLen)) {
 817     Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);
 818
 819     return ;
 820   }
 821
 822   //
 823   // ARP resolve succeeded, Transmit all the frame. Release the ARP
 824   // queue. It isn't necessary for us to cache the ARP binding because
 825   // we always check the ARP cache first before transmit.
 826   //
 827   Interface = ArpQue->Interface;
 828
 829   NET_LIST_FOR_EACH_SAFE (Entry, Next, &ArpQue->Frames) {
 830     RemoveEntryList (Entry);
 831
 832     Token         = NET_LIST_USER_STRUCT (Entry, IP4_LINK_TX_TOKEN, Link);
 833     CopyMem (&Token->DstMac, &ArpQue->Mac, sizeof (Token->DstMac));
 834
 835     //
 836     // Insert the tx token before transmitting it via MNP as the FrameSentDpc
 837     // may be called before Mnp->Transmit returns which will remove this tx
 838     // token from the SentFrames list. Remove it from the list if the returned
 839     // Status of Mnp->Transmit is not EFI_SUCCESS as in this case the
 840     // FrameSentDpc won't be queued.
 841     //
 842     InsertTailList (&Interface->SentFrames, &Token->Link);
 843
 844     Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);
 845     if (EFI_ERROR (Status)) {
 846       RemoveEntryList (Entry);
 847       Token->CallBack (Token->IpInstance, Token->Packet, Status, 0, Token->Context);
 848
 849       Ip4FreeLinkTxToken (Token);
 850       continue;
 851     }
 852   }
 853
 854   Ip4FreeArpQue (ArpQue, EFI_SUCCESS);
 855 }
 856
 857 /**
 858   Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK.
 859
 860   @param  Event             The Arp request event.
 861   @param  Context           The context of the callback, a point to the ARP
 862                             queue.
 863
 864 **/
 865 VOID
 866 EFIAPI
 867 Ip4OnArpResolved (
 868   IN EFI_EVENT              Event,
 869   IN VOID                   *Context
 870   )
 871 {
 872   //
 873   // Request Ip4OnArpResolvedDpc as a DPC at TPL_CALLBACK
 874   //
 875   QueueDpc (TPL_CALLBACK, Ip4OnArpResolvedDpc, Context);
 876 }
 877
 878
 879
 880 /**
 881   Callback funtion when frame transmission is finished. It will
 882   call the frame owner's callback function to tell it the result.
 883
 884   @param[in]  Context            Context which is point to the token.
 885
 886 **/
 887 VOID
 888 EFIAPI
 889 Ip4OnFrameSentDpc (
 890   IN VOID                    *Context
 891   )
 892 {
 893   IP4_LINK_TX_TOKEN         *Token;
 894
 895   Token = (IP4_LINK_TX_TOKEN *) Context;
 896   NET_CHECK_SIGNATURE (Token, IP4_FRAME_TX_SIGNATURE);
 897
 898   RemoveEntryList (&Token->Link);
 899
 900   Token->CallBack (
 901           Token->IpInstance,
 902           Token->Packet,
 903           Token->MnpToken.Status,
 904           0,
 905           Token->Context
 906           );
 907
 908   Ip4FreeLinkTxToken (Token);
 909 }
 910
 911 /**
 912   Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK.
 913
 914   @param[in]  Event              The transmit token's event.
 915   @param[in]  Context            Context which is point to the token.
 916
 917 **/
 918 VOID
 919 EFIAPI
 920 Ip4OnFrameSent (
 921   IN EFI_EVENT               Event,
 922   IN VOID                    *Context
 923   )
 924 {
 925   //
 926   // Request Ip4OnFrameSentDpc as a DPC at TPL_CALLBACK
 927   //
 928   QueueDpc (TPL_CALLBACK, Ip4OnFrameSentDpc, Context);
 929 }
 930
 931
 932
 933 /**
 934   Send a frame from the interface. If the next hop is broadcast or
 935   multicast address, it is transmitted immediately. If the next hop
 936   is a unicast, it will consult ARP to resolve the NextHop's MAC.
 937   If some error happened, the CallBack won't be called. So, the caller
 938   must test the return value, and take action when there is an error.
 939
 940   @param[in]  Interface         The interface to send the frame from
 941   @param[in]  IpInstance        The IP child that request the transmission.  NULL
 942                                 if it is the IP4 driver itself.
 943   @param[in]  Packet            The packet to transmit.
 944   @param[in]  NextHop           The immediate destination to transmit the packet
 945                                 to.
 946   @param[in]  CallBack          Function to call back when transmit finished.
 947   @param[in]  Context           Opaque parameter to the call back.
 948
 949   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to send the frame
 950   @retval EFI_NO_MAPPING        Can't resolve the MAC for the nexthop
 951   @retval EFI_SUCCESS           The packet is successfully transmitted.
 952   @retval other                 Other error occurs.
 953
 954 **/
 955 EFI_STATUS
 956 Ip4SendFrame (
 957   IN  IP4_INTERFACE         *Interface,
 958   IN  IP4_PROTOCOL          *IpInstance       OPTIONAL,
 959   IN  NET_BUF               *Packet,
 960   IN  IP4_ADDR              NextHop,
 961   IN  IP4_FRAME_CALLBACK    CallBack,
 962   IN  VOID                  *Context
 963   )
 964 {
 965   IP4_LINK_TX_TOKEN         *Token;
 966   LIST_ENTRY                *Entry;
 967   IP4_ARP_QUE               *ArpQue;
 968   EFI_ARP_PROTOCOL          *Arp;
 969   EFI_STATUS                Status;
 970
 971   ASSERT (Interface->Configured);
 972
 973   Token = Ip4WrapLinkTxToken (Interface, IpInstance, Packet, CallBack, Context);
 974
 975   if (Token == NULL) {
 976     return EFI_OUT_OF_RESOURCES;
 977   }
 978
 979   //
 980   // Get the destination MAC address for multicast and broadcasts.
 981   // Don't depend on ARP to solve the address since there maybe no
 982   // ARP at all. Ip4Output has set NextHop to 255.255.255.255 for
 983   // all the broadcasts.
 984   //
 985   if (NextHop == IP4_ALLONE_ADDRESS) {
 986     CopyMem (&Token->DstMac, &Interface->BroadcastMac, sizeof (Token->DstMac));
 987     goto SEND_NOW;
 988
 989   } else if (IP4_IS_MULTICAST (NextHop)) {
 990
 991     Status = Ip4GetMulticastMac (Interface->Mnp, NextHop, &Token->DstMac);
 992
 993     if (EFI_ERROR (Status)) {
 994       goto ON_ERROR;
 995     }
 996
 997     goto SEND_NOW;
 998   }
 999
1000   //
1001   // Can only send out multicast/broadcast if the IP address is zero
1002   //
1003   if ((Arp = Interface->Arp) == NULL) {
1004     Status = EFI_NO_MAPPING;
1005     goto ON_ERROR;
1006   }
1007
1008   //
1009   // First check whether this binding is in the ARP cache.
1010   //
1011   NextHop = HTONL (NextHop);
1012   Status  = Arp->Request (Arp, &NextHop, NULL, &Token->DstMac);
1013
1014   if (Status == EFI_SUCCESS) {
1015     goto SEND_NOW;
1016
1017   } else if (Status != EFI_NOT_READY) {
1018     goto ON_ERROR;
1019   }
1020
1021   //
1022   // Have to do asynchronous ARP resolution. First check
1023   // whether there is already a pending request.
1024   //
1025   ArpQue = NULL;
1026
1027   NET_LIST_FOR_EACH (Entry, &Interface->ArpQues) {
1028     ArpQue = NET_LIST_USER_STRUCT (Entry, IP4_ARP_QUE, Link);
1029
1030     if (ArpQue->Ip == NextHop) {
1031       break;
1032     }
1033   }
1034
1035   //
1036   // Found a pending ARP request, enqueue the frame then return
1037   //
1038   if (Entry != &Interface->ArpQues) {
1039     InsertTailList (&ArpQue->Frames, &Token->Link);
1040     return EFI_SUCCESS;
1041   }
1042
1043   //
1044   // First frame to NextHop, issue an asynchronous ARP requests
1045   //
1046   ArpQue = Ip4CreateArpQue (Interface, NextHop);
1047
1048   if (ArpQue == NULL) {
1049     Status = EFI_OUT_OF_RESOURCES;
1050     goto ON_ERROR;
1051   }
1052
1053   Status = Arp->Request (Arp, &ArpQue->Ip, ArpQue->OnResolved, ArpQue->Mac.Addr);
1054
1055   if (EFI_ERROR (Status) && (Status != EFI_NOT_READY)) {
1056     Ip4FreeArpQue (ArpQue, EFI_NO_MAPPING);
1057     goto ON_ERROR;
1058   }
1059
1060   InsertHeadList (&ArpQue->Frames, &Token->Link);
1061   InsertHeadList (&Interface->ArpQues, &ArpQue->Link);
1062   return EFI_SUCCESS;
1063
1064 SEND_NOW:
1065   //
1066   // Insert the tx token into the SentFrames list before calling Mnp->Transmit.
1067   // Remove it if the returned status is not EFI_SUCCESS.
1068   //
1069   InsertTailList (&Interface->SentFrames, &Token->Link);
1070   Status = Interface->Mnp->Transmit (Interface->Mnp, &Token->MnpToken);
1071   if (EFI_ERROR (Status)) {
1072     RemoveEntryList (&Interface->SentFrames);
1073     goto ON_ERROR;
1074   }
1075
1076   return EFI_SUCCESS;
1077
1078 ON_ERROR:
1079   Ip4FreeLinkTxToken (Token);
1080   return Status;
1081 }
1082
1083
1084 /**
1085   Call back function when the received packet is freed.
1086   Check Ip4OnFrameReceived for information.
1087
1088   @param  Context          Context, which is the IP4_LINK_RX_TOKEN.
1089
1090 **/
1091 VOID
1092 EFIAPI
1093 Ip4RecycleFrame (
1094   IN VOID                   *Context
1095   )
1096 {
1097   IP4_LINK_RX_TOKEN         *Frame;
1098
1099   Frame = (IP4_LINK_RX_TOKEN *) Context;
1100   NET_CHECK_SIGNATURE (Frame, IP4_FRAME_RX_SIGNATURE);
1101
1102   gBS->SignalEvent (Frame->MnpToken.Packet.RxData->RecycleEvent);
1103   Ip4FreeFrameRxToken (Frame);
1104 }
1105
1106
1107 /**
1108   Received a frame from MNP, wrap it in net buffer then deliver
1109   it to IP's input function. The ownship of the packet also
1110   transferred to IP. When Ip is finished with this packet, it
1111   will call NetbufFree to release the packet, NetbufFree will
1112   again call the Ip4RecycleFrame to signal MNP's event and free
1113   the token used.
1114
1115   @param  Context               Context for the callback.
1116
1117 **/
1118 VOID
1119 EFIAPI
1120 Ip4OnFrameReceivedDpc (
1121   IN VOID                     *Context
1122   )
1123 {
1124   EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *MnpToken;
1125   EFI_MANAGED_NETWORK_RECEIVE_DATA      *MnpRxData;
1126   IP4_LINK_RX_TOKEN                     *Token;
1127   NET_FRAGMENT                          Netfrag;
1128   NET_BUF                               *Packet;
1129   UINT32                                Flag;
1130
1131   Token = (IP4_LINK_RX_TOKEN *) Context;
1132   NET_CHECK_SIGNATURE (Token, IP4_FRAME_RX_SIGNATURE);
1133
1134   //
1135   // First clear the interface's receive request in case the
1136   // caller wants to call Ip4ReceiveFrame in the callback.
1137   //
1138   Token->Interface->RecvRequest = NULL;
1139
1140   MnpToken  = &Token->MnpToken;
1141   MnpRxData = MnpToken->Packet.RxData;
1142
1143   if (EFI_ERROR (MnpToken->Status) || (MnpRxData == NULL)) {
1144     Token->CallBack (Token->IpInstance, NULL, MnpToken->Status, 0, Token->Context);
1145     Ip4FreeFrameRxToken (Token);
1146
1147     return ;
1148   }
1149
1150   //
1151   // Wrap the frame in a net buffer then deliever it to IP input.
1152   // IP will reassemble the packet, and deliver it to upper layer
1153   //
1154   Netfrag.Len  = MnpRxData->DataLength;
1155   Netfrag.Bulk = MnpRxData->PacketData;
1156
1157   Packet = NetbufFromExt (&Netfrag, 1, 0, IP4_MAX_HEADLEN, Ip4RecycleFrame, Token);
1158
1159   if (Packet == NULL) {
1160     gBS->SignalEvent (MnpRxData->RecycleEvent);
1161
1162     Token->CallBack (Token->IpInstance, NULL, EFI_OUT_OF_RESOURCES, 0, Token->Context);
1163     Ip4FreeFrameRxToken (Token);
1164
1165     return ;
1166   }
1167
1168   Flag  = (MnpRxData->BroadcastFlag ? IP4_LINK_BROADCAST : 0);
1169   Flag |= (MnpRxData->MulticastFlag ? IP4_LINK_MULTICAST : 0);
1170   Flag |= (MnpRxData->PromiscuousFlag ? IP4_LINK_PROMISC : 0);
1171
1172   Token->CallBack (Token->IpInstance, Packet, EFI_SUCCESS, Flag, Token->Context);
1173 }
1174
1175 /**
1176   Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK.
1177
1178   @param Event      The receive event delivered to MNP for receive.
1179   @param Context    Context for the callback.
1180
1181 **/
1182 VOID
1183 EFIAPI
1184 Ip4OnFrameReceived (
1185   IN EFI_EVENT                Event,
1186   IN VOID                     *Context
1187   )
1188 {
1189   //
1190   // Request Ip4OnFrameReceivedDpc as a DPC at TPL_CALLBACK
1191   //
1192   QueueDpc (TPL_CALLBACK, Ip4OnFrameReceivedDpc, Context);
1193 }
1194
1195
1196 /**
1197   Request to receive the packet from the interface.
1198
1199   @param[in]  Interface         The interface to receive the frames from
1200   @param[in]  IpInstance        The instance that requests the receive. NULL for
1201                                 the driver itself.
1202   @param[in]  CallBack          Function to call when receive finished.
1203   @param[in]  Context           Opaque parameter to the callback
1204
1205   @retval EFI_ALREADY_STARTED   There is already a pending receive request.
1206   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resource to receive
1207   @retval EFI_SUCCESS           The recieve request has been started.
1208   @retval other                 Other error occurs.
1209
1210 **/
1211 EFI_STATUS
1212 Ip4ReceiveFrame (
1213   IN  IP4_INTERFACE         *Interface,
1214   IN  IP4_PROTOCOL          *IpInstance       OPTIONAL,
1215   IN  IP4_FRAME_CALLBACK    CallBack,
1216   IN  VOID                  *Context
1217   )
1218 {
1219   IP4_LINK_RX_TOKEN *Token;
1220   EFI_STATUS        Status;
1221
1222   NET_CHECK_SIGNATURE (Interface, IP4_INTERFACE_SIGNATURE);
1223
1224   if (Interface->RecvRequest != NULL) {
1225     return EFI_ALREADY_STARTED;
1226   }
1227
1228   Token = Ip4CreateLinkRxToken (Interface, IpInstance, CallBack, Context);
1229
1230   if (Token == NULL) {
1231     return EFI_OUT_OF_RESOURCES;
1232   }
1233
1234   Interface->RecvRequest = Token;
1235   Status = Interface->Mnp->Receive (Interface->Mnp, &Token->MnpToken);
1236   if (EFI_ERROR (Status)) {
1237     Interface->RecvRequest = NULL;
1238     Ip4FreeFrameRxToken (Token);
1239     return Status;
1240   }
1241   return EFI_SUCCESS;
1242 }