Merge tag 'armsoc-soc' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[linux-2.6-microblaze.git] / drivers / misc / habanalabs / hw_queue.c
1 // SPDX-License-Identifier: GPL-2.0
2
3 /*
4  * Copyright 2016-2019 HabanaLabs, Ltd.
5  * All Rights Reserved.
6  */
7
8 #include "habanalabs.h"
9
10 #include <linux/slab.h>
11
12 /*
13  * hl_queue_add_ptr - add to pi or ci and checks if it wraps around
14  *
15  * @ptr: the current pi/ci value
16  * @val: the amount to add
17  *
18  * Add val to ptr. It can go until twice the queue length.
19  */
20 inline u32 hl_hw_queue_add_ptr(u32 ptr, u16 val)
21 {
22         ptr += val;
23         ptr &= ((HL_QUEUE_LENGTH << 1) - 1);
24         return ptr;
25 }
26
27 static inline int queue_free_slots(struct hl_hw_queue *q, u32 queue_len)
28 {
29         int delta = (q->pi - q->ci);
30
31         if (delta >= 0)
32                 return (queue_len - delta);
33         else
34                 return (abs(delta) - queue_len);
35 }
36
37 void hl_int_hw_queue_update_ci(struct hl_cs *cs)
38 {
39         struct hl_device *hdev = cs->ctx->hdev;
40         struct hl_hw_queue *q;
41         int i;
42
43         hdev->asic_funcs->hw_queues_lock(hdev);
44
45         if (hdev->disabled)
46                 goto out;
47
48         q = &hdev->kernel_queues[0];
49         for (i = 0 ; i < HL_MAX_QUEUES ; i++, q++) {
50                 if (q->queue_type == QUEUE_TYPE_INT) {
51                         q->ci += cs->jobs_in_queue_cnt[i];
52                         q->ci &= ((q->int_queue_len << 1) - 1);
53                 }
54         }
55
56 out:
57         hdev->asic_funcs->hw_queues_unlock(hdev);
58 }
59
60 /*
61  * ext_queue_submit_bd - Submit a buffer descriptor to an external queue
62  *
63  * @hdev: pointer to habanalabs device structure
64  * @q: pointer to habanalabs queue structure
65  * @ctl: BD's control word
66  * @len: BD's length
67  * @ptr: BD's pointer
68  *
69  * This function assumes there is enough space on the queue to submit a new
70  * BD to it. It initializes the next BD and calls the device specific
71  * function to set the pi (and doorbell)
72  *
73  * This function must be called when the scheduler mutex is taken
74  *
75  */
76 static void ext_queue_submit_bd(struct hl_device *hdev, struct hl_hw_queue *q,
77                                 u32 ctl, u32 len, u64 ptr)
78 {
79         struct hl_bd *bd;
80
81         bd = (struct hl_bd *) (uintptr_t) q->kernel_address;
82         bd += hl_pi_2_offset(q->pi);
83         bd->ctl = __cpu_to_le32(ctl);
84         bd->len = __cpu_to_le32(len);
85         bd->ptr = __cpu_to_le64(ptr);
86
87         q->pi = hl_queue_inc_ptr(q->pi);
88         hdev->asic_funcs->ring_doorbell(hdev, q->hw_queue_id, q->pi);
89 }
90
91 /*
92  * ext_queue_sanity_checks - perform some sanity checks on external queue
93  *
94  * @hdev              : pointer to hl_device structure
95  * @q                 : pointer to hl_hw_queue structure
96  * @num_of_entries    : how many entries to check for space
97  * @reserve_cq_entry  : whether to reserve an entry in the cq
98  *
99  * H/W queues spinlock should be taken before calling this function
100  *
101  * Perform the following:
102  * - Make sure we have enough space in the h/w queue
103  * - Make sure we have enough space in the completion queue
104  * - Reserve space in the completion queue (needs to be reversed if there
105  *   is a failure down the road before the actual submission of work). Only
106  *   do this action if reserve_cq_entry is true
107  *
108  */
109 static int ext_queue_sanity_checks(struct hl_device *hdev,
110                                 struct hl_hw_queue *q, int num_of_entries,
111                                 bool reserve_cq_entry)
112 {
113         atomic_t *free_slots =
114                         &hdev->completion_queue[q->hw_queue_id].free_slots_cnt;
115         int free_slots_cnt;
116
117         /* Check we have enough space in the queue */
118         free_slots_cnt = queue_free_slots(q, HL_QUEUE_LENGTH);
119
120         if (free_slots_cnt < num_of_entries) {
121                 dev_dbg(hdev->dev, "Queue %d doesn't have room for %d CBs\n",
122                         q->hw_queue_id, num_of_entries);
123                 return -EAGAIN;
124         }
125
126         if (reserve_cq_entry) {
127                 /*
128                  * Check we have enough space in the completion queue
129                  * Add -1 to counter (decrement) unless counter was already 0
130                  * In that case, CQ is full so we can't submit a new CB because
131                  * we won't get ack on its completion
132                  * atomic_add_unless will return 0 if counter was already 0
133                  */
134                 if (atomic_add_negative(num_of_entries * -1, free_slots)) {
135                         dev_dbg(hdev->dev, "No space for %d on CQ %d\n",
136                                 num_of_entries, q->hw_queue_id);
137                         atomic_add(num_of_entries, free_slots);
138                         return -EAGAIN;
139                 }
140         }
141
142         return 0;
143 }
144
145 /*
146  * int_queue_sanity_checks - perform some sanity checks on internal queue
147  *
148  * @hdev              : pointer to hl_device structure
149  * @q                 : pointer to hl_hw_queue structure
150  * @num_of_entries    : how many entries to check for space
151  *
152  * H/W queues spinlock should be taken before calling this function
153  *
154  * Perform the following:
155  * - Make sure we have enough space in the h/w queue
156  *
157  */
158 static int int_queue_sanity_checks(struct hl_device *hdev,
159                                         struct hl_hw_queue *q,
160                                         int num_of_entries)
161 {
162         int free_slots_cnt;
163
164         /* Check we have enough space in the queue */
165         free_slots_cnt = queue_free_slots(q, q->int_queue_len);
166
167         if (free_slots_cnt < num_of_entries) {
168                 dev_dbg(hdev->dev, "Queue %d doesn't have room for %d CBs\n",
169                         q->hw_queue_id, num_of_entries);
170                 return -EAGAIN;
171         }
172
173         return 0;
174 }
175
176 /*
177  * hl_hw_queue_send_cb_no_cmpl - send a single CB (not a JOB) without completion
178  *
179  * @hdev: pointer to hl_device structure
180  * @hw_queue_id: Queue's type
181  * @cb_size: size of CB
182  * @cb_ptr: pointer to CB location
183  *
184  * This function sends a single CB, that must NOT generate a completion entry
185  *
186  */
187 int hl_hw_queue_send_cb_no_cmpl(struct hl_device *hdev, u32 hw_queue_id,
188                                 u32 cb_size, u64 cb_ptr)
189 {
190         struct hl_hw_queue *q = &hdev->kernel_queues[hw_queue_id];
191         int rc;
192
193         /*
194          * The CPU queue is a synchronous queue with an effective depth of
195          * a single entry (although it is allocated with room for multiple
196          * entries). Therefore, there is a different lock, called
197          * send_cpu_message_lock, that serializes accesses to the CPU queue.
198          * As a result, we don't need to lock the access to the entire H/W
199          * queues module when submitting a JOB to the CPU queue
200          */
201         if (q->queue_type != QUEUE_TYPE_CPU)
202                 hdev->asic_funcs->hw_queues_lock(hdev);
203
204         if (hdev->disabled) {
205                 rc = -EPERM;
206                 goto out;
207         }
208
209         rc = ext_queue_sanity_checks(hdev, q, 1, false);
210         if (rc)
211                 goto out;
212
213         ext_queue_submit_bd(hdev, q, 0, cb_size, cb_ptr);
214
215 out:
216         if (q->queue_type != QUEUE_TYPE_CPU)
217                 hdev->asic_funcs->hw_queues_unlock(hdev);
218
219         return rc;
220 }
221
222 /*
223  * ext_hw_queue_schedule_job - submit an JOB to an external queue
224  *
225  * @job: pointer to the job that needs to be submitted to the queue
226  *
227  * This function must be called when the scheduler mutex is taken
228  *
229  */
230 static void ext_hw_queue_schedule_job(struct hl_cs_job *job)
231 {
232         struct hl_device *hdev = job->cs->ctx->hdev;
233         struct hl_hw_queue *q = &hdev->kernel_queues[job->hw_queue_id];
234         struct hl_cq_entry cq_pkt;
235         struct hl_cq *cq;
236         u64 cq_addr;
237         struct hl_cb *cb;
238         u32 ctl;
239         u32 len;
240         u64 ptr;
241
242         /*
243          * Update the JOB ID inside the BD CTL so the device would know what
244          * to write in the completion queue
245          */
246         ctl = ((q->pi << BD_CTL_SHADOW_INDEX_SHIFT) & BD_CTL_SHADOW_INDEX_MASK);
247
248         cb = job->patched_cb;
249         len = job->job_cb_size;
250         ptr = cb->bus_address;
251
252         cq_pkt.data = __cpu_to_le32(
253                                 ((q->pi << CQ_ENTRY_SHADOW_INDEX_SHIFT)
254                                         & CQ_ENTRY_SHADOW_INDEX_MASK) |
255                                 (1 << CQ_ENTRY_SHADOW_INDEX_VALID_SHIFT) |
256                                 (1 << CQ_ENTRY_READY_SHIFT));
257
258         /*
259          * No need to protect pi_offset because scheduling to the
260          * H/W queues is done under the scheduler mutex
261          *
262          * No need to check if CQ is full because it was already
263          * checked in hl_queue_sanity_checks
264          */
265         cq = &hdev->completion_queue[q->hw_queue_id];
266         cq_addr = cq->bus_address + cq->pi * sizeof(struct hl_cq_entry);
267
268         hdev->asic_funcs->add_end_of_cb_packets(hdev, cb->kernel_address, len,
269                                                 cq_addr,
270                                                 __le32_to_cpu(cq_pkt.data),
271                                                 q->hw_queue_id);
272
273         q->shadow_queue[hl_pi_2_offset(q->pi)] = job;
274
275         cq->pi = hl_cq_inc_ptr(cq->pi);
276
277         ext_queue_submit_bd(hdev, q, ctl, len, ptr);
278 }
279
280 /*
281  * int_hw_queue_schedule_job - submit an JOB to an internal queue
282  *
283  * @job: pointer to the job that needs to be submitted to the queue
284  *
285  * This function must be called when the scheduler mutex is taken
286  *
287  */
288 static void int_hw_queue_schedule_job(struct hl_cs_job *job)
289 {
290         struct hl_device *hdev = job->cs->ctx->hdev;
291         struct hl_hw_queue *q = &hdev->kernel_queues[job->hw_queue_id];
292         struct hl_bd bd;
293         __le64 *pi;
294
295         bd.ctl = 0;
296         bd.len = cpu_to_le32(job->job_cb_size);
297         bd.ptr = cpu_to_le64((u64) (uintptr_t) job->user_cb);
298
299         pi = (__le64 *) (uintptr_t) (q->kernel_address +
300                 ((q->pi & (q->int_queue_len - 1)) * sizeof(bd)));
301
302         q->pi++;
303         q->pi &= ((q->int_queue_len << 1) - 1);
304
305         hdev->asic_funcs->pqe_write(hdev, pi, &bd);
306
307         hdev->asic_funcs->ring_doorbell(hdev, q->hw_queue_id, q->pi);
308 }
309
310 /*
311  * hl_hw_queue_schedule_cs - schedule a command submission
312  *
313  * @job        : pointer to the CS
314  *
315  */
316 int hl_hw_queue_schedule_cs(struct hl_cs *cs)
317 {
318         struct hl_device *hdev = cs->ctx->hdev;
319         struct hl_cs_job *job, *tmp;
320         struct hl_hw_queue *q;
321         int rc = 0, i, cq_cnt;
322
323         hdev->asic_funcs->hw_queues_lock(hdev);
324
325         if (hl_device_disabled_or_in_reset(hdev)) {
326                 dev_err(hdev->dev,
327                         "device is disabled or in reset, CS rejected!\n");
328                 rc = -EPERM;
329                 goto out;
330         }
331
332         q = &hdev->kernel_queues[0];
333         /* This loop assumes all external queues are consecutive */
334         for (i = 0, cq_cnt = 0 ; i < HL_MAX_QUEUES ; i++, q++) {
335                 if (q->queue_type == QUEUE_TYPE_EXT) {
336                         if (cs->jobs_in_queue_cnt[i]) {
337                                 rc = ext_queue_sanity_checks(hdev, q,
338                                         cs->jobs_in_queue_cnt[i], true);
339                                 if (rc)
340                                         goto unroll_cq_resv;
341                                 cq_cnt++;
342                         }
343                 } else if (q->queue_type == QUEUE_TYPE_INT) {
344                         if (cs->jobs_in_queue_cnt[i]) {
345                                 rc = int_queue_sanity_checks(hdev, q,
346                                         cs->jobs_in_queue_cnt[i]);
347                                 if (rc)
348                                         goto unroll_cq_resv;
349                         }
350                 }
351         }
352
353         spin_lock(&hdev->hw_queues_mirror_lock);
354         list_add_tail(&cs->mirror_node, &hdev->hw_queues_mirror_list);
355
356         /* Queue TDR if the CS is the first entry and if timeout is wanted */
357         if ((hdev->timeout_jiffies != MAX_SCHEDULE_TIMEOUT) &&
358                         (list_first_entry(&hdev->hw_queues_mirror_list,
359                                         struct hl_cs, mirror_node) == cs)) {
360                 cs->tdr_active = true;
361                 schedule_delayed_work(&cs->work_tdr, hdev->timeout_jiffies);
362                 spin_unlock(&hdev->hw_queues_mirror_lock);
363         } else {
364                 spin_unlock(&hdev->hw_queues_mirror_lock);
365         }
366
367         atomic_inc(&hdev->cs_active_cnt);
368
369         list_for_each_entry_safe(job, tmp, &cs->job_list, cs_node)
370                 if (job->ext_queue)
371                         ext_hw_queue_schedule_job(job);
372                 else
373                         int_hw_queue_schedule_job(job);
374
375         cs->submitted = true;
376
377         goto out;
378
379 unroll_cq_resv:
380         /* This loop assumes all external queues are consecutive */
381         q = &hdev->kernel_queues[0];
382         for (i = 0 ; (i < HL_MAX_QUEUES) && (cq_cnt > 0) ; i++, q++) {
383                 if ((q->queue_type == QUEUE_TYPE_EXT) &&
384                                 (cs->jobs_in_queue_cnt[i])) {
385                         atomic_t *free_slots =
386                                 &hdev->completion_queue[i].free_slots_cnt;
387                         atomic_add(cs->jobs_in_queue_cnt[i], free_slots);
388                         cq_cnt--;
389                 }
390         }
391
392 out:
393         hdev->asic_funcs->hw_queues_unlock(hdev);
394
395         return rc;
396 }
397
398 /*
399  * hl_hw_queue_inc_ci_kernel - increment ci for kernel's queue
400  *
401  * @hdev: pointer to hl_device structure
402  * @hw_queue_id: which queue to increment its ci
403  */
404 void hl_hw_queue_inc_ci_kernel(struct hl_device *hdev, u32 hw_queue_id)
405 {
406         struct hl_hw_queue *q = &hdev->kernel_queues[hw_queue_id];
407
408         q->ci = hl_queue_inc_ptr(q->ci);
409 }
410
411 static int ext_and_cpu_hw_queue_init(struct hl_device *hdev,
412                                 struct hl_hw_queue *q, bool is_cpu_queue)
413 {
414         void *p;
415         int rc;
416
417         if (is_cpu_queue)
418                 p = hdev->asic_funcs->cpu_accessible_dma_pool_alloc(hdev,
419                                                         HL_QUEUE_SIZE_IN_BYTES,
420                                                         &q->bus_address);
421         else
422                 p = hdev->asic_funcs->asic_dma_alloc_coherent(hdev,
423                                                 HL_QUEUE_SIZE_IN_BYTES,
424                                                 &q->bus_address,
425                                                 GFP_KERNEL | __GFP_ZERO);
426         if (!p)
427                 return -ENOMEM;
428
429         q->kernel_address = (u64) (uintptr_t) p;
430
431         q->shadow_queue = kmalloc_array(HL_QUEUE_LENGTH,
432                                         sizeof(*q->shadow_queue),
433                                         GFP_KERNEL);
434         if (!q->shadow_queue) {
435                 dev_err(hdev->dev,
436                         "Failed to allocate shadow queue for H/W queue %d\n",
437                         q->hw_queue_id);
438                 rc = -ENOMEM;
439                 goto free_queue;
440         }
441
442         /* Make sure read/write pointers are initialized to start of queue */
443         q->ci = 0;
444         q->pi = 0;
445
446         return 0;
447
448 free_queue:
449         if (is_cpu_queue)
450                 hdev->asic_funcs->cpu_accessible_dma_pool_free(hdev,
451                                         HL_QUEUE_SIZE_IN_BYTES,
452                                         (void *) (uintptr_t) q->kernel_address);
453         else
454                 hdev->asic_funcs->asic_dma_free_coherent(hdev,
455                                         HL_QUEUE_SIZE_IN_BYTES,
456                                         (void *) (uintptr_t) q->kernel_address,
457                                         q->bus_address);
458
459         return rc;
460 }
461
462 static int int_hw_queue_init(struct hl_device *hdev, struct hl_hw_queue *q)
463 {
464         void *p;
465
466         p = hdev->asic_funcs->get_int_queue_base(hdev, q->hw_queue_id,
467                                         &q->bus_address, &q->int_queue_len);
468         if (!p) {
469                 dev_err(hdev->dev,
470                         "Failed to get base address for internal queue %d\n",
471                         q->hw_queue_id);
472                 return -EFAULT;
473         }
474
475         q->kernel_address = (u64) (uintptr_t) p;
476         q->pi = 0;
477         q->ci = 0;
478
479         return 0;
480 }
481
482 static int cpu_hw_queue_init(struct hl_device *hdev, struct hl_hw_queue *q)
483 {
484         return ext_and_cpu_hw_queue_init(hdev, q, true);
485 }
486
487 static int ext_hw_queue_init(struct hl_device *hdev, struct hl_hw_queue *q)
488 {
489         return ext_and_cpu_hw_queue_init(hdev, q, false);
490 }
491
492 /*
493  * hw_queue_init - main initialization function for H/W queue object
494  *
495  * @hdev: pointer to hl_device device structure
496  * @q: pointer to hl_hw_queue queue structure
497  * @hw_queue_id: The id of the H/W queue
498  *
499  * Allocate dma-able memory for the queue and initialize fields
500  * Returns 0 on success
501  */
502 static int hw_queue_init(struct hl_device *hdev, struct hl_hw_queue *q,
503                         u32 hw_queue_id)
504 {
505         int rc;
506
507         BUILD_BUG_ON(HL_QUEUE_SIZE_IN_BYTES > HL_PAGE_SIZE);
508
509         q->hw_queue_id = hw_queue_id;
510
511         switch (q->queue_type) {
512         case QUEUE_TYPE_EXT:
513                 rc = ext_hw_queue_init(hdev, q);
514                 break;
515
516         case QUEUE_TYPE_INT:
517                 rc = int_hw_queue_init(hdev, q);
518                 break;
519
520         case QUEUE_TYPE_CPU:
521                 rc = cpu_hw_queue_init(hdev, q);
522                 break;
523
524         case QUEUE_TYPE_NA:
525                 q->valid = 0;
526                 return 0;
527
528         default:
529                 dev_crit(hdev->dev, "wrong queue type %d during init\n",
530                         q->queue_type);
531                 rc = -EINVAL;
532                 break;
533         }
534
535         if (rc)
536                 return rc;
537
538         q->valid = 1;
539
540         return 0;
541 }
542
543 /*
544  * hw_queue_fini - destroy queue
545  *
546  * @hdev: pointer to hl_device device structure
547  * @q: pointer to hl_hw_queue queue structure
548  *
549  * Free the queue memory
550  */
551 static void hw_queue_fini(struct hl_device *hdev, struct hl_hw_queue *q)
552 {
553         if (!q->valid)
554                 return;
555
556         /*
557          * If we arrived here, there are no jobs waiting on this queue
558          * so we can safely remove it.
559          * This is because this function can only called when:
560          * 1. Either a context is deleted, which only can occur if all its
561          *    jobs were finished
562          * 2. A context wasn't able to be created due to failure or timeout,
563          *    which means there are no jobs on the queue yet
564          *
565          * The only exception are the queues of the kernel context, but
566          * if they are being destroyed, it means that the entire module is
567          * being removed. If the module is removed, it means there is no open
568          * user context. It also means that if a job was submitted by
569          * the kernel driver (e.g. context creation), the job itself was
570          * released by the kernel driver when a timeout occurred on its
571          * Completion. Thus, we don't need to release it again.
572          */
573
574         if (q->queue_type == QUEUE_TYPE_INT)
575                 return;
576
577         kfree(q->shadow_queue);
578
579         if (q->queue_type == QUEUE_TYPE_CPU)
580                 hdev->asic_funcs->cpu_accessible_dma_pool_free(hdev,
581                                         HL_QUEUE_SIZE_IN_BYTES,
582                                         (void *) (uintptr_t) q->kernel_address);
583         else
584                 hdev->asic_funcs->asic_dma_free_coherent(hdev,
585                                         HL_QUEUE_SIZE_IN_BYTES,
586                                         (void *) (uintptr_t) q->kernel_address,
587                                         q->bus_address);
588 }
589
590 int hl_hw_queues_create(struct hl_device *hdev)
591 {
592         struct asic_fixed_properties *asic = &hdev->asic_prop;
593         struct hl_hw_queue *q;
594         int i, rc, q_ready_cnt;
595
596         hdev->kernel_queues = kcalloc(HL_MAX_QUEUES,
597                                 sizeof(*hdev->kernel_queues), GFP_KERNEL);
598
599         if (!hdev->kernel_queues) {
600                 dev_err(hdev->dev, "Not enough memory for H/W queues\n");
601                 return -ENOMEM;
602         }
603
604         /* Initialize the H/W queues */
605         for (i = 0, q_ready_cnt = 0, q = hdev->kernel_queues;
606                         i < HL_MAX_QUEUES ; i++, q_ready_cnt++, q++) {
607
608                 q->queue_type = asic->hw_queues_props[i].type;
609                 rc = hw_queue_init(hdev, q, i);
610                 if (rc) {
611                         dev_err(hdev->dev,
612                                 "failed to initialize queue %d\n", i);
613                         goto release_queues;
614                 }
615         }
616
617         return 0;
618
619 release_queues:
620         for (i = 0, q = hdev->kernel_queues ; i < q_ready_cnt ; i++, q++)
621                 hw_queue_fini(hdev, q);
622
623         kfree(hdev->kernel_queues);
624
625         return rc;
626 }
627
628 void hl_hw_queues_destroy(struct hl_device *hdev)
629 {
630         struct hl_hw_queue *q;
631         int i;
632
633         for (i = 0, q = hdev->kernel_queues ; i < HL_MAX_QUEUES ; i++, q++)
634                 hw_queue_fini(hdev, q);
635
636         kfree(hdev->kernel_queues);
637 }
638
639 void hl_hw_queue_reset(struct hl_device *hdev, bool hard_reset)
640 {
641         struct hl_hw_queue *q;
642         int i;
643
644         for (i = 0, q = hdev->kernel_queues ; i < HL_MAX_QUEUES ; i++, q++) {
645                 if ((!q->valid) ||
646                         ((!hard_reset) && (q->queue_type == QUEUE_TYPE_CPU)))
647                         continue;
648                 q->pi = q->ci = 0;
649         }
650 }