Transmit.c File Reference

#include "Snp.h"

Go to the source code of this file.

Functions
EFI_STATUS	PxeFillHeader (SNP_DRIVER *Snp, VOID *MacHeaderPtr, UINTN HeaderSize, VOID *Buffer, UINTN BufferSize, EFI_MAC_ADDRESS *DestAddr, EFI_MAC_ADDRESS *SrcAddr, UINT16 *ProtocolPtr)
EFI_STATUS	PxeTransmit (SNP_DRIVER *Snp, VOID *Buffer, UINTN BufferSize)
EFI_STATUS EFIAPI	SnpUndi32Transmit (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN UINTN HeaderSize, IN UINTN BufferSize, IN VOID *Buffer, IN EFI_MAC_ADDRESS *SrcAddr OPTIONAL, IN EFI_MAC_ADDRESS *DestAddr OPTIONAL, IN UINT16 *Protocol OPTIONAL)

Detailed Description

Implementation of transmitting a packet.

Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file Transmit.c.

Function Documentation

PxeFillHeader()

EFI_STATUS PxeFillHeader	(	SNP_DRIVER *	Snp,
		VOID *	MacHeaderPtr,
		UINTN	HeaderSize,
		VOID *	Buffer,
		UINTN	BufferSize,
		EFI_MAC_ADDRESS *	DestAddr,
		EFI_MAC_ADDRESS *	SrcAddr,
		UINT16 *	ProtocolPtr
	)

Call UNDI to create the meadia header for the given data buffer.

Parameters

Snp	Pointer to SNP driver structure.
MacHeaderPtr	Address where the media header will be filled in.
HeaderSize	Size of the memory at MacHeaderPtr.
Buffer	Data buffer pointer.
BufferSize	Size of data in the Buffer
DestAddr	Address of the destination mac address buffer.
SrcAddr	Address of the source mac address buffer.
ProtocolPtr	Address of the protocol type.

Return values

EFI_SUCCESS	Successfully completed the undi call.
Other	Error return from undi call.

Definition at line 28 of file Transmit.c.

PxeTransmit()

EFI_STATUS PxeTransmit	(	SNP_DRIVER *	Snp,
		VOID *	Buffer,
		UINTN	BufferSize
	)

This routine calls undi to transmit the given data buffer

Parameters

Snp	pointer to SNP driver structure
Buffer	data buffer pointer
BufferSize	Size of data in the Buffer

Return values

EFI_SUCCESS	if successfully completed the undi call
Other	error return from undi call.

Definition at line 139 of file Transmit.c.

SnpUndi32Transmit()

EFI_STATUS EFIAPI SnpUndi32Transmit	(	IN EFI_SIMPLE_NETWORK_PROTOCOL *	This,
		IN UINTN	HeaderSize,
		IN UINTN	BufferSize,
		IN VOID *	Buffer,
		IN EFI_MAC_ADDRESS *SrcAddr	OPTIONAL,
		IN EFI_MAC_ADDRESS *DestAddr	OPTIONAL,
		IN UINT16 *Protocol	OPTIONAL
	)

Places a packet in the transmit queue of a network interface.

This function places the packet specified by Header and Buffer on the transmit queue. If HeaderSize is nonzero and HeaderSize is not equal to This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network interface is busy, then EFI_NOT_READY will be returned. If this packet can be accepted by the transmit engine of the network interface, the packet contents specified by Buffer will be placed on the transmit queue of the network interface, and EFI_SUCCESS will be returned. GetStatus() can be used to determine when the packet has actually been transmitted. The contents of the Buffer must not be modified until the packet has actually been transmitted. The Transmit() function performs nonblocking I/O. A caller who wants to perform blocking I/O, should call Transmit(), and then GetStatus() until the transmitted buffer shows up in the recycled transmit buffer. If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.

Parameters

This	A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
HeaderSize	The size, in bytes, of the media header to be filled in by the Transmit() function. If HeaderSize is nonzero, then it must be equal to This->Mode->MediaHeaderSize and the DestAddr and Protocol parameters must not be NULL.
BufferSize	The size, in bytes, of the entire packet (media header and data) to be transmitted through the network interface.
Buffer	A pointer to the packet (media header followed by data) to be transmitted. This parameter cannot be NULL. If HeaderSize is zero, then the media header in Buffer must already be filled in by the caller. If HeaderSize is nonzero, then the media header will be filled in by the Transmit() function.
SrcAddr	The source HW MAC address. If HeaderSize is zero, then this parameter is ignored. If HeaderSize is nonzero and SrcAddr is NULL, then This->Mode->CurrentAddress is used for the source HW MAC address.
DestAddr	The destination HW MAC address. If HeaderSize is zero, then this parameter is ignored.
Protocol	The type of header to build. If HeaderSize is zero, then this parameter is ignored. See RFC 1700, section "Ether Types," for examples.

Return values

EFI_SUCCESS	The packet was placed on the transmit queue.
EFI_NOT_STARTED	The network interface has not been started.
EFI_NOT_READY	The network interface is too busy to accept this transmit request.
EFI_BUFFER_TOO_SMALL	The BufferSize parameter is too small.
EFI_INVALID_PARAMETER	One or more of the parameters has an unsupported value.
EFI_DEVICE_ERROR	The command could not be sent to the network interface.
EFI_UNSUPPORTED	This function is not supported by the network interface.

Definition at line 270 of file Transmit.c.