2 Provides the basic UNID functions.
4 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which 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.
18 // Global variables defined in this file
20 UNDI_CALL_TABLE api_table
[PXE_OPCODE_LAST_VALID
+1] = { \
21 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,0, (UINT16
)(ANY_STATE
),UNDI_GetState
},\
22 {(UINT16
)(DONT_CHECK
),PXE_DBSIZE_NOT_USED
,0,(UINT16
)(ANY_STATE
),UNDI_Start
},\
23 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,0,MUST_BE_STARTED
,UNDI_Stop
},\
24 {PXE_CPBSIZE_NOT_USED
,sizeof(PXE_DB_GET_INIT_INFO
),0,MUST_BE_STARTED
, UNDI_GetInitInfo
},\
25 {PXE_CPBSIZE_NOT_USED
,sizeof(PXE_DB_GET_CONFIG_INFO
),0,MUST_BE_STARTED
, UNDI_GetConfigInfo
},\
26 {sizeof(PXE_CPB_INITIALIZE
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),MUST_BE_STARTED
,UNDI_Initialize
},\
27 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
,UNDI_Reset
},\
28 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,0, MUST_BE_INITIALIZED
,UNDI_Shutdown
},\
29 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
,UNDI_Interrupt
},\
30 {(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_RecFilter
},\
31 {(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_StnAddr
},\
32 {PXE_CPBSIZE_NOT_USED
, (UINT16
)(DONT_CHECK
), (UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_Statistics
},\
33 {sizeof(PXE_CPB_MCAST_IP_TO_MAC
),sizeof(PXE_DB_MCAST_IP_TO_MAC
), (UINT16
)(DONT_CHECK
),MUST_BE_INITIALIZED
, UNDI_ip2mac
},\
34 {(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_NVData
},\
35 {PXE_CPBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_Status
},\
36 {(UINT16
)(DONT_CHECK
),PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_FillHeader
},\
37 {(UINT16
)(DONT_CHECK
),PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_Transmit
},\
38 {sizeof(PXE_CPB_RECEIVE
),sizeof(PXE_DB_RECEIVE
),0,MUST_BE_INITIALIZED
, UNDI_Receive
} \
42 // end of global variables
47 This routine determines the operational state of the UNDI. It updates the state flags in the
48 Command Descriptor Block based on information derived from the AdapterInfo instance data.
49 To ensure the command has completed successfully, CdbPtr->StatCode will contain the result of
50 the command execution.
51 The CdbPtr->StatFlags will contain a STOPPED, STARTED, or INITIALIZED state once the command
52 has successfully completed.
53 Keep in mind the AdapterInfo->State is the active state of the adapter (based on software
54 interrogation), and the CdbPtr->StateFlags is the passed back information that is reflected
55 to the caller of the UNDI API.
57 @param CdbPtr Pointer to the command descriptor block.
58 @param AdapterInfo Pointer to the NIC data structure information which
59 the UNDI driver is layering on..
67 IN NIC_DATA_INSTANCE
*AdapterInfo
70 CdbPtr
->StatFlags
= (PXE_STATFLAGS
) (CdbPtr
->StatFlags
| AdapterInfo
->State
);
76 This routine is used to change the operational state of the UNDI from stopped to started.
77 It will do this as long as the adapter's state is PXE_STATFLAGS_GET_STATE_STOPPED, otherwise
78 the CdbPtr->StatFlags will reflect a command failure, and the CdbPtr->StatCode will reflect the
79 UNDI as having already been started.
80 This routine is modified to reflect the undi 1.1 specification changes. The
81 changes in the spec are mainly in the callback routines, the new spec adds
82 3 more callbacks and a unique id.
83 Since this UNDI supports both old and new undi specifications,
84 The NIC's data structure is filled in with the callback routines (depending
85 on the version) pointed to in the caller's CpbPtr. This seeds the Delay,
86 Virt2Phys, Block, and Mem_IO for old and new versions and Map_Mem, UnMap_Mem
87 and Sync_Mem routines and a unique id variable for the new version.
88 This is the function which an external entity (SNP, O/S, etc) would call
89 to provide it's I/O abstraction to the UNDI.
90 It's final action is to change the AdapterInfo->State to PXE_STATFLAGS_GET_STATE_STARTED.
92 @param CdbPtr Pointer to the command descriptor block.
93 @param AdapterInfo Pointer to the NIC data structure information which
94 the UNDI driver is layering on..
102 IN NIC_DATA_INSTANCE
*AdapterInfo
105 PXE_CPB_START_30
*CpbPtr
;
106 PXE_CPB_START_31
*CpbPtr_31
;
109 // check if it is already started.
111 if (AdapterInfo
->State
!= PXE_STATFLAGS_GET_STATE_STOPPED
) {
112 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
113 CdbPtr
->StatCode
= PXE_STATCODE_ALREADY_STARTED
;
117 if (CdbPtr
->CPBsize
!= sizeof(PXE_CPB_START_30
) &&
118 CdbPtr
->CPBsize
!= sizeof(PXE_CPB_START_31
)) {
120 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
121 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
125 CpbPtr
= (PXE_CPB_START_30
*) (UINTN
) (CdbPtr
->CPBaddr
);
126 CpbPtr_31
= (PXE_CPB_START_31
*) (UINTN
) (CdbPtr
->CPBaddr
);
128 if (AdapterInfo
->VersionFlag
== 0x30) {
129 AdapterInfo
->Delay_30
= (bsptr_30
) (UINTN
) CpbPtr
->Delay
;
130 AdapterInfo
->Virt2Phys_30
= (virtphys_30
) (UINTN
) CpbPtr
->Virt2Phys
;
131 AdapterInfo
->Block_30
= (block_30
) (UINTN
) CpbPtr
->Block
;
133 // patch for old buggy 3.0 code:
134 // In EFI1.0 undi used to provide the full (absolute) I/O address to the
135 // i/o calls and SNP used to provide a callback that used GlobalIoFncs and
136 // everything worked fine! In EFI 1.1, UNDI is not using the full
137 // i/o or memory address to access the device, The base values for the i/o
138 // and memory address is abstracted by the device specific PciIoFncs and
139 // UNDI only uses the offset values. Since UNDI3.0 cannot provide any
140 // identification to SNP, SNP cannot use nic specific PciIoFncs callback!
142 // To fix this and make undi3.0 work with SNP in EFI1.1 we
143 // use a TmpMemIo function that is defined in init.c
144 // This breaks the runtime driver feature of undi, but what to do
145 // if we have to provide the 3.0 compatibility (including the 3.0 bugs)
147 // This TmpMemIo function also takes a UniqueId parameter
148 // (as in undi3.1 design) and so initialize the UniqueId as well here
149 // Note: AdapterInfo->Mem_Io_30 is just filled for consistency with other
150 // parameters but never used, we only use Mem_Io field in the In/Out routines
153 AdapterInfo
->Mem_Io_30
= (mem_io_30
) (UINTN
) CpbPtr
->Mem_IO
;
154 AdapterInfo
->Mem_Io
= (mem_io
) (UINTN
) TmpMemIo
;
155 AdapterInfo
->Unique_ID
= (UINT64
) (UINTN
) AdapterInfo
;
158 AdapterInfo
->Delay
= (bsptr
) (UINTN
) CpbPtr_31
->Delay
;
159 AdapterInfo
->Virt2Phys
= (virtphys
) (UINTN
) CpbPtr_31
->Virt2Phys
;
160 AdapterInfo
->Block
= (block
) (UINTN
) CpbPtr_31
->Block
;
161 AdapterInfo
->Mem_Io
= (mem_io
) (UINTN
) CpbPtr_31
->Mem_IO
;
163 AdapterInfo
->Map_Mem
= (map_mem
) (UINTN
) CpbPtr_31
->Map_Mem
;
164 AdapterInfo
->UnMap_Mem
= (unmap_mem
) (UINTN
) CpbPtr_31
->UnMap_Mem
;
165 AdapterInfo
->Sync_Mem
= (sync_mem
) (UINTN
) CpbPtr_31
->Sync_Mem
;
166 AdapterInfo
->Unique_ID
= CpbPtr_31
->Unique_ID
;
169 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_STARTED
;
176 This routine is used to change the operational state of the UNDI from started to stopped.
177 It will not do this if the adapter's state is PXE_STATFLAGS_GET_STATE_INITIALIZED, otherwise
178 the CdbPtr->StatFlags will reflect a command failure, and the CdbPtr->StatCode will reflect the
179 UNDI as having already not been shut down.
180 The NIC's data structure will have the Delay, Virt2Phys, and Block, pointers zero'd out..
181 It's final action is to change the AdapterInfo->State to PXE_STATFLAGS_GET_STATE_STOPPED.
183 @param CdbPtr Pointer to the command descriptor block.
184 @param AdapterInfo Pointer to the NIC data structure information which
185 the UNDI driver is layering on..
193 IN NIC_DATA_INSTANCE
*AdapterInfo
196 if (AdapterInfo
->State
== PXE_STATFLAGS_GET_STATE_INITIALIZED
) {
197 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
198 CdbPtr
->StatCode
= PXE_STATCODE_NOT_SHUTDOWN
;
202 AdapterInfo
->Delay_30
= 0;
203 AdapterInfo
->Virt2Phys_30
= 0;
204 AdapterInfo
->Block_30
= 0;
206 AdapterInfo
->Delay
= 0;
207 AdapterInfo
->Virt2Phys
= 0;
208 AdapterInfo
->Block
= 0;
210 AdapterInfo
->Map_Mem
= 0;
211 AdapterInfo
->UnMap_Mem
= 0;
212 AdapterInfo
->Sync_Mem
= 0;
214 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_STOPPED
;
221 This routine is used to retrieve the initialization information that is needed by drivers and
222 applications to initialize the UNDI. This will fill in data in the Data Block structure that is
223 pointed to by the caller's CdbPtr->DBaddr. The fields filled in are as follows:
224 MemoryRequired, FrameDataLen, LinkSpeeds[0-3], NvCount, NvWidth, MediaHeaderLen, HWaddrLen,
225 MCastFilterCnt, TxBufCnt, TxBufSize, RxBufCnt, RxBufSize, IFtype, Duplex, and LoopBack.
226 In addition, the CdbPtr->StatFlags ORs in that this NIC supports cable detection. (APRIORI knowledge)
228 @param CdbPtr Pointer to the command descriptor block.
229 @param AdapterInfo Pointer to the NIC data structure information which
230 the UNDI driver is layering on..
238 IN NIC_DATA_INSTANCE
*AdapterInfo
241 PXE_DB_GET_INIT_INFO
*DbPtr
;
243 DbPtr
= (PXE_DB_GET_INIT_INFO
*) (UINTN
) (CdbPtr
->DBaddr
);
245 DbPtr
->MemoryRequired
= MEMORY_NEEDED
;
246 DbPtr
->FrameDataLen
= PXE_MAX_TXRX_UNIT_ETHER
;
247 DbPtr
->LinkSpeeds
[0] = 10;
248 DbPtr
->LinkSpeeds
[1] = 100;
249 DbPtr
->LinkSpeeds
[2] = DbPtr
->LinkSpeeds
[3] = 0;
250 DbPtr
->NvCount
= MAX_EEPROM_LEN
;
252 DbPtr
->MediaHeaderLen
= PXE_MAC_HEADER_LEN_ETHER
;
253 DbPtr
->HWaddrLen
= PXE_HWADDR_LEN_ETHER
;
254 DbPtr
->MCastFilterCnt
= MAX_MCAST_ADDRESS_CNT
;
256 DbPtr
->TxBufCnt
= TX_BUFFER_COUNT
;
257 DbPtr
->TxBufSize
= (UINT16
) sizeof (TxCB
);
258 DbPtr
->RxBufCnt
= RX_BUFFER_COUNT
;
259 DbPtr
->RxBufSize
= (UINT16
) sizeof (RxFD
);
261 DbPtr
->IFtype
= PXE_IFTYPE_ETHERNET
;
262 DbPtr
->SupportedDuplexModes
= PXE_DUPLEX_ENABLE_FULL_SUPPORTED
|
263 PXE_DUPLEX_FORCE_FULL_SUPPORTED
;
264 DbPtr
->SupportedLoopBackModes
= PXE_LOOPBACK_INTERNAL_SUPPORTED
|
265 PXE_LOOPBACK_EXTERNAL_SUPPORTED
;
267 CdbPtr
->StatFlags
|= (PXE_STATFLAGS_CABLE_DETECT_SUPPORTED
|
268 PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED
);
274 This routine is used to retrieve the configuration information about the NIC being controlled by
275 this driver. This will fill in data in the Data Block structure that is pointed to by the caller's CdbPtr->DBaddr.
276 The fields filled in are as follows:
277 DbPtr->pci.BusType, DbPtr->pci.Bus, DbPtr->pci.Device, and DbPtr->pci.
278 In addition, the DbPtr->pci.Config.Dword[0-63] grabs a copy of this NIC's PCI configuration space.
280 @param CdbPtr Pointer to the command descriptor block.
281 @param AdapterInfo Pointer to the NIC data structure information which
282 the UNDI driver is layering on..
290 IN NIC_DATA_INSTANCE
*AdapterInfo
294 PXE_DB_GET_CONFIG_INFO
*DbPtr
;
296 DbPtr
= (PXE_DB_GET_CONFIG_INFO
*) (UINTN
) (CdbPtr
->DBaddr
);
298 DbPtr
->pci
.BusType
= PXE_BUSTYPE_PCI
;
299 DbPtr
->pci
.Bus
= AdapterInfo
->Bus
;
300 DbPtr
->pci
.Device
= AdapterInfo
->Device
;
301 DbPtr
->pci
.Function
= AdapterInfo
->Function
;
303 for (Index
= 0; Index
< MAX_PCI_CONFIG_LEN
; Index
++) {
304 DbPtr
->pci
.Config
.Dword
[Index
] = AdapterInfo
->Config
[Index
];
312 This routine resets the network adapter and initializes the UNDI using the parameters supplied in
313 the CPB. This command must be issued before the network adapter can be setup to transmit and
315 Once the memory requirements of the UNDI are obtained by using the GetInitInfo command, a block
316 of non-swappable memory may need to be allocated. The address of this memory must be passed to
317 UNDI during the Initialize in the CPB. This memory is used primarily for transmit and receive buffers.
318 The fields CableDetect, LinkSpeed, Duplex, LoopBack, MemoryPtr, and MemoryLength are set with information
319 that was passed in the CPB and the NIC is initialized.
320 If the NIC initialization fails, the CdbPtr->StatFlags are updated with PXE_STATFLAGS_COMMAND_FAILED
321 Otherwise, AdapterInfo->State is updated with PXE_STATFLAGS_GET_STATE_INITIALIZED showing the state of
322 the UNDI is now initialized.
324 @param CdbPtr Pointer to the command descriptor block.
325 @param AdapterInfo Pointer to the NIC data structure information which
326 the UNDI driver is layering on..
334 NIC_DATA_INSTANCE
*AdapterInfo
337 PXE_CPB_INITIALIZE
*CpbPtr
;
339 if ((CdbPtr
->OpFlags
!= PXE_OPFLAGS_INITIALIZE_DETECT_CABLE
) &&
340 (CdbPtr
->OpFlags
!= PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE
)) {
341 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
342 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
347 // check if it is already initialized
349 if (AdapterInfo
->State
== PXE_STATFLAGS_GET_STATE_INITIALIZED
) {
350 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
351 CdbPtr
->StatCode
= PXE_STATCODE_ALREADY_INITIALIZED
;
355 CpbPtr
= (PXE_CPB_INITIALIZE
*) (UINTN
) CdbPtr
->CPBaddr
;
357 if (CpbPtr
->MemoryLength
< (UINT32
) MEMORY_NEEDED
) {
358 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
359 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CPB
;
364 // default behaviour is to detect the cable, if the 3rd param is 1,
367 AdapterInfo
->CableDetect
= (UINT8
) ((CdbPtr
->OpFlags
== (UINT16
) PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE
) ? (UINT8
) 0 : (UINT8
) 1);
368 AdapterInfo
->LinkSpeedReq
= (UINT16
) CpbPtr
->LinkSpeed
;
369 AdapterInfo
->DuplexReq
= CpbPtr
->DuplexMode
;
370 AdapterInfo
->LoopBack
= CpbPtr
->LoopBackMode
;
371 AdapterInfo
->MemoryPtr
= CpbPtr
->MemoryAddr
;
372 AdapterInfo
->MemoryLength
= CpbPtr
->MemoryLength
;
374 CdbPtr
->StatCode
= (PXE_STATCODE
) E100bInit (AdapterInfo
);
376 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
377 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
379 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_INITIALIZED
;
387 This routine resets the network adapter and initializes the UNDI using the parameters supplied in
388 the CPB. The transmit and receive queues are emptied and any pending interrupts are cleared.
389 If the NIC reset fails, the CdbPtr->StatFlags are updated with PXE_STATFLAGS_COMMAND_FAILED
391 @param CdbPtr Pointer to the command descriptor block.
392 @param AdapterInfo Pointer to the NIC data structure information which
393 the UNDI driver is layering on..
401 IN NIC_DATA_INSTANCE
*AdapterInfo
404 if (CdbPtr
->OpFlags
!= PXE_OPFLAGS_NOT_USED
&&
405 CdbPtr
->OpFlags
!= PXE_OPFLAGS_RESET_DISABLE_INTERRUPTS
&&
406 CdbPtr
->OpFlags
!= PXE_OPFLAGS_RESET_DISABLE_FILTERS
) {
408 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
409 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
413 CdbPtr
->StatCode
= (UINT16
) E100bReset (AdapterInfo
, CdbPtr
->OpFlags
);
415 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
416 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
422 This routine resets the network adapter and leaves it in a safe state for another driver to
423 initialize. Any pending transmits or receives are lost. Receive filters and external
424 interrupt enables are disabled. Once the UNDI has been shutdown, it can then be stopped
425 or initialized again.
426 If the NIC reset fails, the CdbPtr->StatFlags are updated with PXE_STATFLAGS_COMMAND_FAILED
427 Otherwise, AdapterInfo->State is updated with PXE_STATFLAGS_GET_STATE_STARTED showing the state of
428 the NIC as being started.
430 @param CdbPtr Pointer to the command descriptor block.
431 @param AdapterInfo Pointer to the NIC data structure information which
432 the UNDI driver is layering on..
440 IN NIC_DATA_INSTANCE
*AdapterInfo
444 // do the shutdown stuff here
446 CdbPtr
->StatCode
= (UINT16
) E100bShutdown (AdapterInfo
);
448 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
449 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
451 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_STARTED
;
459 This routine can be used to read and/or change the current external interrupt enable
460 settings. Disabling an external interrupt enable prevents and external (hardware)
461 interrupt from being signaled by the network device. Internally the interrupt events
462 can still be polled by using the UNDI_GetState command.
463 The resulting information on the interrupt state will be passed back in the CdbPtr->StatFlags.
465 @param CdbPtr Pointer to the command descriptor block.
466 @param AdapterInfo Pointer to the NIC data structure information which
467 the UNDI driver is layering on..
475 IN NIC_DATA_INSTANCE
*AdapterInfo
480 IntMask
= (UINT8
)(UINTN
)(CdbPtr
->OpFlags
& (PXE_OPFLAGS_INTERRUPT_RECEIVE
|
481 PXE_OPFLAGS_INTERRUPT_TRANSMIT
|
482 PXE_OPFLAGS_INTERRUPT_COMMAND
|
483 PXE_OPFLAGS_INTERRUPT_SOFTWARE
));
485 switch (CdbPtr
->OpFlags
& PXE_OPFLAGS_INTERRUPT_OPMASK
) {
486 case PXE_OPFLAGS_INTERRUPT_READ
:
489 case PXE_OPFLAGS_INTERRUPT_ENABLE
:
491 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
492 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
496 AdapterInfo
->int_mask
= IntMask
;
497 E100bSetInterruptState (AdapterInfo
);
500 case PXE_OPFLAGS_INTERRUPT_DISABLE
:
502 AdapterInfo
->int_mask
= (UINT16
) (AdapterInfo
->int_mask
& ~(IntMask
));
503 E100bSetInterruptState (AdapterInfo
);
511 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
512 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
516 if ((AdapterInfo
->int_mask
& PXE_OPFLAGS_INTERRUPT_RECEIVE
) != 0) {
517 CdbPtr
->StatFlags
|= PXE_STATFLAGS_INTERRUPT_RECEIVE
;
521 if ((AdapterInfo
->int_mask
& PXE_OPFLAGS_INTERRUPT_TRANSMIT
) != 0) {
522 CdbPtr
->StatFlags
|= PXE_STATFLAGS_INTERRUPT_TRANSMIT
;
526 if ((AdapterInfo
->int_mask
& PXE_OPFLAGS_INTERRUPT_COMMAND
) != 0) {
527 CdbPtr
->StatFlags
|= PXE_STATFLAGS_INTERRUPT_COMMAND
;
536 This routine is used to read and change receive filters and, if supported, read
537 and change multicast MAC address filter list.
539 @param CdbPtr Pointer to the command descriptor block.
540 @param AdapterInfo Pointer to the NIC data structure information which
541 the UNDI driver is layering on..
549 IN NIC_DATA_INSTANCE
*AdapterInfo
554 PXE_DB_RECEIVE_FILTERS
*DbPtr
;
561 BOOLEAN InvalidMacAddr
;
563 OpFlags
= CdbPtr
->OpFlags
;
564 NewFilter
= (UINT16
) (OpFlags
& 0x1F);
566 switch (OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_OPMASK
) {
567 case PXE_OPFLAGS_RECEIVE_FILTER_READ
:
570 // not expecting a cpb, not expecting any filter bits
572 if ((NewFilter
!= 0) || (CdbPtr
->CPBsize
!= 0)) {
577 if ((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) == 0) {
582 NewFilter
= (UINT16
) (NewFilter
| AdapterInfo
->Rx_Filter
);
584 // all other flags are ignored except mcast_reset
588 case PXE_OPFLAGS_RECEIVE_FILTER_ENABLE
:
590 // there should be atleast one other filter bit set.
592 if (NewFilter
== 0) {
599 if (CdbPtr
->CPBsize
!= 0) {
601 // this must be a multicast address list!
602 // don't accept the list unless selective_mcast is set
603 // don't accept confusing mcast settings with this
605 if (((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST
) == 0) ||
606 ((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) != 0) ||
607 ((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST
) != 0) ||
608 ((CdbPtr
->CPBsize
% sizeof (PXE_MAC_ADDR
)) != 0) ) {
612 MacAddr
= (UINT8
*) ((UINTN
) (CdbPtr
->CPBaddr
));
613 MacCount
= CdbPtr
->CPBsize
/ sizeof (PXE_MAC_ADDR
);
616 // The format of Ethernet multicast address for IPv6 is defined in RFC2464,
617 // for IPv4 is defined in RFC1112. Check whether the address is valid.
619 InvalidMacAddr
= FALSE
;
621 for (; MacCount
-- != 0; MacAddr
+= sizeof (PXE_MAC_ADDR
)) {
622 if (MacAddr
[0] == 0x01) {
624 // This multicast MAC address is mapped from IPv4 address.
626 if (MacAddr
[1] != 0x00 || MacAddr
[2] != 0x5E || (MacAddr
[3] & 0x80) != 0) {
627 InvalidMacAddr
= TRUE
;
629 } else if (MacAddr
[0] == 0x33) {
631 // This multicast MAC address is mapped from IPv6 address.
633 if (MacAddr
[1] != 0x33) {
634 InvalidMacAddr
= TRUE
;
637 InvalidMacAddr
= TRUE
;
640 if (InvalidMacAddr
) {
641 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
642 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CPB
;
649 // check selective mcast case enable case
651 if ((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST
) != 0) {
652 if (((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) != 0) ||
653 ((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST
) != 0) ) {
658 // if no cpb, make sure we have an old list
660 if ((CdbPtr
->CPBsize
== 0) && (AdapterInfo
->mcast_list
.list_len
== 0)) {
665 // if you want to enable anything, you got to have unicast
666 // and you have what you already enabled!
668 NewFilter
= (UINT16
) (NewFilter
| (PXE_OPFLAGS_RECEIVE_FILTER_UNICAST
| AdapterInfo
->Rx_Filter
));
672 case PXE_OPFLAGS_RECEIVE_FILTER_DISABLE
:
675 // mcast list not expected, i.e. no cpb here!
677 if (CdbPtr
->CPBsize
!= PXE_CPBSIZE_NOT_USED
) {
681 NewFilter
= (UINT16
) ((~(CdbPtr
->OpFlags
& 0x1F)) & AdapterInfo
->Rx_Filter
);
689 if ((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) != 0) {
690 AdapterInfo
->mcast_list
.list_len
= 0;
691 NewFilter
&= (~PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST
);
694 E100bSetfilter (AdapterInfo
, NewFilter
, CdbPtr
->CPBaddr
, CdbPtr
->CPBsize
);
698 // give the current mcast list
700 if ((CdbPtr
->DBsize
!= 0) && (AdapterInfo
->mcast_list
.list_len
!= 0)) {
702 // copy the mc list to db
705 DbPtr
= (PXE_DB_RECEIVE_FILTERS
*) (UINTN
) CdbPtr
->DBaddr
;
706 ptr1
= (UINT8
*) (&DbPtr
->MCastList
[0]);
709 // DbPtr->mc_count = AdapterInfo->mcast_list.list_len;
711 copy_len
= (UINT16
) (AdapterInfo
->mcast_list
.list_len
* PXE_MAC_LENGTH
);
713 if (copy_len
> CdbPtr
->DBsize
) {
714 copy_len
= CdbPtr
->DBsize
;
718 ptr2
= (UINT8
*) (&AdapterInfo
->mcast_list
.mc_list
[0]);
719 for (Index
= 0; Index
< copy_len
; Index
++) {
720 ptr1
[Index
] = ptr2
[Index
];
724 // give the stat flags here
726 if (AdapterInfo
->Receive_Started
) {
727 CdbPtr
->StatFlags
= (PXE_STATFLAGS
) (CdbPtr
->StatFlags
| AdapterInfo
->Rx_Filter
);
734 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
735 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
740 This routine is used to get the current station and broadcast MAC addresses, and to change the
741 current station MAC address.
743 @param CdbPtr Pointer to the command descriptor block.
744 @param AdapterInfo Pointer to the NIC data structure information which
745 the UNDI driver is layering on..
753 IN NIC_DATA_INSTANCE
*AdapterInfo
756 PXE_CPB_STATION_ADDRESS
*CpbPtr
;
757 PXE_DB_STATION_ADDRESS
*DbPtr
;
760 if (CdbPtr
->OpFlags
== PXE_OPFLAGS_STATION_ADDRESS_RESET
) {
762 // configure the permanent address.
763 // change the AdapterInfo->CurrentNodeAddress field.
766 &AdapterInfo
->CurrentNodeAddress
[0],
767 &AdapterInfo
->PermNodeAddress
[0],
770 for (Index
= 0; Index
< PXE_MAC_LENGTH
; Index
++) {
771 AdapterInfo
->CurrentNodeAddress
[Index
] = AdapterInfo
->PermNodeAddress
[Index
];
774 E100bSetupIAAddr (AdapterInfo
);
778 if (CdbPtr
->CPBaddr
!= (UINT64
) 0) {
779 CpbPtr
= (PXE_CPB_STATION_ADDRESS
*) (UINTN
) (CdbPtr
->CPBaddr
);
781 // configure the new address
783 for (Index
= 0; Index
< PXE_MAC_LENGTH
; Index
++) {
784 AdapterInfo
->CurrentNodeAddress
[Index
] = CpbPtr
->StationAddr
[Index
];
787 E100bSetupIAAddr (AdapterInfo
);
790 if (CdbPtr
->DBaddr
!= (UINT64
) 0) {
791 DbPtr
= (PXE_DB_STATION_ADDRESS
*) (UINTN
) (CdbPtr
->DBaddr
);
793 // fill it with the new values
795 for (Index
= 0; Index
< PXE_MAC_LENGTH
; Index
++) {
796 DbPtr
->StationAddr
[Index
] = AdapterInfo
->CurrentNodeAddress
[Index
];
797 DbPtr
->BroadcastAddr
[Index
] = AdapterInfo
->BroadcastNodeAddress
[Index
];
798 DbPtr
->PermanentAddr
[Index
] = AdapterInfo
->PermNodeAddress
[Index
];
807 This routine is used to read and clear the NIC traffic statistics. This command is supported only
808 if the !PXE structure's Implementation flags say so.
809 Results will be parsed out in the following manner:
810 CdbPtr->DBaddr.Data[0] R Total Frames (Including frames with errors and dropped frames)
811 CdbPtr->DBaddr.Data[1] R Good Frames (All frames copied into receive buffer)
812 CdbPtr->DBaddr.Data[2] R Undersize Frames (Frames below minimum length for media <64 for ethernet)
813 CdbPtr->DBaddr.Data[4] R Dropped Frames (Frames that were dropped because receive buffers were full)
814 CdbPtr->DBaddr.Data[8] R CRC Error Frames (Frames with alignment or CRC errors)
815 CdbPtr->DBaddr.Data[A] T Total Frames (Including frames with errors and dropped frames)
816 CdbPtr->DBaddr.Data[B] T Good Frames (All frames copied into transmit buffer)
817 CdbPtr->DBaddr.Data[C] T Undersize Frames (Frames below minimum length for media <64 for ethernet)
818 CdbPtr->DBaddr.Data[E] T Dropped Frames (Frames that were dropped because of collisions)
819 CdbPtr->DBaddr.Data[14] T Total Collision Frames (Total collisions on this subnet)
821 @param CdbPtr Pointer to the command descriptor block.
822 @param AdapterInfo Pointer to the NIC data structure information which
823 the UNDI driver is layering on..
831 IN NIC_DATA_INSTANCE
*AdapterInfo
834 if ((CdbPtr
->OpFlags
&~(PXE_OPFLAGS_STATISTICS_RESET
)) != 0) {
835 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
836 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
840 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_STATISTICS_RESET
) != 0) {
842 // Reset the statistics
844 CdbPtr
->StatCode
= (UINT16
) E100bStatistics (AdapterInfo
, 0, 0);
846 CdbPtr
->StatCode
= (UINT16
) E100bStatistics (AdapterInfo
, CdbPtr
->DBaddr
, CdbPtr
->DBsize
);
854 This routine is used to translate a multicast IP address to a multicast MAC address.
855 This results in a MAC address composed of 25 bits of fixed data with the upper 23 bits of the IP
856 address being appended to it. Results passed back in the equivalent of CdbPtr->DBaddr->MAC[0-5].
858 @param CdbPtr Pointer to the command descriptor block.
859 @param AdapterInfo Pointer to the NIC data structure information which
860 the UNDI driver is layering on..
868 IN NIC_DATA_INSTANCE
*AdapterInfo
871 PXE_CPB_MCAST_IP_TO_MAC
*CpbPtr
;
872 PXE_DB_MCAST_IP_TO_MAC
*DbPtr
;
875 CpbPtr
= (PXE_CPB_MCAST_IP_TO_MAC
*) (UINTN
) CdbPtr
->CPBaddr
;
876 DbPtr
= (PXE_DB_MCAST_IP_TO_MAC
*) (UINTN
) CdbPtr
->DBaddr
;
878 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_MCAST_IPV6_TO_MAC
) != 0) {
880 // for now this is not supported
882 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
883 CdbPtr
->StatCode
= PXE_STATCODE_UNSUPPORTED
;
887 TmpPtr
= (UINT8
*) (&CpbPtr
->IP
.IPv4
);
889 // check if the ip given is a mcast IP
891 if ((TmpPtr
[0] & 0xF0) != 0xE0) {
892 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
893 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CPB
;
896 // take the last 23 bits in IP.
897 // be very careful. accessing word on a non-word boundary will hang motherboard codenamed Big Sur
898 // casting the mac array (in the middle) to a UINT32 pointer and accessing
899 // the UINT32 content hung the system...
901 DbPtr
->MAC
[0] = 0x01;
902 DbPtr
->MAC
[1] = 0x00;
903 DbPtr
->MAC
[2] = 0x5e;
904 DbPtr
->MAC
[3] = (UINT8
) (TmpPtr
[1] & 0x7f);
905 DbPtr
->MAC
[4] = (UINT8
) TmpPtr
[2];
906 DbPtr
->MAC
[5] = (UINT8
) TmpPtr
[3];
913 This routine is used to read and write non-volatile storage on the NIC (if supported). The NVRAM
914 could be EEPROM, FLASH, or battery backed RAM.
915 This is an optional function according to the UNDI specification (or will be......)
917 @param CdbPtr Pointer to the command descriptor block.
918 @param AdapterInfo Pointer to the NIC data structure information which
919 the UNDI driver is layering on..
927 IN NIC_DATA_INSTANCE
*AdapterInfo
930 PXE_DB_NVDATA
*DbPtr
;
933 if ((CdbPtr
->OpFlags
== PXE_OPFLAGS_NVDATA_READ
) != 0) {
935 if ((CdbPtr
->DBsize
== PXE_DBSIZE_NOT_USED
) != 0) {
936 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
937 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
941 DbPtr
= (PXE_DB_NVDATA
*) (UINTN
) CdbPtr
->DBaddr
;
943 for (Index
= 0; Index
< MAX_PCI_CONFIG_LEN
; Index
++) {
944 DbPtr
->Data
.Dword
[Index
] = AdapterInfo
->NVData
[Index
];
952 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
953 CdbPtr
->StatCode
= PXE_STATCODE_UNSUPPORTED
;
961 This routine returns the current interrupt status and/or the transmitted buffer addresses.
962 If the current interrupt status is returned, pending interrupts will be acknowledged by this
963 command. Transmitted buffer addresses that are written to the DB are removed from the transmit
965 Normally, this command would be polled with interrupts disabled.
966 The transmit buffers are returned in CdbPtr->DBaddr->TxBufer[0 - NumEntries].
967 The interrupt status is returned in CdbPtr->StatFlags.
969 @param CdbPtr Pointer to the command descriptor block.
970 @param AdapterInfo Pointer to the NIC data structure information which
971 the UNDI driver is layering on..
979 IN NIC_DATA_INSTANCE
*AdapterInfo
982 PXE_DB_GET_STATUS
*DbPtr
;
983 PXE_DB_GET_STATUS TmpGetStatus
;
990 // Fill in temporary GetStatus storage.
992 RxPtr
= &AdapterInfo
->rx_ring
[AdapterInfo
->cur_rx_ind
];
994 if ((RxPtr
->cb_header
.status
& RX_COMPLETE
) != 0) {
995 TmpGetStatus
.RxFrameLen
= RxPtr
->ActualCount
& 0x3fff;
997 TmpGetStatus
.RxFrameLen
= 0;
1000 TmpGetStatus
.reserved
= 0;
1003 // Fill in size of next available receive packet and
1004 // reserved field in caller's DB storage.
1006 DbPtr
= (PXE_DB_GET_STATUS
*) (UINTN
) CdbPtr
->DBaddr
;
1008 if (CdbPtr
->DBsize
> 0 && CdbPtr
->DBsize
< sizeof (UINT32
) * 2) {
1009 CopyMem (DbPtr
, &TmpGetStatus
, CdbPtr
->DBsize
);
1011 CopyMem (DbPtr
, &TmpGetStatus
, sizeof (UINT32
) * 2);
1017 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS
) != 0) {
1019 // DBsize of zero is invalid if Tx buffers are requested.
1021 if (CdbPtr
->DBsize
== 0) {
1022 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1023 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1028 // remember this b4 we overwrite
1030 NumEntries
= (UINT16
) (CdbPtr
->DBsize
- sizeof (UINT64
));
1033 // We already filled in 2 UINT32s.
1035 CdbPtr
->DBsize
= (UINT16
) (sizeof (UINT32
) * 2);
1038 // will claim any hanging free CBs
1040 CheckCBList (AdapterInfo
);
1042 if (AdapterInfo
->xmit_done_head
== AdapterInfo
->xmit_done_tail
) {
1043 CdbPtr
->StatFlags
|= PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY
;
1045 for (Index
= 0; ((Index
< MAX_XMIT_BUFFERS
) && (NumEntries
>= sizeof (UINT64
))); Index
++, NumEntries
-= sizeof (UINT64
)) {
1046 if (AdapterInfo
->xmit_done_head
!= AdapterInfo
->xmit_done_tail
) {
1047 DbPtr
->TxBuffer
[Index
] = AdapterInfo
->xmit_done
[AdapterInfo
->xmit_done_head
];
1048 AdapterInfo
->xmit_done_head
= next (AdapterInfo
->xmit_done_head
);
1049 CdbPtr
->DBsize
+= sizeof (UINT64
);
1056 if (AdapterInfo
->xmit_done_head
!= AdapterInfo
->xmit_done_tail
) {
1057 CdbPtr
->StatFlags
|= PXE_STATFLAGS_DB_WRITE_TRUNCATED
;
1061 // check for a receive buffer and give it's size in db
1067 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_GET_INTERRUPT_STATUS
) != 0) {
1069 Status
= InWord (AdapterInfo
, AdapterInfo
->ioaddr
+ SCBStatus
);
1070 AdapterInfo
->Int_Status
= (UINT16
) (AdapterInfo
->Int_Status
| Status
);
1073 // acknoledge the interrupts
1075 OutWord (AdapterInfo
, (UINT16
) (Status
& 0xfc00), (UINT32
) (AdapterInfo
->ioaddr
+ SCBStatus
));
1078 // report all the outstanding interrupts
1080 Status
= AdapterInfo
->Int_Status
;
1081 if ((Status
& SCB_STATUS_FR
) != 0) {
1082 CdbPtr
->StatFlags
|= PXE_STATFLAGS_GET_STATUS_RECEIVE
;
1085 if ((Status
& SCB_STATUS_SWI
) != 0) {
1086 CdbPtr
->StatFlags
|= PXE_STATFLAGS_GET_STATUS_SOFTWARE
;
1091 // Return current media status
1093 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_GET_MEDIA_STATUS
) != 0) {
1094 AdapterInfo
->PhyAddress
= 0xFF;
1095 AdapterInfo
->CableDetect
= 1;
1097 if (!PhyDetect (AdapterInfo
)) {
1098 CdbPtr
->StatFlags
|= PXE_STATFLAGS_GET_STATUS_NO_MEDIA
;
1107 This routine is used to fill media header(s) in transmit packet(s).
1108 Copies the MAC address into the media header whether it is dealing
1109 with fragmented or non-fragmented packets.
1111 @param CdbPtr Pointer to the command descriptor block.
1112 @param AdapterInfo Pointer to the NIC data structure information which
1113 the UNDI driver is layering on..
1121 IN NIC_DATA_INSTANCE
*AdapterInfo
1124 PXE_CPB_FILL_HEADER
*Cpb
;
1125 PXE_CPB_FILL_HEADER_FRAGMENTED
*Cpbf
;
1126 EtherHeader
*MacHeader
;
1129 if (CdbPtr
->CPBsize
== PXE_CPBSIZE_NOT_USED
) {
1130 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1131 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1135 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_FILL_HEADER_FRAGMENTED
) != 0) {
1136 Cpbf
= (PXE_CPB_FILL_HEADER_FRAGMENTED
*) (UINTN
) CdbPtr
->CPBaddr
;
1139 // assume 1st fragment is big enough for the mac header
1141 if ((Cpbf
->FragCnt
== 0) || (Cpbf
->FragDesc
[0].FragLen
< PXE_MAC_HEADER_LEN_ETHER
)) {
1145 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1146 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1150 MacHeader
= (EtherHeader
*) (UINTN
) Cpbf
->FragDesc
[0].FragAddr
;
1152 // we don't swap the protocol bytes
1154 MacHeader
->type
= Cpbf
->Protocol
;
1156 for (Index
= 0; Index
< PXE_HWADDR_LEN_ETHER
; Index
++) {
1157 MacHeader
->dest_addr
[Index
] = Cpbf
->DestAddr
[Index
];
1158 MacHeader
->src_addr
[Index
] = Cpbf
->SrcAddr
[Index
];
1161 Cpb
= (PXE_CPB_FILL_HEADER
*) (UINTN
) CdbPtr
->CPBaddr
;
1163 MacHeader
= (EtherHeader
*) (UINTN
) Cpb
->MediaHeader
;
1165 // we don't swap the protocol bytes
1167 MacHeader
->type
= Cpb
->Protocol
;
1169 for (Index
= 0; Index
< PXE_HWADDR_LEN_ETHER
; Index
++) {
1170 MacHeader
->dest_addr
[Index
] = Cpb
->DestAddr
[Index
];
1171 MacHeader
->src_addr
[Index
] = Cpb
->SrcAddr
[Index
];
1180 This routine is used to place a packet into the transmit queue. The data buffers given to
1181 this command are to be considered locked and the application or network driver loses
1182 ownership of these buffers and must not free or relocate them until the ownership returns.
1183 When the packets are transmitted, a transmit complete interrupt is generated (if interrupts
1184 are disabled, the transmit interrupt status is still set and can be checked using the UNDI_Status
1186 Some implementations and adapters support transmitting multiple packets with one transmit
1187 command. If this feature is supported, the transmit CPBs can be linked in one transmit
1189 All UNDIs support fragmented frames, now all network devices or protocols do. If a fragmented
1190 frame CPB is given to UNDI and the network device does not support fragmented frames
1191 (see !PXE.Implementation flag), the UNDI will have to copy the fragments into a local buffer
1192 before transmitting.
1194 @param CdbPtr Pointer to the command descriptor block.
1195 @param AdapterInfo Pointer to the NIC data structure information which
1196 the UNDI driver is layering on..
1204 IN NIC_DATA_INSTANCE
*AdapterInfo
1208 if (CdbPtr
->CPBsize
== PXE_CPBSIZE_NOT_USED
) {
1209 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1210 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1214 CdbPtr
->StatCode
= (PXE_STATCODE
) E100bTransmit (AdapterInfo
, CdbPtr
->CPBaddr
, CdbPtr
->OpFlags
);
1216 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
1217 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1225 When the network adapter has received a frame, this command is used to copy the frame
1226 into the driver/application storage location. Once a frame has been copied, it is
1227 removed from the receive queue.
1229 @param CdbPtr Pointer to the command descriptor block.
1230 @param AdapterInfo Pointer to the NIC data structure information which
1231 the UNDI driver is layering on..
1239 IN NIC_DATA_INSTANCE
*AdapterInfo
1244 // check if RU has started...
1246 if (!AdapterInfo
->Receive_Started
) {
1247 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1248 CdbPtr
->StatCode
= PXE_STATCODE_NOT_INITIALIZED
;
1253 CdbPtr
->StatCode
= (UINT16
) E100bReceive (AdapterInfo
, CdbPtr
->CPBaddr
, CdbPtr
->DBaddr
);
1254 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
1255 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1265 This is the main SW UNDI API entry using the newer nii protocol.
1266 The parameter passed in is a 64 bit flat model virtual
1267 address of the cdb. We then jump into the common routine for both old and
1268 new nii protocol entries.
1270 @param CdbPtr Pointer to the command descriptor block.
1271 @param AdapterInfo Pointer to the NIC data structure information which
1272 the UNDI driver is layering on..
1277 // TODO: cdb - add argument and description to function comment
1285 NIC_DATA_INSTANCE
*AdapterInfo
;
1287 if (cdb
== (UINT64
) 0) {
1292 CdbPtr
= (PXE_CDB
*) (UINTN
) cdb
;
1294 if (CdbPtr
->IFnum
>= (pxe_31
->IFcnt
| pxe_31
->IFcntExt
<< 8) ) {
1295 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1296 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1300 AdapterInfo
= &(UNDI32DeviceList
[CdbPtr
->IFnum
]->NicInfo
);
1302 // entering from older entry point
1304 AdapterInfo
->VersionFlag
= 0x31;
1305 UNDI_APIEntry_Common (cdb
);
1310 This is the common routine for both old and new entry point procedures.
1311 The parameter passed in is a 64 bit flat model virtual
1312 address of the cdb. We then jump into the service routine pointed to by the
1315 @param CdbPtr Pointer to the command descriptor block.
1316 @param AdapterInfo Pointer to the NIC data structure information which
1317 the UNDI driver is layering on..
1322 // TODO: cdb - add argument and description to function comment
1324 UNDI_APIEntry_Common (
1329 NIC_DATA_INSTANCE
*AdapterInfo
;
1330 UNDI_CALL_TABLE
*tab_ptr
;
1332 CdbPtr
= (PXE_CDB
*) (UINTN
) cdb
;
1335 // check the OPCODE range
1337 if ((CdbPtr
->OpCode
> PXE_OPCODE_LAST_VALID
) ||
1338 (CdbPtr
->StatCode
!= PXE_STATCODE_INITIALIZE
) ||
1339 (CdbPtr
->StatFlags
!= PXE_STATFLAGS_INITIALIZE
) ||
1340 (CdbPtr
->IFnum
>= (pxe_31
->IFcnt
| pxe_31
->IFcntExt
<< 8))) {
1345 if (CdbPtr
->CPBsize
== PXE_CPBSIZE_NOT_USED
) {
1346 if (CdbPtr
->CPBaddr
!= PXE_CPBADDR_NOT_USED
) {
1349 } else if (CdbPtr
->CPBaddr
== PXE_CPBADDR_NOT_USED
) {
1353 if (CdbPtr
->DBsize
== PXE_DBSIZE_NOT_USED
) {
1354 if (CdbPtr
->DBaddr
!= PXE_DBADDR_NOT_USED
) {
1357 } else if (CdbPtr
->DBaddr
== PXE_DBADDR_NOT_USED
) {
1362 // check if cpbsize and dbsize are as needed
1363 // check if opflags are as expected
1365 tab_ptr
= &api_table
[CdbPtr
->OpCode
];
1367 if (tab_ptr
->cpbsize
!= (UINT16
) (DONT_CHECK
) && tab_ptr
->cpbsize
!= CdbPtr
->CPBsize
) {
1371 if (tab_ptr
->dbsize
!= (UINT16
) (DONT_CHECK
) && tab_ptr
->dbsize
!= CdbPtr
->DBsize
) {
1375 if (tab_ptr
->opflags
!= (UINT16
) (DONT_CHECK
) && tab_ptr
->opflags
!= CdbPtr
->OpFlags
) {
1380 AdapterInfo
= &(UNDI32DeviceList
[CdbPtr
->IFnum
]->NicInfo
);
1383 // check if UNDI_State is valid for this call
1385 if (tab_ptr
->state
!= (UINT16
) (-1)) {
1387 // should atleast be started
1389 if (AdapterInfo
->State
== PXE_STATFLAGS_GET_STATE_STOPPED
) {
1390 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1391 CdbPtr
->StatCode
= PXE_STATCODE_NOT_STARTED
;
1395 // check if it should be initialized
1397 if (tab_ptr
->state
== 2) {
1398 if (AdapterInfo
->State
!= PXE_STATFLAGS_GET_STATE_INITIALIZED
) {
1399 CdbPtr
->StatCode
= PXE_STATCODE_NOT_INITIALIZED
;
1400 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1406 // set the return variable for success case here
1408 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_COMPLETE
;
1409 CdbPtr
->StatCode
= PXE_STATCODE_SUCCESS
;
1411 tab_ptr
->api_ptr (CdbPtr
, AdapterInfo
);
1414 // %% AVL - check for command linking
1417 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1418 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1424 When called with a null NicPtr, this routine decrements the number of NICs
1425 this UNDI is supporting and removes the NIC_DATA_POINTER from the array.
1426 Otherwise, it increments the number of NICs this UNDI is supported and
1427 updates the pxe.Fudge to ensure a proper check sum results.
1429 @param NicPtr Pointer to the NIC data structure.
1436 IN NIC_DATA_INSTANCE
*NicPtr
,
1437 IN PXE_SW_UNDI
*PxePtr
1441 NicNum
= (PxePtr
->IFcnt
| PxePtr
->IFcntExt
<< 8);
1443 if (NicPtr
== NULL
) {
1446 // number of NICs this undi supports
1454 // number of NICs this undi supports
1459 PxePtr
->IFcnt
= (UINT8
)(NicNum
& 0xFF);
1460 PxePtr
->IFcntExt
= (UINT8
) ((NicNum
& 0xFF00) >> 8);
1461 PxePtr
->Fudge
= (UINT8
) (PxePtr
->Fudge
- CalculateSum8 ((VOID
*) PxePtr
, PxePtr
->Len
));
1467 Initialize the !PXE structure
1469 @param PxePtr Pointer to SW_UNDI data structure.
1471 @retval EFI_SUCCESS This driver is added to Controller.
1472 @retval other This driver does not support this device.
1477 IN PXE_SW_UNDI
*PxePtr
1481 // Initialize the !PXE structure
1483 PxePtr
->Signature
= PXE_ROMID_SIGNATURE
;
1484 PxePtr
->Len
= (UINT8
) sizeof (PXE_SW_UNDI
);
1490 // number of NICs this undi supports
1493 PxePtr
->IFcntExt
= 0;
1494 PxePtr
->Rev
= PXE_ROMID_REV
;
1495 PxePtr
->MajorVer
= PXE_ROMID_MAJORVER
;
1496 PxePtr
->MinorVer
= PXE_ROMID_MINORVER
;
1497 PxePtr
->reserved1
= 0;
1499 PxePtr
->Implementation
= PXE_ROMID_IMP_SW_VIRT_ADDR
|
1500 PXE_ROMID_IMP_FRAG_SUPPORTED
|
1501 PXE_ROMID_IMP_CMD_LINK_SUPPORTED
|
1502 PXE_ROMID_IMP_NVDATA_READ_ONLY
|
1503 PXE_ROMID_IMP_STATION_ADDR_SETTABLE
|
1504 PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED
|
1505 PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED
|
1506 PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED
|
1507 PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED
|
1508 PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED
|
1509 PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED
;
1511 PxePtr
->EntryPoint
= (UINT64
) (UINTN
) UNDI_APIEntry_new
;
1512 PxePtr
->MinorVer
= PXE_ROMID_MINORVER_31
;
1514 PxePtr
->reserved2
[0] = 0;
1515 PxePtr
->reserved2
[1] = 0;
1516 PxePtr
->reserved2
[2] = 0;
1518 PxePtr
->BusType
[0] = PXE_BUSTYPE_PCI
;
1520 PxePtr
->Fudge
= (UINT8
) (PxePtr
->Fudge
- CalculateSum8 ((VOID
*) PxePtr
, PxePtr
->Len
));