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/iopoll.h>
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/bitops.h>
26 #include <linux/interrupt.h>
27 #include <linux/clk.h>
28 #include <linux/delay.h>
29 #include <linux/sched.h>
30 #include <linux/semaphore.h>
31 #include <linux/spinlock.h>
32 #include <linux/device.h>
33 #include <linux/dma-mapping.h>
34 #include <linux/firmware.h>
35 #include <linux/slab.h>
36 #include <linux/platform_device.h>
37 #include <linux/dmaengine.h>
39 #include <linux/of_address.h>
40 #include <linux/of_device.h>
41 #include <linux/of_dma.h>
44 #include <linux/platform_data/dma-imx-sdma.h>
45 #include <linux/platform_data/dma-imx.h>
46 #include <linux/regmap.h>
47 #include <linux/mfd/syscon.h>
48 #include <linux/mfd/syscon/imx6q-iomuxc-gpr.h>
50 #include "dmaengine.h"
53 #define SDMA_H_C0PTR 0x000
54 #define SDMA_H_INTR 0x004
55 #define SDMA_H_STATSTOP 0x008
56 #define SDMA_H_START 0x00c
57 #define SDMA_H_EVTOVR 0x010
58 #define SDMA_H_DSPOVR 0x014
59 #define SDMA_H_HOSTOVR 0x018
60 #define SDMA_H_EVTPEND 0x01c
61 #define SDMA_H_DSPENBL 0x020
62 #define SDMA_H_RESET 0x024
63 #define SDMA_H_EVTERR 0x028
64 #define SDMA_H_INTRMSK 0x02c
65 #define SDMA_H_PSW 0x030
66 #define SDMA_H_EVTERRDBG 0x034
67 #define SDMA_H_CONFIG 0x038
68 #define SDMA_ONCE_ENB 0x040
69 #define SDMA_ONCE_DATA 0x044
70 #define SDMA_ONCE_INSTR 0x048
71 #define SDMA_ONCE_STAT 0x04c
72 #define SDMA_ONCE_CMD 0x050
73 #define SDMA_EVT_MIRROR 0x054
74 #define SDMA_ILLINSTADDR 0x058
75 #define SDMA_CHN0ADDR 0x05c
76 #define SDMA_ONCE_RTB 0x060
77 #define SDMA_XTRIG_CONF1 0x070
78 #define SDMA_XTRIG_CONF2 0x074
79 #define SDMA_CHNENBL0_IMX35 0x200
80 #define SDMA_CHNENBL0_IMX31 0x080
81 #define SDMA_CHNPRI_0 0x100
84 * Buffer descriptor status values.
95 * Data Node descriptor status values.
97 #define DND_END_OF_FRAME 0x80
98 #define DND_END_OF_XFER 0x40
100 #define DND_UNUSED 0x01
103 * IPCV2 descriptor status values.
105 #define BD_IPCV2_END_OF_FRAME 0x40
107 #define IPCV2_MAX_NODES 50
109 * Error bit set in the CCB status field by the SDMA,
110 * in setbd routine, in case of a transfer error
112 #define DATA_ERROR 0x10000000
115 * Buffer descriptor commands.
120 #define C0_SETCTX 0x07
121 #define C0_GETCTX 0x03
122 #define C0_SETDM 0x01
123 #define C0_SETPM 0x04
124 #define C0_GETDM 0x02
125 #define C0_GETPM 0x08
127 * Change endianness indicator in the BD command field
129 #define CHANGE_ENDIANNESS 0x80
132 * p_2_p watermark_level description
133 * Bits Name Description
134 * 0-7 Lower WML Lower watermark level
135 * 8 PS 1: Pad Swallowing
136 * 0: No Pad Swallowing
139 * 10 SPDIF If this bit is set both source
140 * and destination are on SPBA
141 * 11 Source Bit(SP) 1: Source on SPBA
143 * 12 Destination Bit(DP) 1: Destination on SPBA
144 * 0: Destination on AIPS
145 * 13-15 --------- MUST BE 0
146 * 16-23 Higher WML HWML
147 * 24-27 N Total number of samples after
148 * which Pad adding/Swallowing
149 * must be done. It must be odd.
150 * 28 Lower WML Event(LWE) SDMA events reg to check for
152 * 0: LWE in EVENTS register
153 * 1: LWE in EVENTS2 register
154 * 29 Higher WML Event(HWE) SDMA events reg to check for
156 * 0: HWE in EVENTS register
157 * 1: HWE in EVENTS2 register
158 * 30 --------- MUST BE 0
159 * 31 CONT 1: Amount of samples to be
160 * transferred is unknown and
161 * script will keep on
162 * transferring samples as long as
163 * both events are detected and
164 * script must be manually stopped
166 * 0: The amount of samples to be
167 * transferred is equal to the
168 * count field of mode word
170 #define SDMA_WATERMARK_LEVEL_LWML 0xFF
171 #define SDMA_WATERMARK_LEVEL_PS BIT(8)
172 #define SDMA_WATERMARK_LEVEL_PA BIT(9)
173 #define SDMA_WATERMARK_LEVEL_SPDIF BIT(10)
174 #define SDMA_WATERMARK_LEVEL_SP BIT(11)
175 #define SDMA_WATERMARK_LEVEL_DP BIT(12)
176 #define SDMA_WATERMARK_LEVEL_HWML (0xFF << 16)
177 #define SDMA_WATERMARK_LEVEL_LWE BIT(28)
178 #define SDMA_WATERMARK_LEVEL_HWE BIT(29)
179 #define SDMA_WATERMARK_LEVEL_CONT BIT(31)
181 #define SDMA_DMA_BUSWIDTHS (BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) | \
182 BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) | \
183 BIT(DMA_SLAVE_BUSWIDTH_4_BYTES))
185 #define SDMA_DMA_DIRECTIONS (BIT(DMA_DEV_TO_MEM) | \
186 BIT(DMA_MEM_TO_DEV) | \
190 * Mode/Count of data node descriptors - IPCv2
192 struct sdma_mode_count {
193 u32 count : 16; /* size of the buffer pointed by this BD */
194 u32 status : 8; /* E,R,I,C,W,D status bits stored here */
195 u32 command : 8; /* command mostly used for channel 0 */
201 struct sdma_buffer_descriptor {
202 struct sdma_mode_count mode;
203 u32 buffer_addr; /* address of the buffer described */
204 u32 ext_buffer_addr; /* extended buffer address */
205 } __attribute__ ((packed));
208 * struct sdma_channel_control - Channel control Block
210 * @current_bd_ptr current buffer descriptor processed
211 * @base_bd_ptr first element of buffer descriptor array
212 * @unused padding. The SDMA engine expects an array of 128 byte
215 struct sdma_channel_control {
219 } __attribute__ ((packed));
222 * struct sdma_state_registers - SDMA context for a channel
224 * @pc: program counter
225 * @t: test bit: status of arithmetic & test instruction
226 * @rpc: return program counter
227 * @sf: source fault while loading data
228 * @spc: loop start program counter
229 * @df: destination fault while storing data
230 * @epc: loop end program counter
233 struct sdma_state_registers {
245 } __attribute__ ((packed));
248 * struct sdma_context_data - sdma context specific to a channel
250 * @channel_state: channel state bits
251 * @gReg: general registers
252 * @mda: burst dma destination address register
253 * @msa: burst dma source address register
254 * @ms: burst dma status register
255 * @md: burst dma data register
256 * @pda: peripheral dma destination address register
257 * @psa: peripheral dma source address register
258 * @ps: peripheral dma status register
259 * @pd: peripheral dma data register
260 * @ca: CRC polynomial register
261 * @cs: CRC accumulator register
262 * @dda: dedicated core destination address register
263 * @dsa: dedicated core source address register
264 * @ds: dedicated core status register
265 * @dd: dedicated core data register
267 struct sdma_context_data {
268 struct sdma_state_registers channel_state;
292 } __attribute__ ((packed));
294 #define NUM_BD (int)(PAGE_SIZE / sizeof(struct sdma_buffer_descriptor))
299 * struct sdma_channel - housekeeping for a SDMA channel
301 * @sdma pointer to the SDMA engine for this channel
302 * @channel the channel number, matches dmaengine chan_id + 1
303 * @direction transfer type. Needed for setting SDMA script
304 * @peripheral_type Peripheral type. Needed for setting SDMA script
305 * @event_id0 aka dma request line
306 * @event_id1 for channels that use 2 events
307 * @word_size peripheral access size
308 * @buf_tail ID of the buffer that was processed
309 * @buf_ptail ID of the previous buffer that was processed
310 * @num_bd max NUM_BD. number of descriptors currently handling
312 struct sdma_channel {
313 struct sdma_engine *sdma;
314 unsigned int channel;
315 enum dma_transfer_direction direction;
316 enum sdma_peripheral_type peripheral_type;
317 unsigned int event_id0;
318 unsigned int event_id1;
319 enum dma_slave_buswidth word_size;
320 unsigned int buf_tail;
321 unsigned int buf_ptail;
323 unsigned int period_len;
324 struct sdma_buffer_descriptor *bd;
326 unsigned int pc_from_device, pc_to_device;
327 unsigned int device_to_device;
329 dma_addr_t per_address, per_address2;
330 unsigned long event_mask[2];
331 unsigned long watermark_level;
332 u32 shp_addr, per_addr;
333 struct dma_chan chan;
335 struct dma_async_tx_descriptor desc;
336 enum dma_status status;
337 unsigned int chn_count;
338 unsigned int chn_real_count;
339 struct tasklet_struct tasklet;
340 struct imx_dma_data data;
344 #define IMX_DMA_SG_LOOP BIT(0)
346 #define MAX_DMA_CHANNELS 32
347 #define MXC_SDMA_DEFAULT_PRIORITY 1
348 #define MXC_SDMA_MIN_PRIORITY 1
349 #define MXC_SDMA_MAX_PRIORITY 7
351 #define SDMA_FIRMWARE_MAGIC 0x414d4453
354 * struct sdma_firmware_header - Layout of the firmware image
357 * @version_major increased whenever layout of struct sdma_script_start_addrs
359 * @version_minor firmware minor version (for binary compatible changes)
360 * @script_addrs_start offset of struct sdma_script_start_addrs in this image
361 * @num_script_addrs Number of script addresses in this image
362 * @ram_code_start offset of SDMA ram image in this firmware image
363 * @ram_code_size size of SDMA ram image
364 * @script_addrs Stores the start address of the SDMA scripts
365 * (in SDMA memory space)
367 struct sdma_firmware_header {
371 u32 script_addrs_start;
372 u32 num_script_addrs;
377 struct sdma_driver_data {
380 struct sdma_script_start_addrs *script_addrs;
385 struct device_dma_parameters dma_parms;
386 struct sdma_channel channel[MAX_DMA_CHANNELS];
387 struct sdma_channel_control *channel_control;
389 struct sdma_context_data *context;
390 dma_addr_t context_phys;
391 struct dma_device dma_device;
394 spinlock_t channel_0_lock;
396 struct sdma_script_start_addrs *script_addrs;
397 const struct sdma_driver_data *drvdata;
403 static struct sdma_driver_data sdma_imx31 = {
404 .chnenbl0 = SDMA_CHNENBL0_IMX31,
408 static struct sdma_script_start_addrs sdma_script_imx25 = {
410 .uart_2_mcu_addr = 904,
411 .per_2_app_addr = 1255,
412 .mcu_2_app_addr = 834,
413 .uartsh_2_mcu_addr = 1120,
414 .per_2_shp_addr = 1329,
415 .mcu_2_shp_addr = 1048,
416 .ata_2_mcu_addr = 1560,
417 .mcu_2_ata_addr = 1479,
418 .app_2_per_addr = 1189,
419 .app_2_mcu_addr = 770,
420 .shp_2_per_addr = 1407,
421 .shp_2_mcu_addr = 979,
424 static struct sdma_driver_data sdma_imx25 = {
425 .chnenbl0 = SDMA_CHNENBL0_IMX35,
427 .script_addrs = &sdma_script_imx25,
430 static struct sdma_driver_data sdma_imx35 = {
431 .chnenbl0 = SDMA_CHNENBL0_IMX35,
435 static struct sdma_script_start_addrs sdma_script_imx51 = {
437 .uart_2_mcu_addr = 817,
438 .mcu_2_app_addr = 747,
439 .mcu_2_shp_addr = 961,
440 .ata_2_mcu_addr = 1473,
441 .mcu_2_ata_addr = 1392,
442 .app_2_per_addr = 1033,
443 .app_2_mcu_addr = 683,
444 .shp_2_per_addr = 1251,
445 .shp_2_mcu_addr = 892,
448 static struct sdma_driver_data sdma_imx51 = {
449 .chnenbl0 = SDMA_CHNENBL0_IMX35,
451 .script_addrs = &sdma_script_imx51,
454 static struct sdma_script_start_addrs sdma_script_imx53 = {
456 .app_2_mcu_addr = 683,
457 .mcu_2_app_addr = 747,
458 .uart_2_mcu_addr = 817,
459 .shp_2_mcu_addr = 891,
460 .mcu_2_shp_addr = 960,
461 .uartsh_2_mcu_addr = 1032,
462 .spdif_2_mcu_addr = 1100,
463 .mcu_2_spdif_addr = 1134,
464 .firi_2_mcu_addr = 1193,
465 .mcu_2_firi_addr = 1290,
468 static struct sdma_driver_data sdma_imx53 = {
469 .chnenbl0 = SDMA_CHNENBL0_IMX35,
471 .script_addrs = &sdma_script_imx53,
474 static struct sdma_script_start_addrs sdma_script_imx6q = {
476 .uart_2_mcu_addr = 817,
477 .mcu_2_app_addr = 747,
478 .per_2_per_addr = 6331,
479 .uartsh_2_mcu_addr = 1032,
480 .mcu_2_shp_addr = 960,
481 .app_2_mcu_addr = 683,
482 .shp_2_mcu_addr = 891,
483 .spdif_2_mcu_addr = 1100,
484 .mcu_2_spdif_addr = 1134,
487 static struct sdma_driver_data sdma_imx6q = {
488 .chnenbl0 = SDMA_CHNENBL0_IMX35,
490 .script_addrs = &sdma_script_imx6q,
493 static struct sdma_script_start_addrs sdma_script_imx7d = {
495 .uart_2_mcu_addr = 819,
496 .mcu_2_app_addr = 749,
497 .uartsh_2_mcu_addr = 1034,
498 .mcu_2_shp_addr = 962,
499 .app_2_mcu_addr = 685,
500 .shp_2_mcu_addr = 893,
501 .spdif_2_mcu_addr = 1102,
502 .mcu_2_spdif_addr = 1136,
505 static struct sdma_driver_data sdma_imx7d = {
506 .chnenbl0 = SDMA_CHNENBL0_IMX35,
508 .script_addrs = &sdma_script_imx7d,
511 static const struct platform_device_id sdma_devtypes[] = {
513 .name = "imx25-sdma",
514 .driver_data = (unsigned long)&sdma_imx25,
516 .name = "imx31-sdma",
517 .driver_data = (unsigned long)&sdma_imx31,
519 .name = "imx35-sdma",
520 .driver_data = (unsigned long)&sdma_imx35,
522 .name = "imx51-sdma",
523 .driver_data = (unsigned long)&sdma_imx51,
525 .name = "imx53-sdma",
526 .driver_data = (unsigned long)&sdma_imx53,
528 .name = "imx6q-sdma",
529 .driver_data = (unsigned long)&sdma_imx6q,
531 .name = "imx7d-sdma",
532 .driver_data = (unsigned long)&sdma_imx7d,
537 MODULE_DEVICE_TABLE(platform, sdma_devtypes);
539 static const struct of_device_id sdma_dt_ids[] = {
540 { .compatible = "fsl,imx6q-sdma", .data = &sdma_imx6q, },
541 { .compatible = "fsl,imx53-sdma", .data = &sdma_imx53, },
542 { .compatible = "fsl,imx51-sdma", .data = &sdma_imx51, },
543 { .compatible = "fsl,imx35-sdma", .data = &sdma_imx35, },
544 { .compatible = "fsl,imx31-sdma", .data = &sdma_imx31, },
545 { .compatible = "fsl,imx25-sdma", .data = &sdma_imx25, },
546 { .compatible = "fsl,imx7d-sdma", .data = &sdma_imx7d, },
549 MODULE_DEVICE_TABLE(of, sdma_dt_ids);
551 #define SDMA_H_CONFIG_DSPDMA BIT(12) /* indicates if the DSPDMA is used */
552 #define SDMA_H_CONFIG_RTD_PINS BIT(11) /* indicates if Real-Time Debug pins are enabled */
553 #define SDMA_H_CONFIG_ACR BIT(4) /* indicates if AHB freq /core freq = 2 or 1 */
554 #define SDMA_H_CONFIG_CSM (3) /* indicates which context switch mode is selected*/
556 static inline u32 chnenbl_ofs(struct sdma_engine *sdma, unsigned int event)
558 u32 chnenbl0 = sdma->drvdata->chnenbl0;
559 return chnenbl0 + event * 4;
562 static int sdma_config_ownership(struct sdma_channel *sdmac,
563 bool event_override, bool mcu_override, bool dsp_override)
565 struct sdma_engine *sdma = sdmac->sdma;
566 int channel = sdmac->channel;
567 unsigned long evt, mcu, dsp;
569 if (event_override && mcu_override && dsp_override)
572 evt = readl_relaxed(sdma->regs + SDMA_H_EVTOVR);
573 mcu = readl_relaxed(sdma->regs + SDMA_H_HOSTOVR);
574 dsp = readl_relaxed(sdma->regs + SDMA_H_DSPOVR);
577 __clear_bit(channel, &dsp);
579 __set_bit(channel, &dsp);
582 __clear_bit(channel, &evt);
584 __set_bit(channel, &evt);
587 __clear_bit(channel, &mcu);
589 __set_bit(channel, &mcu);
591 writel_relaxed(evt, sdma->regs + SDMA_H_EVTOVR);
592 writel_relaxed(mcu, sdma->regs + SDMA_H_HOSTOVR);
593 writel_relaxed(dsp, sdma->regs + SDMA_H_DSPOVR);
598 static void sdma_enable_channel(struct sdma_engine *sdma, int channel)
601 struct sdma_channel *sdmac = &sdma->channel[channel];
603 writel(BIT(channel), sdma->regs + SDMA_H_START);
605 spin_lock_irqsave(&sdmac->lock, flags);
606 sdmac->enabled = true;
607 spin_unlock_irqrestore(&sdmac->lock, flags);
611 * sdma_run_channel0 - run a channel and wait till it's done
613 static int sdma_run_channel0(struct sdma_engine *sdma)
618 sdma_enable_channel(sdma, 0);
620 ret = readl_relaxed_poll_timeout_atomic(sdma->regs + SDMA_H_STATSTOP,
621 reg, !(reg & 1), 1, 500);
623 dev_err(sdma->dev, "Timeout waiting for CH0 ready\n");
625 /* Set bits of CONFIG register with dynamic context switching */
626 if (readl(sdma->regs + SDMA_H_CONFIG) == 0)
627 writel_relaxed(SDMA_H_CONFIG_CSM, sdma->regs + SDMA_H_CONFIG);
632 static int sdma_load_script(struct sdma_engine *sdma, void *buf, int size,
635 struct sdma_buffer_descriptor *bd0 = sdma->channel[0].bd;
641 buf_virt = dma_alloc_coherent(NULL,
643 &buf_phys, GFP_KERNEL);
648 spin_lock_irqsave(&sdma->channel_0_lock, flags);
650 bd0->mode.command = C0_SETPM;
651 bd0->mode.status = BD_DONE | BD_INTR | BD_WRAP | BD_EXTD;
652 bd0->mode.count = size / 2;
653 bd0->buffer_addr = buf_phys;
654 bd0->ext_buffer_addr = address;
656 memcpy(buf_virt, buf, size);
658 ret = sdma_run_channel0(sdma);
660 spin_unlock_irqrestore(&sdma->channel_0_lock, flags);
662 dma_free_coherent(NULL, size, buf_virt, buf_phys);
667 static void sdma_event_enable(struct sdma_channel *sdmac, unsigned int event)
669 struct sdma_engine *sdma = sdmac->sdma;
670 int channel = sdmac->channel;
672 u32 chnenbl = chnenbl_ofs(sdma, event);
674 val = readl_relaxed(sdma->regs + chnenbl);
675 __set_bit(channel, &val);
676 writel_relaxed(val, sdma->regs + chnenbl);
679 static void sdma_event_disable(struct sdma_channel *sdmac, unsigned int event)
681 struct sdma_engine *sdma = sdmac->sdma;
682 int channel = sdmac->channel;
683 u32 chnenbl = chnenbl_ofs(sdma, event);
686 val = readl_relaxed(sdma->regs + chnenbl);
687 __clear_bit(channel, &val);
688 writel_relaxed(val, sdma->regs + chnenbl);
691 static void sdma_update_channel_loop(struct sdma_channel *sdmac)
693 struct sdma_buffer_descriptor *bd;
695 enum dma_status old_status = sdmac->status;
698 spin_lock_irqsave(&sdmac->lock, flags);
699 if (!sdmac->enabled) {
700 spin_unlock_irqrestore(&sdmac->lock, flags);
703 spin_unlock_irqrestore(&sdmac->lock, flags);
706 * loop mode. Iterate over descriptors, re-setup them and
707 * call callback function.
710 bd = &sdmac->bd[sdmac->buf_tail];
712 if (bd->mode.status & BD_DONE)
715 if (bd->mode.status & BD_RROR) {
716 bd->mode.status &= ~BD_RROR;
717 sdmac->status = DMA_ERROR;
722 * We use bd->mode.count to calculate the residue, since contains
723 * the number of bytes present in the current buffer descriptor.
726 sdmac->chn_real_count = bd->mode.count;
727 bd->mode.status |= BD_DONE;
728 bd->mode.count = sdmac->period_len;
729 sdmac->buf_ptail = sdmac->buf_tail;
730 sdmac->buf_tail = (sdmac->buf_tail + 1) % sdmac->num_bd;
733 * The callback is called from the interrupt context in order
734 * to reduce latency and to avoid the risk of altering the
735 * SDMA transaction status by the time the client tasklet is
739 dmaengine_desc_get_callback_invoke(&sdmac->desc, NULL);
742 sdmac->status = old_status;
746 static void mxc_sdma_handle_channel_normal(unsigned long data)
748 struct sdma_channel *sdmac = (struct sdma_channel *) data;
749 struct sdma_buffer_descriptor *bd;
752 sdmac->chn_real_count = 0;
754 * non loop mode. Iterate over all descriptors, collect
755 * errors and call callback function
757 for (i = 0; i < sdmac->num_bd; i++) {
760 if (bd->mode.status & (BD_DONE | BD_RROR))
762 sdmac->chn_real_count += bd->mode.count;
766 sdmac->status = DMA_ERROR;
768 sdmac->status = DMA_COMPLETE;
770 dma_cookie_complete(&sdmac->desc);
772 dmaengine_desc_get_callback_invoke(&sdmac->desc, NULL);
775 static irqreturn_t sdma_int_handler(int irq, void *dev_id)
777 struct sdma_engine *sdma = dev_id;
780 stat = readl_relaxed(sdma->regs + SDMA_H_INTR);
781 writel_relaxed(stat, sdma->regs + SDMA_H_INTR);
782 /* channel 0 is special and not handled here, see run_channel0() */
786 int channel = fls(stat) - 1;
787 struct sdma_channel *sdmac = &sdma->channel[channel];
789 if (sdmac->flags & IMX_DMA_SG_LOOP)
790 sdma_update_channel_loop(sdmac);
792 tasklet_schedule(&sdmac->tasklet);
794 __clear_bit(channel, &stat);
801 * sets the pc of SDMA script according to the peripheral type
803 static void sdma_get_pc(struct sdma_channel *sdmac,
804 enum sdma_peripheral_type peripheral_type)
806 struct sdma_engine *sdma = sdmac->sdma;
807 int per_2_emi = 0, emi_2_per = 0;
809 * These are needed once we start to support transfers between
810 * two peripherals or memory-to-memory transfers
814 sdmac->pc_from_device = 0;
815 sdmac->pc_to_device = 0;
816 sdmac->device_to_device = 0;
818 switch (peripheral_type) {
819 case IMX_DMATYPE_MEMORY:
821 case IMX_DMATYPE_DSP:
822 emi_2_per = sdma->script_addrs->bp_2_ap_addr;
823 per_2_emi = sdma->script_addrs->ap_2_bp_addr;
825 case IMX_DMATYPE_FIRI:
826 per_2_emi = sdma->script_addrs->firi_2_mcu_addr;
827 emi_2_per = sdma->script_addrs->mcu_2_firi_addr;
829 case IMX_DMATYPE_UART:
830 per_2_emi = sdma->script_addrs->uart_2_mcu_addr;
831 emi_2_per = sdma->script_addrs->mcu_2_app_addr;
833 case IMX_DMATYPE_UART_SP:
834 per_2_emi = sdma->script_addrs->uartsh_2_mcu_addr;
835 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
837 case IMX_DMATYPE_ATA:
838 per_2_emi = sdma->script_addrs->ata_2_mcu_addr;
839 emi_2_per = sdma->script_addrs->mcu_2_ata_addr;
841 case IMX_DMATYPE_CSPI:
842 case IMX_DMATYPE_EXT:
843 case IMX_DMATYPE_SSI:
844 case IMX_DMATYPE_SAI:
845 per_2_emi = sdma->script_addrs->app_2_mcu_addr;
846 emi_2_per = sdma->script_addrs->mcu_2_app_addr;
848 case IMX_DMATYPE_SSI_DUAL:
849 per_2_emi = sdma->script_addrs->ssish_2_mcu_addr;
850 emi_2_per = sdma->script_addrs->mcu_2_ssish_addr;
852 case IMX_DMATYPE_SSI_SP:
853 case IMX_DMATYPE_MMC:
854 case IMX_DMATYPE_SDHC:
855 case IMX_DMATYPE_CSPI_SP:
856 case IMX_DMATYPE_ESAI:
857 case IMX_DMATYPE_MSHC_SP:
858 per_2_emi = sdma->script_addrs->shp_2_mcu_addr;
859 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
861 case IMX_DMATYPE_ASRC:
862 per_2_emi = sdma->script_addrs->asrc_2_mcu_addr;
863 emi_2_per = sdma->script_addrs->asrc_2_mcu_addr;
864 per_2_per = sdma->script_addrs->per_2_per_addr;
866 case IMX_DMATYPE_ASRC_SP:
867 per_2_emi = sdma->script_addrs->shp_2_mcu_addr;
868 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
869 per_2_per = sdma->script_addrs->per_2_per_addr;
871 case IMX_DMATYPE_MSHC:
872 per_2_emi = sdma->script_addrs->mshc_2_mcu_addr;
873 emi_2_per = sdma->script_addrs->mcu_2_mshc_addr;
875 case IMX_DMATYPE_CCM:
876 per_2_emi = sdma->script_addrs->dptc_dvfs_addr;
878 case IMX_DMATYPE_SPDIF:
879 per_2_emi = sdma->script_addrs->spdif_2_mcu_addr;
880 emi_2_per = sdma->script_addrs->mcu_2_spdif_addr;
882 case IMX_DMATYPE_IPU_MEMORY:
883 emi_2_per = sdma->script_addrs->ext_mem_2_ipu_addr;
889 sdmac->pc_from_device = per_2_emi;
890 sdmac->pc_to_device = emi_2_per;
891 sdmac->device_to_device = per_2_per;
894 static int sdma_load_context(struct sdma_channel *sdmac)
896 struct sdma_engine *sdma = sdmac->sdma;
897 int channel = sdmac->channel;
899 struct sdma_context_data *context = sdma->context;
900 struct sdma_buffer_descriptor *bd0 = sdma->channel[0].bd;
904 if (sdmac->direction == DMA_DEV_TO_MEM)
905 load_address = sdmac->pc_from_device;
906 else if (sdmac->direction == DMA_DEV_TO_DEV)
907 load_address = sdmac->device_to_device;
909 load_address = sdmac->pc_to_device;
911 if (load_address < 0)
914 dev_dbg(sdma->dev, "load_address = %d\n", load_address);
915 dev_dbg(sdma->dev, "wml = 0x%08x\n", (u32)sdmac->watermark_level);
916 dev_dbg(sdma->dev, "shp_addr = 0x%08x\n", sdmac->shp_addr);
917 dev_dbg(sdma->dev, "per_addr = 0x%08x\n", sdmac->per_addr);
918 dev_dbg(sdma->dev, "event_mask0 = 0x%08x\n", (u32)sdmac->event_mask[0]);
919 dev_dbg(sdma->dev, "event_mask1 = 0x%08x\n", (u32)sdmac->event_mask[1]);
921 spin_lock_irqsave(&sdma->channel_0_lock, flags);
923 memset(context, 0, sizeof(*context));
924 context->channel_state.pc = load_address;
926 /* Send by context the event mask,base address for peripheral
927 * and watermark level
929 context->gReg[0] = sdmac->event_mask[1];
930 context->gReg[1] = sdmac->event_mask[0];
931 context->gReg[2] = sdmac->per_addr;
932 context->gReg[6] = sdmac->shp_addr;
933 context->gReg[7] = sdmac->watermark_level;
935 bd0->mode.command = C0_SETDM;
936 bd0->mode.status = BD_DONE | BD_INTR | BD_WRAP | BD_EXTD;
937 bd0->mode.count = sizeof(*context) / 4;
938 bd0->buffer_addr = sdma->context_phys;
939 bd0->ext_buffer_addr = 2048 + (sizeof(*context) / 4) * channel;
940 ret = sdma_run_channel0(sdma);
942 spin_unlock_irqrestore(&sdma->channel_0_lock, flags);
947 static struct sdma_channel *to_sdma_chan(struct dma_chan *chan)
949 return container_of(chan, struct sdma_channel, chan);
952 static int sdma_disable_channel(struct dma_chan *chan)
954 struct sdma_channel *sdmac = to_sdma_chan(chan);
955 struct sdma_engine *sdma = sdmac->sdma;
956 int channel = sdmac->channel;
959 writel_relaxed(BIT(channel), sdma->regs + SDMA_H_STATSTOP);
960 sdmac->status = DMA_ERROR;
962 spin_lock_irqsave(&sdmac->lock, flags);
963 sdmac->enabled = false;
964 spin_unlock_irqrestore(&sdmac->lock, flags);
969 static int sdma_disable_channel_with_delay(struct dma_chan *chan)
971 sdma_disable_channel(chan);
974 * According to NXP R&D team a delay of one BD SDMA cost time
975 * (maximum is 1ms) should be added after disable of the channel
976 * bit, to ensure SDMA core has really been stopped after SDMA
977 * clients call .device_terminate_all.
984 static void sdma_set_watermarklevel_for_p2p(struct sdma_channel *sdmac)
986 struct sdma_engine *sdma = sdmac->sdma;
988 int lwml = sdmac->watermark_level & SDMA_WATERMARK_LEVEL_LWML;
989 int hwml = (sdmac->watermark_level & SDMA_WATERMARK_LEVEL_HWML) >> 16;
991 set_bit(sdmac->event_id0 % 32, &sdmac->event_mask[1]);
992 set_bit(sdmac->event_id1 % 32, &sdmac->event_mask[0]);
994 if (sdmac->event_id0 > 31)
995 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_LWE;
997 if (sdmac->event_id1 > 31)
998 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_HWE;
1001 * If LWML(src_maxburst) > HWML(dst_maxburst), we need
1002 * swap LWML and HWML of INFO(A.3.2.5.1), also need swap
1003 * r0(event_mask[1]) and r1(event_mask[0]).
1006 sdmac->watermark_level &= ~(SDMA_WATERMARK_LEVEL_LWML |
1007 SDMA_WATERMARK_LEVEL_HWML);
1008 sdmac->watermark_level |= hwml;
1009 sdmac->watermark_level |= lwml << 16;
1010 swap(sdmac->event_mask[0], sdmac->event_mask[1]);
1013 if (sdmac->per_address2 >= sdma->spba_start_addr &&
1014 sdmac->per_address2 <= sdma->spba_end_addr)
1015 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_SP;
1017 if (sdmac->per_address >= sdma->spba_start_addr &&
1018 sdmac->per_address <= sdma->spba_end_addr)
1019 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_DP;
1021 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_CONT;
1024 static int sdma_config_channel(struct dma_chan *chan)
1026 struct sdma_channel *sdmac = to_sdma_chan(chan);
1029 sdma_disable_channel(chan);
1031 sdmac->event_mask[0] = 0;
1032 sdmac->event_mask[1] = 0;
1033 sdmac->shp_addr = 0;
1034 sdmac->per_addr = 0;
1036 if (sdmac->event_id0) {
1037 if (sdmac->event_id0 >= sdmac->sdma->drvdata->num_events)
1039 sdma_event_enable(sdmac, sdmac->event_id0);
1042 if (sdmac->event_id1) {
1043 if (sdmac->event_id1 >= sdmac->sdma->drvdata->num_events)
1045 sdma_event_enable(sdmac, sdmac->event_id1);
1048 switch (sdmac->peripheral_type) {
1049 case IMX_DMATYPE_DSP:
1050 sdma_config_ownership(sdmac, false, true, true);
1052 case IMX_DMATYPE_MEMORY:
1053 sdma_config_ownership(sdmac, false, true, false);
1056 sdma_config_ownership(sdmac, true, true, false);
1060 sdma_get_pc(sdmac, sdmac->peripheral_type);
1062 if ((sdmac->peripheral_type != IMX_DMATYPE_MEMORY) &&
1063 (sdmac->peripheral_type != IMX_DMATYPE_DSP)) {
1064 /* Handle multiple event channels differently */
1065 if (sdmac->event_id1) {
1066 if (sdmac->peripheral_type == IMX_DMATYPE_ASRC_SP ||
1067 sdmac->peripheral_type == IMX_DMATYPE_ASRC)
1068 sdma_set_watermarklevel_for_p2p(sdmac);
1070 __set_bit(sdmac->event_id0, sdmac->event_mask);
1073 sdmac->shp_addr = sdmac->per_address;
1074 sdmac->per_addr = sdmac->per_address2;
1076 sdmac->watermark_level = 0; /* FIXME: M3_BASE_ADDRESS */
1079 ret = sdma_load_context(sdmac);
1084 static int sdma_set_channel_priority(struct sdma_channel *sdmac,
1085 unsigned int priority)
1087 struct sdma_engine *sdma = sdmac->sdma;
1088 int channel = sdmac->channel;
1090 if (priority < MXC_SDMA_MIN_PRIORITY
1091 || priority > MXC_SDMA_MAX_PRIORITY) {
1095 writel_relaxed(priority, sdma->regs + SDMA_CHNPRI_0 + 4 * channel);
1100 static int sdma_request_channel(struct sdma_channel *sdmac)
1102 struct sdma_engine *sdma = sdmac->sdma;
1103 int channel = sdmac->channel;
1106 sdmac->bd = dma_zalloc_coherent(NULL, PAGE_SIZE, &sdmac->bd_phys,
1113 sdma->channel_control[channel].base_bd_ptr = sdmac->bd_phys;
1114 sdma->channel_control[channel].current_bd_ptr = sdmac->bd_phys;
1116 sdma_set_channel_priority(sdmac, MXC_SDMA_DEFAULT_PRIORITY);
1123 static dma_cookie_t sdma_tx_submit(struct dma_async_tx_descriptor *tx)
1125 unsigned long flags;
1126 struct sdma_channel *sdmac = to_sdma_chan(tx->chan);
1127 dma_cookie_t cookie;
1129 spin_lock_irqsave(&sdmac->lock, flags);
1131 cookie = dma_cookie_assign(tx);
1133 spin_unlock_irqrestore(&sdmac->lock, flags);
1138 static int sdma_alloc_chan_resources(struct dma_chan *chan)
1140 struct sdma_channel *sdmac = to_sdma_chan(chan);
1141 struct imx_dma_data *data = chan->private;
1147 switch (data->priority) {
1151 case DMA_PRIO_MEDIUM:
1160 sdmac->peripheral_type = data->peripheral_type;
1161 sdmac->event_id0 = data->dma_request;
1162 sdmac->event_id1 = data->dma_request2;
1164 ret = clk_enable(sdmac->sdma->clk_ipg);
1167 ret = clk_enable(sdmac->sdma->clk_ahb);
1169 goto disable_clk_ipg;
1171 ret = sdma_request_channel(sdmac);
1173 goto disable_clk_ahb;
1175 ret = sdma_set_channel_priority(sdmac, prio);
1177 goto disable_clk_ahb;
1179 dma_async_tx_descriptor_init(&sdmac->desc, chan);
1180 sdmac->desc.tx_submit = sdma_tx_submit;
1181 /* txd.flags will be overwritten in prep funcs */
1182 sdmac->desc.flags = DMA_CTRL_ACK;
1187 clk_disable(sdmac->sdma->clk_ahb);
1189 clk_disable(sdmac->sdma->clk_ipg);
1193 static void sdma_free_chan_resources(struct dma_chan *chan)
1195 struct sdma_channel *sdmac = to_sdma_chan(chan);
1196 struct sdma_engine *sdma = sdmac->sdma;
1198 sdma_disable_channel(chan);
1200 if (sdmac->event_id0)
1201 sdma_event_disable(sdmac, sdmac->event_id0);
1202 if (sdmac->event_id1)
1203 sdma_event_disable(sdmac, sdmac->event_id1);
1205 sdmac->event_id0 = 0;
1206 sdmac->event_id1 = 0;
1208 sdma_set_channel_priority(sdmac, 0);
1210 dma_free_coherent(NULL, PAGE_SIZE, sdmac->bd, sdmac->bd_phys);
1212 clk_disable(sdma->clk_ipg);
1213 clk_disable(sdma->clk_ahb);
1216 static struct dma_async_tx_descriptor *sdma_prep_slave_sg(
1217 struct dma_chan *chan, struct scatterlist *sgl,
1218 unsigned int sg_len, enum dma_transfer_direction direction,
1219 unsigned long flags, void *context)
1221 struct sdma_channel *sdmac = to_sdma_chan(chan);
1222 struct sdma_engine *sdma = sdmac->sdma;
1224 int channel = sdmac->channel;
1225 struct scatterlist *sg;
1227 if (sdmac->status == DMA_IN_PROGRESS)
1229 sdmac->status = DMA_IN_PROGRESS;
1233 sdmac->buf_tail = 0;
1234 sdmac->buf_ptail = 0;
1235 sdmac->chn_real_count = 0;
1237 dev_dbg(sdma->dev, "setting up %d entries for channel %d.\n",
1240 sdmac->direction = direction;
1241 ret = sdma_load_context(sdmac);
1245 if (sg_len > NUM_BD) {
1246 dev_err(sdma->dev, "SDMA channel %d: maximum number of sg exceeded: %d > %d\n",
1247 channel, sg_len, NUM_BD);
1252 sdmac->chn_count = 0;
1253 for_each_sg(sgl, sg, sg_len, i) {
1254 struct sdma_buffer_descriptor *bd = &sdmac->bd[i];
1257 bd->buffer_addr = sg->dma_address;
1259 count = sg_dma_len(sg);
1261 if (count > 0xffff) {
1262 dev_err(sdma->dev, "SDMA channel %d: maximum bytes for sg entry exceeded: %d > %d\n",
1263 channel, count, 0xffff);
1268 bd->mode.count = count;
1269 sdmac->chn_count += count;
1271 if (sdmac->word_size > DMA_SLAVE_BUSWIDTH_4_BYTES) {
1276 switch (sdmac->word_size) {
1277 case DMA_SLAVE_BUSWIDTH_4_BYTES:
1278 bd->mode.command = 0;
1279 if (count & 3 || sg->dma_address & 3)
1282 case DMA_SLAVE_BUSWIDTH_2_BYTES:
1283 bd->mode.command = 2;
1284 if (count & 1 || sg->dma_address & 1)
1287 case DMA_SLAVE_BUSWIDTH_1_BYTE:
1288 bd->mode.command = 1;
1294 param = BD_DONE | BD_EXTD | BD_CONT;
1296 if (i + 1 == sg_len) {
1302 dev_dbg(sdma->dev, "entry %d: count: %d dma: %#llx %s%s\n",
1303 i, count, (u64)sg->dma_address,
1304 param & BD_WRAP ? "wrap" : "",
1305 param & BD_INTR ? " intr" : "");
1307 bd->mode.status = param;
1310 sdmac->num_bd = sg_len;
1311 sdma->channel_control[channel].current_bd_ptr = sdmac->bd_phys;
1313 return &sdmac->desc;
1315 sdmac->status = DMA_ERROR;
1319 static struct dma_async_tx_descriptor *sdma_prep_dma_cyclic(
1320 struct dma_chan *chan, dma_addr_t dma_addr, size_t buf_len,
1321 size_t period_len, enum dma_transfer_direction direction,
1322 unsigned long flags)
1324 struct sdma_channel *sdmac = to_sdma_chan(chan);
1325 struct sdma_engine *sdma = sdmac->sdma;
1326 int num_periods = buf_len / period_len;
1327 int channel = sdmac->channel;
1328 int ret, i = 0, buf = 0;
1330 dev_dbg(sdma->dev, "%s channel: %d\n", __func__, channel);
1332 if (sdmac->status == DMA_IN_PROGRESS)
1335 sdmac->status = DMA_IN_PROGRESS;
1337 sdmac->buf_tail = 0;
1338 sdmac->buf_ptail = 0;
1339 sdmac->chn_real_count = 0;
1340 sdmac->period_len = period_len;
1342 sdmac->flags |= IMX_DMA_SG_LOOP;
1343 sdmac->direction = direction;
1344 ret = sdma_load_context(sdmac);
1348 if (num_periods > NUM_BD) {
1349 dev_err(sdma->dev, "SDMA channel %d: maximum number of sg exceeded: %d > %d\n",
1350 channel, num_periods, NUM_BD);
1354 if (period_len > 0xffff) {
1355 dev_err(sdma->dev, "SDMA channel %d: maximum period size exceeded: %zu > %d\n",
1356 channel, period_len, 0xffff);
1360 while (buf < buf_len) {
1361 struct sdma_buffer_descriptor *bd = &sdmac->bd[i];
1364 bd->buffer_addr = dma_addr;
1366 bd->mode.count = period_len;
1368 if (sdmac->word_size > DMA_SLAVE_BUSWIDTH_4_BYTES)
1370 if (sdmac->word_size == DMA_SLAVE_BUSWIDTH_4_BYTES)
1371 bd->mode.command = 0;
1373 bd->mode.command = sdmac->word_size;
1375 param = BD_DONE | BD_EXTD | BD_CONT | BD_INTR;
1376 if (i + 1 == num_periods)
1379 dev_dbg(sdma->dev, "entry %d: count: %zu dma: %#llx %s%s\n",
1380 i, period_len, (u64)dma_addr,
1381 param & BD_WRAP ? "wrap" : "",
1382 param & BD_INTR ? " intr" : "");
1384 bd->mode.status = param;
1386 dma_addr += period_len;
1392 sdmac->num_bd = num_periods;
1393 sdma->channel_control[channel].current_bd_ptr = sdmac->bd_phys;
1395 return &sdmac->desc;
1397 sdmac->status = DMA_ERROR;
1401 static int sdma_config(struct dma_chan *chan,
1402 struct dma_slave_config *dmaengine_cfg)
1404 struct sdma_channel *sdmac = to_sdma_chan(chan);
1406 if (dmaengine_cfg->direction == DMA_DEV_TO_MEM) {
1407 sdmac->per_address = dmaengine_cfg->src_addr;
1408 sdmac->watermark_level = dmaengine_cfg->src_maxburst *
1409 dmaengine_cfg->src_addr_width;
1410 sdmac->word_size = dmaengine_cfg->src_addr_width;
1411 } else if (dmaengine_cfg->direction == DMA_DEV_TO_DEV) {
1412 sdmac->per_address2 = dmaengine_cfg->src_addr;
1413 sdmac->per_address = dmaengine_cfg->dst_addr;
1414 sdmac->watermark_level = dmaengine_cfg->src_maxburst &
1415 SDMA_WATERMARK_LEVEL_LWML;
1416 sdmac->watermark_level |= (dmaengine_cfg->dst_maxburst << 16) &
1417 SDMA_WATERMARK_LEVEL_HWML;
1418 sdmac->word_size = dmaengine_cfg->dst_addr_width;
1420 sdmac->per_address = dmaengine_cfg->dst_addr;
1421 sdmac->watermark_level = dmaengine_cfg->dst_maxburst *
1422 dmaengine_cfg->dst_addr_width;
1423 sdmac->word_size = dmaengine_cfg->dst_addr_width;
1425 sdmac->direction = dmaengine_cfg->direction;
1426 return sdma_config_channel(chan);
1429 static enum dma_status sdma_tx_status(struct dma_chan *chan,
1430 dma_cookie_t cookie,
1431 struct dma_tx_state *txstate)
1433 struct sdma_channel *sdmac = to_sdma_chan(chan);
1436 if (sdmac->flags & IMX_DMA_SG_LOOP)
1437 residue = (sdmac->num_bd - sdmac->buf_ptail) *
1438 sdmac->period_len - sdmac->chn_real_count;
1440 residue = sdmac->chn_count - sdmac->chn_real_count;
1442 dma_set_tx_state(txstate, chan->completed_cookie, chan->cookie,
1445 return sdmac->status;
1448 static void sdma_issue_pending(struct dma_chan *chan)
1450 struct sdma_channel *sdmac = to_sdma_chan(chan);
1451 struct sdma_engine *sdma = sdmac->sdma;
1453 if (sdmac->status == DMA_IN_PROGRESS)
1454 sdma_enable_channel(sdma, sdmac->channel);
1457 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1 34
1458 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V2 38
1459 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V3 41
1460 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V4 42
1462 static void sdma_add_scripts(struct sdma_engine *sdma,
1463 const struct sdma_script_start_addrs *addr)
1465 s32 *addr_arr = (u32 *)addr;
1466 s32 *saddr_arr = (u32 *)sdma->script_addrs;
1469 /* use the default firmware in ROM if missing external firmware */
1470 if (!sdma->script_number)
1471 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1;
1473 for (i = 0; i < sdma->script_number; i++)
1474 if (addr_arr[i] > 0)
1475 saddr_arr[i] = addr_arr[i];
1478 static void sdma_load_firmware(const struct firmware *fw, void *context)
1480 struct sdma_engine *sdma = context;
1481 const struct sdma_firmware_header *header;
1482 const struct sdma_script_start_addrs *addr;
1483 unsigned short *ram_code;
1486 dev_info(sdma->dev, "external firmware not found, using ROM firmware\n");
1487 /* In this case we just use the ROM firmware. */
1491 if (fw->size < sizeof(*header))
1494 header = (struct sdma_firmware_header *)fw->data;
1496 if (header->magic != SDMA_FIRMWARE_MAGIC)
1498 if (header->ram_code_start + header->ram_code_size > fw->size)
1500 switch (header->version_major) {
1502 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1;
1505 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V2;
1508 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V3;
1511 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V4;
1514 dev_err(sdma->dev, "unknown firmware version\n");
1518 addr = (void *)header + header->script_addrs_start;
1519 ram_code = (void *)header + header->ram_code_start;
1521 clk_enable(sdma->clk_ipg);
1522 clk_enable(sdma->clk_ahb);
1523 /* download the RAM image for SDMA */
1524 sdma_load_script(sdma, ram_code,
1525 header->ram_code_size,
1526 addr->ram_code_start_addr);
1527 clk_disable(sdma->clk_ipg);
1528 clk_disable(sdma->clk_ahb);
1530 sdma_add_scripts(sdma, addr);
1532 dev_info(sdma->dev, "loaded firmware %d.%d\n",
1533 header->version_major,
1534 header->version_minor);
1537 release_firmware(fw);
1540 #define EVENT_REMAP_CELLS 3
1542 static int sdma_event_remap(struct sdma_engine *sdma)
1544 struct device_node *np = sdma->dev->of_node;
1545 struct device_node *gpr_np = of_parse_phandle(np, "gpr", 0);
1546 struct property *event_remap;
1548 char propname[] = "fsl,sdma-event-remap";
1549 u32 reg, val, shift, num_map, i;
1552 if (IS_ERR(np) || IS_ERR(gpr_np))
1555 event_remap = of_find_property(np, propname, NULL);
1556 num_map = event_remap ? (event_remap->length / sizeof(u32)) : 0;
1558 dev_dbg(sdma->dev, "no event needs to be remapped\n");
1560 } else if (num_map % EVENT_REMAP_CELLS) {
1561 dev_err(sdma->dev, "the property %s must modulo %d\n",
1562 propname, EVENT_REMAP_CELLS);
1567 gpr = syscon_node_to_regmap(gpr_np);
1569 dev_err(sdma->dev, "failed to get gpr regmap\n");
1574 for (i = 0; i < num_map; i += EVENT_REMAP_CELLS) {
1575 ret = of_property_read_u32_index(np, propname, i, ®);
1577 dev_err(sdma->dev, "failed to read property %s index %d\n",
1582 ret = of_property_read_u32_index(np, propname, i + 1, &shift);
1584 dev_err(sdma->dev, "failed to read property %s index %d\n",
1589 ret = of_property_read_u32_index(np, propname, i + 2, &val);
1591 dev_err(sdma->dev, "failed to read property %s index %d\n",
1596 regmap_update_bits(gpr, reg, BIT(shift), val << shift);
1600 if (!IS_ERR(gpr_np))
1601 of_node_put(gpr_np);
1606 static int sdma_get_firmware(struct sdma_engine *sdma,
1607 const char *fw_name)
1611 ret = request_firmware_nowait(THIS_MODULE,
1612 FW_ACTION_HOTPLUG, fw_name, sdma->dev,
1613 GFP_KERNEL, sdma, sdma_load_firmware);
1618 static int sdma_init(struct sdma_engine *sdma)
1621 dma_addr_t ccb_phys;
1623 ret = clk_enable(sdma->clk_ipg);
1626 ret = clk_enable(sdma->clk_ahb);
1628 goto disable_clk_ipg;
1630 /* Be sure SDMA has not started yet */
1631 writel_relaxed(0, sdma->regs + SDMA_H_C0PTR);
1633 sdma->channel_control = dma_alloc_coherent(NULL,
1634 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control) +
1635 sizeof(struct sdma_context_data),
1636 &ccb_phys, GFP_KERNEL);
1638 if (!sdma->channel_control) {
1643 sdma->context = (void *)sdma->channel_control +
1644 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control);
1645 sdma->context_phys = ccb_phys +
1646 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control);
1648 /* Zero-out the CCB structures array just allocated */
1649 memset(sdma->channel_control, 0,
1650 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control));
1652 /* disable all channels */
1653 for (i = 0; i < sdma->drvdata->num_events; i++)
1654 writel_relaxed(0, sdma->regs + chnenbl_ofs(sdma, i));
1656 /* All channels have priority 0 */
1657 for (i = 0; i < MAX_DMA_CHANNELS; i++)
1658 writel_relaxed(0, sdma->regs + SDMA_CHNPRI_0 + i * 4);
1660 ret = sdma_request_channel(&sdma->channel[0]);
1664 sdma_config_ownership(&sdma->channel[0], false, true, false);
1666 /* Set Command Channel (Channel Zero) */
1667 writel_relaxed(0x4050, sdma->regs + SDMA_CHN0ADDR);
1669 /* Set bits of CONFIG register but with static context switching */
1670 /* FIXME: Check whether to set ACR bit depending on clock ratios */
1671 writel_relaxed(0, sdma->regs + SDMA_H_CONFIG);
1673 writel_relaxed(ccb_phys, sdma->regs + SDMA_H_C0PTR);
1675 /* Initializes channel's priorities */
1676 sdma_set_channel_priority(&sdma->channel[0], 7);
1678 clk_disable(sdma->clk_ipg);
1679 clk_disable(sdma->clk_ahb);
1684 clk_disable(sdma->clk_ahb);
1686 clk_disable(sdma->clk_ipg);
1687 dev_err(sdma->dev, "initialisation failed with %d\n", ret);
1691 static bool sdma_filter_fn(struct dma_chan *chan, void *fn_param)
1693 struct sdma_channel *sdmac = to_sdma_chan(chan);
1694 struct imx_dma_data *data = fn_param;
1696 if (!imx_dma_is_general_purpose(chan))
1699 sdmac->data = *data;
1700 chan->private = &sdmac->data;
1705 static struct dma_chan *sdma_xlate(struct of_phandle_args *dma_spec,
1706 struct of_dma *ofdma)
1708 struct sdma_engine *sdma = ofdma->of_dma_data;
1709 dma_cap_mask_t mask = sdma->dma_device.cap_mask;
1710 struct imx_dma_data data;
1712 if (dma_spec->args_count != 3)
1715 data.dma_request = dma_spec->args[0];
1716 data.peripheral_type = dma_spec->args[1];
1717 data.priority = dma_spec->args[2];
1719 * init dma_request2 to zero, which is not used by the dts.
1720 * For P2P, dma_request2 is init from dma_request_channel(),
1721 * chan->private will point to the imx_dma_data, and in
1722 * device_alloc_chan_resources(), imx_dma_data.dma_request2 will
1723 * be set to sdmac->event_id1.
1725 data.dma_request2 = 0;
1727 return dma_request_channel(mask, sdma_filter_fn, &data);
1730 static int sdma_probe(struct platform_device *pdev)
1732 const struct of_device_id *of_id =
1733 of_match_device(sdma_dt_ids, &pdev->dev);
1734 struct device_node *np = pdev->dev.of_node;
1735 struct device_node *spba_bus;
1736 const char *fw_name;
1739 struct resource *iores;
1740 struct resource spba_res;
1741 struct sdma_platform_data *pdata = dev_get_platdata(&pdev->dev);
1743 struct sdma_engine *sdma;
1745 const struct sdma_driver_data *drvdata = NULL;
1748 drvdata = of_id->data;
1749 else if (pdev->id_entry)
1750 drvdata = (void *)pdev->id_entry->driver_data;
1753 dev_err(&pdev->dev, "unable to find driver data\n");
1757 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
1761 sdma = devm_kzalloc(&pdev->dev, sizeof(*sdma), GFP_KERNEL);
1765 spin_lock_init(&sdma->channel_0_lock);
1767 sdma->dev = &pdev->dev;
1768 sdma->drvdata = drvdata;
1770 irq = platform_get_irq(pdev, 0);
1774 iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1775 sdma->regs = devm_ioremap_resource(&pdev->dev, iores);
1776 if (IS_ERR(sdma->regs))
1777 return PTR_ERR(sdma->regs);
1779 sdma->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
1780 if (IS_ERR(sdma->clk_ipg))
1781 return PTR_ERR(sdma->clk_ipg);
1783 sdma->clk_ahb = devm_clk_get(&pdev->dev, "ahb");
1784 if (IS_ERR(sdma->clk_ahb))
1785 return PTR_ERR(sdma->clk_ahb);
1787 ret = clk_prepare(sdma->clk_ipg);
1791 ret = clk_prepare(sdma->clk_ahb);
1795 ret = devm_request_irq(&pdev->dev, irq, sdma_int_handler, 0, "sdma",
1802 sdma->script_addrs = kzalloc(sizeof(*sdma->script_addrs), GFP_KERNEL);
1803 if (!sdma->script_addrs) {
1808 /* initially no scripts available */
1809 saddr_arr = (s32 *)sdma->script_addrs;
1810 for (i = 0; i < SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1; i++)
1811 saddr_arr[i] = -EINVAL;
1813 dma_cap_set(DMA_SLAVE, sdma->dma_device.cap_mask);
1814 dma_cap_set(DMA_CYCLIC, sdma->dma_device.cap_mask);
1816 INIT_LIST_HEAD(&sdma->dma_device.channels);
1817 /* Initialize channel parameters */
1818 for (i = 0; i < MAX_DMA_CHANNELS; i++) {
1819 struct sdma_channel *sdmac = &sdma->channel[i];
1822 spin_lock_init(&sdmac->lock);
1824 sdmac->chan.device = &sdma->dma_device;
1825 dma_cookie_init(&sdmac->chan);
1828 tasklet_init(&sdmac->tasklet, mxc_sdma_handle_channel_normal,
1829 (unsigned long) sdmac);
1831 * Add the channel to the DMAC list. Do not add channel 0 though
1832 * because we need it internally in the SDMA driver. This also means
1833 * that channel 0 in dmaengine counting matches sdma channel 1.
1836 list_add_tail(&sdmac->chan.device_node,
1837 &sdma->dma_device.channels);
1840 ret = sdma_init(sdma);
1844 ret = sdma_event_remap(sdma);
1848 if (sdma->drvdata->script_addrs)
1849 sdma_add_scripts(sdma, sdma->drvdata->script_addrs);
1850 if (pdata && pdata->script_addrs)
1851 sdma_add_scripts(sdma, pdata->script_addrs);
1854 ret = sdma_get_firmware(sdma, pdata->fw_name);
1856 dev_warn(&pdev->dev, "failed to get firmware from platform data\n");
1859 * Because that device tree does not encode ROM script address,
1860 * the RAM script in firmware is mandatory for device tree
1861 * probe, otherwise it fails.
1863 ret = of_property_read_string(np, "fsl,sdma-ram-script-name",
1866 dev_warn(&pdev->dev, "failed to get firmware name\n");
1868 ret = sdma_get_firmware(sdma, fw_name);
1870 dev_warn(&pdev->dev, "failed to get firmware from device tree\n");
1874 sdma->dma_device.dev = &pdev->dev;
1876 sdma->dma_device.device_alloc_chan_resources = sdma_alloc_chan_resources;
1877 sdma->dma_device.device_free_chan_resources = sdma_free_chan_resources;
1878 sdma->dma_device.device_tx_status = sdma_tx_status;
1879 sdma->dma_device.device_prep_slave_sg = sdma_prep_slave_sg;
1880 sdma->dma_device.device_prep_dma_cyclic = sdma_prep_dma_cyclic;
1881 sdma->dma_device.device_config = sdma_config;
1882 sdma->dma_device.device_terminate_all = sdma_disable_channel_with_delay;
1883 sdma->dma_device.src_addr_widths = SDMA_DMA_BUSWIDTHS;
1884 sdma->dma_device.dst_addr_widths = SDMA_DMA_BUSWIDTHS;
1885 sdma->dma_device.directions = SDMA_DMA_DIRECTIONS;
1886 sdma->dma_device.residue_granularity = DMA_RESIDUE_GRANULARITY_SEGMENT;
1887 sdma->dma_device.device_issue_pending = sdma_issue_pending;
1888 sdma->dma_device.dev->dma_parms = &sdma->dma_parms;
1889 dma_set_max_seg_size(sdma->dma_device.dev, 65535);
1891 platform_set_drvdata(pdev, sdma);
1893 ret = dma_async_device_register(&sdma->dma_device);
1895 dev_err(&pdev->dev, "unable to register\n");
1900 ret = of_dma_controller_register(np, sdma_xlate, sdma);
1902 dev_err(&pdev->dev, "failed to register controller\n");
1906 spba_bus = of_find_compatible_node(NULL, NULL, "fsl,spba-bus");
1907 ret = of_address_to_resource(spba_bus, 0, &spba_res);
1909 sdma->spba_start_addr = spba_res.start;
1910 sdma->spba_end_addr = spba_res.end;
1912 of_node_put(spba_bus);
1918 dma_async_device_unregister(&sdma->dma_device);
1920 kfree(sdma->script_addrs);
1922 clk_unprepare(sdma->clk_ahb);
1924 clk_unprepare(sdma->clk_ipg);
1928 static int sdma_remove(struct platform_device *pdev)
1930 struct sdma_engine *sdma = platform_get_drvdata(pdev);
1933 devm_free_irq(&pdev->dev, sdma->irq, sdma);
1934 dma_async_device_unregister(&sdma->dma_device);
1935 kfree(sdma->script_addrs);
1936 clk_unprepare(sdma->clk_ahb);
1937 clk_unprepare(sdma->clk_ipg);
1938 /* Kill the tasklet */
1939 for (i = 0; i < MAX_DMA_CHANNELS; i++) {
1940 struct sdma_channel *sdmac = &sdma->channel[i];
1942 tasklet_kill(&sdmac->tasklet);
1945 platform_set_drvdata(pdev, NULL);
1949 static struct platform_driver sdma_driver = {
1952 .of_match_table = sdma_dt_ids,
1954 .id_table = sdma_devtypes,
1955 .remove = sdma_remove,
1956 .probe = sdma_probe,
1959 module_platform_driver(sdma_driver);
1961 MODULE_AUTHOR("Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>");
1962 MODULE_DESCRIPTION("i.MX SDMA driver");
1963 #if IS_ENABLED(CONFIG_SOC_IMX6Q)
1964 MODULE_FIRMWARE("imx/sdma/sdma-imx6q.bin");
1966 #if IS_ENABLED(CONFIG_SOC_IMX7D)
1967 MODULE_FIRMWARE("imx/sdma/sdma-imx7d.bin");
1969 MODULE_LICENSE("GPL");