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/module.h>
22 #include <linux/wait.h>
23 #include <linux/errno.h>
24 #include <linux/kthread.h>
25 #include <linux/device.h>
26 #include <linux/delay.h>
27 #include <linux/idr.h>
28 #include <linux/rwsem.h>
29 #include <asm/semaphore.h>
30 #include <asm/system.h>
31 #include <linux/ctype.h>
32 #include "fw-transaction.h"
33 #include "fw-topology.h"
34 #include "fw-device.h"
36 void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 * p)
39 ci->end = ci->p + (p[0] >> 16);
41 EXPORT_SYMBOL(fw_csr_iterator_init);
43 int fw_csr_iterator_next(struct fw_csr_iterator *ci, int *key, int *value)
46 *value = *ci->p & 0xffffff;
48 return ci->p++ < ci->end;
50 EXPORT_SYMBOL(fw_csr_iterator_next);
52 static int is_fw_unit(struct device *dev);
54 static int match_unit_directory(u32 * directory, const struct fw_device_id *id)
56 struct fw_csr_iterator ci;
57 int key, value, match;
60 fw_csr_iterator_init(&ci, directory);
61 while (fw_csr_iterator_next(&ci, &key, &value)) {
62 if (key == CSR_VENDOR && value == id->vendor)
63 match |= FW_MATCH_VENDOR;
64 if (key == CSR_MODEL && value == id->model)
65 match |= FW_MATCH_MODEL;
66 if (key == CSR_SPECIFIER_ID && value == id->specifier_id)
67 match |= FW_MATCH_SPECIFIER_ID;
68 if (key == CSR_VERSION && value == id->version)
69 match |= FW_MATCH_VERSION;
72 return (match & id->match_flags) == id->match_flags;
75 static int fw_unit_match(struct device *dev, struct device_driver *drv)
77 struct fw_unit *unit = fw_unit(dev);
78 struct fw_driver *driver = fw_driver(drv);
81 /* We only allow binding to fw_units. */
85 for (i = 0; driver->id_table[i].match_flags != 0; i++) {
86 if (match_unit_directory(unit->directory, &driver->id_table[i]))
93 static int get_modalias(struct fw_unit *unit, char *buffer, size_t buffer_size)
95 struct fw_device *device = fw_device(unit->device.parent);
96 struct fw_csr_iterator ci;
101 int specifier_id = 0;
104 fw_csr_iterator_init(&ci, &device->config_rom[5]);
105 while (fw_csr_iterator_next(&ci, &key, &value)) {
116 fw_csr_iterator_init(&ci, unit->directory);
117 while (fw_csr_iterator_next(&ci, &key, &value)) {
119 case CSR_SPECIFIER_ID:
120 specifier_id = value;
128 return snprintf(buffer, buffer_size,
129 "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
130 vendor, model, specifier_id, version);
134 fw_unit_uevent(struct device *dev, struct kobj_uevent_env *env)
136 struct fw_unit *unit = fw_unit(dev);
139 get_modalias(unit, modalias, sizeof(modalias));
141 if (add_uevent_var(env, "MODALIAS=%s", modalias))
147 struct bus_type fw_bus_type = {
149 .match = fw_unit_match,
151 EXPORT_SYMBOL(fw_bus_type);
153 struct fw_device *fw_device_get(struct fw_device *device)
155 get_device(&device->device);
160 void fw_device_put(struct fw_device *device)
162 put_device(&device->device);
165 static void fw_device_release(struct device *dev)
167 struct fw_device *device = fw_device(dev);
171 * Take the card lock so we don't set this to NULL while a
172 * FW_NODE_UPDATED callback is being handled.
174 spin_lock_irqsave(&device->card->lock, flags);
175 device->node->data = NULL;
176 spin_unlock_irqrestore(&device->card->lock, flags);
178 fw_node_put(device->node);
179 fw_card_put(device->card);
180 kfree(device->config_rom);
184 int fw_device_enable_phys_dma(struct fw_device *device)
186 int generation = device->generation;
188 /* device->node_id, accessed below, must not be older than generation */
191 return device->card->driver->enable_phys_dma(device->card,
195 EXPORT_SYMBOL(fw_device_enable_phys_dma);
197 struct config_rom_attribute {
198 struct device_attribute attr;
203 show_immediate(struct device *dev, struct device_attribute *dattr, char *buf)
205 struct config_rom_attribute *attr =
206 container_of(dattr, struct config_rom_attribute, attr);
207 struct fw_csr_iterator ci;
212 dir = fw_unit(dev)->directory;
214 dir = fw_device(dev)->config_rom + 5;
216 fw_csr_iterator_init(&ci, dir);
217 while (fw_csr_iterator_next(&ci, &key, &value))
218 if (attr->key == key)
219 return snprintf(buf, buf ? PAGE_SIZE : 0,
225 #define IMMEDIATE_ATTR(name, key) \
226 { __ATTR(name, S_IRUGO, show_immediate, NULL), key }
229 show_text_leaf(struct device *dev, struct device_attribute *dattr, char *buf)
231 struct config_rom_attribute *attr =
232 container_of(dattr, struct config_rom_attribute, attr);
233 struct fw_csr_iterator ci;
234 u32 *dir, *block = NULL, *p, *end;
235 int length, key, value, last_key = 0;
239 dir = fw_unit(dev)->directory;
241 dir = fw_device(dev)->config_rom + 5;
243 fw_csr_iterator_init(&ci, dir);
244 while (fw_csr_iterator_next(&ci, &key, &value)) {
245 if (attr->key == last_key &&
246 key == (CSR_DESCRIPTOR | CSR_LEAF))
247 block = ci.p - 1 + value;
254 length = min(block[0] >> 16, 256U);
258 if (block[1] != 0 || block[2] != 0)
259 /* Unknown encoding. */
266 end = &block[length + 1];
267 for (p = &block[3]; p < end; p++, b += 4)
268 * (u32 *) b = (__force u32) __cpu_to_be32(*p);
270 /* Strip trailing whitespace and add newline. */
271 while (b--, (isspace(*b) || *b == '\0') && b > buf);
277 #define TEXT_LEAF_ATTR(name, key) \
278 { __ATTR(name, S_IRUGO, show_text_leaf, NULL), key }
280 static struct config_rom_attribute config_rom_attributes[] = {
281 IMMEDIATE_ATTR(vendor, CSR_VENDOR),
282 IMMEDIATE_ATTR(hardware_version, CSR_HARDWARE_VERSION),
283 IMMEDIATE_ATTR(specifier_id, CSR_SPECIFIER_ID),
284 IMMEDIATE_ATTR(version, CSR_VERSION),
285 IMMEDIATE_ATTR(model, CSR_MODEL),
286 TEXT_LEAF_ATTR(vendor_name, CSR_VENDOR),
287 TEXT_LEAF_ATTR(model_name, CSR_MODEL),
288 TEXT_LEAF_ATTR(hardware_version_name, CSR_HARDWARE_VERSION),
292 init_fw_attribute_group(struct device *dev,
293 struct device_attribute *attrs,
294 struct fw_attribute_group *group)
296 struct device_attribute *attr;
299 for (j = 0; attrs[j].attr.name != NULL; j++)
300 group->attrs[j] = &attrs[j].attr;
302 for (i = 0; i < ARRAY_SIZE(config_rom_attributes); i++) {
303 attr = &config_rom_attributes[i].attr;
304 if (attr->show(dev, attr, NULL) < 0)
306 group->attrs[j++] = &attr->attr;
309 BUG_ON(j >= ARRAY_SIZE(group->attrs));
310 group->attrs[j++] = NULL;
311 group->groups[0] = &group->group;
312 group->groups[1] = NULL;
313 group->group.attrs = group->attrs;
314 dev->groups = group->groups;
318 modalias_show(struct device *dev,
319 struct device_attribute *attr, char *buf)
321 struct fw_unit *unit = fw_unit(dev);
324 length = get_modalias(unit, buf, PAGE_SIZE);
325 strcpy(buf + length, "\n");
331 rom_index_show(struct device *dev,
332 struct device_attribute *attr, char *buf)
334 struct fw_device *device = fw_device(dev->parent);
335 struct fw_unit *unit = fw_unit(dev);
337 return snprintf(buf, PAGE_SIZE, "%d\n",
338 (int)(unit->directory - device->config_rom));
341 static struct device_attribute fw_unit_attributes[] = {
343 __ATTR_RO(rom_index),
348 config_rom_show(struct device *dev, struct device_attribute *attr, char *buf)
350 struct fw_device *device = fw_device(dev);
352 memcpy(buf, device->config_rom, device->config_rom_length * 4);
354 return device->config_rom_length * 4;
358 guid_show(struct device *dev, struct device_attribute *attr, char *buf)
360 struct fw_device *device = fw_device(dev);
362 return snprintf(buf, PAGE_SIZE, "0x%08x%08x\n",
363 device->config_rom[3], device->config_rom[4]);
366 static struct device_attribute fw_device_attributes[] = {
367 __ATTR_RO(config_rom),
372 struct read_quadlet_callback_data {
373 struct completion done;
379 complete_transaction(struct fw_card *card, int rcode,
380 void *payload, size_t length, void *data)
382 struct read_quadlet_callback_data *callback_data = data;
384 if (rcode == RCODE_COMPLETE)
385 callback_data->data = be32_to_cpu(*(__be32 *)payload);
386 callback_data->rcode = rcode;
387 complete(&callback_data->done);
391 read_rom(struct fw_device *device, int generation, int index, u32 *data)
393 struct read_quadlet_callback_data callback_data;
394 struct fw_transaction t;
397 /* device->node_id, accessed below, must not be older than generation */
400 init_completion(&callback_data.done);
402 offset = 0xfffff0000400ULL + index * 4;
403 fw_send_request(device->card, &t, TCODE_READ_QUADLET_REQUEST,
404 device->node_id, generation, device->max_speed,
405 offset, NULL, 4, complete_transaction, &callback_data);
407 wait_for_completion(&callback_data.done);
409 *data = callback_data.data;
411 return callback_data.rcode;
415 * Read the bus info block, perform a speed probe, and read all of the rest of
416 * the config ROM. We do all this with a cached bus generation. If the bus
417 * generation changes under us, read_bus_info_block will fail and get retried.
418 * It's better to start all over in this case because the node from which we
419 * are reading the ROM may have changed the ROM during the reset.
421 static int read_bus_info_block(struct fw_device *device, int generation)
424 u32 stack[16], sp, key;
427 device->max_speed = SCODE_100;
429 /* First read the bus info block. */
430 for (i = 0; i < 5; i++) {
431 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
434 * As per IEEE1212 7.2, during power-up, devices can
435 * reply with a 0 for the first quadlet of the config
436 * rom to indicate that they are booting (for example,
437 * if the firmware is on the disk of a external
438 * harddisk). In that case we just fail, and the
439 * retry mechanism will try again later.
441 if (i == 0 && rom[i] == 0)
445 device->max_speed = device->node->max_speed;
448 * Determine the speed of
449 * - devices with link speed less than PHY speed,
450 * - devices with 1394b PHY (unless only connected to 1394a PHYs),
451 * - all devices if there are 1394b repeaters.
452 * Note, we cannot use the bus info block's link_spd as starting point
453 * because some buggy firmwares set it lower than necessary and because
454 * 1394-1995 nodes do not have the field.
456 if ((rom[2] & 0x7) < device->max_speed ||
457 device->max_speed == SCODE_BETA ||
458 device->card->beta_repeaters_present) {
461 /* for S1600 and S3200 */
462 if (device->max_speed == SCODE_BETA)
463 device->max_speed = device->card->link_speed;
465 while (device->max_speed > SCODE_100) {
466 if (read_rom(device, generation, 0, &dummy) ==
474 * Now parse the config rom. The config rom is a recursive
475 * directory structure so we parse it using a stack of
476 * references to the blocks that make up the structure. We
477 * push a reference to the root directory on the stack to
482 stack[sp++] = 0xc0000005;
485 * Pop the next block reference of the stack. The
486 * lower 24 bits is the offset into the config rom,
487 * the upper 8 bits are the type of the reference the
492 if (i >= ARRAY_SIZE(rom))
494 * The reference points outside the standard
495 * config rom area, something's fishy.
499 /* Read header quadlet for the block to get the length. */
500 if (read_rom(device, generation, i, &rom[i]) != RCODE_COMPLETE)
502 end = i + (rom[i] >> 16) + 1;
504 if (end > ARRAY_SIZE(rom))
506 * This block extends outside standard config
507 * area (and the array we're reading it
508 * into). That's broken, so ignore this
514 * Now read in the block. If this is a directory
515 * block, check the entries as we read them to see if
516 * it references another block, and push it in that case.
519 if (read_rom(device, generation, i, &rom[i]) !=
522 if ((key >> 30) == 3 && (rom[i] >> 30) > 1 &&
523 sp < ARRAY_SIZE(stack))
524 stack[sp++] = i + rom[i];
531 device->config_rom = kmalloc(length * 4, GFP_KERNEL);
532 if (device->config_rom == NULL)
534 memcpy(device->config_rom, rom, length * 4);
535 device->config_rom_length = length;
540 static void fw_unit_release(struct device *dev)
542 struct fw_unit *unit = fw_unit(dev);
547 static struct device_type fw_unit_type = {
548 .uevent = fw_unit_uevent,
549 .release = fw_unit_release,
552 static int is_fw_unit(struct device *dev)
554 return dev->type == &fw_unit_type;
557 static void create_units(struct fw_device *device)
559 struct fw_csr_iterator ci;
560 struct fw_unit *unit;
564 fw_csr_iterator_init(&ci, &device->config_rom[5]);
565 while (fw_csr_iterator_next(&ci, &key, &value)) {
566 if (key != (CSR_UNIT | CSR_DIRECTORY))
570 * Get the address of the unit directory and try to
571 * match the drivers id_tables against it.
573 unit = kzalloc(sizeof(*unit), GFP_KERNEL);
575 fw_error("failed to allocate memory for unit\n");
579 unit->directory = ci.p + value - 1;
580 unit->device.bus = &fw_bus_type;
581 unit->device.type = &fw_unit_type;
582 unit->device.parent = &device->device;
583 snprintf(unit->device.bus_id, sizeof(unit->device.bus_id),
584 "%s.%d", device->device.bus_id, i++);
586 init_fw_attribute_group(&unit->device,
588 &unit->attribute_group);
589 if (device_register(&unit->device) < 0)
599 static int shutdown_unit(struct device *device, void *data)
601 device_unregister(device);
606 static DECLARE_RWSEM(idr_rwsem);
607 static DEFINE_IDR(fw_device_idr);
610 struct fw_device *fw_device_get_by_devt(dev_t devt)
612 struct fw_device *device;
614 down_read(&idr_rwsem);
615 device = idr_find(&fw_device_idr, MINOR(devt));
617 fw_device_get(device);
623 static void fw_device_shutdown(struct work_struct *work)
625 struct fw_device *device =
626 container_of(work, struct fw_device, work.work);
627 int minor = MINOR(device->device.devt);
629 fw_device_cdev_remove(device);
630 device_for_each_child(&device->device, NULL, shutdown_unit);
631 device_unregister(&device->device);
633 down_write(&idr_rwsem);
634 idr_remove(&fw_device_idr, minor);
635 up_write(&idr_rwsem);
636 fw_device_put(device);
639 static struct device_type fw_device_type = {
640 .release = fw_device_release,
644 * These defines control the retry behavior for reading the config
645 * rom. It shouldn't be necessary to tweak these; if the device
646 * doesn't respond to a config rom read within 10 seconds, it's not
647 * going to respond at all. As for the initial delay, a lot of
648 * devices will be able to respond within half a second after bus
649 * reset. On the other hand, it's not really worth being more
650 * aggressive than that, since it scales pretty well; if 10 devices
651 * are plugged in, they're all getting read within one second.
654 #define MAX_RETRIES 10
655 #define RETRY_DELAY (3 * HZ)
656 #define INITIAL_DELAY (HZ / 2)
658 static void fw_device_init(struct work_struct *work)
660 struct fw_device *device =
661 container_of(work, struct fw_device, work.work);
665 * All failure paths here set node->data to NULL, so that we
666 * don't try to do device_for_each_child() on a kfree()'d
670 if (read_bus_info_block(device, device->generation) < 0) {
671 if (device->config_rom_retries < MAX_RETRIES) {
672 device->config_rom_retries++;
673 schedule_delayed_work(&device->work, RETRY_DELAY);
675 fw_notify("giving up on config rom for node id %x\n",
677 if (device->node == device->card->root_node)
678 schedule_delayed_work(&device->card->work, 0);
679 fw_device_release(&device->device);
686 fw_device_get(device);
687 down_write(&idr_rwsem);
688 if (idr_pre_get(&fw_device_idr, GFP_KERNEL))
689 err = idr_get_new(&fw_device_idr, device, &minor);
690 up_write(&idr_rwsem);
695 device->device.bus = &fw_bus_type;
696 device->device.type = &fw_device_type;
697 device->device.parent = device->card->device;
698 device->device.devt = MKDEV(fw_cdev_major, minor);
699 snprintf(device->device.bus_id, sizeof(device->device.bus_id),
702 init_fw_attribute_group(&device->device,
703 fw_device_attributes,
704 &device->attribute_group);
705 if (device_add(&device->device)) {
706 fw_error("Failed to add device.\n");
707 goto error_with_cdev;
710 create_units(device);
713 * Transition the device to running state. If it got pulled
714 * out from under us while we did the intialization work, we
715 * have to shut down the device again here. Normally, though,
716 * fw_node_event will be responsible for shutting it down when
717 * necessary. We have to use the atomic cmpxchg here to avoid
718 * racing with the FW_NODE_DESTROYED case in
721 if (atomic_cmpxchg(&device->state,
722 FW_DEVICE_INITIALIZING,
723 FW_DEVICE_RUNNING) == FW_DEVICE_SHUTDOWN) {
724 fw_device_shutdown(&device->work.work);
726 if (device->config_rom_retries)
727 fw_notify("created device %s: GUID %08x%08x, S%d00, "
728 "%d config ROM retries\n",
729 device->device.bus_id,
730 device->config_rom[3], device->config_rom[4],
731 1 << device->max_speed,
732 device->config_rom_retries);
734 fw_notify("created device %s: GUID %08x%08x, S%d00\n",
735 device->device.bus_id,
736 device->config_rom[3], device->config_rom[4],
737 1 << device->max_speed);
741 * Reschedule the IRM work if we just finished reading the
742 * root node config rom. If this races with a bus reset we
743 * just end up running the IRM work a couple of extra times -
746 if (device->node == device->card->root_node)
747 schedule_delayed_work(&device->card->work, 0);
752 down_write(&idr_rwsem);
753 idr_remove(&fw_device_idr, minor);
754 up_write(&idr_rwsem);
756 fw_device_put(device); /* fw_device_idr's reference */
758 put_device(&device->device); /* our reference */
761 static int update_unit(struct device *dev, void *data)
763 struct fw_unit *unit = fw_unit(dev);
764 struct fw_driver *driver = (struct fw_driver *)dev->driver;
766 if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
768 driver->update(unit);
775 static void fw_device_update(struct work_struct *work)
777 struct fw_device *device =
778 container_of(work, struct fw_device, work.work);
780 fw_device_cdev_update(device);
781 device_for_each_child(&device->device, NULL, update_unit);
784 void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
786 struct fw_device *device;
789 case FW_NODE_CREATED:
790 case FW_NODE_LINK_ON:
794 device = kzalloc(sizeof(*device), GFP_ATOMIC);
799 * Do minimal intialization of the device here, the
800 * rest will happen in fw_device_init(). We need the
801 * card and node so we can read the config rom and we
802 * need to do device_initialize() now so
803 * device_for_each_child() in FW_NODE_UPDATED is
806 device_initialize(&device->device);
807 atomic_set(&device->state, FW_DEVICE_INITIALIZING);
808 device->card = fw_card_get(card);
809 device->node = fw_node_get(node);
810 device->node_id = node->node_id;
811 device->generation = card->generation;
812 INIT_LIST_HEAD(&device->client_list);
815 * Set the node data to point back to this device so
816 * FW_NODE_UPDATED callbacks can update the node_id
817 * and generation for the device.
822 * Many devices are slow to respond after bus resets,
823 * especially if they are bus powered and go through
824 * power-up after getting plugged in. We schedule the
825 * first config rom scan half a second after bus reset.
827 INIT_DELAYED_WORK(&device->work, fw_device_init);
828 schedule_delayed_work(&device->work, INITIAL_DELAY);
831 case FW_NODE_UPDATED:
832 if (!node->link_on || node->data == NULL)
836 device->node_id = node->node_id;
837 smp_wmb(); /* update node_id before generation */
838 device->generation = card->generation;
839 if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
840 PREPARE_DELAYED_WORK(&device->work, fw_device_update);
841 schedule_delayed_work(&device->work, 0);
845 case FW_NODE_DESTROYED:
846 case FW_NODE_LINK_OFF:
851 * Destroy the device associated with the node. There
852 * are two cases here: either the device is fully
853 * initialized (FW_DEVICE_RUNNING) or we're in the
854 * process of reading its config rom
855 * (FW_DEVICE_INITIALIZING). If it is fully
856 * initialized we can reuse device->work to schedule a
857 * full fw_device_shutdown(). If not, there's work
858 * scheduled to read it's config rom, and we just put
859 * the device in shutdown state to have that code fail
860 * to create the device.
863 if (atomic_xchg(&device->state,
864 FW_DEVICE_SHUTDOWN) == FW_DEVICE_RUNNING) {
865 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
866 schedule_delayed_work(&device->work, 0);