1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/drivers/mmc/host/omap.c
5 * Copyright (C) 2004 Nokia Corporation
8 * Other hacks (DMA, SD, etc) by David Brownell
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/init.h>
14 #include <linux/ioport.h>
15 #include <linux/platform_device.h>
16 #include <linux/interrupt.h>
17 #include <linux/dmaengine.h>
18 #include <linux/dma-mapping.h>
19 #include <linux/delay.h>
20 #include <linux/spinlock.h>
21 #include <linux/timer.h>
23 #include <linux/mmc/host.h>
24 #include <linux/mmc/card.h>
25 #include <linux/mmc/mmc.h>
26 #include <linux/clk.h>
27 #include <linux/scatterlist.h>
28 #include <linux/slab.h>
29 #include <linux/platform_data/mmc-omap.h>
32 #define OMAP_MMC_REG_CMD 0x00
33 #define OMAP_MMC_REG_ARGL 0x01
34 #define OMAP_MMC_REG_ARGH 0x02
35 #define OMAP_MMC_REG_CON 0x03
36 #define OMAP_MMC_REG_STAT 0x04
37 #define OMAP_MMC_REG_IE 0x05
38 #define OMAP_MMC_REG_CTO 0x06
39 #define OMAP_MMC_REG_DTO 0x07
40 #define OMAP_MMC_REG_DATA 0x08
41 #define OMAP_MMC_REG_BLEN 0x09
42 #define OMAP_MMC_REG_NBLK 0x0a
43 #define OMAP_MMC_REG_BUF 0x0b
44 #define OMAP_MMC_REG_SDIO 0x0d
45 #define OMAP_MMC_REG_REV 0x0f
46 #define OMAP_MMC_REG_RSP0 0x10
47 #define OMAP_MMC_REG_RSP1 0x11
48 #define OMAP_MMC_REG_RSP2 0x12
49 #define OMAP_MMC_REG_RSP3 0x13
50 #define OMAP_MMC_REG_RSP4 0x14
51 #define OMAP_MMC_REG_RSP5 0x15
52 #define OMAP_MMC_REG_RSP6 0x16
53 #define OMAP_MMC_REG_RSP7 0x17
54 #define OMAP_MMC_REG_IOSR 0x18
55 #define OMAP_MMC_REG_SYSC 0x19
56 #define OMAP_MMC_REG_SYSS 0x1a
58 #define OMAP_MMC_STAT_CARD_ERR (1 << 14)
59 #define OMAP_MMC_STAT_CARD_IRQ (1 << 13)
60 #define OMAP_MMC_STAT_OCR_BUSY (1 << 12)
61 #define OMAP_MMC_STAT_A_EMPTY (1 << 11)
62 #define OMAP_MMC_STAT_A_FULL (1 << 10)
63 #define OMAP_MMC_STAT_CMD_CRC (1 << 8)
64 #define OMAP_MMC_STAT_CMD_TOUT (1 << 7)
65 #define OMAP_MMC_STAT_DATA_CRC (1 << 6)
66 #define OMAP_MMC_STAT_DATA_TOUT (1 << 5)
67 #define OMAP_MMC_STAT_END_BUSY (1 << 4)
68 #define OMAP_MMC_STAT_END_OF_DATA (1 << 3)
69 #define OMAP_MMC_STAT_CARD_BUSY (1 << 2)
70 #define OMAP_MMC_STAT_END_OF_CMD (1 << 0)
72 #define mmc_omap7xx() (host->features & MMC_OMAP7XX)
73 #define mmc_omap15xx() (host->features & MMC_OMAP15XX)
74 #define mmc_omap16xx() (host->features & MMC_OMAP16XX)
75 #define MMC_OMAP1_MASK (MMC_OMAP7XX | MMC_OMAP15XX | MMC_OMAP16XX)
76 #define mmc_omap1() (host->features & MMC_OMAP1_MASK)
77 #define mmc_omap2() (!mmc_omap1())
79 #define OMAP_MMC_REG(host, reg) (OMAP_MMC_REG_##reg << (host)->reg_shift)
80 #define OMAP_MMC_READ(host, reg) __raw_readw((host)->virt_base + OMAP_MMC_REG(host, reg))
81 #define OMAP_MMC_WRITE(host, reg, val) __raw_writew((val), (host)->virt_base + OMAP_MMC_REG(host, reg))
86 #define OMAP_MMC_CMDTYPE_BC 0
87 #define OMAP_MMC_CMDTYPE_BCR 1
88 #define OMAP_MMC_CMDTYPE_AC 2
89 #define OMAP_MMC_CMDTYPE_ADTC 3
91 #define DRIVER_NAME "mmci-omap"
93 /* Specifies how often in millisecs to poll for card status changes
94 * when the cover switch is open */
95 #define OMAP_MMC_COVER_POLL_DELAY 500
99 struct mmc_omap_slot {
105 unsigned int fclk_freq;
107 struct tasklet_struct cover_tasklet;
108 struct timer_list cover_timer;
111 struct mmc_request *mrq;
112 struct mmc_omap_host *host;
113 struct mmc_host *mmc;
114 struct omap_mmc_slot_data *pdata;
117 struct mmc_omap_host {
119 struct mmc_request * mrq;
120 struct mmc_command * cmd;
121 struct mmc_data * data;
122 struct mmc_host * mmc;
124 unsigned char id; /* 16xx chips have 2 MMC blocks */
127 struct dma_chan *dma_rx;
129 struct dma_chan *dma_tx;
131 void __iomem *virt_base;
132 unsigned int phys_base;
134 unsigned char bus_mode;
135 unsigned int reg_shift;
137 struct work_struct cmd_abort_work;
139 struct timer_list cmd_abort_timer;
141 struct work_struct slot_release_work;
142 struct mmc_omap_slot *next_slot;
143 struct work_struct send_stop_work;
144 struct mmc_data *stop_data;
149 u32 buffer_bytes_left;
150 u32 total_bytes_left;
153 unsigned brs_received:1, dma_done:1;
154 unsigned dma_in_use:1;
157 struct mmc_omap_slot *slots[OMAP_MMC_MAX_SLOTS];
158 struct mmc_omap_slot *current_slot;
159 spinlock_t slot_lock;
160 wait_queue_head_t slot_wq;
163 struct timer_list clk_timer;
164 spinlock_t clk_lock; /* for changing enabled state */
165 unsigned int fclk_enabled:1;
166 struct workqueue_struct *mmc_omap_wq;
168 struct omap_mmc_platform_data *pdata;
172 static void mmc_omap_fclk_offdelay(struct mmc_omap_slot *slot)
174 unsigned long tick_ns;
176 if (slot != NULL && slot->host->fclk_enabled && slot->fclk_freq > 0) {
177 tick_ns = DIV_ROUND_UP(NSEC_PER_SEC, slot->fclk_freq);
182 static void mmc_omap_fclk_enable(struct mmc_omap_host *host, unsigned int enable)
186 spin_lock_irqsave(&host->clk_lock, flags);
187 if (host->fclk_enabled != enable) {
188 host->fclk_enabled = enable;
190 clk_enable(host->fclk);
192 clk_disable(host->fclk);
194 spin_unlock_irqrestore(&host->clk_lock, flags);
197 static void mmc_omap_select_slot(struct mmc_omap_slot *slot, int claimed)
199 struct mmc_omap_host *host = slot->host;
204 spin_lock_irqsave(&host->slot_lock, flags);
205 while (host->mmc != NULL) {
206 spin_unlock_irqrestore(&host->slot_lock, flags);
207 wait_event(host->slot_wq, host->mmc == NULL);
208 spin_lock_irqsave(&host->slot_lock, flags);
210 host->mmc = slot->mmc;
211 spin_unlock_irqrestore(&host->slot_lock, flags);
213 del_timer(&host->clk_timer);
214 if (host->current_slot != slot || !claimed)
215 mmc_omap_fclk_offdelay(host->current_slot);
217 if (host->current_slot != slot) {
218 OMAP_MMC_WRITE(host, CON, slot->saved_con & 0xFC00);
219 if (host->pdata->switch_slot != NULL)
220 host->pdata->switch_slot(mmc_dev(slot->mmc), slot->id);
221 host->current_slot = slot;
225 mmc_omap_fclk_enable(host, 1);
227 /* Doing the dummy read here seems to work around some bug
228 * at least in OMAP24xx silicon where the command would not
229 * start after writing the CMD register. Sigh. */
230 OMAP_MMC_READ(host, CON);
232 OMAP_MMC_WRITE(host, CON, slot->saved_con);
234 mmc_omap_fclk_enable(host, 0);
237 static void mmc_omap_start_request(struct mmc_omap_host *host,
238 struct mmc_request *req);
240 static void mmc_omap_slot_release_work(struct work_struct *work)
242 struct mmc_omap_host *host = container_of(work, struct mmc_omap_host,
244 struct mmc_omap_slot *next_slot = host->next_slot;
245 struct mmc_request *rq;
247 host->next_slot = NULL;
248 mmc_omap_select_slot(next_slot, 1);
251 next_slot->mrq = NULL;
252 mmc_omap_start_request(host, rq);
255 static void mmc_omap_release_slot(struct mmc_omap_slot *slot, int clk_enabled)
257 struct mmc_omap_host *host = slot->host;
261 BUG_ON(slot == NULL || host->mmc == NULL);
264 /* Keeps clock running for at least 8 cycles on valid freq */
265 mod_timer(&host->clk_timer, jiffies + HZ/10);
267 del_timer(&host->clk_timer);
268 mmc_omap_fclk_offdelay(slot);
269 mmc_omap_fclk_enable(host, 0);
272 spin_lock_irqsave(&host->slot_lock, flags);
273 /* Check for any pending requests */
274 for (i = 0; i < host->nr_slots; i++) {
275 struct mmc_omap_slot *new_slot;
277 if (host->slots[i] == NULL || host->slots[i]->mrq == NULL)
280 BUG_ON(host->next_slot != NULL);
281 new_slot = host->slots[i];
282 /* The current slot should not have a request in queue */
283 BUG_ON(new_slot == host->current_slot);
285 host->next_slot = new_slot;
286 host->mmc = new_slot->mmc;
287 spin_unlock_irqrestore(&host->slot_lock, flags);
288 queue_work(host->mmc_omap_wq, &host->slot_release_work);
293 wake_up(&host->slot_wq);
294 spin_unlock_irqrestore(&host->slot_lock, flags);
298 int mmc_omap_cover_is_open(struct mmc_omap_slot *slot)
300 if (slot->pdata->get_cover_state)
301 return slot->pdata->get_cover_state(mmc_dev(slot->mmc),
307 mmc_omap_show_cover_switch(struct device *dev, struct device_attribute *attr,
310 struct mmc_host *mmc = container_of(dev, struct mmc_host, class_dev);
311 struct mmc_omap_slot *slot = mmc_priv(mmc);
313 return sprintf(buf, "%s\n", mmc_omap_cover_is_open(slot) ? "open" :
317 static DEVICE_ATTR(cover_switch, S_IRUGO, mmc_omap_show_cover_switch, NULL);
320 mmc_omap_show_slot_name(struct device *dev, struct device_attribute *attr,
323 struct mmc_host *mmc = container_of(dev, struct mmc_host, class_dev);
324 struct mmc_omap_slot *slot = mmc_priv(mmc);
326 return sprintf(buf, "%s\n", slot->pdata->name);
329 static DEVICE_ATTR(slot_name, S_IRUGO, mmc_omap_show_slot_name, NULL);
332 mmc_omap_start_command(struct mmc_omap_host *host, struct mmc_command *cmd)
344 /* Our hardware needs to know exact type */
345 switch (mmc_resp_type(cmd)) {
350 /* resp 1, 1b, 6, 7 */
360 dev_err(mmc_dev(host->mmc), "Invalid response type: %04x\n", mmc_resp_type(cmd));
364 if (mmc_cmd_type(cmd) == MMC_CMD_ADTC) {
365 cmdtype = OMAP_MMC_CMDTYPE_ADTC;
366 } else if (mmc_cmd_type(cmd) == MMC_CMD_BC) {
367 cmdtype = OMAP_MMC_CMDTYPE_BC;
368 } else if (mmc_cmd_type(cmd) == MMC_CMD_BCR) {
369 cmdtype = OMAP_MMC_CMDTYPE_BCR;
371 cmdtype = OMAP_MMC_CMDTYPE_AC;
374 cmdreg = cmd->opcode | (resptype << 8) | (cmdtype << 12);
376 if (host->current_slot->bus_mode == MMC_BUSMODE_OPENDRAIN)
379 if (cmd->flags & MMC_RSP_BUSY)
382 if (host->data && !(host->data->flags & MMC_DATA_WRITE))
385 mod_timer(&host->cmd_abort_timer, jiffies + HZ/2);
387 OMAP_MMC_WRITE(host, CTO, 200);
388 OMAP_MMC_WRITE(host, ARGL, cmd->arg & 0xffff);
389 OMAP_MMC_WRITE(host, ARGH, cmd->arg >> 16);
390 irq_mask = OMAP_MMC_STAT_A_EMPTY | OMAP_MMC_STAT_A_FULL |
391 OMAP_MMC_STAT_CMD_CRC | OMAP_MMC_STAT_CMD_TOUT |
392 OMAP_MMC_STAT_DATA_CRC | OMAP_MMC_STAT_DATA_TOUT |
393 OMAP_MMC_STAT_END_OF_CMD | OMAP_MMC_STAT_CARD_ERR |
394 OMAP_MMC_STAT_END_OF_DATA;
395 if (cmd->opcode == MMC_ERASE)
396 irq_mask &= ~OMAP_MMC_STAT_DATA_TOUT;
397 OMAP_MMC_WRITE(host, IE, irq_mask);
398 OMAP_MMC_WRITE(host, CMD, cmdreg);
402 mmc_omap_release_dma(struct mmc_omap_host *host, struct mmc_data *data,
405 enum dma_data_direction dma_data_dir;
406 struct device *dev = mmc_dev(host->mmc);
409 if (data->flags & MMC_DATA_WRITE) {
410 dma_data_dir = DMA_TO_DEVICE;
413 dma_data_dir = DMA_FROM_DEVICE;
418 dmaengine_terminate_all(c);
419 /* Claim nothing transferred on error... */
420 data->bytes_xfered = 0;
422 dev = c->device->dev;
424 dma_unmap_sg(dev, data->sg, host->sg_len, dma_data_dir);
427 static void mmc_omap_send_stop_work(struct work_struct *work)
429 struct mmc_omap_host *host = container_of(work, struct mmc_omap_host,
431 struct mmc_omap_slot *slot = host->current_slot;
432 struct mmc_data *data = host->stop_data;
433 unsigned long tick_ns;
435 tick_ns = DIV_ROUND_UP(NSEC_PER_SEC, slot->fclk_freq);
438 mmc_omap_start_command(host, data->stop);
442 mmc_omap_xfer_done(struct mmc_omap_host *host, struct mmc_data *data)
444 if (host->dma_in_use)
445 mmc_omap_release_dma(host, data, data->error);
450 /* NOTE: MMC layer will sometimes poll-wait CMD13 next, issuing
451 * dozens of requests until the card finishes writing data.
452 * It'd be cheaper to just wait till an EOFB interrupt arrives...
456 struct mmc_host *mmc;
460 mmc_omap_release_slot(host->current_slot, 1);
461 mmc_request_done(mmc, data->mrq);
465 host->stop_data = data;
466 queue_work(host->mmc_omap_wq, &host->send_stop_work);
470 mmc_omap_send_abort(struct mmc_omap_host *host, int maxloops)
472 struct mmc_omap_slot *slot = host->current_slot;
473 unsigned int restarts, passes, timeout;
476 /* Sending abort takes 80 clocks. Have some extra and round up */
477 timeout = DIV_ROUND_UP(120 * USEC_PER_SEC, slot->fclk_freq);
479 while (restarts < maxloops) {
480 OMAP_MMC_WRITE(host, STAT, 0xFFFF);
481 OMAP_MMC_WRITE(host, CMD, (3 << 12) | (1 << 7));
484 while (passes < timeout) {
485 stat = OMAP_MMC_READ(host, STAT);
486 if (stat & OMAP_MMC_STAT_END_OF_CMD)
495 OMAP_MMC_WRITE(host, STAT, stat);
499 mmc_omap_abort_xfer(struct mmc_omap_host *host, struct mmc_data *data)
501 if (host->dma_in_use)
502 mmc_omap_release_dma(host, data, 1);
507 mmc_omap_send_abort(host, 10000);
511 mmc_omap_end_of_data(struct mmc_omap_host *host, struct mmc_data *data)
516 if (!host->dma_in_use) {
517 mmc_omap_xfer_done(host, data);
521 spin_lock_irqsave(&host->dma_lock, flags);
525 host->brs_received = 1;
526 spin_unlock_irqrestore(&host->dma_lock, flags);
528 mmc_omap_xfer_done(host, data);
532 mmc_omap_dma_done(struct mmc_omap_host *host, struct mmc_data *data)
538 spin_lock_irqsave(&host->dma_lock, flags);
539 if (host->brs_received)
543 spin_unlock_irqrestore(&host->dma_lock, flags);
545 mmc_omap_xfer_done(host, data);
549 mmc_omap_cmd_done(struct mmc_omap_host *host, struct mmc_command *cmd)
553 del_timer(&host->cmd_abort_timer);
555 if (cmd->flags & MMC_RSP_PRESENT) {
556 if (cmd->flags & MMC_RSP_136) {
557 /* response type 2 */
559 OMAP_MMC_READ(host, RSP0) |
560 (OMAP_MMC_READ(host, RSP1) << 16);
562 OMAP_MMC_READ(host, RSP2) |
563 (OMAP_MMC_READ(host, RSP3) << 16);
565 OMAP_MMC_READ(host, RSP4) |
566 (OMAP_MMC_READ(host, RSP5) << 16);
568 OMAP_MMC_READ(host, RSP6) |
569 (OMAP_MMC_READ(host, RSP7) << 16);
571 /* response types 1, 1b, 3, 4, 5, 6 */
573 OMAP_MMC_READ(host, RSP6) |
574 (OMAP_MMC_READ(host, RSP7) << 16);
578 if (host->data == NULL || cmd->error) {
579 struct mmc_host *mmc;
581 if (host->data != NULL)
582 mmc_omap_abort_xfer(host, host->data);
585 mmc_omap_release_slot(host->current_slot, 1);
586 mmc_request_done(mmc, cmd->mrq);
591 * Abort stuck command. Can occur when card is removed while it is being
594 static void mmc_omap_abort_command(struct work_struct *work)
596 struct mmc_omap_host *host = container_of(work, struct mmc_omap_host,
600 dev_dbg(mmc_dev(host->mmc), "Aborting stuck command CMD%d\n",
603 if (host->cmd->error == 0)
604 host->cmd->error = -ETIMEDOUT;
606 if (host->data == NULL) {
607 struct mmc_command *cmd;
608 struct mmc_host *mmc;
612 mmc_omap_send_abort(host, 10000);
616 mmc_omap_release_slot(host->current_slot, 1);
617 mmc_request_done(mmc, cmd->mrq);
619 mmc_omap_cmd_done(host, host->cmd);
622 enable_irq(host->irq);
626 mmc_omap_cmd_timer(struct timer_list *t)
628 struct mmc_omap_host *host = from_timer(host, t, cmd_abort_timer);
631 spin_lock_irqsave(&host->slot_lock, flags);
632 if (host->cmd != NULL && !host->abort) {
633 OMAP_MMC_WRITE(host, IE, 0);
634 disable_irq(host->irq);
636 queue_work(host->mmc_omap_wq, &host->cmd_abort_work);
638 spin_unlock_irqrestore(&host->slot_lock, flags);
643 mmc_omap_sg_to_buf(struct mmc_omap_host *host)
645 struct scatterlist *sg;
647 sg = host->data->sg + host->sg_idx;
648 host->buffer_bytes_left = sg->length;
649 host->buffer = sg_virt(sg);
650 if (host->buffer_bytes_left > host->total_bytes_left)
651 host->buffer_bytes_left = host->total_bytes_left;
655 mmc_omap_clk_timer(struct timer_list *t)
657 struct mmc_omap_host *host = from_timer(host, t, clk_timer);
659 mmc_omap_fclk_enable(host, 0);
664 mmc_omap_xfer_data(struct mmc_omap_host *host, int write)
668 if (host->buffer_bytes_left == 0) {
670 BUG_ON(host->sg_idx == host->sg_len);
671 mmc_omap_sg_to_buf(host);
674 if (n > host->buffer_bytes_left)
675 n = host->buffer_bytes_left;
677 /* Round up to handle odd number of bytes to transfer */
678 nwords = DIV_ROUND_UP(n, 2);
680 host->buffer_bytes_left -= n;
681 host->total_bytes_left -= n;
682 host->data->bytes_xfered += n;
685 __raw_writesw(host->virt_base + OMAP_MMC_REG(host, DATA),
686 host->buffer, nwords);
688 __raw_readsw(host->virt_base + OMAP_MMC_REG(host, DATA),
689 host->buffer, nwords);
692 host->buffer += nwords;
695 #ifdef CONFIG_MMC_DEBUG
696 static void mmc_omap_report_irq(struct mmc_omap_host *host, u16 status)
698 static const char *mmc_omap_status_bits[] = {
699 "EOC", "CD", "CB", "BRS", "EOFB", "DTO", "DCRC", "CTO",
700 "CCRC", "CRW", "AF", "AE", "OCRB", "CIRQ", "CERR"
703 char res[64], *buf = res;
705 buf += sprintf(buf, "MMC IRQ 0x%x:", status);
707 for (i = 0; i < ARRAY_SIZE(mmc_omap_status_bits); i++)
708 if (status & (1 << i))
709 buf += sprintf(buf, " %s", mmc_omap_status_bits[i]);
710 dev_vdbg(mmc_dev(host->mmc), "%s\n", res);
713 static void mmc_omap_report_irq(struct mmc_omap_host *host, u16 status)
719 static irqreturn_t mmc_omap_irq(int irq, void *dev_id)
721 struct mmc_omap_host * host = (struct mmc_omap_host *)dev_id;
725 int transfer_error, cmd_error;
727 if (host->cmd == NULL && host->data == NULL) {
728 status = OMAP_MMC_READ(host, STAT);
729 dev_info(mmc_dev(host->slots[0]->mmc),
730 "Spurious IRQ 0x%04x\n", status);
732 OMAP_MMC_WRITE(host, STAT, status);
733 OMAP_MMC_WRITE(host, IE, 0);
743 while ((status = OMAP_MMC_READ(host, STAT)) != 0) {
746 OMAP_MMC_WRITE(host, STAT, status);
747 if (host->cmd != NULL)
748 cmd = host->cmd->opcode;
751 dev_dbg(mmc_dev(host->mmc), "MMC IRQ %04x (CMD %d): ",
753 mmc_omap_report_irq(host, status);
755 if (host->total_bytes_left) {
756 if ((status & OMAP_MMC_STAT_A_FULL) ||
757 (status & OMAP_MMC_STAT_END_OF_DATA))
758 mmc_omap_xfer_data(host, 0);
759 if (status & OMAP_MMC_STAT_A_EMPTY)
760 mmc_omap_xfer_data(host, 1);
763 if (status & OMAP_MMC_STAT_END_OF_DATA)
766 if (status & OMAP_MMC_STAT_DATA_TOUT) {
767 dev_dbg(mmc_dev(host->mmc), "data timeout (CMD%d)\n",
770 host->data->error = -ETIMEDOUT;
775 if (status & OMAP_MMC_STAT_DATA_CRC) {
777 host->data->error = -EILSEQ;
778 dev_dbg(mmc_dev(host->mmc),
779 "data CRC error, bytes left %d\n",
780 host->total_bytes_left);
783 dev_dbg(mmc_dev(host->mmc), "data CRC error\n");
787 if (status & OMAP_MMC_STAT_CMD_TOUT) {
788 /* Timeouts are routine with some commands */
790 struct mmc_omap_slot *slot =
793 !mmc_omap_cover_is_open(slot))
794 dev_err(mmc_dev(host->mmc),
795 "command timeout (CMD%d)\n",
797 host->cmd->error = -ETIMEDOUT;
803 if (status & OMAP_MMC_STAT_CMD_CRC) {
805 dev_err(mmc_dev(host->mmc),
806 "command CRC error (CMD%d, arg 0x%08x)\n",
807 cmd, host->cmd->arg);
808 host->cmd->error = -EILSEQ;
812 dev_err(mmc_dev(host->mmc),
813 "command CRC error without cmd?\n");
816 if (status & OMAP_MMC_STAT_CARD_ERR) {
817 dev_dbg(mmc_dev(host->mmc),
818 "ignoring card status error (CMD%d)\n",
824 * NOTE: On 1610 the END_OF_CMD may come too early when
827 if ((status & OMAP_MMC_STAT_END_OF_CMD) &&
828 (!(status & OMAP_MMC_STAT_A_EMPTY))) {
833 if (cmd_error && host->data) {
834 del_timer(&host->cmd_abort_timer);
836 OMAP_MMC_WRITE(host, IE, 0);
837 disable_irq_nosync(host->irq);
838 queue_work(host->mmc_omap_wq, &host->cmd_abort_work);
842 if (end_command && host->cmd)
843 mmc_omap_cmd_done(host, host->cmd);
844 if (host->data != NULL) {
846 mmc_omap_xfer_done(host, host->data);
847 else if (end_transfer)
848 mmc_omap_end_of_data(host, host->data);
854 void omap_mmc_notify_cover_event(struct device *dev, int num, int is_closed)
857 struct mmc_omap_host *host = dev_get_drvdata(dev);
858 struct mmc_omap_slot *slot = host->slots[num];
860 BUG_ON(num >= host->nr_slots);
862 /* Other subsystems can call in here before we're initialised. */
863 if (host->nr_slots == 0 || !host->slots[num])
866 cover_open = mmc_omap_cover_is_open(slot);
867 if (cover_open != slot->cover_open) {
868 slot->cover_open = cover_open;
869 sysfs_notify(&slot->mmc->class_dev.kobj, NULL, "cover_switch");
872 tasklet_hi_schedule(&slot->cover_tasklet);
875 static void mmc_omap_cover_timer(struct timer_list *t)
877 struct mmc_omap_slot *slot = from_timer(slot, t, cover_timer);
878 tasklet_schedule(&slot->cover_tasklet);
881 static void mmc_omap_cover_handler(struct tasklet_struct *t)
883 struct mmc_omap_slot *slot = from_tasklet(slot, t, cover_tasklet);
884 int cover_open = mmc_omap_cover_is_open(slot);
886 mmc_detect_change(slot->mmc, 0);
891 * If no card is inserted, we postpone polling until
892 * the cover has been closed.
894 if (slot->mmc->card == NULL)
897 mod_timer(&slot->cover_timer,
898 jiffies + msecs_to_jiffies(OMAP_MMC_COVER_POLL_DELAY));
901 static void mmc_omap_dma_callback(void *priv)
903 struct mmc_omap_host *host = priv;
904 struct mmc_data *data = host->data;
906 /* If we got to the end of DMA, assume everything went well */
907 data->bytes_xfered += data->blocks * data->blksz;
909 mmc_omap_dma_done(host, data);
912 static inline void set_cmd_timeout(struct mmc_omap_host *host, struct mmc_request *req)
916 reg = OMAP_MMC_READ(host, SDIO);
918 OMAP_MMC_WRITE(host, SDIO, reg);
919 /* Set maximum timeout */
920 OMAP_MMC_WRITE(host, CTO, 0xfd);
923 static inline void set_data_timeout(struct mmc_omap_host *host, struct mmc_request *req)
925 unsigned int timeout, cycle_ns;
928 cycle_ns = 1000000000 / host->current_slot->fclk_freq;
929 timeout = req->data->timeout_ns / cycle_ns;
930 timeout += req->data->timeout_clks;
932 /* Check if we need to use timeout multiplier register */
933 reg = OMAP_MMC_READ(host, SDIO);
934 if (timeout > 0xffff) {
939 OMAP_MMC_WRITE(host, SDIO, reg);
940 OMAP_MMC_WRITE(host, DTO, timeout);
944 mmc_omap_prepare_data(struct mmc_omap_host *host, struct mmc_request *req)
946 struct mmc_data *data = req->data;
947 int i, use_dma = 1, block_size;
948 struct scatterlist *sg;
953 OMAP_MMC_WRITE(host, BLEN, 0);
954 OMAP_MMC_WRITE(host, NBLK, 0);
955 OMAP_MMC_WRITE(host, BUF, 0);
956 host->dma_in_use = 0;
957 set_cmd_timeout(host, req);
961 block_size = data->blksz;
963 OMAP_MMC_WRITE(host, NBLK, data->blocks - 1);
964 OMAP_MMC_WRITE(host, BLEN, block_size - 1);
965 set_data_timeout(host, req);
967 /* cope with calling layer confusion; it issues "single
968 * block" writes using multi-block scatterlists.
970 sg_len = (data->blocks == 1) ? 1 : data->sg_len;
972 /* Only do DMA for entire blocks */
973 for_each_sg(data->sg, sg, sg_len, i) {
974 if ((sg->length % block_size) != 0) {
982 enum dma_data_direction dma_data_dir;
983 struct dma_async_tx_descriptor *tx;
989 * FIFO is 16x2 bytes on 15xx, and 32x2 bytes on 16xx
990 * and 24xx. Use 16 or 32 word frames when the
991 * blocksize is at least that large. Blocksize is
992 * usually 512 bytes; but not for some SD reads.
994 burst = mmc_omap15xx() ? 32 : 64;
995 if (burst > data->blksz)
1000 if (data->flags & MMC_DATA_WRITE) {
1002 bp = &host->dma_tx_burst;
1003 buf = 0x0f80 | (burst - 1) << 0;
1004 dma_data_dir = DMA_TO_DEVICE;
1007 bp = &host->dma_rx_burst;
1008 buf = 0x800f | (burst - 1) << 8;
1009 dma_data_dir = DMA_FROM_DEVICE;
1015 /* Only reconfigure if we have a different burst size */
1017 struct dma_slave_config cfg = {
1018 .src_addr = host->phys_base +
1019 OMAP_MMC_REG(host, DATA),
1020 .dst_addr = host->phys_base +
1021 OMAP_MMC_REG(host, DATA),
1022 .src_addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES,
1023 .dst_addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES,
1024 .src_maxburst = burst,
1025 .dst_maxburst = burst,
1028 if (dmaengine_slave_config(c, &cfg))
1034 host->sg_len = dma_map_sg(c->device->dev, data->sg, sg_len,
1036 if (host->sg_len == 0)
1039 tx = dmaengine_prep_slave_sg(c, data->sg, host->sg_len,
1040 data->flags & MMC_DATA_WRITE ? DMA_MEM_TO_DEV : DMA_DEV_TO_MEM,
1041 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
1045 OMAP_MMC_WRITE(host, BUF, buf);
1047 tx->callback = mmc_omap_dma_callback;
1048 tx->callback_param = host;
1049 dmaengine_submit(tx);
1050 host->brs_received = 0;
1052 host->dma_in_use = 1;
1057 /* Revert to PIO? */
1058 OMAP_MMC_WRITE(host, BUF, 0x1f1f);
1059 host->total_bytes_left = data->blocks * block_size;
1060 host->sg_len = sg_len;
1061 mmc_omap_sg_to_buf(host);
1062 host->dma_in_use = 0;
1065 static void mmc_omap_start_request(struct mmc_omap_host *host,
1066 struct mmc_request *req)
1068 BUG_ON(host->mrq != NULL);
1072 /* only touch fifo AFTER the controller readies it */
1073 mmc_omap_prepare_data(host, req);
1074 mmc_omap_start_command(host, req->cmd);
1075 if (host->dma_in_use) {
1076 struct dma_chan *c = host->data->flags & MMC_DATA_WRITE ?
1077 host->dma_tx : host->dma_rx;
1079 dma_async_issue_pending(c);
1083 static void mmc_omap_request(struct mmc_host *mmc, struct mmc_request *req)
1085 struct mmc_omap_slot *slot = mmc_priv(mmc);
1086 struct mmc_omap_host *host = slot->host;
1087 unsigned long flags;
1089 spin_lock_irqsave(&host->slot_lock, flags);
1090 if (host->mmc != NULL) {
1091 BUG_ON(slot->mrq != NULL);
1093 spin_unlock_irqrestore(&host->slot_lock, flags);
1097 spin_unlock_irqrestore(&host->slot_lock, flags);
1098 mmc_omap_select_slot(slot, 1);
1099 mmc_omap_start_request(host, req);
1102 static void mmc_omap_set_power(struct mmc_omap_slot *slot, int power_on,
1105 struct mmc_omap_host *host;
1109 if (slot->pdata->set_power != NULL)
1110 slot->pdata->set_power(mmc_dev(slot->mmc), slot->id, power_on,
1116 w = OMAP_MMC_READ(host, CON);
1117 OMAP_MMC_WRITE(host, CON, w | (1 << 11));
1119 w = OMAP_MMC_READ(host, CON);
1120 OMAP_MMC_WRITE(host, CON, w & ~(1 << 11));
1125 static int mmc_omap_calc_divisor(struct mmc_host *mmc, struct mmc_ios *ios)
1127 struct mmc_omap_slot *slot = mmc_priv(mmc);
1128 struct mmc_omap_host *host = slot->host;
1129 int func_clk_rate = clk_get_rate(host->fclk);
1132 if (ios->clock == 0)
1135 dsor = func_clk_rate / ios->clock;
1139 if (func_clk_rate / dsor > ios->clock)
1145 slot->fclk_freq = func_clk_rate / dsor;
1147 if (ios->bus_width == MMC_BUS_WIDTH_4)
1153 static void mmc_omap_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
1155 struct mmc_omap_slot *slot = mmc_priv(mmc);
1156 struct mmc_omap_host *host = slot->host;
1158 int clk_enabled, init_stream;
1160 mmc_omap_select_slot(slot, 0);
1162 dsor = mmc_omap_calc_divisor(mmc, ios);
1164 if (ios->vdd != slot->vdd)
1165 slot->vdd = ios->vdd;
1169 switch (ios->power_mode) {
1171 mmc_omap_set_power(slot, 0, ios->vdd);
1174 /* Cannot touch dsor yet, just power up MMC */
1175 mmc_omap_set_power(slot, 1, ios->vdd);
1176 slot->power_mode = ios->power_mode;
1179 mmc_omap_fclk_enable(host, 1);
1182 if (slot->power_mode != MMC_POWER_ON)
1186 slot->power_mode = ios->power_mode;
1188 if (slot->bus_mode != ios->bus_mode) {
1189 if (slot->pdata->set_bus_mode != NULL)
1190 slot->pdata->set_bus_mode(mmc_dev(mmc), slot->id,
1192 slot->bus_mode = ios->bus_mode;
1195 /* On insanely high arm_per frequencies something sometimes
1196 * goes somehow out of sync, and the POW bit is not being set,
1197 * which results in the while loop below getting stuck.
1198 * Writing to the CON register twice seems to do the trick. */
1199 for (i = 0; i < 2; i++)
1200 OMAP_MMC_WRITE(host, CON, dsor);
1201 slot->saved_con = dsor;
1203 /* worst case at 400kHz, 80 cycles makes 200 microsecs */
1206 /* Send clock cycles, poll completion */
1207 OMAP_MMC_WRITE(host, IE, 0);
1208 OMAP_MMC_WRITE(host, STAT, 0xffff);
1209 OMAP_MMC_WRITE(host, CMD, 1 << 7);
1210 while (usecs > 0 && (OMAP_MMC_READ(host, STAT) & 1) == 0) {
1214 OMAP_MMC_WRITE(host, STAT, 1);
1218 mmc_omap_release_slot(slot, clk_enabled);
1221 static const struct mmc_host_ops mmc_omap_ops = {
1222 .request = mmc_omap_request,
1223 .set_ios = mmc_omap_set_ios,
1226 static int mmc_omap_new_slot(struct mmc_omap_host *host, int id)
1228 struct mmc_omap_slot *slot = NULL;
1229 struct mmc_host *mmc;
1232 mmc = mmc_alloc_host(sizeof(struct mmc_omap_slot), host->dev);
1236 slot = mmc_priv(mmc);
1240 slot->power_mode = MMC_POWER_UNDEFINED;
1241 slot->pdata = &host->pdata->slots[id];
1243 host->slots[id] = slot;
1246 if (host->pdata->slots[id].wires >= 4)
1247 mmc->caps |= MMC_CAP_4_BIT_DATA;
1249 mmc->ops = &mmc_omap_ops;
1250 mmc->f_min = 400000;
1253 mmc->f_max = 48000000;
1255 mmc->f_max = 24000000;
1256 if (host->pdata->max_freq)
1257 mmc->f_max = min(host->pdata->max_freq, mmc->f_max);
1258 mmc->ocr_avail = slot->pdata->ocr_mask;
1260 /* Use scatterlist DMA to reduce per-transfer costs.
1261 * NOTE max_seg_size assumption that small blocks aren't
1262 * normally used (except e.g. for reading SD registers).
1265 mmc->max_blk_size = 2048; /* BLEN is 11 bits (+1) */
1266 mmc->max_blk_count = 2048; /* NBLK is 11 bits (+1) */
1267 mmc->max_req_size = mmc->max_blk_size * mmc->max_blk_count;
1268 mmc->max_seg_size = mmc->max_req_size;
1270 if (slot->pdata->get_cover_state != NULL) {
1271 timer_setup(&slot->cover_timer, mmc_omap_cover_timer, 0);
1272 tasklet_setup(&slot->cover_tasklet, mmc_omap_cover_handler);
1275 r = mmc_add_host(mmc);
1277 goto err_remove_host;
1279 if (slot->pdata->name != NULL) {
1280 r = device_create_file(&mmc->class_dev,
1281 &dev_attr_slot_name);
1283 goto err_remove_host;
1286 if (slot->pdata->get_cover_state != NULL) {
1287 r = device_create_file(&mmc->class_dev,
1288 &dev_attr_cover_switch);
1290 goto err_remove_slot_name;
1291 tasklet_schedule(&slot->cover_tasklet);
1296 err_remove_slot_name:
1297 if (slot->pdata->name != NULL)
1298 device_remove_file(&mmc->class_dev, &dev_attr_slot_name);
1300 mmc_remove_host(mmc);
1305 static void mmc_omap_remove_slot(struct mmc_omap_slot *slot)
1307 struct mmc_host *mmc = slot->mmc;
1309 if (slot->pdata->name != NULL)
1310 device_remove_file(&mmc->class_dev, &dev_attr_slot_name);
1311 if (slot->pdata->get_cover_state != NULL)
1312 device_remove_file(&mmc->class_dev, &dev_attr_cover_switch);
1314 tasklet_kill(&slot->cover_tasklet);
1315 del_timer_sync(&slot->cover_timer);
1316 flush_workqueue(slot->host->mmc_omap_wq);
1318 mmc_remove_host(mmc);
1322 static int mmc_omap_probe(struct platform_device *pdev)
1324 struct omap_mmc_platform_data *pdata = pdev->dev.platform_data;
1325 struct mmc_omap_host *host = NULL;
1326 struct resource *res;
1330 if (pdata == NULL) {
1331 dev_err(&pdev->dev, "platform data missing\n");
1334 if (pdata->nr_slots == 0) {
1335 dev_err(&pdev->dev, "no slots\n");
1336 return -EPROBE_DEFER;
1339 host = devm_kzalloc(&pdev->dev, sizeof(struct mmc_omap_host),
1344 irq = platform_get_irq(pdev, 0);
1348 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1349 host->virt_base = devm_ioremap_resource(&pdev->dev, res);
1350 if (IS_ERR(host->virt_base))
1351 return PTR_ERR(host->virt_base);
1353 INIT_WORK(&host->slot_release_work, mmc_omap_slot_release_work);
1354 INIT_WORK(&host->send_stop_work, mmc_omap_send_stop_work);
1356 INIT_WORK(&host->cmd_abort_work, mmc_omap_abort_command);
1357 timer_setup(&host->cmd_abort_timer, mmc_omap_cmd_timer, 0);
1359 spin_lock_init(&host->clk_lock);
1360 timer_setup(&host->clk_timer, mmc_omap_clk_timer, 0);
1362 spin_lock_init(&host->dma_lock);
1363 spin_lock_init(&host->slot_lock);
1364 init_waitqueue_head(&host->slot_wq);
1366 host->pdata = pdata;
1367 host->features = host->pdata->slots[0].features;
1368 host->dev = &pdev->dev;
1369 platform_set_drvdata(pdev, host);
1371 host->id = pdev->id;
1373 host->phys_base = res->start;
1374 host->iclk = clk_get(&pdev->dev, "ick");
1375 if (IS_ERR(host->iclk))
1376 return PTR_ERR(host->iclk);
1377 clk_enable(host->iclk);
1379 host->fclk = clk_get(&pdev->dev, "fck");
1380 if (IS_ERR(host->fclk)) {
1381 ret = PTR_ERR(host->fclk);
1385 host->dma_tx_burst = -1;
1386 host->dma_rx_burst = -1;
1388 host->dma_tx = dma_request_chan(&pdev->dev, "tx");
1389 if (IS_ERR(host->dma_tx)) {
1390 ret = PTR_ERR(host->dma_tx);
1391 if (ret == -EPROBE_DEFER) {
1392 clk_put(host->fclk);
1396 host->dma_tx = NULL;
1397 dev_warn(host->dev, "TX DMA channel request failed\n");
1400 host->dma_rx = dma_request_chan(&pdev->dev, "rx");
1401 if (IS_ERR(host->dma_rx)) {
1402 ret = PTR_ERR(host->dma_rx);
1403 if (ret == -EPROBE_DEFER) {
1405 dma_release_channel(host->dma_tx);
1406 clk_put(host->fclk);
1410 host->dma_rx = NULL;
1411 dev_warn(host->dev, "RX DMA channel request failed\n");
1414 ret = request_irq(host->irq, mmc_omap_irq, 0, DRIVER_NAME, host);
1418 if (pdata->init != NULL) {
1419 ret = pdata->init(&pdev->dev);
1424 host->nr_slots = pdata->nr_slots;
1425 host->reg_shift = (mmc_omap7xx() ? 1 : 2);
1427 host->mmc_omap_wq = alloc_workqueue("mmc_omap", 0, 0);
1428 if (!host->mmc_omap_wq) {
1430 goto err_plat_cleanup;
1433 for (i = 0; i < pdata->nr_slots; i++) {
1434 ret = mmc_omap_new_slot(host, i);
1437 mmc_omap_remove_slot(host->slots[i]);
1439 goto err_destroy_wq;
1446 destroy_workqueue(host->mmc_omap_wq);
1449 pdata->cleanup(&pdev->dev);
1451 free_irq(host->irq, host);
1454 dma_release_channel(host->dma_tx);
1456 dma_release_channel(host->dma_rx);
1457 clk_put(host->fclk);
1459 clk_disable(host->iclk);
1460 clk_put(host->iclk);
1464 static int mmc_omap_remove(struct platform_device *pdev)
1466 struct mmc_omap_host *host = platform_get_drvdata(pdev);
1469 BUG_ON(host == NULL);
1471 for (i = 0; i < host->nr_slots; i++)
1472 mmc_omap_remove_slot(host->slots[i]);
1474 if (host->pdata->cleanup)
1475 host->pdata->cleanup(&pdev->dev);
1477 mmc_omap_fclk_enable(host, 0);
1478 free_irq(host->irq, host);
1479 clk_put(host->fclk);
1480 clk_disable(host->iclk);
1481 clk_put(host->iclk);
1484 dma_release_channel(host->dma_tx);
1486 dma_release_channel(host->dma_rx);
1488 destroy_workqueue(host->mmc_omap_wq);
1493 #if IS_BUILTIN(CONFIG_OF)
1494 static const struct of_device_id mmc_omap_match[] = {
1495 { .compatible = "ti,omap2420-mmc", },
1498 MODULE_DEVICE_TABLE(of, mmc_omap_match);
1501 static struct platform_driver mmc_omap_driver = {
1502 .probe = mmc_omap_probe,
1503 .remove = mmc_omap_remove,
1505 .name = DRIVER_NAME,
1506 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
1507 .of_match_table = of_match_ptr(mmc_omap_match),
1511 module_platform_driver(mmc_omap_driver);
1512 MODULE_DESCRIPTION("OMAP Multimedia Card driver");
1513 MODULE_LICENSE("GPL");
1514 MODULE_ALIAS("platform:" DRIVER_NAME);
1515 MODULE_AUTHOR("Juha Yrjölä");