1 // SPDX-License-Identifier: GPL-2.0
4 * Copyright 2016-2019 HabanaLabs, Ltd.
8 #define pr_fmt(fmt) "habanalabs: " fmt
10 #include <uapi/misc/habanalabs.h>
11 #include "habanalabs.h"
13 #include <linux/kernel.h>
15 #include <linux/uaccess.h>
16 #include <linux/slab.h>
18 static u32 hl_debug_struct_size[HL_DEBUG_OP_TIMESTAMP + 1] = {
19 [HL_DEBUG_OP_ETR] = sizeof(struct hl_debug_params_etr),
20 [HL_DEBUG_OP_ETF] = sizeof(struct hl_debug_params_etf),
21 [HL_DEBUG_OP_STM] = sizeof(struct hl_debug_params_stm),
22 [HL_DEBUG_OP_FUNNEL] = 0,
23 [HL_DEBUG_OP_BMON] = sizeof(struct hl_debug_params_bmon),
24 [HL_DEBUG_OP_SPMU] = sizeof(struct hl_debug_params_spmu),
25 [HL_DEBUG_OP_TIMESTAMP] = 0
29 static int device_status_info(struct hl_device *hdev, struct hl_info_args *args)
31 struct hl_info_device_status dev_stat = {0};
32 u32 size = args->return_size;
33 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
35 if ((!size) || (!out))
38 dev_stat.status = hl_device_status(hdev);
40 return copy_to_user(out, &dev_stat,
41 min((size_t)size, sizeof(dev_stat))) ? -EFAULT : 0;
44 static int hw_ip_info(struct hl_device *hdev, struct hl_info_args *args)
46 struct hl_info_hw_ip_info hw_ip = {0};
47 u32 size = args->return_size;
48 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
49 struct asic_fixed_properties *prop = &hdev->asic_prop;
50 u64 sram_kmd_size, dram_kmd_size;
52 if ((!size) || (!out))
55 sram_kmd_size = (prop->sram_user_base_address -
56 prop->sram_base_address);
57 dram_kmd_size = (prop->dram_user_base_address -
58 prop->dram_base_address);
60 hw_ip.device_id = hdev->asic_funcs->get_pci_id(hdev);
61 hw_ip.sram_base_address = prop->sram_user_base_address;
62 hw_ip.dram_base_address =
63 hdev->mmu_enable && prop->dram_supports_virtual_memory ?
64 prop->dmmu.start_addr : prop->dram_user_base_address;
65 hw_ip.tpc_enabled_mask = prop->tpc_enabled_mask;
66 hw_ip.sram_size = prop->sram_size - sram_kmd_size;
70 DIV_ROUND_DOWN_ULL(prop->dram_size - dram_kmd_size,
71 prop->dram_page_size) *
74 hw_ip.dram_size = prop->dram_size - dram_kmd_size;
76 if (hw_ip.dram_size > PAGE_SIZE)
77 hw_ip.dram_enabled = 1;
78 hw_ip.dram_page_size = prop->dram_page_size;
79 hw_ip.num_of_events = prop->num_of_events;
81 memcpy(hw_ip.cpucp_version, prop->cpucp_info.cpucp_version,
82 min(VERSION_MAX_LEN, HL_INFO_VERSION_MAX_LEN));
84 memcpy(hw_ip.card_name, prop->cpucp_info.card_name,
85 min(CARD_NAME_MAX_LEN, HL_INFO_CARD_NAME_MAX_LEN));
87 hw_ip.cpld_version = le32_to_cpu(prop->cpucp_info.cpld_version);
88 hw_ip.module_id = le32_to_cpu(prop->cpucp_info.card_location);
90 hw_ip.psoc_pci_pll_nr = prop->psoc_pci_pll_nr;
91 hw_ip.psoc_pci_pll_nf = prop->psoc_pci_pll_nf;
92 hw_ip.psoc_pci_pll_od = prop->psoc_pci_pll_od;
93 hw_ip.psoc_pci_pll_div_factor = prop->psoc_pci_pll_div_factor;
95 hw_ip.first_available_interrupt_id =
96 prop->first_available_user_msix_interrupt;
97 return copy_to_user(out, &hw_ip,
98 min((size_t) size, sizeof(hw_ip))) ? -EFAULT : 0;
101 static int hw_events_info(struct hl_device *hdev, bool aggregate,
102 struct hl_info_args *args)
104 u32 size, max_size = args->return_size;
105 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
108 if ((!max_size) || (!out))
111 arr = hdev->asic_funcs->get_events_stat(hdev, aggregate, &size);
113 return copy_to_user(out, arr, min(max_size, size)) ? -EFAULT : 0;
116 static int dram_usage_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
118 struct hl_device *hdev = hpriv->hdev;
119 struct hl_info_dram_usage dram_usage = {0};
120 u32 max_size = args->return_size;
121 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
122 struct asic_fixed_properties *prop = &hdev->asic_prop;
125 if ((!max_size) || (!out))
128 dram_kmd_size = (prop->dram_user_base_address -
129 prop->dram_base_address);
130 dram_usage.dram_free_mem = (prop->dram_size - dram_kmd_size) -
131 atomic64_read(&hdev->dram_used_mem);
133 dram_usage.ctx_dram_mem =
134 atomic64_read(&hpriv->ctx->dram_phys_mem);
136 return copy_to_user(out, &dram_usage,
137 min((size_t) max_size, sizeof(dram_usage))) ? -EFAULT : 0;
140 static int hw_idle(struct hl_device *hdev, struct hl_info_args *args)
142 struct hl_info_hw_idle hw_idle = {0};
143 u32 max_size = args->return_size;
144 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
146 if ((!max_size) || (!out))
149 hw_idle.is_idle = hdev->asic_funcs->is_device_idle(hdev,
150 hw_idle.busy_engines_mask_ext,
151 HL_BUSY_ENGINES_MASK_EXT_SIZE, NULL);
152 hw_idle.busy_engines_mask =
153 lower_32_bits(hw_idle.busy_engines_mask_ext[0]);
155 return copy_to_user(out, &hw_idle,
156 min((size_t) max_size, sizeof(hw_idle))) ? -EFAULT : 0;
159 static int debug_coresight(struct hl_device *hdev, struct hl_debug_args *args)
161 struct hl_debug_params *params;
162 void *input = NULL, *output = NULL;
165 params = kzalloc(sizeof(*params), GFP_KERNEL);
169 params->reg_idx = args->reg_idx;
170 params->enable = args->enable;
171 params->op = args->op;
173 if (args->input_ptr && args->input_size) {
174 input = kzalloc(hl_debug_struct_size[args->op], GFP_KERNEL);
180 if (copy_from_user(input, u64_to_user_ptr(args->input_ptr),
183 dev_err(hdev->dev, "failed to copy input debug data\n");
187 params->input = input;
190 if (args->output_ptr && args->output_size) {
191 output = kzalloc(args->output_size, GFP_KERNEL);
197 params->output = output;
198 params->output_size = args->output_size;
201 rc = hdev->asic_funcs->debug_coresight(hdev, params);
204 "debug coresight operation failed %d\n", rc);
208 if (output && copy_to_user((void __user *) (uintptr_t) args->output_ptr,
209 output, args->output_size)) {
210 dev_err(hdev->dev, "copy to user failed in debug ioctl\n");
224 static int device_utilization(struct hl_device *hdev, struct hl_info_args *args)
226 struct hl_info_device_utilization device_util = {0};
227 u32 max_size = args->return_size;
228 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
231 if ((!max_size) || (!out))
234 rc = hl_device_utilization(hdev, &device_util.utilization);
238 return copy_to_user(out, &device_util,
239 min((size_t) max_size, sizeof(device_util))) ? -EFAULT : 0;
242 static int get_clk_rate(struct hl_device *hdev, struct hl_info_args *args)
244 struct hl_info_clk_rate clk_rate = {0};
245 u32 max_size = args->return_size;
246 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
249 if ((!max_size) || (!out))
252 rc = hdev->asic_funcs->get_clk_rate(hdev, &clk_rate.cur_clk_rate_mhz,
253 &clk_rate.max_clk_rate_mhz);
257 return copy_to_user(out, &clk_rate,
258 min((size_t) max_size, sizeof(clk_rate))) ? -EFAULT : 0;
261 static int get_reset_count(struct hl_device *hdev, struct hl_info_args *args)
263 struct hl_info_reset_count reset_count = {0};
264 u32 max_size = args->return_size;
265 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
267 if ((!max_size) || (!out))
270 reset_count.hard_reset_cnt = hdev->hard_reset_cnt;
271 reset_count.soft_reset_cnt = hdev->soft_reset_cnt;
273 return copy_to_user(out, &reset_count,
274 min((size_t) max_size, sizeof(reset_count))) ? -EFAULT : 0;
277 static int time_sync_info(struct hl_device *hdev, struct hl_info_args *args)
279 struct hl_info_time_sync time_sync = {0};
280 u32 max_size = args->return_size;
281 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
283 if ((!max_size) || (!out))
286 time_sync.device_time = hdev->asic_funcs->get_device_time(hdev);
287 time_sync.host_time = ktime_get_raw_ns();
289 return copy_to_user(out, &time_sync,
290 min((size_t) max_size, sizeof(time_sync))) ? -EFAULT : 0;
293 static int pci_counters_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
295 struct hl_device *hdev = hpriv->hdev;
296 struct hl_info_pci_counters pci_counters = {0};
297 u32 max_size = args->return_size;
298 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
301 if ((!max_size) || (!out))
304 rc = hl_fw_cpucp_pci_counters_get(hdev, &pci_counters);
308 return copy_to_user(out, &pci_counters,
309 min((size_t) max_size, sizeof(pci_counters))) ? -EFAULT : 0;
312 static int clk_throttle_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
314 struct hl_device *hdev = hpriv->hdev;
315 struct hl_info_clk_throttle clk_throttle = {0};
316 u32 max_size = args->return_size;
317 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
319 if ((!max_size) || (!out))
322 clk_throttle.clk_throttling_reason = hdev->clk_throttling_reason;
324 return copy_to_user(out, &clk_throttle,
325 min((size_t) max_size, sizeof(clk_throttle))) ? -EFAULT : 0;
328 static int cs_counters_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
330 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
331 struct hl_info_cs_counters cs_counters = {0};
332 struct hl_device *hdev = hpriv->hdev;
333 struct hl_cs_counters_atomic *cntr;
334 u32 max_size = args->return_size;
336 cntr = &hdev->aggregated_cs_counters;
338 if ((!max_size) || (!out))
341 cs_counters.total_out_of_mem_drop_cnt =
342 atomic64_read(&cntr->out_of_mem_drop_cnt);
343 cs_counters.total_parsing_drop_cnt =
344 atomic64_read(&cntr->parsing_drop_cnt);
345 cs_counters.total_queue_full_drop_cnt =
346 atomic64_read(&cntr->queue_full_drop_cnt);
347 cs_counters.total_device_in_reset_drop_cnt =
348 atomic64_read(&cntr->device_in_reset_drop_cnt);
349 cs_counters.total_max_cs_in_flight_drop_cnt =
350 atomic64_read(&cntr->max_cs_in_flight_drop_cnt);
351 cs_counters.total_validation_drop_cnt =
352 atomic64_read(&cntr->validation_drop_cnt);
355 cs_counters.ctx_out_of_mem_drop_cnt =
357 &hpriv->ctx->cs_counters.out_of_mem_drop_cnt);
358 cs_counters.ctx_parsing_drop_cnt =
360 &hpriv->ctx->cs_counters.parsing_drop_cnt);
361 cs_counters.ctx_queue_full_drop_cnt =
363 &hpriv->ctx->cs_counters.queue_full_drop_cnt);
364 cs_counters.ctx_device_in_reset_drop_cnt =
366 &hpriv->ctx->cs_counters.device_in_reset_drop_cnt);
367 cs_counters.ctx_max_cs_in_flight_drop_cnt =
369 &hpriv->ctx->cs_counters.max_cs_in_flight_drop_cnt);
370 cs_counters.ctx_validation_drop_cnt =
372 &hpriv->ctx->cs_counters.validation_drop_cnt);
375 return copy_to_user(out, &cs_counters,
376 min((size_t) max_size, sizeof(cs_counters))) ? -EFAULT : 0;
379 static int sync_manager_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
381 struct hl_device *hdev = hpriv->hdev;
382 struct asic_fixed_properties *prop = &hdev->asic_prop;
383 struct hl_info_sync_manager sm_info = {0};
384 u32 max_size = args->return_size;
385 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
387 if ((!max_size) || (!out))
390 if (args->dcore_id >= HL_MAX_DCORES)
393 sm_info.first_available_sync_object =
394 prop->first_available_user_sob[args->dcore_id];
395 sm_info.first_available_monitor =
396 prop->first_available_user_mon[args->dcore_id];
397 sm_info.first_available_cq =
398 prop->first_available_cq[args->dcore_id];
400 return copy_to_user(out, &sm_info, min_t(size_t, (size_t) max_size,
401 sizeof(sm_info))) ? -EFAULT : 0;
404 static int total_energy_consumption_info(struct hl_fpriv *hpriv,
405 struct hl_info_args *args)
407 struct hl_device *hdev = hpriv->hdev;
408 struct hl_info_energy total_energy = {0};
409 u32 max_size = args->return_size;
410 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
413 if ((!max_size) || (!out))
416 rc = hl_fw_cpucp_total_energy_get(hdev,
417 &total_energy.total_energy_consumption);
421 return copy_to_user(out, &total_energy,
422 min((size_t) max_size, sizeof(total_energy))) ? -EFAULT : 0;
425 static int pll_frequency_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
427 struct hl_device *hdev = hpriv->hdev;
428 struct hl_pll_frequency_info freq_info = { {0} };
429 u32 max_size = args->return_size;
430 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
433 if ((!max_size) || (!out))
436 rc = hl_fw_cpucp_pll_info_get(hdev, args->pll_index, freq_info.output);
440 return copy_to_user(out, &freq_info,
441 min((size_t) max_size, sizeof(freq_info))) ? -EFAULT : 0;
444 static int power_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
446 struct hl_device *hdev = hpriv->hdev;
447 u32 max_size = args->return_size;
448 struct hl_power_info power_info = {0};
449 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
452 if ((!max_size) || (!out))
455 rc = hl_fw_cpucp_power_get(hdev, &power_info.power);
459 return copy_to_user(out, &power_info,
460 min((size_t) max_size, sizeof(power_info))) ? -EFAULT : 0;
463 static int open_stats_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
465 struct hl_device *hdev = hpriv->hdev;
466 u32 max_size = args->return_size;
467 struct hl_open_stats_info open_stats_info = {0};
468 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
470 if ((!max_size) || (!out))
473 open_stats_info.last_open_period_ms = jiffies64_to_msecs(
474 hdev->last_open_session_duration_jif);
475 open_stats_info.open_counter = hdev->open_counter;
477 return copy_to_user(out, &open_stats_info,
478 min((size_t) max_size, sizeof(open_stats_info))) ? -EFAULT : 0;
481 static int _hl_info_ioctl(struct hl_fpriv *hpriv, void *data,
484 enum hl_device_status status;
485 struct hl_info_args *args = data;
486 struct hl_device *hdev = hpriv->hdev;
491 * Information is returned for the following opcodes even if the device
492 * is disabled or in reset.
495 case HL_INFO_HW_IP_INFO:
496 return hw_ip_info(hdev, args);
498 case HL_INFO_DEVICE_STATUS:
499 return device_status_info(hdev, args);
501 case HL_INFO_RESET_COUNT:
502 return get_reset_count(hdev, args);
508 if (!hl_device_operational(hdev, &status)) {
509 dev_warn_ratelimited(dev,
510 "Device is %s. Can't execute INFO IOCTL\n",
511 hdev->status[status]);
516 case HL_INFO_HW_EVENTS:
517 rc = hw_events_info(hdev, false, args);
520 case HL_INFO_DRAM_USAGE:
521 rc = dram_usage_info(hpriv, args);
524 case HL_INFO_HW_IDLE:
525 rc = hw_idle(hdev, args);
528 case HL_INFO_DEVICE_UTILIZATION:
529 rc = device_utilization(hdev, args);
532 case HL_INFO_HW_EVENTS_AGGREGATE:
533 rc = hw_events_info(hdev, true, args);
536 case HL_INFO_CLK_RATE:
537 rc = get_clk_rate(hdev, args);
540 case HL_INFO_TIME_SYNC:
541 return time_sync_info(hdev, args);
543 case HL_INFO_CS_COUNTERS:
544 return cs_counters_info(hpriv, args);
546 case HL_INFO_PCI_COUNTERS:
547 return pci_counters_info(hpriv, args);
549 case HL_INFO_CLK_THROTTLE_REASON:
550 return clk_throttle_info(hpriv, args);
552 case HL_INFO_SYNC_MANAGER:
553 return sync_manager_info(hpriv, args);
555 case HL_INFO_TOTAL_ENERGY:
556 return total_energy_consumption_info(hpriv, args);
558 case HL_INFO_PLL_FREQUENCY:
559 return pll_frequency_info(hpriv, args);
562 return power_info(hpriv, args);
564 case HL_INFO_OPEN_STATS:
565 return open_stats_info(hpriv, args);
568 dev_err(dev, "Invalid request %d\n", args->op);
576 static int hl_info_ioctl(struct hl_fpriv *hpriv, void *data)
578 return _hl_info_ioctl(hpriv, data, hpriv->hdev->dev);
581 static int hl_info_ioctl_control(struct hl_fpriv *hpriv, void *data)
583 return _hl_info_ioctl(hpriv, data, hpriv->hdev->dev_ctrl);
586 static int hl_debug_ioctl(struct hl_fpriv *hpriv, void *data)
588 struct hl_debug_args *args = data;
589 struct hl_device *hdev = hpriv->hdev;
590 enum hl_device_status status;
594 if (!hl_device_operational(hdev, &status)) {
595 dev_warn_ratelimited(hdev->dev,
596 "Device is %s. Can't execute DEBUG IOCTL\n",
597 hdev->status[status]);
602 case HL_DEBUG_OP_ETR:
603 case HL_DEBUG_OP_ETF:
604 case HL_DEBUG_OP_STM:
605 case HL_DEBUG_OP_FUNNEL:
606 case HL_DEBUG_OP_BMON:
607 case HL_DEBUG_OP_SPMU:
608 case HL_DEBUG_OP_TIMESTAMP:
609 if (!hdev->in_debug) {
610 dev_err_ratelimited(hdev->dev,
611 "Rejecting debug configuration request because device not in debug mode\n");
615 min(args->input_size, hl_debug_struct_size[args->op]);
616 rc = debug_coresight(hdev, args);
618 case HL_DEBUG_OP_SET_MODE:
619 rc = hl_device_set_debug_mode(hdev, (bool) args->enable);
622 dev_err(hdev->dev, "Invalid request %d\n", args->op);
630 #define HL_IOCTL_DEF(ioctl, _func) \
631 [_IOC_NR(ioctl)] = {.cmd = ioctl, .func = _func}
633 static const struct hl_ioctl_desc hl_ioctls[] = {
634 HL_IOCTL_DEF(HL_IOCTL_INFO, hl_info_ioctl),
635 HL_IOCTL_DEF(HL_IOCTL_CB, hl_cb_ioctl),
636 HL_IOCTL_DEF(HL_IOCTL_CS, hl_cs_ioctl),
637 HL_IOCTL_DEF(HL_IOCTL_WAIT_CS, hl_wait_ioctl),
638 HL_IOCTL_DEF(HL_IOCTL_MEMORY, hl_mem_ioctl),
639 HL_IOCTL_DEF(HL_IOCTL_DEBUG, hl_debug_ioctl)
642 static const struct hl_ioctl_desc hl_ioctls_control[] = {
643 HL_IOCTL_DEF(HL_IOCTL_INFO, hl_info_ioctl_control)
646 static long _hl_ioctl(struct file *filep, unsigned int cmd, unsigned long arg,
647 const struct hl_ioctl_desc *ioctl, struct device *dev)
649 struct hl_fpriv *hpriv = filep->private_data;
650 struct hl_device *hdev = hpriv->hdev;
651 unsigned int nr = _IOC_NR(cmd);
652 char stack_kdata[128] = {0};
654 unsigned int usize, asize;
659 if (hdev->hard_reset_pending) {
660 dev_crit_ratelimited(dev,
661 "Device HARD reset pending! Please close FD\n");
665 /* Do not trust userspace, use our own definition */
668 if (unlikely(!func)) {
669 dev_dbg(dev, "no function\n");
674 hl_size = _IOC_SIZE(ioctl->cmd);
675 usize = asize = _IOC_SIZE(cmd);
681 if (cmd & (IOC_IN | IOC_OUT)) {
682 if (asize <= sizeof(stack_kdata)) {
685 kdata = kzalloc(asize, GFP_KERNEL);
694 if (copy_from_user(kdata, (void __user *)arg, usize)) {
698 } else if (cmd & IOC_OUT) {
699 memset(kdata, 0, usize);
702 retcode = func(hpriv, kdata);
704 if ((cmd & IOC_OUT) && copy_to_user((void __user *)arg, kdata, usize))
709 dev_dbg(dev, "error in ioctl: pid=%d, cmd=0x%02x, nr=0x%02x\n",
710 task_pid_nr(current), cmd, nr);
712 if (kdata != stack_kdata)
718 long hl_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)
720 struct hl_fpriv *hpriv = filep->private_data;
721 struct hl_device *hdev = hpriv->hdev;
722 const struct hl_ioctl_desc *ioctl = NULL;
723 unsigned int nr = _IOC_NR(cmd);
726 pr_err_ratelimited("Sending ioctl after device was removed! Please close FD\n");
730 if ((nr >= HL_COMMAND_START) && (nr < HL_COMMAND_END)) {
731 ioctl = &hl_ioctls[nr];
733 dev_err(hdev->dev, "invalid ioctl: pid=%d, nr=0x%02x\n",
734 task_pid_nr(current), nr);
738 return _hl_ioctl(filep, cmd, arg, ioctl, hdev->dev);
741 long hl_ioctl_control(struct file *filep, unsigned int cmd, unsigned long arg)
743 struct hl_fpriv *hpriv = filep->private_data;
744 struct hl_device *hdev = hpriv->hdev;
745 const struct hl_ioctl_desc *ioctl = NULL;
746 unsigned int nr = _IOC_NR(cmd);
749 pr_err_ratelimited("Sending ioctl after device was removed! Please close FD\n");
753 if (nr == _IOC_NR(HL_IOCTL_INFO)) {
754 ioctl = &hl_ioctls_control[nr];
756 dev_err(hdev->dev_ctrl, "invalid ioctl: pid=%d, nr=0x%02x\n",
757 task_pid_nr(current), nr);
761 return _hl_ioctl(filep, cmd, arg, ioctl, hdev->dev_ctrl);