blob: a47e2129d83d3a5f99aa7165a6600f3bea9b5383 [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
Stefan Richter41f321c2009-01-17 22:45:54 +010021#include <linux/ctype.h>
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050022#include <linux/delay.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010023#include <linux/device.h>
24#include <linux/errno.h>
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -050025#include <linux/idr.h>
Stefan Richter3d36a0d2009-01-17 22:45:54 +010026#include <linux/jiffies.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010027#include <linux/kobject.h>
28#include <linux/list.h>
Stefan Richterd67cfb92008-10-05 10:37:11 +020029#include <linux/mutex.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040030#include <linux/rwsem.h>
31#include <linux/semaphore.h>
Jay Fenlasoncf417e542008-10-03 11:19:09 -040032#include <linux/spinlock.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010033#include <linux/string.h>
34#include <linux/workqueue.h>
35
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010036#include <asm/system.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010037
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050038#include "fw-device.h"
Stefan Richter41f321c2009-01-17 22:45:54 +010039#include "fw-topology.h"
40#include "fw-transaction.h"
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050041
42void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 * p)
43{
44 ci->p = p + 1;
45 ci->end = ci->p + (p[0] >> 16);
46}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050047EXPORT_SYMBOL(fw_csr_iterator_init);
48
49int 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
54 return ci->p++ < ci->end;
55}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050056EXPORT_SYMBOL(fw_csr_iterator_next);
57
58static int is_fw_unit(struct device *dev);
59
Stefan Richter21ebcd12007-01-14 15:29:07 +010060static int match_unit_directory(u32 * directory, const struct fw_device_id *id)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050061{
62 struct fw_csr_iterator ci;
63 int key, value, match;
64
65 match = 0;
66 fw_csr_iterator_init(&ci, directory);
67 while (fw_csr_iterator_next(&ci, &key, &value)) {
68 if (key == CSR_VENDOR && value == id->vendor)
69 match |= FW_MATCH_VENDOR;
70 if (key == CSR_MODEL && value == id->model)
71 match |= FW_MATCH_MODEL;
72 if (key == CSR_SPECIFIER_ID && value == id->specifier_id)
73 match |= FW_MATCH_SPECIFIER_ID;
74 if (key == CSR_VERSION && value == id->version)
75 match |= FW_MATCH_VERSION;
76 }
77
78 return (match & id->match_flags) == id->match_flags;
79}
80
81static int fw_unit_match(struct device *dev, struct device_driver *drv)
82{
83 struct fw_unit *unit = fw_unit(dev);
84 struct fw_driver *driver = fw_driver(drv);
85 int i;
86
87 /* We only allow binding to fw_units. */
88 if (!is_fw_unit(dev))
89 return 0;
90
91 for (i = 0; driver->id_table[i].match_flags != 0; i++) {
92 if (match_unit_directory(unit->directory, &driver->id_table[i]))
93 return 1;
94 }
95
96 return 0;
97}
98
99static int get_modalias(struct fw_unit *unit, char *buffer, size_t buffer_size)
100{
101 struct fw_device *device = fw_device(unit->device.parent);
102 struct fw_csr_iterator ci;
103
104 int key, value;
105 int vendor = 0;
106 int model = 0;
107 int specifier_id = 0;
108 int version = 0;
109
110 fw_csr_iterator_init(&ci, &device->config_rom[5]);
111 while (fw_csr_iterator_next(&ci, &key, &value)) {
112 switch (key) {
113 case CSR_VENDOR:
114 vendor = value;
115 break;
116 case CSR_MODEL:
117 model = value;
118 break;
119 }
120 }
121
122 fw_csr_iterator_init(&ci, unit->directory);
123 while (fw_csr_iterator_next(&ci, &key, &value)) {
124 switch (key) {
125 case CSR_SPECIFIER_ID:
126 specifier_id = value;
127 break;
128 case CSR_VERSION:
129 version = value;
130 break;
131 }
132 }
133
134 return snprintf(buffer, buffer_size,
135 "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
136 vendor, model, specifier_id, version);
137}
138
Stefan Richter53dca512008-12-14 21:47:04 +0100139static int fw_unit_uevent(struct device *dev, struct kobj_uevent_env *env)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500140{
141 struct fw_unit *unit = fw_unit(dev);
142 char modalias[64];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500143
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400144 get_modalias(unit, modalias, sizeof(modalias));
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500145
Kay Sievers7eff2e72007-08-14 15:15:12 +0200146 if (add_uevent_var(env, "MODALIAS=%s", modalias))
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500147 return -ENOMEM;
148
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500149 return 0;
150}
151
152struct bus_type fw_bus_type = {
Kristian Høgsberg362c2c82007-02-06 14:49:37 -0500153 .name = "firewire",
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500154 .match = fw_unit_match,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500155};
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500156EXPORT_SYMBOL(fw_bus_type);
157
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500158int fw_device_enable_phys_dma(struct fw_device *device)
159{
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100160 int generation = device->generation;
161
162 /* device->node_id, accessed below, must not be older than generation */
163 smp_rmb();
164
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500165 return device->card->driver->enable_phys_dma(device->card,
166 device->node_id,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100167 generation);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500168}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500169EXPORT_SYMBOL(fw_device_enable_phys_dma);
170
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400171struct config_rom_attribute {
172 struct device_attribute attr;
173 u32 key;
174};
175
Stefan Richter53dca512008-12-14 21:47:04 +0100176static ssize_t show_immediate(struct device *dev,
177 struct device_attribute *dattr, char *buf)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400178{
179 struct config_rom_attribute *attr =
180 container_of(dattr, struct config_rom_attribute, attr);
181 struct fw_csr_iterator ci;
182 u32 *dir;
Stefan Richterc9755e12008-03-24 20:54:28 +0100183 int key, value, ret = -ENOENT;
184
185 down_read(&fw_device_rwsem);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400186
187 if (is_fw_unit(dev))
188 dir = fw_unit(dev)->directory;
189 else
190 dir = fw_device(dev)->config_rom + 5;
191
192 fw_csr_iterator_init(&ci, dir);
193 while (fw_csr_iterator_next(&ci, &key, &value))
Stefan Richterc9755e12008-03-24 20:54:28 +0100194 if (attr->key == key) {
195 ret = snprintf(buf, buf ? PAGE_SIZE : 0,
196 "0x%06x\n", value);
197 break;
198 }
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400199
Stefan Richterc9755e12008-03-24 20:54:28 +0100200 up_read(&fw_device_rwsem);
201
202 return ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400203}
204
205#define IMMEDIATE_ATTR(name, key) \
206 { __ATTR(name, S_IRUGO, show_immediate, NULL), key }
207
Stefan Richter53dca512008-12-14 21:47:04 +0100208static ssize_t show_text_leaf(struct device *dev,
209 struct device_attribute *dattr, char *buf)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400210{
211 struct config_rom_attribute *attr =
212 container_of(dattr, struct config_rom_attribute, attr);
213 struct fw_csr_iterator ci;
214 u32 *dir, *block = NULL, *p, *end;
Stefan Richterc9755e12008-03-24 20:54:28 +0100215 int length, key, value, last_key = 0, ret = -ENOENT;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400216 char *b;
217
Stefan Richterc9755e12008-03-24 20:54:28 +0100218 down_read(&fw_device_rwsem);
219
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400220 if (is_fw_unit(dev))
221 dir = fw_unit(dev)->directory;
222 else
223 dir = fw_device(dev)->config_rom + 5;
224
225 fw_csr_iterator_init(&ci, dir);
226 while (fw_csr_iterator_next(&ci, &key, &value)) {
227 if (attr->key == last_key &&
228 key == (CSR_DESCRIPTOR | CSR_LEAF))
229 block = ci.p - 1 + value;
230 last_key = key;
231 }
232
233 if (block == NULL)
Stefan Richterc9755e12008-03-24 20:54:28 +0100234 goto out;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400235
236 length = min(block[0] >> 16, 256U);
237 if (length < 3)
Stefan Richterc9755e12008-03-24 20:54:28 +0100238 goto out;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400239
240 if (block[1] != 0 || block[2] != 0)
241 /* Unknown encoding. */
Stefan Richterc9755e12008-03-24 20:54:28 +0100242 goto out;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400243
Stefan Richterc9755e12008-03-24 20:54:28 +0100244 if (buf == NULL) {
245 ret = length * 4;
246 goto out;
247 }
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400248
249 b = buf;
250 end = &block[length + 1];
251 for (p = &block[3]; p < end; p++, b += 4)
252 * (u32 *) b = (__force u32) __cpu_to_be32(*p);
253
254 /* Strip trailing whitespace and add newline. */
255 while (b--, (isspace(*b) || *b == '\0') && b > buf);
256 strcpy(b + 1, "\n");
Stefan Richterc9755e12008-03-24 20:54:28 +0100257 ret = b + 2 - buf;
258 out:
259 up_read(&fw_device_rwsem);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400260
Stefan Richterc9755e12008-03-24 20:54:28 +0100261 return ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400262}
263
264#define TEXT_LEAF_ATTR(name, key) \
265 { __ATTR(name, S_IRUGO, show_text_leaf, NULL), key }
266
267static struct config_rom_attribute config_rom_attributes[] = {
268 IMMEDIATE_ATTR(vendor, CSR_VENDOR),
269 IMMEDIATE_ATTR(hardware_version, CSR_HARDWARE_VERSION),
270 IMMEDIATE_ATTR(specifier_id, CSR_SPECIFIER_ID),
271 IMMEDIATE_ATTR(version, CSR_VERSION),
272 IMMEDIATE_ATTR(model, CSR_MODEL),
273 TEXT_LEAF_ATTR(vendor_name, CSR_VENDOR),
274 TEXT_LEAF_ATTR(model_name, CSR_MODEL),
275 TEXT_LEAF_ATTR(hardware_version_name, CSR_HARDWARE_VERSION),
276};
277
Stefan Richter53dca512008-12-14 21:47:04 +0100278static void init_fw_attribute_group(struct device *dev,
279 struct device_attribute *attrs,
280 struct fw_attribute_group *group)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400281{
282 struct device_attribute *attr;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400283 int i, j;
284
285 for (j = 0; attrs[j].attr.name != NULL; j++)
286 group->attrs[j] = &attrs[j].attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400287
288 for (i = 0; i < ARRAY_SIZE(config_rom_attributes); i++) {
289 attr = &config_rom_attributes[i].attr;
290 if (attr->show(dev, attr, NULL) < 0)
291 continue;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400292 group->attrs[j++] = &attr->attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400293 }
294
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400295 BUG_ON(j >= ARRAY_SIZE(group->attrs));
296 group->attrs[j++] = NULL;
297 group->groups[0] = &group->group;
298 group->groups[1] = NULL;
299 group->group.attrs = group->attrs;
300 dev->groups = group->groups;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400301}
302
Stefan Richter53dca512008-12-14 21:47:04 +0100303static ssize_t modalias_show(struct device *dev,
304 struct device_attribute *attr, char *buf)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500305{
306 struct fw_unit *unit = fw_unit(dev);
307 int length;
308
309 length = get_modalias(unit, buf, PAGE_SIZE);
310 strcpy(buf + length, "\n");
311
312 return length + 1;
313}
314
Stefan Richter53dca512008-12-14 21:47:04 +0100315static ssize_t rom_index_show(struct device *dev,
316 struct device_attribute *attr, char *buf)
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500317{
318 struct fw_device *device = fw_device(dev->parent);
319 struct fw_unit *unit = fw_unit(dev);
320
321 return snprintf(buf, PAGE_SIZE, "%d\n",
Stefan Richterd84702a2007-03-20 19:42:15 +0100322 (int)(unit->directory - device->config_rom));
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500323}
324
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400325static struct device_attribute fw_unit_attributes[] = {
326 __ATTR_RO(modalias),
327 __ATTR_RO(rom_index),
328 __ATTR_NULL,
329};
330
Stefan Richter53dca512008-12-14 21:47:04 +0100331static ssize_t config_rom_show(struct device *dev,
332 struct device_attribute *attr, char *buf)
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400333{
334 struct fw_device *device = fw_device(dev);
Stefan Richterc9755e12008-03-24 20:54:28 +0100335 size_t length;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400336
Stefan Richterc9755e12008-03-24 20:54:28 +0100337 down_read(&fw_device_rwsem);
338 length = device->config_rom_length * 4;
339 memcpy(buf, device->config_rom, length);
340 up_read(&fw_device_rwsem);
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400341
Stefan Richterc9755e12008-03-24 20:54:28 +0100342 return length;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400343}
344
Stefan Richter53dca512008-12-14 21:47:04 +0100345static ssize_t guid_show(struct device *dev,
346 struct device_attribute *attr, char *buf)
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400347{
348 struct fw_device *device = fw_device(dev);
Stefan Richterc9755e12008-03-24 20:54:28 +0100349 int ret;
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400350
Stefan Richterc9755e12008-03-24 20:54:28 +0100351 down_read(&fw_device_rwsem);
352 ret = snprintf(buf, PAGE_SIZE, "0x%08x%08x\n",
353 device->config_rom[3], device->config_rom[4]);
354 up_read(&fw_device_rwsem);
355
356 return ret;
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400357}
358
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400359static struct device_attribute fw_device_attributes[] = {
360 __ATTR_RO(config_rom),
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400361 __ATTR_RO(guid),
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400362 __ATTR_NULL,
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500363};
364
Stefan Richter53dca512008-12-14 21:47:04 +0100365static int read_rom(struct fw_device *device,
366 int generation, int index, u32 *data)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500367{
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200368 int rcode;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100369
370 /* device->node_id, accessed below, must not be older than generation */
371 smp_rmb();
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500372
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200373 rcode = fw_run_transaction(device->card, TCODE_READ_QUADLET_REQUEST,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100374 device->node_id, generation, device->max_speed,
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200375 (CSR_REGISTER_BASE | CSR_CONFIG_ROM) + index * 4,
376 data, 4);
377 be32_to_cpus(data);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500378
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200379 return rcode;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500380}
381
Stefan Richter1dadff72008-03-02 19:35:42 +0100382#define READ_BIB_ROM_SIZE 256
383#define READ_BIB_STACK_SIZE 16
384
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100385/*
386 * Read the bus info block, perform a speed probe, and read all of the rest of
387 * the config ROM. We do all this with a cached bus generation. If the bus
388 * generation changes under us, read_bus_info_block will fail and get retried.
389 * It's better to start all over in this case because the node from which we
390 * are reading the ROM may have changed the ROM during the reset.
391 */
392static int read_bus_info_block(struct fw_device *device, int generation)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500393{
Stefan Richterc9755e12008-03-24 20:54:28 +0100394 u32 *rom, *stack, *old_rom, *new_rom;
Stefan Richter1dadff72008-03-02 19:35:42 +0100395 u32 sp, key;
396 int i, end, length, ret = -1;
397
398 rom = kmalloc(sizeof(*rom) * READ_BIB_ROM_SIZE +
399 sizeof(*stack) * READ_BIB_STACK_SIZE, GFP_KERNEL);
400 if (rom == NULL)
401 return -ENOMEM;
402
403 stack = &rom[READ_BIB_ROM_SIZE];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500404
Stefan Richterf1397492007-06-10 21:31:36 +0200405 device->max_speed = SCODE_100;
406
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500407 /* First read the bus info block. */
408 for (i = 0; i < 5; i++) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100409 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100410 goto out;
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400411 /*
412 * As per IEEE1212 7.2, during power-up, devices can
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500413 * reply with a 0 for the first quadlet of the config
414 * rom to indicate that they are booting (for example,
415 * if the firmware is on the disk of a external
416 * harddisk). In that case we just fail, and the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400417 * retry mechanism will try again later.
418 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500419 if (i == 0 && rom[i] == 0)
Stefan Richter1dadff72008-03-02 19:35:42 +0100420 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500421 }
422
Stefan Richterf1397492007-06-10 21:31:36 +0200423 device->max_speed = device->node->max_speed;
424
425 /*
426 * Determine the speed of
427 * - devices with link speed less than PHY speed,
428 * - devices with 1394b PHY (unless only connected to 1394a PHYs),
429 * - all devices if there are 1394b repeaters.
430 * Note, we cannot use the bus info block's link_spd as starting point
431 * because some buggy firmwares set it lower than necessary and because
432 * 1394-1995 nodes do not have the field.
433 */
434 if ((rom[2] & 0x7) < device->max_speed ||
435 device->max_speed == SCODE_BETA ||
436 device->card->beta_repeaters_present) {
437 u32 dummy;
438
439 /* for S1600 and S3200 */
440 if (device->max_speed == SCODE_BETA)
441 device->max_speed = device->card->link_speed;
442
443 while (device->max_speed > SCODE_100) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100444 if (read_rom(device, generation, 0, &dummy) ==
445 RCODE_COMPLETE)
Stefan Richterf1397492007-06-10 21:31:36 +0200446 break;
447 device->max_speed--;
448 }
449 }
450
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400451 /*
452 * Now parse the config rom. The config rom is a recursive
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500453 * directory structure so we parse it using a stack of
454 * references to the blocks that make up the structure. We
455 * push a reference to the root directory on the stack to
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400456 * start things off.
457 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500458 length = i;
459 sp = 0;
460 stack[sp++] = 0xc0000005;
461 while (sp > 0) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400462 /*
463 * Pop the next block reference of the stack. The
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500464 * lower 24 bits is the offset into the config rom,
465 * the upper 8 bits are the type of the reference the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400466 * block.
467 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500468 key = stack[--sp];
469 i = key & 0xffffff;
Stefan Richter1dadff72008-03-02 19:35:42 +0100470 if (i >= READ_BIB_ROM_SIZE)
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400471 /*
472 * The reference points outside the standard
473 * config rom area, something's fishy.
474 */
Stefan Richter1dadff72008-03-02 19:35:42 +0100475 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500476
477 /* Read header quadlet for the block to get the length. */
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100478 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100479 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500480 end = i + (rom[i] >> 16) + 1;
481 i++;
Stefan Richter1dadff72008-03-02 19:35:42 +0100482 if (end > READ_BIB_ROM_SIZE)
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400483 /*
484 * This block extends outside standard config
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500485 * area (and the array we're reading it
486 * into). That's broken, so ignore this
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400487 * device.
488 */
Stefan Richter1dadff72008-03-02 19:35:42 +0100489 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500490
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400491 /*
492 * Now read in the block. If this is a directory
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500493 * block, check the entries as we read them to see if
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400494 * it references another block, and push it in that case.
495 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500496 while (i < end) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100497 if (read_rom(device, generation, i, &rom[i]) !=
498 RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100499 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500500 if ((key >> 30) == 3 && (rom[i] >> 30) > 1 &&
Stefan Richter1dadff72008-03-02 19:35:42 +0100501 sp < READ_BIB_STACK_SIZE)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500502 stack[sp++] = i + rom[i];
503 i++;
504 }
505 if (length < i)
506 length = i;
507 }
508
Stefan Richterc9755e12008-03-24 20:54:28 +0100509 old_rom = device->config_rom;
510 new_rom = kmemdup(rom, length * 4, GFP_KERNEL);
511 if (new_rom == NULL)
Stefan Richter1dadff72008-03-02 19:35:42 +0100512 goto out;
Stefan Richterc9755e12008-03-24 20:54:28 +0100513
514 down_write(&fw_device_rwsem);
515 device->config_rom = new_rom;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500516 device->config_rom_length = length;
Stefan Richterc9755e12008-03-24 20:54:28 +0100517 up_write(&fw_device_rwsem);
518
519 kfree(old_rom);
Stefan Richter1dadff72008-03-02 19:35:42 +0100520 ret = 0;
Stefan Richter7889b602009-03-10 21:09:28 +0100521 device->cmc = rom[2] >> 30 & 1;
Stefan Richter1dadff72008-03-02 19:35:42 +0100522 out:
523 kfree(rom);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500524
Stefan Richter1dadff72008-03-02 19:35:42 +0100525 return ret;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500526}
527
528static void fw_unit_release(struct device *dev)
529{
530 struct fw_unit *unit = fw_unit(dev);
531
532 kfree(unit);
533}
534
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400535static struct device_type fw_unit_type = {
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400536 .uevent = fw_unit_uevent,
537 .release = fw_unit_release,
538};
539
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500540static int is_fw_unit(struct device *dev)
541{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400542 return dev->type == &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500543}
544
545static void create_units(struct fw_device *device)
546{
547 struct fw_csr_iterator ci;
548 struct fw_unit *unit;
549 int key, value, i;
550
551 i = 0;
552 fw_csr_iterator_init(&ci, &device->config_rom[5]);
553 while (fw_csr_iterator_next(&ci, &key, &value)) {
554 if (key != (CSR_UNIT | CSR_DIRECTORY))
555 continue;
556
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400557 /*
558 * Get the address of the unit directory and try to
559 * match the drivers id_tables against it.
560 */
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400561 unit = kzalloc(sizeof(*unit), GFP_KERNEL);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500562 if (unit == NULL) {
563 fw_error("failed to allocate memory for unit\n");
564 continue;
565 }
566
567 unit->directory = ci.p + value - 1;
568 unit->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400569 unit->device.type = &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500570 unit->device.parent = &device->device;
Kay Sieversa1f64812008-10-30 01:41:56 +0100571 dev_set_name(&unit->device, "%s.%d", dev_name(&device->device), i++);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500572
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400573 init_fw_attribute_group(&unit->device,
574 fw_unit_attributes,
575 &unit->attribute_group);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400576 if (device_register(&unit->device) < 0)
577 goto skip_unit;
578
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400579 continue;
580
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400581 skip_unit:
582 kfree(unit);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500583 }
584}
585
586static int shutdown_unit(struct device *device, void *data)
587{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400588 device_unregister(device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500589
590 return 0;
591}
592
Stefan Richterc9755e12008-03-24 20:54:28 +0100593/*
594 * fw_device_rwsem acts as dual purpose mutex:
595 * - serializes accesses to fw_device_idr,
596 * - serializes accesses to fw_device.config_rom/.config_rom_length and
597 * fw_unit.directory, unless those accesses happen at safe occasions
598 */
599DECLARE_RWSEM(fw_device_rwsem);
600
Stefan Richterd6053e02008-11-24 20:40:00 +0100601DEFINE_IDR(fw_device_idr);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500602int fw_cdev_major;
603
Stefan Richter96b19062008-02-02 15:01:09 +0100604struct fw_device *fw_device_get_by_devt(dev_t devt)
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500605{
606 struct fw_device *device;
607
Stefan Richterc9755e12008-03-24 20:54:28 +0100608 down_read(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500609 device = idr_find(&fw_device_idr, MINOR(devt));
Stefan Richter96b19062008-02-02 15:01:09 +0100610 if (device)
611 fw_device_get(device);
Stefan Richterc9755e12008-03-24 20:54:28 +0100612 up_read(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500613
614 return device;
615}
616
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400617/*
618 * These defines control the retry behavior for reading the config
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500619 * rom. It shouldn't be necessary to tweak these; if the device
620 * doesn't respond to a config rom read within 10 seconds, it's not
621 * going to respond at all. As for the initial delay, a lot of
622 * devices will be able to respond within half a second after bus
623 * reset. On the other hand, it's not really worth being more
624 * aggressive than that, since it scales pretty well; if 10 devices
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400625 * are plugged in, they're all getting read within one second.
626 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500627
Kristian Høgsbergc5dfd0a2007-03-27 01:43:43 -0400628#define MAX_RETRIES 10
629#define RETRY_DELAY (3 * HZ)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500630#define INITIAL_DELAY (HZ / 2)
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100631#define SHUTDOWN_DELAY (2 * HZ)
632
633static void fw_device_shutdown(struct work_struct *work)
634{
635 struct fw_device *device =
636 container_of(work, struct fw_device, work.work);
637 int minor = MINOR(device->device.devt);
638
Stefan Richtere747a5c2009-01-24 20:35:38 +0100639 if (time_is_after_jiffies(device->card->reset_jiffies + SHUTDOWN_DELAY)
640 && !list_empty(&device->card->link)) {
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100641 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
642 return;
643 }
644
645 if (atomic_cmpxchg(&device->state,
646 FW_DEVICE_GONE,
647 FW_DEVICE_SHUTDOWN) != FW_DEVICE_GONE)
648 return;
649
650 fw_device_cdev_remove(device);
651 device_for_each_child(&device->device, NULL, shutdown_unit);
652 device_unregister(&device->device);
653
654 down_write(&fw_device_rwsem);
655 idr_remove(&fw_device_idr, minor);
656 up_write(&fw_device_rwsem);
657
658 fw_device_put(device);
659}
660
Stefan Richteraed80892009-01-17 22:45:54 +0100661static void fw_device_release(struct device *dev)
662{
663 struct fw_device *device = fw_device(dev);
664 struct fw_card *card = device->card;
665 unsigned long flags;
666
667 /*
668 * Take the card lock so we don't set this to NULL while a
669 * FW_NODE_UPDATED callback is being handled or while the
670 * bus manager work looks at this node.
671 */
672 spin_lock_irqsave(&card->lock, flags);
673 device->node->data = NULL;
674 spin_unlock_irqrestore(&card->lock, flags);
675
676 fw_node_put(device->node);
677 kfree(device->config_rom);
678 kfree(device);
679 fw_card_put(card);
680}
681
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100682static struct device_type fw_device_type = {
Stefan Richteraed80892009-01-17 22:45:54 +0100683 .release = fw_device_release,
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100684};
685
Stefan Richteraed80892009-01-17 22:45:54 +0100686static int update_unit(struct device *dev, void *data)
687{
688 struct fw_unit *unit = fw_unit(dev);
689 struct fw_driver *driver = (struct fw_driver *)dev->driver;
690
691 if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
692 down(&dev->sem);
693 driver->update(unit);
694 up(&dev->sem);
695 }
696
697 return 0;
698}
699
700static void fw_device_update(struct work_struct *work)
701{
702 struct fw_device *device =
703 container_of(work, struct fw_device, work.work);
704
705 fw_device_cdev_update(device);
706 device_for_each_child(&device->device, NULL, update_unit);
707}
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100708
709/*
710 * If a device was pending for deletion because its node went away but its
711 * bus info block and root directory header matches that of a newly discovered
712 * device, revive the existing fw_device.
713 * The newly allocated fw_device becomes obsolete instead.
714 */
715static int lookup_existing_device(struct device *dev, void *data)
716{
717 struct fw_device *old = fw_device(dev);
718 struct fw_device *new = data;
719 struct fw_card *card = new->card;
720 int match = 0;
721
722 down_read(&fw_device_rwsem); /* serialize config_rom access */
723 spin_lock_irq(&card->lock); /* serialize node access */
724
725 if (memcmp(old->config_rom, new->config_rom, 6 * 4) == 0 &&
726 atomic_cmpxchg(&old->state,
727 FW_DEVICE_GONE,
728 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
729 struct fw_node *current_node = new->node;
730 struct fw_node *obsolete_node = old->node;
731
732 new->node = obsolete_node;
733 new->node->data = new;
734 old->node = current_node;
735 old->node->data = old;
736
737 old->max_speed = new->max_speed;
738 old->node_id = current_node->node_id;
739 smp_wmb(); /* update node_id before generation */
740 old->generation = card->generation;
741 old->config_rom_retries = 0;
742 fw_notify("rediscovered device %s\n", dev_name(dev));
743
744 PREPARE_DELAYED_WORK(&old->work, fw_device_update);
745 schedule_delayed_work(&old->work, 0);
746
747 if (current_node == card->root_node)
748 fw_schedule_bm_work(card, 0);
749
750 match = 1;
751 }
752
753 spin_unlock_irq(&card->lock);
754 up_read(&fw_device_rwsem);
755
756 return match;
757}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500758
Stefan Richter7889b602009-03-10 21:09:28 +0100759enum { BC_UNKNOWN = 0, BC_UNIMPLEMENTED, BC_IMPLEMENTED, };
760
761void fw_device_set_broadcast_channel(struct fw_device *device, int generation)
762{
763 struct fw_card *card = device->card;
764 __be32 data;
765 int rcode;
766
767 if (!card->broadcast_channel_allocated)
768 return;
769
770 if (device->bc_implemented == BC_UNKNOWN) {
771 rcode = fw_run_transaction(card, TCODE_READ_QUADLET_REQUEST,
772 device->node_id, generation, device->max_speed,
773 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
774 &data, 4);
775 switch (rcode) {
776 case RCODE_COMPLETE:
777 if (data & cpu_to_be32(1 << 31)) {
778 device->bc_implemented = BC_IMPLEMENTED;
779 break;
780 }
781 /* else fall through to case address error */
782 case RCODE_ADDRESS_ERROR:
783 device->bc_implemented = BC_UNIMPLEMENTED;
784 }
785 }
786
787 if (device->bc_implemented == BC_IMPLEMENTED) {
788 data = cpu_to_be32(BROADCAST_CHANNEL_INITIAL |
789 BROADCAST_CHANNEL_VALID);
790 fw_run_transaction(card, TCODE_WRITE_QUADLET_REQUEST,
791 device->node_id, generation, device->max_speed,
792 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
793 &data, 4);
794 }
795}
796
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500797static void fw_device_init(struct work_struct *work)
798{
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500799 struct fw_device *device =
800 container_of(work, struct fw_device, work.work);
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100801 struct device *revived_dev;
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100802 int minor, ret;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500803
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400804 /*
805 * All failure paths here set node->data to NULL, so that we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500806 * don't try to do device_for_each_child() on a kfree()'d
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400807 * device.
808 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500809
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100810 if (read_bus_info_block(device, device->generation) < 0) {
Stefan Richter855c6032008-02-27 22:14:27 +0100811 if (device->config_rom_retries < MAX_RETRIES &&
812 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500813 device->config_rom_retries++;
814 schedule_delayed_work(&device->work, RETRY_DELAY);
815 } else {
Stefan Richter907293d2007-01-23 21:11:43 +0100816 fw_notify("giving up on config rom for node id %x\n",
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500817 device->node_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500818 if (device->node == device->card->root_node)
Jay Fenlason0fa19862008-11-29 17:44:57 +0100819 fw_schedule_bm_work(device->card, 0);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500820 fw_device_release(&device->device);
821 }
822 return;
823 }
824
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100825 revived_dev = device_find_child(device->card->device,
826 device, lookup_existing_device);
827 if (revived_dev) {
828 put_device(revived_dev);
829 fw_device_release(&device->device);
830
831 return;
832 }
833
Stefan Richter62305822009-01-09 20:49:37 +0100834 device_initialize(&device->device);
Stefan Richter96b19062008-02-02 15:01:09 +0100835
836 fw_device_get(device);
Stefan Richterc9755e12008-03-24 20:54:28 +0100837 down_write(&fw_device_rwsem);
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100838 ret = idr_pre_get(&fw_device_idr, GFP_KERNEL) ?
Stefan Richter62305822009-01-09 20:49:37 +0100839 idr_get_new(&fw_device_idr, device, &minor) :
840 -ENOMEM;
Stefan Richterc9755e12008-03-24 20:54:28 +0100841 up_write(&fw_device_rwsem);
Stefan Richter96b19062008-02-02 15:01:09 +0100842
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100843 if (ret < 0)
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500844 goto error;
845
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500846 device->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400847 device->device.type = &fw_device_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500848 device->device.parent = device->card->device;
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500849 device->device.devt = MKDEV(fw_cdev_major, minor);
Kay Sieversa1f64812008-10-30 01:41:56 +0100850 dev_set_name(&device->device, "fw%d", minor);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500851
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400852 init_fw_attribute_group(&device->device,
853 fw_device_attributes,
854 &device->attribute_group);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500855 if (device_add(&device->device)) {
856 fw_error("Failed to add device.\n");
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500857 goto error_with_cdev;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500858 }
859
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500860 create_units(device);
861
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400862 /*
863 * Transition the device to running state. If it got pulled
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500864 * out from under us while we did the intialization work, we
865 * have to shut down the device again here. Normally, though,
866 * fw_node_event will be responsible for shutting it down when
867 * necessary. We have to use the atomic cmpxchg here to avoid
868 * racing with the FW_NODE_DESTROYED case in
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400869 * fw_node_event().
870 */
Stefan Richter641f8792007-01-27 10:34:55 +0100871 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100872 FW_DEVICE_INITIALIZING,
873 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
874 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
875 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
Stefan Richterfa6e6972008-02-03 23:03:00 +0100876 } else {
877 if (device->config_rom_retries)
878 fw_notify("created device %s: GUID %08x%08x, S%d00, "
879 "%d config ROM retries\n",
Kay Sieversa1f64812008-10-30 01:41:56 +0100880 dev_name(&device->device),
Stefan Richterfa6e6972008-02-03 23:03:00 +0100881 device->config_rom[3], device->config_rom[4],
882 1 << device->max_speed,
883 device->config_rom_retries);
884 else
885 fw_notify("created device %s: GUID %08x%08x, S%d00\n",
Kay Sieversa1f64812008-10-30 01:41:56 +0100886 dev_name(&device->device),
Stefan Richterfa6e6972008-02-03 23:03:00 +0100887 device->config_rom[3], device->config_rom[4],
888 1 << device->max_speed);
Stefan Richterc9755e12008-03-24 20:54:28 +0100889 device->config_rom_retries = 0;
Stefan Richter7889b602009-03-10 21:09:28 +0100890
891 fw_device_set_broadcast_channel(device, device->generation);
Stefan Richterfa6e6972008-02-03 23:03:00 +0100892 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500893
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400894 /*
895 * Reschedule the IRM work if we just finished reading the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500896 * root node config rom. If this races with a bus reset we
897 * just end up running the IRM work a couple of extra times -
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400898 * pretty harmless.
899 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500900 if (device->node == device->card->root_node)
Jay Fenlason0fa19862008-11-29 17:44:57 +0100901 fw_schedule_bm_work(device->card, 0);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500902
903 return;
904
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500905 error_with_cdev:
Stefan Richterc9755e12008-03-24 20:54:28 +0100906 down_write(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500907 idr_remove(&fw_device_idr, minor);
Stefan Richterc9755e12008-03-24 20:54:28 +0100908 up_write(&fw_device_rwsem);
Stefan Richter373b2ed2007-03-04 14:45:18 +0100909 error:
Stefan Richter96b19062008-02-02 15:01:09 +0100910 fw_device_put(device); /* fw_device_idr's reference */
911
912 put_device(&device->device); /* our reference */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500913}
914
Stefan Richterc9755e12008-03-24 20:54:28 +0100915enum {
916 REREAD_BIB_ERROR,
917 REREAD_BIB_GONE,
918 REREAD_BIB_UNCHANGED,
919 REREAD_BIB_CHANGED,
920};
921
922/* Reread and compare bus info block and header of root directory */
923static int reread_bus_info_block(struct fw_device *device, int generation)
924{
925 u32 q;
926 int i;
927
928 for (i = 0; i < 6; i++) {
929 if (read_rom(device, generation, i, &q) != RCODE_COMPLETE)
930 return REREAD_BIB_ERROR;
931
932 if (i == 0 && q == 0)
933 return REREAD_BIB_GONE;
934
Stefan Richterd01b0172009-01-17 22:45:54 +0100935 if (q != device->config_rom[i])
Stefan Richterc9755e12008-03-24 20:54:28 +0100936 return REREAD_BIB_CHANGED;
937 }
938
939 return REREAD_BIB_UNCHANGED;
940}
941
942static void fw_device_refresh(struct work_struct *work)
943{
944 struct fw_device *device =
945 container_of(work, struct fw_device, work.work);
946 struct fw_card *card = device->card;
947 int node_id = device->node_id;
948
949 switch (reread_bus_info_block(device, device->generation)) {
950 case REREAD_BIB_ERROR:
951 if (device->config_rom_retries < MAX_RETRIES / 2 &&
952 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
953 device->config_rom_retries++;
954 schedule_delayed_work(&device->work, RETRY_DELAY / 2);
955
956 return;
957 }
958 goto give_up;
959
960 case REREAD_BIB_GONE:
961 goto gone;
962
963 case REREAD_BIB_UNCHANGED:
964 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100965 FW_DEVICE_INITIALIZING,
966 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
Stefan Richterc9755e12008-03-24 20:54:28 +0100967 goto gone;
968
969 fw_device_update(work);
970 device->config_rom_retries = 0;
971 goto out;
972
973 case REREAD_BIB_CHANGED:
974 break;
975 }
976
977 /*
978 * Something changed. We keep things simple and don't investigate
979 * further. We just destroy all previous units and create new ones.
980 */
981 device_for_each_child(&device->device, NULL, shutdown_unit);
982
983 if (read_bus_info_block(device, device->generation) < 0) {
984 if (device->config_rom_retries < MAX_RETRIES &&
985 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
986 device->config_rom_retries++;
987 schedule_delayed_work(&device->work, RETRY_DELAY);
988
989 return;
990 }
991 goto give_up;
992 }
993
994 create_units(device);
995
996 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100997 FW_DEVICE_INITIALIZING,
998 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
Stefan Richterc9755e12008-03-24 20:54:28 +0100999 goto gone;
1000
Kay Sieversa1f64812008-10-30 01:41:56 +01001001 fw_notify("refreshed device %s\n", dev_name(&device->device));
Stefan Richterc9755e12008-03-24 20:54:28 +01001002 device->config_rom_retries = 0;
1003 goto out;
1004
1005 give_up:
Kay Sieversa1f64812008-10-30 01:41:56 +01001006 fw_notify("giving up on refresh of device %s\n", dev_name(&device->device));
Stefan Richterc9755e12008-03-24 20:54:28 +01001007 gone:
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001008 atomic_set(&device->state, FW_DEVICE_GONE);
1009 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1010 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
Stefan Richterc9755e12008-03-24 20:54:28 +01001011 out:
1012 if (node_id == card->root_node->node_id)
Jay Fenlason0fa19862008-11-29 17:44:57 +01001013 fw_schedule_bm_work(card, 0);
Stefan Richterc9755e12008-03-24 20:54:28 +01001014}
1015
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001016void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
1017{
1018 struct fw_device *device;
1019
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001020 switch (event) {
1021 case FW_NODE_CREATED:
1022 case FW_NODE_LINK_ON:
1023 if (!node->link_on)
1024 break;
Stefan Richterc9755e12008-03-24 20:54:28 +01001025 create:
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001026 device = kzalloc(sizeof(*device), GFP_ATOMIC);
1027 if (device == NULL)
1028 break;
1029
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001030 /*
1031 * Do minimal intialization of the device here, the
Stefan Richter62305822009-01-09 20:49:37 +01001032 * rest will happen in fw_device_init().
1033 *
1034 * Attention: A lot of things, even fw_device_get(),
1035 * cannot be done before fw_device_init() finished!
1036 * You can basically just check device->state and
1037 * schedule work until then, but only while holding
1038 * card->lock.
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001039 */
Stefan Richter641f8792007-01-27 10:34:55 +01001040 atomic_set(&device->state, FW_DEVICE_INITIALIZING);
Stefan Richter459f7922008-05-24 16:50:22 +02001041 device->card = fw_card_get(card);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001042 device->node = fw_node_get(node);
1043 device->node_id = node->node_id;
1044 device->generation = card->generation;
Stefan Richterd67cfb92008-10-05 10:37:11 +02001045 mutex_init(&device->client_list_mutex);
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -05001046 INIT_LIST_HEAD(&device->client_list);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001047
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001048 /*
1049 * Set the node data to point back to this device so
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001050 * FW_NODE_UPDATED callbacks can update the node_id
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001051 * and generation for the device.
1052 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001053 node->data = device;
1054
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001055 /*
1056 * Many devices are slow to respond after bus resets,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001057 * especially if they are bus powered and go through
1058 * power-up after getting plugged in. We schedule the
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001059 * first config rom scan half a second after bus reset.
1060 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001061 INIT_DELAYED_WORK(&device->work, fw_device_init);
1062 schedule_delayed_work(&device->work, INITIAL_DELAY);
1063 break;
1064
Stefan Richterc9755e12008-03-24 20:54:28 +01001065 case FW_NODE_INITIATED_RESET:
1066 device = node->data;
1067 if (device == NULL)
1068 goto create;
1069
1070 device->node_id = node->node_id;
1071 smp_wmb(); /* update node_id before generation */
1072 device->generation = card->generation;
1073 if (atomic_cmpxchg(&device->state,
1074 FW_DEVICE_RUNNING,
1075 FW_DEVICE_INITIALIZING) == FW_DEVICE_RUNNING) {
1076 PREPARE_DELAYED_WORK(&device->work, fw_device_refresh);
1077 schedule_delayed_work(&device->work,
1078 node == card->local_node ? 0 : INITIAL_DELAY);
1079 }
1080 break;
1081
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001082 case FW_NODE_UPDATED:
1083 if (!node->link_on || node->data == NULL)
1084 break;
1085
1086 device = node->data;
1087 device->node_id = node->node_id;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +01001088 smp_wmb(); /* update node_id before generation */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001089 device->generation = card->generation;
Kristian Høgsberg5f480472007-03-07 12:12:39 -05001090 if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
1091 PREPARE_DELAYED_WORK(&device->work, fw_device_update);
1092 schedule_delayed_work(&device->work, 0);
1093 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001094 break;
1095
1096 case FW_NODE_DESTROYED:
1097 case FW_NODE_LINK_OFF:
1098 if (!node->data)
1099 break;
1100
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001101 /*
1102 * Destroy the device associated with the node. There
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001103 * are two cases here: either the device is fully
1104 * initialized (FW_DEVICE_RUNNING) or we're in the
1105 * process of reading its config rom
1106 * (FW_DEVICE_INITIALIZING). If it is fully
1107 * initialized we can reuse device->work to schedule a
1108 * full fw_device_shutdown(). If not, there's work
1109 * scheduled to read it's config rom, and we just put
1110 * the device in shutdown state to have that code fail
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001111 * to create the device.
1112 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001113 device = node->data;
Stefan Richter641f8792007-01-27 10:34:55 +01001114 if (atomic_xchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001115 FW_DEVICE_GONE) == FW_DEVICE_RUNNING) {
Kristian Høgsberg5f480472007-03-07 12:12:39 -05001116 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
Stefan Richtere747a5c2009-01-24 20:35:38 +01001117 schedule_delayed_work(&device->work,
1118 list_empty(&card->link) ? 0 : SHUTDOWN_DELAY);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001119 }
1120 break;
1121 }
1122}