3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 // TODO: fix comment to add: Module Name: DECODE.C
25 #pragma data_seg("rtdata")
28 // Global variables defined in this file
30 UNDI_CALL_TABLE api_table
[PXE_OPCODE_LAST_VALID
+1] = { \
31 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,0, (UINT16
)(ANY_STATE
),UNDI_GetState
},\
32 {(UINT16
)(DONT_CHECK
),PXE_DBSIZE_NOT_USED
,0,(UINT16
)(ANY_STATE
),UNDI_Start
},\
33 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,0,MUST_BE_STARTED
,UNDI_Stop
},\
34 {PXE_CPBSIZE_NOT_USED
,sizeof(PXE_DB_GET_INIT_INFO
),0,MUST_BE_STARTED
, UNDI_GetInitInfo
},\
35 {PXE_CPBSIZE_NOT_USED
,sizeof(PXE_DB_GET_CONFIG_INFO
),0,MUST_BE_STARTED
, UNDI_GetConfigInfo
},\
36 {sizeof(PXE_CPB_INITIALIZE
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),MUST_BE_STARTED
,UNDI_Initialize
},\
37 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
,UNDI_Reset
},\
38 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,0, MUST_BE_INITIALIZED
,UNDI_Shutdown
},\
39 {PXE_CPBSIZE_NOT_USED
,PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
,UNDI_Interrupt
},\
40 {(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_RecFilter
},\
41 {(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_StnAddr
},\
42 {PXE_CPBSIZE_NOT_USED
, (UINT16
)(DONT_CHECK
), (UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_Statistics
},\
43 {sizeof(PXE_CPB_MCAST_IP_TO_MAC
),sizeof(PXE_DB_MCAST_IP_TO_MAC
), (UINT16
)(DONT_CHECK
),MUST_BE_INITIALIZED
, UNDI_ip2mac
},\
44 {(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_NVData
},\
45 {PXE_CPBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
),(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_Status
},\
46 {(UINT16
)(DONT_CHECK
),PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_FillHeader
},\
47 {(UINT16
)(DONT_CHECK
),PXE_DBSIZE_NOT_USED
,(UINT16
)(DONT_CHECK
), MUST_BE_INITIALIZED
, UNDI_Transmit
},\
48 {sizeof(PXE_CPB_RECEIVE
),sizeof(PXE_DB_RECEIVE
),0,MUST_BE_INITIALIZED
, UNDI_Receive
} \
52 // end of global variables
58 IN NIC_DATA_INSTANCE
*AdapterInfo
63 This routine determines the operational state of the UNDI. It updates the state flags in the
64 Command Descriptor Block based on information derived from the AdapterInfo instance data.
66 To ensure the command has completed successfully, CdbPtr->StatCode will contain the result of
67 the command execution.
69 The CdbPtr->StatFlags will contain a STOPPED, STARTED, or INITIALIZED state once the command
70 has successfully completed.
72 Keep in mind the AdapterInfo->State is the active state of the adapter (based on software
73 interrogation), and the CdbPtr->StateFlags is the passed back information that is reflected
74 to the caller of the UNDI API.
77 CdbPtr - Pointer to the command descriptor block.
78 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
85 CdbPtr
->StatFlags
= (PXE_STATFLAGS
) (CdbPtr
->StatFlags
| AdapterInfo
->State
);
92 IN NIC_DATA_INSTANCE
*AdapterInfo
97 This routine is used to change the operational state of the UNDI from stopped to started.
98 It will do this as long as the adapter's state is PXE_STATFLAGS_GET_STATE_STOPPED, otherwise
99 the CdbPtr->StatFlags will reflect a command failure, and the CdbPtr->StatCode will reflect the
100 UNDI as having already been started.
102 This routine is modified to reflect the undi 1.1 specification changes. The
103 changes in the spec are mainly in the callback routines, the new spec adds
104 3 more callbacks and a unique id.
105 Since this UNDI supports both old and new undi specifications,
106 The NIC's data structure is filled in with the callback routines (depending
107 on the version) pointed to in the caller's CpbPtr. This seeds the Delay,
108 Virt2Phys, Block, and Mem_IO for old and new versions and Map_Mem, UnMap_Mem
109 and Sync_Mem routines and a unique id variable for the new version.
110 This is the function which an external entity (SNP, O/S, etc) would call
111 to provide it's I/O abstraction to the UNDI.
113 It's final action is to change the AdapterInfo->State to PXE_STATFLAGS_GET_STATE_STARTED.
116 CdbPtr - Pointer to the command descriptor block.
117 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
124 PXE_CPB_START_30
*CpbPtr
;
125 PXE_CPB_START_31
*CpbPtr_31
;
128 // check if it is already started.
130 if (AdapterInfo
->State
!= PXE_STATFLAGS_GET_STATE_STOPPED
) {
131 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
132 CdbPtr
->StatCode
= PXE_STATCODE_ALREADY_STARTED
;
136 if (CdbPtr
->CPBsize
!= sizeof(PXE_CPB_START_30
) &&
137 CdbPtr
->CPBsize
!= sizeof(PXE_CPB_START_31
)) {
139 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
140 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
144 CpbPtr
= (PXE_CPB_START_30
*) (UINTN
) (CdbPtr
->CPBaddr
);
145 CpbPtr_31
= (PXE_CPB_START_31
*) (UINTN
) (CdbPtr
->CPBaddr
);
147 if (AdapterInfo
->VersionFlag
== 0x30) {
148 AdapterInfo
->Delay_30
= (bsptr_30
) (UINTN
) CpbPtr
->Delay
;
149 AdapterInfo
->Virt2Phys_30
= (virtphys_30
) (UINTN
) CpbPtr
->Virt2Phys
;
150 AdapterInfo
->Block_30
= (block_30
) (UINTN
) CpbPtr
->Block
;
152 // patch for old buggy 3.0 code:
153 // In EFI1.0 undi used to provide the full (absolute) I/O address to the
154 // i/o calls and SNP used to provide a callback that used GlobalIoFncs and
155 // everything worked fine! In EFI 1.1, UNDI is not using the full
156 // i/o or memory address to access the device, The base values for the i/o
157 // and memory address is abstracted by the device specific PciIoFncs and
158 // UNDI only uses the offset values. Since UNDI3.0 cannot provide any
159 // identification to SNP, SNP cannot use nic specific PciIoFncs callback!
161 // To fix this and make undi3.0 work with SNP in EFI1.1 we
162 // use a TmpMemIo function that is defined in init.c
163 // This breaks the runtime driver feature of undi, but what to do
164 // if we have to provide the 3.0 compatibility (including the 3.0 bugs)
166 // This TmpMemIo function also takes a UniqueId parameter
167 // (as in undi3.1 design) and so initialize the UniqueId as well here
168 // Note: AdapterInfo->Mem_Io_30 is just filled for consistency with other
169 // parameters but never used, we only use Mem_Io field in the In/Out routines
172 AdapterInfo
->Mem_Io_30
= (mem_io_30
) (UINTN
) CpbPtr
->Mem_IO
;
173 AdapterInfo
->Mem_Io
= (mem_io
) (UINTN
) TmpMemIo
;
174 AdapterInfo
->Unique_ID
= (UINT64
) (UINTN
) AdapterInfo
;
177 AdapterInfo
->Delay
= (bsptr
) (UINTN
) CpbPtr_31
->Delay
;
178 AdapterInfo
->Virt2Phys
= (virtphys
) (UINTN
) CpbPtr_31
->Virt2Phys
;
179 AdapterInfo
->Block
= (block
) (UINTN
) CpbPtr_31
->Block
;
180 AdapterInfo
->Mem_Io
= (mem_io
) (UINTN
) CpbPtr_31
->Mem_IO
;
182 AdapterInfo
->Map_Mem
= (map_mem
) (UINTN
) CpbPtr_31
->Map_Mem
;
183 AdapterInfo
->UnMap_Mem
= (unmap_mem
) (UINTN
) CpbPtr_31
->UnMap_Mem
;
184 AdapterInfo
->Sync_Mem
= (sync_mem
) (UINTN
) CpbPtr_31
->Sync_Mem
;
185 AdapterInfo
->Unique_ID
= CpbPtr_31
->Unique_ID
;
188 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_STARTED
;
196 IN NIC_DATA_INSTANCE
*AdapterInfo
201 This routine is used to change the operational state of the UNDI from started to stopped.
202 It will not do this if the adapter's state is PXE_STATFLAGS_GET_STATE_INITIALIZED, otherwise
203 the CdbPtr->StatFlags will reflect a command failure, and the CdbPtr->StatCode will reflect the
204 UNDI as having already not been shut down.
206 The NIC's data structure will have the Delay, Virt2Phys, and Block, pointers zero'd out..
208 It's final action is to change the AdapterInfo->State to PXE_STATFLAGS_GET_STATE_STOPPED.
211 CdbPtr - Pointer to the command descriptor block.
212 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
219 if (AdapterInfo
->State
== PXE_STATFLAGS_GET_STATE_INITIALIZED
) {
220 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
221 CdbPtr
->StatCode
= PXE_STATCODE_NOT_SHUTDOWN
;
225 AdapterInfo
->Delay_30
= 0;
226 AdapterInfo
->Virt2Phys_30
= 0;
227 AdapterInfo
->Block_30
= 0;
229 AdapterInfo
->Delay
= 0;
230 AdapterInfo
->Virt2Phys
= 0;
231 AdapterInfo
->Block
= 0;
233 AdapterInfo
->Map_Mem
= 0;
234 AdapterInfo
->UnMap_Mem
= 0;
235 AdapterInfo
->Sync_Mem
= 0;
237 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_STOPPED
;
245 IN NIC_DATA_INSTANCE
*AdapterInfo
250 This routine is used to retrieve the initialization information that is needed by drivers and
251 applications to initialize the UNDI. This will fill in data in the Data Block structure that is
252 pointed to by the caller's CdbPtr->DBaddr. The fields filled in are as follows:
254 MemoryRequired, FrameDataLen, LinkSpeeds[0-3], NvCount, NvWidth, MediaHeaderLen, HWaddrLen,
255 MCastFilterCnt, TxBufCnt, TxBufSize, RxBufCnt, RxBufSize, IFtype, Duplex, and LoopBack.
257 In addition, the CdbPtr->StatFlags ORs in that this NIC supports cable detection. (APRIORI knowledge)
260 CdbPtr - Pointer to the command descriptor block.
261 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
268 PXE_DB_GET_INIT_INFO
*DbPtr
;
270 DbPtr
= (PXE_DB_GET_INIT_INFO
*) (UINTN
) (CdbPtr
->DBaddr
);
272 DbPtr
->MemoryRequired
= MEMORY_NEEDED
;
273 DbPtr
->FrameDataLen
= PXE_MAX_TXRX_UNIT_ETHER
;
274 DbPtr
->LinkSpeeds
[0] = 10;
275 DbPtr
->LinkSpeeds
[1] = 100;
276 DbPtr
->LinkSpeeds
[2] = DbPtr
->LinkSpeeds
[3] = 0;
277 DbPtr
->NvCount
= MAX_EEPROM_LEN
;
279 DbPtr
->MediaHeaderLen
= PXE_MAC_HEADER_LEN_ETHER
;
280 DbPtr
->HWaddrLen
= PXE_HWADDR_LEN_ETHER
;
281 DbPtr
->MCastFilterCnt
= MAX_MCAST_ADDRESS_CNT
;
283 DbPtr
->TxBufCnt
= TX_BUFFER_COUNT
;
284 DbPtr
->TxBufSize
= sizeof (TxCB
);
285 DbPtr
->RxBufCnt
= RX_BUFFER_COUNT
;
286 DbPtr
->RxBufSize
= sizeof (RxFD
);
288 DbPtr
->IFtype
= PXE_IFTYPE_ETHERNET
;
289 DbPtr
->SupportedDuplexModes
= PXE_DUPLEX_ENABLE_FULL_SUPPORTED
|
290 PXE_DUPLEX_FORCE_FULL_SUPPORTED
;
291 DbPtr
->SupportedLoopBackModes
= PXE_LOOPBACK_INTERNAL_SUPPORTED
|
292 PXE_LOOPBACK_EXTERNAL_SUPPORTED
;
294 CdbPtr
->StatFlags
|= PXE_STATFLAGS_CABLE_DETECT_SUPPORTED
;
301 IN NIC_DATA_INSTANCE
*AdapterInfo
306 This routine is used to retrieve the configuration information about the NIC being controlled by
307 this driver. This will fill in data in the Data Block structure that is pointed to by the caller's CdbPtr->DBaddr.
308 The fields filled in are as follows:
310 DbPtr->pci.BusType, DbPtr->pci.Bus, DbPtr->pci.Device, and DbPtr->pci.
312 In addition, the DbPtr->pci.Config.Dword[0-63] grabs a copy of this NIC's PCI configuration space.
315 CdbPtr - Pointer to the command descriptor block.
316 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
324 PXE_DB_GET_CONFIG_INFO
*DbPtr
;
326 DbPtr
= (PXE_DB_GET_CONFIG_INFO
*) (UINTN
) (CdbPtr
->DBaddr
);
328 DbPtr
->pci
.BusType
= PXE_BUSTYPE_PCI
;
329 DbPtr
->pci
.Bus
= AdapterInfo
->Bus
;
330 DbPtr
->pci
.Device
= AdapterInfo
->Device
;
331 DbPtr
->pci
.Function
= AdapterInfo
->Function
;
333 for (Index
= 0; Index
< MAX_PCI_CONFIG_LEN
; Index
++) {
334 DbPtr
->pci
.Config
.Dword
[Index
] = AdapterInfo
->Config
[Index
];
343 NIC_DATA_INSTANCE
*AdapterInfo
348 This routine resets the network adapter and initializes the UNDI using the parameters supplied in
349 the CPB. This command must be issued before the network adapter can be setup to transmit and
352 Once the memory requirements of the UNDI are obtained by using the GetInitInfo command, a block
353 of non-swappable memory may need to be allocated. The address of this memory must be passed to
354 UNDI during the Initialize in the CPB. This memory is used primarily for transmit and receive buffers.
356 The fields CableDetect, LinkSpeed, Duplex, LoopBack, MemoryPtr, and MemoryLength are set with information
357 that was passed in the CPB and the NIC is initialized.
359 If the NIC initialization fails, the CdbPtr->StatFlags are updated with PXE_STATFLAGS_COMMAND_FAILED
360 Otherwise, AdapterInfo->State is updated with PXE_STATFLAGS_GET_STATE_INITIALIZED showing the state of
361 the UNDI is now initialized.
364 CdbPtr - Pointer to the command descriptor block.
365 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
372 PXE_CPB_INITIALIZE
*CpbPtr
;
374 if ((CdbPtr
->OpFlags
!= PXE_OPFLAGS_INITIALIZE_DETECT_CABLE
) &&
375 (CdbPtr
->OpFlags
!= PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE
)) {
376 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
377 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
382 // check if it is already initialized
384 if (AdapterInfo
->State
== PXE_STATFLAGS_GET_STATE_INITIALIZED
) {
385 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
386 CdbPtr
->StatCode
= PXE_STATCODE_ALREADY_INITIALIZED
;
390 CpbPtr
= (PXE_CPB_INITIALIZE
*) (UINTN
) CdbPtr
->CPBaddr
;
392 if (CpbPtr
->MemoryLength
< (UINT32
) MEMORY_NEEDED
) {
393 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
394 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CPB
;
399 // default behaviour is to detect the cable, if the 3rd param is 1,
402 AdapterInfo
->CableDetect
= (UINT8
) ((CdbPtr
->OpFlags
== (UINT16
) PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE
) ? (UINT8
) 0 : (UINT8
) 1);
403 AdapterInfo
->LinkSpeedReq
= (UINT16
) CpbPtr
->LinkSpeed
;
404 AdapterInfo
->DuplexReq
= CpbPtr
->DuplexMode
;
405 AdapterInfo
->LoopBack
= CpbPtr
->LoopBackMode
;
406 AdapterInfo
->MemoryPtr
= CpbPtr
->MemoryAddr
;
407 AdapterInfo
->MemoryLength
= CpbPtr
->MemoryLength
;
409 CdbPtr
->StatCode
= (PXE_STATCODE
) E100bInit (AdapterInfo
);
411 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
412 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
414 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_INITIALIZED
;
423 IN NIC_DATA_INSTANCE
*AdapterInfo
428 This routine resets the network adapter and initializes the UNDI using the parameters supplied in
429 the CPB. The transmit and receive queues are emptied and any pending interrupts are cleared.
431 If the NIC reset fails, the CdbPtr->StatFlags are updated with PXE_STATFLAGS_COMMAND_FAILED
434 CdbPtr - Pointer to the command descriptor block.
435 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
442 if (CdbPtr
->OpFlags
!= PXE_OPFLAGS_NOT_USED
&&
443 CdbPtr
->OpFlags
!= PXE_OPFLAGS_RESET_DISABLE_INTERRUPTS
&&
444 CdbPtr
->OpFlags
!= PXE_OPFLAGS_RESET_DISABLE_FILTERS
) {
446 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
447 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
451 CdbPtr
->StatCode
= (UINT16
) E100bReset (AdapterInfo
, CdbPtr
->OpFlags
);
453 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
454 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
461 IN NIC_DATA_INSTANCE
*AdapterInfo
466 This routine resets the network adapter and leaves it in a safe state for another driver to
467 initialize. Any pending transmits or receives are lost. Receive filters and external
468 interrupt enables are disabled. Once the UNDI has been shutdown, it can then be stopped
469 or initialized again.
471 If the NIC reset fails, the CdbPtr->StatFlags are updated with PXE_STATFLAGS_COMMAND_FAILED
473 Otherwise, AdapterInfo->State is updated with PXE_STATFLAGS_GET_STATE_STARTED showing the state of
474 the NIC as being started.
477 CdbPtr - Pointer to the command descriptor block.
478 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
486 // do the shutdown stuff here
488 CdbPtr
->StatCode
= (UINT16
) E100bShutdown (AdapterInfo
);
490 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
491 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
493 AdapterInfo
->State
= PXE_STATFLAGS_GET_STATE_STARTED
;
502 IN NIC_DATA_INSTANCE
*AdapterInfo
507 This routine can be used to read and/or change the current external interrupt enable
508 settings. Disabling an external interrupt enable prevents and external (hardware)
509 interrupt from being signaled by the network device. Internally the interrupt events
510 can still be polled by using the UNDI_GetState command.
512 The resulting information on the interrupt state will be passed back in the CdbPtr->StatFlags.
515 CdbPtr - Pointer to the command descriptor block.
516 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
525 IntMask
= (UINT8
)(UINTN
)(CdbPtr
->OpFlags
& (PXE_OPFLAGS_INTERRUPT_RECEIVE
|
526 PXE_OPFLAGS_INTERRUPT_TRANSMIT
|
527 PXE_OPFLAGS_INTERRUPT_COMMAND
|
528 PXE_OPFLAGS_INTERRUPT_SOFTWARE
));
530 switch (CdbPtr
->OpFlags
& PXE_OPFLAGS_INTERRUPT_OPMASK
) {
531 case PXE_OPFLAGS_INTERRUPT_READ
:
534 case PXE_OPFLAGS_INTERRUPT_ENABLE
:
536 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
537 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
541 AdapterInfo
->int_mask
= IntMask
;
542 E100bSetInterruptState (AdapterInfo
);
545 case PXE_OPFLAGS_INTERRUPT_DISABLE
:
547 AdapterInfo
->int_mask
= (UINT16
) (AdapterInfo
->int_mask
& ~(IntMask
));
548 E100bSetInterruptState (AdapterInfo
);
556 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
557 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
561 if ((AdapterInfo
->int_mask
& PXE_OPFLAGS_INTERRUPT_RECEIVE
) != 0) {
562 CdbPtr
->StatFlags
|= PXE_STATFLAGS_INTERRUPT_RECEIVE
;
566 if ((AdapterInfo
->int_mask
& PXE_OPFLAGS_INTERRUPT_TRANSMIT
) != 0) {
567 CdbPtr
->StatFlags
|= PXE_STATFLAGS_INTERRUPT_TRANSMIT
;
571 if ((AdapterInfo
->int_mask
& PXE_OPFLAGS_INTERRUPT_COMMAND
) != 0) {
572 CdbPtr
->StatFlags
|= PXE_STATFLAGS_INTERRUPT_COMMAND
;
582 IN NIC_DATA_INSTANCE
*AdapterInfo
587 This routine is used to read and change receive filters and, if supported, read
588 and change multicast MAC address filter list.
591 CdbPtr - Pointer to the command descriptor block.
592 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
601 PXE_DB_RECEIVE_FILTERS
*DbPtr
;
608 OpFlags
= CdbPtr
->OpFlags
;
609 NewFilter
= (UINT16
) (OpFlags
& 0x1F);
611 switch (OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_OPMASK
) {
612 case PXE_OPFLAGS_RECEIVE_FILTER_READ
:
615 // not expecting a cpb, not expecting any filter bits
617 if ((NewFilter
!= 0) || (CdbPtr
->CPBsize
!= 0)) {
622 if ((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) == 0) {
627 NewFilter
= (UINT16
) (NewFilter
| AdapterInfo
->Rx_Filter
);
629 // all other flags are ignored except mcast_reset
633 case PXE_OPFLAGS_RECEIVE_FILTER_ENABLE
:
635 // there should be atleast one other filter bit set.
637 if (NewFilter
== 0) {
644 if (CdbPtr
->CPBsize
!= 0) {
646 // this must be a multicast address list!
647 // don't accept the list unless selective_mcast is set
648 // don't accept confusing mcast settings with this
650 if (((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST
) == 0) ||
651 ((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) != 0) ||
652 ((NewFilter
& PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST
) != 0) ||
653 ((CdbPtr
->CPBsize
% sizeof (PXE_MAC_ADDR
)) != 0) ) {
657 MacAddr
= (UINT8
*) ((UINTN
) (CdbPtr
->CPBaddr
));
658 MacCount
= CdbPtr
->CPBsize
/ sizeof (PXE_MAC_ADDR
);
660 for (; MacCount
-- != 0; MacAddr
+= sizeof (PXE_MAC_ADDR
)) {
661 if (MacAddr
[0] != 0x01 || MacAddr
[1] != 0x00 || MacAddr
[2] != 0x5E || (MacAddr
[3] & 0x80) != 0) {
662 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
663 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CPB
;
670 // check selective mcast case enable case
672 if ((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST
) != 0) {
673 if (((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) != 0) ||
674 ((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST
) != 0) ) {
679 // if no cpb, make sure we have an old list
681 if ((CdbPtr
->CPBsize
== 0) && (AdapterInfo
->mcast_list
.list_len
== 0)) {
686 // if you want to enable anything, you got to have unicast
687 // and you have what you already enabled!
689 NewFilter
= (UINT16
) (NewFilter
| (PXE_OPFLAGS_RECEIVE_FILTER_UNICAST
| AdapterInfo
->Rx_Filter
));
693 case PXE_OPFLAGS_RECEIVE_FILTER_DISABLE
:
696 // mcast list not expected, i.e. no cpb here!
698 if (CdbPtr
->CPBsize
!= PXE_CPBSIZE_NOT_USED
) {
702 NewFilter
= (UINT16
) ((~(CdbPtr
->OpFlags
& 0x1F)) & AdapterInfo
->Rx_Filter
);
710 if ((OpFlags
& PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST
) != 0) {
711 AdapterInfo
->mcast_list
.list_len
= 0;
712 NewFilter
&= (~PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST
);
715 E100bSetfilter (AdapterInfo
, NewFilter
, CdbPtr
->CPBaddr
, CdbPtr
->CPBsize
);
719 // give the current mcast list
721 if ((CdbPtr
->DBsize
!= 0) && (AdapterInfo
->mcast_list
.list_len
!= 0)) {
723 // copy the mc list to db
726 DbPtr
= (PXE_DB_RECEIVE_FILTERS
*) (UINTN
) CdbPtr
->DBaddr
;
727 ptr1
= (UINT8
*) (&DbPtr
->MCastList
[0]);
730 // DbPtr->mc_count = AdapterInfo->mcast_list.list_len;
732 copy_len
= (UINT16
) (AdapterInfo
->mcast_list
.list_len
* PXE_MAC_LENGTH
);
734 if (copy_len
> CdbPtr
->DBsize
) {
735 copy_len
= CdbPtr
->DBsize
;
739 ptr2
= (UINT8
*) (&AdapterInfo
->mcast_list
.mc_list
[0]);
740 for (Index
= 0; Index
< copy_len
; Index
++) {
741 ptr1
[Index
] = ptr2
[Index
];
745 // give the stat flags here
747 if (AdapterInfo
->Receive_Started
) {
748 CdbPtr
->StatFlags
= (PXE_STATFLAGS
) (CdbPtr
->StatFlags
| AdapterInfo
->Rx_Filter
);
755 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
756 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
762 IN NIC_DATA_INSTANCE
*AdapterInfo
767 This routine is used to get the current station and broadcast MAC addresses, and to change the
768 current station MAC address.
771 CdbPtr - Pointer to the command descriptor block.
772 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
779 PXE_CPB_STATION_ADDRESS
*CpbPtr
;
780 PXE_DB_STATION_ADDRESS
*DbPtr
;
783 if (CdbPtr
->OpFlags
== PXE_OPFLAGS_STATION_ADDRESS_RESET
) {
785 // configure the permanent address.
786 // change the AdapterInfo->CurrentNodeAddress field.
789 &AdapterInfo
->CurrentNodeAddress
[0],
790 &AdapterInfo
->PermNodeAddress
[0],
793 for (Index
= 0; Index
< PXE_MAC_LENGTH
; Index
++) {
794 AdapterInfo
->CurrentNodeAddress
[Index
] = AdapterInfo
->PermNodeAddress
[Index
];
797 E100bSetupIAAddr (AdapterInfo
);
801 if (CdbPtr
->CPBaddr
!= (UINT64
) 0) {
802 CpbPtr
= (PXE_CPB_STATION_ADDRESS
*) (UINTN
) (CdbPtr
->CPBaddr
);
804 // configure the new address
806 for (Index
= 0; Index
< PXE_MAC_LENGTH
; Index
++) {
807 AdapterInfo
->CurrentNodeAddress
[Index
] = CpbPtr
->StationAddr
[Index
];
810 E100bSetupIAAddr (AdapterInfo
);
813 if (CdbPtr
->DBaddr
!= (UINT64
) 0) {
814 DbPtr
= (PXE_DB_STATION_ADDRESS
*) (UINTN
) (CdbPtr
->DBaddr
);
816 // fill it with the new values
818 for (Index
= 0; Index
< PXE_MAC_LENGTH
; Index
++) {
819 DbPtr
->StationAddr
[Index
] = AdapterInfo
->CurrentNodeAddress
[Index
];
820 DbPtr
->BroadcastAddr
[Index
] = AdapterInfo
->BroadcastNodeAddress
[Index
];
821 DbPtr
->PermanentAddr
[Index
] = AdapterInfo
->PermNodeAddress
[Index
];
831 IN NIC_DATA_INSTANCE
*AdapterInfo
836 This routine is used to read and clear the NIC traffic statistics. This command is supported only
837 if the !PXE structure's Implementation flags say so.
839 Results will be parsed out in the following manner:
840 CdbPtr->DBaddr.Data[0] R Total Frames (Including frames with errors and dropped frames)
841 CdbPtr->DBaddr.Data[1] R Good Frames (All frames copied into receive buffer)
842 CdbPtr->DBaddr.Data[2] R Undersize Frames (Frames below minimum length for media <64 for ethernet)
843 CdbPtr->DBaddr.Data[4] R Dropped Frames (Frames that were dropped because receive buffers were full)
844 CdbPtr->DBaddr.Data[8] R CRC Error Frames (Frames with alignment or CRC errors)
845 CdbPtr->DBaddr.Data[A] T Total Frames (Including frames with errors and dropped frames)
846 CdbPtr->DBaddr.Data[B] T Good Frames (All frames copied into transmit buffer)
847 CdbPtr->DBaddr.Data[C] T Undersize Frames (Frames below minimum length for media <64 for ethernet)
848 CdbPtr->DBaddr.Data[E] T Dropped Frames (Frames that were dropped because of collisions)
849 CdbPtr->DBaddr.Data[14] T Total Collision Frames (Total collisions on this subnet)
852 CdbPtr - Pointer to the command descriptor block.
853 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
860 if ((CdbPtr
->OpFlags
&~(PXE_OPFLAGS_STATISTICS_RESET
)) != 0) {
861 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
862 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
866 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_STATISTICS_RESET
) != 0) {
868 // Reset the statistics
870 CdbPtr
->StatCode
= (UINT16
) E100bStatistics (AdapterInfo
, 0, 0);
872 CdbPtr
->StatCode
= (UINT16
) E100bStatistics (AdapterInfo
, CdbPtr
->DBaddr
, CdbPtr
->DBsize
);
881 IN NIC_DATA_INSTANCE
*AdapterInfo
886 This routine is used to translate a multicast IP address to a multicast MAC address.
888 This results in a MAC address composed of 25 bits of fixed data with the upper 23 bits of the IP
889 address being appended to it. Results passed back in the equivalent of CdbPtr->DBaddr->MAC[0-5].
892 CdbPtr - Pointer to the command descriptor block.
893 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
900 PXE_CPB_MCAST_IP_TO_MAC
*CpbPtr
;
901 PXE_DB_MCAST_IP_TO_MAC
*DbPtr
;
904 CpbPtr
= (PXE_CPB_MCAST_IP_TO_MAC
*) (UINTN
) CdbPtr
->CPBaddr
;
905 DbPtr
= (PXE_DB_MCAST_IP_TO_MAC
*) (UINTN
) CdbPtr
->DBaddr
;
907 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_MCAST_IPV6_TO_MAC
) != 0) {
909 // for now this is not supported
911 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
912 CdbPtr
->StatCode
= PXE_STATCODE_UNSUPPORTED
;
916 TmpPtr
= (UINT8
*) (&CpbPtr
->IP
.IPv4
);
918 // check if the ip given is a mcast IP
920 if ((TmpPtr
[0] & 0xF0) != 0xE0) {
921 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
922 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CPB
;
925 // take the last 23 bits in IP.
926 // be very careful. accessing word on a non-word boundary will hang motherboard codenamed Big Sur
927 // casting the mac array (in the middle) to a UINT32 pointer and accessing
928 // the UINT32 content hung the system...
930 DbPtr
->MAC
[0] = 0x01;
931 DbPtr
->MAC
[1] = 0x00;
932 DbPtr
->MAC
[2] = 0x5e;
933 DbPtr
->MAC
[3] = (UINT8
) (TmpPtr
[1] & 0x7f);
934 DbPtr
->MAC
[4] = (UINT8
) TmpPtr
[2];
935 DbPtr
->MAC
[5] = (UINT8
) TmpPtr
[3];
943 IN NIC_DATA_INSTANCE
*AdapterInfo
948 This routine is used to read and write non-volatile storage on the NIC (if supported). The NVRAM
949 could be EEPROM, FLASH, or battery backed RAM.
951 This is an optional function according to the UNDI specification (or will be......)
954 CdbPtr - Pointer to the command descriptor block.
955 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
962 PXE_DB_NVDATA
*DbPtr
;
965 if ((CdbPtr
->OpFlags
== PXE_OPFLAGS_NVDATA_READ
) != 0) {
967 if ((CdbPtr
->DBsize
== PXE_DBSIZE_NOT_USED
) != 0) {
968 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
969 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
973 DbPtr
= (PXE_DB_NVDATA
*) (UINTN
) CdbPtr
->DBaddr
;
975 for (Index
= 0; Index
< MAX_PCI_CONFIG_LEN
; Index
++) {
976 DbPtr
->Data
.Dword
[Index
] = AdapterInfo
->NVData
[Index
];
984 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
985 CdbPtr
->StatCode
= PXE_STATCODE_UNSUPPORTED
;
994 IN NIC_DATA_INSTANCE
*AdapterInfo
999 This routine returns the current interrupt status and/or the transmitted buffer addresses.
1000 If the current interrupt status is returned, pending interrupts will be acknowledged by this
1001 command. Transmitted buffer addresses that are written to the DB are removed from the transmit
1004 Normally, this command would be polled with interrupts disabled.
1006 The transmit buffers are returned in CdbPtr->DBaddr->TxBufer[0 - NumEntries].
1007 The interrupt status is returned in CdbPtr->StatFlags.
1010 CdbPtr - Pointer to the command descriptor block.
1011 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
1018 PXE_DB_GET_STATUS
*DbPtr
;
1019 PXE_DB_GET_STATUS TmpGetStatus
;
1026 // Fill in temporary GetStatus storage.
1028 RxPtr
= &AdapterInfo
->rx_ring
[AdapterInfo
->cur_rx_ind
];
1030 if ((RxPtr
->cb_header
.status
& RX_COMPLETE
) != 0) {
1031 TmpGetStatus
.RxFrameLen
= RxPtr
->ActualCount
& 0x3fff;
1033 TmpGetStatus
.RxFrameLen
= 0;
1036 TmpGetStatus
.reserved
= 0;
1039 // Fill in size of next available receive packet and
1040 // reserved field in caller's DB storage.
1042 DbPtr
= (PXE_DB_GET_STATUS
*) (UINTN
) CdbPtr
->DBaddr
;
1044 if (CdbPtr
->DBsize
> 0 && CdbPtr
->DBsize
< sizeof (UINT32
) * 2) {
1045 CopyMem (DbPtr
, &TmpGetStatus
, CdbPtr
->DBsize
);
1047 CopyMem (DbPtr
, &TmpGetStatus
, sizeof (UINT32
) * 2);
1053 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS
) != 0) {
1055 // DBsize of zero is invalid if Tx buffers are requested.
1057 if (CdbPtr
->DBsize
== 0) {
1058 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1059 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1064 // remember this b4 we overwrite
1066 NumEntries
= (UINT16
) (CdbPtr
->DBsize
- sizeof (UINT64
));
1069 // We already filled in 2 UINT32s.
1071 CdbPtr
->DBsize
= sizeof (UINT32
) * 2;
1074 // will claim any hanging free CBs
1076 CheckCBList (AdapterInfo
);
1078 if (AdapterInfo
->xmit_done_head
== AdapterInfo
->xmit_done_tail
) {
1079 CdbPtr
->StatFlags
|= PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY
;
1081 for (Index
= 0; NumEntries
>= sizeof (UINT64
); Index
++, NumEntries
-= sizeof (UINT64
)) {
1082 if (AdapterInfo
->xmit_done_head
!= AdapterInfo
->xmit_done_tail
) {
1083 DbPtr
->TxBuffer
[Index
] = AdapterInfo
->xmit_done
[AdapterInfo
->xmit_done_head
];
1084 AdapterInfo
->xmit_done_head
= next (AdapterInfo
->xmit_done_head
);
1085 CdbPtr
->DBsize
+= sizeof (UINT64
);
1092 if (AdapterInfo
->xmit_done_head
!= AdapterInfo
->xmit_done_tail
) {
1093 CdbPtr
->StatFlags
|= PXE_STATFLAGS_DB_WRITE_TRUNCATED
;
1097 // check for a receive buffer and give it's size in db
1103 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_GET_INTERRUPT_STATUS
) != 0) {
1105 Status
= InWord (AdapterInfo
, AdapterInfo
->ioaddr
+ SCBStatus
);
1106 AdapterInfo
->Int_Status
= (UINT16
) (AdapterInfo
->Int_Status
| Status
);
1109 // acknoledge the interrupts
1111 OutWord (AdapterInfo
, (UINT16
) (Status
& 0xfc00), (UINT32
) (AdapterInfo
->ioaddr
+ SCBStatus
));
1114 // report all the outstanding interrupts
1116 Status
= AdapterInfo
->Int_Status
;
1117 if ((Status
& SCB_STATUS_FR
) != 0) {
1118 CdbPtr
->StatFlags
|= PXE_STATFLAGS_GET_STATUS_RECEIVE
;
1121 if ((Status
& SCB_STATUS_SWI
) != 0) {
1122 CdbPtr
->StatFlags
|= PXE_STATFLAGS_GET_STATUS_SOFTWARE
;
1132 IN NIC_DATA_INSTANCE
*AdapterInfo
1136 Routine Description:
1137 This routine is used to fill media header(s) in transmit packet(s).
1138 Copies the MAC address into the media header whether it is dealing
1139 with fragmented or non-fragmented packets.
1142 CdbPtr - Pointer to the command descriptor block.
1143 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
1150 PXE_CPB_FILL_HEADER
*Cpb
;
1151 PXE_CPB_FILL_HEADER_FRAGMENTED
*Cpbf
;
1152 EtherHeader
*MacHeader
;
1155 if (CdbPtr
->CPBsize
== PXE_CPBSIZE_NOT_USED
) {
1156 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1157 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1161 if ((CdbPtr
->OpFlags
& PXE_OPFLAGS_FILL_HEADER_FRAGMENTED
) != 0) {
1162 Cpbf
= (PXE_CPB_FILL_HEADER_FRAGMENTED
*) (UINTN
) CdbPtr
->CPBaddr
;
1165 // assume 1st fragment is big enough for the mac header
1167 if ((Cpbf
->FragCnt
== 0) || (Cpbf
->FragDesc
[0].FragLen
< PXE_MAC_HEADER_LEN_ETHER
)) {
1171 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1172 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1176 MacHeader
= (EtherHeader
*) (UINTN
) Cpbf
->FragDesc
[0].FragAddr
;
1178 // we don't swap the protocol bytes
1180 MacHeader
->type
= Cpbf
->Protocol
;
1182 for (Index
= 0; Index
< PXE_HWADDR_LEN_ETHER
; Index
++) {
1183 MacHeader
->dest_addr
[Index
] = Cpbf
->DestAddr
[Index
];
1184 MacHeader
->src_addr
[Index
] = Cpbf
->SrcAddr
[Index
];
1187 Cpb
= (PXE_CPB_FILL_HEADER
*) (UINTN
) CdbPtr
->CPBaddr
;
1189 MacHeader
= (EtherHeader
*) (UINTN
) Cpb
->MediaHeader
;
1191 // we don't swap the protocol bytes
1193 MacHeader
->type
= Cpb
->Protocol
;
1195 for (Index
= 0; Index
< PXE_HWADDR_LEN_ETHER
; Index
++) {
1196 MacHeader
->dest_addr
[Index
] = Cpb
->DestAddr
[Index
];
1197 MacHeader
->src_addr
[Index
] = Cpb
->SrcAddr
[Index
];
1207 IN NIC_DATA_INSTANCE
*AdapterInfo
1211 Routine Description:
1212 This routine is used to place a packet into the transmit queue. The data buffers given to
1213 this command are to be considered locked and the application or network driver loses
1214 ownership of these buffers and must not free or relocate them until the ownership returns.
1216 When the packets are transmitted, a transmit complete interrupt is generated (if interrupts
1217 are disabled, the transmit interrupt status is still set and can be checked using the UNDI_Status
1220 Some implementations and adapters support transmitting multiple packets with one transmit
1221 command. If this feature is supported, the transmit CPBs can be linked in one transmit
1224 All UNDIs support fragmented frames, now all network devices or protocols do. If a fragmented
1225 frame CPB is given to UNDI and the network device does not support fragmented frames
1226 (see !PXE.Implementation flag), the UNDI will have to copy the fragments into a local buffer
1227 before transmitting.
1231 CdbPtr - Pointer to the command descriptor block.
1232 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
1240 if (CdbPtr
->CPBsize
== PXE_CPBSIZE_NOT_USED
) {
1241 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1242 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1246 CdbPtr
->StatCode
= (PXE_STATCODE
) E100bTransmit (AdapterInfo
, CdbPtr
->CPBaddr
, CdbPtr
->OpFlags
);
1248 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
1249 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1258 IN NIC_DATA_INSTANCE
*AdapterInfo
1262 Routine Description:
1263 When the network adapter has received a frame, this command is used to copy the frame
1264 into the driver/application storage location. Once a frame has been copied, it is
1265 removed from the receive queue.
1268 CdbPtr - Pointer to the command descriptor block.
1269 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
1278 // check if RU has started...
1280 if (!AdapterInfo
->Receive_Started
) {
1281 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1282 CdbPtr
->StatCode
= PXE_STATCODE_NOT_INITIALIZED
;
1287 CdbPtr
->StatCode
= (UINT16
) E100bReceive (AdapterInfo
, CdbPtr
->CPBaddr
, CdbPtr
->DBaddr
);
1288 if (CdbPtr
->StatCode
!= PXE_STATCODE_SUCCESS
) {
1289 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1302 Routine Description:
1303 This is the main SW UNDI API entry using the older nii protocol.
1304 The parameter passed in is a 64 bit flat model virtual
1305 address of the cdb. We then jump into the common routine for both old and
1306 new nii protocol entries.
1309 CdbPtr - Pointer to the command descriptor block.
1310 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
1316 // TODO: cdb - add argument and description to function comment
1319 NIC_DATA_INSTANCE
*AdapterInfo
;
1321 if (cdb
== (UINT64
) 0) {
1326 CdbPtr
= (PXE_CDB
*) (UINTN
) cdb
;
1328 if (CdbPtr
->IFnum
>= pxe
->IFcnt
) {
1329 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1330 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1334 AdapterInfo
= &(UNDI32DeviceList
[CdbPtr
->IFnum
]->NicInfo
);
1337 // entering from older entry point
1339 AdapterInfo
->VersionFlag
= 0x30;
1340 UNDI_APIEntry_Common (cdb
);
1349 Routine Description:
1350 This is the main SW UNDI API entry using the newer nii protocol.
1351 The parameter passed in is a 64 bit flat model virtual
1352 address of the cdb. We then jump into the common routine for both old and
1353 new nii protocol entries.
1356 CdbPtr - Pointer to the command descriptor block.
1357 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
1363 // TODO: cdb - add argument and description to function comment
1366 NIC_DATA_INSTANCE
*AdapterInfo
;
1368 if (cdb
== (UINT64
) 0) {
1373 CdbPtr
= (PXE_CDB
*) (UINTN
) cdb
;
1375 if (CdbPtr
->IFnum
>= pxe_31
->IFcnt
) {
1376 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1377 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1381 AdapterInfo
= &(UNDI32DeviceList
[CdbPtr
->IFnum
]->NicInfo
);
1383 // entering from older entry point
1385 AdapterInfo
->VersionFlag
= 0x31;
1386 UNDI_APIEntry_Common (cdb
);
1390 UNDI_APIEntry_Common (
1395 Routine Description:
1396 This is the common routine for both old and new entry point procedures.
1397 The parameter passed in is a 64 bit flat model virtual
1398 address of the cdb. We then jump into the service routine pointed to by the
1402 CdbPtr - Pointer to the command descriptor block.
1403 AdapterInfo - Pointer to the NIC data structure information which the UNDI driver is layering on..
1409 // TODO: cdb - add argument and description to function comment
1412 NIC_DATA_INSTANCE
*AdapterInfo
;
1413 UNDI_CALL_TABLE
*tab_ptr
;
1415 CdbPtr
= (PXE_CDB
*) (UINTN
) cdb
;
1418 // check the OPCODE range
1420 if ((CdbPtr
->OpCode
> PXE_OPCODE_LAST_VALID
) ||
1421 (CdbPtr
->StatCode
!= PXE_STATCODE_INITIALIZE
) ||
1422 (CdbPtr
->StatFlags
!= PXE_STATFLAGS_INITIALIZE
) ||
1423 (CdbPtr
->IFnum
>= pxe_31
->IFcnt
) ) {
1428 if (CdbPtr
->CPBsize
== PXE_CPBSIZE_NOT_USED
) {
1429 if (CdbPtr
->CPBaddr
!= PXE_CPBADDR_NOT_USED
) {
1432 } else if (CdbPtr
->CPBaddr
== PXE_CPBADDR_NOT_USED
) {
1436 if (CdbPtr
->DBsize
== PXE_DBSIZE_NOT_USED
) {
1437 if (CdbPtr
->DBaddr
!= PXE_DBADDR_NOT_USED
) {
1440 } else if (CdbPtr
->DBaddr
== PXE_DBADDR_NOT_USED
) {
1445 // check if cpbsize and dbsize are as needed
1446 // check if opflags are as expected
1448 tab_ptr
= &api_table
[CdbPtr
->OpCode
];
1450 if (tab_ptr
->cpbsize
!= (UINT16
) (DONT_CHECK
) && tab_ptr
->cpbsize
!= CdbPtr
->CPBsize
) {
1454 if (tab_ptr
->dbsize
!= (UINT16
) (DONT_CHECK
) && tab_ptr
->dbsize
!= CdbPtr
->DBsize
) {
1458 if (tab_ptr
->opflags
!= (UINT16
) (DONT_CHECK
) && tab_ptr
->opflags
!= CdbPtr
->OpFlags
) {
1463 AdapterInfo
= &(UNDI32DeviceList
[CdbPtr
->IFnum
]->NicInfo
);
1466 // check if UNDI_State is valid for this call
1468 if (tab_ptr
->state
!= (UINT16
) (-1)) {
1470 // should atleast be started
1472 if (AdapterInfo
->State
== PXE_STATFLAGS_GET_STATE_STOPPED
) {
1473 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1474 CdbPtr
->StatCode
= PXE_STATCODE_NOT_STARTED
;
1478 // check if it should be initialized
1480 if (tab_ptr
->state
== 2) {
1481 if (AdapterInfo
->State
!= PXE_STATFLAGS_GET_STATE_INITIALIZED
) {
1482 CdbPtr
->StatCode
= PXE_STATCODE_NOT_INITIALIZED
;
1483 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1489 // set the return variable for success case here
1491 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_COMPLETE
;
1492 CdbPtr
->StatCode
= PXE_STATCODE_SUCCESS
;
1494 tab_ptr
->api_ptr (CdbPtr
, AdapterInfo
);
1497 // %% AVL - check for command linking
1500 CdbPtr
->StatFlags
= PXE_STATFLAGS_COMMAND_FAILED
;
1501 CdbPtr
->StatCode
= PXE_STATCODE_INVALID_CDB
;
1513 Routine Description:
1514 This does an 8 bit check sum of the passed in buffer for Len bytes.
1515 This is primarily used to update the check sum in the SW UNDI header.
1518 Buffer - Pointer to the passed in buffer to check sum
1519 Len - Length of buffer to be check summed in bytes.
1530 if ((Bp
= Buffer
) != NULL
) {
1532 Chksum
= (UINT8
) (Chksum
+*Bp
++);
1543 IN NIC_DATA_INSTANCE
*NicPtr
,
1544 IN PXE_SW_UNDI
*PxePtr
1548 Routine Description:
1549 When called with a null NicPtr, this routine decrements the number of NICs
1550 this UNDI is supporting and removes the NIC_DATA_POINTER from the array.
1551 Otherwise, it increments the number of NICs this UNDI is supported and
1552 updates the pxe.Fudge to ensure a proper check sum results.
1555 NicPtr - Pointer to the NIC data structure.
1561 // TODO: PxePtr - add argument and description to function comment
1563 if (NicPtr
== NULL
) {
1564 if (PxePtr
->IFcnt
> 0) {
1566 // number of NICs this undi supports
1571 PxePtr
->Fudge
= (UINT8
) (PxePtr
->Fudge
- ChkSum ((VOID
*) PxePtr
, PxePtr
->Len
));
1576 // number of NICs this undi supports
1579 PxePtr
->Fudge
= (UINT8
) (PxePtr
->Fudge
- ChkSum ((VOID
*) PxePtr
, PxePtr
->Len
));
1586 IN PXE_SW_UNDI
*PxePtr
,
1587 IN UINTN VersionFlag
1591 Routine Description:
1592 Initialize the !PXE structure
1595 RemainingDevicePath - Not used, always produce all possible children.
1598 EFI_SUCCESS - This driver is added to Controller.
1599 other - This driver does not support this device.
1602 // TODO: PxePtr - add argument and description to function comment
1603 // TODO: VersionFlag - add argument and description to function comment
1606 // Initialize the !PXE structure
1608 PxePtr
->Signature
= PXE_ROMID_SIGNATURE
;
1609 PxePtr
->Len
= sizeof (PXE_SW_UNDI
);
1615 // number of NICs this undi supports
1618 PxePtr
->Rev
= PXE_ROMID_REV
;
1619 PxePtr
->MajorVer
= PXE_ROMID_MAJORVER
;
1620 PxePtr
->MinorVer
= PXE_ROMID_MINORVER
;
1621 PxePtr
->reserved1
= 0;
1623 PxePtr
->Implementation
= PXE_ROMID_IMP_SW_VIRT_ADDR
|
1624 PXE_ROMID_IMP_FRAG_SUPPORTED
|
1625 PXE_ROMID_IMP_CMD_LINK_SUPPORTED
|
1626 PXE_ROMID_IMP_NVDATA_READ_ONLY
|
1627 PXE_ROMID_IMP_STATION_ADDR_SETTABLE
|
1628 PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED
|
1629 PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED
|
1630 PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED
|
1631 PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED
|
1632 PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED
|
1633 PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED
;
1635 if (VersionFlag
== 0x30) {
1636 PxePtr
->EntryPoint
= (UINT64
) UNDI_APIEntry_old
;
1638 PxePtr
->EntryPoint
= (UINT64
) UNDI_APIEntry_new
;
1639 PxePtr
->MinorVer
= PXE_ROMID_MINORVER_31
;
1642 PxePtr
->reserved2
[0] = 0;
1643 PxePtr
->reserved2
[1] = 0;
1644 PxePtr
->reserved2
[2] = 0;
1646 PxePtr
->BusType
[0] = PXE_BUSTYPE_PCI
;
1648 PxePtr
->Fudge
= (UINT8
) (PxePtr
->Fudge
- ChkSum ((VOID
*) PxePtr
, PxePtr
->Len
));