Update docuemntation for V2.2

GPUOpen-Tools · Jun 28, 2024 · 9add69a · 9add69a
1 parent 97d1fcc
commit 9add69a
Show file tree

Hide file tree

Showing 22 changed files with 2,787 additions and 2,773 deletions.
diff --git a/RELEASE_NOTES.txt b/RELEASE_NOTES.txt
@@ -1,18 +1,14 @@
-Radeon™ GPU Profiler V2.1 04-24-2024
+Radeon™ GPU Profiler V2.2 07-01-2024
 -------------------------------------
 
-V2.1 Changes
+V2.2 Changes
 -------------------------------------
 
-* Radeon GPU Profiler
-
-1) Interoperability with the Radeon GPU Analyzer: binary pipelines can now be extracted from a loaded profile data set in RGP and automatically loaded into a new instance of RGA for analysis
-2) Rows in Wavefront occupancy pane can now be resized, allowing for additional user customization
-3) New "Color by limiting factor" coloring mode in the Wavefront occupancy and Event timing panes. This will highlight events whose theoretical occupancy is limited by VGPR usage, LDS usage or thread group dimensions
-4) New "Color by context rolls" coloring mode in the Wavefront occupancy and Event timing panes. This will highlight events where a context roll occurred since the previous event
-5) Latency visualization in the Instruction timing pane will now show which part of the total latency represents a "pre-issue" stall
-6) Fixed issue with incorrect LDS usage reported on RDNA™-based GPUs
-7) Bug/stability fixes
+1) Updated to use Qt 6.7.0
+2) Fix a crash when loading a RADV-exported profile (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/98)
+3) Enabling shader instrumentation (to support showing thread divergence in the ray tracing shader table UI) for Vulkan® is now supported starting with 24.10-based drivers
+4) Reduced profile load time for certain profiles, especially for those captured on RDNA™ 3 hardware
+5) Bug/stability fixes
 
 Known Issues
 -------------------------------------
@@ -46,6 +42,19 @@ Known Issues
 Release Notes History
 -------------------------------------
 
+V2.1 Changes
+-------------------------------------
+
+* Radeon GPU Profiler
+
+1) Interoperability with the Radeon GPU Analyzer: binary pipelines can now be extracted from a loaded profile data set in RGP and automatically loaded into a new instance of RGA for analysis
+2) Rows in Wavefront occupancy pane can now be resized, allowing for additional user customization
+3) New "Color by limiting factor" coloring mode in the Wavefront occupancy and Event timing panes. This will highlight events whose theoretical occupancy is limited by VGPR usage, LDS usage or thread group dimensions
+4) New "Color by context rolls" coloring mode in the Wavefront occupancy and Event timing panes. This will highlight events where a context roll occurred since the previous event
+5) Latency visualization in the Instruction timing pane will now show which part of the total latency represents a "pre-issue" stall
+6) Fixed issue with incorrect LDS usage reported on RDNA-based GPUs
+7) Bug/stability fixes
+
 V2.0 Changes
 -------------------------------------
 

diff --git a/docs/source/api_shader_stage_control.rst b/docs/source/api_shader_stage_control.rst
@@ -0,0 +1,55 @@
+.. _api_shader_stage_control:
+
+API Shader Stage Control
+========================
+
+Several views in RGP provide information about which API shader stages are active
+for a particular event or pipeline. This information is represented by the API Shader
+Stage control.
+
+**NOTE**: This control is only available for DirectX and Vulkan profiles.
+
+This control appears in the **Most expensive events** and **Pipelines** Overview panes, as well
+as in the Details side panel in the **Wavefront occupancy** and **Event timings** panes, and in the
+toolbar area of the **Instruction timing** pane.
+
+Here are examples of what the control looks like for a few different DirectX12 and Vulkan pipelines.
+
+DirectX12 pipeline with the VS and PS stages active:
+
+.. image:: media_rgp/rgp_dx12_pipeline_stage_vs_ps.png
+
+DirectX12 pipeline with the VS, HS, DS and PS stages active:
+
+.. image:: media_rgp/rgp_dx12_pipeline_stage_vs_hs_ds_ps.png
+
+DirectX12 pipeline with the VS, GS and PS stages active:
+
+.. image:: media_rgp/rgp_dx12_pipeline_stage_vs_gs_ps.png
+
+DirectX12 pipeline with the CS stages active:
+
+.. image:: media_rgp/rgp_dx12_pipeline_stage_cs.png
+
+DirectX12 pipeline with the RT stages active:
+
+.. image:: media_rgp/rgp_dx12_pipeline_stage_rt.png
+
+Vulkan pipeline with the VS and FS stages active:
+
+.. image:: media_rgp/rgp_vk_pipeline_stage_vs_fs.png
+
+Vulkan pipeline with the CS stages active:
+
+.. image:: media_rgp/rgp_vk_pipeline_stage_cs.png
+
+Vulkan pipeline with the RT stages active:
+
+.. image:: media_rgp/rgp_vk_pipeline_stage_rt.png
+
+This control can also indicate when a particular shader stage contains inline ray
+tracing. When this is detected, a stage will indicate this with a gradient red
+pattern painted in that stage's box. Here is an example of a DirectX12 pipeline
+where the compute shader performs inline ray tracing:
+
+.. image:: media_rgp/rgp_dx12_pipeline_stage_cs_with_inline_rt.png
diff --git a/docs/source/barriers.rst b/docs/source/barriers.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -56,9 +56,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'2.1.0'
+version = u'2.2.0'
 # The full version, including alpha/beta/rc tags.
-release = u'2.1.0'
+release = u'2.2.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/event_timing.rst b/docs/source/event_timing.rst