Documentation/gpu/amdgpu.rst

   1 =========================
   2  drm/amdgpu AMDgpu driver
   3 =========================
   4
   5 The drm/amdgpu driver supports all AMD Radeon GPUs based on the Graphics Core
   6 Next (GCN) architecture.
   7
   8 Module Parameters
   9 =================
  10
  11 The amdgpu driver supports the following module parameters:
  12
  13 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_drv.c
  14
  15 Core Driver Infrastructure
  16 ==========================
  17
  18 This section covers core driver infrastructure.
  19
  20 .. _amdgpu_memory_domains:
  21
  22 Memory Domains
  23 --------------
  24
  25 .. kernel-doc:: include/uapi/drm/amdgpu_drm.h
  26    :doc: memory domains
  27
  28 Buffer 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
  37 PRIME 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
  46 MMU 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
  55 AMDGPU 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
  64 Interrupt 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
  73 AMDGPU XGMI Support
  74 ===================
  75
  76 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c
  77    :doc: AMDGPU XGMI Support
  78
  79 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_xgmi.c
  80    :internal:
  81
  82 AMDGPU RAS Support
  83 ==================
  84
  85 The AMDGPU RAS interfaces are exposed via sysfs (for informational queries) and
  86 debugfs (for error injection).
  87
  88 RAS debugfs/sysfs Control and Error Injection Interfaces
  89 --------------------------------------------------------
  90
  91 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
  92    :doc: AMDGPU RAS debugfs control interface
  93
  94 RAS Reboot Behavior for Unrecoverable Errors
  95 --------------------------------------------------------
  96
  97 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
  98    :doc: AMDGPU RAS Reboot Behavior for Unrecoverable Errors
  99
 100 RAS Error Count sysfs Interface
 101 -------------------------------
 102
 103 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
 104    :doc: AMDGPU RAS sysfs Error Count Interface
 105
 106 RAS EEPROM debugfs Interface
 107 ----------------------------
 108
 109 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
 110    :doc: AMDGPU RAS debugfs EEPROM table reset interface
 111
 112 RAS VRAM Bad Pages sysfs Interface
 113 ----------------------------------
 114
 115 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
 116    :doc: AMDGPU RAS sysfs gpu_vram_bad_pages Interface
 117
 118 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c
 119    :internal:
 120
 121 Sample Code
 122 -----------
 123 Sample code for testing error injection can be found here:
 124 https://cgit.freedesktop.org/mesa/drm/tree/tests/amdgpu/ras_tests.c
 125
 126 This is part of the libdrm amdgpu unit tests which cover several areas of the GPU.
 127 There are four sets of tests:
 128
 129 RAS Basic Test
 130
 131 The test verifies the RAS feature enabled status and makes sure the necessary sysfs and debugfs files
 132 are present.
 133
 134 RAS Query Test
 135
 136 This test checks the RAS availability and enablement status for each supported IP block as well as
 137 the error counts.
 138
 139 RAS Inject Test
 140
 141 This test injects errors for each IP.
 142
 143 RAS Disable Test
 144
 145 This test tests disabling of RAS features for each IP block.
 146
 147
 148 GPU Power/Thermal Controls and Monitoring
 149 =========================================
 150
 151 This section covers hwmon and power/thermal controls.
 152
 153 HWMON Interfaces
 154 ----------------
 155
 156 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 157    :doc: hwmon
 158
 159 GPU sysfs Power State Interfaces
 160 --------------------------------
 161
 162 GPU power controls are exposed via sysfs files.
 163
 164 power_dpm_state
 165 ~~~~~~~~~~~~~~~
 166
 167 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 168    :doc: power_dpm_state
 169
 170 power_dpm_force_performance_level
 171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 172
 173 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 174    :doc: power_dpm_force_performance_level
 175
 176 pp_table
 177 ~~~~~~~~
 178
 179 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 180    :doc: pp_table
 181
 182 pp_od_clk_voltage
 183 ~~~~~~~~~~~~~~~~~
 184
 185 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 186    :doc: pp_od_clk_voltage
 187
 188 pp_dpm_*
 189 ~~~~~~~~
 190
 191 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 192    :doc: pp_dpm_sclk pp_dpm_mclk pp_dpm_socclk pp_dpm_fclk pp_dpm_dcefclk pp_dpm_pcie
 193
 194 pp_power_profile_mode
 195 ~~~~~~~~~~~~~~~~~~~~~
 196
 197 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 198    :doc: pp_power_profile_mode
 199
 200 busy_percent
 201 ~~~~~~~~~~~~
 202
 203 .. kernel-doc:: drivers/gpu/drm/amd/amdgpu/amdgpu_pm.c
 204    :doc: busy_percent