blob: 9a262439e3a7220aa8bd4712acb73dc99b63fb62 [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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090036#include <linux/slab.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/**
Stefan Richter656b7af2010-07-07 13:26:18 +0200110 * fw_csr_string() - reads a string from the configuration ROM
111 * @directory: e.g. root directory or unit directory
112 * @key: the key of the preceding directory entry
113 * @buf: where to put the string
114 * @size: size of @buf, in bytes
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100115 *
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 Richterfe43d6d2010-03-19 00:39:07 +0100130static void get_ids(const u32 *directory, int *id)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500131{
132 struct fw_csr_iterator ci;
Stefan Richter5ae73512010-03-19 00:38:29 +0100133 int key, value;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500134
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500135 fw_csr_iterator_init(&ci, directory);
136 while (fw_csr_iterator_next(&ci, &key, &value)) {
Stefan Richter5ae73512010-03-19 00:38:29 +0100137 switch (key) {
138 case CSR_VENDOR: id[0] = value; break;
139 case CSR_MODEL: id[1] = value; break;
140 case CSR_SPECIFIER_ID: id[2] = value; break;
141 case CSR_VERSION: id[3] = value; break;
142 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500143 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500144}
145
Stefan Richterfe43d6d2010-03-19 00:39:07 +0100146static void get_modalias_ids(struct fw_unit *unit, int *id)
147{
148 get_ids(&fw_parent_device(unit)->config_rom[5], id);
149 get_ids(unit->directory, id);
150}
151
152static bool match_ids(const struct ieee1394_device_id *id_table, int *id)
153{
154 int match = 0;
155
156 if (id[0] == id_table->vendor_id)
157 match |= IEEE1394_MATCH_VENDOR_ID;
158 if (id[1] == id_table->model_id)
159 match |= IEEE1394_MATCH_MODEL_ID;
160 if (id[2] == id_table->specifier_id)
161 match |= IEEE1394_MATCH_SPECIFIER_ID;
162 if (id[3] == id_table->version)
163 match |= IEEE1394_MATCH_VERSION;
164
165 return (match & id_table->match_flags) == id_table->match_flags;
166}
167
168static bool is_fw_unit(struct device *dev);
169
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500170static int fw_unit_match(struct device *dev, struct device_driver *drv)
171{
Stefan Richterfe43d6d2010-03-19 00:39:07 +0100172 const struct ieee1394_device_id *id_table =
173 container_of(drv, struct fw_driver, driver)->id_table;
174 int id[] = {0, 0, 0, 0};
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500175
176 /* We only allow binding to fw_units. */
177 if (!is_fw_unit(dev))
178 return 0;
179
Stefan Richterfe43d6d2010-03-19 00:39:07 +0100180 get_modalias_ids(fw_unit(dev), id);
Stefan Richtere41f8d72009-02-16 00:22:05 +0100181
Stefan Richterfe43d6d2010-03-19 00:39:07 +0100182 for (; id_table->match_flags != 0; id_table++)
183 if (match_ids(id_table, id))
Stefan Richtere41f8d72009-02-16 00:22:05 +0100184 return 1;
185
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500186 return 0;
187}
188
189static int get_modalias(struct fw_unit *unit, char *buffer, size_t buffer_size)
190{
Stefan Richter5ae73512010-03-19 00:38:29 +0100191 int id[] = {0, 0, 0, 0};
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500192
Stefan Richterfe43d6d2010-03-19 00:39:07 +0100193 get_modalias_ids(unit, id);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500194
195 return snprintf(buffer, buffer_size,
196 "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
Stefan Richter5ae73512010-03-19 00:38:29 +0100197 id[0], id[1], id[2], id[3]);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500198}
199
Stefan Richter53dca512008-12-14 21:47:04 +0100200static int fw_unit_uevent(struct device *dev, struct kobj_uevent_env *env)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500201{
202 struct fw_unit *unit = fw_unit(dev);
203 char modalias[64];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500204
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400205 get_modalias(unit, modalias, sizeof(modalias));
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500206
Kay Sievers7eff2e72007-08-14 15:15:12 +0200207 if (add_uevent_var(env, "MODALIAS=%s", modalias))
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500208 return -ENOMEM;
209
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500210 return 0;
211}
212
213struct bus_type fw_bus_type = {
Kristian Høgsberg362c2c82007-02-06 14:49:37 -0500214 .name = "firewire",
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500215 .match = fw_unit_match,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500216};
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500217EXPORT_SYMBOL(fw_bus_type);
218
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500219int fw_device_enable_phys_dma(struct fw_device *device)
220{
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100221 int generation = device->generation;
222
223 /* device->node_id, accessed below, must not be older than generation */
224 smp_rmb();
225
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500226 return device->card->driver->enable_phys_dma(device->card,
227 device->node_id,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100228 generation);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500229}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500230EXPORT_SYMBOL(fw_device_enable_phys_dma);
231
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400232struct config_rom_attribute {
233 struct device_attribute attr;
234 u32 key;
235};
236
Stefan Richter53dca512008-12-14 21:47:04 +0100237static ssize_t show_immediate(struct device *dev,
238 struct device_attribute *dattr, char *buf)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400239{
240 struct config_rom_attribute *attr =
241 container_of(dattr, struct config_rom_attribute, attr);
242 struct fw_csr_iterator ci;
Stefan Richter13b302d2009-12-26 01:44:10 +0100243 const u32 *dir;
Stefan Richterc9755e12008-03-24 20:54:28 +0100244 int key, value, ret = -ENOENT;
245
246 down_read(&fw_device_rwsem);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400247
248 if (is_fw_unit(dev))
249 dir = fw_unit(dev)->directory;
250 else
251 dir = fw_device(dev)->config_rom + 5;
252
253 fw_csr_iterator_init(&ci, dir);
254 while (fw_csr_iterator_next(&ci, &key, &value))
Stefan Richterc9755e12008-03-24 20:54:28 +0100255 if (attr->key == key) {
256 ret = snprintf(buf, buf ? PAGE_SIZE : 0,
257 "0x%06x\n", value);
258 break;
259 }
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400260
Stefan Richterc9755e12008-03-24 20:54:28 +0100261 up_read(&fw_device_rwsem);
262
263 return ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400264}
265
266#define IMMEDIATE_ATTR(name, key) \
267 { __ATTR(name, S_IRUGO, show_immediate, NULL), key }
268
Stefan Richter53dca512008-12-14 21:47:04 +0100269static ssize_t show_text_leaf(struct device *dev,
270 struct device_attribute *dattr, char *buf)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400271{
272 struct config_rom_attribute *attr =
273 container_of(dattr, struct config_rom_attribute, attr);
Stefan Richter13b302d2009-12-26 01:44:10 +0100274 const u32 *dir;
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100275 size_t bufsize;
276 char dummy_buf[2];
277 int ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400278
Stefan Richterc9755e12008-03-24 20:54:28 +0100279 down_read(&fw_device_rwsem);
280
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400281 if (is_fw_unit(dev))
282 dir = fw_unit(dev)->directory;
283 else
284 dir = fw_device(dev)->config_rom + 5;
285
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100286 if (buf) {
287 bufsize = PAGE_SIZE - 1;
288 } else {
289 buf = dummy_buf;
290 bufsize = 1;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400291 }
292
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100293 ret = fw_csr_string(dir, attr->key, buf, bufsize);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400294
Clemens Ladisch1f8fef72009-12-24 11:59:57 +0100295 if (ret >= 0) {
296 /* Strip trailing whitespace and add newline. */
297 while (ret > 0 && isspace(buf[ret - 1]))
298 ret--;
299 strcpy(buf + ret, "\n");
300 ret++;
Stefan Richterc9755e12008-03-24 20:54:28 +0100301 }
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400302
Stefan Richterc9755e12008-03-24 20:54:28 +0100303 up_read(&fw_device_rwsem);
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400304
Stefan Richterc9755e12008-03-24 20:54:28 +0100305 return ret;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400306}
307
308#define TEXT_LEAF_ATTR(name, key) \
309 { __ATTR(name, S_IRUGO, show_text_leaf, NULL), key }
310
311static struct config_rom_attribute config_rom_attributes[] = {
312 IMMEDIATE_ATTR(vendor, CSR_VENDOR),
313 IMMEDIATE_ATTR(hardware_version, CSR_HARDWARE_VERSION),
314 IMMEDIATE_ATTR(specifier_id, CSR_SPECIFIER_ID),
315 IMMEDIATE_ATTR(version, CSR_VERSION),
316 IMMEDIATE_ATTR(model, CSR_MODEL),
317 TEXT_LEAF_ATTR(vendor_name, CSR_VENDOR),
318 TEXT_LEAF_ATTR(model_name, CSR_MODEL),
319 TEXT_LEAF_ATTR(hardware_version_name, CSR_HARDWARE_VERSION),
320};
321
Stefan Richter53dca512008-12-14 21:47:04 +0100322static void init_fw_attribute_group(struct device *dev,
323 struct device_attribute *attrs,
324 struct fw_attribute_group *group)
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400325{
326 struct device_attribute *attr;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400327 int i, j;
328
329 for (j = 0; attrs[j].attr.name != NULL; j++)
330 group->attrs[j] = &attrs[j].attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400331
332 for (i = 0; i < ARRAY_SIZE(config_rom_attributes); i++) {
333 attr = &config_rom_attributes[i].attr;
334 if (attr->show(dev, attr, NULL) < 0)
335 continue;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400336 group->attrs[j++] = &attr->attr;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400337 }
338
Stefan Richtere5333db2009-05-22 23:16:27 +0200339 group->attrs[j] = NULL;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400340 group->groups[0] = &group->group;
341 group->groups[1] = NULL;
342 group->group.attrs = group->attrs;
David Brownella4dbd672009-06-24 10:06:31 -0700343 dev->groups = (const struct attribute_group **) group->groups;
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400344}
345
Stefan Richter53dca512008-12-14 21:47:04 +0100346static ssize_t modalias_show(struct device *dev,
347 struct device_attribute *attr, char *buf)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500348{
349 struct fw_unit *unit = fw_unit(dev);
350 int length;
351
352 length = get_modalias(unit, buf, PAGE_SIZE);
353 strcpy(buf + length, "\n");
354
355 return length + 1;
356}
357
Stefan Richter53dca512008-12-14 21:47:04 +0100358static ssize_t rom_index_show(struct device *dev,
359 struct device_attribute *attr, char *buf)
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500360{
361 struct fw_device *device = fw_device(dev->parent);
362 struct fw_unit *unit = fw_unit(dev);
363
364 return snprintf(buf, PAGE_SIZE, "%d\n",
Stefan Richterd84702a2007-03-20 19:42:15 +0100365 (int)(unit->directory - device->config_rom));
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500366}
367
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400368static struct device_attribute fw_unit_attributes[] = {
369 __ATTR_RO(modalias),
370 __ATTR_RO(rom_index),
371 __ATTR_NULL,
372};
373
Stefan Richter53dca512008-12-14 21:47:04 +0100374static ssize_t config_rom_show(struct device *dev,
375 struct device_attribute *attr, char *buf)
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400376{
377 struct fw_device *device = fw_device(dev);
Stefan Richterc9755e12008-03-24 20:54:28 +0100378 size_t length;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400379
Stefan Richterc9755e12008-03-24 20:54:28 +0100380 down_read(&fw_device_rwsem);
381 length = device->config_rom_length * 4;
382 memcpy(buf, device->config_rom, length);
383 up_read(&fw_device_rwsem);
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400384
Stefan Richterc9755e12008-03-24 20:54:28 +0100385 return length;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400386}
387
Stefan Richter53dca512008-12-14 21:47:04 +0100388static ssize_t guid_show(struct device *dev,
389 struct device_attribute *attr, char *buf)
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400390{
391 struct fw_device *device = fw_device(dev);
Stefan Richterc9755e12008-03-24 20:54:28 +0100392 int ret;
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400393
Stefan Richterc9755e12008-03-24 20:54:28 +0100394 down_read(&fw_device_rwsem);
395 ret = snprintf(buf, PAGE_SIZE, "0x%08x%08x\n",
396 device->config_rom[3], device->config_rom[4]);
397 up_read(&fw_device_rwsem);
398
399 return ret;
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400400}
401
Stefan Richter13b302d2009-12-26 01:44:10 +0100402static int units_sprintf(char *buf, const u32 *directory)
Stefan Richter0210b662009-05-23 00:03:29 +0200403{
404 struct fw_csr_iterator ci;
405 int key, value;
406 int specifier_id = 0;
407 int version = 0;
408
409 fw_csr_iterator_init(&ci, directory);
410 while (fw_csr_iterator_next(&ci, &key, &value)) {
411 switch (key) {
412 case CSR_SPECIFIER_ID:
413 specifier_id = value;
414 break;
415 case CSR_VERSION:
416 version = value;
417 break;
418 }
419 }
420
421 return sprintf(buf, "0x%06x:0x%06x ", specifier_id, version);
422}
423
424static ssize_t units_show(struct device *dev,
425 struct device_attribute *attr, char *buf)
426{
427 struct fw_device *device = fw_device(dev);
428 struct fw_csr_iterator ci;
429 int key, value, i = 0;
430
431 down_read(&fw_device_rwsem);
432 fw_csr_iterator_init(&ci, &device->config_rom[5]);
433 while (fw_csr_iterator_next(&ci, &key, &value)) {
434 if (key != (CSR_UNIT | CSR_DIRECTORY))
435 continue;
436 i += units_sprintf(&buf[i], ci.p + value - 1);
437 if (i >= PAGE_SIZE - (8 + 1 + 8 + 1))
438 break;
439 }
440 up_read(&fw_device_rwsem);
441
442 if (i)
443 buf[i - 1] = '\n';
444
445 return i;
446}
447
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400448static struct device_attribute fw_device_attributes[] = {
449 __ATTR_RO(config_rom),
Kristian Høgsbergbbd14942007-03-20 20:58:35 -0400450 __ATTR_RO(guid),
Stefan Richter0210b662009-05-23 00:03:29 +0200451 __ATTR_RO(units),
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400452 __ATTR_NULL,
Kristian Høgsberg048961e2007-03-07 12:12:46 -0500453};
454
Stefan Richter53dca512008-12-14 21:47:04 +0100455static int read_rom(struct fw_device *device,
456 int generation, int index, u32 *data)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500457{
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200458 int rcode;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100459
460 /* device->node_id, accessed below, must not be older than generation */
461 smp_rmb();
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500462
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200463 rcode = fw_run_transaction(device->card, TCODE_READ_QUADLET_REQUEST,
Stefan Richterb5d2a5e2008-01-25 18:57:41 +0100464 device->node_id, generation, device->max_speed,
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200465 (CSR_REGISTER_BASE | CSR_CONFIG_ROM) + index * 4,
466 data, 4);
467 be32_to_cpus(data);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500468
Jay Fenlason1e119fa2008-07-20 14:20:53 +0200469 return rcode;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500470}
471
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100472#define MAX_CONFIG_ROM_SIZE 256
Stefan Richter1dadff72008-03-02 19:35:42 +0100473
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100474/*
475 * Read the bus info block, perform a speed probe, and read all of the rest of
476 * the config ROM. We do all this with a cached bus generation. If the bus
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100477 * generation changes under us, read_config_rom will fail and get retried.
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100478 * It's better to start all over in this case because the node from which we
479 * are reading the ROM may have changed the ROM during the reset.
480 */
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100481static int read_config_rom(struct fw_device *device, int generation)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500482{
Stefan Richter13b302d2009-12-26 01:44:10 +0100483 const u32 *old_rom, *new_rom;
484 u32 *rom, *stack;
Stefan Richter1dadff72008-03-02 19:35:42 +0100485 u32 sp, key;
486 int i, end, length, ret = -1;
487
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100488 rom = kmalloc(sizeof(*rom) * MAX_CONFIG_ROM_SIZE +
489 sizeof(*stack) * MAX_CONFIG_ROM_SIZE, GFP_KERNEL);
Stefan Richter1dadff72008-03-02 19:35:42 +0100490 if (rom == NULL)
491 return -ENOMEM;
492
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100493 stack = &rom[MAX_CONFIG_ROM_SIZE];
494 memset(rom, 0, sizeof(*rom) * MAX_CONFIG_ROM_SIZE);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500495
Stefan Richterf1397492007-06-10 21:31:36 +0200496 device->max_speed = SCODE_100;
497
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500498 /* First read the bus info block. */
499 for (i = 0; i < 5; i++) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100500 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100501 goto out;
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400502 /*
503 * As per IEEE1212 7.2, during power-up, devices can
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500504 * reply with a 0 for the first quadlet of the config
505 * rom to indicate that they are booting (for example,
506 * if the firmware is on the disk of a external
507 * harddisk). In that case we just fail, and the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400508 * retry mechanism will try again later.
509 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500510 if (i == 0 && rom[i] == 0)
Stefan Richter1dadff72008-03-02 19:35:42 +0100511 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500512 }
513
Stefan Richterf1397492007-06-10 21:31:36 +0200514 device->max_speed = device->node->max_speed;
515
516 /*
517 * Determine the speed of
518 * - devices with link speed less than PHY speed,
519 * - devices with 1394b PHY (unless only connected to 1394a PHYs),
520 * - all devices if there are 1394b repeaters.
521 * Note, we cannot use the bus info block's link_spd as starting point
522 * because some buggy firmwares set it lower than necessary and because
523 * 1394-1995 nodes do not have the field.
524 */
525 if ((rom[2] & 0x7) < device->max_speed ||
526 device->max_speed == SCODE_BETA ||
527 device->card->beta_repeaters_present) {
528 u32 dummy;
529
530 /* for S1600 and S3200 */
531 if (device->max_speed == SCODE_BETA)
532 device->max_speed = device->card->link_speed;
533
534 while (device->max_speed > SCODE_100) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100535 if (read_rom(device, generation, 0, &dummy) ==
536 RCODE_COMPLETE)
Stefan Richterf1397492007-06-10 21:31:36 +0200537 break;
538 device->max_speed--;
539 }
540 }
541
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400542 /*
543 * Now parse the config rom. The config rom is a recursive
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500544 * directory structure so we parse it using a stack of
545 * references to the blocks that make up the structure. We
546 * push a reference to the root directory on the stack to
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400547 * start things off.
548 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500549 length = i;
550 sp = 0;
551 stack[sp++] = 0xc0000005;
552 while (sp > 0) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400553 /*
554 * Pop the next block reference of the stack. The
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500555 * lower 24 bits is the offset into the config rom,
556 * the upper 8 bits are the type of the reference the
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400557 * block.
558 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500559 key = stack[--sp];
560 i = key & 0xffffff;
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100561 if (WARN_ON(i >= MAX_CONFIG_ROM_SIZE))
Stefan Richter1dadff72008-03-02 19:35:42 +0100562 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500563
564 /* Read header quadlet for the block to get the length. */
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100565 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100566 goto out;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500567 end = i + (rom[i] >> 16) + 1;
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100568 if (end > MAX_CONFIG_ROM_SIZE) {
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400569 /*
Stefan Richter2799d5c2010-02-18 01:52:45 +0100570 * This block extends outside the config ROM which is
571 * a firmware bug. Ignore this whole block, i.e.
572 * simply set a fake block length of 0.
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400573 */
Stefan Richter2799d5c2010-02-18 01:52:45 +0100574 fw_error("skipped invalid ROM block %x at %llx\n",
575 rom[i],
576 i * 4 | CSR_REGISTER_BASE | CSR_CONFIG_ROM);
577 rom[i] = 0;
578 end = i;
579 }
580 i++;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500581
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400582 /*
583 * Now read in the block. If this is a directory
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500584 * block, check the entries as we read them to see if
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400585 * it references another block, and push it in that case.
586 */
Stefan Richterd54423c2010-02-18 01:50:31 +0100587 for (; i < end; i++) {
Stefan Richterf8d2dc32008-01-25 17:53:49 +0100588 if (read_rom(device, generation, i, &rom[i]) !=
589 RCODE_COMPLETE)
Stefan Richter1dadff72008-03-02 19:35:42 +0100590 goto out;
Stefan Richterd54423c2010-02-18 01:50:31 +0100591
Stefan Richter58aaa542010-02-18 01:54:00 +0100592 if ((key >> 30) != 3 || (rom[i] >> 30) < 2)
Stefan Richterd54423c2010-02-18 01:50:31 +0100593 continue;
594 /*
595 * Offset points outside the ROM. May be a firmware
596 * bug or an Extended ROM entry (IEEE 1212-2001 clause
597 * 7.7.18). Simply overwrite this pointer here by a
598 * fake immediate entry so that later iterators over
599 * the ROM don't have to check offsets all the time.
600 */
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100601 if (i + (rom[i] & 0xffffff) >= MAX_CONFIG_ROM_SIZE) {
Stefan Richterd54423c2010-02-18 01:50:31 +0100602 fw_error("skipped unsupported ROM entry %x at %llx\n",
603 rom[i],
604 i * 4 | CSR_REGISTER_BASE | CSR_CONFIG_ROM);
605 rom[i] = 0;
606 continue;
607 }
608 stack[sp++] = i + rom[i];
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500609 }
610 if (length < i)
611 length = i;
612 }
613
Stefan Richterc9755e12008-03-24 20:54:28 +0100614 old_rom = device->config_rom;
615 new_rom = kmemdup(rom, length * 4, GFP_KERNEL);
616 if (new_rom == NULL)
Stefan Richter1dadff72008-03-02 19:35:42 +0100617 goto out;
Stefan Richterc9755e12008-03-24 20:54:28 +0100618
619 down_write(&fw_device_rwsem);
620 device->config_rom = new_rom;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500621 device->config_rom_length = length;
Stefan Richterc9755e12008-03-24 20:54:28 +0100622 up_write(&fw_device_rwsem);
623
624 kfree(old_rom);
Stefan Richter1dadff72008-03-02 19:35:42 +0100625 ret = 0;
Stefan Richter837ec782009-06-09 23:56:55 +0200626 device->max_rec = rom[2] >> 12 & 0xf;
627 device->cmc = rom[2] >> 30 & 1;
628 device->irmc = rom[2] >> 31 & 1;
Stefan Richter1dadff72008-03-02 19:35:42 +0100629 out:
630 kfree(rom);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500631
Stefan Richter1dadff72008-03-02 19:35:42 +0100632 return ret;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500633}
634
635static void fw_unit_release(struct device *dev)
636{
637 struct fw_unit *unit = fw_unit(dev);
638
639 kfree(unit);
640}
641
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400642static struct device_type fw_unit_type = {
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400643 .uevent = fw_unit_uevent,
644 .release = fw_unit_release,
645};
646
Stefan Richter099d5412009-06-06 18:37:25 +0200647static bool is_fw_unit(struct device *dev)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500648{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400649 return dev->type == &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500650}
651
652static void create_units(struct fw_device *device)
653{
654 struct fw_csr_iterator ci;
655 struct fw_unit *unit;
656 int key, value, i;
657
658 i = 0;
659 fw_csr_iterator_init(&ci, &device->config_rom[5]);
660 while (fw_csr_iterator_next(&ci, &key, &value)) {
661 if (key != (CSR_UNIT | CSR_DIRECTORY))
662 continue;
663
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400664 /*
665 * Get the address of the unit directory and try to
666 * match the drivers id_tables against it.
667 */
Kristian Høgsberg2d826cc2007-05-09 19:23:14 -0400668 unit = kzalloc(sizeof(*unit), GFP_KERNEL);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500669 if (unit == NULL) {
670 fw_error("failed to allocate memory for unit\n");
671 continue;
672 }
673
674 unit->directory = ci.p + value - 1;
675 unit->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400676 unit->device.type = &fw_unit_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500677 unit->device.parent = &device->device;
Kay Sieversa1f64812008-10-30 01:41:56 +0100678 dev_set_name(&unit->device, "%s.%d", dev_name(&device->device), i++);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500679
Stefan Richtere5333db2009-05-22 23:16:27 +0200680 BUILD_BUG_ON(ARRAY_SIZE(unit->attribute_group.attrs) <
681 ARRAY_SIZE(fw_unit_attributes) +
682 ARRAY_SIZE(config_rom_attributes));
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400683 init_fw_attribute_group(&unit->device,
684 fw_unit_attributes,
685 &unit->attribute_group);
Stefan Richtere5333db2009-05-22 23:16:27 +0200686
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400687 if (device_register(&unit->device) < 0)
688 goto skip_unit;
689
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400690 continue;
691
Kristian Høgsberg7feb9cc2007-03-21 10:55:19 -0400692 skip_unit:
693 kfree(unit);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500694 }
695}
696
697static int shutdown_unit(struct device *device, void *data)
698{
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400699 device_unregister(device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500700
701 return 0;
702}
703
Stefan Richterc9755e12008-03-24 20:54:28 +0100704/*
705 * fw_device_rwsem acts as dual purpose mutex:
706 * - serializes accesses to fw_device_idr,
707 * - serializes accesses to fw_device.config_rom/.config_rom_length and
708 * fw_unit.directory, unless those accesses happen at safe occasions
709 */
710DECLARE_RWSEM(fw_device_rwsem);
711
Stefan Richterd6053e02008-11-24 20:40:00 +0100712DEFINE_IDR(fw_device_idr);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500713int fw_cdev_major;
714
Stefan Richter96b19062008-02-02 15:01:09 +0100715struct fw_device *fw_device_get_by_devt(dev_t devt)
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500716{
717 struct fw_device *device;
718
Stefan Richterc9755e12008-03-24 20:54:28 +0100719 down_read(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500720 device = idr_find(&fw_device_idr, MINOR(devt));
Stefan Richter96b19062008-02-02 15:01:09 +0100721 if (device)
722 fw_device_get(device);
Stefan Richterc9755e12008-03-24 20:54:28 +0100723 up_read(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500724
725 return device;
726}
727
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400728/*
729 * These defines control the retry behavior for reading the config
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500730 * rom. It shouldn't be necessary to tweak these; if the device
731 * doesn't respond to a config rom read within 10 seconds, it's not
732 * going to respond at all. As for the initial delay, a lot of
733 * devices will be able to respond within half a second after bus
734 * reset. On the other hand, it's not really worth being more
735 * aggressive than that, since it scales pretty well; if 10 devices
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400736 * are plugged in, they're all getting read within one second.
737 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500738
Kristian Høgsbergc5dfd0a2007-03-27 01:43:43 -0400739#define MAX_RETRIES 10
740#define RETRY_DELAY (3 * HZ)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500741#define INITIAL_DELAY (HZ / 2)
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100742#define SHUTDOWN_DELAY (2 * HZ)
743
744static void fw_device_shutdown(struct work_struct *work)
745{
746 struct fw_device *device =
747 container_of(work, struct fw_device, work.work);
748 int minor = MINOR(device->device.devt);
749
Clemens Ladische71084a2011-01-22 15:05:03 +0100750 if (time_before64(get_jiffies_64(),
751 device->card->reset_jiffies + SHUTDOWN_DELAY)
Stefan Richtere747a5c2009-01-24 20:35:38 +0100752 && !list_empty(&device->card->link)) {
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100753 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
754 return;
755 }
756
757 if (atomic_cmpxchg(&device->state,
758 FW_DEVICE_GONE,
759 FW_DEVICE_SHUTDOWN) != FW_DEVICE_GONE)
760 return;
761
762 fw_device_cdev_remove(device);
763 device_for_each_child(&device->device, NULL, shutdown_unit);
764 device_unregister(&device->device);
765
766 down_write(&fw_device_rwsem);
767 idr_remove(&fw_device_idr, minor);
768 up_write(&fw_device_rwsem);
769
770 fw_device_put(device);
771}
772
Stefan Richteraed80892009-01-17 22:45:54 +0100773static void fw_device_release(struct device *dev)
774{
775 struct fw_device *device = fw_device(dev);
776 struct fw_card *card = device->card;
777 unsigned long flags;
778
779 /*
780 * Take the card lock so we don't set this to NULL while a
781 * FW_NODE_UPDATED callback is being handled or while the
782 * bus manager work looks at this node.
783 */
784 spin_lock_irqsave(&card->lock, flags);
785 device->node->data = NULL;
786 spin_unlock_irqrestore(&card->lock, flags);
787
788 fw_node_put(device->node);
789 kfree(device->config_rom);
790 kfree(device);
791 fw_card_put(card);
792}
793
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100794static struct device_type fw_device_type = {
Stefan Richteraed80892009-01-17 22:45:54 +0100795 .release = fw_device_release,
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100796};
797
Stefan Richter099d5412009-06-06 18:37:25 +0200798static bool is_fw_device(struct device *dev)
799{
800 return dev->type == &fw_device_type;
801}
802
Stefan Richteraed80892009-01-17 22:45:54 +0100803static int update_unit(struct device *dev, void *data)
804{
805 struct fw_unit *unit = fw_unit(dev);
806 struct fw_driver *driver = (struct fw_driver *)dev->driver;
807
808 if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800809 device_lock(dev);
Stefan Richteraed80892009-01-17 22:45:54 +0100810 driver->update(unit);
Greg Kroah-Hartman8e9394c2010-02-17 10:57:05 -0800811 device_unlock(dev);
Stefan Richteraed80892009-01-17 22:45:54 +0100812 }
813
814 return 0;
815}
816
817static void fw_device_update(struct work_struct *work)
818{
819 struct fw_device *device =
820 container_of(work, struct fw_device, work.work);
821
822 fw_device_cdev_update(device);
823 device_for_each_child(&device->device, NULL, update_unit);
824}
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100825
826/*
827 * If a device was pending for deletion because its node went away but its
828 * bus info block and root directory header matches that of a newly discovered
829 * device, revive the existing fw_device.
830 * The newly allocated fw_device becomes obsolete instead.
831 */
832static int lookup_existing_device(struct device *dev, void *data)
833{
834 struct fw_device *old = fw_device(dev);
835 struct fw_device *new = data;
836 struct fw_card *card = new->card;
837 int match = 0;
838
Stefan Richter099d5412009-06-06 18:37:25 +0200839 if (!is_fw_device(dev))
840 return 0;
841
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100842 down_read(&fw_device_rwsem); /* serialize config_rom access */
843 spin_lock_irq(&card->lock); /* serialize node access */
844
845 if (memcmp(old->config_rom, new->config_rom, 6 * 4) == 0 &&
846 atomic_cmpxchg(&old->state,
847 FW_DEVICE_GONE,
848 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
849 struct fw_node *current_node = new->node;
850 struct fw_node *obsolete_node = old->node;
851
852 new->node = obsolete_node;
853 new->node->data = new;
854 old->node = current_node;
855 old->node->data = old;
856
857 old->max_speed = new->max_speed;
858 old->node_id = current_node->node_id;
859 smp_wmb(); /* update node_id before generation */
860 old->generation = card->generation;
861 old->config_rom_retries = 0;
862 fw_notify("rediscovered device %s\n", dev_name(dev));
863
864 PREPARE_DELAYED_WORK(&old->work, fw_device_update);
865 schedule_delayed_work(&old->work, 0);
866
867 if (current_node == card->root_node)
868 fw_schedule_bm_work(card, 0);
869
870 match = 1;
871 }
872
873 spin_unlock_irq(&card->lock);
874 up_read(&fw_device_rwsem);
875
876 return match;
877}
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500878
Stefan Richter7889b602009-03-10 21:09:28 +0100879enum { BC_UNKNOWN = 0, BC_UNIMPLEMENTED, BC_IMPLEMENTED, };
880
Stefan Richter099d5412009-06-06 18:37:25 +0200881static void set_broadcast_channel(struct fw_device *device, int generation)
Stefan Richter7889b602009-03-10 21:09:28 +0100882{
883 struct fw_card *card = device->card;
884 __be32 data;
885 int rcode;
886
887 if (!card->broadcast_channel_allocated)
888 return;
889
Stefan Richter837ec782009-06-09 23:56:55 +0200890 /*
891 * The Broadcast_Channel Valid bit is required by nodes which want to
892 * transmit on this channel. Such transmissions are practically
893 * exclusive to IP over 1394 (RFC 2734). IP capable nodes are required
894 * to be IRM capable and have a max_rec of 8 or more. We use this fact
895 * to narrow down to which nodes we send Broadcast_Channel updates.
896 */
897 if (!device->irmc || device->max_rec < 8)
898 return;
899
900 /*
901 * Some 1394-1995 nodes crash if this 1394a-2000 register is written.
902 * Perform a read test first.
903 */
Stefan Richter7889b602009-03-10 21:09:28 +0100904 if (device->bc_implemented == BC_UNKNOWN) {
905 rcode = fw_run_transaction(card, TCODE_READ_QUADLET_REQUEST,
906 device->node_id, generation, device->max_speed,
907 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
908 &data, 4);
909 switch (rcode) {
910 case RCODE_COMPLETE:
911 if (data & cpu_to_be32(1 << 31)) {
912 device->bc_implemented = BC_IMPLEMENTED;
913 break;
914 }
915 /* else fall through to case address error */
916 case RCODE_ADDRESS_ERROR:
917 device->bc_implemented = BC_UNIMPLEMENTED;
918 }
919 }
920
921 if (device->bc_implemented == BC_IMPLEMENTED) {
922 data = cpu_to_be32(BROADCAST_CHANNEL_INITIAL |
923 BROADCAST_CHANNEL_VALID);
924 fw_run_transaction(card, TCODE_WRITE_QUADLET_REQUEST,
925 device->node_id, generation, device->max_speed,
926 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
927 &data, 4);
928 }
929}
930
Stefan Richter099d5412009-06-06 18:37:25 +0200931int fw_device_set_broadcast_channel(struct device *dev, void *gen)
932{
933 if (is_fw_device(dev))
934 set_broadcast_channel(fw_device(dev), (long)gen);
935
936 return 0;
937}
938
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500939static void fw_device_init(struct work_struct *work)
940{
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500941 struct fw_device *device =
942 container_of(work, struct fw_device, work.work);
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100943 struct device *revived_dev;
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100944 int minor, ret;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500945
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400946 /*
947 * All failure paths here set node->data to NULL, so that we
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500948 * don't try to do device_for_each_child() on a kfree()'d
Kristian Høgsbergc781c062007-05-07 20:33:32 -0400949 * device.
950 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500951
Stefan Richterfd6e0c512010-02-19 21:00:31 +0100952 if (read_config_rom(device, device->generation) < 0) {
Stefan Richter855c6032008-02-27 22:14:27 +0100953 if (device->config_rom_retries < MAX_RETRIES &&
954 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500955 device->config_rom_retries++;
956 schedule_delayed_work(&device->work, RETRY_DELAY);
957 } else {
Stefan Richter115881d2011-03-15 00:08:41 +0100958 if (device->node->link_on)
959 fw_notify("giving up on config rom for node id %x\n",
960 device->node_id);
Kristian Høgsberg931c4832007-01-26 00:38:45 -0500961 if (device->node == device->card->root_node)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +0100962 fw_schedule_bm_work(device->card, 0);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500963 fw_device_release(&device->device);
964 }
965 return;
966 }
967
Stefan Richter3d36a0d2009-01-17 22:45:54 +0100968 revived_dev = device_find_child(device->card->device,
969 device, lookup_existing_device);
970 if (revived_dev) {
971 put_device(revived_dev);
972 fw_device_release(&device->device);
973
974 return;
975 }
976
Stefan Richter62305822009-01-09 20:49:37 +0100977 device_initialize(&device->device);
Stefan Richter96b19062008-02-02 15:01:09 +0100978
979 fw_device_get(device);
Stefan Richterc9755e12008-03-24 20:54:28 +0100980 down_write(&fw_device_rwsem);
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100981 ret = idr_pre_get(&fw_device_idr, GFP_KERNEL) ?
Stefan Richter62305822009-01-09 20:49:37 +0100982 idr_get_new(&fw_device_idr, device, &minor) :
983 -ENOMEM;
Stefan Richterc9755e12008-03-24 20:54:28 +0100984 up_write(&fw_device_rwsem);
Stefan Richter96b19062008-02-02 15:01:09 +0100985
Stefan Richtere1eff7a2009-02-03 17:55:19 +0100986 if (ret < 0)
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500987 goto error;
988
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500989 device->device.bus = &fw_bus_type;
Kristian Høgsberg21351db2007-03-20 20:58:33 -0400990 device->device.type = &fw_device_type;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500991 device->device.parent = device->card->device;
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -0500992 device->device.devt = MKDEV(fw_cdev_major, minor);
Kay Sieversa1f64812008-10-30 01:41:56 +0100993 dev_set_name(&device->device, "fw%d", minor);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500994
Stefan Richtere5333db2009-05-22 23:16:27 +0200995 BUILD_BUG_ON(ARRAY_SIZE(device->attribute_group.attrs) <
996 ARRAY_SIZE(fw_device_attributes) +
997 ARRAY_SIZE(config_rom_attributes));
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -0400998 init_fw_attribute_group(&device->device,
999 fw_device_attributes,
1000 &device->attribute_group);
Stefan Richtere5333db2009-05-22 23:16:27 +02001001
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001002 if (device_add(&device->device)) {
1003 fw_error("Failed to add device.\n");
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001004 goto error_with_cdev;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001005 }
1006
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001007 create_units(device);
1008
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001009 /*
1010 * Transition the device to running state. If it got pulled
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001011 * out from under us while we did the intialization work, we
1012 * have to shut down the device again here. Normally, though,
1013 * fw_node_event will be responsible for shutting it down when
1014 * necessary. We have to use the atomic cmpxchg here to avoid
1015 * racing with the FW_NODE_DESTROYED case in
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001016 * fw_node_event().
1017 */
Stefan Richter641f8792007-01-27 10:34:55 +01001018 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001019 FW_DEVICE_INITIALIZING,
1020 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
1021 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1022 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
Stefan Richterfa6e6972008-02-03 23:03:00 +01001023 } else {
1024 if (device->config_rom_retries)
1025 fw_notify("created device %s: GUID %08x%08x, S%d00, "
1026 "%d config ROM retries\n",
Kay Sieversa1f64812008-10-30 01:41:56 +01001027 dev_name(&device->device),
Stefan Richterfa6e6972008-02-03 23:03:00 +01001028 device->config_rom[3], device->config_rom[4],
1029 1 << device->max_speed,
1030 device->config_rom_retries);
1031 else
1032 fw_notify("created device %s: GUID %08x%08x, S%d00\n",
Kay Sieversa1f64812008-10-30 01:41:56 +01001033 dev_name(&device->device),
Stefan Richterfa6e6972008-02-03 23:03:00 +01001034 device->config_rom[3], device->config_rom[4],
1035 1 << device->max_speed);
Stefan Richterc9755e12008-03-24 20:54:28 +01001036 device->config_rom_retries = 0;
Stefan Richter7889b602009-03-10 21:09:28 +01001037
Stefan Richter099d5412009-06-06 18:37:25 +02001038 set_broadcast_channel(device, device->generation);
Stefan Richterfa6e6972008-02-03 23:03:00 +01001039 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001040
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001041 /*
1042 * Reschedule the IRM work if we just finished reading the
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001043 * root node config rom. If this races with a bus reset we
1044 * just end up running the IRM work a couple of extra times -
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001045 * pretty harmless.
1046 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001047 if (device->node == device->card->root_node)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +01001048 fw_schedule_bm_work(device->card, 0);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001049
1050 return;
1051
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001052 error_with_cdev:
Stefan Richterc9755e12008-03-24 20:54:28 +01001053 down_write(&fw_device_rwsem);
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -05001054 idr_remove(&fw_device_idr, minor);
Stefan Richterc9755e12008-03-24 20:54:28 +01001055 up_write(&fw_device_rwsem);
Stefan Richter373b2ed2007-03-04 14:45:18 +01001056 error:
Stefan Richter96b19062008-02-02 15:01:09 +01001057 fw_device_put(device); /* fw_device_idr's reference */
1058
1059 put_device(&device->device); /* our reference */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001060}
1061
Stefan Richterc9755e12008-03-24 20:54:28 +01001062enum {
1063 REREAD_BIB_ERROR,
1064 REREAD_BIB_GONE,
1065 REREAD_BIB_UNCHANGED,
1066 REREAD_BIB_CHANGED,
1067};
1068
1069/* Reread and compare bus info block and header of root directory */
Stefan Richterfd6e0c512010-02-19 21:00:31 +01001070static int reread_config_rom(struct fw_device *device, int generation)
Stefan Richterc9755e12008-03-24 20:54:28 +01001071{
1072 u32 q;
1073 int i;
1074
1075 for (i = 0; i < 6; i++) {
1076 if (read_rom(device, generation, i, &q) != RCODE_COMPLETE)
1077 return REREAD_BIB_ERROR;
1078
1079 if (i == 0 && q == 0)
1080 return REREAD_BIB_GONE;
1081
Stefan Richterd01b0172009-01-17 22:45:54 +01001082 if (q != device->config_rom[i])
Stefan Richterc9755e12008-03-24 20:54:28 +01001083 return REREAD_BIB_CHANGED;
1084 }
1085
1086 return REREAD_BIB_UNCHANGED;
1087}
1088
1089static void fw_device_refresh(struct work_struct *work)
1090{
1091 struct fw_device *device =
1092 container_of(work, struct fw_device, work.work);
1093 struct fw_card *card = device->card;
1094 int node_id = device->node_id;
1095
Stefan Richterfd6e0c512010-02-19 21:00:31 +01001096 switch (reread_config_rom(device, device->generation)) {
Stefan Richterc9755e12008-03-24 20:54:28 +01001097 case REREAD_BIB_ERROR:
1098 if (device->config_rom_retries < MAX_RETRIES / 2 &&
1099 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
1100 device->config_rom_retries++;
1101 schedule_delayed_work(&device->work, RETRY_DELAY / 2);
1102
1103 return;
1104 }
1105 goto give_up;
1106
1107 case REREAD_BIB_GONE:
1108 goto gone;
1109
1110 case REREAD_BIB_UNCHANGED:
1111 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001112 FW_DEVICE_INITIALIZING,
1113 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
Stefan Richterc9755e12008-03-24 20:54:28 +01001114 goto gone;
1115
1116 fw_device_update(work);
1117 device->config_rom_retries = 0;
1118 goto out;
1119
1120 case REREAD_BIB_CHANGED:
1121 break;
1122 }
1123
1124 /*
1125 * Something changed. We keep things simple and don't investigate
1126 * further. We just destroy all previous units and create new ones.
1127 */
1128 device_for_each_child(&device->device, NULL, shutdown_unit);
1129
Stefan Richterfd6e0c512010-02-19 21:00:31 +01001130 if (read_config_rom(device, device->generation) < 0) {
Stefan Richterc9755e12008-03-24 20:54:28 +01001131 if (device->config_rom_retries < MAX_RETRIES &&
1132 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
1133 device->config_rom_retries++;
1134 schedule_delayed_work(&device->work, RETRY_DELAY);
1135
1136 return;
1137 }
1138 goto give_up;
1139 }
1140
Stefan Richter8b4f70b2010-07-07 15:36:07 +02001141 fw_device_cdev_update(device);
Stefan Richterc9755e12008-03-24 20:54:28 +01001142 create_units(device);
1143
Stefan Richter0210b662009-05-23 00:03:29 +02001144 /* Userspace may want to re-read attributes. */
1145 kobject_uevent(&device->device.kobj, KOBJ_CHANGE);
1146
Stefan Richterc9755e12008-03-24 20:54:28 +01001147 if (atomic_cmpxchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001148 FW_DEVICE_INITIALIZING,
1149 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
Stefan Richterc9755e12008-03-24 20:54:28 +01001150 goto gone;
1151
Kay Sieversa1f64812008-10-30 01:41:56 +01001152 fw_notify("refreshed device %s\n", dev_name(&device->device));
Stefan Richterc9755e12008-03-24 20:54:28 +01001153 device->config_rom_retries = 0;
1154 goto out;
1155
1156 give_up:
Kay Sieversa1f64812008-10-30 01:41:56 +01001157 fw_notify("giving up on refresh of device %s\n", dev_name(&device->device));
Stefan Richterc9755e12008-03-24 20:54:28 +01001158 gone:
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001159 atomic_set(&device->state, FW_DEVICE_GONE);
1160 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1161 schedule_delayed_work(&device->work, SHUTDOWN_DELAY);
Stefan Richterc9755e12008-03-24 20:54:28 +01001162 out:
1163 if (node_id == card->root_node->node_id)
Jay Fenlason0fa1986f2008-11-29 17:44:57 +01001164 fw_schedule_bm_work(card, 0);
Stefan Richterc9755e12008-03-24 20:54:28 +01001165}
1166
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001167void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
1168{
1169 struct fw_device *device;
1170
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001171 switch (event) {
1172 case FW_NODE_CREATED:
Stefan Richter115881d2011-03-15 00:08:41 +01001173 /*
1174 * Attempt to scan the node, regardless whether its self ID has
1175 * the L (link active) flag set or not. Some broken devices
1176 * send L=0 but have an up-and-running link; others send L=1
1177 * without actually having a link.
1178 */
Stefan Richterc9755e12008-03-24 20:54:28 +01001179 create:
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001180 device = kzalloc(sizeof(*device), GFP_ATOMIC);
1181 if (device == NULL)
1182 break;
1183
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001184 /*
1185 * Do minimal intialization of the device here, the
Stefan Richter62305822009-01-09 20:49:37 +01001186 * rest will happen in fw_device_init().
1187 *
1188 * Attention: A lot of things, even fw_device_get(),
1189 * cannot be done before fw_device_init() finished!
1190 * You can basically just check device->state and
1191 * schedule work until then, but only while holding
1192 * card->lock.
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001193 */
Stefan Richter641f8792007-01-27 10:34:55 +01001194 atomic_set(&device->state, FW_DEVICE_INITIALIZING);
Stefan Richter459f7922008-05-24 16:50:22 +02001195 device->card = fw_card_get(card);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001196 device->node = fw_node_get(node);
1197 device->node_id = node->node_id;
1198 device->generation = card->generation;
Stefan Richter92368892009-05-13 21:42:14 +02001199 device->is_local = node == card->local_node;
Stefan Richterd67cfb92008-10-05 10:37:11 +02001200 mutex_init(&device->client_list_mutex);
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -05001201 INIT_LIST_HEAD(&device->client_list);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001202
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001203 /*
1204 * Set the node data to point back to this device so
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001205 * FW_NODE_UPDATED callbacks can update the node_id
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001206 * and generation for the device.
1207 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001208 node->data = device;
1209
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001210 /*
1211 * Many devices are slow to respond after bus resets,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001212 * especially if they are bus powered and go through
1213 * power-up after getting plugged in. We schedule the
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001214 * first config rom scan half a second after bus reset.
1215 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001216 INIT_DELAYED_WORK(&device->work, fw_device_init);
1217 schedule_delayed_work(&device->work, INITIAL_DELAY);
1218 break;
1219
Stefan Richterc9755e12008-03-24 20:54:28 +01001220 case FW_NODE_INITIATED_RESET:
Stefan Richter115881d2011-03-15 00:08:41 +01001221 case FW_NODE_LINK_ON:
Stefan Richterc9755e12008-03-24 20:54:28 +01001222 device = node->data;
1223 if (device == NULL)
1224 goto create;
1225
1226 device->node_id = node->node_id;
1227 smp_wmb(); /* update node_id before generation */
1228 device->generation = card->generation;
1229 if (atomic_cmpxchg(&device->state,
1230 FW_DEVICE_RUNNING,
1231 FW_DEVICE_INITIALIZING) == FW_DEVICE_RUNNING) {
1232 PREPARE_DELAYED_WORK(&device->work, fw_device_refresh);
1233 schedule_delayed_work(&device->work,
Stefan Richter92368892009-05-13 21:42:14 +02001234 device->is_local ? 0 : INITIAL_DELAY);
Stefan Richterc9755e12008-03-24 20:54:28 +01001235 }
1236 break;
1237
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001238 case FW_NODE_UPDATED:
Stefan Richter115881d2011-03-15 00:08:41 +01001239 device = node->data;
1240 if (device == NULL)
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001241 break;
1242
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001243 device->node_id = node->node_id;
Stefan Richterb5d2a5e2008-01-25 18:57:41 +01001244 smp_wmb(); /* update node_id before generation */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001245 device->generation = card->generation;
Kristian Høgsberg5f480472007-03-07 12:12:39 -05001246 if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
1247 PREPARE_DELAYED_WORK(&device->work, fw_device_update);
1248 schedule_delayed_work(&device->work, 0);
1249 }
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001250 break;
1251
1252 case FW_NODE_DESTROYED:
1253 case FW_NODE_LINK_OFF:
1254 if (!node->data)
1255 break;
1256
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001257 /*
1258 * Destroy the device associated with the node. There
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001259 * are two cases here: either the device is fully
1260 * initialized (FW_DEVICE_RUNNING) or we're in the
1261 * process of reading its config rom
1262 * (FW_DEVICE_INITIALIZING). If it is fully
1263 * initialized we can reuse device->work to schedule a
1264 * full fw_device_shutdown(). If not, there's work
1265 * scheduled to read it's config rom, and we just put
1266 * the device in shutdown state to have that code fail
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001267 * to create the device.
1268 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001269 device = node->data;
Stefan Richter641f8792007-01-27 10:34:55 +01001270 if (atomic_xchg(&device->state,
Stefan Richter3d36a0d2009-01-17 22:45:54 +01001271 FW_DEVICE_GONE) == FW_DEVICE_RUNNING) {
Kristian Høgsberg5f480472007-03-07 12:12:39 -05001272 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
Stefan Richtere747a5c2009-01-24 20:35:38 +01001273 schedule_delayed_work(&device->work,
1274 list_empty(&card->link) ? 0 : SHUTDOWN_DELAY);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05001275 }
1276 break;
1277 }
1278}