1/* linux/arch/arm/plat-s3c24xx/dma.c
2 *
3 * Copyright 2003-2006 Simtec Electronics
4 *	Ben Dooks <ben@simtec.co.uk>
5 *
6 * S3C2410 DMA core
7 *
8 * http://armlinux.simtec.co.uk/
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
13*/
14
15
16#ifdef CONFIG_S3C2410_DMA_DEBUG
17#define DEBUG
18#endif
19
20#include <linux/module.h>
21#include <linux/init.h>
22#include <linux/sched.h>
23#include <linux/spinlock.h>
24#include <linux/interrupt.h>
25#include <linux/syscore_ops.h>
26#include <linux/slab.h>
27#include <linux/errno.h>
28#include <linux/io.h>
29
30#include <asm/irq.h>
31#include <mach/hardware.h>
32#include <mach/dma.h>
33#include <mach/map.h>
34
35#include <plat/dma-s3c24xx.h>
36#include <plat/regs-dma.h>
37
38/* io map for dma */
39static void __iomem *dma_base;
40static struct kmem_cache *dma_kmem;
41
42static int dma_channels;
43
44static struct s3c24xx_dma_selection dma_sel;
45
46
47/* debugging functions */
48
49#define BUF_MAGIC (0xcafebabe)
50
51#define dmawarn(fmt...) printk(KERN_DEBUG fmt)
52
53#define dma_regaddr(chan, reg) ((chan)->regs + (reg))
54
55#if 1
56#define dma_wrreg(chan, reg, val) writel((val), (chan)->regs + (reg))
57#else
58static inline void
59dma_wrreg(struct s3c2410_dma_chan *chan, int reg, unsigned long val)
60{
61	pr_debug("writing %08x to register %08x\n",(unsigned int)val,reg);
62	writel(val, dma_regaddr(chan, reg));
63}
64#endif
65
66#define dma_rdreg(chan, reg) readl((chan)->regs + (reg))
67
68/* captured register state for debug */
69
70struct s3c2410_dma_regstate {
71	unsigned long         dcsrc;
72	unsigned long         disrc;
73	unsigned long         dstat;
74	unsigned long         dcon;
75	unsigned long         dmsktrig;
76};
77
78#ifdef CONFIG_S3C2410_DMA_DEBUG
79
80/* dmadbg_showregs
81 *
82 * simple debug routine to print the current state of the dma registers
83*/
84
85static void
86dmadbg_capture(struct s3c2410_dma_chan *chan, struct s3c2410_dma_regstate *regs)
87{
88	regs->dcsrc    = dma_rdreg(chan, S3C2410_DMA_DCSRC);
89	regs->disrc    = dma_rdreg(chan, S3C2410_DMA_DISRC);
90	regs->dstat    = dma_rdreg(chan, S3C2410_DMA_DSTAT);
91	regs->dcon     = dma_rdreg(chan, S3C2410_DMA_DCON);
92	regs->dmsktrig = dma_rdreg(chan, S3C2410_DMA_DMASKTRIG);
93}
94
95static void
96dmadbg_dumpregs(const char *fname, int line, struct s3c2410_dma_chan *chan,
97		 struct s3c2410_dma_regstate *regs)
98{
99	printk(KERN_DEBUG "dma%d: %s:%d: DCSRC=%08lx, DISRC=%08lx, DSTAT=%08lx DMT=%02lx, DCON=%08lx\n",
100	       chan->number, fname, line,
101	       regs->dcsrc, regs->disrc, regs->dstat, regs->dmsktrig,
102	       regs->dcon);
103}
104
105static void
106dmadbg_showchan(const char *fname, int line, struct s3c2410_dma_chan *chan)
107{
108	struct s3c2410_dma_regstate state;
109
110	dmadbg_capture(chan, &state);
111
112	printk(KERN_DEBUG "dma%d: %s:%d: ls=%d, cur=%p, %p %p\n",
113	       chan->number, fname, line, chan->load_state,
114	       chan->curr, chan->next, chan->end);
115
116	dmadbg_dumpregs(fname, line, chan, &state);
117}
118
119static void
120dmadbg_showregs(const char *fname, int line, struct s3c2410_dma_chan *chan)
121{
122	struct s3c2410_dma_regstate state;
123
124	dmadbg_capture(chan, &state);
125	dmadbg_dumpregs(fname, line, chan, &state);
126}
127
128#define dbg_showregs(chan) dmadbg_showregs(__func__, __LINE__, (chan))
129#define dbg_showchan(chan) dmadbg_showchan(__func__, __LINE__, (chan))
130#else
131#define dbg_showregs(chan) do { } while(0)
132#define dbg_showchan(chan) do { } while(0)
133#endif /* CONFIG_S3C2410_DMA_DEBUG */
134
135/* s3c2410_dma_stats_timeout
136 *
137 * Update DMA stats from timeout info
138*/
139
140static void
141s3c2410_dma_stats_timeout(struct s3c2410_dma_stats *stats, int val)
142{
143	if (stats == NULL)
144		return;
145
146	if (val > stats->timeout_longest)
147		stats->timeout_longest = val;
148	if (val < stats->timeout_shortest)
149		stats->timeout_shortest = val;
150
151	stats->timeout_avg += val;
152}
153
154/* s3c2410_dma_waitforload
155 *
156 * wait for the DMA engine to load a buffer, and update the state accordingly
157*/
158
159static int
160s3c2410_dma_waitforload(struct s3c2410_dma_chan *chan, int line)
161{
162	int timeout = chan->load_timeout;
163	int took;
164
165	if (chan->load_state != S3C2410_DMALOAD_1LOADED) {
166		printk(KERN_ERR "dma%d: s3c2410_dma_waitforload() called in loadstate %d from line %d\n", chan->number, chan->load_state, line);
167		return 0;
168	}
169
170	if (chan->stats != NULL)
171		chan->stats->loads++;
172
173	while (--timeout > 0) {
174		if ((dma_rdreg(chan, S3C2410_DMA_DSTAT) << (32-20)) != 0) {
175			took = chan->load_timeout - timeout;
176
177			s3c2410_dma_stats_timeout(chan->stats, took);
178
179			switch (chan->load_state) {
180			case S3C2410_DMALOAD_1LOADED:
181				chan->load_state = S3C2410_DMALOAD_1RUNNING;
182				break;
183
184			default:
185				printk(KERN_ERR "dma%d: unknown load_state in s3c2410_dma_waitforload() %d\n", chan->number, chan->load_state);
186			}
187
188			return 1;
189		}
190	}
191
192	if (chan->stats != NULL) {
193		chan->stats->timeout_failed++;
194	}
195
196	return 0;
197}
198
199/* s3c2410_dma_loadbuffer
200 *
201 * load a buffer, and update the channel state
202*/
203
204static inline int
205s3c2410_dma_loadbuffer(struct s3c2410_dma_chan *chan,
206		       struct s3c2410_dma_buf *buf)
207{
208	unsigned long reload;
209
210	if (buf == NULL) {
211		dmawarn("buffer is NULL\n");
212		return -EINVAL;
213	}
214
215	pr_debug("s3c2410_chan_loadbuffer: loading buff %p (0x%08lx,0x%06x)\n",
216		 buf, (unsigned long)buf->data, buf->size);
217
218	/* check the state of the channel before we do anything */
219
220	if (chan->load_state == S3C2410_DMALOAD_1LOADED) {
221		dmawarn("load_state is S3C2410_DMALOAD_1LOADED\n");
222	}
223
224	if (chan->load_state == S3C2410_DMALOAD_1LOADED_1RUNNING) {
225		dmawarn("state is S3C2410_DMALOAD_1LOADED_1RUNNING\n");
226	}
227
228	/* it would seem sensible if we are the last buffer to not bother
229	 * with the auto-reload bit, so that the DMA engine will not try
230	 * and load another transfer after this one has finished...
231	 */
232	if (chan->load_state == S3C2410_DMALOAD_NONE) {
233		pr_debug("load_state is none, checking for noreload (next=%p)\n",
234			 buf->next);
235		reload = (buf->next == NULL) ? S3C2410_DCON_NORELOAD : 0;
236	} else {
237		//pr_debug("load_state is %d => autoreload\n", chan->load_state);
238		reload = S3C2410_DCON_AUTORELOAD;
239	}
240
241	if ((buf->data & 0xf0000000) != 0x30000000) {
242		dmawarn("dmaload: buffer is %p\n", (void *)buf->data);
243	}
244
245	writel(buf->data, chan->addr_reg);
246
247	dma_wrreg(chan, S3C2410_DMA_DCON,
248		  chan->dcon | reload | (buf->size/chan->xfer_unit));
249
250	chan->next = buf->next;
251
252	/* update the state of the channel */
253
254	switch (chan->load_state) {
255	case S3C2410_DMALOAD_NONE:
256		chan->load_state = S3C2410_DMALOAD_1LOADED;
257		break;
258
259	case S3C2410_DMALOAD_1RUNNING:
260		chan->load_state = S3C2410_DMALOAD_1LOADED_1RUNNING;
261		break;
262
263	default:
264		dmawarn("dmaload: unknown state %d in loadbuffer\n",
265			chan->load_state);
266		break;
267	}
268
269	return 0;
270}
271
272/* s3c2410_dma_call_op
273 *
274 * small routine to call the op routine with the given op if it has been
275 * registered
276*/
277
278static void
279s3c2410_dma_call_op(struct s3c2410_dma_chan *chan, enum s3c2410_chan_op op)
280{
281	if (chan->op_fn != NULL) {
282		(chan->op_fn)(chan, op);
283	}
284}
285
286/* s3c2410_dma_buffdone
287 *
288 * small wrapper to check if callback routine needs to be called, and
289 * if so, call it
290*/
291
292static inline void
293s3c2410_dma_buffdone(struct s3c2410_dma_chan *chan, struct s3c2410_dma_buf *buf,
294		     enum s3c2410_dma_buffresult result)
295{
296#if 0
297	pr_debug("callback_fn=%p, buf=%p, id=%p, size=%d, result=%d\n",
298		 chan->callback_fn, buf, buf->id, buf->size, result);
299#endif
300
301	if (chan->callback_fn != NULL) {
302		(chan->callback_fn)(chan, buf->id, buf->size, result);
303	}
304}
305
306/* s3c2410_dma_start
307 *
308 * start a dma channel going
309*/
310
311static int s3c2410_dma_start(struct s3c2410_dma_chan *chan)
312{
313	unsigned long tmp;
314	unsigned long flags;
315
316	pr_debug("s3c2410_start_dma: channel=%d\n", chan->number);
317
318	local_irq_save(flags);
319
320	if (chan->state == S3C2410_DMA_RUNNING) {
321		pr_debug("s3c2410_start_dma: already running (%d)\n", chan->state);
322		local_irq_restore(flags);
323		return 0;
324	}
325
326	chan->state = S3C2410_DMA_RUNNING;
327
328	/* check wether there is anything to load, and if not, see
329	 * if we can find anything to load
330	 */
331
332	if (chan->load_state == S3C2410_DMALOAD_NONE) {
333		if (chan->next == NULL) {
334			printk(KERN_ERR "dma%d: channel has nothing loaded\n",
335			       chan->number);
336			chan->state = S3C2410_DMA_IDLE;
337			local_irq_restore(flags);
338			return -EINVAL;
339		}
340
341		s3c2410_dma_loadbuffer(chan, chan->next);
342	}
343
344	dbg_showchan(chan);
345
346	/* enable the channel */
347
348	if (!chan->irq_enabled) {
349		enable_irq(chan->irq);
350		chan->irq_enabled = 1;
351	}
352
353	/* start the channel going */
354
355	tmp = dma_rdreg(chan, S3C2410_DMA_DMASKTRIG);
356	tmp &= ~S3C2410_DMASKTRIG_STOP;
357	tmp |= S3C2410_DMASKTRIG_ON;
358	dma_wrreg(chan, S3C2410_DMA_DMASKTRIG, tmp);
359
360	pr_debug("dma%d: %08lx to DMASKTRIG\n", chan->number, tmp);
361
362#if 0
363	/* the dma buffer loads should take care of clearing the AUTO
364	 * reloading feature */
365	tmp = dma_rdreg(chan, S3C2410_DMA_DCON);
366	tmp &= ~S3C2410_DCON_NORELOAD;
367	dma_wrreg(chan, S3C2410_DMA_DCON, tmp);
368#endif
369
370	s3c2410_dma_call_op(chan, S3C2410_DMAOP_START);
371
372	dbg_showchan(chan);
373
374	/* if we've only loaded one buffer onto the channel, then chec
375	 * to see if we have another, and if so, try and load it so when
376	 * the first buffer is finished, the new one will be loaded onto
377	 * the channel */
378
379	if (chan->next != NULL) {
380		if (chan->load_state == S3C2410_DMALOAD_1LOADED) {
381
382			if (s3c2410_dma_waitforload(chan, __LINE__) == 0) {
383				pr_debug("%s: buff not yet loaded, no more todo\n",
384					 __func__);
385			} else {
386				chan->load_state = S3C2410_DMALOAD_1RUNNING;
387				s3c2410_dma_loadbuffer(chan, chan->next);
388			}
389
390		} else if (chan->load_state == S3C2410_DMALOAD_1RUNNING) {
391			s3c2410_dma_loadbuffer(chan, chan->next);
392		}
393	}
394
395
396	local_irq_restore(flags);
397
398	return 0;
399}
400
401/* s3c2410_dma_canload
402 *
403 * work out if we can queue another buffer into the DMA engine
404*/
405
406static int
407s3c2410_dma_canload(struct s3c2410_dma_chan *chan)
408{
409	if (chan->load_state == S3C2410_DMALOAD_NONE ||
410	    chan->load_state == S3C2410_DMALOAD_1RUNNING)
411		return 1;
412
413	return 0;
414}
415
416/* s3c2410_dma_enqueue
417 *
418 * queue an given buffer for dma transfer.
419 *
420 * id         the device driver's id information for this buffer
421 * data       the physical address of the buffer data
422 * size       the size of the buffer in bytes
423 *
424 * If the channel is not running, then the flag S3C2410_DMAF_AUTOSTART
425 * is checked, and if set, the channel is started. If this flag isn't set,
426 * then an error will be returned.
427 *
428 * It is possible to queue more than one DMA buffer onto a channel at
429 * once, and the code will deal with the re-loading of the next buffer
430 * when necessary.
431*/
432
433int s3c2410_dma_enqueue(unsigned int channel, void *id,
434			dma_addr_t data, int size)
435{
436	struct s3c2410_dma_chan *chan = s3c_dma_lookup_channel(channel);
437	struct s3c2410_dma_buf *buf;
438	unsigned long flags;
439
440	if (chan == NULL)
441		return -EINVAL;
442
443	pr_debug("%s: id=%p, data=%08x, size=%d\n",
444		 __func__, id, (unsigned int)data, size);
445
446	buf = kmem_cache_alloc(dma_kmem, GFP_ATOMIC);
447	if (buf == NULL) {
448		pr_debug("%s: out of memory (%ld alloc)\n",
449			 __func__, (long)sizeof(*buf));
450		return -ENOMEM;
451	}
452
453	//pr_debug("%s: new buffer %p\n", __func__, buf);
454	//dbg_showchan(chan);
455
456	buf->next  = NULL;
457	buf->data  = buf->ptr = data;
458	buf->size  = size;
459	buf->id    = id;
460	buf->magic = BUF_MAGIC;
461
462	local_irq_save(flags);
463
464	if (chan->curr == NULL) {
465		/* we've got nothing loaded... */
466		pr_debug("%s: buffer %p queued onto empty channel\n",
467			 __func__, buf);
468
469		chan->curr = buf;
470		chan->end  = buf;
471		chan->next = NULL;
472	} else {
473		pr_debug("dma%d: %s: buffer %p queued onto non-empty channel\n",
474			 chan->number, __func__, buf);
475
476		if (chan->end == NULL)
477			pr_debug("dma%d: %s: %p not empty, and chan->end==NULL?\n",
478				 chan->number, __func__, chan);
479
480		chan->end->next = buf;
481		chan->end = buf;
482	}
483
484	/* if necessary, update the next buffer field */
485	if (chan->next == NULL)
486		chan->next = buf;
487
488	/* check to see if we can load a buffer */
489	if (chan->state == S3C2410_DMA_RUNNING) {
490		if (chan->load_state == S3C2410_DMALOAD_1LOADED && 1) {
491			if (s3c2410_dma_waitforload(chan, __LINE__) == 0) {
492				printk(KERN_ERR "dma%d: loadbuffer:"
493				       "timeout loading buffer\n",
494				       chan->number);
495				dbg_showchan(chan);
496				local_irq_restore(flags);
497				return -EINVAL;
498			}
499		}
500
501		while (s3c2410_dma_canload(chan) && chan->next != NULL) {
502			s3c2410_dma_loadbuffer(chan, chan->next);
503		}
504	} else if (chan->state == S3C2410_DMA_IDLE) {
505		if (chan->flags & S3C2410_DMAF_AUTOSTART) {
506			s3c2410_dma_ctrl(chan->number | DMACH_LOW_LEVEL,
507					 S3C2410_DMAOP_START);
508		}
509	}
510
511	local_irq_restore(flags);
512	return 0;
513}
514
515EXPORT_SYMBOL(s3c2410_dma_enqueue);
516
517static inline void
518s3c2410_dma_freebuf(struct s3c2410_dma_buf *buf)
519{
520	int magicok = (buf->magic == BUF_MAGIC);
521
522	buf->magic = -1;
523
524	if (magicok) {
525		kmem_cache_free(dma_kmem, buf);
526	} else {
527		printk("s3c2410_dma_freebuf: buff %p with bad magic\n", buf);
528	}
529}
530
531/* s3c2410_dma_lastxfer
532 *
533 * called when the system is out of buffers, to ensure that the channel
534 * is prepared for shutdown.
535*/
536
537static inline void
538s3c2410_dma_lastxfer(struct s3c2410_dma_chan *chan)
539{
540#if 0
541	pr_debug("dma%d: s3c2410_dma_lastxfer: load_state %d\n",
542		 chan->number, chan->load_state);
543#endif
544
545	switch (chan->load_state) {
546	case S3C2410_DMALOAD_NONE:
547		break;
548
549	case S3C2410_DMALOAD_1LOADED:
550		if (s3c2410_dma_waitforload(chan, __LINE__) == 0) {
551				/* flag error? */
552			printk(KERN_ERR "dma%d: timeout waiting for load (%s)\n",
553			       chan->number, __func__);
554			return;
555		}
556		break;
557
558	case S3C2410_DMALOAD_1LOADED_1RUNNING:
559		/* I believe in this case we do not have anything to do
560		 * until the next buffer comes along, and we turn off the
561		 * reload */
562		return;
563
564	default:
565		pr_debug("dma%d: lastxfer: unhandled load_state %d with no next\n",
566			 chan->number, chan->load_state);
567		return;
568
569	}
570
571	/* hopefully this'll shut the damned thing up after the transfer... */
572	dma_wrreg(chan, S3C2410_DMA_DCON, chan->dcon | S3C2410_DCON_NORELOAD);
573}
574
575
576#define dmadbg2(x...)
577
578static irqreturn_t
579s3c2410_dma_irq(int irq, void *devpw)
580{
581	struct s3c2410_dma_chan *chan = (struct s3c2410_dma_chan *)devpw;
582	struct s3c2410_dma_buf  *buf;
583
584	buf = chan->curr;
585
586	dbg_showchan(chan);
587
588	/* modify the channel state */
589
590	switch (chan->load_state) {
591	case S3C2410_DMALOAD_1RUNNING:
592		/* TODO - if we are running only one buffer, we probably
593		 * want to reload here, and then worry about the buffer
594		 * callback */
595
596		chan->load_state = S3C2410_DMALOAD_NONE;
597		break;
598
599	case S3C2410_DMALOAD_1LOADED:
600		/* iirc, we should go back to NONE loaded here, we
601		 * had a buffer, and it was never verified as being
602		 * loaded.
603		 */
604
605		chan->load_state = S3C2410_DMALOAD_NONE;
606		break;
607
608	case S3C2410_DMALOAD_1LOADED_1RUNNING:
609		/* we'll worry about checking to see if another buffer is
610		 * ready after we've called back the owner. This should
611		 * ensure we do not wait around too long for the DMA
612		 * engine to start the next transfer
613		 */
614
615		chan->load_state = S3C2410_DMALOAD_1LOADED;
616		break;
617
618	case S3C2410_DMALOAD_NONE:
619		printk(KERN_ERR "dma%d: IRQ with no loaded buffer?\n",
620		       chan->number);
621		break;
622
623	default:
624		printk(KERN_ERR "dma%d: IRQ in invalid load_state %d\n",
625		       chan->number, chan->load_state);
626		break;
627	}
628
629	if (buf != NULL) {
630		/* update the chain to make sure that if we load any more
631		 * buffers when we call the callback function, things should
632		 * work properly */
633
634		chan->curr = buf->next;
635		buf->next  = NULL;
636
637		if (buf->magic != BUF_MAGIC) {
638			printk(KERN_ERR "dma%d: %s: buf %p incorrect magic\n",
639			       chan->number, __func__, buf);
640			return IRQ_HANDLED;
641		}
642
643		s3c2410_dma_buffdone(chan, buf, S3C2410_RES_OK);
644
645		/* free resouces */
646		s3c2410_dma_freebuf(buf);
647	} else {
648	}
649
650	/* only reload if the channel is still running... our buffer done
651	 * routine may have altered the state by requesting the dma channel
652	 * to stop or shutdown... */
653
654	/* todo: check that when the channel is shut-down from inside this
655	 * function, we cope with unsetting reload, etc */
656
657	if (chan->next != NULL && chan->state != S3C2410_DMA_IDLE) {
658		unsigned long flags;
659
660		switch (chan->load_state) {
661		case S3C2410_DMALOAD_1RUNNING:
662			/* don't need to do anything for this state */
663			break;
664
665		case S3C2410_DMALOAD_NONE:
666			/* can load buffer immediately */
667			break;
668
669		case S3C2410_DMALOAD_1LOADED:
670			if (s3c2410_dma_waitforload(chan, __LINE__) == 0) {
671				/* flag error? */
672				printk(KERN_ERR "dma%d: timeout waiting for load (%s)\n",
673				       chan->number, __func__);
674				return IRQ_HANDLED;
675			}
676
677			break;
678
679		case S3C2410_DMALOAD_1LOADED_1RUNNING:
680			goto no_load;
681
682		default:
683			printk(KERN_ERR "dma%d: unknown load_state in irq, %d\n",
684			       chan->number, chan->load_state);
685			return IRQ_HANDLED;
686		}
687
688		local_irq_save(flags);
689		s3c2410_dma_loadbuffer(chan, chan->next);
690		local_irq_restore(flags);
691	} else {
692		s3c2410_dma_lastxfer(chan);
693
694		/* see if we can stop this channel.. */
695		if (chan->load_state == S3C2410_DMALOAD_NONE) {
696			pr_debug("dma%d: end of transfer, stopping channel (%ld)\n",
697				 chan->number, jiffies);
698			s3c2410_dma_ctrl(chan->number | DMACH_LOW_LEVEL,
699					 S3C2410_DMAOP_STOP);
700		}
701	}
702
703 no_load:
704	return IRQ_HANDLED;
705}
706
707static struct s3c2410_dma_chan *s3c2410_dma_map_channel(int channel);
708
709/* s3c2410_request_dma
710 *
711 * get control of an dma channel
712*/
713
714int s3c2410_dma_request(enum dma_ch channel,
715			struct s3c2410_dma_client *client,
716			void *dev)
717{
718	struct s3c2410_dma_chan *chan;
719	unsigned long flags;
720	int err;
721
722	pr_debug("dma%d: s3c2410_request_dma: client=%s, dev=%p\n",
723		 channel, client->name, dev);
724
725	local_irq_save(flags);
726
727	chan = s3c2410_dma_map_channel(channel);
728	if (chan == NULL) {
729		local_irq_restore(flags);
730		return -EBUSY;
731	}
732
733	dbg_showchan(chan);
734
735	chan->client = client;
736	chan->in_use = 1;
737
738	if (!chan->irq_claimed) {
739		pr_debug("dma%d: %s : requesting irq %d\n",
740			 channel, __func__, chan->irq);
741
742		chan->irq_claimed = 1;
743		local_irq_restore(flags);
744
745		err = request_irq(chan->irq, s3c2410_dma_irq, IRQF_DISABLED,
746				  client->name, (void *)chan);
747
748		local_irq_save(flags);
749
750		if (err) {
751			chan->in_use = 0;
752			chan->irq_claimed = 0;
753			local_irq_restore(flags);
754
755			printk(KERN_ERR "%s: cannot get IRQ %d for DMA %d\n",
756			       client->name, chan->irq, chan->number);
757			return err;
758		}
759
760		chan->irq_enabled = 1;
761	}
762
763	local_irq_restore(flags);
764
765	/* need to setup */
766
767	pr_debug("%s: channel initialised, %p\n", __func__, chan);
768
769	return chan->number | DMACH_LOW_LEVEL;
770}
771
772EXPORT_SYMBOL(s3c2410_dma_request);
773
774/* s3c2410_dma_free
775 *
776 * release the given channel back to the system, will stop and flush
777 * any outstanding transfers, and ensure the channel is ready for the
778 * next claimant.
779 *
780 * Note, although a warning is currently printed if the freeing client
781 * info is not the same as the registrant's client info, the free is still
782 * allowed to go through.
783*/
784
785int s3c2410_dma_free(enum dma_ch channel, struct s3c2410_dma_client *client)
786{
787	struct s3c2410_dma_chan *chan = s3c_dma_lookup_channel(channel);
788	unsigned long flags;
789
790	if (chan == NULL)
791		return -EINVAL;
792
793	local_irq_save(flags);
794
795	if (chan->client != client) {
796		printk(KERN_WARNING "dma%d: possible free from different client (channel %p, passed %p)\n",
797		       channel, chan->client, client);
798	}
799
800	/* sort out stopping and freeing the channel */
801
802	if (chan->state != S3C2410_DMA_IDLE) {
803		pr_debug("%s: need to stop dma channel %p\n",
804		       __func__, chan);
805
806		/* possibly flush the channel */
807		s3c2410_dma_ctrl(channel, S3C2410_DMAOP_STOP);
808	}
809
810	chan->client = NULL;
811	chan->in_use = 0;
812
813	if (chan->irq_claimed)
814		free_irq(chan->irq, (void *)chan);
815
816	chan->irq_claimed = 0;
817
818	if (!(channel & DMACH_LOW_LEVEL))
819		s3c_dma_chan_map[channel] = NULL;
820
821	local_irq_restore(flags);
822
823	return 0;
824}
825
826EXPORT_SYMBOL(s3c2410_dma_free);
827
828static int s3c2410_dma_dostop(struct s3c2410_dma_chan *chan)
829{
830	unsigned long flags;
831	unsigned long tmp;
832
833	pr_debug("%s:\n", __func__);
834
835	dbg_showchan(chan);
836
837	local_irq_save(flags);
838
839	s3c2410_dma_call_op(chan,  S3C2410_DMAOP_STOP);
840
841	tmp = dma_rdreg(chan, S3C2410_DMA_DMASKTRIG);
842	tmp |= S3C2410_DMASKTRIG_STOP;
843	//tmp &= ~S3C2410_DMASKTRIG_ON;
844	dma_wrreg(chan, S3C2410_DMA_DMASKTRIG, tmp);
845
846#if 0
847	/* should also clear interrupts, according to WinCE BSP */
848	tmp = dma_rdreg(chan, S3C2410_DMA_DCON);
849	tmp |= S3C2410_DCON_NORELOAD;
850	dma_wrreg(chan, S3C2410_DMA_DCON, tmp);
851#endif
852
853	/* should stop do this, or should we wait for flush? */
854	chan->state      = S3C2410_DMA_IDLE;
855	chan->load_state = S3C2410_DMALOAD_NONE;
856
857	local_irq_restore(flags);
858
859	return 0;
860}
861
862static void s3c2410_dma_waitforstop(struct s3c2410_dma_chan *chan)
863{
864	unsigned long tmp;
865	unsigned int timeout = 0x10000;
866
867	while (timeout-- > 0) {
868		tmp = dma_rdreg(chan, S3C2410_DMA_DMASKTRIG);
869
870		if (!(tmp & S3C2410_DMASKTRIG_ON))
871			return;
872	}
873
874	pr_debug("dma%d: failed to stop?\n", chan->number);
875}
876
877
878/* s3c2410_dma_flush
879 *
880 * stop the channel, and remove all current and pending transfers
881*/
882
883static int s3c2410_dma_flush(struct s3c2410_dma_chan *chan)
884{
885	struct s3c2410_dma_buf *buf, *next;
886	unsigned long flags;
887
888	pr_debug("%s: chan %p (%d)\n", __func__, chan, chan->number);
889
890	dbg_showchan(chan);
891
892	local_irq_save(flags);
893
894	if (chan->state != S3C2410_DMA_IDLE) {
895		pr_debug("%s: stopping channel...\n", __func__ );
896		s3c2410_dma_ctrl(chan->number, S3C2410_DMAOP_STOP);
897	}
898
899	buf = chan->curr;
900	if (buf == NULL)
901		buf = chan->next;
902
903	chan->curr = chan->next = chan->end = NULL;
904
905	if (buf != NULL) {
906		for ( ; buf != NULL; buf = next) {
907			next = buf->next;
908
909			pr_debug("%s: free buffer %p, next %p\n",
910			       __func__, buf, buf->next);
911
912			s3c2410_dma_buffdone(chan, buf, S3C2410_RES_ABORT);
913			s3c2410_dma_freebuf(buf);
914		}
915	}
916
917	dbg_showregs(chan);
918
919	s3c2410_dma_waitforstop(chan);
920
921#if 0
922	/* should also clear interrupts, according to WinCE BSP */
923	{
924		unsigned long tmp;
925
926		tmp = dma_rdreg(chan, S3C2410_DMA_DCON);
927		tmp |= S3C2410_DCON_NORELOAD;
928		dma_wrreg(chan, S3C2410_DMA_DCON, tmp);
929	}
930#endif
931
932	dbg_showregs(chan);
933
934	local_irq_restore(flags);
935
936	return 0;
937}
938
939static int s3c2410_dma_started(struct s3c2410_dma_chan *chan)
940{
941	unsigned long flags;
942
943	local_irq_save(flags);
944
945	dbg_showchan(chan);
946
947	/* if we've only loaded one buffer onto the channel, then chec
948	 * to see if we have another, and if so, try and load it so when
949	 * the first buffer is finished, the new one will be loaded onto
950	 * the channel */
951
952	if (chan->next != NULL) {
953		if (chan->load_state == S3C2410_DMALOAD_1LOADED) {
954
955			if (s3c2410_dma_waitforload(chan, __LINE__) == 0) {
956				pr_debug("%s: buff not yet loaded, no more todo\n",
957					 __func__);
958			} else {
959				chan->load_state = S3C2410_DMALOAD_1RUNNING;
960				s3c2410_dma_loadbuffer(chan, chan->next);
961			}
962
963		} else if (chan->load_state == S3C2410_DMALOAD_1RUNNING) {
964			s3c2410_dma_loadbuffer(chan, chan->next);
965		}
966	}
967
968
969	local_irq_restore(flags);
970
971	return 0;
972
973}
974
975int
976s3c2410_dma_ctrl(enum dma_ch channel, enum s3c2410_chan_op op)
977{
978	struct s3c2410_dma_chan *chan = s3c_dma_lookup_channel(channel);
979
980	if (chan == NULL)
981		return -EINVAL;
982
983	switch (op) {
984	case S3C2410_DMAOP_START:
985		return s3c2410_dma_start(chan);
986
987	case S3C2410_DMAOP_STOP:
988		return s3c2410_dma_dostop(chan);
989
990	case S3C2410_DMAOP_PAUSE:
991	case S3C2410_DMAOP_RESUME:
992		return -ENOENT;
993
994	case S3C2410_DMAOP_FLUSH:
995		return s3c2410_dma_flush(chan);
996
997	case S3C2410_DMAOP_STARTED:
998		return s3c2410_dma_started(chan);
999
1000	case S3C2410_DMAOP_TIMEOUT:
1001		return 0;
1002
1003	}
1004
1005	return -ENOENT;      /* unknown, don't bother */
1006}
1007
1008EXPORT_SYMBOL(s3c2410_dma_ctrl);
1009
1010/* DMA configuration for each channel
1011 *
1012 * DISRCC -> source of the DMA (AHB,APB)
1013 * DISRC  -> source address of the DMA
1014 * DIDSTC -> destination of the DMA (AHB,APD)
1015 * DIDST  -> destination address of the DMA
1016*/
1017
1018/* s3c2410_dma_config
1019 *
1020 * xfersize:     size of unit in bytes (1,2,4)
1021*/
1022
1023int s3c2410_dma_config(enum dma_ch channel,
1024		       int xferunit)
1025{
1026	struct s3c2410_dma_chan *chan = s3c_dma_lookup_channel(channel);
1027	unsigned int dcon;
1028
1029	pr_debug("%s: chan=%d, xfer_unit=%d\n", __func__, channel, xferunit);
1030
1031	if (chan == NULL)
1032		return -EINVAL;
1033
1034	dcon = chan->dcon & dma_sel.dcon_mask;
1035	pr_debug("%s: dcon is %08x\n", __func__, dcon);
1036
1037	switch (chan->req_ch) {
1038	case DMACH_I2S_IN:
1039	case DMACH_I2S_OUT:
1040	case DMACH_PCM_IN:
1041	case DMACH_PCM_OUT:
1042	case DMACH_MIC_IN:
1043	default:
1044		dcon |= S3C2410_DCON_HANDSHAKE;
1045		dcon |= S3C2410_DCON_SYNC_PCLK;
1046		break;
1047
1048	case DMACH_SDI:
1049		/* note, ensure if need HANDSHAKE or not */
1050		dcon |= S3C2410_DCON_SYNC_PCLK;
1051		break;
1052
1053	case DMACH_XD0:
1054	case DMACH_XD1:
1055		dcon |= S3C2410_DCON_HANDSHAKE;
1056		dcon |= S3C2410_DCON_SYNC_HCLK;
1057		break;
1058	}
1059
1060	switch (xferunit) {
1061	case 1:
1062		dcon |= S3C2410_DCON_BYTE;
1063		break;
1064
1065	case 2:
1066		dcon |= S3C2410_DCON_HALFWORD;
1067		break;
1068
1069	case 4:
1070		dcon |= S3C2410_DCON_WORD;
1071		break;
1072
1073	default:
1074		pr_debug("%s: bad transfer size %d\n", __func__, xferunit);
1075		return -EINVAL;
1076	}
1077
1078	dcon |= S3C2410_DCON_HWTRIG;
1079	dcon |= S3C2410_DCON_INTREQ;
1080
1081	pr_debug("%s: dcon now %08x\n", __func__, dcon);
1082
1083	chan->dcon = dcon;
1084	chan->xfer_unit = xferunit;
1085
1086	return 0;
1087}
1088
1089EXPORT_SYMBOL(s3c2410_dma_config);
1090
1091
1092/* s3c2410_dma_devconfig
1093 *
1094 * configure the dma source/destination hardware type and address
1095 *
1096 * source:    DMA_FROM_DEVICE: source is hardware
1097 *            DMA_TO_DEVICE: source is memory
1098 *
1099 * devaddr:   physical address of the source
1100*/
1101
1102int s3c2410_dma_devconfig(enum dma_ch channel,
1103			  enum dma_data_direction source,
1104			  unsigned long devaddr)
1105{
1106	struct s3c2410_dma_chan *chan = s3c_dma_lookup_channel(channel);
1107	unsigned int hwcfg;
1108
1109	if (chan == NULL)
1110		return -EINVAL;
1111
1112	pr_debug("%s: source=%d, devaddr=%08lx\n",
1113		 __func__, (int)source, devaddr);
1114
1115	chan->source = source;
1116	chan->dev_addr = devaddr;
1117
1118	switch (chan->req_ch) {
1119	case DMACH_XD0:
1120	case DMACH_XD1:
1121		hwcfg = 0; /* AHB */
1122		break;
1123
1124	default:
1125		hwcfg = S3C2410_DISRCC_APB;
1126	}
1127
1128	/* always assume our peripheral desintation is a fixed
1129	 * address in memory. */
1130	 hwcfg |= S3C2410_DISRCC_INC;
1131
1132	switch (source) {
1133	case DMA_FROM_DEVICE:
1134		/* source is hardware */
1135		pr_debug("%s: hw source, devaddr=%08lx, hwcfg=%d\n",
1136			 __func__, devaddr, hwcfg);
1137		dma_wrreg(chan, S3C2410_DMA_DISRCC, hwcfg & 3);
1138		dma_wrreg(chan, S3C2410_DMA_DISRC,  devaddr);
1139		dma_wrreg(chan, S3C2410_DMA_DIDSTC, (0<<1) | (0<<0));
1140
1141		chan->addr_reg = dma_regaddr(chan, S3C2410_DMA_DIDST);
1142		break;
1143
1144	case DMA_TO_DEVICE:
1145		/* source is memory */
1146		pr_debug("%s: mem source, devaddr=%08lx, hwcfg=%d\n",
1147			 __func__, devaddr, hwcfg);
1148		dma_wrreg(chan, S3C2410_DMA_DISRCC, (0<<1) | (0<<0));
1149		dma_wrreg(chan, S3C2410_DMA_DIDST,  devaddr);
1150		dma_wrreg(chan, S3C2410_DMA_DIDSTC, hwcfg & 3);
1151
1152		chan->addr_reg = dma_regaddr(chan, S3C2410_DMA_DISRC);
1153		break;
1154
1155	default:
1156		printk(KERN_ERR "dma%d: invalid source type (%d)\n",
1157		       channel, source);
1158
1159		return -EINVAL;
1160	}
1161
1162	if (dma_sel.direction != NULL)
1163		(dma_sel.direction)(chan, chan->map, source);
1164
1165	return 0;
1166}
1167
1168EXPORT_SYMBOL(s3c2410_dma_devconfig);
1169
1170/* s3c2410_dma_getposition
1171 *
1172 * returns the current transfer points for the dma source and destination
1173*/
1174
1175int s3c2410_dma_getposition(enum dma_ch channel, dma_addr_t *src, dma_addr_t *dst)
1176{
1177	struct s3c2410_dma_chan *chan = s3c_dma_lookup_channel(channel);
1178
1179	if (chan == NULL)
1180		return -EINVAL;
1181
1182	if (src != NULL)
1183 		*src = dma_rdreg(chan, S3C2410_DMA_DCSRC);
1184
1185 	if (dst != NULL)
1186 		*dst = dma_rdreg(chan, S3C2410_DMA_DCDST);
1187
1188 	return 0;
1189}
1190
1191EXPORT_SYMBOL(s3c2410_dma_getposition);
1192
1193/* system core operations */
1194
1195#ifdef CONFIG_PM
1196
1197static void s3c2410_dma_suspend_chan(struct s3c2410_dma_chan *cp)
1198{
1199	printk(KERN_DEBUG "suspending dma channel %d\n", cp->number);
1200
1201	if (dma_rdreg(cp, S3C2410_DMA_DMASKTRIG) & S3C2410_DMASKTRIG_ON) {
1202		/* the dma channel is still working, which is probably
1203		 * a bad thing to do over suspend/resume. We stop the
1204		 * channel and assume that the client is either going to
1205		 * retry after resume, or that it is broken.
1206		 */
1207
1208		printk(KERN_INFO "dma: stopping channel %d due to suspend\n",
1209		       cp->number);
1210
1211		s3c2410_dma_dostop(cp);
1212	}
1213}
1214
1215static int s3c2410_dma_suspend(void)
1216{
1217	struct s3c2410_dma_chan *cp = s3c2410_chans;
1218	int channel;
1219
1220	for (channel = 0; channel < dma_channels; cp++, channel++)
1221		s3c2410_dma_suspend_chan(cp);
1222
1223	return 0;
1224}
1225
1226static void s3c2410_dma_resume_chan(struct s3c2410_dma_chan *cp)
1227{
1228	unsigned int no = cp->number | DMACH_LOW_LEVEL;
1229
1230	/* restore channel's hardware configuration */
1231
1232	if (!cp->in_use)
1233		return;
1234
1235	printk(KERN_INFO "dma%d: restoring configuration\n", cp->number);
1236
1237	s3c2410_dma_config(no, cp->xfer_unit);
1238	s3c2410_dma_devconfig(no, cp->source, cp->dev_addr);
1239
1240	/* re-select the dma source for this channel */
1241
1242	if (cp->map != NULL)
1243		dma_sel.select(cp, cp->map);
1244}
1245
1246static void s3c2410_dma_resume(void)
1247{
1248	struct s3c2410_dma_chan *cp = s3c2410_chans + dma_channels - 1;
1249	int channel;
1250
1251	for (channel = dma_channels - 1; channel >= 0; cp--, channel--)
1252		s3c2410_dma_resume_chan(cp);
1253}
1254
1255#else
1256#define s3c2410_dma_suspend NULL
1257#define s3c2410_dma_resume  NULL
1258#endif /* CONFIG_PM */
1259
1260struct syscore_ops dma_syscore_ops = {
1261	.suspend	= s3c2410_dma_suspend,
1262	.resume		= s3c2410_dma_resume,
1263};
1264
1265/* kmem cache implementation */
1266
1267static void s3c2410_dma_cache_ctor(void *p)
1268{
1269	memset(p, 0, sizeof(struct s3c2410_dma_buf));
1270}
1271
1272/* initialisation code */
1273
1274static int __init s3c24xx_dma_syscore_init(void)
1275{
1276	register_syscore_ops(&dma_syscore_ops);
1277
1278	return 0;
1279}
1280
1281late_initcall(s3c24xx_dma_syscore_init);
1282
1283int __init s3c24xx_dma_init(unsigned int channels, unsigned int irq,
1284			    unsigned int stride)
1285{
1286	struct s3c2410_dma_chan *cp;
1287	int channel;
1288	int ret;
1289
1290	printk("S3C24XX DMA Driver, Copyright 2003-2006 Simtec Electronics\n");
1291
1292	dma_channels = channels;
1293
1294	dma_base = ioremap(S3C24XX_PA_DMA, stride * channels);
1295	if (dma_base == NULL) {
1296		printk(KERN_ERR "dma failed to remap register block\n");
1297		return -ENOMEM;
1298	}
1299
1300	dma_kmem = kmem_cache_create("dma_desc",
1301				     sizeof(struct s3c2410_dma_buf), 0,
1302				     SLAB_HWCACHE_ALIGN,
1303				     s3c2410_dma_cache_ctor);
1304
1305	if (dma_kmem == NULL) {
1306		printk(KERN_ERR "dma failed to make kmem cache\n");
1307		ret = -ENOMEM;
1308		goto err;
1309	}
1310
1311	for (channel = 0; channel < channels;  channel++) {
1312		cp = &s3c2410_chans[channel];
1313
1314		memset(cp, 0, sizeof(struct s3c2410_dma_chan));
1315
1316		/* dma channel irqs are in order.. */
1317		cp->number = channel;
1318		cp->irq    = channel + irq;
1319		cp->regs   = dma_base + (channel * stride);
1320
1321		/* point current stats somewhere */
1322		cp->stats  = &cp->stats_store;
1323		cp->stats_store.timeout_shortest = LONG_MAX;
1324
1325		/* basic channel configuration */
1326
1327		cp->load_timeout = 1<<18;
1328
1329		printk("DMA channel %d at %p, irq %d\n",
1330		       cp->number, cp->regs, cp->irq);
1331	}
1332
1333	return 0;
1334
1335 err:
1336	kmem_cache_destroy(dma_kmem);
1337	iounmap(dma_base);
1338	dma_base = NULL;
1339	return ret;
1340}
1341
1342int __init s3c2410_dma_init(void)
1343{
1344	return s3c24xx_dma_init(4, IRQ_DMA0, 0x40);
1345}
1346
1347static inline int is_channel_valid(unsigned int channel)
1348{
1349	return (channel & DMA_CH_VALID);
1350}
1351
1352static struct s3c24xx_dma_order *dma_order;
1353
1354
1355/* s3c2410_dma_map_channel()
1356 *
1357 * turn the virtual channel number into a real, and un-used hardware
1358 * channel.
1359 *
1360 * first, try the dma ordering given to us by either the relevant
1361 * dma code, or the board. Then just find the first usable free
1362 * channel
1363*/
1364
1365static struct s3c2410_dma_chan *s3c2410_dma_map_channel(int channel)
1366{
1367	struct s3c24xx_dma_order_ch *ord = NULL;
1368	struct s3c24xx_dma_map *ch_map;
1369	struct s3c2410_dma_chan *dmach;
1370	int ch;
1371
1372	if (dma_sel.map == NULL || channel > dma_sel.map_size)
1373		return NULL;
1374
1375	ch_map = dma_sel.map + channel;
1376
1377	/* first, try the board mapping */
1378
1379	if (dma_order) {
1380		ord = &dma_order->channels[channel];
1381
1382		for (ch = 0; ch < dma_channels; ch++) {
1383			int tmp;
1384			if (!is_channel_valid(ord->list[ch]))
1385				continue;
1386
1387			tmp = ord->list[ch] & ~DMA_CH_VALID;
1388			if (s3c2410_chans[tmp].in_use == 0) {
1389				ch = tmp;
1390				goto found;
1391			}
1392		}
1393
1394		if (ord->flags & DMA_CH_NEVER)
1395			return NULL;
1396	}
1397
1398	/* second, search the channel map for first free */
1399
1400	for (ch = 0; ch < dma_channels; ch++) {
1401		if (!is_channel_valid(ch_map->channels[ch]))
1402			continue;
1403
1404		if (s3c2410_chans[ch].in_use == 0) {
1405			printk("mapped channel %d to %d\n", channel, ch);
1406			break;
1407		}
1408	}
1409
1410	if (ch >= dma_channels)
1411		return NULL;
1412
1413	/* update our channel mapping */
1414
1415 found:
1416	dmach = &s3c2410_chans[ch];
1417	dmach->map = ch_map;
1418	dmach->req_ch = channel;
1419	s3c_dma_chan_map[channel] = dmach;
1420
1421	/* select the channel */
1422
1423	(dma_sel.select)(dmach, ch_map);
1424
1425	return dmach;
1426}
1427
1428static int s3c24xx_dma_check_entry(struct s3c24xx_dma_map *map, int ch)
1429{
1430	return 0;
1431}
1432
1433int __init s3c24xx_dma_init_map(struct s3c24xx_dma_selection *sel)
1434{
1435	struct s3c24xx_dma_map *nmap;
1436	size_t map_sz = sizeof(*nmap) * sel->map_size;
1437	int ptr;
1438
1439	nmap = kmemdup(sel->map, map_sz, GFP_KERNEL);
1440	if (nmap == NULL)
1441		return -ENOMEM;
1442
1443	memcpy(&dma_sel, sel, sizeof(*sel));
1444
1445	dma_sel.map = nmap;
1446
1447	for (ptr = 0; ptr < sel->map_size; ptr++)
1448		s3c24xx_dma_check_entry(nmap+ptr, ptr);
1449
1450	return 0;
1451}
1452
1453int __init s3c24xx_dma_order_set(struct s3c24xx_dma_order *ord)
1454{
1455	struct s3c24xx_dma_order *nord = dma_order;
1456
1457	if (nord == NULL)
1458		nord = kmalloc(sizeof(struct s3c24xx_dma_order), GFP_KERNEL);
1459
1460	if (nord == NULL) {
1461		printk(KERN_ERR "no memory to store dma channel order\n");
1462		return -ENOMEM;
1463	}
1464
1465	dma_order = nord;
1466	memcpy(nord, ord, sizeof(struct s3c24xx_dma_order));
1467	return 0;
1468}
1469