2 Implementation of transmitting a packet.
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed
6 and made available under the terms and conditions of the BSD License which
7 accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 Call UNDI to create the meadia header for the given data buffer.
21 @param Snp Pointer to SNP driver structure.
22 @param MacHeaderPtr Address where the media header will be filled in.
23 @param HeaderSize Size of the memory at MacHeaderPtr.
24 @param Buffer Data buffer pointer.
25 @param BufferSize Size of data in the Buffer
26 @param DestAddr Address of the destination mac address buffer.
27 @param SrcAddr Address of the source mac address buffer.
28 @param ProtocolPtr Address of the protocol type.
30 @retval EFI_SUCCESS Successfully completed the undi call.
31 @retval Other Error return from undi call.
41 EFI_MAC_ADDRESS
*DestAddr
,
42 EFI_MAC_ADDRESS
*SrcAddr
,
46 PXE_CPB_FILL_HEADER_FRAGMENTED
*Cpb
;
49 if (SrcAddr
!= NULL
) {
51 (VOID
*) Cpb
->SrcAddr
,
53 Snp
->Mode
.HwAddressSize
57 (VOID
*) Cpb
->SrcAddr
,
58 (VOID
*) &(Snp
->Mode
.CurrentAddress
),
59 Snp
->Mode
.HwAddressSize
64 (VOID
*) Cpb
->DestAddr
,
66 Snp
->Mode
.HwAddressSize
70 // we need to do the byte swapping
72 Cpb
->Protocol
= (UINT16
) PXE_SWAP_UINT16 (*ProtocolPtr
);
74 Cpb
->PacketLen
= (UINT32
) (BufferSize
);
75 Cpb
->MediaHeaderLen
= (UINT16
) HeaderSize
;
80 Cpb
->FragDesc
[0].FragAddr
= (UINT64
)(UINTN
) MacHeaderPtr
;
81 Cpb
->FragDesc
[0].FragLen
= (UINT32
) HeaderSize
;
82 Cpb
->FragDesc
[1].FragAddr
= (UINT64
)(UINTN
) Buffer
;
83 Cpb
->FragDesc
[1].FragLen
= (UINT32
) BufferSize
;
85 Cpb
->FragDesc
[0].reserved
= Cpb
->FragDesc
[1].reserved
= 0;
87 Snp
->Cdb
.OpCode
= PXE_OPCODE_FILL_HEADER
;
88 Snp
->Cdb
.OpFlags
= PXE_OPFLAGS_FILL_HEADER_FRAGMENTED
;
90 Snp
->Cdb
.DBsize
= PXE_DBSIZE_NOT_USED
;
91 Snp
->Cdb
.DBaddr
= PXE_DBADDR_NOT_USED
;
93 Snp
->Cdb
.CPBsize
= (UINT16
) sizeof (PXE_CPB_FILL_HEADER_FRAGMENTED
);
94 Snp
->Cdb
.CPBaddr
= (UINT64
)(UINTN
) Cpb
;
96 Snp
->Cdb
.StatCode
= PXE_STATCODE_INITIALIZE
;
97 Snp
->Cdb
.StatFlags
= PXE_STATFLAGS_INITIALIZE
;
98 Snp
->Cdb
.IFnum
= Snp
->IfNum
;
99 Snp
->Cdb
.Control
= PXE_CONTROL_LAST_CDB_IN_LIST
;
102 // Issue UNDI command and check result.
104 DEBUG ((EFI_D_NET
, "\nSnp->undi.fill_header() "));
106 (*Snp
->IssueUndi32Command
) ((UINT64
) (UINTN
) &Snp
->Cdb
);
108 switch (Snp
->Cdb
.StatCode
) {
109 case PXE_STATCODE_SUCCESS
:
112 case PXE_STATCODE_INVALID_PARAMETER
:
115 "\nSnp->undi.fill_header() %xh:%xh\n",
120 return EFI_INVALID_PARAMETER
;
125 "\nSnp->undi.fill_header() %xh:%xh\n",
130 return EFI_DEVICE_ERROR
;
136 This routine calls undi to transmit the given data buffer
138 @param Snp pointer to SNP driver structure
139 @param Buffer data buffer pointer
140 @param BufferSize Size of data in the Buffer
142 @retval EFI_SUCCESS if successfully completed the undi call
143 @retval Other error return from undi call.
153 PXE_CPB_TRANSMIT
*Cpb
;
157 Cpb
->FrameAddr
= (UINT64
) (UINTN
) Buffer
;
158 Cpb
->DataLen
= (UINT32
) BufferSize
;
160 Cpb
->MediaheaderLen
= 0;
163 Snp
->Cdb
.OpFlags
= PXE_OPFLAGS_TRANSMIT_WHOLE
;
165 Snp
->Cdb
.CPBsize
= (UINT16
) sizeof (PXE_CPB_TRANSMIT
);
166 Snp
->Cdb
.CPBaddr
= (UINT64
)(UINTN
) Cpb
;
168 Snp
->Cdb
.OpCode
= PXE_OPCODE_TRANSMIT
;
169 Snp
->Cdb
.DBsize
= PXE_DBSIZE_NOT_USED
;
170 Snp
->Cdb
.DBaddr
= PXE_DBADDR_NOT_USED
;
172 Snp
->Cdb
.StatCode
= PXE_STATCODE_INITIALIZE
;
173 Snp
->Cdb
.StatFlags
= PXE_STATFLAGS_INITIALIZE
;
174 Snp
->Cdb
.IFnum
= Snp
->IfNum
;
175 Snp
->Cdb
.Control
= PXE_CONTROL_LAST_CDB_IN_LIST
;
178 // Issue UNDI command and check result.
180 DEBUG ((EFI_D_NET
, "\nSnp->undi.transmit() "));
181 DEBUG ((EFI_D_NET
, "\nSnp->Cdb.OpCode == %x", Snp
->Cdb
.OpCode
));
182 DEBUG ((EFI_D_NET
, "\nSnp->Cdb.CPBaddr == %LX", Snp
->Cdb
.CPBaddr
));
183 DEBUG ((EFI_D_NET
, "\nSnp->Cdb.DBaddr == %LX", Snp
->Cdb
.DBaddr
));
184 DEBUG ((EFI_D_NET
, "\nCpb->FrameAddr == %LX\n", Cpb
->FrameAddr
));
186 (*Snp
->IssueUndi32Command
) ((UINT64
) (UINTN
) &Snp
->Cdb
);
188 DEBUG ((EFI_D_NET
, "\nexit Snp->undi.transmit() "));
189 DEBUG ((EFI_D_NET
, "\nSnp->Cdb.StatCode == %r", Snp
->Cdb
.StatCode
));
192 // we will unmap the buffers in get_status call, not here
194 switch (Snp
->Cdb
.StatCode
) {
195 case PXE_STATCODE_SUCCESS
:
198 case PXE_STATCODE_BUFFER_FULL
:
199 case PXE_STATCODE_QUEUE_FULL
:
200 case PXE_STATCODE_BUSY
:
201 Status
= EFI_NOT_READY
;
205 Status
= EFI_DEVICE_ERROR
;
210 "\nSnp->undi.transmit() %xh:%xh\n",
219 Places a packet in the transmit queue of a network interface.
221 This function places the packet specified by Header and Buffer on the transmit
222 queue. If HeaderSize is nonzero and HeaderSize is not equal to
223 This->Mode->MediaHeaderSize, then EFI_INVALID_PARAMETER will be returned. If
224 BufferSize is less than This->Mode->MediaHeaderSize, then EFI_BUFFER_TOO_SMALL
225 will be returned. If Buffer is NULL, then EFI_INVALID_PARAMETER will be
226 returned. If HeaderSize is nonzero and DestAddr or Protocol is NULL, then
227 EFI_INVALID_PARAMETER will be returned. If the transmit engine of the network
228 interface is busy, then EFI_NOT_READY will be returned. If this packet can be
229 accepted by the transmit engine of the network interface, the packet contents
230 specified by Buffer will be placed on the transmit queue of the network
231 interface, and EFI_SUCCESS will be returned. GetStatus() can be used to
232 determine when the packet has actually been transmitted. The contents of the
233 Buffer must not be modified until the packet has actually been transmitted.
234 The Transmit() function performs nonblocking I/O. A caller who wants to perform
235 blocking I/O, should call Transmit(), and then GetStatus() until the
236 transmitted buffer shows up in the recycled transmit buffer.
237 If the driver has not been initialized, EFI_DEVICE_ERROR will be returned.
239 @param This A pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
240 @param HeaderSize The size, in bytes, of the media header to be filled in by the
241 Transmit() function. If HeaderSize is nonzero, then it must
242 be equal to This->Mode->MediaHeaderSize and the DestAddr and
243 Protocol parameters must not be NULL.
244 @param BufferSize The size, in bytes, of the entire packet (media header and
245 data) to be transmitted through the network interface.
246 @param Buffer A pointer to the packet (media header followed by data) to be
247 transmitted. This parameter cannot be NULL. If HeaderSize is
248 zero, then the media header in Buffer must already be filled
249 in by the caller. If HeaderSize is nonzero, then the media
250 header will be filled in by the Transmit() function.
251 @param SrcAddr The source HW MAC address. If HeaderSize is zero, then this
252 parameter is ignored. If HeaderSize is nonzero and SrcAddr
253 is NULL, then This->Mode->CurrentAddress is used for the
254 source HW MAC address.
255 @param DestAddr The destination HW MAC address. If HeaderSize is zero, then
256 this parameter is ignored.
257 @param Protocol The type of header to build. If HeaderSize is zero, then this
258 parameter is ignored. See RFC 1700, section "Ether Types,"
261 @retval EFI_SUCCESS The packet was placed on the transmit queue.
262 @retval EFI_NOT_STARTED The network interface has not been started.
263 @retval EFI_NOT_READY The network interface is too busy to accept this
265 @retval EFI_BUFFER_TOO_SMALL The BufferSize parameter is too small.
266 @retval EFI_INVALID_PARAMETER One or more of the parameters has an unsupported
268 @retval EFI_DEVICE_ERROR The command could not be sent to the network interface.
269 @retval EFI_UNSUPPORTED This function is not supported by the network interface.
275 IN EFI_SIMPLE_NETWORK_PROTOCOL
*This
,
279 IN EFI_MAC_ADDRESS
*SrcAddr
, OPTIONAL
280 IN EFI_MAC_ADDRESS
*DestAddr
, OPTIONAL
281 IN UINT16
*Protocol OPTIONAL
289 return EFI_INVALID_PARAMETER
;
292 Snp
= EFI_SIMPLE_NETWORK_DEV_FROM_THIS (This
);
294 OldTpl
= gBS
->RaiseTPL (TPL_CALLBACK
);
297 return EFI_DEVICE_ERROR
;
300 switch (Snp
->Mode
.State
) {
301 case EfiSimpleNetworkInitialized
:
304 case EfiSimpleNetworkStopped
:
305 Status
= EFI_NOT_STARTED
;
309 Status
= EFI_DEVICE_ERROR
;
313 if (Buffer
== NULL
) {
314 Status
= EFI_INVALID_PARAMETER
;
318 if (BufferSize
< Snp
->Mode
.MediaHeaderSize
) {
319 Status
= EFI_BUFFER_TOO_SMALL
;
324 // if the HeaderSize is non-zero, we need to fill up the header and for that
325 // we need the destination address and the protocol
327 if (HeaderSize
!= 0) {
328 if (HeaderSize
!= Snp
->Mode
.MediaHeaderSize
|| DestAddr
== 0 || Protocol
== 0) {
329 Status
= EFI_INVALID_PARAMETER
;
333 Status
= PxeFillHeader (
337 (UINT8
*) Buffer
+ HeaderSize
,
338 BufferSize
- HeaderSize
,
344 if (EFI_ERROR (Status
)) {
349 Status
= PxeTransmit (Snp
, Buffer
, BufferSize
);
352 gBS
->RestoreTPL (OldTpl
);