id
stringlengths
4
63
text
stringlengths
153
8.81M
xe_exec_queue_idle_skip_suspend(9)
NAME xe_exec_queue_idle_skip_suspend - Can exec queue skip suspend SYNOPSIS bool xe_exec_queue_idle_skip_suspend (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue DESCRIPTION If an exec queue is not parallel and is idle, the suspend steps can be skipped in the submission backend immediatley signaling ...
xe_exec_queue_is_idle(9)
NAME xe_exec_queue_is_idle - Whether an exec_queue is idle. SYNOPSIS bool xe_exec_queue_is_idle (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue DESCRIPTION FIXME: Need to determine what to use as the short-lived timeline lock for the exec_queues, so that the return value of this function becomes mo...
xe_exec_queue_is_lr(9)
NAME xe_exec_queue_is_lr - Whether an exec_queue is long-running SYNOPSIS bool xe_exec_queue_is_lr (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue RETURN True if the exec_queue is long-running, false otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_exec_queue.c Kernel API(9), Kerne...
xe_exec_queue_is_multi_queue(9)
NAME xe_exec_queue_is_multi_queue - Whether an exec_queue is part of a queue group. SYNOPSIS bool xe_exec_queue_is_multi_queue (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue RETURN True if the exec_queue is part of a queue group, false otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_exec_q...
xe_exec_queue_is_multi_queue_primary(9)
NAME xe_exec_queue_is_multi_queue_primary - Whether an exec_queue is primary queue of a multi queue group. SYNOPSIS bool xe_exec_queue_is_multi_queue_primary (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue RETURN True if q is primary queue of a queue group, false otherwise. SEE ALSO Kernel file ./d...
xe_exec_queue_is_multi_queue_secondary(9)
NAME xe_exec_queue_is_multi_queue_secondary - Whether an exec_queue is secondary queue of a multi queue group. SYNOPSIS bool xe_exec_queue_is_multi_queue_secondary (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue RETURN True if q is secondary queue of a queue group, false otherwise. SEE ALSO Kernel ...
xe_exec_queue_kill(9)
NAME xe_exec_queue_kill - permanently stop all execution from an exec queue SYNOPSIS void xe_exec_queue_kill (struct xe_exec_queue *q ); ARGUMENTS q The exec queue DESCRIPTION This function permanently stops all activity on an exec queue. If the queue is actively executing on the HW, it will be kicked off...
xe_exec_queue_last_fence_get(9)
NAME xe_exec_queue_last_fence_get - Get last fence SYNOPSIS struct dma_fence * xe_exec_queue_last_fence_get (struct xe_exec_queue *q , struct xe_vm *vm ); ARGUMENTS q The exec queue vm The VM the engine does a bind or exec for DESCRIPTION Get last fence, takes a ref RETURN last fence if n...
xe_exec_queue_last_fence_get_for_resume(9)
NAME xe_exec_queue_last_fence_get_for_resume - Get last fence SYNOPSIS struct dma_fence * xe_exec_queue_last_fence_get_for_resume (struct xe_exec_queue *q , struct xe_vm *vm ); ARGUMENTS q The exec queue vm The VM the engine does a bind or exec for DESCRIPTION Get last fence, takes a ref. ...
xe_exec_queue_last_fence_put(9)
NAME xe_exec_queue_last_fence_put - Drop ref to last fence SYNOPSIS void xe_exec_queue_last_fence_put (struct xe_exec_queue *q , struct xe_vm *vm ); ARGUMENTS q The exec queue vm The VM the engine does a bind or exec for SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_exec_queue.c Kernel ...
xe_exec_queue_last_fence_put_unlocked(9)
NAME xe_exec_queue_last_fence_put_unlocked - Drop ref to last fence unlocked SYNOPSIS void xe_exec_queue_last_fence_put_unlocked (struct xe_exec_queue *q ); ARGUMENTS q The exec queue DESCRIPTION Only safe to be called from xe_exec_queue_destroy. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_exec_queue.c...
xe_exec_queue_last_fence_set(9)
NAME xe_exec_queue_last_fence_set - Set last fence SYNOPSIS void xe_exec_queue_last_fence_set (struct xe_exec_queue *q , struct xe_vm *vm , struct dma_fence *fence ); ARGUMENTS q The exec queue vm The VM the engine does a bind or exec for fence The fence DESCRIPTION Set the l...
xe_exec_queue_lrc(9)
NAME xe_exec_queue_lrc - Get the LRC from exec queue. SYNOPSIS struct xe_lrc * xe_exec_queue_lrc (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue. DESCRIPTION Retrieves the primary LRC for the exec queue. Note that this function returns only the first LRC instance, even when multiple parallel LRCs ar...
xe_exec_queue_multi_queue_primary(9)
NAME xe_exec_queue_multi_queue_primary - Get multi queue group's primary queue SYNOPSIS struct xe_exec_queue * xe_exec_queue_multi_queue_primary (struct xe_exec_queue *q ); ARGUMENTS q The exec_queue DESCRIPTION If q belongs to a multi queue group, then the primary queue of the group will be returned. Othe...
xe_exec_queue_tlb_inval_last_fence_get(9)
NAME xe_exec_queue_tlb_inval_last_fence_get - Get last fence for TLB invalidation SYNOPSIS struct dma_fence * xe_exec_queue_tlb_inval_last_fence_get (struct xe_exec_queue *q , struct xe_vm *vm , unsigned int type ); ARGUMENTS q The exec queue vm The VM the engine does a bind for typ...
xe_exec_queue_tlb_inval_last_fence_put(9)
NAME xe_exec_queue_tlb_inval_last_fence_put - Drop ref to last TLB invalidation fence SYNOPSIS void xe_exec_queue_tlb_inval_last_fence_put (struct xe_exec_queue *q , struct xe_vm *vm , unsigned int type ); ARGUMENTS q The exec queue vm The VM the engine does a bind for type E...
xe_exec_queue_tlb_inval_last_fence_put_unlocked(9)
NAME xe_exec_queue_tlb_inval_last_fence_put_unlocked - Drop ref to last TLB invalidation fence unlocked SYNOPSIS void xe_exec_queue_tlb_inval_last_fence_put_unlocked (struct xe_exec_queue *q , unsigned int type ); ARGUMENTS q The exec queue type Either primary or media GT DESCRIPTION Only sa...
xe_exec_queue_tlb_inval_last_fence_set(9)
NAME xe_exec_queue_tlb_inval_last_fence_set - Set last fence for TLB invalidation SYNOPSIS void xe_exec_queue_tlb_inval_last_fence_set (struct xe_exec_queue *q , struct xe_vm *vm , struct dma_fence *fence , unsigned int type ); ARGUMENTS q The exec queue vm The VM the engine does a bind for...
xe_exec_queue_update_run_ticks(9)
NAME xe_exec_queue_update_run_ticks - Update run time in ticks for this exec queue from hw SYNOPSIS void xe_exec_queue_update_run_ticks (struct xe_exec_queue *q ); ARGUMENTS q The exec queue DESCRIPTION Update the timestamp saved by HW for this exec queue and save run ticks calculated by using the delta fr...
xe_file_get(9)
NAME xe_file_get - Take a reference to the xe file object SYNOPSIS struct xe_file * xe_file_get (struct xe_file *xef ); ARGUMENTS xef Pointer to the xe file DESCRIPTION Anyone with a pointer to xef must take a reference to the xe file object using this call. RETURN xe file pointer SEE ALSO Kernel file ...
xe_file_put(9)
NAME xe_file_put - Drop a reference to the xe file object SYNOPSIS void xe_file_put (struct xe_file *xef ); ARGUMENTS xef Pointer to the xe file DESCRIPTION Used to drop reference to the xef object SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_device.c xe_file_get(9), xe_is_xe_file(9), xe_device_pr...
xe_force_wake_assert_held(9)
NAME xe_force_wake_assert_held - asserts domain is awake SYNOPSIS void xe_force_wake_assert_held (struct xe_force_wake *fw , enum xe_force_wake_domains domain ); ARGUMENTS fw xe_force_wake structure domain xe_force_wake_domains apart from XE_FORCEWAKE_ALL DESCRIPTION xe_force_wake_assert_held i...
xe_force_wake_get(9)
NAME xe_force_wake_get - Increase the domain refcount SYNOPSIS unsigned int xe_force_wake_get (struct xe_force_wake *fw , enum xe_force_wake_domains domains ); ARGUMENTS fw struct xe_force_wake domains forcewake domains to get refcount on DESCRIPTION This function wakes up domains if they are ...
xe_force_wake_put(9)
NAME xe_force_wake_put - Decrement the refcount and put domain to sleep if refcount becomes 0 SYNOPSIS void xe_force_wake_put (struct xe_force_wake *fw , unsigned int fw_ref ); ARGUMENTS fw Pointer to the force wake structure fw_ref return of xe_force_wake_get DESCRIPTION This function reduces ...
xe_force_wake_ref_has_domain(9)
NAME xe_force_wake_ref_has_domain - verifies if the domains are in fw_ref SYNOPSIS bool xe_force_wake_ref_has_domain (unsigned int fw_ref , enum xe_force_wake_domains domain ); ARGUMENTS fw_ref the force_wake reference domain forcewake domain to verify DESCRIPTION This function confirms whether the...
xe_ggtt_alloc(9)
NAME xe_ggtt_alloc - Allocate a GGTT for a given &xe_tile SYNOPSIS struct xe_ggtt * xe_ggtt_alloc (struct xe_tile *tile ); ARGUMENTS tile xe_tile DESCRIPTION Allocates a xe_ggtt for a given tile. RETURN xe_ggtt on success, or NULL when out of memory. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Ker...
xe_ggtt_assign(9)
NAME xe_ggtt_assign - assign a GGTT region to the VF SYNOPSIS void xe_ggtt_assign (const struct xe_ggtt_node *node , u16 vfid ); ARGUMENTS node the xe_ggtt_node to update vfid the VF identifier DESCRIPTION This function is used by the PF driver to assign a GGTT region to the VF. In addition to...
xe_ggtt_dump(9)
NAME xe_ggtt_dump - Dump GGTT for debug SYNOPSIS int xe_ggtt_dump (struct xe_ggtt *ggtt , struct drm_printer *p ); ARGUMENTS ggtt the xe_ggtt to be dumped p the drm_mm_printer helper handle to be used to dump the information RETURN 0 on success or a negative error code on failure. SEE ALSO ...
xe_ggtt_encode_pte_flags(9)
NAME xe_ggtt_encode_pte_flags - Get PTE encoding flags for BO SYNOPSIS u64 xe_ggtt_encode_pte_flags (struct xe_ggtt *ggtt , struct xe_bo *bo , u16 pat_index ); ARGUMENTS ggtt xe_ggtt bo xe_bo pat_index The pat_index for the PTE. DESCRIPTION This function returns the pte_flags for a ...
xe_ggtt_init(9)
NAME xe_ggtt_init - Regular non-early GGTT initialization SYNOPSIS int xe_ggtt_init (struct xe_ggtt *ggtt ); ARGUMENTS ggtt the xe_ggtt to be initialized RETURN 0 on success or a negative error code on failure. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel API(9), struct xe_ggtt_node(9), xe_ggt...
xe_ggtt_init_early(9)
NAME xe_ggtt_init_early - Early GGTT initialization SYNOPSIS int xe_ggtt_init_early (struct xe_ggtt *ggtt ); ARGUMENTS ggtt the xe_ggtt to be initialized DESCRIPTION It allows to create new mappings usable by the GuC. Mappings are not usable by the HW engines, as it doesn't have scratch nor initial clear don...
xe_ggtt_insert_bo(9)
NAME xe_ggtt_insert_bo - Insert BO into GGTT SYNOPSIS int xe_ggtt_insert_bo (struct xe_ggtt *ggtt , struct xe_bo *bo , struct drm_exec *exec ); ARGUMENTS ggtt the xe_ggtt where bo will be inserted bo the xe_bo to be inserted exec The drm_exec transaction to use for exhaustive ev...
xe_ggtt_insert_bo_at(9)
NAME xe_ggtt_insert_bo_at - Insert BO at a specific GGTT space SYNOPSIS int xe_ggtt_insert_bo_at (struct xe_ggtt *ggtt , struct xe_bo *bo , u64 start , u64 end , struct drm_exec *exec ); ARGUMENTS ggtt the xe_ggtt where bo will be inserted bo the xe_bo to be inserted start addres...
xe_ggtt_largest_hole(9)
NAME xe_ggtt_largest_hole - Largest GGTT hole SYNOPSIS u64 xe_ggtt_largest_hole (struct xe_ggtt *ggtt , u64 alignment , u64 *spare ); ARGUMENTS ggtt the xe_ggtt that will be inspected alignment minimum alignment spare If not NULL: in: desired memory size to be spared / out: Adjusted pos...
xe_ggtt_map_bo(9)
NAME xe_ggtt_map_bo - Map the BO into GGTT SYNOPSIS void xe_ggtt_map_bo (struct xe_ggtt *ggtt , struct xe_ggtt_node *node , struct xe_bo *bo , u64 pte ); ARGUMENTS ggtt the xe_ggtt where node will be mapped node the xe_ggtt_node where this BO is mapped bo the xe_bo to be mapped ...
xe_ggtt_map_bo_unlocked(9)
NAME xe_ggtt_map_bo_unlocked - Restore a mapping of a BO into GGTT SYNOPSIS void xe_ggtt_map_bo_unlocked (struct xe_ggtt *ggtt , struct xe_bo *bo ); ARGUMENTS ggtt the xe_ggtt where node will be mapped bo the xe_bo to be mapped DESCRIPTION This is used to restore a GGTT mapping after suspend....
xe_ggtt_node_addr(9)
NAME xe_ggtt_node_addr - Get @node offset in GGTT. SYNOPSIS u64 xe_ggtt_node_addr (const struct xe_ggtt_node *node ); ARGUMENTS node xe_ggtt_node DESCRIPTION Get the GGTT offset for allocated node. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel API(9), struct xe_ggtt_node(9), xe_ggtt_start(...
xe_ggtt_node_allocated(9)
NAME xe_ggtt_node_allocated - Check if node is allocated in GGTT SYNOPSIS bool xe_ggtt_node_allocated (const struct xe_ggtt_node *node ); ARGUMENTS node the xe_ggtt_node to be inspected RETURN True if allocated, False otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel API(9), struct ...
xe_ggtt_node_fini(9)
NAME xe_ggtt_node_fini - Forcebly finalize %xe_ggtt_node struct SYNOPSIS void xe_ggtt_node_fini (struct xe_ggtt_node *node ); ARGUMENTS node the xe_ggtt_node to be freed DESCRIPTION If anything went wrong with either xe_ggtt_node_insert, xe_ggtt_node_insert_locked, or xe_ggtt_node_insert_balloon_locked...
xe_ggtt_node_init(9)
NAME xe_ggtt_node_init - Initialize %xe_ggtt_node struct SYNOPSIS struct xe_ggtt_node * xe_ggtt_node_init (struct xe_ggtt *ggtt ); ARGUMENTS ggtt the xe_ggtt where the new node will later be inserted/reserved. DESCRIPTION This function will allocate the struct xe_ggtt_node and return its pointer. This ...
xe_ggtt_node_insert(9)
NAME xe_ggtt_node_insert - Insert a &xe_ggtt_node into the GGTT SYNOPSIS int xe_ggtt_node_insert (struct xe_ggtt_node *node , u32 size , u32 align ); ARGUMENTS node the xe_ggtt_node to be inserted size size of the node align alignment constrain of the node DESCRIPTION It cannot be...
xe_ggtt_node_insert_balloon_locked(9)
NAME xe_ggtt_node_insert_balloon_locked - prevent allocation of specified GGTT addresses SYNOPSIS int xe_ggtt_node_insert_balloon_locked (struct xe_ggtt_node *node , u64 start , u64 end ); ARGUMENTS node the xe_ggtt_node to hold reserved GGTT node start the starting GGTT address of the reserved r...
xe_ggtt_node_insert_transform(9)
NAME xe_ggtt_node_insert_transform - Insert a newly allocated &xe_ggtt_node into the GGTT SYNOPSIS struct xe_ggtt_node * xe_ggtt_node_insert_transform (struct xe_ggtt *ggtt , struct xe_bo *bo , u64 pte_flags , u64 size , u32 align , xe_ggtt_transform_cb transform , void *arg ); ARGUMENTS ggtt the xe_ggtt where...
xe_ggtt_node_load(9)
NAME xe_ggtt_node_load - Load a &xe_ggtt_node from a buffer. SYNOPSIS int xe_ggtt_node_load (struct xe_ggtt_node *node , const void *src , size_t size , u16 vfid ); ARGUMENTS node the xe_ggtt_node to be loaded src source buffer size source buffer size in bytes vfid ...
xe_ggtt_node_pt_size(9)
NAME xe_ggtt_node_pt_size - Get the size of page table entries needed to map a GGTT node. SYNOPSIS size_t xe_ggtt_node_pt_size (const struct xe_ggtt_node *node ); ARGUMENTS node the xe_ggtt_node RETURN GGTT node page table entries size in bytes. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel ...
xe_ggtt_node_remove(9)
NAME xe_ggtt_node_remove - Remove a &xe_ggtt_node from the GGTT SYNOPSIS void xe_ggtt_node_remove (struct xe_ggtt_node *node , bool invalidate ); ARGUMENTS node the xe_ggtt_node to be removed invalidate if node needs invalidation upon removal SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Ker...
xe_ggtt_node_remove_balloon_locked(9)
NAME xe_ggtt_node_remove_balloon_locked - release a reserved GGTT region SYNOPSIS void xe_ggtt_node_remove_balloon_locked (struct xe_ggtt_node *node ); ARGUMENTS node the xe_ggtt_node with reserved GGTT region DESCRIPTION To be used in cases where ggtt->lock is already taken. See xe_ggtt_node_insert_balloon_...
xe_ggtt_node_save(9)
NAME xe_ggtt_node_save - Save a &xe_ggtt_node to a buffer. SYNOPSIS int xe_ggtt_node_save (struct xe_ggtt_node *node , void *dst , size_t size , u16 vfid ); ARGUMENTS node the xe_ggtt_node to be saved dst destination buffer size destination buffer size in bytes vfid ...
xe_ggtt_node_size(9)
NAME xe_ggtt_node_size - Get @node allocation size. SYNOPSIS u64 xe_ggtt_node_size (const struct xe_ggtt_node *node ); ARGUMENTS node xe_ggtt_node DESCRIPTION Get the allocated node's size. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel API(9), struct xe_ggtt_node(9), xe_ggtt_start(9), xe_g...
xe_ggtt_print_holes(9)
NAME xe_ggtt_print_holes - Print holes SYNOPSIS u64 xe_ggtt_print_holes (struct xe_ggtt *ggtt , u64 alignment , struct drm_printer *p ); ARGUMENTS ggtt the xe_ggtt to be inspected alignment min alignment p the drm_printer DESCRIPTION Print GGTT ranges that are available and return ...
xe_ggtt_read_pte(9)
NAME xe_ggtt_read_pte - Read a PTE from the GGTT SYNOPSIS u64 xe_ggtt_read_pte (struct xe_ggtt *ggtt , u64 offset ); ARGUMENTS ggtt xe_ggtt offset the offset for which the mapping should be read. DESCRIPTION Used by testcases, and by display reading out an inherited bios FB. SEE ALSO Kernel fil...
xe_ggtt_remove_bo(9)
NAME xe_ggtt_remove_bo - Remove a BO from the GGTT SYNOPSIS void xe_ggtt_remove_bo (struct xe_ggtt *ggtt , struct xe_bo *bo ); ARGUMENTS ggtt the xe_ggtt where node will be removed bo the xe_bo to be removed SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel API(9), struct xe_gg...
xe_ggtt_shift_nodes_locked(9)
NAME xe_ggtt_shift_nodes_locked - Shift GGTT nodes to adjust for a change in usable address range. SYNOPSIS void xe_ggtt_shift_nodes_locked (struct xe_ggtt *ggtt , s64 shift ); ARGUMENTS ggtt the xe_ggtt struct instance shift change to the location of area provisioned for current VF DESCRIPTION ...
xe_ggtt_size(9)
NAME xe_ggtt_size - Get size of GGTT. SYNOPSIS u64 xe_ggtt_size (struct xe_ggtt *ggtt ); ARGUMENTS ggtt xe_ggtt RETURN Total usable size of this xe_ggtt. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel API(9), struct xe_ggtt_node(9), xe_ggtt_start(9), xe_ggtt_alloc(9), xe_ggtt_init_early(9), xe_g...
xe_ggtt_start(9)
NAME xe_ggtt_start - Get starting offset of GGTT. SYNOPSIS u64 xe_ggtt_start (struct xe_ggtt *ggtt ); ARGUMENTS ggtt xe_ggtt RETURN Starting offset for this xe_ggtt. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_ggtt.c Kernel API(9), struct xe_ggtt_node(9), xe_ggtt_size(9), xe_ggtt_alloc(9), xe_ggtt_init_ea...
xe_gsc_check_and_update_pending(9)
NAME xe_gsc_check_and_update_pending - check the pending bit and update the input header with the retry handle from the output header SYNOPSIS bool xe_gsc_check_and_update_pending (struct xe_device *xe , struct iosys_map *in , u32 offset_in , struct iosys_map *out , u32 offset_out ); ARGUMENTS xe the Xe devi...
xe_gsc_create_host_session_id(9)
NAME xe_gsc_create_host_session_id - Creates a random 64 bit host_session id with bits 56-63 masked. SYNOPSIS u64 xe_gsc_create_host_session_id (void ); ARGUMENTS void no arguments RETURN random host_session_id which can be used to send messages to gsc cs SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gsc_subm...
xe_gsc_emit_header(9)
NAME xe_gsc_emit_header - write the MTL GSC header in memory SYNOPSIS u32 xe_gsc_emit_header (struct xe_device *xe , struct iosys_map *map , u32 offset , u8 heci_client_id , u64 host_session_id , u32 payload_size ); ARGUMENTS xe the Xe device map the iosys map to write to offset ...
xe_gsc_pkt_submit_kernel(9)
NAME xe_gsc_pkt_submit_kernel - submit a kernel heci pkt to the GSC SYNOPSIS int xe_gsc_pkt_submit_kernel (struct xe_gsc *gsc , u64 addr_in , u32 size_in , u64 addr_out , u32 size_out ); ARGUMENTS gsc the GSC uC addr_in GGTT address of the message to send to the GSC size_in size of the...
xe_gsc_poison_header(9)
NAME xe_gsc_poison_header - poison the MTL GSC header in memory SYNOPSIS void xe_gsc_poison_header (struct xe_device *xe , struct iosys_map *map , u32 offset ); ARGUMENTS xe the Xe device map the iosys map to write to offset offset from the start of the map at which the header re...
xe_gsc_print_info(9)
NAME xe_gsc_print_info - print info about GSC FW status SYNOPSIS void xe_gsc_print_info (struct xe_gsc *gsc , struct drm_printer *p ); ARGUMENTS gsc the GSC structure p the printer to be used to print the info SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gsc.c April 2026 ...
xe_gsc_proxy_init(9)
NAME xe_gsc_proxy_init - init objects and MEI component required by GSC proxy SYNOPSIS int xe_gsc_proxy_init (struct xe_gsc *gsc ); ARGUMENTS gsc the GSC uC RETURN 0 if the initialization was successful, a negative errno otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gsc_proxy.c xe_gsc_proxy_start(...
xe_gsc_proxy_start(9)
NAME xe_gsc_proxy_start - start the proxy by submitting the first request SYNOPSIS int xe_gsc_proxy_start (struct xe_gsc *gsc ); ARGUMENTS gsc the GSC uC RETURN 0 if the proxy are now enabled, a negative errno otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gsc_proxy.c xe_gsc_proxy_init(9) April 20...
xe_gsc_read_out_header(9)
NAME xe_gsc_read_out_header - reads and validates the output header and returns the offset of the reply following the header SYNOPSIS int xe_gsc_read_out_header (struct xe_device *xe , struct iosys_map *map , u32 offset , u32 min_payload_size , u32 *payload_offset ); ARGUMENTS xe the Xe device map ...
xe_gt_any_hw_engine(9)
NAME xe_gt_any_hw_engine - scan the list of engines and return the first available SYNOPSIS struct xe_hw_engine * xe_gt_any_hw_engine (struct xe_gt *gt ); ARGUMENTS gt GT structure SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt.h xe_gt_record_user_engines(9), xe_gt_wait_for_reset(9), xe_gt_reset(9), xe_gt_...
xe_gt_any_hw_engine_by_reset_domain(9)
NAME xe_gt_any_hw_engine_by_reset_domain - scan the list of engines and return the first that matches the same reset domain as @class SYNOPSIS struct xe_hw_engine * xe_gt_any_hw_engine_by_reset_domain (struct xe_gt *gt , enum xe_engine_class class ); ARGUMENTS gt GT structure class hw engine cl...
xe_gt_assert(9)
NAME xe_gt_assert - warn if condition is false when debugging. SYNOPSIS xe_gt_assert (gt , condition ); ARGUMENTS gt the struct xe_gt pointer to which condition applies condition condition to check DESCRIPTION xe_gt_assert uses drm_WARN to emit a warning and print additional information that coul...
xe_gt_ccs_mode_sysfs_init(9)
NAME xe_gt_ccs_mode_sysfs_init - Initialize CCS mode sysfs interfaces SYNOPSIS int xe_gt_ccs_mode_sysfs_init (struct xe_gt *gt ); ARGUMENTS gt GT structure DESCRIPTION Through a per-gt 'ccs_mode' sysfs interface, the user can enable a fixed number of compute hardware engines to which the available compute s...
xe_gt_clock_interval_to_ms(9)
NAME xe_gt_clock_interval_to_ms - Convert sampled GT clock ticks to msec SYNOPSIS u64 xe_gt_clock_interval_to_ms (struct xe_gt *gt , u64 count ); ARGUMENTS gt the xe_gt count count of GT clock ticks RETURN time in msec SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_clock.c April 2026 ...
xe_gt_dbg_printer(9)
NAME xe_gt_dbg_printer - Construct a &drm_printer that outputs like xe_gt_dbg() SYNOPSIS struct drm_printer xe_gt_dbg_printer (struct xe_gt *gt ); ARGUMENTS gt the xe_gt pointer to use in xe_gt_dbg RETURN The drm_printer object. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_printk.h xe_gt_err_printer(9),...
xe_gt_debugfs_show_with_rpm(9)
NAME xe_gt_debugfs_show_with_rpm - A show callback for struct drm_info_list SYNOPSIS int xe_gt_debugfs_show_with_rpm (struct seq_file *m , void *data ); ARGUMENTS m the seq_file data data used by the drm debugfs helpers DESCRIPTION Similar to xe_gt_debugfs_simple_show but implicitly takes a ...
xe_gt_debugfs_simple_show(9)
NAME xe_gt_debugfs_simple_show - A show callback for struct drm_info_list SYNOPSIS int xe_gt_debugfs_simple_show (struct seq_file *m , void *data ); ARGUMENTS m the seq_file data data used by the drm debugfs helpers DESCRIPTION This callback can be used in struct drm_info_list to describe de...
xe_gt_declare_wedged(9)
NAME xe_gt_declare_wedged - Declare GT wedged SYNOPSIS void xe_gt_declare_wedged (struct xe_gt *gt ); ARGUMENTS gt the GT object DESCRIPTION Wedge the GT which stops all submission, saves desired debug state, and cleans up anything which could timeout. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt.c xe_g...
xe_gt_err_printer(9)
NAME xe_gt_err_printer - Construct a &drm_printer that outputs to xe_gt_err() SYNOPSIS struct drm_printer xe_gt_err_printer (struct xe_gt *gt ); ARGUMENTS gt the xe_gt pointer to use in xe_gt_err RETURN The drm_printer object. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_printk.h xe_gt_info_printer(9), ...
xe_gt_freq_init(9)
NAME xe_gt_freq_init - Initialize Xe Freq component SYNOPSIS int xe_gt_freq_init (struct xe_gt *gt ); ARGUMENTS gt Xe GT object DESCRIPTION It needs to be initialized after GT Sysfs and GuC PC components are ready. RETURN Returns error value for failure and 0 for success. SEE ALSO Kernel file ./drivers/gp...
xe_gt_idle_pg_print(9)
NAME xe_gt_idle_pg_print - Xe powergating info SYNOPSIS int xe_gt_idle_pg_print (struct xe_gt *gt , struct drm_printer *p ); ARGUMENTS gt GT object p drm_printer. DESCRIPTION This function prints the powergating information RETURN 0 on success, negative error code otherwise SEE ALSO Kern...
xe_gt_info_printer(9)
NAME xe_gt_info_printer - Construct a &drm_printer that outputs to xe_gt_info() SYNOPSIS struct drm_printer xe_gt_info_printer (struct xe_gt *gt ); ARGUMENTS gt the xe_gt pointer to use in xe_gt_info RETURN The drm_printer object. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_printk.h xe_gt_err_printer(9...
xe_gt_lrc_hang_replay_size(9)
NAME xe_gt_lrc_hang_replay_size - Hang replay size SYNOPSIS size_t xe_gt_lrc_hang_replay_size (struct xe_gt *gt , enum xe_engine_class class ); ARGUMENTS gt The GT class Hardware engine class DESCRIPTION Determine size of GPU hang replay state for a GT and hardware engine class. RETURN Size o...
xe_gt_mcr_get_dss_steering(9)
NAME xe_gt_mcr_get_dss_steering - Get the group/instance steering for a DSS SYNOPSIS void xe_gt_mcr_get_dss_steering (const struct xe_gt *gt , unsigned int dss , u16 *group , u16 *instance ); ARGUMENTS gt GT structure dss DSS ID to obtain steering for group pointer to storage fo...
xe_gt_mcr_init(9)
NAME xe_gt_mcr_init - Normal initialization of the MCR support SYNOPSIS void xe_gt_mcr_init (struct xe_gt *gt ); ARGUMENTS gt GT structure DESCRIPTION Perform normal initialization of the MCR for all usages. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt_mcr.c Kernel API(9), xe_gt_mcr_get_dss_steering(9)...
xe_gt_mcr_init_early(9)
NAME xe_gt_mcr_init_early - Early initialization of the MCR support SYNOPSIS void xe_gt_mcr_init_early (struct xe_gt *gt ); ARGUMENTS gt GT structure DESCRIPTION Perform early software only initialization of the MCR lock to allow the synchronization on accessing the STEER_SEMAPHORE register and use the ...
xe_gt_mcr_multicast_write(9)
NAME xe_gt_mcr_multicast_write - write a value to all instances of an MCR register SYNOPSIS void xe_gt_mcr_multicast_write (struct xe_gt *gt , struct xe_reg_mcr reg_mcr , u32 value ); ARGUMENTS gt GT structure reg_mcr the MCR register to write value value to write DESCRIPTION Write...
xe_gt_mcr_set_implicit_defaults(9)
NAME xe_gt_mcr_set_implicit_defaults - Initialize steer control registers SYNOPSIS void xe_gt_mcr_set_implicit_defaults (struct xe_gt *gt ); ARGUMENTS gt GT structure DESCRIPTION Some register ranges don't need to have their steering control registers changed on each access - it's sufficient to set them onc...
xe_gt_mcr_steering_info_to_dss_id(9)
NAME xe_gt_mcr_steering_info_to_dss_id - Get DSS ID from group/instance steering SYNOPSIS u32 xe_gt_mcr_steering_info_to_dss_id (struct xe_gt *gt , u16 group , u16 instance ); ARGUMENTS gt GT structure group steering group ID instance steering instance ID RETURN the converted DSS id...
xe_gt_mcr_unicast_read(9)
NAME xe_gt_mcr_unicast_read - read a specific instance of an MCR register SYNOPSIS u32 xe_gt_mcr_unicast_read (struct xe_gt *gt , struct xe_reg_mcr reg_mcr , int group , int instance ); ARGUMENTS gt GT structure reg_mcr the MCR register to read group the MCR group instance ...
xe_gt_mcr_unicast_read_any(9)
NAME xe_gt_mcr_unicast_read_any - reads a non-terminated instance of an MCR register SYNOPSIS u32 xe_gt_mcr_unicast_read_any (struct xe_gt *gt , struct xe_reg_mcr reg_mcr ); ARGUMENTS gt GT structure reg_mcr register to read DESCRIPTION Reads a GT MCR register. The read will be steered to a n...
xe_gt_mcr_unicast_write(9)
NAME xe_gt_mcr_unicast_write - write a specific instance of an MCR register SYNOPSIS void xe_gt_mcr_unicast_write (struct xe_gt *gt , struct xe_reg_mcr reg_mcr , u32 value , int group , int instance ); ARGUMENTS gt GT structure reg_mcr the MCR register to write value value to write ...
xe_gt_mmio_init(9)
NAME xe_gt_mmio_init - Initialize GT's MMIO access SYNOPSIS void xe_gt_mmio_init (struct xe_gt *gt ); ARGUMENTS gt the GT object DESCRIPTION Initialize GT's MMIO accessor, which will be used to access registers inside this GT. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt.c xe_gt_sanitize_freq(9), xe_gt_...
xe_gt_record_user_engines(9)
NAME xe_gt_record_user_engines - save data related to engines available to userspace SYNOPSIS void xe_gt_record_user_engines (struct xe_gt *gt ); ARGUMENTS gt GT structure DESCRIPTION Walk the available HW engines from gt->info.engine_mask and calculate data related to those engines that may be used by ...
xe_gt_recovery_pending(9)
NAME xe_gt_recovery_pending - GT recovery pending SYNOPSIS bool xe_gt_recovery_pending (struct xe_gt *gt ); ARGUMENTS gt the xe_gt RETURN True if GT recovery in pending, False otherwise SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt.h xe_gt_record_user_engines(9), xe_gt_wait_for_reset(9), xe_gt_reset(9), ...
xe_gt_reset(9)
NAME xe_gt_reset - perform synchronous reset SYNOPSIS bool xe_gt_reset (struct xe_gt *gt ); ARGUMENTS gt GT structure RETURN true if it waited for the reset to finish, false if there was no scheduled reset. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt.h xe_gt_record_user_engines(9), xe_gt_wait_for_reset...
xe_gt_runtime_resume(9)
NAME xe_gt_runtime_resume - GT runtime resume SYNOPSIS int xe_gt_runtime_resume (struct xe_gt *gt ); ARGUMENTS gt the GT object RETURN 0 on success, negative error code otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt.c xe_gt_mmio_init(9), xe_gt_sanitize_freq(9), xe_gt_runtime_suspend(9), xe_gt_d...
xe_gt_runtime_suspend(9)
NAME xe_gt_runtime_suspend - GT runtime suspend SYNOPSIS int xe_gt_runtime_suspend (struct xe_gt *gt ); ARGUMENTS gt the GT object RETURN 0 on success, negative error code otherwise. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_gt.c xe_gt_mmio_init(9), xe_gt_sanitize_freq(9), xe_gt_runtime_resume(9), xe_gt...
xe_gt_sanitize_freq(9)
NAME xe_gt_sanitize_freq - Restore saved frequencies if necessary. SYNOPSIS int xe_gt_sanitize_freq (struct xe_gt *gt ); ARGUMENTS gt the GT object DESCRIPTION Called after driver init/GSC load completes to restore GT frequencies if we limited them for any WAs. SEE ALSO Kernel file ./drivers/gpu/drm/xe/xe_...
xe_gt_sriov_pf_assert_vfid(9)
NAME xe_gt_sriov_pf_assert_vfid - warn if &id is not a supported VF number when debugging. SYNOPSIS xe_gt_sriov_pf_assert_vfid (gt , vfid ); ARGUMENTS gt the PF xe_gt to assert on vfid the VF number to assert DESCRIPTION Assert that gt belongs to the Physical Function (PF) device and provided...
xe_gt_sriov_pf_config_bulk_set_ctxs(9)
NAME xe_gt_sriov_pf_config_bulk_set_ctxs - Provision many VFs with GuC context IDs. SYNOPSIS int xe_gt_sriov_pf_config_bulk_set_ctxs (struct xe_gt *gt , unsigned int vfid , unsigned int num_vfs , u32 num_ctxs ); ARGUMENTS gt the xe_gt vfid starting VF identifier num_vfs number of V...
xe_gt_sriov_pf_config_bulk_set_dbs(9)
NAME xe_gt_sriov_pf_config_bulk_set_dbs - Provision many VFs with GuC context IDs. SYNOPSIS int xe_gt_sriov_pf_config_bulk_set_dbs (struct xe_gt *gt , unsigned int vfid , unsigned int num_vfs , u32 num_dbs ); ARGUMENTS gt the xe_gt vfid starting VF identifier (can't be 0) num_vfs n...
xe_gt_sriov_pf_config_bulk_set_exec_quantum_locked(9)
NAME xe_gt_sriov_pf_config_bulk_set_exec_quantum_locked - Configure EQ for PF and VFs. SYNOPSIS int xe_gt_sriov_pf_config_bulk_set_exec_quantum_locked (struct xe_gt *gt , u32 exec_quantum ); ARGUMENTS gt the xe_gt to configure exec_quantum requested execution quantum in millisecond...
xe_gt_sriov_pf_config_bulk_set_ggtt(9)
NAME xe_gt_sriov_pf_config_bulk_set_ggtt - Provision many VFs with GGTT. SYNOPSIS int xe_gt_sriov_pf_config_bulk_set_ggtt (struct xe_gt *gt , unsigned int vfid , unsigned int num_vfs , u64 size ); ARGUMENTS gt the xe_gt (can't be media) vfid starting VF identifier (can't be 0) num_vfs ...
xe_gt_sriov_pf_config_bulk_set_lmem(9)
NAME xe_gt_sriov_pf_config_bulk_set_lmem - Provision many VFs with LMEM. SYNOPSIS int xe_gt_sriov_pf_config_bulk_set_lmem (struct xe_gt *gt , unsigned int vfid , unsigned int num_vfs , u64 size ); ARGUMENTS gt the xe_gt (can't be media) vfid starting VF identifier (can't be 0) num_vfs ...