blob: e02bf2dff84591e5759c2b7a885d7649f67ec079 [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 Richterd54423c2010-02-18 01:50:31 +010021#include <linux/bug.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010022#include <linux/ctype.h>
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050023#include <linux/delay.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010024#include <linux/device.h>
25#include <linux/errno.h>
Stefan Richter77c9a5d2009-06-05 16:26:18 +020026#include <linux/firewire.h>
27#include <linux/firewire-constants.h>
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -050028#include <linux/idr.h>
Stefan Richter3d36a0d2009-01-17 22:45:54 +010029#include <linux/jiffies.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010030#include <linux/kobject.h>
31#include <linux/list.h>
Stefan Richterb3b29882009-02-15 23:12:34 +010032#include <linux/mod_devicetable.h>
Stefan Richtere8ca9702009-06-04 21:09:38 +020033#include <linux/module.h>
Stefan Richterd67cfb92008-10-05 10:37:11 +020034#include <linux/mutex.h>
Matthew Wilcox6188e102008-04-18 22:21:05 -040035#include <linux/rwsem.h>
36#include <linux/semaphore.h>
Jay Fenlasoncf417e542008-10-03 11:19:09 -040037#include <linux/spinlock.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010038#include <linux/string.h>
39#include <linux/workqueue.h>
40
Stefan Richtere8ca9702009-06-04 21:09:38 +020041#include <asm/atomic.h>
42#include <asm/byteorder.h>
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010043#include <asm/system.h>
Stefan Richter41f321c2009-01-17 22:45:54 +010044
Stefan Richter77c9a5d2009-06-05 16:26:18 +020045#include "core.h"
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050046
Stefan Richter13b302d2009-12-26 01:44:10 +010047void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050048{
49 ci->p = p + 1;
50 ci->end = ci->p + (p[0] >> 16);
51}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050052EXPORT_SYMBOL(fw_csr_iterator_init);
53
54int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value)
55{
56 *key = *ci->p >> 24;
57 *value = *ci->p & 0xffffff;
58
59 return ci->p++ < ci->end;
60}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050061EXPORT_SYMBOL(fw_csr_iterator_next);
62
Stefan Richter13b302d2009-12-26 01:44:10 +010063static const u32 *search_leaf(const u32 *directory, int search_key)
Clemens Ladisch1f8fef72009-12-24 11:59:57 +010064{
65 struct fw_csr_iterator ci;
66 int last_key = 0, key, value;
67
68 fw_csr_iterator_init(&ci, directory);
69 while (fw_csr_iterator_next(&ci, &key, &value)) {
70 if (last_key == search_key &&
71 key == (CSR_DESCRIPTOR | CSR_LEAF))
72 return ci.p - 1 + value;
Stefan Richter3c2c58c2009-12-26 01:43:21 +010073
Clemens Ladisch1f8fef72009-12-24 11:59:57 +010074 last_key = key;
75 }
Stefan Richter3c2c58c2009-12-26 01:43:21 +010076
Clemens Ladisch1f8fef72009-12-24 11:59:57 +010077 return NULL;
78}
79
Stefan Richter13b302d2009-12-26 01:44:10 +010080static int textual_leaf_to_string(const u32 *block, char *buf, size_t size)
Clemens Ladisch1f8fef72009-12-24 11:59:57 +010081{
Stefan Richter3c2c58c2009-12-26 01:43:21 +010082 unsigned int quadlets, i;
83 char c;
Clemens Ladisch1f8fef72009-12-24 11:59:57 +010084
85 if (!size || !buf)
86 return -EINVAL;
87
Stefan Richter3c2c58c2009-12-26 01:43:21 +010088 quadlets = min(block[0] >> 16, 256U);
Clemens Ladisch1f8fef72009-12-24 11:59:57 +010089 if (quadlets < 2)
90 return -ENODATA;
91
92 if (block[1] != 0 || block[2] != 0)
93 /* unknown language/character set */
94 return -ENODATA;
95
96 block += 3;
97 quadlets -= 2;
Stefan Richter3c2c58c2009-12-26 01:43:21 +010098 for (i = 0; i < quadlets * 4 && i < size - 1; i++) {
99 c = block[i / 4] >> (24 - 8 * (i % 4));
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100100 if (c == '\0')
101 break;
Stefan Richter3c2c58c2009-12-26 01:43:21 +0100102 buf[i] = c;
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100103 }
Stefan Richter3c2c58c2009-12-26 01:43:21 +0100104 buf[i] = '\0';
105
106 return i;
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100107}
108
109/**
110 * fw_csr_string - reads a string from the configuration ROM
Stefan Richter3c2c58c2009-12-26 01:43:21 +0100111 * @directory: e.g. root directory or unit directory
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100112 * @key: the key of the preceding directory entry
113 * @buf: where to put the string
114 * @size: size of @buf, in bytes
115 *
Stefan Richter3c2c58c2009-12-26 01:43:21 +0100116 * The string is taken from a minimal ASCII text descriptor leaf after
117 * the immediate entry with @key. The string is zero-terminated.
118 * Returns strlen(buf) or a negative error code.
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100119 */
Stefan Richter13b302d2009-12-26 01:44:10 +0100120int fw_csr_string(const u32 *directory, int key, char *buf, size_t size)
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100121{
Stefan Richter13b302d2009-12-26 01:44:10 +0100122 const u32 *leaf = search_leaf(directory, key);
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100123 if (!leaf)
124 return -ENOENT;
Stefan Richter3c2c58c2009-12-26 01:43:21 +0100125
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100126 return textual_leaf_to_string(leaf, buf, size);
127}
128EXPORT_SYMBOL(fw_csr_string);
129
Stefan Richter099d5412009-06-06 18:37:25 +0200130static bool is_fw_unit(struct device *dev);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500131
Stefan Richter13b302d2009-12-26 01:44:10 +0100132static int match_unit_directory(const u32 *directory, u32 match_flags,
Stefan Richterb3b29882009-02-15 23:12:34 +0100133 const struct ieee1394_device_id *id)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500134{
135 struct fw_csr_iterator ci;
136 int key, value, match;
137
138 match = 0;
139 fw_csr_iterator_init(&ci, directory);
140 while (fw_csr_iterator_next(&ci, &key, &value)) {
Stefan Richterb3b29882009-02-15 23:12:34 +0100141 if (key == CSR_VENDOR && value == id->vendor_id)
142 match |= IEEE1394_MATCH_VENDOR_ID;
143 if (key == CSR_MODEL && value == id->model_id)
144 match |= IEEE1394_MATCH_MODEL_ID;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500145 if (key == CSR_SPECIFIER_ID && value == id->specifier_id)
Stefan Richterb3b29882009-02-15 23:12:34 +0100146 match |= IEEE1394_MATCH_SPECIFIER_ID;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500147 if (key == CSR_VERSION && value == id->version)
Stefan Richterb3b29882009-02-15 23:12:34 +0100148 match |= IEEE1394_MATCH_VERSION;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500149 }
150
Stefan Richtere41f8d72009-02-16 00:22:05 +0100151 return (match & match_flags) == match_flags;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500152}
153
154static int fw_unit_match(struct device *dev, struct device_driver *drv)
155{
156 struct fw_unit *unit = fw_unit(dev);
Stefan Richtere41f8d72009-02-16 00:22:05 +0100157 struct fw_device *device;
158 const struct ieee1394_device_id *id;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500159
160 /* We only allow binding to fw_units. */
161 if (!is_fw_unit(dev))
162 return 0;
163
Stefan Richtere5110d02009-06-06 18:35:27 +0200164 device = fw_parent_device(unit);
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200165 id = container_of(drv, struct fw_driver, driver)->id_table;
Stefan Richtere41f8d72009-02-16 00:22:05 +0100166
Stefan Richter77c9a5d2009-06-05 16:26:18 +0200167 for (; id->match_flags != 0; id++) {
Stefan Richtere41f8d72009-02-16 00:22:05 +0100168 if (match_unit_directory(unit->directory, id->match_flags, id))
169 return 1;
170
171 /* Also check vendor ID in the root directory. */
172 if ((id->match_flags & IEEE1394_MATCH_VENDOR_ID) &&
173 match_unit_directory(&device->config_rom[5],
174 IEEE1394_MATCH_VENDOR_ID, id) &&
175 match_unit_directory(unit->directory, id->match_flags
176 & ~IEEE1394_MATCH_VENDOR_ID, id))
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500177 return 1;
178 }
179
180 return 0;
181}
182
183static int get_modalias(struct fw_unit *unit, char *buffer, size_t buffer_size)
184{
Stefan Richtere5110d02009-06-06 18:35:27 +0200185 struct fw_device *device = fw_parent_device(unit);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500186 struct fw_csr_iterator ci;
187
188 int key, value;
189 int vendor = 0;
190 int model = 0;
191 int specifier_id = 0;
192 int version = 0;
193
194 fw_csr_iterator_init(&ci, &device->config_rom[5]);
195 while (fw_csr_iterator_next(&ci, &key, &value)) {
196 switch (key) {
197 case CSR_VENDOR:
198 vendor = value;
199 break;
200 case CSR_MODEL:
201 model = value;
202 break;
203 }
204 }
205
206 fw_csr_iterator_init(&ci, unit->directory);
207 while (fw_csr_iterator_next(&ci, &key, &value)) {
208 switch (key) {
209 case CSR_SPECIFIER_ID:
210 specifier_id = value;
211 break;
212 case CSR_VERSION:
213 version = value;
214 break;
215 }
216 }
217
218 return snprintf(buffer, buffer_size,
219 "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
220 vendor, model, specifier_id, version);
221}
222
Stefan Richter53dca512008-12-14 21:47:04 +0100223static int fw_unit_uevent(struct device *dev, struct kobj_uevent_env *env)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500224{
225 struct fw_unit *unit = fw_unit(dev);
226 char modalias[64];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500227
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400228 get_modalias(unit, modalias, sizeof(modalias));
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500229
Kay Sievers7eff2e72007-08-14 15:15:12 +0200230 if (add_uevent_var(env, "MODALIAS=%s", modalias))
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500231 return -ENOMEM;
232
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500233 return 0;
234}
235
236struct bus_type fw_bus_type = {
Kristian Høgsberg362c2c82007-02-06 14:49:37 -0500237 .name = "firewire",
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500238 .match = fw_unit_match,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500239};
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500240EXPORT_SYMBOL(fw_bus_type);
241
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500242int fw_device_enable_phys_dma(struct fw_device *device)
243{
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100244 int generation = device->generation;
245
246 /* device->node_id, accessed below, must not be older than generation */
247 smp_rmb();
248
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500249 return device->card->driver->enable_phys_dma(device->card,
250 device->node_id,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100251 generation);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500252}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500253EXPORT_SYMBOL(fw_device_enable_phys_dma);
254
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400255struct config_rom_attribute {
256 struct device_attribute attr;
257 u32 key;
258};
259
Stefan Richter53dca512008-12-14 21:47:04 +0100260static ssize_t show_immediate(struct device *dev,
261 struct device_attribute *dattr, char *buf)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400262{
263 struct config_rom_attribute *attr =
264 container_of(dattr, struct config_rom_attribute, attr);
265 struct fw_csr_iterator ci;
Stefan Richter13b302d2009-12-26 01:44:10 +0100266 const u32 *dir;
Stefan Richterc9755e12008-03-24 20:54:28 +0100267 int key, value, ret = -ENOENT;
268
269 down_read(&fw_device_rwsem);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400270
271 if (is_fw_unit(dev))
272 dir = fw_unit(dev)->directory;
273 else
274 dir = fw_device(dev)->config_rom + 5;
275
276 fw_csr_iterator_init(&ci, dir);
277 while (fw_csr_iterator_next(&ci, &key, &value))
Stefan Richterc9755e12008-03-24 20:54:28 +0100278 if (attr->key == key) {
279 ret = snprintf(buf, buf ? PAGE_SIZE : 0,
280 "0x%06x\n", value);
281 break;
282 }
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400283
Stefan Richterc9755e12008-03-24 20:54:28 +0100284 up_read(&fw_device_rwsem);
285
286 return ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400287}
288
289#define IMMEDIATE_ATTR(name, key) \
290 { __ATTR(name, S_IRUGO, show_immediate, NULL), key }
291
Stefan Richter53dca512008-12-14 21:47:04 +0100292static ssize_t show_text_leaf(struct device *dev,
293 struct device_attribute *dattr, char *buf)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400294{
295 struct config_rom_attribute *attr =
296 container_of(dattr, struct config_rom_attribute, attr);
Stefan Richter13b302d2009-12-26 01:44:10 +0100297 const u32 *dir;
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100298 size_t bufsize;
299 char dummy_buf[2];
300 int ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400301
Stefan Richterc9755e12008-03-24 20:54:28 +0100302 down_read(&fw_device_rwsem);
303
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400304 if (is_fw_unit(dev))
305 dir = fw_unit(dev)->directory;
306 else
307 dir = fw_device(dev)->config_rom + 5;
308
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100309 if (buf) {
310 bufsize = PAGE_SIZE - 1;
311 } else {
312 buf = dummy_buf;
313 bufsize = 1;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400314 }
315
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100316 ret = fw_csr_string(dir, attr->key, buf, bufsize);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400317
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100318 if (ret >= 0) {
319 /* Strip trailing whitespace and add newline. */
320 while (ret > 0 && isspace(buf[ret - 1]))
321 ret--;
322 strcpy(buf + ret, "\n");
323 ret++;
Stefan Richterc9755e12008-03-24 20:54:28 +0100324 }
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400325
Stefan Richterc9755e12008-03-24 20:54:28 +0100326 up_read(&fw_device_rwsem);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400327
Stefan Richterc9755e12008-03-24 20:54:28 +0100328 return ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400329}
330
331#define TEXT_LEAF_ATTR(name, key) \
332 { __ATTR(name, S_IRUGO, show_text_leaf, NULL), key }
333
334static struct config_rom_attribute config_rom_attributes[] = {
335 IMMEDIATE_ATTR(vendor, CSR_VENDOR),
336 IMMEDIATE_ATTR(hardware_version, CSR_HARDWARE_VERSION),
337 IMMEDIATE_ATTR(specifier_id, CSR_SPECIFIER_ID),
338 IMMEDIATE_ATTR(version, CSR_VERSION),
339 IMMEDIATE_ATTR(model, CSR_MODEL),
340 TEXT_LEAF_ATTR(vendor_name, CSR_VENDOR),
341 TEXT_LEAF_ATTR(model_name, CSR_MODEL),
342 TEXT_LEAF_ATTR(hardware_version_name, CSR_HARDWARE_VERSION),
343};
344
Stefan Richter53dca512008-12-14 21:47:04 +0100345static void init_fw_attribute_group(struct device *dev,
346 struct device_attribute *attrs,
347 struct fw_attribute_group *group)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400348{
349 struct device_attribute *attr;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400350 int i, j;
351
352 for (j = 0; attrs[j].attr.name != NULL; j++)
353 group->attrs[j] = &attrs[j].attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400354
355 for (i = 0; i < ARRAY_SIZE(config_rom_attributes); i++) {
356 attr = &config_rom_attributes[i].attr;
357 if (attr->show(dev, attr, NULL) < 0)
358 continue;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400359 group->attrs[j++] = &attr->attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400360 }
361
Stefan Richtere5333db2009-05-22 23:16:27 +0200362 group->attrs[j] = NULL;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400363 group->groups[0] = &group->group;
364 group->groups[1] = NULL;
365 group->group.attrs = group->attrs;
David Brownella4dbd672009-06-24 10:06:31 -0700366 dev->groups = (const struct attribute_group **) group->groups;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400367}
368
Stefan Richter53dca512008-12-14 21:47:04 +0100369static ssize_t modalias_show(struct device *dev,
370 struct device_attribute *attr, char *buf)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500371{
372 struct fw_unit *unit = fw_unit(dev);
373 int length;
374
375 length = get_modalias(unit, buf, PAGE_SIZE);
376 strcpy(buf + length, "\n");
377
378 return length + 1;
379}
380
Stefan Richter53dca512008-12-14 21:47:04 +0100381static ssize_t rom_index_show(struct device *dev,
382 struct device_attribute *attr, char *buf)
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500383{
384 struct fw_device *device = fw_device(dev->parent);
385 struct fw_unit *unit = fw_unit(dev);
386
387 return snprintf(buf, PAGE_SIZE, "%d\n",
Stefan Richterd84702a2007-03-20 19:42:15 +0100388 (int)(unit->directory - device->config_rom));
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500389}
390
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400391static struct device_attribute fw_unit_attributes[] = {
392 __ATTR_RO(modalias),
393 __ATTR_RO(rom_index),
394 __ATTR_NULL,
395};
396
Stefan Richter53dca512008-12-14 21:47:04 +0100397static ssize_t config_rom_show(struct device *dev,
398 struct device_attribute *attr, char *buf)
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400399{
400 struct fw_device *device = fw_device(dev);
Stefan Richterc9755e12008-03-24 20:54:28 +0100401 size_t length;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400402
Stefan Richterc9755e12008-03-24 20:54:28 +0100403 down_read(&fw_device_rwsem);
404 length = device->config_rom_length * 4;
405 memcpy(buf, device->config_rom, length);
406 up_read(&fw_device_rwsem);
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400407
Stefan Richterc9755e12008-03-24 20:54:28 +0100408 return length;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400409}
410
Stefan Richter53dca512008-12-14 21:47:04 +0100411static ssize_t guid_show(struct device *dev,
412 struct device_attribute *attr, char *buf)
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400413{
414 struct fw_device *device = fw_device(dev);
Stefan Richterc9755e12008-03-24 20:54:28 +0100415 int ret;
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400416
Stefan Richterc9755e12008-03-24 20:54:28 +0100417 down_read(&fw_device_rwsem);
418 ret = snprintf(buf, PAGE_SIZE, "0x%08x%08x\n",
419 device->config_rom[3], device->config_rom[4]);
420 up_read(&fw_device_rwsem);
421
422 return ret;
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400423}
424
Stefan Richter13b302d2009-12-26 01:44:10 +0100425static int units_sprintf(char *buf, const u32 *directory)
Stefan Richter0210b662009-05-23 00:03:29 +0200426{
427 struct fw_csr_iterator ci;
428 int key, value;
429 int specifier_id = 0;
430 int version = 0;
431
432 fw_csr_iterator_init(&ci, directory);
433 while (fw_csr_iterator_next(&ci, &key, &value)) {
434 switch (key) {
435 case CSR_SPECIFIER_ID:
436 specifier_id = value;
437 break;
438 case CSR_VERSION:
439 version = value;
440 break;
441 }
442 }
443
444 return sprintf(buf, "0x%06x:0x%06x ", specifier_id, version);
445}
446
447static ssize_t units_show(struct device *dev,
448 struct device_attribute *attr, char *buf)
449{
450 struct fw_device *device = fw_device(dev);
451 struct fw_csr_iterator ci;
452 int key, value, i = 0;
453
454 down_read(&fw_device_rwsem);
455 fw_csr_iterator_init(&ci, &device->config_rom[5]);
456 while (fw_csr_iterator_next(&ci, &key, &value)) {
457 if (key != (CSR_UNIT | CSR_DIRECTORY))
458 continue;
459 i += units_sprintf(&buf[i], ci.p + value - 1);
460 if (i >= PAGE_SIZE - (8 + 1 + 8 + 1))
461 break;
462 }
463 up_read(&fw_device_rwsem);
464
465 if (i)
466 buf[i - 1] = '\n';
467
468 return i;
469}
470
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400471static struct device_attribute fw_device_attributes[] = {
472 __ATTR_RO(config_rom),
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400473 __ATTR_RO(guid),
Stefan Richter0210b662009-05-23 00:03:29 +0200474 __ATTR_RO(units),
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400475 __ATTR_NULL,
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500476};
477
Stefan Richter53dca512008-12-14 21:47:04 +0100478static int read_rom(struct fw_device *device,
479 int generation, int index, u32 *data)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500480{
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200481 int rcode;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100482
483 /* device->node_id, accessed below, must not be older than generation */
484 smp_rmb();
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500485
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200486 rcode = fw_run_transaction(device->card, TCODE_READ_QUADLET_REQUEST,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100487 device->node_id, generation, device->max_speed,
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200488 (CSR_REGISTER_BASE | CSR_CONFIG_ROM) + index * 4,
489 data, 4);
490 be32_to_cpus(data);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500491
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200492 return rcode;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500493}
494
Stefan Richter1dadff72008-03-02 19:35:42 +0100495#define READ_BIB_ROM_SIZE 256
496#define READ_BIB_STACK_SIZE 16
497
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100498/*
499 * Read the bus info block, perform a speed probe, and read all of the rest of
500 * the config ROM. We do all this with a cached bus generation. If the bus
501 * generation changes under us, read_bus_info_block will fail and get retried.
502 * It's better to start all over in this case because the node from which we
503 * are reading the ROM may have changed the ROM during the reset.
504 */
505static int read_bus_info_block(struct fw_device *device, int generation)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500506{
Stefan Richter13b302d2009-12-26 01:44:10 +0100507 const u32 *old_rom, *new_rom;
508 u32 *rom, *stack;
Stefan Richter1dadff72008-03-02 19:35:42 +0100509 u32 sp, key;
510 int i, end, length, ret = -1;
511
512 rom = kmalloc(sizeof(*rom) * READ_BIB_ROM_SIZE +
513 sizeof(*stack) * READ_BIB_STACK_SIZE, GFP_KERNEL);
514 if (rom == NULL)
515 return -ENOMEM;
516
517 stack = &rom[READ_BIB_ROM_SIZE];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500518
Stefan Richterf1397492007-06-10 21:31:36 +0200519 device->max_speed = SCODE_100;
520
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500521 /* First read the bus info block. */
522 for (i = 0; i < 5; i++) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100523 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100524 goto out;
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400525 /*
526 * As per IEEE1212 7.2, during power-up, devices can
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500527 * reply with a 0 for the first quadlet of the config
528 * rom to indicate that they are booting (for example,
529 * if the firmware is on the disk of a external
530 * harddisk). In that case we just fail, and the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400531 * retry mechanism will try again later.
532 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500533 if (i == 0 && rom[i] == 0)
Stefan Richter1dadff72008-03-02 19:35:42 +0100534 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500535 }
536
Stefan Richterf1397492007-06-10 21:31:36 +0200537 device->max_speed = device->node->max_speed;
538
539 /*
540 * Determine the speed of
541 * - devices with link speed less than PHY speed,
542 * - devices with 1394b PHY (unless only connected to 1394a PHYs),
543 * - all devices if there are 1394b repeaters.
544 * Note, we cannot use the bus info block's link_spd as starting point
545 * because some buggy firmwares set it lower than necessary and because
546 * 1394-1995 nodes do not have the field.
547 */
548 if ((rom[2] & 0x7) < device->max_speed ||
549 device->max_speed == SCODE_BETA ||
550 device->card->beta_repeaters_present) {
551 u32 dummy;
552
553 /* for S1600 and S3200 */
554 if (device->max_speed == SCODE_BETA)
555 device->max_speed = device->card->link_speed;
556
557 while (device->max_speed > SCODE_100) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100558 if (read_rom(device, generation, 0, &dummy) ==
559 RCODE_COMPLETE)
Stefan Richterf1397492007-06-10 21:31:36 +0200560 break;
561 device->max_speed--;
562 }
563 }
564
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400565 /*
566 * Now parse the config rom. The config rom is a recursive
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500567 * directory structure so we parse it using a stack of
568 * references to the blocks that make up the structure. We
569 * push a reference to the root directory on the stack to
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400570 * start things off.
571 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500572 length = i;
573 sp = 0;
574 stack[sp++] = 0xc0000005;
575 while (sp > 0) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400576 /*
577 * Pop the next block reference of the stack. The
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500578 * lower 24 bits is the offset into the config rom,
579 * the upper 8 bits are the type of the reference the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400580 * block.
581 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500582 key = stack[--sp];
583 i = key & 0xffffff;
Stefan Richterd54423c2010-02-18 01:50:31 +0100584 if (WARN_ON(i >= READ_BIB_ROM_SIZE))
Stefan Richter1dadff72008-03-02 19:35:42 +0100585 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500586
587 /* Read header quadlet for the block to get the length. */
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100588 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100589 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500590 end = i + (rom[i] >> 16) + 1;
591 i++;
Stefan Richter1dadff72008-03-02 19:35:42 +0100592 if (end > READ_BIB_ROM_SIZE)
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400593 /*
594 * This block extends outside standard config
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500595 * area (and the array we're reading it
596 * into). That's broken, so ignore this
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400597 * device.
598 */
Stefan Richter1dadff72008-03-02 19:35:42 +0100599 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500600
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400601 /*
602 * Now read in the block. If this is a directory
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500603 * block, check the entries as we read them to see if
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400604 * it references another block, and push it in that case.
605 */
Stefan Richterd54423c2010-02-18 01:50:31 +0100606 for (; i < end; i++) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100607 if (read_rom(device, generation, i, &rom[i]) !=
608 RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100609 goto out;
Stefan Richterd54423c2010-02-18 01:50:31 +0100610
611 if ((key >> 30) != 3 || (rom[i] >> 30) < 2 ||
612 sp >= READ_BIB_STACK_SIZE)
613 continue;
614 /*
615 * Offset points outside the ROM. May be a firmware
616 * bug or an Extended ROM entry (IEEE 1212-2001 clause
617 * 7.7.18). Simply overwrite this pointer here by a
618 * fake immediate entry so that later iterators over
619 * the ROM don't have to check offsets all the time.
620 */
621 if (i + (rom[i] & 0xffffff) >= READ_BIB_ROM_SIZE) {
622 fw_error("skipped unsupported ROM entry %x at %llx\n",
623 rom[i],
624 i * 4 | CSR_REGISTER_BASE | CSR_CONFIG_ROM);
625 rom[i] = 0;
626 continue;
627 }
628 stack[sp++] = i + rom[i];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500629 }
630 if (length < i)
631 length = i;
632 }
633
Stefan Richterc9755e12008-03-24 20:54:28 +0100634 old_rom = device->config_rom;
635 new_rom = kmemdup(rom, length * 4, GFP_KERNEL);
636 if (new_rom == NULL)
Stefan Richter1dadff72008-03-02 19:35:42 +0100637 goto out;
Stefan Richterc9755e12008-03-24 20:54:28 +0100638
639 down_write(&fw_device_rwsem);
640 device->config_rom = new_rom;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500641 device->config_rom_length = length;
Stefan Richterc9755e12008-03-24 20:54:28 +0100642 up_write(&fw_device_rwsem);
643
644 kfree(old_rom);
Stefan Richter1dadff72008-03-02 19:35:42 +0100645 ret = 0;
Stefan Richter837ec782009-06-09 23:56:55 +0200646 device->max_rec = rom[2] >> 12 & 0xf;
647 device->cmc = rom[2] >> 30 & 1;
648 device->irmc = rom[2] >> 31 & 1;
Stefan Richter1dadff72008-03-02 19:35:42 +0100649 out:
650 kfree(rom);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500651
Stefan Richter1dadff72008-03-02 19:35:42 +0100652 return ret;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500653}
654
655static void fw_unit_release(struct device *dev)
656{
657 struct fw_unit *unit = fw_unit(dev);
658
659 kfree(unit);
660}
661
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400662static struct device_type fw_unit_type = {
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400663 .uevent = fw_unit_uevent,
664 .release = fw_unit_release,
665};
666
Stefan Richter099d5412009-06-06 18:37:25 +0200667static bool is_fw_unit(struct device *dev)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500668{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400669 return dev->type == &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500670}
671
672static void create_units(struct fw_device *device)
673{
674 struct fw_csr_iterator ci;
675 struct fw_unit *unit;
676 int key, value, i;
677
678 i = 0;
679 fw_csr_iterator_init(&ci, &device->config_rom[5]);
680 while (fw_csr_iterator_next(&ci, &key, &value)) {
681 if (key != (CSR_UNIT | CSR_DIRECTORY))
682 continue;
683
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400684 /*
685 * Get the address of the unit directory and try to
686 * match the drivers id_tables against it.
687 */
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400688 unit = kzalloc(sizeof(*unit), GFP_KERNEL);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500689 if (unit == NULL) {
690 fw_error("failed to allocate memory for unit\n");
691 continue;
692 }
693
694 unit->directory = ci.p + value - 1;
695 unit->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400696 unit->device.type = &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500697 unit->device.parent = &device->device;
Kay Sieversa1f64812008-10-30 01:41:56 +0100698 dev_set_name(&unit->device, "%s.%d", dev_name(&device->device), i++);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500699
Stefan Richtere5333db2009-05-22 23:16:27 +0200700 BUILD_BUG_ON(ARRAY_SIZE(unit->attribute_group.attrs) <
701 ARRAY_SIZE(fw_unit_attributes) +
702 ARRAY_SIZE(config_rom_attributes));
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400703 init_fw_attribute_group(&unit->device,
704 fw_unit_attributes,
705 &unit->attribute_group);
Stefan Richtere5333db2009-05-22 23:16:27 +0200706
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400707 if (device_register(&unit->device) < 0)
708 goto skip_unit;
709
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400710 continue;
711
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400712 skip_unit:
713 kfree(unit);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500714 }
715}
716
717static int shutdown_unit(struct device *device, void *data)
718{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400719 device_unregister(device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500720
721 return 0;
722}
723
Stefan Richterc9755e12008-03-24 20:54:28 +0100724/*
725 * fw_device_rwsem acts as dual purpose mutex:
726 * - serializes accesses to fw_device_idr,
727 * - serializes accesses to fw_device.config_rom/.config_rom_length and
728 * fw_unit.directory, unless those accesses happen at safe occasions
729 */
730DECLARE_RWSEM(fw_device_rwsem);
731
Stefan Richterd6053e02008-11-24 20:40:00 +0100732DEFINE_IDR(fw_device_idr);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500733int fw_cdev_major;
734
Stefan Richter96b19062008-02-02 15:01:09 +0100735struct fw_device *fw_device_get_by_devt(dev_t devt)
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500736{
737 struct fw_device *device;
738
Stefan Richterc9755e12008-03-24 20:54:28 +0100739 down_read(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500740 device = idr_find(&fw_device_idr, MINOR(devt));
Stefan Richter96b19062008-02-02 15:01:09 +0100741 if (device)
742 fw_device_get(device);
Stefan Richterc9755e12008-03-24 20:54:28 +0100743 up_read(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500744
745 return device;
746}
747
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400748/*
749 * These defines control the retry behavior for reading the config
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500750 * rom. It shouldn't be necessary to tweak these; if the device
751 * doesn't respond to a config rom read within 10 seconds, it's not
752 * going to respond at all. As for the initial delay, a lot of
753 * devices will be able to respond within half a second after bus
754 * reset. On the other hand, it's not really worth being more
755 * aggressive than that, since it scales pretty well; if 10 devices
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400756 * are plugged in, they're all getting read within one second.
757 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500758
Kristian Høgsbergc5dfd0a2007-03-27 01:43:43 -0400759#define MAX_RETRIES 10
760#define RETRY_DELAY (3 * HZ)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500761#define INITIAL_DELAY (HZ / 2)
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100762#define SHUTDOWN_DELAY (2 * HZ)
763
764static void fw_device_shutdown(struct work_struct *work)
765{
766 struct fw_device *device =
767 container_of(work, struct fw_device, work.work);
768 int minor = MINOR(device->device.devt);
769
Stefan Richtere747a5c2009-01-24 20:35:38 +0100770 if (time_is_after_jiffies(device->card->reset_jiffies + SHUTDOWN_DELAY)
771 && !list_empty(&device->card->link)) {
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100772 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
773 return;
774 }
775
776 if (atomic_cmpxchg(&device->state,
777 FW_DEVICE_GONE,
778 FW_DEVICE_SHUTDOWN) != FW_DEVICE_GONE)
779 return;
780
781 fw_device_cdev_remove(device);
782 device_for_each_child(&device->device, NULL, shutdown_unit);
783 device_unregister(&device->device);
784
785 down_write(&fw_device_rwsem);
786 idr_remove(&fw_device_idr, minor);
787 up_write(&fw_device_rwsem);
788
789 fw_device_put(device);
790}
791
Stefan Richteraed80892009-01-17 22:45:54 +0100792static void fw_device_release(struct device *dev)
793{
794 struct fw_device *device = fw_device(dev);
795 struct fw_card *card = device->card;
796 unsigned long flags;
797
798 /*
799 * Take the card lock so we don't set this to NULL while a
800 * FW_NODE_UPDATED callback is being handled or while the
801 * bus manager work looks at this node.
802 */
803 spin_lock_irqsave(&card->lock, flags);
804 device->node->data = NULL;
805 spin_unlock_irqrestore(&card->lock, flags);
806
807 fw_node_put(device->node);
808 kfree(device->config_rom);
809 kfree(device);
810 fw_card_put(card);
811}
812
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100813static struct device_type fw_device_type = {
Stefan Richteraed80892009-01-17 22:45:54 +0100814 .release = fw_device_release,
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100815};
816
Stefan Richter099d5412009-06-06 18:37:25 +0200817static bool is_fw_device(struct device *dev)
818{
819 return dev->type == &fw_device_type;
820}
821
Stefan Richteraed80892009-01-17 22:45:54 +0100822static int update_unit(struct device *dev, void *data)
823{
824 struct fw_unit *unit = fw_unit(dev);
825 struct fw_driver *driver = (struct fw_driver *)dev->driver;
826
827 if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
828 down(&dev->sem);
829 driver->update(unit);
830 up(&dev->sem);
831 }
832
833 return 0;
834}
835
836static void fw_device_update(struct work_struct *work)
837{
838 struct fw_device *device =
839 container_of(work, struct fw_device, work.work);
840
841 fw_device_cdev_update(device);
842 device_for_each_child(&device->device, NULL, update_unit);
843}
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100844
845/*
846 * If a device was pending for deletion because its node went away but its
847 * bus info block and root directory header matches that of a newly discovered
848 * device, revive the existing fw_device.
849 * The newly allocated fw_device becomes obsolete instead.
850 */
851static int lookup_existing_device(struct device *dev, void *data)
852{
853 struct fw_device *old = fw_device(dev);
854 struct fw_device *new = data;
855 struct fw_card *card = new->card;
856 int match = 0;
857
Stefan Richter099d5412009-06-06 18:37:25 +0200858 if (!is_fw_device(dev))
859 return 0;
860
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100861 down_read(&fw_device_rwsem); /* serialize config_rom access */
862 spin_lock_irq(&card->lock); /* serialize node access */
863
864 if (memcmp(old->config_rom, new->config_rom, 6 * 4) == 0 &&
865 atomic_cmpxchg(&old->state,
866 FW_DEVICE_GONE,
867 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
868 struct fw_node *current_node = new->node;
869 struct fw_node *obsolete_node = old->node;
870
871 new->node = obsolete_node;
872 new->node->data = new;
873 old->node = current_node;
874 old->node->data = old;
875
876 old->max_speed = new->max_speed;
877 old->node_id = current_node->node_id;
878 smp_wmb(); /* update node_id before generation */
879 old->generation = card->generation;
880 old->config_rom_retries = 0;
881 fw_notify("rediscovered device %s\n", dev_name(dev));
882
883 PREPARE_DELAYED_WORK(&old->work, fw_device_update);
884 schedule_delayed_work(&old->work, 0);
885
886 if (current_node == card->root_node)
887 fw_schedule_bm_work(card, 0);
888
889 match = 1;
890 }
891
892 spin_unlock_irq(&card->lock);
893 up_read(&fw_device_rwsem);
894
895 return match;
896}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500897
Stefan Richter7889b602009-03-10 21:09:28 +0100898enum { BC_UNKNOWN = 0, BC_UNIMPLEMENTED, BC_IMPLEMENTED, };
899
Stefan Richter099d5412009-06-06 18:37:25 +0200900static void set_broadcast_channel(struct fw_device *device, int generation)
Stefan Richter7889b602009-03-10 21:09:28 +0100901{
902 struct fw_card *card = device->card;
903 __be32 data;
904 int rcode;
905
906 if (!card->broadcast_channel_allocated)
907 return;
908
Stefan Richter837ec782009-06-09 23:56:55 +0200909 /*
910 * The Broadcast_Channel Valid bit is required by nodes which want to
911 * transmit on this channel. Such transmissions are practically
912 * exclusive to IP over 1394 (RFC 2734). IP capable nodes are required
913 * to be IRM capable and have a max_rec of 8 or more. We use this fact
914 * to narrow down to which nodes we send Broadcast_Channel updates.
915 */
916 if (!device->irmc || device->max_rec < 8)
917 return;
918
919 /*
920 * Some 1394-1995 nodes crash if this 1394a-2000 register is written.
921 * Perform a read test first.
922 */
Stefan Richter7889b602009-03-10 21:09:28 +0100923 if (device->bc_implemented == BC_UNKNOWN) {
924 rcode = fw_run_transaction(card, TCODE_READ_QUADLET_REQUEST,
925 device->node_id, generation, device->max_speed,
926 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
927 &data, 4);
928 switch (rcode) {
929 case RCODE_COMPLETE:
930 if (data & cpu_to_be32(1 << 31)) {
931 device->bc_implemented = BC_IMPLEMENTED;
932 break;
933 }
934 /* else fall through to case address error */
935 case RCODE_ADDRESS_ERROR:
936 device->bc_implemented = BC_UNIMPLEMENTED;
937 }
938 }
939
940 if (device->bc_implemented == BC_IMPLEMENTED) {
941 data = cpu_to_be32(BROADCAST_CHANNEL_INITIAL |
942 BROADCAST_CHANNEL_VALID);
943 fw_run_transaction(card, TCODE_WRITE_QUADLET_REQUEST,
944 device->node_id, generation, device->max_speed,
945 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
946 &data, 4);
947 }
948}
949
Stefan Richter099d5412009-06-06 18:37:25 +0200950int fw_device_set_broadcast_channel(struct device *dev, void *gen)
951{
952 if (is_fw_device(dev))
953 set_broadcast_channel(fw_device(dev), (long)gen);
954
955 return 0;
956}
957
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500958static void fw_device_init(struct work_struct *work)
959{
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500960 struct fw_device *device =
961 container_of(work, struct fw_device, work.work);
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100962 struct device *revived_dev;
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100963 int minor, ret;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500964
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400965 /*
966 * All failure paths here set node->data to NULL, so that we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500967 * don't try to do device_for_each_child() on a kfree()'d
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400968 * device.
969 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500970
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100971 if (read_bus_info_block(device, device->generation) < 0) {
Stefan Richter855c6032008-02-27 22:14:27 +0100972 if (device->config_rom_retries < MAX_RETRIES &&
973 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500974 device->config_rom_retries++;
975 schedule_delayed_work(&device->work, RETRY_DELAY);
976 } else {
Stefan Richter907293d2007-01-23 21:11:43 +0100977 fw_notify("giving up on config rom for node id %x\n",
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500978 device->node_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500979 if (device->node == device->card->root_node)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100980 fw_schedule_bm_work(device->card, 0);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500981 fw_device_release(&device->device);
982 }
983 return;
984 }
985
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100986 revived_dev = device_find_child(device->card->device,
987 device, lookup_existing_device);
988 if (revived_dev) {
989 put_device(revived_dev);
990 fw_device_release(&device->device);
991
992 return;
993 }
994
Stefan Richter62305822009-01-09 20:49:37 +0100995 device_initialize(&device->device);
Stefan Richter96b19062008-02-02 15:01:09 +0100996
997 fw_device_get(device);
Stefan Richterc9755e12008-03-24 20:54:28 +0100998 down_write(&fw_device_rwsem);
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100999 ret = idr_pre_get(&fw_device_idr, GFP_KERNEL) ?
Stefan Richter62305822009-01-09 20:49:37 +01001000 idr_get_new(&fw_device_idr, device, &minor) :
1001 -ENOMEM;
Stefan Richterc9755e12008-03-24 20:54:28 +01001002 up_write(&fw_device_rwsem);
Stefan Richter96b19062008-02-02 15:01:09 +01001003
Stefan Richtere1eff7a2009-02-03 17:55:19 +01001004 if (ret < 0)
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001005 goto error;
1006
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001007 device->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -04001008 device->device.type = &fw_device_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001009 device->device.parent = device->card->device;
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001010 device->device.devt = MKDEV(fw_cdev_major, minor);
Kay Sieversa1f64812008-10-30 01:41:56 +01001011 dev_set_name(&device->device, "fw%d", minor);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001012
Stefan Richtere5333db2009-05-22 23:16:27 +02001013 BUILD_BUG_ON(ARRAY_SIZE(device->attribute_group.attrs) <
1014 ARRAY_SIZE(fw_device_attributes) +
1015 ARRAY_SIZE(config_rom_attributes));
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -04001016 init_fw_attribute_group(&device->device,
1017 fw_device_attributes,
1018 &device->attribute_group);
Stefan Richtere5333db2009-05-22 23:16:27 +02001019
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001020 if (device_add(&device->device)) {
1021 fw_error("Failed to add device.\n");
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001022 goto error_with_cdev;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001023 }
1024
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001025 create_units(device);
1026
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001027 /*
1028 * Transition the device to running state. If it got pulled
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001029 * out from under us while we did the intialization work, we
1030 * have to shut down the device again here. Normally, though,
1031 * fw_node_event will be responsible for shutting it down when
1032 * necessary. We have to use the atomic cmpxchg here to avoid
1033 * racing with the FW_NODE_DESTROYED case in
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001034 * fw_node_event().
1035 */
Stefan Richter641f8792007-01-27 10:34:55 +01001036 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001037 FW_DEVICE_INITIALIZING,
1038 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
1039 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1040 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
Stefan Richterfa6e6972008-02-03 23:03:00 +01001041 } else {
1042 if (device->config_rom_retries)
1043 fw_notify("created device %s: GUID %08x%08x, S%d00, "
1044 "%d config ROM retries\n",
Kay Sieversa1f64812008-10-30 01:41:56 +01001045 dev_name(&device->device),
Stefan Richterfa6e6972008-02-03 23:03:00 +01001046 device->config_rom[3], device->config_rom[4],
1047 1 << device->max_speed,
1048 device->config_rom_retries);
1049 else
1050 fw_notify("created device %s: GUID %08x%08x, S%d00\n",
Kay Sieversa1f64812008-10-30 01:41:56 +01001051 dev_name(&device->device),
Stefan Richterfa6e6972008-02-03 23:03:00 +01001052 device->config_rom[3], device->config_rom[4],
1053 1 << device->max_speed);
Stefan Richterc9755e12008-03-24 20:54:28 +01001054 device->config_rom_retries = 0;
Stefan Richter7889b602009-03-10 21:09:28 +01001055
Stefan Richter099d5412009-06-06 18:37:25 +02001056 set_broadcast_channel(device, device->generation);
Stefan Richterfa6e6972008-02-03 23:03:00 +01001057 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001058
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001059 /*
1060 * Reschedule the IRM work if we just finished reading the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001061 * root node config rom. If this races with a bus reset we
1062 * just end up running the IRM work a couple of extra times -
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001063 * pretty harmless.
1064 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001065 if (device->node == device->card->root_node)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +01001066 fw_schedule_bm_work(device->card, 0);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001067
1068 return;
1069
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001070 error_with_cdev:
Stefan Richterc9755e12008-03-24 20:54:28 +01001071 down_write(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001072 idr_remove(&fw_device_idr, minor);
Stefan Richterc9755e12008-03-24 20:54:28 +01001073 up_write(&fw_device_rwsem);
Stefan Richter373b2ed2007-03-04 14:45:18 +01001074 error:
Stefan Richter96b19062008-02-02 15:01:09 +01001075 fw_device_put(device); /* fw_device_idr's reference */
1076
1077 put_device(&device->device); /* our reference */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001078}
1079
Stefan Richterc9755e12008-03-24 20:54:28 +01001080enum {
1081 REREAD_BIB_ERROR,
1082 REREAD_BIB_GONE,
1083 REREAD_BIB_UNCHANGED,
1084 REREAD_BIB_CHANGED,
1085};
1086
1087/* Reread and compare bus info block and header of root directory */
1088static int reread_bus_info_block(struct fw_device *device, int generation)
1089{
1090 u32 q;
1091 int i;
1092
1093 for (i = 0; i < 6; i++) {
1094 if (read_rom(device, generation, i, &q) != RCODE_COMPLETE)
1095 return REREAD_BIB_ERROR;
1096
1097 if (i == 0 && q == 0)
1098 return REREAD_BIB_GONE;
1099
Stefan Richterd01b0172009-01-17 22:45:54 +01001100 if (q != device->config_rom[i])
Stefan Richterc9755e12008-03-24 20:54:28 +01001101 return REREAD_BIB_CHANGED;
1102 }
1103
1104 return REREAD_BIB_UNCHANGED;
1105}
1106
1107static void fw_device_refresh(struct work_struct *work)
1108{
1109 struct fw_device *device =
1110 container_of(work, struct fw_device, work.work);
1111 struct fw_card *card = device->card;
1112 int node_id = device->node_id;
1113
1114 switch (reread_bus_info_block(device, device->generation)) {
1115 case REREAD_BIB_ERROR:
1116 if (device->config_rom_retries < MAX_RETRIES / 2 &&
1117 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
1118 device->config_rom_retries++;
1119 schedule_delayed_work(&device->work, RETRY_DELAY / 2);
1120
1121 return;
1122 }
1123 goto give_up;
1124
1125 case REREAD_BIB_GONE:
1126 goto gone;
1127
1128 case REREAD_BIB_UNCHANGED:
1129 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001130 FW_DEVICE_INITIALIZING,
1131 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
Stefan Richterc9755e12008-03-24 20:54:28 +01001132 goto gone;
1133
1134 fw_device_update(work);
1135 device->config_rom_retries = 0;
1136 goto out;
1137
1138 case REREAD_BIB_CHANGED:
1139 break;
1140 }
1141
1142 /*
1143 * Something changed. We keep things simple and don't investigate
1144 * further. We just destroy all previous units and create new ones.
1145 */
1146 device_for_each_child(&device->device, NULL, shutdown_unit);
1147
1148 if (read_bus_info_block(device, device->generation) < 0) {
1149 if (device->config_rom_retries < MAX_RETRIES &&
1150 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
1151 device->config_rom_retries++;
1152 schedule_delayed_work(&device->work, RETRY_DELAY);
1153
1154 return;
1155 }
1156 goto give_up;
1157 }
1158
1159 create_units(device);
1160
Stefan Richter0210b662009-05-23 00:03:29 +02001161 /* Userspace may want to re-read attributes. */
1162 kobject_uevent(&device->device.kobj, KOBJ_CHANGE);
1163
Stefan Richterc9755e12008-03-24 20:54:28 +01001164 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001165 FW_DEVICE_INITIALIZING,
1166 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
Stefan Richterc9755e12008-03-24 20:54:28 +01001167 goto gone;
1168
Kay Sieversa1f64812008-10-30 01:41:56 +01001169 fw_notify("refreshed device %s\n", dev_name(&device->device));
Stefan Richterc9755e12008-03-24 20:54:28 +01001170 device->config_rom_retries = 0;
1171 goto out;
1172
1173 give_up:
Kay Sieversa1f64812008-10-30 01:41:56 +01001174 fw_notify("giving up on refresh of device %s\n", dev_name(&device->device));
Stefan Richterc9755e12008-03-24 20:54:28 +01001175 gone:
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001176 atomic_set(&device->state, FW_DEVICE_GONE);
1177 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1178 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
Stefan Richterc9755e12008-03-24 20:54:28 +01001179 out:
1180 if (node_id == card->root_node->node_id)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +01001181 fw_schedule_bm_work(card, 0);
Stefan Richterc9755e12008-03-24 20:54:28 +01001182}
1183
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001184void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
1185{
1186 struct fw_device *device;
1187
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001188 switch (event) {
1189 case FW_NODE_CREATED:
1190 case FW_NODE_LINK_ON:
1191 if (!node->link_on)
1192 break;
Stefan Richterc9755e12008-03-24 20:54:28 +01001193 create:
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001194 device = kzalloc(sizeof(*device), GFP_ATOMIC);
1195 if (device == NULL)
1196 break;
1197
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001198 /*
1199 * Do minimal intialization of the device here, the
Stefan Richter62305822009-01-09 20:49:37 +01001200 * rest will happen in fw_device_init().
1201 *
1202 * Attention: A lot of things, even fw_device_get(),
1203 * cannot be done before fw_device_init() finished!
1204 * You can basically just check device->state and
1205 * schedule work until then, but only while holding
1206 * card->lock.
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001207 */
Stefan Richter641f8792007-01-27 10:34:55 +01001208 atomic_set(&device->state, FW_DEVICE_INITIALIZING);
Stefan Richter459f7922008-05-24 16:50:22 +02001209 device->card = fw_card_get(card);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001210 device->node = fw_node_get(node);
1211 device->node_id = node->node_id;
1212 device->generation = card->generation;
Stefan Richter92368892009-05-13 21:42:14 +02001213 device->is_local = node == card->local_node;
Stefan Richterd67cfb92008-10-05 10:37:11 +02001214 mutex_init(&device->client_list_mutex);
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -05001215 INIT_LIST_HEAD(&device->client_list);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001216
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001217 /*
1218 * Set the node data to point back to this device so
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001219 * FW_NODE_UPDATED callbacks can update the node_id
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001220 * and generation for the device.
1221 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001222 node->data = device;
1223
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001224 /*
1225 * Many devices are slow to respond after bus resets,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001226 * especially if they are bus powered and go through
1227 * power-up after getting plugged in. We schedule the
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001228 * first config rom scan half a second after bus reset.
1229 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001230 INIT_DELAYED_WORK(&device->work, fw_device_init);
1231 schedule_delayed_work(&device->work, INITIAL_DELAY);
1232 break;
1233
Stefan Richterc9755e12008-03-24 20:54:28 +01001234 case FW_NODE_INITIATED_RESET:
1235 device = node->data;
1236 if (device == NULL)
1237 goto create;
1238
1239 device->node_id = node->node_id;
1240 smp_wmb(); /* update node_id before generation */
1241 device->generation = card->generation;
1242 if (atomic_cmpxchg(&device->state,
1243 FW_DEVICE_RUNNING,
1244 FW_DEVICE_INITIALIZING) == FW_DEVICE_RUNNING) {
1245 PREPARE_DELAYED_WORK(&device->work, fw_device_refresh);
1246 schedule_delayed_work(&device->work,
Stefan Richter92368892009-05-13 21:42:14 +02001247 device->is_local ? 0 : INITIAL_DELAY);
Stefan Richterc9755e12008-03-24 20:54:28 +01001248 }
1249 break;
1250
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001251 case FW_NODE_UPDATED:
1252 if (!node->link_on || node->data == NULL)
1253 break;
1254
1255 device = node->data;
1256 device->node_id = node->node_id;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +01001257 smp_wmb(); /* update node_id before generation */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001258 device->generation = card->generation;
Kristian Høgsberg5f480472007-03-07 12:12:39 -05001259 if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
1260 PREPARE_DELAYED_WORK(&device->work, fw_device_update);
1261 schedule_delayed_work(&device->work, 0);
1262 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001263 break;
1264
1265 case FW_NODE_DESTROYED:
1266 case FW_NODE_LINK_OFF:
1267 if (!node->data)
1268 break;
1269
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001270 /*
1271 * Destroy the device associated with the node. There
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001272 * are two cases here: either the device is fully
1273 * initialized (FW_DEVICE_RUNNING) or we're in the
1274 * process of reading its config rom
1275 * (FW_DEVICE_INITIALIZING). If it is fully
1276 * initialized we can reuse device->work to schedule a
1277 * full fw_device_shutdown(). If not, there's work
1278 * scheduled to read it's config rom, and we just put
1279 * the device in shutdown state to have that code fail
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001280 * to create the device.
1281 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001282 device = node->data;
Stefan Richter641f8792007-01-27 10:34:55 +01001283 if (atomic_xchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001284 FW_DEVICE_GONE) == FW_DEVICE_RUNNING) {
Kristian Høgsberg5f480472007-03-07 12:12:39 -05001285 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
Stefan Richtere747a5c2009-01-24 20:35:38 +01001286 schedule_delayed_work(&device->work,
1287 list_empty(&card->link) ? 0 : SHUTDOWN_DELAY);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001288 }
1289 break;
1290 }
1291}