2 * CAAM/SEC 4.x transport/backend driver
3 * JobR backend functionality
5 * Copyright 2008-2012 Freescale Semiconductor, Inc.
8 #include <linux/of_irq.h>
9 #include <linux/of_address.h>
17 struct jr_driver_data
{
18 /* List of Physical JobR's with the Driver */
19 struct list_head jr_list
;
20 spinlock_t jr_alloc_lock
; /* jr_list lock */
21 } ____cacheline_aligned
;
23 static struct jr_driver_data driver_data
;
25 static int caam_reset_hw_jr(struct device
*dev
)
27 struct caam_drv_private_jr
*jrp
= dev_get_drvdata(dev
);
28 unsigned int timeout
= 100000;
31 * mask interrupts since we are going to poll
32 * for reset completion status
34 setbits32(&jrp
->rregs
->rconfig_lo
, JRCFG_IMSK
);
36 /* initiate flush (required prior to reset) */
37 wr_reg32(&jrp
->rregs
->jrcommand
, JRCR_RESET
);
38 while (((rd_reg32(&jrp
->rregs
->jrintstatus
) & JRINT_ERR_HALT_MASK
) ==
39 JRINT_ERR_HALT_INPROGRESS
) && --timeout
)
42 if ((rd_reg32(&jrp
->rregs
->jrintstatus
) & JRINT_ERR_HALT_MASK
) !=
43 JRINT_ERR_HALT_COMPLETE
|| timeout
== 0) {
44 dev_err(dev
, "failed to flush job ring %d\n", jrp
->ridx
);
50 wr_reg32(&jrp
->rregs
->jrcommand
, JRCR_RESET
);
51 while ((rd_reg32(&jrp
->rregs
->jrcommand
) & JRCR_RESET
) && --timeout
)
55 dev_err(dev
, "failed to reset job ring %d\n", jrp
->ridx
);
59 /* unmask interrupts */
60 clrbits32(&jrp
->rregs
->rconfig_lo
, JRCFG_IMSK
);
66 * Shutdown JobR independent of platform property code
68 int caam_jr_shutdown(struct device
*dev
)
70 struct caam_drv_private_jr
*jrp
= dev_get_drvdata(dev
);
71 dma_addr_t inpbusaddr
, outbusaddr
;
74 ret
= caam_reset_hw_jr(dev
);
76 tasklet_kill(&jrp
->irqtask
);
78 /* Release interrupt */
79 free_irq(jrp
->irq
, dev
);
82 inpbusaddr
= rd_reg64(&jrp
->rregs
->inpring_base
);
83 outbusaddr
= rd_reg64(&jrp
->rregs
->outring_base
);
84 dma_free_coherent(dev
, sizeof(dma_addr_t
) * JOBR_DEPTH
,
85 jrp
->inpring
, inpbusaddr
);
86 dma_free_coherent(dev
, sizeof(struct jr_outentry
) * JOBR_DEPTH
,
87 jrp
->outring
, outbusaddr
);
93 static int caam_jr_remove(struct platform_device
*pdev
)
97 struct caam_drv_private_jr
*jrpriv
;
100 jrpriv
= dev_get_drvdata(jrdev
);
103 * Return EBUSY if job ring already allocated.
105 if (atomic_read(&jrpriv
->tfm_count
)) {
106 dev_err(jrdev
, "Device is busy\n");
110 /* Remove the node from Physical JobR list maintained by driver */
111 spin_lock(&driver_data
.jr_alloc_lock
);
112 list_del(&jrpriv
->list_node
);
113 spin_unlock(&driver_data
.jr_alloc_lock
);
116 ret
= caam_jr_shutdown(jrdev
);
118 dev_err(jrdev
, "Failed to shut down job ring\n");
119 irq_dispose_mapping(jrpriv
->irq
);
124 /* Main per-ring interrupt handler */
125 static irqreturn_t
caam_jr_interrupt(int irq
, void *st_dev
)
127 struct device
*dev
= st_dev
;
128 struct caam_drv_private_jr
*jrp
= dev_get_drvdata(dev
);
132 * Check the output ring for ready responses, kick
133 * tasklet if jobs done.
135 irqstate
= rd_reg32(&jrp
->rregs
->jrintstatus
);
140 * If JobR error, we got more development work to do
141 * Flag a bug now, but we really need to shut down and
142 * restart the queue (and fix code).
144 if (irqstate
& JRINT_JR_ERROR
) {
145 dev_err(dev
, "job ring error: irqstate: %08x\n", irqstate
);
149 /* mask valid interrupts */
150 setbits32(&jrp
->rregs
->rconfig_lo
, JRCFG_IMSK
);
152 /* Have valid interrupt at this point, just ACK and trigger */
153 wr_reg32(&jrp
->rregs
->jrintstatus
, irqstate
);
156 tasklet_schedule(&jrp
->irqtask
);
162 /* Deferred service handler, run as interrupt-fired tasklet */
163 static void caam_jr_dequeue(unsigned long devarg
)
165 int hw_idx
, sw_idx
, i
, head
, tail
;
166 struct device
*dev
= (struct device
*)devarg
;
167 struct caam_drv_private_jr
*jrp
= dev_get_drvdata(dev
);
168 void (*usercall
)(struct device
*dev
, u32
*desc
, u32 status
, void *arg
);
169 u32
*userdesc
, userstatus
;
172 while (rd_reg32(&jrp
->rregs
->outring_used
)) {
174 head
= ACCESS_ONCE(jrp
->head
);
176 spin_lock(&jrp
->outlock
);
178 sw_idx
= tail
= jrp
->tail
;
179 hw_idx
= jrp
->out_ring_read_index
;
181 for (i
= 0; CIRC_CNT(head
, tail
+ i
, JOBR_DEPTH
) >= 1; i
++) {
182 sw_idx
= (tail
+ i
) & (JOBR_DEPTH
- 1);
184 smp_read_barrier_depends();
186 if (jrp
->outring
[hw_idx
].desc
==
187 jrp
->entinfo
[sw_idx
].desc_addr_dma
)
190 /* we should never fail to find a matching descriptor */
191 BUG_ON(CIRC_CNT(head
, tail
+ i
, JOBR_DEPTH
) <= 0);
193 /* Unmap just-run descriptor so we can post-process */
194 dma_unmap_single(dev
, jrp
->outring
[hw_idx
].desc
,
195 jrp
->entinfo
[sw_idx
].desc_size
,
198 /* mark completed, avoid matching on a recycled desc addr */
199 jrp
->entinfo
[sw_idx
].desc_addr_dma
= 0;
201 /* Stash callback params for use outside of lock */
202 usercall
= jrp
->entinfo
[sw_idx
].callbk
;
203 userarg
= jrp
->entinfo
[sw_idx
].cbkarg
;
204 userdesc
= jrp
->entinfo
[sw_idx
].desc_addr_virt
;
205 userstatus
= jrp
->outring
[hw_idx
].jrstatus
;
208 wr_reg32(&jrp
->rregs
->outring_rmvd
, 1);
210 jrp
->out_ring_read_index
= (jrp
->out_ring_read_index
+ 1) &
214 * if this job completed out-of-order, do not increment
215 * the tail. Otherwise, increment tail by 1 plus the
216 * number of subsequent jobs already completed out-of-order
218 if (sw_idx
== tail
) {
220 tail
= (tail
+ 1) & (JOBR_DEPTH
- 1);
221 smp_read_barrier_depends();
222 } while (CIRC_CNT(head
, tail
, JOBR_DEPTH
) >= 1 &&
223 jrp
->entinfo
[tail
].desc_addr_dma
== 0);
228 spin_unlock(&jrp
->outlock
);
230 /* Finally, execute user's callback */
231 usercall(dev
, userdesc
, userstatus
, userarg
);
234 /* reenable / unmask IRQs */
235 clrbits32(&jrp
->rregs
->rconfig_lo
, JRCFG_IMSK
);
239 * caam_jr_alloc() - Alloc a job ring for someone to use as needed.
241 * returns : pointer to the newly allocated physical
242 * JobR dev can be written to if successful.
244 struct device
*caam_jr_alloc(void)
246 struct caam_drv_private_jr
*jrpriv
, *min_jrpriv
= NULL
;
247 struct device
*dev
= NULL
;
248 int min_tfm_cnt
= INT_MAX
;
251 spin_lock(&driver_data
.jr_alloc_lock
);
253 if (list_empty(&driver_data
.jr_list
)) {
254 spin_unlock(&driver_data
.jr_alloc_lock
);
255 return ERR_PTR(-ENODEV
);
258 list_for_each_entry(jrpriv
, &driver_data
.jr_list
, list_node
) {
259 tfm_cnt
= atomic_read(&jrpriv
->tfm_count
);
260 if (tfm_cnt
< min_tfm_cnt
) {
261 min_tfm_cnt
= tfm_cnt
;
269 atomic_inc(&min_jrpriv
->tfm_count
);
270 dev
= min_jrpriv
->dev
;
272 spin_unlock(&driver_data
.jr_alloc_lock
);
276 EXPORT_SYMBOL(caam_jr_alloc
);
279 * caam_jr_free() - Free the Job Ring
280 * @rdev - points to the dev that identifies the Job ring to
283 void caam_jr_free(struct device
*rdev
)
285 struct caam_drv_private_jr
*jrpriv
= dev_get_drvdata(rdev
);
287 atomic_dec(&jrpriv
->tfm_count
);
289 EXPORT_SYMBOL(caam_jr_free
);
292 * caam_jr_enqueue() - Enqueue a job descriptor head. Returns 0 if OK,
293 * -EBUSY if the queue is full, -EIO if it cannot map the caller's
295 * @dev: device of the job ring to be used. This device should have
296 * been assigned prior by caam_jr_register().
297 * @desc: points to a job descriptor that execute our request. All
298 * descriptors (and all referenced data) must be in a DMAable
299 * region, and all data references must be physical addresses
300 * accessible to CAAM (i.e. within a PAMU window granted
302 * @cbk: pointer to a callback function to be invoked upon completion
303 * of this request. This has the form:
304 * callback(struct device *dev, u32 *desc, u32 stat, void *arg)
306 * @dev: contains the job ring device that processed this
308 * @desc: descriptor that initiated the request, same as
309 * "desc" being argued to caam_jr_enqueue().
310 * @status: untranslated status received from CAAM. See the
311 * reference manual for a detailed description of
312 * error meaning, or see the JRSTA definitions in the
313 * register header file
314 * @areq: optional pointer to an argument passed with the
316 * @areq: optional pointer to a user argument for use at callback
319 int caam_jr_enqueue(struct device
*dev
, u32
*desc
,
320 void (*cbk
)(struct device
*dev
, u32
*desc
,
321 u32 status
, void *areq
),
324 struct caam_drv_private_jr
*jrp
= dev_get_drvdata(dev
);
325 struct caam_jrentry_info
*head_entry
;
326 int head
, tail
, desc_size
;
329 desc_size
= (*desc
& HDR_JD_LENGTH_MASK
) * sizeof(u32
);
330 desc_dma
= dma_map_single(dev
, desc
, desc_size
, DMA_TO_DEVICE
);
331 if (dma_mapping_error(dev
, desc_dma
)) {
332 dev_err(dev
, "caam_jr_enqueue(): can't map jobdesc\n");
336 spin_lock_bh(&jrp
->inplock
);
339 tail
= ACCESS_ONCE(jrp
->tail
);
341 if (!rd_reg32(&jrp
->rregs
->inpring_avail
) ||
342 CIRC_SPACE(head
, tail
, JOBR_DEPTH
) <= 0) {
343 spin_unlock_bh(&jrp
->inplock
);
344 dma_unmap_single(dev
, desc_dma
, desc_size
, DMA_TO_DEVICE
);
348 head_entry
= &jrp
->entinfo
[head
];
349 head_entry
->desc_addr_virt
= desc
;
350 head_entry
->desc_size
= desc_size
;
351 head_entry
->callbk
= (void *)cbk
;
352 head_entry
->cbkarg
= areq
;
353 head_entry
->desc_addr_dma
= desc_dma
;
355 jrp
->inpring
[jrp
->inp_ring_write_index
] = desc_dma
;
359 jrp
->inp_ring_write_index
= (jrp
->inp_ring_write_index
+ 1) &
361 jrp
->head
= (head
+ 1) & (JOBR_DEPTH
- 1);
363 wr_reg32(&jrp
->rregs
->inpring_jobadd
, 1);
365 spin_unlock_bh(&jrp
->inplock
);
369 EXPORT_SYMBOL(caam_jr_enqueue
);
372 * Init JobR independent of platform property detection
374 static int caam_jr_init(struct device
*dev
)
376 struct caam_drv_private_jr
*jrp
;
377 dma_addr_t inpbusaddr
, outbusaddr
;
380 jrp
= dev_get_drvdata(dev
);
382 tasklet_init(&jrp
->irqtask
, caam_jr_dequeue
, (unsigned long)dev
);
384 /* Connect job ring interrupt handler. */
385 error
= request_irq(jrp
->irq
, caam_jr_interrupt
, IRQF_SHARED
,
388 dev_err(dev
, "can't connect JobR %d interrupt (%d)\n",
389 jrp
->ridx
, jrp
->irq
);
390 irq_dispose_mapping(jrp
->irq
);
395 error
= caam_reset_hw_jr(dev
);
399 jrp
->inpring
= dma_alloc_coherent(dev
, sizeof(dma_addr_t
) * JOBR_DEPTH
,
400 &inpbusaddr
, GFP_KERNEL
);
402 jrp
->outring
= dma_alloc_coherent(dev
, sizeof(struct jr_outentry
) *
403 JOBR_DEPTH
, &outbusaddr
, GFP_KERNEL
);
405 jrp
->entinfo
= kzalloc(sizeof(struct caam_jrentry_info
) * JOBR_DEPTH
,
408 if ((jrp
->inpring
== NULL
) || (jrp
->outring
== NULL
) ||
409 (jrp
->entinfo
== NULL
)) {
410 dev_err(dev
, "can't allocate job rings for %d\n",
415 for (i
= 0; i
< JOBR_DEPTH
; i
++)
416 jrp
->entinfo
[i
].desc_addr_dma
= !0;
419 jrp
->inp_ring_write_index
= 0;
420 jrp
->out_ring_read_index
= 0;
424 wr_reg64(&jrp
->rregs
->inpring_base
, inpbusaddr
);
425 wr_reg64(&jrp
->rregs
->outring_base
, outbusaddr
);
426 wr_reg32(&jrp
->rregs
->inpring_size
, JOBR_DEPTH
);
427 wr_reg32(&jrp
->rregs
->outring_size
, JOBR_DEPTH
);
429 jrp
->ringsize
= JOBR_DEPTH
;
431 spin_lock_init(&jrp
->inplock
);
432 spin_lock_init(&jrp
->outlock
);
434 /* Select interrupt coalescing parameters */
435 setbits32(&jrp
->rregs
->rconfig_lo
, JOBR_INTC
|
436 (JOBR_INTC_COUNT_THLD
<< JRCFG_ICDCT_SHIFT
) |
437 (JOBR_INTC_TIME_THLD
<< JRCFG_ICTT_SHIFT
));
444 * Probe routine for each detected JobR subsystem.
446 static int caam_jr_probe(struct platform_device
*pdev
)
448 struct device
*jrdev
;
449 struct device_node
*nprop
;
450 struct caam_job_ring __iomem
*ctrl
;
451 struct caam_drv_private_jr
*jrpriv
;
452 static int total_jobrs
;
456 jrpriv
= kmalloc(sizeof(struct caam_drv_private_jr
),
461 dev_set_drvdata(jrdev
, jrpriv
);
463 /* save ring identity relative to detection */
464 jrpriv
->ridx
= total_jobrs
++;
466 nprop
= pdev
->dev
.of_node
;
467 /* Get configuration properties from device tree */
468 /* First, get register page */
469 ctrl
= of_iomap(nprop
, 0);
471 dev_err(jrdev
, "of_iomap() failed\n");
475 jrpriv
->rregs
= (struct caam_job_ring __force
*)ctrl
;
477 if (sizeof(dma_addr_t
) == sizeof(u64
))
478 if (of_device_is_compatible(nprop
, "fsl,sec-v5.0-job-ring"))
479 dma_set_mask(jrdev
, DMA_BIT_MASK(40));
481 dma_set_mask(jrdev
, DMA_BIT_MASK(36));
483 dma_set_mask(jrdev
, DMA_BIT_MASK(32));
485 /* Identify the interrupt */
486 jrpriv
->irq
= irq_of_parse_and_map(nprop
, 0);
488 /* Now do the platform independent part */
489 error
= caam_jr_init(jrdev
); /* now turn on hardware */
496 spin_lock(&driver_data
.jr_alloc_lock
);
497 list_add_tail(&jrpriv
->list_node
, &driver_data
.jr_list
);
498 spin_unlock(&driver_data
.jr_alloc_lock
);
500 atomic_set(&jrpriv
->tfm_count
, 0);
505 static struct of_device_id caam_jr_match
[] = {
507 .compatible
= "fsl,sec-v4.0-job-ring",
510 .compatible
= "fsl,sec4.0-job-ring",
514 MODULE_DEVICE_TABLE(of
, caam_jr_match
);
516 static struct platform_driver caam_jr_driver
= {
519 .owner
= THIS_MODULE
,
520 .of_match_table
= caam_jr_match
,
522 .probe
= caam_jr_probe
,
523 .remove
= caam_jr_remove
,
526 static int __init
jr_driver_init(void)
528 spin_lock_init(&driver_data
.jr_alloc_lock
);
529 INIT_LIST_HEAD(&driver_data
.jr_list
);
530 return platform_driver_register(&caam_jr_driver
);
533 static void __exit
jr_driver_exit(void)
535 platform_driver_unregister(&caam_jr_driver
);
538 module_init(jr_driver_init
);
539 module_exit(jr_driver_exit
);
541 MODULE_LICENSE("GPL");
542 MODULE_DESCRIPTION("FSL CAAM JR request backend");
543 MODULE_AUTHOR("Freescale Semiconductor - NMG/STC");