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>
18 #include <linux/mmc/host.h>
19 #include <linux/mmc/card.h>
20 #include <linux/mmc/sdio.h>
21 #include <linux/mmc/sdio_func.h>
26 static int cistpl_vers_1(struct mmc_card *card, struct sdio_func *func,
27 const unsigned char *buf, unsigned size)
29 unsigned i, nr_strings;
30 char **buffer, *string;
36 for (i = 0; i < size; i++) {
44 printk(KERN_WARNING "SDIO: ignoring broken CISTPL_VERS_1\n");
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 };
101 /* FUNCE tuples with these types get passed to SDIO drivers */
102 static const unsigned char funce_type_whitelist[] = {
103 4 /* CISTPL_FUNCE_LAN_NODE_ID used in Broadcom cards */
106 static int cistpl_funce_whitelisted(unsigned char type)
110 for (i = 0; i < ARRAY_SIZE(funce_type_whitelist); i++) {
111 if (funce_type_whitelist[i] == type)
117 static int cistpl_funce_common(struct mmc_card *card,
118 const unsigned char *buf, unsigned size)
120 if (size < 0x04 || buf[0] != 0)
123 /* TPLFE_FN0_BLK_SIZE */
124 card->cis.blksize = buf[1] | (buf[2] << 8);
126 /* TPLFE_MAX_TRAN_SPEED */
127 card->cis.max_dtr = speed_val[(buf[3] >> 3) & 15] *
128 speed_unit[buf[3] & 7];
133 static int cistpl_funce_func(struct sdio_func *func,
134 const unsigned char *buf, unsigned size)
139 /* let SDIO drivers take care of whitelisted FUNCE tuples */
140 if (cistpl_funce_whitelisted(buf[0]))
143 vsn = func->card->cccr.sdio_vsn;
144 min_size = (vsn == SDIO_SDIO_REV_1_00) ? 28 : 42;
146 if (size < min_size || buf[0] != 1)
149 /* TPLFE_MAX_BLK_SIZE */
150 func->max_blksize = buf[12] | (buf[13] << 8);
152 /* TPLFE_ENABLE_TIMEOUT_VAL, present in ver 1.1 and above */
153 if (vsn > SDIO_SDIO_REV_1_00)
154 func->enable_timeout = (buf[28] | (buf[29] << 8)) * 10;
156 func->enable_timeout = jiffies_to_msecs(HZ);
161 static int cistpl_funce(struct mmc_card *card, struct sdio_func *func,
162 const unsigned char *buf, unsigned size)
167 * There should be two versions of the CISTPL_FUNCE tuple,
168 * one for the common CIS (function 0) and a version used by
169 * the individual function's CIS (1-7). Yet, the later has a
170 * different length depending on the SDIO spec version.
173 ret = cistpl_funce_func(func, buf, size);
175 ret = cistpl_funce_common(card, buf, size);
177 if (ret && ret != -EILSEQ) {
178 printk(KERN_ERR "%s: bad CISTPL_FUNCE size %u "
179 "type %u\n", mmc_hostname(card->host), size, buf[0]);
185 typedef int (tpl_parse_t)(struct mmc_card *, struct sdio_func *,
186 const unsigned char *, unsigned);
190 unsigned char min_size;
194 static const struct cis_tpl cis_tpl_list[] = {
195 { 0x15, 3, cistpl_vers_1 },
196 { 0x20, 4, cistpl_manfid },
197 { 0x21, 2, /* cistpl_funcid */ },
198 { 0x22, 0, cistpl_funce },
201 static int sdio_read_cis(struct mmc_card *card, struct sdio_func *func)
204 struct sdio_func_tuple *this, **prev;
208 * Note that this works for the common CIS (function number 0) as
209 * well as a function's CIS * since SDIO_CCCR_CIS and SDIO_FBR_CIS
210 * have the same offset.
212 for (i = 0; i < 3; i++) {
220 ret = mmc_io_rw_direct(card, 0, 0,
221 SDIO_FBR_BASE(fn) + SDIO_FBR_CIS + i, 0, &x);
228 prev = &func->tuples;
230 prev = &card->tuples;
235 unsigned char tpl_code, tpl_link;
237 ret = mmc_io_rw_direct(card, 0, 0, ptr++, 0, &tpl_code);
241 /* 0xff means we're done */
242 if (tpl_code == 0xff)
245 /* null entries have no link field or data */
246 if (tpl_code == 0x00)
249 ret = mmc_io_rw_direct(card, 0, 0, ptr++, 0, &tpl_link);
253 /* a size of 0xff also means we're done */
254 if (tpl_link == 0xff)
257 this = kmalloc(sizeof(*this) + tpl_link, GFP_KERNEL);
261 for (i = 0; i < tpl_link; i++) {
262 ret = mmc_io_rw_direct(card, 0, 0,
263 ptr + i, 0, &this->data[i]);
272 for (i = 0; i < ARRAY_SIZE(cis_tpl_list); i++)
273 if (cis_tpl_list[i].code == tpl_code)
275 if (i < ARRAY_SIZE(cis_tpl_list)) {
276 const struct cis_tpl *tpl = cis_tpl_list + i;
277 if (tpl_link < tpl->min_size) {
279 "%s: bad CIS tuple 0x%02x"
280 " (length = %u, expected >= %u)\n",
281 mmc_hostname(card->host),
282 tpl_code, tpl_link, tpl->min_size);
284 } else if (tpl->parse) {
285 ret = tpl->parse(card, func,
286 this->data, tpl_link);
289 * We don't need the tuple anymore if it was
290 * successfully parsed by the SDIO core or if it is
291 * not going to be parsed by SDIO drivers.
293 if (!ret || ret != -EILSEQ)
300 if (ret == -EILSEQ) {
301 /* this tuple is unknown to the core or whitelisted */
303 this->code = tpl_code;
304 this->size = tpl_link;
308 "%s: queuing CIS tuple 0x%02x length %u\n",
309 mmc_hostname(card->host), tpl_code, tpl_link);
310 /* keep on analyzing tuples */
318 * Link in all unknown tuples found in the common CIS so that
319 * drivers don't have to go digging in two places.
322 *prev = card->tuples;
327 int sdio_read_common_cis(struct mmc_card *card)
329 return sdio_read_cis(card, NULL);
332 void sdio_free_common_cis(struct mmc_card *card)
334 struct sdio_func_tuple *tuple, *victim;
336 tuple = card->tuples;
347 int sdio_read_func_cis(struct sdio_func *func)
351 ret = sdio_read_cis(func->card, func);
356 * Since we've linked to tuples in the card structure,
357 * we must make sure we have a reference to it.
359 get_device(&func->card->dev);
362 * Vendor/device id is optional for function CIS, so
363 * copy it from the card structure as needed.
365 if (func->vendor == 0) {
366 func->vendor = func->card->cis.vendor;
367 func->device = func->card->cis.device;
373 void sdio_free_func_cis(struct sdio_func *func)
375 struct sdio_func_tuple *tuple, *victim;
377 tuple = func->tuples;
379 while (tuple && tuple != func->card->tuples) {
388 * We have now removed the link to the tuples in the
389 * card structure, so remove the reference.
391 put_device(&func->card->dev);