2 * linux/drivers/mmc/core/core.c
4 * Copyright (C) 2003-2004 Russell King, All Rights Reserved.
5 * SD support Copyright (C) 2004 Ian Molton, All Rights Reserved.
6 * Copyright (C) 2005-2007 Pierre Ossman, All Rights Reserved.
7 * MMCv4 support Copyright (C) 2006 Philip Langdale, All Rights Reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/interrupt.h>
16 #include <linux/completion.h>
17 #include <linux/device.h>
18 #include <linux/delay.h>
19 #include <linux/pagemap.h>
20 #include <linux/err.h>
21 #include <asm/scatterlist.h>
22 #include <linux/scatterlist.h>
24 #include <linux/mmc/card.h>
25 #include <linux/mmc/host.h>
26 #include <linux/mmc/mmc.h>
27 #include <linux/mmc/sd.h>
38 extern int mmc_attach_mmc(struct mmc_host *host, u32 ocr);
39 extern int mmc_attach_sd(struct mmc_host *host, u32 ocr);
40 extern int mmc_attach_sdio(struct mmc_host *host, u32 ocr);
42 static struct workqueue_struct *workqueue;
45 * Internal function. Schedule delayed work in the MMC work queue.
47 static int mmc_schedule_delayed_work(struct delayed_work *work,
50 return queue_delayed_work(workqueue, work, delay);
54 * Internal function. Flush all scheduled work from the MMC work queue.
56 static void mmc_flush_scheduled_work(void)
58 flush_workqueue(workqueue);
62 * mmc_request_done - finish processing an MMC request
63 * @host: MMC host which completed request
64 * @mrq: MMC request which request
66 * MMC drivers should call this function when they have completed
67 * their processing of a request.
69 void mmc_request_done(struct mmc_host *host, struct mmc_request *mrq)
71 struct mmc_command *cmd = mrq->cmd;
74 if (err && cmd->retries) {
75 pr_debug("%s: req failed (CMD%u): %d, retrying...\n",
76 mmc_hostname(host), cmd->opcode, err);
80 host->ops->request(host, mrq);
82 pr_debug("%s: req done (CMD%u): %d: %08x %08x %08x %08x\n",
83 mmc_hostname(host), cmd->opcode, err,
84 cmd->resp[0], cmd->resp[1],
85 cmd->resp[2], cmd->resp[3]);
88 pr_debug("%s: %d bytes transferred: %d\n",
90 mrq->data->bytes_xfered, mrq->data->error);
94 pr_debug("%s: (CMD%u): %d: %08x %08x %08x %08x\n",
95 mmc_hostname(host), mrq->stop->opcode,
97 mrq->stop->resp[0], mrq->stop->resp[1],
98 mrq->stop->resp[2], mrq->stop->resp[3]);
106 EXPORT_SYMBOL(mmc_request_done);
109 mmc_start_request(struct mmc_host *host, struct mmc_request *mrq)
111 #ifdef CONFIG_MMC_DEBUG
115 pr_debug("%s: starting CMD%u arg %08x flags %08x\n",
116 mmc_hostname(host), mrq->cmd->opcode,
117 mrq->cmd->arg, mrq->cmd->flags);
120 pr_debug("%s: blksz %d blocks %d flags %08x "
121 "tsac %d ms nsac %d\n",
122 mmc_hostname(host), mrq->data->blksz,
123 mrq->data->blocks, mrq->data->flags,
124 mrq->data->timeout_ns / 10000000,
125 mrq->data->timeout_clks);
129 pr_debug("%s: CMD%u arg %08x flags %08x\n",
130 mmc_hostname(host), mrq->stop->opcode,
131 mrq->stop->arg, mrq->stop->flags);
134 WARN_ON(!host->claimed);
139 BUG_ON(mrq->data->blksz > host->max_blk_size);
140 BUG_ON(mrq->data->blocks > host->max_blk_count);
141 BUG_ON(mrq->data->blocks * mrq->data->blksz >
144 #ifdef CONFIG_MMC_DEBUG
146 for (i = 0;i < mrq->data->sg_len;i++)
147 sz += mrq->data->sg[i].length;
148 BUG_ON(sz != mrq->data->blocks * mrq->data->blksz);
151 mrq->cmd->data = mrq->data;
152 mrq->data->error = 0;
153 mrq->data->mrq = mrq;
155 mrq->data->stop = mrq->stop;
156 mrq->stop->error = 0;
157 mrq->stop->mrq = mrq;
160 host->ops->request(host, mrq);
163 static void mmc_wait_done(struct mmc_request *mrq)
165 complete(mrq->done_data);
169 * mmc_wait_for_req - start a request and wait for completion
170 * @host: MMC host to start command
171 * @mrq: MMC request to start
173 * Start a new MMC custom command request for a host, and wait
174 * for the command to complete. Does not attempt to parse the
177 void mmc_wait_for_req(struct mmc_host *host, struct mmc_request *mrq)
179 DECLARE_COMPLETION_ONSTACK(complete);
181 mrq->done_data = &complete;
182 mrq->done = mmc_wait_done;
184 mmc_start_request(host, mrq);
186 wait_for_completion(&complete);
189 EXPORT_SYMBOL(mmc_wait_for_req);
192 * mmc_wait_for_cmd - start a command and wait for completion
193 * @host: MMC host to start command
194 * @cmd: MMC command to start
195 * @retries: maximum number of retries
197 * Start a new MMC command for a host, and wait for the command
198 * to complete. Return any error that occurred while the command
199 * was executing. Do not attempt to parse the response.
201 int mmc_wait_for_cmd(struct mmc_host *host, struct mmc_command *cmd, int retries)
203 struct mmc_request mrq;
205 BUG_ON(!host->claimed);
207 memset(&mrq, 0, sizeof(struct mmc_request));
209 memset(cmd->resp, 0, sizeof(cmd->resp));
210 cmd->retries = retries;
215 mmc_wait_for_req(host, &mrq);
220 EXPORT_SYMBOL(mmc_wait_for_cmd);
223 * mmc_set_data_timeout - set the timeout for a data command
224 * @data: data phase for command
225 * @card: the MMC card associated with the data transfer
227 * Computes the data timeout parameters according to the
228 * correct algorithm given the card type.
230 void mmc_set_data_timeout(struct mmc_data *data, const struct mmc_card *card)
235 * SD cards use a 100 multiplier rather than 10
237 mult = mmc_card_sd(card) ? 100 : 10;
240 * Scale up the multiplier (and therefore the timeout) by
241 * the r2w factor for writes.
243 if (data->flags & MMC_DATA_WRITE)
244 mult <<= card->csd.r2w_factor;
246 data->timeout_ns = card->csd.tacc_ns * mult;
247 data->timeout_clks = card->csd.tacc_clks * mult;
250 * SD cards also have an upper limit on the timeout.
252 if (mmc_card_sd(card)) {
253 unsigned int timeout_us, limit_us;
255 timeout_us = data->timeout_ns / 1000;
256 timeout_us += data->timeout_clks * 1000 /
257 (card->host->ios.clock / 1000);
259 if (data->flags & MMC_DATA_WRITE)
265 * SDHC cards always use these fixed values.
267 if (timeout_us > limit_us || mmc_card_blockaddr(card)) {
268 data->timeout_ns = limit_us * 1000;
269 data->timeout_clks = 0;
273 EXPORT_SYMBOL(mmc_set_data_timeout);
276 * __mmc_claim_host - exclusively claim a host
277 * @host: mmc host to claim
278 * @abort: whether or not the operation should be aborted
280 * Claim a host for a set of operations. If @abort is non null and
281 * dereference a non-zero value then this will return prematurely with
282 * that non-zero value without acquiring the lock. Returns zero
283 * with the lock held otherwise.
285 int __mmc_claim_host(struct mmc_host *host, atomic_t *abort)
287 DECLARE_WAITQUEUE(wait, current);
293 add_wait_queue(&host->wq, &wait);
294 spin_lock_irqsave(&host->lock, flags);
296 set_current_state(TASK_UNINTERRUPTIBLE);
297 stop = abort ? atomic_read(abort) : 0;
298 if (stop || !host->claimed)
300 spin_unlock_irqrestore(&host->lock, flags);
302 spin_lock_irqsave(&host->lock, flags);
304 set_current_state(TASK_RUNNING);
309 spin_unlock_irqrestore(&host->lock, flags);
310 remove_wait_queue(&host->wq, &wait);
314 EXPORT_SYMBOL(__mmc_claim_host);
317 * mmc_release_host - release a host
318 * @host: mmc host to release
320 * Release a MMC host, allowing others to claim the host
321 * for their operations.
323 void mmc_release_host(struct mmc_host *host)
327 BUG_ON(!host->claimed);
329 spin_lock_irqsave(&host->lock, flags);
331 spin_unlock_irqrestore(&host->lock, flags);
336 EXPORT_SYMBOL(mmc_release_host);
339 * Internal function that does the actual ios call to the host driver,
340 * optionally printing some debug output.
342 static inline void mmc_set_ios(struct mmc_host *host)
344 struct mmc_ios *ios = &host->ios;
346 pr_debug("%s: clock %uHz busmode %u powermode %u cs %u Vdd %u "
347 "width %u timing %u\n",
348 mmc_hostname(host), ios->clock, ios->bus_mode,
349 ios->power_mode, ios->chip_select, ios->vdd,
350 ios->bus_width, ios->timing);
352 host->ops->set_ios(host, ios);
356 * Control chip select pin on a host.
358 void mmc_set_chip_select(struct mmc_host *host, int mode)
360 host->ios.chip_select = mode;
365 * Sets the host clock to the highest possible frequency that
368 void mmc_set_clock(struct mmc_host *host, unsigned int hz)
370 WARN_ON(hz < host->f_min);
372 if (hz > host->f_max)
375 host->ios.clock = hz;
380 * Change the bus mode (open drain/push-pull) of a host.
382 void mmc_set_bus_mode(struct mmc_host *host, unsigned int mode)
384 host->ios.bus_mode = mode;
389 * Change data bus width of a host.
391 void mmc_set_bus_width(struct mmc_host *host, unsigned int width)
393 host->ios.bus_width = width;
398 * Mask off any voltages we don't support and select
401 u32 mmc_select_voltage(struct mmc_host *host, u32 ocr)
405 ocr &= host->ocr_avail;
423 * Select timing parameters for host.
425 void mmc_set_timing(struct mmc_host *host, unsigned int timing)
427 host->ios.timing = timing;
432 * Apply power to the MMC stack. This is a two-stage process.
433 * First, we enable power to the card without the clock running.
434 * We then wait a bit for the power to stabilise. Finally,
435 * enable the bus drivers and clock to the card.
437 * We must _NOT_ enable the clock prior to power stablising.
439 * If a host does all the power sequencing itself, ignore the
440 * initial MMC_POWER_UP stage.
442 static void mmc_power_up(struct mmc_host *host)
444 int bit = fls(host->ocr_avail) - 1;
447 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
448 host->ios.chip_select = MMC_CS_DONTCARE;
449 host->ios.power_mode = MMC_POWER_UP;
450 host->ios.bus_width = MMC_BUS_WIDTH_1;
451 host->ios.timing = MMC_TIMING_LEGACY;
456 host->ios.clock = host->f_min;
457 host->ios.power_mode = MMC_POWER_ON;
463 static void mmc_power_off(struct mmc_host *host)
467 host->ios.bus_mode = MMC_BUSMODE_OPENDRAIN;
468 host->ios.chip_select = MMC_CS_DONTCARE;
469 host->ios.power_mode = MMC_POWER_OFF;
470 host->ios.bus_width = MMC_BUS_WIDTH_1;
471 host->ios.timing = MMC_TIMING_LEGACY;
476 * Cleanup when the last reference to the bus operator is dropped.
478 void __mmc_release_bus(struct mmc_host *host)
481 BUG_ON(host->bus_refs);
482 BUG_ON(!host->bus_dead);
484 host->bus_ops = NULL;
488 * Increase reference count of bus operator
490 static inline void mmc_bus_get(struct mmc_host *host)
494 spin_lock_irqsave(&host->lock, flags);
496 spin_unlock_irqrestore(&host->lock, flags);
500 * Decrease reference count of bus operator and free it if
501 * it is the last reference.
503 static inline void mmc_bus_put(struct mmc_host *host)
507 spin_lock_irqsave(&host->lock, flags);
509 if ((host->bus_refs == 0) && host->bus_ops)
510 __mmc_release_bus(host);
511 spin_unlock_irqrestore(&host->lock, flags);
515 * Assign a mmc bus handler to a host. Only one bus handler may control a
516 * host at any given time.
518 void mmc_attach_bus(struct mmc_host *host, const struct mmc_bus_ops *ops)
525 BUG_ON(!host->claimed);
527 spin_lock_irqsave(&host->lock, flags);
529 BUG_ON(host->bus_ops);
530 BUG_ON(host->bus_refs);
536 spin_unlock_irqrestore(&host->lock, flags);
540 * Remove the current bus handler from a host. Assumes that there are
541 * no interesting cards left, so the bus is powered down.
543 void mmc_detach_bus(struct mmc_host *host)
549 BUG_ON(!host->claimed);
550 BUG_ON(!host->bus_ops);
552 spin_lock_irqsave(&host->lock, flags);
556 spin_unlock_irqrestore(&host->lock, flags);
564 * mmc_detect_change - process change of state on a MMC socket
565 * @host: host which changed state.
566 * @delay: optional delay to wait before detection (jiffies)
568 * MMC drivers should call this when they detect a card has been
569 * inserted or removed. The MMC layer will confirm that any
570 * present card is still functional, and initialize any newly
573 void mmc_detect_change(struct mmc_host *host, unsigned long delay)
575 #ifdef CONFIG_MMC_DEBUG
577 spin_lock_irqsave(&host->lock, flags);
578 BUG_ON(host->removed);
579 spin_unlock_irqrestore(&host->lock, flags);
582 mmc_schedule_delayed_work(&host->detect, delay);
585 EXPORT_SYMBOL(mmc_detect_change);
588 void mmc_rescan(struct work_struct *work)
590 struct mmc_host *host =
591 container_of(work, struct mmc_host, detect.work);
597 if (host->bus_ops == NULL) {
599 * Only we can add a new handler, so it's safe to
600 * release the lock here.
604 mmc_claim_host(host);
609 mmc_send_if_cond(host, host->ocr_avail);
612 * First we search for SDIO...
614 err = mmc_send_io_op_cond(host, 0, &ocr);
616 if (mmc_attach_sdio(host, ocr))
622 * ...then normal SD...
624 err = mmc_send_app_op_cond(host, 0, &ocr);
626 if (mmc_attach_sd(host, ocr))
632 * ...and finally MMC.
634 err = mmc_send_op_cond(host, 0, &ocr);
636 if (mmc_attach_mmc(host, ocr))
641 mmc_release_host(host);
644 if (host->bus_ops->detect && !host->bus_dead)
645 host->bus_ops->detect(host);
651 void mmc_start_host(struct mmc_host *host)
654 mmc_detect_change(host, 0);
657 void mmc_stop_host(struct mmc_host *host)
659 #ifdef CONFIG_MMC_DEBUG
661 spin_lock_irqsave(&host->lock, flags);
663 spin_unlock_irqrestore(&host->lock, flags);
666 mmc_flush_scheduled_work();
669 if (host->bus_ops && !host->bus_dead) {
670 if (host->bus_ops->remove)
671 host->bus_ops->remove(host);
673 mmc_claim_host(host);
674 mmc_detach_bus(host);
675 mmc_release_host(host);
687 * mmc_suspend_host - suspend a host
689 * @state: suspend mode (PM_SUSPEND_xxx)
691 int mmc_suspend_host(struct mmc_host *host, pm_message_t state)
693 mmc_flush_scheduled_work();
696 if (host->bus_ops && !host->bus_dead) {
697 if (host->bus_ops->suspend)
698 host->bus_ops->suspend(host);
699 if (!host->bus_ops->resume) {
700 if (host->bus_ops->remove)
701 host->bus_ops->remove(host);
703 mmc_claim_host(host);
704 mmc_detach_bus(host);
705 mmc_release_host(host);
715 EXPORT_SYMBOL(mmc_suspend_host);
718 * mmc_resume_host - resume a previously suspended host
721 int mmc_resume_host(struct mmc_host *host)
724 if (host->bus_ops && !host->bus_dead) {
726 BUG_ON(!host->bus_ops->resume);
727 host->bus_ops->resume(host);
732 * We add a slight delay here so that resume can progress
735 mmc_detect_change(host, 1);
740 EXPORT_SYMBOL(mmc_resume_host);
744 static int __init mmc_init(void)
748 workqueue = create_singlethread_workqueue("kmmcd");
752 ret = mmc_register_bus();
754 goto destroy_workqueue;
756 ret = mmc_register_host_class();
760 ret = sdio_register_bus();
762 goto unregister_host_class;
766 unregister_host_class:
767 mmc_unregister_host_class();
769 mmc_unregister_bus();
771 destroy_workqueue(workqueue);
776 static void __exit mmc_exit(void)
778 sdio_unregister_bus();
779 mmc_unregister_host_class();
780 mmc_unregister_bus();
781 destroy_workqueue(workqueue);
784 subsys_initcall(mmc_init);
785 module_exit(mmc_exit);
787 MODULE_LICENSE("GPL");