MdeModulePkg: Fix SNP.Initialize() spec conformance issue

[mirror_edk2.git] / MdeModulePkg / Universal / Network / SnpDxe / Initialize.c

/** @file\r
 		Implementation of initializing a network adapter.\r
\r
Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed \r
and made available under the terms and conditions of the BSD License which \r
accompanies this distribution. The full text of the license may be found at \r
http://opensource.org/licenses/bsd-license.php \r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
#include "Snp.h"\r
\r
/**\r
  Call UNDI to initialize the interface.\r
\r
  @param  Snp                   Pointer to snp driver structure.\r
  @param  CableDetectFlag       Do/don't detect the cable (depending on what \r
                                undi supports).\r
  \r
  @retval EFI_SUCCESS           UNDI is initialized successfully.\r
  @retval EFI_DEVICE_ERROR      UNDI could not be initialized.\r
  @retval Other                 Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
PxeInit (\r
  SNP_DRIVER *Snp,\r
  UINT16     CableDetectFlag\r
  )\r
{\r
  PXE_CPB_INITIALIZE  *Cpb;\r
  VOID                *Addr;\r
  EFI_STATUS          Status;\r
\r
  Status = EFI_SUCCESS;\r
\r
  Cpb = Snp->Cpb;\r
  if (Snp->TxRxBufferSize != 0) {\r
    Status = Snp->PciIo->AllocateBuffer (\r
                           Snp->PciIo,\r
                           AllocateAnyPages,\r
                           EfiBootServicesData,\r
                           SNP_MEM_PAGES (Snp->TxRxBufferSize),\r
                           &Addr,\r
                           0\r
                           );\r
\r
    if (Status != EFI_SUCCESS) {\r
      DEBUG (\r
        (EFI_D_ERROR,\r
        "\nSnp->PxeInit()  AllocateBuffer  %xh (%r)\n",\r
        Status,\r
        Status)\r
        );\r
\r
      return Status;\r
    }\r
\r
    ASSERT (Addr);\r
\r
    Snp->TxRxBuffer = Addr;\r
  }\r
\r
  Cpb->MemoryAddr   = (UINT64)(UINTN) Snp->TxRxBuffer;\r
\r
  Cpb->MemoryLength = Snp->TxRxBufferSize;\r
\r
  //\r
  // let UNDI decide/detect these values\r
  //\r
  Cpb->LinkSpeed      = 0;\r
  Cpb->TxBufCnt       = 0;\r
  Cpb->TxBufSize      = 0;\r
  Cpb->RxBufCnt       = 0;\r
  Cpb->RxBufSize      = 0;\r
\r
  Cpb->DuplexMode         = PXE_DUPLEX_DEFAULT;\r
\r
  Cpb->LoopBackMode       = LOOPBACK_NORMAL;\r
\r
  Snp->Cdb.OpCode     = PXE_OPCODE_INITIALIZE;\r
  Snp->Cdb.OpFlags    = CableDetectFlag;\r
\r
  Snp->Cdb.CPBsize    = (UINT16) sizeof (PXE_CPB_INITIALIZE);\r
  Snp->Cdb.DBsize     = (UINT16) sizeof (PXE_DB_INITIALIZE);\r
\r
  Snp->Cdb.CPBaddr    = (UINT64)(UINTN) Snp->Cpb;\r
  Snp->Cdb.DBaddr     = (UINT64)(UINTN) Snp->Db;\r
\r
  Snp->Cdb.StatCode   = PXE_STATCODE_INITIALIZE;\r
  Snp->Cdb.StatFlags  = PXE_STATFLAGS_INITIALIZE;\r
  Snp->Cdb.IFnum      = Snp->IfNum;\r
  Snp->Cdb.Control    = PXE_CONTROL_LAST_CDB_IN_LIST;\r
\r
  DEBUG ((EFI_D_NET, "\nSnp->undi.initialize()  "));\r
\r
  (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb);\r
\r
  //\r
  // There are two fields need to be checked here:\r
  // First is the upper two bits (14 & 15) in the CDB.StatFlags field. Until these bits change to report \r
  // PXE_STATFLAGS_COMMAND_COMPLETE or PXE_STATFLAGS_COMMAND_FAILED, the command has not been executed by the UNDI.\r
  // Second is the CDB.StatCode field. After command execution completes, either successfully or not, \r
  // the CDB.StatCode field contains the result of the command execution.\r
  //\r
  if ((((Snp->Cdb.StatFlags) & PXE_STATFLAGS_STATUS_MASK) == PXE_STATFLAGS_COMMAND_COMPLETE) &&\r
      (Snp->Cdb.StatCode == PXE_STATCODE_SUCCESS)) {\r
    //\r
    // If cable detect feature is enabled in CDB.OpFlags, check the CDB.StatFlags to see if there is an \r
    // active connection to this network device. If the no media StatFlag is set, the UNDI and network \r
    // device are still initialized.    \r
    //\r
    if (CableDetectFlag == PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) {\r
      if(((Snp->Cdb.StatFlags) & PXE_STATFLAGS_INITIALIZED_NO_MEDIA) != PXE_STATFLAGS_INITIALIZED_NO_MEDIA) {\r
        Snp->Mode.MediaPresent = TRUE;\r
      } else {\r
        Snp->Mode.MediaPresent = FALSE;\r
      }\r
    }\r
    \r
    Snp->Mode.State   = EfiSimpleNetworkInitialized;\r
    Status            = EFI_SUCCESS;\r
  } else {\r
    DEBUG (\r
      (EFI_D_WARN,\r
      "\nSnp->undi.initialize()  %xh:%xh\n",\r
      Snp->Cdb.StatFlags,\r
      Snp->Cdb.StatCode)\r
      );\r
\r
    if (Snp->TxRxBuffer != NULL) {\r
      Snp->PciIo->FreeBuffer (\r
                    Snp->PciIo,\r
                    SNP_MEM_PAGES (Snp->TxRxBufferSize),\r
                    (VOID *) Snp->TxRxBuffer\r
                    );\r
    }\r
\r
    Snp->TxRxBuffer = NULL;\r
\r
    Status          = EFI_DEVICE_ERROR;\r
  }\r
\r
  return Status;\r
}\r
\r
\r
/**\r
  Resets a network adapter and allocates the transmit and receive buffers \r
  required by the network interface; optionally, also requests allocation of \r
  additional transmit and receive buffers.\r
\r
  This function allocates the transmit and receive buffers required by the network\r
  interface. If this allocation fails, then EFI_OUT_OF_RESOURCES is returned.\r
  If the allocation succeeds and the network interface is successfully initialized,\r
  then EFI_SUCCESS will be returned.\r
\r
  @param This               A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
\r
  @param ExtraRxBufferSize  The size, in bytes, of the extra receive buffer space\r
                            that the driver should allocate for the network interface.\r
                            Some network interfaces will not be able to use the \r
                            extra buffer, and the caller will not know if it is \r
                            actually being used.\r
  @param ExtraTxBufferSize  The size, in bytes, of the extra transmit buffer space\r
                            that the driver should allocate for the network interface.\r
                            Some network interfaces will not be able to use the\r
                            extra buffer, and the caller will not know if it is\r
                            actually being used.\r
\r
  @retval EFI_SUCCESS           The network interface was initialized.\r
  @retval EFI_NOT_STARTED       The network interface has not been started.\r
  @retval EFI_OUT_OF_RESOURCES  There was not enough memory for the transmit and\r
                                receive buffers.\r
  @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid\r
                                EFI_SIMPLE_NETWORK_PROTOCOL structure.\r
  @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.\r
  @retval EFI_UNSUPPORTED       The increased buffer size feature is not supported.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SnpUndi32Initialize (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This,\r
  IN UINTN                       ExtraRxBufferSize OPTIONAL,\r
  IN UINTN                       ExtraTxBufferSize OPTIONAL\r
  )\r
{\r
  EFI_STATUS  EfiStatus;\r
  SNP_DRIVER  *Snp;\r
  EFI_TPL     OldTpl;\r
\r
  if (This == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This);\r
\r
  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r
\r
  if (Snp == NULL) {\r
    EfiStatus = EFI_INVALID_PARAMETER;\r
    goto ON_EXIT;\r
  }\r
\r
  switch (Snp->Mode.State) {\r
  case EfiSimpleNetworkStarted:\r
    break;\r
\r
  case EfiSimpleNetworkStopped:\r
    EfiStatus = EFI_NOT_STARTED;\r
    goto ON_EXIT;\r
\r
  default:\r
    EfiStatus = EFI_DEVICE_ERROR;\r
    goto ON_EXIT;\r
  }\r
\r
  EfiStatus = gBS->CreateEvent (\r
                    EVT_NOTIFY_WAIT,\r
                    TPL_NOTIFY,\r
                    &SnpWaitForPacketNotify,\r
                    Snp,\r
                    &Snp->Snp.WaitForPacket\r
                    );\r
\r
  if (EFI_ERROR (EfiStatus)) {\r
    Snp->Snp.WaitForPacket = NULL;\r
    EfiStatus = EFI_DEVICE_ERROR;\r
    goto ON_EXIT;\r
  }\r
  //\r
  //\r
  //\r
  Snp->Mode.MCastFilterCount      = 0;\r
  Snp->Mode.ReceiveFilterSetting  = 0;\r
  ZeroMem (Snp->Mode.MCastFilter, sizeof Snp->Mode.MCastFilter);\r
  CopyMem (\r
    &Snp->Mode.CurrentAddress,\r
    &Snp->Mode.PermanentAddress,\r
    sizeof (EFI_MAC_ADDRESS)\r
    );\r
\r
  //\r
  // Compute tx/rx buffer sizes based on UNDI init info and parameters.\r
  //\r
  Snp->TxRxBufferSize = (UINT32) (Snp->InitInfo.MemoryRequired + ExtraRxBufferSize + ExtraTxBufferSize);\r
\r
  //\r
  // If UNDI support cable detect for INITIALIZE command, try it first.\r
  //\r
  if (Snp->CableDetectSupported) {\r
    if (PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DETECT_CABLE) == EFI_SUCCESS) {\r
      goto ON_EXIT;\r
    }\r
  }\r
\r
  Snp->Mode.MediaPresent  = FALSE;\r
\r
  EfiStatus               = PxeInit (Snp, PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE);\r
\r
  if (EFI_ERROR (EfiStatus)) {\r
    gBS->CloseEvent (Snp->Snp.WaitForPacket);\r
    goto ON_EXIT;\r
  }\r
\r
  //\r
  // Try to update the MediaPresent field of EFI_SIMPLE_NETWORK_MODE if the UNDI support it.\r
  //\r
  if (Snp->MediaStatusSupported) {\r
    PxeGetStatus (Snp, NULL, FALSE);\r
  }\r
\r
ON_EXIT:\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return EfiStatus;\r
}\r