id
stringlengths
4
63
text
stringlengths
153
8.81M
xe_guc_exec_queue_cgp_sync_done_handler(9)
NAME xe_guc_exec_queue_cgp_sync_done_handler - CGP synchronization done handler SYNOPSIS int xe_guc_exec_queue_cgp_sync_done_handler (struct xe_guc *guc , u32 *msg , u32 len ); ARGUMENTS guc guc msg message indicating CGP sync done len length of message DESCRIPTION Set multi q...
xe_guc_exec_queue_snapshot_capture(9)
NAME xe_guc_exec_queue_snapshot_capture - Take a quick snapshot of the GuC Engine. SYNOPSIS struct xe_guc_submit_exec_queue_snapshot * xe_guc_exec_queue_snapshot_capture (struct xe_exec_queue *q ); ARGUMENTS q faulty exec queue DESCRIPTION This can be printed out in a later stage like during dev_coredump a...
xe_guc_exec_queue_snapshot_capture_delayed(9)
NAME xe_guc_exec_queue_snapshot_capture_delayed - Take delayed part of snapshot of the GuC Engine. SYNOPSIS void xe_guc_exec_queue_snapshot_capture_delayed (struct xe_guc_submit_exec_queue_snapshot *snapshot ); ARGUMENTS snapshot Previously captured snapshot of job. DESCRIPTION This captures some data that requir...
xe_guc_exec_queue_snapshot_free(9)
NAME xe_guc_exec_queue_snapshot_free - Free all allocated objects for a given snapshot. SYNOPSIS void xe_guc_exec_queue_snapshot_free (struct xe_guc_submit_exec_queue_snapshot *snapshot ); ARGUMENTS snapshot GuC Submit Engine snapshot object. DESCRIPTION This function free all the memory that needed to be allocat...
xe_guc_exec_queue_snapshot_print(9)
NAME xe_guc_exec_queue_snapshot_print - Print out a given GuC Engine snapshot. SYNOPSIS void xe_guc_exec_queue_snapshot_print (struct xe_guc_submit_exec_queue_snapshot *snapshot , struct drm_printer *p ); ARGUMENTS snapshot GuC Submit Engine snapshot object. p drm_printer where it will be printed...
xe_guc_fw_version_at_least(9)
NAME xe_guc_fw_version_at_least - Check if GuC is at least of given version. SYNOPSIS bool xe_guc_fw_version_at_least (const struct xe_guc *guc , u32 ver ); ARGUMENTS guc the xe_guc ver the version to check DESCRIPTION The ver should be prepared using MAKE_GUC_VER(major, minor, patch). RETUR...
xe_guc_has_registered_mlrc_queues(9)
NAME xe_guc_has_registered_mlrc_queues - check whether there are any MLRC queues registered with the GuC SYNOPSIS bool xe_guc_has_registered_mlrc_queues (struct xe_guc *guc ); ARGUMENTS guc GuC. RETURN true if any MLRC queue is registered with the GuC, false otherwise. SEE ALSO Kernel file ./drivers/gpu/d...
xe_guc_id_mgr_init(9)
NAME xe_guc_id_mgr_init - Initialize GuC context ID Manager. SYNOPSIS int xe_guc_id_mgr_init (struct xe_guc_id_mgr *idm , unsigned int limit ); ARGUMENTS idm the xe_guc_id_mgr to initialize limit number of IDs to manage DESCRIPTION The bare-metal or PF driver can pass ~0 as limit to indicat...
xe_guc_id_mgr_print(9)
NAME xe_guc_id_mgr_print - Print status of GuC ID Manager. SYNOPSIS void xe_guc_id_mgr_print (struct xe_guc_id_mgr *idm , struct drm_printer *p , int indent ); ARGUMENTS idm the xe_guc_id_mgr to print p the drm_printer to print to indent tab indentation level SEE ALSO Kernel fi...
xe_guc_id_mgr_release(9)
NAME xe_guc_id_mgr_release - Release a range of GuC context IDs. SYNOPSIS void xe_guc_id_mgr_release (struct xe_guc_id_mgr *idm , unsigned int start , unsigned int count ); ARGUMENTS idm the xe_guc_id_mgr start the starting ID of GuC context range to release count number of GuC con...
xe_guc_id_mgr_release_locked(9)
NAME xe_guc_id_mgr_release_locked - Release one or more GuC context IDs. SYNOPSIS void xe_guc_id_mgr_release_locked (struct xe_guc_id_mgr *idm , unsigned int id , unsigned int count ); ARGUMENTS idm the xe_guc_id_mgr id the GuC context ID to release count number of IDs to releas...
xe_guc_id_mgr_reserve(9)
NAME xe_guc_id_mgr_reserve - Reserve a range of GuC context IDs. SYNOPSIS int xe_guc_id_mgr_reserve (struct xe_guc_id_mgr *idm , unsigned int count , unsigned int retain ); ARGUMENTS idm the xe_guc_id_mgr count number of GuC context IDs to reserve (can't be 0) retain number of GuC c...
xe_guc_id_mgr_reserve_locked(9)
NAME xe_guc_id_mgr_reserve_locked - Reserve one or more GuC context IDs. SYNOPSIS int xe_guc_id_mgr_reserve_locked (struct xe_guc_id_mgr *idm , unsigned int count ); ARGUMENTS idm the xe_guc_id_mgr count number of IDs to allocate (can't be 0) DESCRIPTION This function is dedicated for the use b...
xe_guc_init_post_hwconfig(9)
NAME xe_guc_init_post_hwconfig - initialize GuC post hwconfig load SYNOPSIS int xe_guc_init_post_hwconfig (struct xe_guc *guc ); ARGUMENTS guc The GuC object RETURN 0 on success, negative error code on error. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc.c xe_guc_comm_init_early(9), xe_guc_min_load_f...
xe_guc_klv_count(9)
NAME xe_guc_klv_count - Count KLVs present in the buffer. SYNOPSIS int xe_guc_klv_count (const u32 *klvs , u32 num_dwords ); ARGUMENTS klvs the buffer with KLVs num_dwords number of dwords (u32) in the buffer RETURN number of recognized KLVs or a negative error code if KLV buffer is truncated. SEE A...
xe_guc_klv_key_to_string(9)
NAME xe_guc_klv_key_to_string - Convert KLV key into friendly name. SYNOPSIS const char * xe_guc_klv_key_to_string (u16 key ); ARGUMENTS key the `GuC KLV`_ key RETURN name of the KLV key. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_klv_helpers.c xe_guc_klv_print(9), xe_guc_klv_count(9) April 2026 ...
xe_guc_klv_print(9)
NAME xe_guc_klv_print - Print content of the buffer with `GuC KLV`_. SYNOPSIS void xe_guc_klv_print (const u32 *klvs , u32 num_dwords , struct drm_printer *p ); ARGUMENTS klvs the buffer with KLVs num_dwords number of dwords (u32) available in the buffer p the drm_printer DESCRIPTIO...
xe_guc_klv_threshold_index_to_key(9)
NAME xe_guc_klv_threshold_index_to_key - Get tracked GuC threshold KLV key. SYNOPSIS u32 xe_guc_klv_threshold_index_to_key (enum xe_guc_klv_threshold_index index ); ARGUMENTS index GuC threshold KLV index. DESCRIPTION This translation is automatically generated using MAKE_XE_GUC_KLV_THRESHOLDS_SET. RETURN key...
xe_guc_klv_threshold_key_to_index(9)
NAME xe_guc_klv_threshold_key_to_index - Find index of the tracked GuC threshold. SYNOPSIS int xe_guc_klv_threshold_key_to_index (u32 key ); ARGUMENTS key GuC threshold KLV key. DESCRIPTION This translation is automatically generated using MAKE_XE_GUC_KLV_THRESHOLDS_SET. RETURN index of the GuC threshold KL...
xe_guc_log_print(9)
NAME xe_guc_log_print - dump a copy of the GuC log to some useful location SYNOPSIS void xe_guc_log_print (struct xe_guc_log *log , struct drm_printer *p ); ARGUMENTS log GuC log structure p the printer object to output to SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_log.c xe_guc_log_sn...
xe_guc_log_print_dmesg(9)
NAME xe_guc_log_print_dmesg - dump a copy of the GuC log to dmesg SYNOPSIS void xe_guc_log_print_dmesg (struct xe_guc_log *log ); ARGUMENTS log GuC log structure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_log.c xe_guc_log_snapshot_free(9), xe_guc_log_snapshot_capture(9), xe_guc_log_snapshot_print(9), x...
xe_guc_log_print_lfd(9)
NAME xe_guc_log_print_lfd - dump a copy of the GuC log in LFD format SYNOPSIS void xe_guc_log_print_lfd (struct xe_guc_log *log , struct drm_printer *p ); ARGUMENTS log GuC log structure p the printer object to output to SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_log.c xe_guc_log_snap...
xe_guc_log_snapshot_capture(9)
NAME xe_guc_log_snapshot_capture - create a new snapshot copy the GuC log for later dumping SYNOPSIS struct xe_guc_log_snapshot * xe_guc_log_snapshot_capture (struct xe_guc_log *log , bool atomic ); ARGUMENTS log GuC log structure atomic is the call inside an atomic section of some kind? RETURN ...
xe_guc_log_snapshot_free(9)
NAME xe_guc_log_snapshot_free - free a previously captured GuC log snapshot SYNOPSIS void xe_guc_log_snapshot_free (struct xe_guc_log_snapshot *snapshot ); ARGUMENTS snapshot GuC log snapshot structure RETURN pointer to a newly allocated snapshot object or null if out of memory. Caller is responsible for calling ...
xe_guc_log_snapshot_print(9)
NAME xe_guc_log_snapshot_print - dump a previously saved copy of the GuC log to some useful location SYNOPSIS void xe_guc_log_snapshot_print (struct xe_guc_log_snapshot *snapshot , struct drm_printer *p ); ARGUMENTS snapshot a snapshot of the GuC log p the printer object to output to SEE ALSO Ke...
xe_guc_min_load_for_hwconfig(9)
NAME xe_guc_min_load_for_hwconfig - load minimal GuC and read hwconfig table SYNOPSIS int xe_guc_min_load_for_hwconfig (struct xe_guc *guc ); ARGUMENTS guc The GuC object DESCRIPTION This function uploads a minimal GuC that does not support submissions but in a state where the hwconfig table can be read. Ne...
xe_guc_pagefault_handler(9)
NAME xe_guc_pagefault_handler - G2H page fault handler SYNOPSIS int xe_guc_pagefault_handler (struct xe_guc *guc , u32 *msg , u32 len ); ARGUMENTS guc GuC object msg G2H message len Length of G2H message DESCRIPTION Parse GuC to host (G2H) message into a struct xe_pagefault an...
xe_guc_pc_apply_flush_freq_limit(9)
NAME xe_guc_pc_apply_flush_freq_limit - Limit max GT freq during L2 flush SYNOPSIS void xe_guc_pc_apply_flush_freq_limit (struct xe_guc_pc *pc ); ARGUMENTS pc the xe_guc_pc object DESCRIPTION As per the WA, reduce max GT frequency during L2 cache flush SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc...
xe_guc_pc_c_status(9)
NAME xe_guc_pc_c_status - get the current GT C state SYNOPSIS enum xe_gt_idle_state xe_guc_pc_c_status (struct xe_guc_pc *pc ); ARGUMENTS pc XE_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe...
xe_guc_pc_fini_hw(9)
NAME xe_guc_pc_fini_hw - Finalize GuC's Power Conservation component SYNOPSIS void xe_guc_pc_fini_hw (void *arg ); ARGUMENTS arg opaque pointer that should point to Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_g...
xe_guc_pc_get_act_freq(9)
NAME xe_guc_pc_get_act_freq - Get Actual running frequency SYNOPSIS u32 xe_guc_pc_get_act_freq (struct xe_guc_pc *pc ); ARGUMENTS pc The GuC PC RETURN The Actual running frequency. Which might be 0 if GT is in Render-C sleep state (RC6). SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel...
xe_guc_pc_get_cur_freq(9)
NAME xe_guc_pc_get_cur_freq - Get Current requested frequency SYNOPSIS int xe_guc_pc_get_cur_freq (struct xe_guc_pc *pc , u32 *freq ); ARGUMENTS pc The GuC PC freq A pointer to a u32 where the freq value will be returned RETURN 0 on success, -EAGAIN if GuC PC not ready (likely in middle of a ...
xe_guc_pc_get_cur_freq_fw(9)
NAME xe_guc_pc_get_cur_freq_fw - With fw held, get requested frequency SYNOPSIS u32 xe_guc_pc_get_cur_freq_fw (struct xe_guc_pc *pc ); ARGUMENTS pc The GuC PC RETURN the requested frequency for that GT instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), ...
xe_guc_pc_get_max_freq(9)
NAME xe_guc_pc_get_max_freq - Get Maximum operational frequency SYNOPSIS int xe_guc_pc_get_max_freq (struct xe_guc_pc *pc , u32 *freq ); ARGUMENTS pc The GuC PC freq A pointer to a u32 where the freq value will be returned RETURN 0 on success, -EAGAIN if GuC PC not ready (likely in middle of ...
xe_guc_pc_get_min_freq(9)
NAME xe_guc_pc_get_min_freq - Get the min operational frequency SYNOPSIS int xe_guc_pc_get_min_freq (struct xe_guc_pc *pc , u32 *freq ); ARGUMENTS pc The GuC PC freq A pointer to a u32 where the freq value will be returned RETURN 0 on success, -EAGAIN if GuC PC not ready (likely in middle of ...
xe_guc_pc_get_rp0_freq(9)
NAME xe_guc_pc_get_rp0_freq - Get the RP0 freq SYNOPSIS u32 xe_guc_pc_get_rp0_freq (struct xe_guc_pc *pc ); ARGUMENTS pc The GuC PC RETURN RP0 freq. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_ge...
xe_guc_pc_get_rpa_freq(9)
NAME xe_guc_pc_get_rpa_freq - Get the RPa freq SYNOPSIS u32 xe_guc_pc_get_rpa_freq (struct xe_guc_pc *pc ); ARGUMENTS pc The GuC PC RETURN RPa freq. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_ge...
xe_guc_pc_get_rpe_freq(9)
NAME xe_guc_pc_get_rpe_freq - Get the RPe freq SYNOPSIS u32 xe_guc_pc_get_rpe_freq (struct xe_guc_pc *pc ); ARGUMENTS pc The GuC PC RETURN RPe freq. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_ge...
xe_guc_pc_get_rpn_freq(9)
NAME xe_guc_pc_get_rpn_freq - Get the RPn freq SYNOPSIS u32 xe_guc_pc_get_rpn_freq (struct xe_guc_pc *pc ); ARGUMENTS pc The GuC PC RETURN RPn freq. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_ge...
xe_guc_pc_gucrc_disable(9)
NAME xe_guc_pc_gucrc_disable - Disable GuC RC SYNOPSIS int xe_guc_pc_gucrc_disable (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance DESCRIPTION Disables GuC RC by taking control of RC6 back from GuC. RETURN 0 on success, negative error code on error. SEE ALSO Kernel file ./drivers/gpu/drm/xe...
xe_guc_pc_init(9)
NAME xe_guc_pc_init - Initialize GuC's Power Conservation component SYNOPSIS int xe_guc_pc_init (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc...
xe_guc_pc_init_early(9)
NAME xe_guc_pc_init_early - Initialize RPx values SYNOPSIS void xe_guc_pc_init_early (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_get_cur_fr...
xe_guc_pc_mc6_residency(9)
NAME xe_guc_pc_mc6_residency - mc6 residency counter SYNOPSIS u64 xe_guc_pc_mc6_residency (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_get_c...
xe_guc_pc_override_gucrc_mode(9)
NAME xe_guc_pc_override_gucrc_mode - override GUCRC mode SYNOPSIS int xe_guc_pc_override_gucrc_mode (struct xe_guc_pc *pc , enum slpc_gucrc_mode mode ); ARGUMENTS pc Xe_GuC_PC instance mode new value of the mode. RETURN 0 on success, negative error code on error SEE ALSO Kernel file ./...
xe_guc_pc_print(9)
NAME xe_guc_pc_print - Print GuC's Power Conservation information for debug SYNOPSIS void xe_guc_pc_print (struct xe_guc_pc *pc , struct drm_printer *p ); ARGUMENTS pc Xe_GuC_PC instance p drm_printer SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_gu...
xe_guc_pc_raise_unslice(9)
NAME xe_guc_pc_raise_unslice - Initialize RPx values and request a higher GT frequency to allow faster GuC load times SYNOPSIS void xe_guc_pc_raise_unslice (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_f...
xe_guc_pc_rc6_residency(9)
NAME xe_guc_pc_rc6_residency - rc6 residency counter SYNOPSIS u64 xe_guc_pc_rc6_residency (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_get_c...
xe_guc_pc_remove_flush_freq_limit(9)
NAME xe_guc_pc_remove_flush_freq_limit - Remove max GT freq limit after L2 flush completes. SYNOPSIS void xe_guc_pc_remove_flush_freq_limit (struct xe_guc_pc *pc ); ARGUMENTS pc the xe_guc_pc object DESCRIPTION Retrieve the previous GT max frequency value. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe...
xe_guc_pc_restore_stashed_freq(9)
NAME xe_guc_pc_restore_stashed_freq - Set min/max back to stashed values SYNOPSIS int xe_guc_pc_restore_stashed_freq (struct xe_guc_pc *pc ); ARGUMENTS pc The GuC PC RETURN 0 on success, error code on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_...
xe_guc_pc_set_max_freq(9)
NAME xe_guc_pc_set_max_freq - Set the maximum operational frequency SYNOPSIS int xe_guc_pc_set_max_freq (struct xe_guc_pc *pc , u32 freq ); ARGUMENTS pc The GuC PC freq The selected maximum frequency value RETURN 0 on success, -EAGAIN if GuC PC not ready (likely in middle of a reset), -EINVAL...
xe_guc_pc_set_min_freq(9)
NAME xe_guc_pc_set_min_freq - Set the minimal operational frequency SYNOPSIS int xe_guc_pc_set_min_freq (struct xe_guc_pc *pc , u32 freq ); ARGUMENTS pc The GuC PC freq The selected minimal frequency RETURN 0 on success, -EAGAIN if GuC PC not ready (likely in middle of a reset), -EINVAL if va...
xe_guc_pc_start(9)
NAME xe_guc_pc_start - Start GuC's Power Conservation component SYNOPSIS int xe_guc_pc_start (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_ge...
xe_guc_pc_stop(9)
NAME xe_guc_pc_stop - Stop GuC's Power Conservation component SYNOPSIS int xe_guc_pc_stop (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_act_freq(9), xe_guc_pc_get_cur_freq_fw(9), xe_guc_pc_get_c...
xe_guc_pc_unset_gucrc_mode(9)
NAME xe_guc_pc_unset_gucrc_mode - unset GUCRC mode override SYNOPSIS int xe_guc_pc_unset_gucrc_mode (struct xe_guc_pc *pc ); ARGUMENTS pc Xe_GuC_PC instance RETURN 0 on success, negative error code on error SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_pc.c Kernel API(9), xe_guc_pc_get_ac...
xe_guc_register_vf_exec_queue(9)
NAME xe_guc_register_vf_exec_queue - Register exec queue for a given context type. SYNOPSIS void xe_guc_register_vf_exec_queue (struct xe_exec_queue *q , int ctx_type ); ARGUMENTS q Execution queue ctx_type Type of the context DESCRIPTION This function registers the execution queue with the...
xe_guc_relay_init(9)
NAME xe_guc_relay_init - Initialize a &xe_guc_relay SYNOPSIS int xe_guc_relay_init (struct xe_guc_relay *relay ); ARGUMENTS relay the xe_guc_relay to initialize DESCRIPTION Initialize remaining members of xe_guc_relay that may depend on the SR-IOV mode. RETURN 0 on success or a negative error code on failure....
xe_guc_relay_process_guc2pf(9)
NAME xe_guc_relay_process_guc2pf - Handle relay notification message from the GuC. SYNOPSIS int xe_guc_relay_process_guc2pf (struct xe_guc_relay *relay , const u32 *msg , u32 len ); ARGUMENTS relay the xe_guc_relay which will handle the message msg message to be handled len lengt...
xe_guc_relay_process_guc2vf(9)
NAME xe_guc_relay_process_guc2vf - Handle relay notification message from the GuC. SYNOPSIS int xe_guc_relay_process_guc2vf (struct xe_guc_relay *relay , const u32 *msg , u32 len ); ARGUMENTS relay the xe_guc_relay which will handle the message msg message to be handled len lengt...
xe_guc_relay_send_to_pf(9)
NAME xe_guc_relay_send_to_pf - Send a message to the PF. SYNOPSIS int xe_guc_relay_send_to_pf (struct xe_guc_relay *relay , const u32 *msg , u32 len , u32 *buf , u32 buf_size ); ARGUMENTS relay the xe_guc_relay which will send the message msg request message to be sent len length...
xe_guc_relay_send_to_vf(9)
NAME xe_guc_relay_send_to_vf - Send a message to the VF. SYNOPSIS int xe_guc_relay_send_to_vf (struct xe_guc_relay *relay , u32 target , const u32 *msg , u32 len , u32 *buf , u32 buf_size ); ARGUMENTS relay the xe_guc_relay which will send the message target target VF number msg req...
xe_guc_runtime_resume(9)
NAME xe_guc_runtime_resume - GuC runtime resume SYNOPSIS void xe_guc_runtime_resume (struct xe_guc *guc ); ARGUMENTS guc The GuC object DESCRIPTION Runtime resume GuC CT and allow further runs of submission tasks on given GuC. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc.c xe_guc_comm_init_early(9), ...
xe_guc_runtime_suspend(9)
NAME xe_guc_runtime_suspend - GuC runtime suspend SYNOPSIS void xe_guc_runtime_suspend (struct xe_guc *guc ); ARGUMENTS guc The GuC object DESCRIPTION Stop further runs of submission tasks on given GuC and runtime suspend GuC CT. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc.c xe_guc_comm_init_early(9...
xe_guc_softreset(9)
NAME xe_guc_softreset - Soft reset GuC SYNOPSIS int xe_guc_softreset (struct xe_guc *guc ); ARGUMENTS guc The GuC object DESCRIPTION Send soft reset command to GuC through mmio send. RETURN 0 if success, otherwise error code SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc.c xe_guc_comm_init_early(9), xe_g...
xe_guc_submit_init(9)
NAME xe_guc_submit_init - Initialize GuC submission. SYNOPSIS int xe_guc_submit_init (struct xe_guc *guc , unsigned int num_ids ); ARGUMENTS guc the xe_guc to initialize num_ids number of GuC context IDs to use DESCRIPTION The bare-metal or PF driver can pass ~0 as num_ids to indicate that all Gu...
xe_guc_submit_pause(9)
NAME xe_guc_submit_pause - Stop further runs of submission tasks on given GuC. SYNOPSIS void xe_guc_submit_pause (struct xe_guc *guc ); ARGUMENTS guc the xe_guc struct instance whose scheduler is to be disabled SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_submit.c xe_guc_submit_init(9), Kernel API(9),...
xe_guc_submit_pause_abort(9)
NAME xe_guc_submit_pause_abort - Abort all paused submission task on given GuC. SYNOPSIS void xe_guc_submit_pause_abort (struct xe_guc *guc ); ARGUMENTS guc the xe_guc struct instance whose scheduler is to be aborted SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_submit.c xe_guc_submit_init(9), Kernel ...
xe_guc_submit_pause_vf(9)
NAME xe_guc_submit_pause_vf - Stop further runs of submission tasks for VF. SYNOPSIS void xe_guc_submit_pause_vf (struct xe_guc *guc ); ARGUMENTS guc the xe_guc struct instance whose scheduler is to be disabled SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_submit.c xe_guc_submit_init(9), Kernel API(9...
xe_guc_submit_print(9)
NAME xe_guc_submit_print - GuC Submit Print. SYNOPSIS void xe_guc_submit_print (struct xe_guc *guc , struct drm_printer *p ); ARGUMENTS guc GuC. p drm_printer where it will be printed out. DESCRIPTION This function capture and prints snapshots of **all** GuC Engines. SEE ALSO Kernel file ...
xe_guc_submit_unpause(9)
NAME xe_guc_submit_unpause - Allow further runs of submission tasks on given GuC. SYNOPSIS void xe_guc_submit_unpause (struct xe_guc *guc ); ARGUMENTS guc the xe_guc struct instance whose scheduler is to be enabled SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_submit.c xe_guc_submit_init(9), Kernel A...
xe_guc_submit_unpause_prepare_vf(9)
NAME xe_guc_submit_unpause_prepare_vf - Prepare unpause submission tasks for VF. SYNOPSIS void xe_guc_submit_unpause_prepare_vf (struct xe_guc *guc ); ARGUMENTS guc the xe_guc struct instance whose scheduler is to be prepared for unpause SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_submit.c xe_guc_sub...
xe_guc_submit_unpause_vf(9)
NAME xe_guc_submit_unpause_vf - Allow further runs of submission tasks for VF. SYNOPSIS void xe_guc_submit_unpause_vf (struct xe_guc *guc ); ARGUMENTS guc the xe_guc struct instance whose scheduler is to be enabled SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_submit.c xe_guc_submit_init(9), Kernel A...
xe_guc_submit_wedge(9)
NAME xe_guc_submit_wedge - Wedge GuC submission SYNOPSIS void xe_guc_submit_wedge (struct xe_guc *guc ); ARGUMENTS guc the GuC object DESCRIPTION Save exec queue's registered with GuC state by taking a ref to each queue. Register a DRMM handler to drop refs upon driver unload. SEE ALSO Kernel file ./driv...
xe_guc_tlb_inval_done_handler(9)
NAME xe_guc_tlb_inval_done_handler - TLB invalidation done handler SYNOPSIS int xe_guc_tlb_inval_done_handler (struct xe_guc *guc , u32 *msg , u32 len ); ARGUMENTS guc guc msg message indicating TLB invalidation done len length of message DESCRIPTION Parse seqno of TLB invalid...
xe_guc_tlb_inval_init_early(9)
NAME xe_guc_tlb_inval_init_early - Init GuC TLB invalidation early SYNOPSIS void xe_guc_tlb_inval_init_early (struct xe_guc *guc , struct xe_tlb_inval *tlb_inval ); ARGUMENTS guc GuC object tlb_inval TLB invalidation client DESCRIPTION Initialize GuC TLB invalidation by setting back pointer in TLB ...
xe_guc_using_main_gamctrl_queues(9)
NAME xe_guc_using_main_gamctrl_queues - Detect which reporting queues to use. SYNOPSIS bool xe_guc_using_main_gamctrl_queues (struct xe_guc *guc ); ARGUMENTS guc The GuC object DESCRIPTION For Xe3p and beyond, we want to program the hardware to use the "Main GAMCTRL queue" rather than the legacy queue be...
xe_hw_engine_class_sysfs_init(9)
NAME xe_hw_engine_class_sysfs_init - Init HW engine classes on GT. SYNOPSIS int xe_hw_engine_class_sysfs_init (struct xe_gt *gt ); ARGUMENTS gt Xe GT. DESCRIPTION This routine creates sysfs for HW engine classes and adds methods to get/set different scheduling properties for HW engines class. RETURN Return...
xe_hw_engine_group_add_exec_queue(9)
NAME xe_hw_engine_group_add_exec_queue - Add an exec queue to a hw engine group SYNOPSIS int xe_hw_engine_group_add_exec_queue (struct xe_hw_engine_group *group , struct xe_exec_queue *q ); ARGUMENTS group The hw engine group q The exec_queue RETURN 0 on success, -EINTR if the lock could not ...
xe_hw_engine_group_del_exec_queue(9)
NAME xe_hw_engine_group_del_exec_queue - Delete an exec queue from a hw engine group SYNOPSIS void xe_hw_engine_group_del_exec_queue (struct xe_hw_engine_group *group , struct xe_exec_queue *q ); ARGUMENTS group The hw engine group q The exec_queue SEE ALSO Kernel file ./drivers/gpu/drm/xe/...
xe_hw_engine_group_find_exec_mode(9)
NAME xe_hw_engine_group_find_exec_mode - Find the execution mode for this exec queue SYNOPSIS enum xe_hw_engine_group_execution_mode xe_hw_engine_group_find_exec_mode (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_hw_engine_group.c xe_hw_engine_setup_...
xe_hw_engine_group_get_mode(9)
NAME xe_hw_engine_group_get_mode - Get the group to execute in the new mode SYNOPSIS int xe_hw_engine_group_get_mode (struct xe_hw_engine_group *group , enum xe_hw_engine_group_execution_mode new_mode , enum xe_hw_engine_group_execution_mode *previous_mode , struct xe_sync_entry *syncs , int num_syncs ); ARGUMENTS gr...
xe_hw_engine_group_put(9)
NAME xe_hw_engine_group_put - Put the group SYNOPSIS void xe_hw_engine_group_put (struct xe_hw_engine_group *group ); ARGUMENTS group The hw engine group SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_hw_engine_group.c xe_hw_engine_setup_groups(9), xe_hw_engine_group_add_exec_queue(9), xe_hw_engine_group_de...
xe_hw_engine_group_resume_faulting_lr_jobs(9)
NAME xe_hw_engine_group_resume_faulting_lr_jobs - Asynchronously resume the hw engine group's faulting LR jobs SYNOPSIS void xe_hw_engine_group_resume_faulting_lr_jobs (struct xe_hw_engine_group *group ); ARGUMENTS group The hw engine group SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_hw_engine_group.c xe_h...
xe_hw_engine_group_suspend_faulting_lr_jobs(9)
NAME xe_hw_engine_group_suspend_faulting_lr_jobs - Suspend the faulting LR jobs of this group SYNOPSIS int xe_hw_engine_group_suspend_faulting_lr_jobs (struct xe_hw_engine_group *group , bool has_deps ); ARGUMENTS group The hw engine group has_deps dma-fence job triggering suspend has dependencies R...
xe_hw_engine_group_wait_for_dma_fence_jobs(9)
NAME xe_hw_engine_group_wait_for_dma_fence_jobs - Wait for dma fence jobs to complete SYNOPSIS int xe_hw_engine_group_wait_for_dma_fence_jobs (struct xe_hw_engine_group *group ); ARGUMENTS group The hw engine group DESCRIPTION This function is not meant to be called directly from a user IOCTL as dma_fence_wait...
xe_hw_engine_lookup(9)
NAME xe_hw_engine_lookup - Lookup hardware engine for class:instance SYNOPSIS struct xe_hw_engine * xe_hw_engine_lookup (struct xe_device *xe , struct drm_xe_engine_class_instance eci ); ARGUMENTS xe xe device eci engine class and instance DESCRIPTION This function will find a hardware engin...
xe_hw_engine_mmio_read32(9)
NAME xe_hw_engine_mmio_read32 - Read engine register SYNOPSIS u32 xe_hw_engine_mmio_read32 (struct xe_hw_engine *hwe , struct xe_reg reg ); ARGUMENTS hwe engine reg register to read from DESCRIPTION This function will read from an engine specific register. Forcewake must be held by the calle...
xe_hw_engine_mmio_write32(9)
NAME xe_hw_engine_mmio_write32 - Write engine register SYNOPSIS void xe_hw_engine_mmio_write32 (struct xe_hw_engine *hwe , struct xe_reg reg , u32 val ); ARGUMENTS hwe engine reg register to write into val desired 32-bit value to write DESCRIPTION This function will write val ...
xe_hw_engine_print(9)
NAME xe_hw_engine_print - Xe HW Engine Print. SYNOPSIS void xe_hw_engine_print (struct xe_hw_engine *hwe , struct drm_printer *p ); ARGUMENTS hwe Hardware Engine. p drm_printer. DESCRIPTION This function quickly capture a snapshot and immediately print it out. SEE ALSO Kernel file ./driver...
xe_hw_engine_setup_groups(9)
NAME xe_hw_engine_setup_groups - Setup the hw engine groups for the gt SYNOPSIS int xe_hw_engine_setup_groups (struct xe_gt *gt ); ARGUMENTS gt The gt for which groups are setup RETURN 0 on success, negative error code on error. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_hw_engine_group.c xe_hw_eng...
xe_hw_engine_snapshot_capture(9)
NAME xe_hw_engine_snapshot_capture - Take a quick snapshot of the HW Engine. SYNOPSIS struct xe_hw_engine_snapshot * xe_hw_engine_snapshot_capture (struct xe_hw_engine *hwe , struct xe_exec_queue *q ); ARGUMENTS hwe Xe HW Engine. q The exec queue object. DESCRIPTION This can be printed out ...
xe_hw_engine_snapshot_free(9)
NAME xe_hw_engine_snapshot_free - Free all allocated objects for a given snapshot. SYNOPSIS void xe_hw_engine_snapshot_free (struct xe_hw_engine_snapshot *snapshot ); ARGUMENTS snapshot Xe HW Engine snapshot object. DESCRIPTION This function free all the memory that needed to be allocated at capture time. SEE AL...
xe_hw_engine_timeout_in_range(9)
NAME xe_hw_engine_timeout_in_range - Helper to check if timeout is in range SYNOPSIS bool xe_hw_engine_timeout_in_range (u64 timeout , u64 min , u64 max ); ARGUMENTS timeout timeout to validate min min value of valid range max max value of valid range DESCRIPTION This helper helps...
xe_hw_error_init(9)
NAME xe_hw_error_init - Initialize hw errors SYNOPSIS void xe_hw_error_init (struct xe_device *xe ); ARGUMENTS xe xe device instance DESCRIPTION Initialize and check for errors that occurred during boot prior to driver load SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_hw_error.c xe_hw_error_irq_handler(9) ...
xe_hw_error_irq_handler(9)
NAME xe_hw_error_irq_handler - irq handling for hw errors SYNOPSIS void xe_hw_error_irq_handler (struct xe_tile *tile , const u32 master_ctl ); ARGUMENTS tile tile instance master_ctl value read from master interrupt register DESCRIPTION Xe platforms add three error bits to the master interrupt reg...
xe_hw_fence_alloc(9)
NAME xe_hw_fence_alloc - Allocate an hw fence. SYNOPSIS struct dma_fence * xe_hw_fence_alloc (void ); ARGUMENTS void no arguments DESCRIPTION Allocate but don't initialize an hw fence. RETURN Pointer to the allocated fence or negative error pointer on error. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_hw_f...
xe_hw_fence_free(9)
NAME xe_hw_fence_free - Free an hw fence. SYNOPSIS void xe_hw_fence_free (struct dma_fence *fence ); ARGUMENTS fence Pointer to the fence to free. DESCRIPTION Frees an hw fence that hasn't yet been initialized. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_hw_fence.c xe_hw_fence_alloc(9), xe_hw_fence_init(9) ...
xe_hw_fence_init(9)
NAME xe_hw_fence_init - Initialize an hw fence. SYNOPSIS void xe_hw_fence_init (struct dma_fence *fence , struct xe_hw_fence_ctx *ctx , struct iosys_map seqno_map ); ARGUMENTS fence Pointer to the fence to initialize. ctx Pointer to the struct xe_hw_fence_ctx fence context. seqno_map P...
xe_i2c_irq_handler(9)
NAME xe_i2c_irq_handler - Handler for I2C interrupts SYNOPSIS void xe_i2c_irq_handler (struct xe_device *xe , u32 master_ctl ); ARGUMENTS xe xe device instance master_ctl interrupt register DESCRIPTION Forward interrupts generated by the I2C host adapter to the I2C host adapter driver. SEE ALSO Ke...
xe_i2c_present(9)
NAME xe_i2c_present - I2C controller is present and functional SYNOPSIS bool xe_i2c_present (struct xe_device *xe ); ARGUMENTS xe xe device instance DESCRIPTION Check whether the I2C controller is present and functioning with valid endpoint cookie. RETURN true if present, false otherwise. SEE ALSO Kernel ...
xe_i2c_probe(9)
NAME xe_i2c_probe - Probe the I2C host adapter and the I2C clients attached to it SYNOPSIS int xe_i2c_probe (struct xe_device *xe ); ARGUMENTS xe xe device instance DESCRIPTION Register all the I2C devices described in the I2C Endpoint data structure. RETURN 0 on success, error code on failure SEE ALSO Ke...