4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Implementation of transmitting a packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2004 - 2007, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncand made available under the terms and conditions of the BSD License which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncaccompanies 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 Call UNDI to create the meadia header for the given data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Snp Pointer to SNP driver structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MacHeaderPtr Address where the media header will be filled in.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HeaderSize Size of the memory at MacHeaderPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer Data buffer pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize Size of data in the Buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DestAddr Address of the destination mac address buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SrcAddr Address of the source mac address buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ProtocolPtr Address of the protocol type.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Successfully completed the undi call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Other Error return from undi call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we need to do the byte swapping
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cpb->Protocol = (UINT16) PXE_SWAP_UINT16 (*ProtocolPtr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cpb->FragDesc[0].FragAddr = (UINT64)(UINTN) MacHeaderPtr;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cpb->FragDesc[1].FragAddr = (UINT64)(UINTN) Buffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Cpb->FragDesc[0].reserved = Cpb->FragDesc[1].reserved = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->Cdb.OpFlags = PXE_OPFLAGS_FILL_HEADER_FRAGMENTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_FILL_HEADER_FRAGMENTED);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Issue UNDI command and check result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (*Snp->IssueUndi32Command) ((UINT64) (UINTN) &Snp->Cdb);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "\nSnp->undi.fill_header() %xh:%xh\n",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "\nSnp->undi.fill_header() %xh:%xh\n",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This routine calls undi to transmit the given data buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Snp pointer to SNP driver structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer data buffer pointer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize Size of data in the Buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS if successfully completed the undi call
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Other error return from undi call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Snp->Cdb.CPBsize = (UINT16) sizeof (PXE_CPB_TRANSMIT);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Issue UNDI command and check result.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_NET, "\nSnp->Cdb.OpCode == %x", Snp->Cdb.OpCode));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_NET, "\nSnp->Cdb.CPBaddr == %LX", Snp->Cdb.CPBaddr));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_NET, "\nSnp->Cdb.DBaddr == %LX", Snp->Cdb.DBaddr));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_NET, "\nCpb->FrameAddr == %LX\n", Cpb->FrameAddr));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (*Snp->IssueUndi32Command) ((UINT64) (UINTN) &Snp->Cdb);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_NET, "\nexit Snp->undi.transmit() "));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DEBUG ((EFI_D_NET, "\nSnp->Cdb.StatCode == %r", Snp->Cdb.StatCode));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we will unmap the buffers in get_status call, not here
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync "\nSnp->undi.transmit() %xh:%xh\n",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Places a packet in the transmit queue of a network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function places the packet specified by Header and Buffer on the transmit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync queue. If HeaderSize is nonzero and HeaderSize is not equal to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interface is busy, then EFI_NOT_READY will be returned. If this packet can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync accepted by the transmit engine of the network interface, the packet contents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Buffer will be placed on the transmit queue of the network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync interface, and EFI_SUCCESS will be returned. GetStatus() can be used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync determine when the packet has actually been transmitted. The contents of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer must not be modified until the packet has actually been transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Transmit() function performs nonblocking I/O. A caller who wants to perform
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync blocking I/O, should call Transmit(), and then GetStatus() until the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmitted buffer shows up in the recycled transmit buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param HeaderSize The size, in bytes, of the media header to be filled in by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Transmit() function. If HeaderSize is nonzero, then it must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be equal to This->Mode->MediaHeaderSize and the DestAddr and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol parameters must not be NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param BufferSize The size, in bytes, of the entire packet (media header and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data) to be transmitted through the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer A pointer to the packet (media header followed by data) to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmitted. This parameter cannot be NULL. If HeaderSize is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync zero, then the media header in Buffer must already be filled
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in by the caller. If HeaderSize is nonzero, then the media
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync header will be filled in by the Transmit() function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is ignored. If HeaderSize is nonzero and SrcAddr
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is NULL, then This->Mode->CurrentAddress is used for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync source HW MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DestAddr The destination HW MAC address. If HeaderSize is zero, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this parameter is ignored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Protocol The type of header to build. If HeaderSize is zero, then this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is ignored. See RFC 1700, section "Ether Types,"
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for examples.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The packet was placed on the transmit queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The network interface has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The network interface is too busy to accept this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmit request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This function is not supported by the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if the HeaderSize is non-zero, we need to fill up the header and for that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we need the destination address and the protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HeaderSize != Snp->Mode.MediaHeaderSize || DestAddr == 0 || Protocol == 0) {