Initial revision

man/fbdev.man

+.\" $XFree86: xc/programs/Xserver/hw/xfree86/drivers/fbdev/fbdev.man,v 1.3 2001/10/02 15:57:32 alanh Exp $ 
+.\" shorthand for double quote that works everywhere.
+.ds q \N'34'
+.TH FBDEV __drivermansuffix__ __vendorversion__
+.SH NAME
+fbdev \- video driver for framebuffer device
+.SH SYNOPSIS
+.nf
+.B "Section \*qDevice\*q"
+.BI "  Identifier \*q"  devname \*q
+.B  "  Driver \*qfbdev\*q"
+.BI "  BusID  \*qpci:" bus : dev : func \*q
+\ \ ...
+.B EndSection
+.fi
+.SH DESCRIPTION
+.B fbdev
+is an XFree86 driver for framebuffer devices.  This is a non-accelerated
+driver, the following framebuffer depths are supported: 8, 15, 16, 24.
+All visual types are supported for depth 8, and TrueColor visual is
+supported for the other depths.  Multi-head configurations are supported.
+.SH SUPPORTED HARDWARE
+The 
+.B fbdev
+driver supports all hardware where a framebuffer driver is available.
+fbdev uses the os-specific submodule fbdevhw(__drivermansuffix__) to talk
+to the kernel
+device driver.  Currently a fbdevhw module is available for linux.
+.SH CONFIGURATION DETAILS
+Please refer to XF86Config(__filemansuffix__) for general configuration
+details.  This section only covers configuration details specific to
+this driver.
+.PP
+For this driver it is not required to specify modes in the screen 
+section of the config file.  The
+.B fbdev
+driver can pick up the currently used video mode from the framebuffer 
+driver and will use it if there are no video modes configured.
+.PP
+For PCI boards you might have to add a BusID line to the Device
+section.  See above for a sample line.  You can use "XFree86 -scanpci"
+to figure out the correct values.
+.PP
+The following driver 
+.B Options
+are supported:
+.TP
+.BI "Option \*qfbdev\*q \*q" string \*q
+The framebuffer device to use. Default: /dev/fb0.
+.TP
+.BI "Option \*qShadowFB\*q \*q" boolean \*q
+Enable or disable use of the shadow framebuffer layer.  Default: on.
+.TP
+.BI "Option \*qRotate\*q \*q" string \*q
+Enable rotation of the display. The supported values are "CW" (clockwise,
+90 degrees), "UD" (upside down, 180 degrees) and "CCW" (counter clockwise,
+270 degrees). Implies use of the shadow framebuffer layer.   Default: off.
+.SH "SEE ALSO"
+XFree86(1), XF86Config(__filemansuffix__), xf86config(1), Xserver(1),
+X(__miscmansuffix__), fbdevhw(__drivermansuffix__)
+.SH AUTHORS
+Authors include: Gerd Knorr, Michel Dänzer, Geert Uytterhoeven

src/fbdev.c

+/* $XFree86: xc/programs/Xserver/hw/xfree86/drivers/fbdev/fbdev.c,v 1.42 2002/10/10 01:35:20 dawes Exp $ */
+
+/*
+ * Authors:  Alan Hourihane, <alanh@fairlite.demon.co.uk>
+ *	     Michel Dnzer, <michdaen@iiic.ethz.ch>
+ */
+
+/* all driver need this */
+#include "xf86.h"
+#include "xf86_OSproc.h"
+#include "xf86_ansic.h"
+
+#include "mipointer.h"
+#include "mibstore.h"
+#include "micmap.h"
+#include "colormapst.h"
+#include "xf86cmap.h"
+#include "shadow.h"
+#include "dgaproc.h"
+
+/* for visuals */
+#include "fb.h"
+#ifdef USE_AFB
+#include "afb.h"
+#endif
+
+#include "xf86Resources.h"
+#include "xf86RAC.h"
+
+#include "fbdevhw.h"
+
+#ifdef XvExtension
+#include "xf86xv.h"
+#endif
+
+#define DEBUG 0
+
+#if DEBUG
+# define TRACE_ENTER(str)       ErrorF("fbdev: " str " %d\n",pScrn->scrnIndex)
+# define TRACE_EXIT(str)        ErrorF("fbdev: " str " done\n")
+# define TRACE(str)             ErrorF("fbdev trace: " str "\n")
+#else
+# define TRACE_ENTER(str)
+# define TRACE_EXIT(str)
+# define TRACE(str)
+#endif
+
+/* -------------------------------------------------------------------- */
+/* prototypes                                                           */
+
+static const OptionInfoRec * FBDevAvailableOptions(int chipid, int busid);
+static void	FBDevIdentify(int flags);
+static Bool	FBDevProbe(DriverPtr drv, int flags);
+static Bool	FBDevPreInit(ScrnInfoPtr pScrn, int flags);
+static Bool	FBDevScreenInit(int Index, ScreenPtr pScreen, int argc,
+				char **argv);
+static Bool	FBDevCloseScreen(int scrnIndex, ScreenPtr pScreen);
+static void *	FBDevWindowLinear(ScreenPtr pScreen, CARD32 row, CARD32 offset, int mode,
+				  CARD32 *size, void *closure);
+static void	FBDevPointerMoved(int index, int x, int y);
+static Bool	FBDevDGAInit(ScrnInfoPtr pScrn, ScreenPtr pScreen);
+
+
+enum { FBDEV_ROTATE_NONE=0, FBDEV_ROTATE_CW=270, FBDEV_ROTATE_UD=180, FBDEV_ROTATE_CCW=90 };
+
+/*static ShadowUpdateProc updateFuncs[] =
+  { shadowUpdatePacked, shadowUpdateRotate8_270, shadowUpdateRotate8_180, shadowUpdateRotate8_90,
+    shadowUpdatePacked, shadowUpdateRotate16_270, shadowUpdateRotate16_180, shadowUpdateRotate16_90,
+    shadowUpdatePacked, shadowUpdateRotate32_270, shadowUpdateRotate32_180, shadowUpdateRotate32_90 }; */
+
+
+/* -------------------------------------------------------------------- */
+
+/*
+ * This is intentionally screen-independent.  It indicates the binding
+ * choice made in the first PreInit.
+ */
+static int pix24bpp = 0;
+
+#define VERSION			4000
+#define FBDEV_NAME		"FBDEV"
+#define FBDEV_DRIVER_NAME	"fbdev"
+#define FBDEV_MAJOR_VERSION	0
+#define FBDEV_MINOR_VERSION	1
+
+DriverRec FBDEV = {
+	VERSION,
+	FBDEV_DRIVER_NAME,
+#if 0
+	"driver for linux framebuffer devices",
+#endif
+	FBDevIdentify,
+	FBDevProbe,
+	FBDevAvailableOptions,
+	NULL,
+	0
+};
+
+/* Supported "chipsets" */
+static SymTabRec FBDevChipsets[] = {
+    { 0, "fbdev" },
+#ifdef USE_AFB
+    { 0, "afb" },
+#endif
+    {-1, NULL }
+};
+
+/* Supported options */
+typedef enum {
+	OPTION_SHADOW_FB,
+	OPTION_ROTATE,
+	OPTION_FBDEV
+} FBDevOpts;
+
+static const OptionInfoRec FBDevOptions[] = {
+	{ OPTION_SHADOW_FB,	"ShadowFB",	OPTV_BOOLEAN,	{0},	FALSE },
+	{ OPTION_ROTATE,	"Rotate",	OPTV_STRING,	{0},	FALSE },
+	{ OPTION_FBDEV,		"fbdev",	OPTV_STRING,	{0},	FALSE },
+	{ -1,			NULL,		OPTV_NONE,	{0},	FALSE }
+};
+
+/* -------------------------------------------------------------------- */
+
+static const char *afbSymbols[] = {
+	"afbScreenInit",
+	"afbCreateDefColormap",
+	NULL
+};
+
+static const char *fbSymbols[] = {
+	"fbScreenInit",
+	"fbPictureInit",
+	NULL
+};
+
+static const char *shadowSymbols[] = {
+	"shadowAdd",
+	"shadowAlloc",
+	"shadowInit",
+	"shadowSetup",
+	"shadowUpdatePacked",
+	"shadowUpdateRotatePacked",
+	NULL
+};
+
+static const char *fbdevHWSymbols[] = {
+	"fbdevHWInit",
+	"fbdevHWProbe",
+	"fbdevHWSetVideoModes",
+	"fbdevHWUseBuildinMode",
+
+	"fbdevHWGetDepth",
+	"fbdevHWGetLineLength",
+	"fbdevHWGetName",
+	"fbdevHWGetType",
+	"fbdevHWGetVidmem",
+	"fbdevHWLinearOffset",
+	"fbdevHWLoadPalette",
+	"fbdevHWMapVidmem",
+	"fbdevHWUnmapVidmem",
+
+	/* colormap */
+	"fbdevHWLoadpalette",
+
+	/* ScrnInfo hooks */
+	"fbdevHWAdjustFrame",
+	"fbdevHWEnterVT",
+	"fbdevHWLeaveVT",
+	"fbdevHWModeInit",
+	"fbdevHWRestore",
+	"fbdevHWSave",
+	"fbdevHWSaveScreen",
+	"fbdevHWSwitchMode",
+	"fbdevHWValidMode",
+
+	"fbdevHWDPMSSet",
+
+	NULL
+};
+
+#ifdef XFree86LOADER
+
+MODULESETUPPROTO(FBDevSetup);
+
+static XF86ModuleVersionInfo FBDevVersRec =
+{
+	"fbdev",
+	MODULEVENDORSTRING,
+	MODINFOSTRING1,
+	MODINFOSTRING2,
+	XF86_VERSION_CURRENT,
+	FBDEV_MAJOR_VERSION, FBDEV_MINOR_VERSION, 0,
+	ABI_CLASS_VIDEODRV,
+	ABI_VIDEODRV_VERSION,
+	NULL,
+	{0,0,0,0}
+};
+
+XF86ModuleData fbdevModuleData = { &FBDevVersRec, FBDevSetup, NULL };
+
+pointer
+FBDevSetup(pointer module, pointer opts, int *errmaj, int *errmin)
+{
+	static Bool setupDone = FALSE;
+
+	if (!setupDone) {
+		setupDone = TRUE;
+		xf86AddDriver(&FBDEV, module, 0);
+		LoaderRefSymLists(afbSymbols, fbSymbols,
+				  shadowSymbols, fbdevHWSymbols, NULL);
+		return (pointer)1;
+	} else {
+		if (errmaj) *errmaj = LDR_ONCEONLY;
+		return NULL;
+	}
+}
+
+#endif /* XFree86LOADER */
+
+/* -------------------------------------------------------------------- */
+/* our private data, and two functions to allocate/free this            */
+
+typedef struct {
+	unsigned char*			fbstart;
+	unsigned char*			fbmem;
+	int				fboff;
+	int				lineLength;
+	unsigned char*			shadowmem;
+	int				rotate;
+	Bool				shadowFB;
+	CloseScreenProcPtr		CloseScreen;
+	void				(*PointerMoved)(int index, int x, int y);
+	EntityInfoPtr			pEnt;
+	/* DGA info */
+	DGAModePtr			pDGAMode;
+	int				nDGAMode;
+	OptionInfoPtr			Options;
+} FBDevRec, *FBDevPtr;
+
+#define FBDEVPTR(p) ((FBDevPtr)((p)->driverPrivate))
+
+static Bool
+FBDevGetRec(ScrnInfoPtr pScrn)
+{
+	if (pScrn->driverPrivate != NULL)
+		return TRUE;
+	
+	pScrn->driverPrivate = xnfcalloc(sizeof(FBDevRec), 1);
+	return TRUE;
+}
+
+static void
+FBDevFreeRec(ScrnInfoPtr pScrn)
+{
+	if (pScrn->driverPrivate == NULL)
+		return;
+	xfree(pScrn->driverPrivate);
+	pScrn->driverPrivate = NULL;
+}
+
+/* -------------------------------------------------------------------- */
+
+static const OptionInfoRec *
+FBDevAvailableOptions(int chipid, int busid)
+{
+	return FBDevOptions;
+}
+
+static void
+FBDevIdentify(int flags)
+{
+	xf86PrintChipsets(FBDEV_NAME, "driver for framebuffer", FBDevChipsets);
+}
+
+static Bool
+FBDevProbe(DriverPtr drv, int flags)
+{
+	int i;
+	ScrnInfoPtr pScrn;
+       	GDevPtr *devSections;
+	int numDevSections;
+	int bus,device,func;
+	char *dev;
+	Bool foundScreen = FALSE;
+
+	TRACE("probe start");
+
+	/* For now, just bail out for PROBE_DETECT. */
+	if (flags & PROBE_DETECT)
+		return FALSE;
+
+	if ((numDevSections = xf86MatchDevice(FBDEV_DRIVER_NAME, &devSections)) <= 0) 
+	    return FALSE;
+	
+	if (!xf86LoadDrvSubModule(drv, "fbdevhw"))
+	    return FALSE;
+	    
+	xf86LoaderReqSymLists(fbdevHWSymbols, NULL);
+	
+	for (i = 0; i < numDevSections; i++) {
+	    Bool isIsa = FALSE;
+	    Bool isPci = FALSE;
+
+	    dev = xf86FindOptionValue(devSections[i]->options,"fbdev");
+	    if (devSections[i]->busID) {
+	        if (xf86ParsePciBusString(devSections[i]->busID,&bus,&device,
+					  &func)) {
+		    if (!xf86CheckPciSlot(bus,device,func))
+		        continue;
+		    isPci = TRUE;
+		} else if (xf86ParseIsaBusString(devSections[i]->busID))
+		    isIsa = TRUE;
+		  
+	    }
+	    if (fbdevHWProbe(NULL,dev,NULL)) {
+		pScrn = NULL;
+		if (isPci) {
+		    /* XXX what about when there's no busID set? */
+		    int entity;
+		    
+		    entity = xf86ClaimPciSlot(bus,device,func,drv,
+					      0,devSections[i],
+					      TRUE);
+		    pScrn = xf86ConfigPciEntity(pScrn,0,entity,
+						      NULL,RES_SHARED_VGA,
+						      NULL,NULL,NULL,NULL);
+		    /* xf86DrvMsg() can't be called without setting these */
+		    pScrn->driverName    = FBDEV_DRIVER_NAME;
+		    pScrn->name          = FBDEV_NAME;
+		    xf86DrvMsg(pScrn->scrnIndex, X_CONFIG,
+			       "claimed PCI slot %d:%d:%d\n",bus,device,func);
+
+		} else if (isIsa) {
+		    int entity;
+		    
+		    entity = xf86ClaimIsaSlot(drv, 0,
+					      devSections[i], TRUE);
+		    pScrn = xf86ConfigIsaEntity(pScrn,0,entity,
+						      NULL,RES_SHARED_VGA,
+						      NULL,NULL,NULL,NULL);
+		} else {
+		   int entity;
+
+		    entity = xf86ClaimFbSlot(drv, 0,
+					      devSections[i], TRUE);
+		    pScrn = xf86ConfigFbEntity(pScrn,0,entity,
+					       NULL,NULL,NULL,NULL);
+		   
+		}
+		if (pScrn) {
+		    foundScreen = TRUE;
+		    
+		    pScrn->driverVersion = VERSION;
+		    pScrn->driverName    = FBDEV_DRIVER_NAME;
+		    pScrn->name          = FBDEV_NAME;
+		    pScrn->Probe         = FBDevProbe;
+		    pScrn->PreInit       = FBDevPreInit;
+		    pScrn->ScreenInit    = FBDevScreenInit;
+		    pScrn->SwitchMode    = fbdevHWSwitchMode;
+		    pScrn->AdjustFrame   = fbdevHWAdjustFrame;
+		    pScrn->EnterVT       = fbdevHWEnterVT;
+		    pScrn->LeaveVT       = fbdevHWLeaveVT;
+		    pScrn->ValidMode     = fbdevHWValidMode;
+		    
+		    xf86DrvMsg(pScrn->scrnIndex, X_INFO,
+			       "using %s\n", dev ? dev : "default device");
+		}
+	    }
+	}
+	xfree(devSections);
+	TRACE("probe done");
+	return foundScreen;
+}
+
+static Bool
+FBDevPreInit(ScrnInfoPtr pScrn, int flags)
+{
+	FBDevPtr fPtr;
+	int default_depth, fbbpp;
+	const char *mod = NULL, *s;
+	const char **syms = NULL;
+
+	if (flags & PROBE_DETECT) return FALSE;
+
+	TRACE_ENTER("PreInit");
+
+	/* Check the number of entities, and fail if it isn't one. */
+	if (pScrn->numEntities != 1)
+		return FALSE;
+
+	pScrn->monitor = pScrn->confScreen->monitor;
+
+	FBDevGetRec(pScrn);
+	fPtr = FBDEVPTR(pScrn);
+
+	fPtr->pEnt = xf86GetEntityInfo(pScrn->entityList[0]);
+
+	pScrn->racMemFlags = RAC_FB | RAC_COLORMAP | RAC_CURSOR | RAC_VIEWPORT;
+	/* XXX Is this right?  Can probably remove RAC_FB */
+	pScrn->racIoFlags = RAC_FB | RAC_COLORMAP | RAC_CURSOR | RAC_VIEWPORT;
+
+	if (fPtr->pEnt->location.type == BUS_PCI &&
+	    xf86RegisterResources(fPtr->pEnt->index,NULL,ResExclusive)) {
+		xf86DrvMsg(pScrn->scrnIndex, X_ERROR,
+		   "xf86RegisterResources() found resource conflicts\n");
+		return FALSE;
+	}
+
+	/* open device */
+	if (!fbdevHWInit(pScrn,NULL,xf86FindOptionValue(fPtr->pEnt->device->options,"fbdev")))
+		return FALSE;
+	default_depth = fbdevHWGetDepth(pScrn,&fbbpp);
+	if (!xf86SetDepthBpp(pScrn, default_depth, default_depth, fbbpp,0))
+		return FALSE;
+	xf86PrintDepthBpp(pScrn);
+
+	/* Get the depth24 pixmap format */
+	if (pScrn->depth == 24 && pix24bpp == 0)
+		pix24bpp = xf86GetBppFromDepth(pScrn, 24);
+
+	/* color weight */
+	if (pScrn->depth > 8) {
+		rgb zeros = { 0, 0, 0 };
+		if (!xf86SetWeight(pScrn, zeros, zeros))
+			return FALSE;
+	}
+
+	/* visual init */
+	if (!xf86SetDefaultVisual(pScrn, -1))
+		return FALSE;
+
+	/* We don't currently support DirectColor at > 8bpp */
+	if (pScrn->depth > 8 && pScrn->defaultVisual != TrueColor) {
+		xf86DrvMsg(pScrn->scrnIndex, X_ERROR, "Given default visual"
+			   " (%s) is not supported at depth %d\n",
+			   xf86GetVisualName(pScrn->defaultVisual), pScrn->depth);
+		return FALSE;
+	}
+
+	{
+		Gamma zeros = {0.0, 0.0, 0.0};
+
+		if (!xf86SetGamma(pScrn,zeros)) {
+			return FALSE;
+		}
+	}
+
+	pScrn->progClock = TRUE;
+	pScrn->rgbBits   = 8;
+	pScrn->chipset   = "fbdev";
+	pScrn->videoRam  = fbdevHWGetVidmem(pScrn);
+
+	xf86DrvMsg(pScrn->scrnIndex, X_INFO, "Hardware: %s (vidmem: %dk)\n",
+		   fbdevHWGetName(pScrn),pScrn->videoRam/1024);
+
+	/* handle options */
+	xf86CollectOptions(pScrn, NULL);
+	if (!(fPtr->Options = xalloc(sizeof(FBDevOptions))))
+		return FALSE;
+	memcpy(fPtr->Options, FBDevOptions, sizeof(FBDevOptions));
+	xf86ProcessOptions(pScrn->scrnIndex, fPtr->pEnt->device->options, fPtr->Options);
+
+	/* use shadow framebuffer by default */
+	fPtr->shadowFB = xf86ReturnOptValBool(fPtr->Options, OPTION_SHADOW_FB, TRUE);
+
+	/* rotation */
+	fPtr->rotate = FBDEV_ROTATE_NONE;
+	if ((s = xf86GetOptValString(fPtr->Options, OPTION_ROTATE)))
+	{
+	  if(!xf86NameCmp(s, "CW"))
+	  {
+	    fPtr->shadowFB = TRUE;
+	    fPtr->rotate = FBDEV_ROTATE_CW;
+	    xf86DrvMsg(pScrn->scrnIndex, X_CONFIG,
+		       "Rotating screen clockwise\n");
+	  }
+	  else if(!xf86NameCmp(s, "CCW"))
+	  {
+	    fPtr->shadowFB = TRUE;
+	    fPtr->rotate = FBDEV_ROTATE_CCW;
+	    xf86DrvMsg(pScrn->scrnIndex, X_CONFIG,
+		       "Rotating screen counter clockwise\n");
+	  }
+	  else if(!xf86NameCmp(s, "UD"))
+	  {
+	    fPtr->shadowFB = TRUE;
+	    fPtr->rotate = FBDEV_ROTATE_UD;
+	    xf86DrvMsg(pScrn->scrnIndex, X_CONFIG,
+		       "Rotating screen upside down\n");
+	  }
+	  else
+	  {
+	    xf86DrvMsg(pScrn->scrnIndex, X_CONFIG,
+		       "\"%s\" is not a valid value for Option \"Rotate\"\n", s);
+	    xf86DrvMsg(pScrn->scrnIndex, X_INFO,
+		       "Valid options are \"CW\", \"CCW\" or \"UD\"\n");
+	  }
+	}
+
+	/* select video modes */
+
+	xf86DrvMsg(pScrn->scrnIndex, X_INFO, "Checking Modes against framebuffer device...\n");
+	fbdevHWSetVideoModes(pScrn);
+
+	xf86DrvMsg(pScrn->scrnIndex, X_INFO, "Checking Modes against monitor...\n");
+	{
+		DisplayModePtr mode, first = mode = pScrn->modes;
+		
+		if (mode != NULL) do {
+			mode->status = xf86CheckModeForMonitor(mode, pScrn->monitor);
+			mode = mode->next;
+		} while (mode != NULL && mode != first);
+
+		xf86PruneDriverModes(pScrn);
+	}
+
+	if (NULL == pScrn->modes)
+		fbdevHWUseBuildinMode(pScrn);
+	pScrn->currentMode = pScrn->modes;
+
+	if (fPtr->shadowFB)
+		pScrn->displayWidth = pScrn->virtualX;	/* ShadowFB handles this correctly */
+	else {
+		int fbbpp;
+		/* FIXME: this doesn't work for all cases, e.g. when each scanline
+			has a padding which is independent from the depth (controlfb) */
+		fbdevHWGetDepth(pScrn,&fbbpp);
+		pScrn->displayWidth = fbdevHWGetLineLength(pScrn)/(fbbpp >> 3);
+	}
+
+	xf86PrintModes(pScrn);
+
+	/* Set display resolution */
+	xf86SetDpi(pScrn, 0, 0);
+
+	/* Load bpp-specific modules */
+	switch (fbdevHWGetType(pScrn))
+	{
+	case FBDEVHW_PLANES:
+		mod = "afb";
+		syms = afbSymbols;
+		break;
+	case FBDEVHW_PACKED_PIXELS:
+		switch (pScrn->bitsPerPixel)
+		{
+		case 8:
+		case 16:
+		case 24:
+		case 32:
+			mod = "fb";
+			syms = fbSymbols;
+			break;
+		default:
+			xf86DrvMsg(pScrn->scrnIndex, X_ERROR,
+			"Unsupported bpp: %d", pScrn->bitsPerPixel);
+			return FALSE;
+		}
+		break;
+	case FBDEVHW_INTERLEAVED_PLANES:
+               /* Not supported yet, don't know what to do with this */
+               xf86DrvMsg(pScrn->scrnIndex, X_ERROR,
+               "Interleaved Planes are not supported yet by drivers/fbdev.");
+		return FALSE;
+	case FBDEVHW_TEXT:
+               /* This should never happen ...
+                * we should check for this much much earlier ... */
+               xf86DrvMsg(pScrn->scrnIndex, X_ERROR,
+               "Text mode is not supprted by drivers/fbdev.\n"
+               "Why do you want to run the X in TEXT mode anyway ?");
+		return FALSE;
+       case FBDEVHW_VGA_PLANES:
+               /* Not supported yet */
+               xf86DrvMsg(pScrn->scrnIndex, X_ERROR,
+               "EGA/VGA Planes are not supprted yet by drivers/fbdev.");
+               return FALSE;