drm.4: Update a bit to reflect the current state of affairs.
[dragonfly.git] / share / man / man4 / drm.4
1 .\"     $NetBSD: drm.4,v 1.7 2009/05/12 08:16:46 wiz Exp $
2 .\"
3 .\" Copyright (c) 2007 Thomas Klausner
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .Dd September 13, 2013
27 .Dt DRM 4
28 .Os
29 .Sh NAME
30 .Nm drm
31 .Nd Direct Rendering Manager (DRI kernel support)
32 .Sh DESCRIPTION
33 The
34 .Tn Direct Rendering Manager
35 is part of the
36 .Tn Direct Rendering Infrastructure
37 (see
38 .Pa http://dri.freedesktop.org/ )
39 for supporting video acceleration.
40 For older chipsets it's used for 3d acceleration only, but newer chipsets
41 may require
42 .Nm
43 for 2d acceleration (XVideo, EXA) as well.
44 .Pp
45 The
46 .Nm
47 drivers provide support for the following chipsets:
48 .Pp
49 .Bl -column -offset -indent ".Sy ModuleXXX" ".Sy DeviceXXX" ".Sy ChipsetXXX"
50 .It Sy Module Ta Sy Kernel Ta Sy Chipset
51 .It Pa i915kms.ko Ta n/a Ta Intel i915, i945, i965, G3x, G4x
52 .It Pa mach64.ko Ta Cd mach64drm Ta Mach64 (3D Rage Pro, Rage)
53 .It Pa mga.ko Ta Cd mgadrm Ta Matrox G[24]00, G[45]50
54 .It Pa r128.ko Ta Cd r128drm Ta Rage 128
55 .It Pa radeon.ko Ta Cd radeondrm Ta Radeon
56 .It Pa savage.ko Ta Cd savagedrm Ta S3 Savage
57 .It Pa sis.ko Ta Cd sisdrm Ta SiS
58 .It Pa tdfx.ko Ta Cd tdfxdrm Ta 3dfx (Voodoo)
59 .\".It Pa via.ko Ta Cd viadrm Ta VIA
60 .El
61 .Pp
62 In most cases
63 .Xr Xorg 1
64 will take care of loading the appropriate modules and it is not necessary to
65 modify
66 .Xr loader.conf 5
67 or the kernel configuration to enable
68 .Nm
69 support.
70 .Pp
71 Newer versions of
72 .Xr Xorg 1 ,
73 like the one from
74 .Xr dports 7 ,
75 do a pretty good job of figuring out the right configuration on their own,
76 so having no
77 .Xr xorg.conf 5
78 file at all is usually the best advice.
79 If for some reason an
80 .Xr xorg.conf 5
81 is preferred, DRI must be enabled:
82 .Pp
83 .Bd -literal
84 Section "DRI"
85         Group "wheel"
86         Mode 0660
87 EndSection
88 .Ed
89 .Pp
90 With KMS, DRI is always enabled since the
91 .Nm
92 is always required.
93 .\".Pp
94 .\"In order to use two graphics cards (an on-board and another
95 .\"AGP/PCI/PCIe card) with DRI, a
96 .\".Pa /dev/dri/card1
97 .\"link to
98 .\".Pa /dev/dri/card0
99 .\"has to be created using
100 .\".Xr devfsctl 8 .
101 .Pp
102 If
103 .Xr Xorg 1
104 acceleration fails to initialize with a
105 .Dq contigmalloc_map: failed size...
106 error in dmesg, the reserve of memory for DMA ran out early and should
107 be increased to a sufficiently high value by setting the
108 .Va vm.dma_reserved
109 loader tunable.
110 A read only
111 .Xr sysctl 8
112 variable of the same name is provided for obtaining its current value.
113 .Pp
114 Debugging output can be enabled and disabled by setting the
115 .Xr sysctl 8
116 node
117 .Ar hw.dri.0.debug .
118 .Sh SEE ALSO
119 .Xr Xorg 1 ,
120 .Xr xorg.conf 5
121 .Sh HISTORY
122 DRM was first available for Linux.
123 Subsequently Eric Anholt ported the DRM kernel modules to
124 .Fx .
125 .Sh CAVEATS
126 Disable AIGLX if necessary
127 .Pq Pa xorg.conf :
128 .Bd -literal -offset indent
129 Section "ServerFlags"
130         Option  "AIGLX" "off"
131 EndSection
132 .\"
133 .\"Section "Extensions"
134 .\"        Option "Composite" "Disable"
135 .\"EndSection
136 .Ed
137 .Pp
138 .Cd options DRM_DEBUG
139 can slow DRI down a lot, disable it once
140 .Nm
141 works.