4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file contains two sets of callback routines for undi3.0 and undi3.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the callback routines for Undi3.1 have an extra parameter UniqueId which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stores the interface context for the NIC that snp is trying to talk.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Global variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// these 2 global variables are used only for 3.0 undi. we could not place
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// them in the snp structure because we will not know which snp structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// in the callback context!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// End Global variables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Convert a virtual or CPU address provided by SNP to a physical or device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time. Since EFI uses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the identical mapping, this routine returns the physical address same as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync virtual address for most of the addresses. an address above 4GB cannot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync generally be used as a device address, it needs to be mapped to a lower
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync physical address. This routine does not call the map routine itself, but it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync assumes that the mapping was done at the time of providing the address to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UNDI. This routine just looks up the address in a map table (which is the v2p
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync structure chain).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CpuAddr Virtual address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceAddrPtr Pointer to the physical address, or 0 in case of any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Do nothing if virtual address is zero or physical pointer is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // No need to map if the virtual address is within 4GB limit since
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // EFI uses identical mapping
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_NET, "\nv2p: Null virtual address or physical pointer.\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // SNP creates a vaddr tp paddr mapping at the time of calling undi with any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // big address, this callback routine just looks up in the v2p list and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // returns the physical address for any given virtual address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (FindV2p (&V2p, (VOID *) (UINTN) CpuAddr) != EFI_SUCCESS) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *(UINT64 *) (UINTN) DeviceAddrPtr = V2p->PhysicalAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Acquire or release a lock of an exclusive access to a critical section of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Enable Non-zero indicates acquire; Zero indicates release.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // tcpip was calling snp at tpl_notify and if we acquire a lock that was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // created at a lower level (TPL_CALLBACK) it gives an assert!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Delay MicroSeconds of micro seconds.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MicroSeconds Number of micro seconds to pause, ususlly multiple of 10.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IO routine for UNDI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time. This is not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync currently being used by UNDI3.0 because Undi3.0 uses io/mem offsets relative
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to the beginning of the device io/mem address and so it needs to use the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PCI_IO_FUNCTION that abstracts the start of the device's io/mem addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Since SNP cannot retrive the context of the undi3.0 interface it cannot use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the PCI_IO_FUNCTION that specific for that NIC and uses one global IO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync functions structure, this does not work. This however works fine for EFI1.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Undis because they use absolute addresses for io/mem access.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ReadOrWrite Indicates read or write, IO or Memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumBytes Number of bytes to read or write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Address IO or memory address to read from or write to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferAddr Memory location to read into or that contains the bytes to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0, // BAR 0, Memory base address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0, // BAR 0, Memory base address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Acquire or release a lock of the exclusive access to a critical section of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI3.1 at undi_start time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync New callbacks for 3.1: there won't be a virtual2physical callback for UNDI 3.1
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync because undi3.1 uses the MemMap call to map the required address by itself!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync store Undi interface context (Undi does not read or write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this variable).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Enable Non-zero indicates acquire; Zero indicates release.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // tcpip was calling snp at tpl_notify and when we acquire a lock that was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // created at a lower level (TPL_CALLBACK) it gives an assert!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Delay MicroSeconds of micro seconds.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync store Undi interface context (Undi does not read or write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this variable).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MicroSeconds Number of micro seconds to pause, ususlly multiple of 10.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IO routine for UNDI3.1.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to store Undi interface context (Undi does not read or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync write this variable).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ReadOrWrite Indicates read or write, IO or Memory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumBytes Number of bytes to read or write.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MemOrPortAddr IO or memory address to read from or write to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferPtr Memory location to read into or that contains the bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->IoBarIndex, // BAR 1 (for 32bit regs), IO base address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->IoBarIndex, // BAR 1 (for 32bit regs), IO base address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Map a CPU address to a device address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync store Undi interface context (Undi does not read or write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this variable).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CpuAddr Virtual address to be mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumBytes Size of memory to be mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Direction Direction of data flow for this memory's usage:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cpu->device, device->cpu or both ways.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceAddrPtr Pointer to return the mapped device address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DevAddrPtr = (EFI_PHYSICAL_ADDRESS *) (UINTN) DeviceAddrPtr;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DirectionFlag = EfiPciIoOperationBusMasterCommonBuffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // any non zero indicates error!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // find an unused map_list entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->MapList[Index].VirtualAddress = (EFI_PHYSICAL_ADDRESS) CpuAddr;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unmap an address that was previously mapped using map callback.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync store. Undi interface context (Undi does not read or write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this variable).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CpuAddr Virtual address that was mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumBytes Size of memory mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Direction Direction of data flow for this memory's usage:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cpu->device, device->cpu or both ways.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceAddr The mapped device address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Snp->MapList[Index].VirtualAddress == CpuAddr) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_ERROR, "SNP could not find a mapping, failed to unmap.\n"));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->PciIo->Unmap (Snp->PciIo, Snp->MapList[Index].MapCookie);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Synchronize the virtual buffer contents with the mapped buffer contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is a callback routine supplied to UNDI at undi_start time. The virtual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and mapped buffers need not correspond to the same physical memory (especially
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if the virtual address is > 4GB). Depending on the direction for which the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer is mapped, undi will need to synchronize their contents whenever it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync writes to/reads from the buffer using either the cpu address or the device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI does not provide a sync call since virt=physical, we should just do the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync synchronization ourselves here.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param UniqueId This was supplied to UNDI at Undi_Start, SNP uses this to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync store Undi interface context (Undi does not read or write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this variable).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CpuAddr Virtual address that was mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param NumBytes Size of memory mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Direction Direction of data flow for this memory's usage:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cpu->device, device->cpu or both ways.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeviceAddr The mapped device address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CpuAddr == 0) || (DeviceAddr == 0) || (NumBytes == 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (UINTN) CpuAddr, (UINT8 *) (UINTN) DeviceAddr, NumBytes);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) (UINTN) DeviceAddr, (UINT8 *) (UINTN) CpuAddr, NumBytes);