pdmifs.h revision a45c5d38c12aa76734683de26be5a6cd9a3c6571
* Queries an interface to the driver. * @returns Pointer to interface. * @returns NULL if the interface was not supported by the driver. * @param pInterface Pointer to this interface structure. * @param pszIID The interface ID, a UUID string. /** PDMIBASE interface ID. */ * Helper macro for quering an interface from PDMIBASE. * @returns Correctly typed PDMIBASE::pfnQueryInterface return value. * @param pIBase Pointer to the base interface. * @param InterfaceType The interface type name. The interface ID is * derived from this by appending _IID. * Helper macro for implementing PDMIBASE::pfnQueryInterface. * Return @a pInterface if @a pszIID matches the @a InterfaceType. This will * perform basic type checking. * @param pszIID The ID of the interface that is being queried. * @param InterfaceType The interface type name. The interface ID is * derived from this by appending _IID. * @param pInterface The interface address expression. * PDM Base Interface for querying ring-mode context interfaces in * This is mandatory for drivers present in raw-mode context. * Queries an ring-mode context interface to the driver. * @returns Pointer to interface. * @returns NULL if the interface was not supported by the driver. * @param pInterface Pointer to this interface structure. * @param pszIID The interface ID, a UUID string. /** Pointer to a PDM Base Interface for query ring-mode context interfaces. */ /** PDMIBASERC interface ID. */ * Helper macro for quering an interface from PDMIBASERC. * @returns PDMIBASERC::pfnQueryInterface return value. * @param pIBaseRC Pointer to the base ring-0 interface. * @param InterfaceType The interface type name. The interface ID is * derived from this by appending _IID. * @remarks Unlike PDMIBASE_QUERY_INTERFACE, this macro is not able to do any * implicit type checking for you. * Helper macro for implementing PDMIBASERC::pfnQueryInterface. * Return @a pInterface if @a pszIID matches the @a InterfaceType. This will * perform basic type checking. * @param pIns Pointer to the instance data. * @param pszIID The ID of the interface that is being queried. * @param InterfaceType The interface type name. The interface ID is * derived from this by appending _IID. * @param pInterface The interface address expression. This must resolve * to some address within the instance data. * PDM Base Interface for querying ring-0 interfaces in ring-3. * This is mandatory for drivers present in ring-0 context. * Queries an ring-0 interface to the driver. * @returns Pointer to interface. * @returns NULL if the interface was not supported by the driver. * @param pInterface Pointer to this interface structure. * @param pszIID The interface ID, a UUID string. /** Pointer to a PDM Base Interface for query ring-0 context interfaces. */ /** PDMIBASER0 interface ID. */ * Helper macro for quering an interface from PDMIBASER0. * @returns PDMIBASER0::pfnQueryInterface return value. * @param pIBaseR0 Pointer to the base ring-0 interface. * @param InterfaceType The interface type name. The interface ID is * derived from this by appending _IID. * @remarks Unlike PDMIBASE_QUERY_INTERFACE, this macro is not able to do any * implicit type checking for you. * Helper macro for implementing PDMIBASER0::pfnQueryInterface. * Return @a pInterface if @a pszIID matches the @a InterfaceType. This will * perform basic type checking. * @param pIns Pointer to the instance data. * @param pszIID The ID of the interface that is being queried. * @param InterfaceType The interface type name. The interface ID is * derived from this by appending _IID. * @param pInterface The interface address expression. This must resolve * to some address within the instance data. * 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. */ * Mouse port interface (down). * 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. Return VERR_TRY_AGAIN if you cannot process the * event now and want it to be repeated at a later point. * @param pInterface Pointer to this interface structure. * @param iDeltaX The X delta. * @param iDeltaY The Y delta. * @param iDeltaZ The Z delta. * @param iDeltaW The W (horizontal scroll button) delta. * @param fButtonStates The button states, see the PDMIMOUSEPORT_BUTTON_* \#defines. * Puts an absolute mouse event. * This is called by the source of mouse events. The event will be passed up * until the topmost driver, which then calls the registered event handler. * @returns VBox status code. Return VERR_TRY_AGAIN if you cannot process the * event now and want it to be repeated at a later point. * @param pInterface Pointer to this interface structure. * @param uX The X value, in the range 0 to 0xffff. * @param uY The Y value, in the range 0 to 0xffff. * @param iDeltaZ The Z delta. * @param iDeltaW The W (horizontal scroll button) delta. * @param fButtonStates The button states, see the PDMIMOUSEPORT_BUTTON_* \#defines. /** PDMIMOUSEPORT interface ID. */ /** Mouse button defines for PDMIMOUSEPORT::pfnPutEvent. /** Pointer to a mouse connector interface. */ * Mouse connector interface (up). * Pair with PDMIMOUSEPORT. * Notifies the the downstream driver of changes to the reporting modes * supported by the driver * @param pInterface Pointer to the this interface. * @param fRelative Whether relative mode is currently supported. * @param fAbsolute Whether absolute mode is currently supported. /** PDMIMOUSECONNECTOR interface ID. */ /** Pointer to a keyboard port interface. */ * Keyboard port interface (down). * 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. Return VERR_TRY_AGAIN if you cannot process the * event now and want it to be repeated at a later point. * @param pInterface Pointer to this interface structure. * @param u8KeyCode The keycode to queue. /** PDMIKEYBOARDPORT interface ID. */ /** Pointer to keyboard connector interface. */ * Keyboard connector interface (up). * 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. /** PDMIKEYBOARDCONNECTOR interface ID. */ /** Pointer to a display port interface. */ * Display port interface (down). * 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 screenshot of the display. * This will allocate and return a 32-bbp bitmap. Size of the bitmap scanline in bytes is 4*width. * The allocated bitmap buffer must be freed with pfnFreeScreenshot. * @param pInterface Pointer to this interface. * @param ppu8Data Where to store the pointer to the allocated buffer. * @param pcbData Where to store the actual size of the bitmap. * @param pcx Where to store the width of the bitmap. * @param pcy Where to store the height of the bitmap. * @thread The emulation thread. * Free screenshot buffer. * This will free the memory buffer allocated by pfnTakeScreenshot. * @param pInterface Pointer to this interface. * @param ppu8Data Pointer to the buffer returned by pfnTakeScreenshot. * 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. * 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. /** PDMIDISPLAYPORT interface ID. */ typedef struct _VBOXVHWACMD *
PVBOXVHWACMD;
/**< @todo r=bird: _VBOXVHWACMD -> VBOXVHWACMD; avoid using 1 or 2 leading underscores. Also, a line what it is to make doxygen happy. */ /** Pointer to a display connector interface. */ * Display connector interface (up). * 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. * Process the guest Video HW Acceleration command. * @param pInterface Pointer to this interface. * @param pCmd Video HW Acceleration Command to be processed. * @thread The emulation thread. * The specified screen enters VBVA mode. * @param pInterface Pointer to this interface. * @param uScreenId The screen updates are for. * @thread The emulation thread. * The specified screen leaves VBVA mode. * @param pInterface Pointer to this interface. * @param uScreenId The screen updates are for. * @thread The emulation thread. * A sequence of pfnVBVAUpdateProcess calls begins. * @param pInterface Pointer to this interface. * @param uScreenId The screen updates are for. * @thread The emulation thread. * Process the guest VBVA command. * @param pInterface Pointer to this interface. * @param pCmd Video HW Acceleration Command to be processed. * @thread The emulation thread. * A sequence of pfnVBVAUpdateProcess calls ends. * @param pInterface Pointer to this interface. * @param uScreenId The screen updates are for. * @param x The upper left corner x coordinate of the combined rectangle of all VBVA updates. * @param y The upper left corner y coordinate of the rectangle. * @param cx The width of the rectangle. * @param cy The height of the rectangle. * @thread The emulation thread. * This is called when the resolution changes. This usually happens on * request from the guest os, but may also happen as the result of a reset. * If the callback returns VINF_VGA_RESIZE_IN_PROGRESS, the caller (VGA device) * must not access the connector and return. * @todo Merge with pfnResize. * @returns VINF_SUCCESS if the framebuffer resize was completed, * VINF_VGA_RESIZE_IN_PROGRESS if resize takes time and not yet finished. * @param pInterface Pointer to this interface. * @param pView The description of VRAM block for this screen. * @param pScreen The data of screen being resized. * @param pvVRAM Address of the guest VRAM. * @thread The emulation thread. * 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. /** 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. */ /** PDMIDISPLAYCONNECTOR interface ID. */ * Block notify interface (down). /** PDMIBLOCKPORT interface ID. */ /** Pointer to a block notify interface (dummy). */ /** 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. /** 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. The offset must be aligned to a sector boundary. * @param pvBuf Where to store the read bits. * @param cbRead Number of bytes to read. Must be aligned to a sector boundary. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. The offset must be aligned to a sector boundary. * @param pvBuf Where to store the write bits. * @param cbWrite Number of bytes to write. Must be aligned to a sector boundary. * 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. /** PDMIBLOCK interface ID. */ /** 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. /** PDMIMOUNTNOTIFY interface ID. */ /** Pointer to mount interface. */ * Mount interface (down). * 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. /** PDMIMOUNT interface ID. */ * 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. No interface pair. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start reading from. The offset must be aligned to a sector boundary. * @param pvBuf Where to store the read bits. * @param cbRead Number of bytes to read. Must be aligned to a sector boundary. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. The offset must be aligned to a sector boundary. * @param pvBuf Where to store the write bits. * @param cbWrite Number of bytes to write. Must be aligned to a sector boundary. * 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. /** PDMIMEDIA interface ID. */ /** Pointer to a block BIOS interface. */ * Media BIOS interface (Up / External). * 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. /** PDMIBLOCKBIOS interface ID. */ /** 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. /** Pointer to a asynchronous block notify interface. */ * Asynchronous block notify interface (up). * 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. /** PDMIBLOCKASYNCPORT interface ID. */ /** Pointer to a asynchronous block interface. */ * Asynchronous block interface (down). * 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.c * @param pSeg Pointer to the first element in the scatter list. * @param cSeg Number of entries in the list. * @param cbRead Number of bytes to read. Must be aligned to a sector boundary. * @param pvUser User argument which is returned in completion callback. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. The offset must be aligned to a sector boundary. * @param pSeg Pointer to the first element in the gather list. * @param cSeg Number of entries in the list. * @param cbWrite Number of bytes to write. Must be aligned to a sector boundary. * @param pvUser User argument which is returned in completion callback. /** PDMIBLOCKASYNC interface ID. */ /** Pointer to a asynchronous notification interface. */ * Asynchronous version of the media interface (up). * Pair with PDMIMEDIAASYNC. * 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. /** PDMIMEDIAASYNCPORT interface ID. */ /** Pointer to a asynchronous media interface. */ * Asynchronous version of PDMIMEDIA (down). * Pair with PDMIMEDIAASYNCPORT. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start reading from. Must be aligned to a sector boundary. * @param pSeg Pointer to the first element in the scatter list. * @param cSeg Number of entries in the list. * @param cbRead Number of bytes to read. Must be aligned to a sector boundary. * @param pvUser User data. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param off Offset to start writing at. Must be aligned to a sector boundary. * @param pSeg Pointer to the first element in the gather list. * @param cSeg Number of entries in the list. * @param cbWrite Number of bytes to write. Must be aligned to a sector boundary. * @param pvUser User data. /** PDMIMEDIAASYNC interface ID. */ /** Pointer to a char port interface. */ * Char port interface (down). * Pair with PDMICHARCONNECTOR. * @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. * @returns VBox statsus code. * @param pInterface Pointer to the interface structure containing the called function pointer. /** PDMICHARPORT interface ID. */ /** @name Bit mask definitions for status line type. /** Pointer to a char interface. */ * Char connector interface (up). * 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. * Sets the TD line into break condition. * @returns VBox status code. * @param pInterface Pointer to the interface structure containing the called function pointer. * @param fBreak Set to true to let the device send a break false to put into normal operation. /** PDMICHARCONNECTOR interface ID. */ /** Pointer to a stream interface. */ * Makes up the foundation for PDMICHARCONNECTOR. No pair interface. * @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. /** PDMISTREAM interface ID. */ /** Mode of the parallel port */ /** Pointer to a host parallel port interface. */ * Host parallel port interface (down). * 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. /** PDMIHOSTPARALLELPORT interface ID. */ /** Pointer to a Host Parallel connector interface. */ * Host parallel connector interface (up). * 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. /** PDMIHOSTPARALLELCONNECTOR interface ID. */ /** 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. */ * ACPI port interface (down). Used by both the ACPI driver and (grumble) main. * Pair with PDMIACPICONNECTOR. * Send an ACPI power off event. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * Send an ACPI sleep button event. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * Check if the last power button event was handled by the guest. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pfHandled Is set to true if the last power button event was handled, false otherwise. * Check if the guest entered the ACPI mode. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * @param pfEnabled Is set to true if the guest entered the ACPI mode, false otherwise. * Check if the given CPU is still locked by the guest. * @returns VBox status code * @param pInterface Pointer to the interface structure containing the called function pointer. * @param uCpu The CPU to check for. * @param pfLocked Is set to true if the CPU is still locked by the guest, false otherwise. /** PDMIACPIPORT interface ID. */ /** Pointer to an ACPI connector interface. */ * ACPI connector interface (up). * Pair with PDMIACPIPORT. * 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). /** PDMIACPICONNECTOR interface ID. */ /** Pointer to a VMMDevice port interface. */ * VMMDevice port interface (down). * Pair with PDMIVMMDEVCONNECTOR. * 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). * @param fFlags VMMDEV_SETCREDENTIALS_*. * 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. * Notify the guest of CPU hot-unplug event. * @returns VBox status code * @param idCpuCore The core id of the CPU to remove. * @param idCpuPackage The package id of the CPU to remove. * Notify the guest of CPU hot-plug event. * @returns VBox status code * @param idCpuCore The core id of the CPU to add. * @param idCpuPackage The package id of the CPU to add. /** PDMIVMMDEVPORT interface ID. */ /** Pointer to a HPET legacy notifcation interface. */ * HPET legacy notifcation interface. * Notify about change of HPET legacy mode. * @param pInterface Pointer to the interface structure containing the * called function pointer. * @param fActivated If HPET legacy mode is activated (@c true) or * deactivated (@c false). /** PDMIHPETLEGACYNOTIFY interface ID. */ /** @name Flags for PDMIVMMDEVPORT::pfnSetCredentials. /** The guest should perform a logon with the credentials. */ /** The guest should prevent local logons. */ /** The guest should verify the credentials. */ /** 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 (up). * 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. /** PDMIVMMDEVCONNECTOR interface ID. */ /** Pointer to a network connector interface */ * Audio connector interface (up). /* DECLR3CALLBACKMEMBER(int, pfnSetRecordSource,(PPDMIAUDIOINCONNECTOR pInterface, AUDIORECSOURCE)); */ /** PDMIAUDIOCONNECTOR interface ID. */ /** @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 (down). * Pair with PDMIAUDIOSNIFFERCONNECTOR. * Enables or disables sniffing. * If sniffing is being enabled also sets a flag whether the audio must be also * @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 /** PDMIAUDIOSNIFFERPORT interface ID. */ /** Pointer to a Audio Sniffer connector interface. */ * Audio Sniffer connector interface (up). * 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. /** PDMIAUDIOSNIFFERCONNECTOR - The Audio Sniffer Driver connector interface. */ * 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. */ /** Magic value for PDMLED::u32Magic. */ /** Pointer to an LED ports interface. */ * Interface for exporting LEDs (down). * Pair with PDMILEDCONNECTORS. * 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. /** PDMILEDPORTS interface ID. */ /** Pointer to an LED connectors interface. */ * Interface for reading LEDs (up). * Pair with PDMILEDPORTS. * 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. /** PDMILEDCONNECTORS interface ID. */ /** 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. */ * Host-Guest communication manager port interface (down). Normally implemented * Pair with PDMIHGCMCONNECTOR. * Notify the guest on a command completion. * @param pInterface Pointer to this interface. * @param rc The return code (VBox error code). * @param pCmd A pointer that identifies the completed command. * @returns VBox status code /** PDMIHGCMPORT interface ID. */ /** Pointer to a HGCM service location structure. */ /** Pointer to a HGCM connector interface. */ * The Host-Guest communication manager connector interface (up). Normally * implemented by Main::VMMDevInterface. * 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. /** PDMIHGCMCONNECTOR interface ID. */ #
endif /* VBOX_WITH_HGCM */ * SCSI request structure. /** Direction of the data flow. */ /** Size of the SCSI CDB. */ /** Pointer to the SCSI CDB. */ /** Overall size of all scatter gather list elements * for data transfer if any. */ /** Number of elements in the scatter gather list. */ /** Pointer to the head of the scatter gather list. */ /** Size of the sense buffer. */ /** Pointer to the sense buffer. * * Current assumption that the sense buffer is not scattered. */ /** Opaque user data for use by the device. Left untouched by everything else! */ /** Pointer to a const SCSI request structure. */ /** Pointer to a SCSI port interface. */ * SCSI command execution port interface (down). * Pair with PDMISCSICONNECTOR. * Notify the device on request completion. * @returns VBox status code. * @param pInterface Pointer to this interface. * @param pSCSIRequest Pointer to the finished SCSI request. * @param rcCompletion SCSI_STATUS_* code for the completed request. /** PDMISCSIPORT interface ID. */ /** Pointer to a SCSI connector interface. */ * SCSI command execution connector interface (up). * Pair with PDMISCSIPORT. * Submits a SCSI request for execution. * @returns VBox status code. * @param pInterface Pointer to this interface. * @param pSCSIRequest Pointer to the SCSI request to execute. /** PDMISCSICONNECTOR interface ID. */ /** Pointer to a display VBVA callbacks interface. */ * Display VBVA callbacks interface (up). * Informs guest about completion of processing the given Video HW Acceleration * command, does not wait for the guest to process the command. * @param pInterface Pointer to this interface. * @param pCmd The Video HW Acceleration Command that was * @todo r=bird: if asynch means asyncronous; then /** PDMIDISPLAYVBVACALLBACKS */