Commit 6af7ee08 authored by Michal Wajdeczko's avatar Michal Wajdeczko
Browse files

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



Add initial documentation for recently updated xe_guc_ct_send_recv().

Signed-off-by: default avatarMichal Wajdeczko <michal.wajdeczko@intel.com>
Cc: Matthew Brost <matthew.brost@intel.com>
Reviewed-by: default avatarMatthew Brost <matthew.brost@intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20240112102554.761-2-michal.wajdeczko@intel.com
parent a54e016a

drivers/gpu/drm/xe/xe_guc_ct.c

+18 −0
Original line number Diff line number Diff line
@@ -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)

{