Snp.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Implementation of driver entry point and driver binding protocol.
Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "Snp.h"
//
// Module global variables needed to support undi 3.0 interface
//
// End Global variables
//
/**
One notified function to stop UNDI device when gBS->ExitBootServices() called.
@param Event Pointer to this event
@param Context Event hanlder private data
**/
)
{
//
// Shutdown and stop UNDI driver
//
PxeShutdown (Snp);
}
/**
Send command to UNDI. It does nothing currently.
@param Cdb command to be sent to UNDI.
@retval EFI_INVALID_PARAMETER The command is 0.
@retval EFI_UNSUPPORTED Default return status because it's not
supported currently.
**/
)
{
if (Cdb == 0) {
return EFI_INVALID_PARAMETER;
}
//
// %%TBD - For now, nothing is done.
//
return EFI_UNSUPPORTED;
}
/**
Compute 8-bit checksum of a buffer.
@param Buffer Pointer to buffer.
@param Length Length of buffer in bytes.
@return 8-bit checksum of all bytes in buffer, or zero if ptr is NULL or len
is zero.
**/
)
{
Cksum = 0;
return 0;
}
while (Length-- != 0) {
}
return Cksum;
}
/**
Test to see if this driver supports ControllerHandle. This service
is called by the EFI boot service ConnectController(). In
order to make drivers as small as possible, there are a few calling
restrictions for this service. ConnectController() must
follow these calling restrictions. If any other agent wishes to call
Supported() it must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to test.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device.
@retval EFI_ALREADY_STARTED This driver is already running on this device.
@retval other This driver does not support this device.
**/
)
{
NULL,
);
return Status;
}
(VOID **) &NiiProtocol,
);
if (Status == EFI_ALREADY_STARTED) {
}
return Status;
}
//
// check the version, we don't want to connect to the undi16
//
goto Done;
}
//
// Check to see if !PXE structure is valid. Paragraph alignment of !PXE structure is required.
//
goto Done;
}
//
// Verify !PXE revisions.
//
goto Done;
}
goto Done;
}
goto Done;
goto Done;
}
//
// Do S/W UNDI specific checks.
//
goto Done;
}
goto Done;
}
}
Done:
gBS->CloseProtocol (
);
return Status;
}
/**
Start this driver on ControllerHandle. This service is called by the
EFI boot service ConnectController(). In order to make
drivers as small as possible, there are a few calling restrictions for
this service. ConnectController() must follow these
calling restrictions. If any other agent wishes to call Start() it
must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to bind driver to.
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device
**/
)
{
(VOID **) &NiiDevicePath,
);
return Status;
}
);
return Status;
}
);
return Status;
}
//
// Get the NII interface.
//
);
gBS->CloseProtocol (
);
return Status;
}
goto NiiError;
}
//
// We can get any packets.
//
//
// We need to be able to get broadcast packets for DHCP.
// If we do not have promiscuous support, we must at least have
// broadcast support or we cannot do DHCP!
//
} else {
goto NiiError;
}
//
// OK, we like this UNDI, and we know snp is not already there on this handle
// Allocate and initialize a new simple network protocol structure.
//
SNP_MEM_PAGES (sizeof (SNP_DRIVER)),
&Address,
0
);
if (Status != EFI_SUCCESS) {
goto NiiError;
}
Snp->TxRxBufferSize = 0;
} else {
} else {
Snp->IssueUndi32Command = (ISSUE_UNDI32_COMMAND) (UINTN) ((UINT8) (UINTN) Pxe + Pxe->sw.EntryPoint);
}
}
//
// Allocate a global CPB and DB buffer for this UNDI interface.
// we do this because:
//
// -UNDI 3.0 wants all the addresses passed to it (even the cpb and db) to be
// within 2GB limit, create them here and map them so that when undi calls
// v2p callback to check if the physical address is < 2gb, we will pass.
//
// -This is not a requirement for 3.1 or later UNDIs but the code looks
// simpler if we use the same cpb, db variables for both old and new undi
// interfaces from all the SNP interface calls (we don't map the buffers
// for the newer undi interfaces though)
// .
// -it is OK to allocate one global set of CPB, DB pair for each UNDI
// interface as EFI does not multi-task and so SNP will not be re-entered!
//
SNP_MEM_PAGES (4096),
&Address,
0
);
if (Status != EFI_SUCCESS) {
goto Error_DeleteSNP;
}
//
// PxeStart call is going to give the callback functions to UNDI, these callback
// functions use the BarIndex values from the snp structure, so these must be initialized
// with default values before doing a PxeStart. The correct values can be obtained after
// getting the config information from UNDI
//
Snp->MemoryBarIndex = 0;
//
// we need the undi init information many times in this snp code, just get it
// once here and store it in the snp driver structure. to get Init Info
// from UNDI we have to start undi first.
//
if (Status != EFI_SUCCESS) {
goto Error_DeleteSNP;
}
//
// Save the INIT Stat Code...
//
goto Error_DeleteSNP;
}
goto Error_DeleteSNP;
}
//
// Find the correct BAR to do IO.
//
//
// Enumerate through the PCI BARs for the device to determine which one is
// the IO BAR. Save the index of the BAR into the adapter info structure.
// for regular 32bit BARs, 0 is memory mapped, 1 is io mapped
//
//
// This is a 64-bit memory bar, skip this and the
// next bar as well.
//
TempBar++;
}
break;
}
TempBar++;
}
//
// Initialize simple network protocol mode structure
//
switch (InitStatFlags & PXE_STATFLAGS_CABLE_DETECT_MASK) {
break;
default:
}
switch (InitStatFlags & PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK) {
break;
default:
}
} else {
}
} else {
}
}
}
}
}
}
//
// need to get the station address to save in the mode structure. we need to
// initialize the UNDI first for this.
//
goto Error_DeleteSNP;
}
if (Status != EFI_SUCCESS) {
PxeShutdown (Snp);
goto Error_DeleteSNP;
}
//
// We should not leave UNDI started and initialized here. this DriverStart()
// routine must only find and attach the SNP interface to UNDI layer that it
// finds on the given handle!
// The UNDI layer will be started when upper layers call Snp->start.
// How ever, this DriverStart() must fill up the snp mode structure which
// contains the MAC address of the NIC. For this reason we started and
// initialized UNDI here, now we are done, do a shutdown and stop of the
// UNDI interface!
//
PxeShutdown (Snp);
//
// Create EXIT_BOOT_SERIVES Event
//
Snp,
);
goto Error_DeleteSNP;
}
//
// add SNP to the undi handle
//
);
return Status;
}
SNP_MEM_PAGES (4096),
);
mPciIo->FreeBuffer (
SNP_MEM_PAGES (sizeof (SNP_DRIVER)),
);
gBS->CloseProtocol (
);
gBS->CloseProtocol (
);
return Status;
}
/**
Stop this driver on ControllerHandle. This service is called by the
EFI boot service DisconnectController(). In order to
make drivers as small as possible, there are a few calling
restrictions for this service. DisconnectController()
must follow these calling restrictions. If any other agent wishes
to call Stop() it must also follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
**/
)
{
//
// Get our context back.
//
(VOID **) &SnpProtocol,
);
return EFI_UNSUPPORTED;
}
);
return Status;
}
//
// Close EXIT_BOOT_SERIVES Event
//
);
);
PxeShutdown (Snp);
mPciIo->FreeBuffer (
SNP_MEM_PAGES (4096),
);
mPciIo->FreeBuffer (
SNP_MEM_PAGES (sizeof (SNP_DRIVER)),
);
return Status;
}
//
// Simple Network Protocol Driver Global Variables
//
0xa,
NULL,
};
/**
This routine maps the given CPU address to a Device address. It creates a
an entry in the map list with the virtual and physical addresses and the
un map cookie.
@param V2p pointer to return a map list node pointer.
@param Type the direction in which the data flows from the given
virtual address device->cpu or cpu->device or both
ways.
@param VirtualAddress virtual address (or CPU address) to be mapped.
@param BufferSize size of the buffer to be mapped.
@retval EFI_SUCEESS routine has completed the mapping.
@retval EFI_INVALID_PARAMETER invalid parameter.
@retval EFI_OUT_OF_RESOURCES out of resource.
@retval other error as indicated.
**/
AddV2P (
)
{
return EFI_INVALID_PARAMETER;
}
return EFI_OUT_OF_RESOURCES;
}
Type,
&(*V2p)->PhysicalAddress,
);
if (Status != EFI_SUCCESS) {
return Status;
}
return EFI_SUCCESS;
}
/**
This routine searches the linked list of mapped address nodes (for undi3.0
interface) to find the node that corresponds to the given virtual address and
returns a pointer to that node.
@param V2p pointer to return a map list node pointer.
@param VirtualAddr virtual address (or CPU address) to be searched in
the map list
@retval EFI_SUCEESS A match was found.
@retval Other A match cannot be found.
**/
FindV2p (
)
{
return EFI_INVALID_PARAMETER;
}
return EFI_SUCCESS;
}
}
return EFI_NOT_FOUND;
}
/**
Unmap the given virtual address and free the memory allocated for the map list
node corresponding to that address.
@param VirtualAddress virtual address (or CPU address) to be unmapped.
@retval EFI_SUCEESS Successfully unmapped.
@retval Other Other errors as indicated.
**/
DelV2p (
)
{
if (VirtualAddress == NULL) {
return EFI_INVALID_PARAMETER;
}
return EFI_NOT_FOUND;
}
//
// Is our node at the head of the list??
//
}
return Status;
}
}
return Status;
}
}
return EFI_NOT_FOUND;
}
/**
The SNP driver entry point.
@param ImageHandle The driver image handle.
@param SystemTable The system table.
@retval EFI_SUCEESS Initialization routine has found UNDI hardware,
loaded it's ROM, and installed a notify event for
the Network Indentifier Interface Protocol
successfully.
@retval Other Return value from HandleProtocol for
DeviceIoProtocol or LoadedImageProtocol
**/
)
{
);
}