2 * Device probing and sysfs code.
4 * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
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.
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.
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.
21 #include <linux/bug.h>
22 #include <linux/ctype.h>
23 #include <linux/delay.h>
24 #include <linux/device.h>
25 #include <linux/errno.h>
26 #include <linux/firewire.h>
27 #include <linux/firewire-constants.h>
28 #include <linux/idr.h>
29 #include <linux/jiffies.h>
30 #include <linux/kobject.h>
31 #include <linux/list.h>
32 #include <linux/mod_devicetable.h>
33 #include <linux/module.h>
34 #include <linux/mutex.h>
35 #include <linux/rwsem.h>
36 #include <linux/slab.h>
37 #include <linux/spinlock.h>
38 #include <linux/string.h>
39 #include <linux/workqueue.h>
41 #include <linux/atomic.h>
42 #include <asm/byteorder.h>
43 #include <asm/system.h>
47 void fw_csr_iterator_init(struct fw_csr_iterator *ci, const u32 *p)
50 ci->end = ci->p + (p[0] >> 16);
52 EXPORT_SYMBOL(fw_csr_iterator_init);
54 int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value)
57 *value = *ci->p & 0xffffff;
59 return ci->p++ < ci->end;
61 EXPORT_SYMBOL(fw_csr_iterator_next);
63 static const u32 *search_leaf(const u32 *directory, int search_key)
65 struct fw_csr_iterator ci;
66 int last_key = 0, key, value;
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;
80 static int textual_leaf_to_string(const u32 *block, char *buf, size_t size)
82 unsigned int quadlets, i;
88 quadlets = min(block[0] >> 16, 256U);
92 if (block[1] != 0 || block[2] != 0)
93 /* unknown language/character set */
98 for (i = 0; i < quadlets * 4 && i < size - 1; i++) {
99 c = block[i / 4] >> (24 - 8 * (i % 4));
110 * 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
116 * 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.
120 int fw_csr_string(const u32 *directory, int key, char *buf, size_t size)
122 const u32 *leaf = search_leaf(directory, key);
126 return textual_leaf_to_string(leaf, buf, size);
128 EXPORT_SYMBOL(fw_csr_string);
130 static void get_ids(const u32 *directory, int *id)
132 struct fw_csr_iterator ci;
135 fw_csr_iterator_init(&ci, directory);
136 while (fw_csr_iterator_next(&ci, &key, &value)) {
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;
146 static void get_modalias_ids(struct fw_unit *unit, int *id)
148 get_ids(&fw_parent_device(unit)->config_rom[5], id);
149 get_ids(unit->directory, id);
152 static bool match_ids(const struct ieee1394_device_id *id_table, int *id)
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;
165 return (match & id_table->match_flags) == id_table->match_flags;
168 static bool is_fw_unit(struct device *dev);
170 static int fw_unit_match(struct device *dev, struct device_driver *drv)
172 const struct ieee1394_device_id *id_table =
173 container_of(drv, struct fw_driver, driver)->id_table;
174 int id[] = {0, 0, 0, 0};
176 /* We only allow binding to fw_units. */
177 if (!is_fw_unit(dev))
180 get_modalias_ids(fw_unit(dev), id);
182 for (; id_table->match_flags != 0; id_table++)
183 if (match_ids(id_table, id))
189 static int get_modalias(struct fw_unit *unit, char *buffer, size_t buffer_size)
191 int id[] = {0, 0, 0, 0};
193 get_modalias_ids(unit, id);
195 return snprintf(buffer, buffer_size,
196 "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
197 id[0], id[1], id[2], id[3]);
200 static int fw_unit_uevent(struct device *dev, struct kobj_uevent_env *env)
202 struct fw_unit *unit = fw_unit(dev);
205 get_modalias(unit, modalias, sizeof(modalias));
207 if (add_uevent_var(env, "MODALIAS=%s", modalias))
213 struct bus_type fw_bus_type = {
215 .match = fw_unit_match,
217 EXPORT_SYMBOL(fw_bus_type);
219 int fw_device_enable_phys_dma(struct fw_device *device)
221 int generation = device->generation;
223 /* device->node_id, accessed below, must not be older than generation */
226 return device->card->driver->enable_phys_dma(device->card,
230 EXPORT_SYMBOL(fw_device_enable_phys_dma);
232 struct config_rom_attribute {
233 struct device_attribute attr;
237 static ssize_t show_immediate(struct device *dev,
238 struct device_attribute *dattr, char *buf)
240 struct config_rom_attribute *attr =
241 container_of(dattr, struct config_rom_attribute, attr);
242 struct fw_csr_iterator ci;
244 int key, value, ret = -ENOENT;
246 down_read(&fw_device_rwsem);
249 dir = fw_unit(dev)->directory;
251 dir = fw_device(dev)->config_rom + 5;
253 fw_csr_iterator_init(&ci, dir);
254 while (fw_csr_iterator_next(&ci, &key, &value))
255 if (attr->key == key) {
256 ret = snprintf(buf, buf ? PAGE_SIZE : 0,
261 up_read(&fw_device_rwsem);
266 #define IMMEDIATE_ATTR(name, key) \
267 { __ATTR(name, S_IRUGO, show_immediate, NULL), key }
269 static ssize_t show_text_leaf(struct device *dev,
270 struct device_attribute *dattr, char *buf)
272 struct config_rom_attribute *attr =
273 container_of(dattr, struct config_rom_attribute, attr);
279 down_read(&fw_device_rwsem);
282 dir = fw_unit(dev)->directory;
284 dir = fw_device(dev)->config_rom + 5;
287 bufsize = PAGE_SIZE - 1;
293 ret = fw_csr_string(dir, attr->key, buf, bufsize);
296 /* Strip trailing whitespace and add newline. */
297 while (ret > 0 && isspace(buf[ret - 1]))
299 strcpy(buf + ret, "\n");
303 up_read(&fw_device_rwsem);
308 #define TEXT_LEAF_ATTR(name, key) \
309 { __ATTR(name, S_IRUGO, show_text_leaf, NULL), key }
311 static 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),
322 static void init_fw_attribute_group(struct device *dev,
323 struct device_attribute *attrs,
324 struct fw_attribute_group *group)
326 struct device_attribute *attr;
329 for (j = 0; attrs[j].attr.name != NULL; j++)
330 group->attrs[j] = &attrs[j].attr;
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)
336 group->attrs[j++] = &attr->attr;
339 group->attrs[j] = NULL;
340 group->groups[0] = &group->group;
341 group->groups[1] = NULL;
342 group->group.attrs = group->attrs;
343 dev->groups = (const struct attribute_group **) group->groups;
346 static ssize_t modalias_show(struct device *dev,
347 struct device_attribute *attr, char *buf)
349 struct fw_unit *unit = fw_unit(dev);
352 length = get_modalias(unit, buf, PAGE_SIZE);
353 strcpy(buf + length, "\n");
358 static ssize_t rom_index_show(struct device *dev,
359 struct device_attribute *attr, char *buf)
361 struct fw_device *device = fw_device(dev->parent);
362 struct fw_unit *unit = fw_unit(dev);
364 return snprintf(buf, PAGE_SIZE, "%d\n",
365 (int)(unit->directory - device->config_rom));
368 static struct device_attribute fw_unit_attributes[] = {
370 __ATTR_RO(rom_index),
374 static ssize_t config_rom_show(struct device *dev,
375 struct device_attribute *attr, char *buf)
377 struct fw_device *device = fw_device(dev);
380 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);
388 static ssize_t guid_show(struct device *dev,
389 struct device_attribute *attr, char *buf)
391 struct fw_device *device = fw_device(dev);
394 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);
402 static int units_sprintf(char *buf, const u32 *directory)
404 struct fw_csr_iterator ci;
406 int specifier_id = 0;
409 fw_csr_iterator_init(&ci, directory);
410 while (fw_csr_iterator_next(&ci, &key, &value)) {
412 case CSR_SPECIFIER_ID:
413 specifier_id = value;
421 return sprintf(buf, "0x%06x:0x%06x ", specifier_id, version);
424 static ssize_t units_show(struct device *dev,
425 struct device_attribute *attr, char *buf)
427 struct fw_device *device = fw_device(dev);
428 struct fw_csr_iterator ci;
429 int key, value, i = 0;
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))
436 i += units_sprintf(&buf[i], ci.p + value - 1);
437 if (i >= PAGE_SIZE - (8 + 1 + 8 + 1))
440 up_read(&fw_device_rwsem);
448 static struct device_attribute fw_device_attributes[] = {
449 __ATTR_RO(config_rom),
455 static int read_rom(struct fw_device *device,
456 int generation, int index, u32 *data)
458 u64 offset = (CSR_REGISTER_BASE | CSR_CONFIG_ROM) + index * 4;
461 /* device->node_id, accessed below, must not be older than generation */
464 for (i = 10; i < 100; i += 10) {
465 rcode = fw_run_transaction(device->card,
466 TCODE_READ_QUADLET_REQUEST, device->node_id,
467 generation, device->max_speed, offset, data, 4);
468 if (rcode != RCODE_BUSY)
477 #define MAX_CONFIG_ROM_SIZE 256
480 * Read the bus info block, perform a speed probe, and read all of the rest of
481 * the config ROM. We do all this with a cached bus generation. If the bus
482 * generation changes under us, read_config_rom will fail and get retried.
483 * It's better to start all over in this case because the node from which we
484 * are reading the ROM may have changed the ROM during the reset.
486 static int read_config_rom(struct fw_device *device, int generation)
488 const u32 *old_rom, *new_rom;
491 int i, end, length, ret = -1;
493 rom = kmalloc(sizeof(*rom) * MAX_CONFIG_ROM_SIZE +
494 sizeof(*stack) * MAX_CONFIG_ROM_SIZE, GFP_KERNEL);
498 stack = &rom[MAX_CONFIG_ROM_SIZE];
499 memset(rom, 0, sizeof(*rom) * MAX_CONFIG_ROM_SIZE);
501 device->max_speed = SCODE_100;
503 /* First read the bus info block. */
504 for (i = 0; i < 5; i++) {
505 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
508 * As per IEEE1212 7.2, during power-up, devices can
509 * reply with a 0 for the first quadlet of the config
510 * rom to indicate that they are booting (for example,
511 * if the firmware is on the disk of a external
512 * harddisk). In that case we just fail, and the
513 * retry mechanism will try again later.
515 if (i == 0 && rom[i] == 0)
519 device->max_speed = device->node->max_speed;
522 * Determine the speed of
523 * - devices with link speed less than PHY speed,
524 * - devices with 1394b PHY (unless only connected to 1394a PHYs),
525 * - all devices if there are 1394b repeaters.
526 * Note, we cannot use the bus info block's link_spd as starting point
527 * because some buggy firmwares set it lower than necessary and because
528 * 1394-1995 nodes do not have the field.
530 if ((rom[2] & 0x7) < device->max_speed ||
531 device->max_speed == SCODE_BETA ||
532 device->card->beta_repeaters_present) {
535 /* for S1600 and S3200 */
536 if (device->max_speed == SCODE_BETA)
537 device->max_speed = device->card->link_speed;
539 while (device->max_speed > SCODE_100) {
540 if (read_rom(device, generation, 0, &dummy) ==
548 * Now parse the config rom. The config rom is a recursive
549 * directory structure so we parse it using a stack of
550 * references to the blocks that make up the structure. We
551 * push a reference to the root directory on the stack to
556 stack[sp++] = 0xc0000005;
559 * Pop the next block reference of the stack. The
560 * lower 24 bits is the offset into the config rom,
561 * the upper 8 bits are the type of the reference the
566 if (WARN_ON(i >= MAX_CONFIG_ROM_SIZE))
569 /* Read header quadlet for the block to get the length. */
570 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
572 end = i + (rom[i] >> 16) + 1;
573 if (end > MAX_CONFIG_ROM_SIZE) {
575 * This block extends outside the config ROM which is
576 * a firmware bug. Ignore this whole block, i.e.
577 * simply set a fake block length of 0.
579 fw_error("skipped invalid ROM block %x at %llx\n",
581 i * 4 | CSR_REGISTER_BASE | CSR_CONFIG_ROM);
588 * Now read in the block. If this is a directory
589 * block, check the entries as we read them to see if
590 * it references another block, and push it in that case.
592 for (; i < end; i++) {
593 if (read_rom(device, generation, i, &rom[i]) !=
597 if ((key >> 30) != 3 || (rom[i] >> 30) < 2)
600 * Offset points outside the ROM. May be a firmware
601 * bug or an Extended ROM entry (IEEE 1212-2001 clause
602 * 7.7.18). Simply overwrite this pointer here by a
603 * fake immediate entry so that later iterators over
604 * the ROM don't have to check offsets all the time.
606 if (i + (rom[i] & 0xffffff) >= MAX_CONFIG_ROM_SIZE) {
607 fw_error("skipped unsupported ROM entry %x at %llx\n",
609 i * 4 | CSR_REGISTER_BASE | CSR_CONFIG_ROM);
613 stack[sp++] = i + rom[i];
619 old_rom = device->config_rom;
620 new_rom = kmemdup(rom, length * 4, GFP_KERNEL);
624 down_write(&fw_device_rwsem);
625 device->config_rom = new_rom;
626 device->config_rom_length = length;
627 up_write(&fw_device_rwsem);
631 device->max_rec = rom[2] >> 12 & 0xf;
632 device->cmc = rom[2] >> 30 & 1;
633 device->irmc = rom[2] >> 31 & 1;
640 static void fw_unit_release(struct device *dev)
642 struct fw_unit *unit = fw_unit(dev);
644 fw_device_put(fw_parent_device(unit));
648 static struct device_type fw_unit_type = {
649 .uevent = fw_unit_uevent,
650 .release = fw_unit_release,
653 static bool is_fw_unit(struct device *dev)
655 return dev->type == &fw_unit_type;
658 static void create_units(struct fw_device *device)
660 struct fw_csr_iterator ci;
661 struct fw_unit *unit;
665 fw_csr_iterator_init(&ci, &device->config_rom[5]);
666 while (fw_csr_iterator_next(&ci, &key, &value)) {
667 if (key != (CSR_UNIT | CSR_DIRECTORY))
671 * Get the address of the unit directory and try to
672 * match the drivers id_tables against it.
674 unit = kzalloc(sizeof(*unit), GFP_KERNEL);
676 fw_error("failed to allocate memory for unit\n");
680 unit->directory = ci.p + value - 1;
681 unit->device.bus = &fw_bus_type;
682 unit->device.type = &fw_unit_type;
683 unit->device.parent = &device->device;
684 dev_set_name(&unit->device, "%s.%d", dev_name(&device->device), i++);
686 BUILD_BUG_ON(ARRAY_SIZE(unit->attribute_group.attrs) <
687 ARRAY_SIZE(fw_unit_attributes) +
688 ARRAY_SIZE(config_rom_attributes));
689 init_fw_attribute_group(&unit->device,
691 &unit->attribute_group);
693 if (device_register(&unit->device) < 0)
696 fw_device_get(device);
704 static int shutdown_unit(struct device *device, void *data)
706 device_unregister(device);
712 * fw_device_rwsem acts as dual purpose mutex:
713 * - serializes accesses to fw_device_idr,
714 * - serializes accesses to fw_device.config_rom/.config_rom_length and
715 * fw_unit.directory, unless those accesses happen at safe occasions
717 DECLARE_RWSEM(fw_device_rwsem);
719 DEFINE_IDR(fw_device_idr);
722 struct fw_device *fw_device_get_by_devt(dev_t devt)
724 struct fw_device *device;
726 down_read(&fw_device_rwsem);
727 device = idr_find(&fw_device_idr, MINOR(devt));
729 fw_device_get(device);
730 up_read(&fw_device_rwsem);
735 struct workqueue_struct *fw_workqueue;
736 EXPORT_SYMBOL(fw_workqueue);
738 static void fw_schedule_device_work(struct fw_device *device,
741 queue_delayed_work(fw_workqueue, &device->work, delay);
745 * These defines control the retry behavior for reading the config
746 * rom. It shouldn't be necessary to tweak these; if the device
747 * doesn't respond to a config rom read within 10 seconds, it's not
748 * going to respond at all. As for the initial delay, a lot of
749 * devices will be able to respond within half a second after bus
750 * reset. On the other hand, it's not really worth being more
751 * aggressive than that, since it scales pretty well; if 10 devices
752 * are plugged in, they're all getting read within one second.
755 #define MAX_RETRIES 10
756 #define RETRY_DELAY (3 * HZ)
757 #define INITIAL_DELAY (HZ / 2)
758 #define SHUTDOWN_DELAY (2 * HZ)
760 static void fw_device_shutdown(struct work_struct *work)
762 struct fw_device *device =
763 container_of(work, struct fw_device, work.work);
764 int minor = MINOR(device->device.devt);
766 if (time_before64(get_jiffies_64(),
767 device->card->reset_jiffies + SHUTDOWN_DELAY)
768 && !list_empty(&device->card->link)) {
769 fw_schedule_device_work(device, SHUTDOWN_DELAY);
773 if (atomic_cmpxchg(&device->state,
775 FW_DEVICE_SHUTDOWN) != FW_DEVICE_GONE)
778 fw_device_cdev_remove(device);
779 device_for_each_child(&device->device, NULL, shutdown_unit);
780 device_unregister(&device->device);
782 down_write(&fw_device_rwsem);
783 idr_remove(&fw_device_idr, minor);
784 up_write(&fw_device_rwsem);
786 fw_device_put(device);
789 static void fw_device_release(struct device *dev)
791 struct fw_device *device = fw_device(dev);
792 struct fw_card *card = device->card;
796 * Take the card lock so we don't set this to NULL while a
797 * FW_NODE_UPDATED callback is being handled or while the
798 * bus manager work looks at this node.
800 spin_lock_irqsave(&card->lock, flags);
801 device->node->data = NULL;
802 spin_unlock_irqrestore(&card->lock, flags);
804 fw_node_put(device->node);
805 kfree(device->config_rom);
810 static struct device_type fw_device_type = {
811 .release = fw_device_release,
814 static bool is_fw_device(struct device *dev)
816 return dev->type == &fw_device_type;
819 static int update_unit(struct device *dev, void *data)
821 struct fw_unit *unit = fw_unit(dev);
822 struct fw_driver *driver = (struct fw_driver *)dev->driver;
824 if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
826 driver->update(unit);
833 static void fw_device_update(struct work_struct *work)
835 struct fw_device *device =
836 container_of(work, struct fw_device, work.work);
838 fw_device_cdev_update(device);
839 device_for_each_child(&device->device, NULL, update_unit);
843 * If a device was pending for deletion because its node went away but its
844 * bus info block and root directory header matches that of a newly discovered
845 * device, revive the existing fw_device.
846 * The newly allocated fw_device becomes obsolete instead.
848 static int lookup_existing_device(struct device *dev, void *data)
850 struct fw_device *old = fw_device(dev);
851 struct fw_device *new = data;
852 struct fw_card *card = new->card;
855 if (!is_fw_device(dev))
858 down_read(&fw_device_rwsem); /* serialize config_rom access */
859 spin_lock_irq(&card->lock); /* serialize node access */
861 if (memcmp(old->config_rom, new->config_rom, 6 * 4) == 0 &&
862 atomic_cmpxchg(&old->state,
864 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
865 struct fw_node *current_node = new->node;
866 struct fw_node *obsolete_node = old->node;
868 new->node = obsolete_node;
869 new->node->data = new;
870 old->node = current_node;
871 old->node->data = old;
873 old->max_speed = new->max_speed;
874 old->node_id = current_node->node_id;
875 smp_wmb(); /* update node_id before generation */
876 old->generation = card->generation;
877 old->config_rom_retries = 0;
878 fw_notify("rediscovered device %s\n", dev_name(dev));
880 PREPARE_DELAYED_WORK(&old->work, fw_device_update);
881 fw_schedule_device_work(old, 0);
883 if (current_node == card->root_node)
884 fw_schedule_bm_work(card, 0);
889 spin_unlock_irq(&card->lock);
890 up_read(&fw_device_rwsem);
895 enum { BC_UNKNOWN = 0, BC_UNIMPLEMENTED, BC_IMPLEMENTED, };
897 static void set_broadcast_channel(struct fw_device *device, int generation)
899 struct fw_card *card = device->card;
903 if (!card->broadcast_channel_allocated)
907 * The Broadcast_Channel Valid bit is required by nodes which want to
908 * transmit on this channel. Such transmissions are practically
909 * exclusive to IP over 1394 (RFC 2734). IP capable nodes are required
910 * to be IRM capable and have a max_rec of 8 or more. We use this fact
911 * to narrow down to which nodes we send Broadcast_Channel updates.
913 if (!device->irmc || device->max_rec < 8)
917 * Some 1394-1995 nodes crash if this 1394a-2000 register is written.
918 * Perform a read test first.
920 if (device->bc_implemented == BC_UNKNOWN) {
921 rcode = fw_run_transaction(card, TCODE_READ_QUADLET_REQUEST,
922 device->node_id, generation, device->max_speed,
923 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
927 if (data & cpu_to_be32(1 << 31)) {
928 device->bc_implemented = BC_IMPLEMENTED;
931 /* else fall through to case address error */
932 case RCODE_ADDRESS_ERROR:
933 device->bc_implemented = BC_UNIMPLEMENTED;
937 if (device->bc_implemented == BC_IMPLEMENTED) {
938 data = cpu_to_be32(BROADCAST_CHANNEL_INITIAL |
939 BROADCAST_CHANNEL_VALID);
940 fw_run_transaction(card, TCODE_WRITE_QUADLET_REQUEST,
941 device->node_id, generation, device->max_speed,
942 CSR_REGISTER_BASE + CSR_BROADCAST_CHANNEL,
947 int fw_device_set_broadcast_channel(struct device *dev, void *gen)
949 if (is_fw_device(dev))
950 set_broadcast_channel(fw_device(dev), (long)gen);
955 static void fw_device_init(struct work_struct *work)
957 struct fw_device *device =
958 container_of(work, struct fw_device, work.work);
959 struct device *revived_dev;
963 * All failure paths here set node->data to NULL, so that we
964 * don't try to do device_for_each_child() on a kfree()'d
968 if (read_config_rom(device, device->generation) < 0) {
969 if (device->config_rom_retries < MAX_RETRIES &&
970 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
971 device->config_rom_retries++;
972 fw_schedule_device_work(device, RETRY_DELAY);
974 if (device->node->link_on)
975 fw_notify("giving up on config rom for node id %x\n",
977 if (device->node == device->card->root_node)
978 fw_schedule_bm_work(device->card, 0);
979 fw_device_release(&device->device);
984 revived_dev = device_find_child(device->card->device,
985 device, lookup_existing_device);
987 put_device(revived_dev);
988 fw_device_release(&device->device);
993 device_initialize(&device->device);
995 fw_device_get(device);
996 down_write(&fw_device_rwsem);
997 ret = idr_pre_get(&fw_device_idr, GFP_KERNEL) ?
998 idr_get_new(&fw_device_idr, device, &minor) :
1000 up_write(&fw_device_rwsem);
1005 device->device.bus = &fw_bus_type;
1006 device->device.type = &fw_device_type;
1007 device->device.parent = device->card->device;
1008 device->device.devt = MKDEV(fw_cdev_major, minor);
1009 dev_set_name(&device->device, "fw%d", minor);
1011 BUILD_BUG_ON(ARRAY_SIZE(device->attribute_group.attrs) <
1012 ARRAY_SIZE(fw_device_attributes) +
1013 ARRAY_SIZE(config_rom_attributes));
1014 init_fw_attribute_group(&device->device,
1015 fw_device_attributes,
1016 &device->attribute_group);
1018 if (device_add(&device->device)) {
1019 fw_error("Failed to add device.\n");
1020 goto error_with_cdev;
1023 create_units(device);
1026 * Transition the device to running state. If it got pulled
1027 * out from under us while we did the intialization work, we
1028 * have to shut down the device again here. Normally, though,
1029 * fw_node_event will be responsible for shutting it down when
1030 * necessary. We have to use the atomic cmpxchg here to avoid
1031 * racing with the FW_NODE_DESTROYED case in
1034 if (atomic_cmpxchg(&device->state,
1035 FW_DEVICE_INITIALIZING,
1036 FW_DEVICE_RUNNING) == FW_DEVICE_GONE) {
1037 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1038 fw_schedule_device_work(device, SHUTDOWN_DELAY);
1040 if (device->config_rom_retries)
1041 fw_notify("created device %s: GUID %08x%08x, S%d00, "
1042 "%d config ROM retries\n",
1043 dev_name(&device->device),
1044 device->config_rom[3], device->config_rom[4],
1045 1 << device->max_speed,
1046 device->config_rom_retries);
1048 fw_notify("created device %s: GUID %08x%08x, S%d00\n",
1049 dev_name(&device->device),
1050 device->config_rom[3], device->config_rom[4],
1051 1 << device->max_speed);
1052 device->config_rom_retries = 0;
1054 set_broadcast_channel(device, device->generation);
1058 * Reschedule the IRM work if we just finished reading the
1059 * root node config rom. If this races with a bus reset we
1060 * just end up running the IRM work a couple of extra times -
1063 if (device->node == device->card->root_node)
1064 fw_schedule_bm_work(device->card, 0);
1069 down_write(&fw_device_rwsem);
1070 idr_remove(&fw_device_idr, minor);
1071 up_write(&fw_device_rwsem);
1073 fw_device_put(device); /* fw_device_idr's reference */
1075 put_device(&device->device); /* our reference */
1081 REREAD_BIB_UNCHANGED,
1085 /* Reread and compare bus info block and header of root directory */
1086 static int reread_config_rom(struct fw_device *device, int generation)
1091 for (i = 0; i < 6; i++) {
1092 if (read_rom(device, generation, i, &q) != RCODE_COMPLETE)
1093 return REREAD_BIB_ERROR;
1095 if (i == 0 && q == 0)
1096 return REREAD_BIB_GONE;
1098 if (q != device->config_rom[i])
1099 return REREAD_BIB_CHANGED;
1102 return REREAD_BIB_UNCHANGED;
1105 static void fw_device_refresh(struct work_struct *work)
1107 struct fw_device *device =
1108 container_of(work, struct fw_device, work.work);
1109 struct fw_card *card = device->card;
1110 int node_id = device->node_id;
1112 switch (reread_config_rom(device, device->generation)) {
1113 case REREAD_BIB_ERROR:
1114 if (device->config_rom_retries < MAX_RETRIES / 2 &&
1115 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
1116 device->config_rom_retries++;
1117 fw_schedule_device_work(device, RETRY_DELAY / 2);
1123 case REREAD_BIB_GONE:
1126 case REREAD_BIB_UNCHANGED:
1127 if (atomic_cmpxchg(&device->state,
1128 FW_DEVICE_INITIALIZING,
1129 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
1132 fw_device_update(work);
1133 device->config_rom_retries = 0;
1136 case REREAD_BIB_CHANGED:
1141 * Something changed. We keep things simple and don't investigate
1142 * further. We just destroy all previous units and create new ones.
1144 device_for_each_child(&device->device, NULL, shutdown_unit);
1146 if (read_config_rom(device, device->generation) < 0) {
1147 if (device->config_rom_retries < MAX_RETRIES &&
1148 atomic_read(&device->state) == FW_DEVICE_INITIALIZING) {
1149 device->config_rom_retries++;
1150 fw_schedule_device_work(device, RETRY_DELAY);
1157 fw_device_cdev_update(device);
1158 create_units(device);
1160 /* Userspace may want to re-read attributes. */
1161 kobject_uevent(&device->device.kobj, KOBJ_CHANGE);
1163 if (atomic_cmpxchg(&device->state,
1164 FW_DEVICE_INITIALIZING,
1165 FW_DEVICE_RUNNING) == FW_DEVICE_GONE)
1168 fw_notify("refreshed device %s\n", dev_name(&device->device));
1169 device->config_rom_retries = 0;
1173 fw_notify("giving up on refresh of device %s\n", dev_name(&device->device));
1175 atomic_set(&device->state, FW_DEVICE_GONE);
1176 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1177 fw_schedule_device_work(device, SHUTDOWN_DELAY);
1179 if (node_id == card->root_node->node_id)
1180 fw_schedule_bm_work(card, 0);
1183 void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
1185 struct fw_device *device;
1188 case FW_NODE_CREATED:
1190 * Attempt to scan the node, regardless whether its self ID has
1191 * the L (link active) flag set or not. Some broken devices
1192 * send L=0 but have an up-and-running link; others send L=1
1193 * without actually having a link.
1196 device = kzalloc(sizeof(*device), GFP_ATOMIC);
1201 * Do minimal intialization of the device here, the
1202 * rest will happen in fw_device_init().
1204 * Attention: A lot of things, even fw_device_get(),
1205 * cannot be done before fw_device_init() finished!
1206 * You can basically just check device->state and
1207 * schedule work until then, but only while holding
1210 atomic_set(&device->state, FW_DEVICE_INITIALIZING);
1211 device->card = fw_card_get(card);
1212 device->node = fw_node_get(node);
1213 device->node_id = node->node_id;
1214 device->generation = card->generation;
1215 device->is_local = node == card->local_node;
1216 mutex_init(&device->client_list_mutex);
1217 INIT_LIST_HEAD(&device->client_list);
1220 * Set the node data to point back to this device so
1221 * FW_NODE_UPDATED callbacks can update the node_id
1222 * and generation for the device.
1224 node->data = device;
1227 * Many devices are slow to respond after bus resets,
1228 * especially if they are bus powered and go through
1229 * power-up after getting plugged in. We schedule the
1230 * first config rom scan half a second after bus reset.
1232 INIT_DELAYED_WORK(&device->work, fw_device_init);
1233 fw_schedule_device_work(device, INITIAL_DELAY);
1236 case FW_NODE_INITIATED_RESET:
1237 case FW_NODE_LINK_ON:
1238 device = node->data;
1242 device->node_id = node->node_id;
1243 smp_wmb(); /* update node_id before generation */
1244 device->generation = card->generation;
1245 if (atomic_cmpxchg(&device->state,
1247 FW_DEVICE_INITIALIZING) == FW_DEVICE_RUNNING) {
1248 PREPARE_DELAYED_WORK(&device->work, fw_device_refresh);
1249 fw_schedule_device_work(device,
1250 device->is_local ? 0 : INITIAL_DELAY);
1254 case FW_NODE_UPDATED:
1255 device = node->data;
1259 device->node_id = node->node_id;
1260 smp_wmb(); /* update node_id before generation */
1261 device->generation = card->generation;
1262 if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
1263 PREPARE_DELAYED_WORK(&device->work, fw_device_update);
1264 fw_schedule_device_work(device, 0);
1268 case FW_NODE_DESTROYED:
1269 case FW_NODE_LINK_OFF:
1274 * Destroy the device associated with the node. There
1275 * are two cases here: either the device is fully
1276 * initialized (FW_DEVICE_RUNNING) or we're in the
1277 * process of reading its config rom
1278 * (FW_DEVICE_INITIALIZING). If it is fully
1279 * initialized we can reuse device->work to schedule a
1280 * full fw_device_shutdown(). If not, there's work
1281 * scheduled to read it's config rom, and we just put
1282 * the device in shutdown state to have that code fail
1283 * to create the device.
1285 device = node->data;
1286 if (atomic_xchg(&device->state,
1287 FW_DEVICE_GONE) == FW_DEVICE_RUNNING) {
1288 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
1289 fw_schedule_device_work(device,
1290 list_empty(&card->link) ? 0 : SHUTDOWN_DELAY);