Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
drm/xe/guc: Add kernel-doc for HXG Fast Request
We have kernel-doc for all HXG message types but Fast Request.
Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
Acked-by: Nirmoy Das <nirmoy.das@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240610120411.1768-3-michal.wajdeczko@intel.com
+28
+28
drivers/gpu/drm/xe/abi/guc_messages_abi.h
+28
drivers/gpu/drm/xe/abi/guc_messages_abi.h
···
92
92
#define GUC_HXG_REQUEST_MSG_n_DATAn GUC_HXG_MSG_n_PAYLOAD
93
93
94
94
/**
95
+
* DOC: HXG Fast Request
96
+
*
97
+
* The `HXG Request`_ message should be used to initiate asynchronous activity
98
+
* for which confirmation or return data is not expected.
99
+
*
100
+
* If confirmation is required then `HXG Request`_ shall be used instead.
101
+
*
102
+
* The recipient of this message may only use `HXG Failure`_ message if it was
103
+
* unable to accept this request (like invalid data).
104
+
*
105
+
* Format of `HXG Fast Request`_ message is same as `HXG Request`_ except @TYPE.
106
+
*
107
+
* +---+-------+--------------------------------------------------------------+
108
+
* | | Bits | Description |
109
+
* +===+=======+==============================================================+
110
+
* | 0 | 31 | ORIGIN - see `HXG Message`_ |
111
+
* | +-------+--------------------------------------------------------------+
112
+
* | | 30:28 | TYPE = `GUC_HXG_TYPE_FAST_REQUEST`_ |
113
+
* | +-------+--------------------------------------------------------------+
114
+
* | | 27:16 | DATA0 - see `HXG Request`_ |
115
+
* | +-------+--------------------------------------------------------------+
116
+
* | | 15:0 | ACTION - see `HXG Request`_ |
117
+
* +---+-------+--------------------------------------------------------------+
118
+
* |...| | DATAn - see `HXG Request`_ |
119
+
* +---+-------+--------------------------------------------------------------+
120
+
*/
121
+
122
+
/**
95
123
* DOC: HXG Event
96
124
*
97
125
* The `HXG Event`_ message should be used to initiate asynchronous activity