id
stringlengths
4
63
text
stringlengths
153
8.81M
xe_gt_sriov_pf_policy_set_reset_engine(9)
NAME xe_gt_sriov_pf_policy_set_reset_engine - Control the 'reset_engine' policy. SYNOPSIS int xe_gt_sriov_pf_policy_set_reset_engine (struct xe_gt *gt , bool enable ); ARGUMENTS gt the xe_gt where to apply the policy enable the value of the 'reset_engine' policy DESCRIPTION This function can on...
xe_gt_sriov_pf_policy_set_sample_period(9)
NAME xe_gt_sriov_pf_policy_set_sample_period - Control the 'sample_period' policy. SYNOPSIS int xe_gt_sriov_pf_policy_set_sample_period (struct xe_gt *gt , u32 value ); ARGUMENTS gt the xe_gt where to apply the policy value the value of the 'sample_period' policy DESCRIPTION This function can ...
xe_gt_sriov_pf_policy_set_sched_groups_mode(9)
NAME xe_gt_sriov_pf_policy_set_sched_groups_mode - Control the 'sched_groups' policy. SYNOPSIS int xe_gt_sriov_pf_policy_set_sched_groups_mode (struct xe_gt *gt , enum xe_sriov_sched_group_modes mode ); ARGUMENTS gt the xe_gt where to apply the policy mode the sched_group mode to be activated ...
xe_gt_sriov_pf_policy_set_sched_if_idle(9)
NAME xe_gt_sriov_pf_policy_set_sched_if_idle - Control the 'sched_if_idle' policy. SYNOPSIS int xe_gt_sriov_pf_policy_set_sched_if_idle (struct xe_gt *gt , bool enable ); ARGUMENTS gt the xe_gt where to apply the policy enable the value of the 'sched_if_idle' policy DESCRIPTION This function ca...
xe_gt_sriov_pf_restart(9)
NAME xe_gt_sriov_pf_restart - Restart SR-IOV support after a GT reset. SYNOPSIS void xe_gt_sriov_pf_restart (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function can only be called on PF. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_pf.c xe_gt_sriov_pf_init_early(9), ...
xe_gt_sriov_pf_sanitize_hw(9)
NAME xe_gt_sriov_pf_sanitize_hw - Reset hardware state related to a VF. SYNOPSIS void xe_gt_sriov_pf_sanitize_hw (struct xe_gt *gt , unsigned int vfid ); ARGUMENTS gt the xe_gt vfid the VF identifier DESCRIPTION This function can only be called on PF. SEE ALSO Kernel file ./drivers/gpu/drm...
xe_gt_sriov_pf_sched_groups_enabled(9)
NAME xe_gt_sriov_pf_sched_groups_enabled - Check if multiple scheduler groups are enabled SYNOPSIS bool xe_gt_sriov_pf_sched_groups_enabled (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for PF use only. RETURN true if shed groups were enabled, false otherwise. SEE ALSO Kernel f...
xe_gt_sriov_pf_service_init(9)
NAME xe_gt_sriov_pf_service_init - Early initialization of the GT SR-IOV PF services. SYNOPSIS int xe_gt_sriov_pf_service_init (struct xe_gt *gt ); ARGUMENTS gt the xe_gt to initialize DESCRIPTION Performs early initialization of the GT SR-IOV PF services, including preparation of the runtime info that will...
xe_gt_sriov_pf_service_print_runtime(9)
NAME xe_gt_sriov_pf_service_print_runtime - Print PF runtime data shared with VFs. SYNOPSIS int xe_gt_sriov_pf_service_print_runtime (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt the xe_gt p the drm_printer DESCRIPTION This function is for PF use only. SEE ALSO Kernel file ./d...
xe_gt_sriov_pf_service_process_request(9)
NAME xe_gt_sriov_pf_service_process_request - Service GT level SR-IOV request message from the VF. SYNOPSIS int xe_gt_sriov_pf_service_process_request (struct xe_gt *gt , u32 origin , const u32 *msg , u32 msg_len , u32 *response , u32 resp_size ); ARGUMENTS gt the xe_gt that provides the service orig...
xe_gt_sriov_pf_service_update(9)
NAME xe_gt_sriov_pf_service_update - Update PF SR-IOV services. SYNOPSIS void xe_gt_sriov_pf_service_update (struct xe_gt *gt ); ARGUMENTS gt the xe_gt to update DESCRIPTION Updates runtime data shared with VFs. This function can be called more than once. This function can only be called on PF. SEE ALSO ...
xe_gt_sriov_pf_stop_prepare(9)
NAME xe_gt_sriov_pf_stop_prepare - Prepare to stop SR-IOV support. SYNOPSIS void xe_gt_sriov_pf_stop_prepare (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function can only be called on the PF. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_pf.c xe_gt_sriov_pf_init_early(9), xe_gt_...
xe_gt_sriov_pf_wait_ready(9)
NAME xe_gt_sriov_pf_wait_ready - Wait until per-GT PF SR-IOV support is ready. SYNOPSIS int xe_gt_sriov_pf_wait_ready (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function can only be called on PF. RETURN 0 on success or a negative error code on failure. SEE ALSO Kernel file ./drivers/gpu...
xe_gt_sriov_vf_bootstrap(9)
NAME xe_gt_sriov_vf_bootstrap - Query and setup GuC ABI interface version. SYNOPSIS int xe_gt_sriov_vf_bootstrap (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for VF use only. It requires functional `GuC MMIO based communication`_. RETURN 0 on success or a negative error code on...
xe_gt_sriov_vf_connect(9)
NAME xe_gt_sriov_vf_connect - Establish connection with the PF driver. SYNOPSIS int xe_gt_sriov_vf_connect (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for VF use only. RETURN 0 on success or a negative error code on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe/x...
xe_gt_sriov_vf_debugfs_register(9)
NAME xe_gt_sriov_vf_debugfs_register - Register SR-IOV VF specific entries in GT debugfs. SYNOPSIS void xe_gt_sriov_vf_debugfs_register (struct xe_gt *gt , struct dentry *root ); ARGUMENTS gt the xe_gt to register root the dentry that represents the GT directory DESCRIPTION Register SR-IOV VF...
xe_gt_sriov_vf_default_lrcs_hwsp_rebase(9)
NAME xe_gt_sriov_vf_default_lrcs_hwsp_rebase - Update GGTT references in HWSP of default LRCs. SYNOPSIS void xe_gt_sriov_vf_default_lrcs_hwsp_rebase (struct xe_gt *gt ); ARGUMENTS gt the xe_gt struct instance SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_vf.c xe_gt_sriov_vf_reset(9), ...
xe_gt_sriov_vf_gmdid(9)
NAME xe_gt_sriov_vf_gmdid - Query GMDID over MMIO. SYNOPSIS u32 xe_gt_sriov_vf_gmdid (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for VF use only. RETURN value of GMDID KLV on success or 0 on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_vf.c xe_gt_sriov_vf_r...
xe_gt_sriov_vf_guc_ids(9)
NAME xe_gt_sriov_vf_guc_ids - VF GuC context IDs configuration. SYNOPSIS u16 xe_gt_sriov_vf_guc_ids (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for VF use only. RETURN number of GuC context IDs assigned to VF. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_vf.c xe_gt...
xe_gt_sriov_vf_guc_versions(9)
NAME xe_gt_sriov_vf_guc_versions - Minimum required and found GuC ABI versions SYNOPSIS void xe_gt_sriov_vf_guc_versions (struct xe_gt *gt , struct xe_uc_fw_version *wanted , struct xe_uc_fw_version *found ); ARGUMENTS gt the xe_gt wanted pointer to the xe_uc_fw_version to be filled with the wan...
xe_gt_sriov_vf_init(9)
NAME xe_gt_sriov_vf_init - GT VF init SYNOPSIS int xe_gt_sriov_vf_init (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION Return 0 on success, errno on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_vf.c xe_gt_sriov_vf_reset(9), xe_gt_sriov_vf_bootstrap(9), xe_gt_sr...
xe_gt_sriov_vf_init_early(9)
NAME xe_gt_sriov_vf_init_early - GT VF init early SYNOPSIS int xe_gt_sriov_vf_init_early (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION Return 0 on success, errno on failure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_vf.c xe_gt_sriov_vf_reset(9), xe_gt_sriov_vf_bootstra...
xe_gt_sriov_vf_migrated_event_handler(9)
NAME xe_gt_sriov_vf_migrated_event_handler - Start a VF migration recovery, or just mark that a GuC is ready for it. SYNOPSIS void xe_gt_sriov_vf_migrated_event_handler (struct xe_gt *gt ); ARGUMENTS gt the xe_gt struct instance linked to target GuC DESCRIPTION This function shall be called only by VF. SEE...
xe_gt_sriov_vf_print_config(9)
NAME xe_gt_sriov_vf_print_config - Print VF self config. SYNOPSIS void xe_gt_sriov_vf_print_config (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt the xe_gt p the drm_printer DESCRIPTION This function is for VF use only. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_s...
xe_gt_sriov_vf_print_runtime(9)
NAME xe_gt_sriov_vf_print_runtime - Print VF's runtime regs received from PF. SYNOPSIS void xe_gt_sriov_vf_print_runtime (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt the xe_gt p the drm_printer DESCRIPTION This function is for VF use only. SEE ALSO Kernel file ./driv...
xe_gt_sriov_vf_print_version(9)
NAME xe_gt_sriov_vf_print_version - Print VF ABI versions. SYNOPSIS void xe_gt_sriov_vf_print_version (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt the xe_gt p the drm_printer DESCRIPTION This function is for VF use only. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_g...
xe_gt_sriov_vf_query_config(9)
NAME xe_gt_sriov_vf_query_config - Query SR-IOV config data over MMIO. SYNOPSIS int xe_gt_sriov_vf_query_config (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for VF use only. This function may shift the GGTT and is performed under GGTT lock, making this step visible to all GTs tha...
xe_gt_sriov_vf_query_runtime(9)
NAME xe_gt_sriov_vf_query_runtime - Query SR-IOV runtime data. SYNOPSIS int xe_gt_sriov_vf_query_runtime (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for VF use only. RETURN 0 on success or a negative error code on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_...
xe_gt_sriov_vf_read32(9)
NAME xe_gt_sriov_vf_read32 - Get a register value from the runtime data. SYNOPSIS u32 xe_gt_sriov_vf_read32 (struct xe_gt *gt , struct xe_reg reg ); ARGUMENTS gt the xe_gt reg the register to read DESCRIPTION This function is for VF use only. This function shall be called after VF has conne...
xe_gt_sriov_vf_recovery_pending(9)
NAME xe_gt_sriov_vf_recovery_pending - VF post migration recovery pending SYNOPSIS bool xe_gt_sriov_vf_recovery_pending (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION The return value of this function must be immediately visible upon vCPU unhalt and must persist until RESFIX_DONE is issued. This...
xe_gt_sriov_vf_reset(9)
NAME xe_gt_sriov_vf_reset - Reset GuC VF internal state. SYNOPSIS int xe_gt_sriov_vf_reset (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION It requires functional `GuC MMIO based communication`_. RETURN 0 on success or a negative error code on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe/...
xe_gt_sriov_vf_sched_groups_enabled(9)
NAME xe_gt_sriov_vf_sched_groups_enabled - Check if PF has enabled multiple scheduler groups SYNOPSIS bool xe_gt_sriov_vf_sched_groups_enabled (struct xe_gt *gt ); ARGUMENTS gt the xe_gt DESCRIPTION This function is for VF use only. RETURN true if shed groups were enabled, false otherwise. SEE ALSO Kernel...
xe_gt_sriov_vf_wait_valid_ggtt(9)
NAME xe_gt_sriov_vf_wait_valid_ggtt - VF wait for valid GGTT addresses SYNOPSIS void xe_gt_sriov_vf_wait_valid_ggtt (struct xe_gt *gt ); ARGUMENTS gt the xe_gt SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_sriov_vf.c xe_gt_sriov_vf_reset(9), xe_gt_sriov_vf_bootstrap(9), xe_gt_sriov_vf...
xe_gt_sriov_vf_write32(9)
NAME xe_gt_sriov_vf_write32 - Handle a write to an inaccessible register. SYNOPSIS void xe_gt_sriov_vf_write32 (struct xe_gt *gt , struct xe_reg reg , u32 val ); ARGUMENTS gt the xe_gt reg the register to write val value to write DESCRIPTION This function is for VF use only. ...
xe_gt_stats_clear(9)
NAME xe_gt_stats_clear - Clear the GT stats SYNOPSIS void xe_gt_stats_clear (struct xe_gt *gt ); ARGUMENTS gt GT structure DESCRIPTION This clear (zeros) all the available GT stats. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_stats.c xe_gt_stats_incr(9), xe_gt_stats_print_info(9) April 2026 ...
xe_gt_stats_incr(9)
NAME xe_gt_stats_incr - Increments the specified stats counter SYNOPSIS void xe_gt_stats_incr (struct xe_gt *gt , const enum xe_gt_stats_id id , int incr ); ARGUMENTS gt GT structure id xe_gt_stats_id type id that needs to be incremented incr value to be incremented with DESC...
xe_gt_stats_ktime_get(9)
NAME xe_gt_stats_ktime_get - Get current ktime SYNOPSIS ktime_t xe_gt_stats_ktime_get (void ); ARGUMENTS void no arguments DESCRIPTION Helper for GT stats to get current ktime, compiles out if GT stats are disabled. RETURN Get current ktime SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_stats.h xe_gt_stats...
xe_gt_stats_ktime_us_delta(9)
NAME xe_gt_stats_ktime_us_delta - Get delta in microseconds between now and a start time SYNOPSIS s64 xe_gt_stats_ktime_us_delta (ktime_t start ); ARGUMENTS start Start time DESCRIPTION Helper for GT stats to get delta in microseconds between now and a start time, compiles out if GT stats are disabled. RETURN...
xe_gt_stats_print_info(9)
NAME xe_gt_stats_print_info - Print the GT stats SYNOPSIS int xe_gt_stats_print_info (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt GT structure p drm_printer where it will be printed out. DESCRIPTION This prints out all the available GT stats. SEE ALSO Kernel file ./drivers/gp...
xe_gt_tlb_inval_init_early(9)
NAME xe_gt_tlb_inval_init_early - Initialize TLB invalidation state SYNOPSIS int xe_gt_tlb_inval_init_early (struct xe_gt *gt ); ARGUMENTS gt GT structure DESCRIPTION Initialize TLB invalidation state, purely software initialization, should be called once during driver load. RETURN 0 on success, negative e...
xe_gt_topology_dump(9)
NAME xe_gt_topology_dump - Dump GT topology into a drm printer. SYNOPSIS int xe_gt_topology_dump (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt the xe_gt p the drm_printer RETURN always 0. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_topology.c gen_l3_mask_from_pattern(9), x...
xe_gt_topology_has_dss_in_quadrant(9)
NAME xe_gt_topology_has_dss_in_quadrant - check fusing of DSS in GT quadrant SYNOPSIS bool xe_gt_topology_has_dss_in_quadrant (struct xe_gt *gt , int quad ); ARGUMENTS gt GT to check quad Which quadrant of the DSS space to check DESCRIPTION Since Xe_HP platforms can have up to four CCS engine...
xe_gt_topology_mask_last_dss(9)
NAME xe_gt_topology_mask_last_dss - Returns the index of the last DSS in a mask. SYNOPSIS unsigned int xe_gt_topology_mask_last_dss (const xe_dss_mask_t mask ); ARGUMENTS mask Input DSS mask RETURN Index of the last DSS in the input DSS mask, XE_MAX_DSS_FUSE_BITS if DSS mask is empty. SEE ALSO Kernel file ./...
xe_gt_wait_for_reset(9)
NAME xe_gt_wait_for_reset - wait for gt's async reset to finalize. SYNOPSIS bool xe_gt_wait_for_reset (struct xe_gt *gt ); ARGUMENTS gt GT structure RETURN true if it waited for the work to finish execution, false if there was no scheduled reset or it was done. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_...
xe_guard_arm(9)
NAME xe_guard_arm - Arm the guard for the exclusive/lockdown mode. SYNOPSIS int xe_guard_arm (struct xe_guard *guard , bool lockdown , void *who ); ARGUMENTS guard the xe_guard to arm lockdown arm for lockdown(true) or exclusive(false) mode who optional owner info (for debug only) DE...
xe_guard_disarm(9)
NAME xe_guard_disarm - Disarm the guard from exclusive/lockdown mode. SYNOPSIS bool xe_guard_disarm (struct xe_guard *guard , bool lockdown ); ARGUMENTS guard the xe_guard to disarm lockdown disarm from lockdown(true) or exclusive(false) mode RETURN true if successfully disarmed or false in case of ...
xe_guard_init(9)
NAME xe_guard_init - Initialize the guard. SYNOPSIS void xe_guard_init (struct xe_guard *guard , const char *name ); ARGUMENTS guard the xe_guard to init name name of the guard SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guard.h struct xe_guard(9), xe_guard_arm(9), xe_guard_disarm(9), xe_guard_...
xe_guard_mode_str(9)
NAME xe_guard_mode_str - Convert guard mode into a string. SYNOPSIS const char * xe_guard_mode_str (bool lockdown ); ARGUMENTS lockdown flag used to select lockdown or exclusive mode RETURN "lockdown" or "exclusive" string. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guard.h struct xe_guard(9), xe_guard_init(9)...
xe_guc_ads_init_post_hwconfig(9)
NAME xe_guc_ads_init_post_hwconfig - initialize ADS post hwconfig load SYNOPSIS int xe_guc_ads_init_post_hwconfig (struct xe_guc_ads *ads ); ARGUMENTS ads Additional data structures object DESCRIPTION Recalculate golden_lrc_size, capture_size and regset_size as the number hardware engines may have changed af...
xe_guc_ads_populate_minimal(9)
NAME xe_guc_ads_populate_minimal - populate minimal ADS SYNOPSIS void xe_guc_ads_populate_minimal (struct xe_guc_ads *ads ); ARGUMENTS ads Additional data structures object DESCRIPTION This function populates a minimal ADS that does not support submissions but enough so the GuC can load and the hwconfig tabl...
xe_guc_ads_scheduler_policy_toggle_reset(9)
NAME xe_guc_ads_scheduler_policy_toggle_reset - Toggle reset policy SYNOPSIS int xe_guc_ads_scheduler_policy_toggle_reset (struct xe_guc_ads *ads , bool enable_engine_reset ); ARGUMENTS ads Additional data structures object enable_engine_reset true to enable engine resets, false oth...
xe_guc_buf_cache_dwords(9)
NAME xe_guc_buf_cache_dwords - Number of dwords the GuC Buffer Cache supports. SYNOPSIS u32 xe_guc_buf_cache_dwords (struct xe_guc_buf_cache *cache ); ARGUMENTS cache the xe_guc_buf_cache to query RETURN a size of the largest reusable buffer (in dwords) SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_b...
xe_guc_buf_cache_init(9)
NAME xe_guc_buf_cache_init - Initialize the GuC Buffer Cache. SYNOPSIS int xe_guc_buf_cache_init (struct xe_guc_buf_cache *cache ); ARGUMENTS cache the xe_guc_buf_cache to initialize DESCRIPTION The Buffer Cache allows to obtain a reusable buffer that can be used to pass data to GuC or read data from GuC witho...
xe_guc_buf_cache_init_with_size(9)
NAME xe_guc_buf_cache_init_with_size - Initialize the GuC Buffer Cache. SYNOPSIS int xe_guc_buf_cache_init_with_size (struct xe_guc_buf_cache *cache , u32 size ); ARGUMENTS cache the xe_guc_buf_cache to initialize size size in bytes DESCRIPTION Like xe_guc_buf_cache_init, except it allows the ca...
xe_guc_buf_cpu_ptr(9)
NAME xe_guc_buf_cpu_ptr - Obtain a CPU pointer to the sub-allocation. SYNOPSIS void * xe_guc_buf_cpu_ptr (const struct xe_guc_buf buf ); ARGUMENTS buf the xe_guc_buf to query RETURN a CPU pointer of the sub-allocation. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_buf.c xe_guc_buf_cache_init(9), ...
xe_guc_buf_flush(9)
NAME xe_guc_buf_flush - Copy the data from the sub-allocation to the GPU memory. SYNOPSIS u64 xe_guc_buf_flush (const struct xe_guc_buf buf ); ARGUMENTS buf the xe_guc_buf to flush RETURN a GPU address of the sub-allocation. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_buf.c xe_guc_buf_cache_init(...
xe_guc_buf_from_data(9)
NAME xe_guc_buf_from_data - Reserve a new sub-allocation using data. SYNOPSIS struct xe_guc_buf xe_guc_buf_from_data (struct xe_guc_buf_cache *cache , const void *data , size_t size ); ARGUMENTS cache the xe_guc_buf_cache where reserve sub-allocation data the data to flush the sub-allocation ...
xe_guc_buf_gpu_addr(9)
NAME xe_guc_buf_gpu_addr - Obtain a GPU address of the sub-allocation. SYNOPSIS u64 xe_guc_buf_gpu_addr (const struct xe_guc_buf buf ); ARGUMENTS buf the xe_guc_buf to query RETURN a GPU address of the sub-allocation. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_buf.c xe_guc_buf_cache_init(9), x...
xe_guc_buf_is_valid(9)
NAME xe_guc_buf_is_valid - Check if a buffer reference is valid. SYNOPSIS bool xe_guc_buf_is_valid (const struct xe_guc_buf buf ); ARGUMENTS buf the xe_guc_buf reference to check RETURN true if ref represents a valid sub-allication. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_buf.h April 2026 ...
xe_guc_buf_release(9)
NAME xe_guc_buf_release - Release a sub-allocation. SYNOPSIS void xe_guc_buf_release (const struct xe_guc_buf buf ); ARGUMENTS buf the xe_guc_buf to release DESCRIPTION Releases a sub-allocation reserved by the xe_guc_buf_reserve. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_buf.c xe_guc_buf_cache...
xe_guc_buf_reserve(9)
NAME xe_guc_buf_reserve - Reserve a new sub-allocation. SYNOPSIS struct xe_guc_buf xe_guc_buf_reserve (struct xe_guc_buf_cache *cache , u32 dwords ); ARGUMENTS cache the xe_guc_buf_cache where reserve sub-allocation dwords the requested size of the buffer in dwords DESCRIPTION Use xe_guc_buf_is_va...
xe_guc_buf_sync_read(9)
NAME xe_guc_buf_sync_read - Copy the data from the GPU memory to the sub-allocation. SYNOPSIS void * xe_guc_buf_sync_read (const struct xe_guc_buf buf ); ARGUMENTS buf the xe_guc_buf to sync RETURN a CPU pointer of the sub-allocation. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_buf.c xe_guc_buf_c...
xe_guc_cache_gpu_addr_from_ptr(9)
NAME xe_guc_cache_gpu_addr_from_ptr - Lookup a GPU address using the pointer. SYNOPSIS u64 xe_guc_cache_gpu_addr_from_ptr (struct xe_guc_buf_cache *cache , const void *ptr , u32 size ); ARGUMENTS cache the xe_guc_buf_cache with sub-allocations ptr the CPU pointer of the sub-allocation si...
xe_guc_capture_ads_input_worst_size(9)
NAME xe_guc_capture_ads_input_worst_size - Calculate the worst size for GuC register capture SYNOPSIS size_t xe_guc_capture_ads_input_worst_size (struct xe_guc *guc ); ARGUMENTS guc point to xe_guc structure DESCRIPTION Calculate the worst size for GuC register capture by including all possible engines class...
xe_guc_capture_get_matching_and_lock(9)
NAME xe_guc_capture_get_matching_and_lock - Matching GuC capture for the queue. SYNOPSIS struct __guc_capture_parsed_output * xe_guc_capture_get_matching_and_lock (struct xe_exec_queue *q ); ARGUMENTS q The exec queue object DESCRIPTION Search within the capture outlist for the queue, could be used for che...
xe_guc_capture_getlist(9)
NAME xe_guc_capture_getlist - Get register capture list for owner/type/class combination SYNOPSIS int xe_guc_capture_getlist (struct xe_guc *guc , u32 owner , u32 type , enum guc_capture_list_class_type capture_class , void **outptr ); ARGUMENTS guc The GuC object owner PF/VF owner type ...
xe_guc_capture_getlistsize(9)
NAME xe_guc_capture_getlistsize - Get list size for owner/type/class combination SYNOPSIS int xe_guc_capture_getlistsize (struct xe_guc *guc , u32 owner , u32 type , enum guc_capture_list_class_type capture_class , size_t *size ); ARGUMENTS guc The GuC object owner PF/VF owner type ...
xe_guc_capture_getnullheader(9)
NAME xe_guc_capture_getnullheader - Get a null list for register capture SYNOPSIS int xe_guc_capture_getnullheader (struct xe_guc *guc , void **outptr , size_t *size ); ARGUMENTS guc The GuC object outptr Point to cached register capture list size Point to the size DESCRIPTION Thi...
xe_guc_check_log_buf_overflow(9)
NAME xe_guc_check_log_buf_overflow - Check if log buffer overflowed SYNOPSIS bool xe_guc_check_log_buf_overflow (struct xe_guc_log *log , enum guc_log_type type , unsigned int full_cnt ); ARGUMENTS log The log object. type The log buffer type full_cnt The count of buffer full DESCRI...
xe_guc_comm_init_early(9)
NAME xe_guc_comm_init_early - early initialization of GuC communication SYNOPSIS void xe_guc_comm_init_early (struct xe_guc *guc ); ARGUMENTS guc the xe_guc to initialize DESCRIPTION Must be called prior to first MMIO communication with GuC firmware. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc.c xe_...
xe_guc_contexts_hwsp_rebase(9)
NAME xe_guc_contexts_hwsp_rebase - Re-compute GGTT references within all exec queues registered to given GuC. SYNOPSIS int xe_guc_contexts_hwsp_rebase (struct xe_guc *guc , void *scratch ); ARGUMENTS guc the xe_guc struct instance scratch scratch buffer to be used as temporary storage RETURN zero...
xe_guc_ct_disable(9)
NAME xe_guc_ct_disable - Set GuC to disabled state SYNOPSIS void xe_guc_ct_disable (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct DESCRIPTION Set GuC CT to disabled state and stop g2h handler. No outstanding g2h expected in this transition. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_ct.c Kernel ...
xe_guc_ct_enable(9)
NAME xe_guc_ct_enable - Enable GuC CT SYNOPSIS int xe_guc_ct_enable (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct DESCRIPTION Enable GuC CT to an empty state and issue a CT register MMIO command. RETURN 0 on success, or a negative errno on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gu...
xe_guc_ct_fast_path(9)
NAME xe_guc_ct_fast_path - process critical G2H in the IRQ handler SYNOPSIS void xe_guc_ct_fast_path (struct xe_guc_ct *ct ); ARGUMENTS ct GuC CT object DESCRIPTION Anything related to page faults is critical for performance, process these critical G2H in the IRQ. This is safe as these handlers either just ...
xe_guc_ct_flush_and_stop(9)
NAME xe_guc_ct_flush_and_stop - Flush and stop all processing of G2H / H2G SYNOPSIS void xe_guc_ct_flush_and_stop (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_ct.c Kernel API(9), xe_guc_ct_queue_proc_time_jiffies(9), xe_guc_ct_init_post_hwconfig(...
xe_guc_ct_init_post_hwconfig(9)
NAME xe_guc_ct_init_post_hwconfig - Reinitialize the GuC CTB in VRAM SYNOPSIS int xe_guc_ct_init_post_hwconfig (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct DESCRIPTION Allocate a new BO in VRAM and free the previous BO that was allocated in system memory (SMEM). Applicable only for DGFX products. RE...
xe_guc_ct_print(9)
NAME xe_guc_ct_print - GuC CT Print. SYNOPSIS void xe_guc_ct_print (struct xe_guc_ct *ct , struct drm_printer *p , bool want_ctb ); ARGUMENTS ct GuC CT. p drm_printer where it will be printed out. want_ctb Should the full CTB content be dumped (vs just the headers) DESCRIPTION T...
xe_guc_ct_queue_proc_time_jiffies(9)
NAME xe_guc_ct_queue_proc_time_jiffies - Return maximum time to process a full CT command queue SYNOPSIS long xe_guc_ct_queue_proc_time_jiffies (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct. Unused at this moment but will be used in the future. DESCRIPTION Observation is that a 4KiB buffer full of com...
xe_guc_ct_restart(9)
NAME xe_guc_ct_restart - Restart GuC CT SYNOPSIS int xe_guc_ct_restart (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct DESCRIPTION Restart GuC CT to an empty state without issuing a CT register MMIO command. RETURN 0 on success, or a negative errno on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe...
xe_guc_ct_runtime_resume(9)
NAME xe_guc_ct_runtime_resume - GuC CT runtime resume SYNOPSIS void xe_guc_ct_runtime_resume (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct DESCRIPTION Restart GuC CT and set it to enabled state. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_ct.c Kernel API(9), xe_guc_ct_queue_proc_t...
xe_guc_ct_runtime_suspend(9)
NAME xe_guc_ct_runtime_suspend - GuC CT runtime suspend SYNOPSIS void xe_guc_ct_runtime_suspend (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct DESCRIPTION Set GuC CT to disabled state. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_ct.c Kernel API(9), xe_guc_ct_queue_proc_time_jiffies...
xe_guc_ct_send_recv(9)
NAME xe_guc_ct_send_recv - Send and receive HXG to the GuC SYNOPSIS int xe_guc_ct_send_recv (struct xe_guc_ct *ct , const u32 *action , u32 len , u32 *response_buffer ); ARGUMENTS ct the xe_guc_ct action the dword array with `HXG Request`_ message (can't be NULL) len length of th...
xe_guc_ct_snapshot_capture(9)
NAME xe_guc_ct_snapshot_capture - Take a quick snapshot of the CT state. SYNOPSIS struct xe_guc_ct_snapshot * xe_guc_ct_snapshot_capture (struct xe_guc_ct *ct ); ARGUMENTS ct GuC CT object. DESCRIPTION This can be printed out in a later stage like during dev_coredump analysis. This is safe to be called duri...
xe_guc_ct_snapshot_free(9)
NAME xe_guc_ct_snapshot_free - Free all allocated objects for a given snapshot. SYNOPSIS void xe_guc_ct_snapshot_free (struct xe_guc_ct_snapshot *snapshot ); ARGUMENTS snapshot GuC CT snapshot object. DESCRIPTION This function free all the memory that needed to be allocated at capture time. SEE ALSO Kernel fi...
xe_guc_ct_snapshot_print(9)
NAME xe_guc_ct_snapshot_print - Print out a given GuC CT snapshot. SYNOPSIS void xe_guc_ct_snapshot_print (struct xe_guc_ct_snapshot *snapshot , struct drm_printer *p ); ARGUMENTS snapshot GuC CT snapshot object. p drm_printer where it will be printed out. DESCRIPTION This function prints out a ...
xe_guc_ct_stop(9)
NAME xe_guc_ct_stop - Set GuC to stopped state SYNOPSIS void xe_guc_ct_stop (struct xe_guc_ct *ct ); ARGUMENTS ct the xe_guc_ct DESCRIPTION Set GuC CT to stopped state, stop g2h handler, and clear any outstanding g2h SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_ct.c Kernel API(9), xe_guc...
xe_guc_ct_wake_waiters(9)
NAME xe_guc_ct_wake_waiters - GuC CT wake up waiters SYNOPSIS void xe_guc_ct_wake_waiters (struct xe_guc_ct *ct ); ARGUMENTS ct GuC CT object SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_ct.h April 2026 xe_guc_c...
xe_guc_db_mgr_init(9)
NAME xe_guc_db_mgr_init - Initialize GuC Doorbells Manager. SYNOPSIS int xe_guc_db_mgr_init (struct xe_guc_db_mgr *dbm , unsigned int count ); ARGUMENTS dbm the xe_guc_db_mgr to initialize count number of doorbells to manage DESCRIPTION The bare-metal or PF driver can pass ~0 as count to indica...
xe_guc_db_mgr_print(9)
NAME xe_guc_db_mgr_print - Print status of GuC Doorbells Manager. SYNOPSIS void xe_guc_db_mgr_print (struct xe_guc_db_mgr *dbm , struct drm_printer *p , int indent ); ARGUMENTS dbm the xe_guc_db_mgr to print p the drm_printer to print to indent tab indentation level SEE ALSO Ke...
xe_guc_db_mgr_release_id_locked(9)
NAME xe_guc_db_mgr_release_id_locked - Release a single GuC Doorbell ID. SYNOPSIS void xe_guc_db_mgr_release_id_locked (struct xe_guc_db_mgr *dbm , unsigned int id ); ARGUMENTS dbm the xe_guc_db_mgr id the GuC Doorbell ID to release DESCRIPTION This function expects that submission lock is a...
xe_guc_db_mgr_release_range(9)
NAME xe_guc_db_mgr_release_range - Release a range of Doorbell IDs. SYNOPSIS void xe_guc_db_mgr_release_range (struct xe_guc_db_mgr *dbm , unsigned int start , unsigned int count ); ARGUMENTS dbm the xe_guc_db_mgr start the starting ID of GuC doorbell ID range to release count numb...
xe_guc_db_mgr_reserve_id_locked(9)
NAME xe_guc_db_mgr_reserve_id_locked - Reserve a single GuC Doorbell ID. SYNOPSIS int xe_guc_db_mgr_reserve_id_locked (struct xe_guc_db_mgr *dbm ); ARGUMENTS dbm the xe_guc_db_mgr DESCRIPTION This function expects that submission lock is already taken. RETURN ID of the allocated GuC doorbell or a negative e...
xe_guc_db_mgr_reserve_range(9)
NAME xe_guc_db_mgr_reserve_range - Reserve a range of GuC Doorbell IDs. SYNOPSIS int xe_guc_db_mgr_reserve_range (struct xe_guc_db_mgr *dbm , unsigned int count , unsigned int spare ); ARGUMENTS dbm the xe_guc_db_mgr count number of GuC doorbell IDs to reserve spare number of GuC d...
xe_guc_declare_wedged(9)
NAME xe_guc_declare_wedged - Declare GuC wedged SYNOPSIS void xe_guc_declare_wedged (struct xe_guc *guc ); ARGUMENTS guc the GuC object DESCRIPTION Wedge the GuC which stops all submission, saves desired debug state, and cleans up anything which could timeout. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_...
xe_guc_engine_activity_active_ticks(9)
NAME xe_guc_engine_activity_active_ticks - Get engine active ticks SYNOPSIS u64 xe_guc_engine_activity_active_ticks (struct xe_guc *guc , struct xe_hw_engine *hwe , unsigned int fn_id ); ARGUMENTS guc The GuC object hwe The hw_engine object fn_id function id to report on RETURN ...
xe_guc_engine_activity_enable_stats(9)
NAME xe_guc_engine_activity_enable_stats - Enable engine activity stats SYNOPSIS void xe_guc_engine_activity_enable_stats (struct xe_guc *guc ); ARGUMENTS guc The GuC object DESCRIPTION Enable engine activity stats and set initial timestamps SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_engine_activity...
xe_guc_engine_activity_function_stats(9)
NAME xe_guc_engine_activity_function_stats - Enable/Disable per-function engine activity stats SYNOPSIS int xe_guc_engine_activity_function_stats (struct xe_guc *guc , int num_vfs , bool enable ); ARGUMENTS guc The GuC object num_vfs number of vfs enable true to enable, false otherwis...
xe_guc_engine_activity_init(9)
NAME xe_guc_engine_activity_init - Initialize the engine activity data SYNOPSIS int xe_guc_engine_activity_init (struct xe_guc *guc ); ARGUMENTS guc The GuC object RETURN 0 on success, negative error code otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_guc_engine_activity.c xe_guc_engine_activity...
xe_guc_engine_activity_supported(9)
NAME xe_guc_engine_activity_supported - Check support for engine activity stats SYNOPSIS bool xe_guc_engine_activity_supported (struct xe_guc *guc ); ARGUMENTS guc The GuC object DESCRIPTION Engine activity stats is supported from GuC interface version (1.14.1) RETURN true if engine activity stats supported...
xe_guc_engine_activity_total_ticks(9)
NAME xe_guc_engine_activity_total_ticks - Get engine total ticks SYNOPSIS u64 xe_guc_engine_activity_total_ticks (struct xe_guc *guc , struct xe_hw_engine *hwe , unsigned int fn_id ); ARGUMENTS guc The GuC object hwe The hw_engine object fn_id function id to report on RETURN acc...