2 * drivers/dma/imx-sdma.c
4 * This file contains a driver for the Freescale Smart DMA engine
6 * Copyright 2010 Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>
8 * Based on code from Freescale:
10 * Copyright 2004-2009 Freescale Semiconductor, Inc. All Rights Reserved.
12 * The code contained herein is licensed under the GNU General Public
13 * License. You may obtain a copy of the GNU General Public License
14 * Version 2 or later at the following locations:
16 * http://www.opensource.org/licenses/gpl-license.html
17 * http://www.gnu.org/copyleft/gpl.html
20 #include <linux/init.h>
21 #include <linux/types.h>
23 #include <linux/interrupt.h>
24 #include <linux/clk.h>
25 #include <linux/wait.h>
26 #include <linux/sched.h>
27 #include <linux/semaphore.h>
28 #include <linux/spinlock.h>
29 #include <linux/device.h>
30 #include <linux/dma-mapping.h>
31 #include <linux/firmware.h>
32 #include <linux/slab.h>
33 #include <linux/platform_device.h>
34 #include <linux/dmaengine.h>
37 #include <mach/sdma.h>
39 #include <mach/hardware.h>
42 #define SDMA_H_C0PTR 0x000
43 #define SDMA_H_INTR 0x004
44 #define SDMA_H_STATSTOP 0x008
45 #define SDMA_H_START 0x00c
46 #define SDMA_H_EVTOVR 0x010
47 #define SDMA_H_DSPOVR 0x014
48 #define SDMA_H_HOSTOVR 0x018
49 #define SDMA_H_EVTPEND 0x01c
50 #define SDMA_H_DSPENBL 0x020
51 #define SDMA_H_RESET 0x024
52 #define SDMA_H_EVTERR 0x028
53 #define SDMA_H_INTRMSK 0x02c
54 #define SDMA_H_PSW 0x030
55 #define SDMA_H_EVTERRDBG 0x034
56 #define SDMA_H_CONFIG 0x038
57 #define SDMA_ONCE_ENB 0x040
58 #define SDMA_ONCE_DATA 0x044
59 #define SDMA_ONCE_INSTR 0x048
60 #define SDMA_ONCE_STAT 0x04c
61 #define SDMA_ONCE_CMD 0x050
62 #define SDMA_EVT_MIRROR 0x054
63 #define SDMA_ILLINSTADDR 0x058
64 #define SDMA_CHN0ADDR 0x05c
65 #define SDMA_ONCE_RTB 0x060
66 #define SDMA_XTRIG_CONF1 0x070
67 #define SDMA_XTRIG_CONF2 0x074
68 #define SDMA_CHNENBL0_V2 0x200
69 #define SDMA_CHNENBL0_V1 0x080
70 #define SDMA_CHNPRI_0 0x100
73 * Buffer descriptor status values.
84 * Data Node descriptor status values.
86 #define DND_END_OF_FRAME 0x80
87 #define DND_END_OF_XFER 0x40
89 #define DND_UNUSED 0x01
92 * IPCV2 descriptor status values.
94 #define BD_IPCV2_END_OF_FRAME 0x40
96 #define IPCV2_MAX_NODES 50
98 * Error bit set in the CCB status field by the SDMA,
99 * in setbd routine, in case of a transfer error
101 #define DATA_ERROR 0x10000000
104 * Buffer descriptor commands.
109 #define C0_SETCTX 0x07
110 #define C0_GETCTX 0x03
111 #define C0_SETDM 0x01
112 #define C0_SETPM 0x04
113 #define C0_GETDM 0x02
114 #define C0_GETPM 0x08
116 * Change endianness indicator in the BD command field
118 #define CHANGE_ENDIANNESS 0x80
121 * Mode/Count of data node descriptors - IPCv2
123 struct sdma_mode_count {
124 u32 count : 16; /* size of the buffer pointed by this BD */
125 u32 status : 8; /* E,R,I,C,W,D status bits stored here */
126 u32 command : 8; /* command mostlky used for channel 0 */
132 struct sdma_buffer_descriptor {
133 struct sdma_mode_count mode;
134 u32 buffer_addr; /* address of the buffer described */
135 u32 ext_buffer_addr; /* extended buffer address */
136 } __attribute__ ((packed));
139 * struct sdma_channel_control - Channel control Block
141 * @current_bd_ptr current buffer descriptor processed
142 * @base_bd_ptr first element of buffer descriptor array
143 * @unused padding. The SDMA engine expects an array of 128 byte
146 struct sdma_channel_control {
150 } __attribute__ ((packed));
153 * struct sdma_state_registers - SDMA context for a channel
155 * @pc: program counter
156 * @t: test bit: status of arithmetic & test instruction
157 * @rpc: return program counter
158 * @sf: source fault while loading data
159 * @spc: loop start program counter
160 * @df: destination fault while storing data
161 * @epc: loop end program counter
164 struct sdma_state_registers {
176 } __attribute__ ((packed));
179 * struct sdma_context_data - sdma context specific to a channel
181 * @channel_state: channel state bits
182 * @gReg: general registers
183 * @mda: burst dma destination address register
184 * @msa: burst dma source address register
185 * @ms: burst dma status register
186 * @md: burst dma data register
187 * @pda: peripheral dma destination address register
188 * @psa: peripheral dma source address register
189 * @ps: peripheral dma status register
190 * @pd: peripheral dma data register
191 * @ca: CRC polynomial register
192 * @cs: CRC accumulator register
193 * @dda: dedicated core destination address register
194 * @dsa: dedicated core source address register
195 * @ds: dedicated core status register
196 * @dd: dedicated core data register
198 struct sdma_context_data {
199 struct sdma_state_registers channel_state;
223 } __attribute__ ((packed));
225 #define NUM_BD (int)(PAGE_SIZE / sizeof(struct sdma_buffer_descriptor))
230 * struct sdma_channel - housekeeping for a SDMA channel
232 * @sdma pointer to the SDMA engine for this channel
233 * @channel the channel number, matches dmaengine chan_id
234 * @direction transfer type. Needed for setting SDMA script
235 * @peripheral_type Peripheral type. Needed for setting SDMA script
236 * @event_id0 aka dma request line
237 * @event_id1 for channels that use 2 events
238 * @word_size peripheral access size
239 * @buf_tail ID of the buffer that was processed
240 * @done channel completion
241 * @num_bd max NUM_BD. number of descriptors currently handling
243 struct sdma_channel {
244 struct sdma_engine *sdma;
245 unsigned int channel;
246 enum dma_data_direction direction;
247 enum sdma_peripheral_type peripheral_type;
248 unsigned int event_id0;
249 unsigned int event_id1;
250 enum dma_slave_buswidth word_size;
251 unsigned int buf_tail;
252 struct completion done;
254 struct sdma_buffer_descriptor *bd;
256 unsigned int pc_from_device, pc_to_device;
258 dma_addr_t per_address;
259 u32 event_mask0, event_mask1;
261 u32 shp_addr, per_addr;
262 struct dma_chan chan;
264 struct dma_async_tx_descriptor desc;
265 dma_cookie_t last_completed;
266 enum dma_status status;
269 #define IMX_DMA_SG_LOOP (1 << 0)
271 #define MAX_DMA_CHANNELS 32
272 #define MXC_SDMA_DEFAULT_PRIORITY 1
273 #define MXC_SDMA_MIN_PRIORITY 1
274 #define MXC_SDMA_MAX_PRIORITY 7
277 * struct sdma_script_start_addrs - SDMA script start pointers
279 * start addresses of the different functions in the physical
280 * address space of the SDMA engine.
282 struct sdma_script_start_addrs {
285 u32 ap_2_ap_fixed_addr;
287 u32 loopback_on_dsp_side_addr;
288 u32 mcu_interrupt_only_addr;
298 u32 uartsh_2_per_addr;
299 u32 uartsh_2_mcu_addr;
310 u32 spdif_2_mcu_addr;
311 u32 mcu_2_spdif_addr;
313 u32 ext_mem_2_ipu_addr;
314 u32 descrambler_addr;
317 u32 ram_code_start_addr;
320 #define SDMA_FIRMWARE_MAGIC 0x414d4453
323 * struct sdma_firmware_header - Layout of the firmware image
326 * @version_major increased whenever layout of struct sdma_script_start_addrs
328 * @version_minor firmware minor version (for binary compatible changes)
329 * @script_addrs_start offset of struct sdma_script_start_addrs in this image
330 * @num_script_addrs Number of script addresses in this image
331 * @ram_code_start offset of SDMA ram image in this firmware image
332 * @ram_code_size size of SDMA ram image
333 * @script_addrs Stores the start address of the SDMA scripts
334 * (in SDMA memory space)
336 struct sdma_firmware_header {
340 u32 script_addrs_start;
341 u32 num_script_addrs;
348 struct sdma_channel channel[MAX_DMA_CHANNELS];
349 struct sdma_channel_control *channel_control;
351 unsigned int version;
352 unsigned int num_events;
353 struct sdma_context_data *context;
354 dma_addr_t context_phys;
355 struct dma_device dma_device;
357 struct sdma_script_start_addrs *script_addrs;
360 #define SDMA_H_CONFIG_DSPDMA (1 << 12) /* indicates if the DSPDMA is used */
361 #define SDMA_H_CONFIG_RTD_PINS (1 << 11) /* indicates if Real-Time Debug pins are enabled */
362 #define SDMA_H_CONFIG_ACR (1 << 4) /* indicates if AHB freq /core freq = 2 or 1 */
363 #define SDMA_H_CONFIG_CSM (3) /* indicates which context switch mode is selected*/
365 static inline u32 chnenbl_ofs(struct sdma_engine *sdma, unsigned int event)
367 u32 chnenbl0 = (sdma->version == 2 ? SDMA_CHNENBL0_V2 : SDMA_CHNENBL0_V1);
369 return chnenbl0 + event * 4;
372 static int sdma_config_ownership(struct sdma_channel *sdmac,
373 bool event_override, bool mcu_override, bool dsp_override)
375 struct sdma_engine *sdma = sdmac->sdma;
376 int channel = sdmac->channel;
379 if (event_override && mcu_override && dsp_override)
382 evt = __raw_readl(sdma->regs + SDMA_H_EVTOVR);
383 mcu = __raw_readl(sdma->regs + SDMA_H_HOSTOVR);
384 dsp = __raw_readl(sdma->regs + SDMA_H_DSPOVR);
387 dsp &= ~(1 << channel);
389 dsp |= (1 << channel);
392 evt &= ~(1 << channel);
394 evt |= (1 << channel);
397 mcu &= ~(1 << channel);
399 mcu |= (1 << channel);
401 __raw_writel(evt, sdma->regs + SDMA_H_EVTOVR);
402 __raw_writel(mcu, sdma->regs + SDMA_H_HOSTOVR);
403 __raw_writel(dsp, sdma->regs + SDMA_H_DSPOVR);
409 * sdma_run_channel - run a channel and wait till it's done
411 static int sdma_run_channel(struct sdma_channel *sdmac)
413 struct sdma_engine *sdma = sdmac->sdma;
414 int channel = sdmac->channel;
417 init_completion(&sdmac->done);
419 __raw_writel(1 << channel, sdma->regs + SDMA_H_START);
421 ret = wait_for_completion_timeout(&sdmac->done, HZ);
423 return ret ? 0 : -ETIMEDOUT;
426 static int sdma_load_script(struct sdma_engine *sdma, void *buf, int size,
429 struct sdma_buffer_descriptor *bd0 = sdma->channel[0].bd;
434 buf_virt = dma_alloc_coherent(NULL,
436 &buf_phys, GFP_KERNEL);
440 bd0->mode.command = C0_SETPM;
441 bd0->mode.status = BD_DONE | BD_INTR | BD_WRAP | BD_EXTD;
442 bd0->mode.count = size / 2;
443 bd0->buffer_addr = buf_phys;
444 bd0->ext_buffer_addr = address;
446 memcpy(buf_virt, buf, size);
448 ret = sdma_run_channel(&sdma->channel[0]);
450 dma_free_coherent(NULL, size, buf_virt, buf_phys);
455 static void sdma_event_enable(struct sdma_channel *sdmac, unsigned int event)
457 struct sdma_engine *sdma = sdmac->sdma;
458 int channel = sdmac->channel;
460 u32 chnenbl = chnenbl_ofs(sdma, event);
462 val = __raw_readl(sdma->regs + chnenbl);
463 val |= (1 << channel);
464 __raw_writel(val, sdma->regs + chnenbl);
467 static void sdma_event_disable(struct sdma_channel *sdmac, unsigned int event)
469 struct sdma_engine *sdma = sdmac->sdma;
470 int channel = sdmac->channel;
471 u32 chnenbl = chnenbl_ofs(sdma, event);
474 val = __raw_readl(sdma->regs + chnenbl);
475 val &= ~(1 << channel);
476 __raw_writel(val, sdma->regs + chnenbl);
479 static void sdma_handle_channel_loop(struct sdma_channel *sdmac)
481 struct sdma_buffer_descriptor *bd;
484 * loop mode. Iterate over descriptors, re-setup them and
485 * call callback function.
488 bd = &sdmac->bd[sdmac->buf_tail];
490 if (bd->mode.status & BD_DONE)
493 if (bd->mode.status & BD_RROR)
494 sdmac->status = DMA_ERROR;
496 sdmac->status = DMA_SUCCESS;
498 bd->mode.status |= BD_DONE;
500 sdmac->buf_tail %= sdmac->num_bd;
502 if (sdmac->desc.callback)
503 sdmac->desc.callback(sdmac->desc.callback_param);
507 static void mxc_sdma_handle_channel_normal(struct sdma_channel *sdmac)
509 struct sdma_buffer_descriptor *bd;
513 * non loop mode. Iterate over all descriptors, collect
514 * errors and call callback function
516 for (i = 0; i < sdmac->num_bd; i++) {
519 if (bd->mode.status & (BD_DONE | BD_RROR))
524 sdmac->status = DMA_ERROR;
526 sdmac->status = DMA_SUCCESS;
528 if (sdmac->desc.callback)
529 sdmac->desc.callback(sdmac->desc.callback_param);
530 sdmac->last_completed = sdmac->desc.cookie;
533 static void mxc_sdma_handle_channel(struct sdma_channel *sdmac)
535 complete(&sdmac->done);
537 /* not interested in channel 0 interrupts */
538 if (sdmac->channel == 0)
541 if (sdmac->flags & IMX_DMA_SG_LOOP)
542 sdma_handle_channel_loop(sdmac);
544 mxc_sdma_handle_channel_normal(sdmac);
547 static irqreturn_t sdma_int_handler(int irq, void *dev_id)
549 struct sdma_engine *sdma = dev_id;
552 stat = __raw_readl(sdma->regs + SDMA_H_INTR);
553 __raw_writel(stat, sdma->regs + SDMA_H_INTR);
556 int channel = fls(stat) - 1;
557 struct sdma_channel *sdmac = &sdma->channel[channel];
559 mxc_sdma_handle_channel(sdmac);
561 stat &= ~(1 << channel);
568 * sets the pc of SDMA script according to the peripheral type
570 static void sdma_get_pc(struct sdma_channel *sdmac,
571 enum sdma_peripheral_type peripheral_type)
573 struct sdma_engine *sdma = sdmac->sdma;
574 int per_2_emi = 0, emi_2_per = 0;
576 * These are needed once we start to support transfers between
577 * two peripherals or memory-to-memory transfers
579 int per_2_per = 0, emi_2_emi = 0;
581 sdmac->pc_from_device = 0;
582 sdmac->pc_to_device = 0;
584 switch (peripheral_type) {
585 case IMX_DMATYPE_MEMORY:
586 emi_2_emi = sdma->script_addrs->ap_2_ap_addr;
588 case IMX_DMATYPE_DSP:
589 emi_2_per = sdma->script_addrs->bp_2_ap_addr;
590 per_2_emi = sdma->script_addrs->ap_2_bp_addr;
592 case IMX_DMATYPE_FIRI:
593 per_2_emi = sdma->script_addrs->firi_2_mcu_addr;
594 emi_2_per = sdma->script_addrs->mcu_2_firi_addr;
596 case IMX_DMATYPE_UART:
597 per_2_emi = sdma->script_addrs->uart_2_mcu_addr;
598 emi_2_per = sdma->script_addrs->mcu_2_app_addr;
600 case IMX_DMATYPE_UART_SP:
601 per_2_emi = sdma->script_addrs->uartsh_2_mcu_addr;
602 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
604 case IMX_DMATYPE_ATA:
605 per_2_emi = sdma->script_addrs->ata_2_mcu_addr;
606 emi_2_per = sdma->script_addrs->mcu_2_ata_addr;
608 case IMX_DMATYPE_CSPI:
609 case IMX_DMATYPE_EXT:
610 case IMX_DMATYPE_SSI:
611 per_2_emi = sdma->script_addrs->app_2_mcu_addr;
612 emi_2_per = sdma->script_addrs->mcu_2_app_addr;
614 case IMX_DMATYPE_SSI_SP:
615 case IMX_DMATYPE_MMC:
616 case IMX_DMATYPE_SDHC:
617 case IMX_DMATYPE_CSPI_SP:
618 case IMX_DMATYPE_ESAI:
619 case IMX_DMATYPE_MSHC_SP:
620 per_2_emi = sdma->script_addrs->shp_2_mcu_addr;
621 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
623 case IMX_DMATYPE_ASRC:
624 per_2_emi = sdma->script_addrs->asrc_2_mcu_addr;
625 emi_2_per = sdma->script_addrs->asrc_2_mcu_addr;
626 per_2_per = sdma->script_addrs->per_2_per_addr;
628 case IMX_DMATYPE_MSHC:
629 per_2_emi = sdma->script_addrs->mshc_2_mcu_addr;
630 emi_2_per = sdma->script_addrs->mcu_2_mshc_addr;
632 case IMX_DMATYPE_CCM:
633 per_2_emi = sdma->script_addrs->dptc_dvfs_addr;
635 case IMX_DMATYPE_SPDIF:
636 per_2_emi = sdma->script_addrs->spdif_2_mcu_addr;
637 emi_2_per = sdma->script_addrs->mcu_2_spdif_addr;
639 case IMX_DMATYPE_IPU_MEMORY:
640 emi_2_per = sdma->script_addrs->ext_mem_2_ipu_addr;
646 sdmac->pc_from_device = per_2_emi;
647 sdmac->pc_to_device = emi_2_per;
650 static int sdma_load_context(struct sdma_channel *sdmac)
652 struct sdma_engine *sdma = sdmac->sdma;
653 int channel = sdmac->channel;
655 struct sdma_context_data *context = sdma->context;
656 struct sdma_buffer_descriptor *bd0 = sdma->channel[0].bd;
659 if (sdmac->direction == DMA_FROM_DEVICE) {
660 load_address = sdmac->pc_from_device;
662 load_address = sdmac->pc_to_device;
665 if (load_address < 0)
668 dev_dbg(sdma->dev, "load_address = %d\n", load_address);
669 dev_dbg(sdma->dev, "wml = 0x%08x\n", sdmac->watermark_level);
670 dev_dbg(sdma->dev, "shp_addr = 0x%08x\n", sdmac->shp_addr);
671 dev_dbg(sdma->dev, "per_addr = 0x%08x\n", sdmac->per_addr);
672 dev_dbg(sdma->dev, "event_mask0 = 0x%08x\n", sdmac->event_mask0);
673 dev_dbg(sdma->dev, "event_mask1 = 0x%08x\n", sdmac->event_mask1);
675 memset(context, 0, sizeof(*context));
676 context->channel_state.pc = load_address;
678 /* Send by context the event mask,base address for peripheral
679 * and watermark level
681 context->gReg[0] = sdmac->event_mask1;
682 context->gReg[1] = sdmac->event_mask0;
683 context->gReg[2] = sdmac->per_addr;
684 context->gReg[6] = sdmac->shp_addr;
685 context->gReg[7] = sdmac->watermark_level;
687 bd0->mode.command = C0_SETDM;
688 bd0->mode.status = BD_DONE | BD_INTR | BD_WRAP | BD_EXTD;
689 bd0->mode.count = sizeof(*context) / 4;
690 bd0->buffer_addr = sdma->context_phys;
691 bd0->ext_buffer_addr = 2048 + (sizeof(*context) / 4) * channel;
693 ret = sdma_run_channel(&sdma->channel[0]);
698 static void sdma_disable_channel(struct sdma_channel *sdmac)
700 struct sdma_engine *sdma = sdmac->sdma;
701 int channel = sdmac->channel;
703 __raw_writel(1 << channel, sdma->regs + SDMA_H_STATSTOP);
704 sdmac->status = DMA_ERROR;
707 static int sdma_config_channel(struct sdma_channel *sdmac)
711 sdma_disable_channel(sdmac);
713 sdmac->event_mask0 = 0;
714 sdmac->event_mask1 = 0;
718 if (sdmac->event_id0) {
719 if (sdmac->event_id0 > 32)
721 sdma_event_enable(sdmac, sdmac->event_id0);
724 switch (sdmac->peripheral_type) {
725 case IMX_DMATYPE_DSP:
726 sdma_config_ownership(sdmac, false, true, true);
728 case IMX_DMATYPE_MEMORY:
729 sdma_config_ownership(sdmac, false, true, false);
732 sdma_config_ownership(sdmac, true, true, false);
736 sdma_get_pc(sdmac, sdmac->peripheral_type);
738 if ((sdmac->peripheral_type != IMX_DMATYPE_MEMORY) &&
739 (sdmac->peripheral_type != IMX_DMATYPE_DSP)) {
740 /* Handle multiple event channels differently */
741 if (sdmac->event_id1) {
742 sdmac->event_mask1 = 1 << (sdmac->event_id1 % 32);
743 if (sdmac->event_id1 > 31)
744 sdmac->watermark_level |= 1 << 31;
745 sdmac->event_mask0 = 1 << (sdmac->event_id0 % 32);
746 if (sdmac->event_id0 > 31)
747 sdmac->watermark_level |= 1 << 30;
749 sdmac->event_mask0 = 1 << sdmac->event_id0;
750 sdmac->event_mask1 = 1 << (sdmac->event_id0 - 32);
752 /* Watermark Level */
753 sdmac->watermark_level |= sdmac->watermark_level;
755 sdmac->shp_addr = sdmac->per_address;
757 sdmac->watermark_level = 0; /* FIXME: M3_BASE_ADDRESS */
760 ret = sdma_load_context(sdmac);
765 static int sdma_set_channel_priority(struct sdma_channel *sdmac,
766 unsigned int priority)
768 struct sdma_engine *sdma = sdmac->sdma;
769 int channel = sdmac->channel;
771 if (priority < MXC_SDMA_MIN_PRIORITY
772 || priority > MXC_SDMA_MAX_PRIORITY) {
776 __raw_writel(priority, sdma->regs + SDMA_CHNPRI_0 + 4 * channel);
781 static int sdma_request_channel(struct sdma_channel *sdmac)
783 struct sdma_engine *sdma = sdmac->sdma;
784 int channel = sdmac->channel;
787 sdmac->bd = dma_alloc_coherent(NULL, PAGE_SIZE, &sdmac->bd_phys, GFP_KERNEL);
793 memset(sdmac->bd, 0, PAGE_SIZE);
795 sdma->channel_control[channel].base_bd_ptr = sdmac->bd_phys;
796 sdma->channel_control[channel].current_bd_ptr = sdmac->bd_phys;
798 clk_enable(sdma->clk);
800 sdma_set_channel_priority(sdmac, MXC_SDMA_DEFAULT_PRIORITY);
802 init_completion(&sdmac->done);
812 static void sdma_enable_channel(struct sdma_engine *sdma, int channel)
814 __raw_writel(1 << channel, sdma->regs + SDMA_H_START);
817 static dma_cookie_t sdma_assign_cookie(struct sdma_channel *sdma)
819 dma_cookie_t cookie = sdma->chan.cookie;
824 sdma->chan.cookie = cookie;
825 sdma->desc.cookie = cookie;
830 static struct sdma_channel *to_sdma_chan(struct dma_chan *chan)
832 return container_of(chan, struct sdma_channel, chan);
835 static dma_cookie_t sdma_tx_submit(struct dma_async_tx_descriptor *tx)
837 struct sdma_channel *sdmac = to_sdma_chan(tx->chan);
838 struct sdma_engine *sdma = sdmac->sdma;
841 spin_lock_irq(&sdmac->lock);
843 cookie = sdma_assign_cookie(sdmac);
845 sdma_enable_channel(sdma, tx->chan->chan_id);
847 spin_unlock_irq(&sdmac->lock);
852 static int sdma_alloc_chan_resources(struct dma_chan *chan)
854 struct sdma_channel *sdmac = to_sdma_chan(chan);
855 struct imx_dma_data *data = chan->private;
858 /* No need to execute this for internal channel 0 */
859 if (chan->chan_id == 0)
865 switch (data->priority) {
869 case DMA_PRIO_MEDIUM:
878 sdmac->peripheral_type = data->peripheral_type;
879 sdmac->event_id0 = data->dma_request;
880 ret = sdma_set_channel_priority(sdmac, prio);
884 ret = sdma_request_channel(sdmac);
888 dma_async_tx_descriptor_init(&sdmac->desc, chan);
889 sdmac->desc.tx_submit = sdma_tx_submit;
890 /* txd.flags will be overwritten in prep funcs */
891 sdmac->desc.flags = DMA_CTRL_ACK;
896 static void sdma_free_chan_resources(struct dma_chan *chan)
898 struct sdma_channel *sdmac = to_sdma_chan(chan);
899 struct sdma_engine *sdma = sdmac->sdma;
901 sdma_disable_channel(sdmac);
903 if (sdmac->event_id0)
904 sdma_event_disable(sdmac, sdmac->event_id0);
905 if (sdmac->event_id1)
906 sdma_event_disable(sdmac, sdmac->event_id1);
908 sdmac->event_id0 = 0;
909 sdmac->event_id1 = 0;
911 sdma_set_channel_priority(sdmac, 0);
913 dma_free_coherent(NULL, PAGE_SIZE, sdmac->bd, sdmac->bd_phys);
915 clk_disable(sdma->clk);
918 static struct dma_async_tx_descriptor *sdma_prep_slave_sg(
919 struct dma_chan *chan, struct scatterlist *sgl,
920 unsigned int sg_len, enum dma_data_direction direction,
923 struct sdma_channel *sdmac = to_sdma_chan(chan);
924 struct sdma_engine *sdma = sdmac->sdma;
926 int channel = chan->chan_id;
927 struct scatterlist *sg;
929 if (sdmac->status == DMA_IN_PROGRESS)
931 sdmac->status = DMA_IN_PROGRESS;
935 dev_dbg(sdma->dev, "setting up %d entries for channel %d.\n",
938 sdmac->direction = direction;
939 ret = sdma_load_context(sdmac);
943 if (sg_len > NUM_BD) {
944 dev_err(sdma->dev, "SDMA channel %d: maximum number of sg exceeded: %d > %d\n",
945 channel, sg_len, NUM_BD);
950 for_each_sg(sgl, sg, sg_len, i) {
951 struct sdma_buffer_descriptor *bd = &sdmac->bd[i];
954 bd->buffer_addr = sgl->dma_address;
958 if (count > 0xffff) {
959 dev_err(sdma->dev, "SDMA channel %d: maximum bytes for sg entry exceeded: %d > %d\n",
960 channel, count, 0xffff);
965 bd->mode.count = count;
967 if (sdmac->word_size > DMA_SLAVE_BUSWIDTH_4_BYTES) {
971 if (sdmac->word_size == DMA_SLAVE_BUSWIDTH_4_BYTES)
972 bd->mode.command = 0;
974 bd->mode.command = sdmac->word_size;
976 param = BD_DONE | BD_EXTD | BD_CONT;
978 if (sdmac->flags & IMX_DMA_SG_LOOP) {
987 dev_dbg(sdma->dev, "entry %d: count: %d dma: 0x%08x %s%s\n",
988 i, count, sg->dma_address,
989 param & BD_WRAP ? "wrap" : "",
990 param & BD_INTR ? " intr" : "");
992 bd->mode.status = param;
995 sdmac->num_bd = sg_len;
996 sdma->channel_control[channel].current_bd_ptr = sdmac->bd_phys;
1003 static struct dma_async_tx_descriptor *sdma_prep_dma_cyclic(
1004 struct dma_chan *chan, dma_addr_t dma_addr, size_t buf_len,
1005 size_t period_len, enum dma_data_direction direction)
1007 struct sdma_channel *sdmac = to_sdma_chan(chan);
1008 struct sdma_engine *sdma = sdmac->sdma;
1009 int num_periods = buf_len / period_len;
1010 int channel = chan->chan_id;
1011 int ret, i = 0, buf = 0;
1013 dev_dbg(sdma->dev, "%s channel: %d\n", __func__, channel);
1015 if (sdmac->status == DMA_IN_PROGRESS)
1018 sdmac->status = DMA_IN_PROGRESS;
1020 sdmac->flags |= IMX_DMA_SG_LOOP;
1021 sdmac->direction = direction;
1022 ret = sdma_load_context(sdmac);
1026 if (num_periods > NUM_BD) {
1027 dev_err(sdma->dev, "SDMA channel %d: maximum number of sg exceeded: %d > %d\n",
1028 channel, num_periods, NUM_BD);
1032 if (period_len > 0xffff) {
1033 dev_err(sdma->dev, "SDMA channel %d: maximum period size exceeded: %d > %d\n",
1034 channel, period_len, 0xffff);
1038 while (buf < buf_len) {
1039 struct sdma_buffer_descriptor *bd = &sdmac->bd[i];
1042 bd->buffer_addr = dma_addr;
1044 bd->mode.count = period_len;
1046 if (sdmac->word_size > DMA_SLAVE_BUSWIDTH_4_BYTES)
1048 if (sdmac->word_size == DMA_SLAVE_BUSWIDTH_4_BYTES)
1049 bd->mode.command = 0;
1051 bd->mode.command = sdmac->word_size;
1053 param = BD_DONE | BD_EXTD | BD_CONT | BD_INTR;
1054 if (i + 1 == num_periods)
1057 dev_dbg(sdma->dev, "entry %d: count: %d dma: 0x%08x %s%s\n",
1058 i, period_len, dma_addr,
1059 param & BD_WRAP ? "wrap" : "",
1060 param & BD_INTR ? " intr" : "");
1062 bd->mode.status = param;
1064 dma_addr += period_len;
1070 sdmac->num_bd = num_periods;
1071 sdma->channel_control[channel].current_bd_ptr = sdmac->bd_phys;
1073 return &sdmac->desc;
1075 sdmac->status = DMA_ERROR;
1079 static int sdma_control(struct dma_chan *chan, enum dma_ctrl_cmd cmd,
1082 struct sdma_channel *sdmac = to_sdma_chan(chan);
1083 struct dma_slave_config *dmaengine_cfg = (void *)arg;
1086 case DMA_TERMINATE_ALL:
1087 sdma_disable_channel(sdmac);
1089 case DMA_SLAVE_CONFIG:
1090 if (dmaengine_cfg->direction == DMA_FROM_DEVICE) {
1091 sdmac->per_address = dmaengine_cfg->src_addr;
1092 sdmac->watermark_level = dmaengine_cfg->src_maxburst;
1093 sdmac->word_size = dmaengine_cfg->src_addr_width;
1095 sdmac->per_address = dmaengine_cfg->dst_addr;
1096 sdmac->watermark_level = dmaengine_cfg->dst_maxburst;
1097 sdmac->word_size = dmaengine_cfg->dst_addr_width;
1099 return sdma_config_channel(sdmac);
1107 static enum dma_status sdma_tx_status(struct dma_chan *chan,
1108 dma_cookie_t cookie,
1109 struct dma_tx_state *txstate)
1111 struct sdma_channel *sdmac = to_sdma_chan(chan);
1112 dma_cookie_t last_used;
1113 enum dma_status ret;
1115 last_used = chan->cookie;
1117 ret = dma_async_is_complete(cookie, sdmac->last_completed, last_used);
1118 dma_set_tx_state(txstate, sdmac->last_completed, last_used, 0);
1123 static void sdma_issue_pending(struct dma_chan *chan)
1126 * Nothing to do. We only have a single descriptor
1130 static int __init sdma_init(struct sdma_engine *sdma,
1131 void *ram_code, int ram_code_size)
1134 dma_addr_t ccb_phys;
1136 switch (sdma->version) {
1138 sdma->num_events = 32;
1141 sdma->num_events = 48;
1144 dev_err(sdma->dev, "Unknown version %d. aborting\n", sdma->version);
1148 clk_enable(sdma->clk);
1150 /* Be sure SDMA has not started yet */
1151 __raw_writel(0, sdma->regs + SDMA_H_C0PTR);
1153 sdma->channel_control = dma_alloc_coherent(NULL,
1154 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control) +
1155 sizeof(struct sdma_context_data),
1156 &ccb_phys, GFP_KERNEL);
1158 if (!sdma->channel_control) {
1163 sdma->context = (void *)sdma->channel_control +
1164 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control);
1165 sdma->context_phys = ccb_phys +
1166 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control);
1168 /* Zero-out the CCB structures array just allocated */
1169 memset(sdma->channel_control, 0,
1170 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control));
1172 /* disable all channels */
1173 for (i = 0; i < sdma->num_events; i++)
1174 __raw_writel(0, sdma->regs + chnenbl_ofs(sdma, i));
1176 /* All channels have priority 0 */
1177 for (i = 0; i < MAX_DMA_CHANNELS; i++)
1178 __raw_writel(0, sdma->regs + SDMA_CHNPRI_0 + i * 4);
1180 ret = sdma_request_channel(&sdma->channel[0]);
1184 sdma_config_ownership(&sdma->channel[0], false, true, false);
1186 /* Set Command Channel (Channel Zero) */
1187 __raw_writel(0x4050, sdma->regs + SDMA_CHN0ADDR);
1189 /* Set bits of CONFIG register but with static context switching */
1190 /* FIXME: Check whether to set ACR bit depending on clock ratios */
1191 __raw_writel(0, sdma->regs + SDMA_H_CONFIG);
1193 __raw_writel(ccb_phys, sdma->regs + SDMA_H_C0PTR);
1195 /* download the RAM image for SDMA */
1196 sdma_load_script(sdma, ram_code,
1198 sdma->script_addrs->ram_code_start_addr);
1200 /* Set bits of CONFIG register with given context switching mode */
1201 __raw_writel(SDMA_H_CONFIG_CSM, sdma->regs + SDMA_H_CONFIG);
1203 /* Initializes channel's priorities */
1204 sdma_set_channel_priority(&sdma->channel[0], 7);
1206 clk_disable(sdma->clk);
1211 clk_disable(sdma->clk);
1212 dev_err(sdma->dev, "initialisation failed with %d\n", ret);
1216 static int __init sdma_probe(struct platform_device *pdev)
1219 const struct firmware *fw;
1220 const struct sdma_firmware_header *header;
1221 const struct sdma_script_start_addrs *addr;
1223 unsigned short *ram_code;
1224 struct resource *iores;
1225 struct sdma_platform_data *pdata = pdev->dev.platform_data;
1228 dma_cap_mask_t mask;
1229 struct sdma_engine *sdma;
1231 sdma = kzalloc(sizeof(*sdma), GFP_KERNEL);
1235 sdma->dev = &pdev->dev;
1237 iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1238 irq = platform_get_irq(pdev, 0);
1239 if (!iores || irq < 0 || !pdata) {
1244 if (!request_mem_region(iores->start, resource_size(iores), pdev->name)) {
1246 goto err_request_region;
1249 sdma->clk = clk_get(&pdev->dev, NULL);
1250 if (IS_ERR(sdma->clk)) {
1251 ret = PTR_ERR(sdma->clk);
1255 sdma->regs = ioremap(iores->start, resource_size(iores));
1261 ret = request_irq(irq, sdma_int_handler, 0, "sdma", sdma);
1263 goto err_request_irq;
1265 fwname = kasprintf(GFP_KERNEL, "sdma-%s-to%d.bin",
1266 pdata->cpu_name, pdata->to_version);
1272 ret = request_firmware(&fw, fwname, &pdev->dev);
1274 dev_err(&pdev->dev, "request firmware \"%s\" failed with %d\n",
1281 if (fw->size < sizeof(*header))
1284 header = (struct sdma_firmware_header *)fw->data;
1286 if (header->magic != SDMA_FIRMWARE_MAGIC)
1288 if (header->ram_code_start + header->ram_code_size > fw->size)
1291 addr = (void *)header + header->script_addrs_start;
1292 ram_code = (void *)header + header->ram_code_start;
1293 sdma->script_addrs = kmalloc(sizeof(*addr), GFP_KERNEL);
1294 if (!sdma->script_addrs)
1296 memcpy(sdma->script_addrs, addr, sizeof(*addr));
1298 sdma->version = pdata->sdma_version;
1300 INIT_LIST_HEAD(&sdma->dma_device.channels);
1301 /* Initialize channel parameters */
1302 for (i = 0; i < MAX_DMA_CHANNELS; i++) {
1303 struct sdma_channel *sdmac = &sdma->channel[i];
1306 spin_lock_init(&sdmac->lock);
1308 dma_cap_set(DMA_SLAVE, sdma->dma_device.cap_mask);
1309 dma_cap_set(DMA_CYCLIC, sdma->dma_device.cap_mask);
1311 sdmac->chan.device = &sdma->dma_device;
1312 sdmac->chan.chan_id = i;
1315 /* Add the channel to the DMAC list */
1316 list_add_tail(&sdmac->chan.device_node, &sdma->dma_device.channels);
1319 ret = sdma_init(sdma, ram_code, header->ram_code_size);
1323 sdma->dma_device.dev = &pdev->dev;
1325 sdma->dma_device.device_alloc_chan_resources = sdma_alloc_chan_resources;
1326 sdma->dma_device.device_free_chan_resources = sdma_free_chan_resources;
1327 sdma->dma_device.device_tx_status = sdma_tx_status;
1328 sdma->dma_device.device_prep_slave_sg = sdma_prep_slave_sg;
1329 sdma->dma_device.device_prep_dma_cyclic = sdma_prep_dma_cyclic;
1330 sdma->dma_device.device_control = sdma_control;
1331 sdma->dma_device.device_issue_pending = sdma_issue_pending;
1333 ret = dma_async_device_register(&sdma->dma_device);
1335 dev_err(&pdev->dev, "unable to register\n");
1339 dev_info(&pdev->dev, "initialized (firmware %d.%d)\n",
1340 header->version_major,
1341 header->version_minor);
1343 /* request channel 0. This is an internal control channel
1344 * to the SDMA engine and not available to clients.
1347 dma_cap_set(DMA_SLAVE, mask);
1348 dma_request_channel(mask, NULL, NULL);
1350 release_firmware(fw);
1355 kfree(sdma->script_addrs);
1357 release_firmware(fw);
1359 free_irq(irq, sdma);
1361 iounmap(sdma->regs);
1365 release_mem_region(iores->start, resource_size(iores));
1372 static int __exit sdma_remove(struct platform_device *pdev)
1377 static struct platform_driver sdma_driver = {
1381 .remove = __exit_p(sdma_remove),
1384 static int __init sdma_module_init(void)
1386 return platform_driver_probe(&sdma_driver, sdma_probe);
1388 subsys_initcall(sdma_module_init);
1390 MODULE_AUTHOR("Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>");
1391 MODULE_DESCRIPTION("i.MX SDMA driver");
1392 MODULE_LICENSE("GPL");