linux/drivers/mmc/host/jz4740_mmc.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 *  Copyright (C) 2009-2010, Lars-Peter Clausen <lars@metafoo.de>
   4 *  Copyright (C) 2013, Imagination Technologies
   5 *
   6 *  JZ4740 SD/MMC controller driver
   7 */
   8
   9#include <linux/bitops.h>
  10#include <linux/clk.h>
  11#include <linux/delay.h>
  12#include <linux/dmaengine.h>
  13#include <linux/dma-mapping.h>
  14#include <linux/err.h>
  15#include <linux/interrupt.h>
  16#include <linux/io.h>
  17#include <linux/irq.h>
  18#include <linux/mmc/host.h>
  19#include <linux/mmc/slot-gpio.h>
  20#include <linux/module.h>
  21#include <linux/of_device.h>
  22#include <linux/pinctrl/consumer.h>
  23#include <linux/platform_device.h>
  24#include <linux/scatterlist.h>
  25
  26#include <asm/cacheflush.h>
  27
  28#define JZ_REG_MMC_STRPCL       0x00
  29#define JZ_REG_MMC_STATUS       0x04
  30#define JZ_REG_MMC_CLKRT        0x08
  31#define JZ_REG_MMC_CMDAT        0x0C
  32#define JZ_REG_MMC_RESTO        0x10
  33#define JZ_REG_MMC_RDTO         0x14
  34#define JZ_REG_MMC_BLKLEN       0x18
  35#define JZ_REG_MMC_NOB          0x1C
  36#define JZ_REG_MMC_SNOB         0x20
  37#define JZ_REG_MMC_IMASK        0x24
  38#define JZ_REG_MMC_IREG         0x28
  39#define JZ_REG_MMC_CMD          0x2C
  40#define JZ_REG_MMC_ARG          0x30
  41#define JZ_REG_MMC_RESP_FIFO    0x34
  42#define JZ_REG_MMC_RXFIFO       0x38
  43#define JZ_REG_MMC_TXFIFO       0x3C
  44#define JZ_REG_MMC_LPM          0x40
  45#define JZ_REG_MMC_DMAC         0x44
  46
  47#define JZ_MMC_STRPCL_EXIT_MULTIPLE BIT(7)
  48#define JZ_MMC_STRPCL_EXIT_TRANSFER BIT(6)
  49#define JZ_MMC_STRPCL_START_READWAIT BIT(5)
  50#define JZ_MMC_STRPCL_STOP_READWAIT BIT(4)
  51#define JZ_MMC_STRPCL_RESET BIT(3)
  52#define JZ_MMC_STRPCL_START_OP BIT(2)
  53#define JZ_MMC_STRPCL_CLOCK_CONTROL (BIT(1) | BIT(0))
  54#define JZ_MMC_STRPCL_CLOCK_STOP BIT(0)
  55#define JZ_MMC_STRPCL_CLOCK_START BIT(1)
  56
  57
  58#define JZ_MMC_STATUS_IS_RESETTING BIT(15)
  59#define JZ_MMC_STATUS_SDIO_INT_ACTIVE BIT(14)
  60#define JZ_MMC_STATUS_PRG_DONE BIT(13)
  61#define JZ_MMC_STATUS_DATA_TRAN_DONE BIT(12)
  62#define JZ_MMC_STATUS_END_CMD_RES BIT(11)
  63#define JZ_MMC_STATUS_DATA_FIFO_AFULL BIT(10)
  64#define JZ_MMC_STATUS_IS_READWAIT BIT(9)
  65#define JZ_MMC_STATUS_CLK_EN BIT(8)
  66#define JZ_MMC_STATUS_DATA_FIFO_FULL BIT(7)
  67#define JZ_MMC_STATUS_DATA_FIFO_EMPTY BIT(6)
  68#define JZ_MMC_STATUS_CRC_RES_ERR BIT(5)
  69#define JZ_MMC_STATUS_CRC_READ_ERROR BIT(4)
  70#define JZ_MMC_STATUS_TIMEOUT_WRITE BIT(3)
  71#define JZ_MMC_STATUS_CRC_WRITE_ERROR BIT(2)
  72#define JZ_MMC_STATUS_TIMEOUT_RES BIT(1)
  73#define JZ_MMC_STATUS_TIMEOUT_READ BIT(0)
  74
  75#define JZ_MMC_STATUS_READ_ERROR_MASK (BIT(4) | BIT(0))
  76#define JZ_MMC_STATUS_WRITE_ERROR_MASK (BIT(3) | BIT(2))
  77
  78
  79#define JZ_MMC_CMDAT_IO_ABORT BIT(11)
  80#define JZ_MMC_CMDAT_BUS_WIDTH_4BIT BIT(10)
  81#define JZ_MMC_CMDAT_BUS_WIDTH_8BIT (BIT(10) | BIT(9))
  82#define JZ_MMC_CMDAT_BUS_WIDTH_MASK (BIT(10) | BIT(9))
  83#define JZ_MMC_CMDAT_DMA_EN BIT(8)
  84#define JZ_MMC_CMDAT_INIT BIT(7)
  85#define JZ_MMC_CMDAT_BUSY BIT(6)
  86#define JZ_MMC_CMDAT_STREAM BIT(5)
  87#define JZ_MMC_CMDAT_WRITE BIT(4)
  88#define JZ_MMC_CMDAT_DATA_EN BIT(3)
  89#define JZ_MMC_CMDAT_RESPONSE_FORMAT (BIT(2) | BIT(1) | BIT(0))
  90#define JZ_MMC_CMDAT_RSP_R1 1
  91#define JZ_MMC_CMDAT_RSP_R2 2
  92#define JZ_MMC_CMDAT_RSP_R3 3
  93
  94#define JZ_MMC_IRQ_SDIO BIT(7)
  95#define JZ_MMC_IRQ_TXFIFO_WR_REQ BIT(6)
  96#define JZ_MMC_IRQ_RXFIFO_RD_REQ BIT(5)
  97#define JZ_MMC_IRQ_END_CMD_RES BIT(2)
  98#define JZ_MMC_IRQ_PRG_DONE BIT(1)
  99#define JZ_MMC_IRQ_DATA_TRAN_DONE BIT(0)
 100
 101#define JZ_MMC_DMAC_DMA_SEL BIT(1)
 102#define JZ_MMC_DMAC_DMA_EN BIT(0)
 103
 104#define JZ_MMC_LPM_DRV_RISING BIT(31)
 105#define JZ_MMC_LPM_DRV_RISING_QTR_PHASE_DLY BIT(31)
 106#define JZ_MMC_LPM_DRV_RISING_1NS_DLY BIT(30)
 107#define JZ_MMC_LPM_SMP_RISING_QTR_OR_HALF_PHASE_DLY BIT(29)
 108#define JZ_MMC_LPM_LOW_POWER_MODE_EN BIT(0)
 109
 110#define JZ_MMC_CLK_RATE 24000000
 111#define JZ_MMC_REQ_TIMEOUT_MS 5000
 112
 113enum jz4740_mmc_version {
 114        JZ_MMC_JZ4740,
 115        JZ_MMC_JZ4725B,
 116        JZ_MMC_JZ4760,
 117        JZ_MMC_JZ4780,
 118        JZ_MMC_X1000,
 119};
 120
 121enum jz4740_mmc_state {
 122        JZ4740_MMC_STATE_READ_RESPONSE,
 123        JZ4740_MMC_STATE_TRANSFER_DATA,
 124        JZ4740_MMC_STATE_SEND_STOP,
 125        JZ4740_MMC_STATE_DONE,
 126};
 127
 128/*
 129 * The MMC core allows to prepare a mmc_request while another mmc_request
 130 * is in-flight. This is used via the pre_req/post_req hooks.
 131 * This driver uses the pre_req/post_req hooks to map/unmap the mmc_request.
 132 * Following what other drivers do (sdhci, dw_mmc) we use the following cookie
 133 * flags to keep track of the mmc_request mapping state.
 134 *
 135 * COOKIE_UNMAPPED: the request is not mapped.
 136 * COOKIE_PREMAPPED: the request was mapped in pre_req,
 137 * and should be unmapped in post_req.
 138 * COOKIE_MAPPED: the request was mapped in the irq handler,
 139 * and should be unmapped before mmc_request_done is called..
 140 */
 141enum jz4780_cookie {
 142        COOKIE_UNMAPPED = 0,
 143        COOKIE_PREMAPPED,
 144        COOKIE_MAPPED,
 145};
 146
 147struct jz4740_mmc_host {
 148        struct mmc_host *mmc;
 149        struct platform_device *pdev;
 150        struct clk *clk;
 151
 152        enum jz4740_mmc_version version;
 153
 154        int irq;
 155        int card_detect_irq;
 156
 157        void __iomem *base;
 158        struct resource *mem_res;
 159        struct mmc_request *req;
 160        struct mmc_command *cmd;
 161
 162        unsigned long waiting;
 163
 164        uint32_t cmdat;
 165
 166        uint32_t irq_mask;
 167
 168        spinlock_t lock;
 169
 170        struct timer_list timeout_timer;
 171        struct sg_mapping_iter miter;
 172        enum jz4740_mmc_state state;
 173
 174        /* DMA support */
 175        struct dma_chan *dma_rx;
 176        struct dma_chan *dma_tx;
 177        bool use_dma;
 178
 179/* The DMA trigger level is 8 words, that is to say, the DMA read
 180 * trigger is when data words in MSC_RXFIFO is >= 8 and the DMA write
 181 * trigger is when data words in MSC_TXFIFO is < 8.
 182 */
 183#define JZ4740_MMC_FIFO_HALF_SIZE 8
 184};
 185
 186static void jz4740_mmc_write_irq_mask(struct jz4740_mmc_host *host,
 187                                      uint32_t val)
 188{
 189        if (host->version >= JZ_MMC_JZ4725B)
 190                return writel(val, host->base + JZ_REG_MMC_IMASK);
 191        else
 192                return writew(val, host->base + JZ_REG_MMC_IMASK);
 193}
 194
 195static void jz4740_mmc_write_irq_reg(struct jz4740_mmc_host *host,
 196                                     uint32_t val)
 197{
 198        if (host->version >= JZ_MMC_JZ4780)
 199                writel(val, host->base + JZ_REG_MMC_IREG);
 200        else
 201                writew(val, host->base + JZ_REG_MMC_IREG);
 202}
 203
 204static uint32_t jz4740_mmc_read_irq_reg(struct jz4740_mmc_host *host)
 205{
 206        if (host->version >= JZ_MMC_JZ4780)
 207                return readl(host->base + JZ_REG_MMC_IREG);
 208        else
 209                return readw(host->base + JZ_REG_MMC_IREG);
 210}
 211
 212/*----------------------------------------------------------------------------*/
 213/* DMA infrastructure */
 214
 215static void jz4740_mmc_release_dma_channels(struct jz4740_mmc_host *host)
 216{
 217        if (!host->use_dma)
 218                return;
 219
 220        dma_release_channel(host->dma_tx);
 221        dma_release_channel(host->dma_rx);
 222}
 223
 224static int jz4740_mmc_acquire_dma_channels(struct jz4740_mmc_host *host)
 225{
 226        host->dma_tx = dma_request_chan(mmc_dev(host->mmc), "tx");
 227        if (IS_ERR(host->dma_tx)) {
 228                dev_err(mmc_dev(host->mmc), "Failed to get dma_tx channel\n");
 229                return PTR_ERR(host->dma_tx);
 230        }
 231
 232        host->dma_rx = dma_request_chan(mmc_dev(host->mmc), "rx");
 233        if (IS_ERR(host->dma_rx)) {
 234                dev_err(mmc_dev(host->mmc), "Failed to get dma_rx channel\n");
 235                dma_release_channel(host->dma_tx);
 236                return PTR_ERR(host->dma_rx);
 237        }
 238
 239        return 0;
 240}
 241
 242static inline struct dma_chan *jz4740_mmc_get_dma_chan(struct jz4740_mmc_host *host,
 243                                                       struct mmc_data *data)
 244{
 245        return (data->flags & MMC_DATA_READ) ? host->dma_rx : host->dma_tx;
 246}
 247
 248static void jz4740_mmc_dma_unmap(struct jz4740_mmc_host *host,
 249                                 struct mmc_data *data)
 250{
 251        struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
 252        enum dma_data_direction dir = mmc_get_dma_dir(data);
 253
 254        dma_unmap_sg(chan->device->dev, data->sg, data->sg_len, dir);
 255        data->host_cookie = COOKIE_UNMAPPED;
 256}
 257
 258/* Prepares DMA data for current or next transfer.
 259 * A request can be in-flight when this is called.
 260 */
 261static int jz4740_mmc_prepare_dma_data(struct jz4740_mmc_host *host,
 262                                       struct mmc_data *data,
 263                                       int cookie)
 264{
 265        struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
 266        enum dma_data_direction dir = mmc_get_dma_dir(data);
 267        int sg_count;
 268
 269        if (data->host_cookie == COOKIE_PREMAPPED)
 270                return data->sg_count;
 271
 272        sg_count = dma_map_sg(chan->device->dev,
 273                        data->sg,
 274                        data->sg_len,
 275                        dir);
 276
 277        if (sg_count <= 0) {
 278                dev_err(mmc_dev(host->mmc),
 279                        "Failed to map scatterlist for DMA operation\n");
 280                return -EINVAL;
 281        }
 282
 283        data->sg_count = sg_count;
 284        data->host_cookie = cookie;
 285
 286        return data->sg_count;
 287}
 288
 289static int jz4740_mmc_start_dma_transfer(struct jz4740_mmc_host *host,
 290                                         struct mmc_data *data)
 291{
 292        struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
 293        struct dma_async_tx_descriptor *desc;
 294        struct dma_slave_config conf = {
 295                .src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES,
 296                .dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES,
 297                .src_maxburst = JZ4740_MMC_FIFO_HALF_SIZE,
 298                .dst_maxburst = JZ4740_MMC_FIFO_HALF_SIZE,
 299        };
 300        int sg_count;
 301
 302        if (data->flags & MMC_DATA_WRITE) {
 303                conf.direction = DMA_MEM_TO_DEV;
 304                conf.dst_addr = host->mem_res->start + JZ_REG_MMC_TXFIFO;
 305        } else {
 306                conf.direction = DMA_DEV_TO_MEM;
 307                conf.src_addr = host->mem_res->start + JZ_REG_MMC_RXFIFO;
 308        }
 309
 310        sg_count = jz4740_mmc_prepare_dma_data(host, data, COOKIE_MAPPED);
 311        if (sg_count < 0)
 312                return sg_count;
 313
 314        dmaengine_slave_config(chan, &conf);
 315        desc = dmaengine_prep_slave_sg(chan, data->sg, sg_count,
 316                        conf.direction,
 317                        DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
 318        if (!desc) {
 319                dev_err(mmc_dev(host->mmc),
 320                        "Failed to allocate DMA %s descriptor",
 321                         conf.direction == DMA_MEM_TO_DEV ? "TX" : "RX");
 322                goto dma_unmap;
 323        }
 324
 325        dmaengine_submit(desc);
 326        dma_async_issue_pending(chan);
 327
 328        return 0;
 329
 330dma_unmap:
 331        if (data->host_cookie == COOKIE_MAPPED)
 332                jz4740_mmc_dma_unmap(host, data);
 333        return -ENOMEM;
 334}
 335
 336static void jz4740_mmc_pre_request(struct mmc_host *mmc,
 337                                   struct mmc_request *mrq)
 338{
 339        struct jz4740_mmc_host *host = mmc_priv(mmc);
 340        struct mmc_data *data = mrq->data;
 341
 342        if (!host->use_dma)
 343                return;
 344
 345        data->host_cookie = COOKIE_UNMAPPED;
 346        if (jz4740_mmc_prepare_dma_data(host, data, COOKIE_PREMAPPED) < 0)
 347                data->host_cookie = COOKIE_UNMAPPED;
 348}
 349
 350static void jz4740_mmc_post_request(struct mmc_host *mmc,
 351                                    struct mmc_request *mrq,
 352                                    int err)
 353{
 354        struct jz4740_mmc_host *host = mmc_priv(mmc);
 355        struct mmc_data *data = mrq->data;
 356
 357        if (data && data->host_cookie != COOKIE_UNMAPPED)
 358                jz4740_mmc_dma_unmap(host, data);
 359
 360        if (err) {
 361                struct dma_chan *chan = jz4740_mmc_get_dma_chan(host, data);
 362
 363                dmaengine_terminate_all(chan);
 364        }
 365}
 366
 367/*----------------------------------------------------------------------------*/
 368
 369static void jz4740_mmc_set_irq_enabled(struct jz4740_mmc_host *host,
 370        unsigned int irq, bool enabled)
 371{
 372        unsigned long flags;
 373
 374        spin_lock_irqsave(&host->lock, flags);
 375        if (enabled)
 376                host->irq_mask &= ~irq;
 377        else
 378                host->irq_mask |= irq;
 379
 380        jz4740_mmc_write_irq_mask(host, host->irq_mask);
 381        spin_unlock_irqrestore(&host->lock, flags);
 382}
 383
 384static void jz4740_mmc_clock_enable(struct jz4740_mmc_host *host,
 385        bool start_transfer)
 386{
 387        uint16_t val = JZ_MMC_STRPCL_CLOCK_START;
 388
 389        if (start_transfer)
 390                val |= JZ_MMC_STRPCL_START_OP;
 391
 392        writew(val, host->base + JZ_REG_MMC_STRPCL);
 393}
 394
 395static void jz4740_mmc_clock_disable(struct jz4740_mmc_host *host)
 396{
 397        uint32_t status;
 398        unsigned int timeout = 1000;
 399
 400        writew(JZ_MMC_STRPCL_CLOCK_STOP, host->base + JZ_REG_MMC_STRPCL);
 401        do {
 402                status = readl(host->base + JZ_REG_MMC_STATUS);
 403        } while (status & JZ_MMC_STATUS_CLK_EN && --timeout);
 404}
 405
 406static void jz4740_mmc_reset(struct jz4740_mmc_host *host)
 407{
 408        uint32_t status;
 409        unsigned int timeout = 1000;
 410
 411        writew(JZ_MMC_STRPCL_RESET, host->base + JZ_REG_MMC_STRPCL);
 412        udelay(10);
 413        do {
 414                status = readl(host->base + JZ_REG_MMC_STATUS);
 415        } while (status & JZ_MMC_STATUS_IS_RESETTING && --timeout);
 416}
 417
 418static void jz4740_mmc_request_done(struct jz4740_mmc_host *host)
 419{
 420        struct mmc_request *req;
 421        struct mmc_data *data;
 422
 423        req = host->req;
 424        data = req->data;
 425        host->req = NULL;
 426
 427        if (data && data->host_cookie == COOKIE_MAPPED)
 428                jz4740_mmc_dma_unmap(host, data);
 429        mmc_request_done(host->mmc, req);
 430}
 431
 432static unsigned int jz4740_mmc_poll_irq(struct jz4740_mmc_host *host,
 433        unsigned int irq)
 434{
 435        unsigned int timeout = 0x800;
 436        uint32_t status;
 437
 438        do {
 439                status = jz4740_mmc_read_irq_reg(host);
 440        } while (!(status & irq) && --timeout);
 441
 442        if (timeout == 0) {
 443                set_bit(0, &host->waiting);
 444                mod_timer(&host->timeout_timer,
 445                          jiffies + msecs_to_jiffies(JZ_MMC_REQ_TIMEOUT_MS));
 446                jz4740_mmc_set_irq_enabled(host, irq, true);
 447                return true;
 448        }
 449
 450        return false;
 451}
 452
 453static void jz4740_mmc_transfer_check_state(struct jz4740_mmc_host *host,
 454        struct mmc_data *data)
 455{
 456        int status;
 457
 458        status = readl(host->base + JZ_REG_MMC_STATUS);
 459        if (status & JZ_MMC_STATUS_WRITE_ERROR_MASK) {
 460                if (status & (JZ_MMC_STATUS_TIMEOUT_WRITE)) {
 461                        host->req->cmd->error = -ETIMEDOUT;
 462                        data->error = -ETIMEDOUT;
 463                } else {
 464                        host->req->cmd->error = -EIO;
 465                        data->error = -EIO;
 466                }
 467        } else if (status & JZ_MMC_STATUS_READ_ERROR_MASK) {
 468                if (status & (JZ_MMC_STATUS_TIMEOUT_READ)) {
 469                        host->req->cmd->error = -ETIMEDOUT;
 470                        data->error = -ETIMEDOUT;
 471                } else {
 472                        host->req->cmd->error = -EIO;
 473                        data->error = -EIO;
 474                }
 475        }
 476}
 477
 478static bool jz4740_mmc_write_data(struct jz4740_mmc_host *host,
 479        struct mmc_data *data)
 480{
 481        struct sg_mapping_iter *miter = &host->miter;
 482        void __iomem *fifo_addr = host->base + JZ_REG_MMC_TXFIFO;
 483        uint32_t *buf;
 484        bool timeout;
 485        size_t i, j;
 486
 487        while (sg_miter_next(miter)) {
 488                buf = miter->addr;
 489                i = miter->length / 4;
 490                j = i / 8;
 491                i = i & 0x7;
 492                while (j) {
 493                        timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_TXFIFO_WR_REQ);
 494                        if (unlikely(timeout))
 495                                goto poll_timeout;
 496
 497                        writel(buf[0], fifo_addr);
 498                        writel(buf[1], fifo_addr);
 499                        writel(buf[2], fifo_addr);
 500                        writel(buf[3], fifo_addr);
 501                        writel(buf[4], fifo_addr);
 502                        writel(buf[5], fifo_addr);
 503                        writel(buf[6], fifo_addr);
 504                        writel(buf[7], fifo_addr);
 505                        buf += 8;
 506                        --j;
 507                }
 508                if (unlikely(i)) {
 509                        timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_TXFIFO_WR_REQ);
 510                        if (unlikely(timeout))
 511                                goto poll_timeout;
 512
 513                        while (i) {
 514                                writel(*buf, fifo_addr);
 515                                ++buf;
 516                                --i;
 517                        }
 518                }
 519                data->bytes_xfered += miter->length;
 520        }
 521        sg_miter_stop(miter);
 522
 523        return false;
 524
 525poll_timeout:
 526        miter->consumed = (void *)buf - miter->addr;
 527        data->bytes_xfered += miter->consumed;
 528        sg_miter_stop(miter);
 529
 530        return true;
 531}
 532
 533static bool jz4740_mmc_read_data(struct jz4740_mmc_host *host,
 534                                struct mmc_data *data)
 535{
 536        struct sg_mapping_iter *miter = &host->miter;
 537        void __iomem *fifo_addr = host->base + JZ_REG_MMC_RXFIFO;
 538        uint32_t *buf;
 539        uint32_t d;
 540        uint32_t status;
 541        size_t i, j;
 542        unsigned int timeout;
 543
 544        while (sg_miter_next(miter)) {
 545                buf = miter->addr;
 546                i = miter->length;
 547                j = i / 32;
 548                i = i & 0x1f;
 549                while (j) {
 550                        timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_RXFIFO_RD_REQ);
 551                        if (unlikely(timeout))
 552                                goto poll_timeout;
 553
 554                        buf[0] = readl(fifo_addr);
 555                        buf[1] = readl(fifo_addr);
 556                        buf[2] = readl(fifo_addr);
 557                        buf[3] = readl(fifo_addr);
 558                        buf[4] = readl(fifo_addr);
 559                        buf[5] = readl(fifo_addr);
 560                        buf[6] = readl(fifo_addr);
 561                        buf[7] = readl(fifo_addr);
 562
 563                        buf += 8;
 564                        --j;
 565                }
 566
 567                if (unlikely(i)) {
 568                        timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_RXFIFO_RD_REQ);
 569                        if (unlikely(timeout))
 570                                goto poll_timeout;
 571
 572                        while (i >= 4) {
 573                                *buf++ = readl(fifo_addr);
 574                                i -= 4;
 575                        }
 576                        if (unlikely(i > 0)) {
 577                                d = readl(fifo_addr);
 578                                memcpy(buf, &d, i);
 579                        }
 580                }
 581                data->bytes_xfered += miter->length;
 582
 583                /* This can go away once MIPS implements
 584                 * flush_kernel_dcache_page */
 585                flush_dcache_page(miter->page);
 586        }
 587        sg_miter_stop(miter);
 588
 589        /* For whatever reason there is sometime one word more in the fifo then
 590         * requested */
 591        timeout = 1000;
 592        status = readl(host->base + JZ_REG_MMC_STATUS);
 593        while (!(status & JZ_MMC_STATUS_DATA_FIFO_EMPTY) && --timeout) {
 594                d = readl(fifo_addr);
 595                status = readl(host->base + JZ_REG_MMC_STATUS);
 596        }
 597
 598        return false;
 599
 600poll_timeout:
 601        miter->consumed = (void *)buf - miter->addr;
 602        data->bytes_xfered += miter->consumed;
 603        sg_miter_stop(miter);
 604
 605        return true;
 606}
 607
 608static void jz4740_mmc_timeout(struct timer_list *t)
 609{
 610        struct jz4740_mmc_host *host = from_timer(host, t, timeout_timer);
 611
 612        if (!test_and_clear_bit(0, &host->waiting))
 613                return;
 614
 615        jz4740_mmc_set_irq_enabled(host, JZ_MMC_IRQ_END_CMD_RES, false);
 616
 617        host->req->cmd->error = -ETIMEDOUT;
 618        jz4740_mmc_request_done(host);
 619}
 620
 621static void jz4740_mmc_read_response(struct jz4740_mmc_host *host,
 622        struct mmc_command *cmd)
 623{
 624        int i;
 625        uint16_t tmp;
 626        void __iomem *fifo_addr = host->base + JZ_REG_MMC_RESP_FIFO;
 627
 628        if (cmd->flags & MMC_RSP_136) {
 629                tmp = readw(fifo_addr);
 630                for (i = 0; i < 4; ++i) {
 631                        cmd->resp[i] = tmp << 24;
 632                        tmp = readw(fifo_addr);
 633                        cmd->resp[i] |= tmp << 8;
 634                        tmp = readw(fifo_addr);
 635                        cmd->resp[i] |= tmp >> 8;
 636                }
 637        } else {
 638                cmd->resp[0] = readw(fifo_addr) << 24;
 639                cmd->resp[0] |= readw(fifo_addr) << 8;
 640                cmd->resp[0] |= readw(fifo_addr) & 0xff;
 641        }
 642}
 643
 644static void jz4740_mmc_send_command(struct jz4740_mmc_host *host,
 645        struct mmc_command *cmd)
 646{
 647        uint32_t cmdat = host->cmdat;
 648
 649        host->cmdat &= ~JZ_MMC_CMDAT_INIT;
 650        jz4740_mmc_clock_disable(host);
 651
 652        host->cmd = cmd;
 653
 654        if (cmd->flags & MMC_RSP_BUSY)
 655                cmdat |= JZ_MMC_CMDAT_BUSY;
 656
 657        switch (mmc_resp_type(cmd)) {
 658        case MMC_RSP_R1B:
 659        case MMC_RSP_R1:
 660                cmdat |= JZ_MMC_CMDAT_RSP_R1;
 661                break;
 662        case MMC_RSP_R2:
 663                cmdat |= JZ_MMC_CMDAT_RSP_R2;
 664                break;
 665        case MMC_RSP_R3:
 666                cmdat |= JZ_MMC_CMDAT_RSP_R3;
 667                break;
 668        default:
 669                break;
 670        }
 671
 672        if (cmd->data) {
 673                cmdat |= JZ_MMC_CMDAT_DATA_EN;
 674                if (cmd->data->flags & MMC_DATA_WRITE)
 675                        cmdat |= JZ_MMC_CMDAT_WRITE;
 676                if (host->use_dma) {
 677                        /*
 678                         * The 4780's MMC controller has integrated DMA ability
 679                         * in addition to being able to use the external DMA
 680                         * controller. It moves DMA control bits to a separate
 681                         * register. The DMA_SEL bit chooses the external
 682                         * controller over the integrated one. Earlier SoCs
 683                         * can only use the external controller, and have a
 684                         * single DMA enable bit in CMDAT.
 685                         */
 686                        if (host->version >= JZ_MMC_JZ4780) {
 687                                writel(JZ_MMC_DMAC_DMA_EN | JZ_MMC_DMAC_DMA_SEL,
 688                                       host->base + JZ_REG_MMC_DMAC);
 689                        } else {
 690                                cmdat |= JZ_MMC_CMDAT_DMA_EN;
 691                        }
 692                } else if (host->version >= JZ_MMC_JZ4780) {
 693                        writel(0, host->base + JZ_REG_MMC_DMAC);
 694                }
 695
 696                writew(cmd->data->blksz, host->base + JZ_REG_MMC_BLKLEN);
 697                writew(cmd->data->blocks, host->base + JZ_REG_MMC_NOB);
 698        }
 699
 700        writeb(cmd->opcode, host->base + JZ_REG_MMC_CMD);
 701        writel(cmd->arg, host->base + JZ_REG_MMC_ARG);
 702        writel(cmdat, host->base + JZ_REG_MMC_CMDAT);
 703
 704        jz4740_mmc_clock_enable(host, 1);
 705}
 706
 707static void jz_mmc_prepare_data_transfer(struct jz4740_mmc_host *host)
 708{
 709        struct mmc_command *cmd = host->req->cmd;
 710        struct mmc_data *data = cmd->data;
 711        int direction;
 712
 713        if (data->flags & MMC_DATA_READ)
 714                direction = SG_MITER_TO_SG;
 715        else
 716                direction = SG_MITER_FROM_SG;
 717
 718        sg_miter_start(&host->miter, data->sg, data->sg_len, direction);
 719}
 720
 721
 722static irqreturn_t jz_mmc_irq_worker(int irq, void *devid)
 723{
 724        struct jz4740_mmc_host *host = (struct jz4740_mmc_host *)devid;
 725        struct mmc_command *cmd = host->req->cmd;
 726        struct mmc_request *req = host->req;
 727        struct mmc_data *data = cmd->data;
 728        bool timeout = false;
 729
 730        if (cmd->error)
 731                host->state = JZ4740_MMC_STATE_DONE;
 732
 733        switch (host->state) {
 734        case JZ4740_MMC_STATE_READ_RESPONSE:
 735                if (cmd->flags & MMC_RSP_PRESENT)
 736                        jz4740_mmc_read_response(host, cmd);
 737
 738                if (!data)
 739                        break;
 740
 741                jz_mmc_prepare_data_transfer(host);
 742                fallthrough;
 743
 744        case JZ4740_MMC_STATE_TRANSFER_DATA:
 745                if (host->use_dma) {
 746                        /* Use DMA if enabled.
 747                         * Data transfer direction is defined later by
 748                         * relying on data flags in
 749                         * jz4740_mmc_prepare_dma_data() and
 750                         * jz4740_mmc_start_dma_transfer().
 751                         */
 752                        timeout = jz4740_mmc_start_dma_transfer(host, data);
 753                        data->bytes_xfered = data->blocks * data->blksz;
 754                } else if (data->flags & MMC_DATA_READ)
 755                        /* Use PIO if DMA is not enabled.
 756                         * Data transfer direction was defined before
 757                         * by relying on data flags in
 758                         * jz_mmc_prepare_data_transfer().
 759                         */
 760                        timeout = jz4740_mmc_read_data(host, data);
 761                else
 762                        timeout = jz4740_mmc_write_data(host, data);
 763
 764                if (unlikely(timeout)) {
 765                        host->state = JZ4740_MMC_STATE_TRANSFER_DATA;
 766                        break;
 767                }
 768
 769                jz4740_mmc_transfer_check_state(host, data);
 770
 771                timeout = jz4740_mmc_poll_irq(host, JZ_MMC_IRQ_DATA_TRAN_DONE);
 772                if (unlikely(timeout)) {
 773                        host->state = JZ4740_MMC_STATE_SEND_STOP;
 774                        break;
 775                }
 776                jz4740_mmc_write_irq_reg(host, JZ_MMC_IRQ_DATA_TRAN_DONE);
 777                fallthrough;
 778
 779        case JZ4740_MMC_STATE_SEND_STOP:
 780                if (!req->stop)
 781                        break;
 782
 783                jz4740_mmc_send_command(host, req->stop);
 784
 785                if (mmc_resp_type(req->stop) & MMC_RSP_BUSY) {
 786                        timeout = jz4740_mmc_poll_irq(host,
 787                                                      JZ_MMC_IRQ_PRG_DONE);
 788                        if (timeout) {
 789                                host->state = JZ4740_MMC_STATE_DONE;
 790                                break;
 791                        }
 792                }
 793        case JZ4740_MMC_STATE_DONE:
 794                break;
 795        }
 796
 797        if (!timeout)
 798                jz4740_mmc_request_done(host);
 799
 800        return IRQ_HANDLED;
 801}
 802
 803static irqreturn_t jz_mmc_irq(int irq, void *devid)
 804{
 805        struct jz4740_mmc_host *host = devid;
 806        struct mmc_command *cmd = host->cmd;
 807        uint32_t irq_reg, status, tmp;
 808
 809        status = readl(host->base + JZ_REG_MMC_STATUS);
 810        irq_reg = jz4740_mmc_read_irq_reg(host);
 811
 812        tmp = irq_reg;
 813        irq_reg &= ~host->irq_mask;
 814
 815        tmp &= ~(JZ_MMC_IRQ_TXFIFO_WR_REQ | JZ_MMC_IRQ_RXFIFO_RD_REQ |
 816                JZ_MMC_IRQ_PRG_DONE | JZ_MMC_IRQ_DATA_TRAN_DONE);
 817
 818        if (tmp != irq_reg)
 819                jz4740_mmc_write_irq_reg(host, tmp & ~irq_reg);
 820
 821        if (irq_reg & JZ_MMC_IRQ_SDIO) {
 822                jz4740_mmc_write_irq_reg(host, JZ_MMC_IRQ_SDIO);
 823                mmc_signal_sdio_irq(host->mmc);
 824                irq_reg &= ~JZ_MMC_IRQ_SDIO;
 825        }
 826
 827        if (host->req && cmd && irq_reg) {
 828                if (test_and_clear_bit(0, &host->waiting)) {
 829                        del_timer(&host->timeout_timer);
 830
 831                        if (status & JZ_MMC_STATUS_TIMEOUT_RES) {
 832                                cmd->error = -ETIMEDOUT;
 833                        } else if (status & JZ_MMC_STATUS_CRC_RES_ERR) {
 834                                cmd->error = -EIO;
 835                        } else if (status & (JZ_MMC_STATUS_CRC_READ_ERROR |
 836                                    JZ_MMC_STATUS_CRC_WRITE_ERROR)) {
 837                                if (cmd->data)
 838                                        cmd->data->error = -EIO;
 839                                cmd->error = -EIO;
 840                        }
 841
 842                        jz4740_mmc_set_irq_enabled(host, irq_reg, false);
 843                        jz4740_mmc_write_irq_reg(host, irq_reg);
 844
 845                        return IRQ_WAKE_THREAD;
 846                }
 847        }
 848
 849        return IRQ_HANDLED;
 850}
 851
 852static int jz4740_mmc_set_clock_rate(struct jz4740_mmc_host *host, int rate)
 853{
 854        int div = 0;
 855        int real_rate;
 856
 857        jz4740_mmc_clock_disable(host);
 858        clk_set_rate(host->clk, host->mmc->f_max);
 859
 860        real_rate = clk_get_rate(host->clk);
 861
 862        while (real_rate > rate && div < 7) {
 863                ++div;
 864                real_rate >>= 1;
 865        }
 866
 867        writew(div, host->base + JZ_REG_MMC_CLKRT);
 868
 869        if (real_rate > 25000000) {
 870                if (host->version >= JZ_MMC_X1000) {
 871                        writel(JZ_MMC_LPM_DRV_RISING_QTR_PHASE_DLY |
 872                                   JZ_MMC_LPM_SMP_RISING_QTR_OR_HALF_PHASE_DLY |
 873                                   JZ_MMC_LPM_LOW_POWER_MODE_EN,
 874                                   host->base + JZ_REG_MMC_LPM);
 875                } else if (host->version >= JZ_MMC_JZ4760) {
 876                        writel(JZ_MMC_LPM_DRV_RISING |
 877                                   JZ_MMC_LPM_LOW_POWER_MODE_EN,
 878                                   host->base + JZ_REG_MMC_LPM);
 879                } else if (host->version >= JZ_MMC_JZ4725B)
 880                        writel(JZ_MMC_LPM_LOW_POWER_MODE_EN,
 881                                   host->base + JZ_REG_MMC_LPM);
 882        }
 883
 884        return real_rate;
 885}
 886
 887static void jz4740_mmc_request(struct mmc_host *mmc, struct mmc_request *req)
 888{
 889        struct jz4740_mmc_host *host = mmc_priv(mmc);
 890
 891        host->req = req;
 892
 893        jz4740_mmc_write_irq_reg(host, ~0);
 894        jz4740_mmc_set_irq_enabled(host, JZ_MMC_IRQ_END_CMD_RES, true);
 895
 896        host->state = JZ4740_MMC_STATE_READ_RESPONSE;
 897        set_bit(0, &host->waiting);
 898        mod_timer(&host->timeout_timer,
 899                  jiffies + msecs_to_jiffies(JZ_MMC_REQ_TIMEOUT_MS));
 900        jz4740_mmc_send_command(host, req->cmd);
 901}
 902
 903static void jz4740_mmc_set_ios(struct mmc_host *mmc, struct mmc_ios *ios)
 904{
 905        struct jz4740_mmc_host *host = mmc_priv(mmc);
 906        if (ios->clock)
 907                jz4740_mmc_set_clock_rate(host, ios->clock);
 908
 909        switch (ios->power_mode) {
 910        case MMC_POWER_UP:
 911                jz4740_mmc_reset(host);
 912                if (!IS_ERR(mmc->supply.vmmc))
 913                        mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, ios->vdd);
 914                host->cmdat |= JZ_MMC_CMDAT_INIT;
 915                clk_prepare_enable(host->clk);
 916                break;
 917        case MMC_POWER_ON:
 918                break;
 919        default:
 920                if (!IS_ERR(mmc->supply.vmmc))
 921                        mmc_regulator_set_ocr(mmc, mmc->supply.vmmc, 0);
 922                clk_disable_unprepare(host->clk);
 923                break;
 924        }
 925
 926        switch (ios->bus_width) {
 927        case MMC_BUS_WIDTH_1:
 928                host->cmdat &= ~JZ_MMC_CMDAT_BUS_WIDTH_MASK;
 929                break;
 930        case MMC_BUS_WIDTH_4:
 931                host->cmdat &= ~JZ_MMC_CMDAT_BUS_WIDTH_MASK;
 932                host->cmdat |= JZ_MMC_CMDAT_BUS_WIDTH_4BIT;
 933                break;
 934        case MMC_BUS_WIDTH_8:
 935                host->cmdat &= ~JZ_MMC_CMDAT_BUS_WIDTH_MASK;
 936                host->cmdat |= JZ_MMC_CMDAT_BUS_WIDTH_8BIT;
 937                break;
 938        default:
 939                break;
 940        }
 941}
 942
 943static void jz4740_mmc_enable_sdio_irq(struct mmc_host *mmc, int enable)
 944{
 945        struct jz4740_mmc_host *host = mmc_priv(mmc);
 946        jz4740_mmc_set_irq_enabled(host, JZ_MMC_IRQ_SDIO, enable);
 947}
 948
 949static const struct mmc_host_ops jz4740_mmc_ops = {
 950        .request        = jz4740_mmc_request,
 951        .pre_req        = jz4740_mmc_pre_request,
 952        .post_req       = jz4740_mmc_post_request,
 953        .set_ios        = jz4740_mmc_set_ios,
 954        .get_ro         = mmc_gpio_get_ro,
 955        .get_cd         = mmc_gpio_get_cd,
 956        .enable_sdio_irq = jz4740_mmc_enable_sdio_irq,
 957};
 958
 959static const struct of_device_id jz4740_mmc_of_match[] = {
 960        { .compatible = "ingenic,jz4740-mmc", .data = (void *) JZ_MMC_JZ4740 },
 961        { .compatible = "ingenic,jz4725b-mmc", .data = (void *)JZ_MMC_JZ4725B },
 962        { .compatible = "ingenic,jz4760-mmc", .data = (void *) JZ_MMC_JZ4760 },
 963        { .compatible = "ingenic,jz4780-mmc", .data = (void *) JZ_MMC_JZ4780 },
 964        { .compatible = "ingenic,x1000-mmc", .data = (void *) JZ_MMC_X1000 },
 965        {},
 966};
 967MODULE_DEVICE_TABLE(of, jz4740_mmc_of_match);
 968
 969static int jz4740_mmc_probe(struct platform_device* pdev)
 970{
 971        int ret;
 972        struct mmc_host *mmc;
 973        struct jz4740_mmc_host *host;
 974        const struct of_device_id *match;
 975
 976        mmc = mmc_alloc_host(sizeof(struct jz4740_mmc_host), &pdev->dev);
 977        if (!mmc) {
 978                dev_err(&pdev->dev, "Failed to alloc mmc host structure\n");
 979                return -ENOMEM;
 980        }
 981
 982        host = mmc_priv(mmc);
 983
 984        match = of_match_device(jz4740_mmc_of_match, &pdev->dev);
 985        if (match) {
 986                host->version = (enum jz4740_mmc_version)match->data;
 987        } else {
 988                /* JZ4740 should be the only one using legacy probe */
 989                host->version = JZ_MMC_JZ4740;
 990        }
 991
 992        ret = mmc_of_parse(mmc);
 993        if (ret) {
 994                if (ret != -EPROBE_DEFER)
 995                        dev_err(&pdev->dev,
 996                                "could not parse device properties: %d\n", ret);
 997                goto err_free_host;
 998        }
 999
1000        mmc_regulator_get_supply(mmc);
1001
1002        host->irq = platform_get_irq(pdev, 0);
1003        if (host->irq < 0) {
1004                ret = host->irq;
1005                goto err_free_host;
1006        }
1007
1008        host->clk = devm_clk_get(&pdev->dev, "mmc");
1009        if (IS_ERR(host->clk)) {
1010                ret = PTR_ERR(host->clk);
1011                dev_err(&pdev->dev, "Failed to get mmc clock\n");
1012                goto err_free_host;
1013        }
1014
1015        host->mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1016        host->base = devm_ioremap_resource(&pdev->dev, host->mem_res);
1017        if (IS_ERR(host->base)) {
1018                ret = PTR_ERR(host->base);
1019                dev_err(&pdev->dev, "Failed to ioremap base memory\n");
1020                goto err_free_host;
1021        }
1022
1023        mmc->ops = &jz4740_mmc_ops;
1024        if (!mmc->f_max)
1025                mmc->f_max = JZ_MMC_CLK_RATE;
1026        mmc->f_min = mmc->f_max / 128;
1027        mmc->ocr_avail = MMC_VDD_32_33 | MMC_VDD_33_34;
1028
1029        /*
1030         * We use a fixed timeout of 5s, hence inform the core about it. A
1031         * future improvement should instead respect the cmd->busy_timeout.
1032         */
1033        mmc->max_busy_timeout = JZ_MMC_REQ_TIMEOUT_MS;
1034
1035        mmc->max_blk_size = (1 << 10) - 1;
1036        mmc->max_blk_count = (1 << 15) - 1;
1037        mmc->max_req_size = mmc->max_blk_size * mmc->max_blk_count;
1038
1039        mmc->max_segs = 128;
1040        mmc->max_seg_size = mmc->max_req_size;
1041
1042        host->mmc = mmc;
1043        host->pdev = pdev;
1044        spin_lock_init(&host->lock);
1045        host->irq_mask = ~0;
1046
1047        jz4740_mmc_reset(host);
1048
1049        ret = request_threaded_irq(host->irq, jz_mmc_irq, jz_mmc_irq_worker, 0,
1050                        dev_name(&pdev->dev), host);
1051        if (ret) {
1052                dev_err(&pdev->dev, "Failed to request irq: %d\n", ret);
1053                goto err_free_host;
1054        }
1055
1056        jz4740_mmc_clock_disable(host);
1057        timer_setup(&host->timeout_timer, jz4740_mmc_timeout, 0);
1058
1059        ret = jz4740_mmc_acquire_dma_channels(host);
1060        if (ret == -EPROBE_DEFER)
1061                goto err_free_irq;
1062        host->use_dma = !ret;
1063
1064        platform_set_drvdata(pdev, host);
1065        ret = mmc_add_host(mmc);
1066
1067        if (ret) {
1068                dev_err(&pdev->dev, "Failed to add mmc host: %d\n", ret);
1069                goto err_release_dma;
1070        }
1071        dev_info(&pdev->dev, "Ingenic SD/MMC card driver registered\n");
1072
1073        dev_info(&pdev->dev, "Using %s, %d-bit mode\n",
1074                 host->use_dma ? "DMA" : "PIO",
1075                 (mmc->caps & MMC_CAP_8_BIT_DATA) ? 8 :
1076                 ((mmc->caps & MMC_CAP_4_BIT_DATA) ? 4 : 1));
1077
1078        return 0;
1079
1080err_release_dma:
1081        if (host->use_dma)
1082                jz4740_mmc_release_dma_channels(host);
1083err_free_irq:
1084        free_irq(host->irq, host);
1085err_free_host:
1086        mmc_free_host(mmc);
1087
1088        return ret;
1089}
1090
1091static int jz4740_mmc_remove(struct platform_device *pdev)
1092{
1093        struct jz4740_mmc_host *host = platform_get_drvdata(pdev);
1094
1095        del_timer_sync(&host->timeout_timer);
1096        jz4740_mmc_set_irq_enabled(host, 0xff, false);
1097        jz4740_mmc_reset(host);
1098
1099        mmc_remove_host(host->mmc);
1100
1101        free_irq(host->irq, host);
1102
1103        if (host->use_dma)
1104                jz4740_mmc_release_dma_channels(host);
1105
1106        mmc_free_host(host->mmc);
1107
1108        return 0;
1109}
1110
1111static int __maybe_unused jz4740_mmc_suspend(struct device *dev)
1112{
1113        return pinctrl_pm_select_sleep_state(dev);
1114}
1115
1116static int __maybe_unused jz4740_mmc_resume(struct device *dev)
1117{
1118        return pinctrl_select_default_state(dev);
1119}
1120
1121static SIMPLE_DEV_PM_OPS(jz4740_mmc_pm_ops, jz4740_mmc_suspend,
1122        jz4740_mmc_resume);
1123
1124static struct platform_driver jz4740_mmc_driver = {
1125        .probe = jz4740_mmc_probe,
1126        .remove = jz4740_mmc_remove,
1127        .driver = {
1128                .name = "jz4740-mmc",
1129                .of_match_table = of_match_ptr(jz4740_mmc_of_match),
1130                .pm = pm_ptr(&jz4740_mmc_pm_ops),
1131        },
1132};
1133
1134module_platform_driver(jz4740_mmc_driver);
1135
1136MODULE_DESCRIPTION("JZ4740 SD/MMC controller driver");
1137MODULE_LICENSE("GPL");
1138MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
1139