Merge remote-tracking branch 'asoc/for-5.7' into asoc-linus
[linux-2.6-microblaze.git] / drivers / crypto / caam / jr.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * CAAM/SEC 4.x transport/backend driver
4  * JobR backend functionality
5  *
6  * Copyright 2008-2012 Freescale Semiconductor, Inc.
7  * Copyright 2019 NXP
8  */
9
10 #include <linux/of_irq.h>
11 #include <linux/of_address.h>
12
13 #include "compat.h"
14 #include "ctrl.h"
15 #include "regs.h"
16 #include "jr.h"
17 #include "desc.h"
18 #include "intern.h"
19
20 struct jr_driver_data {
21         /* List of Physical JobR's with the Driver */
22         struct list_head        jr_list;
23         spinlock_t              jr_alloc_lock;  /* jr_list lock */
24 } ____cacheline_aligned;
25
26 static struct jr_driver_data driver_data;
27 static DEFINE_MUTEX(algs_lock);
28 static unsigned int active_devs;
29
30 static void register_algs(struct caam_drv_private_jr *jrpriv,
31                           struct device *dev)
32 {
33         mutex_lock(&algs_lock);
34
35         if (++active_devs != 1)
36                 goto algs_unlock;
37
38         caam_algapi_init(dev);
39         caam_algapi_hash_init(dev);
40         caam_pkc_init(dev);
41         jrpriv->hwrng = !caam_rng_init(dev);
42         caam_qi_algapi_init(dev);
43
44 algs_unlock:
45         mutex_unlock(&algs_lock);
46 }
47
48 static void unregister_algs(void)
49 {
50         mutex_lock(&algs_lock);
51
52         if (--active_devs != 0)
53                 goto algs_unlock;
54
55         caam_qi_algapi_exit();
56
57         caam_pkc_exit();
58         caam_algapi_hash_exit();
59         caam_algapi_exit();
60
61 algs_unlock:
62         mutex_unlock(&algs_lock);
63 }
64
65 static void caam_jr_crypto_engine_exit(void *data)
66 {
67         struct device *jrdev = data;
68         struct caam_drv_private_jr *jrpriv = dev_get_drvdata(jrdev);
69
70         /* Free the resources of crypto-engine */
71         crypto_engine_exit(jrpriv->engine);
72 }
73
74 static int caam_reset_hw_jr(struct device *dev)
75 {
76         struct caam_drv_private_jr *jrp = dev_get_drvdata(dev);
77         unsigned int timeout = 100000;
78
79         /*
80          * mask interrupts since we are going to poll
81          * for reset completion status
82          */
83         clrsetbits_32(&jrp->rregs->rconfig_lo, 0, JRCFG_IMSK);
84
85         /* initiate flush (required prior to reset) */
86         wr_reg32(&jrp->rregs->jrcommand, JRCR_RESET);
87         while (((rd_reg32(&jrp->rregs->jrintstatus) & JRINT_ERR_HALT_MASK) ==
88                 JRINT_ERR_HALT_INPROGRESS) && --timeout)
89                 cpu_relax();
90
91         if ((rd_reg32(&jrp->rregs->jrintstatus) & JRINT_ERR_HALT_MASK) !=
92             JRINT_ERR_HALT_COMPLETE || timeout == 0) {
93                 dev_err(dev, "failed to flush job ring %d\n", jrp->ridx);
94                 return -EIO;
95         }
96
97         /* initiate reset */
98         timeout = 100000;
99         wr_reg32(&jrp->rregs->jrcommand, JRCR_RESET);
100         while ((rd_reg32(&jrp->rregs->jrcommand) & JRCR_RESET) && --timeout)
101                 cpu_relax();
102
103         if (timeout == 0) {
104                 dev_err(dev, "failed to reset job ring %d\n", jrp->ridx);
105                 return -EIO;
106         }
107
108         /* unmask interrupts */
109         clrsetbits_32(&jrp->rregs->rconfig_lo, JRCFG_IMSK, 0);
110
111         return 0;
112 }
113
114 /*
115  * Shutdown JobR independent of platform property code
116  */
117 static int caam_jr_shutdown(struct device *dev)
118 {
119         struct caam_drv_private_jr *jrp = dev_get_drvdata(dev);
120         int ret;
121
122         ret = caam_reset_hw_jr(dev);
123
124         tasklet_kill(&jrp->irqtask);
125
126         return ret;
127 }
128
129 static int caam_jr_remove(struct platform_device *pdev)
130 {
131         int ret;
132         struct device *jrdev;
133         struct caam_drv_private_jr *jrpriv;
134
135         jrdev = &pdev->dev;
136         jrpriv = dev_get_drvdata(jrdev);
137
138         if (jrpriv->hwrng)
139                 caam_rng_exit(jrdev->parent);
140
141         /*
142          * Return EBUSY if job ring already allocated.
143          */
144         if (atomic_read(&jrpriv->tfm_count)) {
145                 dev_err(jrdev, "Device is busy\n");
146                 return -EBUSY;
147         }
148
149         /* Unregister JR-based RNG & crypto algorithms */
150         unregister_algs();
151
152         /* Remove the node from Physical JobR list maintained by driver */
153         spin_lock(&driver_data.jr_alloc_lock);
154         list_del(&jrpriv->list_node);
155         spin_unlock(&driver_data.jr_alloc_lock);
156
157         /* Release ring */
158         ret = caam_jr_shutdown(jrdev);
159         if (ret)
160                 dev_err(jrdev, "Failed to shut down job ring\n");
161
162         return ret;
163 }
164
165 /* Main per-ring interrupt handler */
166 static irqreturn_t caam_jr_interrupt(int irq, void *st_dev)
167 {
168         struct device *dev = st_dev;
169         struct caam_drv_private_jr *jrp = dev_get_drvdata(dev);
170         u32 irqstate;
171
172         /*
173          * Check the output ring for ready responses, kick
174          * tasklet if jobs done.
175          */
176         irqstate = rd_reg32(&jrp->rregs->jrintstatus);
177         if (!irqstate)
178                 return IRQ_NONE;
179
180         /*
181          * If JobR error, we got more development work to do
182          * Flag a bug now, but we really need to shut down and
183          * restart the queue (and fix code).
184          */
185         if (irqstate & JRINT_JR_ERROR) {
186                 dev_err(dev, "job ring error: irqstate: %08x\n", irqstate);
187                 BUG();
188         }
189
190         /* mask valid interrupts */
191         clrsetbits_32(&jrp->rregs->rconfig_lo, 0, JRCFG_IMSK);
192
193         /* Have valid interrupt at this point, just ACK and trigger */
194         wr_reg32(&jrp->rregs->jrintstatus, irqstate);
195
196         preempt_disable();
197         tasklet_schedule(&jrp->irqtask);
198         preempt_enable();
199
200         return IRQ_HANDLED;
201 }
202
203 /* Deferred service handler, run as interrupt-fired tasklet */
204 static void caam_jr_dequeue(unsigned long devarg)
205 {
206         int hw_idx, sw_idx, i, head, tail;
207         struct device *dev = (struct device *)devarg;
208         struct caam_drv_private_jr *jrp = dev_get_drvdata(dev);
209         void (*usercall)(struct device *dev, u32 *desc, u32 status, void *arg);
210         u32 *userdesc, userstatus;
211         void *userarg;
212         u32 outring_used = 0;
213
214         while (outring_used ||
215                (outring_used = rd_reg32(&jrp->rregs->outring_used))) {
216
217                 head = READ_ONCE(jrp->head);
218
219                 sw_idx = tail = jrp->tail;
220                 hw_idx = jrp->out_ring_read_index;
221
222                 for (i = 0; CIRC_CNT(head, tail + i, JOBR_DEPTH) >= 1; i++) {
223                         sw_idx = (tail + i) & (JOBR_DEPTH - 1);
224
225                         if (jr_outentry_desc(jrp->outring, hw_idx) ==
226                             caam_dma_to_cpu(jrp->entinfo[sw_idx].desc_addr_dma))
227                                 break; /* found */
228                 }
229                 /* we should never fail to find a matching descriptor */
230                 BUG_ON(CIRC_CNT(head, tail + i, JOBR_DEPTH) <= 0);
231
232                 /* Unmap just-run descriptor so we can post-process */
233                 dma_unmap_single(dev,
234                                  caam_dma_to_cpu(jr_outentry_desc(jrp->outring,
235                                                                   hw_idx)),
236                                  jrp->entinfo[sw_idx].desc_size,
237                                  DMA_TO_DEVICE);
238
239                 /* mark completed, avoid matching on a recycled desc addr */
240                 jrp->entinfo[sw_idx].desc_addr_dma = 0;
241
242                 /* Stash callback params */
243                 usercall = jrp->entinfo[sw_idx].callbk;
244                 userarg = jrp->entinfo[sw_idx].cbkarg;
245                 userdesc = jrp->entinfo[sw_idx].desc_addr_virt;
246                 userstatus = caam32_to_cpu(jr_outentry_jrstatus(jrp->outring,
247                                                                 hw_idx));
248
249                 /*
250                  * Make sure all information from the job has been obtained
251                  * before telling CAAM that the job has been removed from the
252                  * output ring.
253                  */
254                 mb();
255
256                 /* set done */
257                 wr_reg32(&jrp->rregs->outring_rmvd, 1);
258
259                 jrp->out_ring_read_index = (jrp->out_ring_read_index + 1) &
260                                            (JOBR_DEPTH - 1);
261
262                 /*
263                  * if this job completed out-of-order, do not increment
264                  * the tail.  Otherwise, increment tail by 1 plus the
265                  * number of subsequent jobs already completed out-of-order
266                  */
267                 if (sw_idx == tail) {
268                         do {
269                                 tail = (tail + 1) & (JOBR_DEPTH - 1);
270                         } while (CIRC_CNT(head, tail, JOBR_DEPTH) >= 1 &&
271                                  jrp->entinfo[tail].desc_addr_dma == 0);
272
273                         jrp->tail = tail;
274                 }
275
276                 /* Finally, execute user's callback */
277                 usercall(dev, userdesc, userstatus, userarg);
278                 outring_used--;
279         }
280
281         /* reenable / unmask IRQs */
282         clrsetbits_32(&jrp->rregs->rconfig_lo, JRCFG_IMSK, 0);
283 }
284
285 /**
286  * caam_jr_alloc() - Alloc a job ring for someone to use as needed.
287  *
288  * returns :  pointer to the newly allocated physical
289  *            JobR dev can be written to if successful.
290  **/
291 struct device *caam_jr_alloc(void)
292 {
293         struct caam_drv_private_jr *jrpriv, *min_jrpriv = NULL;
294         struct device *dev = ERR_PTR(-ENODEV);
295         int min_tfm_cnt = INT_MAX;
296         int tfm_cnt;
297
298         spin_lock(&driver_data.jr_alloc_lock);
299
300         if (list_empty(&driver_data.jr_list)) {
301                 spin_unlock(&driver_data.jr_alloc_lock);
302                 return ERR_PTR(-ENODEV);
303         }
304
305         list_for_each_entry(jrpriv, &driver_data.jr_list, list_node) {
306                 tfm_cnt = atomic_read(&jrpriv->tfm_count);
307                 if (tfm_cnt < min_tfm_cnt) {
308                         min_tfm_cnt = tfm_cnt;
309                         min_jrpriv = jrpriv;
310                 }
311                 if (!min_tfm_cnt)
312                         break;
313         }
314
315         if (min_jrpriv) {
316                 atomic_inc(&min_jrpriv->tfm_count);
317                 dev = min_jrpriv->dev;
318         }
319         spin_unlock(&driver_data.jr_alloc_lock);
320
321         return dev;
322 }
323 EXPORT_SYMBOL(caam_jr_alloc);
324
325 /**
326  * caam_jr_free() - Free the Job Ring
327  * @rdev     - points to the dev that identifies the Job ring to
328  *             be released.
329  **/
330 void caam_jr_free(struct device *rdev)
331 {
332         struct caam_drv_private_jr *jrpriv = dev_get_drvdata(rdev);
333
334         atomic_dec(&jrpriv->tfm_count);
335 }
336 EXPORT_SYMBOL(caam_jr_free);
337
338 /**
339  * caam_jr_enqueue() - Enqueue a job descriptor head. Returns -EINPROGRESS
340  * if OK, -ENOSPC if the queue is full, -EIO if it cannot map the caller's
341  * descriptor.
342  * @dev:  device of the job ring to be used. This device should have
343  *        been assigned prior by caam_jr_register().
344  * @desc: points to a job descriptor that execute our request. All
345  *        descriptors (and all referenced data) must be in a DMAable
346  *        region, and all data references must be physical addresses
347  *        accessible to CAAM (i.e. within a PAMU window granted
348  *        to it).
349  * @cbk:  pointer to a callback function to be invoked upon completion
350  *        of this request. This has the form:
351  *        callback(struct device *dev, u32 *desc, u32 stat, void *arg)
352  *        where:
353  *        @dev:    contains the job ring device that processed this
354  *                 response.
355  *        @desc:   descriptor that initiated the request, same as
356  *                 "desc" being argued to caam_jr_enqueue().
357  *        @status: untranslated status received from CAAM. See the
358  *                 reference manual for a detailed description of
359  *                 error meaning, or see the JRSTA definitions in the
360  *                 register header file
361  *        @areq:   optional pointer to an argument passed with the
362  *                 original request
363  * @areq: optional pointer to a user argument for use at callback
364  *        time.
365  **/
366 int caam_jr_enqueue(struct device *dev, u32 *desc,
367                     void (*cbk)(struct device *dev, u32 *desc,
368                                 u32 status, void *areq),
369                     void *areq)
370 {
371         struct caam_drv_private_jr *jrp = dev_get_drvdata(dev);
372         struct caam_jrentry_info *head_entry;
373         int head, tail, desc_size;
374         dma_addr_t desc_dma;
375
376         desc_size = (caam32_to_cpu(*desc) & HDR_JD_LENGTH_MASK) * sizeof(u32);
377         desc_dma = dma_map_single(dev, desc, desc_size, DMA_TO_DEVICE);
378         if (dma_mapping_error(dev, desc_dma)) {
379                 dev_err(dev, "caam_jr_enqueue(): can't map jobdesc\n");
380                 return -EIO;
381         }
382
383         spin_lock_bh(&jrp->inplock);
384
385         head = jrp->head;
386         tail = READ_ONCE(jrp->tail);
387
388         if (!jrp->inpring_avail ||
389             CIRC_SPACE(head, tail, JOBR_DEPTH) <= 0) {
390                 spin_unlock_bh(&jrp->inplock);
391                 dma_unmap_single(dev, desc_dma, desc_size, DMA_TO_DEVICE);
392                 return -ENOSPC;
393         }
394
395         head_entry = &jrp->entinfo[head];
396         head_entry->desc_addr_virt = desc;
397         head_entry->desc_size = desc_size;
398         head_entry->callbk = (void *)cbk;
399         head_entry->cbkarg = areq;
400         head_entry->desc_addr_dma = desc_dma;
401
402         jr_inpentry_set(jrp->inpring, head, cpu_to_caam_dma(desc_dma));
403
404         /*
405          * Guarantee that the descriptor's DMA address has been written to
406          * the next slot in the ring before the write index is updated, since
407          * other cores may update this index independently.
408          */
409         smp_wmb();
410
411         jrp->head = (head + 1) & (JOBR_DEPTH - 1);
412
413         /*
414          * Ensure that all job information has been written before
415          * notifying CAAM that a new job was added to the input ring
416          * using a memory barrier. The wr_reg32() uses api iowrite32()
417          * to do the register write. iowrite32() issues a memory barrier
418          * before the write operation.
419          */
420
421         wr_reg32(&jrp->rregs->inpring_jobadd, 1);
422
423         jrp->inpring_avail--;
424         if (!jrp->inpring_avail)
425                 jrp->inpring_avail = rd_reg32(&jrp->rregs->inpring_avail);
426
427         spin_unlock_bh(&jrp->inplock);
428
429         return -EINPROGRESS;
430 }
431 EXPORT_SYMBOL(caam_jr_enqueue);
432
433 /*
434  * Init JobR independent of platform property detection
435  */
436 static int caam_jr_init(struct device *dev)
437 {
438         struct caam_drv_private_jr *jrp;
439         dma_addr_t inpbusaddr, outbusaddr;
440         int i, error;
441
442         jrp = dev_get_drvdata(dev);
443
444         error = caam_reset_hw_jr(dev);
445         if (error)
446                 return error;
447
448         jrp->inpring = dmam_alloc_coherent(dev, SIZEOF_JR_INPENTRY *
449                                            JOBR_DEPTH, &inpbusaddr,
450                                            GFP_KERNEL);
451         if (!jrp->inpring)
452                 return -ENOMEM;
453
454         jrp->outring = dmam_alloc_coherent(dev, SIZEOF_JR_OUTENTRY *
455                                            JOBR_DEPTH, &outbusaddr,
456                                            GFP_KERNEL);
457         if (!jrp->outring)
458                 return -ENOMEM;
459
460         jrp->entinfo = devm_kcalloc(dev, JOBR_DEPTH, sizeof(*jrp->entinfo),
461                                     GFP_KERNEL);
462         if (!jrp->entinfo)
463                 return -ENOMEM;
464
465         for (i = 0; i < JOBR_DEPTH; i++)
466                 jrp->entinfo[i].desc_addr_dma = !0;
467
468         /* Setup rings */
469         jrp->out_ring_read_index = 0;
470         jrp->head = 0;
471         jrp->tail = 0;
472
473         wr_reg64(&jrp->rregs->inpring_base, inpbusaddr);
474         wr_reg64(&jrp->rregs->outring_base, outbusaddr);
475         wr_reg32(&jrp->rregs->inpring_size, JOBR_DEPTH);
476         wr_reg32(&jrp->rregs->outring_size, JOBR_DEPTH);
477
478         jrp->inpring_avail = JOBR_DEPTH;
479
480         spin_lock_init(&jrp->inplock);
481
482         /* Select interrupt coalescing parameters */
483         clrsetbits_32(&jrp->rregs->rconfig_lo, 0, JOBR_INTC |
484                       (JOBR_INTC_COUNT_THLD << JRCFG_ICDCT_SHIFT) |
485                       (JOBR_INTC_TIME_THLD << JRCFG_ICTT_SHIFT));
486
487         tasklet_init(&jrp->irqtask, caam_jr_dequeue, (unsigned long)dev);
488
489         /* Connect job ring interrupt handler. */
490         error = devm_request_irq(dev, jrp->irq, caam_jr_interrupt, IRQF_SHARED,
491                                  dev_name(dev), dev);
492         if (error) {
493                 dev_err(dev, "can't connect JobR %d interrupt (%d)\n",
494                         jrp->ridx, jrp->irq);
495                 tasklet_kill(&jrp->irqtask);
496         }
497
498         return error;
499 }
500
501 static void caam_jr_irq_dispose_mapping(void *data)
502 {
503         irq_dispose_mapping((unsigned long)data);
504 }
505
506 /*
507  * Probe routine for each detected JobR subsystem.
508  */
509 static int caam_jr_probe(struct platform_device *pdev)
510 {
511         struct device *jrdev;
512         struct device_node *nprop;
513         struct caam_job_ring __iomem *ctrl;
514         struct caam_drv_private_jr *jrpriv;
515         static int total_jobrs;
516         struct resource *r;
517         int error;
518
519         jrdev = &pdev->dev;
520         jrpriv = devm_kzalloc(jrdev, sizeof(*jrpriv), GFP_KERNEL);
521         if (!jrpriv)
522                 return -ENOMEM;
523
524         dev_set_drvdata(jrdev, jrpriv);
525
526         /* save ring identity relative to detection */
527         jrpriv->ridx = total_jobrs++;
528
529         nprop = pdev->dev.of_node;
530         /* Get configuration properties from device tree */
531         /* First, get register page */
532         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
533         if (!r) {
534                 dev_err(jrdev, "platform_get_resource() failed\n");
535                 return -ENOMEM;
536         }
537
538         ctrl = devm_ioremap(jrdev, r->start, resource_size(r));
539         if (!ctrl) {
540                 dev_err(jrdev, "devm_ioremap() failed\n");
541                 return -ENOMEM;
542         }
543
544         jrpriv->rregs = (struct caam_job_ring __iomem __force *)ctrl;
545
546         error = dma_set_mask_and_coherent(jrdev, caam_get_dma_mask(jrdev));
547         if (error) {
548                 dev_err(jrdev, "dma_set_mask_and_coherent failed (%d)\n",
549                         error);
550                 return error;
551         }
552
553         /* Initialize crypto engine */
554         jrpriv->engine = crypto_engine_alloc_init(jrdev, false);
555         if (!jrpriv->engine) {
556                 dev_err(jrdev, "Could not init crypto-engine\n");
557                 return -ENOMEM;
558         }
559
560         error = devm_add_action_or_reset(jrdev, caam_jr_crypto_engine_exit,
561                                          jrdev);
562         if (error)
563                 return error;
564
565         /* Start crypto engine */
566         error = crypto_engine_start(jrpriv->engine);
567         if (error) {
568                 dev_err(jrdev, "Could not start crypto-engine\n");
569                 return error;
570         }
571
572         /* Identify the interrupt */
573         jrpriv->irq = irq_of_parse_and_map(nprop, 0);
574         if (!jrpriv->irq) {
575                 dev_err(jrdev, "irq_of_parse_and_map failed\n");
576                 return -EINVAL;
577         }
578
579         error = devm_add_action_or_reset(jrdev, caam_jr_irq_dispose_mapping,
580                                          (void *)(unsigned long)jrpriv->irq);
581         if (error)
582                 return error;
583
584         /* Now do the platform independent part */
585         error = caam_jr_init(jrdev); /* now turn on hardware */
586         if (error)
587                 return error;
588
589         jrpriv->dev = jrdev;
590         spin_lock(&driver_data.jr_alloc_lock);
591         list_add_tail(&jrpriv->list_node, &driver_data.jr_list);
592         spin_unlock(&driver_data.jr_alloc_lock);
593
594         atomic_set(&jrpriv->tfm_count, 0);
595
596         register_algs(jrpriv, jrdev->parent);
597
598         return 0;
599 }
600
601 static const struct of_device_id caam_jr_match[] = {
602         {
603                 .compatible = "fsl,sec-v4.0-job-ring",
604         },
605         {
606                 .compatible = "fsl,sec4.0-job-ring",
607         },
608         {},
609 };
610 MODULE_DEVICE_TABLE(of, caam_jr_match);
611
612 static struct platform_driver caam_jr_driver = {
613         .driver = {
614                 .name = "caam_jr",
615                 .of_match_table = caam_jr_match,
616         },
617         .probe       = caam_jr_probe,
618         .remove      = caam_jr_remove,
619 };
620
621 static int __init jr_driver_init(void)
622 {
623         spin_lock_init(&driver_data.jr_alloc_lock);
624         INIT_LIST_HEAD(&driver_data.jr_list);
625         return platform_driver_register(&caam_jr_driver);
626 }
627
628 static void __exit jr_driver_exit(void)
629 {
630         platform_driver_unregister(&caam_jr_driver);
631 }
632
633 module_init(jr_driver_init);
634 module_exit(jr_driver_exit);
635
636 MODULE_LICENSE("GPL");
637 MODULE_DESCRIPTION("FSL CAAM JR request backend");
638 MODULE_AUTHOR("Freescale Semiconductor - NMG/STC");