2 * Driver for MPC52xx processor BestComm peripheral controller
5 * Copyright (C) 2006-2007 Sylvain Munaut <tnt@246tNt.com>
6 * Copyright (C) 2005 Varma Electronics Oy,
7 * ( by Andrey Volkov <avolkov@varma-el.com> )
8 * Copyright (C) 2003-2004 MontaVista, Software, Inc.
9 * ( by Dale Farnsworth <dfarnsworth@mvista.com> )
11 * This file is licensed under the terms of the GNU General Public License
12 * version 2. This program is licensed "as is" without any warranty of any
13 * kind, whether express or implied.
16 #include <linux/module.h>
17 #include <linux/kernel.h>
18 #include <linux/slab.h>
20 #include <linux/of_device.h>
21 #include <linux/of_platform.h>
24 #include <asm/mpc52xx.h>
27 #include "bestcomm_priv.h"
30 #define DRIVER_NAME "bestcomm-core"
32 /* MPC5200 device tree match tables */
33 static struct of_device_id mpc52xx_sram_ids
[] __devinitdata
= {
34 { .compatible
= "fsl,mpc5200-sram", },
35 { .compatible
= "mpc5200-sram", },
40 struct bcom_engine
*bcom_eng
= NULL
;
41 EXPORT_SYMBOL_GPL(bcom_eng
); /* needed for inline functions */
43 /* ======================================================================== */
44 /* Public and private API */
45 /* ======================================================================== */
50 bcom_task_alloc(int bd_count
, int bd_size
, int priv_size
)
53 struct bcom_task
*tsk
;
55 /* Don't try to do anything if bestcomm init failed */
59 /* Get and reserve a task num */
60 spin_lock(&bcom_eng
->lock
);
62 for (i
=0; i
<BCOM_MAX_TASKS
; i
++)
63 if (!bcom_eng
->tdt
[i
].stop
) { /* we use stop as a marker */
64 bcom_eng
->tdt
[i
].stop
= 0xfffffffful
; /* dummy addr */
69 spin_unlock(&bcom_eng
->lock
);
74 /* Allocate our structure */
75 tsk
= kzalloc(sizeof(struct bcom_task
) + priv_size
, GFP_KERNEL
);
79 tsk
->tasknum
= tasknum
;
81 tsk
->priv
= (void*)tsk
+ sizeof(struct bcom_task
);
83 /* Get IRQ of that task */
84 tsk
->irq
= irq_of_parse_and_map(bcom_eng
->ofnode
, tsk
->tasknum
);
85 if (tsk
->irq
== NO_IRQ
)
88 /* Init the BDs, if needed */
90 tsk
->cookie
= kmalloc(sizeof(void*) * bd_count
, GFP_KERNEL
);
94 tsk
->bd
= bcom_sram_alloc(bd_count
* bd_size
, 4, &tsk
->bd_pa
);
97 memset(tsk
->bd
, 0x00, bd_count
* bd_size
);
99 tsk
->num_bd
= bd_count
;
100 tsk
->bd_size
= bd_size
;
107 if (tsk
->irq
!= NO_IRQ
)
108 irq_dispose_mapping(tsk
->irq
);
109 bcom_sram_free(tsk
->bd
);
114 bcom_eng
->tdt
[tasknum
].stop
= 0;
118 EXPORT_SYMBOL_GPL(bcom_task_alloc
);
121 bcom_task_free(struct bcom_task
*tsk
)
124 bcom_disable_task(tsk
->tasknum
);
127 bcom_eng
->tdt
[tsk
->tasknum
].start
= 0;
128 bcom_eng
->tdt
[tsk
->tasknum
].stop
= 0;
130 /* Free everything */
131 irq_dispose_mapping(tsk
->irq
);
132 bcom_sram_free(tsk
->bd
);
136 EXPORT_SYMBOL_GPL(bcom_task_free
);
139 bcom_load_image(int task
, u32
*task_image
)
141 struct bcom_task_header
*hdr
= (struct bcom_task_header
*)task_image
;
142 struct bcom_tdt
*tdt
;
143 u32
*desc
, *var
, *inc
;
144 u32
*desc_src
, *var_src
, *inc_src
;
147 if (hdr
->magic
!= BCOM_TASK_MAGIC
) {
148 printk(KERN_ERR DRIVER_NAME
149 ": Trying to load invalid microcode\n");
153 if ((task
< 0) || (task
>= BCOM_MAX_TASKS
)) {
154 printk(KERN_ERR DRIVER_NAME
155 ": Trying to load invalid task %d\n", task
);
159 /* Initial load or reload */
160 tdt
= &bcom_eng
->tdt
[task
];
163 desc
= bcom_task_desc(task
);
164 if (hdr
->desc_size
!= bcom_task_num_descs(task
)) {
165 printk(KERN_ERR DRIVER_NAME
166 ": Trying to reload wrong task image "
167 "(%d size %d/%d)!\n",
170 bcom_task_num_descs(task
));
174 phys_addr_t start_pa
;
176 desc
= bcom_sram_alloc(hdr
->desc_size
* sizeof(u32
), 4, &start_pa
);
180 tdt
->start
= start_pa
;
181 tdt
->stop
= start_pa
+ ((hdr
->desc_size
-1) * sizeof(u32
));
184 var
= bcom_task_var(task
);
185 inc
= bcom_task_inc(task
);
188 memset(var
, 0x00, BCOM_VAR_SIZE
);
189 memset(inc
, 0x00, BCOM_INC_SIZE
);
191 desc_src
= (u32
*)(hdr
+ 1);
192 var_src
= desc_src
+ hdr
->desc_size
;
193 inc_src
= var_src
+ hdr
->var_size
;
195 memcpy(desc
, desc_src
, hdr
->desc_size
* sizeof(u32
));
196 memcpy(var
+ hdr
->first_var
, var_src
, hdr
->var_size
* sizeof(u32
));
197 memcpy(inc
, inc_src
, hdr
->inc_size
* sizeof(u32
));
201 EXPORT_SYMBOL_GPL(bcom_load_image
);
204 bcom_set_initiator(int task
, int initiator
)
209 int next_drd_has_initiator
;
211 bcom_set_tcr_initiator(task
, initiator
);
213 /* Just setting tcr is apparently not enough due to some problem */
214 /* with it. So we just go thru all the microcode and replace in */
215 /* the DRD directly */
217 desc
= bcom_task_desc(task
);
218 next_drd_has_initiator
= 1;
219 num_descs
= bcom_task_num_descs(task
);
221 for (i
=0; i
<num_descs
; i
++, desc
++) {
222 if (!bcom_desc_is_drd(*desc
))
224 if (next_drd_has_initiator
)
225 if (bcom_desc_initiator(*desc
) != BCOM_INITIATOR_ALWAYS
)
226 bcom_set_desc_initiator(desc
, initiator
);
227 next_drd_has_initiator
= !bcom_drd_is_extended(*desc
);
230 EXPORT_SYMBOL_GPL(bcom_set_initiator
);
236 bcom_enable(struct bcom_task
*tsk
)
238 bcom_enable_task(tsk
->tasknum
);
240 EXPORT_SYMBOL_GPL(bcom_enable
);
243 bcom_disable(struct bcom_task
*tsk
)
245 bcom_disable_task(tsk
->tasknum
);
247 EXPORT_SYMBOL_GPL(bcom_disable
);
250 /* ======================================================================== */
251 /* Engine init/cleanup */
252 /* ======================================================================== */
254 /* Function Descriptor table */
255 /* this will need to be updated if Freescale changes their task code FDT */
256 static u32 fdt_ops
[] = {
257 0xa0045670, /* FDT[48] - load_acc() */
258 0x80045670, /* FDT[49] - unload_acc() */
259 0x21800000, /* FDT[50] - and() */
260 0x21e00000, /* FDT[51] - or() */
261 0x21500000, /* FDT[52] - xor() */
262 0x21400000, /* FDT[53] - andn() */
263 0x21500000, /* FDT[54] - not() */
264 0x20400000, /* FDT[55] - add() */
265 0x20500000, /* FDT[56] - sub() */
266 0x20800000, /* FDT[57] - lsh() */
267 0x20a00000, /* FDT[58] - rsh() */
268 0xc0170000, /* FDT[59] - crc8() */
269 0xc0145670, /* FDT[60] - crc16() */
270 0xc0345670, /* FDT[61] - crc32() */
271 0xa0076540, /* FDT[62] - endian32() */
272 0xa0000760, /* FDT[63] - endian16() */
277 bcom_engine_init(void)
280 phys_addr_t tdt_pa
, ctx_pa
, var_pa
, fdt_pa
;
281 unsigned int tdt_size
, ctx_size
, var_size
, fdt_size
;
283 /* Allocate & clear SRAM zones for FDT, TDTs, contexts and vars/incs */
284 tdt_size
= BCOM_MAX_TASKS
* sizeof(struct bcom_tdt
);
285 ctx_size
= BCOM_MAX_TASKS
* BCOM_CTX_SIZE
;
286 var_size
= BCOM_MAX_TASKS
* (BCOM_VAR_SIZE
+ BCOM_INC_SIZE
);
287 fdt_size
= BCOM_FDT_SIZE
;
289 bcom_eng
->tdt
= bcom_sram_alloc(tdt_size
, sizeof(u32
), &tdt_pa
);
290 bcom_eng
->ctx
= bcom_sram_alloc(ctx_size
, BCOM_CTX_ALIGN
, &ctx_pa
);
291 bcom_eng
->var
= bcom_sram_alloc(var_size
, BCOM_VAR_ALIGN
, &var_pa
);
292 bcom_eng
->fdt
= bcom_sram_alloc(fdt_size
, BCOM_FDT_ALIGN
, &fdt_pa
);
294 if (!bcom_eng
->tdt
|| !bcom_eng
->ctx
|| !bcom_eng
->var
|| !bcom_eng
->fdt
) {
295 printk(KERN_ERR
"DMA: SRAM alloc failed in engine init !\n");
297 bcom_sram_free(bcom_eng
->tdt
);
298 bcom_sram_free(bcom_eng
->ctx
);
299 bcom_sram_free(bcom_eng
->var
);
300 bcom_sram_free(bcom_eng
->fdt
);
305 memset(bcom_eng
->tdt
, 0x00, tdt_size
);
306 memset(bcom_eng
->ctx
, 0x00, ctx_size
);
307 memset(bcom_eng
->var
, 0x00, var_size
);
308 memset(bcom_eng
->fdt
, 0x00, fdt_size
);
310 /* Copy the FDT for the EU#3 */
311 memcpy(&bcom_eng
->fdt
[48], fdt_ops
, sizeof(fdt_ops
));
313 /* Initialize Task base structure */
314 for (task
=0; task
<BCOM_MAX_TASKS
; task
++)
316 out_be16(&bcom_eng
->regs
->tcr
[task
], 0);
317 out_8(&bcom_eng
->regs
->ipr
[task
], 0);
319 bcom_eng
->tdt
[task
].context
= ctx_pa
;
320 bcom_eng
->tdt
[task
].var
= var_pa
;
321 bcom_eng
->tdt
[task
].fdt
= fdt_pa
;
323 var_pa
+= BCOM_VAR_SIZE
+ BCOM_INC_SIZE
;
324 ctx_pa
+= BCOM_CTX_SIZE
;
327 out_be32(&bcom_eng
->regs
->taskBar
, tdt_pa
);
329 /* Init 'always' initiator */
330 out_8(&bcom_eng
->regs
->ipr
[BCOM_INITIATOR_ALWAYS
], BCOM_IPR_ALWAYS
);
332 /* Disable COMM Bus Prefetch on the original 5200; it's broken */
333 if ((mfspr(SPRN_SVR
) & MPC5200_SVR_MASK
) == MPC5200_SVR
)
334 bcom_disable_prefetch();
337 spin_lock_init(&bcom_eng
->lock
);
343 bcom_engine_cleanup(void)
348 for (task
=0; task
<BCOM_MAX_TASKS
; task
++)
350 out_be16(&bcom_eng
->regs
->tcr
[task
], 0);
351 out_8(&bcom_eng
->regs
->ipr
[task
], 0);
354 out_be32(&bcom_eng
->regs
->taskBar
, 0ul);
356 /* Release the SRAM zones */
357 bcom_sram_free(bcom_eng
->tdt
);
358 bcom_sram_free(bcom_eng
->ctx
);
359 bcom_sram_free(bcom_eng
->var
);
360 bcom_sram_free(bcom_eng
->fdt
);
364 /* ======================================================================== */
365 /* OF platform driver */
366 /* ======================================================================== */
369 mpc52xx_bcom_probe(struct of_device
*op
, const struct of_device_id
*match
)
371 struct device_node
*ofn_sram
;
372 struct resource res_bcom
;
376 /* Inform user we're ok so far */
377 printk(KERN_INFO
"DMA: MPC52xx BestComm driver\n");
379 /* Get the bestcomm node */
380 of_node_get(op
->node
);
383 ofn_sram
= of_find_matching_node(NULL
, mpc52xx_sram_ids
);
385 printk(KERN_ERR DRIVER_NAME
": "
386 "No SRAM found in device tree\n");
390 rv
= bcom_sram_init(ofn_sram
, DRIVER_NAME
);
391 of_node_put(ofn_sram
);
394 printk(KERN_ERR DRIVER_NAME
": "
395 "Error in SRAM init\n");
399 /* Get a clean struct */
400 bcom_eng
= kzalloc(sizeof(struct bcom_engine
), GFP_KERNEL
);
402 printk(KERN_ERR DRIVER_NAME
": "
403 "Can't allocate state structure\n");
405 goto error_sramclean
;
409 bcom_eng
->ofnode
= op
->node
;
411 /* Get, reserve & map io */
412 if (of_address_to_resource(op
->node
, 0, &res_bcom
)) {
413 printk(KERN_ERR DRIVER_NAME
": "
414 "Can't get resource\n");
416 goto error_sramclean
;
419 if (!request_mem_region(res_bcom
.start
, sizeof(struct mpc52xx_sdma
),
421 printk(KERN_ERR DRIVER_NAME
": "
422 "Can't request registers region\n");
424 goto error_sramclean
;
427 bcom_eng
->regs_base
= res_bcom
.start
;
428 bcom_eng
->regs
= ioremap(res_bcom
.start
, sizeof(struct mpc52xx_sdma
));
429 if (!bcom_eng
->regs
) {
430 printk(KERN_ERR DRIVER_NAME
": "
431 "Can't map registers\n");
436 /* Now, do the real init */
437 rv
= bcom_engine_init();
442 printk(KERN_INFO
"DMA: MPC52xx BestComm engine @%08lx ok !\n",
443 (long)bcom_eng
->regs_base
);
449 iounmap(bcom_eng
->regs
);
451 release_mem_region(res_bcom
.start
, sizeof(struct mpc52xx_sdma
));
456 of_node_put(op
->node
);
458 printk(KERN_ERR
"DMA: MPC52xx BestComm init failed !\n");
465 mpc52xx_bcom_remove(struct of_device
*op
)
467 /* Clean up the engine */
468 bcom_engine_cleanup();
474 iounmap(bcom_eng
->regs
);
475 release_mem_region(bcom_eng
->regs_base
, sizeof(struct mpc52xx_sdma
));
477 /* Release the node */
478 of_node_put(bcom_eng
->ofnode
);
487 static struct of_device_id mpc52xx_bcom_of_match
[] = {
488 { .compatible
= "fsl,mpc5200-bestcomm", },
489 { .compatible
= "mpc5200-bestcomm", },
493 MODULE_DEVICE_TABLE(of
, mpc52xx_bcom_of_match
);
496 static struct of_platform_driver mpc52xx_bcom_of_platform_driver
= {
497 .owner
= THIS_MODULE
,
499 .match_table
= mpc52xx_bcom_of_match
,
500 .probe
= mpc52xx_bcom_probe
,
501 .remove
= mpc52xx_bcom_remove
,
504 .owner
= THIS_MODULE
,
509 /* ======================================================================== */
511 /* ======================================================================== */
514 mpc52xx_bcom_init(void)
516 return of_register_platform_driver(&mpc52xx_bcom_of_platform_driver
);
520 mpc52xx_bcom_exit(void)
522 of_unregister_platform_driver(&mpc52xx_bcom_of_platform_driver
);
525 /* If we're not a module, we must make sure everything is setup before */
526 /* anyone tries to use us ... that's why we use subsys_initcall instead */
527 /* of module_init. */
528 subsys_initcall(mpc52xx_bcom_init
);
529 module_exit(mpc52xx_bcom_exit
);
531 MODULE_DESCRIPTION("Freescale MPC52xx BestComm DMA");
532 MODULE_AUTHOR("Sylvain Munaut <tnt@246tNt.com>");
533 MODULE_AUTHOR("Andrey Volkov <avolkov@varma-el.com>");
534 MODULE_AUTHOR("Dale Farnsworth <dfarnsworth@mvista.com>");
535 MODULE_LICENSE("GPL v2");