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.
6 Copyright (c) 2006 - 2010, 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.
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.
15 @par Revision Reference:
16 32/64-bit PXE specification:
26 #define PXE_BUSTYPE(a, b, c, d) \
28 (((PXE_UINT32) (d) & 0xFF) << 24) | (((PXE_UINT32) (c) & 0xFF) << 16) | (((PXE_UINT32) (b) & 0xFF) << 8) | \
29 ((PXE_UINT32) (a) & 0xFF) \
33 /// UNDI ROM ID and devive ID signature.
35 #define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')
38 /// BUS ROM ID signatures.
40 #define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')
41 #define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')
42 #define PXE_BUSTYPE_USB PXE_BUSTYPE ('U', 'S', 'B', 'R')
43 #define PXE_BUSTYPE_1394 PXE_BUSTYPE ('1', '3', '9', '4')
45 #define PXE_SWAP_UINT16(n) ((((PXE_UINT16) (n) & 0x00FF) << 8) | (((PXE_UINT16) (n) & 0xFF00) >> 8))
47 #define PXE_SWAP_UINT32(n) \
48 ((((PXE_UINT32)(n) & 0x000000FF) << 24) | \
49 (((PXE_UINT32)(n) & 0x0000FF00) << 8) | \
50 (((PXE_UINT32)(n) & 0x00FF0000) >> 8) | \
51 (((PXE_UINT32)(n) & 0xFF000000) >> 24))
53 #define PXE_SWAP_UINT64(n) \
54 ((((PXE_UINT64)(n) & 0x00000000000000FFULL) << 56) | \
55 (((PXE_UINT64)(n) & 0x000000000000FF00ULL) << 40) | \
56 (((PXE_UINT64)(n) & 0x0000000000FF0000ULL) << 24) | \
57 (((PXE_UINT64)(n) & 0x00000000FF000000ULL) << 8) | \
58 (((PXE_UINT64)(n) & 0x000000FF00000000ULL) >> 8) | \
59 (((PXE_UINT64)(n) & 0x0000FF0000000000ULL) >> 24) | \
60 (((PXE_UINT64)(n) & 0x00FF000000000000ULL) >> 40) | \
61 (((PXE_UINT64)(n) & 0xFF00000000000000ULL) >> 56))
64 #define PXE_CPBSIZE_NOT_USED 0 ///< zero
65 #define PXE_DBSIZE_NOT_USED 0 ///< zero
66 #define PXE_CPBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
67 #define PXE_DBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
68 #define PXE_CONST CONST
70 #define PXE_VOLATILE volatile
72 typedef VOID PXE_VOID
;
73 typedef UINT8 PXE_UINT8
;
74 typedef UINT16 PXE_UINT16
;
75 typedef UINT32 PXE_UINT32
;
76 typedef UINTN PXE_UINTN
;
79 /// Typedef unsigned long PXE_UINT64.
81 typedef UINT64 PXE_UINT64
;
83 typedef PXE_UINT8 PXE_BOOL
;
84 #define PXE_FALSE 0 ///< zero
85 #define PXE_TRUE (!PXE_FALSE)
87 typedef PXE_UINT16 PXE_OPCODE
;
90 /// Return UNDI operational state.
92 #define PXE_OPCODE_GET_STATE 0x0000
95 /// Change UNDI operational state from Stopped to Started.
97 #define PXE_OPCODE_START 0x0001
100 /// Change UNDI operational state from Started to Stopped.
102 #define PXE_OPCODE_STOP 0x0002
105 /// Get UNDI initialization information.
107 #define PXE_OPCODE_GET_INIT_INFO 0x0003
110 /// Get NIC configuration information.
112 #define PXE_OPCODE_GET_CONFIG_INFO 0x0004
115 /// Changed UNDI operational state from Started to Initialized.
117 #define PXE_OPCODE_INITIALIZE 0x0005
120 /// Re-initialize the NIC H/W.
122 #define PXE_OPCODE_RESET 0x0006
125 /// Change the UNDI operational state from Initialized to Started.
127 #define PXE_OPCODE_SHUTDOWN 0x0007
130 /// Read & change state of external interrupt enables.
132 #define PXE_OPCODE_INTERRUPT_ENABLES 0x0008
135 /// Read & change state of packet receive filters.
137 #define PXE_OPCODE_RECEIVE_FILTERS 0x0009
140 /// Read & change station MAC address.
142 #define PXE_OPCODE_STATION_ADDRESS 0x000A
145 /// Read traffic statistics.
147 #define PXE_OPCODE_STATISTICS 0x000B
150 /// Convert multicast IP address to multicast MAC address.
152 #define PXE_OPCODE_MCAST_IP_TO_MAC 0x000C
155 /// Read or change non-volatile storage on the NIC.
157 #define PXE_OPCODE_NVDATA 0x000D
160 /// Get & clear interrupt status.
162 #define PXE_OPCODE_GET_STATUS 0x000E
165 /// Fill media header in packet for transmit.
167 #define PXE_OPCODE_FILL_HEADER 0x000F
170 /// Transmit packet(s).
172 #define PXE_OPCODE_TRANSMIT 0x0010
177 #define PXE_OPCODE_RECEIVE 0x0011
180 /// Last valid PXE UNDI OpCode number.
182 #define PXE_OPCODE_LAST_VALID 0x0011
184 typedef PXE_UINT16 PXE_OPFLAGS
;
186 #define PXE_OPFLAGS_NOT_USED 0x0000
189 // //////////////////////////////////////
194 ////////////////////////////////////////
199 ////////////////////////////////////////
204 ////////////////////////////////////////
205 // UNDI Get Init Info
209 ////////////////////////////////////////
210 // UNDI Get Config Info
217 #define PXE_OPFLAGS_INITIALIZE_CABLE_DETECT_MASK 0x0001
218 #define PXE_OPFLAGS_INITIALIZE_DETECT_CABLE 0x0000
219 #define PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE 0x0001
225 #define PXE_OPFLAGS_RESET_DISABLE_INTERRUPTS 0x0001
226 #define PXE_OPFLAGS_RESET_DISABLE_FILTERS 0x0002
234 /// UNDI Interrupt Enables.
237 /// Select whether to enable or disable external interrupt signals.
238 /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPFLAGS.
240 #define PXE_OPFLAGS_INTERRUPT_OPMASK 0xC000
241 #define PXE_OPFLAGS_INTERRUPT_ENABLE 0x8000
242 #define PXE_OPFLAGS_INTERRUPT_DISABLE 0x4000
243 #define PXE_OPFLAGS_INTERRUPT_READ 0x0000
246 /// Enable receive interrupts. An external interrupt will be generated
247 /// after a complete non-error packet has been received.
249 #define PXE_OPFLAGS_INTERRUPT_RECEIVE 0x0001
252 /// Enable transmit interrupts. An external interrupt will be generated
253 /// after a complete non-error packet has been transmitted.
255 #define PXE_OPFLAGS_INTERRUPT_TRANSMIT 0x0002
258 /// Enable command interrupts. An external interrupt will be generated
259 /// when command execution stops.
261 #define PXE_OPFLAGS_INTERRUPT_COMMAND 0x0004
264 /// Generate software interrupt. Setting this bit generates an external
265 /// interrupt, if it is supported by the hardware.
267 #define PXE_OPFLAGS_INTERRUPT_SOFTWARE 0x0008
270 /// UNDI Receive Filters.
273 /// Select whether to enable or disable receive filters.
274 /// Setting both enable and disable will return PXE_STATCODE_INVALID_OPCODE.
276 #define PXE_OPFLAGS_RECEIVE_FILTER_OPMASK 0xC000
277 #define PXE_OPFLAGS_RECEIVE_FILTER_ENABLE 0x8000
278 #define PXE_OPFLAGS_RECEIVE_FILTER_DISABLE 0x4000
279 #define PXE_OPFLAGS_RECEIVE_FILTER_READ 0x0000
282 /// To reset the contents of the multicast MAC address filter list,
285 #define PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST 0x2000
288 /// Enable unicast packet receiving. Packets sent to the current station
289 /// MAC address will be received.
291 #define PXE_OPFLAGS_RECEIVE_FILTER_UNICAST 0x0001
294 /// Enable broadcast packet receiving. Packets sent to the broadcast
295 /// MAC address will be received.
297 #define PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
300 /// Enable filtered multicast packet receiving. Packets sent to any
301 /// of the multicast MAC addresses in the multicast MAC address filter
302 /// list will be received. If the filter list is empty, no multicast
304 #define PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
307 /// Enable promiscuous packet receiving. All packets will be received.
309 #define PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
312 /// Enable promiscuous multicast packet receiving. All multicast
313 /// packets will be received.
315 #define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
318 /// UNDI Station Address.
320 #define PXE_OPFLAGS_STATION_ADDRESS_READ 0x0000
321 #define PXE_OPFLAGS_STATION_ADDRESS_WRITE 0x0000
322 #define PXE_OPFLAGS_STATION_ADDRESS_RESET 0x0001
327 #define PXE_OPFLAGS_STATISTICS_READ 0x0000
328 #define PXE_OPFLAGS_STATISTICS_RESET 0x0001
331 /// UNDI MCast IP to MAC.
334 /// Identify the type of IP address in the CPB.
336 #define PXE_OPFLAGS_MCAST_IP_TO_MAC_OPMASK 0x0003
337 #define PXE_OPFLAGS_MCAST_IPV4_TO_MAC 0x0000
338 #define PXE_OPFLAGS_MCAST_IPV6_TO_MAC 0x0001
344 /// Select the type of non-volatile data operation.
346 #define PXE_OPFLAGS_NVDATA_OPMASK 0x0001
347 #define PXE_OPFLAGS_NVDATA_READ 0x0000
348 #define PXE_OPFLAGS_NVDATA_WRITE 0x0001
354 /// Return current interrupt status. This will also clear any interrupts
355 /// that are currently set. This can be used in a polling routine. The
356 /// interrupt flags are still set and cleared even when the interrupts
359 #define PXE_OPFLAGS_GET_INTERRUPT_STATUS 0x0001
362 /// Return list of transmitted buffers for recycling. Transmit buffers
363 /// must not be changed or unallocated until they have recycled. After
364 /// issuing a transmit command, wait for a transmit complete interrupt.
365 /// When a transmit complete interrupt is received, read the transmitted
366 /// buffers. Do not plan on getting one buffer per interrupt. Some
367 /// NICs and UNDIs may transmit multiple buffers per interrupt.
369 #define PXE_OPFLAGS_GET_TRANSMITTED_BUFFERS 0x0002
372 /// Return current media status.
374 #define PXE_OPFLAGS_GET_MEDIA_STATUS 0x0004
377 /// UNDI Fill Header.
379 #define PXE_OPFLAGS_FILL_HEADER_OPMASK 0x0001
380 #define PXE_OPFLAGS_FILL_HEADER_FRAGMENTED 0x0001
381 #define PXE_OPFLAGS_FILL_HEADER_WHOLE 0x0000
387 /// S/W UNDI only. Return after the packet has been transmitted. A
388 /// transmit complete interrupt will still be generated and the transmit
389 /// buffer will have to be recycled.
391 #define PXE_OPFLAGS_SWUNDI_TRANSMIT_OPMASK 0x0001
392 #define PXE_OPFLAGS_TRANSMIT_BLOCK 0x0001
393 #define PXE_OPFLAGS_TRANSMIT_DONT_BLOCK 0x0000
395 #define PXE_OPFLAGS_TRANSMIT_OPMASK 0x0002
396 #define PXE_OPFLAGS_TRANSMIT_FRAGMENTED 0x0002
397 #define PXE_OPFLAGS_TRANSMIT_WHOLE 0x0000
408 typedef PXE_UINT16 PXE_STATFLAGS
;
410 #define PXE_STATFLAGS_INITIALIZE 0x0000
413 /// Common StatFlags that can be returned by all commands.
416 /// The COMMAND_COMPLETE and COMMAND_FAILED status flags must be
417 /// implemented by all UNDIs. COMMAND_QUEUED is only needed by UNDIs
418 /// that support command queuing.
420 #define PXE_STATFLAGS_STATUS_MASK 0xC000
421 #define PXE_STATFLAGS_COMMAND_COMPLETE 0xC000
422 #define PXE_STATFLAGS_COMMAND_FAILED 0x8000
423 #define PXE_STATFLAGS_COMMAND_QUEUED 0x4000
428 #define PXE_STATFLAGS_GET_STATE_MASK 0x0003
429 #define PXE_STATFLAGS_GET_STATE_INITIALIZED 0x0002
430 #define PXE_STATFLAGS_GET_STATE_STARTED 0x0001
431 #define PXE_STATFLAGS_GET_STATE_STOPPED 0x0000
436 /// No additional StatFlags.
440 /// UNDI Get Init Info.
442 #define PXE_STATFLAGS_CABLE_DETECT_MASK 0x0001
443 #define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000
444 #define PXE_STATFLAGS_CABLE_DETECT_SUPPORTED 0x0001
446 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK 0x0002
447 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED 0x0000
448 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED 0x0002
453 #define PXE_STATFLAGS_INITIALIZED_NO_MEDIA 0x0001
458 #define PXE_STATFLAGS_RESET_NO_MEDIA 0x0001
463 /// No additional StatFlags.
466 /// UNDI Interrupt Enables.
469 /// If set, receive interrupts are enabled.
471 #define PXE_STATFLAGS_INTERRUPT_RECEIVE 0x0001
474 /// If set, transmit interrupts are enabled.
476 #define PXE_STATFLAGS_INTERRUPT_TRANSMIT 0x0002
479 /// If set, command interrupts are enabled.
481 #define PXE_STATFLAGS_INTERRUPT_COMMAND 0x0004
484 /// UNDI Receive Filters.
488 /// If set, unicast packets will be received.
490 #define PXE_STATFLAGS_RECEIVE_FILTER_UNICAST 0x0001
493 /// If set, broadcast packets will be received.
495 #define PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
498 /// If set, multicast packets that match up with the multicast address
499 /// filter list will be received.
501 #define PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
504 /// If set, all packets will be received.
506 #define PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
509 /// If set, all multicast packets will be received.
511 #define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
514 /// UNDI Station Address.
516 /// No additional StatFlags.
522 /// No additional StatFlags.
526 //// UNDI MCast IP to MAC.
528 //// No additional StatFlags.
533 /// No additional StatFlags.
541 /// Use to determine if an interrupt has occurred.
543 #define PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK 0x000F
544 #define PXE_STATFLAGS_GET_STATUS_NO_INTERRUPTS 0x0000
547 /// If set, at least one receive interrupt occurred.
549 #define PXE_STATFLAGS_GET_STATUS_RECEIVE 0x0001
552 /// If set, at least one transmit interrupt occurred.
554 #define PXE_STATFLAGS_GET_STATUS_TRANSMIT 0x0002
557 /// If set, at least one command interrupt occurred.
559 #define PXE_STATFLAGS_GET_STATUS_COMMAND 0x0004
562 /// If set, at least one software interrupt occurred.
564 #define PXE_STATFLAGS_GET_STATUS_SOFTWARE 0x0008
567 /// This flag is set if the transmitted buffer queue is empty. This flag
568 /// will be set if all transmitted buffer addresses get written into the DB.
570 #define PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY 0x0010
573 /// This flag is set if no transmitted buffer addresses were written
574 /// into the DB. (This could be because DBsize was too small.)
576 #define PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN 0x0020
579 /// This flag is set if there is no media detected.
581 #define PXE_STATFLAGS_GET_STATUS_NO_MEDIA 0x0040
584 /// UNDI Fill Header.
586 /// No additional StatFlags.
592 /// No additional StatFlags.
599 /// No additional StatFlags.
601 typedef PXE_UINT16 PXE_STATCODE
;
603 #define PXE_STATCODE_INITIALIZE 0x0000
606 /// Common StatCodes returned by all UNDI commands, UNDI protocol functions
607 /// and BC protocol functions.
609 #define PXE_STATCODE_SUCCESS 0x0000
611 #define PXE_STATCODE_INVALID_CDB 0x0001
612 #define PXE_STATCODE_INVALID_CPB 0x0002
613 #define PXE_STATCODE_BUSY 0x0003
614 #define PXE_STATCODE_QUEUE_FULL 0x0004
615 #define PXE_STATCODE_ALREADY_STARTED 0x0005
616 #define PXE_STATCODE_NOT_STARTED 0x0006
617 #define PXE_STATCODE_NOT_SHUTDOWN 0x0007
618 #define PXE_STATCODE_ALREADY_INITIALIZED 0x0008
619 #define PXE_STATCODE_NOT_INITIALIZED 0x0009
620 #define PXE_STATCODE_DEVICE_FAILURE 0x000A
621 #define PXE_STATCODE_NVDATA_FAILURE 0x000B
622 #define PXE_STATCODE_UNSUPPORTED 0x000C
623 #define PXE_STATCODE_BUFFER_FULL 0x000D
624 #define PXE_STATCODE_INVALID_PARAMETER 0x000E
625 #define PXE_STATCODE_INVALID_UNDI 0x000F
626 #define PXE_STATCODE_IPV4_NOT_SUPPORTED 0x0010
627 #define PXE_STATCODE_IPV6_NOT_SUPPORTED 0x0011
628 #define PXE_STATCODE_NOT_ENOUGH_MEMORY 0x0012
629 #define PXE_STATCODE_NO_DATA 0x0013
631 typedef PXE_UINT16 PXE_IFNUM
;
634 /// This interface number must be passed to the S/W UNDI Start command.
636 #define PXE_IFNUM_START 0x0000
639 /// This interface number is returned by the S/W UNDI Get State and
640 /// Start commands if information in the CDB, CPB or DB is invalid.
642 #define PXE_IFNUM_INVALID 0x0000
644 typedef PXE_UINT16 PXE_CONTROL
;
647 /// Setting this flag directs the UNDI to queue this command for later
648 /// execution if the UNDI is busy and it supports command queuing.
649 /// If queuing is not supported, a PXE_STATCODE_INVALID_CONTROL error
650 /// is returned. If the queue is full, a PXE_STATCODE_CDB_QUEUE_FULL
651 /// error is returned.
653 #define PXE_CONTROL_QUEUE_IF_BUSY 0x0002
656 /// These two bit values are used to determine if there are more UNDI
657 /// CDB structures following this one. If the link bit is set, there
658 /// must be a CDB structure following this one. Execution will start
659 /// on the next CDB structure as soon as this one completes successfully.
660 /// If an error is generated by this command, execution will stop.
662 #define PXE_CONTROL_LINK 0x0001
663 #define PXE_CONTROL_LAST_CDB_IN_LIST 0x0000
665 typedef PXE_UINT8 PXE_FRAME_TYPE
;
667 #define PXE_FRAME_TYPE_NONE 0x00
668 #define PXE_FRAME_TYPE_UNICAST 0x01
669 #define PXE_FRAME_TYPE_BROADCAST 0x02
670 #define PXE_FRAME_TYPE_FILTERED_MULTICAST 0x03
671 #define PXE_FRAME_TYPE_PROMISCUOUS 0x04
672 #define PXE_FRAME_TYPE_PROMISCUOUS_MULTICAST 0x05
674 #define PXE_FRAME_TYPE_MULTICAST PXE_FRAME_TYPE_FILTERED_MULTICAST
676 typedef PXE_UINT32 PXE_IPV4
;
678 typedef PXE_UINT32 PXE_IPV6
[4];
679 #define PXE_MAC_LENGTH 32
681 typedef PXE_UINT8 PXE_MAC_ADDR
[PXE_MAC_LENGTH
];
683 typedef PXE_UINT8 PXE_IFTYPE
;
684 typedef UINT16 PXE_MEDIA_PROTOCOL
;
687 /// This information is from the ARP section of RFC 1700.
689 /// 1 Ethernet (10Mb) [JBP]
690 /// 2 Experimental Ethernet (3Mb) [JBP]
691 /// 3 Amateur Radio AX.25 [PXK]
692 /// 4 Proteon ProNET Token Ring [JBP]
694 /// 6 IEEE 802 Networks [JBP]
696 /// 8 Hyperchannel [JBP]
698 /// 10 Autonet Short Address [MXB1]
699 /// 11 LocalTalk [JKR1]
700 /// 12 LocalNet (IBM* PCNet or SYTEK* LocalNET) [JXM]
701 /// 13 Ultra link [RXD2]
703 /// 15 Frame Relay [AGM]
704 /// 16 Asynchronous Transmission Mode (ATM) [JXB2]
706 /// 18 Fibre Channel [Yakov Rekhter]
707 /// 19 Asynchronous Transmission Mode (ATM) [Mark Laubach]
708 /// 20 Serial Line [JBP]
709 /// 21 Asynchronous Transmission Mode (ATM) [MXB1]
711 /// * Other names and brands may be claimed as the property of others.
713 #define PXE_IFTYPE_ETHERNET 0x01
714 #define PXE_IFTYPE_TOKENRING 0x04
715 #define PXE_IFTYPE_FIBRE_CHANNEL 0x12
717 typedef struct s_pxe_hw_undi
{
718 PXE_UINT32 Signature
; ///< PXE_ROMID_SIGNATURE.
719 PXE_UINT8 Len
; ///< sizeof(PXE_HW_UNDI).
720 PXE_UINT8 Fudge
; ///< makes 8-bit cksum equal zero.
721 PXE_UINT8 Rev
; ///< PXE_ROMID_REV.
722 PXE_UINT8 IFcnt
; ///< physical connector count.
723 PXE_UINT8 MajorVer
; ///< PXE_ROMID_MAJORVER.
724 PXE_UINT8 MinorVer
; ///< PXE_ROMID_MINORVER.
725 PXE_UINT16 reserved
; ///< zero, not used.
726 PXE_UINT32 Implementation
; ///< implementation flags.
727 ///< reserved ///< vendor use.
728 ///< UINT32 Status; ///< status port.
729 ///< UINT32 Command; ///< command port.
730 ///< UINT64 CDBaddr; ///< CDB address port.
735 /// Status port bit definitions.
739 /// UNDI operation state.
741 #define PXE_HWSTAT_STATE_MASK 0xC0000000
742 #define PXE_HWSTAT_BUSY 0xC0000000
743 #define PXE_HWSTAT_INITIALIZED 0x80000000
744 #define PXE_HWSTAT_STARTED 0x40000000
745 #define PXE_HWSTAT_STOPPED 0x00000000
748 /// If set, last command failed.
750 #define PXE_HWSTAT_COMMAND_FAILED 0x20000000
753 /// If set, identifies enabled receive filters.
755 #define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000
756 #define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800
757 #define PXE_HWSTAT_BROADCAST_RX_ENABLED 0x00000400
758 #define PXE_HWSTAT_MULTICAST_RX_ENABLED 0x00000200
759 #define PXE_HWSTAT_UNICAST_RX_ENABLED 0x00000100
762 /// If set, identifies enabled external interrupts.
764 #define PXE_HWSTAT_SOFTWARE_INT_ENABLED 0x00000080
765 #define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040
766 #define PXE_HWSTAT_PACKET_RX_INT_ENABLED 0x00000020
767 #define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010
770 /// If set, identifies pending interrupts.
772 #define PXE_HWSTAT_SOFTWARE_INT_PENDING 0x00000008
773 #define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004
774 #define PXE_HWSTAT_PACKET_RX_INT_PENDING 0x00000002
775 #define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001
778 /// Command port definitions.
782 /// If set, CDB identified in CDBaddr port is given to UNDI.
783 /// If not set, other bits in this word will be processed.
785 #define PXE_HWCMD_ISSUE_COMMAND 0x80000000
786 #define PXE_HWCMD_INTS_AND_FILTS 0x00000000
789 /// Use these to enable/disable receive filters.
791 #define PXE_HWCMD_PROMISCUOUS_MULTICAST_RX_ENABLE 0x00001000
792 #define PXE_HWCMD_PROMISCUOUS_RX_ENABLE 0x00000800
793 #define PXE_HWCMD_BROADCAST_RX_ENABLE 0x00000400
794 #define PXE_HWCMD_MULTICAST_RX_ENABLE 0x00000200
795 #define PXE_HWCMD_UNICAST_RX_ENABLE 0x00000100
798 /// Use these to enable/disable external interrupts.
800 #define PXE_HWCMD_SOFTWARE_INT_ENABLE 0x00000080
801 #define PXE_HWCMD_TX_COMPLETE_INT_ENABLE 0x00000040
802 #define PXE_HWCMD_PACKET_RX_INT_ENABLE 0x00000020
803 #define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010
806 /// Use these to clear pending external interrupts.
808 #define PXE_HWCMD_CLEAR_SOFTWARE_INT 0x00000008
809 #define PXE_HWCMD_CLEAR_TX_COMPLETE_INT 0x00000004
810 #define PXE_HWCMD_CLEAR_PACKET_RX_INT 0x00000002
811 #define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT 0x00000001
813 typedef struct s_pxe_sw_undi
{
814 PXE_UINT32 Signature
; ///< PXE_ROMID_SIGNATURE.
815 PXE_UINT8 Len
; ///< sizeof(PXE_SW_UNDI).
816 PXE_UINT8 Fudge
; ///< makes 8-bit cksum zero.
817 PXE_UINT8 Rev
; ///< PXE_ROMID_REV.
818 PXE_UINT8 IFcnt
; ///< physical connector count.
819 PXE_UINT8 MajorVer
; ///< PXE_ROMID_MAJORVER.
820 PXE_UINT8 MinorVer
; ///< PXE_ROMID_MINORVER.
821 PXE_UINT16 reserved1
; ///< zero, not used.
822 PXE_UINT32 Implementation
; ///< Implementation flags.
823 PXE_UINT64 EntryPoint
; ///< API entry point.
824 PXE_UINT8 reserved2
[3]; ///< zero, not used.
825 PXE_UINT8 BusCnt
; ///< number of bustypes supported.
826 PXE_UINT32 BusType
[1]; ///< list of supported bustypes.
829 typedef union u_pxe_undi
{
835 /// Signature of !PXE structure.
837 #define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')
840 /// !PXE structure format revision
842 #define PXE_ROMID_REV 0x02
845 /// UNDI command interface revision. These are the values that get sent
846 /// in option 94 (Client Network Interface Identifier) in the DHCP Discover
847 /// and PXE Boot Server Request packets.
849 #define PXE_ROMID_MAJORVER 0x03
850 #define PXE_ROMID_MINORVER 0x01
853 /// Implementation flags.
855 #define PXE_ROMID_IMP_HW_UNDI 0x80000000
856 #define PXE_ROMID_IMP_SW_VIRT_ADDR 0x40000000
857 #define PXE_ROMID_IMP_64BIT_DEVICE 0x00010000
858 #define PXE_ROMID_IMP_FRAG_SUPPORTED 0x00008000
859 #define PXE_ROMID_IMP_CMD_LINK_SUPPORTED 0x00004000
860 #define PXE_ROMID_IMP_CMD_QUEUE_SUPPORTED 0x00002000
861 #define PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED 0x00001000
862 #define PXE_ROMID_IMP_NVDATA_SUPPORT_MASK 0x00000C00
863 #define PXE_ROMID_IMP_NVDATA_BULK_WRITABLE 0x00000C00
864 #define PXE_ROMID_IMP_NVDATA_SPARSE_WRITABLE 0x00000800
865 #define PXE_ROMID_IMP_NVDATA_READ_ONLY 0x00000400
866 #define PXE_ROMID_IMP_NVDATA_NOT_AVAILABLE 0x00000000
867 #define PXE_ROMID_IMP_STATISTICS_SUPPORTED 0x00000200
868 #define PXE_ROMID_IMP_STATION_ADDR_SETTABLE 0x00000100
869 #define PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED 0x00000080
870 #define PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED 0x00000040
871 #define PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED 0x00000020
872 #define PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED 0x00000010
873 #define PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED 0x00000008
874 #define PXE_ROMID_IMP_TX_COMPLETE_INT_SUPPORTED 0x00000004
875 #define PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED 0x00000002
876 #define PXE_ROMID_IMP_CMD_COMPLETE_INT_SUPPORTED 0x00000001
878 typedef struct s_pxe_cdb
{
885 PXE_STATCODE StatCode
;
886 PXE_STATFLAGS StatFlags
;
891 typedef union u_pxe_ip_addr
{
896 typedef union pxe_device
{
898 /// PCI and PC Card NICs are both identified using bus, device
899 /// and function numbers. For PC Card, this may require PC
900 /// Card services to be loaded in the BIOS or preboot
905 /// See S/W UNDI ROMID structure definition for PCI and
906 /// PCC BusType definitions.
911 /// Bus, device & function numbers that locate this device.
922 /// cpb and db definitions
924 #define MAX_PCI_CONFIG_LEN 64 ///< # of dwords.
925 #define MAX_EEPROM_LEN 128 ///< # of dwords.
926 #define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done.
927 #define MAX_MCAST_ADDRESS_CNT 8
929 typedef struct s_pxe_cpb_start_30
{
931 /// PXE_VOID Delay(UINTN microseconds);
933 /// UNDI will never request a delay smaller than 10 microseconds
934 /// and will always request delays in increments of 10 microseconds.
935 /// The Delay() CallBack routine must delay between n and n + 10
936 /// microseconds before returning control to the UNDI.
938 /// This field cannot be set to zero.
943 /// PXE_VOID Block(UINT32 enable);
945 /// UNDI may need to block multi-threaded/multi-processor access to
946 /// critical code sections when programming or accessing the network
947 /// device. To this end, a blocking service is needed by the UNDI.
948 /// When UNDI needs a block, it will call Block() passing a non-zero
949 /// value. When UNDI no longer needs a block, it will call Block()
950 /// with a zero value. When called, if the Block() is already enabled,
951 /// do not return control to the UNDI until the previous Block() is
954 /// This field cannot be set to zero.
959 /// PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);
961 /// UNDI will pass the virtual address of a buffer and the virtual
962 /// address of a 64-bit physical buffer. Convert the virtual address
963 /// to a physical address and write the result to the physical address
964 /// buffer. If virtual and physical addresses are the same, just
965 /// copy the virtual address to the physical address buffer.
967 /// This field can be set to zero if virtual and physical addresses
972 /// PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port,
973 /// UINT64 buf_addr);
975 /// UNDI will read or write the device io space using this call back
976 /// function. It passes the number of bytes as the len parameter and it
977 /// will be either 1,2,4 or 8.
979 /// This field can not be set to zero.
984 typedef struct s_pxe_cpb_start_31
{
986 /// PXE_VOID Delay(UINT64 UnqId, UINTN microseconds);
988 /// UNDI will never request a delay smaller than 10 microseconds
989 /// and will always request delays in increments of 10 microseconds.
990 /// The Delay() CallBack routine must delay between n and n + 10
991 /// microseconds before returning control to the UNDI.
993 /// This field cannot be set to zero.
998 /// PXE_VOID Block(UINT64 unq_id, UINT32 enable);
1000 /// UNDI may need to block multi-threaded/multi-processor access to
1001 /// critical code sections when programming or accessing the network
1002 /// device. To this end, a blocking service is needed by the UNDI.
1003 /// When UNDI needs a block, it will call Block() passing a non-zero
1004 /// value. When UNDI no longer needs a block, it will call Block()
1005 /// with a zero value. When called, if the Block() is already enabled,
1006 /// do not return control to the UNDI until the previous Block() is
1009 /// This field cannot be set to zero.
1014 /// PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);
1016 /// UNDI will pass the virtual address of a buffer and the virtual
1017 /// address of a 64-bit physical buffer. Convert the virtual address
1018 /// to a physical address and write the result to the physical address
1019 /// buffer. If virtual and physical addresses are the same, just
1020 /// copy the virtual address to the physical address buffer.
1022 /// This field can be set to zero if virtual and physical addresses
1027 /// PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port,
1028 /// UINT64 buf_addr);
1030 /// UNDI will read or write the device io space using this call back
1031 /// function. It passes the number of bytes as the len parameter and it
1032 /// will be either 1,2,4 or 8.
1034 /// This field can not be set to zero.
1038 /// PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
1039 /// UINT32 Direction, UINT64 mapped_addr);
1041 /// UNDI will pass the virtual address of a buffer, direction of the data
1042 /// flow from/to the mapped buffer (the constants are defined below)
1043 /// and a place holder (pointer) for the mapped address.
1044 /// This call will Map the given address to a physical DMA address and write
1045 /// the result to the mapped_addr pointer. If there is no need to
1046 /// map the given address to a lower address (i.e. the given address is
1047 /// associated with a physical address that is already compatible to be
1048 /// used with the DMA, it converts the given virtual address to it's
1049 /// physical address and write that in the mapped address pointer.
1051 /// This field can be set to zero if there is no mapping service available.
1056 /// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
1057 /// UINT32 Direction, UINT64 mapped_addr);
1059 /// UNDI will pass the virtual and mapped addresses of a buffer.
1060 /// This call will un map the given address.
1062 /// This field can be set to zero if there is no unmapping service available.
1067 /// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,
1068 /// UINT32 size, UINT32 Direction, UINT64 mapped_addr);
1070 /// UNDI will pass the virtual and mapped addresses of a buffer.
1071 /// This call will synchronize the contents of both the virtual and mapped.
1072 /// buffers for the given Direction.
1074 /// This field can be set to zero if there is no service available.
1079 /// protocol driver can provide anything for this Unique_ID, UNDI remembers
1080 /// that as just a 64bit value assocaited to the interface specified by
1081 /// the ifnum and gives it back as a parameter to all the call-back routines
1082 /// when calling for that interface!
1087 #define TO_AND_FROM_DEVICE 0
1088 #define FROM_DEVICE 1
1091 #define PXE_DELAY_MILLISECOND 1000
1092 #define PXE_DELAY_SECOND 1000000
1093 #define PXE_IO_READ 0
1094 #define PXE_IO_WRITE 1
1095 #define PXE_MEM_READ 2
1096 #define PXE_MEM_WRITE 4
1098 typedef struct s_pxe_db_get_init_info
{
1100 /// Minimum length of locked memory buffer that must be given to
1101 /// the Initialize command. Giving UNDI more memory will generally
1102 /// give better performance.
1104 /// If MemoryRequired is zero, the UNDI does not need and will not
1105 /// use system memory to receive and transmit packets.
1107 PXE_UINT32 MemoryRequired
;
1110 /// Maximum frame data length for Tx/Rx excluding the media header.
1112 PXE_UINT32 FrameDataLen
;
1115 /// Supported link speeds are in units of mega bits. Common ethernet
1116 /// values are 10, 100 and 1000. Unused LinkSpeeds[] entries are zero
1119 PXE_UINT32 LinkSpeeds
[4];
1122 /// Number of non-volatile storage items.
1127 /// Width of non-volatile storage item in bytes. 0, 1, 2 or 4
1132 /// Media header length. This is the typical media header length for
1133 /// this UNDI. This information is needed when allocating receive
1134 /// and transmit buffers.
1136 PXE_UINT16 MediaHeaderLen
;
1139 /// Number of bytes in the NIC hardware (MAC) address.
1141 PXE_UINT16 HWaddrLen
;
1144 /// Maximum number of multicast MAC addresses in the multicast
1145 /// MAC address filter list.
1147 PXE_UINT16 MCastFilterCnt
;
1150 /// Default number and size of transmit and receive buffers that will
1151 /// be allocated by the UNDI. If MemoryRequired is non-zero, this
1152 /// allocation will come out of the memory buffer given to the Initialize
1153 /// command. If MemoryRequired is zero, this allocation will come out of
1154 /// memory on the NIC.
1156 PXE_UINT16 TxBufCnt
;
1157 PXE_UINT16 TxBufSize
;
1158 PXE_UINT16 RxBufCnt
;
1159 PXE_UINT16 RxBufSize
;
1162 /// Hardware interface types defined in the Assigned Numbers RFC
1163 /// and used in DHCP and ARP packets.
1164 /// See the PXE_IFTYPE typedef and PXE_IFTYPE_xxx macros.
1169 /// Supported duplex. See PXE_DUPLEX_xxxxx #defines below.
1171 PXE_UINT8 SupportedDuplexModes
;
1174 /// Supported loopback options. See PXE_LOOPBACK_xxxxx #defines below.
1176 PXE_UINT8 SupportedLoopBackModes
;
1177 } PXE_DB_GET_INIT_INFO
;
1179 #define PXE_MAX_TXRX_UNIT_ETHER 1500
1181 #define PXE_HWADDR_LEN_ETHER 0x0006
1182 #define PXE_MAC_HEADER_LEN_ETHER 0x000E
1184 #define PXE_DUPLEX_ENABLE_FULL_SUPPORTED 1
1185 #define PXE_DUPLEX_FORCE_FULL_SUPPORTED 2
1187 #define PXE_LOOPBACK_INTERNAL_SUPPORTED 1
1188 #define PXE_LOOPBACK_EXTERNAL_SUPPORTED 2
1190 typedef struct s_pxe_pci_config_info
{
1192 /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
1193 /// For PCI bus devices, this field is set to PXE_BUSTYPE_PCI.
1198 /// This identifies the PCI network device that this UNDI interface.
1206 /// This is a copy of the PCI configuration space for this
1214 } PXE_PCI_CONFIG_INFO
;
1216 typedef struct s_pxe_pcc_config_info
{
1218 /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
1219 /// For PCC bus devices, this field is set to PXE_BUSTYPE_PCC.
1224 /// This identifies the PCC network device that this UNDI interface
1232 /// This is a copy of the PCC configuration space for this
1236 PXE_UINT8 Byte
[256];
1237 PXE_UINT16 Word
[128];
1238 PXE_UINT32 Dword
[64];
1240 } PXE_PCC_CONFIG_INFO
;
1242 typedef union u_pxe_db_get_config_info
{
1243 PXE_PCI_CONFIG_INFO pci
;
1244 PXE_PCC_CONFIG_INFO pcc
;
1245 } PXE_DB_GET_CONFIG_INFO
;
1247 typedef struct s_pxe_cpb_initialize
{
1249 /// Address of first (lowest) byte of the memory buffer. This buffer must
1250 /// be in contiguous physical memory and cannot be swapped out. The UNDI
1251 /// will be using this for transmit and receive buffering.
1253 PXE_UINT64 MemoryAddr
;
1256 /// MemoryLength must be greater than or equal to MemoryRequired
1257 /// returned by the Get Init Info command.
1259 PXE_UINT32 MemoryLength
;
1262 /// Desired link speed in Mbit/sec. Common ethernet values are 10, 100
1263 /// and 1000. Setting a value of zero will auto-detect and/or use the
1264 /// default link speed (operation depends on UNDI/NIC functionality).
1266 PXE_UINT32 LinkSpeed
;
1269 /// Suggested number and size of receive and transmit buffers to
1270 /// allocate. If MemoryAddr and MemoryLength are non-zero, this
1271 /// allocation comes out of the supplied memory buffer. If MemoryAddr
1272 /// and MemoryLength are zero, this allocation comes out of memory
1275 /// If these fields are set to zero, the UNDI will allocate buffer
1276 /// counts and sizes as it sees fit.
1278 PXE_UINT16 TxBufCnt
;
1279 PXE_UINT16 TxBufSize
;
1280 PXE_UINT16 RxBufCnt
;
1281 PXE_UINT16 RxBufSize
;
1284 /// The following configuration parameters are optional and must be zero
1285 /// to use the default values.
1287 PXE_UINT8 DuplexMode
;
1289 PXE_UINT8 LoopBackMode
;
1290 } PXE_CPB_INITIALIZE
;
1292 #define PXE_DUPLEX_DEFAULT 0x00
1293 #define PXE_FORCE_FULL_DUPLEX 0x01
1294 #define PXE_ENABLE_FULL_DUPLEX 0x02
1295 #define PXE_FORCE_HALF_DUPLEX 0x04
1296 #define PXE_DISABLE_FULL_DUPLEX 0x08
1298 #define LOOPBACK_NORMAL 0
1299 #define LOOPBACK_INTERNAL 1
1300 #define LOOPBACK_EXTERNAL 2
1302 typedef struct s_pxe_db_initialize
{
1304 /// Actual amount of memory used from the supplied memory buffer. This
1305 /// may be less that the amount of memory suppllied and may be zero if
1306 /// the UNDI and network device do not use external memory buffers.
1308 /// Memory used by the UNDI and network device is allocated from the
1309 /// lowest memory buffer address.
1311 PXE_UINT32 MemoryUsed
;
1314 /// Actual number and size of receive and transmit buffers that were
1317 PXE_UINT16 TxBufCnt
;
1318 PXE_UINT16 TxBufSize
;
1319 PXE_UINT16 RxBufCnt
;
1320 PXE_UINT16 RxBufSize
;
1321 } PXE_DB_INITIALIZE
;
1323 typedef struct s_pxe_cpb_receive_filters
{
1325 /// List of multicast MAC addresses. This list, if present, will
1326 /// replace the existing multicast MAC address filter list.
1328 PXE_MAC_ADDR MCastList
[MAX_MCAST_ADDRESS_CNT
];
1329 } PXE_CPB_RECEIVE_FILTERS
;
1331 typedef struct s_pxe_db_receive_filters
{
1333 /// Filtered multicast MAC address list.
1335 PXE_MAC_ADDR MCastList
[MAX_MCAST_ADDRESS_CNT
];
1336 } PXE_DB_RECEIVE_FILTERS
;
1338 typedef struct s_pxe_cpb_station_address
{
1340 /// If supplied and supported, the current station MAC address
1341 /// will be changed.
1343 PXE_MAC_ADDR StationAddr
;
1344 } PXE_CPB_STATION_ADDRESS
;
1346 typedef struct s_pxe_dpb_station_address
{
1348 /// Current station MAC address.
1350 PXE_MAC_ADDR StationAddr
;
1353 /// Station broadcast MAC address.
1355 PXE_MAC_ADDR BroadcastAddr
;
1358 /// Permanent station MAC address.
1360 PXE_MAC_ADDR PermanentAddr
;
1361 } PXE_DB_STATION_ADDRESS
;
1363 typedef struct s_pxe_db_statistics
{
1365 /// Bit field identifying what statistic data is collected by the
1367 /// If bit 0x00 is set, Data[0x00] is collected.
1368 /// If bit 0x01 is set, Data[0x01] is collected.
1369 /// If bit 0x20 is set, Data[0x20] is collected.
1370 /// If bit 0x21 is set, Data[0x21] is collected.
1373 PXE_UINT64 Supported
;
1378 PXE_UINT64 Data
[64];
1379 } PXE_DB_STATISTICS
;
1382 /// Total number of frames received. Includes frames with errors and
1385 #define PXE_STATISTICS_RX_TOTAL_FRAMES 0x00
1388 /// Number of valid frames received and copied into receive buffers.
1390 #define PXE_STATISTICS_RX_GOOD_FRAMES 0x01
1393 /// Number of frames below the minimum length for the media.
1394 /// This would be <64 for ethernet.
1396 #define PXE_STATISTICS_RX_UNDERSIZE_FRAMES 0x02
1399 /// Number of frames longer than the maxminum length for the
1400 /// media. This would be >1500 for ethernet.
1402 #define PXE_STATISTICS_RX_OVERSIZE_FRAMES 0x03
1405 /// Valid frames that were dropped because receive buffers were full.
1407 #define PXE_STATISTICS_RX_DROPPED_FRAMES 0x04
1410 /// Number of valid unicast frames received and not dropped.
1412 #define PXE_STATISTICS_RX_UNICAST_FRAMES 0x05
1415 /// Number of valid broadcast frames received and not dropped.
1417 #define PXE_STATISTICS_RX_BROADCAST_FRAMES 0x06
1420 /// Number of valid mutlicast frames received and not dropped.
1422 #define PXE_STATISTICS_RX_MULTICAST_FRAMES 0x07
1425 /// Number of frames w/ CRC or alignment errors.
1427 #define PXE_STATISTICS_RX_CRC_ERROR_FRAMES 0x08
1430 /// Total number of bytes received. Includes frames with errors
1431 /// and dropped frames.
1433 #define PXE_STATISTICS_RX_TOTAL_BYTES 0x09
1436 /// Transmit statistics.
1438 #define PXE_STATISTICS_TX_TOTAL_FRAMES 0x0A
1439 #define PXE_STATISTICS_TX_GOOD_FRAMES 0x0B
1440 #define PXE_STATISTICS_TX_UNDERSIZE_FRAMES 0x0C
1441 #define PXE_STATISTICS_TX_OVERSIZE_FRAMES 0x0D
1442 #define PXE_STATISTICS_TX_DROPPED_FRAMES 0x0E
1443 #define PXE_STATISTICS_TX_UNICAST_FRAMES 0x0F
1444 #define PXE_STATISTICS_TX_BROADCAST_FRAMES 0x10
1445 #define PXE_STATISTICS_TX_MULTICAST_FRAMES 0x11
1446 #define PXE_STATISTICS_TX_CRC_ERROR_FRAMES 0x12
1447 #define PXE_STATISTICS_TX_TOTAL_BYTES 0x13
1450 /// Number of collisions detection on this subnet.
1452 #define PXE_STATISTICS_COLLISIONS 0x14
1455 /// Number of frames destined for unsupported protocol.
1457 #define PXE_STATISTICS_UNSUPPORTED_PROTOCOL 0x15
1459 typedef struct s_pxe_cpb_mcast_ip_to_mac
{
1461 /// Multicast IP address to be converted to multicast MAC address.
1464 } PXE_CPB_MCAST_IP_TO_MAC
;
1466 typedef struct s_pxe_db_mcast_ip_to_mac
{
1468 /// Multicast MAC address.
1471 } PXE_DB_MCAST_IP_TO_MAC
;
1473 typedef struct s_pxe_cpb_nvdata_sparse
{
1475 /// NvData item list. Only items in this list will be updated.
1479 /// Non-volatile storage address to be changed.
1484 /// Data item to write into above storage address.
1491 } Item
[MAX_EEPROM_LEN
];
1492 } PXE_CPB_NVDATA_SPARSE
;
1495 /// When using bulk update, the size of the CPB structure must be
1496 /// the same size as the non-volatile NIC storage.
1498 typedef union u_pxe_cpb_nvdata_bulk
{
1500 /// Array of byte-wide data items.
1502 PXE_UINT8 Byte
[MAX_EEPROM_LEN
<< 2];
1505 /// Array of word-wide data items.
1507 PXE_UINT16 Word
[MAX_EEPROM_LEN
<< 1];
1510 /// Array of dword-wide data items.
1512 PXE_UINT32 Dword
[MAX_EEPROM_LEN
];
1513 } PXE_CPB_NVDATA_BULK
;
1515 typedef struct s_pxe_db_nvdata
{
1517 /// Arrays of data items from non-volatile storage.
1521 /// Array of byte-wide data items.
1523 PXE_UINT8 Byte
[MAX_EEPROM_LEN
<< 2];
1526 /// Array of word-wide data items.
1528 PXE_UINT16 Word
[MAX_EEPROM_LEN
<< 1];
1531 /// Array of dword-wide data items.
1533 PXE_UINT32 Dword
[MAX_EEPROM_LEN
];
1537 typedef struct s_pxe_db_get_status
{
1539 /// Length of next receive frame (header + data). If this is zero,
1540 /// there is no next receive frame available.
1542 PXE_UINT32 RxFrameLen
;
1545 /// Reserved, set to zero.
1547 PXE_UINT32 reserved
;
1550 /// Addresses of transmitted buffers that need to be recycled.
1552 PXE_UINT64 TxBuffer
[MAX_XMIT_BUFFERS
];
1553 } PXE_DB_GET_STATUS
;
1555 typedef struct s_pxe_cpb_fill_header
{
1557 /// Source and destination MAC addresses. These will be copied into
1558 /// the media header without doing byte swapping.
1560 PXE_MAC_ADDR SrcAddr
;
1561 PXE_MAC_ADDR DestAddr
;
1564 /// Address of first byte of media header. The first byte of packet data
1565 /// follows the last byte of the media header.
1567 PXE_UINT64 MediaHeader
;
1570 /// Length of packet data in bytes (not including the media header).
1572 PXE_UINT32 PacketLen
;
1575 /// Protocol type. This will be copied into the media header without
1576 /// doing byte swapping. Protocol type numbers can be obtained from
1577 /// the Assigned Numbers RFC 1700.
1579 PXE_UINT16 Protocol
;
1582 /// Length of the media header in bytes.
1584 PXE_UINT16 MediaHeaderLen
;
1585 } PXE_CPB_FILL_HEADER
;
1587 #define PXE_PROTOCOL_ETHERNET_IP 0x0800
1588 #define PXE_PROTOCOL_ETHERNET_ARP 0x0806
1589 #define MAX_XMIT_FRAGMENTS 16
1591 typedef struct s_pxe_cpb_fill_header_fragmented
{
1593 /// Source and destination MAC addresses. These will be copied into
1594 /// the media header without doing byte swapping.
1596 PXE_MAC_ADDR SrcAddr
;
1597 PXE_MAC_ADDR DestAddr
;
1600 /// Length of packet data in bytes (not including the media header).
1602 PXE_UINT32 PacketLen
;
1605 /// Protocol type. This will be copied into the media header without
1606 /// doing byte swapping. Protocol type numbers can be obtained from
1607 /// the Assigned Numbers RFC 1700.
1609 PXE_MEDIA_PROTOCOL Protocol
;
1612 /// Length of the media header in bytes.
1614 PXE_UINT16 MediaHeaderLen
;
1617 /// Number of packet fragment descriptors.
1622 /// Reserved, must be set to zero.
1624 PXE_UINT16 reserved
;
1627 /// Array of packet fragment descriptors. The first byte of the media
1628 /// header is the first byte of the first fragment.
1632 /// Address of this packet fragment.
1634 PXE_UINT64 FragAddr
;
1637 /// Length of this packet fragment.
1642 /// Reserved, must be set to zero.
1644 PXE_UINT32 reserved
;
1645 } FragDesc
[MAX_XMIT_FRAGMENTS
];
1647 PXE_CPB_FILL_HEADER_FRAGMENTED
;
1649 typedef struct s_pxe_cpb_transmit
{
1651 /// Address of first byte of frame buffer. This is also the first byte
1652 /// of the media header.
1654 PXE_UINT64 FrameAddr
;
1657 /// Length of the data portion of the frame buffer in bytes. Do not
1658 /// include the length of the media header.
1663 /// Length of the media header in bytes.
1665 PXE_UINT16 MediaheaderLen
;
1668 /// Reserved, must be zero.
1670 PXE_UINT16 reserved
;
1673 typedef struct s_pxe_cpb_transmit_fragments
{
1675 /// Length of packet data in bytes (not including the media header).
1677 PXE_UINT32 FrameLen
;
1680 /// Length of the media header in bytes.
1682 PXE_UINT16 MediaheaderLen
;
1685 /// Number of packet fragment descriptors.
1690 /// Array of frame fragment descriptors. The first byte of the first
1691 /// fragment is also the first byte of the media header.
1695 /// Address of this frame fragment.
1697 PXE_UINT64 FragAddr
;
1700 /// Length of this frame fragment.
1705 /// Reserved, must be set to zero.
1707 PXE_UINT32 reserved
;
1708 } FragDesc
[MAX_XMIT_FRAGMENTS
];
1710 PXE_CPB_TRANSMIT_FRAGMENTS
;
1712 typedef struct s_pxe_cpb_receive
{
1714 /// Address of first byte of receive buffer. This is also the first byte
1715 /// of the frame header.
1717 PXE_UINT64 BufferAddr
;
1720 /// Length of receive buffer. This must be large enough to hold the
1721 /// received frame (media header + data). If the length of smaller than
1722 /// the received frame, data will be lost.
1724 PXE_UINT32 BufferLen
;
1727 /// Reserved, must be set to zero.
1729 PXE_UINT32 reserved
;
1732 typedef struct s_pxe_db_receive
{
1734 /// Source and destination MAC addresses from media header.
1736 PXE_MAC_ADDR SrcAddr
;
1737 PXE_MAC_ADDR DestAddr
;
1740 /// Length of received frame. May be larger than receive buffer size.
1741 /// The receive buffer will not be overwritten. This is how to tell
1742 /// if data was lost because the receive buffer was too small.
1744 PXE_UINT32 FrameLen
;
1747 /// Protocol type from media header.
1749 PXE_MEDIA_PROTOCOL Protocol
;
1752 /// Length of media header in received frame.
1754 PXE_UINT16 MediaHeaderLen
;
1757 /// Type of receive frame.
1759 PXE_FRAME_TYPE Type
;
1762 /// Reserved, must be zero.
1764 PXE_UINT8 reserved
[7];