pdmifs.h revision 9496f2d398b49813176939d7a339ae513d5175ef
* could be put closer to home. /** PDMIBASE - The interface everyone supports. */ /** PDMIMOUSEPORT - The mouse port interface. (Down) Coupled with PDMINTERFACE_MOUSE_CONNECTOR. */ /** PDMIMOUSECONNECTOR - The mouse connector interface. (Up) Coupled with PDMINTERFACE_MOUSE_PORT. */ /** PDMIKEYBOARDPORT - The keyboard port interface. (Down) Coupled with PDMINTERFACE_KEYBOARD_CONNECTOR. */ /** PDMIKEYBOARDCONNECTOR - The keyboard connector interface. (Up) Coupled with PDMINTERFACE_KEYBOARD_PORT. */ /** PDMIDISPLAYPORT - The display port interface. (Down) Coupled with PDMINTERFACE_DISPLAY_CONNECTOR. */ /** PDMIDISPLAYCONNECTOR - The display connector interface. (Up) Coupled with PDMINTERFACE_DISPLAY_PORT. */ /** PDMICHARPORT - The char notify interface. (Down) Coupled with PDMINTERFACE_CHAR. */ /** PDMICHAR - The char driver interface. (Up) Coupled with PDMINTERFACE_CHAR_PORT. */ /** PDMISTREAM - The stream driver interface (Up) No coupling. * Used by a char driver to implement PDMINTERFACE_CHAR. */ /** PDMIBLOCKPORT - The block notify interface (Down) Coupled with PDMINTERFACE_BLOCK. */ /** PDMIBLOCK - The block driver interface (Up) Coupled with PDMINTERFACE_BLOCK_PORT. */ /** PDMIBLOCKBIOS - The block bios interface. (External) */ /** PDMIMOUNTNOTIFY - The mountable notification interface. (Down) Coupled with PDMINTERFACE_MOUNT. */ /** PDMIMOUNT - The mountable interface. (Up) Coupled with PDMINTERFACE_MOUNT_NOTIFY. */ /** PDMIMEDIA - The media interface. (Up) No coupling. * Used by a block unit driver to implement PDMINTERFACE_BLOCK and PDMINTERFACE_BLOCK_BIOS. */ /** PDMIISCSITRANSPORT - The iSCSI transport interface (Up) No coupling. * used by the iSCSI media driver. */ /** PDMIISCSITRANSPORTASYNC - The asynchronous iSCSI interface (Up) Couple with PDMINTERFACE_ISCSITRANSPORT. * extension used by the iSCSI media driver. */ /** PDMIISCSITRANSPORTASYNCPORT - The asynchronous iSCSI interface (Down) Couple with PDMINTERFACE_ISCSITRANSPORTASYNC. * notify port used by the iSCSI media driver. */ /** PDMIMEDIAASYNC - Async version of the media interface (Down) Coupled with PDMINTERFACE_MEDIA_ASYNC_PORT. */ /** PDMIMEDIAASYNCPORT - Async version of the media interface (Up) Coupled with PDMINTERFACE_MEDIA_ASYNC. */ /** PDMIBLOCKASYNC - Async version of the block interface (Down) Coupled with PDMINTERFACE_BLOCK_ASYNC_PORT. */ /** PDMIBLOCKASYNCPORT - Async version of the block interface (Up) Coupled with PDMINTERFACE_BLOCK_ASYNC. */ /** PDMITRANSPORTASYNC - Transport data async to their target (Down) Coupled with PDMINTERFACE_TRANSPORT_ASYNC_PORT. */ /** PDMITRANSPORTASYNCPORT - Transport data async to their target (Up) Coupled with PDMINTERFACE_TRANSPORT_ASYNC. */ /** PDMINETWORKPORT - The network port interface. (Down) Coupled with PDMINTERFACE_NETWORK_CONNECTOR. */ /** PDMINETWORKPORT - The network connector interface. (Up) Coupled with PDMINTERFACE_NETWORK_PORT. */ /** PDMINETWORKCONFIG - The network configuartion interface. (Main) Used by the managment api. */ /** PDMIAUDIOCONNECTOR - The audio driver interface. (Up) No coupling. */ /** PDMIAUDIOSNIFFERPORT - The Audio Sniffer Device port interface. */ /** PDMIAUDIOSNIFFERCONNECTOR - The Audio Sniffer Driver connector interface. */ /** PDMIVMMDEVPORT - The VMM Device port interface. */ /** PDMIVMMDEVCONNECTOR - The VMM Device connector interface. */ /** PDMILEDPORTS - The generic LED port interface. (Down) Coupled with PDMINTERFACE_LED_CONNECTORS. */ /** PDMILEDCONNECTORS - The generic LED connector interface. (Up) Coupled with PDMINTERFACE_LED_PORTS. */ /** PDMIACPIPORT - ACPI port interface. (Down) Coupled with PDMINTERFACE_ACPI_CONNECTOR. */ /** PDMIACPICONNECTOR - ACPI connector interface. (Up) Coupled with PDMINTERFACE_ACPI_PORT. */ /** PDMIHGCMPORT - The Host-Guest communication manager port interface. Normally implemented by VMMDev. */ /** PDMIHGCMCONNECTOR - The Host-Guest communication manager connector interface. Normally implemented by Main::VMMDevInterface. */ /** VUSBIROOTHUBPORT - VUSB RootHub port interface. (Down) Coupled with PDMINTERFACE_USB_RH_CONNECTOR. */ /** VUSBIROOTHUBCONNECTOR - VUSB RootHub connector interface. (Up) Coupled with PDMINTERFACE_USB_RH_PORT. */ /** VUSBIRHCONFIG - VUSB RootHub configuration interface. (Main) Used by the managment api. */ /** VUSBROOTHUBCONNECTOR - VUSB Device interface. (Up) No coupling. */ /** PDMIHOSTPARALLELPORT - The Host Parallel port interface. (Down) Coupled with PDMINTERFACE_HOST_PARALLEL_CONNECTOR. */ /** PDMIHOSTPARALLELCONNECTOR - The Host Parallel connector interface (Up) Coupled with PDMINTERFACE_HOST_PARALLEL_PORT. */ /** Maximum interface number. */ * PDM Driver Base Interface. * Queries an interface to the driver. * @returns Pointer to interface. * @returns NULL if the interface was not supported by the driver. * @param pInterface Pointer to this interface structure. * @param enmInterface The requested interface identification. * This is used to typedef other dummy interfaces. The purpose of a dummy * interface is to validate the logical function of a driver/device and * full a natural interface pair. /** Pointer to a mouse port interface. */ * Pair with PDMIMOUSECONNECTOR. * This is called by the source of mouse events. The event will be passed up until the * topmost driver, which then calls the registered event handler. * @returns VBox status code. * @param pInterface Pointer to this interface structure. * @param i32DeltaX The X delta. * @param i32DeltaY The Y delta. * @param i32DeltaZ The Z delta. * @param fButtonStates The button states, see the PDMIMOUSEPORT_BUTTON_* \#defines. * @thread The emulation thread. /** Mouse button defines for PDMIMOUSEPORT::pfnPutEvent. * Mouse connector interface. * Pair with PDMIMOUSEPORT. /** Pointer to a mouse connector interface. */ /** Pointer to a keyboard port interface. */ * Keyboard port interface. * Pair with PDMIKEYBOARDCONNECTOR. * This is called by the source of keyboard events. The event will be passed up until the * topmost driver, which then calls the registered event handler. * @returns VBox status code. * @param pInterface Pointer to this interface structure. * @param u8KeyCode The keycode to queue. * @thread The emulation thread. /** Pointer to keyboard connector interface. */ * Keyboard connector interface. * Pair with PDMIKEYBOARDPORT * Notifies the the downstream driver about an LED change initiated by the guest. * @param pInterface Pointer to the this interface. * @param enmLeds The new led mask. /** Pointer to a display port interface. */ * Display port interface. * Pair with PDMIDISPLAYCONNECTOR. * Update the display with any changed regions. * Flushes any display changes to the memory pointed to by the * PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect() * @returns VBox status code. * @param pInterface Pointer to this interface. * @thread The emulation thread. * Update the entire display. * Flushes the entire display content to the memory pointed to by the * PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect(). * @returns VBox status code. * @param pInterface Pointer to this interface. * @thread The emulation thread. * Return the current guest color depth in bits per pixel (bpp). * As the graphics card is able to provide display updates with the bpp * requested by the host, this method can be used to query the actual * @returns VBox status code. * @param pInterface Pointer to this interface. * @param pcBits Where to store the current guest color depth. * Sets the refresh rate and restart the timer. * The rate is defined as the minimum interval between the return of * one PDMIDISPLAYPORT::pfnRefresh() call to the next one. * The interval timer will be restarted by this call. So at VM startup * this function must be called to start the refresh cycle. The refresh * rate is not saved, but have to be when resuming a loaded VM state. * @returns VBox status code. * @param pInterface Pointer to this interface. * @param cMilliesInterval Number of millies between two refreshes. * Create a 32-bbp snapshot of the display. * This will create a 32-bbp bitmap with dword aligned scanline length. Because * of a wish for no locks in the graphics device, this must be called from the * @param pInterface Pointer to this interface. * @param pvData Pointer the buffer to copy the bits to. * @param cbData Size of the buffer. * @param pcx Where to store the width of the bitmap. (optional) * @param pcy Where to store the height of the bitmap. (optional) * @param pcbData Where to store the actual size of the bitmap. (optional) * @thread The emulation thread. * Copy bitmap to the display. * This will convert and copy a 32-bbp bitmap (with dword aligned scanline length) to * the memory pointed to by the PDMIDISPLAYCONNECTOR interface. * @param pInterface Pointer to this interface. * @param pvData Pointer to the bitmap bits. * @param x The upper left corner x coordinate of the destination rectangle. * @param y The upper left corner y coordinate of the destination rectangle. * @param cx The width of the source and destination rectangles. * @param cy The height of the source and destination rectangles. * @thread The emulation thread. * @remark This is just a convenience for using the bitmap conversions of the * Render a rectangle from guest VRAM to Framebuffer. * @param pInterface Pointer to this interface. * @param x The upper left corner x coordinate of the rectangle to be updated. * @param y The upper left corner y coordinate of the rectangle to be updated. * @param cx The width of the rectangle to be updated. * @param cy The height of the rectangle to be updated. * @thread The emulation thread. * Inform the VGA device whether the Display is directly using the guest VRAM and there is no need * to render the VRAM to the framebuffer memory. * @param pInterface Pointer to this interface. * @param fRender Whether the VRAM content must be rendered to the framebuffer. * @thread The emulation thread. /** Pointer to a display connector interface. */ * Display connector interface. * Pair with PDMIDISPLAYPORT. * This is called when the resolution changes. This usually happens on * request from the guest os, but may also happen as the result of a reset. * If the callback returns VINF_VGA_RESIZE_IN_PROGRESS, the caller (VGA device) * must not access the connector and return. * @returns VINF_SUCCESS if the framebuffer resize was completed, * VINF_VGA_RESIZE_IN_PROGRESS if resize takes time and not yet finished. * @param pInterface Pointer to this interface. * @param cBits Color depth (bits per pixel) of the new video mode. * @param pvVRAM Address of the guest VRAM. * @param cbLine Size in bytes of a single scan line. * @param cx New display width. * @param cy New display height. * @thread The emulation thread. * Update a rectangle of the display. * PDMIDISPLAYPORT::pfnUpdateDisplay is the caller. * @param pInterface Pointer to this interface. * @param x The upper left corner x coordinate of the rectangle. * @param y The upper left corner y coordinate of the rectangle. * @param cx The width of the rectangle. * @param cy The height of the rectangle. * @thread The emulation thread. * The interval between these calls is set by * PDMIDISPLAYPORT::pfnSetRefreshRate(). The driver should call * PDMIDISPLAYPORT::pfnUpdateDisplay() if it wishes to refresh the * display. PDMIDISPLAYPORT::pfnUpdateDisplay calls pfnUpdateRect with * the changed rectangles. * @param pInterface Pointer to this interface. * @thread The emulation thread. * Notification message when the graphics card has been reset. * @param pInterface Pointer to this interface. * @thread The emulation thread. * Notification message when LinearFrameBuffer video mode is enabled/disabled. * @param pInterface Pointer to this interface. * @param fEnabled false - LFB mode was disabled, * true - an LFB mode was disabled * @thread The emulation thread. * Process the guest graphics adapter information. * Direct notification from guest to the display connector. * @param pInterface Pointer to this interface. * @param pvVRAM Address of the guest VRAM. * @param u32VRAMSize Size of the guest VRAM. * @thread The emulation thread. * Process the guest display information. * Direct notification from guest to the display connector. * @param pInterface Pointer to this interface. * @param pvVRAM Address of the guest VRAM. * @param uScreenId The index of the guest display to be processed. * @thread The emulation thread. /** Read-only attributes. * For preformance reasons some readonly attributes are kept in the interface. * We trust the interface users to respect the readonlyness of these. /** Pointer to the display data buffer. */ /** Size of a scanline in the data buffer. */ /** The color depth (in bits) the graphics card is supposed to provide. */ /** The display width. */ /** The display height. */ /** Error (for the query function). */ /** 360KB 5 1/4" floppy drive. */ /** 720KB 3 1/2" floppy drive. */ /** 1.2MB 5 1/4" floppy drive. */ /** 1.44MB 3 1/2" floppy drive. */ /** 2.88MB 3 1/2" floppy drive. */ * Block raw command data transfer direction. * Block notify interface. /** Pointer to a block notify interface (dummy). */ /** Pointer to a block interface. */ * Pair with PDMIBLOCKPORT. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start reading from. * @param pvBuf Where to store the read bits. * @param cbRead Number of bytes to read. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. * @param pvBuf Where to store the write bits. * @param cbWrite Number of bytes to write. * Make sure that the bits written are actually on the storage medium. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * Send a raw command to the underlying device (CDROM). * This method is optional (i.e. the function pointer may be NULL). * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pbCmd Offset to start reading from. * @param enmTxDir Direction of transfer. * @param pvBuf Pointer tp the transfer buffer. * @param cbBuf Size of the transfer buffer. * @param pbSenseKey Status of the command (when return value is VERR_DEV_IO_ERROR). * @param cTimeoutMillies Command timeout in milliseconds. * Check if the media is readonly or not. * @returns true if readonly. * @param pInterface Pointer to the interface structure containing the called function pointer. * Gets the media size in bytes. * @returns Media size in bytes. * @param pInterface Pointer to the interface structure containing the called function pointer. * Gets the block drive type. * @returns block drive type. * @param pInterface Pointer to the interface structure containing the called function pointer. * Gets the UUID of the block drive. * Don't return the media UUID if it's removable. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pUuid Where to store the UUID on success. /** Pointer to a mount interface. */ * Called when a media is mounted. * @param pInterface Pointer to the interface structure containing the called function pointer. * @thread The emulation thread. * Called when a media is unmounted * @param pInterface Pointer to the interface structure containing the called function pointer. * @thread The emulation thread. /* Pointer to mount interface. */ * Pair with PDMIMOUNTNOTIFY. * This will not unmount any currently mounted media! * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pszFilename Pointer to filename. If this is NULL it assumed that the caller have * constructed a configuration which can be attached to the bottom driver. * @param pszCoreDriver Core driver name. NULL will cause autodetection. Ignored if pszFilanem is NULL. * @thread The emulation thread. * The driver will validate and pass it on. On the rebounce it will decide whether or not to detach it self. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @thread The emulation thread. * @param fForce Force the unmount, even for locked media. * @thread The emulation thread. * Checks if a media is mounted. * @returns true if mounted. * @returns false if not mounted. * @param pInterface Pointer to the interface structure containing the called function pointer. * Locks the media, preventing any unmounting of it. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @thread The emulation thread. * Unlocks the media, canceling previous calls to pfnLock(). * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @thread The emulation thread. * Checks if a media is locked. * @returns true if locked. * @returns false if not locked. * @param pInterface Pointer to the interface structure containing the called function pointer. * Media geometry structure. /** Number of cylinders. */ /** Number of sectors. */ /** Pointer to media geometry structure. */ /** Pointer to constant media geometry structure. */ /** Pointer to a media interface. */ * Makes up the foundation for PDMIBLOCK and PDMIBLOCKBIOS. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start reading from. * @param pvBuf Where to store the read bits. * @param cbRead Number of bytes to read. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. * @param pvBuf Where to store the write bits. * @param cbWrite Number of bytes to write. * Make sure that the bits written are actually on the storage medium. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * Get the media size in bytes. * @returns Media size in bytes. * @param pInterface Pointer to the interface structure containing the called function pointer. * Check if the media is readonly or not. * @returns true if readonly. * @param pInterface Pointer to the interface structure containing the called function pointer. * Get stored media geometry (physical CHS, PCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnBiosSetPCHSGeometry() yet. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * Store the media geometry (physical CHS, PCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * @thread The emulation thread. * Get stored media geometry (logical CHS, LCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnBiosSetLCHSGeometry() yet. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * Store the media geometry (logical CHS, LCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * @thread The emulation thread. * Gets the UUID of the media drive. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pUuid Where to store the UUID on success. /** Pointer to a block BIOS interface. */ * The interface the getting and setting properties which the BIOS/CMOS care about. * Get stored media geometry (physical CHS, PCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnSetPCHSGeometry() yet. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * Store the media geometry (physical CHS, PCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * @thread The emulation thread. * Get stored media geometry (logical CHS, LCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @returns VERR_PDM_GEOMETRY_NOT_SET if the geometry hasn't been set using pfnSetLCHSGeometry() yet. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * Store the media geometry (logical CHS, LCHS) - BIOS property. * This is an optional feature of a media. * @returns VBox status code. * @returns VERR_NOT_IMPLEMENTED if the media doesn't support storing the geometry. * @param pInterface Pointer to the interface structure containing the called function pointer. * @remark This has no influence on the read/write operations. * @thread The emulation thread. * Checks if the device should be visible to the BIOS or not. * @returns true if the device is visible to the BIOS. * @returns false if the device is not visible to the BIOS. * @param pInterface Pointer to the interface structure containing the called function pointer. * Gets the block drive type. * @returns block drive type. * @param pInterface Pointer to the interface structure containing the called function pointer. /** Pointer to a static block core driver interface. */ * Static block core driver interface. * Check if the specified file is a format which the core driver can handle. * @returns true / false accordingly. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pszFilename Name of the file to probe. * iSCSI Request PDU buffer (gather). /** Length of PDU segment in bytes. */ /** Pointer to PDU segment. */ /** Pointer to an iSCSI Request PDU buffer. */ /** Pointer to a const iSCSI Request PDU buffer. */ * iSCSI Response PDU buffer (scatter). /** Length of PDU segment. */ /** Pointer to PDU segment. */ /** Pointer to an iSCSI Response PDU buffer. */ /** Pointer to a const iSCSI Response PDU buffer. */ /** Pointer to an iSCSI transport driver interface. */ * iSCSI transport driver interface. * Read bytes from an iSCSI transport stream. If the connection fails, it is automatically * reopened on the next call after the error is signalled. Error recovery in this case is * the duty of the caller. * @returns VBox status code. * @param pTransport Pointer to the interface structure containing the called function pointer. * @param paResponses Array of scatter segments. * @param cResponses The number of segments. * @todo Correct the docs. * Write bytes to an iSCSI transport stream. Padding is performed when necessary. If the connection * fails, it is automatically reopened on the next call after the error is signalled. Error recovery * in this case is the duty of the caller. * @returns VBox status code. * @param pTransport Pointer to the interface structure containing the called function pointer. * @param paRequests Array of gather segments. * @param cRequests The number of segments. * @todo Correct the docs. * Open the iSCSI transport stream. * @returns VBox status code. * @param pTransport Pointer to the interface structure containing the called function pointer. * @param pszTargetAddress Pointer to string of the format address:port. * Close the iSCSI transport stream. * @returns VBox status code. * @param pTransport Pointer to the interface structure containing the called function pointer. /** Pointer to an asynchronous iSCSI transport driver interface. */ * Asynchronous iSCSI transport driver interface. * Start an asynchronous read request from an iSCSI transport stream. Padding is performed when necessary. * @returns VBox status code. * @param pTransport Pointer to the interface structure containing the called function pointer. * @param paResponses Pointer to a array of scatter segments. * @param cResponses Number of segments in the array. * @param pvUser User argument which is returned in completion callback. * Start an asychronous write to an iSCSI transport stream. Padding is performed when necessary. * @returns VBox status code. * @param pTransport Pointer to the interface structure containing the called function pointer. * @param paRequests Pointer to a array of gather segments. * @param cRequests Number of segments in the array. * @param pvUser User argument which is returned in completion callback. /** Pointer to a asynchronous iSCSI transport notify interface. */ * Asynchronous iSCSI transport notify interface. * Pair with PDMIISCSITRANSPORTASYNC. * Notify completion of a read task. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param paResponses Pointer to a array of scatter segments. * @param cResponses Number of segments in the array. * @param pvUser The user argument given in pfnStartRead. * Notify completion of a write task. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param paRequests Pointer to a array of gather segments. * @param cRequests Number of segments in the array. * @param pvUser The user argument given in pfnStartWrite. /** Pointer to a asynchronous block notify interface. */ * Asynchronous block notify interface. * Pair with PDMIBLOCKASYNC. * Notify completion of a asynchronous transfer. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. /** Pointer to a asynchronous block interface. */ * Asynchronous block interface. * Pair with PDMIBLOCKASYNCPORT. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start reading from. * @param pSeg Pointer to the first element in the scatter list. * @param cSeg Number of entries in the list. * @param cbRead Number of bytes to read. * @param pvUser User argument which is returned in completion callback. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. * @param pSeg Pointer to the first element in the gather list. * @param cSeg Number of entries in the list. * @param cbWrite Number of bytes to write. * @param pvUser User argument which is returned in completion callback. /** Pointer to a asynchronous notification interface. */ * Asynchronous media interface. * Makes up the fundation for PDMIBLOCKASYNC and PDMIBLOCKBIOS. * Notify completion of a task. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvUser The user argument given in pfnStartWrite. /** Pointer to a asynchronous media interface. */ * Asynchronous media interface. * Makes up the fundation for PDMIBLOCKASYNC and PDMIBLOCKBIOS. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start reading from. * @param pSeg Pointer to the first element in the scatter list. * @param cSeg Number of entries in the list. * @param cbRead Number of bytes to read. * @param pvUser User data. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. * @param pSeg Pointer to the first element in the gather list. * @param cSeg Number of entries in the list. * @param cbWrite Number of bytes to write. * @param pvUser User data. /** Pointer to a async media notify interface. */ * Notification interface for completed I/O tasks. * Pair with PDMITRANSPORTASYNC. * Notify completion of tasks. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvUser The user argument given in pfnTasksSubmit. /** Pointer to a async media interface. */ * Asynchronous transport interface. * Makes up the fundation for PDMIMEDIAASYNC. * @returns VBox status code. * @param pInterface Pointer to the interface structure containint the called function pointer. * @param pStorage The storage handle to read from. * @param off Offset to start reading from. * @param pvBuf Where to store the read bits. * @param cbRead Number of bytes to read. * @param pcbRead Where to store the number of bytes actually read. * Write bits synchronous. * @returns VBox status code. * @param pInterface Pointer to the interface structure containint the called function pointer. * @param pStorage The storage handle to write to. * @param off Offset to start reading from. * @param pvBuf Pointer to the buffer which contains the data to write. * @param cbWrite Number of bytes to read. * @param pcbWritten Where to store the number of bytes actually read. * Make sure that the bits written are actually on the storage medium. * This is a synchronous task * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pStorage The storage handle to flush- * Get the media size in bytes. * @returns Media size in bytes. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pStorage The storage handle. * Check if the media is readonly or not. * @returns true if readonly. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pStorage The storage handle. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pszPath The path to open. * @param fReadonly If the target shoudl opened readonly. * @param ppStorage Where to store the storage handle. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pStorage The storage handle to close. * Prepare an asynchronous read task. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pStorage The storage handle. * @param uOffset The offset to start reading from. * @param pvBuf Where to store read bits. * @param cbRead How many bytes to read. * @param ppTask Where to store the opaque task handle. * Prepare an asynchronous write task. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pStorage The storage handle. * @param uOffset The offset to start writing to. * @param pvBuf Where to read the data from. * @param cbWrite How many bytes to write. * @param ppTask Where to store the opaque task handle. * Submit an array of tasks for processing * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param apTasks Array of task handles to submit. * @param cTasks How many tasks to submit. * @param pvUser User data which is passed on completion. /** @name Bit mask definitions for status line type /** Pointer to a char port interface. */ * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Where the read bits are stored. * @param pcbRead Number of bytes available for reading/having been read. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param fNewStatusLine New state of the status line pins. /** Pointer to a char interface. */ * Pair with PDMICHARPORT. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Where to store the write bits. * @param cbWrite Number of bytes to write. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param Bps Speed of the serial connection. (bits per second) * @param chParity Parity method: 'E' - even, 'O' - odd, 'N' - none. * @param cDataBits Number of data bits. * @param cStopBits Number of stop bits. * Set the state of the modem lines. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param fRequestToSend Set to true to make the Request to Send line active otherwise to 0. * @param fDataTerminalReady Set to true to make the Data Terminal Ready line active otherwise 0. /** Pointer to a stream interface. */ * Makes up the foundation for PDMICHAR. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Where to store the read bits. * @param cbRead Number of bytes to read/bytes actually read. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Where to store the write bits. * @param cbWrite Number of bytes to write/bytes actually written. /** Mode of the parallel port */ /** Pointer to a host parallel port interface. */ * Host parallel port interface. * Pair with PDMIHOSTPARALLELCONNECTOR. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Where the read bits are stored. * @param pcbRead Number of bytes available for reading/having been read. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. /** Pointer to a Host Parallel connector interface. */ * Host parallel connector interface * Pair with PDMIHOSTPARALLELPORT. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Where to store the write bits. * @param pcbWrite Number of bytes to write/bytes actually written. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Where to store the read bits. * @param pcbRead Number of bytes to read/bytes actually read. * Write control register bits. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param fReg The new control register value. * Read control register bits. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pfReg Where to store the control register bits. * Read status register bits. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pfReg Where to store the status register bits. * Set mode of the host parallel port. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param enmMode The mode of the host parallel port. /** ACPI power source identifier */ /** Pointer to ACPI battery state. */ /** ACPI battey capacity */ /** Pointer to ACPI battery capacity. */ /** ACPI battery state. See ACPI 3.0 spec '_BST (Battery Status)' */ /** Pointer to ACPI battery state. */ /** Pointer to an ACPI port interface. */ * Send an ACPI power off event. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * Send an ACPI sleep button event. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * Check if the last power button event was handled by the guest. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pfHandled Is set to true if the last power button event was handled, false otherwise. /** Pointer to an ACPI connector interface. */ * ACPI connector interface. * Get the current power source of the host system. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * @param penmPowerSource Pointer to the power source result variable. * Query the current battery status of the host system. * @returns VBox status code? * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pfPresent Is set to true if battery is present, false otherwise. * @param penmRemainingCapacity Pointer to the battery remaining capacity (0 - 100 or 255 for unknown). * @param penmBatteryState Pointer to the battery status. * @param pu32PresentRate Pointer to the present rate (0..1000 of the total capacity). /** Pointer to a VMMDevice port interface. */ * VMMDevice port interface. * Return the current absolute mouse position in pixels * @returns VBox status code * @param pAbsX Pointer of result value, can be NULL * @param pAbsY Pointer of result value, can be NULL * Set the new absolute mouse position in pixels * @returns VBox status code * @param absX New absolute X position * @param absY New absolute Y position * Return the current mouse capability flags * @returns VBox status code * @param pCapabilities Pointer of result value * Set the current mouse capability flag (host side) * @returns VBox status code * @param capabilities Capability mask * Issue a display resolution change request. * Note that there can only one request in the queue and that in case the guest does * not process it, issuing another request will overwrite the previous. * @returns VBox status code * @param cx Horizontal pixel resolution (0 = do not change). * @param cy Vertical pixel resolution (0 = do not change). * @param cBits Bits per pixel (0 = do not change). * @param display The display index. * Pass credentials to guest. * Note that there can only be one set of credentials and the guest may or may not * query them and may do whatever it wants with them. * @returns VBox status code * @param pszUsername User name, may be empty (UTF-8) * @param pszPassword Password, may be empty (UTF-8) * @param pszDomain Domain name, may be empty (UTF-8) * Notify the driver about a VBVA status change. * @returns Nothing. Because it is informational callback. * @param fEnabled Current VBVA status. * Issue a seamless mode change request. * Note that there can only one request in the queue and that in case the guest does * not process it, issuing another request will overwrite the previous. * @returns VBox status code * @param fEnabled Seamless mode enabled or not * Issue a memory balloon change request. * Note that there can only one request in the queue and that in case the guest does * not process it, issuing another request will overwrite the previous. * @returns VBox status code * @param ulBalloonSize Balloon size in megabytes * Issue a statistcs interval change request. * Note that there can only one request in the queue and that in case the guest does * not process it, issuing another request will overwrite the previous. * @returns VBox status code * @param ulStatInterval Statistics query interval in seconds (0=disable) * Notify the guest about a VRDP status change. * @returns VBox status code * @param fVRDPEnabled Current VRDP status. * @param u32VRDPExperienceLevel Which visual effects to be disabled in the guest. /** Forward declaration of the video accelerator command memory. */ /** Forward declaration of the guest information structure. */ /** Forward declaration of the guest statistics structure */ /** Pointer to video accelerator command memory. */ /** Pointer to a VMMDev connector interface. */ * VMMDev connector interface. * Pair with PDMIVMMDEVPORT. * Report guest OS version. * Called whenever the Additions issue a guest version report request. * @param pInterface Pointer to this interface. * @param pGuestInfo Pointer to guest information structure * @thread The emulation thread. * Update the guest additions capabilities. * This is called when the guest additions capabilities change. The new capabilities * are given and the connector should update its internal state. * @param pInterface Pointer to this interface. * @param newCapabilities New capabilities. * @thread The emulation thread. * Update the mouse capabilities. * This is called when the mouse capabilities change. The new capabilities * are given and the connector should update its internal state. * @param pInterface Pointer to this interface. * @param newCapabilities New capabilities. * @thread The emulation thread. * Update the pointer shape. * This is called when the mouse pointer shape changes. The new shape * is passed as a caller allocated buffer that will be freed after returning * @param pInterface Pointer to this interface. * @param fVisible Visibility indicator (if false, the other parameters are undefined). * @param fAlpha Flag whether alpha channel is being passed. * @param xHot Pointer hot spot x coordinate. * @param yHot Pointer hot spot y coordinate. * @param x Pointer new x coordinate on screen. * @param y Pointer new y coordinate on screen. * @param cx Pointer width in pixels. * @param cy Pointer height in pixels. * @param cbScanline Size of one scanline in bytes. * @param pvShape New shape buffer. * @thread The emulation thread. * Enable or disable video acceleration on behalf of guest. * @param pInterface Pointer to this interface. * @param fEnable Whether to enable acceleration. * @param pVbvaMemory Video accelerator memory. * @return VBox rc. VINF_SUCCESS if VBVA was enabled. * @thread The emulation thread. * Force video queue processing. * @param pInterface Pointer to this interface. * @thread The emulation thread. * @returns VBox status code * @param pInterface Pointer to this interface. * @param cy Video mode horizontal resolution in pixels. * @param cx Video mode vertical resolution in pixels. * @param cBits Video mode bits per pixel. * @param pfSupported Where to put the indicator for whether this mode is supported. (output) * @thread The emulation thread. * Queries by how many pixels the height should be reduced when calculating video modes * @returns VBox status code * @param pInterface Pointer to this interface. * @param pcyReduction Pointer to the result value. * @thread The emulation thread. * Informs about a credentials judgement result from the guest. * @returns VBox status code * @param pInterface Pointer to this interface. * @param fFlags Judgement result flags. * @thread The emulation thread. * Set the visible region of the display * @returns VBox status code. * @param pInterface Pointer to this interface. * @param cRect Number of rectangles in pRect * @param pRect Rectangle array * @thread The emulation thread. * Query the visible region of the display * @returns VBox status code. * @param pInterface Pointer to this interface. * @param pcRect Number of rectangles in pRect * @param pRect Rectangle array (set to NULL to query the number of rectangles) * @thread The emulation thread. * Request the statistics interval * @returns VBox status code. * @param pInterface Pointer to this interface. * @param pulInterval Pointer to interval in seconds * @thread The emulation thread. * Report new guest statistics * @returns VBox status code. * @param pInterface Pointer to this interface. * @param pGuestStats Guest statistics * @thread The emulation thread. * Inflate or deflate the memory balloon * @returns VBox status code. * @param pInterface Pointer to this interface. * @param fInflate Inflate or deflate * @param cPages Number of physical pages (must be 256 as we allocate in 1 MB chunks) * @param aPhysPage Array of physical page addresses * @thread The emulation thread. /** Pointer to a network port interface */ * Network port interface. * Wait until there is space for receiving data. We do not care how much space is available * because pfnReceive() will re-check and notify the guest if necessary. * This function must be called before the pfnRecieve() method is called. * @returns VBox status code. VINF_SUCCESS means there is at least one receive descriptor available. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param cMillies Number of milliseconds to wait. 0 means return immediately. * Receive data from the network. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf The available data. * @param cb Number of bytes available in the buffer. /** The link is temporarily down while resuming. */ /** Pointer to a network connector interface */ * Network connector interface. * Send data to the network. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pvBuf Data to send. * @param cb Number of bytes to send. * This is called when the promiscuous mode is set. This means that there doesn't have * to be a mode change when it's called. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param fPromiscuous Set if the adaptor is now in promiscuous mode. Clear if it is not. * Notification on link status changes. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param enmLinkState The new link state. /** Pointer to a network config port interface */ * Network config port interface. * Gets the current Media Access Control (MAC) address. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pMac Where to store the MAC address. * Gets the new link state. * @returns The current link state. * @param pInterface Pointer to the interface structure containing the called function pointer. * Sets the new link state. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param enmState The new link state /** Pointer to a network connector interface */ * Audio connector interface. /* DECLR3CALLBACKMEMBER(int, pfnSetRecordSource,(PPDMIAUDIOINCONNECTOR pInterface, AUDIORECSOURCE)); */ /** @todo r=bird: the two following interfaces are hacks to work around the missing audio driver * interface. This should be addressed rather than making more temporary hacks. */ /** Pointer to a Audio Sniffer Device port interface. */ * Audio Sniffer port interface. * Enables or disables sniffing. If sniffing is being enabled also sets a flag * whether the audio must be also left on the host. * @returns VBox status code * @param pInterface Pointer to this interface. * @param fEnable 'true' for enable sniffing, 'false' to disable. * @param fKeepHostAudio Indicates whether host audio should also present * 'true' means that sound should not be played /** Pointer to a Audio Sniffer connector interface. */ * Audio Sniffer connector interface. * Pair with PDMIAUDIOSNIFFERPORT. * AudioSniffer device calls this method when audio samples * are about to be played and sniffing is enabled. * @param pInterface Pointer to this interface. * @param pvSamples Audio samples buffer. * @param cSamples How many complete samples are in the buffer. * @param iSampleHz The sample frequency in Hz. * @param cChannels Number of channels. 1 for mono, 2 for stereo. * @param cBits How many bits a sample for a single channel has. Normally 8 or 16. * @param fUnsigned Whether samples are unsigned values. * @thread The emulation thread. * AudioSniffer device calls this method when output volume is changed. * @param pInterface Pointer to this interface. * @param u16LeftVolume 0..0xFFFF volume level for left channel. * @param u16RightVolume 0..0xFFFF volume level for right channel. * @thread The emulation thread. * Generic status LED core. * Note that a unit doesn't have to support all the indicators. /** LED bit masks for the u32 view. * Note that a unit doesn't have to support all the indicators. /** Just a magic for sanity checking. */ /** The actual LED status. * Only the device is allowed to change this. */ /** The asserted LED status which is cleared by the reader. * The device will assert the bits but never clear them. * The driver clears them as it sees fit. */ /** Pointer to an LED. */ /** Pointer to a const LED. */ /** Pointer to an LED ports interface. */ * Interface for exporting LEDs. * Gets the pointer to the status LED of a unit. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param iLUN The unit which status LED we desire. * @param ppLed Where to store the LED pointer. /** Pointer to an LED connectors interface. */ * Interface for reading LEDs. * Notification about a unit which have been changed. * The driver must discard any pointers to data owned by * the unit and requery it. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param iLUN The unit number. /** The special status unit number */ /** Abstract HGCM command structure. Used only to define a typed pointer. */ /** Pointer to HGCM command structure. This pointer is unique and identifies * the command being processed. The pointer is passed to HGCM connector methods, * and must be passed back to HGCM port when command is completed. /** Pointer to a HGCM port interface. */ * HGCM port interface. Normally implemented by VMMDev. * Notify the guest on a command completion. * @param pInterface Pointer to this interface. * @param rc The return code (VBox error code). * @param pCmd A pointer that identifies the completed command. * @returns VBox status code /** Pointer to a HGCM connector interface. */ /** Pointer to a HGCM service location structure. */ * HGCM connector interface. * Pair with PDMIHGCMPORT. * Locate a service and inform it about a client connection. * @param pInterface Pointer to this interface. * @param pCmd A pointer that identifies the command. * @param pServiceLocation Pointer to the service location structure. * @param pu32ClientID Where to store the client id for the connection. * @return VBox status code. * @thread The emulation thread. * Disconnect from service. * @param pInterface Pointer to this interface. * @param pCmd A pointer that identifies the command. * @param u32ClientID The client id returned by the pfnConnect call. * @return VBox status code. * @thread The emulation thread. * Process a guest issued command. * @param pInterface Pointer to this interface. * @param pCmd A pointer that identifies the command. * @param u32ClientID The client id returned by the pfnConnect call. * @param u32Function Function to be performed by the service. * @param cParms Number of parameters in the array pointed to by paParams. * @param paParms Pointer to an array of parameters. * @return VBox status code. * @thread The emulation thread.