blob: c04c28800f1dda9a45dfd627787d60dee866578e [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
2 * Device probing and sysfs code.
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05003 *
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
21#include <linux/module.h>
22#include <linux/wait.h>
23#include <linux/errno.h>
24#include <linux/kthread.h>
25#include <linux/device.h>
26#include <linux/delay.h>
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -050027#include <linux/idr.h>
Stefan Richter633c52d2007-03-19 11:37:16 -040028#include <linux/rwsem.h>
29#include <asm/semaphore.h>
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010030#include <asm/system.h>
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -040031#include <linux/ctype.h>
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050032#include "fw-transaction.h"
33#include "fw-topology.h"
34#include "fw-device.h"
35
36void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 * p)
37{
38 ci->p = p + 1;
39 ci->end = ci->p + (p[0] >> 16);
40}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050041EXPORT_SYMBOL(fw_csr_iterator_init);
42
43int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value)
44{
45 *key = *ci->p >> 24;
46 *value = *ci->p & 0xffffff;
47
48 return ci->p++ < ci->end;
49}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050050EXPORT_SYMBOL(fw_csr_iterator_next);
51
52static int is_fw_unit(struct device *dev);
53
Stefan Richter21ebcd12007-01-14 15:29:07 +010054static int match_unit_directory(u32 * directory, const struct fw_device_id *id)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050055{
56 struct fw_csr_iterator ci;
57 int key, value, match;
58
59 match = 0;
60 fw_csr_iterator_init(&ci, directory);
61 while (fw_csr_iterator_next(&ci, &key, &value)) {
62 if (key == CSR_VENDOR && value == id->vendor)
63 match |= FW_MATCH_VENDOR;
64 if (key == CSR_MODEL && value == id->model)
65 match |= FW_MATCH_MODEL;
66 if (key == CSR_SPECIFIER_ID && value == id->specifier_id)
67 match |= FW_MATCH_SPECIFIER_ID;
68 if (key == CSR_VERSION && value == id->version)
69 match |= FW_MATCH_VERSION;
70 }
71
72 return (match & id->match_flags) == id->match_flags;
73}
74
75static int fw_unit_match(struct device *dev, struct device_driver *drv)
76{
77 struct fw_unit *unit = fw_unit(dev);
78 struct fw_driver *driver = fw_driver(drv);
79 int i;
80
81 /* We only allow binding to fw_units. */
82 if (!is_fw_unit(dev))
83 return 0;
84
85 for (i = 0; driver->id_table[i].match_flags != 0; i++) {
86 if (match_unit_directory(unit->directory, &driver->id_table[i]))
87 return 1;
88 }
89
90 return 0;
91}
92
93static int get_modalias(struct fw_unit *unit, char *buffer, size_t buffer_size)
94{
95 struct fw_device *device = fw_device(unit->device.parent);
96 struct fw_csr_iterator ci;
97
98 int key, value;
99 int vendor = 0;
100 int model = 0;
101 int specifier_id = 0;
102 int version = 0;
103
104 fw_csr_iterator_init(&ci, &device->config_rom[5]);
105 while (fw_csr_iterator_next(&ci, &key, &value)) {
106 switch (key) {
107 case CSR_VENDOR:
108 vendor = value;
109 break;
110 case CSR_MODEL:
111 model = value;
112 break;
113 }
114 }
115
116 fw_csr_iterator_init(&ci, unit->directory);
117 while (fw_csr_iterator_next(&ci, &key, &value)) {
118 switch (key) {
119 case CSR_SPECIFIER_ID:
120 specifier_id = value;
121 break;
122 case CSR_VERSION:
123 version = value;
124 break;
125 }
126 }
127
128 return snprintf(buffer, buffer_size,
129 "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
130 vendor, model, specifier_id, version);
131}
132
133static int
Kay Sievers7eff2e72007-08-14 15:15:12 +0200134fw_unit_uevent(struct device *dev, struct kobj_uevent_env *env)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500135{
136 struct fw_unit *unit = fw_unit(dev);
137 char modalias[64];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500138
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400139 get_modalias(unit, modalias, sizeof(modalias));
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500140
Kay Sievers7eff2e72007-08-14 15:15:12 +0200141 if (add_uevent_var(env, "MODALIAS=%s", modalias))
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500142 return -ENOMEM;
143
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500144 return 0;
145}
146
147struct bus_type fw_bus_type = {
Kristian Høgsberg362c2c82007-02-06 14:49:37 -0500148 .name = "firewire",
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500149 .match = fw_unit_match,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500150};
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500151EXPORT_SYMBOL(fw_bus_type);
152
Randy Dunlap0b6aa3d2007-04-25 22:43:16 -0700153struct fw_device *fw_device_get(struct fw_device *device)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500154{
155 get_device(&device->device);
156
157 return device;
158}
159
Randy Dunlap0b6aa3d2007-04-25 22:43:16 -0700160void fw_device_put(struct fw_device *device)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500161{
162 put_device(&device->device);
163}
164
165static void fw_device_release(struct device *dev)
166{
167 struct fw_device *device = fw_device(dev);
168 unsigned long flags;
169
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400170 /*
171 * Take the card lock so we don't set this to NULL while a
172 * FW_NODE_UPDATED callback is being handled.
173 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500174 spin_lock_irqsave(&device->card->lock, flags);
175 device->node->data = NULL;
176 spin_unlock_irqrestore(&device->card->lock, flags);
177
178 fw_node_put(device->node);
179 fw_card_put(device->card);
180 kfree(device->config_rom);
181 kfree(device);
182}
183
184int fw_device_enable_phys_dma(struct fw_device *device)
185{
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100186 int generation = device->generation;
187
188 /* device->node_id, accessed below, must not be older than generation */
189 smp_rmb();
190
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500191 return device->card->driver->enable_phys_dma(device->card,
192 device->node_id,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100193 generation);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500194}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500195EXPORT_SYMBOL(fw_device_enable_phys_dma);
196
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400197struct config_rom_attribute {
198 struct device_attribute attr;
199 u32 key;
200};
201
202static ssize_t
203show_immediate(struct device *dev, struct device_attribute *dattr, char *buf)
204{
205 struct config_rom_attribute *attr =
206 container_of(dattr, struct config_rom_attribute, attr);
207 struct fw_csr_iterator ci;
208 u32 *dir;
209 int key, value;
210
211 if (is_fw_unit(dev))
212 dir = fw_unit(dev)->directory;
213 else
214 dir = fw_device(dev)->config_rom + 5;
215
216 fw_csr_iterator_init(&ci, dir);
217 while (fw_csr_iterator_next(&ci, &key, &value))
218 if (attr->key == key)
219 return snprintf(buf, buf ? PAGE_SIZE : 0,
220 "0x%06x\n", value);
221
222 return -ENOENT;
223}
224
225#define IMMEDIATE_ATTR(name, key) \
226 { __ATTR(name, S_IRUGO, show_immediate, NULL), key }
227
228static ssize_t
229show_text_leaf(struct device *dev, struct device_attribute *dattr, char *buf)
230{
231 struct config_rom_attribute *attr =
232 container_of(dattr, struct config_rom_attribute, attr);
233 struct fw_csr_iterator ci;
234 u32 *dir, *block = NULL, *p, *end;
235 int length, key, value, last_key = 0;
236 char *b;
237
238 if (is_fw_unit(dev))
239 dir = fw_unit(dev)->directory;
240 else
241 dir = fw_device(dev)->config_rom + 5;
242
243 fw_csr_iterator_init(&ci, dir);
244 while (fw_csr_iterator_next(&ci, &key, &value)) {
245 if (attr->key == last_key &&
246 key == (CSR_DESCRIPTOR | CSR_LEAF))
247 block = ci.p - 1 + value;
248 last_key = key;
249 }
250
251 if (block == NULL)
252 return -ENOENT;
253
254 length = min(block[0] >> 16, 256U);
255 if (length < 3)
256 return -ENOENT;
257
258 if (block[1] != 0 || block[2] != 0)
259 /* Unknown encoding. */
260 return -ENOENT;
261
262 if (buf == NULL)
263 return length * 4;
264
265 b = buf;
266 end = &block[length + 1];
267 for (p = &block[3]; p < end; p++, b += 4)
268 * (u32 *) b = (__force u32) __cpu_to_be32(*p);
269
270 /* Strip trailing whitespace and add newline. */
271 while (b--, (isspace(*b) || *b == '\0') && b > buf);
272 strcpy(b + 1, "\n");
273
274 return b + 2 - buf;
275}
276
277#define TEXT_LEAF_ATTR(name, key) \
278 { __ATTR(name, S_IRUGO, show_text_leaf, NULL), key }
279
280static struct config_rom_attribute config_rom_attributes[] = {
281 IMMEDIATE_ATTR(vendor, CSR_VENDOR),
282 IMMEDIATE_ATTR(hardware_version, CSR_HARDWARE_VERSION),
283 IMMEDIATE_ATTR(specifier_id, CSR_SPECIFIER_ID),
284 IMMEDIATE_ATTR(version, CSR_VERSION),
285 IMMEDIATE_ATTR(model, CSR_MODEL),
286 TEXT_LEAF_ATTR(vendor_name, CSR_VENDOR),
287 TEXT_LEAF_ATTR(model_name, CSR_MODEL),
288 TEXT_LEAF_ATTR(hardware_version_name, CSR_HARDWARE_VERSION),
289};
290
291static void
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400292init_fw_attribute_group(struct device *dev,
293 struct device_attribute *attrs,
294 struct fw_attribute_group *group)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400295{
296 struct device_attribute *attr;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400297 int i, j;
298
299 for (j = 0; attrs[j].attr.name != NULL; j++)
300 group->attrs[j] = &attrs[j].attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400301
302 for (i = 0; i < ARRAY_SIZE(config_rom_attributes); i++) {
303 attr = &config_rom_attributes[i].attr;
304 if (attr->show(dev, attr, NULL) < 0)
305 continue;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400306 group->attrs[j++] = &attr->attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400307 }
308
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400309 BUG_ON(j >= ARRAY_SIZE(group->attrs));
310 group->attrs[j++] = NULL;
311 group->groups[0] = &group->group;
312 group->groups[1] = NULL;
313 group->group.attrs = group->attrs;
314 dev->groups = group->groups;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400315}
316
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500317static ssize_t
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400318modalias_show(struct device *dev,
319 struct device_attribute *attr, char *buf)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500320{
321 struct fw_unit *unit = fw_unit(dev);
322 int length;
323
324 length = get_modalias(unit, buf, PAGE_SIZE);
325 strcpy(buf + length, "\n");
326
327 return length + 1;
328}
329
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500330static ssize_t
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400331rom_index_show(struct device *dev,
332 struct device_attribute *attr, char *buf)
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500333{
334 struct fw_device *device = fw_device(dev->parent);
335 struct fw_unit *unit = fw_unit(dev);
336
337 return snprintf(buf, PAGE_SIZE, "%d\n",
Stefan Richterd84702a2007-03-20 19:42:15 +0100338 (int)(unit->directory - device->config_rom));
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500339}
340
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400341static struct device_attribute fw_unit_attributes[] = {
342 __ATTR_RO(modalias),
343 __ATTR_RO(rom_index),
344 __ATTR_NULL,
345};
346
347static ssize_t
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400348config_rom_show(struct device *dev, struct device_attribute *attr, char *buf)
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400349{
350 struct fw_device *device = fw_device(dev);
351
352 memcpy(buf, device->config_rom, device->config_rom_length * 4);
353
354 return device->config_rom_length * 4;
355}
356
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400357static ssize_t
358guid_show(struct device *dev, struct device_attribute *attr, char *buf)
359{
360 struct fw_device *device = fw_device(dev);
361 u64 guid;
362
363 guid = ((u64)device->config_rom[3] << 32) | device->config_rom[4];
364
Andrew Morton3e1dcb02007-04-26 00:16:04 -0700365 return snprintf(buf, PAGE_SIZE, "0x%016llx\n",
366 (unsigned long long)guid);
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400367}
368
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400369static struct device_attribute fw_device_attributes[] = {
370 __ATTR_RO(config_rom),
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400371 __ATTR_RO(guid),
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400372 __ATTR_NULL,
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500373};
374
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500375struct read_quadlet_callback_data {
376 struct completion done;
377 int rcode;
378 u32 data;
379};
380
381static void
382complete_transaction(struct fw_card *card, int rcode,
383 void *payload, size_t length, void *data)
384{
385 struct read_quadlet_callback_data *callback_data = data;
386
387 if (rcode == RCODE_COMPLETE)
388 callback_data->data = be32_to_cpu(*(__be32 *)payload);
389 callback_data->rcode = rcode;
390 complete(&callback_data->done);
391}
392
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100393static int
394read_rom(struct fw_device *device, int generation, int index, u32 *data)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500395{
396 struct read_quadlet_callback_data callback_data;
397 struct fw_transaction t;
398 u64 offset;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100399
400 /* device->node_id, accessed below, must not be older than generation */
401 smp_rmb();
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500402
403 init_completion(&callback_data.done);
404
405 offset = 0xfffff0000400ULL + index * 4;
406 fw_send_request(device->card, &t, TCODE_READ_QUADLET_REQUEST,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100407 device->node_id, generation, device->max_speed,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500408 offset, NULL, 4, complete_transaction, &callback_data);
409
410 wait_for_completion(&callback_data.done);
411
412 *data = callback_data.data;
413
414 return callback_data.rcode;
415}
416
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100417/*
418 * Read the bus info block, perform a speed probe, and read all of the rest of
419 * the config ROM. We do all this with a cached bus generation. If the bus
420 * generation changes under us, read_bus_info_block will fail and get retried.
421 * It's better to start all over in this case because the node from which we
422 * are reading the ROM may have changed the ROM during the reset.
423 */
424static int read_bus_info_block(struct fw_device *device, int generation)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500425{
426 static u32 rom[256];
427 u32 stack[16], sp, key;
428 int i, end, length;
429
Stefan Richterf1397492007-06-10 21:31:36 +0200430 device->max_speed = SCODE_100;
431
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500432 /* First read the bus info block. */
433 for (i = 0; i < 5; i++) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100434 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500435 return -1;
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400436 /*
437 * As per IEEE1212 7.2, during power-up, devices can
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500438 * reply with a 0 for the first quadlet of the config
439 * rom to indicate that they are booting (for example,
440 * if the firmware is on the disk of a external
441 * harddisk). In that case we just fail, and the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400442 * retry mechanism will try again later.
443 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500444 if (i == 0 && rom[i] == 0)
445 return -1;
446 }
447
Stefan Richterf1397492007-06-10 21:31:36 +0200448 device->max_speed = device->node->max_speed;
449
450 /*
451 * Determine the speed of
452 * - devices with link speed less than PHY speed,
453 * - devices with 1394b PHY (unless only connected to 1394a PHYs),
454 * - all devices if there are 1394b repeaters.
455 * Note, we cannot use the bus info block's link_spd as starting point
456 * because some buggy firmwares set it lower than necessary and because
457 * 1394-1995 nodes do not have the field.
458 */
459 if ((rom[2] & 0x7) < device->max_speed ||
460 device->max_speed == SCODE_BETA ||
461 device->card->beta_repeaters_present) {
462 u32 dummy;
463
464 /* for S1600 and S3200 */
465 if (device->max_speed == SCODE_BETA)
466 device->max_speed = device->card->link_speed;
467
468 while (device->max_speed > SCODE_100) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100469 if (read_rom(device, generation, 0, &dummy) ==
470 RCODE_COMPLETE)
Stefan Richterf1397492007-06-10 21:31:36 +0200471 break;
472 device->max_speed--;
473 }
474 }
475
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400476 /*
477 * Now parse the config rom. The config rom is a recursive
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500478 * directory structure so we parse it using a stack of
479 * references to the blocks that make up the structure. We
480 * push a reference to the root directory on the stack to
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400481 * start things off.
482 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500483 length = i;
484 sp = 0;
485 stack[sp++] = 0xc0000005;
486 while (sp > 0) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400487 /*
488 * Pop the next block reference of the stack. The
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500489 * lower 24 bits is the offset into the config rom,
490 * the upper 8 bits are the type of the reference the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400491 * block.
492 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500493 key = stack[--sp];
494 i = key & 0xffffff;
495 if (i >= ARRAY_SIZE(rom))
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400496 /*
497 * The reference points outside the standard
498 * config rom area, something's fishy.
499 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500500 return -1;
501
502 /* Read header quadlet for the block to get the length. */
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100503 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500504 return -1;
505 end = i + (rom[i] >> 16) + 1;
506 i++;
507 if (end > ARRAY_SIZE(rom))
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400508 /*
509 * This block extends outside standard config
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500510 * area (and the array we're reading it
511 * into). That's broken, so ignore this
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400512 * device.
513 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500514 return -1;
515
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400516 /*
517 * Now read in the block. If this is a directory
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500518 * block, check the entries as we read them to see if
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400519 * it references another block, and push it in that case.
520 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500521 while (i < end) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100522 if (read_rom(device, generation, i, &rom[i]) !=
523 RCODE_COMPLETE)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500524 return -1;
525 if ((key >> 30) == 3 && (rom[i] >> 30) > 1 &&
526 sp < ARRAY_SIZE(stack))
527 stack[sp++] = i + rom[i];
528 i++;
529 }
530 if (length < i)
531 length = i;
532 }
533
534 device->config_rom = kmalloc(length * 4, GFP_KERNEL);
535 if (device->config_rom == NULL)
536 return -1;
537 memcpy(device->config_rom, rom, length * 4);
538 device->config_rom_length = length;
539
540 return 0;
541}
542
543static void fw_unit_release(struct device *dev)
544{
545 struct fw_unit *unit = fw_unit(dev);
546
547 kfree(unit);
548}
549
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400550static struct device_type fw_unit_type = {
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400551 .uevent = fw_unit_uevent,
552 .release = fw_unit_release,
553};
554
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500555static int is_fw_unit(struct device *dev)
556{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400557 return dev->type == &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500558}
559
560static void create_units(struct fw_device *device)
561{
562 struct fw_csr_iterator ci;
563 struct fw_unit *unit;
564 int key, value, i;
565
566 i = 0;
567 fw_csr_iterator_init(&ci, &device->config_rom[5]);
568 while (fw_csr_iterator_next(&ci, &key, &value)) {
569 if (key != (CSR_UNIT | CSR_DIRECTORY))
570 continue;
571
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400572 /*
573 * Get the address of the unit directory and try to
574 * match the drivers id_tables against it.
575 */
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400576 unit = kzalloc(sizeof(*unit), GFP_KERNEL);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500577 if (unit == NULL) {
578 fw_error("failed to allocate memory for unit\n");
579 continue;
580 }
581
582 unit->directory = ci.p + value - 1;
583 unit->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400584 unit->device.type = &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500585 unit->device.parent = &device->device;
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400586 snprintf(unit->device.bus_id, sizeof(unit->device.bus_id),
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500587 "%s.%d", device->device.bus_id, i++);
588
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400589 init_fw_attribute_group(&unit->device,
590 fw_unit_attributes,
591 &unit->attribute_group);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400592 if (device_register(&unit->device) < 0)
593 goto skip_unit;
594
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400595 continue;
596
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400597 skip_unit:
598 kfree(unit);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500599 }
600}
601
602static int shutdown_unit(struct device *device, void *data)
603{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400604 device_unregister(device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500605
606 return 0;
607}
608
Kristian Høgsbergdde2b952007-04-17 11:51:57 -0400609static DECLARE_RWSEM(idr_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500610static DEFINE_IDR(fw_device_idr);
611int fw_cdev_major;
612
Stefan Richter96b19062008-02-02 15:01:09 +0100613struct fw_device *fw_device_get_by_devt(dev_t devt)
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500614{
615 struct fw_device *device;
616
Kristian Høgsbergdde2b952007-04-17 11:51:57 -0400617 down_read(&idr_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500618 device = idr_find(&fw_device_idr, MINOR(devt));
Stefan Richter96b19062008-02-02 15:01:09 +0100619 if (device)
620 fw_device_get(device);
Kristian Høgsbergdde2b952007-04-17 11:51:57 -0400621 up_read(&idr_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500622
623 return device;
624}
625
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500626static void fw_device_shutdown(struct work_struct *work)
627{
628 struct fw_device *device =
629 container_of(work, struct fw_device, work.work);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500630 int minor = MINOR(device->device.devt);
631
Kristian Høgsberg2603bf22007-03-07 12:12:48 -0500632 fw_device_cdev_remove(device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500633 device_for_each_child(&device->device, NULL, shutdown_unit);
634 device_unregister(&device->device);
Stefan Richter96b19062008-02-02 15:01:09 +0100635
636 down_write(&idr_rwsem);
637 idr_remove(&fw_device_idr, minor);
638 up_write(&idr_rwsem);
639 fw_device_put(device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500640}
641
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400642static struct device_type fw_device_type = {
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400643 .release = fw_device_release,
644};
645
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400646/*
647 * These defines control the retry behavior for reading the config
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500648 * rom. It shouldn't be necessary to tweak these; if the device
649 * doesn't respond to a config rom read within 10 seconds, it's not
650 * going to respond at all. As for the initial delay, a lot of
651 * devices will be able to respond within half a second after bus
652 * reset. On the other hand, it's not really worth being more
653 * aggressive than that, since it scales pretty well; if 10 devices
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400654 * are plugged in, they're all getting read within one second.
655 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500656
Kristian Høgsbergc5dfd0a2007-03-27 01:43:43 -0400657#define MAX_RETRIES 10
658#define RETRY_DELAY (3 * HZ)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500659#define INITIAL_DELAY (HZ / 2)
660
661static void fw_device_init(struct work_struct *work)
662{
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500663 struct fw_device *device =
664 container_of(work, struct fw_device, work.work);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500665 int minor, err;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500666
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400667 /*
668 * All failure paths here set node->data to NULL, so that we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500669 * don't try to do device_for_each_child() on a kfree()'d
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400670 * device.
671 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500672
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100673 if (read_bus_info_block(device, device->generation) < 0) {
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500674 if (device->config_rom_retries < MAX_RETRIES) {
675 device->config_rom_retries++;
676 schedule_delayed_work(&device->work, RETRY_DELAY);
677 } else {
Stefan Richter907293d2007-01-23 21:11:43 +0100678 fw_notify("giving up on config rom for node id %x\n",
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500679 device->node_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500680 if (device->node == device->card->root_node)
681 schedule_delayed_work(&device->card->work, 0);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500682 fw_device_release(&device->device);
683 }
684 return;
685 }
686
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500687 err = -ENOMEM;
Stefan Richter96b19062008-02-02 15:01:09 +0100688
689 fw_device_get(device);
Kristian Høgsbergdde2b952007-04-17 11:51:57 -0400690 down_write(&idr_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500691 if (idr_pre_get(&fw_device_idr, GFP_KERNEL))
692 err = idr_get_new(&fw_device_idr, device, &minor);
Kristian Høgsbergdde2b952007-04-17 11:51:57 -0400693 up_write(&idr_rwsem);
Stefan Richter96b19062008-02-02 15:01:09 +0100694
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500695 if (err < 0)
696 goto error;
697
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500698 device->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400699 device->device.type = &fw_device_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500700 device->device.parent = device->card->device;
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500701 device->device.devt = MKDEV(fw_cdev_major, minor);
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400702 snprintf(device->device.bus_id, sizeof(device->device.bus_id),
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500703 "fw%d", minor);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500704
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400705 init_fw_attribute_group(&device->device,
706 fw_device_attributes,
707 &device->attribute_group);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500708 if (device_add(&device->device)) {
709 fw_error("Failed to add device.\n");
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500710 goto error_with_cdev;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500711 }
712
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500713 create_units(device);
714
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400715 /*
716 * Transition the device to running state. If it got pulled
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500717 * out from under us while we did the intialization work, we
718 * have to shut down the device again here. Normally, though,
719 * fw_node_event will be responsible for shutting it down when
720 * necessary. We have to use the atomic cmpxchg here to avoid
721 * racing with the FW_NODE_DESTROYED case in
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400722 * fw_node_event().
723 */
Stefan Richter641f8792007-01-27 10:34:55 +0100724 if (atomic_cmpxchg(&device->state,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500725 FW_DEVICE_INITIALIZING,
726 FW_DEVICE_RUNNING) == FW_DEVICE_SHUTDOWN)
727 fw_device_shutdown(&device->work.work);
728 else
Stefan Richterf1397492007-06-10 21:31:36 +0200729 fw_notify("created new fw device %s "
730 "(%d config rom retries, S%d00)\n",
731 device->device.bus_id, device->config_rom_retries,
732 1 << device->max_speed);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500733
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400734 /*
735 * Reschedule the IRM work if we just finished reading the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500736 * root node config rom. If this races with a bus reset we
737 * just end up running the IRM work a couple of extra times -
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400738 * pretty harmless.
739 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500740 if (device->node == device->card->root_node)
741 schedule_delayed_work(&device->card->work, 0);
742
743 return;
744
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500745 error_with_cdev:
Kristian Høgsbergdde2b952007-04-17 11:51:57 -0400746 down_write(&idr_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500747 idr_remove(&fw_device_idr, minor);
Kristian Høgsbergdde2b952007-04-17 11:51:57 -0400748 up_write(&idr_rwsem);
Stefan Richter373b2ed2007-03-04 14:45:18 +0100749 error:
Stefan Richter96b19062008-02-02 15:01:09 +0100750 fw_device_put(device); /* fw_device_idr's reference */
751
752 put_device(&device->device); /* our reference */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500753}
754
755static int update_unit(struct device *dev, void *data)
756{
757 struct fw_unit *unit = fw_unit(dev);
758 struct fw_driver *driver = (struct fw_driver *)dev->driver;
759
Kristian Høgsberg015b0662007-03-19 11:37:16 -0400760 if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
761 down(&dev->sem);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500762 driver->update(unit);
Kristian Høgsberg015b0662007-03-19 11:37:16 -0400763 up(&dev->sem);
764 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500765
766 return 0;
767}
768
Kristian Høgsberg5f480472007-03-07 12:12:39 -0500769static void fw_device_update(struct work_struct *work)
770{
771 struct fw_device *device =
772 container_of(work, struct fw_device, work.work);
773
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -0500774 fw_device_cdev_update(device);
Kristian Høgsberg5f480472007-03-07 12:12:39 -0500775 device_for_each_child(&device->device, NULL, update_unit);
776}
777
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500778void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
779{
780 struct fw_device *device;
781
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500782 switch (event) {
783 case FW_NODE_CREATED:
784 case FW_NODE_LINK_ON:
785 if (!node->link_on)
786 break;
787
788 device = kzalloc(sizeof(*device), GFP_ATOMIC);
789 if (device == NULL)
790 break;
791
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400792 /*
793 * Do minimal intialization of the device here, the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500794 * rest will happen in fw_device_init(). We need the
795 * card and node so we can read the config rom and we
796 * need to do device_initialize() now so
797 * device_for_each_child() in FW_NODE_UPDATED is
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400798 * doesn't freak out.
799 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500800 device_initialize(&device->device);
Stefan Richter641f8792007-01-27 10:34:55 +0100801 atomic_set(&device->state, FW_DEVICE_INITIALIZING);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500802 device->card = fw_card_get(card);
803 device->node = fw_node_get(node);
804 device->node_id = node->node_id;
805 device->generation = card->generation;
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -0500806 INIT_LIST_HEAD(&device->client_list);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500807
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400808 /*
809 * Set the node data to point back to this device so
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500810 * FW_NODE_UPDATED callbacks can update the node_id
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400811 * and generation for the device.
812 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500813 node->data = device;
814
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400815 /*
816 * Many devices are slow to respond after bus resets,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500817 * especially if they are bus powered and go through
818 * power-up after getting plugged in. We schedule the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400819 * first config rom scan half a second after bus reset.
820 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500821 INIT_DELAYED_WORK(&device->work, fw_device_init);
822 schedule_delayed_work(&device->work, INITIAL_DELAY);
823 break;
824
825 case FW_NODE_UPDATED:
826 if (!node->link_on || node->data == NULL)
827 break;
828
829 device = node->data;
830 device->node_id = node->node_id;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100831 smp_wmb(); /* update node_id before generation */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500832 device->generation = card->generation;
Kristian Høgsberg5f480472007-03-07 12:12:39 -0500833 if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
834 PREPARE_DELAYED_WORK(&device->work, fw_device_update);
835 schedule_delayed_work(&device->work, 0);
836 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500837 break;
838
839 case FW_NODE_DESTROYED:
840 case FW_NODE_LINK_OFF:
841 if (!node->data)
842 break;
843
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400844 /*
845 * Destroy the device associated with the node. There
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500846 * are two cases here: either the device is fully
847 * initialized (FW_DEVICE_RUNNING) or we're in the
848 * process of reading its config rom
849 * (FW_DEVICE_INITIALIZING). If it is fully
850 * initialized we can reuse device->work to schedule a
851 * full fw_device_shutdown(). If not, there's work
852 * scheduled to read it's config rom, and we just put
853 * the device in shutdown state to have that code fail
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400854 * to create the device.
855 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500856 device = node->data;
Stefan Richter641f8792007-01-27 10:34:55 +0100857 if (atomic_xchg(&device->state,
Kristian Høgsberg5f480472007-03-07 12:12:39 -0500858 FW_DEVICE_SHUTDOWN) == FW_DEVICE_RUNNING) {
859 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500860 schedule_delayed_work(&device->work, 0);
861 }
862 break;
863 }
864}