From 712d8fb0434a0af6d0479a5ea44a7bbc49dd8b2b Mon Sep 17 00:00:00 2001
From: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Date: Tue, 11 Jan 2022 11:31:07 +0200
Subject: [PATCH] intel/nir: document RT builder

Signed-off-by: Lionel Landwerlin <lionel.g.landwerlin@intel.com>
Reviewed-by: Caio Oliveira <caio.oliveira@intel.com>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/13719>
---
 src/intel/compiler/brw_nir_rt_builder.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/intel/compiler/brw_nir_rt_builder.h b/src/intel/compiler/brw_nir_rt_builder.h
index 5a4cfff..86de1ad 100644
--- a/src/intel/compiler/brw_nir_rt_builder.h
+++ b/src/intel/compiler/brw_nir_rt_builder.h
@@ -24,6 +24,14 @@
 #ifndef BRW_NIR_RT_BUILDER_H
 #define BRW_NIR_RT_BUILDER_H
 
+/* This file provides helpers to access memory based data structures that the
+ * RT hardware reads/writes and their locations.
+ *
+ * See also "Memory Based Data Structures for Ray Tracing" (BSpec 47547) and
+ * "Ray Tracing Address Computation for Memory Resident Structures" (BSpec
+ * 47550).
+ */
+
 #include "brw_rt.h"
 #include "nir_builder.h"
 
-- 
2.7.4