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 - 2008, Intel Corporation
7 All rights reserved. This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. 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
374 #define PXE_OPFLAGS_FILL_HEADER_OPMASK 0x0001
375 #define PXE_OPFLAGS_FILL_HEADER_FRAGMENTED 0x0001
376 #define PXE_OPFLAGS_FILL_HEADER_WHOLE 0x0000
382 /// S/W UNDI only. Return after the packet has been transmitted. A
383 /// transmit complete interrupt will still be generated and the transmit
384 /// buffer will have to be recycled.
386 #define PXE_OPFLAGS_SWUNDI_TRANSMIT_OPMASK 0x0001
387 #define PXE_OPFLAGS_TRANSMIT_BLOCK 0x0001
388 #define PXE_OPFLAGS_TRANSMIT_DONT_BLOCK 0x0000
390 #define PXE_OPFLAGS_TRANSMIT_OPMASK 0x0002
391 #define PXE_OPFLAGS_TRANSMIT_FRAGMENTED 0x0002
392 #define PXE_OPFLAGS_TRANSMIT_WHOLE 0x0000
403 typedef PXE_UINT16 PXE_STATFLAGS
;
405 #define PXE_STATFLAGS_INITIALIZE 0x0000
408 /// Common StatFlags that can be returned by all commands.
411 /// The COMMAND_COMPLETE and COMMAND_FAILED status flags must be
412 /// implemented by all UNDIs. COMMAND_QUEUED is only needed by UNDIs
413 /// that support command queuing.
415 #define PXE_STATFLAGS_STATUS_MASK 0xC000
416 #define PXE_STATFLAGS_COMMAND_COMPLETE 0xC000
417 #define PXE_STATFLAGS_COMMAND_FAILED 0x8000
418 #define PXE_STATFLAGS_COMMAND_QUEUED 0x4000
423 #define PXE_STATFLAGS_GET_STATE_MASK 0x0003
424 #define PXE_STATFLAGS_GET_STATE_INITIALIZED 0x0002
425 #define PXE_STATFLAGS_GET_STATE_STARTED 0x0001
426 #define PXE_STATFLAGS_GET_STATE_STOPPED 0x0000
431 /// No additional StatFlags
435 /// UNDI Get Init Info
437 #define PXE_STATFLAGS_CABLE_DETECT_MASK 0x0001
438 #define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000
439 #define PXE_STATFLAGS_CABLE_DETECT_SUPPORTED 0x0001
444 #define PXE_STATFLAGS_INITIALIZED_NO_MEDIA 0x0001
449 #define PXE_STATFLAGS_RESET_NO_MEDIA 0x0001
454 /// No additional StatFlags
457 /// UNDI Interrupt Enables
460 /// If set, receive interrupts are enabled.
462 #define PXE_STATFLAGS_INTERRUPT_RECEIVE 0x0001
465 /// If set, transmit interrupts are enabled.
467 #define PXE_STATFLAGS_INTERRUPT_TRANSMIT 0x0002
470 /// If set, command interrupts are enabled.
472 #define PXE_STATFLAGS_INTERRUPT_COMMAND 0x0004
475 /// UNDI Receive Filters
479 /// If set, unicast packets will be received.
481 #define PXE_STATFLAGS_RECEIVE_FILTER_UNICAST 0x0001
484 /// If set, broadcast packets will be received.
486 #define PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
489 /// If set, multicast packets that match up with the multicast address
490 /// filter list will be received.
492 #define PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
495 /// If set, all packets will be received.
497 #define PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
500 /// If set, all multicast packets will be received.
502 #define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
505 /// UNDI Station Address
507 /// No additional StatFlags
513 /// No additional StatFlags
517 //// UNDI MCast IP to MAC
519 //// No additional StatFlags
524 /// No additional StatFlags
532 /// Use to determine if an interrupt has occurred.
534 #define PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK 0x000F
535 #define PXE_STATFLAGS_GET_STATUS_NO_INTERRUPTS 0x0000
538 /// If set, at least one receive interrupt occurred.
540 #define PXE_STATFLAGS_GET_STATUS_RECEIVE 0x0001
543 /// If set, at least one transmit interrupt occurred.
545 #define PXE_STATFLAGS_GET_STATUS_TRANSMIT 0x0002
548 /// If set, at least one command interrupt occurred.
550 #define PXE_STATFLAGS_GET_STATUS_COMMAND 0x0004
553 /// If set, at least one software interrupt occurred.
555 #define PXE_STATFLAGS_GET_STATUS_SOFTWARE 0x0008
558 /// This flag is set if the transmitted buffer queue is empty. This flag
559 /// will be set if all transmitted buffer addresses get written into the DB.
561 #define PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY 0x0010
564 /// This flag is set if no transmitted buffer addresses were written
565 /// into the DB. (This could be because DBsize was too small.)
567 #define PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN 0x0020
572 /// No additional StatFlags
578 /// No additional StatFlags.
585 /// No additional StatFlags.
587 typedef PXE_UINT16 PXE_STATCODE
;
589 #define PXE_STATCODE_INITIALIZE 0x0000
592 /// Common StatCodes returned by all UNDI commands, UNDI protocol functions
593 /// and BC protocol functions.
595 #define PXE_STATCODE_SUCCESS 0x0000
597 #define PXE_STATCODE_INVALID_CDB 0x0001
598 #define PXE_STATCODE_INVALID_CPB 0x0002
599 #define PXE_STATCODE_BUSY 0x0003
600 #define PXE_STATCODE_QUEUE_FULL 0x0004
601 #define PXE_STATCODE_ALREADY_STARTED 0x0005
602 #define PXE_STATCODE_NOT_STARTED 0x0006
603 #define PXE_STATCODE_NOT_SHUTDOWN 0x0007
604 #define PXE_STATCODE_ALREADY_INITIALIZED 0x0008
605 #define PXE_STATCODE_NOT_INITIALIZED 0x0009
606 #define PXE_STATCODE_DEVICE_FAILURE 0x000A
607 #define PXE_STATCODE_NVDATA_FAILURE 0x000B
608 #define PXE_STATCODE_UNSUPPORTED 0x000C
609 #define PXE_STATCODE_BUFFER_FULL 0x000D
610 #define PXE_STATCODE_INVALID_PARAMETER 0x000E
611 #define PXE_STATCODE_INVALID_UNDI 0x000F
612 #define PXE_STATCODE_IPV4_NOT_SUPPORTED 0x0010
613 #define PXE_STATCODE_IPV6_NOT_SUPPORTED 0x0011
614 #define PXE_STATCODE_NOT_ENOUGH_MEMORY 0x0012
615 #define PXE_STATCODE_NO_DATA 0x0013
617 typedef PXE_UINT16 PXE_IFNUM
;
620 /// This interface number must be passed to the S/W UNDI Start command.
622 #define PXE_IFNUM_START 0x0000
625 /// This interface number is returned by the S/W UNDI Get State and
626 /// Start commands if information in the CDB, CPB or DB is invalid.
628 #define PXE_IFNUM_INVALID 0x0000
630 typedef PXE_UINT16 PXE_CONTROL
;
633 /// Setting this flag directs the UNDI to queue this command for later
634 /// execution if the UNDI is busy and it supports command queuing.
635 /// If queuing is not supported, a PXE_STATCODE_INVALID_CONTROL error
636 /// is returned. If the queue is full, a PXE_STATCODE_CDB_QUEUE_FULL
637 /// error is returned.
639 #define PXE_CONTROL_QUEUE_IF_BUSY 0x0002
642 /// These two bit values are used to determine if there are more UNDI
643 /// CDB structures following this one. If the link bit is set, there
644 /// must be a CDB structure following this one. Execution will start
645 /// on the next CDB structure as soon as this one completes successfully.
646 /// If an error is generated by this command, execution will stop.
648 #define PXE_CONTROL_LINK 0x0001
649 #define PXE_CONTROL_LAST_CDB_IN_LIST 0x0000
651 typedef PXE_UINT8 PXE_FRAME_TYPE
;
653 #define PXE_FRAME_TYPE_NONE 0x00
654 #define PXE_FRAME_TYPE_UNICAST 0x01
655 #define PXE_FRAME_TYPE_BROADCAST 0x02
656 #define PXE_FRAME_TYPE_FILTERED_MULTICAST 0x03
657 #define PXE_FRAME_TYPE_PROMISCUOUS 0x04
658 #define PXE_FRAME_TYPE_PROMISCUOUS_MULTICAST 0x05
660 #define PXE_FRAME_TYPE_MULTICAST PXE_FRAME_TYPE_FILTERED_MULTICAST
662 typedef PXE_UINT32 PXE_IPV4
;
664 typedef PXE_UINT32 PXE_IPV6
[4];
665 #define PXE_MAC_LENGTH 32
667 typedef PXE_UINT8 PXE_MAC_ADDR
[PXE_MAC_LENGTH
];
669 typedef PXE_UINT8 PXE_IFTYPE
;
670 typedef UINT16 PXE_MEDIA_PROTOCOL
;
673 /// This information is from the ARP section of RFC 1700.
675 /// 1 Ethernet (10Mb) [JBP]
676 /// 2 Experimental Ethernet (3Mb) [JBP]
677 /// 3 Amateur Radio AX.25 [PXK]
678 /// 4 Proteon ProNET Token Ring [JBP]
680 /// 6 IEEE 802 Networks [JBP]
682 /// 8 Hyperchannel [JBP]
684 /// 10 Autonet Short Address [MXB1]
685 /// 11 LocalTalk [JKR1]
686 /// 12 LocalNet (IBM* PCNet or SYTEK* LocalNET) [JXM]
687 /// 13 Ultra link [RXD2]
689 /// 15 Frame Relay [AGM]
690 /// 16 Asynchronous Transmission Mode (ATM) [JXB2]
692 /// 18 Fibre Channel [Yakov Rekhter]
693 /// 19 Asynchronous Transmission Mode (ATM) [Mark Laubach]
694 /// 20 Serial Line [JBP]
695 /// 21 Asynchronous Transmission Mode (ATM) [MXB1]
697 /// * Other names and brands may be claimed as the property of others.
699 #define PXE_IFTYPE_ETHERNET 0x01
700 #define PXE_IFTYPE_TOKENRING 0x04
701 #define PXE_IFTYPE_FIBRE_CHANNEL 0x12
703 typedef struct s_pxe_hw_undi
{
704 PXE_UINT32 Signature
; ///< PXE_ROMID_SIGNATURE
705 PXE_UINT8 Len
; ///< sizeof(PXE_HW_UNDI)
706 PXE_UINT8 Fudge
; ///< makes 8-bit cksum equal zero
707 PXE_UINT8 Rev
; ///< PXE_ROMID_REV
708 PXE_UINT8 IFcnt
; ///< physical connector count
709 PXE_UINT8 MajorVer
; ///< PXE_ROMID_MAJORVER
710 PXE_UINT8 MinorVer
; ///< PXE_ROMID_MINORVER
711 PXE_UINT16 reserved
; ///< zero, not used
712 PXE_UINT32 Implementation
; ///< implementation flags
713 ///< reserved ///< vendor use
714 ///< UINT32 Status; ///< status port
715 ///< UINT32 Command; ///< command port
716 ///< UINT64 CDBaddr; ///< CDB address port
721 /// Status port bit definitions
725 /// UNDI operation state
727 #define PXE_HWSTAT_STATE_MASK 0xC0000000
728 #define PXE_HWSTAT_BUSY 0xC0000000
729 #define PXE_HWSTAT_INITIALIZED 0x80000000
730 #define PXE_HWSTAT_STARTED 0x40000000
731 #define PXE_HWSTAT_STOPPED 0x00000000
734 /// If set, last command failed
736 #define PXE_HWSTAT_COMMAND_FAILED 0x20000000
739 /// If set, identifies enabled receive filters
741 #define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000
742 #define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800
743 #define PXE_HWSTAT_BROADCAST_RX_ENABLED 0x00000400
744 #define PXE_HWSTAT_MULTICAST_RX_ENABLED 0x00000200
745 #define PXE_HWSTAT_UNICAST_RX_ENABLED 0x00000100
748 /// If set, identifies enabled external interrupts
750 #define PXE_HWSTAT_SOFTWARE_INT_ENABLED 0x00000080
751 #define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040
752 #define PXE_HWSTAT_PACKET_RX_INT_ENABLED 0x00000020
753 #define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010
756 /// If set, identifies pending interrupts
758 #define PXE_HWSTAT_SOFTWARE_INT_PENDING 0x00000008
759 #define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004
760 #define PXE_HWSTAT_PACKET_RX_INT_PENDING 0x00000002
761 #define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001
764 /// Command port definitions
768 /// If set, CDB identified in CDBaddr port is given to UNDI.
769 /// If not set, other bits in this word will be processed.
771 #define PXE_HWCMD_ISSUE_COMMAND 0x80000000
772 #define PXE_HWCMD_INTS_AND_FILTS 0x00000000
775 /// Use these to enable/disable receive filters.
777 #define PXE_HWCMD_PROMISCUOUS_MULTICAST_RX_ENABLE 0x00001000
778 #define PXE_HWCMD_PROMISCUOUS_RX_ENABLE 0x00000800
779 #define PXE_HWCMD_BROADCAST_RX_ENABLE 0x00000400
780 #define PXE_HWCMD_MULTICAST_RX_ENABLE 0x00000200
781 #define PXE_HWCMD_UNICAST_RX_ENABLE 0x00000100
784 /// Use these to enable/disable external interrupts
786 #define PXE_HWCMD_SOFTWARE_INT_ENABLE 0x00000080
787 #define PXE_HWCMD_TX_COMPLETE_INT_ENABLE 0x00000040
788 #define PXE_HWCMD_PACKET_RX_INT_ENABLE 0x00000020
789 #define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010
792 /// Use these to clear pending external interrupts
794 #define PXE_HWCMD_CLEAR_SOFTWARE_INT 0x00000008
795 #define PXE_HWCMD_CLEAR_TX_COMPLETE_INT 0x00000004
796 #define PXE_HWCMD_CLEAR_PACKET_RX_INT 0x00000002
797 #define PXE_HWCMD_CLEAR_CMD_COMPLETE_INT 0x00000001
799 typedef struct s_pxe_sw_undi
{
800 PXE_UINT32 Signature
; ///< PXE_ROMID_SIGNATURE
801 PXE_UINT8 Len
; ///< sizeof(PXE_SW_UNDI)
802 PXE_UINT8 Fudge
; ///< makes 8-bit cksum zero
803 PXE_UINT8 Rev
; ///< PXE_ROMID_REV
804 PXE_UINT8 IFcnt
; ///< physical connector count
805 PXE_UINT8 MajorVer
; ///< PXE_ROMID_MAJORVER
806 PXE_UINT8 MinorVer
; ///< PXE_ROMID_MINORVER
807 PXE_UINT16 reserved1
; ///< zero, not used
808 PXE_UINT32 Implementation
; ///< Implementation flags
809 PXE_UINT64 EntryPoint
; ///< API entry point
810 PXE_UINT8 reserved2
[3]; ///< zero, not used
811 PXE_UINT8 BusCnt
; ///< number of bustypes supported
812 PXE_UINT32 BusType
[1]; ///< list of supported bustypes
815 typedef union u_pxe_undi
{
821 /// Signature of !PXE structure
823 #define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')
826 /// !PXE structure format revision
828 #define PXE_ROMID_REV 0x02
831 /// UNDI command interface revision. These are the values that get sent
832 /// in option 94 (Client Network Interface Identifier) in the DHCP Discover
833 /// and PXE Boot Server Request packets.
835 #define PXE_ROMID_MAJORVER 0x03
836 #define PXE_ROMID_MINORVER 0x01
839 /// Implementation flags
841 #define PXE_ROMID_IMP_HW_UNDI 0x80000000
842 #define PXE_ROMID_IMP_SW_VIRT_ADDR 0x40000000
843 #define PXE_ROMID_IMP_64BIT_DEVICE 0x00010000
844 #define PXE_ROMID_IMP_FRAG_SUPPORTED 0x00008000
845 #define PXE_ROMID_IMP_CMD_LINK_SUPPORTED 0x00004000
846 #define PXE_ROMID_IMP_CMD_QUEUE_SUPPORTED 0x00002000
847 #define PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED 0x00001000
848 #define PXE_ROMID_IMP_NVDATA_SUPPORT_MASK 0x00000C00
849 #define PXE_ROMID_IMP_NVDATA_BULK_WRITABLE 0x00000C00
850 #define PXE_ROMID_IMP_NVDATA_SPARSE_WRITABLE 0x00000800
851 #define PXE_ROMID_IMP_NVDATA_READ_ONLY 0x00000400
852 #define PXE_ROMID_IMP_NVDATA_NOT_AVAILABLE 0x00000000
853 #define PXE_ROMID_IMP_STATISTICS_SUPPORTED 0x00000200
854 #define PXE_ROMID_IMP_STATION_ADDR_SETTABLE 0x00000100
855 #define PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED 0x00000080
856 #define PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED 0x00000040
857 #define PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED 0x00000020
858 #define PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED 0x00000010
859 #define PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED 0x00000008
860 #define PXE_ROMID_IMP_TX_COMPLETE_INT_SUPPORTED 0x00000004
861 #define PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED 0x00000002
862 #define PXE_ROMID_IMP_CMD_COMPLETE_INT_SUPPORTED 0x00000001
864 typedef struct s_pxe_cdb
{
871 PXE_STATCODE StatCode
;
872 PXE_STATFLAGS StatFlags
;
877 typedef union u_pxe_ip_addr
{
882 typedef union pxe_device
{
884 /// PCI and PC Card NICs are both identified using bus, device
885 /// and function numbers. For PC Card, this may require PC
886 /// Card services to be loaded in the BIOS or preboot
891 /// See S/W UNDI ROMID structure definition for PCI and
892 /// PCC BusType definitions.
897 /// Bus, device & function numbers that locate this device.
908 /// cpb and db definitions
910 #define MAX_PCI_CONFIG_LEN 64 ///< # of dwords
911 #define MAX_EEPROM_LEN 128 ///< # of dwords
912 #define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done
913 #define MAX_MCAST_ADDRESS_CNT 8
915 typedef struct s_pxe_cpb_start_30
{
917 /// PXE_VOID Delay(UINTN microseconds);
919 /// UNDI will never request a delay smaller than 10 microseconds
920 /// and will always request delays in increments of 10 microseconds.
921 /// The Delay() CallBack routine must delay between n and n + 10
922 /// microseconds before returning control to the UNDI.
924 /// This field cannot be set to zero.
929 /// PXE_VOID Block(UINT32 enable);
931 /// UNDI may need to block multi-threaded/multi-processor access to
932 /// critical code sections when programming or accessing the network
933 /// device. To this end, a blocking service is needed by the UNDI.
934 /// When UNDI needs a block, it will call Block() passing a non-zero
935 /// value. When UNDI no longer needs a block, it will call Block()
936 /// with a zero value. When called, if the Block() is already enabled,
937 /// do not return control to the UNDI until the previous Block() is
940 /// This field cannot be set to zero.
945 /// PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);
947 /// UNDI will pass the virtual address of a buffer and the virtual
948 /// address of a 64-bit physical buffer. Convert the virtual address
949 /// to a physical address and write the result to the physical address
950 /// buffer. If virtual and physical addresses are the same, just
951 /// copy the virtual address to the physical address buffer.
953 /// This field can be set to zero if virtual and physical addresses
958 /// PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port,
959 /// UINT64 buf_addr);
961 /// UNDI will read or write the device io space using this call back
962 /// function. It passes the number of bytes as the len parameter and it
963 /// will be either 1,2,4 or 8.
965 /// This field can not be set to zero.
970 typedef struct s_pxe_cpb_start_31
{
972 /// PXE_VOID Delay(UINT64 UnqId, UINTN microseconds);
974 /// UNDI will never request a delay smaller than 10 microseconds
975 /// and will always request delays in increments of 10 microseconds.
976 /// The Delay() CallBack routine must delay between n and n + 10
977 /// microseconds before returning control to the UNDI.
979 /// This field cannot be set to zero.
984 /// PXE_VOID Block(UINT64 unq_id, UINT32 enable);
986 /// UNDI may need to block multi-threaded/multi-processor access to
987 /// critical code sections when programming or accessing the network
988 /// device. To this end, a blocking service is needed by the UNDI.
989 /// When UNDI needs a block, it will call Block() passing a non-zero
990 /// value. When UNDI no longer needs a block, it will call Block()
991 /// with a zero value. When called, if the Block() is already enabled,
992 /// do not return control to the UNDI until the previous Block() is
995 /// This field cannot be set to zero.
1000 /// PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);
1002 /// UNDI will pass the virtual address of a buffer and the virtual
1003 /// address of a 64-bit physical buffer. Convert the virtual address
1004 /// to a physical address and write the result to the physical address
1005 /// buffer. If virtual and physical addresses are the same, just
1006 /// copy the virtual address to the physical address buffer.
1008 /// This field can be set to zero if virtual and physical addresses
1013 /// PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port,
1014 /// UINT64 buf_addr);
1016 /// UNDI will read or write the device io space using this call back
1017 /// function. It passes the number of bytes as the len parameter and it
1018 /// will be either 1,2,4 or 8.
1020 /// This field can not be set to zero.
1024 /// PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
1025 /// UINT32 Direction, UINT64 mapped_addr);
1027 /// UNDI will pass the virtual address of a buffer, direction of the data
1028 /// flow from/to the mapped buffer (the constants are defined below)
1029 /// and a place holder (pointer) for the mapped address.
1030 /// This call will Map the given address to a physical DMA address and write
1031 /// the result to the mapped_addr pointer. If there is no need to
1032 /// map the given address to a lower address (i.e. the given address is
1033 /// associated with a physical address that is already compatible to be
1034 /// used with the DMA, it converts the given virtual address to it's
1035 /// physical address and write that in the mapped address pointer.
1037 /// This field can be set to zero if there is no mapping service available
1042 /// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
1043 /// UINT32 Direction, UINT64 mapped_addr);
1045 /// UNDI will pass the virtual and mapped addresses of a buffer
1046 /// This call will un map the given address
1048 /// This field can be set to zero if there is no unmapping service available
1053 /// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,
1054 /// UINT32 size, UINT32 Direction, UINT64 mapped_addr);
1056 /// UNDI will pass the virtual and mapped addresses of a buffer
1057 /// This call will synchronize the contents of both the virtual and mapped
1058 /// buffers for the given Direction.
1060 /// This field can be set to zero if there is no service available
1065 /// protocol driver can provide anything for this Unique_ID, UNDI remembers
1066 /// that as just a 64bit value assocaited to the interface specified by
1067 /// the ifnum and gives it back as a parameter to all the call-back routines
1068 /// when calling for that interface!
1073 #define TO_AND_FROM_DEVICE 0
1074 #define FROM_DEVICE 1
1077 #define PXE_DELAY_MILLISECOND 1000
1078 #define PXE_DELAY_SECOND 1000000
1079 #define PXE_IO_READ 0
1080 #define PXE_IO_WRITE 1
1081 #define PXE_MEM_READ 2
1082 #define PXE_MEM_WRITE 4
1084 typedef struct s_pxe_db_get_init_info
{
1086 /// Minimum length of locked memory buffer that must be given to
1087 /// the Initialize command. Giving UNDI more memory will generally
1088 /// give better performance.
1090 /// If MemoryRequired is zero, the UNDI does not need and will not
1091 /// use system memory to receive and transmit packets.
1093 PXE_UINT32 MemoryRequired
;
1096 /// Maximum frame data length for Tx/Rx excluding the media header.
1098 PXE_UINT32 FrameDataLen
;
1101 /// Supported link speeds are in units of mega bits. Common ethernet
1102 /// values are 10, 100 and 1000. Unused LinkSpeeds[] entries are zero
1105 PXE_UINT32 LinkSpeeds
[4];
1108 /// Number of non-volatile storage items.
1113 /// Width of non-volatile storage item in bytes. 0, 1, 2 or 4
1118 /// Media header length. This is the typical media header length for
1119 /// this UNDI. This information is needed when allocating receive
1120 /// and transmit buffers.
1122 PXE_UINT16 MediaHeaderLen
;
1125 /// Number of bytes in the NIC hardware (MAC) address.
1127 PXE_UINT16 HWaddrLen
;
1130 /// Maximum number of multicast MAC addresses in the multicast
1131 /// MAC address filter list.
1133 PXE_UINT16 MCastFilterCnt
;
1136 /// Default number and size of transmit and receive buffers that will
1137 /// be allocated by the UNDI. If MemoryRequired is non-zero, this
1138 /// allocation will come out of the memory buffer given to the Initialize
1139 /// command. If MemoryRequired is zero, this allocation will come out of
1140 /// memory on the NIC.
1142 PXE_UINT16 TxBufCnt
;
1143 PXE_UINT16 TxBufSize
;
1144 PXE_UINT16 RxBufCnt
;
1145 PXE_UINT16 RxBufSize
;
1148 /// Hardware interface types defined in the Assigned Numbers RFC
1149 /// and used in DHCP and ARP packets.
1150 /// See the PXE_IFTYPE typedef and PXE_IFTYPE_xxx macros.
1155 /// Supported duplex. See PXE_DUPLEX_xxxxx #defines below.
1157 PXE_UINT8 SupportedDuplexModes
;
1160 /// Supported loopback options. See PXE_LOOPBACK_xxxxx #defines below.
1162 PXE_UINT8 SupportedLoopBackModes
;
1163 } PXE_DB_GET_INIT_INFO
;
1165 #define PXE_MAX_TXRX_UNIT_ETHER 1500
1167 #define PXE_HWADDR_LEN_ETHER 0x0006
1168 #define PXE_MAC_HEADER_LEN_ETHER 0x000E
1170 #define PXE_DUPLEX_ENABLE_FULL_SUPPORTED 1
1171 #define PXE_DUPLEX_FORCE_FULL_SUPPORTED 2
1173 #define PXE_LOOPBACK_INTERNAL_SUPPORTED 1
1174 #define PXE_LOOPBACK_EXTERNAL_SUPPORTED 2
1176 typedef struct s_pxe_pci_config_info
{
1178 /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
1179 /// For PCI bus devices, this field is set to PXE_BUSTYPE_PCI.
1184 /// This identifies the PCI network device that this UNDI interface
1192 /// This is a copy of the PCI configuration space for this
1200 } PXE_PCI_CONFIG_INFO
;
1202 typedef struct s_pxe_pcc_config_info
{
1204 /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
1205 /// For PCC bus devices, this field is set to PXE_BUSTYPE_PCC.
1210 /// This identifies the PCC network device that this UNDI interface
1218 /// This is a copy of the PCC configuration space for this
1222 PXE_UINT8 Byte
[256];
1223 PXE_UINT16 Word
[128];
1224 PXE_UINT32 Dword
[64];
1226 } PXE_PCC_CONFIG_INFO
;
1228 typedef union u_pxe_db_get_config_info
{
1229 PXE_PCI_CONFIG_INFO pci
;
1230 PXE_PCC_CONFIG_INFO pcc
;
1231 } PXE_DB_GET_CONFIG_INFO
;
1233 typedef struct s_pxe_cpb_initialize
{
1235 /// Address of first (lowest) byte of the memory buffer. This buffer must
1236 /// be in contiguous physical memory and cannot be swapped out. The UNDI
1237 /// will be using this for transmit and receive buffering.
1239 PXE_UINT64 MemoryAddr
;
1242 /// MemoryLength must be greater than or equal to MemoryRequired
1243 /// returned by the Get Init Info command.
1245 PXE_UINT32 MemoryLength
;
1248 /// Desired link speed in Mbit/sec. Common ethernet values are 10, 100
1249 /// and 1000. Setting a value of zero will auto-detect and/or use the
1250 /// default link speed (operation depends on UNDI/NIC functionality).
1252 PXE_UINT32 LinkSpeed
;
1255 /// Suggested number and size of receive and transmit buffers to
1256 /// allocate. If MemoryAddr and MemoryLength are non-zero, this
1257 /// allocation comes out of the supplied memory buffer. If MemoryAddr
1258 /// and MemoryLength are zero, this allocation comes out of memory
1261 /// If these fields are set to zero, the UNDI will allocate buffer
1262 /// counts and sizes as it sees fit.
1264 PXE_UINT16 TxBufCnt
;
1265 PXE_UINT16 TxBufSize
;
1266 PXE_UINT16 RxBufCnt
;
1267 PXE_UINT16 RxBufSize
;
1270 /// The following configuration parameters are optional and must be zero
1271 /// to use the default values.
1273 PXE_UINT8 DuplexMode
;
1275 PXE_UINT8 LoopBackMode
;
1276 } PXE_CPB_INITIALIZE
;
1278 #define PXE_DUPLEX_DEFAULT 0x00
1279 #define PXE_FORCE_FULL_DUPLEX 0x01
1280 #define PXE_ENABLE_FULL_DUPLEX 0x02
1281 #define PXE_FORCE_HALF_DUPLEX 0x04
1282 #define PXE_DISABLE_FULL_DUPLEX 0x08
1284 #define LOOPBACK_NORMAL 0
1285 #define LOOPBACK_INTERNAL 1
1286 #define LOOPBACK_EXTERNAL 2
1288 typedef struct s_pxe_db_initialize
{
1290 /// Actual amount of memory used from the supplied memory buffer. This
1291 /// may be less that the amount of memory suppllied and may be zero if
1292 /// the UNDI and network device do not use external memory buffers.
1294 /// Memory used by the UNDI and network device is allocated from the
1295 /// lowest memory buffer address.
1297 PXE_UINT32 MemoryUsed
;
1300 /// Actual number and size of receive and transmit buffers that were
1303 PXE_UINT16 TxBufCnt
;
1304 PXE_UINT16 TxBufSize
;
1305 PXE_UINT16 RxBufCnt
;
1306 PXE_UINT16 RxBufSize
;
1307 } PXE_DB_INITIALIZE
;
1309 typedef struct s_pxe_cpb_receive_filters
{
1311 /// List of multicast MAC addresses. This list, if present, will
1312 /// replace the existing multicast MAC address filter list.
1314 PXE_MAC_ADDR MCastList
[MAX_MCAST_ADDRESS_CNT
];
1315 } PXE_CPB_RECEIVE_FILTERS
;
1317 typedef struct s_pxe_db_receive_filters
{
1319 /// Filtered multicast MAC address list.
1321 PXE_MAC_ADDR MCastList
[MAX_MCAST_ADDRESS_CNT
];
1322 } PXE_DB_RECEIVE_FILTERS
;
1324 typedef struct s_pxe_cpb_station_address
{
1326 /// If supplied and supported, the current station MAC address
1327 /// will be changed.
1329 PXE_MAC_ADDR StationAddr
;
1330 } PXE_CPB_STATION_ADDRESS
;
1332 typedef struct s_pxe_dpb_station_address
{
1334 /// Current station MAC address.
1336 PXE_MAC_ADDR StationAddr
;
1339 /// Station broadcast MAC address.
1341 PXE_MAC_ADDR BroadcastAddr
;
1344 /// Permanent station MAC address.
1346 PXE_MAC_ADDR PermanentAddr
;
1347 } PXE_DB_STATION_ADDRESS
;
1349 typedef struct s_pxe_db_statistics
{
1351 /// Bit field identifying what statistic data is collected by the
1353 /// If bit 0x00 is set, Data[0x00] is collected.
1354 /// If bit 0x01 is set, Data[0x01] is collected.
1355 /// If bit 0x20 is set, Data[0x20] is collected.
1356 /// If bit 0x21 is set, Data[0x21] is collected.
1359 PXE_UINT64 Supported
;
1364 PXE_UINT64 Data
[64];
1365 } PXE_DB_STATISTICS
;
1368 /// Total number of frames received. Includes frames with errors and
1371 #define PXE_STATISTICS_RX_TOTAL_FRAMES 0x00
1374 /// Number of valid frames received and copied into receive buffers.
1376 #define PXE_STATISTICS_RX_GOOD_FRAMES 0x01
1379 /// Number of frames below the minimum length for the media.
1380 /// This would be <64 for ethernet.
1382 #define PXE_STATISTICS_RX_UNDERSIZE_FRAMES 0x02
1385 /// Number of frames longer than the maxminum length for the
1386 /// media. This would be >1500 for ethernet.
1388 #define PXE_STATISTICS_RX_OVERSIZE_FRAMES 0x03
1391 /// Valid frames that were dropped because receive buffers were full.
1393 #define PXE_STATISTICS_RX_DROPPED_FRAMES 0x04
1396 /// Number of valid unicast frames received and not dropped.
1398 #define PXE_STATISTICS_RX_UNICAST_FRAMES 0x05
1401 /// Number of valid broadcast frames received and not dropped.
1403 #define PXE_STATISTICS_RX_BROADCAST_FRAMES 0x06
1406 /// Number of valid mutlicast frames received and not dropped.
1408 #define PXE_STATISTICS_RX_MULTICAST_FRAMES 0x07
1411 /// Number of frames w/ CRC or alignment errors.
1413 #define PXE_STATISTICS_RX_CRC_ERROR_FRAMES 0x08
1416 /// Total number of bytes received. Includes frames with errors
1417 /// and dropped frames.
1419 #define PXE_STATISTICS_RX_TOTAL_BYTES 0x09
1422 /// Transmit statistics.
1424 #define PXE_STATISTICS_TX_TOTAL_FRAMES 0x0A
1425 #define PXE_STATISTICS_TX_GOOD_FRAMES 0x0B
1426 #define PXE_STATISTICS_TX_UNDERSIZE_FRAMES 0x0C
1427 #define PXE_STATISTICS_TX_OVERSIZE_FRAMES 0x0D
1428 #define PXE_STATISTICS_TX_DROPPED_FRAMES 0x0E
1429 #define PXE_STATISTICS_TX_UNICAST_FRAMES 0x0F
1430 #define PXE_STATISTICS_TX_BROADCAST_FRAMES 0x10
1431 #define PXE_STATISTICS_TX_MULTICAST_FRAMES 0x11
1432 #define PXE_STATISTICS_TX_CRC_ERROR_FRAMES 0x12
1433 #define PXE_STATISTICS_TX_TOTAL_BYTES 0x13
1436 /// Number of collisions detection on this subnet.
1438 #define PXE_STATISTICS_COLLISIONS 0x14
1441 /// Number of frames destined for unsupported protocol.
1443 #define PXE_STATISTICS_UNSUPPORTED_PROTOCOL 0x15
1445 typedef struct s_pxe_cpb_mcast_ip_to_mac
{
1447 /// Multicast IP address to be converted to multicast MAC address.
1450 } PXE_CPB_MCAST_IP_TO_MAC
;
1452 typedef struct s_pxe_db_mcast_ip_to_mac
{
1454 /// Multicast MAC address.
1457 } PXE_DB_MCAST_IP_TO_MAC
;
1459 typedef struct s_pxe_cpb_nvdata_sparse
{
1461 /// NvData item list. Only items in this list will be updated.
1465 /// Non-volatile storage address to be changed.
1470 /// Data item to write into above storage address.
1477 } Item
[MAX_EEPROM_LEN
];
1478 } PXE_CPB_NVDATA_SPARSE
;
1481 /// When using bulk update, the size of the CPB structure must be
1482 /// the same size as the non-volatile NIC storage.
1484 typedef union u_pxe_cpb_nvdata_bulk
{
1486 /// Array of byte-wide data items.
1488 PXE_UINT8 Byte
[MAX_EEPROM_LEN
<< 2];
1491 /// Array of word-wide data items.
1493 PXE_UINT16 Word
[MAX_EEPROM_LEN
<< 1];
1496 /// Array of dword-wide data items.
1498 PXE_UINT32 Dword
[MAX_EEPROM_LEN
];
1499 } PXE_CPB_NVDATA_BULK
;
1501 typedef struct s_pxe_db_nvdata
{
1503 /// Arrays of data items from non-volatile storage.
1507 /// Array of byte-wide data items.
1509 PXE_UINT8 Byte
[MAX_EEPROM_LEN
<< 2];
1512 /// Array of word-wide data items.
1514 PXE_UINT16 Word
[MAX_EEPROM_LEN
<< 1];
1517 /// Array of dword-wide data items.
1519 PXE_UINT32 Dword
[MAX_EEPROM_LEN
];
1523 typedef struct s_pxe_db_get_status
{
1525 /// Length of next receive frame (header + data). If this is zero,
1526 /// there is no next receive frame available.
1528 PXE_UINT32 RxFrameLen
;
1531 /// Reserved, set to zero.
1533 PXE_UINT32 reserved
;
1536 /// Addresses of transmitted buffers that need to be recycled.
1538 PXE_UINT64 TxBuffer
[MAX_XMIT_BUFFERS
];
1539 } PXE_DB_GET_STATUS
;
1541 typedef struct s_pxe_cpb_fill_header
{
1543 /// Source and destination MAC addresses. These will be copied into
1544 /// the media header without doing byte swapping.
1546 PXE_MAC_ADDR SrcAddr
;
1547 PXE_MAC_ADDR DestAddr
;
1550 /// Address of first byte of media header. The first byte of packet data
1551 /// follows the last byte of the media header.
1553 PXE_UINT64 MediaHeader
;
1556 /// Length of packet data in bytes (not including the media header).
1558 PXE_UINT32 PacketLen
;
1561 /// Protocol type. This will be copied into the media header without
1562 /// doing byte swapping. Protocol type numbers can be obtained from
1563 /// the Assigned Numbers RFC 1700.
1565 PXE_UINT16 Protocol
;
1568 /// Length of the media header in bytes.
1570 PXE_UINT16 MediaHeaderLen
;
1571 } PXE_CPB_FILL_HEADER
;
1573 #define PXE_PROTOCOL_ETHERNET_IP 0x0800
1574 #define PXE_PROTOCOL_ETHERNET_ARP 0x0806
1575 #define MAX_XMIT_FRAGMENTS 16
1577 typedef struct s_pxe_cpb_fill_header_fragmented
{
1579 /// Source and destination MAC addresses. These will be copied into
1580 /// the media header without doing byte swapping.
1582 PXE_MAC_ADDR SrcAddr
;
1583 PXE_MAC_ADDR DestAddr
;
1586 /// Length of packet data in bytes (not including the media header).
1588 PXE_UINT32 PacketLen
;
1591 /// Protocol type. This will be copied into the media header without
1592 /// doing byte swapping. Protocol type numbers can be obtained from
1593 /// the Assigned Numbers RFC 1700.
1595 PXE_MEDIA_PROTOCOL Protocol
;
1598 /// Length of the media header in bytes.
1600 PXE_UINT16 MediaHeaderLen
;
1603 /// Number of packet fragment descriptors.
1608 /// Reserved, must be set to zero.
1610 PXE_UINT16 reserved
;
1613 /// Array of packet fragment descriptors. The first byte of the media
1614 /// header is the first byte of the first fragment.
1618 /// Address of this packet fragment.
1620 PXE_UINT64 FragAddr
;
1623 /// Length of this packet fragment.
1628 /// Reserved, must be set to zero.
1630 PXE_UINT32 reserved
;
1631 } FragDesc
[MAX_XMIT_FRAGMENTS
];
1633 PXE_CPB_FILL_HEADER_FRAGMENTED
;
1635 typedef struct s_pxe_cpb_transmit
{
1637 /// Address of first byte of frame buffer. This is also the first byte
1638 /// of the media header.
1640 PXE_UINT64 FrameAddr
;
1643 /// Length of the data portion of the frame buffer in bytes. Do not
1644 /// include the length of the media header.
1649 /// Length of the media header in bytes.
1651 PXE_UINT16 MediaheaderLen
;
1654 /// Reserved, must be zero.
1656 PXE_UINT16 reserved
;
1659 typedef struct s_pxe_cpb_transmit_fragments
{
1661 /// Length of packet data in bytes (not including the media header).
1663 PXE_UINT32 FrameLen
;
1666 /// Length of the media header in bytes.
1668 PXE_UINT16 MediaheaderLen
;
1671 /// Number of packet fragment descriptors.
1676 /// Array of frame fragment descriptors. The first byte of the first
1677 /// fragment is also the first byte of the media header.
1681 /// Address of this frame fragment.
1683 PXE_UINT64 FragAddr
;
1686 /// Length of this frame fragment.
1691 /// Reserved, must be set to zero.
1693 PXE_UINT32 reserved
;
1694 } FragDesc
[MAX_XMIT_FRAGMENTS
];
1696 PXE_CPB_TRANSMIT_FRAGMENTS
;
1698 typedef struct s_pxe_cpb_receive
{
1700 /// Address of first byte of receive buffer. This is also the first byte
1701 /// of the frame header.
1703 PXE_UINT64 BufferAddr
;
1706 /// Length of receive buffer. This must be large enough to hold the
1707 /// received frame (media header + data). If the length of smaller than
1708 /// the received frame, data will be lost.
1710 PXE_UINT32 BufferLen
;
1713 /// Reserved, must be set to zero.
1715 PXE_UINT32 reserved
;
1718 typedef struct s_pxe_db_receive
{
1720 /// Source and destination MAC addresses from media header.
1722 PXE_MAC_ADDR SrcAddr
;
1723 PXE_MAC_ADDR DestAddr
;
1726 /// Length of received frame. May be larger than receive buffer size.
1727 /// The receive buffer will not be overwritten. This is how to tell
1728 /// if data was lost because the receive buffer was too small.
1730 PXE_UINT32 FrameLen
;
1733 /// Protocol type from media header.
1735 PXE_MEDIA_PROTOCOL Protocol
;
1738 /// Length of media header in received frame.
1740 PXE_UINT16 MediaHeaderLen
;
1743 /// Type of receive frame.
1745 PXE_FRAME_TYPE Type
;
1748 /// Reserved, must be zero.
1750 PXE_UINT8 reserved
[7];