diff mbox series

[RFC,2/7] Documentation/gpu: Separate GuC ABI section

Message ID 20240611143008.1900-3-michal.wajdeczko@intel.com (mailing list archive)
State New, archived
Headers show
Series Promote GuC ABI headers to shared location | expand

Commit Message

Michal Wajdeczko June 11, 2024, 2:30 p.m. UTC 
GuC ABI definitions are not strictly tied to the i915 driver.
Move them to a separate section.

Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
---
 Documentation/gpu/drivers.rst |  1 +
 Documentation/gpu/guc.rst     | 16 ++++++++++++++++
 Documentation/gpu/i915.rst    |  9 ---------
 3 files changed, 17 insertions(+), 9 deletions(-)
 create mode 100644 Documentation/gpu/guc.rst
diff mbox series

Patch

diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst
index b899cbc5c2b4..294e39e34c32 100644
--- a/Documentation/gpu/drivers.rst
+++ b/Documentation/gpu/drivers.rst
@@ -7,6 +7,7 @@  GPU Driver Documentation
 
    amdgpu/index
    i915
+   guc
    imagination/index
    mcde
    meson
diff --git a/Documentation/gpu/guc.rst b/Documentation/gpu/guc.rst
new file mode 100644
index 000000000000..b0fcb824c15a
--- /dev/null
+++ b/Documentation/gpu/guc.rst
@@ -0,0 +1,16 @@ 
+.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
+
+======================
+drm/intel GuC firmware
+======================
+
+The graphics microcontroller (GuC) is available starting from Gen9 hardware.
+
+GuC ABI
+=======
+
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_messages_abi.h
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_abi.h
+.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_klvs_abi.h
diff --git a/Documentation/gpu/i915.rst b/Documentation/gpu/i915.rst
index ad59ae579237..e96fd87ffd94 100644
--- a/Documentation/gpu/i915.rst
+++ b/Documentation/gpu/i915.rst
@@ -541,15 +541,6 @@  GuC-based command submission
 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_guc_submission.c
    :doc: GuC-based command submission
 
-GuC ABI
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_messages_abi.h
-.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
-.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
-.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_actions_abi.h
-.. kernel-doc:: drivers/gpu/drm/i915/gt/uc/abi/guc_klvs_abi.h
-
 HuC
 ---
 .. kernel-doc:: drivers/gpu/drm/i915/gt/uc/intel_huc.c