github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-31 02:24:24 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

drm/xe/guc: Add kernel-doc for xe_guc_ct_send_recv()

Browse Source 
Add initial documentation for recently updated xe_guc_ct_send_recv().

Signed-off-by: Michal Wajdeczko <michal.wajdeczko@intel.com>
Cc: Matthew Brost <matthew.brost@intel.com>
Reviewed-by: Matthew Brost <matthew.brost@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240112102554.761-2-michal.wajdeczko@intel.com
This commit is contained in:
Michal Wajdeczko 2024-01-12 11:25:54 +01:00
parent a54e016ace
commit 6af7ee0827
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
drivers/gpu/drm/xe/xe_guc_ct.c
View File

@ -785,6 +785,24 @@ static int guc_ct_send_recv(struct xe_guc_ct *ct, const u32 *action, u32 len,
return ret > 0 ? response_buffer ? g2h_fence.response_len : g2h_fence.response_data : ret;
}
/**
* xe_guc_ct_send_recv - Send and receive HXG to the GuC
* @ct: the &xe_guc_ct
* @action: the dword array with `HXG Request`_ message (can't be NULL)
* @len: length of the `HXG Request`_ message (in dwords, can't be 0)
* @response_buffer: placeholder for the `HXG Response`_ message (can be NULL)
*
* Send a `HXG Request`_ message to the GuC over CT communication channel and
* blocks until GuC replies with a `HXG Response`_ message.
*
* For non-blocking communication with GuC use xe_guc_ct_send().
*
* Note: The size of &response_buffer must be at least GUC_CTB_MAX_DWORDS_.
*
* Return: response length (in dwords) if &response_buffer was not NULL, or
* DATA0 from `HXG Response`_ if &response_buffer was NULL, or
* a negative error code on failure.
*/
int xe_guc_ct_send_recv(struct xe_guc_ct *ct, const u32 *action, u32 len,
u32 *response_buffer)
{