ieee1394: nodemgr: take it easy if bus_rescan_devices fails
[firewire-audio.git] / drivers / ieee1394 / nodemgr.c
blob89a4bd4c842dd545c55a1f02c4b437816bac86bc
1 /*
2 * Node information (ConfigROM) collection and management.
4 * Copyright (C) 2000 Andreas E. Bombe
5 * 2001-2003 Ben Collins <bcollins@debian.net>
7 * This code is licensed under the GPL. See the file COPYING in the root
8 * directory of the kernel sources for details.
9 */
11 #include <linux/bitmap.h>
12 #include <linux/kernel.h>
13 #include <linux/list.h>
14 #include <linux/slab.h>
15 #include <linux/delay.h>
16 #include <linux/kthread.h>
17 #include <linux/moduleparam.h>
18 #include <linux/freezer.h>
19 #include <asm/atomic.h>
21 #include "csr.h"
22 #include "highlevel.h"
23 #include "hosts.h"
24 #include "ieee1394.h"
25 #include "ieee1394_core.h"
26 #include "ieee1394_hotplug.h"
27 #include "ieee1394_types.h"
28 #include "ieee1394_transactions.h"
29 #include "nodemgr.h"
31 static int ignore_drivers;
32 module_param(ignore_drivers, int, S_IRUGO | S_IWUSR);
33 MODULE_PARM_DESC(ignore_drivers, "Disable automatic probing for drivers.");
35 struct nodemgr_csr_info {
36 struct hpsb_host *host;
37 nodeid_t nodeid;
38 unsigned int generation;
39 unsigned int speed_unverified:1;
43 static char *nodemgr_find_oui_name(int oui)
45 #ifdef CONFIG_IEEE1394_OUI_DB
46 extern struct oui_list_struct {
47 int oui;
48 char *name;
49 } oui_list[];
50 int i;
52 for (i = 0; oui_list[i].name; i++)
53 if (oui_list[i].oui == oui)
54 return oui_list[i].name;
55 #endif
56 return NULL;
60 * Correct the speed map entry. This is necessary
61 * - for nodes with link speed < phy speed,
62 * - for 1394b nodes with negotiated phy port speed < IEEE1394_SPEED_MAX.
63 * A possible speed is determined by trial and error, using quadlet reads.
65 static int nodemgr_check_speed(struct nodemgr_csr_info *ci, u64 addr,
66 quadlet_t *buffer)
68 quadlet_t q;
69 u8 i, *speed, old_speed, good_speed;
70 int error;
72 speed = &(ci->host->speed[NODEID_TO_NODE(ci->nodeid)]);
73 old_speed = *speed;
74 good_speed = IEEE1394_SPEED_MAX + 1;
76 /* Try every speed from S100 to old_speed.
77 * If we did it the other way around, a too low speed could be caught
78 * if the retry succeeded for some other reason, e.g. because the link
79 * just finished its initialization. */
80 for (i = IEEE1394_SPEED_100; i <= old_speed; i++) {
81 *speed = i;
82 error = hpsb_read(ci->host, ci->nodeid, ci->generation, addr,
83 &q, sizeof(quadlet_t));
84 if (error)
85 break;
86 *buffer = q;
87 good_speed = i;
89 if (good_speed <= IEEE1394_SPEED_MAX) {
90 HPSB_DEBUG("Speed probe of node " NODE_BUS_FMT " yields %s",
91 NODE_BUS_ARGS(ci->host, ci->nodeid),
92 hpsb_speedto_str[good_speed]);
93 *speed = good_speed;
94 ci->speed_unverified = 0;
95 return 0;
97 *speed = old_speed;
98 return error;
101 static int nodemgr_bus_read(struct csr1212_csr *csr, u64 addr, u16 length,
102 void *buffer, void *__ci)
104 struct nodemgr_csr_info *ci = (struct nodemgr_csr_info*)__ci;
105 int i, error;
107 for (i = 1; ; i++) {
108 error = hpsb_read(ci->host, ci->nodeid, ci->generation, addr,
109 buffer, length);
110 if (!error) {
111 ci->speed_unverified = 0;
112 break;
114 /* Give up after 3rd failure. */
115 if (i == 3)
116 break;
118 /* The ieee1394_core guessed the node's speed capability from
119 * the self ID. Check whether a lower speed works. */
120 if (ci->speed_unverified && length == sizeof(quadlet_t)) {
121 error = nodemgr_check_speed(ci, addr, buffer);
122 if (!error)
123 break;
125 if (msleep_interruptible(334))
126 return -EINTR;
128 return error;
131 static int nodemgr_get_max_rom(quadlet_t *bus_info_data, void *__ci)
133 return (CSR1212_BE32_TO_CPU(bus_info_data[2]) >> 8) & 0x3;
136 static struct csr1212_bus_ops nodemgr_csr_ops = {
137 .bus_read = nodemgr_bus_read,
138 .get_max_rom = nodemgr_get_max_rom
143 * Basically what we do here is start off retrieving the bus_info block.
144 * From there will fill in some info about the node, verify it is of IEEE
145 * 1394 type, and that the crc checks out ok. After that we start off with
146 * the root directory, and subdirectories. To do this, we retrieve the
147 * quadlet header for a directory, find out the length, and retrieve the
148 * complete directory entry (be it a leaf or a directory). We then process
149 * it and add the info to our structure for that particular node.
151 * We verify CRC's along the way for each directory/block/leaf. The entire
152 * node structure is generic, and simply stores the information in a way
153 * that's easy to parse by the protocol interface.
157 * The nodemgr relies heavily on the Driver Model for device callbacks and
158 * driver/device mappings. The old nodemgr used to handle all this itself,
159 * but now we are much simpler because of the LDM.
162 static DEFINE_MUTEX(nodemgr_serialize);
164 struct host_info {
165 struct hpsb_host *host;
166 struct list_head list;
167 struct task_struct *thread;
170 static int nodemgr_bus_match(struct device * dev, struct device_driver * drv);
171 static int nodemgr_uevent(struct class_device *cdev, char **envp, int num_envp,
172 char *buffer, int buffer_size);
173 static void nodemgr_resume_ne(struct node_entry *ne);
174 static void nodemgr_remove_ne(struct node_entry *ne);
175 static struct node_entry *find_entry_by_guid(u64 guid);
177 struct bus_type ieee1394_bus_type = {
178 .name = "ieee1394",
179 .match = nodemgr_bus_match,
182 static void host_cls_release(struct class_device *class_dev)
184 put_device(&container_of((class_dev), struct hpsb_host, class_dev)->device);
187 struct class hpsb_host_class = {
188 .name = "ieee1394_host",
189 .release = host_cls_release,
192 static void ne_cls_release(struct class_device *class_dev)
194 put_device(&container_of((class_dev), struct node_entry, class_dev)->device);
197 static struct class nodemgr_ne_class = {
198 .name = "ieee1394_node",
199 .release = ne_cls_release,
202 static void ud_cls_release(struct class_device *class_dev)
204 put_device(&container_of((class_dev), struct unit_directory, class_dev)->device);
207 /* The name here is only so that unit directory hotplug works with old
208 * style hotplug, which only ever did unit directories anyway. */
209 static struct class nodemgr_ud_class = {
210 .name = "ieee1394",
211 .release = ud_cls_release,
212 .uevent = nodemgr_uevent,
215 static struct hpsb_highlevel nodemgr_highlevel;
218 static void nodemgr_release_ud(struct device *dev)
220 struct unit_directory *ud = container_of(dev, struct unit_directory, device);
222 if (ud->vendor_name_kv)
223 csr1212_release_keyval(ud->vendor_name_kv);
224 if (ud->model_name_kv)
225 csr1212_release_keyval(ud->model_name_kv);
227 kfree(ud);
230 static void nodemgr_release_ne(struct device *dev)
232 struct node_entry *ne = container_of(dev, struct node_entry, device);
234 if (ne->vendor_name_kv)
235 csr1212_release_keyval(ne->vendor_name_kv);
237 kfree(ne);
241 static void nodemgr_release_host(struct device *dev)
243 struct hpsb_host *host = container_of(dev, struct hpsb_host, device);
245 csr1212_destroy_csr(host->csr.rom);
247 kfree(host);
250 static int nodemgr_ud_platform_data;
252 static struct device nodemgr_dev_template_ud = {
253 .bus = &ieee1394_bus_type,
254 .release = nodemgr_release_ud,
255 .platform_data = &nodemgr_ud_platform_data,
258 static struct device nodemgr_dev_template_ne = {
259 .bus = &ieee1394_bus_type,
260 .release = nodemgr_release_ne,
263 struct device nodemgr_dev_template_host = {
264 .bus = &ieee1394_bus_type,
265 .release = nodemgr_release_host,
269 #define fw_attr(class, class_type, field, type, format_string) \
270 static ssize_t fw_show_##class##_##field (struct device *dev, struct device_attribute *attr, char *buf)\
272 class_type *class; \
273 class = container_of(dev, class_type, device); \
274 return sprintf(buf, format_string, (type)class->field); \
276 static struct device_attribute dev_attr_##class##_##field = { \
277 .attr = {.name = __stringify(field), .mode = S_IRUGO }, \
278 .show = fw_show_##class##_##field, \
281 #define fw_attr_td(class, class_type, td_kv) \
282 static ssize_t fw_show_##class##_##td_kv (struct device *dev, struct device_attribute *attr, char *buf)\
284 int len; \
285 class_type *class = container_of(dev, class_type, device); \
286 len = (class->td_kv->value.leaf.len - 2) * sizeof(quadlet_t); \
287 memcpy(buf, \
288 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_DATA(class->td_kv), \
289 len); \
290 while ((buf + len - 1) == '\0') \
291 len--; \
292 buf[len++] = '\n'; \
293 buf[len] = '\0'; \
294 return len; \
296 static struct device_attribute dev_attr_##class##_##td_kv = { \
297 .attr = {.name = __stringify(td_kv), .mode = S_IRUGO }, \
298 .show = fw_show_##class##_##td_kv, \
302 #define fw_drv_attr(field, type, format_string) \
303 static ssize_t fw_drv_show_##field (struct device_driver *drv, char *buf) \
305 struct hpsb_protocol_driver *driver; \
306 driver = container_of(drv, struct hpsb_protocol_driver, driver); \
307 return sprintf(buf, format_string, (type)driver->field);\
309 static struct driver_attribute driver_attr_drv_##field = { \
310 .attr = {.name = __stringify(field), .mode = S_IRUGO }, \
311 .show = fw_drv_show_##field, \
315 static ssize_t fw_show_ne_bus_options(struct device *dev, struct device_attribute *attr, char *buf)
317 struct node_entry *ne = container_of(dev, struct node_entry, device);
319 return sprintf(buf, "IRMC(%d) CMC(%d) ISC(%d) BMC(%d) PMC(%d) GEN(%d) "
320 "LSPD(%d) MAX_REC(%d) MAX_ROM(%d) CYC_CLK_ACC(%d)\n",
321 ne->busopt.irmc,
322 ne->busopt.cmc, ne->busopt.isc, ne->busopt.bmc,
323 ne->busopt.pmc, ne->busopt.generation, ne->busopt.lnkspd,
324 ne->busopt.max_rec,
325 ne->busopt.max_rom,
326 ne->busopt.cyc_clk_acc);
328 static DEVICE_ATTR(bus_options,S_IRUGO,fw_show_ne_bus_options,NULL);
331 #ifdef HPSB_DEBUG_TLABELS
332 static ssize_t fw_show_ne_tlabels_free(struct device *dev,
333 struct device_attribute *attr, char *buf)
335 struct node_entry *ne = container_of(dev, struct node_entry, device);
336 unsigned long flags;
337 unsigned long *tp = ne->host->tl_pool[NODEID_TO_NODE(ne->nodeid)].map;
338 int tf;
340 spin_lock_irqsave(&hpsb_tlabel_lock, flags);
341 tf = 64 - bitmap_weight(tp, 64);
342 spin_unlock_irqrestore(&hpsb_tlabel_lock, flags);
344 return sprintf(buf, "%d\n", tf);
346 static DEVICE_ATTR(tlabels_free,S_IRUGO,fw_show_ne_tlabels_free,NULL);
349 static ssize_t fw_show_ne_tlabels_mask(struct device *dev,
350 struct device_attribute *attr, char *buf)
352 struct node_entry *ne = container_of(dev, struct node_entry, device);
353 unsigned long flags;
354 unsigned long *tp = ne->host->tl_pool[NODEID_TO_NODE(ne->nodeid)].map;
355 u64 tm;
357 spin_lock_irqsave(&hpsb_tlabel_lock, flags);
358 #if (BITS_PER_LONG <= 32)
359 tm = ((u64)tp[0] << 32) + tp[1];
360 #else
361 tm = tp[0];
362 #endif
363 spin_unlock_irqrestore(&hpsb_tlabel_lock, flags);
365 return sprintf(buf, "0x%016llx\n", (unsigned long long)tm);
367 static DEVICE_ATTR(tlabels_mask, S_IRUGO, fw_show_ne_tlabels_mask, NULL);
368 #endif /* HPSB_DEBUG_TLABELS */
371 static ssize_t fw_set_ignore_driver(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
373 struct unit_directory *ud = container_of(dev, struct unit_directory, device);
374 int state = simple_strtoul(buf, NULL, 10);
376 if (state == 1) {
377 ud->ignore_driver = 1;
378 down_write(&ieee1394_bus_type.subsys.rwsem);
379 device_release_driver(dev);
380 up_write(&ieee1394_bus_type.subsys.rwsem);
381 } else if (state == 0)
382 ud->ignore_driver = 0;
384 return count;
386 static ssize_t fw_get_ignore_driver(struct device *dev, struct device_attribute *attr, char *buf)
388 struct unit_directory *ud = container_of(dev, struct unit_directory, device);
390 return sprintf(buf, "%d\n", ud->ignore_driver);
392 static DEVICE_ATTR(ignore_driver, S_IWUSR | S_IRUGO, fw_get_ignore_driver, fw_set_ignore_driver);
395 static ssize_t fw_set_destroy_node(struct bus_type *bus, const char *buf, size_t count)
397 struct node_entry *ne;
398 u64 guid = (u64)simple_strtoull(buf, NULL, 16);
400 ne = find_entry_by_guid(guid);
402 if (ne == NULL || !ne->in_limbo)
403 return -EINVAL;
405 nodemgr_remove_ne(ne);
407 return count;
409 static ssize_t fw_get_destroy_node(struct bus_type *bus, char *buf)
411 return sprintf(buf, "You can destroy in_limbo nodes by writing their GUID to this file\n");
413 static BUS_ATTR(destroy_node, S_IWUSR | S_IRUGO, fw_get_destroy_node, fw_set_destroy_node);
416 static ssize_t fw_set_rescan(struct bus_type *bus, const char *buf,
417 size_t count)
419 int error = 0;
421 if (simple_strtoul(buf, NULL, 10) == 1)
422 error = bus_rescan_devices(&ieee1394_bus_type);
423 return error ? error : count;
425 static ssize_t fw_get_rescan(struct bus_type *bus, char *buf)
427 return sprintf(buf, "You can force a rescan of the bus for "
428 "drivers by writing a 1 to this file\n");
430 static BUS_ATTR(rescan, S_IWUSR | S_IRUGO, fw_get_rescan, fw_set_rescan);
433 static ssize_t fw_set_ignore_drivers(struct bus_type *bus, const char *buf, size_t count)
435 int state = simple_strtoul(buf, NULL, 10);
437 if (state == 1)
438 ignore_drivers = 1;
439 else if (state == 0)
440 ignore_drivers = 0;
442 return count;
444 static ssize_t fw_get_ignore_drivers(struct bus_type *bus, char *buf)
446 return sprintf(buf, "%d\n", ignore_drivers);
448 static BUS_ATTR(ignore_drivers, S_IWUSR | S_IRUGO, fw_get_ignore_drivers, fw_set_ignore_drivers);
451 struct bus_attribute *const fw_bus_attrs[] = {
452 &bus_attr_destroy_node,
453 &bus_attr_rescan,
454 &bus_attr_ignore_drivers,
455 NULL
459 fw_attr(ne, struct node_entry, capabilities, unsigned int, "0x%06x\n")
460 fw_attr(ne, struct node_entry, nodeid, unsigned int, "0x%04x\n")
462 fw_attr(ne, struct node_entry, vendor_id, unsigned int, "0x%06x\n")
463 fw_attr_td(ne, struct node_entry, vendor_name_kv)
464 fw_attr(ne, struct node_entry, vendor_oui, const char *, "%s\n")
466 fw_attr(ne, struct node_entry, guid, unsigned long long, "0x%016Lx\n")
467 fw_attr(ne, struct node_entry, guid_vendor_id, unsigned int, "0x%06x\n")
468 fw_attr(ne, struct node_entry, guid_vendor_oui, const char *, "%s\n")
469 fw_attr(ne, struct node_entry, in_limbo, int, "%d\n");
471 static struct device_attribute *const fw_ne_attrs[] = {
472 &dev_attr_ne_guid,
473 &dev_attr_ne_guid_vendor_id,
474 &dev_attr_ne_capabilities,
475 &dev_attr_ne_vendor_id,
476 &dev_attr_ne_nodeid,
477 &dev_attr_bus_options,
478 #ifdef HPSB_DEBUG_TLABELS
479 &dev_attr_tlabels_free,
480 &dev_attr_tlabels_mask,
481 #endif
486 fw_attr(ud, struct unit_directory, address, unsigned long long, "0x%016Lx\n")
487 fw_attr(ud, struct unit_directory, length, int, "%d\n")
488 /* These are all dependent on the value being provided */
489 fw_attr(ud, struct unit_directory, vendor_id, unsigned int, "0x%06x\n")
490 fw_attr(ud, struct unit_directory, model_id, unsigned int, "0x%06x\n")
491 fw_attr(ud, struct unit_directory, specifier_id, unsigned int, "0x%06x\n")
492 fw_attr(ud, struct unit_directory, version, unsigned int, "0x%06x\n")
493 fw_attr_td(ud, struct unit_directory, vendor_name_kv)
494 fw_attr(ud, struct unit_directory, vendor_oui, const char *, "%s\n")
495 fw_attr_td(ud, struct unit_directory, model_name_kv)
497 static struct device_attribute *const fw_ud_attrs[] = {
498 &dev_attr_ud_address,
499 &dev_attr_ud_length,
500 &dev_attr_ignore_driver,
504 fw_attr(host, struct hpsb_host, node_count, int, "%d\n")
505 fw_attr(host, struct hpsb_host, selfid_count, int, "%d\n")
506 fw_attr(host, struct hpsb_host, nodes_active, int, "%d\n")
507 fw_attr(host, struct hpsb_host, in_bus_reset, int, "%d\n")
508 fw_attr(host, struct hpsb_host, is_root, int, "%d\n")
509 fw_attr(host, struct hpsb_host, is_cycmst, int, "%d\n")
510 fw_attr(host, struct hpsb_host, is_irm, int, "%d\n")
511 fw_attr(host, struct hpsb_host, is_busmgr, int, "%d\n")
513 static struct device_attribute *const fw_host_attrs[] = {
514 &dev_attr_host_node_count,
515 &dev_attr_host_selfid_count,
516 &dev_attr_host_nodes_active,
517 &dev_attr_host_in_bus_reset,
518 &dev_attr_host_is_root,
519 &dev_attr_host_is_cycmst,
520 &dev_attr_host_is_irm,
521 &dev_attr_host_is_busmgr,
525 static ssize_t fw_show_drv_device_ids(struct device_driver *drv, char *buf)
527 struct hpsb_protocol_driver *driver;
528 struct ieee1394_device_id *id;
529 int length = 0;
530 char *scratch = buf;
532 driver = container_of(drv, struct hpsb_protocol_driver, driver);
534 for (id = driver->id_table; id->match_flags != 0; id++) {
535 int need_coma = 0;
537 if (id->match_flags & IEEE1394_MATCH_VENDOR_ID) {
538 length += sprintf(scratch, "vendor_id=0x%06x", id->vendor_id);
539 scratch = buf + length;
540 need_coma++;
543 if (id->match_flags & IEEE1394_MATCH_MODEL_ID) {
544 length += sprintf(scratch, "%smodel_id=0x%06x",
545 need_coma++ ? "," : "",
546 id->model_id);
547 scratch = buf + length;
550 if (id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) {
551 length += sprintf(scratch, "%sspecifier_id=0x%06x",
552 need_coma++ ? "," : "",
553 id->specifier_id);
554 scratch = buf + length;
557 if (id->match_flags & IEEE1394_MATCH_VERSION) {
558 length += sprintf(scratch, "%sversion=0x%06x",
559 need_coma++ ? "," : "",
560 id->version);
561 scratch = buf + length;
564 if (need_coma) {
565 *scratch++ = '\n';
566 length++;
570 return length;
572 static DRIVER_ATTR(device_ids,S_IRUGO,fw_show_drv_device_ids,NULL);
575 fw_drv_attr(name, const char *, "%s\n")
577 static struct driver_attribute *const fw_drv_attrs[] = {
578 &driver_attr_drv_name,
579 &driver_attr_device_ids,
583 static void nodemgr_create_drv_files(struct hpsb_protocol_driver *driver)
585 struct device_driver *drv = &driver->driver;
586 int i;
588 for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
589 if (driver_create_file(drv, fw_drv_attrs[i]))
590 goto fail;
591 return;
592 fail:
593 HPSB_ERR("Failed to add sysfs attribute for driver %s", driver->name);
597 static void nodemgr_remove_drv_files(struct hpsb_protocol_driver *driver)
599 struct device_driver *drv = &driver->driver;
600 int i;
602 for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
603 driver_remove_file(drv, fw_drv_attrs[i]);
607 static void nodemgr_create_ne_dev_files(struct node_entry *ne)
609 struct device *dev = &ne->device;
610 int i;
612 for (i = 0; i < ARRAY_SIZE(fw_ne_attrs); i++)
613 if (device_create_file(dev, fw_ne_attrs[i]))
614 goto fail;
615 return;
616 fail:
617 HPSB_ERR("Failed to add sysfs attribute for node %016Lx",
618 (unsigned long long)ne->guid);
622 static void nodemgr_create_host_dev_files(struct hpsb_host *host)
624 struct device *dev = &host->device;
625 int i;
627 for (i = 0; i < ARRAY_SIZE(fw_host_attrs); i++)
628 if (device_create_file(dev, fw_host_attrs[i]))
629 goto fail;
630 return;
631 fail:
632 HPSB_ERR("Failed to add sysfs attribute for host %d", host->id);
636 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host,
637 nodeid_t nodeid);
639 static void nodemgr_update_host_dev_links(struct hpsb_host *host)
641 struct device *dev = &host->device;
642 struct node_entry *ne;
644 sysfs_remove_link(&dev->kobj, "irm_id");
645 sysfs_remove_link(&dev->kobj, "busmgr_id");
646 sysfs_remove_link(&dev->kobj, "host_id");
648 if ((ne = find_entry_by_nodeid(host, host->irm_id)) &&
649 sysfs_create_link(&dev->kobj, &ne->device.kobj, "irm_id"))
650 goto fail;
651 if ((ne = find_entry_by_nodeid(host, host->busmgr_id)) &&
652 sysfs_create_link(&dev->kobj, &ne->device.kobj, "busmgr_id"))
653 goto fail;
654 if ((ne = find_entry_by_nodeid(host, host->node_id)) &&
655 sysfs_create_link(&dev->kobj, &ne->device.kobj, "host_id"))
656 goto fail;
657 return;
658 fail:
659 HPSB_ERR("Failed to update sysfs attributes for host %d", host->id);
662 static void nodemgr_create_ud_dev_files(struct unit_directory *ud)
664 struct device *dev = &ud->device;
665 int i;
667 for (i = 0; i < ARRAY_SIZE(fw_ud_attrs); i++)
668 if (device_create_file(dev, fw_ud_attrs[i]))
669 goto fail;
670 if (ud->flags & UNIT_DIRECTORY_SPECIFIER_ID)
671 if (device_create_file(dev, &dev_attr_ud_specifier_id))
672 goto fail;
673 if (ud->flags & UNIT_DIRECTORY_VERSION)
674 if (device_create_file(dev, &dev_attr_ud_version))
675 goto fail;
676 if (ud->flags & UNIT_DIRECTORY_VENDOR_ID) {
677 if (device_create_file(dev, &dev_attr_ud_vendor_id))
678 goto fail;
679 if (ud->vendor_name_kv &&
680 device_create_file(dev, &dev_attr_ud_vendor_name_kv))
681 goto fail;
683 if (ud->flags & UNIT_DIRECTORY_MODEL_ID) {
684 if (device_create_file(dev, &dev_attr_ud_model_id))
685 goto fail;
686 if (ud->model_name_kv &&
687 device_create_file(dev, &dev_attr_ud_model_name_kv))
688 goto fail;
690 return;
691 fail:
692 HPSB_ERR("Failed to add sysfs attributes for unit %s",
693 ud->device.bus_id);
697 static int nodemgr_bus_match(struct device * dev, struct device_driver * drv)
699 struct hpsb_protocol_driver *driver;
700 struct unit_directory *ud;
701 struct ieee1394_device_id *id;
703 /* We only match unit directories */
704 if (dev->platform_data != &nodemgr_ud_platform_data)
705 return 0;
707 ud = container_of(dev, struct unit_directory, device);
708 driver = container_of(drv, struct hpsb_protocol_driver, driver);
710 if (ud->ne->in_limbo || ud->ignore_driver)
711 return 0;
713 for (id = driver->id_table; id->match_flags != 0; id++) {
714 if ((id->match_flags & IEEE1394_MATCH_VENDOR_ID) &&
715 id->vendor_id != ud->vendor_id)
716 continue;
718 if ((id->match_flags & IEEE1394_MATCH_MODEL_ID) &&
719 id->model_id != ud->model_id)
720 continue;
722 if ((id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) &&
723 id->specifier_id != ud->specifier_id)
724 continue;
726 if ((id->match_flags & IEEE1394_MATCH_VERSION) &&
727 id->version != ud->version)
728 continue;
730 return 1;
733 return 0;
737 static DEFINE_MUTEX(nodemgr_serialize_remove_uds);
739 static void nodemgr_remove_uds(struct node_entry *ne)
741 struct class_device *cdev;
742 struct unit_directory *ud, **unreg;
743 size_t i, count;
746 * This is awkward:
747 * Iteration over nodemgr_ud_class.children has to be protected by
748 * nodemgr_ud_class.sem, but class_device_unregister() will eventually
749 * take nodemgr_ud_class.sem too. Therefore store all uds to be
750 * unregistered in a temporary array, release the semaphore, and then
751 * unregister the uds.
753 * Since nodemgr_remove_uds can also run in other contexts than the
754 * knodemgrds (which are currently globally serialized), protect the
755 * gap after release of the semaphore by nodemgr_serialize_remove_uds.
758 mutex_lock(&nodemgr_serialize_remove_uds);
760 down(&nodemgr_ud_class.sem);
761 count = 0;
762 list_for_each_entry(cdev, &nodemgr_ud_class.children, node) {
763 ud = container_of(cdev, struct unit_directory, class_dev);
764 if (ud->ne == ne)
765 count++;
767 if (!count) {
768 up(&nodemgr_ud_class.sem);
769 mutex_unlock(&nodemgr_serialize_remove_uds);
770 return;
772 unreg = kcalloc(count, sizeof(*unreg), GFP_KERNEL);
773 if (!unreg) {
774 HPSB_ERR("NodeMgr: out of memory in nodemgr_remove_uds");
775 up(&nodemgr_ud_class.sem);
776 mutex_unlock(&nodemgr_serialize_remove_uds);
777 return;
779 i = 0;
780 list_for_each_entry(cdev, &nodemgr_ud_class.children, node) {
781 ud = container_of(cdev, struct unit_directory, class_dev);
782 if (ud->ne == ne) {
783 BUG_ON(i >= count);
784 unreg[i++] = ud;
787 up(&nodemgr_ud_class.sem);
789 for (i = 0; i < count; i++) {
790 class_device_unregister(&unreg[i]->class_dev);
791 device_unregister(&unreg[i]->device);
793 kfree(unreg);
795 mutex_unlock(&nodemgr_serialize_remove_uds);
799 static void nodemgr_remove_ne(struct node_entry *ne)
801 struct device *dev = &ne->device;
803 dev = get_device(&ne->device);
804 if (!dev)
805 return;
807 HPSB_DEBUG("Node removed: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
808 NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
810 nodemgr_remove_uds(ne);
812 class_device_unregister(&ne->class_dev);
813 device_unregister(dev);
815 put_device(dev);
818 static int __nodemgr_remove_host_dev(struct device *dev, void *data)
820 nodemgr_remove_ne(container_of(dev, struct node_entry, device));
821 return 0;
824 static void nodemgr_remove_host_dev(struct device *dev)
826 WARN_ON(device_for_each_child(dev, NULL, __nodemgr_remove_host_dev));
827 sysfs_remove_link(&dev->kobj, "irm_id");
828 sysfs_remove_link(&dev->kobj, "busmgr_id");
829 sysfs_remove_link(&dev->kobj, "host_id");
833 static void nodemgr_update_bus_options(struct node_entry *ne)
835 #ifdef CONFIG_IEEE1394_VERBOSEDEBUG
836 static const u16 mr[] = { 4, 64, 1024, 0};
837 #endif
838 quadlet_t busoptions = be32_to_cpu(ne->csr->bus_info_data[2]);
840 ne->busopt.irmc = (busoptions >> 31) & 1;
841 ne->busopt.cmc = (busoptions >> 30) & 1;
842 ne->busopt.isc = (busoptions >> 29) & 1;
843 ne->busopt.bmc = (busoptions >> 28) & 1;
844 ne->busopt.pmc = (busoptions >> 27) & 1;
845 ne->busopt.cyc_clk_acc = (busoptions >> 16) & 0xff;
846 ne->busopt.max_rec = 1 << (((busoptions >> 12) & 0xf) + 1);
847 ne->busopt.max_rom = (busoptions >> 8) & 0x3;
848 ne->busopt.generation = (busoptions >> 4) & 0xf;
849 ne->busopt.lnkspd = busoptions & 0x7;
851 HPSB_VERBOSE("NodeMgr: raw=0x%08x irmc=%d cmc=%d isc=%d bmc=%d pmc=%d "
852 "cyc_clk_acc=%d max_rec=%d max_rom=%d gen=%d lspd=%d",
853 busoptions, ne->busopt.irmc, ne->busopt.cmc,
854 ne->busopt.isc, ne->busopt.bmc, ne->busopt.pmc,
855 ne->busopt.cyc_clk_acc, ne->busopt.max_rec,
856 mr[ne->busopt.max_rom],
857 ne->busopt.generation, ne->busopt.lnkspd);
861 static struct node_entry *nodemgr_create_node(octlet_t guid, struct csr1212_csr *csr,
862 struct host_info *hi, nodeid_t nodeid,
863 unsigned int generation)
865 struct hpsb_host *host = hi->host;
866 struct node_entry *ne;
868 ne = kzalloc(sizeof(*ne), GFP_KERNEL);
869 if (!ne)
870 goto fail_alloc;
872 ne->host = host;
873 ne->nodeid = nodeid;
874 ne->generation = generation;
875 ne->needs_probe = 1;
877 ne->guid = guid;
878 ne->guid_vendor_id = (guid >> 40) & 0xffffff;
879 ne->guid_vendor_oui = nodemgr_find_oui_name(ne->guid_vendor_id);
880 ne->csr = csr;
882 memcpy(&ne->device, &nodemgr_dev_template_ne,
883 sizeof(ne->device));
884 ne->device.parent = &host->device;
885 snprintf(ne->device.bus_id, BUS_ID_SIZE, "%016Lx",
886 (unsigned long long)(ne->guid));
888 ne->class_dev.dev = &ne->device;
889 ne->class_dev.class = &nodemgr_ne_class;
890 snprintf(ne->class_dev.class_id, BUS_ID_SIZE, "%016Lx",
891 (unsigned long long)(ne->guid));
893 if (device_register(&ne->device))
894 goto fail_devreg;
895 if (class_device_register(&ne->class_dev))
896 goto fail_classdevreg;
897 get_device(&ne->device);
899 if (ne->guid_vendor_oui &&
900 device_create_file(&ne->device, &dev_attr_ne_guid_vendor_oui))
901 goto fail_addoiu;
902 nodemgr_create_ne_dev_files(ne);
904 nodemgr_update_bus_options(ne);
906 HPSB_DEBUG("%s added: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
907 (host->node_id == nodeid) ? "Host" : "Node",
908 NODE_BUS_ARGS(host, nodeid), (unsigned long long)guid);
910 return ne;
912 fail_addoiu:
913 put_device(&ne->device);
914 fail_classdevreg:
915 device_unregister(&ne->device);
916 fail_devreg:
917 kfree(ne);
918 fail_alloc:
919 HPSB_ERR("Failed to create node ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
920 NODE_BUS_ARGS(host, nodeid), (unsigned long long)guid);
922 return NULL;
926 static struct node_entry *find_entry_by_guid(u64 guid)
928 struct class_device *cdev;
929 struct node_entry *ne, *ret_ne = NULL;
931 down(&nodemgr_ne_class.sem);
932 list_for_each_entry(cdev, &nodemgr_ne_class.children, node) {
933 ne = container_of(cdev, struct node_entry, class_dev);
935 if (ne->guid == guid) {
936 ret_ne = ne;
937 break;
940 up(&nodemgr_ne_class.sem);
942 return ret_ne;
946 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host,
947 nodeid_t nodeid)
949 struct class_device *cdev;
950 struct node_entry *ne, *ret_ne = NULL;
952 down(&nodemgr_ne_class.sem);
953 list_for_each_entry(cdev, &nodemgr_ne_class.children, node) {
954 ne = container_of(cdev, struct node_entry, class_dev);
956 if (ne->host == host && ne->nodeid == nodeid) {
957 ret_ne = ne;
958 break;
961 up(&nodemgr_ne_class.sem);
963 return ret_ne;
967 static void nodemgr_register_device(struct node_entry *ne,
968 struct unit_directory *ud, struct device *parent)
970 memcpy(&ud->device, &nodemgr_dev_template_ud,
971 sizeof(ud->device));
973 ud->device.parent = parent;
975 snprintf(ud->device.bus_id, BUS_ID_SIZE, "%s-%u",
976 ne->device.bus_id, ud->id);
978 ud->class_dev.dev = &ud->device;
979 ud->class_dev.class = &nodemgr_ud_class;
980 snprintf(ud->class_dev.class_id, BUS_ID_SIZE, "%s-%u",
981 ne->device.bus_id, ud->id);
983 if (device_register(&ud->device))
984 goto fail_devreg;
985 if (class_device_register(&ud->class_dev))
986 goto fail_classdevreg;
987 get_device(&ud->device);
989 if (ud->vendor_oui &&
990 device_create_file(&ud->device, &dev_attr_ud_vendor_oui))
991 goto fail_addoui;
992 nodemgr_create_ud_dev_files(ud);
994 return;
996 fail_addoui:
997 put_device(&ud->device);
998 fail_classdevreg:
999 device_unregister(&ud->device);
1000 fail_devreg:
1001 HPSB_ERR("Failed to create unit %s", ud->device.bus_id);
1005 /* This implementation currently only scans the config rom and its
1006 * immediate unit directories looking for software_id and
1007 * software_version entries, in order to get driver autoloading working. */
1008 static struct unit_directory *nodemgr_process_unit_directory
1009 (struct host_info *hi, struct node_entry *ne, struct csr1212_keyval *ud_kv,
1010 unsigned int *id, struct unit_directory *parent)
1012 struct unit_directory *ud;
1013 struct unit_directory *ud_child = NULL;
1014 struct csr1212_dentry *dentry;
1015 struct csr1212_keyval *kv;
1016 u8 last_key_id = 0;
1018 ud = kzalloc(sizeof(*ud), GFP_KERNEL);
1019 if (!ud)
1020 goto unit_directory_error;
1022 ud->ne = ne;
1023 ud->ignore_driver = ignore_drivers;
1024 ud->address = ud_kv->offset + CSR1212_CONFIG_ROM_SPACE_BASE;
1025 ud->ud_kv = ud_kv;
1026 ud->id = (*id)++;
1028 csr1212_for_each_dir_entry(ne->csr, kv, ud_kv, dentry) {
1029 switch (kv->key.id) {
1030 case CSR1212_KV_ID_VENDOR:
1031 if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1032 ud->vendor_id = kv->value.immediate;
1033 ud->flags |= UNIT_DIRECTORY_VENDOR_ID;
1035 if (ud->vendor_id)
1036 ud->vendor_oui = nodemgr_find_oui_name(ud->vendor_id);
1038 break;
1040 case CSR1212_KV_ID_MODEL:
1041 ud->model_id = kv->value.immediate;
1042 ud->flags |= UNIT_DIRECTORY_MODEL_ID;
1043 break;
1045 case CSR1212_KV_ID_SPECIFIER_ID:
1046 ud->specifier_id = kv->value.immediate;
1047 ud->flags |= UNIT_DIRECTORY_SPECIFIER_ID;
1048 break;
1050 case CSR1212_KV_ID_VERSION:
1051 ud->version = kv->value.immediate;
1052 ud->flags |= UNIT_DIRECTORY_VERSION;
1053 break;
1055 case CSR1212_KV_ID_DESCRIPTOR:
1056 if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
1057 CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
1058 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
1059 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
1060 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
1061 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
1062 switch (last_key_id) {
1063 case CSR1212_KV_ID_VENDOR:
1064 ud->vendor_name_kv = kv;
1065 csr1212_keep_keyval(kv);
1066 break;
1068 case CSR1212_KV_ID_MODEL:
1069 ud->model_name_kv = kv;
1070 csr1212_keep_keyval(kv);
1071 break;
1074 } /* else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) ... */
1075 break;
1077 case CSR1212_KV_ID_DEPENDENT_INFO:
1078 /* Logical Unit Number */
1079 if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1080 if (ud->flags & UNIT_DIRECTORY_HAS_LUN) {
1081 ud_child = kmemdup(ud, sizeof(*ud_child), GFP_KERNEL);
1082 if (!ud_child)
1083 goto unit_directory_error;
1084 nodemgr_register_device(ne, ud_child, &ne->device);
1085 ud_child = NULL;
1087 ud->id = (*id)++;
1089 ud->lun = kv->value.immediate;
1090 ud->flags |= UNIT_DIRECTORY_HAS_LUN;
1092 /* Logical Unit Directory */
1093 } else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) {
1094 /* This should really be done in SBP2 as this is
1095 * doing SBP2 specific parsing.
1098 /* first register the parent unit */
1099 ud->flags |= UNIT_DIRECTORY_HAS_LUN_DIRECTORY;
1100 if (ud->device.bus != &ieee1394_bus_type)
1101 nodemgr_register_device(ne, ud, &ne->device);
1103 /* process the child unit */
1104 ud_child = nodemgr_process_unit_directory(hi, ne, kv, id, ud);
1106 if (ud_child == NULL)
1107 break;
1109 /* inherit unspecified values, the driver core picks it up */
1110 if ((ud->flags & UNIT_DIRECTORY_MODEL_ID) &&
1111 !(ud_child->flags & UNIT_DIRECTORY_MODEL_ID))
1113 ud_child->flags |= UNIT_DIRECTORY_MODEL_ID;
1114 ud_child->model_id = ud->model_id;
1116 if ((ud->flags & UNIT_DIRECTORY_SPECIFIER_ID) &&
1117 !(ud_child->flags & UNIT_DIRECTORY_SPECIFIER_ID))
1119 ud_child->flags |= UNIT_DIRECTORY_SPECIFIER_ID;
1120 ud_child->specifier_id = ud->specifier_id;
1122 if ((ud->flags & UNIT_DIRECTORY_VERSION) &&
1123 !(ud_child->flags & UNIT_DIRECTORY_VERSION))
1125 ud_child->flags |= UNIT_DIRECTORY_VERSION;
1126 ud_child->version = ud->version;
1129 /* register the child unit */
1130 ud_child->flags |= UNIT_DIRECTORY_LUN_DIRECTORY;
1131 nodemgr_register_device(ne, ud_child, &ud->device);
1134 break;
1136 default:
1137 break;
1139 last_key_id = kv->key.id;
1142 /* do not process child units here and only if not already registered */
1143 if (!parent && ud->device.bus != &ieee1394_bus_type)
1144 nodemgr_register_device(ne, ud, &ne->device);
1146 return ud;
1148 unit_directory_error:
1149 kfree(ud);
1150 return NULL;
1154 static void nodemgr_process_root_directory(struct host_info *hi, struct node_entry *ne)
1156 unsigned int ud_id = 0;
1157 struct csr1212_dentry *dentry;
1158 struct csr1212_keyval *kv;
1159 u8 last_key_id = 0;
1161 ne->needs_probe = 0;
1163 csr1212_for_each_dir_entry(ne->csr, kv, ne->csr->root_kv, dentry) {
1164 switch (kv->key.id) {
1165 case CSR1212_KV_ID_VENDOR:
1166 ne->vendor_id = kv->value.immediate;
1168 if (ne->vendor_id)
1169 ne->vendor_oui = nodemgr_find_oui_name(ne->vendor_id);
1170 break;
1172 case CSR1212_KV_ID_NODE_CAPABILITIES:
1173 ne->capabilities = kv->value.immediate;
1174 break;
1176 case CSR1212_KV_ID_UNIT:
1177 nodemgr_process_unit_directory(hi, ne, kv, &ud_id, NULL);
1178 break;
1180 case CSR1212_KV_ID_DESCRIPTOR:
1181 if (last_key_id == CSR1212_KV_ID_VENDOR) {
1182 if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
1183 CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
1184 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
1185 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
1186 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
1187 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
1188 ne->vendor_name_kv = kv;
1189 csr1212_keep_keyval(kv);
1192 break;
1194 last_key_id = kv->key.id;
1197 if (ne->vendor_oui &&
1198 device_create_file(&ne->device, &dev_attr_ne_vendor_oui))
1199 goto fail;
1200 if (ne->vendor_name_kv &&
1201 device_create_file(&ne->device, &dev_attr_ne_vendor_name_kv))
1202 goto fail;
1203 return;
1204 fail:
1205 HPSB_ERR("Failed to add sysfs attribute for node %016Lx",
1206 (unsigned long long)ne->guid);
1209 #ifdef CONFIG_HOTPLUG
1211 static int nodemgr_uevent(struct class_device *cdev, char **envp, int num_envp,
1212 char *buffer, int buffer_size)
1214 struct unit_directory *ud;
1215 int i = 0;
1216 int length = 0;
1217 /* ieee1394:venNmoNspNverN */
1218 char buf[8 + 1 + 3 + 8 + 2 + 8 + 2 + 8 + 3 + 8 + 1];
1220 if (!cdev)
1221 return -ENODEV;
1223 ud = container_of(cdev, struct unit_directory, class_dev);
1225 if (ud->ne->in_limbo || ud->ignore_driver)
1226 return -ENODEV;
1228 #define PUT_ENVP(fmt,val) \
1229 do { \
1230 int printed; \
1231 envp[i++] = buffer; \
1232 printed = snprintf(buffer, buffer_size - length, \
1233 fmt, val); \
1234 if ((buffer_size - (length+printed) <= 0) || (i >= num_envp)) \
1235 return -ENOMEM; \
1236 length += printed+1; \
1237 buffer += printed+1; \
1238 } while (0)
1240 PUT_ENVP("VENDOR_ID=%06x", ud->vendor_id);
1241 PUT_ENVP("MODEL_ID=%06x", ud->model_id);
1242 PUT_ENVP("GUID=%016Lx", (unsigned long long)ud->ne->guid);
1243 PUT_ENVP("SPECIFIER_ID=%06x", ud->specifier_id);
1244 PUT_ENVP("VERSION=%06x", ud->version);
1245 snprintf(buf, sizeof(buf), "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
1246 ud->vendor_id,
1247 ud->model_id,
1248 ud->specifier_id,
1249 ud->version);
1250 PUT_ENVP("MODALIAS=%s", buf);
1252 #undef PUT_ENVP
1254 envp[i] = NULL;
1256 return 0;
1259 #else
1261 static int nodemgr_uevent(struct class_device *cdev, char **envp, int num_envp,
1262 char *buffer, int buffer_size)
1264 return -ENODEV;
1267 #endif /* CONFIG_HOTPLUG */
1270 int hpsb_register_protocol(struct hpsb_protocol_driver *driver)
1272 /* This will cause a probe for devices */
1273 int error = driver_register(&driver->driver);
1274 if (!error)
1275 nodemgr_create_drv_files(driver);
1276 return error;
1279 void hpsb_unregister_protocol(struct hpsb_protocol_driver *driver)
1281 nodemgr_remove_drv_files(driver);
1282 /* This will subsequently disconnect all devices that our driver
1283 * is attached to. */
1284 driver_unregister(&driver->driver);
1289 * This function updates nodes that were present on the bus before the
1290 * reset and still are after the reset. The nodeid and the config rom
1291 * may have changed, and the drivers managing this device must be
1292 * informed that this device just went through a bus reset, to allow
1293 * the to take whatever actions required.
1295 static void nodemgr_update_node(struct node_entry *ne, struct csr1212_csr *csr,
1296 struct host_info *hi, nodeid_t nodeid,
1297 unsigned int generation)
1299 if (ne->nodeid != nodeid) {
1300 HPSB_DEBUG("Node changed: " NODE_BUS_FMT " -> " NODE_BUS_FMT,
1301 NODE_BUS_ARGS(ne->host, ne->nodeid),
1302 NODE_BUS_ARGS(ne->host, nodeid));
1303 ne->nodeid = nodeid;
1306 if (ne->busopt.generation != ((be32_to_cpu(csr->bus_info_data[2]) >> 4) & 0xf)) {
1307 kfree(ne->csr->private);
1308 csr1212_destroy_csr(ne->csr);
1309 ne->csr = csr;
1311 /* If the node's configrom generation has changed, we
1312 * unregister all the unit directories. */
1313 nodemgr_remove_uds(ne);
1315 nodemgr_update_bus_options(ne);
1317 /* Mark the node as new, so it gets re-probed */
1318 ne->needs_probe = 1;
1319 } else {
1320 /* old cache is valid, so update its generation */
1321 struct nodemgr_csr_info *ci = ne->csr->private;
1322 ci->generation = generation;
1323 /* free the partially filled now unneeded new cache */
1324 kfree(csr->private);
1325 csr1212_destroy_csr(csr);
1328 if (ne->in_limbo)
1329 nodemgr_resume_ne(ne);
1331 /* Mark the node current */
1332 ne->generation = generation;
1337 static void nodemgr_node_scan_one(struct host_info *hi,
1338 nodeid_t nodeid, int generation)
1340 struct hpsb_host *host = hi->host;
1341 struct node_entry *ne;
1342 octlet_t guid;
1343 struct csr1212_csr *csr;
1344 struct nodemgr_csr_info *ci;
1345 u8 *speed;
1347 ci = kmalloc(sizeof(*ci), GFP_KERNEL);
1348 if (!ci)
1349 return;
1351 ci->host = host;
1352 ci->nodeid = nodeid;
1353 ci->generation = generation;
1355 /* Prepare for speed probe which occurs when reading the ROM */
1356 speed = &(host->speed[NODEID_TO_NODE(nodeid)]);
1357 if (*speed > host->csr.lnk_spd)
1358 *speed = host->csr.lnk_spd;
1359 ci->speed_unverified = *speed > IEEE1394_SPEED_100;
1361 /* We need to detect when the ConfigROM's generation has changed,
1362 * so we only update the node's info when it needs to be. */
1364 csr = csr1212_create_csr(&nodemgr_csr_ops, 5 * sizeof(quadlet_t), ci);
1365 if (!csr || csr1212_parse_csr(csr) != CSR1212_SUCCESS) {
1366 HPSB_ERR("Error parsing configrom for node " NODE_BUS_FMT,
1367 NODE_BUS_ARGS(host, nodeid));
1368 if (csr)
1369 csr1212_destroy_csr(csr);
1370 kfree(ci);
1371 return;
1374 if (csr->bus_info_data[1] != IEEE1394_BUSID_MAGIC) {
1375 /* This isn't a 1394 device, but we let it slide. There
1376 * was a report of a device with broken firmware which
1377 * reported '2394' instead of '1394', which is obviously a
1378 * mistake. One would hope that a non-1394 device never
1379 * gets connected to Firewire bus. If someone does, we
1380 * shouldn't be held responsible, so we'll allow it with a
1381 * warning. */
1382 HPSB_WARN("Node " NODE_BUS_FMT " has invalid busID magic [0x%08x]",
1383 NODE_BUS_ARGS(host, nodeid), csr->bus_info_data[1]);
1386 guid = ((u64)be32_to_cpu(csr->bus_info_data[3]) << 32) | be32_to_cpu(csr->bus_info_data[4]);
1387 ne = find_entry_by_guid(guid);
1389 if (ne && ne->host != host && ne->in_limbo) {
1390 /* Must have moved this device from one host to another */
1391 nodemgr_remove_ne(ne);
1392 ne = NULL;
1395 if (!ne)
1396 nodemgr_create_node(guid, csr, hi, nodeid, generation);
1397 else
1398 nodemgr_update_node(ne, csr, hi, nodeid, generation);
1402 static void nodemgr_node_scan(struct host_info *hi, int generation)
1404 int count;
1405 struct hpsb_host *host = hi->host;
1406 struct selfid *sid = (struct selfid *)host->topology_map;
1407 nodeid_t nodeid = LOCAL_BUS;
1409 /* Scan each node on the bus */
1410 for (count = host->selfid_count; count; count--, sid++) {
1411 if (sid->extended)
1412 continue;
1414 if (!sid->link_active) {
1415 nodeid++;
1416 continue;
1418 nodemgr_node_scan_one(hi, nodeid++, generation);
1423 static void nodemgr_suspend_ne(struct node_entry *ne)
1425 struct class_device *cdev;
1426 struct unit_directory *ud;
1428 HPSB_DEBUG("Node suspended: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
1429 NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
1431 ne->in_limbo = 1;
1432 WARN_ON(device_create_file(&ne->device, &dev_attr_ne_in_limbo));
1434 down(&nodemgr_ud_class.sem);
1435 list_for_each_entry(cdev, &nodemgr_ud_class.children, node) {
1436 ud = container_of(cdev, struct unit_directory, class_dev);
1437 if (ud->ne != ne)
1438 continue;
1440 down_write(&ieee1394_bus_type.subsys.rwsem);
1441 if (ud->device.driver &&
1442 (!ud->device.driver->suspend ||
1443 ud->device.driver->suspend(&ud->device, PMSG_SUSPEND)))
1444 device_release_driver(&ud->device);
1445 up_write(&ieee1394_bus_type.subsys.rwsem);
1447 up(&nodemgr_ud_class.sem);
1451 static void nodemgr_resume_ne(struct node_entry *ne)
1453 struct class_device *cdev;
1454 struct unit_directory *ud;
1456 ne->in_limbo = 0;
1457 device_remove_file(&ne->device, &dev_attr_ne_in_limbo);
1459 down(&nodemgr_ud_class.sem);
1460 list_for_each_entry(cdev, &nodemgr_ud_class.children, node) {
1461 ud = container_of(cdev, struct unit_directory, class_dev);
1462 if (ud->ne != ne)
1463 continue;
1465 down_read(&ieee1394_bus_type.subsys.rwsem);
1466 if (ud->device.driver && ud->device.driver->resume)
1467 ud->device.driver->resume(&ud->device);
1468 up_read(&ieee1394_bus_type.subsys.rwsem);
1470 up(&nodemgr_ud_class.sem);
1472 HPSB_DEBUG("Node resumed: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
1473 NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
1477 static void nodemgr_update_pdrv(struct node_entry *ne)
1479 struct unit_directory *ud;
1480 struct hpsb_protocol_driver *pdrv;
1481 struct class_device *cdev;
1483 down(&nodemgr_ud_class.sem);
1484 list_for_each_entry(cdev, &nodemgr_ud_class.children, node) {
1485 ud = container_of(cdev, struct unit_directory, class_dev);
1486 if (ud->ne != ne)
1487 continue;
1489 down_write(&ieee1394_bus_type.subsys.rwsem);
1490 if (ud->device.driver) {
1491 pdrv = container_of(ud->device.driver,
1492 struct hpsb_protocol_driver,
1493 driver);
1494 if (pdrv->update && pdrv->update(ud))
1495 device_release_driver(&ud->device);
1497 up_write(&ieee1394_bus_type.subsys.rwsem);
1499 up(&nodemgr_ud_class.sem);
1503 /* Write the BROADCAST_CHANNEL as per IEEE1394a 8.3.2.3.11 and 8.4.2.3. This
1504 * seems like an optional service but in the end it is practically mandatory
1505 * as a consequence of these clauses.
1507 * Note that we cannot do a broadcast write to all nodes at once because some
1508 * pre-1394a devices would hang. */
1509 static void nodemgr_irm_write_bc(struct node_entry *ne, int generation)
1511 const u64 bc_addr = (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL);
1512 quadlet_t bc_remote, bc_local;
1513 int error;
1515 if (!ne->host->is_irm || ne->generation != generation ||
1516 ne->nodeid == ne->host->node_id)
1517 return;
1519 bc_local = cpu_to_be32(ne->host->csr.broadcast_channel);
1521 /* Check if the register is implemented and 1394a compliant. */
1522 error = hpsb_read(ne->host, ne->nodeid, generation, bc_addr, &bc_remote,
1523 sizeof(bc_remote));
1524 if (!error && bc_remote & cpu_to_be32(0x80000000) &&
1525 bc_remote != bc_local)
1526 hpsb_node_write(ne, bc_addr, &bc_local, sizeof(bc_local));
1530 static void nodemgr_probe_ne(struct host_info *hi, struct node_entry *ne, int generation)
1532 struct device *dev;
1534 if (ne->host != hi->host || ne->in_limbo)
1535 return;
1537 dev = get_device(&ne->device);
1538 if (!dev)
1539 return;
1541 nodemgr_irm_write_bc(ne, generation);
1543 /* If "needs_probe", then this is either a new or changed node we
1544 * rescan totally. If the generation matches for an existing node
1545 * (one that existed prior to the bus reset) we send update calls
1546 * down to the drivers. Otherwise, this is a dead node and we
1547 * suspend it. */
1548 if (ne->needs_probe)
1549 nodemgr_process_root_directory(hi, ne);
1550 else if (ne->generation == generation)
1551 nodemgr_update_pdrv(ne);
1552 else
1553 nodemgr_suspend_ne(ne);
1555 put_device(dev);
1559 static void nodemgr_node_probe(struct host_info *hi, int generation)
1561 struct hpsb_host *host = hi->host;
1562 struct class_device *cdev;
1563 struct node_entry *ne;
1565 /* Do some processing of the nodes we've probed. This pulls them
1566 * into the sysfs layer if needed, and can result in processing of
1567 * unit-directories, or just updating the node and it's
1568 * unit-directories.
1570 * Run updates before probes. Usually, updates are time-critical
1571 * while probes are time-consuming. (Well, those probes need some
1572 * improvement...) */
1574 down(&nodemgr_ne_class.sem);
1575 list_for_each_entry(cdev, &nodemgr_ne_class.children, node) {
1576 ne = container_of(cdev, struct node_entry, class_dev);
1577 if (!ne->needs_probe)
1578 nodemgr_probe_ne(hi, ne, generation);
1580 list_for_each_entry(cdev, &nodemgr_ne_class.children, node) {
1581 ne = container_of(cdev, struct node_entry, class_dev);
1582 if (ne->needs_probe)
1583 nodemgr_probe_ne(hi, ne, generation);
1585 up(&nodemgr_ne_class.sem);
1588 /* If we had a bus reset while we were scanning the bus, it is
1589 * possible that we did not probe all nodes. In that case, we
1590 * skip the clean up for now, since we could remove nodes that
1591 * were still on the bus. Another bus scan is pending which will
1592 * do the clean up eventually.
1594 * Now let's tell the bus to rescan our devices. This may seem
1595 * like overhead, but the driver-model core will only scan a
1596 * device for a driver when either the device is added, or when a
1597 * new driver is added. A bus reset is a good reason to rescan
1598 * devices that were there before. For example, an sbp2 device
1599 * may become available for login, if the host that held it was
1600 * just removed. */
1602 if (generation == get_hpsb_generation(host))
1603 if (bus_rescan_devices(&ieee1394_bus_type))
1604 HPSB_DEBUG("bus_rescan_devices had an error");
1607 static int nodemgr_send_resume_packet(struct hpsb_host *host)
1609 struct hpsb_packet *packet;
1610 int error = -ENOMEM;
1612 packet = hpsb_make_phypacket(host,
1613 EXTPHYPACKET_TYPE_RESUME |
1614 NODEID_TO_NODE(host->node_id) << PHYPACKET_PORT_SHIFT);
1615 if (packet) {
1616 packet->no_waiter = 1;
1617 packet->generation = get_hpsb_generation(host);
1618 error = hpsb_send_packet(packet);
1620 if (error)
1621 HPSB_WARN("fw-host%d: Failed to broadcast resume packet",
1622 host->id);
1623 return error;
1626 /* Perform a few high-level IRM responsibilities. */
1627 static int nodemgr_do_irm_duties(struct hpsb_host *host, int cycles)
1629 quadlet_t bc;
1631 /* if irm_id == -1 then there is no IRM on this bus */
1632 if (!host->is_irm || host->irm_id == (nodeid_t)-1)
1633 return 1;
1635 /* We are a 1394a-2000 compliant IRM. Set the validity bit. */
1636 host->csr.broadcast_channel |= 0x40000000;
1638 /* If there is no bus manager then we should set the root node's
1639 * force_root bit to promote bus stability per the 1394
1640 * spec. (8.4.2.6) */
1641 if (host->busmgr_id == 0xffff && host->node_count > 1)
1643 u16 root_node = host->node_count - 1;
1645 /* get cycle master capability flag from root node */
1646 if (host->is_cycmst ||
1647 (!hpsb_read(host, LOCAL_BUS | root_node, get_hpsb_generation(host),
1648 (CSR_REGISTER_BASE + CSR_CONFIG_ROM + 2 * sizeof(quadlet_t)),
1649 &bc, sizeof(quadlet_t)) &&
1650 be32_to_cpu(bc) & 1 << CSR_CMC_SHIFT))
1651 hpsb_send_phy_config(host, root_node, -1);
1652 else {
1653 HPSB_DEBUG("The root node is not cycle master capable; "
1654 "selecting a new root node and resetting...");
1656 if (cycles >= 5) {
1657 /* Oh screw it! Just leave the bus as it is */
1658 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1659 return 1;
1662 hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1663 hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1665 return 0;
1669 /* Some devices suspend their ports while being connected to an inactive
1670 * host adapter, i.e. if connected before the low-level driver is
1671 * loaded. They become visible either when physically unplugged and
1672 * replugged, or when receiving a resume packet. Send one once. */
1673 if (!host->resume_packet_sent && !nodemgr_send_resume_packet(host))
1674 host->resume_packet_sent = 1;
1676 return 1;
1679 /* We need to ensure that if we are not the IRM, that the IRM node is capable of
1680 * everything we can do, otherwise issue a bus reset and try to become the IRM
1681 * ourselves. */
1682 static int nodemgr_check_irm_capability(struct hpsb_host *host, int cycles)
1684 quadlet_t bc;
1685 int status;
1687 if (hpsb_disable_irm || host->is_irm)
1688 return 1;
1690 status = hpsb_read(host, LOCAL_BUS | (host->irm_id),
1691 get_hpsb_generation(host),
1692 (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL),
1693 &bc, sizeof(quadlet_t));
1695 if (status < 0 || !(be32_to_cpu(bc) & 0x80000000)) {
1696 /* The current irm node does not have a valid BROADCAST_CHANNEL
1697 * register and we do, so reset the bus with force_root set */
1698 HPSB_DEBUG("Current remote IRM is not 1394a-2000 compliant, resetting...");
1700 if (cycles >= 5) {
1701 /* Oh screw it! Just leave the bus as it is */
1702 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1703 return 1;
1706 hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1707 hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1709 return 0;
1712 return 1;
1715 static int nodemgr_host_thread(void *__hi)
1717 struct host_info *hi = (struct host_info *)__hi;
1718 struct hpsb_host *host = hi->host;
1719 unsigned int g, generation = 0;
1720 int i, reset_cycles = 0;
1722 /* Setup our device-model entries */
1723 nodemgr_create_host_dev_files(host);
1725 for (;;) {
1726 /* Sleep until next bus reset */
1727 set_current_state(TASK_INTERRUPTIBLE);
1728 if (get_hpsb_generation(host) == generation)
1729 schedule();
1730 __set_current_state(TASK_RUNNING);
1732 /* Thread may have been woken up to freeze or to exit */
1733 if (try_to_freeze())
1734 continue;
1735 if (kthread_should_stop())
1736 goto exit;
1738 if (mutex_lock_interruptible(&nodemgr_serialize)) {
1739 if (try_to_freeze())
1740 continue;
1741 goto exit;
1744 /* Pause for 1/4 second in 1/16 second intervals,
1745 * to make sure things settle down. */
1746 g = get_hpsb_generation(host);
1747 for (i = 0; i < 4 ; i++) {
1748 if (msleep_interruptible(63) || kthread_should_stop())
1749 goto unlock_exit;
1751 /* Now get the generation in which the node ID's we collect
1752 * are valid. During the bus scan we will use this generation
1753 * for the read transactions, so that if another reset occurs
1754 * during the scan the transactions will fail instead of
1755 * returning bogus data. */
1756 generation = get_hpsb_generation(host);
1758 /* If we get a reset before we are done waiting, then
1759 * start the the waiting over again */
1760 if (generation != g)
1761 g = generation, i = 0;
1764 if (!nodemgr_check_irm_capability(host, reset_cycles) ||
1765 !nodemgr_do_irm_duties(host, reset_cycles)) {
1766 reset_cycles++;
1767 mutex_unlock(&nodemgr_serialize);
1768 continue;
1770 reset_cycles = 0;
1772 /* Scan our nodes to get the bus options and create node
1773 * entries. This does not do the sysfs stuff, since that
1774 * would trigger uevents and such, which is a bad idea at
1775 * this point. */
1776 nodemgr_node_scan(hi, generation);
1778 /* This actually does the full probe, with sysfs
1779 * registration. */
1780 nodemgr_node_probe(hi, generation);
1782 /* Update some of our sysfs symlinks */
1783 nodemgr_update_host_dev_links(host);
1785 mutex_unlock(&nodemgr_serialize);
1787 unlock_exit:
1788 mutex_unlock(&nodemgr_serialize);
1789 exit:
1790 HPSB_VERBOSE("NodeMgr: Exiting thread");
1791 return 0;
1794 int nodemgr_for_each_host(void *__data, int (*cb)(struct hpsb_host *, void *))
1796 struct class_device *cdev;
1797 struct hpsb_host *host;
1798 int error = 0;
1800 down(&hpsb_host_class.sem);
1801 list_for_each_entry(cdev, &hpsb_host_class.children, node) {
1802 host = container_of(cdev, struct hpsb_host, class_dev);
1804 if ((error = cb(host, __data)))
1805 break;
1807 up(&hpsb_host_class.sem);
1809 return error;
1812 /* The following four convenience functions use a struct node_entry
1813 * for addressing a node on the bus. They are intended for use by any
1814 * process context, not just the nodemgr thread, so we need to be a
1815 * little careful when reading out the node ID and generation. The
1816 * thing that can go wrong is that we get the node ID, then a bus
1817 * reset occurs, and then we read the generation. The node ID is
1818 * possibly invalid, but the generation is current, and we end up
1819 * sending a packet to a the wrong node.
1821 * The solution is to make sure we read the generation first, so that
1822 * if a reset occurs in the process, we end up with a stale generation
1823 * and the transactions will fail instead of silently using wrong node
1824 * ID's.
1827 void hpsb_node_fill_packet(struct node_entry *ne, struct hpsb_packet *pkt)
1829 pkt->host = ne->host;
1830 pkt->generation = ne->generation;
1831 barrier();
1832 pkt->node_id = ne->nodeid;
1835 int hpsb_node_write(struct node_entry *ne, u64 addr,
1836 quadlet_t *buffer, size_t length)
1838 unsigned int generation = ne->generation;
1840 barrier();
1841 return hpsb_write(ne->host, ne->nodeid, generation,
1842 addr, buffer, length);
1845 static void nodemgr_add_host(struct hpsb_host *host)
1847 struct host_info *hi;
1849 hi = hpsb_create_hostinfo(&nodemgr_highlevel, host, sizeof(*hi));
1850 if (!hi) {
1851 HPSB_ERR("NodeMgr: out of memory in add host");
1852 return;
1854 hi->host = host;
1855 hi->thread = kthread_run(nodemgr_host_thread, hi, "knodemgrd_%d",
1856 host->id);
1857 if (IS_ERR(hi->thread)) {
1858 HPSB_ERR("NodeMgr: cannot start thread for host %d", host->id);
1859 hpsb_destroy_hostinfo(&nodemgr_highlevel, host);
1863 static void nodemgr_host_reset(struct hpsb_host *host)
1865 struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1867 if (hi) {
1868 HPSB_VERBOSE("NodeMgr: Processing reset for host %d", host->id);
1869 wake_up_process(hi->thread);
1873 static void nodemgr_remove_host(struct hpsb_host *host)
1875 struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1877 if (hi) {
1878 kthread_stop(hi->thread);
1879 nodemgr_remove_host_dev(&host->device);
1883 static struct hpsb_highlevel nodemgr_highlevel = {
1884 .name = "Node manager",
1885 .add_host = nodemgr_add_host,
1886 .host_reset = nodemgr_host_reset,
1887 .remove_host = nodemgr_remove_host,
1890 int init_ieee1394_nodemgr(void)
1892 int error;
1894 error = class_register(&nodemgr_ne_class);
1895 if (error)
1896 return error;
1898 error = class_register(&nodemgr_ud_class);
1899 if (error) {
1900 class_unregister(&nodemgr_ne_class);
1901 return error;
1904 hpsb_register_highlevel(&nodemgr_highlevel);
1905 return 0;
1908 void cleanup_ieee1394_nodemgr(void)
1910 hpsb_unregister_highlevel(&nodemgr_highlevel);
1912 class_unregister(&nodemgr_ud_class);
1913 class_unregister(&nodemgr_ne_class);