drivers/mmc/core/sdio_cis.c

   1 /*
   2  * linux/drivers/mmc/core/sdio_cis.c
   3  *
   4  * Author:      Nicolas Pitre
   5  * Created:     June 11, 2007
   6  * Copyright:   MontaVista Software Inc.
   7  *
   8  * Copyright 2007 Pierre Ossman
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or (at
  13  * your option) any later version.
  14  */
  15
  16 #include <linux/kernel.h>
  17 #include <linux/slab.h>
  18
  19 #include <linux/mmc/host.h>
  20 #include <linux/mmc/card.h>
  21 #include <linux/mmc/sdio.h>
  22 #include <linux/mmc/sdio_func.h>
  23
  24 #include "sdio_cis.h"
  25 #include "sdio_ops.h"
  26
  27 #define SDIO_READ_CIS_TIMEOUT_MS  (10 * 1000) /* 10s */
  28
  29 static int cistpl_vers_1(struct mmc_card *card, struct sdio_func *func,
  30                          const unsigned char *buf, unsigned size)
  31 {
  32         unsigned i, nr_strings;
  33         char **buffer, *string;
  34
  35         if (size < 2)
  36                 return 0;
  37
  38         /* Find all null-terminated (including zero length) strings in
  39            the TPLLV1_INFO field. Trailing garbage is ignored. */
  40         buf += 2;
  41         size -= 2;
  42
  43         nr_strings = 0;
  44         for (i = 0; i < size; i++) {
  45                 if (buf[i] == 0xff)
  46                         break;
  47                 if (buf[i] == 0)
  48                         nr_strings++;
  49         }
  50         if (nr_strings == 0)
  51                 return 0;
  52
  53         size = i;
  54
  55         buffer = kzalloc(sizeof(char*) * nr_strings + size, GFP_KERNEL);
  56         if (!buffer)
  57                 return -ENOMEM;
  58
  59         string = (char*)(buffer + nr_strings);
  60
  61         for (i = 0; i < nr_strings; i++) {
  62                 buffer[i] = string;
  63                 strcpy(string, buf);
  64                 string += strlen(string) + 1;
  65                 buf += strlen(buf) + 1;
  66         }
  67
  68         if (func) {
  69                 func->num_info = nr_strings;
  70                 func->info = (const char**)buffer;
  71         } else {
  72                 card->num_info = nr_strings;
  73                 card->info = (const char**)buffer;
  74         }
  75
  76         return 0;
  77 }
  78
  79 static int cistpl_manfid(struct mmc_card *card, struct sdio_func *func,
  80                          const unsigned char *buf, unsigned size)
  81 {
  82         unsigned int vendor, device;
  83
  84         /* TPLMID_MANF */
  85         vendor = buf[0] | (buf[1] << 8);
  86
  87         /* TPLMID_CARD */
  88         device = buf[2] | (buf[3] << 8);
  89
  90         if (func) {
  91                 func->vendor = vendor;
  92                 func->device = device;
  93         } else {
  94                 card->cis.vendor = vendor;
  95                 card->cis.device = device;
  96         }
  97
  98         return 0;
  99 }
 100
 101 static const unsigned char speed_val[16] =
 102         { 0, 10, 12, 13, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 70, 80 };
 103 static const unsigned int speed_unit[8] =
 104         { 10000, 100000, 1000000, 10000000, 0, 0, 0, 0 };
 105
 106
 107 typedef int (tpl_parse_t)(struct mmc_card *, struct sdio_func *,
 108                            const unsigned char *, unsigned);
 109
 110 struct cis_tpl {
 111         unsigned char code;
 112         unsigned char min_size;
 113         tpl_parse_t *parse;
 114 };
 115
 116 static int cis_tpl_parse(struct mmc_card *card, struct sdio_func *func,
 117                          const char *tpl_descr,
 118                          const struct cis_tpl *tpl, int tpl_count,
 119                          unsigned char code,
 120                          const unsigned char *buf, unsigned size)
 121 {
 122         int i, ret;
 123
 124         /* look for a matching code in the table */
 125         for (i = 0; i < tpl_count; i++, tpl++) {
 126                 if (tpl->code == code)
 127                         break;
 128         }
 129         if (i < tpl_count) {
 130                 if (size >= tpl->min_size) {
 131                         if (tpl->parse)
 132                                 ret = tpl->parse(card, func, buf, size);
 133                         else
 134                                 ret = -EILSEQ;  /* known tuple, not parsed */
 135                 } else {
 136                         /* invalid tuple */
 137                         ret = -EINVAL;
 138                 }
 139                 if (ret && ret != -EILSEQ && ret != -ENOENT) {
 140                         pr_err("%s: bad %s tuple 0x%02x (%u bytes)\n",
 141                                mmc_hostname(card->host), tpl_descr, code, size);
 142                 }
 143         } else {
 144                 /* unknown tuple */
 145                 ret = -ENOENT;
 146         }
 147
 148         return ret;
 149 }
 150
 151 static int cistpl_funce_common(struct mmc_card *card, struct sdio_func *func,
 152                                const unsigned char *buf, unsigned size)
 153 {
 154         /* Only valid for the common CIS (function 0) */
 155         if (func)
 156                 return -EINVAL;
 157
 158         /* TPLFE_FN0_BLK_SIZE */
 159         card->cis.blksize = buf[1] | (buf[2] << 8);
 160
 161         /* TPLFE_MAX_TRAN_SPEED */
 162         card->cis.max_dtr = speed_val[(buf[3] >> 3) & 15] *
 163                             speed_unit[buf[3] & 7];
 164
 165         return 0;
 166 }
 167
 168 static int cistpl_funce_func(struct mmc_card *card, struct sdio_func *func,
 169                              const unsigned char *buf, unsigned size)
 170 {
 171         unsigned vsn;
 172         unsigned min_size;
 173
 174         /* Only valid for the individual function's CIS (1-7) */
 175         if (!func)
 176                 return -EINVAL;
 177
 178         /*
 179          * This tuple has a different length depending on the SDIO spec
 180          * version.
 181          */
 182         vsn = func->card->cccr.sdio_vsn;
 183         min_size = (vsn == SDIO_SDIO_REV_1_00) ? 28 : 42;
 184
 185         if (size == 28 && vsn == SDIO_SDIO_REV_1_10) {
 186                 pr_warn("%s: card has broken SDIO 1.1 CIS, forcing SDIO 1.0\n",
 187                         mmc_hostname(card->host));
 188                 vsn = SDIO_SDIO_REV_1_00;
 189         } else if (size < min_size) {
 190                 return -EINVAL;
 191         }
 192
 193         /* TPLFE_MAX_BLK_SIZE */
 194         func->max_blksize = buf[12] | (buf[13] << 8);
 195
 196         /* TPLFE_ENABLE_TIMEOUT_VAL, present in ver 1.1 and above */
 197         if (vsn > SDIO_SDIO_REV_1_00)
 198                 func->enable_timeout = (buf[28] | (buf[29] << 8)) * 10;
 199         else
 200                 func->enable_timeout = jiffies_to_msecs(HZ);
 201
 202         return 0;
 203 }
 204
 205 /*
 206  * Known TPLFE_TYPEs table for CISTPL_FUNCE tuples.
 207  *
 208  * Note that, unlike PCMCIA, CISTPL_FUNCE tuples are not parsed depending
 209  * on the TPLFID_FUNCTION value of the previous CISTPL_FUNCID as on SDIO
 210  * TPLFID_FUNCTION is always hardcoded to 0x0C.
 211  */
 212 static const struct cis_tpl cis_tpl_funce_list[] = {
 213         {       0x00,   4,      cistpl_funce_common             },
 214         {       0x01,   0,      cistpl_funce_func               },
 215         {       0x04,   1+1+6,  /* CISTPL_FUNCE_LAN_NODE_ID */  },
 216 };
 217
 218 static int cistpl_funce(struct mmc_card *card, struct sdio_func *func,
 219                         const unsigned char *buf, unsigned size)
 220 {
 221         if (size < 1)
 222                 return -EINVAL;
 223
 224         return cis_tpl_parse(card, func, "CISTPL_FUNCE",
 225                              cis_tpl_funce_list,
 226                              ARRAY_SIZE(cis_tpl_funce_list),
 227                              buf[0], buf, size);
 228 }
 229
 230 /* Known TPL_CODEs table for CIS tuples */
 231 static const struct cis_tpl cis_tpl_list[] = {
 232         {       0x15,   3,      cistpl_vers_1           },
 233         {       0x20,   4,      cistpl_manfid           },
 234         {       0x21,   2,      /* cistpl_funcid */     },
 235         {       0x22,   0,      cistpl_funce            },
 236         {       0x91,   2,      /* cistpl_sdio_std */   },
 237 };
 238
 239 static int sdio_read_cis(struct mmc_card *card, struct sdio_func *func)
 240 {
 241         int ret;
 242         struct sdio_func_tuple *this, **prev;
 243         unsigned i, ptr = 0;
 244
 245         /*
 246          * Note that this works for the common CIS (function number 0) as
 247          * well as a function's CIS * since SDIO_CCCR_CIS and SDIO_FBR_CIS
 248          * have the same offset.
 249          */
 250         for (i = 0; i < 3; i++) {
 251                 unsigned char x, fn;
 252
 253                 if (func)
 254                         fn = func->num;
 255                 else
 256                         fn = 0;
 257
 258                 ret = mmc_io_rw_direct(card, 0, 0,
 259                         SDIO_FBR_BASE(fn) + SDIO_FBR_CIS + i, 0, &x);
 260                 if (ret)
 261                         return ret;
 262                 ptr |= x << (i * 8);
 263         }
 264
 265         if (func)
 266                 prev = &func->tuples;
 267         else
 268                 prev = &card->tuples;
 269
 270         BUG_ON(*prev);
 271
 272         do {
 273                 unsigned char tpl_code, tpl_link;
 274                 unsigned long timeout = jiffies +
 275                         msecs_to_jiffies(SDIO_READ_CIS_TIMEOUT_MS);
 276
 277                 ret = mmc_io_rw_direct(card, 0, 0, ptr++, 0, &tpl_code);
 278                 if (ret)
 279                         break;
 280
 281                 /* 0xff means we're done */
 282                 if (tpl_code == 0xff)
 283                         break;
 284
 285                 /* null entries have no link field or data */
 286                 if (tpl_code == 0x00)
 287                         continue;
 288
 289                 ret = mmc_io_rw_direct(card, 0, 0, ptr++, 0, &tpl_link);
 290                 if (ret)
 291                         break;
 292
 293                 /* a size of 0xff also means we're done */
 294                 if (tpl_link == 0xff)
 295                         break;
 296
 297                 this = kmalloc(sizeof(*this) + tpl_link, GFP_KERNEL);
 298                 if (!this)
 299                         return -ENOMEM;
 300
 301                 for (i = 0; i < tpl_link; i++) {
 302                         ret = mmc_io_rw_direct(card, 0, 0,
 303                                                ptr + i, 0, &this->data[i]);
 304                         if (ret)
 305                                 break;
 306                 }
 307                 if (ret) {
 308                         kfree(this);
 309                         break;
 310                 }
 311
 312                 /* Try to parse the CIS tuple */
 313                 ret = cis_tpl_parse(card, func, "CIS",
 314                                     cis_tpl_list, ARRAY_SIZE(cis_tpl_list),
 315                                     tpl_code, this->data, tpl_link);
 316                 if (ret == -EILSEQ || ret == -ENOENT) {
 317                         /*
 318                          * The tuple is unknown or known but not parsed.
 319                          * Queue the tuple for the function driver.
 320                          */
 321                         this->next = NULL;
 322                         this->code = tpl_code;
 323                         this->size = tpl_link;
 324                         *prev = this;
 325                         prev = &this->next;
 326
 327                         if (ret == -ENOENT) {
 328                                 if (time_after(jiffies, timeout))
 329                                         break;
 330                                 /* warn about unknown tuples */
 331                                 pr_warn_ratelimited("%s: queuing unknown"
 332                                        " CIS tuple 0x%02x (%u bytes)\n",
 333                                        mmc_hostname(card->host),
 334                                        tpl_code, tpl_link);
 335                         }
 336
 337                         /* keep on analyzing tuples */
 338                         ret = 0;
 339                 } else {
 340                         /*
 341                          * We don't need the tuple anymore if it was
 342                          * successfully parsed by the SDIO core or if it is
 343                          * not going to be queued for a driver.
 344                          */
 345                         kfree(this);
 346                 }
 347
 348                 ptr += tpl_link;
 349         } while (!ret);
 350
 351         /*
 352          * Link in all unknown tuples found in the common CIS so that
 353          * drivers don't have to go digging in two places.
 354          */
 355         if (func)
 356                 *prev = card->tuples;
 357
 358         return ret;
 359 }
 360
 361 int sdio_read_common_cis(struct mmc_card *card)
 362 {
 363         return sdio_read_cis(card, NULL);
 364 }
 365
 366 void sdio_free_common_cis(struct mmc_card *card)
 367 {
 368         struct sdio_func_tuple *tuple, *victim;
 369
 370         tuple = card->tuples;
 371
 372         while (tuple) {
 373                 victim = tuple;
 374                 tuple = tuple->next;
 375                 kfree(victim);
 376         }
 377
 378         card->tuples = NULL;
 379 }
 380
 381 int sdio_read_func_cis(struct sdio_func *func)
 382 {
 383         int ret;
 384
 385         ret = sdio_read_cis(func->card, func);
 386         if (ret)
 387                 return ret;
 388
 389         /*
 390          * Since we've linked to tuples in the card structure,
 391          * we must make sure we have a reference to it.
 392          */
 393         get_device(&func->card->dev);
 394
 395         /*
 396          * Vendor/device id is optional for function CIS, so
 397          * copy it from the card structure as needed.
 398          */
 399         if (func->vendor == 0) {
 400                 func->vendor = func->card->cis.vendor;
 401                 func->device = func->card->cis.device;
 402         }
 403
 404         return 0;
 405 }
 406
 407 void sdio_free_func_cis(struct sdio_func *func)
 408 {
 409         struct sdio_func_tuple *tuple, *victim;
 410
 411         tuple = func->tuples;
 412
 413         while (tuple && tuple != func->card->tuples) {
 414                 victim = tuple;
 415                 tuple = tuple->next;
 416                 kfree(victim);
 417         }
 418
 419         func->tuples = NULL;
 420
 421         /*
 422          * We have now removed the link to the tuples in the
 423          * card structure, so remove the reference.
 424          */
 425         put_device(&func->card->dev);
 426 }
 427