uapi/drm/habanalabs_accel.h

32 /* Max number of elements in timestamps registration buffers */
187  * In GAUDI2 we have two modes of operation in regard to queues:
191  * When in legacy mode, the user sends the queue id per JOB according to
194  * When in F/W mode, the user sends a stream id per Command Submission. The
196  * of streams the F/W exposes and is passed to the user in
468  * Used in the "busy_engines_mask" field in `struct hl_info_hw_idle'
609  * Used to retrieve in frequency info of different IPs via HL_INFO_PLL_FREQUENCY under
611  * The enums need to be used as an index in struct hl_pll_frequency_info.
668  * @HL_DMA_ENUM_MAX: number of values in enum
688  * @HL_DEVICE_STATUS_IN_DEVICE_CREATION: Device is operational but its creation is still in
722  * HL_NOTIFIER_EVENT_USER_ENGINE_ERR	- Indicates device engine in error state
745  * HW_IP_INFO            - Receive information about different IP blocks in the
758  *                               The period can be between 100ms to 1s, in
764  *                               of the device in MHz. The maximum clock rate is
789  *                            May return 0 even though no new data is available, in that case
797  *                                  May return 0 even though no new data is available, in that case
799  * HL_INFO_ENGINE_STATUS - Retrieve the status of all the h/w engines in the asic.
801  *                            May return 0 even though no new data is available, in that case
806  *                          May return 0 even though no new data is available, in that case
809  *                          May return 0 even though no new data is available, in that case
858  * struct hl_info_hw_ip_info - hardware information on various IPs in the ASIC
870  * @module_id: Module ID of the ASIC for mezzanine cards in servers
876  * @server_type: Server type that the Gaudi ASIC is currently installed in.
879  * @psoc_pci_pll_nr: PCI PLL NR value. Needed by the profiler in some ASICs.
880  * @psoc_pci_pll_nf: PCI PLL NF value. Needed by the profiler in some ASICs.
881  * @psoc_pci_pll_od: PCI PLL OD value. Needed by the profiler in some ASICs.
883  *                           in some ASICs.
888  * @mme_master_slave_mode: Indicate whether the MME is working in master/slave
899  * @device_mem_alloc_default_page_size: default page size used in device memory allocation.
901  * @tpc_interrupt_id: interrupt id for TPC to use in order to raise events towards the host.
905  *                                  in order to raise events toward FW.
1023  * @clk_throttling_timestamp_us: represents CPU timestamp in microseconds of the start-event
1024  * @clk_throttling_duration_ns: the clock throttle time in nanosec
1087  * @total_parsing_drop_cnt: total dropped due to error in packet parsing
1088  * @ctx_parsing_drop_cnt: context dropped due to error in packet parsing
1091  * @total_device_in_reset_drop_cnt: total dropped due to device in reset
1092  * @ctx_device_in_reset_drop_cnt: context dropped due to device in reset
1093  * @total_max_cs_in_flight_drop_cnt: total dropped due to maximum CS in-flight
1094  * @ctx_max_cs_in_flight_drop_cnt: context dropped due to maximum CS in-flight
1151  *                           in gaudi, where we don't indication on specific engine, in that case
1159  *         Note: this data is not supported by all asics, in that case the relevant bits will not
1176  * @cb_addr_streams: CB addresses (per stream) that are currently exists in the PQ
1178  *                   filled with values, it means the execution was in Lower-CP.
1182  *                       should be equal to 1 in case of undefined opcode
1183  *                       in Upper-CP (specific stream) and equal to 4 incase
1184  *                       of undefined opcode in Lower-CP.
1211 /* FW error definition for event_type in struct hl_info_fw_err_event */
1220  * @err_type: The type of event as defined in hl_info_fw_err_type.
1247  * struct hl_info_dev_memalloc_page_sizes - valid page sizes in device mem alloc information.
1248  * @page_order_bitmask: bitmap in which a set bit represents the order of the supported page size
1269  * @pcr_num_reg: number of PCR registers in the pcr_data array
1270  * @pcr_reg_len: length of each PCR register in the pcr_data array (bytes)
1325  * @engine_id: engine id which caused the page fault, supported only in gaudi3.
1354  *                  mentioned in @op.
1355  * @return_size: Size of the structure used in @return_pointer, just like "size" in "snprintf", it
1360  * @ctx_id: Context ID of the user. Currently not in use.
1361  * @period_ms: Period value, in milliseconds, for utilization rate in range 100ms - 1000ms in 100 ms
1362  *             resolution. Currently not in use.
1363  * @pll_index: Index as defined in hl_<asic type>_pll_index enumeration.
1422 	/* Context ID - Currently not in use */
1448 	struct hl_cb_in in;
1477 		 * For internal queue in Goya, this represents an SRAM or
1485 		 * A mapped host address is in the device address space, after
1520 		 * Number of entries in signal_seq_arr
1571  *    value, in case other signaling request to the same SOB occurred between
1640 			/* number of engine cores in engine_cores array */
1652 			/* number of engines in engines array */
1690 	/* Number of chunks in restore phase array. Maximum number is
1695 	/* Number of chunks in execution array. Maximum number is
1700 	/* timeout in seconds - valid only if HL_CS_FLAGS_CUSTOM_TIMEOUT
1708 	/* Context ID - Currently not in use */
1741 	 * Count of completed signals in SOB before current signal submission.
1750 	struct hl_cs_in in;
1774 			 * in microseconds
1784 				 * in order not to perform any comparison, set address
1802 	/* Context ID - Currently not in use */
1809 	 * in order to wait for any CQ interrupt, set interrupt value to
1812 	 * in order to wait for any decoder interrupt, set interrupt value to
1819 			/* Multi CS API info- valid entries in multi-CS array */
1824 		/* Absolute timeout to wait for an interrupt in microseconds.
1879 	struct hl_wait_cs_in in;
1924  * @ctx_id: context ID - currently not in use.
2002 		 *        inside the device's DRAM. this is because in Gaudi1
2032 		 * assigned in the device VA space.
2038 		 * Used in HL_MEM_OP_ALLOC
2045 			 * Used in HL_MEM_OP_MAP_BLOCK.
2051 			 * Used in HL_MEM_OP_MAP_BLOCK
2059 		/* Returned in HL_MEM_OP_EXPORT_DMABUF_FD. Represents the
2069 	struct hl_mem_in in;
2076 	/* Address in memory to allocate buffer */
2088 	/* Address in memory to allocate buffer */
2184 	 * Register index in the component, taken from the debug_regs_index enum
2185 	 * in the various ASIC header files
2190 	/* Context ID - Currently not in use */
2211  * in order to prevent data corruption in case of differences between the
2212  * definitions of structures in kernel and userspace, e.g. in case of old
2222  * The command buffers are memory blocks that reside in DMA-able address
2256  * on JOBS which are enqueued in the external queues.
2270  * This IOCTL is asynchronous in regard to the actual execution of the CS. This
2310  * The driver also returns a custom define in case the IOCTL call returned 0.
2330  * to allocate the memory in user-space (malloc/new). The driver pins the
2332  * address in the device VA space and initializes the device MMU.
2347  * This is because the debug/profile infrastructure is shared component in the