1 // SPDX-License-Identifier: GPL-2.0+
3 // drivers/dma/imx-sdma.c
5 // This file contains a driver for the Freescale Smart DMA engine
7 // Copyright 2010 Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>
9 // Based on code from Freescale:
11 // Copyright 2004-2009 Freescale Semiconductor, Inc. All Rights Reserved.
13 #include <linux/init.h>
14 #include <linux/iopoll.h>
15 #include <linux/module.h>
16 #include <linux/types.h>
17 #include <linux/bitops.h>
19 #include <linux/interrupt.h>
20 #include <linux/clk.h>
21 #include <linux/delay.h>
22 #include <linux/sched.h>
23 #include <linux/semaphore.h>
24 #include <linux/spinlock.h>
25 #include <linux/device.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/firmware.h>
28 #include <linux/slab.h>
29 #include <linux/platform_device.h>
30 #include <linux/dmaengine.h>
32 #include <linux/of_address.h>
33 #include <linux/of_device.h>
34 #include <linux/of_dma.h>
35 #include <linux/workqueue.h>
38 #include <linux/platform_data/dma-imx-sdma.h>
39 #include <linux/platform_data/dma-imx.h>
40 #include <linux/regmap.h>
41 #include <linux/mfd/syscon.h>
42 #include <linux/mfd/syscon/imx6q-iomuxc-gpr.h>
44 #include "dmaengine.h"
48 #define SDMA_H_C0PTR 0x000
49 #define SDMA_H_INTR 0x004
50 #define SDMA_H_STATSTOP 0x008
51 #define SDMA_H_START 0x00c
52 #define SDMA_H_EVTOVR 0x010
53 #define SDMA_H_DSPOVR 0x014
54 #define SDMA_H_HOSTOVR 0x018
55 #define SDMA_H_EVTPEND 0x01c
56 #define SDMA_H_DSPENBL 0x020
57 #define SDMA_H_RESET 0x024
58 #define SDMA_H_EVTERR 0x028
59 #define SDMA_H_INTRMSK 0x02c
60 #define SDMA_H_PSW 0x030
61 #define SDMA_H_EVTERRDBG 0x034
62 #define SDMA_H_CONFIG 0x038
63 #define SDMA_ONCE_ENB 0x040
64 #define SDMA_ONCE_DATA 0x044
65 #define SDMA_ONCE_INSTR 0x048
66 #define SDMA_ONCE_STAT 0x04c
67 #define SDMA_ONCE_CMD 0x050
68 #define SDMA_EVT_MIRROR 0x054
69 #define SDMA_ILLINSTADDR 0x058
70 #define SDMA_CHN0ADDR 0x05c
71 #define SDMA_ONCE_RTB 0x060
72 #define SDMA_XTRIG_CONF1 0x070
73 #define SDMA_XTRIG_CONF2 0x074
74 #define SDMA_CHNENBL0_IMX35 0x200
75 #define SDMA_CHNENBL0_IMX31 0x080
76 #define SDMA_CHNPRI_0 0x100
79 * Buffer descriptor status values.
90 * Data Node descriptor status values.
92 #define DND_END_OF_FRAME 0x80
93 #define DND_END_OF_XFER 0x40
95 #define DND_UNUSED 0x01
98 * IPCV2 descriptor status values.
100 #define BD_IPCV2_END_OF_FRAME 0x40
102 #define IPCV2_MAX_NODES 50
104 * Error bit set in the CCB status field by the SDMA,
105 * in setbd routine, in case of a transfer error
107 #define DATA_ERROR 0x10000000
110 * Buffer descriptor commands.
115 #define C0_SETCTX 0x07
116 #define C0_GETCTX 0x03
117 #define C0_SETDM 0x01
118 #define C0_SETPM 0x04
119 #define C0_GETDM 0x02
120 #define C0_GETPM 0x08
122 * Change endianness indicator in the BD command field
124 #define CHANGE_ENDIANNESS 0x80
127 * p_2_p watermark_level description
128 * Bits Name Description
129 * 0-7 Lower WML Lower watermark level
130 * 8 PS 1: Pad Swallowing
131 * 0: No Pad Swallowing
134 * 10 SPDIF If this bit is set both source
135 * and destination are on SPBA
136 * 11 Source Bit(SP) 1: Source on SPBA
138 * 12 Destination Bit(DP) 1: Destination on SPBA
139 * 0: Destination on AIPS
140 * 13-15 --------- MUST BE 0
141 * 16-23 Higher WML HWML
142 * 24-27 N Total number of samples after
143 * which Pad adding/Swallowing
144 * must be done. It must be odd.
145 * 28 Lower WML Event(LWE) SDMA events reg to check for
147 * 0: LWE in EVENTS register
148 * 1: LWE in EVENTS2 register
149 * 29 Higher WML Event(HWE) SDMA events reg to check for
151 * 0: HWE in EVENTS register
152 * 1: HWE in EVENTS2 register
153 * 30 --------- MUST BE 0
154 * 31 CONT 1: Amount of samples to be
155 * transferred is unknown and
156 * script will keep on
157 * transferring samples as long as
158 * both events are detected and
159 * script must be manually stopped
161 * 0: The amount of samples to be
162 * transferred is equal to the
163 * count field of mode word
165 #define SDMA_WATERMARK_LEVEL_LWML 0xFF
166 #define SDMA_WATERMARK_LEVEL_PS BIT(8)
167 #define SDMA_WATERMARK_LEVEL_PA BIT(9)
168 #define SDMA_WATERMARK_LEVEL_SPDIF BIT(10)
169 #define SDMA_WATERMARK_LEVEL_SP BIT(11)
170 #define SDMA_WATERMARK_LEVEL_DP BIT(12)
171 #define SDMA_WATERMARK_LEVEL_HWML (0xFF << 16)
172 #define SDMA_WATERMARK_LEVEL_LWE BIT(28)
173 #define SDMA_WATERMARK_LEVEL_HWE BIT(29)
174 #define SDMA_WATERMARK_LEVEL_CONT BIT(31)
176 #define SDMA_DMA_BUSWIDTHS (BIT(DMA_SLAVE_BUSWIDTH_1_BYTE) | \
177 BIT(DMA_SLAVE_BUSWIDTH_2_BYTES) | \
178 BIT(DMA_SLAVE_BUSWIDTH_4_BYTES))
180 #define SDMA_DMA_DIRECTIONS (BIT(DMA_DEV_TO_MEM) | \
181 BIT(DMA_MEM_TO_DEV) | \
185 * Mode/Count of data node descriptors - IPCv2
187 struct sdma_mode_count {
188 #define SDMA_BD_MAX_CNT 0xffff
189 u32 count : 16; /* size of the buffer pointed by this BD */
190 u32 status : 8; /* E,R,I,C,W,D status bits stored here */
191 u32 command : 8; /* command mostly used for channel 0 */
197 struct sdma_buffer_descriptor {
198 struct sdma_mode_count mode;
199 u32 buffer_addr; /* address of the buffer described */
200 u32 ext_buffer_addr; /* extended buffer address */
201 } __attribute__ ((packed));
204 * struct sdma_channel_control - Channel control Block
206 * @current_bd_ptr: current buffer descriptor processed
207 * @base_bd_ptr: first element of buffer descriptor array
208 * @unused: padding. The SDMA engine expects an array of 128 byte
211 struct sdma_channel_control {
215 } __attribute__ ((packed));
218 * struct sdma_state_registers - SDMA context for a channel
220 * @pc: program counter
222 * @t: test bit: status of arithmetic & test instruction
223 * @rpc: return program counter
225 * @sf: source fault while loading data
226 * @spc: loop start program counter
228 * @df: destination fault while storing data
229 * @epc: loop end program counter
232 struct sdma_state_registers {
244 } __attribute__ ((packed));
247 * struct sdma_context_data - sdma context specific to a channel
249 * @channel_state: channel state bits
250 * @gReg: general registers
251 * @mda: burst dma destination address register
252 * @msa: burst dma source address register
253 * @ms: burst dma status register
254 * @md: burst dma data register
255 * @pda: peripheral dma destination address register
256 * @psa: peripheral dma source address register
257 * @ps: peripheral dma status register
258 * @pd: peripheral dma data register
259 * @ca: CRC polynomial register
260 * @cs: CRC accumulator register
261 * @dda: dedicated core destination address register
262 * @dsa: dedicated core source address register
263 * @ds: dedicated core status register
264 * @dd: dedicated core data register
265 * @scratch0: 1st word of dedicated ram for context switch
266 * @scratch1: 2nd word of dedicated ram for context switch
267 * @scratch2: 3rd word of dedicated ram for context switch
268 * @scratch3: 4th word of dedicated ram for context switch
269 * @scratch4: 5th word of dedicated ram for context switch
270 * @scratch5: 6th word of dedicated ram for context switch
271 * @scratch6: 7th word of dedicated ram for context switch
272 * @scratch7: 8th word of dedicated ram for context switch
274 struct sdma_context_data {
275 struct sdma_state_registers channel_state;
299 } __attribute__ ((packed));
305 * struct sdma_desc - descriptor structor for one transfer
306 * @vd: descriptor for virt dma
307 * @num_bd: number of descriptors currently handling
308 * @bd_phys: physical address of bd
309 * @buf_tail: ID of the buffer that was processed
310 * @buf_ptail: ID of the previous buffer that was processed
311 * @period_len: period length, used in cyclic.
312 * @chn_real_count: the real count updated from bd->mode.count
313 * @chn_count: the transfer count set
314 * @sdmac: sdma_channel pointer
315 * @bd: pointer of allocate bd
318 struct virt_dma_desc vd;
321 unsigned int buf_tail;
322 unsigned int buf_ptail;
323 unsigned int period_len;
324 unsigned int chn_real_count;
325 unsigned int chn_count;
326 struct sdma_channel *sdmac;
327 struct sdma_buffer_descriptor *bd;
331 * struct sdma_channel - housekeeping for a SDMA channel
333 * @vc: virt_dma base structure
334 * @desc: sdma description including vd and other special member
335 * @sdma: pointer to the SDMA engine for this channel
336 * @channel: the channel number, matches dmaengine chan_id + 1
337 * @direction: transfer type. Needed for setting SDMA script
338 * @slave_config: Slave configuration
339 * @peripheral_type: Peripheral type. Needed for setting SDMA script
340 * @event_id0: aka dma request line
341 * @event_id1: for channels that use 2 events
342 * @word_size: peripheral access size
343 * @pc_from_device: script address for those device_2_memory
344 * @pc_to_device: script address for those memory_2_device
345 * @device_to_device: script address for those device_2_device
346 * @pc_to_pc: script address for those memory_2_memory
347 * @flags: loop mode or not
348 * @per_address: peripheral source or destination address in common case
349 * destination address in p_2_p case
350 * @per_address2: peripheral source address in p_2_p case
351 * @event_mask: event mask used in p_2_p script
352 * @watermark_level: value for gReg[7], some script will extend it from
353 * basic watermark such as p_2_p
354 * @shp_addr: value for gReg[6]
355 * @per_addr: value for gReg[2]
356 * @status: status of dma channel
357 * @context_loaded: ensure context is only loaded once
358 * @data: specific sdma interface structure
359 * @bd_pool: dma_pool for bd
360 * @terminate_worker: used to call back into terminate work function
362 struct sdma_channel {
363 struct virt_dma_chan vc;
364 struct sdma_desc *desc;
365 struct sdma_engine *sdma;
366 unsigned int channel;
367 enum dma_transfer_direction direction;
368 struct dma_slave_config slave_config;
369 enum sdma_peripheral_type peripheral_type;
370 unsigned int event_id0;
371 unsigned int event_id1;
372 enum dma_slave_buswidth word_size;
373 unsigned int pc_from_device, pc_to_device;
374 unsigned int device_to_device;
375 unsigned int pc_to_pc;
377 dma_addr_t per_address, per_address2;
378 unsigned long event_mask[2];
379 unsigned long watermark_level;
380 u32 shp_addr, per_addr;
381 enum dma_status status;
382 struct imx_dma_data data;
383 struct work_struct terminate_worker;
386 #define IMX_DMA_SG_LOOP BIT(0)
388 #define MAX_DMA_CHANNELS 32
389 #define MXC_SDMA_DEFAULT_PRIORITY 1
390 #define MXC_SDMA_MIN_PRIORITY 1
391 #define MXC_SDMA_MAX_PRIORITY 7
393 #define SDMA_FIRMWARE_MAGIC 0x414d4453
396 * struct sdma_firmware_header - Layout of the firmware image
399 * @version_major: increased whenever layout of struct
400 * sdma_script_start_addrs changes.
401 * @version_minor: firmware minor version (for binary compatible changes)
402 * @script_addrs_start: offset of struct sdma_script_start_addrs in this image
403 * @num_script_addrs: Number of script addresses in this image
404 * @ram_code_start: offset of SDMA ram image in this firmware image
405 * @ram_code_size: size of SDMA ram image
406 * @script_addrs: Stores the start address of the SDMA scripts
407 * (in SDMA memory space)
409 struct sdma_firmware_header {
413 u32 script_addrs_start;
414 u32 num_script_addrs;
419 struct sdma_driver_data {
422 struct sdma_script_start_addrs *script_addrs;
428 struct sdma_channel channel[MAX_DMA_CHANNELS];
429 struct sdma_channel_control *channel_control;
431 struct sdma_context_data *context;
432 dma_addr_t context_phys;
433 struct dma_device dma_device;
436 spinlock_t channel_0_lock;
438 struct sdma_script_start_addrs *script_addrs;
439 const struct sdma_driver_data *drvdata;
444 struct sdma_buffer_descriptor *bd0;
445 /* clock ratio for AHB:SDMA core. 1:1 is 1, 2:1 is 0*/
449 static int sdma_config_write(struct dma_chan *chan,
450 struct dma_slave_config *dmaengine_cfg,
451 enum dma_transfer_direction direction);
453 static struct sdma_driver_data sdma_imx31 = {
454 .chnenbl0 = SDMA_CHNENBL0_IMX31,
458 static struct sdma_script_start_addrs sdma_script_imx25 = {
460 .uart_2_mcu_addr = 904,
461 .per_2_app_addr = 1255,
462 .mcu_2_app_addr = 834,
463 .uartsh_2_mcu_addr = 1120,
464 .per_2_shp_addr = 1329,
465 .mcu_2_shp_addr = 1048,
466 .ata_2_mcu_addr = 1560,
467 .mcu_2_ata_addr = 1479,
468 .app_2_per_addr = 1189,
469 .app_2_mcu_addr = 770,
470 .shp_2_per_addr = 1407,
471 .shp_2_mcu_addr = 979,
474 static struct sdma_driver_data sdma_imx25 = {
475 .chnenbl0 = SDMA_CHNENBL0_IMX35,
477 .script_addrs = &sdma_script_imx25,
480 static struct sdma_driver_data sdma_imx35 = {
481 .chnenbl0 = SDMA_CHNENBL0_IMX35,
485 static struct sdma_script_start_addrs sdma_script_imx51 = {
487 .uart_2_mcu_addr = 817,
488 .mcu_2_app_addr = 747,
489 .mcu_2_shp_addr = 961,
490 .ata_2_mcu_addr = 1473,
491 .mcu_2_ata_addr = 1392,
492 .app_2_per_addr = 1033,
493 .app_2_mcu_addr = 683,
494 .shp_2_per_addr = 1251,
495 .shp_2_mcu_addr = 892,
498 static struct sdma_driver_data sdma_imx51 = {
499 .chnenbl0 = SDMA_CHNENBL0_IMX35,
501 .script_addrs = &sdma_script_imx51,
504 static struct sdma_script_start_addrs sdma_script_imx53 = {
506 .app_2_mcu_addr = 683,
507 .mcu_2_app_addr = 747,
508 .uart_2_mcu_addr = 817,
509 .shp_2_mcu_addr = 891,
510 .mcu_2_shp_addr = 960,
511 .uartsh_2_mcu_addr = 1032,
512 .spdif_2_mcu_addr = 1100,
513 .mcu_2_spdif_addr = 1134,
514 .firi_2_mcu_addr = 1193,
515 .mcu_2_firi_addr = 1290,
518 static struct sdma_driver_data sdma_imx53 = {
519 .chnenbl0 = SDMA_CHNENBL0_IMX35,
521 .script_addrs = &sdma_script_imx53,
524 static struct sdma_script_start_addrs sdma_script_imx6q = {
526 .uart_2_mcu_addr = 817,
527 .mcu_2_app_addr = 747,
528 .per_2_per_addr = 6331,
529 .uartsh_2_mcu_addr = 1032,
530 .mcu_2_shp_addr = 960,
531 .app_2_mcu_addr = 683,
532 .shp_2_mcu_addr = 891,
533 .spdif_2_mcu_addr = 1100,
534 .mcu_2_spdif_addr = 1134,
537 static struct sdma_driver_data sdma_imx6q = {
538 .chnenbl0 = SDMA_CHNENBL0_IMX35,
540 .script_addrs = &sdma_script_imx6q,
543 static struct sdma_script_start_addrs sdma_script_imx7d = {
545 .uart_2_mcu_addr = 819,
546 .mcu_2_app_addr = 749,
547 .uartsh_2_mcu_addr = 1034,
548 .mcu_2_shp_addr = 962,
549 .app_2_mcu_addr = 685,
550 .shp_2_mcu_addr = 893,
551 .spdif_2_mcu_addr = 1102,
552 .mcu_2_spdif_addr = 1136,
555 static struct sdma_driver_data sdma_imx7d = {
556 .chnenbl0 = SDMA_CHNENBL0_IMX35,
558 .script_addrs = &sdma_script_imx7d,
561 static struct sdma_driver_data sdma_imx8mq = {
562 .chnenbl0 = SDMA_CHNENBL0_IMX35,
564 .script_addrs = &sdma_script_imx7d,
568 static const struct platform_device_id sdma_devtypes[] = {
570 .name = "imx25-sdma",
571 .driver_data = (unsigned long)&sdma_imx25,
573 .name = "imx31-sdma",
574 .driver_data = (unsigned long)&sdma_imx31,
576 .name = "imx35-sdma",
577 .driver_data = (unsigned long)&sdma_imx35,
579 .name = "imx51-sdma",
580 .driver_data = (unsigned long)&sdma_imx51,
582 .name = "imx53-sdma",
583 .driver_data = (unsigned long)&sdma_imx53,
585 .name = "imx6q-sdma",
586 .driver_data = (unsigned long)&sdma_imx6q,
588 .name = "imx7d-sdma",
589 .driver_data = (unsigned long)&sdma_imx7d,
591 .name = "imx8mq-sdma",
592 .driver_data = (unsigned long)&sdma_imx8mq,
597 MODULE_DEVICE_TABLE(platform, sdma_devtypes);
599 static const struct of_device_id sdma_dt_ids[] = {
600 { .compatible = "fsl,imx6q-sdma", .data = &sdma_imx6q, },
601 { .compatible = "fsl,imx53-sdma", .data = &sdma_imx53, },
602 { .compatible = "fsl,imx51-sdma", .data = &sdma_imx51, },
603 { .compatible = "fsl,imx35-sdma", .data = &sdma_imx35, },
604 { .compatible = "fsl,imx31-sdma", .data = &sdma_imx31, },
605 { .compatible = "fsl,imx25-sdma", .data = &sdma_imx25, },
606 { .compatible = "fsl,imx7d-sdma", .data = &sdma_imx7d, },
607 { .compatible = "fsl,imx8mq-sdma", .data = &sdma_imx8mq, },
610 MODULE_DEVICE_TABLE(of, sdma_dt_ids);
612 #define SDMA_H_CONFIG_DSPDMA BIT(12) /* indicates if the DSPDMA is used */
613 #define SDMA_H_CONFIG_RTD_PINS BIT(11) /* indicates if Real-Time Debug pins are enabled */
614 #define SDMA_H_CONFIG_ACR BIT(4) /* indicates if AHB freq /core freq = 2 or 1 */
615 #define SDMA_H_CONFIG_CSM (3) /* indicates which context switch mode is selected*/
617 static inline u32 chnenbl_ofs(struct sdma_engine *sdma, unsigned int event)
619 u32 chnenbl0 = sdma->drvdata->chnenbl0;
620 return chnenbl0 + event * 4;
623 static int sdma_config_ownership(struct sdma_channel *sdmac,
624 bool event_override, bool mcu_override, bool dsp_override)
626 struct sdma_engine *sdma = sdmac->sdma;
627 int channel = sdmac->channel;
628 unsigned long evt, mcu, dsp;
630 if (event_override && mcu_override && dsp_override)
633 evt = readl_relaxed(sdma->regs + SDMA_H_EVTOVR);
634 mcu = readl_relaxed(sdma->regs + SDMA_H_HOSTOVR);
635 dsp = readl_relaxed(sdma->regs + SDMA_H_DSPOVR);
638 __clear_bit(channel, &dsp);
640 __set_bit(channel, &dsp);
643 __clear_bit(channel, &evt);
645 __set_bit(channel, &evt);
648 __clear_bit(channel, &mcu);
650 __set_bit(channel, &mcu);
652 writel_relaxed(evt, sdma->regs + SDMA_H_EVTOVR);
653 writel_relaxed(mcu, sdma->regs + SDMA_H_HOSTOVR);
654 writel_relaxed(dsp, sdma->regs + SDMA_H_DSPOVR);
659 static void sdma_enable_channel(struct sdma_engine *sdma, int channel)
661 writel(BIT(channel), sdma->regs + SDMA_H_START);
665 * sdma_run_channel0 - run a channel and wait till it's done
667 static int sdma_run_channel0(struct sdma_engine *sdma)
672 sdma_enable_channel(sdma, 0);
674 ret = readl_relaxed_poll_timeout_atomic(sdma->regs + SDMA_H_STATSTOP,
675 reg, !(reg & 1), 1, 500);
677 dev_err(sdma->dev, "Timeout waiting for CH0 ready\n");
679 /* Set bits of CONFIG register with dynamic context switching */
680 reg = readl(sdma->regs + SDMA_H_CONFIG);
681 if ((reg & SDMA_H_CONFIG_CSM) == 0) {
682 reg |= SDMA_H_CONFIG_CSM;
683 writel_relaxed(reg, sdma->regs + SDMA_H_CONFIG);
689 static int sdma_load_script(struct sdma_engine *sdma, void *buf, int size,
692 struct sdma_buffer_descriptor *bd0 = sdma->bd0;
698 buf_virt = dma_alloc_coherent(sdma->dev, size, &buf_phys, GFP_KERNEL);
703 spin_lock_irqsave(&sdma->channel_0_lock, flags);
705 bd0->mode.command = C0_SETPM;
706 bd0->mode.status = BD_DONE | BD_WRAP | BD_EXTD;
707 bd0->mode.count = size / 2;
708 bd0->buffer_addr = buf_phys;
709 bd0->ext_buffer_addr = address;
711 memcpy(buf_virt, buf, size);
713 ret = sdma_run_channel0(sdma);
715 spin_unlock_irqrestore(&sdma->channel_0_lock, flags);
717 dma_free_coherent(sdma->dev, size, buf_virt, buf_phys);
722 static void sdma_event_enable(struct sdma_channel *sdmac, unsigned int event)
724 struct sdma_engine *sdma = sdmac->sdma;
725 int channel = sdmac->channel;
727 u32 chnenbl = chnenbl_ofs(sdma, event);
729 val = readl_relaxed(sdma->regs + chnenbl);
730 __set_bit(channel, &val);
731 writel_relaxed(val, sdma->regs + chnenbl);
734 static void sdma_event_disable(struct sdma_channel *sdmac, unsigned int event)
736 struct sdma_engine *sdma = sdmac->sdma;
737 int channel = sdmac->channel;
738 u32 chnenbl = chnenbl_ofs(sdma, event);
741 val = readl_relaxed(sdma->regs + chnenbl);
742 __clear_bit(channel, &val);
743 writel_relaxed(val, sdma->regs + chnenbl);
746 static struct sdma_desc *to_sdma_desc(struct dma_async_tx_descriptor *t)
748 return container_of(t, struct sdma_desc, vd.tx);
751 static void sdma_start_desc(struct sdma_channel *sdmac)
753 struct virt_dma_desc *vd = vchan_next_desc(&sdmac->vc);
754 struct sdma_desc *desc;
755 struct sdma_engine *sdma = sdmac->sdma;
756 int channel = sdmac->channel;
762 sdmac->desc = desc = to_sdma_desc(&vd->tx);
766 sdma->channel_control[channel].base_bd_ptr = desc->bd_phys;
767 sdma->channel_control[channel].current_bd_ptr = desc->bd_phys;
768 sdma_enable_channel(sdma, sdmac->channel);
771 static void sdma_update_channel_loop(struct sdma_channel *sdmac)
773 struct sdma_buffer_descriptor *bd;
775 enum dma_status old_status = sdmac->status;
778 * loop mode. Iterate over descriptors, re-setup them and
779 * call callback function.
781 while (sdmac->desc) {
782 struct sdma_desc *desc = sdmac->desc;
784 bd = &desc->bd[desc->buf_tail];
786 if (bd->mode.status & BD_DONE)
789 if (bd->mode.status & BD_RROR) {
790 bd->mode.status &= ~BD_RROR;
791 sdmac->status = DMA_ERROR;
796 * We use bd->mode.count to calculate the residue, since contains
797 * the number of bytes present in the current buffer descriptor.
800 desc->chn_real_count = bd->mode.count;
801 bd->mode.status |= BD_DONE;
802 bd->mode.count = desc->period_len;
803 desc->buf_ptail = desc->buf_tail;
804 desc->buf_tail = (desc->buf_tail + 1) % desc->num_bd;
807 * The callback is called from the interrupt context in order
808 * to reduce latency and to avoid the risk of altering the
809 * SDMA transaction status by the time the client tasklet is
812 spin_unlock(&sdmac->vc.lock);
813 dmaengine_desc_get_callback_invoke(&desc->vd.tx, NULL);
814 spin_lock(&sdmac->vc.lock);
817 sdmac->status = old_status;
821 static void mxc_sdma_handle_channel_normal(struct sdma_channel *data)
823 struct sdma_channel *sdmac = (struct sdma_channel *) data;
824 struct sdma_buffer_descriptor *bd;
827 sdmac->desc->chn_real_count = 0;
829 * non loop mode. Iterate over all descriptors, collect
830 * errors and call callback function
832 for (i = 0; i < sdmac->desc->num_bd; i++) {
833 bd = &sdmac->desc->bd[i];
835 if (bd->mode.status & (BD_DONE | BD_RROR))
837 sdmac->desc->chn_real_count += bd->mode.count;
841 sdmac->status = DMA_ERROR;
843 sdmac->status = DMA_COMPLETE;
846 static irqreturn_t sdma_int_handler(int irq, void *dev_id)
848 struct sdma_engine *sdma = dev_id;
851 stat = readl_relaxed(sdma->regs + SDMA_H_INTR);
852 writel_relaxed(stat, sdma->regs + SDMA_H_INTR);
853 /* channel 0 is special and not handled here, see run_channel0() */
857 int channel = fls(stat) - 1;
858 struct sdma_channel *sdmac = &sdma->channel[channel];
859 struct sdma_desc *desc;
861 spin_lock(&sdmac->vc.lock);
864 if (sdmac->flags & IMX_DMA_SG_LOOP) {
865 sdma_update_channel_loop(sdmac);
867 mxc_sdma_handle_channel_normal(sdmac);
868 vchan_cookie_complete(&desc->vd);
869 sdma_start_desc(sdmac);
873 spin_unlock(&sdmac->vc.lock);
874 __clear_bit(channel, &stat);
881 * sets the pc of SDMA script according to the peripheral type
883 static void sdma_get_pc(struct sdma_channel *sdmac,
884 enum sdma_peripheral_type peripheral_type)
886 struct sdma_engine *sdma = sdmac->sdma;
887 int per_2_emi = 0, emi_2_per = 0;
889 * These are needed once we start to support transfers between
890 * two peripherals or memory-to-memory transfers
892 int per_2_per = 0, emi_2_emi = 0;
894 sdmac->pc_from_device = 0;
895 sdmac->pc_to_device = 0;
896 sdmac->device_to_device = 0;
899 switch (peripheral_type) {
900 case IMX_DMATYPE_MEMORY:
901 emi_2_emi = sdma->script_addrs->ap_2_ap_addr;
903 case IMX_DMATYPE_DSP:
904 emi_2_per = sdma->script_addrs->bp_2_ap_addr;
905 per_2_emi = sdma->script_addrs->ap_2_bp_addr;
907 case IMX_DMATYPE_FIRI:
908 per_2_emi = sdma->script_addrs->firi_2_mcu_addr;
909 emi_2_per = sdma->script_addrs->mcu_2_firi_addr;
911 case IMX_DMATYPE_UART:
912 per_2_emi = sdma->script_addrs->uart_2_mcu_addr;
913 emi_2_per = sdma->script_addrs->mcu_2_app_addr;
915 case IMX_DMATYPE_UART_SP:
916 per_2_emi = sdma->script_addrs->uartsh_2_mcu_addr;
917 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
919 case IMX_DMATYPE_ATA:
920 per_2_emi = sdma->script_addrs->ata_2_mcu_addr;
921 emi_2_per = sdma->script_addrs->mcu_2_ata_addr;
923 case IMX_DMATYPE_CSPI:
924 case IMX_DMATYPE_EXT:
925 case IMX_DMATYPE_SSI:
926 case IMX_DMATYPE_SAI:
927 per_2_emi = sdma->script_addrs->app_2_mcu_addr;
928 emi_2_per = sdma->script_addrs->mcu_2_app_addr;
930 case IMX_DMATYPE_SSI_DUAL:
931 per_2_emi = sdma->script_addrs->ssish_2_mcu_addr;
932 emi_2_per = sdma->script_addrs->mcu_2_ssish_addr;
934 case IMX_DMATYPE_SSI_SP:
935 case IMX_DMATYPE_MMC:
936 case IMX_DMATYPE_SDHC:
937 case IMX_DMATYPE_CSPI_SP:
938 case IMX_DMATYPE_ESAI:
939 case IMX_DMATYPE_MSHC_SP:
940 per_2_emi = sdma->script_addrs->shp_2_mcu_addr;
941 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
943 case IMX_DMATYPE_ASRC:
944 per_2_emi = sdma->script_addrs->asrc_2_mcu_addr;
945 emi_2_per = sdma->script_addrs->asrc_2_mcu_addr;
946 per_2_per = sdma->script_addrs->per_2_per_addr;
948 case IMX_DMATYPE_ASRC_SP:
949 per_2_emi = sdma->script_addrs->shp_2_mcu_addr;
950 emi_2_per = sdma->script_addrs->mcu_2_shp_addr;
951 per_2_per = sdma->script_addrs->per_2_per_addr;
953 case IMX_DMATYPE_MSHC:
954 per_2_emi = sdma->script_addrs->mshc_2_mcu_addr;
955 emi_2_per = sdma->script_addrs->mcu_2_mshc_addr;
957 case IMX_DMATYPE_CCM:
958 per_2_emi = sdma->script_addrs->dptc_dvfs_addr;
960 case IMX_DMATYPE_SPDIF:
961 per_2_emi = sdma->script_addrs->spdif_2_mcu_addr;
962 emi_2_per = sdma->script_addrs->mcu_2_spdif_addr;
964 case IMX_DMATYPE_IPU_MEMORY:
965 emi_2_per = sdma->script_addrs->ext_mem_2_ipu_addr;
971 sdmac->pc_from_device = per_2_emi;
972 sdmac->pc_to_device = emi_2_per;
973 sdmac->device_to_device = per_2_per;
974 sdmac->pc_to_pc = emi_2_emi;
977 static int sdma_load_context(struct sdma_channel *sdmac)
979 struct sdma_engine *sdma = sdmac->sdma;
980 int channel = sdmac->channel;
982 struct sdma_context_data *context = sdma->context;
983 struct sdma_buffer_descriptor *bd0 = sdma->bd0;
987 if (sdmac->direction == DMA_DEV_TO_MEM)
988 load_address = sdmac->pc_from_device;
989 else if (sdmac->direction == DMA_DEV_TO_DEV)
990 load_address = sdmac->device_to_device;
991 else if (sdmac->direction == DMA_MEM_TO_MEM)
992 load_address = sdmac->pc_to_pc;
994 load_address = sdmac->pc_to_device;
996 if (load_address < 0)
999 dev_dbg(sdma->dev, "load_address = %d\n", load_address);
1000 dev_dbg(sdma->dev, "wml = 0x%08x\n", (u32)sdmac->watermark_level);
1001 dev_dbg(sdma->dev, "shp_addr = 0x%08x\n", sdmac->shp_addr);
1002 dev_dbg(sdma->dev, "per_addr = 0x%08x\n", sdmac->per_addr);
1003 dev_dbg(sdma->dev, "event_mask0 = 0x%08x\n", (u32)sdmac->event_mask[0]);
1004 dev_dbg(sdma->dev, "event_mask1 = 0x%08x\n", (u32)sdmac->event_mask[1]);
1006 spin_lock_irqsave(&sdma->channel_0_lock, flags);
1008 memset(context, 0, sizeof(*context));
1009 context->channel_state.pc = load_address;
1011 /* Send by context the event mask,base address for peripheral
1012 * and watermark level
1014 context->gReg[0] = sdmac->event_mask[1];
1015 context->gReg[1] = sdmac->event_mask[0];
1016 context->gReg[2] = sdmac->per_addr;
1017 context->gReg[6] = sdmac->shp_addr;
1018 context->gReg[7] = sdmac->watermark_level;
1020 bd0->mode.command = C0_SETDM;
1021 bd0->mode.status = BD_DONE | BD_WRAP | BD_EXTD;
1022 bd0->mode.count = sizeof(*context) / 4;
1023 bd0->buffer_addr = sdma->context_phys;
1024 bd0->ext_buffer_addr = 2048 + (sizeof(*context) / 4) * channel;
1025 ret = sdma_run_channel0(sdma);
1027 spin_unlock_irqrestore(&sdma->channel_0_lock, flags);
1032 static struct sdma_channel *to_sdma_chan(struct dma_chan *chan)
1034 return container_of(chan, struct sdma_channel, vc.chan);
1037 static int sdma_disable_channel(struct dma_chan *chan)
1039 struct sdma_channel *sdmac = to_sdma_chan(chan);
1040 struct sdma_engine *sdma = sdmac->sdma;
1041 int channel = sdmac->channel;
1043 writel_relaxed(BIT(channel), sdma->regs + SDMA_H_STATSTOP);
1044 sdmac->status = DMA_ERROR;
1048 static void sdma_channel_terminate_work(struct work_struct *work)
1050 struct sdma_channel *sdmac = container_of(work, struct sdma_channel,
1052 unsigned long flags;
1056 * According to NXP R&D team a delay of one BD SDMA cost time
1057 * (maximum is 1ms) should be added after disable of the channel
1058 * bit, to ensure SDMA core has really been stopped after SDMA
1059 * clients call .device_terminate_all.
1061 usleep_range(1000, 2000);
1063 spin_lock_irqsave(&sdmac->vc.lock, flags);
1064 vchan_get_all_descriptors(&sdmac->vc, &head);
1065 spin_unlock_irqrestore(&sdmac->vc.lock, flags);
1066 vchan_dma_desc_free_list(&sdmac->vc, &head);
1069 static int sdma_terminate_all(struct dma_chan *chan)
1071 struct sdma_channel *sdmac = to_sdma_chan(chan);
1072 unsigned long flags;
1074 spin_lock_irqsave(&sdmac->vc.lock, flags);
1076 sdma_disable_channel(chan);
1079 vchan_terminate_vdesc(&sdmac->desc->vd);
1081 schedule_work(&sdmac->terminate_worker);
1084 spin_unlock_irqrestore(&sdmac->vc.lock, flags);
1089 static void sdma_channel_synchronize(struct dma_chan *chan)
1091 struct sdma_channel *sdmac = to_sdma_chan(chan);
1093 vchan_synchronize(&sdmac->vc);
1095 flush_work(&sdmac->terminate_worker);
1098 static void sdma_set_watermarklevel_for_p2p(struct sdma_channel *sdmac)
1100 struct sdma_engine *sdma = sdmac->sdma;
1102 int lwml = sdmac->watermark_level & SDMA_WATERMARK_LEVEL_LWML;
1103 int hwml = (sdmac->watermark_level & SDMA_WATERMARK_LEVEL_HWML) >> 16;
1105 set_bit(sdmac->event_id0 % 32, &sdmac->event_mask[1]);
1106 set_bit(sdmac->event_id1 % 32, &sdmac->event_mask[0]);
1108 if (sdmac->event_id0 > 31)
1109 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_LWE;
1111 if (sdmac->event_id1 > 31)
1112 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_HWE;
1115 * If LWML(src_maxburst) > HWML(dst_maxburst), we need
1116 * swap LWML and HWML of INFO(A.3.2.5.1), also need swap
1117 * r0(event_mask[1]) and r1(event_mask[0]).
1120 sdmac->watermark_level &= ~(SDMA_WATERMARK_LEVEL_LWML |
1121 SDMA_WATERMARK_LEVEL_HWML);
1122 sdmac->watermark_level |= hwml;
1123 sdmac->watermark_level |= lwml << 16;
1124 swap(sdmac->event_mask[0], sdmac->event_mask[1]);
1127 if (sdmac->per_address2 >= sdma->spba_start_addr &&
1128 sdmac->per_address2 <= sdma->spba_end_addr)
1129 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_SP;
1131 if (sdmac->per_address >= sdma->spba_start_addr &&
1132 sdmac->per_address <= sdma->spba_end_addr)
1133 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_DP;
1135 sdmac->watermark_level |= SDMA_WATERMARK_LEVEL_CONT;
1138 static int sdma_config_channel(struct dma_chan *chan)
1140 struct sdma_channel *sdmac = to_sdma_chan(chan);
1142 sdma_disable_channel(chan);
1144 sdmac->event_mask[0] = 0;
1145 sdmac->event_mask[1] = 0;
1146 sdmac->shp_addr = 0;
1147 sdmac->per_addr = 0;
1149 switch (sdmac->peripheral_type) {
1150 case IMX_DMATYPE_DSP:
1151 sdma_config_ownership(sdmac, false, true, true);
1153 case IMX_DMATYPE_MEMORY:
1154 sdma_config_ownership(sdmac, false, true, false);
1157 sdma_config_ownership(sdmac, true, true, false);
1161 sdma_get_pc(sdmac, sdmac->peripheral_type);
1163 if ((sdmac->peripheral_type != IMX_DMATYPE_MEMORY) &&
1164 (sdmac->peripheral_type != IMX_DMATYPE_DSP)) {
1165 /* Handle multiple event channels differently */
1166 if (sdmac->event_id1) {
1167 if (sdmac->peripheral_type == IMX_DMATYPE_ASRC_SP ||
1168 sdmac->peripheral_type == IMX_DMATYPE_ASRC)
1169 sdma_set_watermarklevel_for_p2p(sdmac);
1171 __set_bit(sdmac->event_id0, sdmac->event_mask);
1174 sdmac->shp_addr = sdmac->per_address;
1175 sdmac->per_addr = sdmac->per_address2;
1177 sdmac->watermark_level = 0; /* FIXME: M3_BASE_ADDRESS */
1183 static int sdma_set_channel_priority(struct sdma_channel *sdmac,
1184 unsigned int priority)
1186 struct sdma_engine *sdma = sdmac->sdma;
1187 int channel = sdmac->channel;
1189 if (priority < MXC_SDMA_MIN_PRIORITY
1190 || priority > MXC_SDMA_MAX_PRIORITY) {
1194 writel_relaxed(priority, sdma->regs + SDMA_CHNPRI_0 + 4 * channel);
1199 static int sdma_request_channel0(struct sdma_engine *sdma)
1203 sdma->bd0 = dma_alloc_coherent(sdma->dev, PAGE_SIZE, &sdma->bd0_phys,
1210 sdma->channel_control[0].base_bd_ptr = sdma->bd0_phys;
1211 sdma->channel_control[0].current_bd_ptr = sdma->bd0_phys;
1213 sdma_set_channel_priority(&sdma->channel[0], MXC_SDMA_DEFAULT_PRIORITY);
1221 static int sdma_alloc_bd(struct sdma_desc *desc)
1223 u32 bd_size = desc->num_bd * sizeof(struct sdma_buffer_descriptor);
1226 desc->bd = dma_alloc_coherent(desc->sdmac->sdma->dev, bd_size,
1227 &desc->bd_phys, GFP_NOWAIT);
1236 static void sdma_free_bd(struct sdma_desc *desc)
1238 u32 bd_size = desc->num_bd * sizeof(struct sdma_buffer_descriptor);
1240 dma_free_coherent(desc->sdmac->sdma->dev, bd_size, desc->bd,
1244 static void sdma_desc_free(struct virt_dma_desc *vd)
1246 struct sdma_desc *desc = container_of(vd, struct sdma_desc, vd);
1252 static int sdma_alloc_chan_resources(struct dma_chan *chan)
1254 struct sdma_channel *sdmac = to_sdma_chan(chan);
1255 struct imx_dma_data *data = chan->private;
1256 struct imx_dma_data mem_data;
1260 * MEMCPY may never setup chan->private by filter function such as
1261 * dmatest, thus create 'struct imx_dma_data mem_data' for this case.
1262 * Please note in any other slave case, you have to setup chan->private
1263 * with 'struct imx_dma_data' in your own filter function if you want to
1264 * request dma channel by dma_request_channel() rather than
1265 * dma_request_slave_channel(). Othwise, 'MEMCPY in case?' will appear
1266 * to warn you to correct your filter function.
1269 dev_dbg(sdmac->sdma->dev, "MEMCPY in case?\n");
1270 mem_data.priority = 2;
1271 mem_data.peripheral_type = IMX_DMATYPE_MEMORY;
1272 mem_data.dma_request = 0;
1273 mem_data.dma_request2 = 0;
1276 sdma_get_pc(sdmac, IMX_DMATYPE_MEMORY);
1279 switch (data->priority) {
1283 case DMA_PRIO_MEDIUM:
1292 sdmac->peripheral_type = data->peripheral_type;
1293 sdmac->event_id0 = data->dma_request;
1294 sdmac->event_id1 = data->dma_request2;
1296 ret = clk_enable(sdmac->sdma->clk_ipg);
1299 ret = clk_enable(sdmac->sdma->clk_ahb);
1301 goto disable_clk_ipg;
1303 ret = sdma_set_channel_priority(sdmac, prio);
1305 goto disable_clk_ahb;
1310 clk_disable(sdmac->sdma->clk_ahb);
1312 clk_disable(sdmac->sdma->clk_ipg);
1316 static void sdma_free_chan_resources(struct dma_chan *chan)
1318 struct sdma_channel *sdmac = to_sdma_chan(chan);
1319 struct sdma_engine *sdma = sdmac->sdma;
1321 sdma_terminate_all(chan);
1323 sdma_channel_synchronize(chan);
1325 sdma_event_disable(sdmac, sdmac->event_id0);
1326 if (sdmac->event_id1)
1327 sdma_event_disable(sdmac, sdmac->event_id1);
1329 sdmac->event_id0 = 0;
1330 sdmac->event_id1 = 0;
1332 sdma_set_channel_priority(sdmac, 0);
1334 clk_disable(sdma->clk_ipg);
1335 clk_disable(sdma->clk_ahb);
1338 static struct sdma_desc *sdma_transfer_init(struct sdma_channel *sdmac,
1339 enum dma_transfer_direction direction, u32 bds)
1341 struct sdma_desc *desc;
1343 desc = kzalloc((sizeof(*desc)), GFP_NOWAIT);
1347 sdmac->status = DMA_IN_PROGRESS;
1348 sdmac->direction = direction;
1351 desc->chn_count = 0;
1352 desc->chn_real_count = 0;
1354 desc->buf_ptail = 0;
1355 desc->sdmac = sdmac;
1358 if (sdma_alloc_bd(desc))
1361 /* No slave_config called in MEMCPY case, so do here */
1362 if (direction == DMA_MEM_TO_MEM)
1363 sdma_config_ownership(sdmac, false, true, false);
1365 if (sdma_load_context(sdmac))
1376 static struct dma_async_tx_descriptor *sdma_prep_memcpy(
1377 struct dma_chan *chan, dma_addr_t dma_dst,
1378 dma_addr_t dma_src, size_t len, unsigned long flags)
1380 struct sdma_channel *sdmac = to_sdma_chan(chan);
1381 struct sdma_engine *sdma = sdmac->sdma;
1382 int channel = sdmac->channel;
1385 struct sdma_buffer_descriptor *bd;
1386 struct sdma_desc *desc;
1391 dev_dbg(sdma->dev, "memcpy: %pad->%pad, len=%zu, channel=%d.\n",
1392 &dma_src, &dma_dst, len, channel);
1394 desc = sdma_transfer_init(sdmac, DMA_MEM_TO_MEM,
1395 len / SDMA_BD_MAX_CNT + 1);
1400 count = min_t(size_t, len, SDMA_BD_MAX_CNT);
1402 bd->buffer_addr = dma_src;
1403 bd->ext_buffer_addr = dma_dst;
1404 bd->mode.count = count;
1405 desc->chn_count += count;
1406 bd->mode.command = 0;
1413 param = BD_DONE | BD_EXTD | BD_CONT;
1421 dev_dbg(sdma->dev, "entry %d: count: %zd dma: 0x%x %s%s\n",
1422 i, count, bd->buffer_addr,
1423 param & BD_WRAP ? "wrap" : "",
1424 param & BD_INTR ? " intr" : "");
1426 bd->mode.status = param;
1429 return vchan_tx_prep(&sdmac->vc, &desc->vd, flags);
1432 static struct dma_async_tx_descriptor *sdma_prep_slave_sg(
1433 struct dma_chan *chan, struct scatterlist *sgl,
1434 unsigned int sg_len, enum dma_transfer_direction direction,
1435 unsigned long flags, void *context)
1437 struct sdma_channel *sdmac = to_sdma_chan(chan);
1438 struct sdma_engine *sdma = sdmac->sdma;
1440 int channel = sdmac->channel;
1441 struct scatterlist *sg;
1442 struct sdma_desc *desc;
1444 sdma_config_write(chan, &sdmac->slave_config, direction);
1446 desc = sdma_transfer_init(sdmac, direction, sg_len);
1450 dev_dbg(sdma->dev, "setting up %d entries for channel %d.\n",
1453 for_each_sg(sgl, sg, sg_len, i) {
1454 struct sdma_buffer_descriptor *bd = &desc->bd[i];
1457 bd->buffer_addr = sg->dma_address;
1459 count = sg_dma_len(sg);
1461 if (count > SDMA_BD_MAX_CNT) {
1462 dev_err(sdma->dev, "SDMA channel %d: maximum bytes for sg entry exceeded: %d > %d\n",
1463 channel, count, SDMA_BD_MAX_CNT);
1467 bd->mode.count = count;
1468 desc->chn_count += count;
1470 if (sdmac->word_size > DMA_SLAVE_BUSWIDTH_4_BYTES)
1473 switch (sdmac->word_size) {
1474 case DMA_SLAVE_BUSWIDTH_4_BYTES:
1475 bd->mode.command = 0;
1476 if (count & 3 || sg->dma_address & 3)
1479 case DMA_SLAVE_BUSWIDTH_2_BYTES:
1480 bd->mode.command = 2;
1481 if (count & 1 || sg->dma_address & 1)
1484 case DMA_SLAVE_BUSWIDTH_1_BYTE:
1485 bd->mode.command = 1;
1491 param = BD_DONE | BD_EXTD | BD_CONT;
1493 if (i + 1 == sg_len) {
1499 dev_dbg(sdma->dev, "entry %d: count: %d dma: %#llx %s%s\n",
1500 i, count, (u64)sg->dma_address,
1501 param & BD_WRAP ? "wrap" : "",
1502 param & BD_INTR ? " intr" : "");
1504 bd->mode.status = param;
1507 return vchan_tx_prep(&sdmac->vc, &desc->vd, flags);
1512 sdmac->status = DMA_ERROR;
1516 static struct dma_async_tx_descriptor *sdma_prep_dma_cyclic(
1517 struct dma_chan *chan, dma_addr_t dma_addr, size_t buf_len,
1518 size_t period_len, enum dma_transfer_direction direction,
1519 unsigned long flags)
1521 struct sdma_channel *sdmac = to_sdma_chan(chan);
1522 struct sdma_engine *sdma = sdmac->sdma;
1523 int num_periods = buf_len / period_len;
1524 int channel = sdmac->channel;
1526 struct sdma_desc *desc;
1528 dev_dbg(sdma->dev, "%s channel: %d\n", __func__, channel);
1530 sdma_config_write(chan, &sdmac->slave_config, direction);
1532 desc = sdma_transfer_init(sdmac, direction, num_periods);
1536 desc->period_len = period_len;
1538 sdmac->flags |= IMX_DMA_SG_LOOP;
1540 if (period_len > SDMA_BD_MAX_CNT) {
1541 dev_err(sdma->dev, "SDMA channel %d: maximum period size exceeded: %zu > %d\n",
1542 channel, period_len, SDMA_BD_MAX_CNT);
1546 while (buf < buf_len) {
1547 struct sdma_buffer_descriptor *bd = &desc->bd[i];
1550 bd->buffer_addr = dma_addr;
1552 bd->mode.count = period_len;
1554 if (sdmac->word_size > DMA_SLAVE_BUSWIDTH_4_BYTES)
1556 if (sdmac->word_size == DMA_SLAVE_BUSWIDTH_4_BYTES)
1557 bd->mode.command = 0;
1559 bd->mode.command = sdmac->word_size;
1561 param = BD_DONE | BD_EXTD | BD_CONT | BD_INTR;
1562 if (i + 1 == num_periods)
1565 dev_dbg(sdma->dev, "entry %d: count: %zu dma: %#llx %s%s\n",
1566 i, period_len, (u64)dma_addr,
1567 param & BD_WRAP ? "wrap" : "",
1568 param & BD_INTR ? " intr" : "");
1570 bd->mode.status = param;
1572 dma_addr += period_len;
1578 return vchan_tx_prep(&sdmac->vc, &desc->vd, flags);
1583 sdmac->status = DMA_ERROR;
1587 static int sdma_config_write(struct dma_chan *chan,
1588 struct dma_slave_config *dmaengine_cfg,
1589 enum dma_transfer_direction direction)
1591 struct sdma_channel *sdmac = to_sdma_chan(chan);
1593 if (direction == DMA_DEV_TO_MEM) {
1594 sdmac->per_address = dmaengine_cfg->src_addr;
1595 sdmac->watermark_level = dmaengine_cfg->src_maxburst *
1596 dmaengine_cfg->src_addr_width;
1597 sdmac->word_size = dmaengine_cfg->src_addr_width;
1598 } else if (direction == DMA_DEV_TO_DEV) {
1599 sdmac->per_address2 = dmaengine_cfg->src_addr;
1600 sdmac->per_address = dmaengine_cfg->dst_addr;
1601 sdmac->watermark_level = dmaengine_cfg->src_maxburst &
1602 SDMA_WATERMARK_LEVEL_LWML;
1603 sdmac->watermark_level |= (dmaengine_cfg->dst_maxburst << 16) &
1604 SDMA_WATERMARK_LEVEL_HWML;
1605 sdmac->word_size = dmaengine_cfg->dst_addr_width;
1607 sdmac->per_address = dmaengine_cfg->dst_addr;
1608 sdmac->watermark_level = dmaengine_cfg->dst_maxburst *
1609 dmaengine_cfg->dst_addr_width;
1610 sdmac->word_size = dmaengine_cfg->dst_addr_width;
1612 sdmac->direction = direction;
1613 return sdma_config_channel(chan);
1616 static int sdma_config(struct dma_chan *chan,
1617 struct dma_slave_config *dmaengine_cfg)
1619 struct sdma_channel *sdmac = to_sdma_chan(chan);
1621 memcpy(&sdmac->slave_config, dmaengine_cfg, sizeof(*dmaengine_cfg));
1623 /* Set ENBLn earlier to make sure dma request triggered after that */
1624 if (sdmac->event_id0 >= sdmac->sdma->drvdata->num_events)
1626 sdma_event_enable(sdmac, sdmac->event_id0);
1628 if (sdmac->event_id1) {
1629 if (sdmac->event_id1 >= sdmac->sdma->drvdata->num_events)
1631 sdma_event_enable(sdmac, sdmac->event_id1);
1637 static enum dma_status sdma_tx_status(struct dma_chan *chan,
1638 dma_cookie_t cookie,
1639 struct dma_tx_state *txstate)
1641 struct sdma_channel *sdmac = to_sdma_chan(chan);
1642 struct sdma_desc *desc = NULL;
1644 struct virt_dma_desc *vd;
1645 enum dma_status ret;
1646 unsigned long flags;
1648 ret = dma_cookie_status(chan, cookie, txstate);
1649 if (ret == DMA_COMPLETE || !txstate)
1652 spin_lock_irqsave(&sdmac->vc.lock, flags);
1654 vd = vchan_find_desc(&sdmac->vc, cookie);
1656 desc = to_sdma_desc(&vd->tx);
1657 else if (sdmac->desc && sdmac->desc->vd.tx.cookie == cookie)
1661 if (sdmac->flags & IMX_DMA_SG_LOOP)
1662 residue = (desc->num_bd - desc->buf_ptail) *
1663 desc->period_len - desc->chn_real_count;
1665 residue = desc->chn_count - desc->chn_real_count;
1670 spin_unlock_irqrestore(&sdmac->vc.lock, flags);
1672 dma_set_tx_state(txstate, chan->completed_cookie, chan->cookie,
1675 return sdmac->status;
1678 static void sdma_issue_pending(struct dma_chan *chan)
1680 struct sdma_channel *sdmac = to_sdma_chan(chan);
1681 unsigned long flags;
1683 spin_lock_irqsave(&sdmac->vc.lock, flags);
1684 if (vchan_issue_pending(&sdmac->vc) && !sdmac->desc)
1685 sdma_start_desc(sdmac);
1686 spin_unlock_irqrestore(&sdmac->vc.lock, flags);
1689 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1 34
1690 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V2 38
1691 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V3 41
1692 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V4 42
1694 static void sdma_add_scripts(struct sdma_engine *sdma,
1695 const struct sdma_script_start_addrs *addr)
1697 s32 *addr_arr = (u32 *)addr;
1698 s32 *saddr_arr = (u32 *)sdma->script_addrs;
1701 /* use the default firmware in ROM if missing external firmware */
1702 if (!sdma->script_number)
1703 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1;
1705 if (sdma->script_number > sizeof(struct sdma_script_start_addrs)
1708 "SDMA script number %d not match with firmware.\n",
1709 sdma->script_number);
1713 for (i = 0; i < sdma->script_number; i++)
1714 if (addr_arr[i] > 0)
1715 saddr_arr[i] = addr_arr[i];
1718 static void sdma_load_firmware(const struct firmware *fw, void *context)
1720 struct sdma_engine *sdma = context;
1721 const struct sdma_firmware_header *header;
1722 const struct sdma_script_start_addrs *addr;
1723 unsigned short *ram_code;
1726 dev_info(sdma->dev, "external firmware not found, using ROM firmware\n");
1727 /* In this case we just use the ROM firmware. */
1731 if (fw->size < sizeof(*header))
1734 header = (struct sdma_firmware_header *)fw->data;
1736 if (header->magic != SDMA_FIRMWARE_MAGIC)
1738 if (header->ram_code_start + header->ram_code_size > fw->size)
1740 switch (header->version_major) {
1742 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1;
1745 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V2;
1748 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V3;
1751 sdma->script_number = SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V4;
1754 dev_err(sdma->dev, "unknown firmware version\n");
1758 addr = (void *)header + header->script_addrs_start;
1759 ram_code = (void *)header + header->ram_code_start;
1761 clk_enable(sdma->clk_ipg);
1762 clk_enable(sdma->clk_ahb);
1763 /* download the RAM image for SDMA */
1764 sdma_load_script(sdma, ram_code,
1765 header->ram_code_size,
1766 addr->ram_code_start_addr);
1767 clk_disable(sdma->clk_ipg);
1768 clk_disable(sdma->clk_ahb);
1770 sdma_add_scripts(sdma, addr);
1772 dev_info(sdma->dev, "loaded firmware %d.%d\n",
1773 header->version_major,
1774 header->version_minor);
1777 release_firmware(fw);
1780 #define EVENT_REMAP_CELLS 3
1782 static int sdma_event_remap(struct sdma_engine *sdma)
1784 struct device_node *np = sdma->dev->of_node;
1785 struct device_node *gpr_np = of_parse_phandle(np, "gpr", 0);
1786 struct property *event_remap;
1788 char propname[] = "fsl,sdma-event-remap";
1789 u32 reg, val, shift, num_map, i;
1792 if (IS_ERR(np) || !gpr_np)
1795 event_remap = of_find_property(np, propname, NULL);
1796 num_map = event_remap ? (event_remap->length / sizeof(u32)) : 0;
1798 dev_dbg(sdma->dev, "no event needs to be remapped\n");
1800 } else if (num_map % EVENT_REMAP_CELLS) {
1801 dev_err(sdma->dev, "the property %s must modulo %d\n",
1802 propname, EVENT_REMAP_CELLS);
1807 gpr = syscon_node_to_regmap(gpr_np);
1809 dev_err(sdma->dev, "failed to get gpr regmap\n");
1814 for (i = 0; i < num_map; i += EVENT_REMAP_CELLS) {
1815 ret = of_property_read_u32_index(np, propname, i, ®);
1817 dev_err(sdma->dev, "failed to read property %s index %d\n",
1822 ret = of_property_read_u32_index(np, propname, i + 1, &shift);
1824 dev_err(sdma->dev, "failed to read property %s index %d\n",
1829 ret = of_property_read_u32_index(np, propname, i + 2, &val);
1831 dev_err(sdma->dev, "failed to read property %s index %d\n",
1836 regmap_update_bits(gpr, reg, BIT(shift), val << shift);
1841 of_node_put(gpr_np);
1846 static int sdma_get_firmware(struct sdma_engine *sdma,
1847 const char *fw_name)
1851 ret = reject_firmware_nowait(THIS_MODULE,
1852 FW_ACTION_HOTPLUG, fw_name, sdma->dev,
1853 GFP_KERNEL, sdma, sdma_load_firmware);
1858 static int sdma_init(struct sdma_engine *sdma)
1861 dma_addr_t ccb_phys;
1863 ret = clk_enable(sdma->clk_ipg);
1866 ret = clk_enable(sdma->clk_ahb);
1868 goto disable_clk_ipg;
1870 if (sdma->drvdata->check_ratio &&
1871 (clk_get_rate(sdma->clk_ahb) == clk_get_rate(sdma->clk_ipg)))
1872 sdma->clk_ratio = 1;
1874 /* Be sure SDMA has not started yet */
1875 writel_relaxed(0, sdma->regs + SDMA_H_C0PTR);
1877 sdma->channel_control = dma_alloc_coherent(sdma->dev,
1878 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control) +
1879 sizeof(struct sdma_context_data),
1880 &ccb_phys, GFP_KERNEL);
1882 if (!sdma->channel_control) {
1887 sdma->context = (void *)sdma->channel_control +
1888 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control);
1889 sdma->context_phys = ccb_phys +
1890 MAX_DMA_CHANNELS * sizeof (struct sdma_channel_control);
1892 /* disable all channels */
1893 for (i = 0; i < sdma->drvdata->num_events; i++)
1894 writel_relaxed(0, sdma->regs + chnenbl_ofs(sdma, i));
1896 /* All channels have priority 0 */
1897 for (i = 0; i < MAX_DMA_CHANNELS; i++)
1898 writel_relaxed(0, sdma->regs + SDMA_CHNPRI_0 + i * 4);
1900 ret = sdma_request_channel0(sdma);
1904 sdma_config_ownership(&sdma->channel[0], false, true, false);
1906 /* Set Command Channel (Channel Zero) */
1907 writel_relaxed(0x4050, sdma->regs + SDMA_CHN0ADDR);
1909 /* Set bits of CONFIG register but with static context switching */
1910 if (sdma->clk_ratio)
1911 writel_relaxed(SDMA_H_CONFIG_ACR, sdma->regs + SDMA_H_CONFIG);
1913 writel_relaxed(0, sdma->regs + SDMA_H_CONFIG);
1915 writel_relaxed(ccb_phys, sdma->regs + SDMA_H_C0PTR);
1917 /* Initializes channel's priorities */
1918 sdma_set_channel_priority(&sdma->channel[0], 7);
1920 clk_disable(sdma->clk_ipg);
1921 clk_disable(sdma->clk_ahb);
1926 clk_disable(sdma->clk_ahb);
1928 clk_disable(sdma->clk_ipg);
1929 dev_err(sdma->dev, "initialisation failed with %d\n", ret);
1933 static bool sdma_filter_fn(struct dma_chan *chan, void *fn_param)
1935 struct sdma_channel *sdmac = to_sdma_chan(chan);
1936 struct imx_dma_data *data = fn_param;
1938 if (!imx_dma_is_general_purpose(chan))
1941 sdmac->data = *data;
1942 chan->private = &sdmac->data;
1947 static struct dma_chan *sdma_xlate(struct of_phandle_args *dma_spec,
1948 struct of_dma *ofdma)
1950 struct sdma_engine *sdma = ofdma->of_dma_data;
1951 dma_cap_mask_t mask = sdma->dma_device.cap_mask;
1952 struct imx_dma_data data;
1954 if (dma_spec->args_count != 3)
1957 data.dma_request = dma_spec->args[0];
1958 data.peripheral_type = dma_spec->args[1];
1959 data.priority = dma_spec->args[2];
1961 * init dma_request2 to zero, which is not used by the dts.
1962 * For P2P, dma_request2 is init from dma_request_channel(),
1963 * chan->private will point to the imx_dma_data, and in
1964 * device_alloc_chan_resources(), imx_dma_data.dma_request2 will
1965 * be set to sdmac->event_id1.
1967 data.dma_request2 = 0;
1969 return __dma_request_channel(&mask, sdma_filter_fn, &data,
1973 static int sdma_probe(struct platform_device *pdev)
1975 const struct of_device_id *of_id =
1976 of_match_device(sdma_dt_ids, &pdev->dev);
1977 struct device_node *np = pdev->dev.of_node;
1978 struct device_node *spba_bus;
1979 const char *fw_name;
1982 struct resource *iores;
1983 struct resource spba_res;
1984 struct sdma_platform_data *pdata = dev_get_platdata(&pdev->dev);
1986 struct sdma_engine *sdma;
1988 const struct sdma_driver_data *drvdata = NULL;
1991 drvdata = of_id->data;
1992 else if (pdev->id_entry)
1993 drvdata = (void *)pdev->id_entry->driver_data;
1996 dev_err(&pdev->dev, "unable to find driver data\n");
2000 ret = dma_coerce_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
2004 sdma = devm_kzalloc(&pdev->dev, sizeof(*sdma), GFP_KERNEL);
2008 spin_lock_init(&sdma->channel_0_lock);
2010 sdma->dev = &pdev->dev;
2011 sdma->drvdata = drvdata;
2013 irq = platform_get_irq(pdev, 0);
2017 iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2018 sdma->regs = devm_ioremap_resource(&pdev->dev, iores);
2019 if (IS_ERR(sdma->regs))
2020 return PTR_ERR(sdma->regs);
2022 sdma->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
2023 if (IS_ERR(sdma->clk_ipg))
2024 return PTR_ERR(sdma->clk_ipg);
2026 sdma->clk_ahb = devm_clk_get(&pdev->dev, "ahb");
2027 if (IS_ERR(sdma->clk_ahb))
2028 return PTR_ERR(sdma->clk_ahb);
2030 ret = clk_prepare(sdma->clk_ipg);
2034 ret = clk_prepare(sdma->clk_ahb);
2038 ret = devm_request_irq(&pdev->dev, irq, sdma_int_handler, 0, "sdma",
2045 sdma->script_addrs = kzalloc(sizeof(*sdma->script_addrs), GFP_KERNEL);
2046 if (!sdma->script_addrs) {
2051 /* initially no scripts available */
2052 saddr_arr = (s32 *)sdma->script_addrs;
2053 for (i = 0; i < sizeof(*sdma->script_addrs) / sizeof(s32); i++)
2054 saddr_arr[i] = -EINVAL;
2056 dma_cap_set(DMA_SLAVE, sdma->dma_device.cap_mask);
2057 dma_cap_set(DMA_CYCLIC, sdma->dma_device.cap_mask);
2058 dma_cap_set(DMA_MEMCPY, sdma->dma_device.cap_mask);
2060 INIT_LIST_HEAD(&sdma->dma_device.channels);
2061 /* Initialize channel parameters */
2062 for (i = 0; i < MAX_DMA_CHANNELS; i++) {
2063 struct sdma_channel *sdmac = &sdma->channel[i];
2068 sdmac->vc.desc_free = sdma_desc_free;
2069 INIT_WORK(&sdmac->terminate_worker,
2070 sdma_channel_terminate_work);
2072 * Add the channel to the DMAC list. Do not add channel 0 though
2073 * because we need it internally in the SDMA driver. This also means
2074 * that channel 0 in dmaengine counting matches sdma channel 1.
2077 vchan_init(&sdmac->vc, &sdma->dma_device);
2080 ret = sdma_init(sdma);
2084 ret = sdma_event_remap(sdma);
2088 if (sdma->drvdata->script_addrs)
2089 sdma_add_scripts(sdma, sdma->drvdata->script_addrs);
2090 if (pdata && pdata->script_addrs)
2091 sdma_add_scripts(sdma, pdata->script_addrs);
2093 sdma->dma_device.dev = &pdev->dev;
2095 sdma->dma_device.device_alloc_chan_resources = sdma_alloc_chan_resources;
2096 sdma->dma_device.device_free_chan_resources = sdma_free_chan_resources;
2097 sdma->dma_device.device_tx_status = sdma_tx_status;
2098 sdma->dma_device.device_prep_slave_sg = sdma_prep_slave_sg;
2099 sdma->dma_device.device_prep_dma_cyclic = sdma_prep_dma_cyclic;
2100 sdma->dma_device.device_config = sdma_config;
2101 sdma->dma_device.device_terminate_all = sdma_terminate_all;
2102 sdma->dma_device.device_synchronize = sdma_channel_synchronize;
2103 sdma->dma_device.src_addr_widths = SDMA_DMA_BUSWIDTHS;
2104 sdma->dma_device.dst_addr_widths = SDMA_DMA_BUSWIDTHS;
2105 sdma->dma_device.directions = SDMA_DMA_DIRECTIONS;
2106 sdma->dma_device.residue_granularity = DMA_RESIDUE_GRANULARITY_SEGMENT;
2107 sdma->dma_device.device_prep_dma_memcpy = sdma_prep_memcpy;
2108 sdma->dma_device.device_issue_pending = sdma_issue_pending;
2109 sdma->dma_device.copy_align = 2;
2110 dma_set_max_seg_size(sdma->dma_device.dev, SDMA_BD_MAX_CNT);
2112 platform_set_drvdata(pdev, sdma);
2114 ret = dma_async_device_register(&sdma->dma_device);
2116 dev_err(&pdev->dev, "unable to register\n");
2121 ret = of_dma_controller_register(np, sdma_xlate, sdma);
2123 dev_err(&pdev->dev, "failed to register controller\n");
2127 spba_bus = of_find_compatible_node(NULL, NULL, "fsl,spba-bus");
2128 ret = of_address_to_resource(spba_bus, 0, &spba_res);
2130 sdma->spba_start_addr = spba_res.start;
2131 sdma->spba_end_addr = spba_res.end;
2133 of_node_put(spba_bus);
2137 * Kick off firmware loading as the very last step:
2138 * attempt to load firmware only if we're not on the error path, because
2139 * the firmware callback requires a fully functional and allocated sdma
2143 ret = sdma_get_firmware(sdma, pdata->fw_name);
2145 dev_warn(&pdev->dev, "failed to get firmware from platform data\n");
2148 * Because that device tree does not encode ROM script address,
2149 * the RAM script in firmware is mandatory for device tree
2150 * probe, otherwise it fails.
2152 ret = of_property_read_string(np, "fsl,sdma-ram-script-name",
2155 dev_warn(&pdev->dev, "failed to get firmware name\n");
2157 ret = sdma_get_firmware(sdma, fw_name);
2159 dev_warn(&pdev->dev, "failed to get firmware from device tree\n");
2166 dma_async_device_unregister(&sdma->dma_device);
2168 kfree(sdma->script_addrs);
2170 clk_unprepare(sdma->clk_ahb);
2172 clk_unprepare(sdma->clk_ipg);
2176 static int sdma_remove(struct platform_device *pdev)
2178 struct sdma_engine *sdma = platform_get_drvdata(pdev);
2181 devm_free_irq(&pdev->dev, sdma->irq, sdma);
2182 dma_async_device_unregister(&sdma->dma_device);
2183 kfree(sdma->script_addrs);
2184 clk_unprepare(sdma->clk_ahb);
2185 clk_unprepare(sdma->clk_ipg);
2186 /* Kill the tasklet */
2187 for (i = 0; i < MAX_DMA_CHANNELS; i++) {
2188 struct sdma_channel *sdmac = &sdma->channel[i];
2190 tasklet_kill(&sdmac->vc.task);
2191 sdma_free_chan_resources(&sdmac->vc.chan);
2194 platform_set_drvdata(pdev, NULL);
2198 static struct platform_driver sdma_driver = {
2201 .of_match_table = sdma_dt_ids,
2203 .id_table = sdma_devtypes,
2204 .remove = sdma_remove,
2205 .probe = sdma_probe,
2208 module_platform_driver(sdma_driver);
2210 MODULE_AUTHOR("Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>");
2211 MODULE_DESCRIPTION("i.MX SDMA driver");
2212 #if IS_ENABLED(CONFIG_SOC_IMX6Q)
2215 #if IS_ENABLED(CONFIG_SOC_IMX7D) || IS_ENABLED(CONFIG_SOC_IMX8M)
2218 MODULE_LICENSE("GPL");