index.rst (a723c6d0785acf9e4bf5b77167d6a0c32ecf8503) index.rst (c08d2f8bc16b56699673314eb0142ee863f137fe)
1==========================
2 drm/amdgpu AMDgpu driver
3==========================
4
5The drm/amdgpu driver supports all AMD Radeon GPUs based on the Graphics Core
6Next (GCN) architecture.
7
1==========================
2 drm/amdgpu AMDgpu driver
3==========================
4
5The drm/amdgpu driver supports all AMD Radeon GPUs based on the Graphics Core
6Next (GCN) architecture.
7
8Module Parameters
9=================
10
11The amdgpu driver supports the following module parameters:
12
13.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
14
15Core Driver Infrastructure
16==========================
17
18This section covers core driver infrastructure.
19
20.. _amdgpu_memory_domains:
21
22Memory Domains
23--------------
24
25.. kernel-doc:: include/uapi/drm/amdgpu_drm.h
26 :doc: memory domains
27
28Buffer Objects
29--------------
30
31.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
32 :doc: amdgpu_object
33
34.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_object.c
35 :internal:
36
37PRIME Buffer Sharing
38--------------------
39
40.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
41 :doc: PRIME Buffer Sharing
42
43.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_dma_buf.c
44 :internal:
45
46MMU Notifier
47------------
48
49.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c
50 :doc: MMU Notifier
51
52.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_mn.c
53 :internal:
54
55AMDGPU Virtual Memory
56---------------------
57
58.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
59 :doc: GPUVM
60
61.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_vm.c
62 :internal:
63
64Interrupt Handling
65------------------
66
67.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c
68 :doc: Interrupt Handling
69
70.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_irq.c
71 :internal:
72
73IP Blocks
74---------
75
76.. kernel-doc:: drivers/gpu/drm/amd/include/amd_shared.h
77 :doc: IP Blocks
78
79.. kernel-doc:: drivers/gpu/drm/amd/include/amd_shared.h
80 :identifiers: amd_ip_block_type amd_ip_funcs
81
82Display Core
83============
84
85This section covers Display core.
86
87.. toctree::
88
8.. toctree::
9
89 display/index
90
91.. kernel-doc:: drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
92 :doc: overview
93
94AMDGPU XGMI Support
95===================
96
97.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c
98
99AMDGPU RAS Support
100==================
101
102The AMDGPU RAS interfaces are exposed via sysfs (for informational queries) and
103debugfs (for error injection).
104
105RAS debugfs/sysfs Control and Error Injection Interfaces
106--------------------------------------------------------
107
108.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
109 :doc: AMDGPU RAS debugfs control interface
110
111RAS Reboot Behavior for Unrecoverable Errors
112--------------------------------------------------------
113
114.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
115 :doc: AMDGPU RAS Reboot Behavior for Unrecoverable Errors
116
117RAS Error Count sysfs Interface
118-------------------------------
119
120.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
121 :doc: AMDGPU RAS sysfs Error Count Interface
122
123RAS EEPROM debugfs Interface
124----------------------------
125
126.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
127 :doc: AMDGPU RAS debugfs EEPROM table reset interface
128
129RAS VRAM Bad Pages sysfs Interface
130----------------------------------
131
132.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
133 :doc: AMDGPU RAS sysfs gpu_vram_bad_pages Interface
134
135Sample Code
136-----------
137Sample code for testing error injection can be found here:
138https://cgit.freedesktop.org/mesa/drm/tree/tests/amdgpu/ras_tests.c
139
140This is part of the libdrm amdgpu unit tests which cover several areas of the GPU.
141There are four sets of tests:
142
143RAS Basic Test
144
145The test verifies the RAS feature enabled status and makes sure the necessary sysfs and debugfs files
146are present.
147
148RAS Query Test
149
150This test checks the RAS availability and enablement status for each supported IP block as well as
151the error counts.
152
153RAS Inject Test
154
155This test injects errors for each IP.
156
157RAS Disable Test
158
159This test tests disabling of RAS features for each IP block.
160
161
162GPU Power/Thermal Controls and Monitoring
163=========================================
164
165This section covers hwmon and power/thermal controls.
166
167HWMON Interfaces
168----------------
169
170.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
171 :doc: hwmon
172
173GPU sysfs Power State Interfaces
174--------------------------------
175
176GPU power controls are exposed via sysfs files.
177
178power_dpm_state
179~~~~~~~~~~~~~~~
180
181.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
182 :doc: power_dpm_state
183
184power_dpm_force_performance_level
185~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
186
187.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
188 :doc: power_dpm_force_performance_level
189
190pp_table
191~~~~~~~~
192
193.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
194 :doc: pp_table
195
196pp_od_clk_voltage
197~~~~~~~~~~~~~~~~~
198
199.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
200 :doc: pp_od_clk_voltage
201
202pp_dpm_*
203~~~~~~~~
204
205.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
206 :doc: pp_dpm_sclk pp_dpm_mclk pp_dpm_socclk pp_dpm_fclk pp_dpm_dcefclk pp_dpm_pcie
207
208pp_power_profile_mode
209~~~~~~~~~~~~~~~~~~~~~
210
211.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
212 :doc: pp_power_profile_mode
213
214\*_busy_percent
215~~~~~~~~~~~~~~~
216
217.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
218 :doc: gpu_busy_percent
219
220.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
221 :doc: mem_busy_percent
222
223gpu_metrics
224~~~~~~~~~~~~~~~~~~~~~
225
226.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
227 :doc: gpu_metrics
228
229GPU Product Information
230=======================
231
232Information about the GPU can be obtained on certain cards
233via sysfs
234
235product_name
236------------
237
238.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
239 :doc: product_name
240
241product_number
242--------------
243
244.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
245 :doc: product_name
246
247serial_number
248-------------
249
250.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
251 :doc: serial_number
252
253unique_id
254---------
255
256.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
257 :doc: unique_id
258
259GPU Memory Usage Information
260============================
261
262Various memory accounting can be accessed via sysfs
263
264mem_info_vram_total
265-------------------
266
267.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
268 :doc: mem_info_vram_total
269
270mem_info_vram_used
271------------------
272
273.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
274 :doc: mem_info_vram_used
275
276mem_info_vis_vram_total
277-----------------------
278
279.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
280 :doc: mem_info_vis_vram_total
281
282mem_info_vis_vram_used
283----------------------
284
285.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_vram_mgr.c
286 :doc: mem_info_vis_vram_used
287
288mem_info_gtt_total
289------------------
290
291.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
292 :doc: mem_info_gtt_total
293
294mem_info_gtt_used
295-----------------
296
297.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_gtt_mgr.c
298 :doc: mem_info_gtt_used
299
300PCIe Accounting Information
301===========================
302
303pcie_bw
304-------
305
306.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
307 :doc: pcie_bw
308
309pcie_replay_count
310-----------------
311
312.. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
313 :doc: pcie_replay_count
314
315GPU SmartShift Information
316==========================
317
318GPU SmartShift information via sysfs
319
320smartshift_apu_power
321--------------------
322
323.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
324 :doc: smartshift_apu_power
325
326smartshift_dgpu_power
327---------------------
328
329.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
330 :doc: smartshift_dgpu_power
331
332smartshift_bias
333---------------
334
335.. kernel-doc:: drivers/gpu/drm/amd/pm/amdgpu_pm.c
336 :doc: smartshift_bias
337
338AMDGPU Glossary
339===============
340
341.. toctree::
342
343 amdgpu-glossary.rst
10 module-parameters
11 driver-core
12 display/index
13 xgmi
14 ras
15 thermal
16 driver-misc
17 amdgpu-glossary