drivers/mmc/core/sd_ops.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  linux/drivers/mmc/core/sd_ops.h
   4  *
   5  *  Copyright 2006-2007 Pierre Ossman
   6  */
   7
   8 #include <linux/slab.h>
   9 #include <linux/types.h>
  10 #include <linux/export.h>
  11 #include <linux/scatterlist.h>
  12
  13 #include <linux/mmc/host.h>
  14 #include <linux/mmc/card.h>
  15 #include <linux/mmc/mmc.h>
  16 #include <linux/mmc/sd.h>
  17
  18 #include "core.h"
  19 #include "sd_ops.h"
  20
  21 int mmc_app_cmd(struct mmc_host *host, struct mmc_card *card)
  22 {
  23         int err;
  24         struct mmc_command cmd = {};
  25
  26         if (WARN_ON(card && card->host != host))
  27                 return -EINVAL;
  28
  29         cmd.opcode = MMC_APP_CMD;
  30
  31         if (card) {
  32                 cmd.arg = card->rca << 16;
  33                 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_AC;
  34         } else {
  35                 cmd.arg = 0;
  36                 cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_BCR;
  37         }
  38
  39         err = mmc_wait_for_cmd(host, &cmd, 0);
  40         if (err)
  41                 return err;
  42
  43         /* Check that card supported application commands */
  44         if (!mmc_host_is_spi(host) && !(cmd.resp[0] & R1_APP_CMD))
  45                 return -EOPNOTSUPP;
  46
  47         return 0;
  48 }
  49 EXPORT_SYMBOL_GPL(mmc_app_cmd);
  50
  51 static int mmc_wait_for_app_cmd(struct mmc_host *host, struct mmc_card *card,
  52                                 struct mmc_command *cmd)
  53 {
  54         struct mmc_request mrq = {};
  55         int i, err = -EIO;
  56
  57         /*
  58          * We have to resend MMC_APP_CMD for each attempt so
  59          * we cannot use the retries field in mmc_command.
  60          */
  61         for (i = 0; i <= MMC_CMD_RETRIES; i++) {
  62                 err = mmc_app_cmd(host, card);
  63                 if (err) {
  64                         /* no point in retrying; no APP commands allowed */
  65                         if (mmc_host_is_spi(host)) {
  66                                 if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
  67                                         break;
  68                         }
  69                         continue;
  70                 }
  71
  72                 memset(&mrq, 0, sizeof(struct mmc_request));
  73
  74                 memset(cmd->resp, 0, sizeof(cmd->resp));
  75                 cmd->retries = 0;
  76
  77                 mrq.cmd = cmd;
  78                 cmd->data = NULL;
  79
  80                 mmc_wait_for_req(host, &mrq);
  81
  82                 err = cmd->error;
  83                 if (!cmd->error)
  84                         break;
  85
  86                 /* no point in retrying illegal APP commands */
  87                 if (mmc_host_is_spi(host)) {
  88                         if (cmd->resp[0] & R1_SPI_ILLEGAL_COMMAND)
  89                                 break;
  90                 }
  91         }
  92
  93         return err;
  94 }
  95
  96 int mmc_app_set_bus_width(struct mmc_card *card, int width)
  97 {
  98         struct mmc_command cmd = {};
  99
 100         cmd.opcode = SD_APP_SET_BUS_WIDTH;
 101         cmd.flags = MMC_RSP_R1 | MMC_CMD_AC;
 102
 103         switch (width) {
 104         case MMC_BUS_WIDTH_1:
 105                 cmd.arg = SD_BUS_WIDTH_1;
 106                 break;
 107         case MMC_BUS_WIDTH_4:
 108                 cmd.arg = SD_BUS_WIDTH_4;
 109                 break;
 110         default:
 111                 return -EINVAL;
 112         }
 113
 114         return mmc_wait_for_app_cmd(card->host, card, &cmd);
 115 }
 116
 117 int mmc_send_app_op_cond(struct mmc_host *host, u32 ocr, u32 *rocr)
 118 {
 119         struct mmc_command cmd = {};
 120         int i, err = 0;
 121
 122         cmd.opcode = SD_APP_OP_COND;
 123         if (mmc_host_is_spi(host))
 124                 cmd.arg = ocr & (1 << 30); /* SPI only defines one bit */
 125         else
 126                 cmd.arg = ocr;
 127         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R3 | MMC_CMD_BCR;
 128
 129         for (i = 100; i; i--) {
 130                 err = mmc_wait_for_app_cmd(host, NULL, &cmd);
 131                 if (err)
 132                         break;
 133
 134                 /* if we're just probing, do a single pass */
 135                 if (ocr == 0)
 136                         break;
 137
 138                 /* otherwise wait until reset completes */
 139                 if (mmc_host_is_spi(host)) {
 140                         if (!(cmd.resp[0] & R1_SPI_IDLE))
 141                                 break;
 142                 } else {
 143                         if (cmd.resp[0] & MMC_CARD_BUSY)
 144                                 break;
 145                 }
 146
 147                 err = -ETIMEDOUT;
 148
 149                 mmc_delay(10);
 150         }
 151
 152         if (!i)
 153                 pr_err("%s: card never left busy state\n", mmc_hostname(host));
 154
 155         if (rocr && !mmc_host_is_spi(host))
 156                 *rocr = cmd.resp[0];
 157
 158         return err;
 159 }
 160
 161 static int __mmc_send_if_cond(struct mmc_host *host, u32 ocr, u8 pcie_bits,
 162                               u32 *resp)
 163 {
 164         struct mmc_command cmd = {};
 165         int err;
 166         static const u8 test_pattern = 0xAA;
 167         u8 result_pattern;
 168
 169         /*
 170          * To support SD 2.0 cards, we must always invoke SD_SEND_IF_COND
 171          * before SD_APP_OP_COND. This command will harmlessly fail for
 172          * SD 1.0 cards.
 173          */
 174         cmd.opcode = SD_SEND_IF_COND;
 175         cmd.arg = ((ocr & 0xFF8000) != 0) << 8 | pcie_bits << 8 | test_pattern;
 176         cmd.flags = MMC_RSP_SPI_R7 | MMC_RSP_R7 | MMC_CMD_BCR;
 177
 178         err = mmc_wait_for_cmd(host, &cmd, 0);
 179         if (err)
 180                 return err;
 181
 182         if (mmc_host_is_spi(host))
 183                 result_pattern = cmd.resp[1] & 0xFF;
 184         else
 185                 result_pattern = cmd.resp[0] & 0xFF;
 186
 187         if (result_pattern != test_pattern)
 188                 return -EIO;
 189
 190         if (resp)
 191                 *resp = cmd.resp[0];
 192
 193         return 0;
 194 }
 195
 196 int mmc_send_if_cond(struct mmc_host *host, u32 ocr)
 197 {
 198         return __mmc_send_if_cond(host, ocr, 0, NULL);
 199 }
 200
 201 int mmc_send_if_cond_pcie(struct mmc_host *host, u32 ocr)
 202 {
 203         u32 resp = 0;
 204         u8 pcie_bits = 0;
 205         int ret;
 206
 207         if (host->caps2 & MMC_CAP2_SD_EXP) {
 208                 /* Probe card for SD express support via PCIe. */
 209                 pcie_bits = 0x10;
 210                 if (host->caps2 & MMC_CAP2_SD_EXP_1_2V)
 211                         /* Probe also for 1.2V support. */
 212                         pcie_bits = 0x30;
 213         }
 214
 215         ret = __mmc_send_if_cond(host, ocr, pcie_bits, &resp);
 216         if (ret)
 217                 return 0;
 218
 219         /* Continue with the SD express init, if the card supports it. */
 220         resp &= 0x3000;
 221         if (pcie_bits && resp) {
 222                 if (resp == 0x3000)
 223                         host->ios.timing = MMC_TIMING_SD_EXP_1_2V;
 224                 else
 225                         host->ios.timing = MMC_TIMING_SD_EXP;
 226
 227                 /*
 228                  * According to the spec the clock shall also be gated, but
 229                  * let's leave this to the host driver for more flexibility.
 230                  */
 231                 return host->ops->init_sd_express(host, &host->ios);
 232         }
 233
 234         return 0;
 235 }
 236
 237 int mmc_send_relative_addr(struct mmc_host *host, unsigned int *rca)
 238 {
 239         int err;
 240         struct mmc_command cmd = {};
 241
 242         cmd.opcode = SD_SEND_RELATIVE_ADDR;
 243         cmd.arg = 0;
 244         cmd.flags = MMC_RSP_R6 | MMC_CMD_BCR;
 245
 246         err = mmc_wait_for_cmd(host, &cmd, MMC_CMD_RETRIES);
 247         if (err)
 248                 return err;
 249
 250         *rca = cmd.resp[0] >> 16;
 251
 252         return 0;
 253 }
 254
 255 int mmc_app_send_scr(struct mmc_card *card)
 256 {
 257         int err;
 258         struct mmc_request mrq = {};
 259         struct mmc_command cmd = {};
 260         struct mmc_data data = {};
 261         struct scatterlist sg;
 262         __be32 *scr;
 263
 264         /* NOTE: caller guarantees scr is heap-allocated */
 265
 266         err = mmc_app_cmd(card->host, card);
 267         if (err)
 268                 return err;
 269
 270         /* dma onto stack is unsafe/nonportable, but callers to this
 271          * routine normally provide temporary on-stack buffers ...
 272          */
 273         scr = kmalloc(sizeof(card->raw_scr), GFP_KERNEL);
 274         if (!scr)
 275                 return -ENOMEM;
 276
 277         mrq.cmd = &cmd;
 278         mrq.data = &data;
 279
 280         cmd.opcode = SD_APP_SEND_SCR;
 281         cmd.arg = 0;
 282         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
 283
 284         data.blksz = 8;
 285         data.blocks = 1;
 286         data.flags = MMC_DATA_READ;
 287         data.sg = &sg;
 288         data.sg_len = 1;
 289
 290         sg_init_one(&sg, scr, 8);
 291
 292         mmc_set_data_timeout(&data, card);
 293
 294         mmc_wait_for_req(card->host, &mrq);
 295
 296         card->raw_scr[0] = be32_to_cpu(scr[0]);
 297         card->raw_scr[1] = be32_to_cpu(scr[1]);
 298
 299         kfree(scr);
 300
 301         if (cmd.error)
 302                 return cmd.error;
 303         if (data.error)
 304                 return data.error;
 305
 306         return 0;
 307 }
 308
 309 int mmc_sd_switch(struct mmc_card *card, int mode, int group,
 310         u8 value, u8 *resp)
 311 {
 312         struct mmc_request mrq = {};
 313         struct mmc_command cmd = {};
 314         struct mmc_data data = {};
 315         struct scatterlist sg;
 316
 317         /* NOTE: caller guarantees resp is heap-allocated */
 318
 319         mode = !!mode;
 320         value &= 0xF;
 321
 322         mrq.cmd = &cmd;
 323         mrq.data = &data;
 324
 325         cmd.opcode = SD_SWITCH;
 326         cmd.arg = mode << 31 | 0x00FFFFFF;
 327         cmd.arg &= ~(0xF << (group * 4));
 328         cmd.arg |= value << (group * 4);
 329         cmd.flags = MMC_RSP_SPI_R1 | MMC_RSP_R1 | MMC_CMD_ADTC;
 330
 331         data.blksz = 64;
 332         data.blocks = 1;
 333         data.flags = MMC_DATA_READ;
 334         data.sg = &sg;
 335         data.sg_len = 1;
 336
 337         sg_init_one(&sg, resp, 64);
 338
 339         mmc_set_data_timeout(&data, card);
 340
 341         mmc_wait_for_req(card->host, &mrq);
 342
 343         if (cmd.error)
 344                 return cmd.error;
 345         if (data.error)
 346                 return data.error;
 347
 348         return 0;
 349 }
 350
 351 int mmc_app_sd_status(struct mmc_card *card, void *ssr)
 352 {
 353         int err;
 354         struct mmc_request mrq = {};
 355         struct mmc_command cmd = {};
 356         struct mmc_data data = {};
 357         struct scatterlist sg;
 358
 359         /* NOTE: caller guarantees ssr is heap-allocated */
 360
 361         err = mmc_app_cmd(card->host, card);
 362         if (err)
 363                 return err;
 364
 365         mrq.cmd = &cmd;
 366         mrq.data = &data;
 367
 368         cmd.opcode = SD_APP_SD_STATUS;
 369         cmd.arg = 0;
 370         cmd.flags = MMC_RSP_SPI_R2 | MMC_RSP_R1 | MMC_CMD_ADTC;
 371
 372         data.blksz = 64;
 373         data.blocks = 1;
 374         data.flags = MMC_DATA_READ;
 375         data.sg = &sg;
 376         data.sg_len = 1;
 377
 378         sg_init_one(&sg, ssr, 64);
 379
 380         mmc_set_data_timeout(&data, card);
 381
 382         mmc_wait_for_req(card->host, &mrq);
 383
 384         if (cmd.error)
 385                 return cmd.error;
 386         if (data.error)
 387                 return data.error;
 388
 389         return 0;
 390 }