Callback.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
This file contains two sets of callback routines for undi3.0 and undi3.1.
the callback routines for Undi3.1 have an extra parameter UniqueId which
stores the interface context for the NIC that snp is trying to talk.
Copyright (c) 2006 - 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"
//
// Global variables
// these 2 global variables are used only for 3.0 undi. we could not place
// them in the snp structure because we will not know which snp structure
// in the callback context!
//
//
// End Global variables
//
extern EFI_PCI_IO_PROTOCOL *mPciIo;
/**
Convert a virtual or CPU address provided by SNP to a physical or device
address.
This is a callback routine supplied to UNDI at undi_start time. Since EFI uses
the identical mapping, this routine returns the physical address same as the
virtual address for most of the addresses. an address above 4GB cannot
generally be used as a device address, it needs to be mapped to a lower
physical address. This routine does not call the map routine itself, but it
assumes that the mapping was done at the time of providing the address to
UNDI. This routine just looks up the address in a map table (which is the v2p
structure chain).
@param CpuAddr Virtual address.
@param DeviceAddrPtr Pointer to the physical address, or 0 in case of any
error.
**/
)
{
//
// Do nothing if virtual address is zero or physical pointer is NULL.
// No need to map if the virtual address is within 4GB limit since
// EFI uses identical mapping
//
if ((CpuAddr == 0) || (DeviceAddrPtr == 0)) {
return ;
}
if (CpuAddr < FOUR_GIGABYTES) {
return ;
}
//
// SNP creates a vaddr tp paddr mapping at the time of calling undi with any
// big address, this callback routine just looks up in the v2p list and
// returns the physical address for any given virtual address.
//
} else {
}
}
/**
Acquire or release a lock of an exclusive access to a critical section of the
This is a callback routine supplied to UNDI at undi_start time.
@param Enable Non-zero indicates acquire; Zero indicates release.
**/
)
{
//
// tcpip was calling snp at tpl_notify and if we acquire a lock that was
// created at a lower level (TPL_CALLBACK) it gives an assert!
//
if (mInitializeLock) {
}
if (Enable != 0) {
EfiAcquireLock (&mLock);
} else {
EfiReleaseLock (&mLock);
}
}
/**
Delay MicroSeconds of micro seconds.
This is a callback routine supplied to UNDI at undi_start time.
@param MicroSeconds Number of micro seconds to pause, ususlly multiple of 10.
**/
)
{
if (MicroSeconds != 0) {
}
}
/**
IO routine for UNDI.
This is a callback routine supplied to UNDI at undi_start time. This is not
Since SNP cannot retrive the context of the undi3.0 interface it cannot use
the PCI_IO_FUNCTION that specific for that NIC and uses one global IO
functions structure, this does not work. This however works fine for EFI1.0
@param ReadOrWrite Indicates read or write, IO or Memory.
@param NumBytes Number of bytes to read or write.
@param Address IO or memory address to read from or write to.
@param BufferAddr Memory location to read into or that contains the bytes to
write.
**/
)
{
switch (NumBytes) {
case 2:
break;
case 4:
break;
case 8:
break;
default:
Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 0;
}
switch (ReadOrWrite) {
case PXE_IO_READ:
1, // BAR 1, IO base address
1, // count
);
break;
case PXE_IO_WRITE:
1, // BAR 1, IO base address
1, // count
);
break;
case PXE_MEM_READ:
0, // BAR 0, Memory base address
1, // count
);
break;
case PXE_MEM_WRITE:
0, // BAR 0, Memory base address
1, // count
);
break;
}
return ;
}
/**
Acquire or release a lock of the exclusive access to a critical section of the
This is a callback routine supplied to UNDI3.1 at undi_start time.
New callbacks for 3.1: there won't be a virtual2physical callback for UNDI 3.1
because undi3.1 uses the MemMap call to map the required address by itself!
@param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
store Undi interface context (Undi does not read or write
this variable).
@param Enable Non-zero indicates acquire; Zero indicates release.
**/
)
{
//
// tcpip was calling snp at tpl_notify and when we acquire a lock that was
// created at a lower level (TPL_CALLBACK) it gives an assert!
//
if (Enable != 0) {
} else {
}
}
/**
Delay MicroSeconds of micro seconds.
This is a callback routine supplied to UNDI at undi_start time.
@param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
store Undi interface context (Undi does not read or write
this variable).
@param MicroSeconds Number of micro seconds to pause, ususlly multiple of 10.
**/
)
{
if (MicroSeconds != 0) {
}
}
/**
IO routine for UNDI3.1.
This is a callback routine supplied to UNDI at undi_start time.
@param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this
to store Undi interface context (Undi does not read or
write this variable).
@param ReadOrWrite Indicates read or write, IO or Memory.
@param NumBytes Number of bytes to read or write.
@param MemOrPortAddr IO or memory address to read from or write to.
@param BufferPtr Memory location to read into or that contains the bytes
to write.
**/
)
{
Width = (EFI_PCI_IO_PROTOCOL_WIDTH) 0;
switch (NumBytes) {
case 2:
break;
case 4:
break;
case 8:
break;
}
switch (ReadOrWrite) {
case PXE_IO_READ:
1, // count
);
break;
case PXE_IO_WRITE:
1, // count
);
break;
case PXE_MEM_READ:
1, // count
);
break;
case PXE_MEM_WRITE:
1, // count
);
break;
}
return ;
}
/**
Map a CPU address to a device address.
This is a callback routine supplied to UNDI at undi_start time.
@param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
store Undi interface context (Undi does not read or write
this variable).
@param CpuAddr Virtual address to be mapped.
@param NumBytes Size of memory to be mapped.
@param Direction Direction of data flow for this memory's usage:
cpu->device, device->cpu or both ways.
@param DeviceAddrPtr Pointer to return the mapped device address.
**/
)
{
if (CpuAddr == 0) {
*DevAddrPtr = 0;
return ;
}
switch (Direction) {
case TO_AND_FROM_DEVICE:
break;
case FROM_DEVICE:
break;
case TO_DEVICE:
break;
default:
*DevAddrPtr = 0;
//
// any non zero indicates error!
//
return ;
}
//
// find an unused map_list entry
//
break;
}
}
if (Index >= MAX_MAP_LENGTH) {
*DevAddrPtr = 0;
return ;
}
&BuffSize,
);
if (Status != EFI_SUCCESS) {
*DevAddrPtr = 0;
}
return ;
}
/**
Unmap an address that was previously mapped using map callback.
This is a callback routine supplied to UNDI at undi_start time.
@param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
store. Undi interface context (Undi does not read or write
this variable).
@param CpuAddr Virtual address that was mapped.
@param NumBytes Size of memory mapped.
@param Direction Direction of data flow for this memory's usage:
cpu->device, device->cpu or both ways.
@param DeviceAddr The mapped device address.
**/
)
{
break;
}
}
if (Index >= MAX_MAP_LENGTH) {
return ;
}
return ;
}
/**
Synchronize the virtual buffer contents with the mapped buffer contents.
This is a callback routine supplied to UNDI at undi_start time. The virtual
and mapped buffers need not correspond to the same physical memory (especially
if the virtual address is > 4GB). Depending on the direction for which the
buffer is mapped, undi will need to synchronize their contents whenever it
address.
EFI does not provide a sync call since virt=physical, we should just do the
synchronization ourselves here.
@param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
store Undi interface context (Undi does not read or write
this variable).
@param CpuAddr Virtual address that was mapped.
@param NumBytes Size of memory mapped.
@param Direction Direction of data flow for this memory's usage:
cpu->device, device->cpu or both ways.
@param DeviceAddr The mapped device address.
**/
)
{
return ;
}
switch (Direction) {
case FROM_DEVICE:
break;
case TO_DEVICE:
break;
}
return ;
}