2 * pxa3xx-gcu.c - Linux kernel module for PXA3xx graphics controllers
4 * This driver needs a DirectFB counterpart in user space, communication
5 * is handled via mmap()ed memory areas and an ioctl.
7 * Copyright (c) 2009 Daniel Mack <daniel@caiaq.de>
8 * Copyright (c) 2009 Janine Kropp <nin@directfb.org>
9 * Copyright (c) 2009 Denis Oliver Kropp <dok@directfb.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
27 * WARNING: This controller is attached to System Bus 2 of the PXA which
28 * needs its arbiter to be enabled explicitly (CKENB & 1<<9).
29 * There is currently no way to do this from Linux, so you need to teach
30 * your bootloader for now.
33 #include <linux/module.h>
34 #include <linux/version.h>
36 #include <linux/platform_device.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/miscdevice.h>
39 #include <linux/interrupt.h>
40 #include <linux/spinlock.h>
41 #include <linux/uaccess.h>
42 #include <linux/ioctl.h>
43 #include <linux/delay.h>
44 #include <linux/sched.h>
45 #include <linux/slab.h>
46 #include <linux/clk.h>
50 #include "pxa3xx-gcu.h"
52 #define DRV_NAME "pxa3xx-gcu"
53 #define MISCDEV_MINOR 197
56 #define GCCR_SYNC_CLR (1 << 9)
57 #define GCCR_BP_RST (1 << 8)
58 #define GCCR_ABORT (1 << 6)
59 #define GCCR_STOP (1 << 4)
61 #define REG_GCISCR 0x04
62 #define REG_GCIECR 0x08
63 #define REG_GCRBBR 0x20
64 #define REG_GCRBLR 0x24
65 #define REG_GCRBHR 0x28
66 #define REG_GCRBTR 0x2C
67 #define REG_GCRBEXHR 0x30
69 #define IE_EOB (1 << 0)
70 #define IE_EEOB (1 << 5)
73 #define SHARED_SIZE PAGE_ALIGN(sizeof(struct pxa3xx_gcu_shared))
75 /* #define PXA3XX_GCU_DEBUG */
76 /* #define PXA3XX_GCU_DEBUG_TIMER */
78 #ifdef PXA3XX_GCU_DEBUG
81 QPRINT(priv, KERN_DEBUG, msg); \
84 #define QDUMP(msg) do {} while (0)
89 QPRINT(priv, KERN_ERR, msg); \
92 struct pxa3xx_gcu_batch
{
93 struct pxa3xx_gcu_batch
*next
;
99 struct pxa3xx_gcu_priv
{
100 void __iomem
*mmio_base
;
102 struct pxa3xx_gcu_shared
*shared
;
103 dma_addr_t shared_phys
;
104 struct resource
*resource_mem
;
105 struct miscdevice misc_dev
;
106 struct file_operations misc_fops
;
107 wait_queue_head_t wait_idle
;
108 wait_queue_head_t wait_free
;
110 struct timeval base_time
;
112 struct pxa3xx_gcu_batch
*free
;
114 struct pxa3xx_gcu_batch
*ready
;
115 struct pxa3xx_gcu_batch
*ready_last
;
116 struct pxa3xx_gcu_batch
*running
;
119 static inline unsigned long
120 gc_readl(struct pxa3xx_gcu_priv
*priv
, unsigned int off
)
122 return __raw_readl(priv
->mmio_base
+ off
);
126 gc_writel(struct pxa3xx_gcu_priv
*priv
, unsigned int off
, unsigned long val
)
128 __raw_writel(val
, priv
->mmio_base
+ off
);
131 #define QPRINT(priv, level, msg) \
134 struct pxa3xx_gcu_shared *shared = priv->shared; \
135 u32 base = gc_readl(priv, REG_GCRBBR); \
137 do_gettimeofday(&tv); \
139 printk(level "%ld.%03ld.%03ld - %-17s: %-21s (%s, " \
141 "0x%02lx, B 0x%08lx [%ld], E %5ld, H %5ld, " \
143 tv.tv_sec - priv->base_time.tv_sec, \
144 tv.tv_usec / 1000, tv.tv_usec % 1000, \
146 shared->hw_running ? "running" : " idle", \
147 gc_readl(priv, REG_GCISCR), \
148 gc_readl(priv, REG_GCRBBR), \
149 gc_readl(priv, REG_GCRBLR), \
150 (gc_readl(priv, REG_GCRBEXHR) - base) / 4, \
151 (gc_readl(priv, REG_GCRBHR) - base) / 4, \
152 (gc_readl(priv, REG_GCRBTR) - base) / 4); \
156 pxa3xx_gcu_reset(struct pxa3xx_gcu_priv
*priv
)
160 /* disable interrupts */
161 gc_writel(priv
, REG_GCIECR
, 0);
164 gc_writel(priv
, REG_GCCR
, GCCR_ABORT
);
165 gc_writel(priv
, REG_GCCR
, 0);
167 memset(priv
->shared
, 0, SHARED_SIZE
);
168 priv
->shared
->buffer_phys
= priv
->shared_phys
;
169 priv
->shared
->magic
= PXA3XX_GCU_SHARED_MAGIC
;
171 do_gettimeofday(&priv
->base_time
);
173 /* set up the ring buffer pointers */
174 gc_writel(priv
, REG_GCRBLR
, 0);
175 gc_writel(priv
, REG_GCRBBR
, priv
->shared_phys
);
176 gc_writel(priv
, REG_GCRBTR
, priv
->shared_phys
);
178 /* enable all IRQs except EOB */
179 gc_writel(priv
, REG_GCIECR
, IE_ALL
& ~IE_EOB
);
183 dump_whole_state(struct pxa3xx_gcu_priv
*priv
)
185 struct pxa3xx_gcu_shared
*sh
= priv
->shared
;
186 u32 base
= gc_readl(priv
, REG_GCRBBR
);
190 printk(KERN_DEBUG
"== PXA3XX-GCU DUMP ==\n"
191 "%s, STATUS 0x%02lx, B 0x%08lx [%ld], E %5ld, H %5ld, T %5ld\n",
192 sh
->hw_running
? "running" : "idle ",
193 gc_readl(priv
, REG_GCISCR
),
194 gc_readl(priv
, REG_GCRBBR
),
195 gc_readl(priv
, REG_GCRBLR
),
196 (gc_readl(priv
, REG_GCRBEXHR
) - base
) / 4,
197 (gc_readl(priv
, REG_GCRBHR
) - base
) / 4,
198 (gc_readl(priv
, REG_GCRBTR
) - base
) / 4);
202 flush_running(struct pxa3xx_gcu_priv
*priv
)
204 struct pxa3xx_gcu_batch
*running
= priv
->running
;
205 struct pxa3xx_gcu_batch
*next
;
208 next
= running
->next
;
209 running
->next
= priv
->free
;
210 priv
->free
= running
;
214 priv
->running
= NULL
;
218 run_ready(struct pxa3xx_gcu_priv
*priv
)
220 unsigned int num
= 0;
221 struct pxa3xx_gcu_shared
*shared
= priv
->shared
;
222 struct pxa3xx_gcu_batch
*ready
= priv
->ready
;
228 shared
->buffer
[num
++] = 0x05000000;
231 shared
->buffer
[num
++] = 0x00000001;
232 shared
->buffer
[num
++] = ready
->phys
;
236 shared
->buffer
[num
++] = 0x05000000;
237 priv
->running
= priv
->ready
;
238 priv
->ready
= priv
->ready_last
= NULL
;
239 gc_writel(priv
, REG_GCRBLR
, 0);
240 shared
->hw_running
= 1;
242 /* ring base address */
243 gc_writel(priv
, REG_GCRBBR
, shared
->buffer_phys
);
245 /* ring tail address */
246 gc_writel(priv
, REG_GCRBTR
, shared
->buffer_phys
+ num
* 4);
249 gc_writel(priv
, REG_GCRBLR
, ((num
+ 63) & ~63) * 4);
253 pxa3xx_gcu_handle_irq(int irq
, void *ctx
)
255 struct pxa3xx_gcu_priv
*priv
= ctx
;
256 struct pxa3xx_gcu_shared
*shared
= priv
->shared
;
257 u32 status
= gc_readl(priv
, REG_GCISCR
) & IE_ALL
;
264 spin_lock(&priv
->spinlock
);
265 shared
->num_interrupts
++;
267 if (status
& IE_EEOB
) {
271 wake_up_all(&priv
->wait_free
);
276 /* There is no more data prepared by the userspace.
277 * Set hw_running = 0 and wait for the next userspace
280 shared
->hw_running
= 0;
284 /* set ring buffer length to zero */
285 gc_writel(priv
, REG_GCRBLR
, 0);
287 wake_up_all(&priv
->wait_idle
);
293 dump_whole_state(priv
);
296 /* Clear the interrupt */
297 gc_writel(priv
, REG_GCISCR
, status
);
298 spin_unlock(&priv
->spinlock
);
304 pxa3xx_gcu_wait_idle(struct pxa3xx_gcu_priv
*priv
)
308 QDUMP("Waiting for idle...");
310 /* Does not need to be atomic. There's a lock in user space,
311 * but anyhow, this is just for statistics. */
312 priv
->shared
->num_wait_idle
++;
314 while (priv
->shared
->hw_running
) {
315 int num
= priv
->shared
->num_interrupts
;
316 u32 rbexhr
= gc_readl(priv
, REG_GCRBEXHR
);
318 ret
= wait_event_interruptible_timeout(priv
->wait_idle
,
319 !priv
->shared
->hw_running
, HZ
*4);
327 if (gc_readl(priv
, REG_GCRBEXHR
) == rbexhr
&&
328 priv
->shared
->num_interrupts
== num
) {
341 pxa3xx_gcu_wait_free(struct pxa3xx_gcu_priv
*priv
)
345 QDUMP("Waiting for free...");
347 /* Does not need to be atomic. There's a lock in user space,
348 * but anyhow, this is just for statistics. */
349 priv
->shared
->num_wait_free
++;
351 while (!priv
->free
) {
352 u32 rbexhr
= gc_readl(priv
, REG_GCRBEXHR
);
354 ret
= wait_event_interruptible_timeout(priv
->wait_free
,
363 if (gc_readl(priv
, REG_GCRBEXHR
) == rbexhr
) {
375 /* Misc device layer */
378 pxa3xx_gcu_misc_write(struct file
*filp
, const char *buff
,
379 size_t count
, loff_t
*offp
)
383 struct pxa3xx_gcu_batch
*buffer
;
384 struct pxa3xx_gcu_priv
*priv
=
385 container_of(filp
->f_op
, struct pxa3xx_gcu_priv
, misc_fops
);
387 int words
= count
/ 4;
389 /* Does not need to be atomic. There's a lock in user space,
390 * but anyhow, this is just for statistics. */
391 priv
->shared
->num_writes
++;
393 priv
->shared
->num_words
+= words
;
395 /* Last word reserved for batch buffer end command */
396 if (words
>= PXA3XX_GCU_BATCH_WORDS
)
399 /* Wait for a free buffer */
401 ret
= pxa3xx_gcu_wait_free(priv
);
407 * Get buffer from free list
409 spin_lock_irqsave(&priv
->spinlock
, flags
);
412 priv
->free
= buffer
->next
;
414 spin_unlock_irqrestore(&priv
->spinlock
, flags
);
417 /* Copy data from user into buffer */
418 ret
= copy_from_user(buffer
->ptr
, buff
, words
* 4);
420 spin_lock_irqsave(&priv
->spinlock
, flags
);
421 buffer
->next
= priv
->free
;
423 spin_unlock_irqrestore(&priv
->spinlock
, flags
);
427 buffer
->length
= words
;
429 /* Append batch buffer end command */
430 buffer
->ptr
[words
] = 0x01000000;
433 * Add buffer to ready list
435 spin_lock_irqsave(&priv
->spinlock
, flags
);
440 BUG_ON(priv
->ready_last
== NULL
);
442 priv
->ready_last
->next
= buffer
;
444 priv
->ready
= buffer
;
446 priv
->ready_last
= buffer
;
448 if (!priv
->shared
->hw_running
)
451 spin_unlock_irqrestore(&priv
->spinlock
, flags
);
458 pxa3xx_gcu_misc_ioctl(struct file
*filp
, unsigned int cmd
, unsigned long arg
)
461 struct pxa3xx_gcu_priv
*priv
=
462 container_of(filp
->f_op
, struct pxa3xx_gcu_priv
, misc_fops
);
465 case PXA3XX_GCU_IOCTL_RESET
:
466 spin_lock_irqsave(&priv
->spinlock
, flags
);
467 pxa3xx_gcu_reset(priv
);
468 spin_unlock_irqrestore(&priv
->spinlock
, flags
);
471 case PXA3XX_GCU_IOCTL_WAIT_IDLE
:
472 return pxa3xx_gcu_wait_idle(priv
);
479 pxa3xx_gcu_misc_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
481 unsigned int size
= vma
->vm_end
- vma
->vm_start
;
482 struct pxa3xx_gcu_priv
*priv
=
483 container_of(filp
->f_op
, struct pxa3xx_gcu_priv
, misc_fops
);
485 switch (vma
->vm_pgoff
) {
487 /* hand out the shared data area */
488 if (size
!= SHARED_SIZE
)
491 return dma_mmap_coherent(NULL
, vma
,
492 priv
->shared
, priv
->shared_phys
, size
);
494 case SHARED_SIZE
>> PAGE_SHIFT
:
495 /* hand out the MMIO base for direct register access
497 if (size
!= resource_size(priv
->resource_mem
))
500 vma
->vm_flags
|= VM_IO
;
501 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
503 return io_remap_pfn_range(vma
, vma
->vm_start
,
504 priv
->resource_mem
->start
>> PAGE_SHIFT
,
505 size
, vma
->vm_page_prot
);
512 #ifdef PXA3XX_GCU_DEBUG_TIMER
513 static struct timer_list pxa3xx_gcu_debug_timer
;
515 static void pxa3xx_gcu_debug_timedout(unsigned long ptr
)
517 struct pxa3xx_gcu_priv
*priv
= (struct pxa3xx_gcu_priv
*) ptr
;
519 QERROR("Timer DUMP");
521 /* init the timer structure */
522 init_timer(&pxa3xx_gcu_debug_timer
);
523 pxa3xx_gcu_debug_timer
.function
= pxa3xx_gcu_debug_timedout
;
524 pxa3xx_gcu_debug_timer
.data
= ptr
;
525 pxa3xx_gcu_debug_timer
.expires
= jiffies
+ 5*HZ
; /* one second */
527 add_timer(&pxa3xx_gcu_debug_timer
);
530 static void pxa3xx_gcu_init_debug_timer(void)
532 pxa3xx_gcu_debug_timedout((unsigned long) &pxa3xx_gcu_debug_timer
);
535 static inline void pxa3xx_gcu_init_debug_timer(void) {}
539 add_buffer(struct platform_device
*dev
,
540 struct pxa3xx_gcu_priv
*priv
)
542 struct pxa3xx_gcu_batch
*buffer
;
544 buffer
= kzalloc(sizeof(struct pxa3xx_gcu_batch
), GFP_KERNEL
);
548 buffer
->ptr
= dma_alloc_coherent(&dev
->dev
, PXA3XX_GCU_BATCH_WORDS
* 4,
549 &buffer
->phys
, GFP_KERNEL
);
555 buffer
->next
= priv
->free
;
563 free_buffers(struct platform_device
*dev
,
564 struct pxa3xx_gcu_priv
*priv
)
566 struct pxa3xx_gcu_batch
*next
, *buffer
= priv
->free
;
571 dma_free_coherent(&dev
->dev
, PXA3XX_GCU_BATCH_WORDS
* 4,
572 buffer
->ptr
, buffer
->phys
);
583 pxa3xx_gcu_probe(struct platform_device
*dev
)
587 struct pxa3xx_gcu_priv
*priv
;
589 priv
= kzalloc(sizeof(struct pxa3xx_gcu_priv
), GFP_KERNEL
);
593 for (i
= 0; i
< 8; i
++) {
594 ret
= add_buffer(dev
, priv
);
596 dev_err(&dev
->dev
, "failed to allocate DMA memory\n");
601 init_waitqueue_head(&priv
->wait_idle
);
602 init_waitqueue_head(&priv
->wait_free
);
603 spin_lock_init(&priv
->spinlock
);
605 /* we allocate the misc device structure as part of our own allocation,
606 * so we can get a pointer to our priv structure later on with
607 * container_of(). This isn't really necessary as we have a fixed minor
608 * number anyway, but this is to avoid statics. */
610 priv
->misc_fops
.owner
= THIS_MODULE
;
611 priv
->misc_fops
.write
= pxa3xx_gcu_misc_write
;
612 priv
->misc_fops
.unlocked_ioctl
= pxa3xx_gcu_misc_ioctl
;
613 priv
->misc_fops
.mmap
= pxa3xx_gcu_misc_mmap
;
615 priv
->misc_dev
.minor
= MISCDEV_MINOR
,
616 priv
->misc_dev
.name
= DRV_NAME
,
617 priv
->misc_dev
.fops
= &priv
->misc_fops
,
619 /* register misc device */
620 ret
= misc_register(&priv
->misc_dev
);
622 dev_err(&dev
->dev
, "misc_register() for minor %d failed\n",
627 /* handle IO resources */
628 r
= platform_get_resource(dev
, IORESOURCE_MEM
, 0);
630 dev_err(&dev
->dev
, "no I/O memory resource defined\n");
632 goto err_misc_deregister
;
635 if (!request_mem_region(r
->start
, resource_size(r
), dev
->name
)) {
636 dev_err(&dev
->dev
, "failed to request I/O memory\n");
638 goto err_misc_deregister
;
641 priv
->mmio_base
= ioremap_nocache(r
->start
, resource_size(r
));
642 if (!priv
->mmio_base
) {
643 dev_err(&dev
->dev
, "failed to map I/O memory\n");
645 goto err_free_mem_region
;
648 /* allocate dma memory */
649 priv
->shared
= dma_alloc_coherent(&dev
->dev
, SHARED_SIZE
,
650 &priv
->shared_phys
, GFP_KERNEL
);
653 dev_err(&dev
->dev
, "failed to allocate DMA memory\n");
658 /* enable the clock */
659 priv
->clk
= clk_get(&dev
->dev
, NULL
);
660 if (IS_ERR(priv
->clk
)) {
661 dev_err(&dev
->dev
, "failed to get clock\n");
666 ret
= clk_enable(priv
->clk
);
668 dev_err(&dev
->dev
, "failed to enable clock\n");
672 /* request the IRQ */
673 irq
= platform_get_irq(dev
, 0);
675 dev_err(&dev
->dev
, "no IRQ defined\n");
680 ret
= request_irq(irq
, pxa3xx_gcu_handle_irq
,
681 IRQF_DISABLED
, DRV_NAME
, priv
);
683 dev_err(&dev
->dev
, "request_irq failed\n");
688 platform_set_drvdata(dev
, priv
);
689 priv
->resource_mem
= r
;
690 pxa3xx_gcu_reset(priv
);
691 pxa3xx_gcu_init_debug_timer();
693 dev_info(&dev
->dev
, "registered @0x%p, DMA 0x%p (%d bytes), IRQ %d\n",
694 (void *) r
->start
, (void *) priv
->shared_phys
,
699 clk_disable(priv
->clk
);
703 dma_free_coherent(&dev
->dev
, SHARED_SIZE
,
704 priv
->shared
, priv
->shared_phys
);
707 iounmap(priv
->mmio_base
);
710 release_mem_region(r
->start
, resource_size(r
));
713 misc_deregister(&priv
->misc_dev
);
716 platform_set_drvdata(dev
, NULL
);
717 free_buffers(dev
, priv
);
723 pxa3xx_gcu_remove(struct platform_device
*dev
)
725 struct pxa3xx_gcu_priv
*priv
= platform_get_drvdata(dev
);
726 struct resource
*r
= priv
->resource_mem
;
728 pxa3xx_gcu_wait_idle(priv
);
730 misc_deregister(&priv
->misc_dev
);
731 dma_free_coherent(&dev
->dev
, SHARED_SIZE
,
732 priv
->shared
, priv
->shared_phys
);
733 iounmap(priv
->mmio_base
);
734 release_mem_region(r
->start
, resource_size(r
));
735 platform_set_drvdata(dev
, NULL
);
736 clk_disable(priv
->clk
);
737 free_buffers(dev
, priv
);
743 static struct platform_driver pxa3xx_gcu_driver
= {
744 .probe
= pxa3xx_gcu_probe
,
745 .remove
= __devexit_p(pxa3xx_gcu_remove
),
747 .owner
= THIS_MODULE
,
753 pxa3xx_gcu_init(void)
755 return platform_driver_register(&pxa3xx_gcu_driver
);
759 pxa3xx_gcu_exit(void)
761 platform_driver_unregister(&pxa3xx_gcu_driver
);
764 module_init(pxa3xx_gcu_init
);
765 module_exit(pxa3xx_gcu_exit
);
767 MODULE_DESCRIPTION("PXA3xx graphics controller unit driver");
768 MODULE_LICENSE("GPL");
769 MODULE_ALIAS_MISCDEV(MISCDEV_MINOR
);
770 MODULE_AUTHOR("Janine Kropp <nin@directfb.org>, "
771 "Denis Oliver Kropp <dok@directfb.org>, "
772 "Daniel Mack <daniel@caiaq.de>");