Intel-XE Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Michal Wajdeczko <michal.wajdeczko@intel.com>
To: intel-xe@lists.freedesktop.org
Subject: [PATCH 2/2] drm/xe/guc: Add kernel-doc for HXG Fast Request
Date: Mon, 10 Jun 2024 14:04:11 +0200	[thread overview]
Message-ID: <20240610120411.1768-3-michal.wajdeczko@intel.com> (raw)
In-Reply-To: <20240610120411.1768-1-michal.wajdeczko@intel.com>

We have kernel-doc for all HXG message types but Fast Request.

Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
---
 drivers/gpu/drm/xe/abi/guc_messages_abi.h | 28 +++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/drivers/gpu/drm/xe/abi/guc_messages_abi.h b/drivers/gpu/drm/xe/abi/guc_messages_abi.h
index e32142e3fe41..f6ed4dfd215c 100644
--- a/drivers/gpu/drm/xe/abi/guc_messages_abi.h
+++ b/drivers/gpu/drm/xe/abi/guc_messages_abi.h
@@ -91,6 +91,34 @@
 #define GUC_HXG_REQUEST_MSG_0_ACTION		(0xffffu << 0)
 #define GUC_HXG_REQUEST_MSG_n_DATAn		GUC_HXG_MSG_n_PAYLOAD
 
+/**
+ * DOC: HXG Fast Request
+ *
+ * The `HXG Request`_ message should be used to initiate asynchronous activity
+ * for which confirmation or return data is not expected.
+ *
+ * If confirmation is required then `HXG Request`_ shall be used instead.
+ *
+ * The recipient of this message may only use `HXG Failure`_ message if it was
+ * unable to accept this request (like invalid data).
+ *
+ * Format of `HXG Fast Request`_ message is same as `HXG Request`_ except @TYPE.
+ *
+ *  +---+-------+--------------------------------------------------------------+
+ *  |   | Bits  | Description                                                  |
+ *  +===+=======+==============================================================+
+ *  | 0 |    31 | ORIGIN - see `HXG Message`_                                  |
+ *  |   +-------+--------------------------------------------------------------+
+ *  |   | 30:28 | TYPE = `GUC_HXG_TYPE_FAST_REQUEST`_                          |
+ *  |   +-------+--------------------------------------------------------------+
+ *  |   | 27:16 | DATA0 - see `HXG Request`_                                   |
+ *  |   +-------+--------------------------------------------------------------+
+ *  |   |  15:0 | ACTION - see `HXG Request`_                                  |
+ *  +---+-------+--------------------------------------------------------------+
+ *  |...|       | DATAn - see `HXG Request`_                                   |
+ *  +---+-------+--------------------------------------------------------------+
+ */
+
 /**
  * DOC: HXG Event
  *
-- 
2.43.0


  parent reply	other threads:[~2024-06-10 12:04 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-10 12:04 [PATCH 0/2] Fixup GuC ABI Michal Wajdeczko
2024-06-10 12:04 ` [PATCH 1/2] drm/xe/guc: Drop unused legacy GuC message ABI definitions Michal Wajdeczko
2024-06-10 13:02   ` Nirmoy Das
2024-06-10 12:04 ` Michal Wajdeczko [this message]
2024-06-10 13:05   ` [PATCH 2/2] drm/xe/guc: Add kernel-doc for HXG Fast Request Nirmoy Das
2024-06-11 15:09   ` Lucas De Marchi
2024-06-11 16:18     ` Michal Wajdeczko
2024-06-10 12:11 ` ✓ CI.Patch_applied: success for Fixup GuC ABI Patchwork
2024-06-10 12:11 ` ✓ CI.checkpatch: " Patchwork
2024-06-10 12:12 ` ✓ CI.KUnit: " Patchwork
2024-06-10 12:28 ` ✓ CI.Build: " Patchwork
2024-06-10 12:30 ` ✓ CI.Hooks: " Patchwork
2024-06-10 12:31 ` ✓ CI.checksparse: " Patchwork
2024-06-10 13:26 ` ✓ CI.BAT: " Patchwork
2024-06-10 15:12 ` ✗ CI.FULL: failure " Patchwork
2024-06-10 16:55   ` Michal Wajdeczko

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=20240610120411.1768-3-michal.wajdeczko@intel.com \
    --to=michal.wajdeczko@intel.com \
    --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