1 /* -*- c-basic-offset: 8 -*-
3 * fw-device.c - Device probing and sysfs code.
5 * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 #include <linux/module.h>
23 #include <linux/wait.h>
24 #include <linux/errno.h>
25 #include <linux/kthread.h>
26 #include <linux/device.h>
27 #include <linux/delay.h>
28 #include <linux/idr.h>
29 #include <linux/rwsem.h>
30 #include <asm/semaphore.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, char **envp, int num_envp,
135 char *buffer, int buffer_size)
137 struct fw_unit *unit = fw_unit(dev);
142 get_modalias(unit, modalias, sizeof modalias);
144 if (add_uevent_var(envp, num_envp, &i,
145 buffer, buffer_size, &length,
146 "MODALIAS=%s", modalias))
154 struct bus_type fw_bus_type = {
156 .match = fw_unit_match,
158 EXPORT_SYMBOL(fw_bus_type);
160 extern struct fw_device *fw_device_get(struct fw_device *device)
162 get_device(&device->device);
167 extern void fw_device_put(struct fw_device *device)
169 put_device(&device->device);
172 static void fw_device_release(struct device *dev)
174 struct fw_device *device = fw_device(dev);
177 /* Take the card lock so we don't set this to NULL while a
178 * FW_NODE_UPDATED callback is being handled. */
179 spin_lock_irqsave(&device->card->lock, flags);
180 device->node->data = NULL;
181 spin_unlock_irqrestore(&device->card->lock, flags);
183 fw_node_put(device->node);
184 fw_card_put(device->card);
185 kfree(device->config_rom);
189 int fw_device_enable_phys_dma(struct fw_device *device)
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);
363 guid = ((u64)device->config_rom[3] << 32) | device->config_rom[4];
365 return snprintf(buf, PAGE_SIZE, "0x%016llx\n", guid);
368 static struct device_attribute fw_device_attributes[] = {
369 __ATTR_RO(config_rom),
374 struct read_quadlet_callback_data {
375 struct completion done;
381 complete_transaction(struct fw_card *card, int rcode,
382 void *payload, size_t length, void *data)
384 struct read_quadlet_callback_data *callback_data = data;
386 if (rcode == RCODE_COMPLETE)
387 callback_data->data = be32_to_cpu(*(__be32 *)payload);
388 callback_data->rcode = rcode;
389 complete(&callback_data->done);
392 static int read_rom(struct fw_device *device, int index, u32 * data)
394 struct read_quadlet_callback_data callback_data;
395 struct fw_transaction t;
398 init_completion(&callback_data.done);
400 offset = 0xfffff0000400ULL + index * 4;
401 fw_send_request(device->card, &t, TCODE_READ_QUADLET_REQUEST,
403 device->generation, SCODE_100,
404 offset, NULL, 4, complete_transaction, &callback_data);
406 wait_for_completion(&callback_data.done);
408 *data = callback_data.data;
410 return callback_data.rcode;
413 static int read_bus_info_block(struct fw_device *device)
416 u32 stack[16], sp, key;
419 /* First read the bus info block. */
420 for (i = 0; i < 5; i++) {
421 if (read_rom(device, i, &rom[i]) != RCODE_COMPLETE)
423 /* As per IEEE1212 7.2, during power-up, devices can
424 * reply with a 0 for the first quadlet of the config
425 * rom to indicate that they are booting (for example,
426 * if the firmware is on the disk of a external
427 * harddisk). In that case we just fail, and the
428 * retry mechanism will try again later. */
429 if (i == 0 && rom[i] == 0)
433 /* Now parse the config rom. The config rom is a recursive
434 * directory structure so we parse it using a stack of
435 * references to the blocks that make up the structure. We
436 * push a reference to the root directory on the stack to
437 * start things off. */
440 stack[sp++] = 0xc0000005;
442 /* Pop the next block reference of the stack. The
443 * lower 24 bits is the offset into the config rom,
444 * the upper 8 bits are the type of the reference the
448 if (i >= ARRAY_SIZE(rom))
449 /* The reference points outside the standard
450 * config rom area, something's fishy. */
453 /* Read header quadlet for the block to get the length. */
454 if (read_rom(device, i, &rom[i]) != RCODE_COMPLETE)
456 end = i + (rom[i] >> 16) + 1;
458 if (end > ARRAY_SIZE(rom))
459 /* This block extends outside standard config
460 * area (and the array we're reading it
461 * into). That's broken, so ignore this
465 /* Now read in the block. If this is a directory
466 * block, check the entries as we read them to see if
467 * it references another block, and push it in that case. */
469 if (read_rom(device, i, &rom[i]) != RCODE_COMPLETE)
471 if ((key >> 30) == 3 && (rom[i] >> 30) > 1 &&
472 sp < ARRAY_SIZE(stack))
473 stack[sp++] = i + rom[i];
480 device->config_rom = kmalloc(length * 4, GFP_KERNEL);
481 if (device->config_rom == NULL)
483 memcpy(device->config_rom, rom, length * 4);
484 device->config_rom_length = length;
489 static void fw_unit_release(struct device *dev)
491 struct fw_unit *unit = fw_unit(dev);
496 static struct device_type fw_unit_type = {
497 .uevent = fw_unit_uevent,
498 .release = fw_unit_release,
501 static int is_fw_unit(struct device *dev)
503 return dev->type == &fw_unit_type;
506 static void create_units(struct fw_device *device)
508 struct fw_csr_iterator ci;
509 struct fw_unit *unit;
513 fw_csr_iterator_init(&ci, &device->config_rom[5]);
514 while (fw_csr_iterator_next(&ci, &key, &value)) {
515 if (key != (CSR_UNIT | CSR_DIRECTORY))
518 /* Get the address of the unit directory and try to
519 * match the drivers id_tables against it. */
520 unit = kzalloc(sizeof *unit, GFP_KERNEL);
522 fw_error("failed to allocate memory for unit\n");
526 unit->directory = ci.p + value - 1;
527 unit->device.bus = &fw_bus_type;
528 unit->device.type = &fw_unit_type;
529 unit->device.parent = &device->device;
530 snprintf(unit->device.bus_id, sizeof unit->device.bus_id,
531 "%s.%d", device->device.bus_id, i++);
533 init_fw_attribute_group(&unit->device,
535 &unit->attribute_group);
536 if (device_register(&unit->device) < 0)
546 static int shutdown_unit(struct device *device, void *data)
548 device_unregister(device);
553 static DECLARE_RWSEM(idr_rwsem);
554 static DEFINE_IDR(fw_device_idr);
557 struct fw_device *fw_device_from_devt(dev_t devt)
559 struct fw_device *device;
561 down_read(&idr_rwsem);
562 device = idr_find(&fw_device_idr, MINOR(devt));
568 static void fw_device_shutdown(struct work_struct *work)
570 struct fw_device *device =
571 container_of(work, struct fw_device, work.work);
572 int minor = MINOR(device->device.devt);
574 down_write(&idr_rwsem);
575 idr_remove(&fw_device_idr, minor);
576 up_write(&idr_rwsem);
578 fw_device_cdev_remove(device);
579 device_for_each_child(&device->device, NULL, shutdown_unit);
580 device_unregister(&device->device);
583 static struct device_type fw_device_type = {
584 .release = fw_device_release,
587 /* These defines control the retry behavior for reading the config
588 * rom. It shouldn't be necessary to tweak these; if the device
589 * doesn't respond to a config rom read within 10 seconds, it's not
590 * going to respond at all. As for the initial delay, a lot of
591 * devices will be able to respond within half a second after bus
592 * reset. On the other hand, it's not really worth being more
593 * aggressive than that, since it scales pretty well; if 10 devices
594 * are plugged in, they're all getting read within one second. */
596 #define MAX_RETRIES 10
597 #define RETRY_DELAY (3 * HZ)
598 #define INITIAL_DELAY (HZ / 2)
600 static void fw_device_init(struct work_struct *work)
602 struct fw_device *device =
603 container_of(work, struct fw_device, work.work);
606 /* All failure paths here set node->data to NULL, so that we
607 * don't try to do device_for_each_child() on a kfree()'d
610 if (read_bus_info_block(device) < 0) {
611 if (device->config_rom_retries < MAX_RETRIES) {
612 device->config_rom_retries++;
613 schedule_delayed_work(&device->work, RETRY_DELAY);
615 fw_notify("giving up on config rom for node id %x\n",
617 if (device->node == device->card->root_node)
618 schedule_delayed_work(&device->card->work, 0);
619 fw_device_release(&device->device);
625 down_write(&idr_rwsem);
626 if (idr_pre_get(&fw_device_idr, GFP_KERNEL))
627 err = idr_get_new(&fw_device_idr, device, &minor);
628 up_write(&idr_rwsem);
632 device->device.bus = &fw_bus_type;
633 device->device.type = &fw_device_type;
634 device->device.parent = device->card->device;
635 device->device.devt = MKDEV(fw_cdev_major, minor);
636 snprintf(device->device.bus_id, sizeof device->device.bus_id,
639 init_fw_attribute_group(&device->device,
640 fw_device_attributes,
641 &device->attribute_group);
642 if (device_add(&device->device)) {
643 fw_error("Failed to add device.\n");
644 goto error_with_cdev;
647 create_units(device);
649 /* Transition the device to running state. If it got pulled
650 * out from under us while we did the intialization work, we
651 * have to shut down the device again here. Normally, though,
652 * fw_node_event will be responsible for shutting it down when
653 * necessary. We have to use the atomic cmpxchg here to avoid
654 * racing with the FW_NODE_DESTROYED case in
655 * fw_node_event(). */
656 if (atomic_cmpxchg(&device->state,
657 FW_DEVICE_INITIALIZING,
658 FW_DEVICE_RUNNING) == FW_DEVICE_SHUTDOWN)
659 fw_device_shutdown(&device->work.work);
661 fw_notify("created new fw device %s (%d config rom retries)\n",
662 device->device.bus_id, device->config_rom_retries);
664 /* Reschedule the IRM work if we just finished reading the
665 * root node config rom. If this races with a bus reset we
666 * just end up running the IRM work a couple of extra times -
667 * pretty harmless. */
668 if (device->node == device->card->root_node)
669 schedule_delayed_work(&device->card->work, 0);
674 down_write(&idr_rwsem);
675 idr_remove(&fw_device_idr, minor);
676 up_write(&idr_rwsem);
678 put_device(&device->device);
681 static int update_unit(struct device *dev, void *data)
683 struct fw_unit *unit = fw_unit(dev);
684 struct fw_driver *driver = (struct fw_driver *)dev->driver;
686 if (is_fw_unit(dev) && driver != NULL && driver->update != NULL) {
688 driver->update(unit);
695 static void fw_device_update(struct work_struct *work)
697 struct fw_device *device =
698 container_of(work, struct fw_device, work.work);
700 fw_device_cdev_update(device);
701 device_for_each_child(&device->device, NULL, update_unit);
704 void fw_node_event(struct fw_card *card, struct fw_node *node, int event)
706 struct fw_device *device;
709 case FW_NODE_CREATED:
710 case FW_NODE_LINK_ON:
714 device = kzalloc(sizeof(*device), GFP_ATOMIC);
718 /* Do minimal intialization of the device here, the
719 * rest will happen in fw_device_init(). We need the
720 * card and node so we can read the config rom and we
721 * need to do device_initialize() now so
722 * device_for_each_child() in FW_NODE_UPDATED is
723 * doesn't freak out. */
724 device_initialize(&device->device);
725 atomic_set(&device->state, FW_DEVICE_INITIALIZING);
726 device->card = fw_card_get(card);
727 device->node = fw_node_get(node);
728 device->node_id = node->node_id;
729 device->generation = card->generation;
730 INIT_LIST_HEAD(&device->client_list);
732 /* Set the node data to point back to this device so
733 * FW_NODE_UPDATED callbacks can update the node_id
734 * and generation for the device. */
737 /* Many devices are slow to respond after bus resets,
738 * especially if they are bus powered and go through
739 * power-up after getting plugged in. We schedule the
740 * first config rom scan half a second after bus reset. */
741 INIT_DELAYED_WORK(&device->work, fw_device_init);
742 schedule_delayed_work(&device->work, INITIAL_DELAY);
745 case FW_NODE_UPDATED:
746 if (!node->link_on || node->data == NULL)
750 device->node_id = node->node_id;
751 device->generation = card->generation;
752 if (atomic_read(&device->state) == FW_DEVICE_RUNNING) {
753 PREPARE_DELAYED_WORK(&device->work, fw_device_update);
754 schedule_delayed_work(&device->work, 0);
758 case FW_NODE_DESTROYED:
759 case FW_NODE_LINK_OFF:
763 /* Destroy the device associated with the node. There
764 * are two cases here: either the device is fully
765 * initialized (FW_DEVICE_RUNNING) or we're in the
766 * process of reading its config rom
767 * (FW_DEVICE_INITIALIZING). If it is fully
768 * initialized we can reuse device->work to schedule a
769 * full fw_device_shutdown(). If not, there's work
770 * scheduled to read it's config rom, and we just put
771 * the device in shutdown state to have that code fail
772 * to create the device. */
774 if (atomic_xchg(&device->state,
775 FW_DEVICE_SHUTDOWN) == FW_DEVICE_RUNNING) {
776 PREPARE_DELAYED_WORK(&device->work, fw_device_shutdown);
777 schedule_delayed_work(&device->work, 0);