pdmifs.h revision ee4d840f54fd2dcea8a73b1b86d5ec0db370b05d
/** @file
* PDM - Pluggable Device Manager, Interfaces. (VMM)
*/
/*
* Copyright (C) 2006-2008 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___VBox_pdmifs_h
#define ___VBox_pdmifs_h
/** @defgroup grp_pdm_interfaces The PDM Interface Definitions
* @ingroup grp_pdm
* @{
*/
/** @name Common Driver Interface Identficators.
* @todo Convert all these to _IID.
* @{
*/
/** PDMIMOUSEPORT - The mouse port interface. (Down) Coupled with PDMINTERFACE_MOUSE_CONNECTOR. */
#define PDMINTERFACE_MOUSE_PORT "dcf20e6b-6cd5-4517-8759-91064605b8a8"
/** PDMIMOUSECONNECTOR - The mouse connector interface. (Up) Coupled with PDMINTERFACE_MOUSE_PORT. */
#define PDMINTERFACE_MOUSE_CONNECTOR "847f965f-0eb8-4363-88ac-b0ee58a05bde"
/** PDMIKEYBOARDPORT - The keyboard port interface. (Down) Coupled with PDMINTERFACE_KEYBOARD_CONNECTOR. */
#define PDMINTERFACE_KEYBOARD_PORT "2a0844f0-410b-40ab-a6ed-6575f3aa3e29"
/** PDMIKEYBOARDCONNECTOR - The keyboard connector interface. (Up) Coupled with PDMINTERFACE_KEYBOARD_PORT. */
#define PDMINTERFACE_KEYBOARD_CONNECTOR "db3f7bd5-953e-436f-9f8e-077905a92d82"
/** PDMIDISPLAYPORT - The display port interface. (Down) Coupled with PDMINTERFACE_DISPLAY_CONNECTOR. */
#define PDMINTERFACE_DISPLAY_PORT "48bbcb6b-ba43-449b-9248-b8bb09929771"
/** PDMIDISPLAYCONNECTOR - The display connector interface. (Up) Coupled with PDMINTERFACE_DISPLAY_PORT. */
#define PDMINTERFACE_DISPLAY_CONNECTOR "c7a1b36d-8dfc-421d-b71f-3a0eeaf733e6"
/** PDMICHARPORT - The char notify interface. (Down) Coupled with PDMINTERFACE_CHAR. */
#define PDMINTERFACE_CHAR_PORT "22769834-ea8b-4a6d-ade1-213dcdbd1228"
/** PDMICHAR - The char driver interface. (Up) Coupled with PDMINTERFACE_CHAR_PORT. */
#define PDMINTERFACE_CHAR "4ad5c190-b408-4cef-926f-fbffce0dc5cc"
/** PDMISTREAM - The stream driver interface (Up) No coupling.
* Used by a char driver to implement PDMINTERFACE_CHAR. */
#define PDMINTERFACE_STREAM "d1a5bf5e-3d2c-449a-bde9-addd7920b71f"
/** PDMIBLOCKPORT - The block notify interface (Down) Coupled with PDMINTERFACE_BLOCK. */
#define PDMINTERFACE_BLOCK_PORT "e87fa1ab-92d5-4100-8712-fe2a0c042faf"
/** PDMIBLOCK - The block driver interface (Up) Coupled with PDMINTERFACE_BLOCK_PORT. */
#define PDMINTERFACE_BLOCK "0a5f3156-8b21-4cf5-83fd-e097281d2900"
/** PDMIBLOCKBIOS - The block bios interface. (External) */
#define PDMINTERFACE_BLOCK_BIOS "477c3eee-a48d-48a9-82fd-2a54de16b2e9"
/** PDMIMOUNTNOTIFY - The mountable notification interface. (Down) Coupled with PDMINTERFACE_MOUNT. */
#define PDMINTERFACE_MOUNT_NOTIFY "fa143ac9-9fc6-498e-997f-945380a558f9"
/** PDMIMOUNT - The mountable interface. (Up) Coupled with PDMINTERFACE_MOUNT_NOTIFY. */
#define PDMINTERFACE_MOUNT "8e5a009a-6032-4ca1-9d86-a388d8eaf926"
/** PDMIMEDIA - The media interface. (Up) No coupling.
* Used by a block unit driver to implement PDMINTERFACE_BLOCK and PDMINTERFACE_BLOCK_BIOS. */
#define PDMINTERFACE_MEDIA "f5bb07c9-2843-46f8-a56f-cc090b6e5bac"
/** PDMIISCSITRANSPORT - The iSCSI transport interface (Up) No coupling.
* used by the iSCSI media driver. */
#define PDMINTERFACE_ISCSITRANSPORT "b69c9b49-fd24-4955-8d8b-40aaead815e5"
/** PDMIISCSITRANSPORTASYNC - The asynchronous iSCSI interface (Up) Couple with PDMINTERFACE_ISCSITRANSPORT.
* extension used by the iSCSI media driver. */
#define PDMINTERFACE_ISCSITRANSPORTASYNC "f6751563-c378-4928-b7fe-411873112ac3"
/** PDMIISCSITRANSPORTASYNCPORT - The asynchronous iSCSI interface (Down) Couple with PDMINTERFACE_ISCSITRANSPORTASYNC.
* notify port used by the iSCSI media driver. */
#define PDMINTERFACE_ISCSITRANSPORTASYNCPORT "6ab0fbf1-aa72-4b27-bc46-f58896ba0392"
/** PDMIMEDIAASYNC - Async version of the media interface (Down) Coupled with PDMINTERFACE_MEDIA_ASYNC_PORT. */
#define PDMINTERFACE_MEDIA_ASYNC "d7bc3c90-e686-4d9c-a7bc-6c6742e452ec"
/** PDMIMEDIAASYNCPORT - Async version of the media interface (Up) Coupled with PDMINTERFACE_MEDIA_ASYNC. */
#define PDMINTERFACE_MEDIA_ASYNC_PORT "22d38853-901f-4a71-9670-4d9da6e82317"
/** PDMIBLOCKASYNC - Async version of the block interface (Down) Coupled with PDMINTERFACE_BLOCK_ASYNC_PORT. */
#define PDMINTERFACE_BLOCK_ASYNC "142cd775-3be6-4c9f-9e3d-68969c3d4779"
/** PDMIBLOCKASYNCPORT - Async version of the block interface (Up) Coupled with PDMINTERFACE_BLOCK_ASYNC. */
#define PDMINTERFACE_BLOCK_ASYNC_PORT "e3bdc0cb-9d99-41dd-8eec-0dc8cf5b2a92"
/** PDMINETWORKPORT - The network port interface. (Down) Coupled with PDMINTERFACE_NETWORK_CONNECTOR. */
#define PDMINTERFACE_NETWORK_PORT "eb66670b-7998-4470-8e72-886e30f6a9c3"
/** PDMINETWORKPORT - The network connector interface. (Up) Coupled with PDMINTERFACE_NETWORK_PORT. */
#define PDMINTERFACE_NETWORK_CONNECTOR "b4b6f850-50d0-4ddf-9efa-daee80194dca"
/** PDMINETWORKCONFIG - The network configuartion interface. (Main) Used by the managment api. */
#define PDMINTERFACE_NETWORK_CONFIG "d6d909e8-716d-415d-b109-534e4478ff4e"
/** PDMIAUDIOCONNECTOR - The audio driver interface. (Up) No coupling. */
#define PDMINTERFACE_AUDIO_CONNECTOR "85d52af5-b3aa-4b3e-b176-4b5ebfc52f47"
/** PDMIAUDIOSNIFFERPORT - The Audio Sniffer Device port interface. */
#define PDMINTERFACE_AUDIO_SNIFFER_PORT "83b95e02-68cb-470d-9dfc-25a0f8efe197"
/** PDMIAUDIOSNIFFERCONNECTOR - The Audio Sniffer Driver connector interface. */
#define PDMINTERFACE_AUDIO_SNIFFER_CONNECTOR "433b64ab-e603-4933-bc97-8fe79b2bd0e0"
/** PDMIVMMDEVPORT - The VMM Device port interface. */
#define PDMINTERFACE_VMMDEV_PORT "d7e52035-3b6c-422e-9215-2a75646a945d"
/** PDMIVMMDEVCONNECTOR - The VMM Device connector interface. */
#define PDMINTERFACE_VMMDEV_CONNECTOR "38b96194-ee83-489e-b92e-73ee28a29439"
/** PDMILEDPORTS - The generic LED port interface. (Down) Coupled with PDMINTERFACE_LED_CONNECTORS. */
#define PDMINTERFACE_LED_PORTS "435e0cec-8549-4ca0-8c0d-98e52f1dc038"
/** PDMILEDCONNECTORS - The generic LED connector interface. (Up) Coupled with PDMINTERFACE_LED_PORTS. */
#define PDMINTERFACE_LED_CONNECTORS "8ed63568-82a7-4193-b57b-db8085ac4495"
/** PDMIACPIPORT - ACPI port interface. (Down) Coupled with PDMINTERFACE_ACPI_CONNECTOR. */
#define PDMINTERFACE_ACPI_PORT "30d3dc4c-6a73-40c8-80e9-34309deacbb3"
/** PDMIACPICONNECTOR - ACPI connector interface. (Up) Coupled with PDMINTERFACE_ACPI_PORT. */
#define PDMINTERFACE_ACPI_CONNECTOR "5f14bf8d-1edf-4e3a-a1e1-cca9fd08e359"
/** PDMIHGCMPORT - The Host-Guest communication manager port interface. Normally implemented by VMMDev. */
#define PDMINTERFACE_HGCM_PORT "e00a0cbf-b75a-45c3-87f4-41cddbc5ae0b"
/** PDMIHGCMCONNECTOR - The Host-Guest communication manager connector interface. Normally implemented by Main::VMMDevInterface. */
#define PDMINTERFACE_HGCM_CONNECTOR "a1104758-c888-4437-8f2a-7bac17865b5c"
/** VUSBIROOTHUBPORT - VUSB RootHub port interface. (Down) Coupled with PDMINTERFACE_USB_RH_CONNECTOR. */
#define PDMINTERFACE_VUSB_RH_PORT "e38e2978-7aa2-4860-94b6-9ef4a066d8a0"
/** VUSBIROOTHUBCONNECTOR - VUSB RootHub connector interface. (Up) Coupled with PDMINTERFACE_USB_RH_PORT. */
#define PDMINTERFACE_VUSB_RH_CONNECTOR "d9a90c59-e3ff-4dff-9754-844557c3f7a0"
/** VUSBIRHCONFIG - VUSB RootHub configuration interface. (Main) Used by the managment api. */
#define PDMINTERFACE_VUSB_RH_CONFIG "c354cd97-e85f-465e-bc12-b58798465f52"
/** VUSBIDEVICE - VUSB Device interface. (Up) No coupling. */
#define PDMINTERFACE_VUSB_DEVICE "88732dd3-0ccd-4625-b040-48804ac7a217"
/** PDMIHOSTPARALLELPORT - The Host Parallel port interface. (Down) Coupled with PDMINTERFACE_HOST_PARALLEL_CONNECTOR. */
#define PDMINTERFACE_HOST_PARALLEL_PORT "ac13e437-cd30-47ac-a271-6120571f3a22"
/** PDMIHOSTPARALLELCONNECTOR - The Host Parallel connector interface (Up) Coupled with PDMINTERFACE_HOST_PARALLEL_PORT. */
#define PDMINTERFACE_HOST_PARALLEL_CONNECTOR "a03567ca-b29e-4a1b-b2f3-a12435fa2982"
/** PDMISCSIPORT - The SCSI command execution port interface (Down) Coupled with PDMINTERFACE_SCSI_CONNECTOR. */
#define PDMINTERFACE_SCSI_PORT "0f894add-714d-4a77-818e-a32fe3586ba4"
/** PDMISCSICONNECTOR - The SCSI command execution connector interface (Up) Coupled with PDMINTERFACE_SCSI_PORT. */
#define PDMINTERFACE_SCSI_CONNECTOR "94465fbd-a2f2-447e-88c9-7366421bfbfe"
/** PDMDDISPLAYVBVACALLBACKS - The Display VBVA callbacks. */
#define PDMINTERFACE_DISPLAY_VBVA_CALLBACKS "b78b81d2-c821-4e66-96ff-dbafa76343a5"
/** @} */
/**
* PDM Driver Base Interface.
*
* Everyone implements this.
*/
typedef struct PDMIBASE
{
/**
* Queries an interface to the driver.
*
* @returns Pointer to interface.
* @returns NULL if the interface was not supported by the driver.
* @param pInterface Pointer to this interface structure.
* @param pszIID The interface ID, a UUID string.
* @thread Any thread.
*/
} PDMIBASE;
/** PDMIBASE interface ID. */
#define PDMIBASE_IID "a2299c0d-b709-4551-aa5a-73f59ffbed74"
/**
* Dummy interface.
*
* This is used to typedef other dummy interfaces. The purpose of a dummy
* full a natural interface pair.
*/
typedef struct PDMIDUMMY
{
} PDMIDUMMY;
/** Pointer to a mouse port interface. */
typedef struct PDMIMOUSEPORT *PPDMIMOUSEPORT;
/**
* Mouse port interface.
* Pair with PDMIMOUSECONNECTOR.
*/
typedef struct PDMIMOUSEPORT
{
/**
* Puts a mouse event.
* This is called by the source of mouse events. The event will be passed up until the
* topmost driver, which then calls the registered event handler.
*
* @returns VBox status code.
* @param pInterface Pointer to this interface structure.
* @param i32DeltaX The X delta.
* @param i32DeltaY The Y delta.
* @param i32DeltaZ The Z delta.
* @param i32DeltaW The W (horizontal scroll button) delta.
* @param fButtonStates The button states, see the PDMIMOUSEPORT_BUTTON_* \#defines.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnPutEvent,(PPDMIMOUSEPORT pInterface, int32_t i32DeltaX, int32_t i32DeltaY, int32_t i32DeltaZ, int32_t i32DeltaW, uint32_t fButtonStates));
/** Mouse button defines for PDMIMOUSEPORT::pfnPutEvent.
* @{ */
#define PDMIMOUSEPORT_BUTTON_LEFT RT_BIT(0)
/** @} */
/**
* Mouse connector interface.
* Pair with PDMIMOUSEPORT.
*/
typedef PDMIDUMMY PDMIMOUSECONNECTOR;
/** Pointer to a mouse connector interface. */
typedef PDMIMOUSECONNECTOR *PPDMIMOUSECONNECTOR;
/** Pointer to a keyboard port interface. */
typedef struct PDMIKEYBOARDPORT *PPDMIKEYBOARDPORT;
/**
* Keyboard port interface.
* Pair with PDMIKEYBOARDCONNECTOR.
*/
typedef struct PDMIKEYBOARDPORT
{
/**
* Puts a keyboard event.
* This is called by the source of keyboard events. The event will be passed up until the
* topmost driver, which then calls the registered event handler.
*
* @returns VBox status code.
* @param pInterface Pointer to this interface structure.
* @param u8KeyCode The keycode to queue.
* @thread The emulation thread.
*/
/**
* Keyboard LEDs.
*/
typedef enum PDMKEYBLEDS
{
/** No leds. */
PDMKEYBLEDS_NONE = 0x0000,
/** Num Lock */
PDMKEYBLEDS_NUMLOCK = 0x0001,
/** Caps Lock */
PDMKEYBLEDS_CAPSLOCK = 0x0002,
/** Scroll Lock */
PDMKEYBLEDS_SCROLLLOCK = 0x0004
} PDMKEYBLEDS;
/** Pointer to keyboard connector interface. */
typedef struct PDMIKEYBOARDCONNECTOR *PPDMIKEYBOARDCONNECTOR;
/**
* Keyboard connector interface.
* Pair with PDMIKEYBOARDPORT
*/
typedef struct PDMIKEYBOARDCONNECTOR
{
/**
* Notifies the the downstream driver about an LED change initiated by the guest.
*
* @param pInterface Pointer to the this interface.
* @param enmLeds The new led mask.
*/
DECLR3CALLBACKMEMBER(void, pfnLedStatusChange,(PPDMIKEYBOARDCONNECTOR pInterface, PDMKEYBLEDS enmLeds));
/** Pointer to a display port interface. */
typedef struct PDMIDISPLAYPORT *PPDMIDISPLAYPORT;
/**
* Display port interface.
* Pair with PDMIDISPLAYCONNECTOR.
*/
typedef struct PDMIDISPLAYPORT
{
/**
* Update the display with any changed regions.
*
* Flushes any display changes to the memory pointed to by the
* PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect()
* while doing so.
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @thread The emulation thread.
*/
/**
* Update the entire display.
*
* Flushes the entire display content to the memory pointed to by the
* PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect().
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @thread The emulation thread.
*/
/**
* Return the current guest color depth in bits per pixel (bpp).
*
* As the graphics card is able to provide display updates with the bpp
* requested by the host, this method can be used to query the actual
* guest color depth.
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param pcBits Where to store the current guest color depth.
* @thread Any thread.
*/
/**
* Sets the refresh rate and restart the timer.
* The rate is defined as the minimum interval between the return of
* one PDMIDISPLAYPORT::pfnRefresh() call to the next one.
*
* The interval timer will be restarted by this call. So at VM startup
* this function must be called to start the refresh cycle. The refresh
* rate is not saved, but have to be when resuming a loaded VM state.
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param cMilliesInterval Number of millies between two refreshes.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetRefreshRate,(PPDMIDISPLAYPORT pInterface, uint32_t cMilliesInterval));
/**
* Create a 32-bbp screenshot of the display.
*
* This will allocate and return a 32-bbp bitmap. Size of the bitmap scanline in bytes is 4*width.
*
* The allocated bitmap buffer must be freed with pfnFreeScreenshot.
*
* @param pInterface Pointer to this interface.
* @param ppu8Data Where to store the pointer to the allocated buffer.
* @param pcbData Where to store the actual size of the bitmap.
* @param pcx Where to store the width of the bitmap.
* @param pcy Where to store the height of the bitmap.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnTakeScreenshot,(PPDMIDISPLAYPORT pInterface, uint8_t **ppu8Data, size_t *pcbData, uint32_t *pcx, uint32_t *pcy));
/**
* Free screenshot buffer.
*
* This will free the memory buffer allocated by pfnTakeScreenshot.
*
* @param pInterface Pointer to this interface.
* @param ppu8Data Pointer to the buffer returned by pfnTakeScreenshot.
* @thread Any.
*/
/**
* Copy bitmap to the display.
*
* This will convert and copy a 32-bbp bitmap (with dword aligned scanline length) to
* the memory pointed to by the PDMIDISPLAYCONNECTOR interface.
*
* @param pInterface Pointer to this interface.
* @param pvData Pointer to the bitmap bits.
* @param x The upper left corner x coordinate of the destination rectangle.
* @param y The upper left corner y coordinate of the destination rectangle.
* @param cx The width of the source and destination rectangles.
* @param cy The height of the source and destination rectangles.
* @thread The emulation thread.
* @remark This is just a convenience for using the bitmap conversions of the
* graphics device.
*/
DECLR3CALLBACKMEMBER(int, pfnDisplayBlt,(PPDMIDISPLAYPORT pInterface, const void *pvData, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy));
/**
* Render a rectangle from guest VRAM to Framebuffer.
*
* @param pInterface Pointer to this interface.
* @param x The upper left corner x coordinate of the rectangle to be updated.
* @param y The upper left corner y coordinate of the rectangle to be updated.
* @param cx The width of the rectangle to be updated.
* @param cy The height of the rectangle to be updated.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnUpdateDisplayRect,(PPDMIDISPLAYPORT pInterface, int32_t x, int32_t y, uint32_t cx, uint32_t cy));
/**
* Inform the VGA device whether the Display is directly using the guest VRAM and there is no need
* to render the VRAM to the framebuffer memory.
*
* @param pInterface Pointer to this interface.
* @param fRender Whether the VRAM content must be rendered to the framebuffer.
* @thread The emulation thread.
*/
typedef struct _VBOXVHWACMD *PVBOXVHWACMD; /**< @todo r=bird: _VBOXVHWACMD -> VBOXVHWACMD; avoid using 1 or 2 leading underscores. Also, a line what it is to make doxygen happy. */
typedef struct VBVACMDHDR *PVBVACMDHDR;
typedef struct VBVAINFOSCREEN *PVBVAINFOSCREEN;
typedef struct VBVAINFOVIEW *PVBVAINFOVIEW;
typedef struct VBVAHOSTFLAGS *PVBVAHOSTFLAGS;
/** Pointer to a display connector interface. */
typedef struct PDMIDISPLAYCONNECTOR *PPDMIDISPLAYCONNECTOR;
/**
* Display connector interface.
* Pair with PDMIDISPLAYPORT.
*/
typedef struct PDMIDISPLAYCONNECTOR
{
/**
* Resize the display.
* This is called when the resolution changes. This usually happens on
* request from the guest os, but may also happen as the result of a reset.
* If the callback returns VINF_VGA_RESIZE_IN_PROGRESS, the caller (VGA device)
* must not access the connector and return.
*
* @returns VINF_SUCCESS if the framebuffer resize was completed,
* VINF_VGA_RESIZE_IN_PROGRESS if resize takes time and not yet finished.
* @param pInterface Pointer to this interface.
* @param cBits Color depth (bits per pixel) of the new video mode.
* @param pvVRAM Address of the guest VRAM.
* @param cbLine Size in bytes of a single scan line.
* @param cx New display width.
* @param cy New display height.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnResize,(PPDMIDISPLAYCONNECTOR pInterface, uint32_t cBits, void *pvVRAM, uint32_t cbLine, uint32_t cx, uint32_t cy));
/**
* Update a rectangle of the display.
* PDMIDISPLAYPORT::pfnUpdateDisplay is the caller.
*
* @param pInterface Pointer to this interface.
* @param x The upper left corner x coordinate of the rectangle.
* @param y The upper left corner y coordinate of the rectangle.
* @param cx The width of the rectangle.
* @param cy The height of the rectangle.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnUpdateRect,(PPDMIDISPLAYCONNECTOR pInterface, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy));
/**
* Refresh the display.
*
* The interval between these calls is set by
* PDMIDISPLAYPORT::pfnSetRefreshRate(). The driver should call
* PDMIDISPLAYPORT::pfnUpdateDisplay() if it wishes to refresh the
* display. PDMIDISPLAYPORT::pfnUpdateDisplay calls pfnUpdateRect with
* the changed rectangles.
*
* @param pInterface Pointer to this interface.
* @thread The emulation thread.
*/
/**
* Reset the display.
*
* Notification message when the graphics card has been reset.
*
* @param pInterface Pointer to this interface.
* @thread The emulation thread.
*/
/**
*
*
* @param pInterface Pointer to this interface.
* @param fEnabled false - LFB mode was disabled,
* true - an LFB mode was disabled
* @thread The emulation thread.
*/
/**
* Process the guest graphics adapter information.
*
* Direct notification from guest to the display connector.
*
* @param pInterface Pointer to this interface.
* @param pvVRAM Address of the guest VRAM.
* @param u32VRAMSize Size of the guest VRAM.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnProcessAdapterData, (PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, uint32_t u32VRAMSize));
/**
* Process the guest display information.
*
* Direct notification from guest to the display connector.
*
* @param pInterface Pointer to this interface.
* @param pvVRAM Address of the guest VRAM.
* @param uScreenId The index of the guest display to be processed.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnProcessDisplayData, (PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, unsigned uScreenId));
/**
* Process the guest Video HW Acceleration command.
*
* @param pInterface Pointer to this interface.
* @param pCmd Video HW Acceleration Command to be processed.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnVHWACommandProcess, (PPDMIDISPLAYCONNECTOR pInterface, PVBOXVHWACMD pCmd));
/**
* The specified screen enters VBVA mode.
*
* @param pInterface Pointer to this interface.
* @param uScreenId The screen updates are for.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnVBVAEnable,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, PVBVAHOSTFLAGS pHostFlags));
/**
* The specified screen leaves VBVA mode.
*
* @param pInterface Pointer to this interface.
* @param uScreenId The screen updates are for.
* @thread The emulation thread.
*/
/**
* A sequence of pfnVBVAUpdateProcess calls begins.
*
* @param pInterface Pointer to this interface.
* @param uScreenId The screen updates are for.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnVBVAUpdateBegin,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId));
/**
* Process the guest VBVA command.
*
* @param pInterface Pointer to this interface.
* @param pCmd Video HW Acceleration Command to be processed.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnVBVAUpdateProcess,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, const PVBVACMDHDR pCmd, size_t cbCmd));
/**
* A sequence of pfnVBVAUpdateProcess calls ends.
*
* @param pInterface Pointer to this interface.
* @param uScreenId The screen updates are for.
* @param x The upper left corner x coordinate of the combined rectangle of all VBVA updates.
* @param y The upper left corner y coordinate of the rectangle.
* @param cx The width of the rectangle.
* @param cy The height of the rectangle.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnVBVAUpdateEnd,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, int32_t x, int32_t y, uint32_t cx, uint32_t cy));
/**
* Resize the display.
* This is called when the resolution changes. This usually happens on
* request from the guest os, but may also happen as the result of a reset.
* If the callback returns VINF_VGA_RESIZE_IN_PROGRESS, the caller (VGA device)
* must not access the connector and return.
*
* @todo Merge with pfnResize.
*
* @returns VINF_SUCCESS if the framebuffer resize was completed,
* VINF_VGA_RESIZE_IN_PROGRESS if resize takes time and not yet finished.
* @param pInterface Pointer to this interface.
* @param pView The description of VRAM block for this screen.
* @param pScreen The data of screen being resized.
* @param pvVRAM Address of the guest VRAM.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnVBVAResize,(PPDMIDISPLAYCONNECTOR pInterface, const PVBVAINFOVIEW pView, const PVBVAINFOSCREEN pScreen, void *pvVRAM));
/**
* Update the pointer shape.
* This is called when the mouse pointer shape changes. The new shape
* is passed as a caller allocated buffer that will be freed after returning
*
* @param pInterface Pointer to this interface.
* @param fVisible Visibility indicator (if false, the other parameters are undefined).
* @param fAlpha Flag whether alpha channel is being passed.
* @param xHot Pointer hot spot x coordinate.
* @param yHot Pointer hot spot y coordinate.
* @param x Pointer new x coordinate on screen.
* @param y Pointer new y coordinate on screen.
* @param cx Pointer width in pixels.
* @param cy Pointer height in pixels.
* @param cbScanline Size of one scanline in bytes.
* @param pvShape New shape buffer.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnVBVAMousePointerShape,(PPDMIDISPLAYCONNECTOR pInterface, bool fVisible, bool fAlpha,
const void *pvShape));
/** Read-only attributes.
* For preformance reasons some readonly attributes are kept in the interface.
* We trust the interface users to respect the readonlyness of these.
* @{
*/
/** Pointer to the display data buffer. */
/** Size of a scanline in the data buffer. */
/** The color depth (in bits) the graphics card is supposed to provide. */
/** The display width. */
/** The display height. */
/** @} */
/**
* Block drive type.
*/
typedef enum PDMBLOCKTYPE
{
/** Error (for the query function). */
PDMBLOCKTYPE_ERROR = 1,
/** 360KB 5 1/4" floppy drive. */
/** 720KB 3 1/2" floppy drive. */
/** 1.2MB 5 1/4" floppy drive. */
/** 1.44MB 3 1/2" floppy drive. */
/** 2.88MB 3 1/2" floppy drive. */
/** CDROM drive. */
/** DVD drive. */
/** Hard disk drive. */
} PDMBLOCKTYPE;
/**
* Block raw command data transfer direction.
*/
typedef enum PDMBLOCKTXDIR
{
PDMBLOCKTXDIR_NONE = 0,
/**
* Block notify interface.
* Pair with PDMIBLOCK.
*/
typedef PDMIDUMMY PDMIBLOCKPORT;
/** Pointer to a block notify interface (dummy). */
typedef PDMIBLOCKPORT *PPDMIBLOCKPORT;
/** Pointer to a block interface. */
typedef struct PDMIBLOCK *PPDMIBLOCK;
/**
* Block interface.
* Pair with PDMIBLOCKPORT.
*/
typedef struct PDMIBLOCK
{
/**
* Read bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start reading from. The offset must be aligned to a sector boundary.
* @param pvBuf Where to store the read bits.
* @param cbRead Number of bytes to read. Must be aligned to a sector boundary.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIBLOCK pInterface, uint64_t off, void *pvBuf, size_t cbRead));
/**
* Write bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start writing at. The offset must be aligned to a sector boundary.
* @param pvBuf Where to store the write bits.
* @param cbWrite Number of bytes to write. Must be aligned to a sector boundary.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIBLOCK pInterface, uint64_t off, const void *pvBuf, size_t cbWrite));
/**
* Make sure that the bits written are actually on the storage medium.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Send a raw command to the underlying device (CDROM).
* This method is optional (i.e. the function pointer may be NULL).
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pbCmd Offset to start reading from.
* @param enmTxDir Direction of transfer.
* @param pvBuf Pointer tp the transfer buffer.
* @param cbBuf Size of the transfer buffer.
* @param pbSenseKey Status of the command (when return value is VERR_DEV_IO_ERROR).
* @param cTimeoutMillies Command timeout in milliseconds.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSendCmd,(PPDMIBLOCK pInterface, const uint8_t *pbCmd, PDMBLOCKTXDIR enmTxDir, void *pvBuf, uint32_t *pcbBuf, uint8_t *pabSense, size_t cbSense, uint32_t cTimeoutMillies));
/**
* Check if the media is readonly or not.
*
* @returns true if readonly.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Gets the media size in bytes.
*
* @returns Media size in bytes.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Gets the block drive type.
*
* @returns block drive type.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Gets the UUID of the block drive.
* Don't return the media UUID if it's removable.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pUuid Where to store the UUID on success.
* @thread Any thread.
*/
} PDMIBLOCK;
/** Pointer to a mount interface. */
typedef struct PDMIMOUNTNOTIFY *PPDMIMOUNTNOTIFY;
/**
* Block interface.
* Pair with PDMIMOUNT.
*/
typedef struct PDMIMOUNTNOTIFY
{
/**
* Called when a media is mounted.
*
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
/**
* Called when a media is unmounted
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
/* Pointer to mount interface. */
typedef struct PDMIMOUNT *PPDMIMOUNT;
/**
* Mount interface.
* Pair with PDMIMOUNTNOTIFY.
*/
typedef struct PDMIMOUNT
{
/**
* Mount a media.
*
* This will not unmount any currently mounted media!
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
* constructed a configuration which can be attached to the bottom driver.
* @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnMount,(PPDMIMOUNT pInterface, const char *pszFilename, const char *pszCoreDriver));
/**
* Unmount the media.
*
* The driver will validate and pass it on. On the rebounce it will decide whether or not to detach it self.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
* @param fForce Force the unmount, even for locked media.
* @thread The emulation thread.
*/
/**
* Checks if a media is mounted.
*
* @returns true if mounted.
* @returns false if not mounted.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Locks the media, preventing any unmounting of it.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
/**
* Unlocks the media, canceling previous calls to pfnLock().
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
/**
* Checks if a media is locked.
*
* @returns true if locked.
* @returns false if not locked.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Media geometry structure.
*/
typedef struct PDMMEDIAGEOMETRY
{
/** Number of cylinders. */
/** Number of heads. */
/** Number of sectors. */
/** Pointer to media geometry structure. */
typedef PDMMEDIAGEOMETRY *PPDMMEDIAGEOMETRY;
/** Pointer to constant media geometry structure. */
typedef const PDMMEDIAGEOMETRY *PCPDMMEDIAGEOMETRY;
/** Pointer to a media interface. */
typedef struct PDMIMEDIA *PPDMIMEDIA;
/**
* Media interface.
* Makes up the foundation for PDMIBLOCK and PDMIBLOCKBIOS.
*/
typedef struct PDMIMEDIA
{
/**
* Read bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start reading from. The offset must be aligned to a sector boundary.
* @param pvBuf Where to store the read bits.
* @param cbRead Number of bytes to read. Must be aligned to a sector boundary.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIMEDIA pInterface, uint64_t off, void *pvBuf, size_t cbRead));
/**
* Write bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start writing at. The offset must be aligned to a sector boundary.
* @param pvBuf Where to store the write bits.
* @param cbWrite Number of bytes to write. Must be aligned to a sector boundary.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIMEDIA pInterface, uint64_t off, const void *pvBuf, size_t cbWrite));
/**
* Make sure that the bits written are actually on the storage medium.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Get the media size in bytes.
*
* @returns Media size in bytes.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Check if the media is readonly or not.
*
* @returns true if readonly.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Get stored media geometry (physical CHS, PCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnBiosSetPCHSGeometry() yet.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnBiosGetPCHSGeometry,(PPDMIMEDIA pInterface, PPDMMEDIAGEOMETRY pPCHSGeometry));
/**
* Store the media geometry (physical CHS, PCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnBiosSetPCHSGeometry,(PPDMIMEDIA pInterface, PCPDMMEDIAGEOMETRY pPCHSGeometry));
/**
* Get stored media geometry (logical CHS, LCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnBiosSetLCHSGeometry() yet.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnBiosGetLCHSGeometry,(PPDMIMEDIA pInterface, PPDMMEDIAGEOMETRY pLCHSGeometry));
/**
* Store the media geometry (logical CHS, LCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnBiosSetLCHSGeometry,(PPDMIMEDIA pInterface, PCPDMMEDIAGEOMETRY pLCHSGeometry));
/**
* Gets the UUID of the media drive.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pUuid Where to store the UUID on success.
* @thread Any thread.
*/
} PDMIMEDIA;
/** Pointer to a block BIOS interface. */
typedef struct PDMIBLOCKBIOS *PPDMIBLOCKBIOS;
/**
* Media BIOS interface.
*/
typedef struct PDMIBLOCKBIOS
{
/**
* Get stored media geometry (physical CHS, PCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnSetPCHSGeometry() yet.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnGetPCHSGeometry,(PPDMIBLOCKBIOS pInterface, PPDMMEDIAGEOMETRY pPCHSGeometry));
/**
* Store the media geometry (physical CHS, PCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetPCHSGeometry,(PPDMIBLOCKBIOS pInterface, PCPDMMEDIAGEOMETRY pPCHSGeometry));
/**
* Get stored media geometry (logical CHS, LCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnSetLCHSGeometry() yet.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnGetLCHSGeometry,(PPDMIBLOCKBIOS pInterface, PPDMMEDIAGEOMETRY pLCHSGeometry));
/**
* Store the media geometry (logical CHS, LCHS) - BIOS property.
* This is an optional feature of a media.
*
* @returns VBox status code.
* @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetLCHSGeometry,(PPDMIBLOCKBIOS pInterface, PCPDMMEDIAGEOMETRY pLCHSGeometry));
/**
* Checks if the device should be visible to the BIOS or not.
*
* @returns true if the device is visible to the BIOS.
* @returns false if the device is not visible to the BIOS.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/**
* Gets the block drive type.
*
* @returns block drive type.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/** Pointer to a static block core driver interface. */
typedef struct PDMIMEDIASTATIC *PPDMIMEDIASTATIC;
/**
* Static block core driver interface.
*/
typedef struct PDMIMEDIASTATIC
{
/**
* Check if the specified file is a format which the core driver can handle.
*
* @returns true / false accordingly.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pszFilename Name of the file to probe.
*/
/**
* iSCSI Request PDU buffer (gather).
*/
typedef struct ISCSIREQ
{
/** Length of PDU segment in bytes. */
/** Pointer to PDU segment. */
const void *pcvSeg;
} ISCSIREQ;
/** Pointer to an iSCSI Request PDU buffer. */
/** Pointer to a const iSCSI Request PDU buffer. */
typedef ISCSIREQ const *PCISCSIREQ;
/**
* iSCSI Response PDU buffer (scatter).
*/
typedef struct ISCSIRES
{
/** Length of PDU segment. */
/** Pointer to PDU segment. */
void *pvSeg;
} ISCSIRES;
/** Pointer to an iSCSI Response PDU buffer. */
/** Pointer to a const iSCSI Response PDU buffer. */
typedef ISCSIRES const *PCISCSIRES;
/** Pointer to an iSCSI transport driver interface. */
typedef struct PDMIISCSITRANSPORT *PPDMIISCSITRANSPORT;
/**
* iSCSI transport driver interface.
*/
typedef struct PDMIISCSITRANSPORT
{
/**
* Read bytes from an iSCSI transport stream. If the connection fails, it is automatically
* reopened on the next call after the error is signalled. Error recovery in this case is
* the duty of the caller.
*
* @returns VBox status code.
* @param pTransport Pointer to the interface structure containing the called function pointer.
* @param paResponses Array of scatter segments.
* @param cResponses The number of segments.
* @thread Any thread.
* @todo Correct the docs.
*/
DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIISCSITRANSPORT pTransport, PISCSIRES paResponses, unsigned cResponses));
/**
* Write bytes to an iSCSI transport stream. Padding is performed when necessary. If the connection
* fails, it is automatically reopened on the next call after the error is signalled. Error recovery
* in this case is the duty of the caller.
*
* @returns VBox status code.
* @param pTransport Pointer to the interface structure containing the called function pointer.
* @param paRequests Array of gather segments.
* @param cRequests The number of segments.
* @thread Any thread.
* @todo Correct the docs.
*/
DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIISCSITRANSPORT pTransport, PISCSIREQ paRequests, unsigned cRequests));
/**
* Open the iSCSI transport stream.
*
* @returns VBox status code.
* @param pTransport Pointer to the interface structure containing the called function pointer.
* @param pszTargetAddress Pointer to string of the format address:port.
* @thread Any thread.
*/
/**
* Close the iSCSI transport stream.
*
* @returns VBox status code.
* @param pTransport Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/** Pointer to an asynchronous iSCSI transport driver interface. */
typedef struct PDMIISCSITRANSPORTASYNC *PPDMIISCSITRANSPORTASYNC;
/**
* Asynchronous iSCSI transport driver interface.
*/
typedef struct PDMIISCSITRANSPORTASYNC
{
/**
* Start an asynchronous read request from an iSCSI transport stream. Padding is performed when necessary.
*
* @returns VBox status code.
* @param pTransport Pointer to the interface structure containing the called function pointer.
* @param paResponses Pointer to a array of scatter segments.
* @param cResponses Number of segments in the array.
* @param pvUser User argument which is returned in completion callback.
* @thread EMT thread.
*/
DECLR3CALLBACKMEMBER(int, pfnStartRead,(PPDMIISCSITRANSPORTASYNC pTransport, PISCSIRES paResponses, unsigned cResponses, void *pvUser));
/**
* Start an asychronous write to an iSCSI transport stream. Padding is performed when necessary.
*
* @returns VBox status code.
* @param pTransport Pointer to the interface structure containing the called function pointer.
* @param paRequests Pointer to a array of gather segments.
* @param cRequests Number of segments in the array.
* @param pvUser User argument which is returned in completion callback.
* @thread EMT thread.
*/
DECLR3CALLBACKMEMBER(int, pfnStartWrite,(PPDMIISCSITRANSPORTASYNC pTransport, PISCSIREQ pRequests, unsigned cRequests, void *pvUser));
/** Pointer to a asynchronous iSCSI transport notify interface. */
typedef struct PDMIISCSITRANSPORTASYNCPORT *PPDMIISCSITRANSPORTASYNCPORT;
/**
* Asynchronous iSCSI transport notify interface.
* Pair with PDMIISCSITRANSPORTASYNC.
*/
typedef struct PDMIISCSITRANSPORTASYNCPORT
{
/**
* Notify completion of a read task.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param paResponses Pointer to a array of scatter segments.
* @param cResponses Number of segments in the array.
* @param pvUser The user argument given in pfnStartRead.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnReadCompleteNotify, (PPDMIISCSITRANSPORTASYNCPORT pInterface, PISCSIRES paResponses, unsigned cResponse, void *pvUser));
/**
* Notify completion of a write task.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param paRequests Pointer to a array of gather segments.
* @param cRequests Number of segments in the array.
* @param pvUser The user argument given in pfnStartWrite.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnWriteCompleteNotify, (PPDMIISCSITRANSPORTASYNCPORT pTransport, PISCSIREQ paRequests, unsigned cRequests, void *pvUser));
/** Pointer to a asynchronous block notify interface. */
typedef struct PDMIBLOCKASYNCPORT *PPDMIBLOCKASYNCPORT;
/**
* Asynchronous block notify interface.
* Pair with PDMIBLOCKASYNC.
*/
typedef struct PDMIBLOCKASYNCPORT
{
/**
* Notify completion of a asynchronous transfer.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvUser The user argument given in pfnStartWrite/Read.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnTransferCompleteNotify, (PPDMIBLOCKASYNCPORT pInterface, void *pvUser));
/** Pointer to a asynchronous block interface. */
typedef struct PDMIBLOCKASYNC *PPDMIBLOCKASYNC;
/**
* Asynchronous block interface.
* Pair with PDMIBLOCKASYNCPORT.
*/
typedef struct PDMIBLOCKASYNC
{
/**
* Start reading task.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start reading from.c
* @param pSeg Pointer to the first element in the scatter list.
* @param cSeg Number of entries in the list.
* @param cbRead Number of bytes to read. Must be aligned to a sector boundary.
* @param pvUser User argument which is returned in completion callback.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnStartRead,(PPDMIBLOCKASYNC pInterface, uint64_t off, PPDMDATASEG pSeg, unsigned cSeg, size_t cbRead, void *pvUser));
/**
* Write bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start writing at. The offset must be aligned to a sector boundary.
* @param pSeg Pointer to the first element in the gather list.
* @param cSeg Number of entries in the list.
* @param cbWrite Number of bytes to write. Must be aligned to a sector boundary.
* @param pvUser User argument which is returned in completion callback.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnStartWrite,(PPDMIBLOCKASYNC pInterface, uint64_t off, PPDMDATASEG pSeg, unsigned cSeg, size_t cbWrite, void *pvUser));
/** Pointer to a asynchronous notification interface. */
typedef struct PDMIMEDIAASYNCPORT *PPDMIMEDIAASYNCPORT;
/**
* Asynchronous media interface.
* Makes up the fundation for PDMIBLOCKASYNC and PDMIBLOCKBIOS.
*/
typedef struct PDMIMEDIAASYNCPORT
{
/**
* Notify completion of a task.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvUser The user argument given in pfnStartWrite.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnTransferCompleteNotify, (PPDMIMEDIAASYNCPORT pInterface, void *pvUser));
/** Pointer to a asynchronous media interface. */
typedef struct PDMIMEDIAASYNC *PPDMIMEDIAASYNC;
/**
* Asynchronous media interface.
* Makes up the fundation for PDMIBLOCKASYNC and PDMIBLOCKBIOS.
*/
typedef struct PDMIMEDIAASYNC
{
/**
* Start reading task.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start reading from. Must be aligned to a sector boundary.
* @param pSeg Pointer to the first element in the scatter list.
* @param cSeg Number of entries in the list.
* @param cbRead Number of bytes to read. Must be aligned to a sector boundary.
* @param pvUser User data.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnStartRead,(PPDMIMEDIAASYNC pInterface, uint64_t off, PPDMDATASEG pSeg, unsigned cSeg, size_t cbRead, void *pvUser));
/**
* Start writing task.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param off Offset to start writing at. Must be aligned to a sector boundary.
* @param pSeg Pointer to the first element in the gather list.
* @param cSeg Number of entries in the list.
* @param cbWrite Number of bytes to write. Must be aligned to a sector boundary.
* @param pvUser User data.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnStartWrite,(PPDMIMEDIAASYNC pInterface, uint64_t off, PPDMDATASEG pSeg, unsigned cSeg, size_t cbWrite, void *pvUser));
/** @name Bit mask definitions for status line type
* @{ */
#define PDM_ICHAR_STATUS_LINES_DCD RT_BIT(0)
/** @} */
/** Pointer to a char port interface. */
typedef struct PDMICHARPORT *PPDMICHARPORT;
/**
* Char port interface.
* Pair with PDMICHAR.
*/
typedef struct PDMICHARPORT
{
/**
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Where the read bits are stored.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnNotifyRead,(PPDMICHARPORT pInterface, const void *pvBuf, size_t *pcbRead));
/**
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param fNewStatusLine New state of the status line pins.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnNotifyStatusLinesChanged,(PPDMICHARPORT pInterface, uint32_t fNewStatusLines));
/**
*
* @returns VBox statsus code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
} PDMICHARPORT;
/** Pointer to a char interface. */
/**
* Char interface.
* Pair with PDMICHARPORT.
*/
typedef struct PDMICHAR
{
/**
* Write bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Where to store the write bits.
* @param cbWrite Number of bytes to write.
* @thread Any thread.
*/
/**
* Set device parameters.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param Bps Speed of the serial connection. (bits per second)
* @param chParity Parity method: 'E' - even, 'O' - odd, 'N' - none.
* @param cDataBits Number of data bits.
* @param cStopBits Number of stop bits.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetParameters,(PPDMICHAR pInterface, unsigned Bps, char chParity, unsigned cDataBits, unsigned cStopBits));
/**
* Set the state of the modem lines.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param fRequestToSend Set to true to make the Request to Send line active otherwise to 0.
* @param fDataTerminalReady Set to true to make the Data Terminal Ready line active otherwise 0.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetModemLines,(PPDMICHAR pInterface, bool fRequestToSend, bool fDataTerminalReady));
/**
* Sets the TD line into break condition.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param fBreak Set to true to let the device send a break false to put into normal operation.
* @thread Any thread.
*/
} PDMICHAR;
/** Pointer to a stream interface. */
typedef struct PDMISTREAM *PPDMISTREAM;
/**
* Stream interface.
* Makes up the foundation for PDMICHAR.
*/
typedef struct PDMISTREAM
{
/**
* Read bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Where to store the read bits.
* @thread Any thread.
*/
/**
* Write bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Where to store the write bits.
* @thread Any thread.
*/
} PDMISTREAM;
/** Mode of the parallel port */
typedef enum PDMPARALLELPORTMODE
{
/** Pointer to a host parallel port interface. */
typedef struct PDMIHOSTPARALLELPORT *PPDMIHOSTPARALLELPORT;
/**
* Host parallel port interface.
* Pair with PDMIHOSTPARALLELCONNECTOR.
*/
typedef struct PDMIHOSTPARALLELPORT
{
/**
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Where the read bits are stored.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnNotifyRead,(PPDMIHOSTPARALLELPORT pInterface, const void *pvBuf, size_t *pcbRead));
/**
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread Any thread.
*/
/** Pointer to a Host Parallel connector interface. */
typedef struct PDMIHOSTPARALLELCONNECTOR *PPDMIHOSTPARALLELCONNECTOR;
/**
* Host parallel connector interface
* Pair with PDMIHOSTPARALLELPORT.
*/
typedef struct PDMIHOSTPARALLELCONNECTOR
{
/**
* Write bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Where to store the write bits.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIHOSTPARALLELCONNECTOR pInterface, const void *pvBuf, size_t *pcbWrite));
/**
* Read bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Where to store the read bits.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIHOSTPARALLELCONNECTOR pInterface, void *pvBuf, size_t *pcbRead));
/**
* Write control register bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param fReg The new control register value.
* @thread Any thread.
*/
/**
* Read control register bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pfReg Where to store the control register bits.
* @thread Any thread.
*/
/**
* Read status register bits.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pfReg Where to store the status register bits.
* @thread Any thread.
*/
/**
* Set mode of the host parallel port.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param enmMode The mode of the host parallel port.
* @thread Any thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetMode,(PPDMIHOSTPARALLELCONNECTOR pInterface, PDMPARALLELPORTMODE enmMode));
/** ACPI power source identifier */
typedef enum PDMACPIPOWERSOURCE
{
/** Pointer to ACPI battery state. */
typedef PDMACPIPOWERSOURCE *PPDMACPIPOWERSOURCE;
/** ACPI battey capacity */
typedef enum PDMACPIBATCAPACITY
{
PDM_ACPI_BAT_CAPACITY_MAX = 100,
/** Pointer to ACPI battery capacity. */
typedef PDMACPIBATCAPACITY *PPDMACPIBATCAPACITY;
/** ACPI battery state. See ACPI 3.0 spec '_BST (Battery Status)' */
typedef enum PDMACPIBATSTATE
{
PDM_ACPI_BAT_STATE_CHARGED = 0x00,
PDM_ACPI_BAT_STATE_DISCHARGING = 0x01,
PDM_ACPI_BAT_STATE_CHARGING = 0x02,
PDM_ACPI_BAT_STATE_CRITICAL = 0x04
/** Pointer to ACPI battery state. */
typedef PDMACPIBATSTATE *PPDMACPIBATSTATE;
/** Pointer to an ACPI port interface. */
typedef struct PDMIACPIPORT *PPDMIACPIPORT;
/**
* ACPI port interface.
*/
typedef struct PDMIACPIPORT
{
/**
* Send an ACPI power off event.
*
* @returns VBox status code
* @param pInterface Pointer to the interface structure containing the called function pointer.
*/
/**
* Send an ACPI sleep button event.
*
* @returns VBox status code
* @param pInterface Pointer to the interface structure containing the called function pointer.
*/
/**
* Check if the last power button event was handled by the guest.
*
* @returns VBox status code
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pfHandled Is set to true if the last power button event was handled, false otherwise.
*/
/**
* Check if the guest entered the ACPI mode.
*
* @returns VBox status code
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pfEnabled Is set to true if the guest entered the ACPI mode, false otherwise.
*/
/**
* Check if the given CPU is still locked by the guest.
*
* @returns VBox status code
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param uCpu The CPU to check for.
* @param pfLocked Is set to true if the CPU is still locked by the guest, false otherwise.
*/
DECLR3CALLBACKMEMBER(int, pfnGetCpuStatus,(PPDMIACPIPORT pInterface, unsigned uCpu, bool *pfLocked));
} PDMIACPIPORT;
/** Pointer to an ACPI connector interface. */
typedef struct PDMIACPICONNECTOR *PPDMIACPICONNECTOR;
/**
* ACPI connector interface.
*/
typedef struct PDMIACPICONNECTOR
{
/**
* Get the current power source of the host system.
*
* @returns VBox status code
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param penmPowerSource Pointer to the power source result variable.
*/
DECLR3CALLBACKMEMBER(int, pfnQueryPowerSource,(PPDMIACPICONNECTOR, PPDMACPIPOWERSOURCE penmPowerSource));
/**
* Query the current battery status of the host system.
*
* @returns VBox status code?
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pfPresent Is set to true if battery is present, false otherwise.
* @param penmRemainingCapacity Pointer to the battery remaining capacity (0 - 100 or 255 for unknown).
* @param penmBatteryState Pointer to the battery status.
* @param pu32PresentRate Pointer to the present rate (0..1000 of the total capacity).
*/
DECLR3CALLBACKMEMBER(int, pfnQueryBatteryStatus,(PPDMIACPICONNECTOR, bool *pfPresent, PPDMACPIBATCAPACITY penmRemainingCapacity,
/** Pointer to a VMMDevice port interface. */
typedef struct PDMIVMMDEVPORT *PPDMIVMMDEVPORT;
/**
* VMMDevice port interface.
*/
typedef struct PDMIVMMDEVPORT
{
/**
* Return the current absolute mouse position in pixels
*
* @returns VBox status code
* @param pAbsX Pointer of result value, can be NULL
* @param pAbsY Pointer of result value, can be NULL
*/
DECLR3CALLBACKMEMBER(int, pfnQueryAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t *pAbsX, uint32_t *pAbsY));
/**
* Set the new absolute mouse position in pixels
*
* @returns VBox status code
* @param absX New absolute X position
* @param absY New absolute Y position
*/
DECLR3CALLBACKMEMBER(int, pfnSetAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t absX, uint32_t absY));
/**
* Return the current mouse capability flags
*
* @returns VBox status code
* @param pCapabilities Pointer of result value
*/
DECLR3CALLBACKMEMBER(int, pfnQueryMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t *pCapabilities));
/**
* Set the current mouse capability flag (host side)
*
* @returns VBox status code
* @param capabilities Capability mask
*/
DECLR3CALLBACKMEMBER(int, pfnSetMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t capabilities));
/**
* Issue a display resolution change request.
*
* Note that there can only one request in the queue and that in case the guest does
* not process it, issuing another request will overwrite the previous.
*
* @returns VBox status code
* @param cx Horizontal pixel resolution (0 = do not change).
* @param cy Vertical pixel resolution (0 = do not change).
* @param cBits Bits per pixel (0 = do not change).
* @param display The display index.
*/
DECLR3CALLBACKMEMBER(int, pfnRequestDisplayChange,(PPDMIVMMDEVPORT pInterface, uint32_t cx, uint32_t cy, uint32_t cBits, uint32_t display));
/**
* Pass credentials to guest.
*
* Note that there can only be one set of credentials and the guest may or may not
* query them and may do whatever it wants with them.
*
* @returns VBox status code.
* @param pszUsername User name, may be empty (UTF-8).
* @param pszPassword Password, may be empty (UTF-8).
* @param pszDomain Domain name, may be empty (UTF-8).
* @param fFlags VMMDEV_SETCREDENTIALS_*.
*/
const char *pszPassword, const char *pszDomain,
/**
* Notify the driver about a VBVA status change.
*
* @returns Nothing. Because it is informational callback.
* @param fEnabled Current VBVA status.
*/
/**
* Issue a seamless mode change request.
*
* Note that there can only one request in the queue and that in case the guest does
* not process it, issuing another request will overwrite the previous.
*
* @returns VBox status code
* @param fEnabled Seamless mode enabled or not
*/
/**
* Issue a memory balloon change request.
*
* Note that there can only one request in the queue and that in case the guest does
* not process it, issuing another request will overwrite the previous.
*
* @returns VBox status code
* @param ulBalloonSize Balloon size in megabytes
*/
DECLR3CALLBACKMEMBER(int, pfnSetMemoryBalloon,(PPDMIVMMDEVPORT pInterface, uint32_t ulBalloonSize));
/**
* Issue a statistcs interval change request.
*
* Note that there can only one request in the queue and that in case the guest does
* not process it, issuing another request will overwrite the previous.
*
* @returns VBox status code
* @param ulStatInterval Statistics query interval in seconds (0=disable)
*/
DECLR3CALLBACKMEMBER(int, pfnSetStatisticsInterval,(PPDMIVMMDEVPORT pInterface, uint32_t ulStatInterval));
/**
* Notify the guest about a VRDP status change.
*
* @returns VBox status code
* @param fVRDPEnabled Current VRDP status.
* @param u32VRDPExperienceLevel Which visual effects to be disabled in the guest.
*/
DECLR3CALLBACKMEMBER(int, pfnVRDPChange, (PPDMIVMMDEVPORT pInterface, bool fVRDPEnabled, uint32_t u32VRDPExperienceLevel));
/**
* Notify the guest of CPU hot-unplug event.
*
* @returns VBox status code
* @param idCpuCore The core id of the CPU to remove.
* @param idCpuPackage The package id of the CPU to remove.
*/
DECLR3CALLBACKMEMBER(int, pfnCpuHotUnplug, (PPDMIVMMDEVPORT pInterface, uint32_t idCpuCore, uint32_t idCpuPackage));
/**
* Notify the guest of CPU hot-plug event.
*
* @returns VBox status code
* @param idCpuCore The core id of the CPU to add.
* @param idCpuPackage The package id of the CPU to add.
*/
DECLR3CALLBACKMEMBER(int, pfnCpuHotPlug, (PPDMIVMMDEVPORT pInterface, uint32_t idCpuCore, uint32_t idCpuPackage));
/** @name Flags for PDMIVMMDEVPORT::pfnSetCredentials.
* @{ */
/** The guest should perform a logon with the credentials. */
#define VMMDEV_SETCREDENTIALS_GUESTLOGON RT_BIT(0)
/** The guest should prevent local logons. */
/** The guest should verify the credentials. */
/** @} */
/** Forward declaration of the video accelerator command memory. */
struct VBVAMEMORY;
/** Forward declaration of the guest information structure. */
struct VBoxGuestInfo;
/** Forward declaration of the guest statistics structure */
struct VBoxGuestStatistics;
/** Pointer to video accelerator command memory. */
typedef struct VBVAMEMORY *PVBVAMEMORY;
/** Pointer to a VMMDev connector interface. */
typedef struct PDMIVMMDEVCONNECTOR *PPDMIVMMDEVCONNECTOR;
/**
* VMMDev connector interface.
* Pair with PDMIVMMDEVPORT.
*/
typedef struct PDMIVMMDEVCONNECTOR
{
/**
* Report guest OS version.
* Called whenever the Additions issue a guest version report request.
*
* @param pInterface Pointer to this interface.
* @param pGuestInfo Pointer to guest information structure
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnUpdateGuestVersion,(PPDMIVMMDEVCONNECTOR pInterface, struct VBoxGuestInfo *pGuestInfo));
/**
* Update the guest additions capabilities.
* This is called when the guest additions capabilities change. The new capabilities
* are given and the connector should update its internal state.
*
* @param pInterface Pointer to this interface.
* @param newCapabilities New capabilities.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnUpdateGuestCapabilities,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities));
/**
* Update the mouse capabilities.
* This is called when the mouse capabilities change. The new capabilities
* are given and the connector should update its internal state.
*
* @param pInterface Pointer to this interface.
* @param newCapabilities New capabilities.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnUpdateMouseCapabilities,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities));
/**
* Update the pointer shape.
* This is called when the mouse pointer shape changes. The new shape
* is passed as a caller allocated buffer that will be freed after returning
*
* @param pInterface Pointer to this interface.
* @param fVisible Visibility indicator (if false, the other parameters are undefined).
* @param fAlpha Flag whether alpha channel is being passed.
* @param xHot Pointer hot spot x coordinate.
* @param yHot Pointer hot spot y coordinate.
* @param x Pointer new x coordinate on screen.
* @param y Pointer new y coordinate on screen.
* @param cx Pointer width in pixels.
* @param cy Pointer height in pixels.
* @param cbScanline Size of one scanline in bytes.
* @param pvShape New shape buffer.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnUpdatePointerShape,(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
void *pvShape));
/**
* Enable or disable video acceleration on behalf of guest.
*
* @param pInterface Pointer to this interface.
* @param fEnable Whether to enable acceleration.
* @param pVbvaMemory Video accelerator memory.
* @return VBox rc. VINF_SUCCESS if VBVA was enabled.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnVideoAccelEnable,(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, PVBVAMEMORY pVbvaMemory));
/**
* Force video queue processing.
*
* @param pInterface Pointer to this interface.
* @thread The emulation thread.
*/
/**
*
* @returns VBox status code
* @param pInterface Pointer to this interface.
* @param cy Video mode horizontal resolution in pixels.
* @param cx Video mode vertical resolution in pixels.
* @param cBits Video mode bits per pixel.
* @param pfSupported Where to put the indicator for whether this mode is supported. (output)
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnVideoModeSupported,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cx, uint32_t cy, uint32_t cBits, bool *pfSupported));
/**
* Queries by how many pixels the height should be reduced when calculating video modes
*
* @returns VBox status code
* @param pInterface Pointer to this interface.
* @param pcyReduction Pointer to the result value.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnGetHeightReduction,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcyReduction));
/**
* Informs about a credentials judgement result from the guest.
*
* @returns VBox status code
* @param pInterface Pointer to this interface.
* @param fFlags Judgement result flags.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetCredentialsJudgementResult,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t fFlags));
/**
* Set the visible region of the display
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param cRect Number of rectangles in pRect
* @param pRect Rectangle array
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnSetVisibleRegion,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect));
/**
* Query the visible region of the display
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param pcRect Number of rectangles in pRect
* @param pRect Rectangle array (set to NULL to query the number of rectangles)
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnQueryVisibleRegion,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRect, PRTRECT pRect));
/**
* Request the statistics interval
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param pulInterval Pointer to interval in seconds
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnQueryStatisticsInterval,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pulInterval));
/**
* Report new guest statistics
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param pGuestStats Guest statistics
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnReportStatistics,(PPDMIVMMDEVCONNECTOR pInterface, struct VBoxGuestStatistics *pGuestStats));
/**
* Inflate or deflate the memory balloon
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param fInflate Inflate or deflate
* @param cPages Number of physical pages (must be 256 as we allocate in 1 MB chunks)
* @param aPhysPage Array of physical page addresses
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnChangeMemoryBalloon, (PPDMIVMMDEVCONNECTOR pInterface, bool fInflate, uint32_t cPages, RTGCPHYS *aPhysPage));
/** Pointer to a network port interface */
typedef struct PDMINETWORKPORT *PPDMINETWORKPORT;
/**
* Network port interface.
*/
typedef struct PDMINETWORKPORT
{
/**
* Wait until there is space for receiving data. We do not care how much space is available
* because pfnReceive() will re-check and notify the guest if necessary.
*
* This function must be called before the pfnRecieve() method is called.
*
* @returns VBox status code. VINF_SUCCESS means there is at least one receive descriptor available.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param cMillies Number of milliseconds to wait. 0 means return immediately.
*/
DECLR3CALLBACKMEMBER(int, pfnWaitReceiveAvail,(PPDMINETWORKPORT pInterface, RTMSINTERVAL cMillies));
/**
* Receive data from the network.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf The available data.
* @param cb Number of bytes available in the buffer.
* @thread EMT
*/
/**
* Network link state.
*/
typedef enum PDMNETWORKLINKSTATE
{
/** Invalid state. */
/** The link is up. */
/** The link is down. */
/** The link is temporarily down while resuming. */
/** Pointer to a network connector interface */
typedef struct PDMINETWORKCONNECTOR *PPDMINETWORKCONNECTOR;
/**
* Network connector interface.
*/
typedef struct PDMINETWORKCONNECTOR
{
/**
* Send data to the network.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pvBuf Data to send.
* @param cb Number of bytes to send.
* @thread EMT
*/
DECLR3CALLBACKMEMBER(int, pfnSend,(PPDMINETWORKCONNECTOR pInterface, const void *pvBuf, size_t cb));
/**
* Set promiscuous mode.
*
* This is called when the promiscuous mode is set. This means that there doesn't have
* to be a mode change when it's called.
*
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param fPromiscuous Set if the adaptor is now in promiscuous mode. Clear if it is not.
* @thread EMT
*/
DECLR3CALLBACKMEMBER(void, pfnSetPromiscuousMode,(PPDMINETWORKCONNECTOR pInterface, bool fPromiscuous));
/**
* Notification on link status changes.
*
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param enmLinkState The new link state.
* @thread EMT
*/
DECLR3CALLBACKMEMBER(void, pfnNotifyLinkChanged,(PPDMINETWORKCONNECTOR pInterface, PDMNETWORKLINKSTATE enmLinkState));
/** @todo Add a callback that informs the driver chain about MAC address changes if we ever implement that. */
/** Pointer to a network config port interface */
typedef struct PDMINETWORKCONFIG *PPDMINETWORKCONFIG;
/**
* Network config port interface.
*/
typedef struct PDMINETWORKCONFIG
{
/**
* Gets the current Media Access Control (MAC) address.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param pMac Where to store the MAC address.
* @thread EMT
*/
/**
* Gets the new link state.
*
* @returns The current link state.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @thread EMT
*/
/**
* Sets the new link state.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param enmState The new link state
* @thread EMT
*/
DECLR3CALLBACKMEMBER(int, pfnSetLinkState,(PPDMINETWORKCONFIG pInterface, PDMNETWORKLINKSTATE enmState));
/** Pointer to a network connector interface */
typedef struct PDMIAUDIOCONNECTOR *PPDMIAUDIOCONNECTOR;
/**
* Audio connector interface.
*/
typedef struct PDMIAUDIOCONNECTOR
{
/* DECLR3CALLBACKMEMBER(int, pfnSetRecordSource,(PPDMIAUDIOINCONNECTOR pInterface, AUDIORECSOURCE)); */
/** @todo r=bird: the two following interfaces are hacks to work around the missing audio driver
* interface. This should be addressed rather than making more temporary hacks. */
/** Pointer to a Audio Sniffer Device port interface. */
typedef struct PDMIAUDIOSNIFFERPORT *PPDMIAUDIOSNIFFERPORT;
/**
* Audio Sniffer port interface.
*/
typedef struct PDMIAUDIOSNIFFERPORT
{
/**
* Enables or disables sniffing. If sniffing is being enabled also sets a flag
* whether the audio must be also left on the host.
*
* @returns VBox status code
* @param pInterface Pointer to this interface.
* @param fEnable 'true' for enable sniffing, 'false' to disable.
* @param fKeepHostAudio Indicates whether host audio should also present
* 'true' means that sound should not be played
* by the audio device.
*/
DECLR3CALLBACKMEMBER(int, pfnSetup,(PPDMIAUDIOSNIFFERPORT pInterface, bool fEnable, bool fKeepHostAudio));
/** Pointer to a Audio Sniffer connector interface. */
typedef struct PDMIAUDIOSNIFFERCONNECTOR *PPDMIAUDIOSNIFFERCONNECTOR;
/**
* Audio Sniffer connector interface.
* Pair with PDMIAUDIOSNIFFERPORT.
*/
typedef struct PDMIAUDIOSNIFFERCONNECTOR
{
/**
* AudioSniffer device calls this method when audio samples
* are about to be played and sniffing is enabled.
*
* @param pInterface Pointer to this interface.
* @param pvSamples Audio samples buffer.
* @param cSamples How many complete samples are in the buffer.
* @param iSampleHz The sample frequency in Hz.
* @param cChannels Number of channels. 1 for mono, 2 for stereo.
* @param cBits How many bits a sample for a single channel has. Normally 8 or 16.
* @param fUnsigned Whether samples are unsigned values.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnAudioSamplesOut,(PPDMIAUDIOSNIFFERCONNECTOR pInterface, void *pvSamples, uint32_t cSamples,
/**
* AudioSniffer device calls this method when output volume is changed.
*
* @param pInterface Pointer to this interface.
* @param u16LeftVolume 0..0xFFFF volume level for left channel.
* @param u16RightVolume 0..0xFFFF volume level for right channel.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(void, pfnAudioVolumeOut,(PPDMIAUDIOSNIFFERCONNECTOR pInterface, uint16_t u16LeftVolume, uint16_t u16RightVolume));
/**
* Generic status LED core.
* Note that a unit doesn't have to support all the indicators.
*/
typedef union PDMLEDCORE
{
/** 32-bit view. */
/** Bit view. */
struct
{
/** Busy indicator. */
/** Error indicator. */
} s;
} PDMLEDCORE;
/** LED bit masks for the u32 view.
* @{ */
#define PDMLED_READING RT_BIT(0)
/** Busy indicator. */
/** Error indicator. */
/** @} */
/**
* Generic status LED.
* Note that a unit doesn't have to support all the indicators.
*/
typedef struct PDMLED
{
/** Just a magic for sanity checking. */
/** The actual LED status.
* Only the device is allowed to change this. */
/** The asserted LED status which is cleared by the reader.
* The device will assert the bits but never clear them.
* The driver clears them as it sees fit. */
} PDMLED;
/** Pointer to an LED. */
/** Pointer to a const LED. */
#define PDMLED_MAGIC ( 0x11335577 )
/** Pointer to an LED ports interface. */
typedef struct PDMILEDPORTS *PPDMILEDPORTS;
/**
* Interface for exporting LEDs.
*/
typedef struct PDMILEDPORTS
{
/**
* Gets the pointer to the status LED of a unit.
*
* @returns VBox status code.
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param iLUN The unit which status LED we desire.
* @param ppLed Where to store the LED pointer.
*/
DECLR3CALLBACKMEMBER(int, pfnQueryStatusLed,(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed));
} PDMILEDPORTS;
/** Pointer to an LED connectors interface. */
typedef struct PDMILEDCONNECTORS *PPDMILEDCONNECTORS;
/**
* Interface for reading LEDs.
*/
typedef struct PDMILEDCONNECTORS
{
/**
* Notification about a unit which have been changed.
*
* The driver must discard any pointers to data owned by
* the unit and requery it.
*
* @param pInterface Pointer to the interface structure containing the called function pointer.
* @param iLUN The unit number.
*/
/** The special status unit number */
#define PDM_STATUS_LUN 999
#ifdef VBOX_WITH_HGCM
/** Abstract HGCM command structure. Used only to define a typed pointer. */
struct VBOXHGCMCMD;
/** Pointer to HGCM command structure. This pointer is unique and identifies
* the command being processed. The pointer is passed to HGCM connector methods,
* and must be passed back to HGCM port when command is completed.
*/
typedef struct VBOXHGCMCMD *PVBOXHGCMCMD;
/** Pointer to a HGCM port interface. */
typedef struct PDMIHGCMPORT *PPDMIHGCMPORT;
/**
* HGCM port interface. Normally implemented by VMMDev.
*/
typedef struct PDMIHGCMPORT
{
/**
* Notify the guest on a command completion.
*
* @param pInterface Pointer to this interface.
* @param rc The return code (VBox error code).
* @param pCmd A pointer that identifies the completed command.
*
* @returns VBox status code
*/
} PDMIHGCMPORT;
/** Pointer to a HGCM connector interface. */
typedef struct PDMIHGCMCONNECTOR *PPDMIHGCMCONNECTOR;
/** Pointer to a HGCM service location structure. */
typedef struct HGCMSERVICELOCATION *PHGCMSERVICELOCATION;
/**
* HGCM connector interface.
* Pair with PDMIHGCMPORT.
*/
typedef struct PDMIHGCMCONNECTOR
{
/**
* Locate a service and inform it about a client connection.
*
* @param pInterface Pointer to this interface.
* @param pCmd A pointer that identifies the command.
* @param pServiceLocation Pointer to the service location structure.
* @param pu32ClientID Where to store the client id for the connection.
* @return VBox status code.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnConnect,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, PHGCMSERVICELOCATION pServiceLocation, uint32_t *pu32ClientID));
/**
* Disconnect from service.
*
* @param pInterface Pointer to this interface.
* @param pCmd A pointer that identifies the command.
* @param u32ClientID The client id returned by the pfnConnect call.
* @return VBox status code.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnDisconnect,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID));
/**
* Process a guest issued command.
*
* @param pInterface Pointer to this interface.
* @param pCmd A pointer that identifies the command.
* @param u32ClientID The client id returned by the pfnConnect call.
* @param u32Function Function to be performed by the service.
* @param cParms Number of parameters in the array pointed to by paParams.
* @param paParms Pointer to an array of parameters.
* @return VBox status code.
* @thread The emulation thread.
*/
DECLR3CALLBACKMEMBER(int, pfnCall,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID, uint32_t u32Function,
#endif
/**
* Data direction.
*/
typedef enum PDMSCSIREQUESTTXDIR
{
PDMSCSIREQUESTTXDIR_UNKNOWN = 0x00,
PDMSCSIREQUESTTXDIR_FROM_DEVICE = 0x01,
PDMSCSIREQUESTTXDIR_TO_DEVICE = 0x02,
PDMSCSIREQUESTTXDIR_NONE = 0x03,
PDMSCSIREQUESTTXDIR_32BIT_HACK = 0x7fffffff
/**
* SCSI request structure.
*/
typedef struct PDMSCSIREQUEST
{
/** The logical unit. */
/** Direction of the data flow. */
/** Size of the SCSI CDB. */
/** Pointer to the SCSI CDB. */
/** Overall size of all scatter gather list elements
* for data transfer if any. */
/** Number of elements in the scatter gather list. */
/** Pointer to the head of the scatter gather list. */
/** Size of the sense buffer. */
/** Pointer to the sense buffer. *
* Current assumption that the sense buffer is not scattered. */
/** Opaque user data for use by the device. Left untouched by everything else! */
void *pvUser;
/** Pointer to a const SCSI request structure. */
typedef const PDMSCSIREQUEST *PCSCSIREQUEST;
/** Pointer to a SCSI port interface. */
typedef struct PDMISCSIPORT *PPDMISCSIPORT;
/**
* SCSI port interface.
* Pair with PDMISCSICONNECTOR.
*/
typedef struct PDMISCSIPORT
{
/**
* Notify the device on request completion.
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param pSCSIRequest Pointer to the finished SCSI request.
* @param rcCompletion SCSI_STATUS_* code for the completed request.
*/
DECLR3CALLBACKMEMBER(int, pfnSCSIRequestCompleted, (PPDMISCSIPORT pInterface, PPDMSCSIREQUEST pSCSIRequest, int rcCompletion));
} PDMISCSIPORT;
/** Pointer to a SCSI connector interface. */
typedef struct PDMISCSICONNECTOR *PPDMISCSICONNECTOR;
/**
* SCSI connector interface.
* Pair with PDMISCSIPORT.
*/
typedef struct PDMISCSICONNECTOR
{
/**
* Submits a SCSI request for execution.
*
* @returns VBox status code.
* @param pInterface Pointer to this interface.
* @param pSCSIRequest Pointer to the SCSI request to execute.
*/
DECLR3CALLBACKMEMBER(int, pfnSCSIRequestSend, (PPDMISCSICONNECTOR pInterface, PPDMSCSIREQUEST pSCSIRequest));
typedef struct PDMDDISPLAYVBVACALLBACKS *PPDMDDISPLAYVBVACALLBACKS;
/**
* Display VBVA callbacks.
*/
typedef struct PDMDDISPLAYVBVACALLBACKS
{
/**
* Informs guest about completion of processing the given Video HW Acceleration
* command, does not wait for the guest to process the command.
*
* @returns ???
* @param pInterface Pointer to this interface.
* @param pCmd The Video HW Acceleration Command that was
* completed.
* @todo r=bird: if asynch mean asyncronous; then
* fi
*/
DECLR3CALLBACKMEMBER(int, pfnVHWACommandCompleteAsynch, (PPDMDDISPLAYVBVACALLBACKS pInterface, PVBOXVHWACMD pCmd));
/** @} */
#endif