[PATCH 2/2] drm/xe/guc: Add kernel-doc for HXG Fast Request

[Michal Wajdeczko]

On 11.06.2024 17:09, Lucas De Marchi wrote:
> On Mon, Jun 10, 2024 at 02:04:11PM GMT, Michal Wajdeczko wrote:
>> We have kernel-doc for all HXG message types but Fast Request.
>>
>> Signed-off-by: Michal Wajdeczko <michal.wajdeczko at 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
> 
> I think you meant HXG Fast Request here.

oops, it was copy-pasted from i915 as-as and already pushed ;(

will sent fixup (including ones found while working on 134722)

> 
> Lucas De Marchi
> 
>> + * 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
>>