vboxvideo.h revision 86ada7c88cb99860e17b13260838b877ffbbb61a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * VirtualBox X11 Additions graphics driver
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (C) 2006-2013 Oracle Corporation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This file is part of VirtualBox Open Source Edition (OSE), as
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * available from http://www.virtualbox.org. This file is free software;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * you can redistribute it and/or modify it under the terms of the GNU
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * General Public License (GPL) as published by the Free Software
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Foundation, in version 2 as it comes in the "COPYING" file of the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * --------------------------------------------------------------------
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * This code is based on:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * X11 VESA driver
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Copyright (c) 2000 by Conectiva S.A. (http://www.conectiva.com)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Permission is hereby granted, free of charge, to any person obtaining a
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * copy of this software and associated documentation files (the "Software"),
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * to deal in the Software without restriction, including without limitation
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * the rights to use, copy, modify, merge, publish, distribute, sublicense,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * and/or sell copies of the Software, and to permit persons to whom the
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Software is furnished to do so, subject to the following conditions:
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * The above copyright notice and this permission notice shall be included in
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * all copies or substantial portions of the Software.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * CONECTIVA LINUX BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Except as contained in this notice, the name of Conectiva Linux shall
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * not be used in advertising or otherwise to promote the sale, use or other
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * dealings in this Software without prior written authorization from
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Conectiva Linux.
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * Authors: Paulo César Pereira de Andrade <pcpa@conectiva.com.br>
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * $XFree86: xc/programs/Xserver/hw/xfree86/drivers/vesa/vesa.h,v 1.9 2001/05/04 19:05:49 dawes Exp $
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster# define TRACE_LINE() do \
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster ErrorF ("%s: line %d\n", __FUNCTION__, __LINE__); \
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster ErrorF ("at %s (%s:%d)\n", __PRETTY_FUNCTION__, __FILE__, __LINE__); \
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#else /* !DEBUG */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define TRACE_ENTRY() do { } while (0)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define TRACE_EXIT() do { } while (0)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define TRACE_LOG(...) do { } while (0)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#endif /* !DEBUG */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/* DRI support */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/* Hack to work around a libdrm header which is broken on Solaris */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/* Get rid of a warning due to a broken header file */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/* For some reason this is not in the header files. */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void GlxSetVisualConfigs(int nconfigs, __GLXvisualConfig *configs,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define VBOX_DRM_DRIVER_NAME "vboxvideo" /* For now, as this driver is basically a stub. */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define VBOX_DRI_DRIVER_NAME "vboxvideo" /* For starters. */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#define VBOXPTR(p) ((VBOXPtr)((p)->driverPrivate))
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fostertypedef struct VBOXRec
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** The amount of VRAM available for use as a framebuffer */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster unsigned long cbFBMax;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** The size of the framebuffer and the VBVA buffers at the end of it. */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster unsigned long cbView;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** The current line size in bytes */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Whether the pre-X-server mode was a VBE mode */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Paramters of the saved pre-X-server VBE mode, invalid if there is none
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster uint16_t cSavedWidth, cSavedHeight, cSavedPitch, cSavedBPP, fSavedFlags;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Default X server procedure for enabling and disabling framebuffer access */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster xf86EnableDisableFBAccessProc *EnableDisableFBAccess;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** @todo we never actually free this */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Do we know that the guest can handle absolute co-ordinates? */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Does this host support sending graphics commands using HGSMI? */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Number of screens attached */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Position information for each virtual screen for the purposes of
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster * sending dirty rectangle information to the right one. */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster RTRECT2 aScreenLocation[VBOX_VIDEO_MAX_SCREENS];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** The last requested framebuffer size. */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Has this screen been disabled by the guest? */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** The virtual crtcs */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster struct _xf86Crtc *paCrtcs[VBOX_VIDEO_MAX_SCREENS];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster struct _xf86Output *paOutputs[VBOX_VIDEO_MAX_SCREENS];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Offsets of VBVA buffers in video RAM */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster uint32_t aoffVBVABuffer[VBOX_VIDEO_MAX_SCREENS];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Context information about the VBVA buffers for each screen */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster struct VBVABUFFERCONTEXT aVbvaCtx[VBOX_VIDEO_MAX_SCREENS];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** The current preferred resolution for the screen */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster RTRECTSIZE aPreferredSize[VBOX_VIDEO_MAX_SCREENS];
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** HGSMI guest heap context */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster /** Unrestricted horizontal resolution flag. */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vbox_init(int scrnIndex, VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vbox_cursor_init (ScreenPtr pScreen);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vbox_open (ScrnInfoPtr pScrn, ScreenPtr pScreen, VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void vbox_close (ScrnInfoPtr pScrn, VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vbox_device_available(VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vboxEnableGraphicsCap(VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vboxDisableGraphicsCap(VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vboxGuestIsSeamless(ScrnInfoPtr pScrn);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vboxGetDisplayChangeRequest(ScrnInfoPtr pScrn, uint32_t *pcx,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vboxHostLikesVideoMode(ScrnInfoPtr pScrn, uint32_t cx, uint32_t cy, uint32_t cBits);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vboxSaveVideoMode(ScrnInfoPtr pScrn, uint32_t cx, uint32_t cy, uint32_t cBits);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool vboxRetrieveVideoMode(ScrnInfoPtr pScrn, uint32_t *pcx, uint32_t *pcy, uint32_t *pcBits);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern unsigned vboxNextStandardMode(ScrnInfoPtr pScrn, unsigned cIndex,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void vboxGetPreferredMode(ScrnInfoPtr pScrn, uint32_t iScreen,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void vboxWriteHostModes(ScrnInfoPtr pScrn, DisplayModePtr pCurrent);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void vboxAddModes(ScrnInfoPtr pScrn, uint32_t cxInit,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/* DRI stuff */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool VBOXDRIScreenInit(ScrnInfoPtr pScrn, ScreenPtr pScreen,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool VBOXDRIFinishScreenInit(ScreenPtr pScreen);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void VBOXDRIUpdateStride(ScrnInfoPtr pScrn, VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void VBOXDRICloseScreen(ScreenPtr pScreen, VBOXPtr pVBox);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/* EDID generation */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool VBOXEDIDSet(struct _xf86Output *output, DisplayModePtr pmode);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/* Utilities */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterstatic inline VBOXPtr VBOXGetRec(ScrnInfoPtr pScrn)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/** Calculate the BPP from the screen depth */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterstatic inline uint16_t vboxBPP(ScrnInfoPtr pScrn)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/** Calculate the scan line length for a display width */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterstatic inline int32_t vboxLineLength(ScrnInfoPtr pScrn, int32_t cDisplayWidth)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster uint32_t cbLine = (cDisplayWidth * vboxBPP(pScrn) / 8 + 3) & ~3;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster return cbLine < INT32_MAX ? cbLine : INT32_MAX;
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster/** Calculate the display pitch from the scan line length */
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterstatic inline int32_t vboxDisplayPitch(ScrnInfoPtr pScrn, int32_t cbLine)
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern void vboxClearVRAM(ScrnInfoPtr pScrn, int32_t cNewX, int32_t cNewY);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool VBOXSetMode(ScrnInfoPtr pScrn, unsigned cDisplay, unsigned cWidth,
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster unsigned cHeight, int x, int y);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Fosterextern Bool VBOXAdjustScreenPixmap(ScrnInfoPtr pScrn, int width, int height);
a688bcbb4bcff5398fdd29b86f83450257dc0df4Allan Foster#endif /* _VBOXVIDEO_H_ */