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 June 9, 2015
  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 .Pp
  41 The
  42 .Nm
  43 drivers provide support for the following chipsets:
  44 .Bl -column -offset indent ".Sy ModuleXXX" ".Sy Kernel option" ".Sy Chipset"
  45 .It Sy Module Ta Sy "Kernel option" Ta Sy Chipset
  46 .It Pa i915kms.ko Ta n/a Ta Intel i915, i945, i965, G3x, G4x
  47 .It Pa radeonkms.ko Ta n/a Ta AMD Radeon
  48 .El
  49 .Pp
  50 In most cases
  51 .Xr Xorg 1
  52 will take care of loading the appropriate modules and it is not necessary to
  53 modify
  54 .Xr loader.conf 5
  55 or the kernel configuration to enable
  56 .Nm
  57 support.
  58 .Pp
  59 Newer versions of
  60 .Xr Xorg 1 ,
  61 like the one from
  62 .Xr dports 7 ,
  63 do a pretty good job of figuring out the right configuration on their own,
  64 so having no
  65 .Xr xorg.conf 5
  66 file at all is usually the best advice.
  67 If for some reason an
  68 .Xr xorg.conf 5
  69 is preferred, DRI must be enabled:
  70 .Bd -literal
  71 Section "DRI"
  72         Group "wheel"
  73         Mode 0660
  74 EndSection
  75 .Ed
  76 .Pp
  77 With KMS, DRI is always enabled since the
  78 .Nm
  79 is always required.
  80 .\".Pp
  81 .\"In order to use two graphics cards (an on-board and another
  82 .\"AGP/PCI/PCIe card) with DRI, a
  83 .\".Pa /dev/dri/card1
  84 .\"link to
  85 .\".Pa /dev/dri/card0
  86 .\"has to be created using
  87 .\".Xr devfsctl 8 .
  88 .Pp
  89 If
  90 .Xr Xorg 1
  91 acceleration fails to initialize with a
  92 .Dq contigmalloc_map: failed size...
  93 error in dmesg, the reserve of memory for DMA ran out early and should
  94 be increased to a sufficiently high value by setting the
  95 .Va vm.dma_reserved
  96 loader tunable.
  97 A read only
  98 .Xr sysctl 8
  99 variable of the same name is provided for obtaining its current value.
 100 .Pp
 101 Debugging output can be enabled and disabled by setting the
 102 .Xr sysctl 8
 103 node
 104 .Ar hw.dri.0.debug .
 105 .Sh SEE ALSO
 106 .Xr Xorg 1 ,
 107 .Xr i915kms 4 ,
 108 .Xr radeonkms 4 ,
 109 .Xr xorg.conf 5
 110 .Sh HISTORY
 111 DRM was first available for Linux.
 112 Subsequently Eric Anholt ported the DRM kernel modules to
 113 .Fx .
 114 .Sh CAVEATS
 115 Disable AIGLX if necessary
 116 .Pq Pa xorg.conf :
 117 .Bd -literal -offset indent
 118 Section "ServerFlags"
 119         Option  "AIGLX" "off"
 120 EndSection
 121 .\"
 122 .\"Section "Extensions"
 123 .\"        Option "Composite" "Disable"
 124 .\"EndSection
 125 .Ed
 126 .Pp
 127 .Cd options DRM_DEBUG
 128 can slow DRI down a lot, disable it once
 129 .Nm
 130 works.