2 * linux/drivers/mmc/core/sdio_cis.c
4 * Author: Nicolas Pitre
5 * Created: June 11, 2007
6 * Copyright: MontaVista Software Inc.
8 * Copyright 2007 Pierre Ossman
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.
16 #include <linux/kernel.h>
17 #include <linux/slab.h>
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>
27 static int cistpl_vers_1(struct mmc_card *card, struct sdio_func *func,
28 const unsigned char *buf, unsigned size)
30 unsigned i, nr_strings;
31 char **buffer, *string;
33 /* Find all null-terminated (including zero length) strings in
34 the TPLLV1_INFO field. Trailing garbage is ignored. */
39 for (i = 0; i < size; i++) {
50 buffer = kzalloc(sizeof(char*) * nr_strings + size, GFP_KERNEL);
54 string = (char*)(buffer + nr_strings);
56 for (i = 0; i < nr_strings; i++) {
59 string += strlen(string) + 1;
60 buf += strlen(buf) + 1;
64 func->num_info = nr_strings;
65 func->info = (const char**)buffer;
67 card->num_info = nr_strings;
68 card->info = (const char**)buffer;
74 static int cistpl_manfid(struct mmc_card *card, struct sdio_func *func,
75 const unsigned char *buf, unsigned size)
77 unsigned int vendor, device;
80 vendor = buf[0] | (buf[1] << 8);
83 device = buf[2] | (buf[3] << 8);
86 func->vendor = vendor;
87 func->device = device;
89 card->cis.vendor = vendor;
90 card->cis.device = device;
96 static const unsigned char speed_val[16] =
97 { 0, 10, 12, 13, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 70, 80 };
98 static const unsigned int speed_unit[8] =
99 { 10000, 100000, 1000000, 10000000, 0, 0, 0, 0 };
102 typedef int (tpl_parse_t)(struct mmc_card *, struct sdio_func *,
103 const unsigned char *, unsigned);
107 unsigned char min_size;
111 static int cis_tpl_parse(struct mmc_card *card, struct sdio_func *func,
112 const char *tpl_descr,
113 const struct cis_tpl *tpl, int tpl_count,
115 const unsigned char *buf, unsigned size)
119 /* look for a matching code in the table */
120 for (i = 0; i < tpl_count; i++, tpl++) {
121 if (tpl->code == code)
125 if (size >= tpl->min_size) {
127 ret = tpl->parse(card, func, buf, size);
129 ret = -EILSEQ; /* known tuple, not parsed */
134 if (ret && ret != -EILSEQ && ret != -ENOENT) {
135 pr_err("%s: bad %s tuple 0x%02x (%u bytes)\n",
136 mmc_hostname(card->host), tpl_descr, code, size);
146 static int cistpl_funce_common(struct mmc_card *card, struct sdio_func *func,
147 const unsigned char *buf, unsigned size)
149 /* Only valid for the common CIS (function 0) */
153 /* TPLFE_FN0_BLK_SIZE */
154 card->cis.blksize = buf[1] | (buf[2] << 8);
156 /* TPLFE_MAX_TRAN_SPEED */
157 card->cis.max_dtr = speed_val[(buf[3] >> 3) & 15] *
158 speed_unit[buf[3] & 7];
163 static int cistpl_funce_func(struct mmc_card *card, struct sdio_func *func,
164 const unsigned char *buf, unsigned size)
169 /* Only valid for the individual function's CIS (1-7) */
174 * This tuple has a different length depending on the SDIO spec
177 vsn = func->card->cccr.sdio_vsn;
178 min_size = (vsn == SDIO_SDIO_REV_1_00) ? 28 : 42;
180 if (size == 28 && vsn == SDIO_SDIO_REV_1_10) {
181 pr_warn("%s: card has broken SDIO 1.1 CIS, forcing SDIO 1.0\n",
182 mmc_hostname(card->host));
183 vsn = SDIO_SDIO_REV_1_00;
184 } else if (size < min_size) {
188 /* TPLFE_MAX_BLK_SIZE */
189 func->max_blksize = buf[12] | (buf[13] << 8);
191 /* TPLFE_ENABLE_TIMEOUT_VAL, present in ver 1.1 and above */
192 if (vsn > SDIO_SDIO_REV_1_00)
193 func->enable_timeout = (buf[28] | (buf[29] << 8)) * 10;
195 func->enable_timeout = jiffies_to_msecs(HZ);
201 * Known TPLFE_TYPEs table for CISTPL_FUNCE tuples.
203 * Note that, unlike PCMCIA, CISTPL_FUNCE tuples are not parsed depending
204 * on the TPLFID_FUNCTION value of the previous CISTPL_FUNCID as on SDIO
205 * TPLFID_FUNCTION is always hardcoded to 0x0C.
207 static const struct cis_tpl cis_tpl_funce_list[] = {
208 { 0x00, 4, cistpl_funce_common },
209 { 0x01, 0, cistpl_funce_func },
210 { 0x04, 1+1+6, /* CISTPL_FUNCE_LAN_NODE_ID */ },
213 static int cistpl_funce(struct mmc_card *card, struct sdio_func *func,
214 const unsigned char *buf, unsigned size)
219 return cis_tpl_parse(card, func, "CISTPL_FUNCE",
221 ARRAY_SIZE(cis_tpl_funce_list),
225 /* Known TPL_CODEs table for CIS tuples */
226 static const struct cis_tpl cis_tpl_list[] = {
227 { 0x15, 3, cistpl_vers_1 },
228 { 0x20, 4, cistpl_manfid },
229 { 0x21, 2, /* cistpl_funcid */ },
230 { 0x22, 0, cistpl_funce },
231 { 0x91, 2, /* cistpl_sdio_std */ },
234 static int sdio_read_cis(struct mmc_card *card, struct sdio_func *func)
237 struct sdio_func_tuple *this, **prev;
241 * Note that this works for the common CIS (function number 0) as
242 * well as a function's CIS * since SDIO_CCCR_CIS and SDIO_FBR_CIS
243 * have the same offset.
245 for (i = 0; i < 3; i++) {
253 ret = mmc_io_rw_direct(card, 0, 0,
254 SDIO_FBR_BASE(fn) + SDIO_FBR_CIS + i, 0, &x);
261 prev = &func->tuples;
263 prev = &card->tuples;
269 unsigned char tpl_code, tpl_link;
271 ret = mmc_io_rw_direct(card, 0, 0, ptr++, 0, &tpl_code);
275 /* 0xff means we're done */
276 if (tpl_code == 0xff)
279 /* null entries have no link field or data */
280 if (tpl_code == 0x00)
283 ret = mmc_io_rw_direct(card, 0, 0, ptr++, 0, &tpl_link);
287 /* a size of 0xff also means we're done */
288 if (tpl_link == 0xff)
291 this = kmalloc(sizeof(*this) + tpl_link, GFP_KERNEL);
295 for (i = 0; i < tpl_link; i++) {
296 ret = mmc_io_rw_direct(card, 0, 0,
297 ptr + i, 0, &this->data[i]);
306 /* Try to parse the CIS tuple */
307 ret = cis_tpl_parse(card, func, "CIS",
308 cis_tpl_list, ARRAY_SIZE(cis_tpl_list),
309 tpl_code, this->data, tpl_link);
310 if (ret == -EILSEQ || ret == -ENOENT) {
312 * The tuple is unknown or known but not parsed.
313 * Queue the tuple for the function driver.
316 this->code = tpl_code;
317 this->size = tpl_link;
321 if (ret == -ENOENT) {
322 /* warn about unknown tuples */
323 pr_warn_ratelimited("%s: queuing unknown"
324 " CIS tuple 0x%02x (%u bytes)\n",
325 mmc_hostname(card->host),
329 /* keep on analyzing tuples */
333 * We don't need the tuple anymore if it was
334 * successfully parsed by the SDIO core or if it is
335 * not going to be queued for a driver.
344 * Link in all unknown tuples found in the common CIS so that
345 * drivers don't have to go digging in two places.
348 *prev = card->tuples;
353 int sdio_read_common_cis(struct mmc_card *card)
355 return sdio_read_cis(card, NULL);
358 void sdio_free_common_cis(struct mmc_card *card)
360 struct sdio_func_tuple *tuple, *victim;
362 tuple = card->tuples;
373 int sdio_read_func_cis(struct sdio_func *func)
377 ret = sdio_read_cis(func->card, func);
382 * Since we've linked to tuples in the card structure,
383 * we must make sure we have a reference to it.
385 get_device(&func->card->dev);
388 * Vendor/device id is optional for function CIS, so
389 * copy it from the card structure as needed.
391 if (func->vendor == 0) {
392 func->vendor = func->card->cis.vendor;
393 func->device = func->card->cis.device;
399 void sdio_free_func_cis(struct sdio_func *func)
401 struct sdio_func_tuple *tuple, *victim;
403 tuple = func->tuples;
405 while (tuple && tuple != func->card->tuples) {
414 * We have now removed the link to the tuples in the
415 * card structure, so remove the reference.
417 put_device(&func->card->dev);