modesetting.man (4783B)
1 .\" shorthand for double quote that works everywhere. 2 .ds q \N'34' 3 .TH MODESETTING @drivermansuffix@ @vendorversion@ 4 .SH NAME 5 modesetting \- video driver for framebuffer device 6 .SH SYNOPSIS 7 .nf 8 .B "Section \*qDevice\*q" 9 .BI " Identifier \*q" devname \*q 10 .B " Driver \*qmodesetting\*q" 11 .BI " BusID \*qpci:" bus : dev : func \*q 12 \ \ ... 13 .B EndSection 14 .fi 15 .SH DESCRIPTION 16 .B modesetting 17 is an @xservername@ driver for KMS devices. This driver supports 18 TrueColor visuals at framebuffer depths of 15, 16, 24, and 30. RandR 19 1.2 is supported for multi-head configurations. Acceleration is available 20 through glamor for devices supporting at least OpenGL ES 2.0 or OpenGL 2.1. 21 If glamor is not enabled, a shadow framebuffer is configured based on the 22 KMS drivers' preference (unless the framebuffer is 24 bits per pixel, in 23 which case the shadow framebuffer is always used). 24 .SH SUPPORTED HARDWARE 25 The 26 .B modesetting 27 driver supports all hardware where a KMS driver is available. 28 modesetting uses the Linux DRM KMS ioctls and dumb object create/map. 29 .SH CONFIGURATION DETAILS 30 Please refer to @xconfigfile@(@filemansuffix@) for general configuration 31 details. This section only covers configuration details specific to 32 this driver. 33 .PP 34 For this driver it is not required to specify modes in the screen 35 section of the config file. The 36 .B modesetting 37 driver can pick up the currently used video mode from the kernel 38 driver and will use it if there are no video modes configured. 39 .PP 40 For PCI boards you might have to add a BusID line to the Device 41 section. See above for a sample line. 42 .PP 43 The following driver 44 .B Options 45 are supported: 46 .TP 47 .BI "Option \*qSWcursor\*q \*q" boolean \*q 48 Selects software cursor. The default is 49 .B off. 50 .TP 51 .BI "Option \*qkmsdev\*q \*q" string \*q 52 The framebuffer device to use. Default: /dev/dri/card0. 53 .TP 54 .BI "Option \*qShadowFB\*q \*q" boolean \*q 55 Enable or disable use of the shadow framebuffer layer. Default: on. 56 .TP 57 .BI "Option \*qDoubleShadow\*q \*q" boolean \*q 58 Double-buffer shadow updates. When enabled, the driver will keep two copies of 59 the shadow framebuffer. When the shadow framebuffer is flushed, the old and new 60 versions of the shadow are compared, and only tiles that have actually changed 61 are uploaded to the device. This is an optimization for server-class GPUs with 62 a remote display function (typically VNC), where remote updates are triggered 63 by any framebuffer write, so minimizing the amount of data uploaded is crucial. 64 This defaults to enabled for ASPEED and Matrox G200 devices, and disabled 65 otherwise. 66 .TP 67 .BI "Option \*qAccelMethod\*q \*q" string \*q 68 One of \*qglamor\*q or \*qnone\*q. Default: glamor. 69 .TP 70 .BI "Option \*qPageFlip\*q \*q" boolean \*q 71 Enable DRI3 page flipping. The default is 72 .B on. 73 .TP 74 .BI "Option \*qVariableRefresh\*q \*q" boolean \*q 75 Enables support for enabling variable refresh on the Screen's CRTCs 76 when an suitable application is flipping via the Present extension. 77 .br 78 The default is 79 .B off. 80 .TP 81 .BI "Option \*qAsyncFlipSecondaries\*q \*q" boolean \*q 82 Use async flips for secondary video outputs on multi-display setups. If a screen 83 has multiple displays attached and DRI3 page flipping is used, then only one of 84 the displays will have its page flip synchronized to vblank for tear-free 85 presentation. This is the display that is used for presentation timing and 86 timestamping, usually the one covering the biggest pixel area of the screen. 87 All other displays ("Secondaries") will not synchronize their flips. This may 88 cause some tearing on these displays, but it prevents a permanent or periodic 89 slowdown or irritating judder of animations if not all video outputs are running 90 synchronized with each other and with the same refresh rate. There is no perfect 91 solution apart from perfectly synchronized outputs, but this option may give 92 preferrable results if the displays in a multi-display setup mirror or clone 93 each other. The default is 94 .B off. 95 .TP 96 .BI "Option \*qZaphodHeads\*q \*q" string \*q 97 Specify the RandR output(s) to use with zaphod mode for a particular driver 98 instance. If you use this option you must use this option for all instances 99 of the driver. 100 .br 101 For example: 102 .B 103 Option \*qZaphodHeads\*q \*qLVDS,VGA-0\*q 104 will assign xrandr outputs LVDS and VGA-0 to this instance of the driver. 105 .TP 106 .BI "Option \*qUseGammaLUT\*q \*q" boolean \*q 107 Enable or disable use of the GAMMA_LUT property, when available. 108 When enabled, this option allows the driver to use gamma ramps with more 109 entries, if supported by the kernel. By default, GAMMA_LUT will be used for 110 kms drivers which are known to be safe for use of GAMMA_LUT. 111 .TP 112 .SH "SEE ALSO" 113 @xservername@(@appmansuffix@), @xconfigfile@(@filemansuffix@), Xserver(@appmansuffix@), 114 X(@miscmansuffix@) 115 .SH AUTHORS 116 Authors include: Dave Airlie