Lines Matching +full:required +full:- +full:for +full:- +full:hardware +full:- +full:jobs

1 /* SPDX-License-Identifier: GPL-2.0
3 * Copyright 2016-2023 HabanaLabs, Ltd.
19 #include <linux/dma-direction.h>
28 #include <linux/io-64-nonatomic-lo-hi.h>
30 #include <linux/dma-buf.h>
45 * bits[63:59] - Encode mmap type
46 * bits[45:0] - mmap offset value
51 #define HL_MMAP_TYPE_SHIFT (59 - PAGE_SHIFT)
64 * In device fini, wait 10 minutes for user processes to be terminated after we kill them.
95 /* Default value for device reset trigger , an invalid value */
110 * enum hl_mmu_page_table_location - mmu page table location
111 * @MMU_DR_PGT: page-table is located on device DRAM.
112 * @MMU_HR_PGT: page-table is located on host memory.
113 * @MMU_NUM_PGT_LOCATIONS: number of page-table locations currently supported.
116 MMU_DR_PGT = 0, /* device-dram-resident MMU PGT */
135 #define IS_POWER_OF_2(n) (n != 0 && ((n & (n - 1)) == 0))
168 * - HL_DRV_RESET_HARD
172 * - HL_DRV_RESET_FROM_RESET_THR
173 * Set if the caller is the hard-reset thread
175 * - HL_DRV_RESET_HEARTBEAT
178 * - HL_DRV_RESET_TDR
181 * - HL_DRV_RESET_DEV_RELEASE
184 * - HL_DRV_RESET_BYPASS_REQ_TO_FW
188 * - HL_DRV_RESET_FW_FATAL_ERR
191 * - HL_DRV_RESET_DELAY
194 * - HL_DRV_RESET_FROM_WD_THR
220 #define HL_BLOCK_GLBL_SEC_SIZE (HL_BLOCK_SIZE - HL_BLOCK_GLBL_SEC_OFFS)
231 * struct iterate_module_ctx - HW module iterator
234 * @rc: return code for optional use of iterator/iterator-caller
238 * callback for the HW module iterator
242 * @offset: current HW module instance offset from the 1-st HW module instance
243 * in the 1-st block
259 * struct hl_gen_wait_properties - properties for generating a wait CB
264 * @sob_val: SOB value to wait for
279 * struct pgt_info - MMU hop page info.
280 * @node: hash linked-list node for the pgts on host (shadow pgts for device resident MMU and
281 * actual pgts for host resident MMU).
284 * @shadow_addr: shadow hop in the host for device resident MMU.
286 * @num_of_ptes: indicates how many ptes are used in the pgt. used only for dynamically
290 * pgts will be stored on host memory) or on host memory (in which case no shadow is required).
307 * enum hl_pci_match_mode - pci match mode per region
317 * enum hl_fw_component - F/W components to read version through registers.
329 * enum hl_fw_types - F/W types present in the system
331 * @FW_TYPE_LINUX: Linux image for device CPU
332 * @FW_TYPE_BOOT_CPU: Boot image for device CPU
333 * @FW_TYPE_PREBOOT_CPU: Indicates pre-loaded CPUs are present in the system
335 * @FW_TYPE_ALL_TYPES: Mask for all types
347 * enum hl_queue_type - Supported QUEUE types.
353 * @QUEUE_TYPE_CPU: S/W queue for communication with the device's CPU.
354 * @QUEUE_TYPE_HW: queue of DMA and compute engines jobs, for which completion
378 * struct hl_inbound_pci_region - inbound region descriptor
379 * @mode: pci match mode for this region
394 * struct hl_outbound_pci_region - outbound region descriptor
404 * enum queue_cb_alloc_flags - Indicates queue support for CBs that
415 * struct hl_hw_sob - H/W SOB info.
439 * struct hw_queue_properties - queue information.
443 * a CB handle can be provided for jobs on this queue.
451 * @dram_bd: True if the bd should be copied to dram, needed for PQ which has been allocated on dram
465 * enum vm_type - virtual memory mapping request information.
475 * enum mmu_op_flags - mmu operation relevant information.
490 * enum hl_device_hw_state - H/W device state. use this to understand whether
504 * struct hl_mmu_properties - ASIC specific MMU address translation properties.
510 * @pgt_size: size for page tables.
511 * @supported_pages_mask: bitmask for supported page size (relevant only for MMUs
516 * @hop0_tables_total_size: total size for all HOP0 tables.
536 * struct hl_hints_range - hint addresses reserved va range.
546 * struct asic_fixed_properties - ASIC specific immutable properties.
550 * @cpucp_info: received various information from CPU-CP regarding the H/W, e.g.
552 * @uboot_ver: F/W U-boot version.
556 * @pmmu_huge: PCI (host) MMU address translation properties for memory
563 * @sram_user_base_address - SRAM physical start address for user access.
566 * @dram_user_base_address: DRAM physical start address for user access.
582 * for hints validity check.
588 * @host_base_address: host physical start address for host DMA from device
589 * @host_end_address: host physical end address for host DMA from device
591 * @engine_core_interrupt_reg_addr: interrupt register address for engine core to use
638 * 1- enabled, 0- isolated.
640 * 1- faulty cluster, 0- good cluster.
642 * 1- enabled, 0- isolated.
643 * @device_mem_alloc_default_page_size: may be different than dram_page_size only for ASICs for
653 * @reserved_fw_mem_size: size of dram memory reserved for FW.
654 * @fw_event_queue_size: queue size for events from CPU-CP.
656 * @collective_first_sob: first sync object available for collective use
657 * @collective_first_mon: first monitor available for collective use
658 * @sync_stream_first_sob: first sync object available for sync stream use
659 * @sync_stream_first_mon: first monitor available for sync stream use
660 * @first_available_user_sob: first sob available for the user
661 * @first_available_user_mon: first monitor available for the user
662 * @first_available_user_interrupt: first available interrupt reserved for the user
663 * @first_available_cq: first available CQ for the user.
666 * @tpc_interrupt_id: interrupt id for TPC to use in order to raise events towards the host.
667 * @eq_interrupt_id: interrupt id for EQ, uses to synchronize EQ interrupts in hard-reset.
672 * @completion_mode: 0 - job based completion, 1 - cs based completion
673 * @mme_master_slave_mode: 0 - Each MME works independently, 1 - MME works
689 * @use_get_power_for_reset_history: To support backward compatibility for Goya
691 * @supports_compute_reset: is a reset which is not a hard-reset supported by this asic.
694 * in inference ASICs, as there is no real-world
695 * use-case of doing soft-reset in training (due
698 * @configurable_stop_on_err: is stop-on-error option configurable via debugfs.
701 * @dma_mask: the dma mask to be set for this device.
704 * @support_dynamic_resereved_fw_size: true if we support dynamic reserved size for fw.
828 * struct hl_fence - software synchronization primitive
830 * @refcount: refcount for this fence
851 * struct hl_cs_compl - command submission completion object.
858 * @type: type of the CS - signal/wait.
882 * struct hl_ts_buff - describes a timestamp buffer.
896 * struct hl_mem_mgr - describes unified memory manager for mappable memory chunks.
908 * struct hl_mem_mgr_fini_stats - describes statistics returned during memory manager teardown.
920 * struct hl_mmap_mem_buf_behavior - describes unified memory manager buffer behavior
921 * @topic: string identifier used for logging
939 * struct hl_mmap_mem_buf - describes a single unified memory buffer
942 * @refcount: reference counter for buffer users
963 * struct hl_cb - describes a Command Buffer.
1021 /* Host <-> CPU-CP shared memory size */
1025 * struct hl_sync_stream_properties -
1028 * @next_sob_val: the next value to use for the currently used SOB.
1052 * struct hl_encaps_signals_mgr - describes sync stream encapsulated signals
1063 * struct hl_hw_queue - describes a H/W transport queue.
1064 * @shadow_queue: pointer to a shadow queue that holds pointers to jobs.
1075 * @cq_id: the id for the corresponding CQ for this H/W queue.
1081 * @dram_bd: True if the bd should be copied to dram, needed for PQ which has been allocated on dram
1103 * struct hl_cq - describes a completion queue
1132 * struct hl_ts_free_jobs - holds user interrupt ts free nodes related data
1133 * @free_nodes_pool: pool of nodes to be used for free timestamp jobs
1148 * struct hl_user_interrupt - holds user interrupt information
1150 * @ts_free_jobs_data: timestamp free jobs related data
1172 * struct timestamp_reg_free_node - holds the timestamp registration free objects node
1187 /* struct timestamp_reg_work_obj - holds the timestamp registration free objects job
1192 * @free_obj_head: list of free jobs nodes (node type timestamp_reg_free_node)
1193 * @dynamic_alloc_free_obj_head: list of free jobs nodes which were dynamically allocated in the
1203 /* struct timestamp_reg_info - holds the timestamp registration related data.
1225 * struct hl_user_pending_interrupt - holds a context to a user thread
1229 * @fence: hl fence object for interrupt completion
1232 * handler for target value comparison
1243 * struct hl_eq - describes the event queue (single one per device)
1252 * previous one. This is for backward compatibility with older
1266 * struct hl_dec - describes a decoder sw instance.
1280 * enum hl_asic_type - supported ASIC types.
1282 * @ASIC_GOYA: Goya device (HL-1000).
1283 * @ASIC_GAUDI: Gaudi device (HL-2000).
1284 * @ASIC_GAUDI_SEC: Gaudi secured device (HL-2000).
1305 * enum hl_pm_mng_profile - power management profile.
1317 * enum hl_pll_frequency - PLL frequency.
1355 * struct pci_mem_region - describe memory region in a PCI bar
1373 * struct static_fw_load_mgr - static FW load manager
1376 * @kmd_msg_to_cpu_reg: register address for KDM->CPU messages
1377 * @cpu_cmd_status_to_host_reg: register address for CPU command status response
1385 * @sram_offset_mask: mask for getting offset into the SRAM
1405 * struct fw_response - FW response to LKD command
1417 * struct dynamic_fw_load_mgr - dynamic FW load manager
1422 * @wait_for_bl_timeout: timeout for waiting for boot loader to respond
1435 * struct pre_fw_load_props - needed properties for pre-FW load
1441 * @wait_for_preboot_timeout: timeout to poll for preboot ready
1442 * @wait_for_preboot_extended_timeout: timeout to pull for preboot ready in case where we know
1456 * struct fw_image_props - properties of FW image
1468 * struct fw_load_mgr - manager FW loading process
1469 * @dynamic_loader: specific structure for dynamic load
1470 * @static_loader: specific structure for static load
1471 * @pre_fw_load_props: parameter for pre FW load
1501 * struct engines_data - asic engines data
1502 * @buf: buffer for engines data in ascii
1513 * struct hl_asic_funcs - ASIC specific functions that are can be called from
1517 * @late_init: sets up late driver/hw state (post hw_init) - Optional.
1518 * @late_fini: tears down what was done in late_init (pre hw_fini) - Optional.
1523 * @halt_engines: halt engines, needed for reset sequence. This also disables
1526 * @suspend: handles IP specific H/W or SW changes for suspend.
1527 * @resume: handles IP specific H/W or SW changes for resume.
1530 * @pqe_write: Write the PQ entry to the PQ. This is ASIC-specific
1546 * @test_queues: run simple test on all queues for sanity check.
1552 * @dma_unmap_sgtable: DMA unmap scatter-gather table.
1553 * @dma_map_sgtable: DMA map scatter-gather table.
1559 * @debugfs_read_dma: debug interface for reading up to 2MB from the device's
1562 * @handle_eqe: handle event queue entry (IRQ) from CPU-CP.
1568 * @mmu_invalidate_cache_range: flush specific MMU STLB cache lines with ASID-VA-size mask.
1569 * @mmu_prefetch_cache_range: pre-fetch specific MMU STLB cache lines with ASID-VA-size mask.
1570 * @send_heartbeat: send is-alive packet to CPU-CP and verify response.
1571 * @debug_coresight: perform certain actions on Coresight for debugging.
1582 * then the timeout is the default timeout for the specific
1587 * @rreg: Read a register. Needed for simulator support.
1588 * @wreg: Write a register. Needed for simulator support.
1592 * @pre_schedule_cs: Perform pre-CS-scheduling operations.
1605 * and place them in the relevant cs jobs
1606 * @collective_wait_create_jobs: allocate collective wait cs jobs
1610 * @descramble_addr: Routine to de-scramble the address prior of
1615 * a valid pointer for it
1620 * after every hard-reset of the device
1622 * @get_msi_info: Retrieve asic-specific MSI ID of the f/w async event
1625 * @init_firmware_preload_params: initialize pre FW-load parameters.
1626 * @init_firmware_loader: initialize data for FW loader.
1628 * @state_dump_init: initialize constants required for state dump
1639 * @set_binning_masks: set binning/enable masks for all relevant components.
1784 * enum hl_va_range_type - virtual address range type.
1797 * struct hl_va_range - virtual addresses range.
1799 * @list: list of virtual addresses blocks available for mappings.
1813 * struct hl_cs_counters_atomic - command submission counters
1818 * @max_cs_in_flight_drop_cnt: dropped due to maximum CS in-flight
1831 * struct hl_dmabuf_priv - a dma-buf private object.
1832 * @dmabuf: pointer to dma-buf object.
1833 * @ctx: pointer to the dma-buf owner's context.
1834 * @phys_pg_pack: pointer to physical page pack if the dma-buf was exported
1840 * if phys_pg_pack is NULL (dma-buf was exported from address).
1855 * struct hl_cs_outcome - represents a single completed CS outcome
1871 * struct hl_cs_outcome_store - represents a limited store of completed CS outcomes
1875 * @nodes_pool: a static pool of pre-allocated outcome objects
1887 * struct hl_ctx - user/kernel context.
1891 * @hr_mmu_phys_hash: if host-resident MMU is used, holds a mapping from
1892 * MMU-hop-page physical address to its host-resident
1896 * @refcount: reference counter for the context. Context is released only when
1900 * command submissions for a long time after CS id wraparound.
1901 * @va_range: holds available virtual addresses for host and dram mappings.
1908 * @cb_va_pool: device VA pool for command buffers which are mapped to the
1911 * @cb_va_pool_base: the base address for the device VA pool
1912 * @cs_sequence: sequence number for CS. Value is assigned to a CS and passed
1915 * @dram_default_hops: array that holds all hops addresses needed for default
1927 * @handle: context's opaque handle for user
1959 * struct hl_ctx_mgr - for handling multiple contexts.
1974 * struct hl_userptr - memory mapping chunk information
1976 * @job_node: linked-list node for hanging the object on the Job's list.
1979 * @sgt: pointer to the scatter-gather table that holds the pages.
1980 * @dir: for DMA unmapping, the direction must be supplied, so save it.
1983 * @addr: user-space virtual address of the start of the memory area.
2002 * struct hl_cs - command submission.
2003 * @jobs_in_queue_cnt: per each queue, maintain counter of submitted jobs.
2005 * @job_list: list of the CS's jobs in the various queues.
2006 * @job_lock: spinlock for the CS's jobs list. Needed for free_job.
2007 * @refcount: reference counter for usage of the CS.
2012 * @work_tdr: delayed work node for TDR.
2023 * @jobs_cnt: counter of submitted jobs on all queues.
2024 * @encaps_sig_hdl_id: encaps signals handle id, set for the first staged cs.
2032 * @tdr_active: true if TDR was activated for this CS (to prevent
2038 * timeout for this CS.
2082 * struct hl_cs_job - command submission job.
2083 * @cs_node: the node to hang on the CS jobs list.
2089 * @userptr_list: linked-list of userptr mappings that belong to this job and
2090 * wait for completion.
2091 * @debugfs_list: node in debugfs list of command submission jobs.
2092 * @refcount: reference counter for usage of the CS job.
2102 * handle to a kernel-allocated CB object, false
2107 * MSG_PROT packets. Relevant only for GAUDI as GOYA doesn't
2132 * struct hl_cs_parser - command submission parser properties.
2136 * @job_userptr_list: linked-list of userptr mappings that belong to the related
2137 * job and wait for completion.
2146 * handle to a kernel-allocated CB object, false
2151 * MSG_PROT packets. Relevant only for GAUDI as GOYA doesn't
2154 * @completion: true if we need completion for this CS.
2177 * struct hl_vm_hash_node - hash element from virtual address to virtual
2182 * @handle: memory handle for device memory allocation.
2195 * struct hl_vm_hw_block_list_node - list element from user virtual address to
2201 * @mapped_size: size of the block which is mapped. May change if partial un-mappings are done.
2214 * struct hl_vm_phys_pg_pack - physical page pack.
2247 * struct hl_vm_va_block - virtual range block information.
2261 * struct hl_vm - virtual memory manager for MMU.
2262 * @dram_pg_pool: pool for DRAM physical pages of 2MB.
2263 * @dram_pg_pool_refcount: reference counter for the pool usage.
2283 * struct hl_debug_params - Coresight debug parameters.
2301 * struct hl_notifier_event - holds the notifier data structure
2317 * struct hl_fpriv - process information stored in FD private data.
2321 * @ctx: current executing context. TODO: remove for multiple ctx per process
2322 * @ctx_mgr: context manager to handle multiple context for this FD.
2323 * @mem_mgr: manager descriptor for memory exportable via mmap
2328 * @restore_phase_mutex: lock for context switch and restore phase.
2329 * @ctx_lock: protects the pointer to current executing context pointer. TODO: remove for multiple
2353 * struct hl_info_list - debugfs file ops.
2366 * struct hl_debugfs_entry - debugfs dentry wrapper.
2376 * struct hl_dbg_device_entry - ASIC specific debugfs manager.
2386 * @cs_job_list: list of available CB jobs.
2399 * @userptr_lookup: the target user ptr to look up for on demand.
2402 * @i2c_bus: generic u8 debugfs file for bus value to use in i2c_data_read.
2403 * @i2c_addr: generic u8 debugfs file for address value to use in i2c_data_read.
2404 * @i2c_reg: generic u8 debugfs file for register value to use in i2c_data_read.
2405 * @i2c_len: generic u8 debugfs file for length value to use in i2c_data_read.
2440 * struct hl_hw_obj_name_entry - single hw object name, member of
2493 * struct hl_mon_state_dump - represents a state dump of a single monitor
2511 * struct hl_sync_to_engine_map_entry - sync object id to engine mapping entry
2524 * struct hl_sync_to_engine_map - maps sync object id to associated engine id
2533 * struct hl_state_dump_specs_funcs - virtual functions used by the state dump
2555 * struct hl_state_dump_specs - defines ASIC known hw objects names
2558 * @funcs: virtual functions used for state dump
2559 * @sync_namager_names: readable names for sync manager if available (ex: N_E)
2560 * @props: pointer to a per asic const props array required for state dump
2591 #define RREG32(reg) hdev->asic_funcs->rreg(hdev, (reg))
2592 #define WREG32(reg, v) hdev->asic_funcs->wreg(hdev, (reg), (v))
2594 hdev->asic_funcs->rreg(hdev, (reg)))
2629 for (;;) { \
2654 __rc ? __rc : ((cond) ? 0 : -ETIMEDOUT); \
2667 * this is done both for efficiency and due to some registers are "clear on read".
2668 * TODO: use read from PCI bar in other places in the code (SW-91406)
2682 __rc = -EINVAL; \
2684 __elem_bitmask = BIT_ULL(arr_size) - 1; \
2685 for (;;) { \
2688 for (__arr_idx = 0; __arr_idx < (arr_size); __arr_idx++) { \
2708 __rc ? __rc : ((__elem_bitmask == 0) ? 0 : -ETIMEDOUT); \
2730 * be updated by host CPU. Required so host knows whether or not the memory
2731 * might need to be byte-swapped before returning value to caller.
2733 * On the first 4 polling iterations the macro goes to sleep for short period of
2745 for (;;) { \
2764 (cond) ? 0 : -ETIMEDOUT; \
2771 p->address = base; \
2772 p->size = sz; \
2789 * struct hl_device_reset_work - reset work wrapper.
2801 * struct hl_mmu_hr_pgt_priv - used for holding per-device mmu host-resident
2802 * page-table internal information.
2803 * @mmu_pgt_pool: pool of page tables used by a host-resident MMU for
2805 * @mmu_asid_hop0: per-ASID array of host-resident hop0 tables.
2813 * struct hl_mmu_dr_pgt_priv - used for holding per-device mmu device-resident
2814 * page-table internal information.
2815 * @mmu_pgt_pool: pool of page tables used by MMU for allocating hops.
2824 * struct hl_mmu_priv - used for holding per-device mmu internal information.
2825 * @dr: information on the device-resident MMU, when exists.
2826 * @hr: information on the host-resident MMU, when exists.
2834 * struct hl_mmu_per_hop_info - A structure describing one TLB HOP and its entry
2848 * struct hl_mmu_hop_info - A structure describing the TLB hops and their
2849 * hop-entries that were created in order to translate a virtual address to a
2852 * address replaces the original virtual-address when mapped
2854 * @unscrambled_paddr: The un-scrambled physical address.
2855 * @hop_info: Array holding the per-hop information used for the translation.
2856 * @used_hops: The number of hops used for the translation.
2868 * struct hl_hr_mmu_funcs - Device related host resident MMU functions.
2869 * @get_hop0_pgt_info: get page table info structure for HOP0.
2870 * @get_pgt_info: get page table info structure for HOP other than HOP0.
2872 * @get_tlb_mapping_params: get mapping parameters needed for getting TLB info for specific mapping.
2884 * struct hl_mmu_funcs - Device related MMU functions.
2887 * @ctx_init: Initialize a context for using the MMU module.
2889 * @map: maps a virtual address to physical address for a context.
2894 * @get_tlb_info: returns the list of hops and hop-entries used that were
2915 * struct hl_prefetch_work - prefetch work structure handler
2918 * @va: virtual address to pre-fetch.
2919 * @size: pre-fetch size.
2921 * @asid: ASID for maintenance operation.
2939 * struct multi_cs_completion - multi CS wait completion.
2941 * @lock: spinlock for the completion structure
2942 * @timestamp: timestamp for the multi-CS completion
2943 * @stream_master_qid_map: bitmap of all stream masters on which the multi-CS
2956 * struct multi_cs_data - internal data for multi CS call
2960 * @timeout_jiffies: timeout in jiffies for waiting for CS to complete
2962 * @wait_status: wait for CS status
2963 * @completion_bitmap: bitmap of completed CSs (1- completed, otherwise 0)
2965 * @gone_cs: indication of gone CS (1- there was gone CS, otherwise 0)
2966 * @update_ts: update timestamp. 1- update the timestamp, otherwise 0.
2982 * struct hl_clk_throttle_timestamp - current/last clock throttling timestamp
2992 * struct hl_clk_throttle - keeps current/last clock throttling timestamps
3008 * struct user_mapped_block - describes a hw block allowed to be mmapped by user
3010 * @size: allowed size for mmap
3018 * struct cs_timeout_info - info of last CS timeout occurred.
3020 * @write_enable: if set writing to CS parameters in the structure is enabled. otherwise - disabled,
3033 * struct undefined_opcode_info - info about last undefined opcode error
3037 * filled with values, it means the execution was in Lower-CP.
3040 * @cb_addr_streams_len: num of streams - actual len of cb_addr_streams array.
3042 * in Upper-CP (specific stream) and equal to 4 in case
3043 * of undefined opcode in Lower-CP.
3044 * @engine_id: engine-id that the error occurred on
3046 * MAX_QMAN_STREAMS_INFO it means the error occurred on a Lower-CP.
3063 * struct page_fault_info - page fault information.
3067 * @page_fault_detected: if set as 1, then a page-fault was discovered for the
3068 * first time after the driver has finished booting-up.
3069 * Since we're looking for the page-fault's root cause,
3070 * we don't care of the others that might follow it-
3083 * struct razwi_info - RAZWI information.
3085 * @razwi_detected: if set as 1, then a RAZWI was discovered for the
3086 * first time after the driver has finished booting-up.
3087 * Since we're looking for the RAZWI's root cause,
3088 * we don't care of the others that might follow it-
3099 * struct hw_err_info - HW error information.
3101 * @event_detected: if set as 1, then a HW event was discovered for the
3102 * first time after the driver has finished booting-up.
3103 * currently we assume that only fatal events (that require hard-reset) are
3116 * struct fw_err_info - FW error information.
3118 * @event_detected: if set as 1, then a FW event was discovered for the
3119 * first time after the driver has finished booting-up.
3120 * currently we assume that only fatal events (that require hard-reset) are
3133 * struct engine_err_info - engine error information.
3135 * @event_detected: if set as 1, then an engine event was discovered for the
3136 * first time after the driver has finished booting-up.
3147 * struct hl_error_info - holds information collected during an error.
3152 * @hw_err: (fatal) hardware error information.
3167 * struct hl_reset_info - holds current device reset information.
3174 * @in_compute_reset: Device is currently in reset but not in hard-reset.
3184 * @skip_reset_on_timeout: Skip device reset if CS has timed out, wait for it to
3205 * struct eq_heartbeat_debug_info - stores debug info to be used upon heartbeat failure.
3220 * struct hl_device - habanalabs device structure.
3223 * (required only for PCI address match mode)
3227 * @cdev_ctrl: char device for control operations only (INFO IOCTL)
3229 * @dev_ctrl: related kernel device structure for the control device
3230 * @work_heartbeat: delayed work for CPU-CP is-alive check.
3240 * @tpc_interrupt: single TPC interrupt for all TPCs.
3241 * @unexpected_error_interrupt: single interrupt for unexpected user error indication.
3242 * @common_user_cq_interrupt: common user CQ interrupt for all user CQ interrupts.
3245 * @common_decoder_interrupt: common decoder interrupt for all user decoder interrupts.
3248 * @cq_wq: work queues of completion queues for executing work in process
3250 * @eq_wq: work queue of event queue for executing work in process context.
3251 * @cs_cmplt_wq: work queue of CS completions for executing work in process
3253 * @ts_free_obj_wq: work queue for timestamp registration objects release.
3254 * @prefetch_wq: work queue for MMU pre-fetch operations.
3255 * @reset_wq: work queue for device reset procedure.
3258 * @cs_mirror_list: CS mirror list for TDR.
3260 * @kernel_mem_mgr: memory manager for memory buffers with lifespan of driver.
3261 * @event_queue: event queue for IRQ from CPU-CP.
3262 * @dma_pool: DMA pool for small allocations.
3263 * @cpu_accessible_dma_mem: Host <-> CPU-CP shared memory CPU address.
3264 * @cpu_accessible_dma_address: Host <-> CPU-CP shared memory DMA address.
3265 * @cpu_accessible_dma_pool: Host <-> CPU-CP shared memory pool.
3268 * @send_cpu_message_lock: enforces only one message in Host <-> CPU-CP queue.
3269 * @debug_lock: protects critical section of setting debug mode for device
3279 * @vm: virtual memory manager for MMU.
3297 * @mmu_priv: device-specific MMU data.
3298 * @mmu_func: device-related MMU functions.
3303 * @multi_cs_completion: array of multi-CS completion.
3308 * @irq_affinity_mask: mask of available CPU cores for user and decoder interrupt handling.
3314 * @fw_sw_sub_minor_ver: the sub-minor of current loaded preboot SW version.
3319 * value is saved so in case of hard-reset, the driver will restore
3320 * this value and update the F/W after the re-initialization
3335 * used for CPU boot status
3337 * used for COMMs protocols cmds(COMMS_STS_*)
3339 * drams are binned-out
3341 * tpc engines are binned-out
3342 * @dmabuf_export_cnt: number of dma-buf exporting.
3348 * indicates which decoder engines are binned-out
3350 * indicates which edma engines are binned-out
3353 * which indicates which rotator engines are binned-out(Gaudi3 and above).
3356 * @cpu_pci_msb_addr: 50-bit extension bits for the device CPU's 40-bit
3366 * such as context-switch, context close, page free, etc.
3367 * @pmmu_huge_range: is a different virtual addresses range used for PMMU with
3377 * @sync_stream_queue_idx: helper index for sync stream queues initialization.
3378 * @collective_mon_idx: helper index for collective initialization
3384 * waiting for the reset thread to finish
3388 * protocol will throw an error. Relevant only for
3390 * @supports_wait_for_multi_cs: true if wait for multi CS is supported
3396 * @supports_ctx_switch: true if a ctx switch is required upon first submission.
3399 * @nic_ports_mask: Controls which NIC ports are enabled. Used only for testing.
3401 * stages and sometimes we want to stop at a certain stage. Used only for testing.
3402 * @mmu_disable: Disable the device MMU(s). Used only for testing.
3403 * @cpu_queues_enable: Whether to enable queues communication vs. the f/w. Used only for testing.
3404 * @pldm: Whether we are running in Palladium environment. Used only for testing.
3405 * @hard_reset_on_fw_events: Whether to do device hard-reset when a fatal event is received from
3406 * the f/w. Used only for testing.
3407 * @bmc_enable: Whether we are running in a box with BMC. Used only for testing.
3409 * Used only for testing.
3411 * that the f/w is always alive. Used only for testing.
3565 /* Parameters for bring-up to be upstreamed */
3579 ((hdev)->pdev ? dev_name(&(hdev)->pdev->dev) : "NA-DEVICE")
3582 * struct hl_cs_encaps_sig_handle - encapsulated signals handle structure
3607 * struct hl_info_fw_err_info - firmware error information structure
3625 * typedef hl_ioctl_t - typedef for ioctl function in the driver
3630 * Return: 0 for success, negative value for error
3635 * struct hl_ioctl_desc - describes an IOCTL entry of the driver.
3637 * @func: pointer to the driver's function that should be called for this IOCTL.
3649 * hl_get_sg_info() - get number of pages and the DMA address from SG list.
3661 return ((((*dma_addr) & (PAGE_SIZE - 1)) + sg_dma_len(sg)) + in hl_get_sg_info()
3662 (PAGE_SIZE - 1)) >> PAGE_SHIFT; in hl_get_sg_info()
3666 * hl_mem_area_inside_range() - Checks whether address+size are inside a range.
3693 * hl_mem_area_crosses_range() - Checks whether address+size crossing a range.
3705 u64 end_address = address + size - 1; in hl_mem_area_crosses_range()
3761 #define hl_pi_2_offset(pi) ((pi) & (HL_QUEUE_LENGTH - 1))