iPXE
UefiPxe.h
Go to the documentation of this file.
1 /** @file
2  This header file contains all of the PXE type definitions,
3  structure prototypes, global variables and constants that
4  are needed for porting PXE to EFI.
5 
6 Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials are licensed and made available under
8 the terms and conditions of the BSD License that accompanies this distribution.
9 The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
11 
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 
15  @par Revision Reference:
16  32/64-bit PXE specification:
17  alpha-4, 99-Dec-17.
18 
19 **/
20 
21 #ifndef __EFI_PXE_H__
22 #define __EFI_PXE_H__
23 
24 FILE_LICENCE ( BSD3 );
25 
26 #pragma pack(1)
27 
28 #define PXE_BUSTYPE(a, b, c, d) \
29  ( \
30  (((PXE_UINT32) (d) & 0xFF) << 24) | (((PXE_UINT32) (c) & 0xFF) << 16) | (((PXE_UINT32) (b) & 0xFF) << 8) | \
31  ((PXE_UINT32) (a) & 0xFF) \
32  )
33 
34 ///
35 /// UNDI ROM ID and devive ID signature.
36 ///
37 #define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')
38 
39 ///
40 /// BUS ROM ID signatures.
41 ///
42 #define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')
43 #define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')
44 #define PXE_BUSTYPE_USB PXE_BUSTYPE ('U', 'S', 'B', 'R')
45 #define PXE_BUSTYPE_1394 PXE_BUSTYPE ('1', '3', '9', '4')
46 
47 #define PXE_SWAP_UINT16(n) ((((PXE_UINT16) (n) & 0x00FF) << 8) | (((PXE_UINT16) (n) & 0xFF00) >> 8))
48 
49 #define PXE_SWAP_UINT32(n) \
50  ((((PXE_UINT32)(n) & 0x000000FF) << 24) | \
51  (((PXE_UINT32)(n) & 0x0000FF00) << 8) | \
52  (((PXE_UINT32)(n) & 0x00FF0000) >> 8) | \
53  (((PXE_UINT32)(n) & 0xFF000000) >> 24))
54 
55 #define PXE_SWAP_UINT64(n) \
56  ((((PXE_UINT64)(n) & 0x00000000000000FFULL) << 56) | \
57  (((PXE_UINT64)(n) & 0x000000000000FF00ULL) << 40) | \
58  (((PXE_UINT64)(n) & 0x0000000000FF0000ULL) << 24) | \
59  (((PXE_UINT64)(n) & 0x00000000FF000000ULL) << 8) | \
60  (((PXE_UINT64)(n) & 0x000000FF00000000ULL) >> 8) | \
61  (((PXE_UINT64)(n) & 0x0000FF0000000000ULL) >> 24) | \
62  (((PXE_UINT64)(n) & 0x00FF000000000000ULL) >> 40) | \
63  (((PXE_UINT64)(n) & 0xFF00000000000000ULL) >> 56))
64 
65 
66 #define PXE_CPBSIZE_NOT_USED 0 ///< zero
67 #define PXE_DBSIZE_NOT_USED 0 ///< zero
68 #define PXE_CPBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
69 #define PXE_DBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
70 #define PXE_CONST CONST
71 
72 #define PXE_VOLATILE volatile
73 
74 typedef VOID PXE_VOID;
75 typedef UINT8 PXE_UINT8;
78 typedef UINTN PXE_UINTN;
79 
80 ///
81 /// Typedef unsigned long PXE_UINT64.
82 ///
84 
86 #define PXE_FALSE 0 ///< zero
87 #define PXE_TRUE (!PXE_FALSE)
88 
90 
91 ///
92 /// Return UNDI operational state.
93 ///
94 #define PXE_OPCODE_GET_STATE 0x0000
95 
96 ///
97 /// Change UNDI operational state from Stopped to Started.
98 ///
99 #define PXE_OPCODE_START 0x0001
100 
101 ///
102 /// Change UNDI operational state from Started to Stopped.
103 ///
104 #define PXE_OPCODE_STOP 0x0002
105 
106 ///
107 /// Get UNDI initialization information.
108 ///
109 #define PXE_OPCODE_GET_INIT_INFO 0x0003
110 
111 ///
112 /// Get NIC configuration information.
113 ///
114 #define PXE_OPCODE_GET_CONFIG_INFO 0x0004
115 
116 ///
117 /// Changed UNDI operational state from Started to Initialized.
118 ///
119 #define PXE_OPCODE_INITIALIZE 0x0005
120 
121 ///
122 /// Re-initialize the NIC H/W.
123 ///
124 #define PXE_OPCODE_RESET 0x0006
125 
126 ///
127 /// Change the UNDI operational state from Initialized to Started.
128 ///
129 #define PXE_OPCODE_SHUTDOWN 0x0007
130 
131 ///
132 /// Read & change state of external interrupt enables.
133 ///
134 #define PXE_OPCODE_INTERRUPT_ENABLES 0x0008
135 
136 ///
137 /// Read & change state of packet receive filters.
138 ///
139 #define PXE_OPCODE_RECEIVE_FILTERS 0x0009
140 
141 ///
142 /// Read & change station MAC address.
143 ///
144 #define PXE_OPCODE_STATION_ADDRESS 0x000A
145 
146 ///
147 /// Read traffic statistics.
148 ///
149 #define PXE_OPCODE_STATISTICS 0x000B
150 
151 ///
152 /// Convert multicast IP address to multicast MAC address.
153 ///
154 #define PXE_OPCODE_MCAST_IP_TO_MAC 0x000C
155 
156 ///
157 /// Read or change non-volatile storage on the NIC.
158 ///
159 #define PXE_OPCODE_NVDATA 0x000D
160 
161 ///
162 /// Get & clear interrupt status.
163 ///
164 #define PXE_OPCODE_GET_STATUS 0x000E
165 
166 ///
167 /// Fill media header in packet for transmit.
168 ///
169 #define PXE_OPCODE_FILL_HEADER 0x000F
170 
171 ///
172 /// Transmit packet(s).
173 ///
174 #define PXE_OPCODE_TRANSMIT 0x0010
175 
176 ///
177 /// Receive packet.
178 ///
179 #define PXE_OPCODE_RECEIVE 0x0011
180 
181 ///
182 /// Last valid PXE UNDI OpCode number.
183 ///
184 #define PXE_OPCODE_LAST_VALID 0x0011
185 
187 
188 #define PXE_OPFLAGS_NOT_USED 0x0000
189 
190 //
191 // //////////////////////////////////////
192 // UNDI Get State
193 //
194 // No OpFlags
195 
196 ////////////////////////////////////////
197 // UNDI Start
198 //
199 // No OpFlags
200 
201 ////////////////////////////////////////
202 // UNDI Stop
203 //
204 // No OpFlags
205 
206 ////////////////////////////////////////
207 // UNDI Get Init Info
208 //
209 // No Opflags
210 
211 ////////////////////////////////////////
212 // UNDI Get Config Info
213 //
214 // No Opflags
215 
216 ///
217 /// UNDI Initialize
218 ///
219 #define PXE_OPFLAGS_INITIALIZE_CABLE_DETECT_MASK 0x0001
220 #define PXE_OPFLAGS_INITIALIZE_DETECT_CABLE 0x0000
221 #define PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE 0x0001
222 
223 ///
224 ///
225 /// UNDI Reset
226 ///
227 #define PXE_OPFLAGS_RESET_DISABLE_INTERRUPTS 0x0001
228 #define PXE_OPFLAGS_RESET_DISABLE_FILTERS 0x0002
229 
230 ///
231 /// UNDI Shutdown.
232 ///
233 /// No OpFlags.
234 
235 ///
236 /// UNDI Interrupt Enables.
237 ///
238 ///
239 /// Select whether to enable or disable external interrupt signals.
240 /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPFLAGS.
241 ///
242 #define PXE_OPFLAGS_INTERRUPT_OPMASK 0xC000
243 #define PXE_OPFLAGS_INTERRUPT_ENABLE 0x8000
244 #define PXE_OPFLAGS_INTERRUPT_DISABLE 0x4000
245 #define PXE_OPFLAGS_INTERRUPT_READ 0x0000
246 
247 ///
248 /// Enable receive interrupts. An external interrupt will be generated
249 /// after a complete non-error packet has been received.
250 ///
251 #define PXE_OPFLAGS_INTERRUPT_RECEIVE 0x0001
252 
253 ///
254 /// Enable transmit interrupts. An external interrupt will be generated
255 /// after a complete non-error packet has been transmitted.
256 ///
257 #define PXE_OPFLAGS_INTERRUPT_TRANSMIT 0x0002
258 
259 ///
260 /// Enable command interrupts. An external interrupt will be generated
261 /// when command execution stops.
262 ///
263 #define PXE_OPFLAGS_INTERRUPT_COMMAND 0x0004
264 
265 ///
266 /// Generate software interrupt. Setting this bit generates an external
267 /// interrupt, if it is supported by the hardware.
268 ///
269 #define PXE_OPFLAGS_INTERRUPT_SOFTWARE 0x0008
270 
271 ///
272 /// UNDI Receive Filters.
273 ///
274 ///
275 /// Select whether to enable or disable receive filters.
276 /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPCODE.
277 ///
278 #define PXE_OPFLAGS_RECEIVE_FILTER_OPMASK 0xC000
279 #define PXE_OPFLAGS_RECEIVE_FILTER_ENABLE 0x8000
280 #define PXE_OPFLAGS_RECEIVE_FILTER_DISABLE 0x4000
281 #define PXE_OPFLAGS_RECEIVE_FILTER_READ 0x0000
282 
283 ///
284 /// To reset the contents of the multicast MAC address filter list,
285 /// set this OpFlag:
286 ///
287 #define PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST 0x2000
288 
289 ///
290 /// Enable unicast packet receiving. Packets sent to the current station
291 /// MAC address will be received.
292 ///
293 #define PXE_OPFLAGS_RECEIVE_FILTER_UNICAST 0x0001
294 
295 ///
296 /// Enable broadcast packet receiving. Packets sent to the broadcast
297 /// MAC address will be received.
298 ///
299 #define PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
300 
301 ///
302 /// Enable filtered multicast packet receiving. Packets sent to any
303 /// of the multicast MAC addresses in the multicast MAC address filter
304 /// list will be received. If the filter list is empty, no multicast
305 ///
306 #define PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
307 
308 ///
309 /// Enable promiscuous packet receiving. All packets will be received.
310 ///
311 #define PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
312 
313 ///
314 /// Enable promiscuous multicast packet receiving. All multicast
315 /// packets will be received.
316 ///
317 #define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
318 
319 ///
320 /// UNDI Station Address.
321 ///
322 #define PXE_OPFLAGS_STATION_ADDRESS_READ 0x0000
323 #define PXE_OPFLAGS_STATION_ADDRESS_WRITE 0x0000
324 #define PXE_OPFLAGS_STATION_ADDRESS_RESET 0x0001
325 
326 ///
327 /// UNDI Statistics.
328 ///
329 #define PXE_OPFLAGS_STATISTICS_READ 0x0000
330 #define PXE_OPFLAGS_STATISTICS_RESET 0x0001
331 
332 ///
333 /// UNDI MCast IP to MAC.
334 ///
335 ///
336 /// Identify the type of IP address in the CPB.
337 ///
338 #define PXE_OPFLAGS_MCAST_IP_TO_MAC_OPMASK 0x0003
339 #define PXE_OPFLAGS_MCAST_IPV4_TO_MAC 0x0000
340 #define PXE_OPFLAGS_MCAST_IPV6_TO_MAC 0x0001
341 
342 ///
343 /// UNDI NvData.
344 ///
345 ///
346 /// Select the type of non-volatile data operation.
347 ///
348 #define PXE_OPFLAGS_NVDATA_OPMASK 0x0001
349 #define PXE_OPFLAGS_NVDATA_READ 0x0000
350 #define PXE_OPFLAGS_NVDATA_WRITE 0x0001
351 
352 ///
353 /// UNDI Get Status.
354 ///
355 ///
356 /// Return current interrupt status. This will also clear any interrupts
357 /// that are currently set. This can be used in a polling routine. The
358 /// interrupt flags are still set and cleared even when the interrupts
359 /// are disabled.
360 ///
361 #define PXE_OPFLAGS_GET_INTERRUPT_STATUS 0x0001
362 
363 ///
364 /// Return list of transmitted buffers for recycling. Transmit buffers
365 /// must not be changed or unallocated until they have recycled. After
366 /// issuing a transmit command, wait for a transmit complete interrupt.
367 /// When a transmit complete interrupt is received, read the transmitted
368 /// buffers. Do not plan on getting one buffer per interrupt. Some
369 /// NICs and UNDIs may transmit multiple buffers per interrupt.
370 ///
371 #define PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS 0x0002
372 
373 ///
374 /// Return current media status.
375 ///
376 #define PXE_OPFLAGS_GET_MEDIA_STATUS 0x0004
377 
378 ///
379 /// UNDI Fill Header.
380 ///
381 #define PXE_OPFLAGS_FILL_HEADER_OPMASK 0x0001
382 #define PXE_OPFLAGS_FILL_HEADER_FRAGMENTED 0x0001
383 #define PXE_OPFLAGS_FILL_HEADER_WHOLE 0x0000
384 
385 ///
386 /// UNDI Transmit.
387 ///
388 ///
389 /// S/W UNDI only. Return after the packet has been transmitted. A
390 /// transmit complete interrupt will still be generated and the transmit
391 /// buffer will have to be recycled.
392 ///
393 #define PXE_OPFLAGS_SWUNDI_TRANSMIT_OPMASK 0x0001
394 #define PXE_OPFLAGS_TRANSMIT_BLOCK 0x0001
395 #define PXE_OPFLAGS_TRANSMIT_DONT_BLOCK 0x0000
396 
397 #define PXE_OPFLAGS_TRANSMIT_OPMASK 0x0002
398 #define PXE_OPFLAGS_TRANSMIT_FRAGMENTED 0x0002
399 #define PXE_OPFLAGS_TRANSMIT_WHOLE 0x0000
400 
401 ///
402 /// UNDI Receive.
403 ///
404 /// No OpFlags.
405 ///
406 
407 ///
408 /// PXE STATFLAGS.
409 ///
411 
412 #define PXE_STATFLAGS_INITIALIZE 0x0000
413 
414 ///
415 /// Common StatFlags that can be returned by all commands.
416 ///
417 ///
418 /// The COMMAND_COMPLETE and COMMAND_FAILED status flags must be
419 /// implemented by all UNDIs. COMMAND_QUEUED is only needed by UNDIs
420 /// that support command queuing.
421 ///
422 #define PXE_STATFLAGS_STATUS_MASK 0xC000
423 #define PXE_STATFLAGS_COMMAND_COMPLETE 0xC000
424 #define PXE_STATFLAGS_COMMAND_FAILED 0x8000
425 #define PXE_STATFLAGS_COMMAND_QUEUED 0x4000
426 
427 ///
428 /// UNDI Get State.
429 ///
430 #define PXE_STATFLAGS_GET_STATE_MASK 0x0003
431 #define PXE_STATFLAGS_GET_STATE_INITIALIZED 0x0002
432 #define PXE_STATFLAGS_GET_STATE_STARTED 0x0001
433 #define PXE_STATFLAGS_GET_STATE_STOPPED 0x0000
434 
435 ///
436 /// UNDI Start.
437 ///
438 /// No additional StatFlags.
439 ///
440 
441 ///
442 /// UNDI Get Init Info.
443 ///
444 #define PXE_STATFLAGS_CABLE_DETECT_MASK 0x0001
445 #define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000
446 #define PXE_STATFLAGS_CABLE_DETECT_SUPPORTED 0x0001
447 
448 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK 0x0002
449 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED 0x0000
450 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED 0x0002
451 
452 ///
453 /// UNDI Initialize.
454 ///
455 #define PXE_STATFLAGS_INITIALIZED_NO_MEDIA 0x0001
456 
457 ///
458 /// UNDI Reset.
459 ///
460 #define PXE_STATFLAGS_RESET_NO_MEDIA 0x0001
461 
462 ///
463 /// UNDI Shutdown.
464 ///
465 /// No additional StatFlags.
466 
467 ///
468 /// UNDI Interrupt Enables.
469 ///
470 ///
471 /// If set, receive interrupts are enabled.
472 ///
473 #define PXE_STATFLAGS_INTERRUPT_RECEIVE 0x0001
474 
475 ///
476 /// If set, transmit interrupts are enabled.
477 ///
478 #define PXE_STATFLAGS_INTERRUPT_TRANSMIT 0x0002
479 
480 ///
481 /// If set, command interrupts are enabled.
482 ///
483 #define PXE_STATFLAGS_INTERRUPT_COMMAND 0x0004
484 
485 ///
486 /// UNDI Receive Filters.
487 ///
488 
489 ///
490 /// If set, unicast packets will be received.
491 ///
492 #define PXE_STATFLAGS_RECEIVE_FILTER_UNICAST 0x0001
493 
494 ///
495 /// If set, broadcast packets will be received.
496 ///
497 #define PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
498 
499 ///
500 /// If set, multicast packets that match up with the multicast address
501 /// filter list will be received.
502 ///
503 #define PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
504 
505 ///
506 /// If set, all packets will be received.
507 ///
508 #define PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
509 
510 ///
511 /// If set, all multicast packets will be received.
512 ///
513 #define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
514 
515 ///
516 /// UNDI Station Address.
517 ///
518 /// No additional StatFlags.
519 ///
520 
521 ///
522 /// UNDI Statistics.
523 ///
524 /// No additional StatFlags.
525 ///
526 
527 ///
528 //// UNDI MCast IP to MAC.
529 ////
530 //// No additional StatFlags.
531 
532 ///
533 /// UNDI NvData.
534 ///
535 /// No additional StatFlags.
536 ///
537 
538 ///
539 /// UNDI Get Status.
540 ///
541 
542 ///
543 /// Use to determine if an interrupt has occurred.
544 ///
545 #define PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK 0x000F
546 #define PXE_STATFLAGS_GET_STATUS_NO_INTERRUPTS 0x0000
547 
548 ///
549 /// If set, at least one receive interrupt occurred.
550 ///
551 #define PXE_STATFLAGS_GET_STATUS_RECEIVE 0x0001
552 
553 ///
554 /// If set, at least one transmit interrupt occurred.
555 ///
556 #define PXE_STATFLAGS_GET_STATUS_TRANSMIT 0x0002
557 
558 ///
559 /// If set, at least one command interrupt occurred.
560 ///
561 #define PXE_STATFLAGS_GET_STATUS_COMMAND 0x0004
562 
563 ///
564 /// If set, at least one software interrupt occurred.
565 ///
566 #define PXE_STATFLAGS_GET_STATUS_SOFTWARE 0x0008
567 
568 ///
569 /// This flag is set if the transmitted buffer queue is empty. This flag
570 /// will be set if all transmitted buffer addresses get written into the DB.
571 ///
572 #define PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY 0x0010
573 
574 ///
575 /// This flag is set if no transmitted buffer addresses were written
576 /// into the DB. (This could be because DBsize was too small.)
577 ///
578 #define PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN 0x0020
579 
580 ///
581 /// This flag is set if there is no media detected.
582 ///
583 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA 0x0040
584 
585 ///
586 /// UNDI Fill Header.
587 ///
588 /// No additional StatFlags.
589 ///
590 
591 ///
592 /// UNDI Transmit.
593 ///
594 /// No additional StatFlags.
595 
596 ///
597 /// UNDI Receive
598 ///.
599 
600 ///
601 /// No additional StatFlags.
602 ///
604 
605 #define PXE_STATCODE_INITIALIZE 0x0000
606 
607 ///
608 /// Common StatCodes returned by all UNDI commands, UNDI protocol functions
609 /// and BC protocol functions.
610 ///
611 #define PXE_STATCODE_SUCCESS 0x0000
612 
613 #define PXE_STATCODE_INVALID_CDB 0x0001
614 #define PXE_STATCODE_INVALID_CPB 0x0002
615 #define PXE_STATCODE_BUSY 0x0003
616 #define PXE_STATCODE_QUEUE_FULL 0x0004
617 #define PXE_STATCODE_ALREADY_STARTED 0x0005
618 #define PXE_STATCODE_NOT_STARTED 0x0006
619 #define PXE_STATCODE_NOT_SHUTDOWN 0x0007
620 #define PXE_STATCODE_ALREADY_INITIALIZED 0x0008
621 #define PXE_STATCODE_NOT_INITIALIZED 0x0009
622 #define PXE_STATCODE_DEVICE_FAILURE 0x000A
623 #define PXE_STATCODE_NVDATA_FAILURE 0x000B
624 #define PXE_STATCODE_UNSUPPORTED 0x000C
625 #define PXE_STATCODE_BUFFER_FULL 0x000D
626 #define PXE_STATCODE_INVALID_PARAMETER 0x000E
627 #define PXE_STATCODE_INVALID_UNDI 0x000F
628 #define PXE_STATCODE_IPV4_NOT_SUPPORTED 0x0010
629 #define PXE_STATCODE_IPV6_NOT_SUPPORTED 0x0011
630 #define PXE_STATCODE_NOT_ENOUGH_MEMORY 0x0012
631 #define PXE_STATCODE_NO_DATA 0x0013
632 
634 
635 ///
636 /// This interface number must be passed to the S/W UNDI Start command.
637 ///
638 #define PXE_IFNUM_START 0x0000
639 
640 ///
641 /// This interface number is returned by the S/W UNDI Get State and
642 /// Start commands if information in the CDB, CPB or DB is invalid.
643 ///
644 #define PXE_IFNUM_INVALID 0x0000
645 
647 
648 ///
649 /// Setting this flag directs the UNDI to queue this command for later
650 /// execution if the UNDI is busy and it supports command queuing.
651 /// If queuing is not supported, a PXE_STATCODE_INVALID_CONTROL error
652 /// is returned. If the queue is full, a PXE_STATCODE_CDB_QUEUE_FULL
653 /// error is returned.
654 ///
655 #define PXE_CONTROL_QUEUE_IF_BUSY 0x0002
656 
657 ///
658 /// These two bit values are used to determine if there are more UNDI
659 /// CDB structures following this one. If the link bit is set, there
660 /// must be a CDB structure following this one. Execution will start
661 /// on the next CDB structure as soon as this one completes successfully.
662 /// If an error is generated by this command, execution will stop.
663 ///
664 #define PXE_CONTROL_LINK 0x0001
665 #define PXE_CONTROL_LAST_CDB_IN_LIST 0x0000
666 
668 
669 #define PXE_FRAME_TYPE_NONE 0x00
670 #define PXE_FRAME_TYPE_UNICAST 0x01
671 #define PXE_FRAME_TYPE_BROADCAST 0x02
672 #define PXE_FRAME_TYPE_FILTERED_MULTICAST 0x03
673 #define PXE_FRAME_TYPE_PROMISCUOUS 0x04
674 #define PXE_FRAME_TYPE_PROMISCUOUS_MULTICAST 0x05
675 
676 #define PXE_FRAME_TYPE_MULTICAST PXE_FRAME_TYPE_FILTERED_MULTICAST
677 
679 
680 typedef PXE_UINT32 PXE_IPV6[4];
681 #define PXE_MAC_LENGTH 32
682 
684 
687 
688 ///
689 /// This information is from the ARP section of RFC 1700.
690 ///
691 /// 1 Ethernet (10Mb) [JBP]
692 /// 2 Experimental Ethernet (3Mb) [JBP]
693 /// 3 Amateur Radio AX.25 [PXK]
694 /// 4 Proteon ProNET Token Ring [JBP]
695 /// 5 Chaos [GXP]
696 /// 6 IEEE 802 Networks [JBP]
697 /// 7 ARCNET [JBP]
698 /// 8 Hyperchannel [JBP]
699 /// 9 Lanstar [TU]
700 /// 10 Autonet Short Address [MXB1]
701 /// 11 LocalTalk [JKR1]
702 /// 12 LocalNet (IBM* PCNet or SYTEK* LocalNET) [JXM]
703 /// 13 Ultra link [RXD2]
704 /// 14 SMDS [GXC1]
705 /// 15 Frame Relay [AGM]
706 /// 16 Asynchronous Transmission Mode (ATM) [JXB2]
707 /// 17 HDLC [JBP]
708 /// 18 Fibre Channel [Yakov Rekhter]
709 /// 19 Asynchronous Transmission Mode (ATM) [Mark Laubach]
710 /// 20 Serial Line [JBP]
711 /// 21 Asynchronous Transmission Mode (ATM) [MXB1]
712 ///
713 /// * Other names and brands may be claimed as the property of others.
714 ///
715 #define PXE_IFTYPE_ETHERNET 0x01
716 #define PXE_IFTYPE_TOKENRING 0x04
717 #define PXE_IFTYPE_FIBRE_CHANNEL 0x12
718 
719 typedef struct s_pxe_hw_undi {
720  PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.
721  PXE_UINT8 Len; ///< sizeof(PXE_HW_UNDI).
722  PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero.
723  PXE_UINT8 Rev; ///< PXE_ROMID_REV.
724  PXE_UINT8 IFcnt; ///< physical connector count lower byte.
725  PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.
726  PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.
727  PXE_UINT8 IFcntExt; ///< physical connector count upper byte.
728  PXE_UINT8 reserved; ///< zero, not used.
729  PXE_UINT32 Implementation; ///< implementation flags.
730  ///< reserved ///< vendor use.
731  ///< UINT32 Status; ///< status port.
732  ///< UINT32 Command; ///< command port.
733  ///< UINT64 CDBaddr; ///< CDB address port.
734  ///<
735 } PXE_HW_UNDI;
736 
737 ///
738 /// Status port bit definitions.
739 ///
740 
741 ///
742 /// UNDI operation state.
743 ///
744 #define PXE_HWSTAT_STATE_MASK 0xC0000000
745 #define PXE_HWSTAT_BUSY 0xC0000000
746 #define PXE_HWSTAT_INITIALIZED 0x80000000
747 #define PXE_HWSTAT_STARTED 0x40000000
748 #define PXE_HWSTAT_STOPPED 0x00000000
749 
750 ///
751 /// If set, last command failed.
752 ///
753 #define PXE_HWSTAT_COMMAND_FAILED 0x20000000
754 
755 ///
756 /// If set, identifies enabled receive filters.
757 ///
758 #define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000
759 #define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800
760 #define PXE_HWSTAT_BROADCAST_RX_ENABLED 0x00000400
761 #define PXE_HWSTAT_MULTICAST_RX_ENABLED 0x00000200
762 #define PXE_HWSTAT_UNICAST_RX_ENABLED 0x00000100
763 
764 ///
765 /// If set, identifies enabled external interrupts.
766 ///
767 #define PXE_HWSTAT_SOFTWARE_INT_ENABLED 0x00000080
768 #define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040
769 #define PXE_HWSTAT_PACKET_RX_INT_ENABLED 0x00000020
770 #define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010
771 
772 ///
773 /// If set, identifies pending interrupts.
774 ///
775 #define PXE_HWSTAT_SOFTWARE_INT_PENDING 0x00000008
776 #define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004
777 #define PXE_HWSTAT_PACKET_RX_INT_PENDING 0x00000002
778 #define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001
779 
780 ///
781 /// Command port definitions.
782 ///
783 
784 ///
785 /// If set, CDB identified in CDBaddr port is given to UNDI.
786 /// If not set, other bits in this word will be processed.
787 ///
788 #define PXE_HWCMD_ISSUE_COMMAND 0x80000000
789 #define PXE_HWCMD_INTS_AND_FILTS 0x00000000
790 
791 ///
792 /// Use these to enable/disable receive filters.
793 ///
794 #define PXE_HWCMD_PROMISCUOUS_MULTICAST_RX_ENABLE 0x00001000
795 #define PXE_HWCMD_PROMISCUOUS_RX_ENABLE 0x00000800
796 #define PXE_HWCMD_BROADCAST_RX_ENABLE 0x00000400
797 #define PXE_HWCMD_MULTICAST_RX_ENABLE 0x00000200
798 #define PXE_HWCMD_UNICAST_RX_ENABLE 0x00000100
799 
800 ///
801 /// Use these to enable/disable external interrupts.
802 ///
803 #define PXE_HWCMD_SOFTWARE_INT_ENABLE 0x00000080
804 #define PXE_HWCMD_TX_COMPLETE_INT_ENABLE 0x00000040
805 #define PXE_HWCMD_PACKET_RX_INT_ENABLE 0x00000020
806 #define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010
807 
808 ///
809 /// Use these to clear pending external interrupts.
810 ///
811 #define PXE_HWCMD_CLEAR_SOFTWARE_INT 0x00000008
812 #define PXE_HWCMD_CLEAR_TX_COMPLETE_INT 0x00000004
813 #define PXE_HWCMD_CLEAR_PACKET_RX_INT 0x00000002
814 #define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT 0x00000001
815 
816 typedef struct s_pxe_sw_undi {
817  PXE_UINT32 Signature; ///< PXE_ROMID_SIGNATURE.
818  PXE_UINT8 Len; ///< sizeof(PXE_SW_UNDI).
819  PXE_UINT8 Fudge; ///< makes 8-bit cksum zero.
820  PXE_UINT8 Rev; ///< PXE_ROMID_REV.
821  PXE_UINT8 IFcnt; ///< physical connector count lower byte.
822  PXE_UINT8 MajorVer; ///< PXE_ROMID_MAJORVER.
823  PXE_UINT8 MinorVer; ///< PXE_ROMID_MINORVER.
824  PXE_UINT8 IFcntExt; ///< physical connector count upper byte.
825  PXE_UINT8 reserved1; ///< zero, not used.
826  PXE_UINT32 Implementation; ///< Implementation flags.
827  PXE_UINT64 EntryPoint; ///< API entry point.
828  PXE_UINT8 reserved2[3]; ///< zero, not used.
829  PXE_UINT8 BusCnt; ///< number of bustypes supported.
830  PXE_UINT32 BusType[1]; ///< list of supported bustypes.
831 } PXE_SW_UNDI;
832 
833 typedef union u_pxe_undi {
836 } PXE_UNDI;
837 
838 ///
839 /// Signature of !PXE structure.
840 ///
841 #define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')
842 
843 ///
844 /// !PXE structure format revision
845 ///.
846 #define PXE_ROMID_REV 0x02
847 
848 ///
849 /// UNDI command interface revision. These are the values that get sent
850 /// in option 94 (Client Network Interface Identifier) in the DHCP Discover
851 /// and PXE Boot Server Request packets.
852 ///
853 #define PXE_ROMID_MAJORVER 0x03
854 #define PXE_ROMID_MINORVER 0x01
855 
856 ///
857 /// Implementation flags.
858 ///
859 #define PXE_ROMID_IMP_HW_UNDI 0x80000000
860 #define PXE_ROMID_IMP_SW_VIRT_ADDR 0x40000000
861 #define PXE_ROMID_IMP_64BIT_DEVICE 0x00010000
862 #define PXE_ROMID_IMP_FRAG_SUPPORTED 0x00008000
863 #define PXE_ROMID_IMP_CMD_LINK_SUPPORTED 0x00004000
864 #define PXE_ROMID_IMP_CMD_QUEUE_SUPPORTED 0x00002000
865 #define PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED 0x00001000
866 #define PXE_ROMID_IMP_NVDATA_SUPPORT_MASK 0x00000C00
867 #define PXE_ROMID_IMP_NVDATA_BULK_WRITABLE 0x00000C00
868 #define PXE_ROMID_IMP_NVDATA_SPARSE_WRITABLE 0x00000800
869 #define PXE_ROMID_IMP_NVDATA_READ_ONLY 0x00000400
870 #define PXE_ROMID_IMP_NVDATA_NOT_AVAILABLE 0x00000000
871 #define PXE_ROMID_IMP_STATISTICS_SUPPORTED 0x00000200
872 #define PXE_ROMID_IMP_STATION_ADDR_SETTABLE 0x00000100
873 #define PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED 0x00000080
874 #define PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED 0x00000040
875 #define PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED 0x00000020
876 #define PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED 0x00000010
877 #define PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED 0x00000008
878 #define PXE_ROMID_IMP_TX_COMPLETE_INT_SUPPORTED 0x00000004
879 #define PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED 0x00000002
880 #define PXE_ROMID_IMP_CMD_COMPLETE_INT_SUPPORTED 0x00000001
881 
882 typedef struct s_pxe_cdb {
893 } PXE_CDB;
894 
895 typedef union u_pxe_ip_addr {
898 } PXE_IP_ADDR;
899 
900 typedef union pxe_device {
901  ///
902  /// PCI and PC Card NICs are both identified using bus, device
903  /// and function numbers. For PC Card, this may require PC
904  /// Card services to be loaded in the BIOS or preboot
905  /// environment.
906  ///
907  struct {
908  ///
909  /// See S/W UNDI ROMID structure definition for PCI and
910  /// PCC BusType definitions.
911  ///
913 
914  ///
915  /// Bus, device & function numbers that locate this device.
916  ///
920  }
921  PCI, PCC;
922 
923 } PXE_DEVICE;
924 
925 ///
926 /// cpb and db definitions
927 ///
928 #define MAX_PCI_CONFIG_LEN 64 ///< # of dwords.
929 #define MAX_EEPROM_LEN 128 ///< # of dwords.
930 #define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done.
931 #define MAX_MCAST_ADDRESS_CNT 8
932 
933 typedef struct s_pxe_cpb_start_30 {
934  ///
935  /// PXE_VOID Delay(UINTN microseconds);
936  ///
937  /// UNDI will never request a delay smaller than 10 microseconds
938  /// and will always request delays in increments of 10 microseconds.
939  /// The Delay() CallBack routine must delay between n and n + 10
940  /// microseconds before returning control to the UNDI.
941  ///
942  /// This field cannot be set to zero.
943  ///
945 
946  ///
947  /// PXE_VOID Block(UINT32 enable);
948  ///
949  /// UNDI may need to block multi-threaded/multi-processor access to
950  /// critical code sections when programming or accessing the network
951  /// device. To this end, a blocking service is needed by the UNDI.
952  /// When UNDI needs a block, it will call Block() passing a non-zero
953  /// value. When UNDI no longer needs a block, it will call Block()
954  /// with a zero value. When called, if the Block() is already enabled,
955  /// do not return control to the UNDI until the previous Block() is
956  /// disabled.
957  ///
958  /// This field cannot be set to zero.
959  ///
961 
962  ///
963  /// PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);
964  ///
965  /// UNDI will pass the virtual address of a buffer and the virtual
966  /// address of a 64-bit physical buffer. Convert the virtual address
967  /// to a physical address and write the result to the physical address
968  /// buffer. If virtual and physical addresses are the same, just
969  /// copy the virtual address to the physical address buffer.
970  ///
971  /// This field can be set to zero if virtual and physical addresses
972  /// are equal.
973  ///
975  ///
976  /// PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port,
977  /// UINT64 buf_addr);
978  ///
979  /// UNDI will read or write the device io space using this call back
980  /// function. It passes the number of bytes as the len parameter and it
981  /// will be either 1,2,4 or 8.
982  ///
983  /// This field can not be set to zero.
984  ///
987 
988 typedef struct s_pxe_cpb_start_31 {
989  ///
990  /// PXE_VOID Delay(UINT64 UnqId, UINTN microseconds);
991  ///
992  /// UNDI will never request a delay smaller than 10 microseconds
993  /// and will always request delays in increments of 10 microseconds.
994  /// The Delay() CallBack routine must delay between n and n + 10
995  /// microseconds before returning control to the UNDI.
996  ///
997  /// This field cannot be set to zero.
998  ///
1000 
1001  ///
1002  /// PXE_VOID Block(UINT64 unq_id, UINT32 enable);
1003  ///
1004  /// UNDI may need to block multi-threaded/multi-processor access to
1005  /// critical code sections when programming or accessing the network
1006  /// device. To this end, a blocking service is needed by the UNDI.
1007  /// When UNDI needs a block, it will call Block() passing a non-zero
1008  /// value. When UNDI no longer needs a block, it will call Block()
1009  /// with a zero value. When called, if the Block() is already enabled,
1010  /// do not return control to the UNDI until the previous Block() is
1011  /// disabled.
1012  ///
1013  /// This field cannot be set to zero.
1014  ///
1016 
1017  ///
1018  /// PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);
1019  ///
1020  /// UNDI will pass the virtual address of a buffer and the virtual
1021  /// address of a 64-bit physical buffer. Convert the virtual address
1022  /// to a physical address and write the result to the physical address
1023  /// buffer. If virtual and physical addresses are the same, just
1024  /// copy the virtual address to the physical address buffer.
1025  ///
1026  /// This field can be set to zero if virtual and physical addresses
1027  /// are equal.
1028  ///
1030  ///
1031  /// PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port,
1032  /// UINT64 buf_addr);
1033  ///
1034  /// UNDI will read or write the device io space using this call back
1035  /// function. It passes the number of bytes as the len parameter and it
1036  /// will be either 1,2,4 or 8.
1037  ///
1038  /// This field can not be set to zero.
1039  ///
1041  ///
1042  /// PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
1043  /// UINT32 Direction, UINT64 mapped_addr);
1044  ///
1045  /// UNDI will pass the virtual address of a buffer, direction of the data
1046  /// flow from/to the mapped buffer (the constants are defined below)
1047  /// and a place holder (pointer) for the mapped address.
1048  /// This call will Map the given address to a physical DMA address and write
1049  /// the result to the mapped_addr pointer. If there is no need to
1050  /// map the given address to a lower address (i.e. the given address is
1051  /// associated with a physical address that is already compatible to be
1052  /// used with the DMA, it converts the given virtual address to it's
1053  /// physical address and write that in the mapped address pointer.
1054  ///
1055  /// This field can be set to zero if there is no mapping service available.
1056  ///
1058 
1059  ///
1060  /// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
1061  /// UINT32 Direction, UINT64 mapped_addr);
1062  ///
1063  /// UNDI will pass the virtual and mapped addresses of a buffer.
1064  /// This call will un map the given address.
1065  ///
1066  /// This field can be set to zero if there is no unmapping service available.
1067  ///
1069 
1070  ///
1071  /// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,
1072  /// UINT32 size, UINT32 Direction, UINT64 mapped_addr);
1073  ///
1074  /// UNDI will pass the virtual and mapped addresses of a buffer.
1075  /// This call will synchronize the contents of both the virtual and mapped.
1076  /// buffers for the given Direction.
1077  ///
1078  /// This field can be set to zero if there is no service available.
1079  ///
1081 
1082  ///
1083  /// protocol driver can provide anything for this Unique_ID, UNDI remembers
1084  /// that as just a 64bit value associated to the interface specified by
1085  /// the ifnum and gives it back as a parameter to all the call-back routines
1086  /// when calling for that interface!
1087  ///
1090 
1091 #define TO_AND_FROM_DEVICE 0
1092 #define FROM_DEVICE 1
1093 #define TO_DEVICE 2
1094 
1095 #define PXE_DELAY_MILLISECOND 1000
1096 #define PXE_DELAY_SECOND 1000000
1097 #define PXE_IO_READ 0
1098 #define PXE_IO_WRITE 1
1099 #define PXE_MEM_READ 2
1100 #define PXE_MEM_WRITE 4
1101 
1102 typedef struct s_pxe_db_get_init_info {
1103  ///
1104  /// Minimum length of locked memory buffer that must be given to
1105  /// the Initialize command. Giving UNDI more memory will generally
1106  /// give better performance.
1107  ///
1108  /// If MemoryRequired is zero, the UNDI does not need and will not
1109  /// use system memory to receive and transmit packets.
1110  ///
1112 
1113  ///
1114  /// Maximum frame data length for Tx/Rx excluding the media header.
1115  ///
1117 
1118  ///
1119  /// Supported link speeds are in units of mega bits. Common ethernet
1120  /// values are 10, 100 and 1000. Unused LinkSpeeds[] entries are zero
1121  /// filled.
1122  ///
1124 
1125  ///
1126  /// Number of non-volatile storage items.
1127  ///
1129 
1130  ///
1131  /// Width of non-volatile storage item in bytes. 0, 1, 2 or 4
1132  ///
1134 
1135  ///
1136  /// Media header length. This is the typical media header length for
1137  /// this UNDI. This information is needed when allocating receive
1138  /// and transmit buffers.
1139  ///
1141 
1142  ///
1143  /// Number of bytes in the NIC hardware (MAC) address.
1144  ///
1146 
1147  ///
1148  /// Maximum number of multicast MAC addresses in the multicast
1149  /// MAC address filter list.
1150  ///
1152 
1153  ///
1154  /// Default number and size of transmit and receive buffers that will
1155  /// be allocated by the UNDI. If MemoryRequired is non-zero, this
1156  /// allocation will come out of the memory buffer given to the Initialize
1157  /// command. If MemoryRequired is zero, this allocation will come out of
1158  /// memory on the NIC.
1159  ///
1164 
1165  ///
1166  /// Hardware interface types defined in the Assigned Numbers RFC
1167  /// and used in DHCP and ARP packets.
1168  /// See the PXE_IFTYPE typedef and PXE_IFTYPE_xxx macros.
1169  ///
1171 
1172  ///
1173  /// Supported duplex. See PXE_DUPLEX_xxxxx #defines below.
1174  ///
1176 
1177  ///
1178  /// Supported loopback options. See PXE_LOOPBACK_xxxxx #defines below.
1179  ///
1182 
1183 #define PXE_MAX_TXRX_UNIT_ETHER 1500
1184 
1185 #define PXE_HWADDR_LEN_ETHER 0x0006
1186 #define PXE_MAC_HEADER_LEN_ETHER 0x000E
1187 
1188 #define PXE_DUPLEX_ENABLE_FULL_SUPPORTED 1
1189 #define PXE_DUPLEX_FORCE_FULL_SUPPORTED 2
1190 
1191 #define PXE_LOOPBACK_INTERNAL_SUPPORTED 1
1192 #define PXE_LOOPBACK_EXTERNAL_SUPPORTED 2
1193 
1194 typedef struct s_pxe_pci_config_info {
1195  ///
1196  /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
1197  /// For PCI bus devices, this field is set to PXE_BUSTYPE_PCI.
1198  ///
1200 
1201  ///
1202  /// This identifies the PCI network device that this UNDI interface.
1203  /// is bound to.
1204  ///
1208 
1209  ///
1210  /// This is a copy of the PCI configuration space for this
1211  /// network device.
1212  ///
1213  union {
1214  UINT8 Byte[256];
1215  UINT16 Word[128];
1217  } Config;
1219 
1220 typedef struct s_pxe_pcc_config_info {
1221  ///
1222  /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
1223  /// For PCC bus devices, this field is set to PXE_BUSTYPE_PCC.
1224  ///
1226 
1227  ///
1228  /// This identifies the PCC network device that this UNDI interface
1229  /// is bound to.
1230  ///
1234 
1235  ///
1236  /// This is a copy of the PCC configuration space for this
1237  /// network device.
1238  ///
1239  union {
1243  } Config;
1245 
1250 
1251 typedef struct s_pxe_cpb_initialize {
1252  ///
1253  /// Address of first (lowest) byte of the memory buffer. This buffer must
1254  /// be in contiguous physical memory and cannot be swapped out. The UNDI
1255  /// will be using this for transmit and receive buffering.
1256  ///
1258 
1259  ///
1260  /// MemoryLength must be greater than or equal to MemoryRequired
1261  /// returned by the Get Init Info command.
1262  ///
1264 
1265  ///
1266  /// Desired link speed in Mbit/sec. Common ethernet values are 10, 100
1267  /// and 1000. Setting a value of zero will auto-detect and/or use the
1268  /// default link speed (operation depends on UNDI/NIC functionality).
1269  ///
1271 
1272  ///
1273  /// Suggested number and size of receive and transmit buffers to
1274  /// allocate. If MemoryAddr and MemoryLength are non-zero, this
1275  /// allocation comes out of the supplied memory buffer. If MemoryAddr
1276  /// and MemoryLength are zero, this allocation comes out of memory
1277  /// on the NIC.
1278  ///
1279  /// If these fields are set to zero, the UNDI will allocate buffer
1280  /// counts and sizes as it sees fit.
1281  ///
1286 
1287  ///
1288  /// The following configuration parameters are optional and must be zero
1289  /// to use the default values.
1290  ///
1292 
1295 
1296 #define PXE_DUPLEX_DEFAULT 0x00
1297 #define PXE_FORCE_FULL_DUPLEX 0x01
1298 #define PXE_ENABLE_FULL_DUPLEX 0x02
1299 #define PXE_FORCE_HALF_DUPLEX 0x04
1300 #define PXE_DISABLE_FULL_DUPLEX 0x08
1301 
1302 #define LOOPBACK_NORMAL 0
1303 #define LOOPBACK_INTERNAL 1
1304 #define LOOPBACK_EXTERNAL 2
1305 
1306 typedef struct s_pxe_db_initialize {
1307  ///
1308  /// Actual amount of memory used from the supplied memory buffer. This
1309  /// may be less that the amount of memory suppllied and may be zero if
1310  /// the UNDI and network device do not use external memory buffers.
1311  ///
1312  /// Memory used by the UNDI and network device is allocated from the
1313  /// lowest memory buffer address.
1314  ///
1316 
1317  ///
1318  /// Actual number and size of receive and transmit buffers that were
1319  /// allocated.
1320  ///
1326 
1328  ///
1329  /// List of multicast MAC addresses. This list, if present, will
1330  /// replace the existing multicast MAC address filter list.
1331  ///
1334 
1336  ///
1337  /// Filtered multicast MAC address list.
1338  ///
1341 
1343  ///
1344  /// If supplied and supported, the current station MAC address
1345  /// will be changed.
1346  ///
1349 
1351  ///
1352  /// Current station MAC address.
1353  ///
1355 
1356  ///
1357  /// Station broadcast MAC address.
1358  ///
1360 
1361  ///
1362  /// Permanent station MAC address.
1363  ///
1366 
1367 typedef struct s_pxe_db_statistics {
1368  ///
1369  /// Bit field identifying what statistic data is collected by the
1370  /// UNDI/NIC.
1371  /// If bit 0x00 is set, Data[0x00] is collected.
1372  /// If bit 0x01 is set, Data[0x01] is collected.
1373  /// If bit 0x20 is set, Data[0x20] is collected.
1374  /// If bit 0x21 is set, Data[0x21] is collected.
1375  /// Etc.
1376  ///
1378 
1379  ///
1380  /// Statistic data.
1381  ///
1384 
1385 ///
1386 /// Total number of frames received. Includes frames with errors and
1387 /// dropped frames.
1388 ///
1389 #define PXE_STATISTICS_RX_TOTAL_FRAMES 0x00
1390 
1391 ///
1392 /// Number of valid frames received and copied into receive buffers.
1393 ///
1394 #define PXE_STATISTICS_RX_GOOD_FRAMES 0x01
1395 
1396 ///
1397 /// Number of frames below the minimum length for the media.
1398 /// This would be <64 for ethernet.
1399 ///
1400 #define PXE_STATISTICS_RX_UNDERSIZE_FRAMES 0x02
1401 
1402 ///
1403 /// Number of frames longer than the maxminum length for the
1404 /// media. This would be >1500 for ethernet.
1405 ///
1406 #define PXE_STATISTICS_RX_OVERSIZE_FRAMES 0x03
1407 
1408 ///
1409 /// Valid frames that were dropped because receive buffers were full.
1410 ///
1411 #define PXE_STATISTICS_RX_DROPPED_FRAMES 0x04
1412 
1413 ///
1414 /// Number of valid unicast frames received and not dropped.
1415 ///
1416 #define PXE_STATISTICS_RX_UNICAST_FRAMES 0x05
1417 
1418 ///
1419 /// Number of valid broadcast frames received and not dropped.
1420 ///
1421 #define PXE_STATISTICS_RX_BROADCAST_FRAMES 0x06
1422 
1423 ///
1424 /// Number of valid mutlicast frames received and not dropped.
1425 ///
1426 #define PXE_STATISTICS_RX_MULTICAST_FRAMES 0x07
1427 
1428 ///
1429 /// Number of frames w/ CRC or alignment errors.
1430 ///
1431 #define PXE_STATISTICS_RX_CRC_ERROR_FRAMES 0x08
1432 
1433 ///
1434 /// Total number of bytes received. Includes frames with errors
1435 /// and dropped frames.
1436 ///
1437 #define PXE_STATISTICS_RX_TOTAL_BYTES 0x09
1438 
1439 ///
1440 /// Transmit statistics.
1441 ///
1442 #define PXE_STATISTICS_TX_TOTAL_FRAMES 0x0A
1443 #define PXE_STATISTICS_TX_GOOD_FRAMES 0x0B
1444 #define PXE_STATISTICS_TX_UNDERSIZE_FRAMES 0x0C
1445 #define PXE_STATISTICS_TX_OVERSIZE_FRAMES 0x0D
1446 #define PXE_STATISTICS_TX_DROPPED_FRAMES 0x0E
1447 #define PXE_STATISTICS_TX_UNICAST_FRAMES 0x0F
1448 #define PXE_STATISTICS_TX_BROADCAST_FRAMES 0x10
1449 #define PXE_STATISTICS_TX_MULTICAST_FRAMES 0x11
1450 #define PXE_STATISTICS_TX_CRC_ERROR_FRAMES 0x12
1451 #define PXE_STATISTICS_TX_TOTAL_BYTES 0x13
1452 
1453 ///
1454 /// Number of collisions detection on this subnet.
1455 ///
1456 #define PXE_STATISTICS_COLLISIONS 0x14
1457 
1458 ///
1459 /// Number of frames destined for unsupported protocol.
1460 ///
1461 #define PXE_STATISTICS_UNSUPPORTED_PROTOCOL 0x15
1462 
1463 ///
1464 /// Number of valid frames received that were duplicated.
1465 ///
1466 #define PXE_STATISTICS_RX_DUPLICATED_FRAMES 0x16
1467 
1468 ///
1469 /// Number of encrypted frames received that failed to decrypt.
1470 ///
1471 #define PXE_STATISTICS_RX_DECRYPT_ERROR_FRAMES 0x17
1472 
1473 ///
1474 /// Number of frames that failed to transmit after exceeding the retry limit.
1475 ///
1476 #define PXE_STATISTICS_TX_ERROR_FRAMES 0x18
1477 
1478 ///
1479 /// Number of frames transmitted successfully after more than one attempt.
1480 ///
1481 #define PXE_STATISTICS_TX_RETRY_FRAMES 0x19
1482 
1484  ///
1485  /// Multicast IP address to be converted to multicast MAC address.
1486  ///
1489 
1491  ///
1492  /// Multicast MAC address.
1493  ///
1496 
1497 typedef struct s_pxe_cpb_nvdata_sparse {
1498  ///
1499  /// NvData item list. Only items in this list will be updated.
1500  ///
1501  struct {
1502  ///
1503  /// Non-volatile storage address to be changed.
1504  ///
1506 
1507  ///
1508  /// Data item to write into above storage address.
1509  ///
1510  union {
1514  } Data;
1515  } Item[MAX_EEPROM_LEN];
1517 
1518 ///
1519 /// When using bulk update, the size of the CPB structure must be
1520 /// the same size as the non-volatile NIC storage.
1521 ///
1522 typedef union u_pxe_cpb_nvdata_bulk {
1523  ///
1524  /// Array of byte-wide data items.
1525  ///
1527 
1528  ///
1529  /// Array of word-wide data items.
1530  ///
1532 
1533  ///
1534  /// Array of dword-wide data items.
1535  ///
1538 
1539 typedef struct s_pxe_db_nvdata {
1540  ///
1541  /// Arrays of data items from non-volatile storage.
1542  ///
1543  union {
1544  ///
1545  /// Array of byte-wide data items.
1546  ///
1548 
1549  ///
1550  /// Array of word-wide data items.
1551  ///
1553 
1554  ///
1555  /// Array of dword-wide data items.
1556  ///
1558  } Data;
1559 } PXE_DB_NVDATA;
1560 
1561 typedef struct s_pxe_db_get_status {
1562  ///
1563  /// Length of next receive frame (header + data). If this is zero,
1564  /// there is no next receive frame available.
1565  ///
1567 
1568  ///
1569  /// Reserved, set to zero.
1570  ///
1572 
1573  ///
1574  /// Addresses of transmitted buffers that need to be recycled.
1575  ///
1578 
1579 typedef struct s_pxe_cpb_fill_header {
1580  ///
1581  /// Source and destination MAC addresses. These will be copied into
1582  /// the media header without doing byte swapping.
1583  ///
1586 
1587  ///
1588  /// Address of first byte of media header. The first byte of packet data
1589  /// follows the last byte of the media header.
1590  ///
1592 
1593  ///
1594  /// Length of packet data in bytes (not including the media header).
1595  ///
1597 
1598  ///
1599  /// Protocol type. This will be copied into the media header without
1600  /// doing byte swapping. Protocol type numbers can be obtained from
1601  /// the Assigned Numbers RFC 1700.
1602  ///
1604 
1605  ///
1606  /// Length of the media header in bytes.
1607  ///
1610 
1611 #define PXE_PROTOCOL_ETHERNET_IP 0x0800
1612 #define PXE_PROTOCOL_ETHERNET_ARP 0x0806
1613 #define MAX_XMIT_FRAGMENTS 16
1614 
1616  ///
1617  /// Source and destination MAC addresses. These will be copied into
1618  /// the media header without doing byte swapping.
1619  ///
1622 
1623  ///
1624  /// Length of packet data in bytes (not including the media header).
1625  ///
1627 
1628  ///
1629  /// Protocol type. This will be copied into the media header without
1630  /// doing byte swapping. Protocol type numbers can be obtained from
1631  /// the Assigned Numbers RFC 1700.
1632  ///
1634 
1635  ///
1636  /// Length of the media header in bytes.
1637  ///
1639 
1640  ///
1641  /// Number of packet fragment descriptors.
1642  ///
1644 
1645  ///
1646  /// Reserved, must be set to zero.
1647  ///
1649 
1650  ///
1651  /// Array of packet fragment descriptors. The first byte of the media
1652  /// header is the first byte of the first fragment.
1653  ///
1654  struct {
1655  ///
1656  /// Address of this packet fragment.
1657  ///
1659 
1660  ///
1661  /// Length of this packet fragment.
1662  ///
1664 
1665  ///
1666  /// Reserved, must be set to zero.
1667  ///
1670 }
1672 
1673 typedef struct s_pxe_cpb_transmit {
1674  ///
1675  /// Address of first byte of frame buffer. This is also the first byte
1676  /// of the media header.
1677  ///
1679 
1680  ///
1681  /// Length of the data portion of the frame buffer in bytes. Do not
1682  /// include the length of the media header.
1683  ///
1685 
1686  ///
1687  /// Length of the media header in bytes.
1688  ///
1690 
1691  ///
1692  /// Reserved, must be zero.
1693  ///
1696 
1698  ///
1699  /// Length of packet data in bytes (not including the media header).
1700  ///
1702 
1703  ///
1704  /// Length of the media header in bytes.
1705  ///
1707 
1708  ///
1709  /// Number of packet fragment descriptors.
1710  ///
1712 
1713  ///
1714  /// Array of frame fragment descriptors. The first byte of the first
1715  /// fragment is also the first byte of the media header.
1716  ///
1717  struct {
1718  ///
1719  /// Address of this frame fragment.
1720  ///
1722 
1723  ///
1724  /// Length of this frame fragment.
1725  ///
1727 
1728  ///
1729  /// Reserved, must be set to zero.
1730  ///
1733 }
1735 
1736 typedef struct s_pxe_cpb_receive {
1737  ///
1738  /// Address of first byte of receive buffer. This is also the first byte
1739  /// of the frame header.
1740  ///
1742 
1743  ///
1744  /// Length of receive buffer. This must be large enough to hold the
1745  /// received frame (media header + data). If the length of smaller than
1746  /// the received frame, data will be lost.
1747  ///
1749 
1750  ///
1751  /// Reserved, must be set to zero.
1752  ///
1754 } PXE_CPB_RECEIVE;
1755 
1756 typedef struct s_pxe_db_receive {
1757  ///
1758  /// Source and destination MAC addresses from media header.
1759  ///
1762 
1763  ///
1764  /// Length of received frame. May be larger than receive buffer size.
1765  /// The receive buffer will not be overwritten. This is how to tell
1766  /// if data was lost because the receive buffer was too small.
1767  ///
1769 
1770  ///
1771  /// Protocol type from media header.
1772  ///
1774 
1775  ///
1776  /// Length of media header in received frame.
1777  ///
1779 
1780  ///
1781  /// Type of receive frame.
1782  ///
1784 
1785  ///
1786  /// Reserved, must be zero.
1787  ///
1789 
1790 } PXE_DB_RECEIVE;
1791 
1792 #pragma pack()
1793 
1794 #endif
PXE_UINT32 reserved
Reserved, set to zero.
Definition: UefiPxe.h:1571
union u_pxe_ip_addr PXE_IP_ADDR
PXE_UINT64 Supported
Bit field identifying what statistic data is collected by the UNDI/NIC.
Definition: UefiPxe.h:1377
struct pxe_device::@511 PCI
PCI and PC Card NICs are both identified using bus, device and function numbers.
UINT32 Dword[64]
Definition: UefiPxe.h:1216
PXE_UINT16 Protocol
Protocol type.
Definition: UefiPxe.h:1603
PXE_UINT16 RxBufSize
Definition: UefiPxe.h:1285
PXE_UINT32 BufferLen
Length of receive buffer.
Definition: UefiPxe.h:1748
PXE_UINT32 Dword[MAX_EEPROM_LEN]
Array of dword-wide data items.
Definition: UefiPxe.h:1536
PXE_UINT8 reserved2[3]
zero, not used.
Definition: UefiPxe.h:828
union s_pxe_pci_config_info::@512 Config
This is a copy of the PCI configuration space for this network device.
PXE_STATCODE StatCode
Definition: UefiPxe.h:889
struct s_pxe_cpb_transmit_fragments::@518 FragDesc[MAX_XMIT_FRAGMENTS]
Array of frame fragment descriptors.
PXE_UINT16 CPBsize
Definition: UefiPxe.h:885
PXE_MAC_ADDR SrcAddr
Source and destination MAC addresses.
Definition: UefiPxe.h:1620
struct s_pxe_pcc_config_info PXE_PCC_CONFIG_INFO
UINT64 PXE_UINT64
Typedef unsigned long PXE_UINT64.
Definition: UefiPxe.h:83
PXE_UINT16 TxBufSize
Definition: UefiPxe.h:1283
PXE_UINT32 FrameLen
Length of packet data in bytes (not including the media header).
Definition: UefiPxe.h:1701
PXE_SW_UNDI sw
Definition: UefiPxe.h:835
PXE_UINT16 PXE_STATCODE
UNDI Fill Header.
Definition: UefiPxe.h:603
VOID PXE_VOID
Definition: UefiPxe.h:74
PXE_UINT32 MemoryLength
MemoryLength must be greater than or equal to MemoryRequired returned by the Get Init Info command.
Definition: UefiPxe.h:1263
PXE_UINT32 FragLen
Length of this packet fragment.
Definition: UefiPxe.h:1663
PXE_UINT8 Byte[MAX_EEPROM_LEN<< 2]
Array of byte-wide data items.
Definition: UefiPxe.h:1526
PXE_UINT16 MediaHeaderLen
Length of the media header in bytes.
Definition: UefiPxe.h:1638
PXE_IPV6 IPv6
Definition: UefiPxe.h:896
PXE_UINT16 RxBufCnt
Definition: UefiPxe.h:1323
PXE_UINT16 DBsize
Definition: UefiPxe.h:886
PXE_UINT8 MinorVer
PXE_ROMID_MINORVER.
Definition: UefiPxe.h:726
PXE_UINT32 MemoryUsed
Actual amount of memory used from the supplied memory buffer.
Definition: UefiPxe.h:1315
PXE_UINT8 Rev
PXE_ROMID_REV.
Definition: UefiPxe.h:820
UINT32 BusType
This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
Definition: UefiPxe.h:1199
PXE_MEDIA_PROTOCOL Protocol
Protocol type from media header.
Definition: UefiPxe.h:1773
PXE_UINT8 Function
Definition: UefiPxe.h:1233
UINT32 PXE_UINT32
Definition: UefiPxe.h:77
struct s_pxe_db_receive PXE_DB_RECEIVE
PXE_UINT32 DataLen
Length of the data portion of the frame buffer in bytes.
Definition: UefiPxe.h:1684
PXE_MAC_ADDR DestAddr
Definition: UefiPxe.h:1761
struct s_pxe_cpb_transmit PXE_CPB_TRANSMIT
PXE_UINT16 PXE_IFNUM
Definition: UefiPxe.h:633
PXE_OPFLAGS OpFlags
Definition: UefiPxe.h:884
struct s_pxe_db_initialize PXE_DB_INITIALIZE
struct s_pxe_db_get_init_info PXE_DB_GET_INIT_INFO
unsigned int UINT32
Definition: ProcessorBind.h:56
struct s_pxe_cpb_transmit_fragments PXE_CPB_TRANSMIT_FRAGMENTS
PXE_UINT32 Implementation
Implementation flags.
Definition: UefiPxe.h:826
struct s_pxe_cpb_nvdata_sparse::@514 Item[MAX_EEPROM_LEN]
NvData item list.
PXE_UINT16 reserved
Reserved, must be set to zero.
Definition: UefiPxe.h:1648
UINT16 Word[128]
Definition: UefiPxe.h:1215
PXE_UINT8 IFcntExt
physical connector count upper byte.
Definition: UefiPxe.h:727
PXE_MAC_ADDR StationAddr
If supplied and supported, the current station MAC address will be changed.
Definition: UefiPxe.h:1347
PXE_UINT8 MajorVer
PXE_ROMID_MAJORVER.
Definition: UefiPxe.h:725
PXE_UINT16 MediaHeaderLen
Length of the media header in bytes.
Definition: UefiPxe.h:1608
#define MAX_XMIT_FRAGMENTS
Definition: UefiPxe.h:1613
PXE_UINT16 TxBufSize
Definition: UefiPxe.h:1322
PXE_MAC_ADDR DestAddr
Definition: UefiPxe.h:1585
PXE_UINT32 LinkSpeeds[4]
Supported link speeds are in units of mega bits.
Definition: UefiPxe.h:1123
PXE_UINT16 PXE_CONTROL
Definition: UefiPxe.h:646
PXE_UINT32 reserved
Reserved, must be set to zero.
Definition: UefiPxe.h:1731
unsigned char UINT8
Definition: ProcessorBind.h:62
PXE_UINT8 PXE_BOOL
Definition: UefiPxe.h:85
PXE_UINT32 FragLen
Length of this frame fragment.
Definition: UefiPxe.h:1726
PXE_MAC_ADDR SrcAddr
Source and destination MAC addresses.
Definition: UefiPxe.h:1584
PXE_UINT32 Signature
PXE_ROMID_SIGNATURE.
Definition: UefiPxe.h:720
PXE_UINT16 MCastFilterCnt
Maximum number of multicast MAC addresses in the multicast MAC address filter list.
Definition: UefiPxe.h:1151
PXE_UINT64 FrameAddr
Address of first byte of frame buffer.
Definition: UefiPxe.h:1678
PXE_UINT64 MemoryAddr
Address of first (lowest) byte of the memory buffer.
Definition: UefiPxe.h:1257
UINT64 Delay
PXE_VOID Delay(UINTN microseconds);.
Definition: UefiPxe.h:944
PXE_UINT32 MemoryRequired
Minimum length of locked memory buffer that must be given to the Initialize command.
Definition: UefiPxe.h:1111
PXE_UINT32 PacketLen
Length of packet data in bytes (not including the media header).
Definition: UefiPxe.h:1596
PXE_MAC_ADDR BroadcastAddr
Station broadcast MAC address.
Definition: UefiPxe.h:1359
UINT16 Bus
This identifies the PCI network device that this UNDI interface.
Definition: UefiPxe.h:1205
PXE_UINT32 LinkSpeed
Desired link speed in Mbit/sec.
Definition: UefiPxe.h:1270
UINT16 PXE_MEDIA_PROTOCOL
Definition: UefiPxe.h:686
PXE_UINT16 reserved
Reserved, must be zero.
Definition: UefiPxe.h:1694
PXE_IP_ADDR IP
Multicast IP address to be converted to multicast MAC address.
Definition: UefiPxe.h:1487
struct s_pxe_cpb_nvdata_sparse PXE_CPB_NVDATA_SPARSE
PXE_UINT8 Rev
PXE_ROMID_REV.
Definition: UefiPxe.h:723
PXE_UINT16 RxBufSize
Definition: UefiPxe.h:1163
UINT64 Mem_IO
PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port, UINT64 buf_addr);.
Definition: UefiPxe.h:1040
PXE_UINT8 Fudge
makes 8-bit cksum equal zero.
Definition: UefiPxe.h:722
PXE_MAC_ADDR StationAddr
Current station MAC address.
Definition: UefiPxe.h:1354
PXE_UINT32 Dword[64]
Definition: UefiPxe.h:1242
PXE_UINT8 DuplexMode
The following configuration parameters are optional and must be zero to use the default values.
Definition: UefiPxe.h:1291
PXE_UINT16 Word[128]
Definition: UefiPxe.h:1241
PXE_MEDIA_PROTOCOL Protocol
Protocol type.
Definition: UefiPxe.h:1633
struct s_pxe_cpb_start_31 PXE_CPB_START_31
struct s_pxe_cpb_mcast_ip_to_mac PXE_CPB_MCAST_IP_TO_MAC
struct s_pxe_cpb_fill_header_fragmented PXE_CPB_FILL_HEADER_FRAGMENTED
PXE_UINT16 TxBufCnt
Suggested number and size of receive and transmit buffers to allocate.
Definition: UefiPxe.h:1282
union s_pxe_db_nvdata::@516 Data
Arrays of data items from non-volatile storage.
PXE_UINT16 MediaHeaderLen
Media header length.
Definition: UefiPxe.h:1140
struct s_pxe_db_nvdata PXE_DB_NVDATA
PXE_UINT16 PXE_OPCODE
Definition: UefiPxe.h:89
#define PXE_MAC_LENGTH
Definition: UefiPxe.h:681
union pxe_device PXE_DEVICE
PXE_HW_UNDI hw
Definition: UefiPxe.h:834
PXE_UINT16 MediaheaderLen
Length of the media header in bytes.
Definition: UefiPxe.h:1706
PXE_UINT32 PacketLen
Length of packet data in bytes (not including the media header).
Definition: UefiPxe.h:1626
struct s_pxe_cpb_initialize PXE_CPB_INITIALIZE
PXE_UINT16 PXE_STATFLAGS
UNDI Receive.
Definition: UefiPxe.h:410
PXE_UINT8 SupportedLoopBackModes
Supported loopback options.
Definition: UefiPxe.h:1180
PXE_UINT8 reserved[7]
Reserved, must be zero.
Definition: UefiPxe.h:1788
UINTN PXE_UINTN
Definition: UefiPxe.h:78
PXE_PCI_CONFIG_INFO pci
Definition: UefiPxe.h:1247
PXE_UINT16 PXE_OPFLAGS
Definition: UefiPxe.h:186
UINT64 Map_Mem
PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size, UINT32 Direction,...
Definition: UefiPxe.h:1057
struct s_pxe_cpb_receive PXE_CPB_RECEIVE
unsigned short UINT16
Definition: ProcessorBind.h:58
struct s_pxe_cpb_fill_header PXE_CPB_FILL_HEADER
PXE_UINT16 Word[MAX_EEPROM_LEN<< 1]
Array of word-wide data items.
Definition: UefiPxe.h:1552
PXE_UINT16 TxBufCnt
Actual number and size of receive and transmit buffers that were allocated.
Definition: UefiPxe.h:1321
PXE_UINT8 Device
Definition: UefiPxe.h:918
PXE_UINT64 CPBaddr
Definition: UefiPxe.h:887
UINT64 Virt2Phys
PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);.
Definition: UefiPxe.h:1029
PXE_UINT64 BufferAddr
Address of first byte of receive buffer.
Definition: UefiPxe.h:1741
PXE_UINT32 RxFrameLen
Length of next receive frame (header + data).
Definition: UefiPxe.h:1566
PXE_MAC_ADDR MAC
Multicast MAC address.
Definition: UefiPxe.h:1494
struct s_pxe_db_mcast_ip_to_mac PXE_DB_MCAST_IP_TO_MAC
union u_pxe_db_get_config_info PXE_DB_GET_CONFIG_INFO
PXE_UINT8 reserved
zero, not used.
Definition: UefiPxe.h:728
struct s_pxe_cpb_station_address PXE_CPB_STATION_ADDRESS
struct s_pxe_dpb_station_address PXE_DB_STATION_ADDRESS
PXE_UINT8 Fudge
makes 8-bit cksum zero.
Definition: UefiPxe.h:819
struct s_pxe_cpb_receive_filters PXE_CPB_RECEIVE_FILTERS
UINT64 Virt2Phys
PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);.
Definition: UefiPxe.h:974
UINT64 UINTN
Unsigned value of native width.
Definition: ProcessorBind.h:71
PXE_MAC_ADDR SrcAddr
Source and destination MAC addresses from media header.
Definition: UefiPxe.h:1760
PXE_UINT16 Bus
Bus, device & function numbers that locate this device.
Definition: UefiPxe.h:917
PXE_UINT32 reserved
Reserved, must be set to zero.
Definition: UefiPxe.h:1753
PXE_UINT8 Len
sizeof(PXE_HW_UNDI).
Definition: UefiPxe.h:721
#define VOID
Undeclared type.
Definition: Base.h:319
#define MAX_MCAST_ADDRESS_CNT
Definition: UefiPxe.h:931
unsigned long long UINT64
Definition: ProcessorBind.h:54
PXE_UINT8 IFcnt
physical connector count lower byte.
Definition: UefiPxe.h:724
struct s_pxe_db_receive_filters PXE_DB_RECEIVE_FILTERS
PXE_UINT8 BusCnt
number of bustypes supported.
Definition: UefiPxe.h:829
PXE_UINT32 NvCount
Number of non-volatile storage items.
Definition: UefiPxe.h:1128
PXE_UINT64 TxBuffer[MAX_XMIT_BUFFERS]
Addresses of transmitted buffers that need to be recycled.
Definition: UefiPxe.h:1576
union s_pxe_pcc_config_info::@513 Config
This is a copy of the PCC configuration space for this network device.
PXE_UINT8 MajorVer
PXE_ROMID_MAJORVER.
Definition: UefiPxe.h:822
PXE_UINT16 Bus
This identifies the PCC network device that this UNDI interface is bound to.
Definition: UefiPxe.h:1231
PXE_UINT16 Word[MAX_EEPROM_LEN<< 1]
Array of word-wide data items.
Definition: UefiPxe.h:1531
UINT16 PXE_UINT16
Definition: UefiPxe.h:76
PXE_UINT64 Data[64]
Statistic data.
Definition: UefiPxe.h:1382
struct s_pxe_cpb_start_30 PXE_CPB_START_30
struct s_pxe_hw_undi PXE_HW_UNDI
PXE_UINT64 FragAddr
Address of this frame fragment.
Definition: UefiPxe.h:1721
PXE_MAC_ADDR MCastList[MAX_MCAST_ADDRESS_CNT]
Filtered multicast MAC address list.
Definition: UefiPxe.h:1339
When using bulk update, the size of the CPB structure must be the same size as the non-volatile NIC s...
Definition: UefiPxe.h:1522
PXE_UINT8 Byte[MAX_EEPROM_LEN<< 2]
Array of byte-wide data items.
Definition: UefiPxe.h:1547
PXE_UINT16 NvWidth
Width of non-volatile storage item in bytes.
Definition: UefiPxe.h:1133
PXE_UINT8 reserved1
zero, not used.
Definition: UefiPxe.h:825
PXE_UINT8 IFcntExt
physical connector count upper byte.
Definition: UefiPxe.h:824
PXE_UINT32 Dword[MAX_EEPROM_LEN]
Array of dword-wide data items.
Definition: UefiPxe.h:1557
UINT64 Delay
PXE_VOID Delay(UINT64 UnqId, UINTN microseconds);.
Definition: UefiPxe.h:999
UINT64 Sync_Mem
PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual, UINT32 size, UINT32 Direction, UINT64 mapped_addr);.
Definition: UefiPxe.h:1080
union s_pxe_cpb_nvdata_sparse::@514::@515 Data
Data item to write into above storage address.
#define MAX_XMIT_BUFFERS
recycling Q length for xmit_done.
Definition: UefiPxe.h:930
struct s_pxe_cpb_fill_header_fragmented::@517 FragDesc[MAX_XMIT_FRAGMENTS]
Array of packet fragment descriptors.
PXE_UINT64 EntryPoint
API entry point.
Definition: UefiPxe.h:827
PXE_UINT16 FragCnt
Number of packet fragment descriptors.
Definition: UefiPxe.h:1643
PXE_UINT16 MediaheaderLen
Length of the media header in bytes.
Definition: UefiPxe.h:1689
PXE_UINT8 Function
Definition: UefiPxe.h:919
PXE_UINT8 PXE_IFTYPE
Definition: UefiPxe.h:685
PXE_UINT8 IFcnt
physical connector count lower byte.
Definition: UefiPxe.h:821
struct s_pxe_cdb PXE_CDB
UINT64 Block
PXE_VOID Block(UINT64 unq_id, UINT32 enable);.
Definition: UefiPxe.h:1015
UINT64 Unique_ID
protocol driver can provide anything for this Unique_ID, UNDI remembers that as just a 64bit value as...
Definition: UefiPxe.h:1088
PXE_UINT32 Addr
Non-volatile storage address to be changed.
Definition: UefiPxe.h:1505
PXE_UINT64 MediaHeader
Address of first byte of media header.
Definition: UefiPxe.h:1591
PXE_STATFLAGS StatFlags
Definition: UefiPxe.h:890
FILE_LICENCE(BSD3)
PXE_FRAME_TYPE Type
Type of receive frame.
Definition: UefiPxe.h:1783
PXE_UINT8 SupportedDuplexModes
Supported duplex.
Definition: UefiPxe.h:1175
struct s_pxe_sw_undi PXE_SW_UNDI
PXE_MAC_ADDR PermanentAddr
Permanent station MAC address.
Definition: UefiPxe.h:1364
PXE_PCC_CONFIG_INFO pcc
Definition: UefiPxe.h:1248
PXE_UINT32 BusType[1]
list of supported bustypes.
Definition: UefiPxe.h:830
PXE_UINT16 RxBufCnt
Definition: UefiPxe.h:1284
union u_pxe_undi PXE_UNDI
PXE_UINT8 PXE_MAC_ADDR[PXE_MAC_LENGTH]
Definition: UefiPxe.h:683
PXE_IPV4 IPv4
Definition: UefiPxe.h:897
struct s_pxe_db_statistics PXE_DB_STATISTICS
PXE_UINT16 RxBufCnt
Definition: UefiPxe.h:1162
PXE_UINT16 HWaddrLen
Number of bytes in the NIC hardware (MAC) address.
Definition: UefiPxe.h:1145
struct s_pxe_db_get_status PXE_DB_GET_STATUS
PXE_UINT8 IFtype
Hardware interface types defined in the Assigned Numbers RFC and used in DHCP and ARP packets.
Definition: UefiPxe.h:1170
union u_pxe_cpb_nvdata_bulk PXE_CPB_NVDATA_BULK
When using bulk update, the size of the CPB structure must be the same size as the non-volatile NIC s...
PXE_UINT16 TxBufSize
Definition: UefiPxe.h:1161
struct pxe_device::@511 PCC
PXE_UINT32 PXE_IPV4
Definition: UefiPxe.h:678
PXE_UINT32 PXE_IPV6[4]
Definition: UefiPxe.h:680
UINT64 Mem_IO
PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port, UINT64 buf_addr);.
Definition: UefiPxe.h:985
UINT64 Block
PXE_VOID Block(UINT32 enable);.
Definition: UefiPxe.h:960
PXE_UINT16 TxBufCnt
Default number and size of transmit and receive buffers that will be allocated by the UNDI.
Definition: UefiPxe.h:1160
PXE_UINT8 PXE_FRAME_TYPE
Definition: UefiPxe.h:667
PXE_UINT16 IFnum
Definition: UefiPxe.h:891
UINT8 PXE_UINT8
Definition: UefiPxe.h:75
PXE_UINT16 MediaHeaderLen
Length of media header in received frame.
Definition: UefiPxe.h:1778
PXE_UINT8 Byte[256]
Definition: UefiPxe.h:1240
UINT64 UnMap_Mem
PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size, UINT32 Direction,...
Definition: UefiPxe.h:1068
PXE_UINT32 BusType
This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
Definition: UefiPxe.h:1225
PXE_OPCODE OpCode
Definition: UefiPxe.h:883
PXE_UINT8 LoopBackMode
Definition: UefiPxe.h:1293
PXE_UINT32 Signature
PXE_ROMID_SIGNATURE.
Definition: UefiPxe.h:817
struct s_pxe_pci_config_info PXE_PCI_CONFIG_INFO
PXE_UINT32 FrameDataLen
Maximum frame data length for Tx/Rx excluding the media header.
Definition: UefiPxe.h:1116
PXE_UINT32 reserved
Reserved, must be set to zero.
Definition: UefiPxe.h:1668
PXE_UINT32 BusType
See S/W UNDI ROMID structure definition for PCI and PCC BusType definitions.
Definition: UefiPxe.h:912
PXE_UINT32 FrameLen
Length of received frame.
Definition: UefiPxe.h:1768
#define MAX_EEPROM_LEN
Definition: UefiPxe.h:929
PXE_CONTROL Control
Definition: UefiPxe.h:892
PXE_UINT32 Implementation
implementation flags.
Definition: UefiPxe.h:729
PXE_UINT64 DBaddr
Definition: UefiPxe.h:888
PXE_UINT64 FragAddr
Address of this packet fragment.
Definition: UefiPxe.h:1658
PXE_UINT16 FragCnt
Number of packet fragment descriptors.
Definition: UefiPxe.h:1711
PXE_UINT8 Len
sizeof(PXE_SW_UNDI).
Definition: UefiPxe.h:818
PXE_UINT16 RxBufSize
Definition: UefiPxe.h:1324
PXE_UINT8 MinorVer
PXE_ROMID_MINORVER.
Definition: UefiPxe.h:823
PXE_MAC_ADDR MCastList[MAX_MCAST_ADDRESS_CNT]
List of multicast MAC addresses.
Definition: UefiPxe.h:1332