MdeModulePkg/Universal/Network/Ip4Dxe/Ip4If.c

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