4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This header file contains all of the PXE type definitions,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync structure prototypes, global variables and constants that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are needed for porting PXE to EFI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 32/64-bit PXE specification:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync alpha-4, 99-Dec-17.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((PXE_UINT32) (d) & 0xFF) << 24) | (((PXE_UINT32) (c) & 0xFF) << 16) | (((PXE_UINT32) (b) & 0xFF) << 8) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI ROM ID and devive ID signature.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// BUS ROM ID signatures.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_BUSTYPE_USB PXE_BUSTYPE ('U', 'S', 'B', 'R')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_BUSTYPE_1394 PXE_BUSTYPE ('1', '3', '9', '4')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_SWAP_UINT16(n) ((((PXE_UINT16) (n) & 0x00FF) << 8) | (((PXE_UINT16) (n) & 0xFF00) >> 8))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((((PXE_UINT64)(n) & 0x00000000000000FFULL) << 56) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((PXE_UINT64)(n) & 0x000000000000FF00ULL) << 40) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((PXE_UINT64)(n) & 0x0000000000FF0000ULL) << 24) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((PXE_UINT64)(n) & 0x00000000FF000000ULL) << 8) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((PXE_UINT64)(n) & 0x000000FF00000000ULL) >> 8) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((PXE_UINT64)(n) & 0x0000FF0000000000ULL) >> 24) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (((PXE_UINT64)(n) & 0x00FF000000000000ULL) >> 40) | \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_CPBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_DBADDR_NOT_USED (PXE_UINT64) 0 ///< zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Typedef unsigned long PXE_UINT64.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Return UNDI operational state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Change UNDI operational state from Stopped to Started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Change UNDI operational state from Started to Stopped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Get UNDI initialization information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Get NIC configuration information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Changed UNDI operational state from Started to Initialized.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Re-initialize the NIC H/W.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Change the UNDI operational state from Initialized to Started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Read & change state of external interrupt enables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Read & change state of packet receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Read & change station MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Read traffic statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Convert multicast IP address to multicast MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Read or change non-volatile storage on the NIC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Get & clear interrupt status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Fill media header in packet for transmit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Transmit packet(s).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Receive packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Last valid PXE UNDI OpCode number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// //////////////////////////////////////
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UNDI Get State
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// No OpFlags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync////////////////////////////////////////
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UNDI Start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// No OpFlags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync////////////////////////////////////////
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UNDI Stop
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// No OpFlags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync////////////////////////////////////////
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UNDI Get Init Info
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// No Opflags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync////////////////////////////////////////
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// UNDI Get Config Info
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// No Opflags
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Initialize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_OPFLAGS_INITIALIZE_CABLE_DETECT_MASK 0x0001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_OPFLAGS_INITIALIZE_DO_NOT_DETECT_CABLE 0x0001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Shutdown.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No OpFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Interrupt Enables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Select whether to enable or disable external interrupt signals.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Setting both enable and disable will return PXE_STATCODE_INVALID_OPFLAGS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable receive interrupts. An external interrupt will be generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// after a complete non-error packet has been received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable transmit interrupts. An external interrupt will be generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// after a complete non-error packet has been transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable command interrupts. An external interrupt will be generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// when command execution stops.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Generate software interrupt. Setting this bit generates an external
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// interrupt, if it is supported by the hardware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Receive Filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Select whether to enable or disable receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Setting both enable and disable will return PXE_STATCODE_INVALID_OPCODE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// To reset the contents of the multicast MAC address filter list,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// set this OpFlag:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST 0x2000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable unicast packet receiving. Packets sent to the current station
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// MAC address will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable broadcast packet receiving. Packets sent to the broadcast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// MAC address will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable filtered multicast packet receiving. Packets sent to any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// of the multicast MAC addresses in the multicast MAC address filter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// list will be received. If the filter list is empty, no multicast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable promiscuous packet receiving. All packets will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Enable promiscuous multicast packet receiving. All multicast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// packets will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Station Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI MCast IP to MAC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Identify the type of IP address in the CPB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI NvData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Select the type of non-volatile data operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Get Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Return current interrupt status. This will also clear any interrupts
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// that are currently set. This can be used in a polling routine. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// interrupt flags are still set and cleared even when the interrupts
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// are disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Return list of transmitted buffers for recycling. Transmit buffers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// must not be changed or unallocated until they have recycled. After
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// issuing a transmit command, wait for a transmit complete interrupt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// When a transmit complete interrupt is received, read the transmitted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// buffers. Do not plan on getting one buffer per interrupt. Some
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// NICs and UNDIs may transmit multiple buffers per interrupt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Return current media status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Fill Header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Transmit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// S/W UNDI only. Return after the packet has been transmitted. A
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// transmit complete interrupt will still be generated and the transmit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// buffer will have to be recycled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Receive.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No OpFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// PXE STATFLAGS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Common StatFlags that can be returned by all commands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The COMMAND_COMPLETE and COMMAND_FAILED status flags must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// implemented by all UNDIs. COMMAND_QUEUED is only needed by UNDIs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// that support command queuing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Get State.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Start.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Get Init Info.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_CABLE_DETECT_NOT_SUPPORTED 0x0000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_MASK 0x0002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_NOT_SUPPORTED 0x0000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED 0x0002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Initialize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Shutdown.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Interrupt Enables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, receive interrupts are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, transmit interrupts are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, command interrupts are enabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Receive Filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, unicast packets will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, broadcast packets will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, multicast packets that match up with the multicast address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// filter list will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, all packets will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, all multicast packets will be received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Station Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//// UNDI MCast IP to MAC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI NvData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Get Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Use to determine if an interrupt has occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_GET_STATUS_INTERRUPT_MASK 0x000F
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_GET_STATUS_NO_INTERRUPTS 0x0000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, at least one receive interrupt occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, at least one transmit interrupt occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, at least one command interrupt occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, at least one software interrupt occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This flag is set if the transmitted buffer queue is empty. This flag
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// will be set if all transmitted buffer addresses get written into the DB.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_GET_STATUS_TXBUF_QUEUE_EMPTY 0x0010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This flag is set if no transmitted buffer addresses were written
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// into the DB. (This could be because DBsize was too small.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_STATFLAGS_GET_STATUS_NO_TXBUFS_WRITTEN 0x0020
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This flag is set if there is no media detected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Fill Header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Transmit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI Receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// No additional StatFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Common StatCodes returned by all UNDI commands, UNDI protocol functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and BC protocol functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This interface number must be passed to the S/W UNDI Start command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This interface number is returned by the S/W UNDI Get State and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Start commands if information in the CDB, CPB or DB is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Setting this flag directs the UNDI to queue this command for later
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// execution if the UNDI is busy and it supports command queuing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If queuing is not supported, a PXE_STATCODE_INVALID_CONTROL error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is returned. If the queue is full, a PXE_STATCODE_CDB_QUEUE_FULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// error is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// These two bit values are used to determine if there are more UNDI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// CDB structures following this one. If the link bit is set, there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// must be a CDB structure following this one. Execution will start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// on the next CDB structure as soon as this one completes successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If an error is generated by this command, execution will stop.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_FRAME_TYPE_MULTICAST PXE_FRAME_TYPE_FILTERED_MULTICAST
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This information is from the ARP section of RFC 1700.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 1 Ethernet (10Mb) [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 2 Experimental Ethernet (3Mb) [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 3 Amateur Radio AX.25 [PXK]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 4 Proteon ProNET Token Ring [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 5 Chaos [GXP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 6 IEEE 802 Networks [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 7 ARCNET [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 8 Hyperchannel [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 9 Lanstar [TU]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 10 Autonet Short Address [MXB1]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 11 LocalTalk [JKR1]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 12 LocalNet (IBM* PCNet or SYTEK* LocalNET) [JXM]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 13 Ultra link [RXD2]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 14 SMDS [GXC1]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 15 Frame Relay [AGM]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 16 Asynchronous Transmission Mode (ATM) [JXB2]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 17 HDLC [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 18 Fibre Channel [Yakov Rekhter]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 19 Asynchronous Transmission Mode (ATM) [Mark Laubach]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 20 Serial Line [JBP]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// 21 Asynchronous Transmission Mode (ATM) [MXB1]
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// * Other names and brands may be claimed as the property of others.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE_UINT8 Fudge; ///< makes 8-bit cksum equal zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE_UINT32 Implementation; ///< implementation flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< reserved ///< vendor use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< UINT32 Status; ///< status port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< UINT32 Command; ///< command port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///< UINT64 CDBaddr; ///< CDB address port.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Status port bit definitions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI operation state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, last command failed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, identifies enabled receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWSTAT_PROMISCUOUS_MULTICAST_RX_ENABLED 0x00001000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWSTAT_PROMISCUOUS_RX_ENABLED 0x00000800
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, identifies enabled external interrupts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWSTAT_TX_COMPLETE_INT_ENABLED 0x00000040
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWSTAT_CMD_COMPLETE_INT_ENABLED 0x00000010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, identifies pending interrupts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWSTAT_TX_COMPLETE_INT_PENDING 0x00000004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWSTAT_CMD_COMPLETE_INT_PENDING 0x00000001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Command port definitions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If set, CDB identified in CDBaddr port is given to UNDI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// If not set, other bits in this word will be processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Use these to enable/disable receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWCMD_PROMISCUOUS_MULTICAST_RX_ENABLE 0x00001000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Use these to enable/disable external interrupts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_HWCMD_CMD_COMPLETE_INT_ENABLE 0x00000010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Use these to clear pending external interrupts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE_UINT32 Implementation; ///< Implementation flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE_UINT8 BusCnt; ///< number of bustypes supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE_UINT32 BusType[1]; ///< list of supported bustypes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Signature of !PXE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_SIGNATURE PXE_BUSTYPE ('!', 'P', 'X', 'E')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// !PXE structure format revision
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// UNDI command interface revision. These are the values that get sent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// in option 94 (Client Network Interface Identifier) in the DHCP Discover
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and PXE Boot Server Request packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Implementation flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_CMD_QUEUE_SUPPORTED 0x00002000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_MULTI_FRAME_SUPPORTED 0x00001000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_NVDATA_SUPPORT_MASK 0x00000C00
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_NVDATA_BULK_WRITABLE 0x00000C00
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_NVDATA_SPARSE_WRITABLE 0x00000800
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_NVDATA_NOT_AVAILABLE 0x00000000
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_STATISTICS_SUPPORTED 0x00000200
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_STATION_ADDR_SETTABLE 0x00000100
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_PROMISCUOUS_MULTICAST_RX_SUPPORTED 0x00000080
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_PROMISCUOUS_RX_SUPPORTED 0x00000040
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_BROADCAST_RX_SUPPORTED 0x00000020
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_FILTERED_MULTICAST_RX_SUPPORTED 0x00000010
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_SOFTWARE_INT_SUPPORTED 0x00000008
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_TX_COMPLETE_INT_SUPPORTED 0x00000004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_PACKET_RX_INT_SUPPORTED 0x00000002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define PXE_ROMID_IMP_CMD_COMPLETE_INT_SUPPORTED 0x00000001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PCI and PC Card NICs are both identified using bus, device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and function numbers. For PC Card, this may require PC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Card services to be loaded in the BIOS or preboot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// See S/W UNDI ROMID structure definition for PCI and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PCC BusType definitions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bus, device & function numbers that locate this device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// cpb and db definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define MAX_XMIT_BUFFERS 32 ///< recycling Q length for xmit_done.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Delay(UINTN microseconds);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will never request a delay smaller than 10 microseconds
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and will always request delays in increments of 10 microseconds.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The Delay() CallBack routine must delay between n and n + 10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// microseconds before returning control to the UNDI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field cannot be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Block(UINT32 enable);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI may need to block multi-threaded/multi-processor access to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// critical code sections when programming or accessing the network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// device. To this end, a blocking service is needed by the UNDI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When UNDI needs a block, it will call Block() passing a non-zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value. When UNDI no longer needs a block, it will call Block()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// with a zero value. When called, if the Block() is already enabled,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// do not return control to the UNDI until the previous Block() is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field cannot be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Virt2Phys(UINT64 virtual, UINT64 physical_ptr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will pass the virtual address of a buffer and the virtual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// address of a 64-bit physical buffer. Convert the virtual address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to a physical address and write the result to the physical address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// buffer. If virtual and physical addresses are the same, just
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// copy the virtual address to the physical address buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field can be set to zero if virtual and physical addresses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// are equal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Mem_IO(UINT8 read_write, UINT8 len, UINT64 port,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UINT64 buf_addr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will read or write the device io space using this call back
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// function. It passes the number of bytes as the len parameter and it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// will be either 1,2,4 or 8.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field can not be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Delay(UINT64 UnqId, UINTN microseconds);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will never request a delay smaller than 10 microseconds
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and will always request delays in increments of 10 microseconds.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The Delay() CallBack routine must delay between n and n + 10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// microseconds before returning control to the UNDI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field cannot be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Block(UINT64 unq_id, UINT32 enable);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI may need to block multi-threaded/multi-processor access to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// critical code sections when programming or accessing the network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// device. To this end, a blocking service is needed by the UNDI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When UNDI needs a block, it will call Block() passing a non-zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value. When UNDI no longer needs a block, it will call Block()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// with a zero value. When called, if the Block() is already enabled,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// do not return control to the UNDI until the previous Block() is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// disabled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field cannot be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Virt2Phys(UINT64 UnqId, UINT64 virtual, UINT64 physical_ptr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will pass the virtual address of a buffer and the virtual
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// address of a 64-bit physical buffer. Convert the virtual address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to a physical address and write the result to the physical address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// buffer. If virtual and physical addresses are the same, just
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// copy the virtual address to the physical address buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field can be set to zero if virtual and physical addresses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// are equal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Mem_IO(UINT64 UnqId, UINT8 read_write, UINT8 len, UINT64 port,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UINT64 buf_addr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will read or write the device io space using this call back
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// function. It passes the number of bytes as the len parameter and it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// will be either 1,2,4 or 8.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field can not be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Map_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UINT32 Direction, UINT64 mapped_addr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will pass the virtual address of a buffer, direction of the data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// flow from/to the mapped buffer (the constants are defined below)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and a place holder (pointer) for the mapped address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This call will Map the given address to a physical DMA address and write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the result to the mapped_addr pointer. If there is no need to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// map the given address to a lower address (i.e. the given address is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// associated with a physical address that is already compatible to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// used with the DMA, it converts the given virtual address to it's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// physical address and write that in the mapped address pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field can be set to zero if there is no mapping service available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID UnMap_Mem(UINT64 unq_id, UINT64 virtual_addr, UINT32 size,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UINT32 Direction, UINT64 mapped_addr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will pass the virtual and mapped addresses of a buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This call will un map the given address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field can be set to zero if there is no unmapping service available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// PXE_VOID Sync_Mem(UINT64 unq_id, UINT64 virtual,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UINT32 size, UINT32 Direction, UINT64 mapped_addr);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UNDI will pass the virtual and mapped addresses of a buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This call will synchronize the contents of both the virtual and mapped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// buffers for the given Direction.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field can be set to zero if there is no service available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// protocol driver can provide anything for this Unique_ID, UNDI remembers
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that as just a 64bit value assocaited to the interface specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the ifnum and gives it back as a parameter to all the call-back routines
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// when calling for that interface!
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Minimum length of locked memory buffer that must be given to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the Initialize command. Giving UNDI more memory will generally
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// give better performance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If MemoryRequired is zero, the UNDI does not need and will not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// use system memory to receive and transmit packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Maximum frame data length for Tx/Rx excluding the media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Supported link speeds are in units of mega bits. Common ethernet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// values are 10, 100 and 1000. Unused LinkSpeeds[] entries are zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// filled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of non-volatile storage items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Width of non-volatile storage item in bytes. 0, 1, 2 or 4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Media header length. This is the typical media header length for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// this UNDI. This information is needed when allocating receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and transmit buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of bytes in the NIC hardware (MAC) address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Maximum number of multicast MAC addresses in the multicast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// MAC address filter list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Default number and size of transmit and receive buffers that will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// be allocated by the UNDI. If MemoryRequired is non-zero, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// allocation will come out of the memory buffer given to the Initialize
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// command. If MemoryRequired is zero, this allocation will come out of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// memory on the NIC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Hardware interface types defined in the Assigned Numbers RFC
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and used in DHCP and ARP packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// See the PXE_IFTYPE typedef and PXE_IFTYPE_xxx macros.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Supported duplex. See PXE_DUPLEX_xxxxx #defines below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Supported loopback options. See PXE_LOOPBACK_xxxxx #defines below.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// For PCI bus devices, this field is set to PXE_BUSTYPE_PCI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This identifies the PCI network device that this UNDI interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is bound to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This is a copy of the PCI configuration space for this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// network device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This is the flag field for the PXE_DB_GET_CONFIG_INFO union.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// For PCC bus devices, this field is set to PXE_BUSTYPE_PCC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This identifies the PCC network device that this UNDI interface
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is bound to.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This is a copy of the PCC configuration space for this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// network device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address of first (lowest) byte of the memory buffer. This buffer must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// be in contiguous physical memory and cannot be swapped out. The UNDI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// will be using this for transmit and receive buffering.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// MemoryLength must be greater than or equal to MemoryRequired
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// returned by the Get Init Info command.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Desired link speed in Mbit/sec. Common ethernet values are 10, 100
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and 1000. Setting a value of zero will auto-detect and/or use the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// default link speed (operation depends on UNDI/NIC functionality).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Suggested number and size of receive and transmit buffers to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// allocate. If MemoryAddr and MemoryLength are non-zero, this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// allocation comes out of the supplied memory buffer. If MemoryAddr
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and MemoryLength are zero, this allocation comes out of memory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// on the NIC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If these fields are set to zero, the UNDI will allocate buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// counts and sizes as it sees fit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The following configuration parameters are optional and must be zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to use the default values.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Actual amount of memory used from the supplied memory buffer. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// may be less that the amount of memory suppllied and may be zero if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the UNDI and network device do not use external memory buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Memory used by the UNDI and network device is allocated from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// lowest memory buffer address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Actual number and size of receive and transmit buffers that were
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// List of multicast MAC addresses. This list, if present, will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// replace the existing multicast MAC address filter list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Filtered multicast MAC address list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If supplied and supported, the current station MAC address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// will be changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Current station MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Station broadcast MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Permanent station MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit field identifying what statistic data is collected by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If bit 0x00 is set, Data[0x00] is collected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If bit 0x01 is set, Data[0x01] is collected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If bit 0x20 is set, Data[0x20] is collected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If bit 0x21 is set, Data[0x21] is collected.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Statistic data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Total number of frames received. Includes frames with errors and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// dropped frames.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of valid frames received and copied into receive buffers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of frames below the minimum length for the media.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This would be <64 for ethernet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of frames longer than the maxminum length for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// media. This would be >1500 for ethernet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Valid frames that were dropped because receive buffers were full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of valid unicast frames received and not dropped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of valid broadcast frames received and not dropped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of valid mutlicast frames received and not dropped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of frames w/ CRC or alignment errors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Total number of bytes received. Includes frames with errors
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// and dropped frames.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Transmit statistics.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of collisions detection on this subnet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Number of frames destined for unsupported protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Multicast IP address to be converted to multicast MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Multicast MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// NvData item list. Only items in this list will be updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Non-volatile storage address to be changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Data item to write into above storage address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// When using bulk update, the size of the CPB structure must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the same size as the non-volatile NIC storage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of byte-wide data items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of word-wide data items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of dword-wide data items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Arrays of data items from non-volatile storage.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of byte-wide data items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of word-wide data items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of dword-wide data items.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of next receive frame (header + data). If this is zero,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// there is no next receive frame available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reserved, set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Addresses of transmitted buffers that need to be recycled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Source and destination MAC addresses. These will be copied into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the media header without doing byte swapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address of first byte of media header. The first byte of packet data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// follows the last byte of the media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of packet data in bytes (not including the media header).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Protocol type. This will be copied into the media header without
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// doing byte swapping. Protocol type numbers can be obtained from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the Assigned Numbers RFC 1700.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of the media header in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Source and destination MAC addresses. These will be copied into
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the media header without doing byte swapping.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of packet data in bytes (not including the media header).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Protocol type. This will be copied into the media header without
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// doing byte swapping. Protocol type numbers can be obtained from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the Assigned Numbers RFC 1700.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of the media header in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of packet fragment descriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reserved, must be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of packet fragment descriptors. The first byte of the media
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// header is the first byte of the first fragment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address of this packet fragment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of this packet fragment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reserved, must be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address of first byte of frame buffer. This is also the first byte
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of the media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of the data portion of the frame buffer in bytes. Do not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// include the length of the media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of the media header in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reserved, must be zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of packet data in bytes (not including the media header).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of the media header in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of packet fragment descriptors.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of frame fragment descriptors. The first byte of the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// fragment is also the first byte of the media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address of this frame fragment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of this frame fragment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reserved, must be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address of first byte of receive buffer. This is also the first byte
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of the frame header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of receive buffer. This must be large enough to hold the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// received frame (media header + data). If the length of smaller than
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the received frame, data will be lost.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reserved, must be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Source and destination MAC addresses from media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of received frame. May be larger than receive buffer size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The receive buffer will not be overwritten. This is how to tell
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// if data was lost because the receive buffer was too small.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Protocol type from media header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Length of media header in received frame.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Type of receive frame.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Reserved, must be zero.