pdmifs.h revision aa32d4906f2f685992091893d5abdf27a2352a85
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * PDM - Pluggable Device Manager, Interfaces.
c6ade8a5a12fad69394e7223b7ea170bd729f0f4vboxsync * Copyright (C) 2006-2007 innotek GmbH
c6ade8a5a12fad69394e7223b7ea170bd729f0f4vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c6ade8a5a12fad69394e7223b7ea170bd729f0f4vboxsync * available from http://www.virtualbox.org. This file is free software;
c6ade8a5a12fad69394e7223b7ea170bd729f0f4vboxsync * you can redistribute it and/or modify it under the terms of the GNU
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * General Public License as published by the Free Software Foundation,
c6ade8a5a12fad69394e7223b7ea170bd729f0f4vboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
c6ade8a5a12fad69394e7223b7ea170bd729f0f4vboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** @defgroup grp_pdm_interfaces Interfaces
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @ingroup grp_pdm
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Driver interface identficators.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @remark All interfaces have to be declared here. There is no such thing as
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * private interface identifiers since they must be unique.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * That said, interface structures and other stuff can be put elsewhere,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * actually, it is best if this file is not flooded with structures that
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * could be put closer to home.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIBASE - The interface everyone supports. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIMOUSEPORT - The mouse port interface. (Down) Coupled with PDMINTERFACE_MOUSE_CONNECTOR. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIMOUSECONNECTOR - The mouse connector interface. (Up) Coupled with PDMINTERFACE_MOUSE_PORT. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIKEYBOARDPORT - The keyboard port interface. (Down) Coupled with PDMINTERFACE_KEYBOARD_CONNECTOR. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIKEYBOARDCONNECTOR - The keyboard connector interface. (Up) Coupled with PDMINTERFACE_KEYBOARD_PORT. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIDISPLAYPORT - The display port interface. (Down) Coupled with PDMINTERFACE_DISPLAY_CONNECTOR. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIDISPLAYCONNECTOR - The display connector interface. (Up) Coupled with PDMINTERFACE_DISPLAY_PORT. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMICHARPORT - The char notify interface. (Down) Coupled with PDMINTERFACE_CHAR. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMICHAR - The char driver interface. (Up) Coupled with PDMINTERFACE_CHAR_PORT. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMISTREAM - The stream driver interface (Up) No coupling.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Used by a char driver to implement PDMINTERFACE_CHAR. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIBLOCKPORT - The block notify interface (Down) Coupled with PDMINTERFACE_BLOCK. */
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync /** PDMIBLOCK - The block driver interface (Up) Coupled with PDMINTERFACE_BLOCK_PORT. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIBLOCKBIOS - The block bios interface. (External) */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** PDMIMOUNTNOTIFY - The mountable notification interface. (Down) Coupled with PDMINTERFACE_MOUNT. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** PDMIMOUNT - The mountable interface. (Up) Coupled with PDMINTERFACE_MOUNT_NOTIFY. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** PDMIMEDIA - The media interface. (Up) No coupling.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * Used by a block unit driver to implement PDMINTERFACE_BLOCK and PDMINTERFACE_BLOCK_BIOS. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** PDMIISCSITRANSPORT - The iSCSI transport interface (Up) No coupling.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * used by the iSCSI media driver. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** PDMINETWORKPORT - The network port interface. (Down) Coupled with PDMINTERFACE_NETWORK_CONNECTOR. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMINETWORKPORT - The network connector interface. (Up) Coupled with PDMINTERFACE_NETWORK_PORT. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMINETWORKCONFIG - The network configuartion interface. (Main) Used by the managment api. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIAUDIOCONNECTOR - The audio driver interface. (Up) No coupling. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIAUDIOSNIFFERPORT - The Audio Sniffer Device port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIAUDIOSNIFFERCONNECTOR - The Audio Sniffer Driver connector interface. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** PDMIVMMDEVPORT - The VMM Device port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIVMMDEVCONNECTOR - The VMM Device connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMILEDPORTS - The generic LED port interface. (Down) Coupled with PDMINTERFACE_LED_CONNECTORS. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMILEDCONNECTORS - The generic LED connector interface. (Up) Coupled with PDMINTERFACE_LED_PORTS. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIACPIPORT - ACPI port interface. (Down) Coupled with PDMINTERFACE_ACPI_CONNECTOR. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIACPICONNECTOR - ACPI connector interface. (Up) Coupled with PDMINTERFACE_ACPI_PORT. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** PDMIHGCMPORT - The Host-Guest communication manager port interface. Normally implemented by VMMDev. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** PDMIHGCMCONNECTOR - The Host-Guest communication manager connector interface. Normally implemented by Main::VMMDevInterface. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** VUSBIROOTHUBPORT - VUSB RootHub port interface. (Down) Coupled with PDMINTERFACE_USB_RH_CONNECTOR. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** VUSBIROOTHUBCONNECTOR - VUSB RootHub connector interface. (Up) Coupled with PDMINTERFACE_USB_RH_PORT. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** VUSBIRHCONFIG - VUSB RootHub configuration interface. (Main) Used by the managment api. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** VUSBROOTHUBCONNECTOR - VUSB Device interface. (Up) No coupling. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** PDMIHOSTDEVICEPORT - The Host Device port interface. (Down) Coupled with PDMINTERFACE_HOST_DEVICE_CONNECTOR. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** PDMIHOSTDEVICECONNECTOR - The Host device connector interface (Up) Coupled with PDMINTERFACE_HOST_DEVICE_PORT. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync /** Maximum interface number. */
c66e448632d5ef48cf6b896f02e750440f5c6586vboxsync * PDM Driver Base Interface.
c66e448632d5ef48cf6b896f02e750440f5c6586vboxsynctypedef struct PDMIBASE
c66e448632d5ef48cf6b896f02e750440f5c6586vboxsync * Queries an interface to the driver.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns Pointer to interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns NULL if the interface was not supported by the driver.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface structure.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param enmInterface The requested interface identification.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void *, pfnQueryInterface,(struct PDMIBASE *pInterface, PDMINTERFACE enmInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Dummy interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is used to typedef other dummy interfaces. The purpose of a dummy
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * interface is to validate the logical function of a driver/device and
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * full a natural interface pair.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIDUMMY
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a mouse port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Mouse port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIMOUSECONNECTOR.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Puts a mouse event.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This is called by the source of mouse events. The event will be passed up until the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * topmost driver, which then calls the registered event handler.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns VBox status code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pInterface Pointer to this interface structure.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param i32DeltaX The X delta.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param i32DeltaY The Y delta.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param i32DeltaZ The Z delta.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param fButtonStates The button states, see the PDMIMOUSEPORT_BUTTON_* \#defines.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnPutEvent,(PPDMIMOUSEPORT pInterface, int32_t i32DeltaX, int32_t i32DeltaY, int32_t i32DeltaZ, uint32_t fButtonStates));
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync/** Mouse button defines for PDMIMOUSEPORT::pfnPutEvent.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Mouse connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIMOUSEPORT.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** Pointer to a mouse connector interface. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/** Pointer to a keyboard port interface. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Keyboard port interface.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Pair with PDMIKEYBOARDCONNECTOR.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Puts a keyboard event.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This is called by the source of keyboard events. The event will be passed up until the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * topmost driver, which then calls the registered event handler.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns VBox status code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pInterface Pointer to this interface structure.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param u8KeyCode The keycode to queue.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @thread The emulation thread.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLR3CALLBACKMEMBER(int, pfnPutEvent,(PPDMIKEYBOARDPORT pInterface, uint8_t u8KeyCode));
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Keyboard LEDs.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** No leds. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** Num Lock */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** Caps Lock */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** Scroll Lock */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to keyboard connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIKEYBOARDCONNECTOR *PPDMIKEYBOARDCONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Keyboard connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIKEYBOARDPORT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Notifies the the downstream driver about an LED change initiated by the guest.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param enmLeds The new led mask.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnLedStatusChange,(PPDMIKEYBOARDCONNECTOR pInterface, PDMKEYBLEDS enmLeds));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a display port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Display port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIDISPLAYCONNECTOR.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Update the display with any changed regions.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Flushes any display changes to the memory pointed to by the
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect()
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * while doing so.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnUpdateDisplay,(PPDMIDISPLAYPORT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Update the entire display.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Flushes the entire display content to the memory pointed to by the
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect().
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnUpdateDisplayAll,(PPDMIDISPLAYPORT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Return the current guest color depth in bits per pixel (bpp).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * As the graphics card is able to provide display updates with the bpp
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * requested by the host, this method can be used to query the actual
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * guest color depth.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcBits Where to store the current guest color depth.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryColorDepth,(PPDMIDISPLAYPORT pInterface, uint32_t *pcBits));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Sets the refresh rate and restart the timer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * The rate is defined as the minimum interval between the return of
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * one PDMIDISPLAYPORT::pfnRefresh() call to the next one.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * The interval timer will be restarted by this call. So at VM startup
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * this function must be called to start the refresh cycle. The refresh
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * rate is not saved, but have to be when resuming a loaded VM state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cMilliesInterval Number of millies between two refreshes.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetRefreshRate,(PPDMIDISPLAYPORT pInterface, uint32_t cMilliesInterval));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Create a 32-bbp snapshot of the display.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This will create a 32-bbp bitmap with dword aligned scanline length. Because
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * of a wish for no locks in the graphics device, this must be called from the
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvData Pointer the buffer to copy the bits to.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbData Size of the buffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcx Where to store the width of the bitmap. (optional)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcy Where to store the height of the bitmap. (optional)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcbData Where to store the actual size of the bitmap. (optional)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSnapshot,(PPDMIDISPLAYPORT pInterface, void *pvData, size_t cbData, uint32_t *pcx, uint32_t *pcy, size_t *pcbData));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Copy bitmap to the display.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This will convert and copy a 32-bbp bitmap (with dword aligned scanline length) to
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * the memory pointed to by the PDMIDISPLAYCONNECTOR interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvData Pointer to the bitmap bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param x The upper left corner x coordinate of the destination rectangle.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param y The upper left corner y coordinate of the destination rectangle.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cx The width of the source and destination rectangles.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cy The height of the source and destination rectangles.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @remark This is just a convenience for using the bitmap conversions of the
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * graphics device.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnDisplayBlt,(PPDMIDISPLAYPORT pInterface, const void *pvData, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy));
de8636fc8bdeb02161ee5b329c407dd0c48b0885vboxsync * Render a rectangle from guest VRAM to Framebuffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param x The upper left corner x coordinate of the rectangle to be updated.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param y The upper left corner y coordinate of the rectangle to be updated.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cx The width of the rectangle to be updated.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cy The height of the rectangle to be updated.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUpdateDisplayRect,(PPDMIDISPLAYPORT pInterface, int32_t x, int32_t y, uint32_t cx, uint32_t cy));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Inform the VGA device whether the Display is directly using the guest VRAM and there is no need
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * to render the VRAM to the framebuffer memory.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fRender Whether the VRAM content must be rendered to the framebuffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnSetRenderVRAM,(PPDMIDISPLAYPORT pInterface, bool fRender));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a display connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIDISPLAYCONNECTOR *PPDMIDISPLAYCONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Display connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIDISPLAYPORT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Resize the display.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is called when the resolution changes. This usually happens on
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * request from the guest os, but may also happen as the result of a reset.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * If the callback returns VINF_VGA_RESIZE_IN_PROGRESS, the caller (VGA device)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * must not access the connector and return.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VINF_SUCCESS if the framebuffer resize was completed,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * VINF_VGA_RESIZE_IN_PROGRESS if resize takes time and not yet finished.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cBits Color depth (bits per pixel) of the new video mode.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvVRAM Address of the guest VRAM.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbLine Size in bytes of a single scan line.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cx New display width.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cy New display height.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnResize,(PPDMIDISPLAYCONNECTOR pInterface, uint32_t cBits, void *pvVRAM, uint32_t cbLine, uint32_t cx, uint32_t cy));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Update a rectangle of the display.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * PDMIDISPLAYPORT::pfnUpdateDisplay is the caller.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param x The upper left corner x coordinate of the rectangle.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param y The upper left corner y coordinate of the rectangle.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cx The width of the rectangle.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cy The height of the rectangle.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUpdateRect,(PPDMIDISPLAYCONNECTOR pInterface, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Refresh the display.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * The interval between these calls is set by
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * PDMIDISPLAYPORT::pfnSetRefreshRate(). The driver should call
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * PDMIDISPLAYPORT::pfnUpdateDisplay() if it wishes to refresh the
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * display. PDMIDISPLAYPORT::pfnUpdateDisplay calls pfnUpdateRect with
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * the changed rectangles.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnRefresh,(PPDMIDISPLAYCONNECTOR pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Reset the display.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Notification message when the graphics card has been reset.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnReset,(PPDMIDISPLAYCONNECTOR pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * LFB video mode enter/exit.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Notification message when LinearFrameBuffer video mode is enabled/disabled.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fEnabled false - LFB mode was disabled,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * true - an LFB mode was disabled
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLCALLBACKMEMBER(void, pfnLFBModeChange)(PPDMIDISPLAYCONNECTOR pInterface, bool fEnabled);
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Process the guest graphics adapter information.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Direct notification from guest to the display connector.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvVRAM Address of the guest VRAM.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param u32VRAMSize Size of the guest VRAM.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLCALLBACKMEMBER(void, pfnProcessAdapterData)(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, uint32_t u32VRAMSize);
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Process the guest display information.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Direct notification from guest to the display connector.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvVRAM Address of the guest VRAM.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param uScreenId The index of the guest display to be processed.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLCALLBACKMEMBER(void, pfnProcessDisplayData)(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, unsigned uScreenId);
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Read-only attributes.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * For preformance reasons some readonly attributes are kept in the interface.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * We trust the interface users to respect the readonlyness of these.
2b114c590cf5a19f8047cd7bde9c7e5ae00aa22bvboxsync /** Pointer to the display data buffer. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** Size of a scanline in the data buffer. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** The color depth (in bits) the graphics card is supposed to provide. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** The display width. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** The display height. */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Block drive type.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /** Error (for the query function). */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 360KB 5 1/4" floppy drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 720KB 3 1/2" floppy drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 1.2MB 5 1/4" floppy drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 1.44MB 3 1/2" floppy drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 2.88MB 3 1/2" floppy drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** CDROM drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** DVD drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Hard disk drive. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Block raw command data transfer direction.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Block notify interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIBLOCK.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a block notify interface (dummy). */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a block interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Block interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIBLOCKPORT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIBLOCK
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Read bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param off Offset to start reading from.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the read bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbRead Number of bytes to read.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIBLOCK pInterface, uint64_t off, void *pvBuf, size_t cbRead));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Write bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param off Offset to start writing at.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the write bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbWrite Number of bytes to write.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIBLOCK pInterface, uint64_t off, const void *pvBuf, size_t cbWrite));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Make sure that the bits written are actually on the storage medium.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnFlush,(PPDMIBLOCK pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Send a raw command to the underlying device (CDROM).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This method is optional (i.e. the function pointer may be NULL).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pbCmd Offset to start reading from.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param enmTxDir Direction of transfer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pvBuf Pointer tp the transfer buffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbBuf Size of the transfer buffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pbSenseKey Status of the command (when return value is VERR_DEV_IO_ERROR).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cTimeoutMillies Command timeout in milliseconds.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSendCmd,(PPDMIBLOCK pInterface, const uint8_t *pbCmd, PDMBLOCKTXDIR enmTxDir, void *pvBuf, size_t *pcbBuf, uint8_t *pbSenseKey, uint32_t cTimeoutMillies));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Check if the media is readonly or not.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns true if readonly.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns false if read/write.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @thread Any thread.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLR3CALLBACKMEMBER(bool, pfnIsReadOnly,(PPDMIBLOCK pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Gets the media size in bytes.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns Media size in bytes.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(uint64_t, pfnGetSize,(PPDMIBLOCK pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Gets the block drive type.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns block drive type.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(PDMBLOCKTYPE, pfnGetType,(PPDMIBLOCK pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Gets the UUID of the block drive.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Don't return the media UUID if it's removable.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pUuid Where to store the UUID on success.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnGetUuid,(PPDMIBLOCK pInterface, PRTUUID pUuid));
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/** Pointer to a mount interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Block interface.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Pair with PDMIMOUNT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Called when a media is mounted.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnMountNotify,(PPDMIMOUNTNOTIFY pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Called when a media is unmounted
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUnmountNotify,(PPDMIMOUNTNOTIFY pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/* Pointer to mount interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Mount interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIMOUNTNOTIFY.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIMOUNT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Mount a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This will not unmount any currently mounted media!
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * constructed a configuration which can be attached to the bottom driver.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnMount,(PPDMIMOUNT pInterface, const char *pszFilename, const char *pszCoreDriver));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Unmount the media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * The driver will validate and pass it on. On the rebounce it will decide whether or not to detach it self.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fForce Force the unmount, even for locked media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnUnmount,(PPDMIMOUNT pInterface, bool fForce));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Checks if a media is mounted.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns true if mounted.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns false if not mounted.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(bool, pfnIsMounted,(PPDMIMOUNT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Locks the media, preventing any unmounting of it.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnLock,(PPDMIMOUNT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Unlocks the media, canceling previous calls to pfnLock().
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnUnlock,(PPDMIMOUNT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Checks if a media is locked.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns true if locked.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns false if not locked.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(bool, pfnIsLocked,(PPDMIMOUNT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * BIOS translation mode.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** No translation. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** LBA translation. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Automatic select mode. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to BIOS translation mode. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a media interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Media interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Makes up the fundation for PDMIBLOCK and PDMIBLOCKBIOS.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIMEDIA
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Read bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param off Offset to start reading from.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the read bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbRead Number of bytes to read.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @thread Any thread.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIMEDIA pInterface, uint64_t off, void *pvBuf, size_t cbRead));
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * Write bits.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @returns VBox status code.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param off Offset to start writing at.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pvBuf Where to store the write bits.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param cbWrite Number of bytes to write.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @thread Any thread.
326ffe46af8b56e4a0b9648193c1c0681104f127vboxsync DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIMEDIA pInterface, uint64_t off, const void *pvBuf, size_t cbWrite));
326ffe46af8b56e4a0b9648193c1c0681104f127vboxsync * Make sure that the bits written are actually on the storage medium.
326ffe46af8b56e4a0b9648193c1c0681104f127vboxsync * @returns VBox status code.
534b08d8ec6f569f90e80fd5eb49021993da0745vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
326ffe46af8b56e4a0b9648193c1c0681104f127vboxsync * @thread Any thread.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync DECLR3CALLBACKMEMBER(int, pfnFlush,(PPDMIMEDIA pInterface));
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * Get the media size in bytes.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns Media size in bytes.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(uint64_t, pfnGetSize,(PPDMIMEDIA pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Check if the media is readonly or not.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns true if readonly.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns false if read/write.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(bool, pfnIsReadOnly,(PPDMIMEDIA pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Get stored media geometry - BIOS property.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is an optional feature of a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnBiosSetGeometry() yet.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcCylinders Number of cylinders.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcHeads Number of heads.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcSectors Number of sectors. This number is 1-based.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @remark This have no influence on the read/write operations.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnBiosGetGeometry,(PPDMIMEDIA pInterface, uint32_t *pcCylinders, uint32_t *pcHeads, uint32_t *pcSectors));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Store the media geometry - BIOS property.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is an optional feature of a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cCylinders Number of cylinders.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cHeads Number of heads.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cSectors Number of sectors. This number is 1-based.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @remark This have no influence on the read/write operations.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnBiosSetGeometry,(PPDMIMEDIA pInterface, uint32_t cCylinders, uint32_t cHeads, uint32_t cSectors));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Get stored geometry translation mode - BIOS property.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is an optional feature of a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry translation mode.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VERR_PDM_TRANSLATION_NOT_SET if the translation hasn't been set using pfnBiosSetTranslation() yet.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param penmTranslation Where to store the translation type.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @remark This have no influence on the read/write operations.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnBiosGetTranslation,(PPDMIMEDIA pInterface, PPDMBIOSTRANSLATION penmTranslation));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Store media geometry - BIOS property.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is an optional feature of a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param enmTranslation The translation type.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @remark This have no influence on the read/write operations.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnBiosSetTranslation,(PPDMIMEDIA pInterface, PDMBIOSTRANSLATION enmTranslation));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Gets the UUID of the media drive.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pUuid Where to store the UUID on success.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnGetUuid,(PPDMIMEDIA pInterface, PRTUUID pUuid));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a block BIOS interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Media BIOS interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * The interface the getting and setting properties which the BIOS/CMOS care about.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Get stored media geometry - BIOS property.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is an optional feature of a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcCylinders Number of cylinders.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcHeads Number of heads.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcSectors Number of sectors. This number is 1-based.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @remark This have no influence on the read/write operations.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnGetGeometry,(PPDMIBLOCKBIOS pInterface, uint32_t *pcCylinders, uint32_t *pcHeads, uint32_t *pcSectors));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Store the media geometry - BIOS property.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is an optional feature of a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param cCylinders Number of cylinders.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cHeads Number of heads.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cSectors Number of sectors. This number is 1-based.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @remark This have no influence on the read/write operations.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetGeometry,(PPDMIBLOCKBIOS pInterface, uint32_t cCylinders, uint32_t cHeads, uint32_t cSectors));
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Get stored geometry translation mode - BIOS property.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * This is an optional feature of a media.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns VBox status code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry translation mode.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param penmTranslation Where to store the translation type.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @remark This have no influence on the read/write operations.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @thread Any thread.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLR3CALLBACKMEMBER(int, pfnGetTranslation,(PPDMIBLOCKBIOS pInterface, PPDMBIOSTRANSLATION penmTranslation));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Store media geometry - BIOS property.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is an optional feature of a media.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param enmTranslation The translation type.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @remark This have no influence on the read/write operations.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLR3CALLBACKMEMBER(int, pfnSetTranslation,(PPDMIBLOCKBIOS pInterface, PDMBIOSTRANSLATION enmTranslation));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Checks if the device should be visible to the BIOS or not.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns true if the device is visible to the BIOS.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns false if the device is not visible to the BIOS.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @thread Any thread.
2b114c590cf5a19f8047cd7bde9c7e5ae00aa22bvboxsync DECLR3CALLBACKMEMBER(bool, pfnIsVisible,(PPDMIBLOCKBIOS pInterface));
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Gets the block drive type.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns block drive type.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @thread Any thread.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync DECLR3CALLBACKMEMBER(PDMBLOCKTYPE, pfnGetType,(PPDMIBLOCKBIOS pInterface));
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync/** Pointer to a static block core driver interface. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * Static block core driver interface.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * Check if the specified file is a format which the core driver can handle.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @returns true / false accordingly.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pszFilename Name of the file to probe.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync DECLR3CALLBACKMEMBER(bool, pfnCanHandle,(PPDMIMEDIASTATIC pInterface, const char *pszFilename));
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync/** Pointer to an iSCSI Request PDU buffer. */
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * iSCSI Request PDU buffer (gather).
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsynctypedef struct ISCSIREQ
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Length of PDU segment in bytes. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Pointer to PDU segment. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync const void *pcvSeg;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to an iSCSI Response PDU buffer. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * iSCSI Response PDU buffer (scatter).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct ISCSIRES
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Length of PDU segment. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Pointer to PDU segment. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to an iSCSI transport driver interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIISCSITRANSPORT *PPDMIISCSITRANSPORT;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * iSCSI transport driver interface.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Read bytes from an iSCSI transport stream. If the connection fails, it is automatically
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * reopened on the next call after the error is signalled. Error recovery in this case is
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * the duty of the caller.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pTransport Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the read bits.
2b114c590cf5a19f8047cd7bde9c7e5ae00aa22bvboxsync * @param cbBuf Number of bytes to read.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcbRead Actual number of bytes read.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @todo Correct the docs.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIISCSITRANSPORT pTransport, PISCSIRES prgResponse, unsigned int cnResponse));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Write bytes to an iSCSI transport stream. Padding is performed when necessary. If the connection
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * fails, it is automatically reopened on the next call after the error is signalled. Error recovery
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * in this case is the duty of the caller.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pTransport Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where the write bits are stored.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param cbWrite Number of bytes to write.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @thread Any thread.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @todo Correct the docs.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIISCSITRANSPORT pTransport, PISCSIREQ prgRequest, unsigned int cnRequest));
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Open the iSCSI transport stream.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pTransport Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pszTargetAddress Pointer to string of the format address:port.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnOpen,(PPDMIISCSITRANSPORT pTransport, const char *pszTargetAddress));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Close the iSCSI transport stream.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pTransport Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnClose,(PPDMIISCSITRANSPORT pTransport));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a char port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Char port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMICHAR.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMICHARPORT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Deliver data read to the device/driver.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where the read bits are stored.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param pcbRead Number of bytes available for reading/having been read.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @thread Any thread.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync DECLR3CALLBACKMEMBER(int, pfnNotifyRead,(PPDMICHARPORT pInterface, const void *pvBuf, size_t *pcbRead));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a char interface. */
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * Char interface.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * Pair with PDMICHARPORT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMICHAR
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Write bits.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param pvBuf Where to store the write bits.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param cbWrite Number of bytes to write.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMICHAR pInterface, const void *pvBuf, size_t cbWrite));
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * Set device parameters.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @returns VBox status code.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param speed Speed of the serial connection.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param parity Enable parity
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param data_bits Number of data bits
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param stop_bits Number of stop bits
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
c66e448632d5ef48cf6b896f02e750440f5c6586vboxsync DECLR3CALLBACKMEMBER(int, pfnSetParameters,(PPDMICHAR pInterface, int speed, int parity, int data_bits, int stop_bits));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a stream interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Stream interface.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * Makes up the fundation for PDMICHAR.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsynctypedef struct PDMISTREAM
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Read bits.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @returns VBox status code.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the read bits.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @param cbRead Number of bytes to read/bytes actually read.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMISTREAM pInterface, void *pvBuf, size_t *cbRead));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Write bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the write bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbWrite Number of bytes to write/bytes actually written.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMISTREAM pInterface, const void *pvBuf, size_t *cbWrite));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a host device port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIHOSTDEVICEPORT *PPDMIHOSTDEVICEPORT;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Char port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIHOSTDEVICECONNECTOR.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * Deliver data read to the device/driver.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
cb39011e69667689c166f1cdf95247b46fff324dvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where the read bits are stored.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcbRead Number of bytes available for reading/having been read.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnNotifyRead,(PPDMIHOSTDEVICEPORT pInterface, const void *pvBuf, size_t *pcbRead));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a Host Device connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIHOSTDEVICECONNECTOR *PPDMIHOSTDEVICECONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Host device connector interface
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIHOSTDEVICEPORT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Write bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the write bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcbWrite Number of bytes to write/bytes actually written.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIHOSTDEVICECONNECTOR pInterface, const void *pvBuf, size_t *pcbWrite));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Read bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Where to store the read bits.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcbRead Number of bytes to read/bytes actually read.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIHOSTDEVICECONNECTOR pInterface, void *pvBuf, size_t *pcbRead));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Perform IO control on the host device.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param uCommand The number of the command to set or get data
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvData Where to store the command data.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread Any thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnIOCtl,(PPDMIHOSTDEVICECONNECTOR pInterface, RTUINT uCommand, void *pvData));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** ACPI power source identifier */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to ACPI battery state. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** ACPI battey capacity */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to ACPI battery capacity. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** ACPI battery state. See ACPI 3.0 spec '_BST (Battery Status)' */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to ACPI battery state. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to an ACPI port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * ACPI port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIACPIPORT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Send an ACPI power off event.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnPowerButtonPress,(PPDMIACPIPORT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to an ACPI connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIACPICONNECTOR *PPDMIACPICONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * ACPI connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Get the current power source of the host system.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param penmPowerSource Pointer to the power source result variable.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryPowerSource,(PPDMIACPICONNECTOR, PPDMACPIPOWERSOURCE penmPowerSource));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Query the current battery status of the host system.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code?
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pfPresent Is set to true if battery is present, false otherwise.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param penmRemainingCapacity Pointer to the battery remaining capacity (0 - 100 or 255 for unknown).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param penmBatteryState Pointer to the battery status.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pu32PresentRate Pointer to the present rate (0..1000 of the total capacity).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryBatteryStatus,(PPDMIACPICONNECTOR, bool *pfPresent, PPDMACPIBATCAPACITY penmRemainingCapacity,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync PPDMACPIBATSTATE penmBatteryState, uint32_t *pu32PresentRate));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a VMMDevice port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * VMMDevice port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Return the current absolute mouse position in pixels
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pAbsX Pointer of result value, can be NULL
2b114c590cf5a19f8047cd7bde9c7e5ae00aa22bvboxsync * @param pAbsY Pointer of result value, can be NULL
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t *pAbsX, uint32_t *pAbsY));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Set the new absolute mouse position in pixels
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param absX New absolute X position
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param absY New absolute Y position
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, uint32_t absX, uint32_t absY));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Return the current mouse capability flags
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pCapabilities Pointer of result value
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t *pCapabilities));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Set the current mouse capability flag (host side)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param capabilities Capability mask
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t capabilities));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Issue a display resolution change request.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Note that there can only one request in the queue and that in case the guest does
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * not process it, issuing another request will overwrite the previous.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cx Horizontal pixel resolution (0 = do not change).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cy Vertical pixel resolution (0 = do not change).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cBits Bits per pixel (0 = do not change).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param display The display index.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnRequestDisplayChange,(PPDMIVMMDEVPORT pInterface, uint32_t cx, uint32_t cy, uint32_t cBits, uint32_t display));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pass credentials to guest.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Note that there can only be one set of credentials and the guest may or may not
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * query them and may do whatever it wants with them.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pszUsername User name, may be empty (UTF-8)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pszPassword Password, may be empty (UTF-8)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pszDomain Domain name, may be empty (UTF-8)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fFlags Bitflags
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetCredentials,(PPDMIVMMDEVPORT pInterface, const char *pszUsername,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Notify the driver about a VBVA status change.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns Nothing. Because it is informational callback.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fEnabled Current VBVA status.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLCALLBACKMEMBER(void, pfnVBVAChange)(PPDMIVMMDEVPORT pInterface, bool fEnabled);
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Issue a seamless mode change request.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Note that there can only one request in the queue and that in case the guest does
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * not process it, issuing another request will overwrite the previous.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fEnabled Seamless mode enabled or not
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnRequestSeamlessChange,(PPDMIVMMDEVPORT pInterface, bool fEnabled));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Forward declaration of the video accelerator command memory. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Forward declaration of the guest information structure. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to video accelerator command memory. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a VMMDev connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIVMMDEVCONNECTOR *PPDMIVMMDEVCONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * VMMDev connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIVMMDEVPORT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Report guest OS version.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Called whenever the Additions issue a guest version report request.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pGuestInfo Pointer to guest information structure
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUpdateGuestVersion,(PPDMIVMMDEVCONNECTOR pInterface, struct VBoxGuestInfo *pGuestInfo));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Update the guest additions capabilities.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is called when the guest additions capabilities change. The new capabilities
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * are given and the connector should update its internal state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param newCapabilities New capabilities.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUpdateGuestCapabilities,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Update the mouse capabilities.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is called when the mouse capabilities change. The new capabilities
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * are given and the connector should update its internal state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param newCapabilities New capabilities.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUpdateMouseCapabilities,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Update the pointer shape.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is called when the mouse pointer shape changes. The new shape
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * is passed as a caller allocated buffer that will be freed after returning
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fVisible Visibility indicator (if false, the other parameters are undefined).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fAlpha Flag whether alpha channel is being passed.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param xHot Pointer hot spot x coordinate.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param yHot Pointer hot spot y coordinate.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param x Pointer new x coordinate on screen.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param y Pointer new y coordinate on screen.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cx Pointer width in pixels.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cy Pointer height in pixels.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cbScanline Size of one scanline in bytes.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvShape New shape buffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUpdatePointerShape,(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Enable or disable video acceleration on behalf of guest.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fEnable Whether to enable acceleration.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pVbvaMemory Video accelerator memory.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @return VBox rc. VINF_SUCCESS if VBVA was enabled.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
2b114c590cf5a19f8047cd7bde9c7e5ae00aa22bvboxsync DECLR3CALLBACKMEMBER(int, pfnVideoAccelEnable,(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, PVBVAMEMORY pVbvaMemory));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Force video queue processing.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnVideoAccelFlush,(PPDMIVMMDEVCONNECTOR pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Return whether the given video mode is supported/wanted by the host.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cy Video mode horizontal resolution in pixels.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cx Video mode vertical resolution in pixels.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cBits Video mode bits per pixel.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pfSupported Where to put the indicator for whether this mode is supported. (output)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnVideoModeSupported,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cx, uint32_t cy, uint32_t cBits, bool *pfSupported));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Queries by how many pixels the height should be reduced when calculating video modes
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcyReduction Pointer to the result value.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnGetHeightReduction,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcyReduction));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Informs about a credentials judgement result from the guest.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fFlags Judgement result flags.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetCredentialsJudgementResult,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t fFlags));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Set the visible region of the display
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cRect Number of rectangles in pRect
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pRect Rectangle array
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetVisibleRegion,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Query the visible region of the display
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pcRect Number of rectangles in pRect
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pRect Rectangle array (set to NULL to query the number of rectangles)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryVisibleRegion,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRect, PRTRECT pRect));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * MAC address.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * (The first 24 bits are the 'company id', where the first bit seems to have a special meaning if set.)
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef union PDMMAC
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 8-bit view. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 16-bit view. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a MAC address. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a const MAC address. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a network port interface */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Network port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Check how much data the device/driver can receive data now.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This must be called before the pfnRecieve() method is called.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns Number of bytes the device can receive now.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(size_t, pfnCanReceive,(PPDMINETWORKPORT pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Receive data from the network.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf The available data.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cb Number of bytes available in the buffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnReceive,(PPDMINETWORKPORT pInterface, const void *pvBuf, size_t cb));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Network link state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Invalid state. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** The link is up. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** The link is down. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** The link is temporarily down while resuming. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a network connector interface */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMINETWORKCONNECTOR *PPDMINETWORKCONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Network connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Send data to the network.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvBuf Data to send.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cb Number of bytes to send.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSend,(PPDMINETWORKCONNECTOR pInterface, const void *pvBuf, size_t cb));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Set promiscuous mode.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is called when the promiscuous mode is set. This means that there doesn't have
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * to be a mode change when it's called.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fPromiscuous Set if the adaptor is now in promiscuous mode. Clear if it is not.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnSetPromiscuousMode,(PPDMINETWORKCONNECTOR pInterface, bool fPromiscuous));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Notification on link status changes.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param enmLinkState The new link state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnNotifyLinkChanged,(PPDMINETWORKCONNECTOR pInterface, PDMNETWORKLINKSTATE enmLinkState));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * More receive buffer has become available.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * This is called when the NIC frees up receive buffers.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnNotifyCanReceive,(PPDMINETWORKCONNECTOR pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a network config port interface */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMINETWORKCONFIG *PPDMINETWORKCONFIG;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Network config port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Gets the current Media Access Control (MAC) address.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pMac Where to store the MAC address.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnGetMac,(PPDMINETWORKCONFIG pInterface, PPDMMAC *pMac));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Gets the new link state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns The current link state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(PDMNETWORKLINKSTATE, pfnGetLinkState,(PPDMINETWORKCONFIG pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Sets the new link state.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param enmState The new link state
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread EMT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetLinkState,(PPDMINETWORKCONFIG pInterface, PDMNETWORKLINKSTATE enmState));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a network connector interface */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIAUDIOCONNECTOR *PPDMIAUDIOCONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Audio connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnRun,(PPDMIAUDIOCONNECTOR pInterface));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/* DECLR3CALLBACKMEMBER(int, pfnSetRecordSource,(PPDMIAUDIOINCONNECTOR pInterface, AUDIORECSOURCE)); */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** @todo r=bird: the two following interfaces are hacks to work around the missing audio driver
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * interface. This should be addressed rather than making more temporary hacks. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a Audio Sniffer Device port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIAUDIOSNIFFERPORT *PPDMIAUDIOSNIFFERPORT;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Audio Sniffer port interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Enables or disables sniffing. If sniffing is being enabled also sets a flag
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * whether the audio must be also left on the host.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fEnable 'true' for enable sniffing, 'false' to disable.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fKeepHostAudio Indicates whether host audio should also present
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * 'true' means that sound should not be played
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * by the audio device.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnSetup,(PPDMIAUDIOSNIFFERPORT pInterface, bool fEnable, bool fKeepHostAudio));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a Audio Sniffer connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIAUDIOSNIFFERCONNECTOR *PPDMIAUDIOSNIFFERCONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Audio Sniffer connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIAUDIOSNIFFERPORT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * AudioSniffer device calls this method when audio samples
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * are about to be played and sniffing is enabled.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pvSamples Audio samples buffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cSamples How many complete samples are in the buffer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param iSampleHz The sample frequency in Hz.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cChannels Number of channels. 1 for mono, 2 for stereo.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param cBits How many bits a sample for a single channel has. Normally 8 or 16.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param fUnsigned Whether samples are unsigned values.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnAudioSamplesOut,(PPDMIAUDIOSNIFFERCONNECTOR pInterface, void *pvSamples, uint32_t cSamples,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync int iSampleHz, int cChannels, int cBits, bool fUnsigned));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * AudioSniffer device calls this method when output volume is changed.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param u16LeftVolume 0..0xFFFF volume level for left channel.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param u16RightVolume 0..0xFFFF volume level for right channel.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnAudioVolumeOut,(PPDMIAUDIOSNIFFERCONNECTOR pInterface, uint16_t u16LeftVolume, uint16_t u16RightVolume));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Generic status LED core.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Note that a unit doesn't have to support all the indicators.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** 32-bit view. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Bit view. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Reading/Receiving indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Writing/Sending indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Busy indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Error indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** LED bit masks for the u32 view.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Reading/Receiving indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Writing/Sending indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Busy indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Error indicator. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Generic status LED.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Note that a unit doesn't have to support all the indicators.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMLED
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** Just a magic for sanity checking. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync uint32_t u32Alignment; /**< structure size alignment. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** The actual LED status.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Only the device is allowed to change this. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync /** The asserted LED status which is cleared by the reader.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * The device will assert the bits but never clear them.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * The driver clears them as it sees fit. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to an LED. */
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync/** Pointer to a const LED. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to an LED ports interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Interface for exporting LEDs.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMILEDPORTS
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Gets the pointer to the status LED of a unit.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param iLUN The unit which status LED we desire.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param ppLed Where to store the LED pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnQueryStatusLed,(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to an LED connectors interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMILEDCONNECTORS *PPDMILEDCONNECTORS;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Interface for reading LEDs.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Notification about a unit which have been changed.
2b114c590cf5a19f8047cd7bde9c7e5ae00aa22bvboxsync * The driver must discard any pointers to data owned by
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * the unit and requery it.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to the interface structure containing the called function pointer.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param iLUN The unit number.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnUnitChanged,(PPDMILEDCONNECTORS pInterface, unsigned iLUN));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** The special status unit number */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Abstract HGCM command structure. Used only to define a typed pointer. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to HGCM command structure. This pointer is unique and identifies
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * the command being processed. The pointer is passed to HGCM connector methods,
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * and must be passed back to HGCM port when command is completed.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a HGCM port interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * HGCM port interface. Normally implemented by VMMDev.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIHGCMPORT
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Notify the guest on a command completion.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param rc The return code (VBox error code).
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pCmd A pointer that identifies the completed command.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @returns VBox status code
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(void, pfnCompleted,(PPDMIHGCMPORT pInterface, int32_t rc, PVBOXHGCMCMD pCmd));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a HGCM connector interface. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct PDMIHGCMCONNECTOR *PPDMIHGCMCONNECTOR;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync/** Pointer to a HGCM service location structure. */
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsynctypedef struct HGCMSERVICELOCATION *PHGCMSERVICELOCATION;
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * HGCM connector interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Pair with PDMIHGCMPORT.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Locate a service and inform it about a client connection.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pCmd A pointer that identifies the command.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pServiceLocation Pointer to the service location structure.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pu32ClientID Where to store the client id for the connection.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @return VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnConnect,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, PHGCMSERVICELOCATION pServiceLocation, uint32_t *pu32ClientID));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Disconnect from service.
2b114c590cf5a19f8047cd7bde9c7e5ae00aa22bvboxsync * @param pInterface Pointer to this interface.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param pCmd A pointer that identifies the command.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @param u32ClientID The client id returned by the pfnConnect call.
0802b726efeabba46f90cb2b285de4dadaac9507vboxsync * @return VBox status code.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * @thread The emulation thread.
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync DECLR3CALLBACKMEMBER(int, pfnDisconnect,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID));
ae94ad7e769e467419ab99cab5403bdb39bc544fvboxsync * Process a guest issued command.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pInterface Pointer to this interface.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param pCmd A pointer that identifies the command.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param u32ClientID The client id returned by the pfnConnect call.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param u32Function Function to be performed by the service.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param cParms Number of parameters in the array pointed to by paParams.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @param paParms Pointer to an array of parameters.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @return VBox status code.
36c3589d6411416bba897f2595f1812b9d9ff4b3vboxsync * @thread The emulation thread.