Merge branch 'vendor/DIALOG'
[dragonfly.git] / share / man / man4 / radeon.4
1 .\"
2 .\" Copyright (c) 2015 The DragonFly Project.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\"
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in
12 .\"    the documentation and/or other materials provided with the
13 .\"    distribution.
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\"    contributors may be used to endorse or promote products derived
16 .\"    from this software without specific, prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .Dd October 9, 2019
32 .Dt RADEON 4
33 .Os
34 .Sh NAME
35 .Nm radeon
36 .Nd Driver for AMD/ATI Radeon graphics chipsets
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for the AMD Radeon graphics chips.
41 Please refer the
42 .Sx Loader Tunables
43 section in
44 .Xr syscons 4
45 for more information about how to make the console work with
46 .Nm .
47 .Sh LOADER TUNABLES
48 Tunables can be set at the
49 .Xr loader 8
50 prompt before booting the kernel or stored in
51 .Xr loader.conf 5 .
52 .Bl -tag -width "xxxxxx"
53 .It Va drm.radeon.no_wb
54 Disables AGP writeback for scratch registers.
55 .It Va drm.radeon.dynclks
56 Enable/Disable dynamic clocks
57 .\".It Va drm.radeon.r4xx_atom
58 .\"XXX
59 .\".It Va drm.radeon.vram_limit
60 .\"XXX
61 .\".It Va drm.radeon.agpmode
62 .\"XXX
63 .\".It Va drm.radeon.gart_size
64 .\"XXX
65 .\".It Va drm.radeon.benchmarking
66 .\"XXX
67 .\".It Va drm.radeon.testing
68 .\"XXX
69 .\".It Va drm.radeon.connector_table
70 .\"XXX
71 .\".It Va drm.radeon.tv
72 .\"XXX
73 .\".It Va drm.radeon.audio
74 .\"XXX
75 .\".It Va drm.radeon.disp_priority
76 .\"XXX
77 .\".It Va drm.radeon.hw_i2c
78 .\"XXX
79 .\".It Va drm.radeon.pcie_gen2
80 .\"XXX
81 .It Va drm.radeon.msi
82 Enable/Disable MSI (message signaled interrupts)
83 1 = enable, 0 = disable, -1 = auto (default)
84 .\".It Va drm.radeon.lockup_timeout
85 .\"XXX
86 .It Va drm.radeon.fastfb
87 Direct FB access for IGP chips, which can significantly improve performance
88 for some applications.
89 This option only affects the RS690, RS780 and RS880 chipsets, and only
90 when no sideport memory is available.
91 1 = enable, 0 = disable (default)
92 .It Va drm.radeon.dpm
93 DPM (dynamic power management) support.
94 1 = enable, 0 = disable, -1 = auto (default)
95 .\".It Va drm.radeon.aspm
96 .\"XXX
97 .It Va drm.radeon.backlight
98 Backlight support.
99 1 = enable, 0 = disable, -1 = auto (default)
100 .El
101 .Sh SYSCTL VARIABLES
102 If display backlight level can be controlled by the GPU (which is often
103 the case in notebooks), the sysctl
104 .Va hw.backlight_level
105 can be used to adjust the backlight level.
106 Permitted values are from 0 to the value returned from the
107 .Va hw.backlight_max
108 sysctl.
109 On older Radeon GPU models than the R600 series, the
110 .Va hw.backlight_level
111 and
112 .Va hw.backlight_max
113 sysctl variables are no longer available by default.
114 Setting the
115 .Va drm.radeon.backlight
116 tunable to
117 .Dq 1
118 will force-enable native backlight control via the
119 sysctl variables in this case.
120 .Sh SEE ALSO
121 .Xr drm 4 ,
122 .Xr syscons 4
123 .Sh HISTORY
124 The
125 .Nm
126 driver was first available for Linux.
127 .Sh BUGS
128 Enabling
129 .Va drm.radeon.fastfb
130 on RS690 chipsets can cause graphics corruption when hardware acceleration
131 is used.
132 Display backlight control with the
133 .Va hw.backlight_level
134 sysctl is only supported for chipsets using AtomBIOS (which includes some
135 R400 chipsets and all later generations).