MdeModulePkg/Universal/Network/MnpDxe/MnpMain.c

   1 /** @file
   2   Implementation of Managed Network Protocol public services.
   3
   4 Copyright (c) 2005 - 2009, Intel Corporation. <BR>
   5 All rights reserved. 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 "MnpImpl.h"
  16
  17 /**
  18   Returns the operational parameters for the current MNP child driver. May also
  19   support returning the underlying SNP driver mode data.
  20
  21   The GetModeData() function is used to read the current mode data (operational
  22   parameters) from the MNP or the underlying SNP.
  23
  24   @param[in]  This          Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
  25   @param[out] MnpConfigData Pointer to storage for MNP operational parameters. Type
  26                             EFI_MANAGED_NETWORK_CONFIG_DATA is defined in "Related
  27                             Definitions" below.
  28   @param[out] SnpModeData   Pointer to storage for SNP operational parameters. This
  29                             feature may be unsupported. Type EFI_SIMPLE_NETWORK_MODE
  30                             is defined in the EFI_SIMPLE_NETWORK_PROTOCOL.
  31
  32   @retval EFI_SUCCESS           The operation completed successfully.
  33   @retval EFI_INVALID_PARAMETER This is NULL.
  34   @retval EFI_UNSUPPORTED       The requested feature is unsupported in this
  35                                 MNP implementation.
  36   @retval EFI_NOT_STARTED       This MNP child driver instance has not been
  37                                 configured. The default values are returned in
  38                                 MnpConfigData if it is not NULL.
  39   @retval Others                The mode data could not be read.
  40
  41 **/
  42 EFI_STATUS
  43 EFIAPI
  44 MnpGetModeData (
  45   IN  EFI_MANAGED_NETWORK_PROTOCOL     *This,
  46   OUT EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData, OPTIONAL
  47   OUT EFI_SIMPLE_NETWORK_MODE          *SnpModeData    OPTIONAL
  48   )
  49 {
  50   MNP_INSTANCE_DATA           *Instance;
  51   EFI_SIMPLE_NETWORK_PROTOCOL *Snp;
  52   EFI_TPL                     OldTpl;
  53   EFI_STATUS                  Status;
  54
  55   if (This == NULL) {
  56
  57     return EFI_INVALID_PARAMETER;
  58   }
  59
  60   Instance = MNP_INSTANCE_DATA_FROM_THIS (This);
  61
  62   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
  63
  64   if (MnpConfigData != NULL) {
  65     //
  66     // Copy the instance configuration data.
  67     //
  68     CopyMem (MnpConfigData, &Instance->ConfigData, sizeof (*MnpConfigData));
  69   }
  70
  71   if (SnpModeData != NULL) {
  72     //
  73     // Copy the underlayer Snp mode data.
  74     //
  75     Snp = Instance->MnpServiceData->Snp;
  76     CopyMem (SnpModeData, Snp->Mode, sizeof (*SnpModeData));
  77   }
  78
  79   if (!Instance->Configured) {
  80     Status = EFI_NOT_STARTED;
  81   } else {
  82     Status = EFI_SUCCESS;
  83   }
  84
  85   gBS->RestoreTPL (OldTpl);
  86
  87   return Status;
  88 }
  89
  90
  91 /**
  92   Sets or clears the operational parameters for the MNP child driver.
  93
  94   The Configure() function is used to set, change, or reset the operational
  95   parameters for the MNP child driver instance. Until the operational parameters
  96   have been set, no network traffic can be sent or received by this MNP child
  97   driver instance. Once the operational parameters have been reset, no more
  98   traffic can be sent or received until the operational parameters have been set
  99   again.
 100   Each MNP child driver instance can be started and stopped independently of
 101   each other by setting or resetting their receive filter settings with the
 102   Configure() function.
 103   After any successful call to Configure(), the MNP child driver instance is
 104   started. The internal periodic timer (if supported) is enabled. Data can be
 105   transmitted and may be received if the receive filters have also been enabled.
 106   Note: If multiple MNP child driver instances will receive the same packet
 107   because of overlapping receive filter settings, then the first MNP child
 108   driver instance will receive the original packet and additional instances will
 109   receive copies of the original packet.
 110   Note: Warning: Receive filter settings that overlap will consume extra
 111   processor and/or DMA resources and degrade system and network performance.
 112
 113   @param[in]  This           Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
 114   @param[in]  MnpConfigData  Pointer to configuration data that will be assigned
 115                              to the MNP child driver instance. If NULL, the MNP
 116                              child driver instance is reset to startup defaults
 117                              and all pending transmit and receive requests are
 118                              flushed. Type EFI_MANAGED_NETWORK_CONFIG_DATA is
 119                              defined in EFI_MANAGED_NETWORK_PROTOCOL.GetModeData().
 120
 121   @retval EFI_SUCCESS            The operation completed successfully.
 122   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is
 123                                  TRUE:
 124                                  * This is NULL.
 125                                  * MnpConfigData.ProtocolTypeFilter is not
 126                                    valid.
 127                                  The operational data for the MNP child driver
 128                                  instance is unchanged.
 129   @retval EFI_OUT_OF_RESOURCES   Required system resources (usually memory)
 130                                  could not be allocated.
 131                                  The MNP child driver instance has been reset to
 132                                  startup defaults.
 133   @retval EFI_UNSUPPORTED        The requested feature is unsupported in
 134                                  this [MNP] implementation. The operational data
 135                                  for the MNP child driver instance is unchanged.
 136   @retval EFI_DEVICE_ERROR       An unexpected network or system error
 137                                  occurred. The MNP child driver instance has
 138                                  been reset to startup defaults.
 139   @retval Others                 The MNP child driver instance has been reset to
 140                                  startup defaults.
 141
 142 **/
 143 EFI_STATUS
 144 EFIAPI
 145 MnpConfigure (
 146   IN EFI_MANAGED_NETWORK_PROTOCOL     *This,
 147   IN EFI_MANAGED_NETWORK_CONFIG_DATA  *MnpConfigData OPTIONAL
 148   )
 149 {
 150   MNP_INSTANCE_DATA  *Instance;
 151   EFI_TPL            OldTpl;
 152   EFI_STATUS         Status;
 153
 154   if ((This == NULL) ||
 155     ((MnpConfigData != NULL) &&
 156     (MnpConfigData->ProtocolTypeFilter > 0) &&
 157     (MnpConfigData->ProtocolTypeFilter <= 1500))) {
 158
 159     return EFI_INVALID_PARAMETER;
 160   }
 161
 162   Instance = MNP_INSTANCE_DATA_FROM_THIS (This);
 163
 164   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 165
 166   if ((MnpConfigData == NULL) && (!Instance->Configured)) {
 167     //
 168     // If the instance is not configured and a reset is requested, just return.
 169     //
 170     Status = EFI_SUCCESS;
 171     goto ON_EXIT;
 172   }
 173
 174   //
 175   // Configure the instance.
 176   //
 177   Status = MnpConfigureInstance (Instance, MnpConfigData);
 178
 179 ON_EXIT:
 180   gBS->RestoreTPL (OldTpl);
 181
 182   return Status;
 183 }
 184
 185
 186 /**
 187   Translates an IP multicast address to a hardware (MAC) multicast address. This
 188   function may be unsupported in some MNP implementations.
 189
 190   The McastIpToMac() function translates an IP multicast address to a hardware
 191   (MAC) multicast address. This function may be implemented by calling the
 192   underlying EFI_SIMPLE_NETWORK. MCastIpToMac() function, which may also be
 193   unsupported in some MNP implementations.
 194
 195   @param[in]  This        Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
 196   @param[in]  Ipv6Flag    Set to TRUE to if IpAddress is an IPv6 multicast address.
 197                           Set to FALSE if IpAddress is an IPv4 multicast address.
 198   @param[in]  IpAddress   Pointer to the multicast IP address (in network byte
 199                           order) to convert.
 200   @param[out] MacAddress  Pointer to the resulting multicast MAC address.
 201
 202   @retval EFI_SUCCESS           The operation completed successfully.
 203   @retval EFI_INVALID_PARAMETER One of the following conditions is TRUE:
 204                                  * This is NULL.
 205                                  * IpAddress is NULL.
 206                                  * IpAddress is not a valid multicast IP
 207                                    address.
 208                                  * MacAddress is NULL.
 209   @retval EFI_NOT_STARTED       This MNP child driver instance has not been
 210                                 configured.
 211   @retval EFI_UNSUPPORTED       The requested feature is unsupported in this
 212                                 MNP implementation.
 213   @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred.
 214   @retval Others                The address could not be converted.
 215 **/
 216 EFI_STATUS
 217 EFIAPI
 218 MnpMcastIpToMac (
 219   IN  EFI_MANAGED_NETWORK_PROTOCOL  *This,
 220   IN  BOOLEAN                       Ipv6Flag,
 221   IN  EFI_IP_ADDRESS                *IpAddress,
 222   OUT EFI_MAC_ADDRESS               *MacAddress
 223   )
 224 {
 225   EFI_STATUS                  Status;
 226   MNP_INSTANCE_DATA           *Instance;
 227   EFI_SIMPLE_NETWORK_PROTOCOL *Snp;
 228   EFI_TPL                     OldTpl;
 229   EFI_IPv6_ADDRESS            *Ip6Address;
 230
 231   if ((This == NULL) || (IpAddress == NULL) || (MacAddress == NULL)) {
 232
 233     return EFI_INVALID_PARAMETER;
 234   }
 235
 236   Ip6Address = &IpAddress->v6;
 237
 238   if ((Ipv6Flag && !IP6_IS_MULTICAST (Ip6Address)) ||
 239       (!Ipv6Flag && !IP4_IS_MULTICAST (EFI_NTOHL (*IpAddress)))
 240       ) {
 241     //
 242     // The IP address passed in is not a multicast address.
 243     //
 244     return EFI_INVALID_PARAMETER;
 245   }
 246
 247   Instance = MNP_INSTANCE_DATA_FROM_THIS (This);
 248
 249   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 250
 251   if (!Instance->Configured) {
 252
 253     Status = EFI_NOT_STARTED;
 254     goto ON_EXIT;
 255   }
 256
 257   Snp = Instance->MnpServiceData->Snp;
 258   ASSERT (Snp != NULL);
 259
 260   ZeroMem (MacAddress, sizeof (EFI_MAC_ADDRESS));
 261
 262   if (Snp->Mode->IfType == NET_IFTYPE_ETHERNET) {
 263     if (!Ipv6Flag) {
 264       //
 265       // Translate the IPv4 address into a multicast MAC address if the NIC is an
 266       // ethernet NIC according to RFC1112..
 267       //
 268       MacAddress->Addr[0] = 0x01;
 269       MacAddress->Addr[1] = 0x00;
 270       MacAddress->Addr[2] = 0x5E;
 271       MacAddress->Addr[3] = (UINT8) (IpAddress->v4.Addr[1] & 0x7F);
 272       MacAddress->Addr[4] = IpAddress->v4.Addr[2];
 273       MacAddress->Addr[5] = IpAddress->v4.Addr[3];
 274     } else {
 275       //
 276       // Translate the IPv6 address into a multicast MAC address if the NIC is an
 277       // ethernet NIC according to RFC2464.
 278       //
 279
 280       MacAddress->Addr[0] = 0x33;
 281       MacAddress->Addr[1] = 0x33;
 282       MacAddress->Addr[2] = Ip6Address->Addr[12];
 283       MacAddress->Addr[3] = Ip6Address->Addr[13];
 284       MacAddress->Addr[4] = Ip6Address->Addr[14];
 285       MacAddress->Addr[5] = Ip6Address->Addr[15];
 286     }
 287
 288     Status = EFI_SUCCESS;
 289   } else {
 290     //
 291     // Invoke Snp to translate the multicast IP address.
 292     //
 293     Status = Snp->MCastIpToMac (
 294                     Snp,
 295                     Ipv6Flag,
 296                     IpAddress,
 297                     MacAddress
 298                     );
 299   }
 300
 301 ON_EXIT:
 302   gBS->RestoreTPL (OldTpl);
 303
 304   return Status;
 305 }
 306
 307 /**
 308   Enables and disables receive filters for multicast address. This function may
 309   be unsupported in some MNP implementations.
 310
 311   The Groups() function only adds and removes multicast MAC addresses from the
 312   filter list. The MNP driver does not transmit or process Internet Group
 313   Management Protocol (IGMP) packets. If JoinFlag is FALSE and MacAddress is
 314   NULL, then all joined groups are left.
 315
 316   @param[in]  This        Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
 317   @param[in]  JoinFlag    Set to TRUE to join this multicast group.
 318                           Set to FALSE to leave this multicast group.
 319   @param[in]  MacAddress  Pointer to the multicast MAC group (address) to join or
 320                           leave.
 321
 322   @retval EFI_SUCCESS           The requested operation completed successfully.
 323   @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
 324                                 * This is NULL.
 325                                 * JoinFlag is TRUE and MacAddress is NULL.
 326                                 * MacAddress is not a valid multicast MAC
 327                                   address.
 328                                 * The MNP multicast group settings are
 329                                   unchanged.
 330   @retval EFI_NOT_STARTED       This MNP child driver instance has not been
 331                                 configured.
 332   @retval EFI_ALREADY_STARTED   The supplied multicast group is already joined.
 333   @retval EFI_NOT_FOUND         The supplied multicast group is not joined.
 334   @retval EFI_DEVICE_ERROR      An unexpected network or system error occurred.
 335                                 The MNP child driver instance has been reset to
 336                                 startup defaults.
 337   @retval EFI_UNSUPPORTED       The requested feature is unsupported in this MNP
 338                                 implementation.
 339   @retval Others                The requested operation could not be completed.
 340                                 The MNP multicast group settings are unchanged.
 341
 342 **/
 343 EFI_STATUS
 344 EFIAPI
 345 MnpGroups (
 346   IN EFI_MANAGED_NETWORK_PROTOCOL  *This,
 347   IN BOOLEAN                       JoinFlag,
 348   IN EFI_MAC_ADDRESS               *MacAddress OPTIONAL
 349   )
 350 {
 351   MNP_INSTANCE_DATA       *Instance;
 352   EFI_SIMPLE_NETWORK_MODE *SnpMode;
 353   MNP_GROUP_CONTROL_BLOCK *GroupCtrlBlk;
 354   MNP_GROUP_ADDRESS       *GroupAddress;
 355   LIST_ENTRY              *ListEntry;
 356   BOOLEAN                 AddressExist;
 357   EFI_TPL                 OldTpl;
 358   EFI_STATUS              Status;
 359
 360   if (This == NULL || (JoinFlag && (MacAddress == NULL))) {
 361     //
 362     // This is NULL, or it's a join operation but MacAddress is NULL.
 363     //
 364     return EFI_INVALID_PARAMETER;
 365   }
 366
 367   Instance  = MNP_INSTANCE_DATA_FROM_THIS (This);
 368   SnpMode   = Instance->MnpServiceData->Snp->Mode;
 369
 370   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 371
 372   if (!Instance->Configured) {
 373
 374     Status = EFI_NOT_STARTED;
 375     goto ON_EXIT;
 376   }
 377
 378   if ((!Instance->ConfigData.EnableMulticastReceive) ||
 379     ((MacAddress != NULL) && !NET_MAC_IS_MULTICAST (MacAddress, &SnpMode->BroadcastAddress, SnpMode->HwAddressSize))) {
 380     //
 381     // The instance isn't configured to do mulitcast receive. OR
 382     // the passed in MacAddress is not a mutlticast mac address.
 383     //
 384     Status = EFI_INVALID_PARAMETER;
 385     goto ON_EXIT;
 386   }
 387
 388   Status       = EFI_SUCCESS;
 389   AddressExist = FALSE;
 390   GroupCtrlBlk = NULL;
 391
 392   if (MacAddress != NULL) {
 393     //
 394     // Search the instance's GroupCtrlBlkList to find the specific address.
 395     //
 396     NET_LIST_FOR_EACH (ListEntry, &Instance->GroupCtrlBlkList) {
 397
 398       GroupCtrlBlk = NET_LIST_USER_STRUCT (
 399                       ListEntry,
 400                       MNP_GROUP_CONTROL_BLOCK,
 401                       CtrlBlkEntry
 402                       );
 403       GroupAddress = GroupCtrlBlk->GroupAddress;
 404       if (0 == CompareMem (
 405                 MacAddress,
 406                 &GroupAddress->Address,
 407                 SnpMode->HwAddressSize
 408                 )) {
 409         //
 410         // There is already the same multicast mac address configured.
 411         //
 412         AddressExist = TRUE;
 413         break;
 414       }
 415     }
 416
 417     if (JoinFlag && AddressExist) {
 418       //
 419       // The multicast mac address to join already exists.
 420       //
 421       Status = EFI_ALREADY_STARTED;
 422     }
 423
 424     if (!JoinFlag && !AddressExist) {
 425       //
 426       // The multicast mac address to leave doesn't exist in this instance.
 427       //
 428       Status = EFI_NOT_FOUND;
 429     }
 430
 431     if (EFI_ERROR (Status)) {
 432       goto ON_EXIT;
 433     }
 434   } else if (IsListEmpty (&Instance->GroupCtrlBlkList)) {
 435     //
 436     // The MacAddress is NULL and there is no configured multicast mac address,
 437     // just return.
 438     //
 439     goto ON_EXIT;
 440   }
 441
 442   //
 443   // OK, it is time to take action.
 444   //
 445   Status = MnpGroupOp (Instance, JoinFlag, MacAddress, GroupCtrlBlk);
 446
 447 ON_EXIT:
 448   gBS->RestoreTPL (OldTpl);
 449
 450   return Status;
 451 }
 452
 453 /**
 454   Places asynchronous outgoing data packets into the transmit queue.
 455
 456   The Transmit() function places a completion token into the transmit packet
 457   queue. This function is always asynchronous.
 458   The caller must fill in the Token.Event and Token.TxData fields in the
 459   completion token, and these fields cannot be NULL. When the transmit operation
 460   completes, the MNP updates the Token.Status field and the Token.Event is
 461   signaled.
 462   Note: There may be a performance penalty if the packet needs to be
 463   defragmented before it can be transmitted by the network device. Systems in
 464   which performance is critical should review the requirements and features of
 465   the underlying communications device and drivers.
 466
 467
 468   @param[in]  This    Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
 469   @param[in]  Token   Pointer to a token associated with the transmit data
 470                       descriptor. Type EFI_MANAGED_NETWORK_COMPLETION_TOKEN
 471                       is defined in "Related Definitions" below.
 472
 473   @retval EFI_SUCCESS            The transmit completion token was cached.
 474   @retval EFI_NOT_STARTED        This MNP child driver instance has not been
 475                                  configured.
 476   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is
 477                                  TRUE:
 478                                  * This is NULL.
 479                                  * Token is NULL.
 480                                  * Token.Event is NULL.
 481                                  * Token.TxData is NULL.
 482                                  * Token.TxData.DestinationAddress is not
 483                                    NULL and Token.TxData.HeaderLength is zero.
 484                                  * Token.TxData.FragmentCount is zero.
 485                                  * (Token.TxData.HeaderLength +
 486                                    Token.TxData.DataLength) is not equal to the
 487                                    sum of the
 488                                    Token.TxData.FragmentTable[].FragmentLength
 489                                    fields.
 490                                  * One or more of the
 491                                    Token.TxData.FragmentTable[].FragmentLength
 492                                    fields is zero.
 493                                  * One or more of the
 494                                    Token.TxData.FragmentTable[].FragmentBufferfields
 495                                    is NULL.
 496                                  * Token.TxData.DataLength is greater than MTU.
 497   @retval EFI_ACCESS_DENIED      The transmit completion token is already in the
 498                                  transmit queue.
 499   @retval EFI_OUT_OF_RESOURCES   The transmit data could not be queued due to a
 500                                  lack of system resources (usually memory).
 501   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 502                                  The MNP child driver instance has been reset to
 503                                  startup defaults.
 504   @retval EFI_NOT_READY          The transmit request could not be queued because
 505                                  the transmit queue is full.
 506
 507 **/
 508 EFI_STATUS
 509 EFIAPI
 510 MnpTransmit (
 511   IN EFI_MANAGED_NETWORK_PROTOCOL          *This,
 512   IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token
 513   )
 514 {
 515   EFI_STATUS        Status;
 516   MNP_INSTANCE_DATA *Instance;
 517   MNP_SERVICE_DATA  *MnpServiceData;
 518   UINT8             *PktBuf;
 519   UINT32            PktLen;
 520   EFI_TPL           OldTpl;
 521
 522   if ((This == NULL) || (Token == NULL)) {
 523
 524     return EFI_INVALID_PARAMETER;
 525   }
 526
 527   Instance = MNP_INSTANCE_DATA_FROM_THIS (This);
 528
 529   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 530
 531   if (!Instance->Configured) {
 532
 533     Status = EFI_NOT_STARTED;
 534     goto ON_EXIT;
 535   }
 536
 537   if (!MnpIsValidTxToken (Instance, Token)) {
 538     //
 539     // The Token is invalid.
 540     //
 541     Status = EFI_INVALID_PARAMETER;
 542     goto ON_EXIT;
 543   }
 544
 545   MnpServiceData = Instance->MnpServiceData;
 546   NET_CHECK_SIGNATURE (MnpServiceData, MNP_SERVICE_DATA_SIGNATURE);
 547
 548   //
 549   // Build the tx packet
 550   //
 551   MnpBuildTxPacket (MnpServiceData, Token->Packet.TxData, &PktBuf, &PktLen);
 552
 553   //
 554   //  OK, send the packet synchronously.
 555   //
 556   Status = MnpSyncSendPacket (MnpServiceData, PktBuf, PktLen, Token);
 557
 558 ON_EXIT:
 559   gBS->RestoreTPL (OldTpl);
 560
 561   return Status;
 562 }
 563
 564
 565 /**
 566   Places an asynchronous receiving request into the receiving queue.
 567
 568   The Receive() function places a completion token into the receive packet
 569   queue. This function is always asynchronous.
 570   The caller must fill in the Token.Event field in the completion token, and
 571   this field cannot be NULL. When the receive operation completes, the MNP
 572   updates the Token.Status and Token.RxData fields and the Token.Event is
 573   signaled.
 574
 575   @param[in]  This      Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
 576   @param[in]  Token     Pointer to a token associated with the receive
 577                         data descriptor. Type
 578                         EFI_MANAGED_NETWORK_COMPLETION_TOKEN is defined in
 579                         EFI_MANAGED_NETWORK_PROTOCOL.Transmit().
 580
 581   @retval EFI_SUCCESS            The receive completion token was cached.
 582   @retval EFI_NOT_STARTED        This MNP child driver instance has not been
 583                                  configured.
 584   @retval EFI_INVALID_PARAMETER  One or more of the following conditions is
 585                                  TRUE:
 586                                  * This is NULL.
 587                                  * Token is NULL.
 588                                  * Token.Event is NULL
 589   @retval EFI_OUT_OF_RESOURCES   The transmit data could not be queued due to a
 590                                  lack of system resources (usually memory).
 591   @retval EFI_DEVICE_ERROR       An unexpected system or network error occurred.
 592                                  The MNP child driver instance has been reset to
 593                                  startup defaults.
 594   @retval EFI_ACCESS_DENIED      The receive completion token was already in the
 595                                  receive queue.
 596   @retval EFI_NOT_READY          The receive request could not be queued because
 597                                  the receive queue is full.
 598
 599 **/
 600 EFI_STATUS
 601 EFIAPI
 602 MnpReceive (
 603   IN EFI_MANAGED_NETWORK_PROTOCOL          *This,
 604   IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token
 605   )
 606 {
 607   EFI_STATUS         Status;
 608   MNP_INSTANCE_DATA  *Instance;
 609   EFI_TPL            OldTpl;
 610
 611   if ((This == NULL) || (Token == NULL) || (Token->Event == NULL)) {
 612
 613     return EFI_INVALID_PARAMETER;
 614   }
 615
 616   Instance = MNP_INSTANCE_DATA_FROM_THIS (This);
 617
 618   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 619
 620   if (!Instance->Configured) {
 621
 622     Status = EFI_NOT_STARTED;
 623     goto ON_EXIT;
 624   }
 625
 626   //
 627   // Check whether this token(event) is already in the rx token queue.
 628   //
 629   Status = NetMapIterate (&Instance->RxTokenMap, MnpTokenExist, (VOID *) Token);
 630   if (EFI_ERROR (Status)) {
 631
 632     goto ON_EXIT;
 633   }
 634
 635   //
 636   // Insert the Token into the RxTokenMap.
 637   //
 638   Status = NetMapInsertTail (&Instance->RxTokenMap, (VOID *) Token, NULL);
 639
 640   if (!EFI_ERROR (Status)) {
 641     //
 642     // Try to deliver any buffered packets.
 643     //
 644     Status = MnpInstanceDeliverPacket (Instance);
 645
 646     //
 647     // Dispatch the DPC queued by the NotifyFunction of Token->Event.
 648     //
 649     DispatchDpc ();
 650   }
 651
 652 ON_EXIT:
 653   gBS->RestoreTPL (OldTpl);
 654
 655   return Status;
 656 }
 657
 658 /**
 659   Aborts an asynchronous transmit or receive request.
 660
 661   The Cancel() function is used to abort a pending transmit or receive request.
 662   If the token is in the transmit or receive request queues, after calling this
 663   function, Token.Status will be set to EFI_ABORTED and then Token.Event will be
 664   signaled. If the token is not in one of the queues, which usually means that
 665   the asynchronous operation has completed, this function will not signal the
 666   token and EFI_NOT_FOUND is returned.
 667
 668   @param[in]  This     Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
 669   @param[in]  Token    Pointer to a token that has been issued by
 670                        EFI_MANAGED_NETWORK_PROTOCOL.Transmit() or
 671                        EFI_MANAGED_NETWORK_PROTOCOL.Receive(). If NULL, all
 672                        pending tokens are aborted.
 673
 674   @retval EFI_SUCCESS            The asynchronous I/O request was aborted and
 675                                  Token.Event was signaled. When Token is NULL,
 676                                  all pending requests were aborted and their
 677                                  events were signaled.
 678   @retval EFI_NOT_STARTED        This MNP child driver instance has not been
 679                                  configured.
 680   @retval EFI_INVALID_PARAMETER  This is NULL.
 681   @retval EFI_NOT_FOUND          When Token is not NULL, the asynchronous I/O
 682                                  request was not found in the transmit or
 683                                  receive queue. It has either completed or was
 684                                  not issued by Transmit() and Receive().
 685
 686 **/
 687 EFI_STATUS
 688 EFIAPI
 689 MnpCancel (
 690   IN EFI_MANAGED_NETWORK_PROTOCOL          *This,
 691   IN EFI_MANAGED_NETWORK_COMPLETION_TOKEN  *Token OPTIONAL
 692   )
 693 {
 694   EFI_STATUS         Status;
 695   MNP_INSTANCE_DATA  *Instance;
 696   EFI_TPL            OldTpl;
 697
 698   if (This == NULL) {
 699
 700     return EFI_INVALID_PARAMETER;
 701   }
 702
 703   Instance = MNP_INSTANCE_DATA_FROM_THIS (This);
 704
 705   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 706
 707   if (!Instance->Configured) {
 708
 709     Status = EFI_NOT_STARTED;
 710     goto ON_EXIT;
 711   }
 712
 713   //
 714   // Iterate the RxTokenMap to cancel the specified Token.
 715   //
 716   Status = NetMapIterate (&Instance->RxTokenMap, MnpCancelTokens, (VOID *) Token);
 717
 718   if (Token != NULL) {
 719
 720     Status = (Status == EFI_ABORTED) ? EFI_SUCCESS : EFI_NOT_FOUND;
 721   }
 722
 723   //
 724   // Dispatch the DPC queued by the NotifyFunction of the cancled token's events.
 725   //
 726   DispatchDpc ();
 727
 728 ON_EXIT:
 729   gBS->RestoreTPL (OldTpl);
 730
 731   return Status;
 732 }
 733
 734 /**
 735   Polls for incoming data packets and processes outgoing data packets.
 736
 737   The Poll() function can be used by network drivers and applications to
 738   increase the rate that data packets are moved between the communications
 739   device and the transmit and receive queues.
 740   Normally, a periodic timer event internally calls the Poll() function. But, in
 741   some systems, the periodic timer event may not call Poll() fast enough to
 742   transmit and/or receive all data packets without missing packets. Drivers and
 743   applications that are experiencing packet loss should try calling the Poll()
 744   function more often.
 745
 746   @param[in]  This         Pointer to the EFI_MANAGED_NETWORK_PROTOCOL instance.
 747
 748   @retval EFI_SUCCESS      Incoming or outgoing data was processed.
 749   @retval EFI_NOT_STARTED  This MNP child driver instance has not been
 750                            configured.
 751   @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The
 752                            MNP child driver instance has been reset to startup
 753                            defaults.
 754   @retval EFI_NOT_READY    No incoming or outgoing data was processed. Consider
 755                            increasing the polling rate.
 756   @retval EFI_TIMEOUT      Data was dropped out of the transmit and/or receive
 757                            queue. Consider increasing the polling rate.
 758
 759 **/
 760 EFI_STATUS
 761 EFIAPI
 762 MnpPoll (
 763   IN EFI_MANAGED_NETWORK_PROTOCOL  *This
 764   )
 765 {
 766   EFI_STATUS         Status;
 767   MNP_INSTANCE_DATA  *Instance;
 768   EFI_TPL            OldTpl;
 769
 770   if (This == NULL) {
 771     return EFI_INVALID_PARAMETER;
 772   }
 773
 774   Instance = MNP_INSTANCE_DATA_FROM_THIS (This);
 775
 776   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 777
 778   if (!Instance->Configured) {
 779     Status = EFI_NOT_STARTED;
 780     goto ON_EXIT;
 781   }
 782
 783   //
 784   // Try to receive packets.
 785   //
 786   Status = MnpReceivePacket (Instance->MnpServiceData);
 787
 788   //
 789   // Dispatch the DPC queued by the NotifyFunction of rx token's events.
 790   //
 791   DispatchDpc ();
 792
 793 ON_EXIT:
 794   gBS->RestoreTPL (OldTpl);
 795
 796   return Status;
 797 }
 798