MdeModulePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
    Implementation of shuting down a network adapter.\r
\r
Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Snp.h"\r
\r
\r
/**\r
  Call UNDI to shut down the interface.\r
\r
  @param  Snp   Pointer to snp driver structure.\r
\r
  @retval EFI_SUCCESS        UNDI is shut down successfully.\r
  @retval EFI_DEVICE_ERROR   UNDI could not be shut down.\r
\r
**/\r
EFI_STATUS\r
PxeShutdown (\r
  IN SNP_DRIVER *Snp\r
  )\r
{\r
  Snp->Cdb.OpCode     = PXE_OPCODE_SHUTDOWN;\r
  Snp->Cdb.OpFlags    = PXE_OPFLAGS_NOT_USED;\r
  Snp->Cdb.CPBsize    = PXE_CPBSIZE_NOT_USED;\r
  Snp->Cdb.DBsize     = PXE_DBSIZE_NOT_USED;\r
  Snp->Cdb.CPBaddr    = PXE_CPBADDR_NOT_USED;\r
  Snp->Cdb.DBaddr     = PXE_DBADDR_NOT_USED;\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
  //\r
  // Issue UNDI command and check result.\r
  //\r
  DEBUG ((EFI_D_NET, "\nsnp->undi.shutdown()  "));\r
\r
  (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb);\r
\r
  if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) {\r
    //\r
    // UNDI could not be shutdown. Return UNDI error.\r
    //\r
    DEBUG ((EFI_D_WARN, "\nsnp->undi.shutdown()  %xh:%xh\n", Snp->Cdb.StatFlags, Snp->Cdb.StatCode));\r
\r
    return EFI_DEVICE_ERROR;\r
  }\r
  //\r
  // Free allocated memory.\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
  Snp->TxRxBufferSize  = 0;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
/**\r
  Resets a network adapter and leaves it in a state that is safe for another\r
  driver to initialize.\r
\r
  This function releases the memory buffers assigned in the Initialize() call.\r
  Pending transmits and receives are lost, and interrupts are cleared and disabled.\r
  After this call, only the Initialize() and Stop() calls may be used. If the\r
  network interface was successfully shutdown, then EFI_SUCCESS will be returned.\r
  If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.\r
\r
  @param  This  A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.\r
\r
  @retval EFI_SUCCESS           The network interface was shutdown.\r
  @retval EFI_NOT_STARTED       The network interface has not been started.\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
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SnpUndi32Shutdown (\r
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This\r
  )\r
{\r
  SNP_DRIVER  *Snp;\r
  EFI_STATUS  Status;\r
  EFI_TPL     OldTpl;\r
\r
  //\r
  // Get pointer to SNP driver instance for *This.\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
  //\r
  // Return error if the SNP is not initialized.\r
  //\r
  switch (Snp->Mode.State) {\r
  case EfiSimpleNetworkInitialized:\r
    break;\r
\r
  case EfiSimpleNetworkStopped:\r
    Status = EFI_NOT_STARTED;\r
    goto ON_EXIT;\r
\r
  default:\r
    Status = EFI_DEVICE_ERROR;\r
    goto ON_EXIT;\r
  }\r
\r
  Status                          = PxeShutdown (Snp);\r
\r
  Snp->Mode.State                 = EfiSimpleNetworkStarted;\r
  Snp->Mode.ReceiveFilterSetting  = 0;\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
  gBS->CloseEvent (Snp->Snp.WaitForPacket);\r
\r
ON_EXIT:\r
  gBS->RestoreTPL (OldTpl);\r
\r
  return Status;\r
}\r