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/module.h>
22 #include <linux/types.h>
24 #include <linux/interrupt.h>
25 #include <linux/clk.h>
26 #include <linux/wait.h>
27 #include <linux/sched.h>
28 #include <linux/semaphore.h>
29 #include <linux/spinlock.h>
30 #include <linux/device.h>
31 #include <linux/dma-mapping.h>
32 #include <linux/firmware.h>
33 #include <linux/slab.h>
34 #include <linux/platform_device.h>
35 #include <linux/dmaengine.h>
37 #include <linux/of_device.h>
38 #include <linux/module.h>
41 #include <mach/sdma.h>
43 #include <mach/hardware.h>
46 #define SDMA_H_C0PTR 0x000
47 #define SDMA_H_INTR 0x004
48 #define SDMA_H_STATSTOP 0x008
49 #define SDMA_H_START 0x00c
50 #define SDMA_H_EVTOVR 0x010
51 #define SDMA_H_DSPOVR 0x014
52 #define SDMA_H_HOSTOVR 0x018
53 #define SDMA_H_EVTPEND 0x01c
54 #define SDMA_H_DSPENBL 0x020
55 #define SDMA_H_RESET 0x024
56 #define SDMA_H_EVTERR 0x028
57 #define SDMA_H_INTRMSK 0x02c
58 #define SDMA_H_PSW 0x030
59 #define SDMA_H_EVTERRDBG 0x034
60 #define SDMA_H_CONFIG 0x038
61 #define SDMA_ONCE_ENB 0x040
62 #define SDMA_ONCE_DATA 0x044
63 #define SDMA_ONCE_INSTR 0x048
64 #define SDMA_ONCE_STAT 0x04c
65 #define SDMA_ONCE_CMD 0x050
66 #define SDMA_EVT_MIRROR 0x054
67 #define SDMA_ILLINSTADDR 0x058
68 #define SDMA_CHN0ADDR 0x05c
69 #define SDMA_ONCE_RTB 0x060
70 #define SDMA_XTRIG_CONF1 0x070
71 #define SDMA_XTRIG_CONF2 0x074
72 #define SDMA_CHNENBL0_IMX35 0x200
73 #define SDMA_CHNENBL0_IMX31 0x080
74 #define SDMA_CHNPRI_0 0x100
77 * Buffer descriptor status values.
88 * Data Node descriptor status values.
90 #define DND_END_OF_FRAME 0x80
91 #define DND_END_OF_XFER 0x40
93 #define DND_UNUSED 0x01
96 * IPCV2 descriptor status values.
98 #define BD_IPCV2_END_OF_FRAME 0x40
100 #define IPCV2_MAX_NODES 50
102 * Error bit set in the CCB status field by the SDMA,
103 * in setbd routine, in case of a transfer error
105 #define DATA_ERROR 0x10000000
108 * Buffer descriptor commands.
113 #define C0_SETCTX 0x07
114 #define C0_GETCTX 0x03
115 #define C0_SETDM 0x01
116 #define C0_SETPM 0x04
117 #define C0_GETDM 0x02
118 #define C0_GETPM 0x08
120 * Change endianness indicator in the BD command field
122 #define CHANGE_ENDIANNESS 0x80
125 * Mode/Count of data node descriptors - IPCv2
127 struct sdma_mode_count
{
128 u32 count
: 16; /* size of the buffer pointed by this BD */
129 u32 status
: 8; /* E,R,I,C,W,D status bits stored here */
130 u32 command
: 8; /* command mostlky used for channel 0 */
136 struct sdma_buffer_descriptor
{
137 struct sdma_mode_count mode
;
138 u32 buffer_addr
; /* address of the buffer described */
139 u32 ext_buffer_addr
; /* extended buffer address */
140 } __attribute__ ((packed
));
143 * struct sdma_channel_control - Channel control Block
145 * @current_bd_ptr current buffer descriptor processed
146 * @base_bd_ptr first element of buffer descriptor array
147 * @unused padding. The SDMA engine expects an array of 128 byte
150 struct sdma_channel_control
{
154 } __attribute__ ((packed
));
157 * struct sdma_state_registers - SDMA context for a channel
159 * @pc: program counter
160 * @t: test bit: status of arithmetic & test instruction
161 * @rpc: return program counter
162 * @sf: source fault while loading data
163 * @spc: loop start program counter
164 * @df: destination fault while storing data
165 * @epc: loop end program counter
168 struct sdma_state_registers
{
180 } __attribute__ ((packed
));
183 * struct sdma_context_data - sdma context specific to a channel
185 * @channel_state: channel state bits
186 * @gReg: general registers
187 * @mda: burst dma destination address register
188 * @msa: burst dma source address register
189 * @ms: burst dma status register
190 * @md: burst dma data register
191 * @pda: peripheral dma destination address register
192 * @psa: peripheral dma source address register
193 * @ps: peripheral dma status register
194 * @pd: peripheral dma data register
195 * @ca: CRC polynomial register
196 * @cs: CRC accumulator register
197 * @dda: dedicated core destination address register
198 * @dsa: dedicated core source address register
199 * @ds: dedicated core status register
200 * @dd: dedicated core data register
202 struct sdma_context_data
{
203 struct sdma_state_registers channel_state
;
227 } __attribute__ ((packed
));
229 #define NUM_BD (int)(PAGE_SIZE / sizeof(struct sdma_buffer_descriptor))
234 * struct sdma_channel - housekeeping for a SDMA channel
236 * @sdma pointer to the SDMA engine for this channel
237 * @channel the channel number, matches dmaengine chan_id + 1
238 * @direction transfer type. Needed for setting SDMA script
239 * @peripheral_type Peripheral type. Needed for setting SDMA script
240 * @event_id0 aka dma request line
241 * @event_id1 for channels that use 2 events
242 * @word_size peripheral access size
243 * @buf_tail ID of the buffer that was processed
244 * @done channel completion
245 * @num_bd max NUM_BD. number of descriptors currently handling
247 struct sdma_channel
{
248 struct sdma_engine
*sdma
;
249 unsigned int channel
;
250 enum dma_data_direction direction
;
251 enum sdma_peripheral_type peripheral_type
;
252 unsigned int event_id0
;
253 unsigned int event_id1
;
254 enum dma_slave_buswidth word_size
;
255 unsigned int buf_tail
;
256 struct completion done
;
258 struct sdma_buffer_descriptor
*bd
;
260 unsigned int pc_from_device
, pc_to_device
;
262 dma_addr_t per_address
;
263 u32 event_mask0
, event_mask1
;
265 u32 shp_addr
, per_addr
;
266 struct dma_chan chan
;
268 struct dma_async_tx_descriptor desc
;
269 dma_cookie_t last_completed
;
270 enum dma_status status
;
273 #define IMX_DMA_SG_LOOP (1 << 0)
275 #define MAX_DMA_CHANNELS 32
276 #define MXC_SDMA_DEFAULT_PRIORITY 1
277 #define MXC_SDMA_MIN_PRIORITY 1
278 #define MXC_SDMA_MAX_PRIORITY 7
280 #define SDMA_FIRMWARE_MAGIC 0x414d4453
283 * struct sdma_firmware_header - Layout of the firmware image
286 * @version_major increased whenever layout of struct sdma_script_start_addrs
288 * @version_minor firmware minor version (for binary compatible changes)
289 * @script_addrs_start offset of struct sdma_script_start_addrs in this image
290 * @num_script_addrs Number of script addresses in this image
291 * @ram_code_start offset of SDMA ram image in this firmware image
292 * @ram_code_size size of SDMA ram image
293 * @script_addrs Stores the start address of the SDMA scripts
294 * (in SDMA memory space)
296 struct sdma_firmware_header
{
300 u32 script_addrs_start
;
301 u32 num_script_addrs
;
307 IMX31_SDMA
, /* runs on i.mx31 */
308 IMX35_SDMA
, /* runs on i.mx35 and later */
313 struct device_dma_parameters dma_parms
;
314 struct sdma_channel channel
[MAX_DMA_CHANNELS
];
315 struct sdma_channel_control
*channel_control
;
317 enum sdma_devtype devtype
;
318 unsigned int num_events
;
319 struct sdma_context_data
*context
;
320 dma_addr_t context_phys
;
321 struct dma_device dma_device
;
323 struct mutex channel_0_lock
;
324 struct sdma_script_start_addrs
*script_addrs
;
327 static struct platform_device_id sdma_devtypes
[] = {
329 .name
= "imx31-sdma",
330 .driver_data
= IMX31_SDMA
,
332 .name
= "imx35-sdma",
333 .driver_data
= IMX35_SDMA
,
338 MODULE_DEVICE_TABLE(platform
, sdma_devtypes
);
340 static const struct of_device_id sdma_dt_ids
[] = {
341 { .compatible
= "fsl,imx31-sdma", .data
= &sdma_devtypes
[IMX31_SDMA
], },
342 { .compatible
= "fsl,imx35-sdma", .data
= &sdma_devtypes
[IMX35_SDMA
], },
345 MODULE_DEVICE_TABLE(of
, sdma_dt_ids
);
347 #define SDMA_H_CONFIG_DSPDMA (1 << 12) /* indicates if the DSPDMA is used */
348 #define SDMA_H_CONFIG_RTD_PINS (1 << 11) /* indicates if Real-Time Debug pins are enabled */
349 #define SDMA_H_CONFIG_ACR (1 << 4) /* indicates if AHB freq /core freq = 2 or 1 */
350 #define SDMA_H_CONFIG_CSM (3) /* indicates which context switch mode is selected*/
352 static inline u32
chnenbl_ofs(struct sdma_engine
*sdma
, unsigned int event
)
354 u32 chnenbl0
= (sdma
->devtype
== IMX31_SDMA
? SDMA_CHNENBL0_IMX31
:
355 SDMA_CHNENBL0_IMX35
);
356 return chnenbl0
+ event
* 4;
359 static int sdma_config_ownership(struct sdma_channel
*sdmac
,
360 bool event_override
, bool mcu_override
, bool dsp_override
)
362 struct sdma_engine
*sdma
= sdmac
->sdma
;
363 int channel
= sdmac
->channel
;
366 if (event_override
&& mcu_override
&& dsp_override
)
369 evt
= __raw_readl(sdma
->regs
+ SDMA_H_EVTOVR
);
370 mcu
= __raw_readl(sdma
->regs
+ SDMA_H_HOSTOVR
);
371 dsp
= __raw_readl(sdma
->regs
+ SDMA_H_DSPOVR
);
374 dsp
&= ~(1 << channel
);
376 dsp
|= (1 << channel
);
379 evt
&= ~(1 << channel
);
381 evt
|= (1 << channel
);
384 mcu
&= ~(1 << channel
);
386 mcu
|= (1 << channel
);
388 __raw_writel(evt
, sdma
->regs
+ SDMA_H_EVTOVR
);
389 __raw_writel(mcu
, sdma
->regs
+ SDMA_H_HOSTOVR
);
390 __raw_writel(dsp
, sdma
->regs
+ SDMA_H_DSPOVR
);
396 * sdma_run_channel - run a channel and wait till it's done
398 static int sdma_run_channel(struct sdma_channel
*sdmac
)
400 struct sdma_engine
*sdma
= sdmac
->sdma
;
401 int channel
= sdmac
->channel
;
404 init_completion(&sdmac
->done
);
406 __raw_writel(1 << channel
, sdma
->regs
+ SDMA_H_START
);
408 ret
= wait_for_completion_timeout(&sdmac
->done
, HZ
);
410 return ret
? 0 : -ETIMEDOUT
;
413 static int sdma_load_script(struct sdma_engine
*sdma
, void *buf
, int size
,
416 struct sdma_buffer_descriptor
*bd0
= sdma
->channel
[0].bd
;
421 mutex_lock(&sdma
->channel_0_lock
);
423 buf_virt
= dma_alloc_coherent(NULL
,
425 &buf_phys
, GFP_KERNEL
);
431 bd0
->mode
.command
= C0_SETPM
;
432 bd0
->mode
.status
= BD_DONE
| BD_INTR
| BD_WRAP
| BD_EXTD
;
433 bd0
->mode
.count
= size
/ 2;
434 bd0
->buffer_addr
= buf_phys
;
435 bd0
->ext_buffer_addr
= address
;
437 memcpy(buf_virt
, buf
, size
);
439 ret
= sdma_run_channel(&sdma
->channel
[0]);
441 dma_free_coherent(NULL
, size
, buf_virt
, buf_phys
);
444 mutex_unlock(&sdma
->channel_0_lock
);
449 static void sdma_event_enable(struct sdma_channel
*sdmac
, unsigned int event
)
451 struct sdma_engine
*sdma
= sdmac
->sdma
;
452 int channel
= sdmac
->channel
;
454 u32 chnenbl
= chnenbl_ofs(sdma
, event
);
456 val
= __raw_readl(sdma
->regs
+ chnenbl
);
457 val
|= (1 << channel
);
458 __raw_writel(val
, sdma
->regs
+ chnenbl
);
461 static void sdma_event_disable(struct sdma_channel
*sdmac
, unsigned int event
)
463 struct sdma_engine
*sdma
= sdmac
->sdma
;
464 int channel
= sdmac
->channel
;
465 u32 chnenbl
= chnenbl_ofs(sdma
, event
);
468 val
= __raw_readl(sdma
->regs
+ chnenbl
);
469 val
&= ~(1 << channel
);
470 __raw_writel(val
, sdma
->regs
+ chnenbl
);
473 static void sdma_handle_channel_loop(struct sdma_channel
*sdmac
)
475 struct sdma_buffer_descriptor
*bd
;
478 * loop mode. Iterate over descriptors, re-setup them and
479 * call callback function.
482 bd
= &sdmac
->bd
[sdmac
->buf_tail
];
484 if (bd
->mode
.status
& BD_DONE
)
487 if (bd
->mode
.status
& BD_RROR
)
488 sdmac
->status
= DMA_ERROR
;
490 sdmac
->status
= DMA_IN_PROGRESS
;
492 bd
->mode
.status
|= BD_DONE
;
494 sdmac
->buf_tail
%= sdmac
->num_bd
;
496 if (sdmac
->desc
.callback
)
497 sdmac
->desc
.callback(sdmac
->desc
.callback_param
);
501 static void mxc_sdma_handle_channel_normal(struct sdma_channel
*sdmac
)
503 struct sdma_buffer_descriptor
*bd
;
507 * non loop mode. Iterate over all descriptors, collect
508 * errors and call callback function
510 for (i
= 0; i
< sdmac
->num_bd
; i
++) {
513 if (bd
->mode
.status
& (BD_DONE
| BD_RROR
))
518 sdmac
->status
= DMA_ERROR
;
520 sdmac
->status
= DMA_SUCCESS
;
522 if (sdmac
->desc
.callback
)
523 sdmac
->desc
.callback(sdmac
->desc
.callback_param
);
524 sdmac
->last_completed
= sdmac
->desc
.cookie
;
527 static void mxc_sdma_handle_channel(struct sdma_channel
*sdmac
)
529 complete(&sdmac
->done
);
531 /* not interested in channel 0 interrupts */
532 if (sdmac
->channel
== 0)
535 if (sdmac
->flags
& IMX_DMA_SG_LOOP
)
536 sdma_handle_channel_loop(sdmac
);
538 mxc_sdma_handle_channel_normal(sdmac
);
541 static irqreturn_t
sdma_int_handler(int irq
, void *dev_id
)
543 struct sdma_engine
*sdma
= dev_id
;
546 stat
= __raw_readl(sdma
->regs
+ SDMA_H_INTR
);
547 __raw_writel(stat
, sdma
->regs
+ SDMA_H_INTR
);
550 int channel
= fls(stat
) - 1;
551 struct sdma_channel
*sdmac
= &sdma
->channel
[channel
];
553 mxc_sdma_handle_channel(sdmac
);
555 stat
&= ~(1 << channel
);
562 * sets the pc of SDMA script according to the peripheral type
564 static void sdma_get_pc(struct sdma_channel
*sdmac
,
565 enum sdma_peripheral_type peripheral_type
)
567 struct sdma_engine
*sdma
= sdmac
->sdma
;
568 int per_2_emi
= 0, emi_2_per
= 0;
570 * These are needed once we start to support transfers between
571 * two peripherals or memory-to-memory transfers
573 int per_2_per
= 0, emi_2_emi
= 0;
575 sdmac
->pc_from_device
= 0;
576 sdmac
->pc_to_device
= 0;
578 switch (peripheral_type
) {
579 case IMX_DMATYPE_MEMORY
:
580 emi_2_emi
= sdma
->script_addrs
->ap_2_ap_addr
;
582 case IMX_DMATYPE_DSP
:
583 emi_2_per
= sdma
->script_addrs
->bp_2_ap_addr
;
584 per_2_emi
= sdma
->script_addrs
->ap_2_bp_addr
;
586 case IMX_DMATYPE_FIRI
:
587 per_2_emi
= sdma
->script_addrs
->firi_2_mcu_addr
;
588 emi_2_per
= sdma
->script_addrs
->mcu_2_firi_addr
;
590 case IMX_DMATYPE_UART
:
591 per_2_emi
= sdma
->script_addrs
->uart_2_mcu_addr
;
592 emi_2_per
= sdma
->script_addrs
->mcu_2_app_addr
;
594 case IMX_DMATYPE_UART_SP
:
595 per_2_emi
= sdma
->script_addrs
->uartsh_2_mcu_addr
;
596 emi_2_per
= sdma
->script_addrs
->mcu_2_shp_addr
;
598 case IMX_DMATYPE_ATA
:
599 per_2_emi
= sdma
->script_addrs
->ata_2_mcu_addr
;
600 emi_2_per
= sdma
->script_addrs
->mcu_2_ata_addr
;
602 case IMX_DMATYPE_CSPI
:
603 case IMX_DMATYPE_EXT
:
604 case IMX_DMATYPE_SSI
:
605 per_2_emi
= sdma
->script_addrs
->app_2_mcu_addr
;
606 emi_2_per
= sdma
->script_addrs
->mcu_2_app_addr
;
608 case IMX_DMATYPE_SSI_SP
:
609 case IMX_DMATYPE_MMC
:
610 case IMX_DMATYPE_SDHC
:
611 case IMX_DMATYPE_CSPI_SP
:
612 case IMX_DMATYPE_ESAI
:
613 case IMX_DMATYPE_MSHC_SP
:
614 per_2_emi
= sdma
->script_addrs
->shp_2_mcu_addr
;
615 emi_2_per
= sdma
->script_addrs
->mcu_2_shp_addr
;
617 case IMX_DMATYPE_ASRC
:
618 per_2_emi
= sdma
->script_addrs
->asrc_2_mcu_addr
;
619 emi_2_per
= sdma
->script_addrs
->asrc_2_mcu_addr
;
620 per_2_per
= sdma
->script_addrs
->per_2_per_addr
;
622 case IMX_DMATYPE_MSHC
:
623 per_2_emi
= sdma
->script_addrs
->mshc_2_mcu_addr
;
624 emi_2_per
= sdma
->script_addrs
->mcu_2_mshc_addr
;
626 case IMX_DMATYPE_CCM
:
627 per_2_emi
= sdma
->script_addrs
->dptc_dvfs_addr
;
629 case IMX_DMATYPE_SPDIF
:
630 per_2_emi
= sdma
->script_addrs
->spdif_2_mcu_addr
;
631 emi_2_per
= sdma
->script_addrs
->mcu_2_spdif_addr
;
633 case IMX_DMATYPE_IPU_MEMORY
:
634 emi_2_per
= sdma
->script_addrs
->ext_mem_2_ipu_addr
;
640 sdmac
->pc_from_device
= per_2_emi
;
641 sdmac
->pc_to_device
= emi_2_per
;
644 static int sdma_load_context(struct sdma_channel
*sdmac
)
646 struct sdma_engine
*sdma
= sdmac
->sdma
;
647 int channel
= sdmac
->channel
;
649 struct sdma_context_data
*context
= sdma
->context
;
650 struct sdma_buffer_descriptor
*bd0
= sdma
->channel
[0].bd
;
653 if (sdmac
->direction
== DMA_FROM_DEVICE
) {
654 load_address
= sdmac
->pc_from_device
;
656 load_address
= sdmac
->pc_to_device
;
659 if (load_address
< 0)
662 dev_dbg(sdma
->dev
, "load_address = %d\n", load_address
);
663 dev_dbg(sdma
->dev
, "wml = 0x%08x\n", sdmac
->watermark_level
);
664 dev_dbg(sdma
->dev
, "shp_addr = 0x%08x\n", sdmac
->shp_addr
);
665 dev_dbg(sdma
->dev
, "per_addr = 0x%08x\n", sdmac
->per_addr
);
666 dev_dbg(sdma
->dev
, "event_mask0 = 0x%08x\n", sdmac
->event_mask0
);
667 dev_dbg(sdma
->dev
, "event_mask1 = 0x%08x\n", sdmac
->event_mask1
);
669 mutex_lock(&sdma
->channel_0_lock
);
671 memset(context
, 0, sizeof(*context
));
672 context
->channel_state
.pc
= load_address
;
674 /* Send by context the event mask,base address for peripheral
675 * and watermark level
677 context
->gReg
[0] = sdmac
->event_mask1
;
678 context
->gReg
[1] = sdmac
->event_mask0
;
679 context
->gReg
[2] = sdmac
->per_addr
;
680 context
->gReg
[6] = sdmac
->shp_addr
;
681 context
->gReg
[7] = sdmac
->watermark_level
;
683 bd0
->mode
.command
= C0_SETDM
;
684 bd0
->mode
.status
= BD_DONE
| BD_INTR
| BD_WRAP
| BD_EXTD
;
685 bd0
->mode
.count
= sizeof(*context
) / 4;
686 bd0
->buffer_addr
= sdma
->context_phys
;
687 bd0
->ext_buffer_addr
= 2048 + (sizeof(*context
) / 4) * channel
;
689 ret
= sdma_run_channel(&sdma
->channel
[0]);
691 mutex_unlock(&sdma
->channel_0_lock
);
696 static void sdma_disable_channel(struct sdma_channel
*sdmac
)
698 struct sdma_engine
*sdma
= sdmac
->sdma
;
699 int channel
= sdmac
->channel
;
701 __raw_writel(1 << channel
, sdma
->regs
+ SDMA_H_STATSTOP
);
702 sdmac
->status
= DMA_ERROR
;
705 static int sdma_config_channel(struct sdma_channel
*sdmac
)
709 sdma_disable_channel(sdmac
);
711 sdmac
->event_mask0
= 0;
712 sdmac
->event_mask1
= 0;
716 if (sdmac
->event_id0
) {
717 if (sdmac
->event_id0
> 32)
719 sdma_event_enable(sdmac
, sdmac
->event_id0
);
722 switch (sdmac
->peripheral_type
) {
723 case IMX_DMATYPE_DSP
:
724 sdma_config_ownership(sdmac
, false, true, true);
726 case IMX_DMATYPE_MEMORY
:
727 sdma_config_ownership(sdmac
, false, true, false);
730 sdma_config_ownership(sdmac
, true, true, false);
734 sdma_get_pc(sdmac
, sdmac
->peripheral_type
);
736 if ((sdmac
->peripheral_type
!= IMX_DMATYPE_MEMORY
) &&
737 (sdmac
->peripheral_type
!= IMX_DMATYPE_DSP
)) {
738 /* Handle multiple event channels differently */
739 if (sdmac
->event_id1
) {
740 sdmac
->event_mask1
= 1 << (sdmac
->event_id1
% 32);
741 if (sdmac
->event_id1
> 31)
742 sdmac
->watermark_level
|= 1 << 31;
743 sdmac
->event_mask0
= 1 << (sdmac
->event_id0
% 32);
744 if (sdmac
->event_id0
> 31)
745 sdmac
->watermark_level
|= 1 << 30;
747 sdmac
->event_mask0
= 1 << sdmac
->event_id0
;
748 sdmac
->event_mask1
= 1 << (sdmac
->event_id0
- 32);
750 /* Watermark Level */
751 sdmac
->watermark_level
|= sdmac
->watermark_level
;
753 sdmac
->shp_addr
= sdmac
->per_address
;
755 sdmac
->watermark_level
= 0; /* FIXME: M3_BASE_ADDRESS */
758 ret
= sdma_load_context(sdmac
);
763 static int sdma_set_channel_priority(struct sdma_channel
*sdmac
,
764 unsigned int priority
)
766 struct sdma_engine
*sdma
= sdmac
->sdma
;
767 int channel
= sdmac
->channel
;
769 if (priority
< MXC_SDMA_MIN_PRIORITY
770 || priority
> MXC_SDMA_MAX_PRIORITY
) {
774 __raw_writel(priority
, sdma
->regs
+ SDMA_CHNPRI_0
+ 4 * channel
);
779 static int sdma_request_channel(struct sdma_channel
*sdmac
)
781 struct sdma_engine
*sdma
= sdmac
->sdma
;
782 int channel
= sdmac
->channel
;
785 sdmac
->bd
= dma_alloc_coherent(NULL
, PAGE_SIZE
, &sdmac
->bd_phys
, GFP_KERNEL
);
791 memset(sdmac
->bd
, 0, PAGE_SIZE
);
793 sdma
->channel_control
[channel
].base_bd_ptr
= sdmac
->bd_phys
;
794 sdma
->channel_control
[channel
].current_bd_ptr
= sdmac
->bd_phys
;
796 clk_enable(sdma
->clk
);
798 sdma_set_channel_priority(sdmac
, MXC_SDMA_DEFAULT_PRIORITY
);
800 init_completion(&sdmac
->done
);
810 static void sdma_enable_channel(struct sdma_engine
*sdma
, int channel
)
812 __raw_writel(1 << channel
, sdma
->regs
+ SDMA_H_START
);
815 static dma_cookie_t
sdma_assign_cookie(struct sdma_channel
*sdmac
)
817 dma_cookie_t cookie
= sdmac
->chan
.cookie
;
822 sdmac
->chan
.cookie
= cookie
;
823 sdmac
->desc
.cookie
= cookie
;
828 static struct sdma_channel
*to_sdma_chan(struct dma_chan
*chan
)
830 return container_of(chan
, struct sdma_channel
, chan
);
833 static dma_cookie_t
sdma_tx_submit(struct dma_async_tx_descriptor
*tx
)
835 struct sdma_channel
*sdmac
= to_sdma_chan(tx
->chan
);
836 struct sdma_engine
*sdma
= sdmac
->sdma
;
839 spin_lock_irq(&sdmac
->lock
);
841 cookie
= sdma_assign_cookie(sdmac
);
843 sdma_enable_channel(sdma
, sdmac
->channel
);
845 spin_unlock_irq(&sdmac
->lock
);
850 static int sdma_alloc_chan_resources(struct dma_chan
*chan
)
852 struct sdma_channel
*sdmac
= to_sdma_chan(chan
);
853 struct imx_dma_data
*data
= chan
->private;
859 switch (data
->priority
) {
863 case DMA_PRIO_MEDIUM
:
872 sdmac
->peripheral_type
= data
->peripheral_type
;
873 sdmac
->event_id0
= data
->dma_request
;
874 ret
= sdma_set_channel_priority(sdmac
, prio
);
878 ret
= sdma_request_channel(sdmac
);
882 dma_async_tx_descriptor_init(&sdmac
->desc
, chan
);
883 sdmac
->desc
.tx_submit
= sdma_tx_submit
;
884 /* txd.flags will be overwritten in prep funcs */
885 sdmac
->desc
.flags
= DMA_CTRL_ACK
;
890 static void sdma_free_chan_resources(struct dma_chan
*chan
)
892 struct sdma_channel
*sdmac
= to_sdma_chan(chan
);
893 struct sdma_engine
*sdma
= sdmac
->sdma
;
895 sdma_disable_channel(sdmac
);
897 if (sdmac
->event_id0
)
898 sdma_event_disable(sdmac
, sdmac
->event_id0
);
899 if (sdmac
->event_id1
)
900 sdma_event_disable(sdmac
, sdmac
->event_id1
);
902 sdmac
->event_id0
= 0;
903 sdmac
->event_id1
= 0;
905 sdma_set_channel_priority(sdmac
, 0);
907 dma_free_coherent(NULL
, PAGE_SIZE
, sdmac
->bd
, sdmac
->bd_phys
);
909 clk_disable(sdma
->clk
);
912 static struct dma_async_tx_descriptor
*sdma_prep_slave_sg(
913 struct dma_chan
*chan
, struct scatterlist
*sgl
,
914 unsigned int sg_len
, enum dma_data_direction direction
,
917 struct sdma_channel
*sdmac
= to_sdma_chan(chan
);
918 struct sdma_engine
*sdma
= sdmac
->sdma
;
920 int channel
= sdmac
->channel
;
921 struct scatterlist
*sg
;
923 if (sdmac
->status
== DMA_IN_PROGRESS
)
925 sdmac
->status
= DMA_IN_PROGRESS
;
929 dev_dbg(sdma
->dev
, "setting up %d entries for channel %d.\n",
932 sdmac
->direction
= direction
;
933 ret
= sdma_load_context(sdmac
);
937 if (sg_len
> NUM_BD
) {
938 dev_err(sdma
->dev
, "SDMA channel %d: maximum number of sg exceeded: %d > %d\n",
939 channel
, sg_len
, NUM_BD
);
944 for_each_sg(sgl
, sg
, sg_len
, i
) {
945 struct sdma_buffer_descriptor
*bd
= &sdmac
->bd
[i
];
948 bd
->buffer_addr
= sg
->dma_address
;
952 if (count
> 0xffff) {
953 dev_err(sdma
->dev
, "SDMA channel %d: maximum bytes for sg entry exceeded: %d > %d\n",
954 channel
, count
, 0xffff);
959 bd
->mode
.count
= count
;
961 if (sdmac
->word_size
> DMA_SLAVE_BUSWIDTH_4_BYTES
) {
966 switch (sdmac
->word_size
) {
967 case DMA_SLAVE_BUSWIDTH_4_BYTES
:
968 bd
->mode
.command
= 0;
969 if (count
& 3 || sg
->dma_address
& 3)
972 case DMA_SLAVE_BUSWIDTH_2_BYTES
:
973 bd
->mode
.command
= 2;
974 if (count
& 1 || sg
->dma_address
& 1)
977 case DMA_SLAVE_BUSWIDTH_1_BYTE
:
978 bd
->mode
.command
= 1;
984 param
= BD_DONE
| BD_EXTD
| BD_CONT
;
986 if (i
+ 1 == sg_len
) {
992 dev_dbg(sdma
->dev
, "entry %d: count: %d dma: 0x%08x %s%s\n",
993 i
, count
, sg
->dma_address
,
994 param
& BD_WRAP
? "wrap" : "",
995 param
& BD_INTR
? " intr" : "");
997 bd
->mode
.status
= param
;
1000 sdmac
->num_bd
= sg_len
;
1001 sdma
->channel_control
[channel
].current_bd_ptr
= sdmac
->bd_phys
;
1003 return &sdmac
->desc
;
1005 sdmac
->status
= DMA_ERROR
;
1009 static struct dma_async_tx_descriptor
*sdma_prep_dma_cyclic(
1010 struct dma_chan
*chan
, dma_addr_t dma_addr
, size_t buf_len
,
1011 size_t period_len
, enum dma_data_direction direction
)
1013 struct sdma_channel
*sdmac
= to_sdma_chan(chan
);
1014 struct sdma_engine
*sdma
= sdmac
->sdma
;
1015 int num_periods
= buf_len
/ period_len
;
1016 int channel
= sdmac
->channel
;
1017 int ret
, i
= 0, buf
= 0;
1019 dev_dbg(sdma
->dev
, "%s channel: %d\n", __func__
, channel
);
1021 if (sdmac
->status
== DMA_IN_PROGRESS
)
1024 sdmac
->status
= DMA_IN_PROGRESS
;
1026 sdmac
->flags
|= IMX_DMA_SG_LOOP
;
1027 sdmac
->direction
= direction
;
1028 ret
= sdma_load_context(sdmac
);
1032 if (num_periods
> NUM_BD
) {
1033 dev_err(sdma
->dev
, "SDMA channel %d: maximum number of sg exceeded: %d > %d\n",
1034 channel
, num_periods
, NUM_BD
);
1038 if (period_len
> 0xffff) {
1039 dev_err(sdma
->dev
, "SDMA channel %d: maximum period size exceeded: %d > %d\n",
1040 channel
, period_len
, 0xffff);
1044 while (buf
< buf_len
) {
1045 struct sdma_buffer_descriptor
*bd
= &sdmac
->bd
[i
];
1048 bd
->buffer_addr
= dma_addr
;
1050 bd
->mode
.count
= period_len
;
1052 if (sdmac
->word_size
> DMA_SLAVE_BUSWIDTH_4_BYTES
)
1054 if (sdmac
->word_size
== DMA_SLAVE_BUSWIDTH_4_BYTES
)
1055 bd
->mode
.command
= 0;
1057 bd
->mode
.command
= sdmac
->word_size
;
1059 param
= BD_DONE
| BD_EXTD
| BD_CONT
| BD_INTR
;
1060 if (i
+ 1 == num_periods
)
1063 dev_dbg(sdma
->dev
, "entry %d: count: %d dma: 0x%08x %s%s\n",
1064 i
, period_len
, dma_addr
,
1065 param
& BD_WRAP
? "wrap" : "",
1066 param
& BD_INTR
? " intr" : "");
1068 bd
->mode
.status
= param
;
1070 dma_addr
+= period_len
;
1076 sdmac
->num_bd
= num_periods
;
1077 sdma
->channel_control
[channel
].current_bd_ptr
= sdmac
->bd_phys
;
1079 return &sdmac
->desc
;
1081 sdmac
->status
= DMA_ERROR
;
1085 static int sdma_control(struct dma_chan
*chan
, enum dma_ctrl_cmd cmd
,
1088 struct sdma_channel
*sdmac
= to_sdma_chan(chan
);
1089 struct dma_slave_config
*dmaengine_cfg
= (void *)arg
;
1092 case DMA_TERMINATE_ALL
:
1093 sdma_disable_channel(sdmac
);
1095 case DMA_SLAVE_CONFIG
:
1096 if (dmaengine_cfg
->direction
== DMA_FROM_DEVICE
) {
1097 sdmac
->per_address
= dmaengine_cfg
->src_addr
;
1098 sdmac
->watermark_level
= dmaengine_cfg
->src_maxburst
;
1099 sdmac
->word_size
= dmaengine_cfg
->src_addr_width
;
1101 sdmac
->per_address
= dmaengine_cfg
->dst_addr
;
1102 sdmac
->watermark_level
= dmaengine_cfg
->dst_maxburst
;
1103 sdmac
->word_size
= dmaengine_cfg
->dst_addr_width
;
1105 return sdma_config_channel(sdmac
);
1113 static enum dma_status
sdma_tx_status(struct dma_chan
*chan
,
1114 dma_cookie_t cookie
,
1115 struct dma_tx_state
*txstate
)
1117 struct sdma_channel
*sdmac
= to_sdma_chan(chan
);
1118 dma_cookie_t last_used
;
1120 last_used
= chan
->cookie
;
1122 dma_set_tx_state(txstate
, sdmac
->last_completed
, last_used
, 0);
1124 return sdmac
->status
;
1127 static void sdma_issue_pending(struct dma_chan
*chan
)
1130 * Nothing to do. We only have a single descriptor
1134 #define SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1 34
1136 static void sdma_add_scripts(struct sdma_engine
*sdma
,
1137 const struct sdma_script_start_addrs
*addr
)
1139 s32
*addr_arr
= (u32
*)addr
;
1140 s32
*saddr_arr
= (u32
*)sdma
->script_addrs
;
1143 for (i
= 0; i
< SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1
; i
++)
1144 if (addr_arr
[i
] > 0)
1145 saddr_arr
[i
] = addr_arr
[i
];
1148 static void sdma_load_firmware(const struct firmware
*fw
, void *context
)
1150 struct sdma_engine
*sdma
= context
;
1151 const struct sdma_firmware_header
*header
;
1152 const struct sdma_script_start_addrs
*addr
;
1153 unsigned short *ram_code
;
1156 dev_err(sdma
->dev
, "firmware not found\n");
1160 if (fw
->size
< sizeof(*header
))
1163 header
= (struct sdma_firmware_header
*)fw
->data
;
1165 if (header
->magic
!= SDMA_FIRMWARE_MAGIC
)
1167 if (header
->ram_code_start
+ header
->ram_code_size
> fw
->size
)
1170 addr
= (void *)header
+ header
->script_addrs_start
;
1171 ram_code
= (void *)header
+ header
->ram_code_start
;
1173 clk_enable(sdma
->clk
);
1174 /* download the RAM image for SDMA */
1175 sdma_load_script(sdma
, ram_code
,
1176 header
->ram_code_size
,
1177 addr
->ram_code_start_addr
);
1178 clk_disable(sdma
->clk
);
1180 sdma_add_scripts(sdma
, addr
);
1182 dev_info(sdma
->dev
, "loaded firmware %d.%d\n",
1183 header
->version_major
,
1184 header
->version_minor
);
1187 release_firmware(fw
);
1190 static int __init
sdma_get_firmware(struct sdma_engine
*sdma
,
1191 const char *fw_name
)
1195 ret
= request_firmware_nowait(THIS_MODULE
,
1196 FW_ACTION_HOTPLUG
, fw_name
, sdma
->dev
,
1197 GFP_KERNEL
, sdma
, sdma_load_firmware
);
1202 static int __init
sdma_init(struct sdma_engine
*sdma
)
1205 dma_addr_t ccb_phys
;
1207 switch (sdma
->devtype
) {
1209 sdma
->num_events
= 32;
1212 sdma
->num_events
= 48;
1215 dev_err(sdma
->dev
, "Unknown sdma type %d. aborting\n",
1220 clk_enable(sdma
->clk
);
1222 /* Be sure SDMA has not started yet */
1223 __raw_writel(0, sdma
->regs
+ SDMA_H_C0PTR
);
1225 sdma
->channel_control
= dma_alloc_coherent(NULL
,
1226 MAX_DMA_CHANNELS
* sizeof (struct sdma_channel_control
) +
1227 sizeof(struct sdma_context_data
),
1228 &ccb_phys
, GFP_KERNEL
);
1230 if (!sdma
->channel_control
) {
1235 sdma
->context
= (void *)sdma
->channel_control
+
1236 MAX_DMA_CHANNELS
* sizeof (struct sdma_channel_control
);
1237 sdma
->context_phys
= ccb_phys
+
1238 MAX_DMA_CHANNELS
* sizeof (struct sdma_channel_control
);
1240 /* Zero-out the CCB structures array just allocated */
1241 memset(sdma
->channel_control
, 0,
1242 MAX_DMA_CHANNELS
* sizeof (struct sdma_channel_control
));
1244 /* disable all channels */
1245 for (i
= 0; i
< sdma
->num_events
; i
++)
1246 __raw_writel(0, sdma
->regs
+ chnenbl_ofs(sdma
, i
));
1248 /* All channels have priority 0 */
1249 for (i
= 0; i
< MAX_DMA_CHANNELS
; i
++)
1250 __raw_writel(0, sdma
->regs
+ SDMA_CHNPRI_0
+ i
* 4);
1252 ret
= sdma_request_channel(&sdma
->channel
[0]);
1256 sdma_config_ownership(&sdma
->channel
[0], false, true, false);
1258 /* Set Command Channel (Channel Zero) */
1259 __raw_writel(0x4050, sdma
->regs
+ SDMA_CHN0ADDR
);
1261 /* Set bits of CONFIG register but with static context switching */
1262 /* FIXME: Check whether to set ACR bit depending on clock ratios */
1263 __raw_writel(0, sdma
->regs
+ SDMA_H_CONFIG
);
1265 __raw_writel(ccb_phys
, sdma
->regs
+ SDMA_H_C0PTR
);
1267 /* Set bits of CONFIG register with given context switching mode */
1268 __raw_writel(SDMA_H_CONFIG_CSM
, sdma
->regs
+ SDMA_H_CONFIG
);
1270 /* Initializes channel's priorities */
1271 sdma_set_channel_priority(&sdma
->channel
[0], 7);
1273 clk_disable(sdma
->clk
);
1278 clk_disable(sdma
->clk
);
1279 dev_err(sdma
->dev
, "initialisation failed with %d\n", ret
);
1283 static int __init
sdma_probe(struct platform_device
*pdev
)
1285 const struct of_device_id
*of_id
=
1286 of_match_device(sdma_dt_ids
, &pdev
->dev
);
1287 struct device_node
*np
= pdev
->dev
.of_node
;
1288 const char *fw_name
;
1291 struct resource
*iores
;
1292 struct sdma_platform_data
*pdata
= pdev
->dev
.platform_data
;
1294 struct sdma_engine
*sdma
;
1297 sdma
= kzalloc(sizeof(*sdma
), GFP_KERNEL
);
1301 mutex_init(&sdma
->channel_0_lock
);
1303 sdma
->dev
= &pdev
->dev
;
1305 iores
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1306 irq
= platform_get_irq(pdev
, 0);
1307 if (!iores
|| irq
< 0) {
1312 if (!request_mem_region(iores
->start
, resource_size(iores
), pdev
->name
)) {
1314 goto err_request_region
;
1317 sdma
->clk
= clk_get(&pdev
->dev
, NULL
);
1318 if (IS_ERR(sdma
->clk
)) {
1319 ret
= PTR_ERR(sdma
->clk
);
1323 sdma
->regs
= ioremap(iores
->start
, resource_size(iores
));
1329 ret
= request_irq(irq
, sdma_int_handler
, 0, "sdma", sdma
);
1331 goto err_request_irq
;
1333 sdma
->script_addrs
= kzalloc(sizeof(*sdma
->script_addrs
), GFP_KERNEL
);
1334 if (!sdma
->script_addrs
) {
1339 /* initially no scripts available */
1340 saddr_arr
= (s32
*)sdma
->script_addrs
;
1341 for (i
= 0; i
< SDMA_SCRIPT_ADDRS_ARRAY_SIZE_V1
; i
++)
1342 saddr_arr
[i
] = -EINVAL
;
1345 pdev
->id_entry
= of_id
->data
;
1346 sdma
->devtype
= pdev
->id_entry
->driver_data
;
1348 dma_cap_set(DMA_SLAVE
, sdma
->dma_device
.cap_mask
);
1349 dma_cap_set(DMA_CYCLIC
, sdma
->dma_device
.cap_mask
);
1351 INIT_LIST_HEAD(&sdma
->dma_device
.channels
);
1352 /* Initialize channel parameters */
1353 for (i
= 0; i
< MAX_DMA_CHANNELS
; i
++) {
1354 struct sdma_channel
*sdmac
= &sdma
->channel
[i
];
1357 spin_lock_init(&sdmac
->lock
);
1359 sdmac
->chan
.device
= &sdma
->dma_device
;
1363 * Add the channel to the DMAC list. Do not add channel 0 though
1364 * because we need it internally in the SDMA driver. This also means
1365 * that channel 0 in dmaengine counting matches sdma channel 1.
1368 list_add_tail(&sdmac
->chan
.device_node
,
1369 &sdma
->dma_device
.channels
);
1372 ret
= sdma_init(sdma
);
1376 if (pdata
&& pdata
->script_addrs
)
1377 sdma_add_scripts(sdma
, pdata
->script_addrs
);
1380 sdma_get_firmware(sdma
, pdata
->fw_name
);
1383 * Because that device tree does not encode ROM script address,
1384 * the RAM script in firmware is mandatory for device tree
1385 * probe, otherwise it fails.
1387 ret
= of_property_read_string(np
, "fsl,sdma-ram-script-name",
1390 dev_err(&pdev
->dev
, "failed to get firmware name\n");
1394 ret
= sdma_get_firmware(sdma
, fw_name
);
1396 dev_err(&pdev
->dev
, "failed to get firmware\n");
1401 sdma
->dma_device
.dev
= &pdev
->dev
;
1403 sdma
->dma_device
.device_alloc_chan_resources
= sdma_alloc_chan_resources
;
1404 sdma
->dma_device
.device_free_chan_resources
= sdma_free_chan_resources
;
1405 sdma
->dma_device
.device_tx_status
= sdma_tx_status
;
1406 sdma
->dma_device
.device_prep_slave_sg
= sdma_prep_slave_sg
;
1407 sdma
->dma_device
.device_prep_dma_cyclic
= sdma_prep_dma_cyclic
;
1408 sdma
->dma_device
.device_control
= sdma_control
;
1409 sdma
->dma_device
.device_issue_pending
= sdma_issue_pending
;
1410 sdma
->dma_device
.dev
->dma_parms
= &sdma
->dma_parms
;
1411 dma_set_max_seg_size(sdma
->dma_device
.dev
, 65535);
1413 ret
= dma_async_device_register(&sdma
->dma_device
);
1415 dev_err(&pdev
->dev
, "unable to register\n");
1419 dev_info(sdma
->dev
, "initialized\n");
1424 kfree(sdma
->script_addrs
);
1426 free_irq(irq
, sdma
);
1428 iounmap(sdma
->regs
);
1432 release_mem_region(iores
->start
, resource_size(iores
));
1439 static int __exit
sdma_remove(struct platform_device
*pdev
)
1444 static struct platform_driver sdma_driver
= {
1447 .of_match_table
= sdma_dt_ids
,
1449 .id_table
= sdma_devtypes
,
1450 .remove
= __exit_p(sdma_remove
),
1453 static int __init
sdma_module_init(void)
1455 return platform_driver_probe(&sdma_driver
, sdma_probe
);
1457 module_init(sdma_module_init
);
1459 MODULE_AUTHOR("Sascha Hauer, Pengutronix <s.hauer@pengutronix.de>");
1460 MODULE_DESCRIPTION("i.MX SDMA driver");
1461 MODULE_LICENSE("GPL");