core-device.c 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317
  1. /*
  2. * Device probing and sysfs code.
  3. *
  4. * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
  5. *
  6. * This program is free software; you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation; either version 2 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with this program; if not, write to the Free Software Foundation,
  18. * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19. */
  20. #include <linux/bug.h>
  21. #include <linux/ctype.h>
  22. #include <linux/delay.h>
  23. #include <linux/device.h>
  24. #include <linux/errno.h>
  25. #include <linux/firewire.h>
  26. #include <linux/firewire-constants.h>
  27. #include <linux/idr.h>
  28. #include <linux/jiffies.h>
  29. #include <linux/kobject.h>
  30. #include <linux/list.h>
  31. #include <linux/mod_devicetable.h>
  32. #include <linux/module.h>
  33. #include <linux/mutex.h>
  34. #include <linux/random.h>
  35. #include <linux/rwsem.h>
  36. #include <linux/slab.h>
  37. #include <linux/spinlock.h>
  38. #include <linux/string.h>
  39. #include <linux/workqueue.h>
  40. #include <linux/atomic.h>
  41. #include <asm/byteorder.h>
  42. #include "core.h"
  43. void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p)
  44. {
  45. ci->p = p + 1;
  46. ci->end = ci->p + (p[0] >> 16);
  47. }
  48. EXPORT_SYMBOL(fw_csr_iterator_init);
  49. int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value)
  50. {
  51. *key = *ci->p >> 24;
  52. *value = *ci->p & 0xffffff;
  53. return ci->p++ < ci->end;
  54. }
  55. EXPORT_SYMBOL(fw_csr_iterator_next);
  56. static const u32 *search_leaf(const u32 *directory, int search_key)
  57. {
  58. struct fw_csr_iterator ci;
  59. int last_key = 0, key, value;
  60. fw_csr_iterator_init(&ci, directory);
  61. while (fw_csr_iterator_next(&ci, &key, &value)) {
  62. if (last_key == search_key &&
  63. key == (CSR_DESCRIPTOR | CSR_LEAF))
  64. return ci.p - 1 + value;
  65. last_key = key;
  66. }
  67. return NULL;
  68. }
  69. static int textual_leaf_to_string(const u32 *block, char *buf, size_t size)
  70. {
  71. unsigned int quadlets, i;
  72. char c;
  73. if (!size || !buf)
  74. return -EINVAL;
  75. quadlets = min(block[0] >> 16, 256U);
  76. if (quadlets < 2)
  77. return -ENODATA;
  78. if (block[1] != 0 || block[2] != 0)
  79. /* unknown language/character set */
  80. return -ENODATA;
  81. block += 3;
  82. quadlets -= 2;
  83. for (i = 0; i < quadlets * 4 && i < size - 1; i++) {
  84. c = block[i / 4] >> (24 - 8 * (i % 4));
  85. if (c == '\0')
  86. break;
  87. buf[i] = c;
  88. }
  89. buf[i] = '\0';
  90. return i;
  91. }
  92. /**
  93. * fw_csr_string() - reads a string from the configuration ROM
  94. * @directory: e.g. root directory or unit directory
  95. * @key: the key of the preceding directory entry
  96. * @buf: where to put the string
  97. * @size: size of @buf, in bytes
  98. *
  99. * The string is taken from a minimal ASCII text descriptor leaf after
  100. * the immediate entry with @key. The string is zero-terminated.
  101. * Returns strlen(buf) or a negative error code.
  102. */
  103. int fw_csr_string(const u32 *directory, int key, char *buf, size_t size)
  104. {
  105. const u32 *leaf = search_leaf(directory, key);
  106. if (!leaf)
  107. return -ENOENT;
  108. return textual_leaf_to_string(leaf, buf, size);
  109. }
  110. EXPORT_SYMBOL(fw_csr_string);
  111. static void get_ids(const u32 *directory, int *id)
  112. {
  113. struct fw_csr_iterator ci;
  114. int key, value;
  115. fw_csr_iterator_init(&ci, directory);
  116. while (fw_csr_iterator_next(&ci, &key, &value)) {
  117. switch (key) {
  118. case CSR_VENDOR: id[0] = value; break;
  119. case CSR_MODEL: id[1] = value; break;
  120. case CSR_SPECIFIER_ID: id[2] = value; break;
  121. case CSR_VERSION: id[3] = value; break;
  122. }
  123. }
  124. }
  125. static void get_modalias_ids(struct fw_unit *unit, int *id)
  126. {
  127. get_ids(&fw_parent_device(unit)->config_rom[5], id);
  128. get_ids(unit->directory, id);
  129. }
  130. static bool match_ids(const struct ieee1394_device_id *id_table, int *id)
  131. {
  132. int match = 0;
  133. if (id[0] == id_table->vendor_id)
  134. match |= IEEE1394_MATCH_VENDOR_ID;
  135. if (id[1] == id_table->model_id)
  136. match |= IEEE1394_MATCH_MODEL_ID;
  137. if (id[2] == id_table->specifier_id)
  138. match |= IEEE1394_MATCH_SPECIFIER_ID;
  139. if (id[3] == id_table->version)
  140. match |= IEEE1394_MATCH_VERSION;
  141. return (match & id_table->match_flags) == id_table->match_flags;
  142. }
  143. static const struct ieee1394_device_id *unit_match(struct device *dev,
  144. struct device_driver *drv)
  145. {
  146. const struct ieee1394_device_id *id_table =
  147. container_of(drv, struct fw_driver, driver)->id_table;
  148. int id[] = {0, 0, 0, 0};
  149. get_modalias_ids(fw_unit(dev), id);
  150. for (; id_table->match_flags != 0; id_table++)
  151. if (match_ids(id_table, id))
  152. return id_table;
  153. return NULL;
  154. }
  155. static bool is_fw_unit(struct device *dev);
  156. static int fw_unit_match(struct device *dev, struct device_driver *drv)
  157. {
  158. /* We only allow binding to fw_units. */
  159. return is_fw_unit(dev) && unit_match(dev, drv) != NULL;
  160. }
  161. static int fw_unit_probe(struct device *dev)
  162. {
  163. struct fw_driver *driver =
  164. container_of(dev->driver, struct fw_driver, driver);
  165. return driver->probe(fw_unit(dev), unit_match(dev, dev->driver));
  166. }
  167. static int fw_unit_remove(struct device *dev)
  168. {
  169. struct fw_driver *driver =
  170. container_of(dev->driver, struct fw_driver, driver);
  171. return driver->remove(fw_unit(dev)), 0;
  172. }
  173. static int get_modalias(struct fw_unit *unit, char *buffer, size_t buffer_size)
  174. {
  175. int id[] = {0, 0, 0, 0};
  176. get_modalias_ids(unit, id);
  177. return snprintf(buffer, buffer_size,
  178. "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
  179. id[0], id[1], id[2], id[3]);
  180. }
  181. static int fw_unit_uevent(struct device *dev, struct kobj_uevent_env *env)
  182. {
  183. struct fw_unit *unit = fw_unit(dev);
  184. char modalias[64];
  185. get_modalias(unit, modalias, sizeof(modalias));
  186. if (add_uevent_var(env, "MODALIAS=%s", modalias))
  187. return -ENOMEM;
  188. return 0;
  189. }
  190. struct bus_type fw_bus_type = {
  191. .name = "firewire",
  192. .match = fw_unit_match,
  193. .probe = fw_unit_probe,
  194. .remove = fw_unit_remove,
  195. };
  196. EXPORT_SYMBOL(fw_bus_type);
  197. int fw_device_enable_phys_dma(struct fw_device *device)
  198. {
  199. int generation = device->generation;
  200. /* device->node_id, accessed below, must not be older than generation */
  201. smp_rmb();
  202. return device->card->driver->enable_phys_dma(device->card,
  203. device->node_id,
  204. generation);
  205. }
  206. EXPORT_SYMBOL(fw_device_enable_phys_dma);
  207. struct config_rom_attribute {
  208. struct device_attribute attr;
  209. u32 key;
  210. };
  211. static ssize_t show_immediate(struct device *dev,
  212. struct device_attribute *dattr, char *buf)
  213. {
  214. struct config_rom_attribute *attr =
  215. container_of(dattr, struct config_rom_attribute, attr);
  216. struct fw_csr_iterator ci;
  217. const u32 *dir;
  218. int key, value, ret = -ENOENT;
  219. down_read(&fw_device_rwsem);
  220. if (is_fw_unit(dev))
  221. dir = fw_unit(dev)->directory;
  222. else
  223. dir = fw_device(dev)->config_rom + 5;
  224. fw_csr_iterator_init(&ci, dir);
  225. while (fw_csr_iterator_next(&ci, &key, &value))
  226. if (attr->key == key) {
  227. ret = snprintf(buf, buf ? PAGE_SIZE : 0,
  228. "0x%06x\n", value);
  229. break;
  230. }
  231. up_read(&fw_device_rwsem);
  232. return ret;
  233. }
  234. #define IMMEDIATE_ATTR(name, key) \
  235. { __ATTR(name, S_IRUGO, show_immediate, NULL), key }
  236. static ssize_t show_text_leaf(struct device *dev,
  237. struct device_attribute *dattr, char *buf)
  238. {
  239. struct config_rom_attribute *attr =
  240. container_of(dattr, struct config_rom_attribute, attr);
  241. const u32 *dir;
  242. size_t bufsize;
  243. char dummy_buf[2];
  244. int ret;
  245. down_read(&fw_device_rwsem);
  246. if (is_fw_unit(dev))
  247. dir = fw_unit(dev)->directory;
  248. else
  249. dir = fw_device(dev)->config_rom + 5;
  250. if (buf) {
  251. bufsize = PAGE_SIZE - 1;
  252. } else {
  253. buf = dummy_buf;
  254. bufsize = 1;
  255. }
  256. ret = fw_csr_string(dir, attr->key, buf, bufsize);
  257. if (ret >= 0) {
  258. /* Strip trailing whitespace and add newline. */
  259. while (ret > 0 && isspace(buf[ret - 1]))
  260. ret--;
  261. strcpy(buf + ret, "\n");
  262. ret++;
  263. }
  264. up_read(&fw_device_rwsem);
  265. return ret;
  266. }
  267. #define TEXT_LEAF_ATTR(name, key) \
  268. { __ATTR(name, S_IRUGO, show_text_leaf, NULL), key }
  269. static struct config_rom_attribute config_rom_attributes[] = {
  270. IMMEDIATE_ATTR(vendor, CSR_VENDOR),
  271. IMMEDIATE_ATTR(hardware_version, CSR_HARDWARE_VERSION),
  272. IMMEDIATE_ATTR(specifier_id, CSR_SPECIFIER_ID),
  273. IMMEDIATE_ATTR(version, CSR_VERSION),
  274. IMMEDIATE_ATTR(model, CSR_MODEL),
  275. TEXT_LEAF_ATTR(vendor_name, CSR_VENDOR),
  276. TEXT_LEAF_ATTR(model_name, CSR_MODEL),
  277. TEXT_LEAF_ATTR(hardware_version_name, CSR_HARDWARE_VERSION),
  278. };
  279. static void init_fw_attribute_group(struct device *dev,
  280. struct device_attribute *attrs,
  281. struct fw_attribute_group *group)
  282. {
  283. struct device_attribute *attr;
  284. int i, j;
  285. for (j = 0; attrs[j].attr.name != NULL; j++)
  286. group->attrs[j] = &attrs[j].attr;
  287. for (i = 0; i < ARRAY_SIZE(config_rom_attributes); i++) {
  288. attr = &config_rom_attributes[i].attr;
  289. if (attr->show(dev, attr, NULL) < 0)
  290. continue;
  291. group->attrs[j++] = &attr->attr;
  292. }
  293. group->attrs[j] = NULL;
  294. group->groups[0] = &group->group;
  295. group->groups[1] = NULL;
  296. group->group.attrs = group->attrs;
  297. dev->groups = (const struct attribute_group **) group->groups;
  298. }
  299. static ssize_t modalias_show(struct device *dev,
  300. struct device_attribute *attr, char *buf)
  301. {
  302. struct fw_unit *unit = fw_unit(dev);
  303. int length;
  304. length = get_modalias(unit, buf, PAGE_SIZE);
  305. strcpy(buf + length, "\n");
  306. return length + 1;
  307. }
  308. static ssize_t rom_index_show(struct device *dev,
  309. struct device_attribute *attr, char *buf)
  310. {
  311. struct fw_device *device = fw_device(dev->parent);
  312. struct fw_unit *unit = fw_unit(dev);
  313. return snprintf(buf, PAGE_SIZE, "%d\n",
  314. (int)(unit->directory - device->config_rom));
  315. }
  316. static struct device_attribute fw_unit_attributes[] = {
  317. __ATTR_RO(modalias),
  318. __ATTR_RO(rom_index),
  319. __ATTR_NULL,
  320. };
  321. static ssize_t config_rom_show(struct device *dev,
  322. struct device_attribute *attr, char *buf)
  323. {
  324. struct fw_device *device = fw_device(dev);
  325. size_t length;
  326. down_read(&fw_device_rwsem);
  327. length = device->config_rom_length * 4;
  328. memcpy(buf, device->config_rom, length);
  329. up_read(&fw_device_rwsem);
  330. return length;
  331. }
  332. static ssize_t guid_show(struct device *dev,
  333. struct device_attribute *attr, char *buf)
  334. {
  335. struct fw_device *device = fw_device(dev);
  336. int ret;
  337. down_read(&fw_device_rwsem);
  338. ret = snprintf(buf, PAGE_SIZE, "0x%08x%08x\n",
  339. device->config_rom[3], device->config_rom[4]);
  340. up_read(&fw_device_rwsem);
  341. return ret;
  342. }
  343. static ssize_t is_local_show(struct device *dev,
  344. struct device_attribute *attr, char *buf)
  345. {
  346. struct fw_device *device = fw_device(dev);
  347. return sprintf(buf, "%u\n", device->is_local);
  348. }
  349. static int units_sprintf(char *buf, const u32 *directory)
  350. {
  351. struct fw_csr_iterator ci;
  352. int key, value;
  353. int specifier_id = 0;
  354. int version = 0;
  355. fw_csr_iterator_init(&ci, directory);
  356. while (fw_csr_iterator_next(&ci, &key, &value)) {
  357. switch (key) {
  358. case CSR_SPECIFIER_ID:
  359. specifier_id = value;
  360. break;
  361. case CSR_VERSION:
  362. version = value;
  363. break;
  364. }
  365. }
  366. return sprintf(buf, "0x%06x:0x%06x ", specifier_id, version);
  367. }
  368. static ssize_t units_show(struct device *dev,
  369. struct device_attribute *attr, char *buf)
  370. {
  371. struct fw_device *device = fw_device(dev);
  372. struct fw_csr_iterator ci;
  373. int key, value, i = 0;
  374. down_read(&fw_device_rwsem);
  375. fw_csr_iterator_init(&ci, &device->config_rom[5]);
  376. while (fw_csr_iterator_next(&ci, &key, &value)) {
  377. if (key != (CSR_UNIT | CSR_DIRECTORY))
  378. continue;
  379. i += units_sprintf(&buf[i], ci.p + value - 1);
  380. if (i >= PAGE_SIZE - (8 + 1 + 8 + 1))
  381. break;
  382. }
  383. up_read(&fw_device_rwsem);
  384. if (i)
  385. buf[i - 1] = '\n';
  386. return i;
  387. }
  388. static struct device_attribute fw_device_attributes[] = {
  389. __ATTR_RO(config_rom),
  390. __ATTR_RO(guid),
  391. __ATTR_RO(is_local),
  392. __ATTR_RO(units),
  393. __ATTR_NULL,
  394. };
  395. static int read_rom(struct fw_device *device,
  396. int generation, int index, u32 *data)
  397. {
  398. u64 offset = (CSR_REGISTER_BASE | CSR_CONFIG_ROM) + index * 4;
  399. int i, rcode;
  400. /* device->node_id, accessed below, must not be older than generation */
  401. smp_rmb();
  402. for (i = 10; i < 100; i += 10) {
  403. rcode = fw_run_transaction(device->card,
  404. TCODE_READ_QUADLET_REQUEST, device->node_id,
  405. generation, device->max_speed, offset, data, 4);
  406. if (rcode != RCODE_BUSY)
  407. break;
  408. msleep(i);
  409. }
  410. be32_to_cpus(data);
  411. return rcode;
  412. }
  413. #define MAX_CONFIG_ROM_SIZE 256
  414. /*
  415. * Read the bus info block, perform a speed probe, and read all of the rest of
  416. * the config ROM. We do all this with a cached bus generation. If the bus
  417. * generation changes under us, read_config_rom will fail and get retried.
  418. * It's better to start all over in this case because the node from which we
  419. * are reading the ROM may have changed the ROM during the reset.
  420. * Returns either a result code or a negative error code.
  421. */
  422. static int read_config_rom(struct fw_device *device, int generation)
  423. {
  424. struct fw_card *card = device->card;
  425. const u32 *old_rom, *new_rom;
  426. u32 *rom, *stack;
  427. u32 sp, key;
  428. int i, end, length, ret;
  429. rom = kmalloc(sizeof(*rom) * MAX_CONFIG_ROM_SIZE +
  430. sizeof(*stack) * MAX_CONFIG_ROM_SIZE, GFP_KERNEL);
  431. if (rom == NULL)
  432. return -ENOMEM;
  433. stack = &rom[MAX_CONFIG_ROM_SIZE];
  434. memset(rom, 0, sizeof(*rom) * MAX_CONFIG_ROM_SIZE);
  435. device->max_speed = SCODE_100;
  436. /* First read the bus info block. */
  437. for (i = 0; i < 5; i++) {
  438. ret = read_rom(device, generation, i, &rom[i]);
  439. if (ret != RCODE_COMPLETE)
  440. goto out;
  441. /*
  442. * As per IEEE1212 7.2, during initialization, devices can
  443. * reply with a 0 for the first quadlet of the config
  444. * rom to indicate that they are booting (for example,
  445. * if the firmware is on the disk of a external
  446. * harddisk). In that case we just fail, and the
  447. * retry mechanism will try again later.
  448. */
  449. if (i == 0 && rom[i] == 0) {
  450. ret = RCODE_BUSY;
  451. goto out;
  452. }
  453. }
  454. device->max_speed = device->node->max_speed;
  455. /*
  456. * Determine the speed of
  457. * - devices with link speed less than PHY speed,
  458. * - devices with 1394b PHY (unless only connected to 1394a PHYs),
  459. * - all devices if there are 1394b repeaters.
  460. * Note, we cannot use the bus info block's link_spd as starting point
  461. * because some buggy firmwares set it lower than necessary and because
  462. * 1394-1995 nodes do not have the field.
  463. */
  464. if ((rom[2] & 0x7) < device->max_speed ||
  465. device->max_speed == SCODE_BETA ||
  466. card->beta_repeaters_present) {
  467. u32 dummy;
  468. /* for S1600 and S3200 */
  469. if (device->max_speed == SCODE_BETA)
  470. device->max_speed = card->link_speed;
  471. while (device->max_speed > SCODE_100) {
  472. if (read_rom(device, generation, 0, &dummy) ==
  473. RCODE_COMPLETE)
  474. break;
  475. device->max_speed--;
  476. }
  477. }
  478. /*
  479. * Now parse the config rom. The config rom is a recursive
  480. * directory structure so we parse it using a stack of
  481. * references to the blocks that make up the structure. We
  482. * push a reference to the root directory on the stack to
  483. * start things off.
  484. */
  485. length = i;
  486. sp = 0;
  487. stack[sp++] = 0xc0000005;
  488. while (sp > 0) {
  489. /*
  490. * Pop the next block reference of the stack. The
  491. * lower 24 bits is the offset into the config rom,
  492. * the upper 8 bits are the type of the reference the
  493. * block.
  494. */
  495. key = stack[--sp];
  496. i = key & 0xffffff;
  497. if (WARN_ON(i >= MAX_CONFIG_ROM_SIZE)) {
  498. ret = -ENXIO;
  499. goto out;
  500. }
  501. /* Read header quadlet for the block to get the length. */
  502. ret = read_rom(device, generation, i, &rom[i]);
  503. if (ret != RCODE_COMPLETE)
  504. goto out;
  505. end = i + (rom[i] >> 16) + 1;
  506. if (end > MAX_CONFIG_ROM_SIZE) {
  507. /*
  508. * This block extends outside the config ROM which is
  509. * a firmware bug. Ignore this whole block, i.e.
  510. * simply set a fake block length of 0.
  511. */
  512. fw_err(card, "skipped invalid ROM block %x at %llx\n",
  513. rom[i],
  514. i * 4 | CSR_REGISTER_BASE | CSR_CONFIG_ROM);
  515. rom[i] = 0;
  516. end = i;
  517. }
  518. i++;
  519. /*
  520. * Now read in the block. If this is a directory
  521. * block, check the entries as we read them to see if
  522. * it references another block, and push it in that case.
  523. */
  524. for (; i < end; i++) {
  525. ret = read_rom(device, generation, i, &rom[i]);
  526. if (ret != RCODE_COMPLETE)
  527. goto out;
  528. if ((key >> 30) != 3 || (rom[i] >> 30) < 2)
  529. continue;
  530. /*
  531. * Offset points outside the ROM. May be a firmware
  532. * bug or an Extended ROM entry (IEEE 1212-2001 clause
  533. * 7.7.18). Simply overwrite this pointer here by a
  534. * fake immediate entry so that later iterators over
  535. * the ROM don't have to check offsets all the time.
  536. */
  537. if (i + (rom[i] & 0xffffff) >= MAX_CONFIG_ROM_SIZE) {
  538. fw_err(card,
  539. "skipped unsupported ROM entry %x at %llx\n",
  540. rom[i],
  541. i * 4 | CSR_REGISTER_BASE | CSR_CONFIG_ROM);
  542. rom[i] = 0;
  543. continue;
  544. }
  545. stack[sp++] = i + rom[i];
  546. }
  547. if (length < i)
  548. length = i;
  549. }
  550. old_rom = device->config_rom;
  551. new_rom = kmemdup(rom, length * 4, GFP_KERNEL);
  552. if (new_rom == NULL) {
  553. ret = -ENOMEM;
  554. goto out;
  555. }
  556. down_write(&fw_device_rwsem);
  557. device->config_rom = new_rom;
  558. device->config_rom_length = length;
  559. up_write(&fw_device_rwsem);
  560. kfree(old_rom);
  561. ret = RCODE_COMPLETE;
  562. device->max_rec = rom[2] >> 12 & 0xf;
  563. device->cmc = rom[2] >> 30 & 1;
  564. device->irmc = rom[2] >> 31 & 1;
  565. out:
  566. kfree(rom);
  567. return ret;
  568. }
  569. static void fw_unit_release(struct device *dev)
  570. {
  571. struct fw_unit *unit = fw_unit(dev);
  572. fw_device_put(fw_parent_device(unit));
  573. kfree(unit);
  574. }
  575. static struct device_type fw_unit_type = {
  576. .uevent = fw_unit_uevent,
  577. .release = fw_unit_release,
  578. };
  579. static bool is_fw_unit(struct device *dev)
  580. {
  581. return dev->type == &fw_unit_type;
  582. }
  583. static void create_units(struct fw_device *device)
  584. {
  585. struct fw_csr_iterator ci;
  586. struct fw_unit *unit;
  587. int key, value, i;
  588. i = 0;
  589. fw_csr_iterator_init(&ci, &device->config_rom[5]);
  590. while (fw_csr_iterator_next(&ci, &key, &value)) {
  591. if (key != (CSR_UNIT | CSR_DIRECTORY))
  592. continue;
  593. /*
  594. * Get the address of the unit directory and try to
  595. * match the drivers id_tables against it.
  596. */
  597. unit = kzalloc(sizeof(*unit), GFP_KERNEL);
  598. if (unit == NULL)
  599. continue;
  600. unit->directory = ci.p + value - 1;
  601. unit->device.bus = &fw_bus_type;
  602. unit->device.type = &fw_unit_type;
  603. unit->device.parent = &device->device;
  604. dev_set_name(&unit->device, "%s.%d", dev_name(&device->device), i++);
  605. BUILD_BUG_ON(ARRAY_SIZE(unit->attribute_group.attrs) <
  606. ARRAY_SIZE(fw_unit_attributes) +
  607. ARRAY_SIZE(config_rom_attributes));
  608. init_fw_attribute_group(&unit->device,
  609. fw_unit_attributes,
  610. &unit->attribute_group);
  611. if (device_register(&unit->device) < 0)
  612. goto skip_unit;
  613. fw_device_get(device);
  614. continue;
  615. skip_unit:
  616. kfree(unit);
  617. }
  618. }
  619. static int shutdown_unit(struct device *device, void *data)
  620. {
  621. device_unregister(device);
  622. return 0;
  623. }
  624. /*
  625. * fw_device_rwsem acts as dual purpose mutex:
  626. * - serializes accesses to fw_device_idr,
  627. * - serializes accesses to fw_device.config_rom/.config_rom_length and
  628. * fw_unit.directory, unless those accesses happen at safe occasions
  629. */
  630. DECLARE_RWSEM(fw_device_rwsem);
  631. DEFINE_IDR(fw_device_idr);
  632. int fw_cdev_major;
  633. struct fw_device *fw_device_get_by_devt(dev_t devt)
  634. {
  635. struct fw_device *device;
  636. down_read(&fw_device_rwsem);
  637. device = idr_find(&fw_device_idr, MINOR(devt));
  638. if (device)
  639. fw_device_get(device);
  640. up_read(&fw_device_rwsem);
  641. return device;
  642. }
  643. struct workqueue_struct *fw_workqueue;
  644. EXPORT_SYMBOL(fw_workqueue);
  645. static void fw_schedule_device_work(struct fw_device *device,
  646. unsigned long delay)
  647. {
  648. queue_delayed_work(fw_workqueue, &device->work, delay);
  649. }
  650. /*
  651. * These defines control the retry behavior for reading the config
  652. * rom. It shouldn't be necessary to tweak these; if the device
  653. * doesn't respond to a config rom read within 10 seconds, it's not
  654. * going to respond at all. As for the initial delay, a lot of
  655. * devices will be able to respond within half a second after bus
  656. * reset. On the other hand, it's not really worth being more
  657. * aggressive than that, since it scales pretty well; if 10 devices
  658. * are plugged in, they're all getting read within one second.
  659. */
  660. #define MAX_RETRIES 10
  661. #define RETRY_DELAY (3 * HZ)
  662. #define INITIAL_DELAY (HZ / 2)
  663. #define SHUTDOWN_DELAY (2 * HZ)
  664. static void fw_device_shutdown(struct work_struct *work)
  665. {
  666. struct fw_device *device =
  667. container_of(work, struct fw_device, work.work);
  668. int minor = MINOR(device->device.devt);
  669. if (time_before64(get_jiffies_64(),
  670. device->card->reset_jiffies + SHUTDOWN_DELAY)
  671. && !list_empty(&device->card->link)) {
  672. fw_schedule_device_work(device, SHUTDOWN_DELAY);
  673. return;
  674. }
  675. if (atomic_cmpxchg(&device->state,
  676. FW_DEVICE_GONE,
  677. FW_DEVICE_SHUTDOWN) != FW_DEVICE_GONE)
  678. return;
  679. fw_device_cdev_remove(device);
  680. device_for_each_child(&device->device, NULL, shutdown_unit);
  681. device_unregister(&device->device);
  682. down_write(&fw_device_rwsem);
  683. idr_remove(&fw_device_idr, minor);
  684. up_write(&fw_device_rwsem);
  685. fw_device_put(device);
  686. }
  687. static void fw_device_release(struct device *dev)
  688. {
  689. struct fw_device *device = fw_device(dev);
  690. struct fw_card *card = device->card;
  691. unsigned long flags;
  692. /*
  693. * Take the card lock so we don't set this to NULL while a
  694. * FW_NODE_UPDATED callback is being handled or while the
  695. * bus manager work looks at this node.
  696. */
  697. spin_lock_irqsave(&card->lock, flags);
  698. device->node->data = NULL;
  699. spin_unlock_irqrestore(&card->lock, flags);
  700. fw_node_put(device->node);
  701. kfree(device->config_rom);
  702. kfree(device);
  703. fw_card_put(card);
  704. }
  705. static struct device_type fw_device_type = {
  706. .release = fw_device_release,
  707. };
  708. static bool is_fw_device(struct device *dev)
  709. {
  710. return dev->type == &fw_device_type;
  711. }
  712. static int update_unit(struct device *dev, void *data)
  713. {
  714. struct fw_unit *unit = fw_unit(dev);
  715. struct fw_driver *driver = (struct fw_driver *)dev->driver;
  716. if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
  717. device_lock(dev);
  718. driver->update(unit);
  719. device_unlock(dev);
  720. }
  721. return 0;
  722. }
  723. static void fw_device_update(struct work_struct *work)
  724. {
  725. struct fw_device *device =
  726. container_of(work, struct fw_device, work.work);
  727. fw_device_cdev_update(device);
  728. device_for_each_child(&device->device, NULL, update_unit);
  729. }
  730. /*
  731. * If a device was pending for deletion because its node went away but its
  732. * bus info block and root directory header matches that of a newly discovered
  733. * device, revive the existing fw_device.
  734. * The newly allocated fw_device becomes obsolete instead.
  735. */
  736. static int lookup_existing_device(struct device *dev, void *data)
  737. {
  738. struct fw_device *old = fw_device(dev);
  739. struct fw_device *new = data;
  740. struct fw_card *card = new->card;
  741. int match = 0;
  742. if (!is_fw_device(dev))
  743. return 0;
  744. down_read(&fw_device_rwsem); /* serialize config_rom access */
  745. spin_lock_irq(&card->lock); /* serialize node access */
  746. if (memcmp(old->config_rom, new->config_rom, 6 * 4) == 0 &&
  747. atomic_cmpxchg(&old->state,
  748. FW_DEVICE_GONE,
  749. FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
  750. struct fw_node *current_node = new->node;
  751. struct fw_node *obsolete_node = old->node;
  752. new->node = obsolete_node;
  753. new->node->data = new;
  754. old->node = current_node;
  755. old->node->data = old;
  756. old->max_speed = new->max_speed;
  757. old->node_id = current_node->node_id;
  758. smp_wmb(); /* update node_id before generation */
  759. old->generation = card->generation;
  760. old->config_rom_retries = 0;
  761. fw_notice(card, "rediscovered device %s\n", dev_name(dev));
  762. PREPARE_DELAYED_WORK(&old->work, fw_device_update);
  763. fw_schedule_device_work(old, 0);
  764. if (current_node == card->root_node)
  765. fw_schedule_bm_work(card, 0);
  766. match = 1;
  767. }
  768. spin_unlock_irq(&card->lock);
  769. up_read(&fw_device_rwsem);
  770. return match;
  771. }
  772. enum { BC_UNKNOWN = 0, BC_UNIMPLEMENTED, BC_IMPLEMENTED, };
  773. static void set_broadcast_channel(struct fw_device *device, int generation)
  774. {
  775. struct fw_card *card = device->card;
  776. __be32 data;
  777. int rcode;
  778. if (!card->broadcast_channel_allocated)
  779. return;
  780. /*
  781. * The Broadcast_Channel Valid bit is required by nodes which want to
  782. * transmit on this channel. Such transmissions are practically
  783. * exclusive to IP over 1394 (RFC 2734). IP capable nodes are required
  784. * to be IRM capable and have a max_rec of 8 or more. We use this fact
  785. * to narrow down to which nodes we send Broadcast_Channel updates.
  786. */
  787. if (!device->irmc || device->max_rec < 8)
  788. return;
  789. /*
  790. * Some 1394-1995 nodes crash if this 1394a-2000 register is written.
  791. * Perform a read test first.
  792. */
  793. if (device->bc_implemented == BC_UNKNOWN) {
  794. rcode = fw_run_transaction(card, TCODE_READ_QUADLET_REQUEST,
  795. device->node_id, generation, device->max_speed,
  796. CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
  797. &data, 4);
  798. switch (rcode) {
  799. case RCODE_COMPLETE:
  800. if (data & cpu_to_be32(1 << 31)) {
  801. device->bc_implemented = BC_IMPLEMENTED;
  802. break;
  803. }
  804. /* else fall through to case address error */
  805. case RCODE_ADDRESS_ERROR:
  806. device->bc_implemented = BC_UNIMPLEMENTED;
  807. }
  808. }
  809. if (device->bc_implemented == BC_IMPLEMENTED) {
  810. data = cpu_to_be32(BROADCAST_CHANNEL_INITIAL |
  811. BROADCAST_CHANNEL_VALID);
  812. fw_run_transaction(card, TCODE_WRITE_QUADLET_REQUEST,
  813. device->node_id, generation, device->max_speed,
  814. CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
  815. &data, 4);
  816. }
  817. }
  818. int fw_device_set_broadcast_channel(struct device *dev, void *gen)
  819. {
  820. if (is_fw_device(dev))
  821. set_broadcast_channel(fw_device(dev), (long)gen);
  822. return 0;
  823. }
  824. static void fw_device_init(struct work_struct *work)
  825. {
  826. struct fw_device *device =
  827. container_of(work, struct fw_device, work.work);
  828. struct fw_card *card = device->card;
  829. struct device *revived_dev;
  830. int minor, ret;
  831. /*
  832. * All failure paths here set node->data to NULL, so that we
  833. * don't try to do device_for_each_child() on a kfree()'d
  834. * device.
  835. */
  836. ret = read_config_rom(device, device->generation);
  837. if (ret != RCODE_COMPLETE) {
  838. if (device->config_rom_retries < MAX_RETRIES &&
  839. atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
  840. device->config_rom_retries++;
  841. fw_schedule_device_work(device, RETRY_DELAY);
  842. } else {
  843. if (device->node->link_on)
  844. fw_notice(card, "giving up on node %x: reading config rom failed: %s\n",
  845. device->node_id,
  846. fw_rcode_string(ret));
  847. if (device->node == card->root_node)
  848. fw_schedule_bm_work(card, 0);
  849. fw_device_release(&device->device);
  850. }
  851. return;
  852. }
  853. revived_dev = device_find_child(card->device,
  854. device, lookup_existing_device);
  855. if (revived_dev) {
  856. put_device(revived_dev);
  857. fw_device_release(&device->device);
  858. return;
  859. }
  860. device_initialize(&device->device);
  861. fw_device_get(device);
  862. down_write(&fw_device_rwsem);
  863. minor = idr_alloc(&fw_device_idr, device, 0, 1 << MINORBITS,
  864. GFP_KERNEL);
  865. up_write(&fw_device_rwsem);
  866. if (minor < 0)
  867. goto error;
  868. device->device.bus = &fw_bus_type;
  869. device->device.type = &fw_device_type;
  870. device->device.parent = card->device;
  871. device->device.devt = MKDEV(fw_cdev_major, minor);
  872. dev_set_name(&device->device, "fw%d", minor);
  873. BUILD_BUG_ON(ARRAY_SIZE(device->attribute_group.attrs) <
  874. ARRAY_SIZE(fw_device_attributes) +
  875. ARRAY_SIZE(config_rom_attributes));
  876. init_fw_attribute_group(&device->device,
  877. fw_device_attributes,
  878. &device->attribute_group);
  879. if (device_add(&device->device)) {
  880. fw_err(card, "failed to add device\n");
  881. goto error_with_cdev;
  882. }
  883. create_units(device);
  884. /*
  885. * Transition the device to running state. If it got pulled
  886. * out from under us while we did the intialization work, we
  887. * have to shut down the device again here. Normally, though,
  888. * fw_node_event will be responsible for shutting it down when
  889. * necessary. We have to use the atomic cmpxchg here to avoid
  890. * racing with the FW_NODE_DESTROYED case in
  891. * fw_node_event().
  892. */
  893. if (atomic_cmpxchg(&device->state,
  894. FW_DEVICE_INITIALIZING,
  895. FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
  896. PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
  897. fw_schedule_device_work(device, SHUTDOWN_DELAY);
  898. } else {
  899. fw_notice(card, "created device %s: GUID %08x%08x, S%d00\n",
  900. dev_name(&device->device),
  901. device->config_rom[3], device->config_rom[4],
  902. 1 << device->max_speed);
  903. device->config_rom_retries = 0;
  904. set_broadcast_channel(device, device->generation);
  905. add_device_randomness(&device->config_rom[3], 8);
  906. }
  907. /*
  908. * Reschedule the IRM work if we just finished reading the
  909. * root node config rom. If this races with a bus reset we
  910. * just end up running the IRM work a couple of extra times -
  911. * pretty harmless.
  912. */
  913. if (device->node == card->root_node)
  914. fw_schedule_bm_work(card, 0);
  915. return;
  916. error_with_cdev:
  917. down_write(&fw_device_rwsem);
  918. idr_remove(&fw_device_idr, minor);
  919. up_write(&fw_device_rwsem);
  920. error:
  921. fw_device_put(device); /* fw_device_idr's reference */
  922. put_device(&device->device); /* our reference */
  923. }
  924. /* Reread and compare bus info block and header of root directory */
  925. static int reread_config_rom(struct fw_device *device, int generation,
  926. bool *changed)
  927. {
  928. u32 q;
  929. int i, rcode;
  930. for (i = 0; i < 6; i++) {
  931. rcode = read_rom(device, generation, i, &q);
  932. if (rcode != RCODE_COMPLETE)
  933. return rcode;
  934. if (i == 0 && q == 0)
  935. /* inaccessible (see read_config_rom); retry later */
  936. return RCODE_BUSY;
  937. if (q != device->config_rom[i]) {
  938. *changed = true;
  939. return RCODE_COMPLETE;
  940. }
  941. }
  942. *changed = false;
  943. return RCODE_COMPLETE;
  944. }
  945. static void fw_device_refresh(struct work_struct *work)
  946. {
  947. struct fw_device *device =
  948. container_of(work, struct fw_device, work.work);
  949. struct fw_card *card = device->card;
  950. int ret, node_id = device->node_id;
  951. bool changed;
  952. ret = reread_config_rom(device, device->generation, &changed);
  953. if (ret != RCODE_COMPLETE)
  954. goto failed_config_rom;
  955. if (!changed) {
  956. if (atomic_cmpxchg(&device->state,
  957. FW_DEVICE_INITIALIZING,
  958. FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
  959. goto gone;
  960. fw_device_update(work);
  961. device->config_rom_retries = 0;
  962. goto out;
  963. }
  964. /*
  965. * Something changed. We keep things simple and don't investigate
  966. * further. We just destroy all previous units and create new ones.
  967. */
  968. device_for_each_child(&device->device, NULL, shutdown_unit);
  969. ret = read_config_rom(device, device->generation);
  970. if (ret != RCODE_COMPLETE)
  971. goto failed_config_rom;
  972. fw_device_cdev_update(device);
  973. create_units(device);
  974. /* Userspace may want to re-read attributes. */
  975. kobject_uevent(&device->device.kobj, KOBJ_CHANGE);
  976. if (atomic_cmpxchg(&device->state,
  977. FW_DEVICE_INITIALIZING,
  978. FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
  979. goto gone;
  980. fw_notice(card, "refreshed device %s\n", dev_name(&device->device));
  981. device->config_rom_retries = 0;
  982. goto out;
  983. failed_config_rom:
  984. if (device->config_rom_retries < MAX_RETRIES &&
  985. atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
  986. device->config_rom_retries++;
  987. fw_schedule_device_work(device, RETRY_DELAY);
  988. return;
  989. }
  990. fw_notice(card, "giving up on refresh of device %s: %s\n",
  991. dev_name(&device->device), fw_rcode_string(ret));
  992. gone:
  993. atomic_set(&device->state, FW_DEVICE_GONE);
  994. PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
  995. fw_schedule_device_work(device, SHUTDOWN_DELAY);
  996. out:
  997. if (node_id == card->root_node->node_id)
  998. fw_schedule_bm_work(card, 0);
  999. }
  1000. void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
  1001. {
  1002. struct fw_device *device;
  1003. switch (event) {
  1004. case FW_NODE_CREATED:
  1005. /*
  1006. * Attempt to scan the node, regardless whether its self ID has
  1007. * the L (link active) flag set or not. Some broken devices
  1008. * send L=0 but have an up-and-running link; others send L=1
  1009. * without actually having a link.
  1010. */
  1011. create:
  1012. device = kzalloc(sizeof(*device), GFP_ATOMIC);
  1013. if (device == NULL)
  1014. break;
  1015. /*
  1016. * Do minimal intialization of the device here, the
  1017. * rest will happen in fw_device_init().
  1018. *
  1019. * Attention: A lot of things, even fw_device_get(),
  1020. * cannot be done before fw_device_init() finished!
  1021. * You can basically just check device->state and
  1022. * schedule work until then, but only while holding
  1023. * card->lock.
  1024. */
  1025. atomic_set(&device->state, FW_DEVICE_INITIALIZING);
  1026. device->card = fw_card_get(card);
  1027. device->node = fw_node_get(node);
  1028. device->node_id = node->node_id;
  1029. device->generation = card->generation;
  1030. device->is_local = node == card->local_node;
  1031. mutex_init(&device->client_list_mutex);
  1032. INIT_LIST_HEAD(&device->client_list);
  1033. /*
  1034. * Set the node data to point back to this device so
  1035. * FW_NODE_UPDATED callbacks can update the node_id
  1036. * and generation for the device.
  1037. */
  1038. node->data = device;
  1039. /*
  1040. * Many devices are slow to respond after bus resets,
  1041. * especially if they are bus powered and go through
  1042. * power-up after getting plugged in. We schedule the
  1043. * first config rom scan half a second after bus reset.
  1044. */
  1045. INIT_DELAYED_WORK(&device->work, fw_device_init);
  1046. fw_schedule_device_work(device, INITIAL_DELAY);
  1047. break;
  1048. case FW_NODE_INITIATED_RESET:
  1049. case FW_NODE_LINK_ON:
  1050. device = node->data;
  1051. if (device == NULL)
  1052. goto create;
  1053. device->node_id = node->node_id;
  1054. smp_wmb(); /* update node_id before generation */
  1055. device->generation = card->generation;
  1056. if (atomic_cmpxchg(&device->state,
  1057. FW_DEVICE_RUNNING,
  1058. FW_DEVICE_INITIALIZING) == FW_DEVICE_RUNNING) {
  1059. PREPARE_DELAYED_WORK(&device->work, fw_device_refresh);
  1060. fw_schedule_device_work(device,
  1061. device->is_local ? 0 : INITIAL_DELAY);
  1062. }
  1063. break;
  1064. case FW_NODE_UPDATED:
  1065. device = node->data;
  1066. if (device == NULL)
  1067. break;
  1068. device->node_id = node->node_id;
  1069. smp_wmb(); /* update node_id before generation */
  1070. device->generation = card->generation;
  1071. if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
  1072. PREPARE_DELAYED_WORK(&device->work, fw_device_update);
  1073. fw_schedule_device_work(device, 0);
  1074. }
  1075. break;
  1076. case FW_NODE_DESTROYED:
  1077. case FW_NODE_LINK_OFF:
  1078. if (!node->data)
  1079. break;
  1080. /*
  1081. * Destroy the device associated with the node. There
  1082. * are two cases here: either the device is fully
  1083. * initialized (FW_DEVICE_RUNNING) or we're in the
  1084. * process of reading its config rom
  1085. * (FW_DEVICE_INITIALIZING). If it is fully
  1086. * initialized we can reuse device->work to schedule a
  1087. * full fw_device_shutdown(). If not, there's work
  1088. * scheduled to read it's config rom, and we just put
  1089. * the device in shutdown state to have that code fail
  1090. * to create the device.
  1091. */
  1092. device = node->data;
  1093. if (atomic_xchg(&device->state,
  1094. FW_DEVICE_GONE) == FW_DEVICE_RUNNING) {
  1095. PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
  1096. fw_schedule_device_work(device,
  1097. list_empty(&card->link) ? 0 : SHUTDOWN_DELAY);
  1098. }
  1099. break;
  1100. }
  1101. }