audk/MdeModulePkg/Universal/Network/SnpDxe/start.c

/** @file
Copyright (c) 2004 - 2007, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution.  The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Module name:
  start.c

Abstract:

Revision history:
  2000-Feb-07 M(f)J   Genesis.

**/

#include "Snp.h"


/**
  this routine calls undi to start the interface and changes the snp state!

  @param  snp                    pointer to snp driver structure


**/
EFI_STATUS
pxe_start (
  SNP_DRIVER *snp
  )
{
  PXE_CPB_START_30  *cpb;
  PXE_CPB_START_31  *cpb_31;

  cpb     = snp->cpb;
  cpb_31  = snp->cpb;
  //
  // Initialize UNDI Start CDB for H/W UNDI
  //
  snp->cdb.OpCode     = PXE_OPCODE_START;
  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->if_num;
  snp->cdb.Control    = PXE_CONTROL_LAST_CDB_IN_LIST;

  //
  // Make changes to H/W UNDI Start CDB if this is
  // a S/W UNDI.
  //
  if (snp->is_swundi) {
    if (snp->IsOldUndi) {
      snp->cdb.CPBsize  = sizeof (PXE_CPB_START_30);
      snp->cdb.CPBaddr  = (UINT64)(UINTN) cpb;

      cpb->Delay        = (UINT64)(UINTN) &snp_undi32_callback_delay_30;
      cpb->Block        = (UINT64)(UINTN) &snp_undi32_callback_block_30;

      //
      // Virtual == Physical.  This can be set to zero.
      //
      cpb->Virt2Phys  = (UINT64)(UINTN) &snp_undi32_callback_v2p_30;
      cpb->Mem_IO     = (UINT64)(UINTN) &snp_undi32_callback_memio_30;
    } else {
      snp->cdb.CPBsize  = sizeof (PXE_CPB_START_31);
      snp->cdb.CPBaddr  = (UINT64)(UINTN) cpb_31;

      cpb_31->Delay     = (UINT64)(UINTN) &snp_undi32_callback_delay;
      cpb_31->Block     = (UINT64)(UINTN) &snp_undi32_callback_block;

      //
      // Virtual == Physical.  This can be set to zero.
      //
      cpb_31->Virt2Phys = (UINT64)(UINTN) 0;
      cpb_31->Mem_IO    = (UINT64)(UINTN) &snp_undi32_callback_memio;

      cpb_31->Map_Mem   = (UINT64)(UINTN) &snp_undi32_callback_map;
      cpb_31->UnMap_Mem = (UINT64)(UINTN) &snp_undi32_callback_unmap;
      cpb_31->Sync_Mem  = (UINT64)(UINTN) &snp_undi32_callback_sync;

      cpb_31->Unique_ID = (UINT64)(UINTN) snp;
    }
  }
  //
  // Issue UNDI command and check result.
  //
  DEBUG ((EFI_D_NET, "\nsnp->undi.start()  "));

  (*snp->issue_undi32_command) ((UINT64)(UINTN) &snp->cdb);

  if (snp->cdb.StatCode != PXE_STATCODE_SUCCESS) {
    //
    // UNDI could not be started. Return UNDI error.
    //
    DEBUG (
      (EFI_D_ERROR,
      "\nsnp->undi.start()  %xh:%xh\n",
      snp->cdb.StatCode,
      snp->cdb.StatFlags)
      );

    return EFI_DEVICE_ERROR;
  }
  //
  // Set simple network state to Started and return success.
  //
  snp->mode.State = EfiSimpleNetworkStarted;

  return EFI_SUCCESS;
}


/**
  This is the SNP interface routine for starting the interface
  This routine basically retrieves snp structure, checks the SNP state and
  calls the pxe_start routine to actually do start undi interface

  @param  This                   context pointer

  @retval EFI_INVALID_PARAMETER  "This" is Null
  @retval      No                SNP driver can be extracted from "This"
  @retval EFI_ALREADY_STARTED    The state of SNP is EfiSimpleNetworkStarted or
                                 EfiSimpleNetworkInitialized
  @retval EFI_DEVICE_ERROR       The state of SNP is other than
                                 EfiSimpleNetworkStarted,
                                 EfiSimpleNetworkInitialized, and
                                 EfiSimpleNetworkStopped
  @retval EFI_SUCCESS            UNDI interface is succesfully started
  @retval Other                  Error occurs while calling pxe_start function.

**/
EFI_STATUS
EFIAPI
snp_undi32_start (
  IN EFI_SIMPLE_NETWORK_PROTOCOL *This
  )
{
  SNP_DRIVER  *Snp;
  EFI_STATUS  Status;
  UINTN       Index;
  EFI_TPL     OldTpl;

  if (This == NULL) {
    return EFI_INVALID_PARAMETER;
  }

  Snp = EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This);

  OldTpl = gBS->RaiseTPL (TPL_CALLBACK);

  switch (Snp->mode.State) {
  case EfiSimpleNetworkStopped:
    break;

  case EfiSimpleNetworkStarted:
  case EfiSimpleNetworkInitialized:
    Status = EFI_ALREADY_STARTED;
    goto ON_EXIT;

  default:
    Status = EFI_DEVICE_ERROR;
    goto ON_EXIT;
  }

  Status = pxe_start (Snp);
  if (EFI_ERROR (Status)) {
    goto ON_EXIT;
  }
  //
  // clear the map_list in SNP structure
  //
  for (Index = 0; Index < MAX_MAP_LENGTH; Index++) {
    Snp->map_list[Index].virt       = 0;
    Snp->map_list[Index].map_cookie = 0;
  }

  Snp->mode.MCastFilterCount = 0;

ON_EXIT:
  gBS->RestoreTPL (OldTpl);

  return Status;
}