* SUCH DAMAGE.
*/
+/*! \file vif_interface.h
+ \brief XENVIF VIF Interface
+
+ This interface provides access to the PV network frontend
+*/
+
#ifndef _XENVIF_VIF_INTERFACE_H
#define _XENVIF_VIF_INTERFACE_H
#include <ifdef.h>
#include <ethernet.h>
+/*! \struct _XENVIF_PACKET_HEADER_V1
+ \brief Packet header information
+*/
struct _XENVIF_PACKET_HEADER_V1 {
+ /*! Offset from beginning of packet */
ULONG Offset;
+ /*! Length of header (0 indicates a header is not present) */
ULONG Length;
};
+/*! \struct _XENVIF_PACKET_INFO_V1
+ \brief Packet information
+*/
struct _XENVIF_PACKET_INFO_V1 {
+ /*! Total length of all headers */
ULONG Length;
+ /*! VLAN TCI if present (0 indicates not present) */
USHORT TagControlInformation;
+ /*! TRUE if the packet is an IP fragment */
BOOLEAN IsAFragment;
+ /*! Ethernet header (stripped of any VLAN tag) */
struct _XENVIF_PACKET_HEADER_V1 EthernetHeader;
+ /*! LLC header (used for IPX or 802.3 IP) */
struct _XENVIF_PACKET_HEADER_V1 LLCSnapHeader;
+ /*! IP header (v4 or v6) */
struct _XENVIF_PACKET_HEADER_V1 IpHeader;
+ /*! IP options (v4 or v6) */
struct _XENVIF_PACKET_HEADER_V1 IpOptions;
+ /*! TCP header */
struct _XENVIF_PACKET_HEADER_V1 TcpHeader;
+ /*! TCP options */
struct _XENVIF_PACKET_HEADER_V1 TcpOptions;
+ /*! UDP header */
struct _XENVIF_PACKET_HEADER_V1 UdpHeader;
};
#pragma warning(disable:4214) // nonstandard extension used : bit field types other than int
#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union
+/*! \struct _XENVIF_PACKET_CHECKSUM_FLAGS_V1
+ \brief Packet checksum flags
+*/
struct _XENVIF_PACKET_CHECKSUM_FLAGS_V1 {
union {
struct {
+ /*! IPv4 header checksum validation succeeded */
ULONG IpChecksumSucceeded:1;
+ /*! IPv4 header checksum validation failed */
ULONG IpChecksumFailed:1;
+ /*! IPv4 header checksum is present */
ULONG IpChecksumPresent:1;
+ /*! TCP checksum validation succeeded */
ULONG TcpChecksumSucceeded:1;
+ /*! TCP checksum validation failed */
ULONG TcpChecksumFailed:1;
+ /*! TCP checksum is present */
ULONG TcpChecksumPresent:1;
+ /*! UDP checksum validation succeeded */
ULONG UdpChecksumSucceeded:1;
+ /*! UDP checksum validation failed */
ULONG UdpChecksumFailed:1;
+ /*! UDP checksum is present */
ULONG UdpChecksumPresent:1;
ULONG Reserved:23;
};
-
+ /*! Raw representation */
ULONG Value;
};
};
#pragma warning(pop)
+/*! \struct _XENVIF_RECEIVER_PACKET_V1
+ \brief Receive-side packet structure
+*/
struct _XENVIF_RECEIVER_PACKET_V1 {
+ /*! List entry used for chaining packets together */
LIST_ENTRY ListEntry;
+ /*! Pointer to packet information */
struct _XENVIF_PACKET_INFO_V1 *Info;
+ /*! Offset of start of packet in MDL */
ULONG Offset;
+ /*! Total length of packet */
ULONG Length;
+ /*! Checksum flags */
struct _XENVIF_PACKET_CHECKSUM_FLAGS_V1 Flags;
+ /*! TCP MSS if the packet contains a TCP large segment */
USHORT MaximumSegmentSize;
+ /*! Opaque cookie used to store context information for packet return */
PVOID Cookie;
+ /*! MDL referencing the initial buffer of the packet */
MDL Mdl;
+ /*! PFN information, which must always follow an MDL */
PFN_NUMBER __Pfn;
};
#pragma warning(disable:4214) // nonstandard extension used : bit field types other than int
#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union
+/*! \struct _XENVIF_VIF_OFFLOAD_OPTIONS_V1
+ \brief Offload options
+*/
struct _XENVIF_VIF_OFFLOAD_OPTIONS_V1 {
union {
struct {
+ /*! Insert/strip VLAN tags */
USHORT OffloadTagManipulation:1;
+ /*! Segment/coalesce IPv4 packets containing TCP large segments */
USHORT OffloadIpVersion4LargePacket:1;
+ /*! Calculate/validate IPv4 header checksum */
USHORT OffloadIpVersion4HeaderChecksum:1;
+ /*! Calculate/validate IPv4 TCP checksum */
USHORT OffloadIpVersion4TcpChecksum:1;
+ /*! Calculate/validate IPv4 UDP checksum */
USHORT OffloadIpVersion4UdpChecksum:1;
+ /*! Segment/coalesce IPv6 packets containing TCP large segments */
USHORT OffloadIpVersion6LargePacket:1;
+ /*! Calculate/validate IPv6 TCP checksum */
USHORT OffloadIpVersion6TcpChecksum:1;
+ /*! Calculate/validate IPv6 UDP checksum */
USHORT OffloadIpVersion6UdpChecksum:1;
+ /*! Force calculation of any missing checksums on receive side */
USHORT NeedChecksumValue:1;
+ /*! Force segmentation of packets containing TCP large segments on receive side */
USHORT NeedLargePacketSplit:1;
USHORT Reserved:6;
};
+ /*! Raw representation */
USHORT Value;
};
};
#pragma warning(pop)
-// To fit into the reserved space in NDIS_PACKET and NET_BUFFER structures the XENVIF_TRANSMITTER_PACKET
-// structure must be at most the size of 3 pointer types.
-
#pragma pack(push, 1)
+
+/*! \struct _XENVIF_TRANSMITTER_PACKET_SEND_INFO_V1
+ \brief Packet information passed from subscriber to provider on
+ transmit side packet send
+
+ To fit into the reserved space in NDIS_PACKET and NET_BUFFER structures
+ this structure must be at most the size of 3 pointer types.
+*/
struct _XENVIF_TRANSMITTER_PACKET_SEND_INFO_V1 {
+ /*! Offload options for this packet */
XENVIF_VIF_OFFLOAD_OPTIONS OffloadOptions;
- USHORT MaximumSegmentSize; // Only used if OffloadOptions.OffloadIpVersion[4|6]LargePacket is set
- USHORT TagControlInformation; // Only used if OffloadOptions.OffloadTagManipulation is set
+ /*! TCP MSS (used only if OffloadOptions.OffloadIpVersion[4|6]LargePacket is set) */
+ USHORT MaximumSegmentSize;
+ /*! VLAN TCI (used only if OffloadOptions.OffloadTagManipulation is set) */
+ USHORT TagControlInformation;
};
typedef struct _XENVIF_TRANSMITTER_PACKET_SEND_INFO_V1 XENVIF_TRANSMITTER_PACKET_SEND_INFO, *PXENVIF_TRANSMITTER_PACKET_SEND_INFO;
+/*! \enum _XENVIF_TRANSMITTER_PACKET_STATUS
+ \brief Transmit-side packet status
+*/
+typedef enum _XENVIF_TRANSMITTER_PACKET_STATUS {
+ /*! Packet was queued for the backend */
+ XENVIF_TRANSMITTER_PACKET_PENDING = 1,
+ /*! Packet has been successfully processed by the backend */
+ XENVIF_TRANSMITTER_PACKET_OK,
+ /*! Packet was dropped */
+ XENVIF_TRANSMITTER_PACKET_DROPPED,
+ /*! There was a problem handling the packet */
+ XENVIF_TRANSMITTER_PACKET_ERROR
+} XENVIF_TRANSMITTER_PACKET_STATUS, *PXENVIF_TRANSMITTER_PACKET_STATUS;
+
+/*! \struct _XENVIF_TRANSMITTER_PACKET_COMPLETION_INFO_V1
+ \brief Packet information passed from provider to subsriber on
+ transmit side packet return
+
+ To fit into the reserved space in NDIS_PACKET and NET_BUFFER structures
+ this structure must be at most the size of 3 pointer types.
+*/
struct _XENVIF_TRANSMITTER_PACKET_COMPLETION_INFO_V1 {
+ /*! Ethernet address type (see \ref _ETHERNET_ADDRESS_TYPE) */
UCHAR Type;
+ /*! Send status (see \ref _XENVIF_TRANSMITTER_PACKET_STATUS) */
UCHAR Status;
-
-#define XENVIF_TRANSMITTER_PACKET_PENDING 1
-#define XENVIF_TRANSMITTER_PACKET_OK 2
-#define XENVIF_TRANSMITTER_PACKET_DROPPED 3
-#define XENVIF_TRANSMITTER_PACKET_ERROR 4
-
+ /*! Total length of the sent packet */
USHORT PacketLength;
+ /*! Length of packet payload after recognized headers are removed */
USHORT PayloadLength;
};
#pragma warning(push)
#pragma warning(disable:4201) // nonstandard extension used : nameless struct/union
+/*! \struct _XENVIF_TRANSMITTER_PACKET_V1
+ \brief Transmit-side packet structure
+*/
struct _XENVIF_TRANSMITTER_PACKET_V1 {
+ /*! Pointer used for chaining packets together */
struct _XENVIF_TRANSMITTER_PACKET_V1 *Next;
union {
struct _XENVIF_TRANSMITTER_PACKET_SEND_INFO_V1 Send;
C_ASSERT(sizeof (struct _XENVIF_TRANSMITTER_PACKET_V1) <= (3 * sizeof (PVOID)));
+/*! \enum _XENVIF_TRANSMITTER_PACKET_OFFSET
+ \brief Offsets of packet metadata relative to
+ XENVIF_TRANSMITTER_PACKET pointer
+
+ Because the transmit side packet structure is limited to 3 pointer
+ types in size, not all information about the packet can be passed in
+ the structure. Other information can, however, be found by applying
+ these byte offsets to the structure pointer and then dereferencing the
+ specified type.
+*/
typedef enum _XENVIF_TRANSMITTER_PACKET_OFFSET {
+ /*! The offset of the start of the packet within the MDL (type ULONG) */
XENVIF_TRANSMITTER_PACKET_OFFSET_OFFSET = 0,
+ /*! The total length of the packet (type ULONG) */
XENVIF_TRANSMITTER_PACKET_LENGTH_OFFSET,
+ /*! MDL referencing the initial buffer of the packet (type PMDL) */
XENVIF_TRANSMITTER_PACKET_MDL_OFFSET,
XENVIF_TRANSMITTER_PACKET_OFFSET_COUNT
} XENVIF_TRANSMITTER_PACKET_OFFSET, *PXENVIF_TRANSMITTER_PACKET_OFFSET;
+/*! \enum _XENVIF_VIF_STATISTIC
+ \brief Interface statistics
+*/
typedef enum _XENVIF_VIF_STATISTIC {
+ /*! RFC 2863 ifOutDiscards */
XENVIF_TRANSMITTER_PACKETS_DROPPED = 0,
+ /*! Backend component of RFC 2863 ifOutErrors */
XENVIF_TRANSMITTER_BACKEND_ERRORS,
+ /*! Frontend component of RFC 2863 ifOutErrors */
XENVIF_TRANSMITTER_FRONTEND_ERRORS,
+ /*! RFC 2863 ifOutUcastPkts */
XENVIF_TRANSMITTER_UNICAST_PACKETS,
+ /*! Total number of octets in ifOutUcastPkts */
XENVIF_TRANSMITTER_UNICAST_OCTETS,
+ /*! RFC 2863 ifOutMulticastPkts */
XENVIF_TRANSMITTER_MULTICAST_PACKETS,
+ /*! Total number of octets in ifOutMulticastPkts */
XENVIF_TRANSMITTER_MULTICAST_OCTETS,
+ /*! RFC 2863 ifOutBroadcastPkts */
XENVIF_TRANSMITTER_BROADCAST_PACKETS,
+ /*! Total number of octets in ifOutBroadcastPkts */
XENVIF_TRANSMITTER_BROADCAST_OCTETS,
+ /*! RFC 2863 ifInDiscards */
XENVIF_RECEIVER_PACKETS_DROPPED,
+ /*! Backend component of RFC 2863 ifInErrors */
XENVIF_RECEIVER_BACKEND_ERRORS,
+ /*! Frontend component of RFC 2863 ifInErrors */
XENVIF_RECEIVER_FRONTEND_ERRORS,
+ /*! RFC 2863 ifInUcastPkts */
XENVIF_RECEIVER_UNICAST_PACKETS,
+ /*! Total number of octets in ifInUcastPkts */
XENVIF_RECEIVER_UNICAST_OCTETS,
+ /*! RFC 2863 ifInMulticastPkts */
XENVIF_RECEIVER_MULTICAST_PACKETS,
+ /*! Total number of octets in ifInMulticastPkts */
XENVIF_RECEIVER_MULTICAST_OCTETS,
+ /*! RFC 2863 ifInBroadcastPkts */
XENVIF_RECEIVER_BROADCAST_PACKETS,
+ /*! Total number of octets in ifInBroadcastPkts */
XENVIF_RECEIVER_BROADCAST_OCTETS,
XENVIF_VIF_STATISTIC_COUNT
} XENVIF_VIF_STATISTIC, *PXENVIF_VIF_STATISTIC;
+/*! \enum _XENVIF_MAC_FILTER_LEVEL
+ \brief Filter level applied to packets
+*/
typedef enum _XENVIF_MAC_FILTER_LEVEL {
+ /*! Don't filter out any packets */
XENVIF_MAC_FILTER_NONE = 0,
+ /*! Filter out all packets except those with a matching destination address */
XENVIF_MAC_FILTER_MATCHING = 1,
+ /*! Filter out all packets */
XENVIF_MAC_FILTER_ALL = 2
} XENVIF_MAC_FILTER_LEVEL, *PXENVIF_MAC_FILTER_LEVEL;
+/*! \enum _XENVIF_VIF_CALLBACK_TYPE
+ \brief Type of callback (see \ref XENVIF_VIF_CALLBACK)
+*/
typedef enum _XENVIF_VIF_CALLBACK_TYPE {
+ /*! Return transmit side packets to the subscriber */
XENVIF_TRANSMITTER_RETURN_PACKETS = 0,
+ /*! Queue receive side packets at the subscriber */
XENVIF_RECEIVER_QUEUE_PACKETS,
+ /*! Notify the subscriber of a MAC (link) state has change */
XENVIF_MAC_STATE_CHANGE
} XENVIF_VIF_CALLBACK_TYPE, *PXENVIF_VIF_CALLBACK_TYPE;
+/*! \typedef XENVIF_VIF_ACQUIRE
+ \brief Acquire a reference to the VIF interface
+
+ \param Interface The interface header
+*/
typedef NTSTATUS
(*XENVIF_VIF_ACQUIRE)(
IN PINTERFACE Interface
);
+/*! \typedef XENVIF_VIF_RELEASE
+ \brief Release a reference to the VIF interface
+
+ \param Interface The interface header
+*/
typedef VOID
(*XENVIF_VIF_RELEASE)(
IN PINTERFACE Interface
);
+/*! \typedef XENVIF_VIF_CALLBACK
+ \brief Provider to subscriber callback function
+
+ \param Argument An optional context argument passed to the callback
+ \param Type The callback type
+ \param ... Additional paramaters required by \a Type
+
+ \b XENVIF_TRANSMITTER_RETURN_PACKETS:
+ \param Head The head of a chain of XENVIF_TRANSMITTER_PACKET
+
+ \b XENVIF_RECEIVER_QUEUE_PACKETS:
+ \param List List of XENVIF_TRANSMITTER_PACKET
+
+ \b XENVIF_MAC_STATE_CHANGE:
+ No additional arguments
+*/
typedef VOID
(*XENVIF_VIF_CALLBACK)(
- IN PVOID Argument,
+ IN PVOID Argument OPTIONAL,
IN XENVIF_VIF_CALLBACK_TYPE Type,
...
);
+/*! \typedef XENVIF_VIF_ENABLE
+ \brief Enable the VIF interface
+
+ All packets queued for transmit will be rejected and no packets will
+ be queued for receive until this method completes.
+
+ \param Interface The interface header
+ \param Callback The subscriber's callback function
+ \param Argument An optional context argument passed to the callback
+*/
typedef NTSTATUS
(*XENVIF_VIF_ENABLE)(
IN PINTERFACE Interface,
IN PVOID Argument OPTIONAL
);
+/*! \typedef XENVIF_VIF_DISABLE
+ \brief Disable the VIF interface
+
+ This method will not complete until any packets queued for receive
+ have been returned. Any packets queued for transmit may be aborted.
+
+ \param Interface The interface header
+*/
typedef VOID
(*XENVIF_VIF_DISABLE)(
IN PINTERFACE Interface
);
+/*! \typedef XENVIF_VIF_QUERY_STATISTIC
+ \brief Query the value of an interface statistic
+
+ Interface statistics are 64-bits wide and zero based. They are
+ zeroed when the vif device object is created. They are not
+ zeroed by this call or by any vif state change (e.g. reconnection
+ across migration).
+
+ \param Interface The interface header
+ \param Index The index of the statistic in \ref _XENVIF_VIF_STATISTIC
+ \param Value Buffer to receive the value of the statistic
+*/
typedef NTSTATUS
(*XENVIF_VIF_QUERY_STATISTIC)(
IN PINTERFACE Interface,
OUT PULONGLONG Value
);
+/*! \typedef XENVIF_VIF_RECEIVER_RETURN_PACKETS
+ \brief Return packets queues for receive by \ref XENVIF_VIF_CALLBACK
+ (Type = \ref XENVIF_RECEIVER_QUEUE_PACKETS)
+
+ \param Interface The interface header
+ \param List List of \ref _XENVIF_RECEIVER_PACKET_V1
+*/
typedef VOID
(*XENVIF_VIF_RECEIVER_RETURN_PACKETS)(
IN PINTERFACE Interface,
IN PLIST_ENTRY List
);
+/*! \typedef XENVIF_VIF_TRANSMITTER_SET_PACKET_OFFSET
+ \brief Set byte offset of packet information relative to
+ XENVIF_TRANSMITTER_PACKET pointer.
+
+ See \ref _XENVIF_TRANSMITTER_PACKET_OFFSET.
+
+ \param Interface The interface header
+ \param Type The offset type
+ \param Value The offset value
+*/
typedef NTSTATUS
(*XENVIF_VIF_TRANSMITTER_SET_PACKET_OFFSET)(
IN PINTERFACE Interface,
IN LONG_PTR Value
);
+/*! \typedef XENVIF_VIF_TRANSMITTER_QUEUE_PACKETS
+ \brief Queue transmit side packets at the provider
+
+ \param Interface The interface header
+ \param Head The head of a chain of XENVIF_TRANSMITTER_PACKET
+*/
typedef NTSTATUS
(*XENVIF_VIF_TRANSMITTER_QUEUE_PACKETS)(
IN PINTERFACE Interface,
IN PXENVIF_TRANSMITTER_PACKET Head
);
+/*! \typedef XENVIF_VIF_TRANSMITTER_QUERY_OFFLOAD_OPTIONS
+ \brief Query the available set of transmit side offload options
+
+ \param Interface The interface header
+ \param Options Buffer to receive the avilable options
+ (see \ref _XENVIF_VIF_OFFLOAD_OPTIONS_V1)
+*/
typedef VOID
(*XENVIF_VIF_TRANSMITTER_QUERY_OFFLOAD_OPTIONS)(
IN PINTERFACE Interface,
OUT PXENVIF_VIF_OFFLOAD_OPTIONS Options
);
+/*! \typedef XENVIF_VIF_RECEIVER_SET_OFFLOAD_OPTIONS
+ \brief Set the required set of receive side offload options
+
+ \param Interface The interface header
+ \param Options The required options
+ (see \ref _XENVIF_VIF_OFFLOAD_OPTIONS_V1)
+*/
typedef VOID
(*XENVIF_VIF_RECEIVER_SET_OFFLOAD_OPTIONS)(
IN PINTERFACE Interface,
IN XENVIF_VIF_OFFLOAD_OPTIONS Options
);
+/*! \typedef XENVIF_VIF_TRANSMITTER_QUERY_LARGE_PACKET_SIZE
+ \brief Query the maximum size of packet containing a TCP large segment
+ that can be handled by the transmit side
+
+ \param Interface The interface header
+ \param Version The IP version (4 or 6)
+ \param Size Buffer to receive the maximum packet size
+*/
typedef VOID
(*XENVIF_VIF_TRANSMITTER_QUERY_LARGE_PACKET_SIZE)(
IN PINTERFACE Interface,
OUT PULONG Size
);
+/*! \typedef XENVIF_VIF_TRANSMITTER_QUERY_RING_SIZE
+ \brief Query the maximum number of transmit side packets that can
+ be queued in the shared ring between frontend and backend
+
+ \param Interface The interface header
+ \param Size Buffer to receive the maximum number of packets
+*/
typedef VOID
(*XENVIF_VIF_TRANSMITTER_QUERY_RING_SIZE)(
IN PINTERFACE Interface,
OUT PULONG Size
);
+/*! \typedef XENVIF_VIF_RECEIVER_QUERY_RING_SIZE
+ \brief Query the maximum number of receive side packets that can
+ be queued in the shared ring between backend and frontend
+
+ \param Interface The interface header
+ \param Size Buffer to receive the maximum number of packets
+*/
typedef VOID
(*XENVIF_VIF_RECEIVER_QUERY_RING_SIZE)(
IN PINTERFACE Interface,
OUT PULONG Size
);
+/*! \typedef XENVIF_VIF_MAC_QUERY_STATE
+ \brief Query the current MAC (link) state
+
+ \param Interface The interface header
+ \param MediaConnectState Buffer to receive the current connection state
+ \param LinkSpeed Buffer to receive the current link speed in Gbps
+ \param MediaDuplexState Buffer to receive the current duplex state
+*/
typedef VOID
(*XENVIF_VIF_MAC_QUERY_STATE)(
IN PINTERFACE Interface,
OUT PNET_IF_MEDIA_DUPLEX_STATE MediaDuplexState OPTIONAL
);
+/*! \typedef XENVIF_VIF_MAC_QUERY_MAXIMUM_FRAME_SIZE
+ \brief Query the maximum MAC (i.e. on the wire) frame size (not
+ including CRC)
+
+ \param Interface The interface header
+ \param Size Buffer to receive the maximum frame size
+*/
typedef VOID
(*XENVIF_VIF_MAC_QUERY_MAXIMUM_FRAME_SIZE)(
IN PINTERFACE Interface,
OUT PULONG Size
);
+/*! \typedef XENVIF_VIF_MAC_QUERY_PERMANENT_ADDRESS
+ \brief Query the permanent MAC address (set by the toolstack)
+
+ \param Interface The interface header
+ \param Address Buffer to receive the permanent address
+*/
typedef VOID
(*XENVIF_VIF_MAC_QUERY_PERMANENT_ADDRESS)(
IN PINTERFACE Interface,
OUT PETHERNET_ADDRESS Address
);
+/*! \typedef XENVIF_VIF_MAC_QUERY_CURRENT_ADDRESS
+ \brief Query the current MAC address (may be set by the guest)
+
+ The guest OS may override the MAC address using the registry. If this
+ is not done then the current address will be identical to the
+ permanent address.
+
+ \param Interface The interface header
+ \param Address Buffer to receive the current address
+*/
typedef VOID
(*XENVIF_VIF_MAC_QUERY_CURRENT_ADDRESS)(
IN PINTERFACE Interface,
OUT PETHERNET_ADDRESS Address
);
+/*! \typedef XENVIF_VIF_MAC_QUERY_MULTICAST_ADDRESSES
+ \brief Query the current set of active multicast addresses
+
+ \param Interface The interface header
+ \param Address An optional buffer to receive the set of addresses
+ \param Count A buffer to receive the number of active addresses
+
+ Call this method with \a Address set to NULL to get the \a Count,
+ which can then be used to allocate a buffer of suitable size to receive
+ the array of addresses.
+*/
typedef NTSTATUS
(*XENVIF_VIF_MAC_QUERY_MULTICAST_ADDRESSES)(
IN PINTERFACE Interface,
IN OUT PULONG Count
);
+/*! \typedef XENVIF_VIF_MAC_SET_MULTICAST_ADDRESSES
+ \brief Update the set of active multicast addresses
+
+ \param Interface The interface header
+ \param Address An optional buffer containing the set of addresses
+ \param Count The number of addresses in the buffer
+
+ The \a Address buffer may only by NULL if \a Count is zero, in which
+ case the set of active multicast addresses will be cleared.
+*/
typedef NTSTATUS
(*XENVIF_VIF_MAC_SET_MULTICAST_ADDRESSES)(
IN PINTERFACE Interface,
IN ULONG Count
);
+/*! \typedef XENVIF_VIF_MAC_SET_FILTER_LEVEL
+ \brief Set a filter level for a given type of packet
+
+ \param Interface The interface header
+ \param Type The destination address type of the packet
+ (see \ref _ETHERNET_ADDRESS_TYPE)
+ \param Level The new filter level (see \ref _XENVIF_MAC_FILTER_LEVEL)
+*/
typedef NTSTATUS
(*XENVIF_VIF_MAC_SET_FILTER_LEVEL)(
IN PINTERFACE Interface,
IN XENVIF_MAC_FILTER_LEVEL Level
);
+/*! \typedef XENVIF_VIF_MAC_QUERY_FILTER_LEVEL
+ \brief Query the current filter level for a given type of packet
+
+ \param Interface The interface header
+ \param Type The destination address type of the packet
+ (see \ref _ETHERNET_ADDRESS_TYPE)
+ \param Level Buffer to receive the filter level (see \ref _XENVIF_MAC_FILTER_LEVEL)
+*/
typedef NTSTATUS
(*XENVIF_VIF_MAC_QUERY_FILTER_LEVEL)(
IN PINTERFACE Interface,
DEFINE_GUID(GUID_XENVIF_VIF_INTERFACE,
0x76f279cd, 0xca11, 0x418b, 0x92, 0xe8, 0xc5, 0x7f, 0x77, 0xde, 0xe, 0x2e);
+/*! \struct _XENVIF_VIF_INTERFACE_V1
+ \brief VIF interface version 1
+ \ingroup interfaces
+*/
struct _XENVIF_VIF_INTERFACE_V1 {
INTERFACE Interface;
XENVIF_VIF_ACQUIRE Acquire;
typedef struct _XENVIF_VIF_INTERFACE_V1 XENVIF_VIF_INTERFACE, *PXENVIF_VIF_INTERFACE;
+/*! \def XENVIF_VIF
+ \brief Macro at assist in method invocation
+*/
#define XENVIF_VIF(_Method, _Interface, ...) \
(_Interface)-> ## _Method((PINTERFACE)(_Interface), __VA_ARGS__)
projects / people / pauldu / xennet.git / commitdiff