Intel-XE Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Michal Wajdeczko <michal.wajdeczko@intel.com>
To: intel-gfx@lists.freedesktop.org, intel-xe@lists.freedesktop.org
Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
Subject: [RFC 2/7] Documentation/gpu: Separate GuC ABI section
Date: Tue, 11 Jun 2024 16:30:03 +0200	[thread overview]
Message-ID: <20240611143008.1900-3-michal.wajdeczko@intel.com> (raw)
In-Reply-To: <20240611143008.1900-1-michal.wajdeczko@intel.com>

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 --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
-- 
2.43.0


  parent reply	other threads:[~2024-06-11 14:30 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-11 14:30 [RFC 0/7] Promote GuC ABI headers to shared location Michal Wajdeczko
2024-06-11 14:30 ` [RFC 1/7] drm/xe/guc: " Michal Wajdeczko
2024-06-11 14:30 ` Michal Wajdeczko [this message]
2024-06-11 14:30 ` [RFC 3/7] Documentation/gpu: Switch to shared GuC ABI definitions Michal Wajdeczko
2024-06-11 14:30 ` [RFC 4/7] drm/intel/guc: Update CTB communication ABI Michal Wajdeczko
2024-06-11 14:30 ` [RFC 5/7] drm/intel/guc: Add new KLV definitions Michal Wajdeczko
2024-06-11 14:30 ` [RFC 6/7] drm/i915: Use shared GuC ABI definitions Michal Wajdeczko
2024-06-11 14:30 ` [RFC 7/7] drm/xe: Promote SR-IOV GuC ABI definitions to shared location Michal Wajdeczko
2024-06-11 14:36 ` ✓ CI.Patch_applied: success for Promote GuC ABI headers " Patchwork
2024-06-11 14:36 ` ✗ CI.checkpatch: warning " Patchwork
2024-06-11 14:37 ` ✓ CI.KUnit: success " Patchwork
2024-06-11 14:49 ` ✓ CI.Build: " Patchwork
2024-06-11 14:51 ` ✗ CI.Hooks: failure " Patchwork
2024-06-11 14:52 ` ✗ CI.checksparse: warning " Patchwork
2024-06-11 15:13 ` [RFC 0/7] " Lucas De Marchi
2024-06-11 15:34 ` ✓ CI.BAT: success for " Patchwork
2024-06-11 17:08 ` ✗ CI.FULL: failure " Patchwork
2024-06-11 20:32 ` [RFC 0/7] " John Harrison
2024-06-11 21:45   ` Michal Wajdeczko
2024-06-11 22:12     ` Rodrigo Vivi
2024-06-12  4:12       ` Lucas De Marchi
2024-06-12 21:18     ` John Harrison

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240611143008.1900-3-michal.wajdeczko@intel.com \
    --to=michal.wajdeczko@intel.com \
    --cc=intel-gfx@lists.freedesktop.org \
    --cc=intel-xe@lists.freedesktop.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox