1 // SPDX-License-Identifier: GPL-2.0
4 * Copyright 2016-2019 HabanaLabs, Ltd.
8 #include <uapi/misc/habanalabs.h>
9 #include "habanalabs.h"
11 #include <linux/kernel.h>
13 #include <linux/uaccess.h>
14 #include <linux/slab.h>
16 static u32 hl_debug_struct_size[HL_DEBUG_OP_TIMESTAMP + 1] = {
17 [HL_DEBUG_OP_ETR] = sizeof(struct hl_debug_params_etr),
18 [HL_DEBUG_OP_ETF] = sizeof(struct hl_debug_params_etf),
19 [HL_DEBUG_OP_STM] = sizeof(struct hl_debug_params_stm),
20 [HL_DEBUG_OP_FUNNEL] = 0,
21 [HL_DEBUG_OP_BMON] = sizeof(struct hl_debug_params_bmon),
22 [HL_DEBUG_OP_SPMU] = sizeof(struct hl_debug_params_spmu),
23 [HL_DEBUG_OP_TIMESTAMP] = 0
27 static int device_status_info(struct hl_device *hdev, struct hl_info_args *args)
29 struct hl_info_device_status dev_stat = {0};
30 u32 size = args->return_size;
31 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
33 if ((!size) || (!out))
36 dev_stat.status = hl_device_status(hdev);
38 return copy_to_user(out, &dev_stat,
39 min((size_t)size, sizeof(dev_stat))) ? -EFAULT : 0;
42 static int hw_ip_info(struct hl_device *hdev, struct hl_info_args *args)
44 struct hl_info_hw_ip_info hw_ip = {0};
45 u32 size = args->return_size;
46 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
47 struct asic_fixed_properties *prop = &hdev->asic_prop;
48 u64 sram_kmd_size, dram_kmd_size;
50 if ((!size) || (!out))
53 sram_kmd_size = (prop->sram_user_base_address -
54 prop->sram_base_address);
55 dram_kmd_size = (prop->dram_user_base_address -
56 prop->dram_base_address);
58 hw_ip.device_id = hdev->asic_funcs->get_pci_id(hdev);
59 hw_ip.sram_base_address = prop->sram_user_base_address;
60 hw_ip.dram_base_address = prop->dram_user_base_address;
61 hw_ip.tpc_enabled_mask = prop->tpc_enabled_mask;
62 hw_ip.sram_size = prop->sram_size - sram_kmd_size;
63 hw_ip.dram_size = prop->dram_size - dram_kmd_size;
64 if (hw_ip.dram_size > PAGE_SIZE)
65 hw_ip.dram_enabled = 1;
66 hw_ip.num_of_events = prop->num_of_events;
68 memcpy(hw_ip.cpucp_version, prop->cpucp_info.cpucp_version,
69 min(VERSION_MAX_LEN, HL_INFO_VERSION_MAX_LEN));
71 memcpy(hw_ip.card_name, prop->cpucp_info.card_name,
72 min(CARD_NAME_MAX_LEN, HL_INFO_CARD_NAME_MAX_LEN));
74 hw_ip.cpld_version = le32_to_cpu(prop->cpucp_info.cpld_version);
75 hw_ip.module_id = le32_to_cpu(prop->cpucp_info.card_location);
77 hw_ip.psoc_pci_pll_nr = prop->psoc_pci_pll_nr;
78 hw_ip.psoc_pci_pll_nf = prop->psoc_pci_pll_nf;
79 hw_ip.psoc_pci_pll_od = prop->psoc_pci_pll_od;
80 hw_ip.psoc_pci_pll_div_factor = prop->psoc_pci_pll_div_factor;
82 return copy_to_user(out, &hw_ip,
83 min((size_t)size, sizeof(hw_ip))) ? -EFAULT : 0;
86 static int hw_events_info(struct hl_device *hdev, bool aggregate,
87 struct hl_info_args *args)
89 u32 size, max_size = args->return_size;
90 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
93 if ((!max_size) || (!out))
96 arr = hdev->asic_funcs->get_events_stat(hdev, aggregate, &size);
98 return copy_to_user(out, arr, min(max_size, size)) ? -EFAULT : 0;
101 static int dram_usage_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
103 struct hl_device *hdev = hpriv->hdev;
104 struct hl_info_dram_usage dram_usage = {0};
105 u32 max_size = args->return_size;
106 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
107 struct asic_fixed_properties *prop = &hdev->asic_prop;
110 if ((!max_size) || (!out))
113 dram_kmd_size = (prop->dram_user_base_address -
114 prop->dram_base_address);
115 dram_usage.dram_free_mem = (prop->dram_size - dram_kmd_size) -
116 atomic64_read(&hdev->dram_used_mem);
118 dram_usage.ctx_dram_mem =
119 atomic64_read(&hpriv->ctx->dram_phys_mem);
121 return copy_to_user(out, &dram_usage,
122 min((size_t) max_size, sizeof(dram_usage))) ? -EFAULT : 0;
125 static int hw_idle(struct hl_device *hdev, struct hl_info_args *args)
127 struct hl_info_hw_idle hw_idle = {0};
128 u32 max_size = args->return_size;
129 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
131 if ((!max_size) || (!out))
134 hw_idle.is_idle = hdev->asic_funcs->is_device_idle(hdev,
135 &hw_idle.busy_engines_mask_ext, NULL);
136 hw_idle.busy_engines_mask =
137 lower_32_bits(hw_idle.busy_engines_mask_ext);
139 return copy_to_user(out, &hw_idle,
140 min((size_t) max_size, sizeof(hw_idle))) ? -EFAULT : 0;
143 static int debug_coresight(struct hl_device *hdev, struct hl_debug_args *args)
145 struct hl_debug_params *params;
146 void *input = NULL, *output = NULL;
149 params = kzalloc(sizeof(*params), GFP_KERNEL);
153 params->reg_idx = args->reg_idx;
154 params->enable = args->enable;
155 params->op = args->op;
157 if (args->input_ptr && args->input_size) {
158 input = kzalloc(hl_debug_struct_size[args->op], GFP_KERNEL);
164 if (copy_from_user(input, u64_to_user_ptr(args->input_ptr),
167 dev_err(hdev->dev, "failed to copy input debug data\n");
171 params->input = input;
174 if (args->output_ptr && args->output_size) {
175 output = kzalloc(args->output_size, GFP_KERNEL);
181 params->output = output;
182 params->output_size = args->output_size;
185 rc = hdev->asic_funcs->debug_coresight(hdev, params);
188 "debug coresight operation failed %d\n", rc);
192 if (output && copy_to_user((void __user *) (uintptr_t) args->output_ptr,
193 output, args->output_size)) {
194 dev_err(hdev->dev, "copy to user failed in debug ioctl\n");
208 static int device_utilization(struct hl_device *hdev, struct hl_info_args *args)
210 struct hl_info_device_utilization device_util = {0};
211 u32 max_size = args->return_size;
212 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
214 if ((!max_size) || (!out))
217 if ((args->period_ms < 100) || (args->period_ms > 1000) ||
218 (args->period_ms % 100)) {
220 "period %u must be between 100 - 1000 and must be divisible by 100\n",
225 device_util.utilization = hl_device_utilization(hdev, args->period_ms);
227 return copy_to_user(out, &device_util,
228 min((size_t) max_size, sizeof(device_util))) ? -EFAULT : 0;
231 static int get_clk_rate(struct hl_device *hdev, struct hl_info_args *args)
233 struct hl_info_clk_rate clk_rate = {0};
234 u32 max_size = args->return_size;
235 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
238 if ((!max_size) || (!out))
241 rc = hdev->asic_funcs->get_clk_rate(hdev, &clk_rate.cur_clk_rate_mhz,
242 &clk_rate.max_clk_rate_mhz);
246 return copy_to_user(out, &clk_rate,
247 min((size_t) max_size, sizeof(clk_rate))) ? -EFAULT : 0;
250 static int get_reset_count(struct hl_device *hdev, struct hl_info_args *args)
252 struct hl_info_reset_count reset_count = {0};
253 u32 max_size = args->return_size;
254 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
256 if ((!max_size) || (!out))
259 reset_count.hard_reset_cnt = hdev->hard_reset_cnt;
260 reset_count.soft_reset_cnt = hdev->soft_reset_cnt;
262 return copy_to_user(out, &reset_count,
263 min((size_t) max_size, sizeof(reset_count))) ? -EFAULT : 0;
266 static int time_sync_info(struct hl_device *hdev, struct hl_info_args *args)
268 struct hl_info_time_sync time_sync = {0};
269 u32 max_size = args->return_size;
270 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
272 if ((!max_size) || (!out))
275 time_sync.device_time = hdev->asic_funcs->get_device_time(hdev);
276 time_sync.host_time = ktime_get_raw_ns();
278 return copy_to_user(out, &time_sync,
279 min((size_t) max_size, sizeof(time_sync))) ? -EFAULT : 0;
282 static int pci_counters_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
284 struct hl_device *hdev = hpriv->hdev;
285 struct hl_info_pci_counters pci_counters = {0};
286 u32 max_size = args->return_size;
287 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
290 if ((!max_size) || (!out))
293 rc = hl_fw_cpucp_pci_counters_get(hdev, &pci_counters);
297 return copy_to_user(out, &pci_counters,
298 min((size_t) max_size, sizeof(pci_counters))) ? -EFAULT : 0;
301 static int clk_throttle_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
303 struct hl_device *hdev = hpriv->hdev;
304 struct hl_info_clk_throttle clk_throttle = {0};
305 u32 max_size = args->return_size;
306 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
308 if ((!max_size) || (!out))
311 clk_throttle.clk_throttling_reason = hdev->clk_throttling_reason;
313 return copy_to_user(out, &clk_throttle,
314 min((size_t) max_size, sizeof(clk_throttle))) ? -EFAULT : 0;
317 static int cs_counters_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
319 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
320 struct hl_info_cs_counters cs_counters = {0};
321 struct hl_device *hdev = hpriv->hdev;
322 struct hl_cs_counters_atomic *cntr;
323 u32 max_size = args->return_size;
325 cntr = &hdev->aggregated_cs_counters;
327 if ((!max_size) || (!out))
330 cs_counters.total_out_of_mem_drop_cnt =
331 atomic64_read(&cntr->out_of_mem_drop_cnt);
332 cs_counters.total_parsing_drop_cnt =
333 atomic64_read(&cntr->parsing_drop_cnt);
334 cs_counters.total_queue_full_drop_cnt =
335 atomic64_read(&cntr->queue_full_drop_cnt);
336 cs_counters.total_device_in_reset_drop_cnt =
337 atomic64_read(&cntr->device_in_reset_drop_cnt);
338 cs_counters.total_max_cs_in_flight_drop_cnt =
339 atomic64_read(&cntr->max_cs_in_flight_drop_cnt);
340 cs_counters.total_validation_drop_cnt =
341 atomic64_read(&cntr->validation_drop_cnt);
344 cs_counters.ctx_out_of_mem_drop_cnt =
346 &hpriv->ctx->cs_counters.out_of_mem_drop_cnt);
347 cs_counters.ctx_parsing_drop_cnt =
349 &hpriv->ctx->cs_counters.parsing_drop_cnt);
350 cs_counters.ctx_queue_full_drop_cnt =
352 &hpriv->ctx->cs_counters.queue_full_drop_cnt);
353 cs_counters.ctx_device_in_reset_drop_cnt =
355 &hpriv->ctx->cs_counters.device_in_reset_drop_cnt);
356 cs_counters.ctx_max_cs_in_flight_drop_cnt =
358 &hpriv->ctx->cs_counters.max_cs_in_flight_drop_cnt);
359 cs_counters.ctx_validation_drop_cnt =
361 &hpriv->ctx->cs_counters.validation_drop_cnt);
364 return copy_to_user(out, &cs_counters,
365 min((size_t) max_size, sizeof(cs_counters))) ? -EFAULT : 0;
368 static int sync_manager_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
370 struct hl_device *hdev = hpriv->hdev;
371 struct asic_fixed_properties *prop = &hdev->asic_prop;
372 struct hl_info_sync_manager sm_info = {0};
373 u32 max_size = args->return_size;
374 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
376 if ((!max_size) || (!out))
379 if (args->dcore_id >= HL_MAX_DCORES)
382 sm_info.first_available_sync_object =
383 prop->first_available_user_sob[args->dcore_id];
384 sm_info.first_available_monitor =
385 prop->first_available_user_mon[args->dcore_id];
388 return copy_to_user(out, &sm_info, min_t(size_t, (size_t) max_size,
389 sizeof(sm_info))) ? -EFAULT : 0;
392 static int total_energy_consumption_info(struct hl_fpriv *hpriv,
393 struct hl_info_args *args)
395 struct hl_device *hdev = hpriv->hdev;
396 struct hl_info_energy total_energy = {0};
397 u32 max_size = args->return_size;
398 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
401 if ((!max_size) || (!out))
404 rc = hl_fw_cpucp_total_energy_get(hdev,
405 &total_energy.total_energy_consumption);
409 return copy_to_user(out, &total_energy,
410 min((size_t) max_size, sizeof(total_energy))) ? -EFAULT : 0;
413 static int pll_frequency_info(struct hl_fpriv *hpriv, struct hl_info_args *args)
415 struct hl_device *hdev = hpriv->hdev;
416 struct hl_pll_frequency_info freq_info = { {0} };
417 u32 max_size = args->return_size;
418 void __user *out = (void __user *) (uintptr_t) args->return_pointer;
421 if ((!max_size) || (!out))
424 rc = hl_fw_cpucp_pll_info_get(hdev, args->pll_index, freq_info.output);
428 return copy_to_user(out, &freq_info,
429 min((size_t) max_size, sizeof(freq_info))) ? -EFAULT : 0;
432 static int _hl_info_ioctl(struct hl_fpriv *hpriv, void *data,
435 enum hl_device_status status;
436 struct hl_info_args *args = data;
437 struct hl_device *hdev = hpriv->hdev;
442 * Information is returned for the following opcodes even if the device
443 * is disabled or in reset.
446 case HL_INFO_HW_IP_INFO:
447 return hw_ip_info(hdev, args);
449 case HL_INFO_DEVICE_STATUS:
450 return device_status_info(hdev, args);
452 case HL_INFO_RESET_COUNT:
453 return get_reset_count(hdev, args);
459 if (!hl_device_operational(hdev, &status)) {
460 dev_warn_ratelimited(dev,
461 "Device is %s. Can't execute INFO IOCTL\n",
462 hdev->status[status]);
467 case HL_INFO_HW_EVENTS:
468 rc = hw_events_info(hdev, false, args);
471 case HL_INFO_DRAM_USAGE:
472 rc = dram_usage_info(hpriv, args);
475 case HL_INFO_HW_IDLE:
476 rc = hw_idle(hdev, args);
479 case HL_INFO_DEVICE_UTILIZATION:
480 rc = device_utilization(hdev, args);
483 case HL_INFO_HW_EVENTS_AGGREGATE:
484 rc = hw_events_info(hdev, true, args);
487 case HL_INFO_CLK_RATE:
488 rc = get_clk_rate(hdev, args);
491 case HL_INFO_TIME_SYNC:
492 return time_sync_info(hdev, args);
494 case HL_INFO_CS_COUNTERS:
495 return cs_counters_info(hpriv, args);
497 case HL_INFO_PCI_COUNTERS:
498 return pci_counters_info(hpriv, args);
500 case HL_INFO_CLK_THROTTLE_REASON:
501 return clk_throttle_info(hpriv, args);
503 case HL_INFO_SYNC_MANAGER:
504 return sync_manager_info(hpriv, args);
506 case HL_INFO_TOTAL_ENERGY:
507 return total_energy_consumption_info(hpriv, args);
509 case HL_INFO_PLL_FREQUENCY:
510 return pll_frequency_info(hpriv, args);
513 dev_err(dev, "Invalid request %d\n", args->op);
521 static int hl_info_ioctl(struct hl_fpriv *hpriv, void *data)
523 return _hl_info_ioctl(hpriv, data, hpriv->hdev->dev);
526 static int hl_info_ioctl_control(struct hl_fpriv *hpriv, void *data)
528 return _hl_info_ioctl(hpriv, data, hpriv->hdev->dev_ctrl);
531 static int hl_debug_ioctl(struct hl_fpriv *hpriv, void *data)
533 struct hl_debug_args *args = data;
534 struct hl_device *hdev = hpriv->hdev;
535 enum hl_device_status status;
539 if (!hl_device_operational(hdev, &status)) {
540 dev_warn_ratelimited(hdev->dev,
541 "Device is %s. Can't execute DEBUG IOCTL\n",
542 hdev->status[status]);
547 case HL_DEBUG_OP_ETR:
548 case HL_DEBUG_OP_ETF:
549 case HL_DEBUG_OP_STM:
550 case HL_DEBUG_OP_FUNNEL:
551 case HL_DEBUG_OP_BMON:
552 case HL_DEBUG_OP_SPMU:
553 case HL_DEBUG_OP_TIMESTAMP:
554 if (!hdev->in_debug) {
555 dev_err_ratelimited(hdev->dev,
556 "Rejecting debug configuration request because device not in debug mode\n");
560 min(args->input_size, hl_debug_struct_size[args->op]);
561 rc = debug_coresight(hdev, args);
563 case HL_DEBUG_OP_SET_MODE:
564 rc = hl_device_set_debug_mode(hdev, (bool) args->enable);
567 dev_err(hdev->dev, "Invalid request %d\n", args->op);
575 #define HL_IOCTL_DEF(ioctl, _func) \
576 [_IOC_NR(ioctl)] = {.cmd = ioctl, .func = _func}
578 static const struct hl_ioctl_desc hl_ioctls[] = {
579 HL_IOCTL_DEF(HL_IOCTL_INFO, hl_info_ioctl),
580 HL_IOCTL_DEF(HL_IOCTL_CB, hl_cb_ioctl),
581 HL_IOCTL_DEF(HL_IOCTL_CS, hl_cs_ioctl),
582 HL_IOCTL_DEF(HL_IOCTL_WAIT_CS, hl_cs_wait_ioctl),
583 HL_IOCTL_DEF(HL_IOCTL_MEMORY, hl_mem_ioctl),
584 HL_IOCTL_DEF(HL_IOCTL_DEBUG, hl_debug_ioctl)
587 static const struct hl_ioctl_desc hl_ioctls_control[] = {
588 HL_IOCTL_DEF(HL_IOCTL_INFO, hl_info_ioctl_control)
591 static long _hl_ioctl(struct file *filep, unsigned int cmd, unsigned long arg,
592 const struct hl_ioctl_desc *ioctl, struct device *dev)
594 struct hl_fpriv *hpriv = filep->private_data;
595 struct hl_device *hdev = hpriv->hdev;
596 unsigned int nr = _IOC_NR(cmd);
597 char stack_kdata[128] = {0};
599 unsigned int usize, asize;
604 if (hdev->hard_reset_pending) {
605 dev_crit_ratelimited(dev,
606 "Device HARD reset pending! Please close FD\n");
610 /* Do not trust userspace, use our own definition */
613 if (unlikely(!func)) {
614 dev_dbg(dev, "no function\n");
619 hl_size = _IOC_SIZE(ioctl->cmd);
620 usize = asize = _IOC_SIZE(cmd);
626 if (cmd & (IOC_IN | IOC_OUT)) {
627 if (asize <= sizeof(stack_kdata)) {
630 kdata = kzalloc(asize, GFP_KERNEL);
639 if (copy_from_user(kdata, (void __user *)arg, usize)) {
643 } else if (cmd & IOC_OUT) {
644 memset(kdata, 0, usize);
647 retcode = func(hpriv, kdata);
649 if ((cmd & IOC_OUT) && copy_to_user((void __user *)arg, kdata, usize))
654 dev_dbg(dev, "error in ioctl: pid=%d, cmd=0x%02x, nr=0x%02x\n",
655 task_pid_nr(current), cmd, nr);
657 if (kdata != stack_kdata)
663 long hl_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)
665 struct hl_fpriv *hpriv = filep->private_data;
666 struct hl_device *hdev = hpriv->hdev;
667 const struct hl_ioctl_desc *ioctl = NULL;
668 unsigned int nr = _IOC_NR(cmd);
670 if ((nr >= HL_COMMAND_START) && (nr < HL_COMMAND_END)) {
671 ioctl = &hl_ioctls[nr];
673 dev_err(hdev->dev, "invalid ioctl: pid=%d, nr=0x%02x\n",
674 task_pid_nr(current), nr);
678 return _hl_ioctl(filep, cmd, arg, ioctl, hdev->dev);
681 long hl_ioctl_control(struct file *filep, unsigned int cmd, unsigned long arg)
683 struct hl_fpriv *hpriv = filep->private_data;
684 struct hl_device *hdev = hpriv->hdev;
685 const struct hl_ioctl_desc *ioctl = NULL;
686 unsigned int nr = _IOC_NR(cmd);
688 if (nr == _IOC_NR(HL_IOCTL_INFO)) {
689 ioctl = &hl_ioctls_control[nr];
691 dev_err(hdev->dev_ctrl, "invalid ioctl: pid=%d, nr=0x%02x\n",
692 task_pid_nr(current), nr);
696 return _hl_ioctl(filep, cmd, arg, ioctl, hdev->dev_ctrl);