0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * PDM - Pluggable Device Manager, Network Interfaces.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Copyright (C) 2006-2010 Oracle Corporation
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * available from http://www.virtualbox.org. This file is free software;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * you can redistribute it and/or modify it under the terms of the GNU
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * General Public License (GPL) as published by the Free Software
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The contents of this file may alternatively be used under the terms
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * of the Common Development and Distribution License Version 1.0
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution, in which case the provisions of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * CDDL are applicable instead of those of the GPL.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * You may elect to license modified versions of this file under the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * terms and conditions of either the GPL or the CDDL or both.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @defgroup grp_pdm_ifs_net PDM Network Interfaces
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @ingroup grp_pdm_interfaces
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * PDM scatter/gather buffer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @todo Promote this to VBox/types.h, VBox/vmm/pdmcommon.h or some such place.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** Flags. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** The number of bytes used.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This is cleared on alloc and set by the user. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** The number of bytes available.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This is set on alloc and not changed by the user. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** Private data member for the allocator side. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** Private data member for the user side. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** The number of segments
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This is set on alloc and not changed by the user. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** Variable sized array of segments. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a PDM scatter/gather buffer. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a PDM scatter/gather buffer pointer. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @name PDMSCATTERGATHER::fFlags
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Magic value. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_MAGIC UINT32_C(0xb1b10000)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Magic mask. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_MAGIC_MASK UINT32_C(0xffff0000)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Owned by owner number 1. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_OWNER_1 UINT32_C(0x00000001)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Owned by owner number 2. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_OWNER_2 UINT32_C(0x00000002)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Owned by owner number 3. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_OWNER_3 UINT32_C(0x00000002)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Owner mask. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_OWNER_MASK UINT32_C(0x00000003)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Mask of flags available to general use.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The parties using the SG must all agree upon how to use these of course. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_AVL_MASK UINT32_C(0x0000f000)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Flags reserved for future use, MBZ. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMSCATTERGATHER_FLAGS_RVD_MASK UINT32_C(0x00000ff8)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Sets the owner of a scatter/gather buffer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pSgBuf .
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param uNewOwner The new owner.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncDECLINLINE(void) PDMScatterGatherSetOwner(PPDMSCATTERGATHER pSgBuf, uint32_t uNewOwner)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync pSgBuf->fFlags = (pSgBuf->fFlags & ~PDMSCATTERGATHER_FLAGS_OWNER_MASK) | uNewOwner;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a network port interface */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Network port interface (down).
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Pair with PDMINETWORKUP.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Wait until there is space for receiving data. We do not care how much space is available
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * because pfnReceive() will re-check and notify the guest if necessary.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This function must be called before the pfnRecieve() method is called.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code. VINF_SUCCESS means there is at least one receive descriptor available.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cMillies Number of milliseconds to wait. 0 means return immediately.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Non-EMT.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnWaitReceiveAvail,(PPDMINETWORKDOWN pInterface, RTMSINTERVAL cMillies));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Receive data from the network.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvBuf The available data.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cb Number of bytes available in the buffer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Non-EMT.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnReceive,(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Receive data with segmentation context from the network.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pvBuf The available data.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cb Number of bytes available in the buffer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pGso Segmentation context.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Non-EMT.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnReceiveGso,(PPDMINETWORKDOWN pInterface, const void *pvBuf, size_t cb, PCPDMNETWORKGSO pGso));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Do pending transmit work on the leaf driver's XMIT thread.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * When a PDMINETWORKUP::pfnBeginTransmit or PDMINETWORKUP::pfnAllocBuf call
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * fails with VERR_TRY_AGAIN, the leaf drivers XMIT thread will offer to process
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * the upstream device/driver when the the VERR_TRY_AGAIN condition has been
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * removed. In some cases the VERR_TRY_AGAIN condition is simply being in an
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * inconvenient context and the XMIT thread will start working ASAP.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to this interface.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Non-EMT.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(void, pfnXmitPending,(PPDMINETWORKDOWN pInterface));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** PDMINETWORKDOWN interface ID. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMINETWORKDOWN_IID "52b8cdbb-a087-493b-baa7-81ec3b803e06"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Network link state.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** Invalid state. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** The link is up. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** The link is down. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** The link is temporarily down while resuming. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a network connector interface */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef R3PTRTYPE(struct PDMINETWORKUP *) PPDMINETWORKUPR3;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a network connector interface, ring-0 context. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef R0PTRTYPE(struct PDMINETWORKUPR0 *) PPDMINETWORKUPR0;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a network connector interface, raw-mode context. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef RCPTRTYPE(struct PDMINETWORKUPRC *) PPDMINETWORKUPRC;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a current context network connector interface. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Network connector interface (up).
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Pair with PDMINETWORKDOWN.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Begins a transmit session.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The leaf driver guarantees that there are no concurrent sessions.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VINF_SUCCESS on success. Must always call
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * PDMINETWORKUP::pfnEndXmit.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VERR_TRY_AGAIN if there is already an open transmit session or some
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * important resource was unavailable (like buffer space). If it's a
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * resources issue, the driver will signal its XMIT thread and have it
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * work the device thru the PDMINETWORKDOWN::pfnNotifyBufAvailable
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * callback method.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param fOnWorkerThread Set if we're being called on a work thread. Clear
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * if an EMT.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Any, but normally EMT or the XMIT thread.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnBeginXmit,(PPDMINETWORKUP pInterface, bool fOnWorkerThread));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Get a send buffer for passing to pfnSendBuf.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VINF_SUCCESS on success.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VERR_TRY_AGAIN if temporarily out of buffer space. After this
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * happens, the driver will call PDMINETWORKDOWN::pfnNotifyBufAvailable
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * when this is a buffer of the required size available.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VERR_NO_MEMORY if really out of buffer space.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VERR_NET_DOWN if we cannot send anything to the network at this
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * point in time. Drop the frame with a xmit error. This is typically
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * only seen when pausing the VM since the device keeps the link state,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * but there could of course be races.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cbMin The minimum buffer size.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pGso Pointer to a GSO context (only reference while in
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * this call). NULL indicates no segmentation
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * offloading. PDMSCATTERGATHER::pvUser is used to
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * indicate that a network SG uses GSO, usually by
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * pointing to a copy of @a pGso.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppSgBuf Where to return the buffer. The buffer will be
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * owned by the caller, designation owner number 1.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Any, but normally EMT or the XMIT thread.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnAllocBuf,(PPDMINETWORKUP pInterface, size_t cbMin, PCPDMNETWORKGSO pGso,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Frees an unused buffer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VINF_SUCCESS on success.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pSgBuf A buffer from PDMINETWORKUP::pfnAllocBuf or
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * PDMINETWORKDOWN::pfnNotifyBufAvailable. The buffer
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * ownership shall be 1.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Any, but normally EMT or the XMIT thread.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnFreeBuf,(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Send data to the network.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VINF_SUCCESS on success.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VERR_NET_DOWN if the NIC is not connected to a network. pSgBuf will
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * be freed.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @retval VERR_NET_NO_BUFFER_SPACE if we're out of resources. pSgBuf will be
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pSgBuf The buffer containing the data to send. The buffer
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * ownership shall be 1. The buffer will always be
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * consumed, regardless of the status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param fOnWorkerThread Set if we're being called on a work thread. Clear
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * if an EMT.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Any, but normally EMT or the XMIT thread.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnSendBuf,(PPDMINETWORKUP pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Ends a transmit session.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Pairs with successful PDMINETWORKUP::pfnBeginXmit calls.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread Any, but normally EMT or the XMIT thread.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(void, pfnEndXmit,(PPDMINETWORKUP pInterface));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Set promiscuous mode.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This is called when the promiscuous mode is set. This means that there doesn't have
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * to be a mode change when it's called.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param fPromiscuous Set if the adaptor is now in promiscuous mode. Clear if it is not.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread EMT ??
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(void, pfnSetPromiscuousMode,(PPDMINETWORKUP pInterface, bool fPromiscuous));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Notification on link status changes.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param enmLinkState The new link state.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread EMT ??
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(void, pfnNotifyLinkChanged,(PPDMINETWORKUP pInterface, PDMNETWORKLINKSTATE enmLinkState));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @todo Add a callback that informs the driver chain about MAC address changes if we ever implement that. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Ring-0 edition of PDMINETWORKUP. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnBeginXmit */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR0CALLBACKMEMBER(int, pfnBeginXmit,(PPDMINETWORKUPR0 pInterface, bool fOnWorkerThread));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnAllocBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR0CALLBACKMEMBER(int, pfnAllocBuf,(PPDMINETWORKUPR0 pInterface, size_t cbMin, PCPDMNETWORKGSO pGso,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnFreeBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR0CALLBACKMEMBER(int, pfnFreeBuf,(PPDMINETWORKUPR0 pInterface, PPDMSCATTERGATHER pSgBuf));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnSendBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR0CALLBACKMEMBER(int, pfnSendBuf,(PPDMINETWORKUPR0 pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnEndBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR0CALLBACKMEMBER(void, pfnEndXmit,(PPDMINETWORKUPR0 pInterface));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnSetPromiscuousMode */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR0CALLBACKMEMBER(void, pfnSetPromiscuousMode,(PPDMINETWORKUPR0 pInterface, bool fPromiscuous));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Raw-mode context edition of PDMINETWORKUP. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnBeginXmit */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLRCCALLBACKMEMBER(int, pfnBeginXmit,(PPDMINETWORKUPRC pInterface, bool fOnWorkerThread));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnAllocBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLRCCALLBACKMEMBER(int, pfnAllocBuf,(PPDMINETWORKUPRC pInterface, size_t cbMin, PCPDMNETWORKGSO pGso,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnFreeBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLRCCALLBACKMEMBER(int, pfnFreeBuf,(PPDMINETWORKUPRC pInterface, PPDMSCATTERGATHER pSgBuf));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnSendBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLRCCALLBACKMEMBER(int, pfnSendBuf,(PPDMINETWORKUPRC pInterface, PPDMSCATTERGATHER pSgBuf, bool fOnWorkerThread));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnEndBuf */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLRCCALLBACKMEMBER(void, pfnEndXmit,(PPDMINETWORKUPRC pInterface));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /** @copydoc PDMINETWORKUP::pfnSetPromiscuousMode */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLRCCALLBACKMEMBER(void, pfnSetPromiscuousMode,(PPDMINETWORKUPRC pInterface, bool fPromiscuous));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** PDMINETWORKUP interface ID. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMINETWORKUP_IID "67e7e7a8-2594-4649-a1e3-7cee680c6083"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** PDMINETWORKUP interface method names. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMINETWORKUP_SYM_LIST "BeginXmit;AllocBuf;FreeBuf;SendBuf;EndXmit;SetPromiscuousMode"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a network config port interface */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef struct PDMINETWORKCONFIG *PPDMINETWORKCONFIG;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Network config port interface (main).
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * No interface pair.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Gets the current Media Access Control (MAC) address.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pMac Where to store the MAC address.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread EMT
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnGetMac,(PPDMINETWORKCONFIG pInterface, PRTMAC pMac));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Gets the new link state.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns The current link state.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread EMT
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(PDMNETWORKLINKSTATE, pfnGetLinkState,(PPDMINETWORKCONFIG pInterface));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Sets the new link state.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns VBox status code.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param enmState The new link state
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @thread EMT
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnSetLinkState,(PPDMINETWORKCONFIG pInterface, PDMNETWORKLINKSTATE enmState));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** PDMINETWORKCONFIG interface ID. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#define PDMINETWORKCONFIG_IID "d6d909e8-716d-415d-b109-534e4478ff4e"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** Pointer to a NAT configuration port. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsynctypedef struct PDMINETWORKNATCONFIG *PPDMINETWORKNATCONFIG;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Network config port interface (main).
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * No interface pair.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Inform NAT about the adding/removing redirection rule
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @todo D O C U M E N T M E !
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @todo s/u16/u/g
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync DECLR3CALLBACKMEMBER(int, pfnRedirectRuleCommand ,(PPDMINETWORKNATCONFIG pInterface, bool fRemove,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync bool fUdp, const char *pHostIp, uint16_t u16HostPort,
09179c0602b404854c7bb247878fe05c65f4c167vboxsync * Inform NAT about host DNS settings change.
09179c0602b404854c7bb247878fe05c65f4c167vboxsync * IHostNameResolutionConfigurationChangeEvent.
09179c0602b404854c7bb247878fe05c65f4c167vboxsync DECLR3CALLBACKMEMBER(void, pfnNotifyDnsChanged, (PPDMINETWORKNATCONFIG pInterface));
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** PDMINETWORKNATCONFIG interface ID. */
09179c0602b404854c7bb247878fe05c65f4c167vboxsync#define PDMINETWORKNATCONFIG_IID "dc961028-3523-4b52-a93b-e38168a4a9fa"