Fix few typos in comments and documentation. Cc: Jiaxin Wu <jiaxin.wu@intel.com> Cc: Siyuan Fu <siyuan.fu@intel.com> Cc: Maciej Rabeda <maciej.rabeda@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Reviewed-by: Maciej Rabeda <maciej.rabeda@linux.intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-47-philmd@redhat.com>
		
			
				
	
	
		
			147 lines
		
	
	
		
			3.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			147 lines
		
	
	
		
			3.9 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /** @file
 | |
|     Implementation of shutting down a network adapter.
 | |
| 
 | |
| Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
 | |
| SPDX-License-Identifier: BSD-2-Clause-Patent
 | |
| 
 | |
| **/
 | |
| 
 | |
| #include "Snp.h"
 | |
| 
 | |
| 
 | |
| /**
 | |
|   Call UNDI to shut down the interface.
 | |
| 
 | |
|   @param  Snp   Pointer to snp driver structure.
 | |
| 
 | |
|   @retval EFI_SUCCESS        UNDI is shut down successfully.
 | |
|   @retval EFI_DEVICE_ERROR   UNDI could not be shut down.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| PxeShutdown (
 | |
|   IN SNP_DRIVER *Snp
 | |
|   )
 | |
| {
 | |
|   Snp->Cdb.OpCode     = PXE_OPCODE_SHUTDOWN;
 | |
|   Snp->Cdb.OpFlags    = PXE_OPFLAGS_NOT_USED;
 | |
|   Snp->Cdb.CPBsize    = PXE_CPBSIZE_NOT_USED;
 | |
|   Snp->Cdb.DBsize     = PXE_DBSIZE_NOT_USED;
 | |
|   Snp->Cdb.CPBaddr    = PXE_CPBADDR_NOT_USED;
 | |
|   Snp->Cdb.DBaddr     = PXE_DBADDR_NOT_USED;
 | |
|   Snp->Cdb.StatCode   = PXE_STATCODE_INITIALIZE;
 | |
|   Snp->Cdb.StatFlags  = PXE_STATFLAGS_INITIALIZE;
 | |
|   Snp->Cdb.IFnum      = Snp->IfNum;
 | |
|   Snp->Cdb.Control    = PXE_CONTROL_LAST_CDB_IN_LIST;
 | |
| 
 | |
|   //
 | |
|   // Issue UNDI command and check result.
 | |
|   //
 | |
|   DEBUG ((EFI_D_NET, "\nsnp->undi.shutdown()  "));
 | |
| 
 | |
|   (*Snp->IssueUndi32Command) ((UINT64)(UINTN) &Snp->Cdb);
 | |
| 
 | |
|   if (Snp->Cdb.StatCode != PXE_STATCODE_SUCCESS) {
 | |
|     //
 | |
|     // UNDI could not be shutdown. Return UNDI error.
 | |
|     //
 | |
|     DEBUG ((EFI_D_WARN, "\nsnp->undi.shutdown()  %xh:%xh\n", Snp->Cdb.StatFlags, Snp->Cdb.StatCode));
 | |
| 
 | |
|     return EFI_DEVICE_ERROR;
 | |
|   }
 | |
|   //
 | |
|   // Free allocated memory.
 | |
|   //
 | |
|   if (Snp->TxRxBuffer != NULL) {
 | |
|     Snp->PciIo->FreeBuffer (
 | |
|                   Snp->PciIo,
 | |
|                   SNP_MEM_PAGES (Snp->TxRxBufferSize),
 | |
|                   (VOID *) Snp->TxRxBuffer
 | |
|                   );
 | |
|   }
 | |
| 
 | |
|   Snp->TxRxBuffer      = NULL;
 | |
|   Snp->TxRxBufferSize  = 0;
 | |
| 
 | |
|   return EFI_SUCCESS;
 | |
| }
 | |
| 
 | |
| 
 | |
| /**
 | |
|   Resets a network adapter and leaves it in a state that is safe for another
 | |
|   driver to initialize.
 | |
| 
 | |
|   This function releases the memory buffers assigned in the Initialize() call.
 | |
|   Pending transmits and receives are lost, and interrupts are cleared and disabled.
 | |
|   After this call, only the Initialize() and Stop() calls may be used. If the
 | |
|   network interface was successfully shutdown, then EFI_SUCCESS will be returned.
 | |
|   If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.
 | |
| 
 | |
|   @param  This  A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
 | |
| 
 | |
|   @retval EFI_SUCCESS           The network interface was shutdown.
 | |
|   @retval EFI_NOT_STARTED       The network interface has not been started.
 | |
|   @retval EFI_INVALID_PARAMETER This parameter was NULL or did not point to a valid
 | |
|                                 EFI_SIMPLE_NETWORK_PROTOCOL structure.
 | |
|   @retval EFI_DEVICE_ERROR      The command could not be sent to the network interface.
 | |
| 
 | |
| **/
 | |
| EFI_STATUS
 | |
| EFIAPI
 | |
| SnpUndi32Shutdown (
 | |
|   IN EFI_SIMPLE_NETWORK_PROTOCOL *This
 | |
|   )
 | |
| {
 | |
|   SNP_DRIVER  *Snp;
 | |
|   EFI_STATUS  Status;
 | |
|   EFI_TPL     OldTpl;
 | |
| 
 | |
|   //
 | |
|   // Get pointer to SNP driver instance for *This.
 | |
|   //
 | |
|   if (This == NULL) {
 | |
|     return EFI_INVALID_PARAMETER;
 | |
|   }
 | |
| 
 | |
|   Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This);
 | |
| 
 | |
|   OldTpl = gBS->RaiseTPL (TPL_CALLBACK);
 | |
| 
 | |
|   //
 | |
|   // Return error if the SNP is not initialized.
 | |
|   //
 | |
|   switch (Snp->Mode.State) {
 | |
|   case EfiSimpleNetworkInitialized:
 | |
|     break;
 | |
| 
 | |
|   case EfiSimpleNetworkStopped:
 | |
|     Status = EFI_NOT_STARTED;
 | |
|     goto ON_EXIT;
 | |
| 
 | |
|   default:
 | |
|     Status = EFI_DEVICE_ERROR;
 | |
|     goto ON_EXIT;
 | |
|   }
 | |
| 
 | |
|   Status                          = PxeShutdown (Snp);
 | |
| 
 | |
|   Snp->Mode.State                 = EfiSimpleNetworkStarted;
 | |
|   Snp->Mode.ReceiveFilterSetting  = 0;
 | |
| 
 | |
|   Snp->Mode.MCastFilterCount      = 0;
 | |
|   Snp->Mode.ReceiveFilterSetting  = 0;
 | |
|   ZeroMem (Snp->Mode.MCastFilter, sizeof Snp->Mode.MCastFilter);
 | |
|   CopyMem (
 | |
|     &Snp->Mode.CurrentAddress,
 | |
|     &Snp->Mode.PermanentAddress,
 | |
|     sizeof (EFI_MAC_ADDRESS)
 | |
|     );
 | |
| 
 | |
|   gBS->CloseEvent (Snp->Snp.WaitForPacket);
 | |
| 
 | |
| ON_EXIT:
 | |
|   gBS->RestoreTPL (OldTpl);
 | |
| 
 | |
|   return Status;
 | |
| }
 |