1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * linux/drivers/mmc/host/sdhci.c - Secure Digital Host Controller Interface driver 4 * 5 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved. 6 * 7 * Thanks to the following companies for their support: 8 * 9 * - JMicron (hardware and technical support) 10 */ 11 12 #include <linux/bitfield.h> 13 #include <linux/delay.h> 14 #include <linux/dmaengine.h> 15 #include <linux/ktime.h> 16 #include <linux/highmem.h> 17 #include <linux/io.h> 18 #include <linux/module.h> 19 #include <linux/dma-mapping.h> 20 #include <linux/slab.h> 21 #include <linux/scatterlist.h> 22 #include <linux/sizes.h> 23 #include <linux/regulator/consumer.h> 24 #include <linux/pm_runtime.h> 25 #include <linux/of.h> 26 27 #include <linux/leds.h> 28 29 #include <linux/mmc/mmc.h> 30 #include <linux/mmc/host.h> 31 #include <linux/mmc/card.h> 32 #include <linux/mmc/sdio.h> 33 #include <linux/mmc/slot-gpio.h> 34 35 #include "sdhci.h" 36 37 #define DRIVER_NAME "sdhci" 38 39 #define DBG(f, x...) \ 40 pr_debug("%s: " DRIVER_NAME ": " f, mmc_hostname(host->mmc), ## x) 41 42 #define SDHCI_DUMP(f, x...) \ 43 pr_err("%s: " DRIVER_NAME ": " f, mmc_hostname(host->mmc), ## x) 44 45 #define MAX_TUNING_LOOP 40 46 47 static unsigned int debug_quirks = 0; 48 static unsigned int debug_quirks2; 49 50 static void sdhci_enable_preset_value(struct sdhci_host *host, bool enable); 51 52 static bool sdhci_send_command(struct sdhci_host *host, struct mmc_command *cmd); 53 54 void sdhci_dumpregs(struct sdhci_host *host) 55 { 56 SDHCI_DUMP("============ SDHCI REGISTER DUMP ===========\n"); 57 58 SDHCI_DUMP("Sys addr: 0x%08x | Version: 0x%08x\n", 59 sdhci_readl(host, SDHCI_DMA_ADDRESS), 60 sdhci_readw(host, SDHCI_HOST_VERSION)); 61 SDHCI_DUMP("Blk size: 0x%08x | Blk cnt: 0x%08x\n", 62 sdhci_readw(host, SDHCI_BLOCK_SIZE), 63 sdhci_readw(host, SDHCI_BLOCK_COUNT)); 64 SDHCI_DUMP("Argument: 0x%08x | Trn mode: 0x%08x\n", 65 sdhci_readl(host, SDHCI_ARGUMENT), 66 sdhci_readw(host, SDHCI_TRANSFER_MODE)); 67 SDHCI_DUMP("Present: 0x%08x | Host ctl: 0x%08x\n", 68 sdhci_readl(host, SDHCI_PRESENT_STATE), 69 sdhci_readb(host, SDHCI_HOST_CONTROL)); 70 SDHCI_DUMP("Power: 0x%08x | Blk gap: 0x%08x\n", 71 sdhci_readb(host, SDHCI_POWER_CONTROL), 72 sdhci_readb(host, SDHCI_BLOCK_GAP_CONTROL)); 73 SDHCI_DUMP("Wake-up: 0x%08x | Clock: 0x%08x\n", 74 sdhci_readb(host, SDHCI_WAKE_UP_CONTROL), 75 sdhci_readw(host, SDHCI_CLOCK_CONTROL)); 76 SDHCI_DUMP("Timeout: 0x%08x | Int stat: 0x%08x\n", 77 sdhci_readb(host, SDHCI_TIMEOUT_CONTROL), 78 sdhci_readl(host, SDHCI_INT_STATUS)); 79 SDHCI_DUMP("Int enab: 0x%08x | Sig enab: 0x%08x\n", 80 sdhci_readl(host, SDHCI_INT_ENABLE), 81 sdhci_readl(host, SDHCI_SIGNAL_ENABLE)); 82 SDHCI_DUMP("ACmd stat: 0x%08x | Slot int: 0x%08x\n", 83 sdhci_readw(host, SDHCI_AUTO_CMD_STATUS), 84 sdhci_readw(host, SDHCI_SLOT_INT_STATUS)); 85 SDHCI_DUMP("Caps: 0x%08x | Caps_1: 0x%08x\n", 86 sdhci_readl(host, SDHCI_CAPABILITIES), 87 sdhci_readl(host, SDHCI_CAPABILITIES_1)); 88 SDHCI_DUMP("Cmd: 0x%08x | Max curr: 0x%08x\n", 89 sdhci_readw(host, SDHCI_COMMAND), 90 sdhci_readl(host, SDHCI_MAX_CURRENT)); 91 SDHCI_DUMP("Resp[0]: 0x%08x | Resp[1]: 0x%08x\n", 92 sdhci_readl(host, SDHCI_RESPONSE), 93 sdhci_readl(host, SDHCI_RESPONSE + 4)); 94 SDHCI_DUMP("Resp[2]: 0x%08x | Resp[3]: 0x%08x\n", 95 sdhci_readl(host, SDHCI_RESPONSE + 8), 96 sdhci_readl(host, SDHCI_RESPONSE + 12)); 97 SDHCI_DUMP("Host ctl2: 0x%08x\n", 98 sdhci_readw(host, SDHCI_HOST_CONTROL2)); 99 100 if (host->flags & SDHCI_USE_ADMA) { 101 if (host->flags & SDHCI_USE_64_BIT_DMA) { 102 SDHCI_DUMP("ADMA Err: 0x%08x | ADMA Ptr: 0x%08x%08x\n", 103 sdhci_readl(host, SDHCI_ADMA_ERROR), 104 sdhci_readl(host, SDHCI_ADMA_ADDRESS_HI), 105 sdhci_readl(host, SDHCI_ADMA_ADDRESS)); 106 } else { 107 SDHCI_DUMP("ADMA Err: 0x%08x | ADMA Ptr: 0x%08x\n", 108 sdhci_readl(host, SDHCI_ADMA_ERROR), 109 sdhci_readl(host, SDHCI_ADMA_ADDRESS)); 110 } 111 } 112 113 if (host->ops->dump_vendor_regs) 114 host->ops->dump_vendor_regs(host); 115 116 SDHCI_DUMP("============================================\n"); 117 } 118 EXPORT_SYMBOL_GPL(sdhci_dumpregs); 119 120 /*****************************************************************************\ 121 * * 122 * Low level functions * 123 * * 124 \*****************************************************************************/ 125 126 static void sdhci_do_enable_v4_mode(struct sdhci_host *host) 127 { 128 u16 ctrl2; 129 130 ctrl2 = sdhci_readw(host, SDHCI_HOST_CONTROL2); 131 if (ctrl2 & SDHCI_CTRL_V4_MODE) 132 return; 133 134 ctrl2 |= SDHCI_CTRL_V4_MODE; 135 sdhci_writew(host, ctrl2, SDHCI_HOST_CONTROL2); 136 } 137 138 /* 139 * This can be called before sdhci_add_host() by Vendor's host controller 140 * driver to enable v4 mode if supported. 141 */ 142 void sdhci_enable_v4_mode(struct sdhci_host *host) 143 { 144 host->v4_mode = true; 145 sdhci_do_enable_v4_mode(host); 146 } 147 EXPORT_SYMBOL_GPL(sdhci_enable_v4_mode); 148 149 static inline bool sdhci_data_line_cmd(struct mmc_command *cmd) 150 { 151 return cmd->data || cmd->flags & MMC_RSP_BUSY; 152 } 153 154 static void sdhci_set_card_detection(struct sdhci_host *host, bool enable) 155 { 156 u32 present; 157 158 if ((host->quirks & SDHCI_QUIRK_BROKEN_CARD_DETECTION) || 159 !mmc_card_is_removable(host->mmc) || mmc_can_gpio_cd(host->mmc)) 160 return; 161 162 if (enable) { 163 present = sdhci_readl(host, SDHCI_PRESENT_STATE) & 164 SDHCI_CARD_PRESENT; 165 166 host->ier |= present ? SDHCI_INT_CARD_REMOVE : 167 SDHCI_INT_CARD_INSERT; 168 } else { 169 host->ier &= ~(SDHCI_INT_CARD_REMOVE | SDHCI_INT_CARD_INSERT); 170 } 171 172 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 173 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 174 } 175 176 static void sdhci_enable_card_detection(struct sdhci_host *host) 177 { 178 sdhci_set_card_detection(host, true); 179 } 180 181 static void sdhci_disable_card_detection(struct sdhci_host *host) 182 { 183 sdhci_set_card_detection(host, false); 184 } 185 186 static void sdhci_runtime_pm_bus_on(struct sdhci_host *host) 187 { 188 if (host->bus_on) 189 return; 190 host->bus_on = true; 191 pm_runtime_get_noresume(mmc_dev(host->mmc)); 192 } 193 194 static void sdhci_runtime_pm_bus_off(struct sdhci_host *host) 195 { 196 if (!host->bus_on) 197 return; 198 host->bus_on = false; 199 pm_runtime_put_noidle(mmc_dev(host->mmc)); 200 } 201 202 void sdhci_reset(struct sdhci_host *host, u8 mask) 203 { 204 ktime_t timeout; 205 206 sdhci_writeb(host, mask, SDHCI_SOFTWARE_RESET); 207 208 if (mask & SDHCI_RESET_ALL) { 209 host->clock = 0; 210 /* Reset-all turns off SD Bus Power */ 211 if (host->quirks2 & SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON) 212 sdhci_runtime_pm_bus_off(host); 213 } 214 215 /* Wait max 100 ms */ 216 timeout = ktime_add_ms(ktime_get(), 100); 217 218 /* hw clears the bit when it's done */ 219 while (1) { 220 bool timedout = ktime_after(ktime_get(), timeout); 221 222 if (!(sdhci_readb(host, SDHCI_SOFTWARE_RESET) & mask)) 223 break; 224 if (timedout) { 225 pr_err("%s: Reset 0x%x never completed.\n", 226 mmc_hostname(host->mmc), (int)mask); 227 sdhci_err_stats_inc(host, CTRL_TIMEOUT); 228 sdhci_dumpregs(host); 229 return; 230 } 231 udelay(10); 232 } 233 } 234 EXPORT_SYMBOL_GPL(sdhci_reset); 235 236 static void sdhci_do_reset(struct sdhci_host *host, u8 mask) 237 { 238 if (host->quirks & SDHCI_QUIRK_NO_CARD_NO_RESET) { 239 struct mmc_host *mmc = host->mmc; 240 241 if (!mmc->ops->get_cd(mmc)) 242 return; 243 } 244 245 host->ops->reset(host, mask); 246 247 if (mask & SDHCI_RESET_ALL) { 248 if (host->flags & (SDHCI_USE_SDMA | SDHCI_USE_ADMA)) { 249 if (host->ops->enable_dma) 250 host->ops->enable_dma(host); 251 } 252 253 /* Resetting the controller clears many */ 254 host->preset_enabled = false; 255 } 256 } 257 258 static void sdhci_set_default_irqs(struct sdhci_host *host) 259 { 260 host->ier = SDHCI_INT_BUS_POWER | SDHCI_INT_DATA_END_BIT | 261 SDHCI_INT_DATA_CRC | SDHCI_INT_DATA_TIMEOUT | 262 SDHCI_INT_INDEX | SDHCI_INT_END_BIT | SDHCI_INT_CRC | 263 SDHCI_INT_TIMEOUT | SDHCI_INT_DATA_END | 264 SDHCI_INT_RESPONSE; 265 266 if (host->tuning_mode == SDHCI_TUNING_MODE_2 || 267 host->tuning_mode == SDHCI_TUNING_MODE_3) 268 host->ier |= SDHCI_INT_RETUNE; 269 270 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 271 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 272 } 273 274 static void sdhci_config_dma(struct sdhci_host *host) 275 { 276 u8 ctrl; 277 u16 ctrl2; 278 279 if (host->version < SDHCI_SPEC_200) 280 return; 281 282 ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL); 283 284 /* 285 * Always adjust the DMA selection as some controllers 286 * (e.g. JMicron) can't do PIO properly when the selection 287 * is ADMA. 288 */ 289 ctrl &= ~SDHCI_CTRL_DMA_MASK; 290 if (!(host->flags & SDHCI_REQ_USE_DMA)) 291 goto out; 292 293 /* Note if DMA Select is zero then SDMA is selected */ 294 if (host->flags & SDHCI_USE_ADMA) 295 ctrl |= SDHCI_CTRL_ADMA32; 296 297 if (host->flags & SDHCI_USE_64_BIT_DMA) { 298 /* 299 * If v4 mode, all supported DMA can be 64-bit addressing if 300 * controller supports 64-bit system address, otherwise only 301 * ADMA can support 64-bit addressing. 302 */ 303 if (host->v4_mode) { 304 ctrl2 = sdhci_readw(host, SDHCI_HOST_CONTROL2); 305 ctrl2 |= SDHCI_CTRL_64BIT_ADDR; 306 sdhci_writew(host, ctrl2, SDHCI_HOST_CONTROL2); 307 } else if (host->flags & SDHCI_USE_ADMA) { 308 /* 309 * Don't need to undo SDHCI_CTRL_ADMA32 in order to 310 * set SDHCI_CTRL_ADMA64. 311 */ 312 ctrl |= SDHCI_CTRL_ADMA64; 313 } 314 } 315 316 out: 317 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 318 } 319 320 static void sdhci_init(struct sdhci_host *host, int soft) 321 { 322 struct mmc_host *mmc = host->mmc; 323 unsigned long flags; 324 325 if (soft) 326 sdhci_do_reset(host, SDHCI_RESET_CMD | SDHCI_RESET_DATA); 327 else 328 sdhci_do_reset(host, SDHCI_RESET_ALL); 329 330 if (host->v4_mode) 331 sdhci_do_enable_v4_mode(host); 332 333 spin_lock_irqsave(&host->lock, flags); 334 sdhci_set_default_irqs(host); 335 spin_unlock_irqrestore(&host->lock, flags); 336 337 host->cqe_on = false; 338 339 if (soft) { 340 /* force clock reconfiguration */ 341 host->clock = 0; 342 mmc->ops->set_ios(mmc, &mmc->ios); 343 } 344 } 345 346 static void sdhci_reinit(struct sdhci_host *host) 347 { 348 u32 cd = host->ier & (SDHCI_INT_CARD_REMOVE | SDHCI_INT_CARD_INSERT); 349 350 sdhci_init(host, 0); 351 sdhci_enable_card_detection(host); 352 353 /* 354 * A change to the card detect bits indicates a change in present state, 355 * refer sdhci_set_card_detection(). A card detect interrupt might have 356 * been missed while the host controller was being reset, so trigger a 357 * rescan to check. 358 */ 359 if (cd != (host->ier & (SDHCI_INT_CARD_REMOVE | SDHCI_INT_CARD_INSERT))) 360 mmc_detect_change(host->mmc, msecs_to_jiffies(200)); 361 } 362 363 static void __sdhci_led_activate(struct sdhci_host *host) 364 { 365 u8 ctrl; 366 367 if (host->quirks & SDHCI_QUIRK_NO_LED) 368 return; 369 370 ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL); 371 ctrl |= SDHCI_CTRL_LED; 372 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 373 } 374 375 static void __sdhci_led_deactivate(struct sdhci_host *host) 376 { 377 u8 ctrl; 378 379 if (host->quirks & SDHCI_QUIRK_NO_LED) 380 return; 381 382 ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL); 383 ctrl &= ~SDHCI_CTRL_LED; 384 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 385 } 386 387 #if IS_REACHABLE(CONFIG_LEDS_CLASS) 388 static void sdhci_led_control(struct led_classdev *led, 389 enum led_brightness brightness) 390 { 391 struct sdhci_host *host = container_of(led, struct sdhci_host, led); 392 unsigned long flags; 393 394 spin_lock_irqsave(&host->lock, flags); 395 396 if (host->runtime_suspended) 397 goto out; 398 399 if (brightness == LED_OFF) 400 __sdhci_led_deactivate(host); 401 else 402 __sdhci_led_activate(host); 403 out: 404 spin_unlock_irqrestore(&host->lock, flags); 405 } 406 407 static int sdhci_led_register(struct sdhci_host *host) 408 { 409 struct mmc_host *mmc = host->mmc; 410 411 if (host->quirks & SDHCI_QUIRK_NO_LED) 412 return 0; 413 414 snprintf(host->led_name, sizeof(host->led_name), 415 "%s::", mmc_hostname(mmc)); 416 417 host->led.name = host->led_name; 418 host->led.brightness = LED_OFF; 419 host->led.default_trigger = mmc_hostname(mmc); 420 host->led.brightness_set = sdhci_led_control; 421 422 return led_classdev_register(mmc_dev(mmc), &host->led); 423 } 424 425 static void sdhci_led_unregister(struct sdhci_host *host) 426 { 427 if (host->quirks & SDHCI_QUIRK_NO_LED) 428 return; 429 430 led_classdev_unregister(&host->led); 431 } 432 433 static inline void sdhci_led_activate(struct sdhci_host *host) 434 { 435 } 436 437 static inline void sdhci_led_deactivate(struct sdhci_host *host) 438 { 439 } 440 441 #else 442 443 static inline int sdhci_led_register(struct sdhci_host *host) 444 { 445 return 0; 446 } 447 448 static inline void sdhci_led_unregister(struct sdhci_host *host) 449 { 450 } 451 452 static inline void sdhci_led_activate(struct sdhci_host *host) 453 { 454 __sdhci_led_activate(host); 455 } 456 457 static inline void sdhci_led_deactivate(struct sdhci_host *host) 458 { 459 __sdhci_led_deactivate(host); 460 } 461 462 #endif 463 464 static void sdhci_mod_timer(struct sdhci_host *host, struct mmc_request *mrq, 465 unsigned long timeout) 466 { 467 if (sdhci_data_line_cmd(mrq->cmd)) 468 mod_timer(&host->data_timer, timeout); 469 else 470 mod_timer(&host->timer, timeout); 471 } 472 473 static void sdhci_del_timer(struct sdhci_host *host, struct mmc_request *mrq) 474 { 475 if (sdhci_data_line_cmd(mrq->cmd)) 476 del_timer(&host->data_timer); 477 else 478 del_timer(&host->timer); 479 } 480 481 static inline bool sdhci_has_requests(struct sdhci_host *host) 482 { 483 return host->cmd || host->data_cmd; 484 } 485 486 /*****************************************************************************\ 487 * * 488 * Core functions * 489 * * 490 \*****************************************************************************/ 491 492 static void sdhci_read_block_pio(struct sdhci_host *host) 493 { 494 unsigned long flags; 495 size_t blksize, len, chunk; 496 u32 scratch; 497 u8 *buf; 498 499 DBG("PIO reading\n"); 500 501 blksize = host->data->blksz; 502 chunk = 0; 503 504 local_irq_save(flags); 505 506 while (blksize) { 507 BUG_ON(!sg_miter_next(&host->sg_miter)); 508 509 len = min(host->sg_miter.length, blksize); 510 511 blksize -= len; 512 host->sg_miter.consumed = len; 513 514 buf = host->sg_miter.addr; 515 516 while (len) { 517 if (chunk == 0) { 518 scratch = sdhci_readl(host, SDHCI_BUFFER); 519 chunk = 4; 520 } 521 522 *buf = scratch & 0xFF; 523 524 buf++; 525 scratch >>= 8; 526 chunk--; 527 len--; 528 } 529 } 530 531 sg_miter_stop(&host->sg_miter); 532 533 local_irq_restore(flags); 534 } 535 536 static void sdhci_write_block_pio(struct sdhci_host *host) 537 { 538 unsigned long flags; 539 size_t blksize, len, chunk; 540 u32 scratch; 541 u8 *buf; 542 543 DBG("PIO writing\n"); 544 545 blksize = host->data->blksz; 546 chunk = 0; 547 scratch = 0; 548 549 local_irq_save(flags); 550 551 while (blksize) { 552 BUG_ON(!sg_miter_next(&host->sg_miter)); 553 554 len = min(host->sg_miter.length, blksize); 555 556 blksize -= len; 557 host->sg_miter.consumed = len; 558 559 buf = host->sg_miter.addr; 560 561 while (len) { 562 scratch |= (u32)*buf << (chunk * 8); 563 564 buf++; 565 chunk++; 566 len--; 567 568 if ((chunk == 4) || ((len == 0) && (blksize == 0))) { 569 sdhci_writel(host, scratch, SDHCI_BUFFER); 570 chunk = 0; 571 scratch = 0; 572 } 573 } 574 } 575 576 sg_miter_stop(&host->sg_miter); 577 578 local_irq_restore(flags); 579 } 580 581 static void sdhci_transfer_pio(struct sdhci_host *host) 582 { 583 u32 mask; 584 585 if (host->blocks == 0) 586 return; 587 588 if (host->data->flags & MMC_DATA_READ) 589 mask = SDHCI_DATA_AVAILABLE; 590 else 591 mask = SDHCI_SPACE_AVAILABLE; 592 593 /* 594 * Some controllers (JMicron JMB38x) mess up the buffer bits 595 * for transfers < 4 bytes. As long as it is just one block, 596 * we can ignore the bits. 597 */ 598 if ((host->quirks & SDHCI_QUIRK_BROKEN_SMALL_PIO) && 599 (host->data->blocks == 1)) 600 mask = ~0; 601 602 while (sdhci_readl(host, SDHCI_PRESENT_STATE) & mask) { 603 if (host->quirks & SDHCI_QUIRK_PIO_NEEDS_DELAY) 604 udelay(100); 605 606 if (host->data->flags & MMC_DATA_READ) 607 sdhci_read_block_pio(host); 608 else 609 sdhci_write_block_pio(host); 610 611 host->blocks--; 612 if (host->blocks == 0) 613 break; 614 } 615 616 DBG("PIO transfer complete.\n"); 617 } 618 619 static int sdhci_pre_dma_transfer(struct sdhci_host *host, 620 struct mmc_data *data, int cookie) 621 { 622 int sg_count; 623 624 /* 625 * If the data buffers are already mapped, return the previous 626 * dma_map_sg() result. 627 */ 628 if (data->host_cookie == COOKIE_PRE_MAPPED) 629 return data->sg_count; 630 631 /* Bounce write requests to the bounce buffer */ 632 if (host->bounce_buffer) { 633 unsigned int length = data->blksz * data->blocks; 634 635 if (length > host->bounce_buffer_size) { 636 pr_err("%s: asked for transfer of %u bytes exceeds bounce buffer %u bytes\n", 637 mmc_hostname(host->mmc), length, 638 host->bounce_buffer_size); 639 return -EIO; 640 } 641 if (mmc_get_dma_dir(data) == DMA_TO_DEVICE) { 642 /* Copy the data to the bounce buffer */ 643 if (host->ops->copy_to_bounce_buffer) { 644 host->ops->copy_to_bounce_buffer(host, 645 data, length); 646 } else { 647 sg_copy_to_buffer(data->sg, data->sg_len, 648 host->bounce_buffer, length); 649 } 650 } 651 /* Switch ownership to the DMA */ 652 dma_sync_single_for_device(mmc_dev(host->mmc), 653 host->bounce_addr, 654 host->bounce_buffer_size, 655 mmc_get_dma_dir(data)); 656 /* Just a dummy value */ 657 sg_count = 1; 658 } else { 659 /* Just access the data directly from memory */ 660 sg_count = dma_map_sg(mmc_dev(host->mmc), 661 data->sg, data->sg_len, 662 mmc_get_dma_dir(data)); 663 } 664 665 if (sg_count == 0) 666 return -ENOSPC; 667 668 data->sg_count = sg_count; 669 data->host_cookie = cookie; 670 671 return sg_count; 672 } 673 674 static char *sdhci_kmap_atomic(struct scatterlist *sg, unsigned long *flags) 675 { 676 local_irq_save(*flags); 677 return kmap_atomic(sg_page(sg)) + sg->offset; 678 } 679 680 static void sdhci_kunmap_atomic(void *buffer, unsigned long *flags) 681 { 682 kunmap_atomic(buffer); 683 local_irq_restore(*flags); 684 } 685 686 void sdhci_adma_write_desc(struct sdhci_host *host, void **desc, 687 dma_addr_t addr, int len, unsigned int cmd) 688 { 689 struct sdhci_adma2_64_desc *dma_desc = *desc; 690 691 /* 32-bit and 64-bit descriptors have these members in same position */ 692 dma_desc->cmd = cpu_to_le16(cmd); 693 dma_desc->len = cpu_to_le16(len); 694 dma_desc->addr_lo = cpu_to_le32(lower_32_bits(addr)); 695 696 if (host->flags & SDHCI_USE_64_BIT_DMA) 697 dma_desc->addr_hi = cpu_to_le32(upper_32_bits(addr)); 698 699 *desc += host->desc_sz; 700 } 701 EXPORT_SYMBOL_GPL(sdhci_adma_write_desc); 702 703 static inline void __sdhci_adma_write_desc(struct sdhci_host *host, 704 void **desc, dma_addr_t addr, 705 int len, unsigned int cmd) 706 { 707 if (host->ops->adma_write_desc) 708 host->ops->adma_write_desc(host, desc, addr, len, cmd); 709 else 710 sdhci_adma_write_desc(host, desc, addr, len, cmd); 711 } 712 713 static void sdhci_adma_mark_end(void *desc) 714 { 715 struct sdhci_adma2_64_desc *dma_desc = desc; 716 717 /* 32-bit and 64-bit descriptors have 'cmd' in same position */ 718 dma_desc->cmd |= cpu_to_le16(ADMA2_END); 719 } 720 721 static void sdhci_adma_table_pre(struct sdhci_host *host, 722 struct mmc_data *data, int sg_count) 723 { 724 struct scatterlist *sg; 725 unsigned long flags; 726 dma_addr_t addr, align_addr; 727 void *desc, *align; 728 char *buffer; 729 int len, offset, i; 730 731 /* 732 * The spec does not specify endianness of descriptor table. 733 * We currently guess that it is LE. 734 */ 735 736 host->sg_count = sg_count; 737 738 desc = host->adma_table; 739 align = host->align_buffer; 740 741 align_addr = host->align_addr; 742 743 for_each_sg(data->sg, sg, host->sg_count, i) { 744 addr = sg_dma_address(sg); 745 len = sg_dma_len(sg); 746 747 /* 748 * The SDHCI specification states that ADMA addresses must 749 * be 32-bit aligned. If they aren't, then we use a bounce 750 * buffer for the (up to three) bytes that screw up the 751 * alignment. 752 */ 753 offset = (SDHCI_ADMA2_ALIGN - (addr & SDHCI_ADMA2_MASK)) & 754 SDHCI_ADMA2_MASK; 755 if (offset) { 756 if (data->flags & MMC_DATA_WRITE) { 757 buffer = sdhci_kmap_atomic(sg, &flags); 758 memcpy(align, buffer, offset); 759 sdhci_kunmap_atomic(buffer, &flags); 760 } 761 762 /* tran, valid */ 763 __sdhci_adma_write_desc(host, &desc, align_addr, 764 offset, ADMA2_TRAN_VALID); 765 766 BUG_ON(offset > 65536); 767 768 align += SDHCI_ADMA2_ALIGN; 769 align_addr += SDHCI_ADMA2_ALIGN; 770 771 addr += offset; 772 len -= offset; 773 } 774 775 /* 776 * The block layer forces a minimum segment size of PAGE_SIZE, 777 * so 'len' can be too big here if PAGE_SIZE >= 64KiB. Write 778 * multiple descriptors, noting that the ADMA table is sized 779 * for 4KiB chunks anyway, so it will be big enough. 780 */ 781 while (len > host->max_adma) { 782 int n = 32 * 1024; /* 32KiB*/ 783 784 __sdhci_adma_write_desc(host, &desc, addr, n, ADMA2_TRAN_VALID); 785 addr += n; 786 len -= n; 787 } 788 789 /* tran, valid */ 790 if (len) 791 __sdhci_adma_write_desc(host, &desc, addr, len, 792 ADMA2_TRAN_VALID); 793 794 /* 795 * If this triggers then we have a calculation bug 796 * somewhere. :/ 797 */ 798 WARN_ON((desc - host->adma_table) >= host->adma_table_sz); 799 } 800 801 if (host->quirks & SDHCI_QUIRK_NO_ENDATTR_IN_NOPDESC) { 802 /* Mark the last descriptor as the terminating descriptor */ 803 if (desc != host->adma_table) { 804 desc -= host->desc_sz; 805 sdhci_adma_mark_end(desc); 806 } 807 } else { 808 /* Add a terminating entry - nop, end, valid */ 809 __sdhci_adma_write_desc(host, &desc, 0, 0, ADMA2_NOP_END_VALID); 810 } 811 } 812 813 static void sdhci_adma_table_post(struct sdhci_host *host, 814 struct mmc_data *data) 815 { 816 struct scatterlist *sg; 817 int i, size; 818 void *align; 819 char *buffer; 820 unsigned long flags; 821 822 if (data->flags & MMC_DATA_READ) { 823 bool has_unaligned = false; 824 825 /* Do a quick scan of the SG list for any unaligned mappings */ 826 for_each_sg(data->sg, sg, host->sg_count, i) 827 if (sg_dma_address(sg) & SDHCI_ADMA2_MASK) { 828 has_unaligned = true; 829 break; 830 } 831 832 if (has_unaligned) { 833 dma_sync_sg_for_cpu(mmc_dev(host->mmc), data->sg, 834 data->sg_len, DMA_FROM_DEVICE); 835 836 align = host->align_buffer; 837 838 for_each_sg(data->sg, sg, host->sg_count, i) { 839 if (sg_dma_address(sg) & SDHCI_ADMA2_MASK) { 840 size = SDHCI_ADMA2_ALIGN - 841 (sg_dma_address(sg) & SDHCI_ADMA2_MASK); 842 843 buffer = sdhci_kmap_atomic(sg, &flags); 844 memcpy(buffer, align, size); 845 sdhci_kunmap_atomic(buffer, &flags); 846 847 align += SDHCI_ADMA2_ALIGN; 848 } 849 } 850 } 851 } 852 } 853 854 static void sdhci_set_adma_addr(struct sdhci_host *host, dma_addr_t addr) 855 { 856 sdhci_writel(host, lower_32_bits(addr), SDHCI_ADMA_ADDRESS); 857 if (host->flags & SDHCI_USE_64_BIT_DMA) 858 sdhci_writel(host, upper_32_bits(addr), SDHCI_ADMA_ADDRESS_HI); 859 } 860 861 static dma_addr_t sdhci_sdma_address(struct sdhci_host *host) 862 { 863 if (host->bounce_buffer) 864 return host->bounce_addr; 865 else 866 return sg_dma_address(host->data->sg); 867 } 868 869 static void sdhci_set_sdma_addr(struct sdhci_host *host, dma_addr_t addr) 870 { 871 if (host->v4_mode) 872 sdhci_set_adma_addr(host, addr); 873 else 874 sdhci_writel(host, addr, SDHCI_DMA_ADDRESS); 875 } 876 877 static unsigned int sdhci_target_timeout(struct sdhci_host *host, 878 struct mmc_command *cmd, 879 struct mmc_data *data) 880 { 881 unsigned int target_timeout; 882 883 /* timeout in us */ 884 if (!data) { 885 target_timeout = cmd->busy_timeout * 1000; 886 } else { 887 target_timeout = DIV_ROUND_UP(data->timeout_ns, 1000); 888 if (host->clock && data->timeout_clks) { 889 unsigned long long val; 890 891 /* 892 * data->timeout_clks is in units of clock cycles. 893 * host->clock is in Hz. target_timeout is in us. 894 * Hence, us = 1000000 * cycles / Hz. Round up. 895 */ 896 val = 1000000ULL * data->timeout_clks; 897 if (do_div(val, host->clock)) 898 target_timeout++; 899 target_timeout += val; 900 } 901 } 902 903 return target_timeout; 904 } 905 906 static void sdhci_calc_sw_timeout(struct sdhci_host *host, 907 struct mmc_command *cmd) 908 { 909 struct mmc_data *data = cmd->data; 910 struct mmc_host *mmc = host->mmc; 911 struct mmc_ios *ios = &mmc->ios; 912 unsigned char bus_width = 1 << ios->bus_width; 913 unsigned int blksz; 914 unsigned int freq; 915 u64 target_timeout; 916 u64 transfer_time; 917 918 target_timeout = sdhci_target_timeout(host, cmd, data); 919 target_timeout *= NSEC_PER_USEC; 920 921 if (data) { 922 blksz = data->blksz; 923 freq = mmc->actual_clock ? : host->clock; 924 transfer_time = (u64)blksz * NSEC_PER_SEC * (8 / bus_width); 925 do_div(transfer_time, freq); 926 /* multiply by '2' to account for any unknowns */ 927 transfer_time = transfer_time * 2; 928 /* calculate timeout for the entire data */ 929 host->data_timeout = data->blocks * target_timeout + 930 transfer_time; 931 } else { 932 host->data_timeout = target_timeout; 933 } 934 935 if (host->data_timeout) 936 host->data_timeout += MMC_CMD_TRANSFER_TIME; 937 } 938 939 static u8 sdhci_calc_timeout(struct sdhci_host *host, struct mmc_command *cmd, 940 bool *too_big) 941 { 942 u8 count; 943 struct mmc_data *data; 944 unsigned target_timeout, current_timeout; 945 946 *too_big = false; 947 948 /* 949 * If the host controller provides us with an incorrect timeout 950 * value, just skip the check and use the maximum. The hardware may take 951 * longer to time out, but that's much better than having a too-short 952 * timeout value. 953 */ 954 if (host->quirks & SDHCI_QUIRK_BROKEN_TIMEOUT_VAL) 955 return host->max_timeout_count; 956 957 /* Unspecified command, assume max */ 958 if (cmd == NULL) 959 return host->max_timeout_count; 960 961 data = cmd->data; 962 /* Unspecified timeout, assume max */ 963 if (!data && !cmd->busy_timeout) 964 return host->max_timeout_count; 965 966 /* timeout in us */ 967 target_timeout = sdhci_target_timeout(host, cmd, data); 968 969 /* 970 * Figure out needed cycles. 971 * We do this in steps in order to fit inside a 32 bit int. 972 * The first step is the minimum timeout, which will have a 973 * minimum resolution of 6 bits: 974 * (1) 2^13*1000 > 2^22, 975 * (2) host->timeout_clk < 2^16 976 * => 977 * (1) / (2) > 2^6 978 */ 979 count = 0; 980 current_timeout = (1 << 13) * 1000 / host->timeout_clk; 981 while (current_timeout < target_timeout) { 982 count++; 983 current_timeout <<= 1; 984 if (count > host->max_timeout_count) { 985 if (!(host->quirks2 & SDHCI_QUIRK2_DISABLE_HW_TIMEOUT)) 986 DBG("Too large timeout 0x%x requested for CMD%d!\n", 987 count, cmd->opcode); 988 count = host->max_timeout_count; 989 *too_big = true; 990 break; 991 } 992 } 993 994 return count; 995 } 996 997 static void sdhci_set_transfer_irqs(struct sdhci_host *host) 998 { 999 u32 pio_irqs = SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL; 1000 u32 dma_irqs = SDHCI_INT_DMA_END | SDHCI_INT_ADMA_ERROR; 1001 1002 if (host->flags & SDHCI_REQ_USE_DMA) 1003 host->ier = (host->ier & ~pio_irqs) | dma_irqs; 1004 else 1005 host->ier = (host->ier & ~dma_irqs) | pio_irqs; 1006 1007 if (host->flags & (SDHCI_AUTO_CMD23 | SDHCI_AUTO_CMD12)) 1008 host->ier |= SDHCI_INT_AUTO_CMD_ERR; 1009 else 1010 host->ier &= ~SDHCI_INT_AUTO_CMD_ERR; 1011 1012 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 1013 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 1014 } 1015 1016 void sdhci_set_data_timeout_irq(struct sdhci_host *host, bool enable) 1017 { 1018 if (enable) 1019 host->ier |= SDHCI_INT_DATA_TIMEOUT; 1020 else 1021 host->ier &= ~SDHCI_INT_DATA_TIMEOUT; 1022 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 1023 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 1024 } 1025 EXPORT_SYMBOL_GPL(sdhci_set_data_timeout_irq); 1026 1027 void __sdhci_set_timeout(struct sdhci_host *host, struct mmc_command *cmd) 1028 { 1029 bool too_big = false; 1030 u8 count = sdhci_calc_timeout(host, cmd, &too_big); 1031 1032 if (too_big && 1033 host->quirks2 & SDHCI_QUIRK2_DISABLE_HW_TIMEOUT) { 1034 sdhci_calc_sw_timeout(host, cmd); 1035 sdhci_set_data_timeout_irq(host, false); 1036 } else if (!(host->ier & SDHCI_INT_DATA_TIMEOUT)) { 1037 sdhci_set_data_timeout_irq(host, true); 1038 } 1039 1040 sdhci_writeb(host, count, SDHCI_TIMEOUT_CONTROL); 1041 } 1042 EXPORT_SYMBOL_GPL(__sdhci_set_timeout); 1043 1044 static void sdhci_set_timeout(struct sdhci_host *host, struct mmc_command *cmd) 1045 { 1046 if (host->ops->set_timeout) 1047 host->ops->set_timeout(host, cmd); 1048 else 1049 __sdhci_set_timeout(host, cmd); 1050 } 1051 1052 static void sdhci_initialize_data(struct sdhci_host *host, 1053 struct mmc_data *data) 1054 { 1055 WARN_ON(host->data); 1056 1057 /* Sanity checks */ 1058 BUG_ON(data->blksz * data->blocks > 524288); 1059 BUG_ON(data->blksz > host->mmc->max_blk_size); 1060 BUG_ON(data->blocks > 65535); 1061 1062 host->data = data; 1063 host->data_early = 0; 1064 host->data->bytes_xfered = 0; 1065 } 1066 1067 static inline void sdhci_set_block_info(struct sdhci_host *host, 1068 struct mmc_data *data) 1069 { 1070 /* Set the DMA boundary value and block size */ 1071 sdhci_writew(host, 1072 SDHCI_MAKE_BLKSZ(host->sdma_boundary, data->blksz), 1073 SDHCI_BLOCK_SIZE); 1074 /* 1075 * For Version 4.10 onwards, if v4 mode is enabled, 32-bit Block Count 1076 * can be supported, in that case 16-bit block count register must be 0. 1077 */ 1078 if (host->version >= SDHCI_SPEC_410 && host->v4_mode && 1079 (host->quirks2 & SDHCI_QUIRK2_USE_32BIT_BLK_CNT)) { 1080 if (sdhci_readw(host, SDHCI_BLOCK_COUNT)) 1081 sdhci_writew(host, 0, SDHCI_BLOCK_COUNT); 1082 sdhci_writew(host, data->blocks, SDHCI_32BIT_BLK_CNT); 1083 } else { 1084 sdhci_writew(host, data->blocks, SDHCI_BLOCK_COUNT); 1085 } 1086 } 1087 1088 static void sdhci_prepare_data(struct sdhci_host *host, struct mmc_command *cmd) 1089 { 1090 struct mmc_data *data = cmd->data; 1091 1092 sdhci_initialize_data(host, data); 1093 1094 if (host->flags & (SDHCI_USE_SDMA | SDHCI_USE_ADMA)) { 1095 struct scatterlist *sg; 1096 unsigned int length_mask, offset_mask; 1097 int i; 1098 1099 host->flags |= SDHCI_REQ_USE_DMA; 1100 1101 /* 1102 * FIXME: This doesn't account for merging when mapping the 1103 * scatterlist. 1104 * 1105 * The assumption here being that alignment and lengths are 1106 * the same after DMA mapping to device address space. 1107 */ 1108 length_mask = 0; 1109 offset_mask = 0; 1110 if (host->flags & SDHCI_USE_ADMA) { 1111 if (host->quirks & SDHCI_QUIRK_32BIT_ADMA_SIZE) { 1112 length_mask = 3; 1113 /* 1114 * As we use up to 3 byte chunks to work 1115 * around alignment problems, we need to 1116 * check the offset as well. 1117 */ 1118 offset_mask = 3; 1119 } 1120 } else { 1121 if (host->quirks & SDHCI_QUIRK_32BIT_DMA_SIZE) 1122 length_mask = 3; 1123 if (host->quirks & SDHCI_QUIRK_32BIT_DMA_ADDR) 1124 offset_mask = 3; 1125 } 1126 1127 if (unlikely(length_mask | offset_mask)) { 1128 for_each_sg(data->sg, sg, data->sg_len, i) { 1129 if (sg->length & length_mask) { 1130 DBG("Reverting to PIO because of transfer size (%d)\n", 1131 sg->length); 1132 host->flags &= ~SDHCI_REQ_USE_DMA; 1133 break; 1134 } 1135 if (sg->offset & offset_mask) { 1136 DBG("Reverting to PIO because of bad alignment\n"); 1137 host->flags &= ~SDHCI_REQ_USE_DMA; 1138 break; 1139 } 1140 } 1141 } 1142 } 1143 1144 if (host->flags & SDHCI_REQ_USE_DMA) { 1145 int sg_cnt = sdhci_pre_dma_transfer(host, data, COOKIE_MAPPED); 1146 1147 if (sg_cnt <= 0) { 1148 /* 1149 * This only happens when someone fed 1150 * us an invalid request. 1151 */ 1152 WARN_ON(1); 1153 host->flags &= ~SDHCI_REQ_USE_DMA; 1154 } else if (host->flags & SDHCI_USE_ADMA) { 1155 sdhci_adma_table_pre(host, data, sg_cnt); 1156 sdhci_set_adma_addr(host, host->adma_addr); 1157 } else { 1158 WARN_ON(sg_cnt != 1); 1159 sdhci_set_sdma_addr(host, sdhci_sdma_address(host)); 1160 } 1161 } 1162 1163 sdhci_config_dma(host); 1164 1165 if (!(host->flags & SDHCI_REQ_USE_DMA)) { 1166 int flags; 1167 1168 flags = SG_MITER_ATOMIC; 1169 if (host->data->flags & MMC_DATA_READ) 1170 flags |= SG_MITER_TO_SG; 1171 else 1172 flags |= SG_MITER_FROM_SG; 1173 sg_miter_start(&host->sg_miter, data->sg, data->sg_len, flags); 1174 host->blocks = data->blocks; 1175 } 1176 1177 sdhci_set_transfer_irqs(host); 1178 1179 sdhci_set_block_info(host, data); 1180 } 1181 1182 #if IS_ENABLED(CONFIG_MMC_SDHCI_EXTERNAL_DMA) 1183 1184 static int sdhci_external_dma_init(struct sdhci_host *host) 1185 { 1186 int ret = 0; 1187 struct mmc_host *mmc = host->mmc; 1188 1189 host->tx_chan = dma_request_chan(mmc_dev(mmc), "tx"); 1190 if (IS_ERR(host->tx_chan)) { 1191 ret = PTR_ERR(host->tx_chan); 1192 if (ret != -EPROBE_DEFER) 1193 pr_warn("Failed to request TX DMA channel.\n"); 1194 host->tx_chan = NULL; 1195 return ret; 1196 } 1197 1198 host->rx_chan = dma_request_chan(mmc_dev(mmc), "rx"); 1199 if (IS_ERR(host->rx_chan)) { 1200 if (host->tx_chan) { 1201 dma_release_channel(host->tx_chan); 1202 host->tx_chan = NULL; 1203 } 1204 1205 ret = PTR_ERR(host->rx_chan); 1206 if (ret != -EPROBE_DEFER) 1207 pr_warn("Failed to request RX DMA channel.\n"); 1208 host->rx_chan = NULL; 1209 } 1210 1211 return ret; 1212 } 1213 1214 static struct dma_chan *sdhci_external_dma_channel(struct sdhci_host *host, 1215 struct mmc_data *data) 1216 { 1217 return data->flags & MMC_DATA_WRITE ? host->tx_chan : host->rx_chan; 1218 } 1219 1220 static int sdhci_external_dma_setup(struct sdhci_host *host, 1221 struct mmc_command *cmd) 1222 { 1223 int ret, i; 1224 enum dma_transfer_direction dir; 1225 struct dma_async_tx_descriptor *desc; 1226 struct mmc_data *data = cmd->data; 1227 struct dma_chan *chan; 1228 struct dma_slave_config cfg; 1229 dma_cookie_t cookie; 1230 int sg_cnt; 1231 1232 if (!host->mapbase) 1233 return -EINVAL; 1234 1235 memset(&cfg, 0, sizeof(cfg)); 1236 cfg.src_addr = host->mapbase + SDHCI_BUFFER; 1237 cfg.dst_addr = host->mapbase + SDHCI_BUFFER; 1238 cfg.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES; 1239 cfg.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES; 1240 cfg.src_maxburst = data->blksz / 4; 1241 cfg.dst_maxburst = data->blksz / 4; 1242 1243 /* Sanity check: all the SG entries must be aligned by block size. */ 1244 for (i = 0; i < data->sg_len; i++) { 1245 if ((data->sg + i)->length % data->blksz) 1246 return -EINVAL; 1247 } 1248 1249 chan = sdhci_external_dma_channel(host, data); 1250 1251 ret = dmaengine_slave_config(chan, &cfg); 1252 if (ret) 1253 return ret; 1254 1255 sg_cnt = sdhci_pre_dma_transfer(host, data, COOKIE_MAPPED); 1256 if (sg_cnt <= 0) 1257 return -EINVAL; 1258 1259 dir = data->flags & MMC_DATA_WRITE ? DMA_MEM_TO_DEV : DMA_DEV_TO_MEM; 1260 desc = dmaengine_prep_slave_sg(chan, data->sg, data->sg_len, dir, 1261 DMA_PREP_INTERRUPT | DMA_CTRL_ACK); 1262 if (!desc) 1263 return -EINVAL; 1264 1265 desc->callback = NULL; 1266 desc->callback_param = NULL; 1267 1268 cookie = dmaengine_submit(desc); 1269 if (dma_submit_error(cookie)) 1270 ret = cookie; 1271 1272 return ret; 1273 } 1274 1275 static void sdhci_external_dma_release(struct sdhci_host *host) 1276 { 1277 if (host->tx_chan) { 1278 dma_release_channel(host->tx_chan); 1279 host->tx_chan = NULL; 1280 } 1281 1282 if (host->rx_chan) { 1283 dma_release_channel(host->rx_chan); 1284 host->rx_chan = NULL; 1285 } 1286 1287 sdhci_switch_external_dma(host, false); 1288 } 1289 1290 static void __sdhci_external_dma_prepare_data(struct sdhci_host *host, 1291 struct mmc_command *cmd) 1292 { 1293 struct mmc_data *data = cmd->data; 1294 1295 sdhci_initialize_data(host, data); 1296 1297 host->flags |= SDHCI_REQ_USE_DMA; 1298 sdhci_set_transfer_irqs(host); 1299 1300 sdhci_set_block_info(host, data); 1301 } 1302 1303 static void sdhci_external_dma_prepare_data(struct sdhci_host *host, 1304 struct mmc_command *cmd) 1305 { 1306 if (!sdhci_external_dma_setup(host, cmd)) { 1307 __sdhci_external_dma_prepare_data(host, cmd); 1308 } else { 1309 sdhci_external_dma_release(host); 1310 pr_err("%s: Cannot use external DMA, switch to the DMA/PIO which standard SDHCI provides.\n", 1311 mmc_hostname(host->mmc)); 1312 sdhci_prepare_data(host, cmd); 1313 } 1314 } 1315 1316 static void sdhci_external_dma_pre_transfer(struct sdhci_host *host, 1317 struct mmc_command *cmd) 1318 { 1319 struct dma_chan *chan; 1320 1321 if (!cmd->data) 1322 return; 1323 1324 chan = sdhci_external_dma_channel(host, cmd->data); 1325 if (chan) 1326 dma_async_issue_pending(chan); 1327 } 1328 1329 #else 1330 1331 static inline int sdhci_external_dma_init(struct sdhci_host *host) 1332 { 1333 return -EOPNOTSUPP; 1334 } 1335 1336 static inline void sdhci_external_dma_release(struct sdhci_host *host) 1337 { 1338 } 1339 1340 static inline void sdhci_external_dma_prepare_data(struct sdhci_host *host, 1341 struct mmc_command *cmd) 1342 { 1343 /* This should never happen */ 1344 WARN_ON_ONCE(1); 1345 } 1346 1347 static inline void sdhci_external_dma_pre_transfer(struct sdhci_host *host, 1348 struct mmc_command *cmd) 1349 { 1350 } 1351 1352 static inline struct dma_chan *sdhci_external_dma_channel(struct sdhci_host *host, 1353 struct mmc_data *data) 1354 { 1355 return NULL; 1356 } 1357 1358 #endif 1359 1360 void sdhci_switch_external_dma(struct sdhci_host *host, bool en) 1361 { 1362 host->use_external_dma = en; 1363 } 1364 EXPORT_SYMBOL_GPL(sdhci_switch_external_dma); 1365 1366 static inline bool sdhci_auto_cmd12(struct sdhci_host *host, 1367 struct mmc_request *mrq) 1368 { 1369 return !mrq->sbc && (host->flags & SDHCI_AUTO_CMD12) && 1370 !mrq->cap_cmd_during_tfr; 1371 } 1372 1373 static inline bool sdhci_auto_cmd23(struct sdhci_host *host, 1374 struct mmc_request *mrq) 1375 { 1376 return mrq->sbc && (host->flags & SDHCI_AUTO_CMD23); 1377 } 1378 1379 static inline bool sdhci_manual_cmd23(struct sdhci_host *host, 1380 struct mmc_request *mrq) 1381 { 1382 return mrq->sbc && !(host->flags & SDHCI_AUTO_CMD23); 1383 } 1384 1385 static inline void sdhci_auto_cmd_select(struct sdhci_host *host, 1386 struct mmc_command *cmd, 1387 u16 *mode) 1388 { 1389 bool use_cmd12 = sdhci_auto_cmd12(host, cmd->mrq) && 1390 (cmd->opcode != SD_IO_RW_EXTENDED); 1391 bool use_cmd23 = sdhci_auto_cmd23(host, cmd->mrq); 1392 u16 ctrl2; 1393 1394 /* 1395 * In case of Version 4.10 or later, use of 'Auto CMD Auto 1396 * Select' is recommended rather than use of 'Auto CMD12 1397 * Enable' or 'Auto CMD23 Enable'. We require Version 4 Mode 1398 * here because some controllers (e.g sdhci-of-dwmshc) expect it. 1399 */ 1400 if (host->version >= SDHCI_SPEC_410 && host->v4_mode && 1401 (use_cmd12 || use_cmd23)) { 1402 *mode |= SDHCI_TRNS_AUTO_SEL; 1403 1404 ctrl2 = sdhci_readw(host, SDHCI_HOST_CONTROL2); 1405 if (use_cmd23) 1406 ctrl2 |= SDHCI_CMD23_ENABLE; 1407 else 1408 ctrl2 &= ~SDHCI_CMD23_ENABLE; 1409 sdhci_writew(host, ctrl2, SDHCI_HOST_CONTROL2); 1410 1411 return; 1412 } 1413 1414 /* 1415 * If we are sending CMD23, CMD12 never gets sent 1416 * on successful completion (so no Auto-CMD12). 1417 */ 1418 if (use_cmd12) 1419 *mode |= SDHCI_TRNS_AUTO_CMD12; 1420 else if (use_cmd23) 1421 *mode |= SDHCI_TRNS_AUTO_CMD23; 1422 } 1423 1424 static void sdhci_set_transfer_mode(struct sdhci_host *host, 1425 struct mmc_command *cmd) 1426 { 1427 u16 mode = 0; 1428 struct mmc_data *data = cmd->data; 1429 1430 if (data == NULL) { 1431 if (host->quirks2 & 1432 SDHCI_QUIRK2_CLEAR_TRANSFERMODE_REG_BEFORE_CMD) { 1433 /* must not clear SDHCI_TRANSFER_MODE when tuning */ 1434 if (cmd->opcode != MMC_SEND_TUNING_BLOCK_HS200) 1435 sdhci_writew(host, 0x0, SDHCI_TRANSFER_MODE); 1436 } else { 1437 /* clear Auto CMD settings for no data CMDs */ 1438 mode = sdhci_readw(host, SDHCI_TRANSFER_MODE); 1439 sdhci_writew(host, mode & ~(SDHCI_TRNS_AUTO_CMD12 | 1440 SDHCI_TRNS_AUTO_CMD23), SDHCI_TRANSFER_MODE); 1441 } 1442 return; 1443 } 1444 1445 WARN_ON(!host->data); 1446 1447 if (!(host->quirks2 & SDHCI_QUIRK2_SUPPORT_SINGLE)) 1448 mode = SDHCI_TRNS_BLK_CNT_EN; 1449 1450 if (mmc_op_multi(cmd->opcode) || data->blocks > 1) { 1451 mode = SDHCI_TRNS_BLK_CNT_EN | SDHCI_TRNS_MULTI; 1452 sdhci_auto_cmd_select(host, cmd, &mode); 1453 if (sdhci_auto_cmd23(host, cmd->mrq)) 1454 sdhci_writel(host, cmd->mrq->sbc->arg, SDHCI_ARGUMENT2); 1455 } 1456 1457 if (data->flags & MMC_DATA_READ) 1458 mode |= SDHCI_TRNS_READ; 1459 if (host->flags & SDHCI_REQ_USE_DMA) 1460 mode |= SDHCI_TRNS_DMA; 1461 1462 sdhci_writew(host, mode, SDHCI_TRANSFER_MODE); 1463 } 1464 1465 static bool sdhci_needs_reset(struct sdhci_host *host, struct mmc_request *mrq) 1466 { 1467 return (!(host->flags & SDHCI_DEVICE_DEAD) && 1468 ((mrq->cmd && mrq->cmd->error) || 1469 (mrq->sbc && mrq->sbc->error) || 1470 (mrq->data && mrq->data->stop && mrq->data->stop->error) || 1471 (host->quirks & SDHCI_QUIRK_RESET_AFTER_REQUEST))); 1472 } 1473 1474 static void sdhci_set_mrq_done(struct sdhci_host *host, struct mmc_request *mrq) 1475 { 1476 int i; 1477 1478 for (i = 0; i < SDHCI_MAX_MRQS; i++) { 1479 if (host->mrqs_done[i] == mrq) { 1480 WARN_ON(1); 1481 return; 1482 } 1483 } 1484 1485 for (i = 0; i < SDHCI_MAX_MRQS; i++) { 1486 if (!host->mrqs_done[i]) { 1487 host->mrqs_done[i] = mrq; 1488 break; 1489 } 1490 } 1491 1492 WARN_ON(i >= SDHCI_MAX_MRQS); 1493 } 1494 1495 static void __sdhci_finish_mrq(struct sdhci_host *host, struct mmc_request *mrq) 1496 { 1497 if (host->cmd && host->cmd->mrq == mrq) 1498 host->cmd = NULL; 1499 1500 if (host->data_cmd && host->data_cmd->mrq == mrq) 1501 host->data_cmd = NULL; 1502 1503 if (host->deferred_cmd && host->deferred_cmd->mrq == mrq) 1504 host->deferred_cmd = NULL; 1505 1506 if (host->data && host->data->mrq == mrq) 1507 host->data = NULL; 1508 1509 if (sdhci_needs_reset(host, mrq)) 1510 host->pending_reset = true; 1511 1512 sdhci_set_mrq_done(host, mrq); 1513 1514 sdhci_del_timer(host, mrq); 1515 1516 if (!sdhci_has_requests(host)) 1517 sdhci_led_deactivate(host); 1518 } 1519 1520 static void sdhci_finish_mrq(struct sdhci_host *host, struct mmc_request *mrq) 1521 { 1522 __sdhci_finish_mrq(host, mrq); 1523 1524 queue_work(host->complete_wq, &host->complete_work); 1525 } 1526 1527 static void __sdhci_finish_data(struct sdhci_host *host, bool sw_data_timeout) 1528 { 1529 struct mmc_command *data_cmd = host->data_cmd; 1530 struct mmc_data *data = host->data; 1531 1532 host->data = NULL; 1533 host->data_cmd = NULL; 1534 1535 /* 1536 * The controller needs a reset of internal state machines upon error 1537 * conditions. 1538 */ 1539 if (data->error) { 1540 if (!host->cmd || host->cmd == data_cmd) 1541 sdhci_do_reset(host, SDHCI_RESET_CMD); 1542 sdhci_do_reset(host, SDHCI_RESET_DATA); 1543 } 1544 1545 if ((host->flags & (SDHCI_REQ_USE_DMA | SDHCI_USE_ADMA)) == 1546 (SDHCI_REQ_USE_DMA | SDHCI_USE_ADMA)) 1547 sdhci_adma_table_post(host, data); 1548 1549 /* 1550 * The specification states that the block count register must 1551 * be updated, but it does not specify at what point in the 1552 * data flow. That makes the register entirely useless to read 1553 * back so we have to assume that nothing made it to the card 1554 * in the event of an error. 1555 */ 1556 if (data->error) 1557 data->bytes_xfered = 0; 1558 else 1559 data->bytes_xfered = data->blksz * data->blocks; 1560 1561 /* 1562 * Need to send CMD12 if - 1563 * a) open-ended multiblock transfer not using auto CMD12 (no CMD23) 1564 * b) error in multiblock transfer 1565 */ 1566 if (data->stop && 1567 ((!data->mrq->sbc && !sdhci_auto_cmd12(host, data->mrq)) || 1568 data->error)) { 1569 /* 1570 * 'cap_cmd_during_tfr' request must not use the command line 1571 * after mmc_command_done() has been called. It is upper layer's 1572 * responsibility to send the stop command if required. 1573 */ 1574 if (data->mrq->cap_cmd_during_tfr) { 1575 __sdhci_finish_mrq(host, data->mrq); 1576 } else { 1577 /* Avoid triggering warning in sdhci_send_command() */ 1578 host->cmd = NULL; 1579 if (!sdhci_send_command(host, data->stop)) { 1580 if (sw_data_timeout) { 1581 /* 1582 * This is anyway a sw data timeout, so 1583 * give up now. 1584 */ 1585 data->stop->error = -EIO; 1586 __sdhci_finish_mrq(host, data->mrq); 1587 } else { 1588 WARN_ON(host->deferred_cmd); 1589 host->deferred_cmd = data->stop; 1590 } 1591 } 1592 } 1593 } else { 1594 __sdhci_finish_mrq(host, data->mrq); 1595 } 1596 } 1597 1598 static void sdhci_finish_data(struct sdhci_host *host) 1599 { 1600 __sdhci_finish_data(host, false); 1601 } 1602 1603 static bool sdhci_send_command(struct sdhci_host *host, struct mmc_command *cmd) 1604 { 1605 int flags; 1606 u32 mask; 1607 unsigned long timeout; 1608 1609 WARN_ON(host->cmd); 1610 1611 /* Initially, a command has no error */ 1612 cmd->error = 0; 1613 1614 if ((host->quirks2 & SDHCI_QUIRK2_STOP_WITH_TC) && 1615 cmd->opcode == MMC_STOP_TRANSMISSION) 1616 cmd->flags |= MMC_RSP_BUSY; 1617 1618 mask = SDHCI_CMD_INHIBIT; 1619 if (sdhci_data_line_cmd(cmd)) 1620 mask |= SDHCI_DATA_INHIBIT; 1621 1622 /* We shouldn't wait for data inihibit for stop commands, even 1623 though they might use busy signaling */ 1624 if (cmd->mrq->data && (cmd == cmd->mrq->data->stop)) 1625 mask &= ~SDHCI_DATA_INHIBIT; 1626 1627 if (sdhci_readl(host, SDHCI_PRESENT_STATE) & mask) 1628 return false; 1629 1630 host->cmd = cmd; 1631 host->data_timeout = 0; 1632 if (sdhci_data_line_cmd(cmd)) { 1633 WARN_ON(host->data_cmd); 1634 host->data_cmd = cmd; 1635 sdhci_set_timeout(host, cmd); 1636 } 1637 1638 if (cmd->data) { 1639 if (host->use_external_dma) 1640 sdhci_external_dma_prepare_data(host, cmd); 1641 else 1642 sdhci_prepare_data(host, cmd); 1643 } 1644 1645 sdhci_writel(host, cmd->arg, SDHCI_ARGUMENT); 1646 1647 sdhci_set_transfer_mode(host, cmd); 1648 1649 if ((cmd->flags & MMC_RSP_136) && (cmd->flags & MMC_RSP_BUSY)) { 1650 WARN_ONCE(1, "Unsupported response type!\n"); 1651 /* 1652 * This does not happen in practice because 136-bit response 1653 * commands never have busy waiting, so rather than complicate 1654 * the error path, just remove busy waiting and continue. 1655 */ 1656 cmd->flags &= ~MMC_RSP_BUSY; 1657 } 1658 1659 if (!(cmd->flags & MMC_RSP_PRESENT)) 1660 flags = SDHCI_CMD_RESP_NONE; 1661 else if (cmd->flags & MMC_RSP_136) 1662 flags = SDHCI_CMD_RESP_LONG; 1663 else if (cmd->flags & MMC_RSP_BUSY) 1664 flags = SDHCI_CMD_RESP_SHORT_BUSY; 1665 else 1666 flags = SDHCI_CMD_RESP_SHORT; 1667 1668 if (cmd->flags & MMC_RSP_CRC) 1669 flags |= SDHCI_CMD_CRC; 1670 if (cmd->flags & MMC_RSP_OPCODE) 1671 flags |= SDHCI_CMD_INDEX; 1672 1673 /* CMD19 is special in that the Data Present Select should be set */ 1674 if (cmd->data || cmd->opcode == MMC_SEND_TUNING_BLOCK || 1675 cmd->opcode == MMC_SEND_TUNING_BLOCK_HS200) 1676 flags |= SDHCI_CMD_DATA; 1677 1678 timeout = jiffies; 1679 if (host->data_timeout) 1680 timeout += nsecs_to_jiffies(host->data_timeout); 1681 else if (!cmd->data && cmd->busy_timeout > 9000) 1682 timeout += DIV_ROUND_UP(cmd->busy_timeout, 1000) * HZ + HZ; 1683 else 1684 timeout += 10 * HZ; 1685 sdhci_mod_timer(host, cmd->mrq, timeout); 1686 1687 if (host->use_external_dma) 1688 sdhci_external_dma_pre_transfer(host, cmd); 1689 1690 sdhci_writew(host, SDHCI_MAKE_CMD(cmd->opcode, flags), SDHCI_COMMAND); 1691 1692 return true; 1693 } 1694 1695 static bool sdhci_present_error(struct sdhci_host *host, 1696 struct mmc_command *cmd, bool present) 1697 { 1698 if (!present || host->flags & SDHCI_DEVICE_DEAD) { 1699 cmd->error = -ENOMEDIUM; 1700 return true; 1701 } 1702 1703 return false; 1704 } 1705 1706 static bool sdhci_send_command_retry(struct sdhci_host *host, 1707 struct mmc_command *cmd, 1708 unsigned long flags) 1709 __releases(host->lock) 1710 __acquires(host->lock) 1711 { 1712 struct mmc_command *deferred_cmd = host->deferred_cmd; 1713 int timeout = 10; /* Approx. 10 ms */ 1714 bool present; 1715 1716 while (!sdhci_send_command(host, cmd)) { 1717 if (!timeout--) { 1718 pr_err("%s: Controller never released inhibit bit(s).\n", 1719 mmc_hostname(host->mmc)); 1720 sdhci_err_stats_inc(host, CTRL_TIMEOUT); 1721 sdhci_dumpregs(host); 1722 cmd->error = -EIO; 1723 return false; 1724 } 1725 1726 spin_unlock_irqrestore(&host->lock, flags); 1727 1728 usleep_range(1000, 1250); 1729 1730 present = host->mmc->ops->get_cd(host->mmc); 1731 1732 spin_lock_irqsave(&host->lock, flags); 1733 1734 /* A deferred command might disappear, handle that */ 1735 if (cmd == deferred_cmd && cmd != host->deferred_cmd) 1736 return true; 1737 1738 if (sdhci_present_error(host, cmd, present)) 1739 return false; 1740 } 1741 1742 if (cmd == host->deferred_cmd) 1743 host->deferred_cmd = NULL; 1744 1745 return true; 1746 } 1747 1748 static void sdhci_read_rsp_136(struct sdhci_host *host, struct mmc_command *cmd) 1749 { 1750 int i, reg; 1751 1752 for (i = 0; i < 4; i++) { 1753 reg = SDHCI_RESPONSE + (3 - i) * 4; 1754 cmd->resp[i] = sdhci_readl(host, reg); 1755 } 1756 1757 if (host->quirks2 & SDHCI_QUIRK2_RSP_136_HAS_CRC) 1758 return; 1759 1760 /* CRC is stripped so we need to do some shifting */ 1761 for (i = 0; i < 4; i++) { 1762 cmd->resp[i] <<= 8; 1763 if (i != 3) 1764 cmd->resp[i] |= cmd->resp[i + 1] >> 24; 1765 } 1766 } 1767 1768 static void sdhci_finish_command(struct sdhci_host *host) 1769 { 1770 struct mmc_command *cmd = host->cmd; 1771 1772 host->cmd = NULL; 1773 1774 if (cmd->flags & MMC_RSP_PRESENT) { 1775 if (cmd->flags & MMC_RSP_136) { 1776 sdhci_read_rsp_136(host, cmd); 1777 } else { 1778 cmd->resp[0] = sdhci_readl(host, SDHCI_RESPONSE); 1779 } 1780 } 1781 1782 if (cmd->mrq->cap_cmd_during_tfr && cmd == cmd->mrq->cmd) 1783 mmc_command_done(host->mmc, cmd->mrq); 1784 1785 /* 1786 * The host can send and interrupt when the busy state has 1787 * ended, allowing us to wait without wasting CPU cycles. 1788 * The busy signal uses DAT0 so this is similar to waiting 1789 * for data to complete. 1790 * 1791 * Note: The 1.0 specification is a bit ambiguous about this 1792 * feature so there might be some problems with older 1793 * controllers. 1794 */ 1795 if (cmd->flags & MMC_RSP_BUSY) { 1796 if (cmd->data) { 1797 DBG("Cannot wait for busy signal when also doing a data transfer"); 1798 } else if (!(host->quirks & SDHCI_QUIRK_NO_BUSY_IRQ) && 1799 cmd == host->data_cmd) { 1800 /* Command complete before busy is ended */ 1801 return; 1802 } 1803 } 1804 1805 /* Finished CMD23, now send actual command. */ 1806 if (cmd == cmd->mrq->sbc) { 1807 if (!sdhci_send_command(host, cmd->mrq->cmd)) { 1808 WARN_ON(host->deferred_cmd); 1809 host->deferred_cmd = cmd->mrq->cmd; 1810 } 1811 } else { 1812 1813 /* Processed actual command. */ 1814 if (host->data && host->data_early) 1815 sdhci_finish_data(host); 1816 1817 if (!cmd->data) 1818 __sdhci_finish_mrq(host, cmd->mrq); 1819 } 1820 } 1821 1822 static u16 sdhci_get_preset_value(struct sdhci_host *host) 1823 { 1824 u16 preset = 0; 1825 1826 switch (host->timing) { 1827 case MMC_TIMING_MMC_HS: 1828 case MMC_TIMING_SD_HS: 1829 preset = sdhci_readw(host, SDHCI_PRESET_FOR_HIGH_SPEED); 1830 break; 1831 case MMC_TIMING_UHS_SDR12: 1832 preset = sdhci_readw(host, SDHCI_PRESET_FOR_SDR12); 1833 break; 1834 case MMC_TIMING_UHS_SDR25: 1835 preset = sdhci_readw(host, SDHCI_PRESET_FOR_SDR25); 1836 break; 1837 case MMC_TIMING_UHS_SDR50: 1838 preset = sdhci_readw(host, SDHCI_PRESET_FOR_SDR50); 1839 break; 1840 case MMC_TIMING_UHS_SDR104: 1841 case MMC_TIMING_MMC_HS200: 1842 preset = sdhci_readw(host, SDHCI_PRESET_FOR_SDR104); 1843 break; 1844 case MMC_TIMING_UHS_DDR50: 1845 case MMC_TIMING_MMC_DDR52: 1846 preset = sdhci_readw(host, SDHCI_PRESET_FOR_DDR50); 1847 break; 1848 case MMC_TIMING_MMC_HS400: 1849 preset = sdhci_readw(host, SDHCI_PRESET_FOR_HS400); 1850 break; 1851 default: 1852 pr_warn("%s: Invalid UHS-I mode selected\n", 1853 mmc_hostname(host->mmc)); 1854 preset = sdhci_readw(host, SDHCI_PRESET_FOR_SDR12); 1855 break; 1856 } 1857 return preset; 1858 } 1859 1860 u16 sdhci_calc_clk(struct sdhci_host *host, unsigned int clock, 1861 unsigned int *actual_clock) 1862 { 1863 int div = 0; /* Initialized for compiler warning */ 1864 int real_div = div, clk_mul = 1; 1865 u16 clk = 0; 1866 bool switch_base_clk = false; 1867 1868 if (host->version >= SDHCI_SPEC_300) { 1869 if (host->preset_enabled) { 1870 u16 pre_val; 1871 1872 clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL); 1873 pre_val = sdhci_get_preset_value(host); 1874 div = FIELD_GET(SDHCI_PRESET_SDCLK_FREQ_MASK, pre_val); 1875 if (host->clk_mul && 1876 (pre_val & SDHCI_PRESET_CLKGEN_SEL)) { 1877 clk = SDHCI_PROG_CLOCK_MODE; 1878 real_div = div + 1; 1879 clk_mul = host->clk_mul; 1880 } else { 1881 real_div = max_t(int, 1, div << 1); 1882 } 1883 goto clock_set; 1884 } 1885 1886 /* 1887 * Check if the Host Controller supports Programmable Clock 1888 * Mode. 1889 */ 1890 if (host->clk_mul) { 1891 for (div = 1; div <= 1024; div++) { 1892 if ((host->max_clk * host->clk_mul / div) 1893 <= clock) 1894 break; 1895 } 1896 if ((host->max_clk * host->clk_mul / div) <= clock) { 1897 /* 1898 * Set Programmable Clock Mode in the Clock 1899 * Control register. 1900 */ 1901 clk = SDHCI_PROG_CLOCK_MODE; 1902 real_div = div; 1903 clk_mul = host->clk_mul; 1904 div--; 1905 } else { 1906 /* 1907 * Divisor can be too small to reach clock 1908 * speed requirement. Then use the base clock. 1909 */ 1910 switch_base_clk = true; 1911 } 1912 } 1913 1914 if (!host->clk_mul || switch_base_clk) { 1915 /* Version 3.00 divisors must be a multiple of 2. */ 1916 if (host->max_clk <= clock) 1917 div = 1; 1918 else { 1919 for (div = 2; div < SDHCI_MAX_DIV_SPEC_300; 1920 div += 2) { 1921 if ((host->max_clk / div) <= clock) 1922 break; 1923 } 1924 } 1925 real_div = div; 1926 div >>= 1; 1927 if ((host->quirks2 & SDHCI_QUIRK2_CLOCK_DIV_ZERO_BROKEN) 1928 && !div && host->max_clk <= 25000000) 1929 div = 1; 1930 } 1931 } else { 1932 /* Version 2.00 divisors must be a power of 2. */ 1933 for (div = 1; div < SDHCI_MAX_DIV_SPEC_200; div *= 2) { 1934 if ((host->max_clk / div) <= clock) 1935 break; 1936 } 1937 real_div = div; 1938 div >>= 1; 1939 } 1940 1941 clock_set: 1942 if (real_div) 1943 *actual_clock = (host->max_clk * clk_mul) / real_div; 1944 clk |= (div & SDHCI_DIV_MASK) << SDHCI_DIVIDER_SHIFT; 1945 clk |= ((div & SDHCI_DIV_HI_MASK) >> SDHCI_DIV_MASK_LEN) 1946 << SDHCI_DIVIDER_HI_SHIFT; 1947 1948 return clk; 1949 } 1950 EXPORT_SYMBOL_GPL(sdhci_calc_clk); 1951 1952 void sdhci_enable_clk(struct sdhci_host *host, u16 clk) 1953 { 1954 ktime_t timeout; 1955 1956 clk |= SDHCI_CLOCK_INT_EN; 1957 sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL); 1958 1959 /* Wait max 150 ms */ 1960 timeout = ktime_add_ms(ktime_get(), 150); 1961 while (1) { 1962 bool timedout = ktime_after(ktime_get(), timeout); 1963 1964 clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL); 1965 if (clk & SDHCI_CLOCK_INT_STABLE) 1966 break; 1967 if (timedout) { 1968 pr_err("%s: Internal clock never stabilised.\n", 1969 mmc_hostname(host->mmc)); 1970 sdhci_err_stats_inc(host, CTRL_TIMEOUT); 1971 sdhci_dumpregs(host); 1972 return; 1973 } 1974 udelay(10); 1975 } 1976 1977 if (host->version >= SDHCI_SPEC_410 && host->v4_mode) { 1978 clk |= SDHCI_CLOCK_PLL_EN; 1979 clk &= ~SDHCI_CLOCK_INT_STABLE; 1980 sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL); 1981 1982 /* Wait max 150 ms */ 1983 timeout = ktime_add_ms(ktime_get(), 150); 1984 while (1) { 1985 bool timedout = ktime_after(ktime_get(), timeout); 1986 1987 clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL); 1988 if (clk & SDHCI_CLOCK_INT_STABLE) 1989 break; 1990 if (timedout) { 1991 pr_err("%s: PLL clock never stabilised.\n", 1992 mmc_hostname(host->mmc)); 1993 sdhci_err_stats_inc(host, CTRL_TIMEOUT); 1994 sdhci_dumpregs(host); 1995 return; 1996 } 1997 udelay(10); 1998 } 1999 } 2000 2001 clk |= SDHCI_CLOCK_CARD_EN; 2002 sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL); 2003 } 2004 EXPORT_SYMBOL_GPL(sdhci_enable_clk); 2005 2006 void sdhci_set_clock(struct sdhci_host *host, unsigned int clock) 2007 { 2008 u16 clk; 2009 2010 host->mmc->actual_clock = 0; 2011 2012 sdhci_writew(host, 0, SDHCI_CLOCK_CONTROL); 2013 2014 if (clock == 0) 2015 return; 2016 2017 clk = sdhci_calc_clk(host, clock, &host->mmc->actual_clock); 2018 sdhci_enable_clk(host, clk); 2019 } 2020 EXPORT_SYMBOL_GPL(sdhci_set_clock); 2021 2022 static void sdhci_set_power_reg(struct sdhci_host *host, unsigned char mode, 2023 unsigned short vdd) 2024 { 2025 struct mmc_host *mmc = host->mmc; 2026 2027 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd); 2028 2029 if (mode != MMC_POWER_OFF) 2030 sdhci_writeb(host, SDHCI_POWER_ON, SDHCI_POWER_CONTROL); 2031 else 2032 sdhci_writeb(host, 0, SDHCI_POWER_CONTROL); 2033 } 2034 2035 void sdhci_set_power_noreg(struct sdhci_host *host, unsigned char mode, 2036 unsigned short vdd) 2037 { 2038 u8 pwr = 0; 2039 2040 if (mode != MMC_POWER_OFF) { 2041 switch (1 << vdd) { 2042 case MMC_VDD_165_195: 2043 /* 2044 * Without a regulator, SDHCI does not support 2.0v 2045 * so we only get here if the driver deliberately 2046 * added the 2.0v range to ocr_avail. Map it to 1.8v 2047 * for the purpose of turning on the power. 2048 */ 2049 case MMC_VDD_20_21: 2050 pwr = SDHCI_POWER_180; 2051 break; 2052 case MMC_VDD_29_30: 2053 case MMC_VDD_30_31: 2054 pwr = SDHCI_POWER_300; 2055 break; 2056 case MMC_VDD_32_33: 2057 case MMC_VDD_33_34: 2058 /* 2059 * 3.4 ~ 3.6V are valid only for those platforms where it's 2060 * known that the voltage range is supported by hardware. 2061 */ 2062 case MMC_VDD_34_35: 2063 case MMC_VDD_35_36: 2064 pwr = SDHCI_POWER_330; 2065 break; 2066 default: 2067 WARN(1, "%s: Invalid vdd %#x\n", 2068 mmc_hostname(host->mmc), vdd); 2069 break; 2070 } 2071 } 2072 2073 if (host->pwr == pwr) 2074 return; 2075 2076 host->pwr = pwr; 2077 2078 if (pwr == 0) { 2079 sdhci_writeb(host, 0, SDHCI_POWER_CONTROL); 2080 if (host->quirks2 & SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON) 2081 sdhci_runtime_pm_bus_off(host); 2082 } else { 2083 /* 2084 * Spec says that we should clear the power reg before setting 2085 * a new value. Some controllers don't seem to like this though. 2086 */ 2087 if (!(host->quirks & SDHCI_QUIRK_SINGLE_POWER_WRITE)) 2088 sdhci_writeb(host, 0, SDHCI_POWER_CONTROL); 2089 2090 /* 2091 * At least the Marvell CaFe chip gets confused if we set the 2092 * voltage and set turn on power at the same time, so set the 2093 * voltage first. 2094 */ 2095 if (host->quirks & SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER) 2096 sdhci_writeb(host, pwr, SDHCI_POWER_CONTROL); 2097 2098 pwr |= SDHCI_POWER_ON; 2099 2100 sdhci_writeb(host, pwr, SDHCI_POWER_CONTROL); 2101 2102 if (host->quirks2 & SDHCI_QUIRK2_CARD_ON_NEEDS_BUS_ON) 2103 sdhci_runtime_pm_bus_on(host); 2104 2105 /* 2106 * Some controllers need an extra 10ms delay of 10ms before 2107 * they can apply clock after applying power 2108 */ 2109 if (host->quirks & SDHCI_QUIRK_DELAY_AFTER_POWER) 2110 mdelay(10); 2111 } 2112 } 2113 EXPORT_SYMBOL_GPL(sdhci_set_power_noreg); 2114 2115 void sdhci_set_power(struct sdhci_host *host, unsigned char mode, 2116 unsigned short vdd) 2117 { 2118 if (IS_ERR(host->mmc->supply.vmmc)) 2119 sdhci_set_power_noreg(host, mode, vdd); 2120 else 2121 sdhci_set_power_reg(host, mode, vdd); 2122 } 2123 EXPORT_SYMBOL_GPL(sdhci_set_power); 2124 2125 /* 2126 * Some controllers need to configure a valid bus voltage on their power 2127 * register regardless of whether an external regulator is taking care of power 2128 * supply. This helper function takes care of it if set as the controller's 2129 * sdhci_ops.set_power callback. 2130 */ 2131 void sdhci_set_power_and_bus_voltage(struct sdhci_host *host, 2132 unsigned char mode, 2133 unsigned short vdd) 2134 { 2135 if (!IS_ERR(host->mmc->supply.vmmc)) { 2136 struct mmc_host *mmc = host->mmc; 2137 2138 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, vdd); 2139 } 2140 sdhci_set_power_noreg(host, mode, vdd); 2141 } 2142 EXPORT_SYMBOL_GPL(sdhci_set_power_and_bus_voltage); 2143 2144 /*****************************************************************************\ 2145 * * 2146 * MMC callbacks * 2147 * * 2148 \*****************************************************************************/ 2149 2150 void sdhci_request(struct mmc_host *mmc, struct mmc_request *mrq) 2151 { 2152 struct sdhci_host *host = mmc_priv(mmc); 2153 struct mmc_command *cmd; 2154 unsigned long flags; 2155 bool present; 2156 2157 /* Firstly check card presence */ 2158 present = mmc->ops->get_cd(mmc); 2159 2160 spin_lock_irqsave(&host->lock, flags); 2161 2162 sdhci_led_activate(host); 2163 2164 if (sdhci_present_error(host, mrq->cmd, present)) 2165 goto out_finish; 2166 2167 cmd = sdhci_manual_cmd23(host, mrq) ? mrq->sbc : mrq->cmd; 2168 2169 if (!sdhci_send_command_retry(host, cmd, flags)) 2170 goto out_finish; 2171 2172 spin_unlock_irqrestore(&host->lock, flags); 2173 2174 return; 2175 2176 out_finish: 2177 sdhci_finish_mrq(host, mrq); 2178 spin_unlock_irqrestore(&host->lock, flags); 2179 } 2180 EXPORT_SYMBOL_GPL(sdhci_request); 2181 2182 int sdhci_request_atomic(struct mmc_host *mmc, struct mmc_request *mrq) 2183 { 2184 struct sdhci_host *host = mmc_priv(mmc); 2185 struct mmc_command *cmd; 2186 unsigned long flags; 2187 int ret = 0; 2188 2189 spin_lock_irqsave(&host->lock, flags); 2190 2191 if (sdhci_present_error(host, mrq->cmd, true)) { 2192 sdhci_finish_mrq(host, mrq); 2193 goto out_finish; 2194 } 2195 2196 cmd = sdhci_manual_cmd23(host, mrq) ? mrq->sbc : mrq->cmd; 2197 2198 /* 2199 * The HSQ may send a command in interrupt context without polling 2200 * the busy signaling, which means we should return BUSY if controller 2201 * has not released inhibit bits to allow HSQ trying to send request 2202 * again in non-atomic context. So we should not finish this request 2203 * here. 2204 */ 2205 if (!sdhci_send_command(host, cmd)) 2206 ret = -EBUSY; 2207 else 2208 sdhci_led_activate(host); 2209 2210 out_finish: 2211 spin_unlock_irqrestore(&host->lock, flags); 2212 return ret; 2213 } 2214 EXPORT_SYMBOL_GPL(sdhci_request_atomic); 2215 2216 void sdhci_set_bus_width(struct sdhci_host *host, int width) 2217 { 2218 u8 ctrl; 2219 2220 ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL); 2221 if (width == MMC_BUS_WIDTH_8) { 2222 ctrl &= ~SDHCI_CTRL_4BITBUS; 2223 ctrl |= SDHCI_CTRL_8BITBUS; 2224 } else { 2225 if (host->mmc->caps & MMC_CAP_8_BIT_DATA) 2226 ctrl &= ~SDHCI_CTRL_8BITBUS; 2227 if (width == MMC_BUS_WIDTH_4) 2228 ctrl |= SDHCI_CTRL_4BITBUS; 2229 else 2230 ctrl &= ~SDHCI_CTRL_4BITBUS; 2231 } 2232 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 2233 } 2234 EXPORT_SYMBOL_GPL(sdhci_set_bus_width); 2235 2236 void sdhci_set_uhs_signaling(struct sdhci_host *host, unsigned timing) 2237 { 2238 u16 ctrl_2; 2239 2240 ctrl_2 = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2241 /* Select Bus Speed Mode for host */ 2242 ctrl_2 &= ~SDHCI_CTRL_UHS_MASK; 2243 if ((timing == MMC_TIMING_MMC_HS200) || 2244 (timing == MMC_TIMING_UHS_SDR104)) 2245 ctrl_2 |= SDHCI_CTRL_UHS_SDR104; 2246 else if (timing == MMC_TIMING_UHS_SDR12) 2247 ctrl_2 |= SDHCI_CTRL_UHS_SDR12; 2248 else if (timing == MMC_TIMING_UHS_SDR25) 2249 ctrl_2 |= SDHCI_CTRL_UHS_SDR25; 2250 else if (timing == MMC_TIMING_UHS_SDR50) 2251 ctrl_2 |= SDHCI_CTRL_UHS_SDR50; 2252 else if ((timing == MMC_TIMING_UHS_DDR50) || 2253 (timing == MMC_TIMING_MMC_DDR52)) 2254 ctrl_2 |= SDHCI_CTRL_UHS_DDR50; 2255 else if (timing == MMC_TIMING_MMC_HS400) 2256 ctrl_2 |= SDHCI_CTRL_HS400; /* Non-standard */ 2257 sdhci_writew(host, ctrl_2, SDHCI_HOST_CONTROL2); 2258 } 2259 EXPORT_SYMBOL_GPL(sdhci_set_uhs_signaling); 2260 2261 void sdhci_set_ios(struct mmc_host *mmc, struct mmc_ios *ios) 2262 { 2263 struct sdhci_host *host = mmc_priv(mmc); 2264 u8 ctrl; 2265 2266 if (ios->power_mode == MMC_POWER_UNDEFINED) 2267 return; 2268 2269 if (host->flags & SDHCI_DEVICE_DEAD) { 2270 if (!IS_ERR(mmc->supply.vmmc) && 2271 ios->power_mode == MMC_POWER_OFF) 2272 mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, 0); 2273 return; 2274 } 2275 2276 /* 2277 * Reset the chip on each power off. 2278 * Should clear out any weird states. 2279 */ 2280 if (ios->power_mode == MMC_POWER_OFF) { 2281 sdhci_writel(host, 0, SDHCI_SIGNAL_ENABLE); 2282 sdhci_reinit(host); 2283 } 2284 2285 if (host->version >= SDHCI_SPEC_300 && 2286 (ios->power_mode == MMC_POWER_UP) && 2287 !(host->quirks2 & SDHCI_QUIRK2_PRESET_VALUE_BROKEN)) 2288 sdhci_enable_preset_value(host, false); 2289 2290 if (!ios->clock || ios->clock != host->clock) { 2291 host->ops->set_clock(host, ios->clock); 2292 host->clock = ios->clock; 2293 2294 if (host->quirks & SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK && 2295 host->clock) { 2296 host->timeout_clk = mmc->actual_clock ? 2297 mmc->actual_clock / 1000 : 2298 host->clock / 1000; 2299 mmc->max_busy_timeout = 2300 host->ops->get_max_timeout_count ? 2301 host->ops->get_max_timeout_count(host) : 2302 1 << 27; 2303 mmc->max_busy_timeout /= host->timeout_clk; 2304 } 2305 } 2306 2307 if (host->ops->set_power) 2308 host->ops->set_power(host, ios->power_mode, ios->vdd); 2309 else 2310 sdhci_set_power(host, ios->power_mode, ios->vdd); 2311 2312 if (host->ops->platform_send_init_74_clocks) 2313 host->ops->platform_send_init_74_clocks(host, ios->power_mode); 2314 2315 host->ops->set_bus_width(host, ios->bus_width); 2316 2317 ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL); 2318 2319 if (!(host->quirks & SDHCI_QUIRK_NO_HISPD_BIT)) { 2320 if (ios->timing == MMC_TIMING_SD_HS || 2321 ios->timing == MMC_TIMING_MMC_HS || 2322 ios->timing == MMC_TIMING_MMC_HS400 || 2323 ios->timing == MMC_TIMING_MMC_HS200 || 2324 ios->timing == MMC_TIMING_MMC_DDR52 || 2325 ios->timing == MMC_TIMING_UHS_SDR50 || 2326 ios->timing == MMC_TIMING_UHS_SDR104 || 2327 ios->timing == MMC_TIMING_UHS_DDR50 || 2328 ios->timing == MMC_TIMING_UHS_SDR25) 2329 ctrl |= SDHCI_CTRL_HISPD; 2330 else 2331 ctrl &= ~SDHCI_CTRL_HISPD; 2332 } 2333 2334 if (host->version >= SDHCI_SPEC_300) { 2335 u16 clk, ctrl_2; 2336 2337 if (!host->preset_enabled) { 2338 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 2339 /* 2340 * We only need to set Driver Strength if the 2341 * preset value enable is not set. 2342 */ 2343 ctrl_2 = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2344 ctrl_2 &= ~SDHCI_CTRL_DRV_TYPE_MASK; 2345 if (ios->drv_type == MMC_SET_DRIVER_TYPE_A) 2346 ctrl_2 |= SDHCI_CTRL_DRV_TYPE_A; 2347 else if (ios->drv_type == MMC_SET_DRIVER_TYPE_B) 2348 ctrl_2 |= SDHCI_CTRL_DRV_TYPE_B; 2349 else if (ios->drv_type == MMC_SET_DRIVER_TYPE_C) 2350 ctrl_2 |= SDHCI_CTRL_DRV_TYPE_C; 2351 else if (ios->drv_type == MMC_SET_DRIVER_TYPE_D) 2352 ctrl_2 |= SDHCI_CTRL_DRV_TYPE_D; 2353 else { 2354 pr_warn("%s: invalid driver type, default to driver type B\n", 2355 mmc_hostname(mmc)); 2356 ctrl_2 |= SDHCI_CTRL_DRV_TYPE_B; 2357 } 2358 2359 sdhci_writew(host, ctrl_2, SDHCI_HOST_CONTROL2); 2360 } else { 2361 /* 2362 * According to SDHC Spec v3.00, if the Preset Value 2363 * Enable in the Host Control 2 register is set, we 2364 * need to reset SD Clock Enable before changing High 2365 * Speed Enable to avoid generating clock gliches. 2366 */ 2367 2368 /* Reset SD Clock Enable */ 2369 clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL); 2370 clk &= ~SDHCI_CLOCK_CARD_EN; 2371 sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL); 2372 2373 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 2374 2375 /* Re-enable SD Clock */ 2376 host->ops->set_clock(host, host->clock); 2377 } 2378 2379 /* Reset SD Clock Enable */ 2380 clk = sdhci_readw(host, SDHCI_CLOCK_CONTROL); 2381 clk &= ~SDHCI_CLOCK_CARD_EN; 2382 sdhci_writew(host, clk, SDHCI_CLOCK_CONTROL); 2383 2384 host->ops->set_uhs_signaling(host, ios->timing); 2385 host->timing = ios->timing; 2386 2387 if (!(host->quirks2 & SDHCI_QUIRK2_PRESET_VALUE_BROKEN) && 2388 ((ios->timing == MMC_TIMING_UHS_SDR12) || 2389 (ios->timing == MMC_TIMING_UHS_SDR25) || 2390 (ios->timing == MMC_TIMING_UHS_SDR50) || 2391 (ios->timing == MMC_TIMING_UHS_SDR104) || 2392 (ios->timing == MMC_TIMING_UHS_DDR50) || 2393 (ios->timing == MMC_TIMING_MMC_DDR52))) { 2394 u16 preset; 2395 2396 sdhci_enable_preset_value(host, true); 2397 preset = sdhci_get_preset_value(host); 2398 ios->drv_type = FIELD_GET(SDHCI_PRESET_DRV_MASK, 2399 preset); 2400 } 2401 2402 /* Re-enable SD Clock */ 2403 host->ops->set_clock(host, host->clock); 2404 } else 2405 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 2406 2407 /* 2408 * Some (ENE) controllers go apeshit on some ios operation, 2409 * signalling timeout and CRC errors even on CMD0. Resetting 2410 * it on each ios seems to solve the problem. 2411 */ 2412 if (host->quirks & SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS) 2413 sdhci_do_reset(host, SDHCI_RESET_CMD | SDHCI_RESET_DATA); 2414 } 2415 EXPORT_SYMBOL_GPL(sdhci_set_ios); 2416 2417 static int sdhci_get_cd(struct mmc_host *mmc) 2418 { 2419 struct sdhci_host *host = mmc_priv(mmc); 2420 int gpio_cd = mmc_gpio_get_cd(mmc); 2421 2422 if (host->flags & SDHCI_DEVICE_DEAD) 2423 return 0; 2424 2425 /* If nonremovable, assume that the card is always present. */ 2426 if (!mmc_card_is_removable(mmc)) 2427 return 1; 2428 2429 /* 2430 * Try slot gpio detect, if defined it take precedence 2431 * over build in controller functionality 2432 */ 2433 if (gpio_cd >= 0) 2434 return !!gpio_cd; 2435 2436 /* If polling, assume that the card is always present. */ 2437 if (host->quirks & SDHCI_QUIRK_BROKEN_CARD_DETECTION) 2438 return 1; 2439 2440 /* Host native card detect */ 2441 return !!(sdhci_readl(host, SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT); 2442 } 2443 2444 int sdhci_get_cd_nogpio(struct mmc_host *mmc) 2445 { 2446 struct sdhci_host *host = mmc_priv(mmc); 2447 unsigned long flags; 2448 int ret = 0; 2449 2450 spin_lock_irqsave(&host->lock, flags); 2451 2452 if (host->flags & SDHCI_DEVICE_DEAD) 2453 goto out; 2454 2455 ret = !!(sdhci_readl(host, SDHCI_PRESENT_STATE) & SDHCI_CARD_PRESENT); 2456 out: 2457 spin_unlock_irqrestore(&host->lock, flags); 2458 2459 return ret; 2460 } 2461 EXPORT_SYMBOL_GPL(sdhci_get_cd_nogpio); 2462 2463 static int sdhci_check_ro(struct sdhci_host *host) 2464 { 2465 unsigned long flags; 2466 int is_readonly; 2467 2468 spin_lock_irqsave(&host->lock, flags); 2469 2470 if (host->flags & SDHCI_DEVICE_DEAD) 2471 is_readonly = 0; 2472 else if (host->ops->get_ro) 2473 is_readonly = host->ops->get_ro(host); 2474 else if (mmc_can_gpio_ro(host->mmc)) 2475 is_readonly = mmc_gpio_get_ro(host->mmc); 2476 else 2477 is_readonly = !(sdhci_readl(host, SDHCI_PRESENT_STATE) 2478 & SDHCI_WRITE_PROTECT); 2479 2480 spin_unlock_irqrestore(&host->lock, flags); 2481 2482 /* This quirk needs to be replaced by a callback-function later */ 2483 return host->quirks & SDHCI_QUIRK_INVERTED_WRITE_PROTECT ? 2484 !is_readonly : is_readonly; 2485 } 2486 2487 #define SAMPLE_COUNT 5 2488 2489 static int sdhci_get_ro(struct mmc_host *mmc) 2490 { 2491 struct sdhci_host *host = mmc_priv(mmc); 2492 int i, ro_count; 2493 2494 if (!(host->quirks & SDHCI_QUIRK_UNSTABLE_RO_DETECT)) 2495 return sdhci_check_ro(host); 2496 2497 ro_count = 0; 2498 for (i = 0; i < SAMPLE_COUNT; i++) { 2499 if (sdhci_check_ro(host)) { 2500 if (++ro_count > SAMPLE_COUNT / 2) 2501 return 1; 2502 } 2503 msleep(30); 2504 } 2505 return 0; 2506 } 2507 2508 static void sdhci_hw_reset(struct mmc_host *mmc) 2509 { 2510 struct sdhci_host *host = mmc_priv(mmc); 2511 2512 if (host->ops && host->ops->hw_reset) 2513 host->ops->hw_reset(host); 2514 } 2515 2516 static void sdhci_enable_sdio_irq_nolock(struct sdhci_host *host, int enable) 2517 { 2518 if (!(host->flags & SDHCI_DEVICE_DEAD)) { 2519 if (enable) 2520 host->ier |= SDHCI_INT_CARD_INT; 2521 else 2522 host->ier &= ~SDHCI_INT_CARD_INT; 2523 2524 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 2525 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 2526 } 2527 } 2528 2529 void sdhci_enable_sdio_irq(struct mmc_host *mmc, int enable) 2530 { 2531 struct sdhci_host *host = mmc_priv(mmc); 2532 unsigned long flags; 2533 2534 if (enable) 2535 pm_runtime_get_noresume(mmc_dev(mmc)); 2536 2537 spin_lock_irqsave(&host->lock, flags); 2538 sdhci_enable_sdio_irq_nolock(host, enable); 2539 spin_unlock_irqrestore(&host->lock, flags); 2540 2541 if (!enable) 2542 pm_runtime_put_noidle(mmc_dev(mmc)); 2543 } 2544 EXPORT_SYMBOL_GPL(sdhci_enable_sdio_irq); 2545 2546 static void sdhci_ack_sdio_irq(struct mmc_host *mmc) 2547 { 2548 struct sdhci_host *host = mmc_priv(mmc); 2549 unsigned long flags; 2550 2551 spin_lock_irqsave(&host->lock, flags); 2552 sdhci_enable_sdio_irq_nolock(host, true); 2553 spin_unlock_irqrestore(&host->lock, flags); 2554 } 2555 2556 int sdhci_start_signal_voltage_switch(struct mmc_host *mmc, 2557 struct mmc_ios *ios) 2558 { 2559 struct sdhci_host *host = mmc_priv(mmc); 2560 u16 ctrl; 2561 int ret; 2562 2563 /* 2564 * Signal Voltage Switching is only applicable for Host Controllers 2565 * v3.00 and above. 2566 */ 2567 if (host->version < SDHCI_SPEC_300) 2568 return 0; 2569 2570 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2571 2572 switch (ios->signal_voltage) { 2573 case MMC_SIGNAL_VOLTAGE_330: 2574 if (!(host->flags & SDHCI_SIGNALING_330)) 2575 return -EINVAL; 2576 /* Set 1.8V Signal Enable in the Host Control2 register to 0 */ 2577 ctrl &= ~SDHCI_CTRL_VDD_180; 2578 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2); 2579 2580 if (!IS_ERR(mmc->supply.vqmmc)) { 2581 ret = mmc_regulator_set_vqmmc(mmc, ios); 2582 if (ret < 0) { 2583 pr_warn("%s: Switching to 3.3V signalling voltage failed\n", 2584 mmc_hostname(mmc)); 2585 return -EIO; 2586 } 2587 } 2588 /* Wait for 5ms */ 2589 usleep_range(5000, 5500); 2590 2591 /* 3.3V regulator output should be stable within 5 ms */ 2592 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2593 if (!(ctrl & SDHCI_CTRL_VDD_180)) 2594 return 0; 2595 2596 pr_warn("%s: 3.3V regulator output did not become stable\n", 2597 mmc_hostname(mmc)); 2598 2599 return -EAGAIN; 2600 case MMC_SIGNAL_VOLTAGE_180: 2601 if (!(host->flags & SDHCI_SIGNALING_180)) 2602 return -EINVAL; 2603 if (!IS_ERR(mmc->supply.vqmmc)) { 2604 ret = mmc_regulator_set_vqmmc(mmc, ios); 2605 if (ret < 0) { 2606 pr_warn("%s: Switching to 1.8V signalling voltage failed\n", 2607 mmc_hostname(mmc)); 2608 return -EIO; 2609 } 2610 } 2611 2612 /* 2613 * Enable 1.8V Signal Enable in the Host Control2 2614 * register 2615 */ 2616 ctrl |= SDHCI_CTRL_VDD_180; 2617 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2); 2618 2619 /* Some controller need to do more when switching */ 2620 if (host->ops->voltage_switch) 2621 host->ops->voltage_switch(host); 2622 2623 /* 1.8V regulator output should be stable within 5 ms */ 2624 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2625 if (ctrl & SDHCI_CTRL_VDD_180) 2626 return 0; 2627 2628 pr_warn("%s: 1.8V regulator output did not become stable\n", 2629 mmc_hostname(mmc)); 2630 2631 return -EAGAIN; 2632 case MMC_SIGNAL_VOLTAGE_120: 2633 if (!(host->flags & SDHCI_SIGNALING_120)) 2634 return -EINVAL; 2635 if (!IS_ERR(mmc->supply.vqmmc)) { 2636 ret = mmc_regulator_set_vqmmc(mmc, ios); 2637 if (ret < 0) { 2638 pr_warn("%s: Switching to 1.2V signalling voltage failed\n", 2639 mmc_hostname(mmc)); 2640 return -EIO; 2641 } 2642 } 2643 return 0; 2644 default: 2645 /* No signal voltage switch required */ 2646 return 0; 2647 } 2648 } 2649 EXPORT_SYMBOL_GPL(sdhci_start_signal_voltage_switch); 2650 2651 static int sdhci_card_busy(struct mmc_host *mmc) 2652 { 2653 struct sdhci_host *host = mmc_priv(mmc); 2654 u32 present_state; 2655 2656 /* Check whether DAT[0] is 0 */ 2657 present_state = sdhci_readl(host, SDHCI_PRESENT_STATE); 2658 2659 return !(present_state & SDHCI_DATA_0_LVL_MASK); 2660 } 2661 2662 static int sdhci_prepare_hs400_tuning(struct mmc_host *mmc, struct mmc_ios *ios) 2663 { 2664 struct sdhci_host *host = mmc_priv(mmc); 2665 unsigned long flags; 2666 2667 spin_lock_irqsave(&host->lock, flags); 2668 host->flags |= SDHCI_HS400_TUNING; 2669 spin_unlock_irqrestore(&host->lock, flags); 2670 2671 return 0; 2672 } 2673 2674 void sdhci_start_tuning(struct sdhci_host *host) 2675 { 2676 u16 ctrl; 2677 2678 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2679 ctrl |= SDHCI_CTRL_EXEC_TUNING; 2680 if (host->quirks2 & SDHCI_QUIRK2_TUNING_WORK_AROUND) 2681 ctrl |= SDHCI_CTRL_TUNED_CLK; 2682 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2); 2683 2684 /* 2685 * As per the Host Controller spec v3.00, tuning command 2686 * generates Buffer Read Ready interrupt, so enable that. 2687 * 2688 * Note: The spec clearly says that when tuning sequence 2689 * is being performed, the controller does not generate 2690 * interrupts other than Buffer Read Ready interrupt. But 2691 * to make sure we don't hit a controller bug, we _only_ 2692 * enable Buffer Read Ready interrupt here. 2693 */ 2694 sdhci_writel(host, SDHCI_INT_DATA_AVAIL, SDHCI_INT_ENABLE); 2695 sdhci_writel(host, SDHCI_INT_DATA_AVAIL, SDHCI_SIGNAL_ENABLE); 2696 } 2697 EXPORT_SYMBOL_GPL(sdhci_start_tuning); 2698 2699 void sdhci_end_tuning(struct sdhci_host *host) 2700 { 2701 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 2702 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 2703 } 2704 EXPORT_SYMBOL_GPL(sdhci_end_tuning); 2705 2706 void sdhci_reset_tuning(struct sdhci_host *host) 2707 { 2708 u16 ctrl; 2709 2710 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2711 ctrl &= ~SDHCI_CTRL_TUNED_CLK; 2712 ctrl &= ~SDHCI_CTRL_EXEC_TUNING; 2713 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2); 2714 } 2715 EXPORT_SYMBOL_GPL(sdhci_reset_tuning); 2716 2717 void sdhci_abort_tuning(struct sdhci_host *host, u32 opcode) 2718 { 2719 sdhci_reset_tuning(host); 2720 2721 sdhci_do_reset(host, SDHCI_RESET_CMD); 2722 sdhci_do_reset(host, SDHCI_RESET_DATA); 2723 2724 sdhci_end_tuning(host); 2725 2726 mmc_send_abort_tuning(host->mmc, opcode); 2727 } 2728 EXPORT_SYMBOL_GPL(sdhci_abort_tuning); 2729 2730 /* 2731 * We use sdhci_send_tuning() because mmc_send_tuning() is not a good fit. SDHCI 2732 * tuning command does not have a data payload (or rather the hardware does it 2733 * automatically) so mmc_send_tuning() will return -EIO. Also the tuning command 2734 * interrupt setup is different to other commands and there is no timeout 2735 * interrupt so special handling is needed. 2736 */ 2737 void sdhci_send_tuning(struct sdhci_host *host, u32 opcode) 2738 { 2739 struct mmc_host *mmc = host->mmc; 2740 struct mmc_command cmd = {}; 2741 struct mmc_request mrq = {}; 2742 unsigned long flags; 2743 u32 b = host->sdma_boundary; 2744 2745 spin_lock_irqsave(&host->lock, flags); 2746 2747 cmd.opcode = opcode; 2748 cmd.flags = MMC_RSP_R1 | MMC_CMD_ADTC; 2749 cmd.mrq = &mrq; 2750 2751 mrq.cmd = &cmd; 2752 /* 2753 * In response to CMD19, the card sends 64 bytes of tuning 2754 * block to the Host Controller. So we set the block size 2755 * to 64 here. 2756 */ 2757 if (cmd.opcode == MMC_SEND_TUNING_BLOCK_HS200 && 2758 mmc->ios.bus_width == MMC_BUS_WIDTH_8) 2759 sdhci_writew(host, SDHCI_MAKE_BLKSZ(b, 128), SDHCI_BLOCK_SIZE); 2760 else 2761 sdhci_writew(host, SDHCI_MAKE_BLKSZ(b, 64), SDHCI_BLOCK_SIZE); 2762 2763 /* 2764 * The tuning block is sent by the card to the host controller. 2765 * So we set the TRNS_READ bit in the Transfer Mode register. 2766 * This also takes care of setting DMA Enable and Multi Block 2767 * Select in the same register to 0. 2768 */ 2769 sdhci_writew(host, SDHCI_TRNS_READ, SDHCI_TRANSFER_MODE); 2770 2771 if (!sdhci_send_command_retry(host, &cmd, flags)) { 2772 spin_unlock_irqrestore(&host->lock, flags); 2773 host->tuning_done = 0; 2774 return; 2775 } 2776 2777 host->cmd = NULL; 2778 2779 sdhci_del_timer(host, &mrq); 2780 2781 host->tuning_done = 0; 2782 2783 spin_unlock_irqrestore(&host->lock, flags); 2784 2785 /* Wait for Buffer Read Ready interrupt */ 2786 wait_event_timeout(host->buf_ready_int, (host->tuning_done == 1), 2787 msecs_to_jiffies(50)); 2788 2789 } 2790 EXPORT_SYMBOL_GPL(sdhci_send_tuning); 2791 2792 static int __sdhci_execute_tuning(struct sdhci_host *host, u32 opcode) 2793 { 2794 int i; 2795 2796 /* 2797 * Issue opcode repeatedly till Execute Tuning is set to 0 or the number 2798 * of loops reaches tuning loop count. 2799 */ 2800 for (i = 0; i < host->tuning_loop_count; i++) { 2801 u16 ctrl; 2802 2803 sdhci_send_tuning(host, opcode); 2804 2805 if (!host->tuning_done) { 2806 pr_debug("%s: Tuning timeout, falling back to fixed sampling clock\n", 2807 mmc_hostname(host->mmc)); 2808 sdhci_abort_tuning(host, opcode); 2809 return -ETIMEDOUT; 2810 } 2811 2812 /* Spec does not require a delay between tuning cycles */ 2813 if (host->tuning_delay > 0) 2814 mdelay(host->tuning_delay); 2815 2816 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2817 if (!(ctrl & SDHCI_CTRL_EXEC_TUNING)) { 2818 if (ctrl & SDHCI_CTRL_TUNED_CLK) 2819 return 0; /* Success! */ 2820 break; 2821 } 2822 2823 } 2824 2825 pr_info("%s: Tuning failed, falling back to fixed sampling clock\n", 2826 mmc_hostname(host->mmc)); 2827 sdhci_reset_tuning(host); 2828 return -EAGAIN; 2829 } 2830 2831 int sdhci_execute_tuning(struct mmc_host *mmc, u32 opcode) 2832 { 2833 struct sdhci_host *host = mmc_priv(mmc); 2834 int err = 0; 2835 unsigned int tuning_count = 0; 2836 bool hs400_tuning; 2837 2838 hs400_tuning = host->flags & SDHCI_HS400_TUNING; 2839 2840 if (host->tuning_mode == SDHCI_TUNING_MODE_1) 2841 tuning_count = host->tuning_count; 2842 2843 /* 2844 * The Host Controller needs tuning in case of SDR104 and DDR50 2845 * mode, and for SDR50 mode when Use Tuning for SDR50 is set in 2846 * the Capabilities register. 2847 * If the Host Controller supports the HS200 mode then the 2848 * tuning function has to be executed. 2849 */ 2850 switch (host->timing) { 2851 /* HS400 tuning is done in HS200 mode */ 2852 case MMC_TIMING_MMC_HS400: 2853 err = -EINVAL; 2854 goto out; 2855 2856 case MMC_TIMING_MMC_HS200: 2857 /* 2858 * Periodic re-tuning for HS400 is not expected to be needed, so 2859 * disable it here. 2860 */ 2861 if (hs400_tuning) 2862 tuning_count = 0; 2863 break; 2864 2865 case MMC_TIMING_UHS_SDR104: 2866 case MMC_TIMING_UHS_DDR50: 2867 break; 2868 2869 case MMC_TIMING_UHS_SDR50: 2870 if (host->flags & SDHCI_SDR50_NEEDS_TUNING) 2871 break; 2872 fallthrough; 2873 2874 default: 2875 goto out; 2876 } 2877 2878 if (host->ops->platform_execute_tuning) { 2879 err = host->ops->platform_execute_tuning(host, opcode); 2880 goto out; 2881 } 2882 2883 mmc->retune_period = tuning_count; 2884 2885 if (host->tuning_delay < 0) 2886 host->tuning_delay = opcode == MMC_SEND_TUNING_BLOCK; 2887 2888 sdhci_start_tuning(host); 2889 2890 host->tuning_err = __sdhci_execute_tuning(host, opcode); 2891 2892 sdhci_end_tuning(host); 2893 out: 2894 host->flags &= ~SDHCI_HS400_TUNING; 2895 2896 return err; 2897 } 2898 EXPORT_SYMBOL_GPL(sdhci_execute_tuning); 2899 2900 static void sdhci_enable_preset_value(struct sdhci_host *host, bool enable) 2901 { 2902 /* Host Controller v3.00 defines preset value registers */ 2903 if (host->version < SDHCI_SPEC_300) 2904 return; 2905 2906 /* 2907 * We only enable or disable Preset Value if they are not already 2908 * enabled or disabled respectively. Otherwise, we bail out. 2909 */ 2910 if (host->preset_enabled != enable) { 2911 u16 ctrl = sdhci_readw(host, SDHCI_HOST_CONTROL2); 2912 2913 if (enable) 2914 ctrl |= SDHCI_CTRL_PRESET_VAL_ENABLE; 2915 else 2916 ctrl &= ~SDHCI_CTRL_PRESET_VAL_ENABLE; 2917 2918 sdhci_writew(host, ctrl, SDHCI_HOST_CONTROL2); 2919 2920 if (enable) 2921 host->flags |= SDHCI_PV_ENABLED; 2922 else 2923 host->flags &= ~SDHCI_PV_ENABLED; 2924 2925 host->preset_enabled = enable; 2926 } 2927 } 2928 2929 static void sdhci_post_req(struct mmc_host *mmc, struct mmc_request *mrq, 2930 int err) 2931 { 2932 struct mmc_data *data = mrq->data; 2933 2934 if (data->host_cookie != COOKIE_UNMAPPED) 2935 dma_unmap_sg(mmc_dev(mmc), data->sg, data->sg_len, 2936 mmc_get_dma_dir(data)); 2937 2938 data->host_cookie = COOKIE_UNMAPPED; 2939 } 2940 2941 static void sdhci_pre_req(struct mmc_host *mmc, struct mmc_request *mrq) 2942 { 2943 struct sdhci_host *host = mmc_priv(mmc); 2944 2945 mrq->data->host_cookie = COOKIE_UNMAPPED; 2946 2947 /* 2948 * No pre-mapping in the pre hook if we're using the bounce buffer, 2949 * for that we would need two bounce buffers since one buffer is 2950 * in flight when this is getting called. 2951 */ 2952 if (host->flags & SDHCI_REQ_USE_DMA && !host->bounce_buffer) 2953 sdhci_pre_dma_transfer(host, mrq->data, COOKIE_PRE_MAPPED); 2954 } 2955 2956 static void sdhci_error_out_mrqs(struct sdhci_host *host, int err) 2957 { 2958 if (host->data_cmd) { 2959 host->data_cmd->error = err; 2960 sdhci_finish_mrq(host, host->data_cmd->mrq); 2961 } 2962 2963 if (host->cmd) { 2964 host->cmd->error = err; 2965 sdhci_finish_mrq(host, host->cmd->mrq); 2966 } 2967 } 2968 2969 static void sdhci_card_event(struct mmc_host *mmc) 2970 { 2971 struct sdhci_host *host = mmc_priv(mmc); 2972 unsigned long flags; 2973 int present; 2974 2975 /* First check if client has provided their own card event */ 2976 if (host->ops->card_event) 2977 host->ops->card_event(host); 2978 2979 present = mmc->ops->get_cd(mmc); 2980 2981 spin_lock_irqsave(&host->lock, flags); 2982 2983 /* Check sdhci_has_requests() first in case we are runtime suspended */ 2984 if (sdhci_has_requests(host) && !present) { 2985 pr_err("%s: Card removed during transfer!\n", 2986 mmc_hostname(mmc)); 2987 pr_err("%s: Resetting controller.\n", 2988 mmc_hostname(mmc)); 2989 2990 sdhci_do_reset(host, SDHCI_RESET_CMD); 2991 sdhci_do_reset(host, SDHCI_RESET_DATA); 2992 2993 sdhci_error_out_mrqs(host, -ENOMEDIUM); 2994 } 2995 2996 spin_unlock_irqrestore(&host->lock, flags); 2997 } 2998 2999 static const struct mmc_host_ops sdhci_ops = { 3000 .request = sdhci_request, 3001 .post_req = sdhci_post_req, 3002 .pre_req = sdhci_pre_req, 3003 .set_ios = sdhci_set_ios, 3004 .get_cd = sdhci_get_cd, 3005 .get_ro = sdhci_get_ro, 3006 .card_hw_reset = sdhci_hw_reset, 3007 .enable_sdio_irq = sdhci_enable_sdio_irq, 3008 .ack_sdio_irq = sdhci_ack_sdio_irq, 3009 .start_signal_voltage_switch = sdhci_start_signal_voltage_switch, 3010 .prepare_hs400_tuning = sdhci_prepare_hs400_tuning, 3011 .execute_tuning = sdhci_execute_tuning, 3012 .card_event = sdhci_card_event, 3013 .card_busy = sdhci_card_busy, 3014 }; 3015 3016 /*****************************************************************************\ 3017 * * 3018 * Request done * 3019 * * 3020 \*****************************************************************************/ 3021 3022 static bool sdhci_request_done(struct sdhci_host *host) 3023 { 3024 unsigned long flags; 3025 struct mmc_request *mrq; 3026 int i; 3027 3028 spin_lock_irqsave(&host->lock, flags); 3029 3030 for (i = 0; i < SDHCI_MAX_MRQS; i++) { 3031 mrq = host->mrqs_done[i]; 3032 if (mrq) 3033 break; 3034 } 3035 3036 if (!mrq) { 3037 spin_unlock_irqrestore(&host->lock, flags); 3038 return true; 3039 } 3040 3041 /* 3042 * The controller needs a reset of internal state machines 3043 * upon error conditions. 3044 */ 3045 if (sdhci_needs_reset(host, mrq)) { 3046 /* 3047 * Do not finish until command and data lines are available for 3048 * reset. Note there can only be one other mrq, so it cannot 3049 * also be in mrqs_done, otherwise host->cmd and host->data_cmd 3050 * would both be null. 3051 */ 3052 if (host->cmd || host->data_cmd) { 3053 spin_unlock_irqrestore(&host->lock, flags); 3054 return true; 3055 } 3056 3057 /* Some controllers need this kick or reset won't work here */ 3058 if (host->quirks & SDHCI_QUIRK_CLOCK_BEFORE_RESET) 3059 /* This is to force an update */ 3060 host->ops->set_clock(host, host->clock); 3061 3062 /* 3063 * Spec says we should do both at the same time, but Ricoh 3064 * controllers do not like that. 3065 */ 3066 sdhci_do_reset(host, SDHCI_RESET_CMD); 3067 sdhci_do_reset(host, SDHCI_RESET_DATA); 3068 3069 host->pending_reset = false; 3070 } 3071 3072 /* 3073 * Always unmap the data buffers if they were mapped by 3074 * sdhci_prepare_data() whenever we finish with a request. 3075 * This avoids leaking DMA mappings on error. 3076 */ 3077 if (host->flags & SDHCI_REQ_USE_DMA) { 3078 struct mmc_data *data = mrq->data; 3079 3080 if (host->use_external_dma && data && 3081 (mrq->cmd->error || data->error)) { 3082 struct dma_chan *chan = sdhci_external_dma_channel(host, data); 3083 3084 host->mrqs_done[i] = NULL; 3085 spin_unlock_irqrestore(&host->lock, flags); 3086 dmaengine_terminate_sync(chan); 3087 spin_lock_irqsave(&host->lock, flags); 3088 sdhci_set_mrq_done(host, mrq); 3089 } 3090 3091 if (data && data->host_cookie == COOKIE_MAPPED) { 3092 if (host->bounce_buffer) { 3093 /* 3094 * On reads, copy the bounced data into the 3095 * sglist 3096 */ 3097 if (mmc_get_dma_dir(data) == DMA_FROM_DEVICE) { 3098 unsigned int length = data->bytes_xfered; 3099 3100 if (length > host->bounce_buffer_size) { 3101 pr_err("%s: bounce buffer is %u bytes but DMA claims to have transferred %u bytes\n", 3102 mmc_hostname(host->mmc), 3103 host->bounce_buffer_size, 3104 data->bytes_xfered); 3105 /* Cap it down and continue */ 3106 length = host->bounce_buffer_size; 3107 } 3108 dma_sync_single_for_cpu( 3109 mmc_dev(host->mmc), 3110 host->bounce_addr, 3111 host->bounce_buffer_size, 3112 DMA_FROM_DEVICE); 3113 sg_copy_from_buffer(data->sg, 3114 data->sg_len, 3115 host->bounce_buffer, 3116 length); 3117 } else { 3118 /* No copying, just switch ownership */ 3119 dma_sync_single_for_cpu( 3120 mmc_dev(host->mmc), 3121 host->bounce_addr, 3122 host->bounce_buffer_size, 3123 mmc_get_dma_dir(data)); 3124 } 3125 } else { 3126 /* Unmap the raw data */ 3127 dma_unmap_sg(mmc_dev(host->mmc), data->sg, 3128 data->sg_len, 3129 mmc_get_dma_dir(data)); 3130 } 3131 data->host_cookie = COOKIE_UNMAPPED; 3132 } 3133 } 3134 3135 host->mrqs_done[i] = NULL; 3136 3137 spin_unlock_irqrestore(&host->lock, flags); 3138 3139 if (host->ops->request_done) 3140 host->ops->request_done(host, mrq); 3141 else 3142 mmc_request_done(host->mmc, mrq); 3143 3144 return false; 3145 } 3146 3147 static void sdhci_complete_work(struct work_struct *work) 3148 { 3149 struct sdhci_host *host = container_of(work, struct sdhci_host, 3150 complete_work); 3151 3152 while (!sdhci_request_done(host)) 3153 ; 3154 } 3155 3156 static void sdhci_timeout_timer(struct timer_list *t) 3157 { 3158 struct sdhci_host *host; 3159 unsigned long flags; 3160 3161 host = from_timer(host, t, timer); 3162 3163 spin_lock_irqsave(&host->lock, flags); 3164 3165 if (host->cmd && !sdhci_data_line_cmd(host->cmd)) { 3166 pr_err("%s: Timeout waiting for hardware cmd interrupt.\n", 3167 mmc_hostname(host->mmc)); 3168 sdhci_err_stats_inc(host, REQ_TIMEOUT); 3169 sdhci_dumpregs(host); 3170 3171 host->cmd->error = -ETIMEDOUT; 3172 sdhci_finish_mrq(host, host->cmd->mrq); 3173 } 3174 3175 spin_unlock_irqrestore(&host->lock, flags); 3176 } 3177 3178 static void sdhci_timeout_data_timer(struct timer_list *t) 3179 { 3180 struct sdhci_host *host; 3181 unsigned long flags; 3182 3183 host = from_timer(host, t, data_timer); 3184 3185 spin_lock_irqsave(&host->lock, flags); 3186 3187 if (host->data || host->data_cmd || 3188 (host->cmd && sdhci_data_line_cmd(host->cmd))) { 3189 pr_err("%s: Timeout waiting for hardware interrupt.\n", 3190 mmc_hostname(host->mmc)); 3191 sdhci_err_stats_inc(host, REQ_TIMEOUT); 3192 sdhci_dumpregs(host); 3193 3194 if (host->data) { 3195 host->data->error = -ETIMEDOUT; 3196 __sdhci_finish_data(host, true); 3197 queue_work(host->complete_wq, &host->complete_work); 3198 } else if (host->data_cmd) { 3199 host->data_cmd->error = -ETIMEDOUT; 3200 sdhci_finish_mrq(host, host->data_cmd->mrq); 3201 } else { 3202 host->cmd->error = -ETIMEDOUT; 3203 sdhci_finish_mrq(host, host->cmd->mrq); 3204 } 3205 } 3206 3207 spin_unlock_irqrestore(&host->lock, flags); 3208 } 3209 3210 /*****************************************************************************\ 3211 * * 3212 * Interrupt handling * 3213 * * 3214 \*****************************************************************************/ 3215 3216 static void sdhci_cmd_irq(struct sdhci_host *host, u32 intmask, u32 *intmask_p) 3217 { 3218 /* Handle auto-CMD12 error */ 3219 if (intmask & SDHCI_INT_AUTO_CMD_ERR && host->data_cmd) { 3220 struct mmc_request *mrq = host->data_cmd->mrq; 3221 u16 auto_cmd_status = sdhci_readw(host, SDHCI_AUTO_CMD_STATUS); 3222 int data_err_bit = (auto_cmd_status & SDHCI_AUTO_CMD_TIMEOUT) ? 3223 SDHCI_INT_DATA_TIMEOUT : 3224 SDHCI_INT_DATA_CRC; 3225 3226 /* Treat auto-CMD12 error the same as data error */ 3227 if (!mrq->sbc && (host->flags & SDHCI_AUTO_CMD12)) { 3228 *intmask_p |= data_err_bit; 3229 return; 3230 } 3231 } 3232 3233 if (!host->cmd) { 3234 /* 3235 * SDHCI recovers from errors by resetting the cmd and data 3236 * circuits. Until that is done, there very well might be more 3237 * interrupts, so ignore them in that case. 3238 */ 3239 if (host->pending_reset) 3240 return; 3241 pr_err("%s: Got command interrupt 0x%08x even though no command operation was in progress.\n", 3242 mmc_hostname(host->mmc), (unsigned)intmask); 3243 sdhci_err_stats_inc(host, UNEXPECTED_IRQ); 3244 sdhci_dumpregs(host); 3245 return; 3246 } 3247 3248 if (intmask & (SDHCI_INT_TIMEOUT | SDHCI_INT_CRC | 3249 SDHCI_INT_END_BIT | SDHCI_INT_INDEX)) { 3250 if (intmask & SDHCI_INT_TIMEOUT) { 3251 host->cmd->error = -ETIMEDOUT; 3252 sdhci_err_stats_inc(host, CMD_TIMEOUT); 3253 } else { 3254 host->cmd->error = -EILSEQ; 3255 if (!mmc_op_tuning(host->cmd->opcode)) 3256 sdhci_err_stats_inc(host, CMD_CRC); 3257 } 3258 /* Treat data command CRC error the same as data CRC error */ 3259 if (host->cmd->data && 3260 (intmask & (SDHCI_INT_CRC | SDHCI_INT_TIMEOUT)) == 3261 SDHCI_INT_CRC) { 3262 host->cmd = NULL; 3263 *intmask_p |= SDHCI_INT_DATA_CRC; 3264 return; 3265 } 3266 3267 __sdhci_finish_mrq(host, host->cmd->mrq); 3268 return; 3269 } 3270 3271 /* Handle auto-CMD23 error */ 3272 if (intmask & SDHCI_INT_AUTO_CMD_ERR) { 3273 struct mmc_request *mrq = host->cmd->mrq; 3274 u16 auto_cmd_status = sdhci_readw(host, SDHCI_AUTO_CMD_STATUS); 3275 int err = (auto_cmd_status & SDHCI_AUTO_CMD_TIMEOUT) ? 3276 -ETIMEDOUT : 3277 -EILSEQ; 3278 3279 sdhci_err_stats_inc(host, AUTO_CMD); 3280 3281 if (sdhci_auto_cmd23(host, mrq)) { 3282 mrq->sbc->error = err; 3283 __sdhci_finish_mrq(host, mrq); 3284 return; 3285 } 3286 } 3287 3288 if (intmask & SDHCI_INT_RESPONSE) 3289 sdhci_finish_command(host); 3290 } 3291 3292 static void sdhci_adma_show_error(struct sdhci_host *host) 3293 { 3294 void *desc = host->adma_table; 3295 dma_addr_t dma = host->adma_addr; 3296 3297 sdhci_dumpregs(host); 3298 3299 while (true) { 3300 struct sdhci_adma2_64_desc *dma_desc = desc; 3301 3302 if (host->flags & SDHCI_USE_64_BIT_DMA) 3303 SDHCI_DUMP("%08llx: DMA 0x%08x%08x, LEN 0x%04x, Attr=0x%02x\n", 3304 (unsigned long long)dma, 3305 le32_to_cpu(dma_desc->addr_hi), 3306 le32_to_cpu(dma_desc->addr_lo), 3307 le16_to_cpu(dma_desc->len), 3308 le16_to_cpu(dma_desc->cmd)); 3309 else 3310 SDHCI_DUMP("%08llx: DMA 0x%08x, LEN 0x%04x, Attr=0x%02x\n", 3311 (unsigned long long)dma, 3312 le32_to_cpu(dma_desc->addr_lo), 3313 le16_to_cpu(dma_desc->len), 3314 le16_to_cpu(dma_desc->cmd)); 3315 3316 desc += host->desc_sz; 3317 dma += host->desc_sz; 3318 3319 if (dma_desc->cmd & cpu_to_le16(ADMA2_END)) 3320 break; 3321 } 3322 } 3323 3324 static void sdhci_data_irq(struct sdhci_host *host, u32 intmask) 3325 { 3326 u32 command; 3327 3328 /* 3329 * CMD19 generates _only_ Buffer Read Ready interrupt if 3330 * use sdhci_send_tuning. 3331 * Need to exclude this case: PIO mode and use mmc_send_tuning, 3332 * If not, sdhci_transfer_pio will never be called, make the 3333 * SDHCI_INT_DATA_AVAIL always there, stuck in irq storm. 3334 */ 3335 if (intmask & SDHCI_INT_DATA_AVAIL && !host->data) { 3336 command = SDHCI_GET_CMD(sdhci_readw(host, SDHCI_COMMAND)); 3337 if (command == MMC_SEND_TUNING_BLOCK || 3338 command == MMC_SEND_TUNING_BLOCK_HS200) { 3339 host->tuning_done = 1; 3340 wake_up(&host->buf_ready_int); 3341 return; 3342 } 3343 } 3344 3345 if (!host->data) { 3346 struct mmc_command *data_cmd = host->data_cmd; 3347 3348 /* 3349 * The "data complete" interrupt is also used to 3350 * indicate that a busy state has ended. See comment 3351 * above in sdhci_cmd_irq(). 3352 */ 3353 if (data_cmd && (data_cmd->flags & MMC_RSP_BUSY)) { 3354 if (intmask & SDHCI_INT_DATA_TIMEOUT) { 3355 host->data_cmd = NULL; 3356 data_cmd->error = -ETIMEDOUT; 3357 sdhci_err_stats_inc(host, CMD_TIMEOUT); 3358 __sdhci_finish_mrq(host, data_cmd->mrq); 3359 return; 3360 } 3361 if (intmask & SDHCI_INT_DATA_END) { 3362 host->data_cmd = NULL; 3363 /* 3364 * Some cards handle busy-end interrupt 3365 * before the command completed, so make 3366 * sure we do things in the proper order. 3367 */ 3368 if (host->cmd == data_cmd) 3369 return; 3370 3371 __sdhci_finish_mrq(host, data_cmd->mrq); 3372 return; 3373 } 3374 } 3375 3376 /* 3377 * SDHCI recovers from errors by resetting the cmd and data 3378 * circuits. Until that is done, there very well might be more 3379 * interrupts, so ignore them in that case. 3380 */ 3381 if (host->pending_reset) 3382 return; 3383 3384 pr_err("%s: Got data interrupt 0x%08x even though no data operation was in progress.\n", 3385 mmc_hostname(host->mmc), (unsigned)intmask); 3386 sdhci_err_stats_inc(host, UNEXPECTED_IRQ); 3387 sdhci_dumpregs(host); 3388 3389 return; 3390 } 3391 3392 if (intmask & SDHCI_INT_DATA_TIMEOUT) { 3393 host->data->error = -ETIMEDOUT; 3394 sdhci_err_stats_inc(host, DAT_TIMEOUT); 3395 } else if (intmask & SDHCI_INT_DATA_END_BIT) { 3396 host->data->error = -EILSEQ; 3397 if (!mmc_op_tuning(SDHCI_GET_CMD(sdhci_readw(host, SDHCI_COMMAND)))) 3398 sdhci_err_stats_inc(host, DAT_CRC); 3399 } else if ((intmask & SDHCI_INT_DATA_CRC) && 3400 SDHCI_GET_CMD(sdhci_readw(host, SDHCI_COMMAND)) 3401 != MMC_BUS_TEST_R) { 3402 host->data->error = -EILSEQ; 3403 if (!mmc_op_tuning(SDHCI_GET_CMD(sdhci_readw(host, SDHCI_COMMAND)))) 3404 sdhci_err_stats_inc(host, DAT_CRC); 3405 } else if (intmask & SDHCI_INT_ADMA_ERROR) { 3406 pr_err("%s: ADMA error: 0x%08x\n", mmc_hostname(host->mmc), 3407 intmask); 3408 sdhci_adma_show_error(host); 3409 sdhci_err_stats_inc(host, ADMA); 3410 host->data->error = -EIO; 3411 if (host->ops->adma_workaround) 3412 host->ops->adma_workaround(host, intmask); 3413 } 3414 3415 if (host->data->error) 3416 sdhci_finish_data(host); 3417 else { 3418 if (intmask & (SDHCI_INT_DATA_AVAIL | SDHCI_INT_SPACE_AVAIL)) 3419 sdhci_transfer_pio(host); 3420 3421 /* 3422 * We currently don't do anything fancy with DMA 3423 * boundaries, but as we can't disable the feature 3424 * we need to at least restart the transfer. 3425 * 3426 * According to the spec sdhci_readl(host, SDHCI_DMA_ADDRESS) 3427 * should return a valid address to continue from, but as 3428 * some controllers are faulty, don't trust them. 3429 */ 3430 if (intmask & SDHCI_INT_DMA_END) { 3431 dma_addr_t dmastart, dmanow; 3432 3433 dmastart = sdhci_sdma_address(host); 3434 dmanow = dmastart + host->data->bytes_xfered; 3435 /* 3436 * Force update to the next DMA block boundary. 3437 */ 3438 dmanow = (dmanow & 3439 ~((dma_addr_t)SDHCI_DEFAULT_BOUNDARY_SIZE - 1)) + 3440 SDHCI_DEFAULT_BOUNDARY_SIZE; 3441 host->data->bytes_xfered = dmanow - dmastart; 3442 DBG("DMA base %pad, transferred 0x%06x bytes, next %pad\n", 3443 &dmastart, host->data->bytes_xfered, &dmanow); 3444 sdhci_set_sdma_addr(host, dmanow); 3445 } 3446 3447 if (intmask & SDHCI_INT_DATA_END) { 3448 if (host->cmd == host->data_cmd) { 3449 /* 3450 * Data managed to finish before the 3451 * command completed. Make sure we do 3452 * things in the proper order. 3453 */ 3454 host->data_early = 1; 3455 } else { 3456 sdhci_finish_data(host); 3457 } 3458 } 3459 } 3460 } 3461 3462 static inline bool sdhci_defer_done(struct sdhci_host *host, 3463 struct mmc_request *mrq) 3464 { 3465 struct mmc_data *data = mrq->data; 3466 3467 return host->pending_reset || host->always_defer_done || 3468 ((host->flags & SDHCI_REQ_USE_DMA) && data && 3469 data->host_cookie == COOKIE_MAPPED); 3470 } 3471 3472 static irqreturn_t sdhci_irq(int irq, void *dev_id) 3473 { 3474 struct mmc_request *mrqs_done[SDHCI_MAX_MRQS] = {0}; 3475 irqreturn_t result = IRQ_NONE; 3476 struct sdhci_host *host = dev_id; 3477 u32 intmask, mask, unexpected = 0; 3478 int max_loops = 16; 3479 int i; 3480 3481 spin_lock(&host->lock); 3482 3483 if (host->runtime_suspended) { 3484 spin_unlock(&host->lock); 3485 return IRQ_NONE; 3486 } 3487 3488 intmask = sdhci_readl(host, SDHCI_INT_STATUS); 3489 if (!intmask || intmask == 0xffffffff) { 3490 result = IRQ_NONE; 3491 goto out; 3492 } 3493 3494 do { 3495 DBG("IRQ status 0x%08x\n", intmask); 3496 3497 if (host->ops->irq) { 3498 intmask = host->ops->irq(host, intmask); 3499 if (!intmask) 3500 goto cont; 3501 } 3502 3503 /* Clear selected interrupts. */ 3504 mask = intmask & (SDHCI_INT_CMD_MASK | SDHCI_INT_DATA_MASK | 3505 SDHCI_INT_BUS_POWER); 3506 sdhci_writel(host, mask, SDHCI_INT_STATUS); 3507 3508 if (intmask & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE)) { 3509 u32 present = sdhci_readl(host, SDHCI_PRESENT_STATE) & 3510 SDHCI_CARD_PRESENT; 3511 3512 /* 3513 * There is a observation on i.mx esdhc. INSERT 3514 * bit will be immediately set again when it gets 3515 * cleared, if a card is inserted. We have to mask 3516 * the irq to prevent interrupt storm which will 3517 * freeze the system. And the REMOVE gets the 3518 * same situation. 3519 * 3520 * More testing are needed here to ensure it works 3521 * for other platforms though. 3522 */ 3523 host->ier &= ~(SDHCI_INT_CARD_INSERT | 3524 SDHCI_INT_CARD_REMOVE); 3525 host->ier |= present ? SDHCI_INT_CARD_REMOVE : 3526 SDHCI_INT_CARD_INSERT; 3527 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 3528 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 3529 3530 sdhci_writel(host, intmask & (SDHCI_INT_CARD_INSERT | 3531 SDHCI_INT_CARD_REMOVE), SDHCI_INT_STATUS); 3532 3533 host->thread_isr |= intmask & (SDHCI_INT_CARD_INSERT | 3534 SDHCI_INT_CARD_REMOVE); 3535 result = IRQ_WAKE_THREAD; 3536 } 3537 3538 if (intmask & SDHCI_INT_CMD_MASK) 3539 sdhci_cmd_irq(host, intmask & SDHCI_INT_CMD_MASK, &intmask); 3540 3541 if (intmask & SDHCI_INT_DATA_MASK) 3542 sdhci_data_irq(host, intmask & SDHCI_INT_DATA_MASK); 3543 3544 if (intmask & SDHCI_INT_BUS_POWER) 3545 pr_err("%s: Card is consuming too much power!\n", 3546 mmc_hostname(host->mmc)); 3547 3548 if (intmask & SDHCI_INT_RETUNE) 3549 mmc_retune_needed(host->mmc); 3550 3551 if ((intmask & SDHCI_INT_CARD_INT) && 3552 (host->ier & SDHCI_INT_CARD_INT)) { 3553 sdhci_enable_sdio_irq_nolock(host, false); 3554 sdio_signal_irq(host->mmc); 3555 } 3556 3557 intmask &= ~(SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE | 3558 SDHCI_INT_CMD_MASK | SDHCI_INT_DATA_MASK | 3559 SDHCI_INT_ERROR | SDHCI_INT_BUS_POWER | 3560 SDHCI_INT_RETUNE | SDHCI_INT_CARD_INT); 3561 3562 if (intmask) { 3563 unexpected |= intmask; 3564 sdhci_writel(host, intmask, SDHCI_INT_STATUS); 3565 } 3566 cont: 3567 if (result == IRQ_NONE) 3568 result = IRQ_HANDLED; 3569 3570 intmask = sdhci_readl(host, SDHCI_INT_STATUS); 3571 } while (intmask && --max_loops); 3572 3573 /* Determine if mrqs can be completed immediately */ 3574 for (i = 0; i < SDHCI_MAX_MRQS; i++) { 3575 struct mmc_request *mrq = host->mrqs_done[i]; 3576 3577 if (!mrq) 3578 continue; 3579 3580 if (sdhci_defer_done(host, mrq)) { 3581 result = IRQ_WAKE_THREAD; 3582 } else { 3583 mrqs_done[i] = mrq; 3584 host->mrqs_done[i] = NULL; 3585 } 3586 } 3587 out: 3588 if (host->deferred_cmd) 3589 result = IRQ_WAKE_THREAD; 3590 3591 spin_unlock(&host->lock); 3592 3593 /* Process mrqs ready for immediate completion */ 3594 for (i = 0; i < SDHCI_MAX_MRQS; i++) { 3595 if (!mrqs_done[i]) 3596 continue; 3597 3598 if (host->ops->request_done) 3599 host->ops->request_done(host, mrqs_done[i]); 3600 else 3601 mmc_request_done(host->mmc, mrqs_done[i]); 3602 } 3603 3604 if (unexpected) { 3605 pr_err("%s: Unexpected interrupt 0x%08x.\n", 3606 mmc_hostname(host->mmc), unexpected); 3607 sdhci_err_stats_inc(host, UNEXPECTED_IRQ); 3608 sdhci_dumpregs(host); 3609 } 3610 3611 return result; 3612 } 3613 3614 static irqreturn_t sdhci_thread_irq(int irq, void *dev_id) 3615 { 3616 struct sdhci_host *host = dev_id; 3617 struct mmc_command *cmd; 3618 unsigned long flags; 3619 u32 isr; 3620 3621 while (!sdhci_request_done(host)) 3622 ; 3623 3624 spin_lock_irqsave(&host->lock, flags); 3625 3626 isr = host->thread_isr; 3627 host->thread_isr = 0; 3628 3629 cmd = host->deferred_cmd; 3630 if (cmd && !sdhci_send_command_retry(host, cmd, flags)) 3631 sdhci_finish_mrq(host, cmd->mrq); 3632 3633 spin_unlock_irqrestore(&host->lock, flags); 3634 3635 if (isr & (SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE)) { 3636 struct mmc_host *mmc = host->mmc; 3637 3638 mmc->ops->card_event(mmc); 3639 mmc_detect_change(mmc, msecs_to_jiffies(200)); 3640 } 3641 3642 return IRQ_HANDLED; 3643 } 3644 3645 /*****************************************************************************\ 3646 * * 3647 * Suspend/resume * 3648 * * 3649 \*****************************************************************************/ 3650 3651 #ifdef CONFIG_PM 3652 3653 static bool sdhci_cd_irq_can_wakeup(struct sdhci_host *host) 3654 { 3655 return mmc_card_is_removable(host->mmc) && 3656 !(host->quirks & SDHCI_QUIRK_BROKEN_CARD_DETECTION) && 3657 !mmc_can_gpio_cd(host->mmc); 3658 } 3659 3660 /* 3661 * To enable wakeup events, the corresponding events have to be enabled in 3662 * the Interrupt Status Enable register too. See 'Table 1-6: Wakeup Signal 3663 * Table' in the SD Host Controller Standard Specification. 3664 * It is useless to restore SDHCI_INT_ENABLE state in 3665 * sdhci_disable_irq_wakeups() since it will be set by 3666 * sdhci_enable_card_detection() or sdhci_init(). 3667 */ 3668 static bool sdhci_enable_irq_wakeups(struct sdhci_host *host) 3669 { 3670 u8 mask = SDHCI_WAKE_ON_INSERT | SDHCI_WAKE_ON_REMOVE | 3671 SDHCI_WAKE_ON_INT; 3672 u32 irq_val = 0; 3673 u8 wake_val = 0; 3674 u8 val; 3675 3676 if (sdhci_cd_irq_can_wakeup(host)) { 3677 wake_val |= SDHCI_WAKE_ON_INSERT | SDHCI_WAKE_ON_REMOVE; 3678 irq_val |= SDHCI_INT_CARD_INSERT | SDHCI_INT_CARD_REMOVE; 3679 } 3680 3681 if (mmc_card_wake_sdio_irq(host->mmc)) { 3682 wake_val |= SDHCI_WAKE_ON_INT; 3683 irq_val |= SDHCI_INT_CARD_INT; 3684 } 3685 3686 if (!irq_val) 3687 return false; 3688 3689 val = sdhci_readb(host, SDHCI_WAKE_UP_CONTROL); 3690 val &= ~mask; 3691 val |= wake_val; 3692 sdhci_writeb(host, val, SDHCI_WAKE_UP_CONTROL); 3693 3694 sdhci_writel(host, irq_val, SDHCI_INT_ENABLE); 3695 3696 host->irq_wake_enabled = !enable_irq_wake(host->irq); 3697 3698 return host->irq_wake_enabled; 3699 } 3700 3701 static void sdhci_disable_irq_wakeups(struct sdhci_host *host) 3702 { 3703 u8 val; 3704 u8 mask = SDHCI_WAKE_ON_INSERT | SDHCI_WAKE_ON_REMOVE 3705 | SDHCI_WAKE_ON_INT; 3706 3707 val = sdhci_readb(host, SDHCI_WAKE_UP_CONTROL); 3708 val &= ~mask; 3709 sdhci_writeb(host, val, SDHCI_WAKE_UP_CONTROL); 3710 3711 disable_irq_wake(host->irq); 3712 3713 host->irq_wake_enabled = false; 3714 } 3715 3716 int sdhci_suspend_host(struct sdhci_host *host) 3717 { 3718 sdhci_disable_card_detection(host); 3719 3720 mmc_retune_timer_stop(host->mmc); 3721 3722 if (!device_may_wakeup(mmc_dev(host->mmc)) || 3723 !sdhci_enable_irq_wakeups(host)) { 3724 host->ier = 0; 3725 sdhci_writel(host, 0, SDHCI_INT_ENABLE); 3726 sdhci_writel(host, 0, SDHCI_SIGNAL_ENABLE); 3727 free_irq(host->irq, host); 3728 } 3729 3730 return 0; 3731 } 3732 3733 EXPORT_SYMBOL_GPL(sdhci_suspend_host); 3734 3735 int sdhci_resume_host(struct sdhci_host *host) 3736 { 3737 struct mmc_host *mmc = host->mmc; 3738 int ret = 0; 3739 3740 if (host->flags & (SDHCI_USE_SDMA | SDHCI_USE_ADMA)) { 3741 if (host->ops->enable_dma) 3742 host->ops->enable_dma(host); 3743 } 3744 3745 if ((mmc->pm_flags & MMC_PM_KEEP_POWER) && 3746 (host->quirks2 & SDHCI_QUIRK2_HOST_OFF_CARD_ON)) { 3747 /* Card keeps power but host controller does not */ 3748 sdhci_init(host, 0); 3749 host->pwr = 0; 3750 host->clock = 0; 3751 mmc->ops->set_ios(mmc, &mmc->ios); 3752 } else { 3753 sdhci_init(host, (mmc->pm_flags & MMC_PM_KEEP_POWER)); 3754 } 3755 3756 if (host->irq_wake_enabled) { 3757 sdhci_disable_irq_wakeups(host); 3758 } else { 3759 ret = request_threaded_irq(host->irq, sdhci_irq, 3760 sdhci_thread_irq, IRQF_SHARED, 3761 mmc_hostname(mmc), host); 3762 if (ret) 3763 return ret; 3764 } 3765 3766 sdhci_enable_card_detection(host); 3767 3768 return ret; 3769 } 3770 3771 EXPORT_SYMBOL_GPL(sdhci_resume_host); 3772 3773 int sdhci_runtime_suspend_host(struct sdhci_host *host) 3774 { 3775 unsigned long flags; 3776 3777 mmc_retune_timer_stop(host->mmc); 3778 3779 spin_lock_irqsave(&host->lock, flags); 3780 host->ier &= SDHCI_INT_CARD_INT; 3781 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 3782 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 3783 spin_unlock_irqrestore(&host->lock, flags); 3784 3785 synchronize_hardirq(host->irq); 3786 3787 spin_lock_irqsave(&host->lock, flags); 3788 host->runtime_suspended = true; 3789 spin_unlock_irqrestore(&host->lock, flags); 3790 3791 return 0; 3792 } 3793 EXPORT_SYMBOL_GPL(sdhci_runtime_suspend_host); 3794 3795 int sdhci_runtime_resume_host(struct sdhci_host *host, int soft_reset) 3796 { 3797 struct mmc_host *mmc = host->mmc; 3798 unsigned long flags; 3799 int host_flags = host->flags; 3800 3801 if (host_flags & (SDHCI_USE_SDMA | SDHCI_USE_ADMA)) { 3802 if (host->ops->enable_dma) 3803 host->ops->enable_dma(host); 3804 } 3805 3806 sdhci_init(host, soft_reset); 3807 3808 if (mmc->ios.power_mode != MMC_POWER_UNDEFINED && 3809 mmc->ios.power_mode != MMC_POWER_OFF) { 3810 /* Force clock and power re-program */ 3811 host->pwr = 0; 3812 host->clock = 0; 3813 mmc->ops->start_signal_voltage_switch(mmc, &mmc->ios); 3814 mmc->ops->set_ios(mmc, &mmc->ios); 3815 3816 if ((host_flags & SDHCI_PV_ENABLED) && 3817 !(host->quirks2 & SDHCI_QUIRK2_PRESET_VALUE_BROKEN)) { 3818 spin_lock_irqsave(&host->lock, flags); 3819 sdhci_enable_preset_value(host, true); 3820 spin_unlock_irqrestore(&host->lock, flags); 3821 } 3822 3823 if ((mmc->caps2 & MMC_CAP2_HS400_ES) && 3824 mmc->ops->hs400_enhanced_strobe) 3825 mmc->ops->hs400_enhanced_strobe(mmc, &mmc->ios); 3826 } 3827 3828 spin_lock_irqsave(&host->lock, flags); 3829 3830 host->runtime_suspended = false; 3831 3832 /* Enable SDIO IRQ */ 3833 if (sdio_irq_claimed(mmc)) 3834 sdhci_enable_sdio_irq_nolock(host, true); 3835 3836 /* Enable Card Detection */ 3837 sdhci_enable_card_detection(host); 3838 3839 spin_unlock_irqrestore(&host->lock, flags); 3840 3841 return 0; 3842 } 3843 EXPORT_SYMBOL_GPL(sdhci_runtime_resume_host); 3844 3845 #endif /* CONFIG_PM */ 3846 3847 /*****************************************************************************\ 3848 * * 3849 * Command Queue Engine (CQE) helpers * 3850 * * 3851 \*****************************************************************************/ 3852 3853 void sdhci_cqe_enable(struct mmc_host *mmc) 3854 { 3855 struct sdhci_host *host = mmc_priv(mmc); 3856 unsigned long flags; 3857 u8 ctrl; 3858 3859 spin_lock_irqsave(&host->lock, flags); 3860 3861 ctrl = sdhci_readb(host, SDHCI_HOST_CONTROL); 3862 ctrl &= ~SDHCI_CTRL_DMA_MASK; 3863 /* 3864 * Host from V4.10 supports ADMA3 DMA type. 3865 * ADMA3 performs integrated descriptor which is more suitable 3866 * for cmd queuing to fetch both command and transfer descriptors. 3867 */ 3868 if (host->v4_mode && (host->caps1 & SDHCI_CAN_DO_ADMA3)) 3869 ctrl |= SDHCI_CTRL_ADMA3; 3870 else if (host->flags & SDHCI_USE_64_BIT_DMA) 3871 ctrl |= SDHCI_CTRL_ADMA64; 3872 else 3873 ctrl |= SDHCI_CTRL_ADMA32; 3874 sdhci_writeb(host, ctrl, SDHCI_HOST_CONTROL); 3875 3876 sdhci_writew(host, SDHCI_MAKE_BLKSZ(host->sdma_boundary, 512), 3877 SDHCI_BLOCK_SIZE); 3878 3879 /* Set maximum timeout */ 3880 sdhci_set_timeout(host, NULL); 3881 3882 host->ier = host->cqe_ier; 3883 3884 sdhci_writel(host, host->ier, SDHCI_INT_ENABLE); 3885 sdhci_writel(host, host->ier, SDHCI_SIGNAL_ENABLE); 3886 3887 host->cqe_on = true; 3888 3889 pr_debug("%s: sdhci: CQE on, IRQ mask %#x, IRQ status %#x\n", 3890 mmc_hostname(mmc), host->ier, 3891 sdhci_readl(host, SDHCI_INT_STATUS)); 3892 3893 spin_unlock_irqrestore(&host->lock, flags); 3894 } 3895 EXPORT_SYMBOL_GPL(sdhci_cqe_enable); 3896 3897 void sdhci_cqe_disable(struct mmc_host *mmc, bool recovery) 3898 { 3899 struct sdhci_host *host = mmc_priv(mmc); 3900 unsigned long flags; 3901 3902 spin_lock_irqsave(&host->lock, flags); 3903 3904 sdhci_set_default_irqs(host); 3905 3906 host->cqe_on = false; 3907 3908 if (recovery) { 3909 sdhci_do_reset(host, SDHCI_RESET_CMD); 3910 sdhci_do_reset(host, SDHCI_RESET_DATA); 3911 } 3912 3913 pr_debug("%s: sdhci: CQE off, IRQ mask %#x, IRQ status %#x\n", 3914 mmc_hostname(mmc), host->ier, 3915 sdhci_readl(host, SDHCI_INT_STATUS)); 3916 3917 spin_unlock_irqrestore(&host->lock, flags); 3918 } 3919 EXPORT_SYMBOL_GPL(sdhci_cqe_disable); 3920 3921 bool sdhci_cqe_irq(struct sdhci_host *host, u32 intmask, int *cmd_error, 3922 int *data_error) 3923 { 3924 u32 mask; 3925 3926 if (!host->cqe_on) 3927 return false; 3928 3929 if (intmask & (SDHCI_INT_INDEX | SDHCI_INT_END_BIT | SDHCI_INT_CRC)) { 3930 *cmd_error = -EILSEQ; 3931 if (!mmc_op_tuning(host->cmd->opcode)) 3932 sdhci_err_stats_inc(host, CMD_CRC); 3933 } else if (intmask & SDHCI_INT_TIMEOUT) { 3934 *cmd_error = -ETIMEDOUT; 3935 sdhci_err_stats_inc(host, CMD_TIMEOUT); 3936 } else 3937 *cmd_error = 0; 3938 3939 if (intmask & (SDHCI_INT_DATA_END_BIT | SDHCI_INT_DATA_CRC)) { 3940 *data_error = -EILSEQ; 3941 if (!mmc_op_tuning(host->cmd->opcode)) 3942 sdhci_err_stats_inc(host, DAT_CRC); 3943 } else if (intmask & SDHCI_INT_DATA_TIMEOUT) { 3944 *data_error = -ETIMEDOUT; 3945 sdhci_err_stats_inc(host, DAT_TIMEOUT); 3946 } else if (intmask & SDHCI_INT_ADMA_ERROR) { 3947 *data_error = -EIO; 3948 sdhci_err_stats_inc(host, ADMA); 3949 } else 3950 *data_error = 0; 3951 3952 /* Clear selected interrupts. */ 3953 mask = intmask & host->cqe_ier; 3954 sdhci_writel(host, mask, SDHCI_INT_STATUS); 3955 3956 if (intmask & SDHCI_INT_BUS_POWER) 3957 pr_err("%s: Card is consuming too much power!\n", 3958 mmc_hostname(host->mmc)); 3959 3960 intmask &= ~(host->cqe_ier | SDHCI_INT_ERROR); 3961 if (intmask) { 3962 sdhci_writel(host, intmask, SDHCI_INT_STATUS); 3963 pr_err("%s: CQE: Unexpected interrupt 0x%08x.\n", 3964 mmc_hostname(host->mmc), intmask); 3965 sdhci_err_stats_inc(host, UNEXPECTED_IRQ); 3966 sdhci_dumpregs(host); 3967 } 3968 3969 return true; 3970 } 3971 EXPORT_SYMBOL_GPL(sdhci_cqe_irq); 3972 3973 /*****************************************************************************\ 3974 * * 3975 * Device allocation/registration * 3976 * * 3977 \*****************************************************************************/ 3978 3979 struct sdhci_host *sdhci_alloc_host(struct device *dev, 3980 size_t priv_size) 3981 { 3982 struct mmc_host *mmc; 3983 struct sdhci_host *host; 3984 3985 WARN_ON(dev == NULL); 3986 3987 mmc = mmc_alloc_host(sizeof(struct sdhci_host) + priv_size, dev); 3988 if (!mmc) 3989 return ERR_PTR(-ENOMEM); 3990 3991 host = mmc_priv(mmc); 3992 host->mmc = mmc; 3993 host->mmc_host_ops = sdhci_ops; 3994 mmc->ops = &host->mmc_host_ops; 3995 3996 host->flags = SDHCI_SIGNALING_330; 3997 3998 host->cqe_ier = SDHCI_CQE_INT_MASK; 3999 host->cqe_err_ier = SDHCI_CQE_INT_ERR_MASK; 4000 4001 host->tuning_delay = -1; 4002 host->tuning_loop_count = MAX_TUNING_LOOP; 4003 4004 host->sdma_boundary = SDHCI_DEFAULT_BOUNDARY_ARG; 4005 4006 /* 4007 * The DMA table descriptor count is calculated as the maximum 4008 * number of segments times 2, to allow for an alignment 4009 * descriptor for each segment, plus 1 for a nop end descriptor. 4010 */ 4011 host->adma_table_cnt = SDHCI_MAX_SEGS * 2 + 1; 4012 host->max_adma = 65536; 4013 4014 host->max_timeout_count = 0xE; 4015 4016 return host; 4017 } 4018 4019 EXPORT_SYMBOL_GPL(sdhci_alloc_host); 4020 4021 static int sdhci_set_dma_mask(struct sdhci_host *host) 4022 { 4023 struct mmc_host *mmc = host->mmc; 4024 struct device *dev = mmc_dev(mmc); 4025 int ret = -EINVAL; 4026 4027 if (host->quirks2 & SDHCI_QUIRK2_BROKEN_64_BIT_DMA) 4028 host->flags &= ~SDHCI_USE_64_BIT_DMA; 4029 4030 /* Try 64-bit mask if hardware is capable of it */ 4031 if (host->flags & SDHCI_USE_64_BIT_DMA) { 4032 ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(64)); 4033 if (ret) { 4034 pr_warn("%s: Failed to set 64-bit DMA mask.\n", 4035 mmc_hostname(mmc)); 4036 host->flags &= ~SDHCI_USE_64_BIT_DMA; 4037 } 4038 } 4039 4040 /* 32-bit mask as default & fallback */ 4041 if (ret) { 4042 ret = dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32)); 4043 if (ret) 4044 pr_warn("%s: Failed to set 32-bit DMA mask.\n", 4045 mmc_hostname(mmc)); 4046 } 4047 4048 return ret; 4049 } 4050 4051 void __sdhci_read_caps(struct sdhci_host *host, const u16 *ver, 4052 const u32 *caps, const u32 *caps1) 4053 { 4054 u16 v; 4055 u64 dt_caps_mask = 0; 4056 u64 dt_caps = 0; 4057 4058 if (host->read_caps) 4059 return; 4060 4061 host->read_caps = true; 4062 4063 if (debug_quirks) 4064 host->quirks = debug_quirks; 4065 4066 if (debug_quirks2) 4067 host->quirks2 = debug_quirks2; 4068 4069 sdhci_do_reset(host, SDHCI_RESET_ALL); 4070 4071 if (host->v4_mode) 4072 sdhci_do_enable_v4_mode(host); 4073 4074 device_property_read_u64(mmc_dev(host->mmc), 4075 "sdhci-caps-mask", &dt_caps_mask); 4076 device_property_read_u64(mmc_dev(host->mmc), 4077 "sdhci-caps", &dt_caps); 4078 4079 v = ver ? *ver : sdhci_readw(host, SDHCI_HOST_VERSION); 4080 host->version = (v & SDHCI_SPEC_VER_MASK) >> SDHCI_SPEC_VER_SHIFT; 4081 4082 if (host->quirks & SDHCI_QUIRK_MISSING_CAPS) 4083 return; 4084 4085 if (caps) { 4086 host->caps = *caps; 4087 } else { 4088 host->caps = sdhci_readl(host, SDHCI_CAPABILITIES); 4089 host->caps &= ~lower_32_bits(dt_caps_mask); 4090 host->caps |= lower_32_bits(dt_caps); 4091 } 4092 4093 if (host->version < SDHCI_SPEC_300) 4094 return; 4095 4096 if (caps1) { 4097 host->caps1 = *caps1; 4098 } else { 4099 host->caps1 = sdhci_readl(host, SDHCI_CAPABILITIES_1); 4100 host->caps1 &= ~upper_32_bits(dt_caps_mask); 4101 host->caps1 |= upper_32_bits(dt_caps); 4102 } 4103 } 4104 EXPORT_SYMBOL_GPL(__sdhci_read_caps); 4105 4106 static void sdhci_allocate_bounce_buffer(struct sdhci_host *host) 4107 { 4108 struct mmc_host *mmc = host->mmc; 4109 unsigned int max_blocks; 4110 unsigned int bounce_size; 4111 int ret; 4112 4113 /* 4114 * Cap the bounce buffer at 64KB. Using a bigger bounce buffer 4115 * has diminishing returns, this is probably because SD/MMC 4116 * cards are usually optimized to handle this size of requests. 4117 */ 4118 bounce_size = SZ_64K; 4119 /* 4120 * Adjust downwards to maximum request size if this is less 4121 * than our segment size, else hammer down the maximum 4122 * request size to the maximum buffer size. 4123 */ 4124 if (mmc->max_req_size < bounce_size) 4125 bounce_size = mmc->max_req_size; 4126 max_blocks = bounce_size / 512; 4127 4128 /* 4129 * When we just support one segment, we can get significant 4130 * speedups by the help of a bounce buffer to group scattered 4131 * reads/writes together. 4132 */ 4133 host->bounce_buffer = devm_kmalloc(mmc_dev(mmc), 4134 bounce_size, 4135 GFP_KERNEL); 4136 if (!host->bounce_buffer) { 4137 pr_err("%s: failed to allocate %u bytes for bounce buffer, falling back to single segments\n", 4138 mmc_hostname(mmc), 4139 bounce_size); 4140 /* 4141 * Exiting with zero here makes sure we proceed with 4142 * mmc->max_segs == 1. 4143 */ 4144 return; 4145 } 4146 4147 host->bounce_addr = dma_map_single(mmc_dev(mmc), 4148 host->bounce_buffer, 4149 bounce_size, 4150 DMA_BIDIRECTIONAL); 4151 ret = dma_mapping_error(mmc_dev(mmc), host->bounce_addr); 4152 if (ret) { 4153 devm_kfree(mmc_dev(mmc), host->bounce_buffer); 4154 host->bounce_buffer = NULL; 4155 /* Again fall back to max_segs == 1 */ 4156 return; 4157 } 4158 4159 host->bounce_buffer_size = bounce_size; 4160 4161 /* Lie about this since we're bouncing */ 4162 mmc->max_segs = max_blocks; 4163 mmc->max_seg_size = bounce_size; 4164 mmc->max_req_size = bounce_size; 4165 4166 pr_info("%s bounce up to %u segments into one, max segment size %u bytes\n", 4167 mmc_hostname(mmc), max_blocks, bounce_size); 4168 } 4169 4170 static inline bool sdhci_can_64bit_dma(struct sdhci_host *host) 4171 { 4172 /* 4173 * According to SD Host Controller spec v4.10, bit[27] added from 4174 * version 4.10 in Capabilities Register is used as 64-bit System 4175 * Address support for V4 mode. 4176 */ 4177 if (host->version >= SDHCI_SPEC_410 && host->v4_mode) 4178 return host->caps & SDHCI_CAN_64BIT_V4; 4179 4180 return host->caps & SDHCI_CAN_64BIT; 4181 } 4182 4183 int sdhci_setup_host(struct sdhci_host *host) 4184 { 4185 struct mmc_host *mmc; 4186 u32 max_current_caps; 4187 unsigned int ocr_avail; 4188 unsigned int override_timeout_clk; 4189 u32 max_clk; 4190 int ret = 0; 4191 bool enable_vqmmc = false; 4192 4193 WARN_ON(host == NULL); 4194 if (host == NULL) 4195 return -EINVAL; 4196 4197 mmc = host->mmc; 4198 4199 /* 4200 * If there are external regulators, get them. Note this must be done 4201 * early before resetting the host and reading the capabilities so that 4202 * the host can take the appropriate action if regulators are not 4203 * available. 4204 */ 4205 if (!mmc->supply.vqmmc) { 4206 ret = mmc_regulator_get_supply(mmc); 4207 if (ret) 4208 return ret; 4209 enable_vqmmc = true; 4210 } 4211 4212 DBG("Version: 0x%08x | Present: 0x%08x\n", 4213 sdhci_readw(host, SDHCI_HOST_VERSION), 4214 sdhci_readl(host, SDHCI_PRESENT_STATE)); 4215 DBG("Caps: 0x%08x | Caps_1: 0x%08x\n", 4216 sdhci_readl(host, SDHCI_CAPABILITIES), 4217 sdhci_readl(host, SDHCI_CAPABILITIES_1)); 4218 4219 sdhci_read_caps(host); 4220 4221 override_timeout_clk = host->timeout_clk; 4222 4223 if (host->version > SDHCI_SPEC_420) { 4224 pr_err("%s: Unknown controller version (%d). You may experience problems.\n", 4225 mmc_hostname(mmc), host->version); 4226 } 4227 4228 if (host->quirks & SDHCI_QUIRK_FORCE_DMA) 4229 host->flags |= SDHCI_USE_SDMA; 4230 else if (!(host->caps & SDHCI_CAN_DO_SDMA)) 4231 DBG("Controller doesn't have SDMA capability\n"); 4232 else 4233 host->flags |= SDHCI_USE_SDMA; 4234 4235 if ((host->quirks & SDHCI_QUIRK_BROKEN_DMA) && 4236 (host->flags & SDHCI_USE_SDMA)) { 4237 DBG("Disabling DMA as it is marked broken\n"); 4238 host->flags &= ~SDHCI_USE_SDMA; 4239 } 4240 4241 if ((host->version >= SDHCI_SPEC_200) && 4242 (host->caps & SDHCI_CAN_DO_ADMA2)) 4243 host->flags |= SDHCI_USE_ADMA; 4244 4245 if ((host->quirks & SDHCI_QUIRK_BROKEN_ADMA) && 4246 (host->flags & SDHCI_USE_ADMA)) { 4247 DBG("Disabling ADMA as it is marked broken\n"); 4248 host->flags &= ~SDHCI_USE_ADMA; 4249 } 4250 4251 if (sdhci_can_64bit_dma(host)) 4252 host->flags |= SDHCI_USE_64_BIT_DMA; 4253 4254 if (host->use_external_dma) { 4255 ret = sdhci_external_dma_init(host); 4256 if (ret == -EPROBE_DEFER) 4257 goto unreg; 4258 /* 4259 * Fall back to use the DMA/PIO integrated in standard SDHCI 4260 * instead of external DMA devices. 4261 */ 4262 else if (ret) 4263 sdhci_switch_external_dma(host, false); 4264 /* Disable internal DMA sources */ 4265 else 4266 host->flags &= ~(SDHCI_USE_SDMA | SDHCI_USE_ADMA); 4267 } 4268 4269 if (host->flags & (SDHCI_USE_SDMA | SDHCI_USE_ADMA)) { 4270 if (host->ops->set_dma_mask) 4271 ret = host->ops->set_dma_mask(host); 4272 else 4273 ret = sdhci_set_dma_mask(host); 4274 4275 if (!ret && host->ops->enable_dma) 4276 ret = host->ops->enable_dma(host); 4277 4278 if (ret) { 4279 pr_warn("%s: No suitable DMA available - falling back to PIO\n", 4280 mmc_hostname(mmc)); 4281 host->flags &= ~(SDHCI_USE_SDMA | SDHCI_USE_ADMA); 4282 4283 ret = 0; 4284 } 4285 } 4286 4287 /* SDMA does not support 64-bit DMA if v4 mode not set */ 4288 if ((host->flags & SDHCI_USE_64_BIT_DMA) && !host->v4_mode) 4289 host->flags &= ~SDHCI_USE_SDMA; 4290 4291 if (host->flags & SDHCI_USE_ADMA) { 4292 dma_addr_t dma; 4293 void *buf; 4294 4295 if (!(host->flags & SDHCI_USE_64_BIT_DMA)) 4296 host->alloc_desc_sz = SDHCI_ADMA2_32_DESC_SZ; 4297 else if (!host->alloc_desc_sz) 4298 host->alloc_desc_sz = SDHCI_ADMA2_64_DESC_SZ(host); 4299 4300 host->desc_sz = host->alloc_desc_sz; 4301 host->adma_table_sz = host->adma_table_cnt * host->desc_sz; 4302 4303 host->align_buffer_sz = SDHCI_MAX_SEGS * SDHCI_ADMA2_ALIGN; 4304 /* 4305 * Use zalloc to zero the reserved high 32-bits of 128-bit 4306 * descriptors so that they never need to be written. 4307 */ 4308 buf = dma_alloc_coherent(mmc_dev(mmc), 4309 host->align_buffer_sz + host->adma_table_sz, 4310 &dma, GFP_KERNEL); 4311 if (!buf) { 4312 pr_warn("%s: Unable to allocate ADMA buffers - falling back to standard DMA\n", 4313 mmc_hostname(mmc)); 4314 host->flags &= ~SDHCI_USE_ADMA; 4315 } else if ((dma + host->align_buffer_sz) & 4316 (SDHCI_ADMA2_DESC_ALIGN - 1)) { 4317 pr_warn("%s: unable to allocate aligned ADMA descriptor\n", 4318 mmc_hostname(mmc)); 4319 host->flags &= ~SDHCI_USE_ADMA; 4320 dma_free_coherent(mmc_dev(mmc), host->align_buffer_sz + 4321 host->adma_table_sz, buf, dma); 4322 } else { 4323 host->align_buffer = buf; 4324 host->align_addr = dma; 4325 4326 host->adma_table = buf + host->align_buffer_sz; 4327 host->adma_addr = dma + host->align_buffer_sz; 4328 } 4329 } 4330 4331 /* 4332 * If we use DMA, then it's up to the caller to set the DMA 4333 * mask, but PIO does not need the hw shim so we set a new 4334 * mask here in that case. 4335 */ 4336 if (!(host->flags & (SDHCI_USE_SDMA | SDHCI_USE_ADMA))) { 4337 host->dma_mask = DMA_BIT_MASK(64); 4338 mmc_dev(mmc)->dma_mask = &host->dma_mask; 4339 } 4340 4341 if (host->version >= SDHCI_SPEC_300) 4342 host->max_clk = FIELD_GET(SDHCI_CLOCK_V3_BASE_MASK, host->caps); 4343 else 4344 host->max_clk = FIELD_GET(SDHCI_CLOCK_BASE_MASK, host->caps); 4345 4346 host->max_clk *= 1000000; 4347 if (host->max_clk == 0 || host->quirks & 4348 SDHCI_QUIRK_CAP_CLOCK_BASE_BROKEN) { 4349 if (!host->ops->get_max_clock) { 4350 pr_err("%s: Hardware doesn't specify base clock frequency.\n", 4351 mmc_hostname(mmc)); 4352 ret = -ENODEV; 4353 goto undma; 4354 } 4355 host->max_clk = host->ops->get_max_clock(host); 4356 } 4357 4358 /* 4359 * In case of Host Controller v3.00, find out whether clock 4360 * multiplier is supported. 4361 */ 4362 host->clk_mul = FIELD_GET(SDHCI_CLOCK_MUL_MASK, host->caps1); 4363 4364 /* 4365 * In case the value in Clock Multiplier is 0, then programmable 4366 * clock mode is not supported, otherwise the actual clock 4367 * multiplier is one more than the value of Clock Multiplier 4368 * in the Capabilities Register. 4369 */ 4370 if (host->clk_mul) 4371 host->clk_mul += 1; 4372 4373 /* 4374 * Set host parameters. 4375 */ 4376 max_clk = host->max_clk; 4377 4378 if (host->ops->get_min_clock) 4379 mmc->f_min = host->ops->get_min_clock(host); 4380 else if (host->version >= SDHCI_SPEC_300) { 4381 if (host->clk_mul) 4382 max_clk = host->max_clk * host->clk_mul; 4383 /* 4384 * Divided Clock Mode minimum clock rate is always less than 4385 * Programmable Clock Mode minimum clock rate. 4386 */ 4387 mmc->f_min = host->max_clk / SDHCI_MAX_DIV_SPEC_300; 4388 } else 4389 mmc->f_min = host->max_clk / SDHCI_MAX_DIV_SPEC_200; 4390 4391 if (!mmc->f_max || mmc->f_max > max_clk) 4392 mmc->f_max = max_clk; 4393 4394 if (!(host->quirks & SDHCI_QUIRK_DATA_TIMEOUT_USES_SDCLK)) { 4395 host->timeout_clk = FIELD_GET(SDHCI_TIMEOUT_CLK_MASK, host->caps); 4396 4397 if (host->caps & SDHCI_TIMEOUT_CLK_UNIT) 4398 host->timeout_clk *= 1000; 4399 4400 if (host->timeout_clk == 0) { 4401 if (!host->ops->get_timeout_clock) { 4402 pr_err("%s: Hardware doesn't specify timeout clock frequency.\n", 4403 mmc_hostname(mmc)); 4404 ret = -ENODEV; 4405 goto undma; 4406 } 4407 4408 host->timeout_clk = 4409 DIV_ROUND_UP(host->ops->get_timeout_clock(host), 4410 1000); 4411 } 4412 4413 if (override_timeout_clk) 4414 host->timeout_clk = override_timeout_clk; 4415 4416 mmc->max_busy_timeout = host->ops->get_max_timeout_count ? 4417 host->ops->get_max_timeout_count(host) : 1 << 27; 4418 mmc->max_busy_timeout /= host->timeout_clk; 4419 } 4420 4421 if (host->quirks2 & SDHCI_QUIRK2_DISABLE_HW_TIMEOUT && 4422 !host->ops->get_max_timeout_count) 4423 mmc->max_busy_timeout = 0; 4424 4425 mmc->caps |= MMC_CAP_SDIO_IRQ | MMC_CAP_CMD23; 4426 mmc->caps2 |= MMC_CAP2_SDIO_IRQ_NOTHREAD; 4427 4428 if (host->quirks & SDHCI_QUIRK_MULTIBLOCK_READ_ACMD12) 4429 host->flags |= SDHCI_AUTO_CMD12; 4430 4431 /* 4432 * For v3 mode, Auto-CMD23 stuff only works in ADMA or PIO. 4433 * For v4 mode, SDMA may use Auto-CMD23 as well. 4434 */ 4435 if ((host->version >= SDHCI_SPEC_300) && 4436 ((host->flags & SDHCI_USE_ADMA) || 4437 !(host->flags & SDHCI_USE_SDMA) || host->v4_mode) && 4438 !(host->quirks2 & SDHCI_QUIRK2_ACMD23_BROKEN)) { 4439 host->flags |= SDHCI_AUTO_CMD23; 4440 DBG("Auto-CMD23 available\n"); 4441 } else { 4442 DBG("Auto-CMD23 unavailable\n"); 4443 } 4444 4445 /* 4446 * A controller may support 8-bit width, but the board itself 4447 * might not have the pins brought out. Boards that support 4448 * 8-bit width must set "mmc->caps |= MMC_CAP_8_BIT_DATA;" in 4449 * their platform code before calling sdhci_add_host(), and we 4450 * won't assume 8-bit width for hosts without that CAP. 4451 */ 4452 if (!(host->quirks & SDHCI_QUIRK_FORCE_1_BIT_DATA)) 4453 mmc->caps |= MMC_CAP_4_BIT_DATA; 4454 4455 if (host->quirks2 & SDHCI_QUIRK2_HOST_NO_CMD23) 4456 mmc->caps &= ~MMC_CAP_CMD23; 4457 4458 if (host->caps & SDHCI_CAN_DO_HISPD) 4459 mmc->caps |= MMC_CAP_SD_HIGHSPEED | MMC_CAP_MMC_HIGHSPEED; 4460 4461 if ((host->quirks & SDHCI_QUIRK_BROKEN_CARD_DETECTION) && 4462 mmc_card_is_removable(mmc) && 4463 mmc_gpio_get_cd(mmc) < 0) 4464 mmc->caps |= MMC_CAP_NEEDS_POLL; 4465 4466 if (!IS_ERR(mmc->supply.vqmmc)) { 4467 if (enable_vqmmc) { 4468 ret = regulator_enable(mmc->supply.vqmmc); 4469 host->sdhci_core_to_disable_vqmmc = !ret; 4470 } 4471 4472 /* If vqmmc provides no 1.8V signalling, then there's no UHS */ 4473 if (!regulator_is_supported_voltage(mmc->supply.vqmmc, 1700000, 4474 1950000)) 4475 host->caps1 &= ~(SDHCI_SUPPORT_SDR104 | 4476 SDHCI_SUPPORT_SDR50 | 4477 SDHCI_SUPPORT_DDR50); 4478 4479 /* In eMMC case vqmmc might be a fixed 1.8V regulator */ 4480 if (!regulator_is_supported_voltage(mmc->supply.vqmmc, 2700000, 4481 3600000)) 4482 host->flags &= ~SDHCI_SIGNALING_330; 4483 4484 if (ret) { 4485 pr_warn("%s: Failed to enable vqmmc regulator: %d\n", 4486 mmc_hostname(mmc), ret); 4487 mmc->supply.vqmmc = ERR_PTR(-EINVAL); 4488 } 4489 4490 } 4491 4492 if (host->quirks2 & SDHCI_QUIRK2_NO_1_8_V) { 4493 host->caps1 &= ~(SDHCI_SUPPORT_SDR104 | SDHCI_SUPPORT_SDR50 | 4494 SDHCI_SUPPORT_DDR50); 4495 /* 4496 * The SDHCI controller in a SoC might support HS200/HS400 4497 * (indicated using mmc-hs200-1_8v/mmc-hs400-1_8v dt property), 4498 * but if the board is modeled such that the IO lines are not 4499 * connected to 1.8v then HS200/HS400 cannot be supported. 4500 * Disable HS200/HS400 if the board does not have 1.8v connected 4501 * to the IO lines. (Applicable for other modes in 1.8v) 4502 */ 4503 mmc->caps2 &= ~(MMC_CAP2_HSX00_1_8V | MMC_CAP2_HS400_ES); 4504 mmc->caps &= ~(MMC_CAP_1_8V_DDR | MMC_CAP_UHS); 4505 } 4506 4507 /* Any UHS-I mode in caps implies SDR12 and SDR25 support. */ 4508 if (host->caps1 & (SDHCI_SUPPORT_SDR104 | SDHCI_SUPPORT_SDR50 | 4509 SDHCI_SUPPORT_DDR50)) 4510 mmc->caps |= MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25; 4511 4512 /* SDR104 supports also implies SDR50 support */ 4513 if (host->caps1 & SDHCI_SUPPORT_SDR104) { 4514 mmc->caps |= MMC_CAP_UHS_SDR104 | MMC_CAP_UHS_SDR50; 4515 /* SD3.0: SDR104 is supported so (for eMMC) the caps2 4516 * field can be promoted to support HS200. 4517 */ 4518 if (!(host->quirks2 & SDHCI_QUIRK2_BROKEN_HS200)) 4519 mmc->caps2 |= MMC_CAP2_HS200; 4520 } else if (host->caps1 & SDHCI_SUPPORT_SDR50) { 4521 mmc->caps |= MMC_CAP_UHS_SDR50; 4522 } 4523 4524 if (host->quirks2 & SDHCI_QUIRK2_CAPS_BIT63_FOR_HS400 && 4525 (host->caps1 & SDHCI_SUPPORT_HS400)) 4526 mmc->caps2 |= MMC_CAP2_HS400; 4527 4528 if ((mmc->caps2 & MMC_CAP2_HSX00_1_2V) && 4529 (IS_ERR(mmc->supply.vqmmc) || 4530 !regulator_is_supported_voltage(mmc->supply.vqmmc, 1100000, 4531 1300000))) 4532 mmc->caps2 &= ~MMC_CAP2_HSX00_1_2V; 4533 4534 if ((host->caps1 & SDHCI_SUPPORT_DDR50) && 4535 !(host->quirks2 & SDHCI_QUIRK2_BROKEN_DDR50)) 4536 mmc->caps |= MMC_CAP_UHS_DDR50; 4537 4538 /* Does the host need tuning for SDR50? */ 4539 if (host->caps1 & SDHCI_USE_SDR50_TUNING) 4540 host->flags |= SDHCI_SDR50_NEEDS_TUNING; 4541 4542 /* Driver Type(s) (A, C, D) supported by the host */ 4543 if (host->caps1 & SDHCI_DRIVER_TYPE_A) 4544 mmc->caps |= MMC_CAP_DRIVER_TYPE_A; 4545 if (host->caps1 & SDHCI_DRIVER_TYPE_C) 4546 mmc->caps |= MMC_CAP_DRIVER_TYPE_C; 4547 if (host->caps1 & SDHCI_DRIVER_TYPE_D) 4548 mmc->caps |= MMC_CAP_DRIVER_TYPE_D; 4549 4550 /* Initial value for re-tuning timer count */ 4551 host->tuning_count = FIELD_GET(SDHCI_RETUNING_TIMER_COUNT_MASK, 4552 host->caps1); 4553 4554 /* 4555 * In case Re-tuning Timer is not disabled, the actual value of 4556 * re-tuning timer will be 2 ^ (n - 1). 4557 */ 4558 if (host->tuning_count) 4559 host->tuning_count = 1 << (host->tuning_count - 1); 4560 4561 /* Re-tuning mode supported by the Host Controller */ 4562 host->tuning_mode = FIELD_GET(SDHCI_RETUNING_MODE_MASK, host->caps1); 4563 4564 ocr_avail = 0; 4565 4566 /* 4567 * According to SD Host Controller spec v3.00, if the Host System 4568 * can afford more than 150mA, Host Driver should set XPC to 1. Also 4569 * the value is meaningful only if Voltage Support in the Capabilities 4570 * register is set. The actual current value is 4 times the register 4571 * value. 4572 */ 4573 max_current_caps = sdhci_readl(host, SDHCI_MAX_CURRENT); 4574 if (!max_current_caps && !IS_ERR(mmc->supply.vmmc)) { 4575 int curr = regulator_get_current_limit(mmc->supply.vmmc); 4576 if (curr > 0) { 4577 4578 /* convert to SDHCI_MAX_CURRENT format */ 4579 curr = curr/1000; /* convert to mA */ 4580 curr = curr/SDHCI_MAX_CURRENT_MULTIPLIER; 4581 4582 curr = min_t(u32, curr, SDHCI_MAX_CURRENT_LIMIT); 4583 max_current_caps = 4584 FIELD_PREP(SDHCI_MAX_CURRENT_330_MASK, curr) | 4585 FIELD_PREP(SDHCI_MAX_CURRENT_300_MASK, curr) | 4586 FIELD_PREP(SDHCI_MAX_CURRENT_180_MASK, curr); 4587 } 4588 } 4589 4590 if (host->caps & SDHCI_CAN_VDD_330) { 4591 ocr_avail |= MMC_VDD_32_33 | MMC_VDD_33_34; 4592 4593 mmc->max_current_330 = FIELD_GET(SDHCI_MAX_CURRENT_330_MASK, 4594 max_current_caps) * 4595 SDHCI_MAX_CURRENT_MULTIPLIER; 4596 } 4597 if (host->caps & SDHCI_CAN_VDD_300) { 4598 ocr_avail |= MMC_VDD_29_30 | MMC_VDD_30_31; 4599 4600 mmc->max_current_300 = FIELD_GET(SDHCI_MAX_CURRENT_300_MASK, 4601 max_current_caps) * 4602 SDHCI_MAX_CURRENT_MULTIPLIER; 4603 } 4604 if (host->caps & SDHCI_CAN_VDD_180) { 4605 ocr_avail |= MMC_VDD_165_195; 4606 4607 mmc->max_current_180 = FIELD_GET(SDHCI_MAX_CURRENT_180_MASK, 4608 max_current_caps) * 4609 SDHCI_MAX_CURRENT_MULTIPLIER; 4610 } 4611 4612 /* If OCR set by host, use it instead. */ 4613 if (host->ocr_mask) 4614 ocr_avail = host->ocr_mask; 4615 4616 /* If OCR set by external regulators, give it highest prio. */ 4617 if (mmc->ocr_avail) 4618 ocr_avail = mmc->ocr_avail; 4619 4620 mmc->ocr_avail = ocr_avail; 4621 mmc->ocr_avail_sdio = ocr_avail; 4622 if (host->ocr_avail_sdio) 4623 mmc->ocr_avail_sdio &= host->ocr_avail_sdio; 4624 mmc->ocr_avail_sd = ocr_avail; 4625 if (host->ocr_avail_sd) 4626 mmc->ocr_avail_sd &= host->ocr_avail_sd; 4627 else /* normal SD controllers don't support 1.8V */ 4628 mmc->ocr_avail_sd &= ~MMC_VDD_165_195; 4629 mmc->ocr_avail_mmc = ocr_avail; 4630 if (host->ocr_avail_mmc) 4631 mmc->ocr_avail_mmc &= host->ocr_avail_mmc; 4632 4633 if (mmc->ocr_avail == 0) { 4634 pr_err("%s: Hardware doesn't report any support voltages.\n", 4635 mmc_hostname(mmc)); 4636 ret = -ENODEV; 4637 goto unreg; 4638 } 4639 4640 if ((mmc->caps & (MMC_CAP_UHS_SDR12 | MMC_CAP_UHS_SDR25 | 4641 MMC_CAP_UHS_SDR50 | MMC_CAP_UHS_SDR104 | 4642 MMC_CAP_UHS_DDR50 | MMC_CAP_1_8V_DDR)) || 4643 (mmc->caps2 & (MMC_CAP2_HS200_1_8V_SDR | MMC_CAP2_HS400_1_8V))) 4644 host->flags |= SDHCI_SIGNALING_180; 4645 4646 if (mmc->caps2 & MMC_CAP2_HSX00_1_2V) 4647 host->flags |= SDHCI_SIGNALING_120; 4648 4649 spin_lock_init(&host->lock); 4650 4651 /* 4652 * Maximum number of sectors in one transfer. Limited by SDMA boundary 4653 * size (512KiB). Note some tuning modes impose a 4MiB limit, but this 4654 * is less anyway. 4655 */ 4656 mmc->max_req_size = 524288; 4657 4658 /* 4659 * Maximum number of segments. Depends on if the hardware 4660 * can do scatter/gather or not. 4661 */ 4662 if (host->flags & SDHCI_USE_ADMA) { 4663 mmc->max_segs = SDHCI_MAX_SEGS; 4664 } else if (host->flags & SDHCI_USE_SDMA) { 4665 mmc->max_segs = 1; 4666 mmc->max_req_size = min_t(size_t, mmc->max_req_size, 4667 dma_max_mapping_size(mmc_dev(mmc))); 4668 } else { /* PIO */ 4669 mmc->max_segs = SDHCI_MAX_SEGS; 4670 } 4671 4672 /* 4673 * Maximum segment size. Could be one segment with the maximum number 4674 * of bytes. When doing hardware scatter/gather, each entry cannot 4675 * be larger than 64 KiB though. 4676 */ 4677 if (host->flags & SDHCI_USE_ADMA) { 4678 if (host->quirks & SDHCI_QUIRK_BROKEN_ADMA_ZEROLEN_DESC) { 4679 host->max_adma = 65532; /* 32-bit alignment */ 4680 mmc->max_seg_size = 65535; 4681 } else { 4682 mmc->max_seg_size = 65536; 4683 } 4684 } else { 4685 mmc->max_seg_size = mmc->max_req_size; 4686 } 4687 4688 /* 4689 * Maximum block size. This varies from controller to controller and 4690 * is specified in the capabilities register. 4691 */ 4692 if (host->quirks & SDHCI_QUIRK_FORCE_BLK_SZ_2048) { 4693 mmc->max_blk_size = 2; 4694 } else { 4695 mmc->max_blk_size = (host->caps & SDHCI_MAX_BLOCK_MASK) >> 4696 SDHCI_MAX_BLOCK_SHIFT; 4697 if (mmc->max_blk_size >= 3) { 4698 pr_warn("%s: Invalid maximum block size, assuming 512 bytes\n", 4699 mmc_hostname(mmc)); 4700 mmc->max_blk_size = 0; 4701 } 4702 } 4703 4704 mmc->max_blk_size = 512 << mmc->max_blk_size; 4705 4706 /* 4707 * Maximum block count. 4708 */ 4709 mmc->max_blk_count = (host->quirks & SDHCI_QUIRK_NO_MULTIBLOCK) ? 1 : 65535; 4710 4711 if (mmc->max_segs == 1) 4712 /* This may alter mmc->*_blk_* parameters */ 4713 sdhci_allocate_bounce_buffer(host); 4714 4715 return 0; 4716 4717 unreg: 4718 if (host->sdhci_core_to_disable_vqmmc) 4719 regulator_disable(mmc->supply.vqmmc); 4720 undma: 4721 if (host->align_buffer) 4722 dma_free_coherent(mmc_dev(mmc), host->align_buffer_sz + 4723 host->adma_table_sz, host->align_buffer, 4724 host->align_addr); 4725 host->adma_table = NULL; 4726 host->align_buffer = NULL; 4727 4728 return ret; 4729 } 4730 EXPORT_SYMBOL_GPL(sdhci_setup_host); 4731 4732 void sdhci_cleanup_host(struct sdhci_host *host) 4733 { 4734 struct mmc_host *mmc = host->mmc; 4735 4736 if (host->sdhci_core_to_disable_vqmmc) 4737 regulator_disable(mmc->supply.vqmmc); 4738 4739 if (host->align_buffer) 4740 dma_free_coherent(mmc_dev(mmc), host->align_buffer_sz + 4741 host->adma_table_sz, host->align_buffer, 4742 host->align_addr); 4743 4744 if (host->use_external_dma) 4745 sdhci_external_dma_release(host); 4746 4747 host->adma_table = NULL; 4748 host->align_buffer = NULL; 4749 } 4750 EXPORT_SYMBOL_GPL(sdhci_cleanup_host); 4751 4752 int __sdhci_add_host(struct sdhci_host *host) 4753 { 4754 unsigned int flags = WQ_UNBOUND | WQ_MEM_RECLAIM | WQ_HIGHPRI; 4755 struct mmc_host *mmc = host->mmc; 4756 int ret; 4757 4758 if ((mmc->caps2 & MMC_CAP2_CQE) && 4759 (host->quirks & SDHCI_QUIRK_BROKEN_CQE)) { 4760 mmc->caps2 &= ~MMC_CAP2_CQE; 4761 mmc->cqe_ops = NULL; 4762 } 4763 4764 host->complete_wq = alloc_workqueue("sdhci", flags, 0); 4765 if (!host->complete_wq) 4766 return -ENOMEM; 4767 4768 INIT_WORK(&host->complete_work, sdhci_complete_work); 4769 4770 timer_setup(&host->timer, sdhci_timeout_timer, 0); 4771 timer_setup(&host->data_timer, sdhci_timeout_data_timer, 0); 4772 4773 init_waitqueue_head(&host->buf_ready_int); 4774 4775 sdhci_init(host, 0); 4776 4777 ret = request_threaded_irq(host->irq, sdhci_irq, sdhci_thread_irq, 4778 IRQF_SHARED, mmc_hostname(mmc), host); 4779 if (ret) { 4780 pr_err("%s: Failed to request IRQ %d: %d\n", 4781 mmc_hostname(mmc), host->irq, ret); 4782 goto unwq; 4783 } 4784 4785 ret = sdhci_led_register(host); 4786 if (ret) { 4787 pr_err("%s: Failed to register LED device: %d\n", 4788 mmc_hostname(mmc), ret); 4789 goto unirq; 4790 } 4791 4792 ret = mmc_add_host(mmc); 4793 if (ret) 4794 goto unled; 4795 4796 pr_info("%s: SDHCI controller on %s [%s] using %s\n", 4797 mmc_hostname(mmc), host->hw_name, dev_name(mmc_dev(mmc)), 4798 host->use_external_dma ? "External DMA" : 4799 (host->flags & SDHCI_USE_ADMA) ? 4800 (host->flags & SDHCI_USE_64_BIT_DMA) ? "ADMA 64-bit" : "ADMA" : 4801 (host->flags & SDHCI_USE_SDMA) ? "DMA" : "PIO"); 4802 4803 sdhci_enable_card_detection(host); 4804 4805 return 0; 4806 4807 unled: 4808 sdhci_led_unregister(host); 4809 unirq: 4810 sdhci_do_reset(host, SDHCI_RESET_ALL); 4811 sdhci_writel(host, 0, SDHCI_INT_ENABLE); 4812 sdhci_writel(host, 0, SDHCI_SIGNAL_ENABLE); 4813 free_irq(host->irq, host); 4814 unwq: 4815 destroy_workqueue(host->complete_wq); 4816 4817 return ret; 4818 } 4819 EXPORT_SYMBOL_GPL(__sdhci_add_host); 4820 4821 int sdhci_add_host(struct sdhci_host *host) 4822 { 4823 int ret; 4824 4825 ret = sdhci_setup_host(host); 4826 if (ret) 4827 return ret; 4828 4829 ret = __sdhci_add_host(host); 4830 if (ret) 4831 goto cleanup; 4832 4833 return 0; 4834 4835 cleanup: 4836 sdhci_cleanup_host(host); 4837 4838 return ret; 4839 } 4840 EXPORT_SYMBOL_GPL(sdhci_add_host); 4841 4842 void sdhci_remove_host(struct sdhci_host *host, int dead) 4843 { 4844 struct mmc_host *mmc = host->mmc; 4845 unsigned long flags; 4846 4847 if (dead) { 4848 spin_lock_irqsave(&host->lock, flags); 4849 4850 host->flags |= SDHCI_DEVICE_DEAD; 4851 4852 if (sdhci_has_requests(host)) { 4853 pr_err("%s: Controller removed during " 4854 " transfer!\n", mmc_hostname(mmc)); 4855 sdhci_error_out_mrqs(host, -ENOMEDIUM); 4856 } 4857 4858 spin_unlock_irqrestore(&host->lock, flags); 4859 } 4860 4861 sdhci_disable_card_detection(host); 4862 4863 mmc_remove_host(mmc); 4864 4865 sdhci_led_unregister(host); 4866 4867 if (!dead) 4868 sdhci_do_reset(host, SDHCI_RESET_ALL); 4869 4870 sdhci_writel(host, 0, SDHCI_INT_ENABLE); 4871 sdhci_writel(host, 0, SDHCI_SIGNAL_ENABLE); 4872 free_irq(host->irq, host); 4873 4874 del_timer_sync(&host->timer); 4875 del_timer_sync(&host->data_timer); 4876 4877 destroy_workqueue(host->complete_wq); 4878 4879 if (host->sdhci_core_to_disable_vqmmc) 4880 regulator_disable(mmc->supply.vqmmc); 4881 4882 if (host->align_buffer) 4883 dma_free_coherent(mmc_dev(mmc), host->align_buffer_sz + 4884 host->adma_table_sz, host->align_buffer, 4885 host->align_addr); 4886 4887 if (host->use_external_dma) 4888 sdhci_external_dma_release(host); 4889 4890 host->adma_table = NULL; 4891 host->align_buffer = NULL; 4892 } 4893 4894 EXPORT_SYMBOL_GPL(sdhci_remove_host); 4895 4896 void sdhci_free_host(struct sdhci_host *host) 4897 { 4898 mmc_free_host(host->mmc); 4899 } 4900 4901 EXPORT_SYMBOL_GPL(sdhci_free_host); 4902 4903 /*****************************************************************************\ 4904 * * 4905 * Driver init/exit * 4906 * * 4907 \*****************************************************************************/ 4908 4909 static int __init sdhci_drv_init(void) 4910 { 4911 pr_info(DRIVER_NAME 4912 ": Secure Digital Host Controller Interface driver\n"); 4913 pr_info(DRIVER_NAME ": Copyright(c) Pierre Ossman\n"); 4914 4915 return 0; 4916 } 4917 4918 static void __exit sdhci_drv_exit(void) 4919 { 4920 } 4921 4922 module_init(sdhci_drv_init); 4923 module_exit(sdhci_drv_exit); 4924 4925 module_param(debug_quirks, uint, 0444); 4926 module_param(debug_quirks2, uint, 0444); 4927 4928 MODULE_AUTHOR("Pierre Ossman <pierre@ossman.eu>"); 4929 MODULE_DESCRIPTION("Secure Digital Host Controller Interface core driver"); 4930 MODULE_LICENSE("GPL"); 4931 4932 MODULE_PARM_DESC(debug_quirks, "Force certain quirks."); 4933 MODULE_PARM_DESC(debug_quirks2, "Force certain other quirks."); 4934