[POWERPC] iSeries: don't printk with HV spinlock held
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / ieee1394 / nodemgr.c
blob90dc75be3418c91f0baab414181577f62ded696f
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/module.h>
18 #include <linux/moduleparam.h>
19 #include <linux/mutex.h>
20 #include <linux/freezer.h>
21 #include <asm/atomic.h>
22 #include <asm/semaphore.h>
24 #include "csr.h"
25 #include "highlevel.h"
26 #include "hosts.h"
27 #include "ieee1394.h"
28 #include "ieee1394_core.h"
29 #include "ieee1394_hotplug.h"
30 #include "ieee1394_types.h"
31 #include "ieee1394_transactions.h"
32 #include "nodemgr.h"
34 static int ignore_drivers;
35 module_param(ignore_drivers, int, S_IRUGO | S_IWUSR);
36 MODULE_PARM_DESC(ignore_drivers, "Disable automatic probing for drivers.");
38 struct nodemgr_csr_info {
39 struct hpsb_host *host;
40 nodeid_t nodeid;
41 unsigned int generation;
42 unsigned int speed_unverified:1;
47 * Correct the speed map entry. This is necessary
48 * - for nodes with link speed < phy speed,
49 * - for 1394b nodes with negotiated phy port speed < IEEE1394_SPEED_MAX.
50 * A possible speed is determined by trial and error, using quadlet reads.
52 static int nodemgr_check_speed(struct nodemgr_csr_info *ci, u64 addr,
53 quadlet_t *buffer)
55 quadlet_t q;
56 u8 i, *speed, old_speed, good_speed;
57 int error;
59 speed = &(ci->host->speed[NODEID_TO_NODE(ci->nodeid)]);
60 old_speed = *speed;
61 good_speed = IEEE1394_SPEED_MAX + 1;
63 /* Try every speed from S100 to old_speed.
64 * If we did it the other way around, a too low speed could be caught
65 * if the retry succeeded for some other reason, e.g. because the link
66 * just finished its initialization. */
67 for (i = IEEE1394_SPEED_100; i <= old_speed; i++) {
68 *speed = i;
69 error = hpsb_read(ci->host, ci->nodeid, ci->generation, addr,
70 &q, sizeof(quadlet_t));
71 if (error)
72 break;
73 *buffer = q;
74 good_speed = i;
76 if (good_speed <= IEEE1394_SPEED_MAX) {
77 HPSB_DEBUG("Speed probe of node " NODE_BUS_FMT " yields %s",
78 NODE_BUS_ARGS(ci->host, ci->nodeid),
79 hpsb_speedto_str[good_speed]);
80 *speed = good_speed;
81 ci->speed_unverified = 0;
82 return 0;
84 *speed = old_speed;
85 return error;
88 static int nodemgr_bus_read(struct csr1212_csr *csr, u64 addr, u16 length,
89 void *buffer, void *__ci)
91 struct nodemgr_csr_info *ci = (struct nodemgr_csr_info*)__ci;
92 int i, error;
94 for (i = 1; ; i++) {
95 error = hpsb_read(ci->host, ci->nodeid, ci->generation, addr,
96 buffer, length);
97 if (!error) {
98 ci->speed_unverified = 0;
99 break;
101 /* Give up after 3rd failure. */
102 if (i == 3)
103 break;
105 /* The ieee1394_core guessed the node's speed capability from
106 * the self ID. Check whether a lower speed works. */
107 if (ci->speed_unverified && length == sizeof(quadlet_t)) {
108 error = nodemgr_check_speed(ci, addr, buffer);
109 if (!error)
110 break;
112 if (msleep_interruptible(334))
113 return -EINTR;
115 return error;
118 static int nodemgr_get_max_rom(quadlet_t *bus_info_data, void *__ci)
120 return (be32_to_cpu(bus_info_data[2]) >> 8) & 0x3;
123 static struct csr1212_bus_ops nodemgr_csr_ops = {
124 .bus_read = nodemgr_bus_read,
125 .get_max_rom = nodemgr_get_max_rom
130 * Basically what we do here is start off retrieving the bus_info block.
131 * From there will fill in some info about the node, verify it is of IEEE
132 * 1394 type, and that the crc checks out ok. After that we start off with
133 * the root directory, and subdirectories. To do this, we retrieve the
134 * quadlet header for a directory, find out the length, and retrieve the
135 * complete directory entry (be it a leaf or a directory). We then process
136 * it and add the info to our structure for that particular node.
138 * We verify CRC's along the way for each directory/block/leaf. The entire
139 * node structure is generic, and simply stores the information in a way
140 * that's easy to parse by the protocol interface.
144 * The nodemgr relies heavily on the Driver Model for device callbacks and
145 * driver/device mappings. The old nodemgr used to handle all this itself,
146 * but now we are much simpler because of the LDM.
149 struct host_info {
150 struct hpsb_host *host;
151 struct list_head list;
152 struct task_struct *thread;
155 static int nodemgr_bus_match(struct device * dev, struct device_driver * drv);
156 static int nodemgr_uevent(struct device *dev, struct kobj_uevent_env *env);
157 static void nodemgr_resume_ne(struct node_entry *ne);
158 static void nodemgr_remove_ne(struct node_entry *ne);
159 static struct node_entry *find_entry_by_guid(u64 guid);
161 struct bus_type ieee1394_bus_type = {
162 .name = "ieee1394",
163 .match = nodemgr_bus_match,
166 static void host_cls_release(struct device *dev)
168 put_device(&container_of((dev), struct hpsb_host, host_dev)->device);
171 struct class hpsb_host_class = {
172 .name = "ieee1394_host",
173 .dev_release = host_cls_release,
176 static void ne_cls_release(struct device *dev)
178 put_device(&container_of((dev), struct node_entry, node_dev)->device);
181 static struct class nodemgr_ne_class = {
182 .name = "ieee1394_node",
183 .dev_release = ne_cls_release,
186 static void ud_cls_release(struct device *dev)
188 put_device(&container_of((dev), struct unit_directory, unit_dev)->device);
191 /* The name here is only so that unit directory hotplug works with old
192 * style hotplug, which only ever did unit directories anyway.
194 static struct class nodemgr_ud_class = {
195 .name = "ieee1394",
196 .dev_release = ud_cls_release,
197 .dev_uevent = nodemgr_uevent,
200 static struct hpsb_highlevel nodemgr_highlevel;
203 static void nodemgr_release_ud(struct device *dev)
205 struct unit_directory *ud = container_of(dev, struct unit_directory, device);
207 if (ud->vendor_name_kv)
208 csr1212_release_keyval(ud->vendor_name_kv);
209 if (ud->model_name_kv)
210 csr1212_release_keyval(ud->model_name_kv);
212 kfree(ud);
215 static void nodemgr_release_ne(struct device *dev)
217 struct node_entry *ne = container_of(dev, struct node_entry, device);
219 if (ne->vendor_name_kv)
220 csr1212_release_keyval(ne->vendor_name_kv);
222 kfree(ne);
226 static void nodemgr_release_host(struct device *dev)
228 struct hpsb_host *host = container_of(dev, struct hpsb_host, device);
230 csr1212_destroy_csr(host->csr.rom);
232 kfree(host);
235 static int nodemgr_ud_platform_data;
237 static struct device nodemgr_dev_template_ud = {
238 .bus = &ieee1394_bus_type,
239 .release = nodemgr_release_ud,
240 .platform_data = &nodemgr_ud_platform_data,
243 static struct device nodemgr_dev_template_ne = {
244 .bus = &ieee1394_bus_type,
245 .release = nodemgr_release_ne,
248 /* This dummy driver prevents the host devices from being scanned. We have no
249 * useful drivers for them yet, and there would be a deadlock possible if the
250 * driver core scans the host device while the host's low-level driver (i.e.
251 * the host's parent device) is being removed. */
252 static struct device_driver nodemgr_mid_layer_driver = {
253 .bus = &ieee1394_bus_type,
254 .name = "nodemgr",
255 .owner = THIS_MODULE,
258 struct device nodemgr_dev_template_host = {
259 .bus = &ieee1394_bus_type,
260 .release = nodemgr_release_host,
264 #define fw_attr(class, class_type, field, type, format_string) \
265 static ssize_t fw_show_##class##_##field (struct device *dev, struct device_attribute *attr, char *buf)\
267 class_type *class; \
268 class = container_of(dev, class_type, device); \
269 return sprintf(buf, format_string, (type)class->field); \
271 static struct device_attribute dev_attr_##class##_##field = { \
272 .attr = {.name = __stringify(field), .mode = S_IRUGO }, \
273 .show = fw_show_##class##_##field, \
276 #define fw_attr_td(class, class_type, td_kv) \
277 static ssize_t fw_show_##class##_##td_kv (struct device *dev, struct device_attribute *attr, char *buf)\
279 int len; \
280 class_type *class = container_of(dev, class_type, device); \
281 len = (class->td_kv->value.leaf.len - 2) * sizeof(quadlet_t); \
282 memcpy(buf, \
283 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_DATA(class->td_kv), \
284 len); \
285 while (buf[len - 1] == '\0') \
286 len--; \
287 buf[len++] = '\n'; \
288 buf[len] = '\0'; \
289 return len; \
291 static struct device_attribute dev_attr_##class##_##td_kv = { \
292 .attr = {.name = __stringify(td_kv), .mode = S_IRUGO }, \
293 .show = fw_show_##class##_##td_kv, \
297 #define fw_drv_attr(field, type, format_string) \
298 static ssize_t fw_drv_show_##field (struct device_driver *drv, char *buf) \
300 struct hpsb_protocol_driver *driver; \
301 driver = container_of(drv, struct hpsb_protocol_driver, driver); \
302 return sprintf(buf, format_string, (type)driver->field);\
304 static struct driver_attribute driver_attr_drv_##field = { \
305 .attr = {.name = __stringify(field), .mode = S_IRUGO }, \
306 .show = fw_drv_show_##field, \
310 static ssize_t fw_show_ne_bus_options(struct device *dev, struct device_attribute *attr, char *buf)
312 struct node_entry *ne = container_of(dev, struct node_entry, device);
314 return sprintf(buf, "IRMC(%d) CMC(%d) ISC(%d) BMC(%d) PMC(%d) GEN(%d) "
315 "LSPD(%d) MAX_REC(%d) MAX_ROM(%d) CYC_CLK_ACC(%d)\n",
316 ne->busopt.irmc,
317 ne->busopt.cmc, ne->busopt.isc, ne->busopt.bmc,
318 ne->busopt.pmc, ne->busopt.generation, ne->busopt.lnkspd,
319 ne->busopt.max_rec,
320 ne->busopt.max_rom,
321 ne->busopt.cyc_clk_acc);
323 static DEVICE_ATTR(bus_options,S_IRUGO,fw_show_ne_bus_options,NULL);
326 #ifdef HPSB_DEBUG_TLABELS
327 static ssize_t fw_show_ne_tlabels_free(struct device *dev,
328 struct device_attribute *attr, char *buf)
330 struct node_entry *ne = container_of(dev, struct node_entry, device);
331 unsigned long flags;
332 unsigned long *tp = ne->host->tl_pool[NODEID_TO_NODE(ne->nodeid)].map;
333 int tf;
335 spin_lock_irqsave(&hpsb_tlabel_lock, flags);
336 tf = 64 - bitmap_weight(tp, 64);
337 spin_unlock_irqrestore(&hpsb_tlabel_lock, flags);
339 return sprintf(buf, "%d\n", tf);
341 static DEVICE_ATTR(tlabels_free,S_IRUGO,fw_show_ne_tlabels_free,NULL);
344 static ssize_t fw_show_ne_tlabels_mask(struct device *dev,
345 struct device_attribute *attr, char *buf)
347 struct node_entry *ne = container_of(dev, struct node_entry, device);
348 unsigned long flags;
349 unsigned long *tp = ne->host->tl_pool[NODEID_TO_NODE(ne->nodeid)].map;
350 u64 tm;
352 spin_lock_irqsave(&hpsb_tlabel_lock, flags);
353 #if (BITS_PER_LONG <= 32)
354 tm = ((u64)tp[0] << 32) + tp[1];
355 #else
356 tm = tp[0];
357 #endif
358 spin_unlock_irqrestore(&hpsb_tlabel_lock, flags);
360 return sprintf(buf, "0x%016llx\n", (unsigned long long)tm);
362 static DEVICE_ATTR(tlabels_mask, S_IRUGO, fw_show_ne_tlabels_mask, NULL);
363 #endif /* HPSB_DEBUG_TLABELS */
366 static ssize_t fw_set_ignore_driver(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
368 struct unit_directory *ud = container_of(dev, struct unit_directory, device);
369 int state = simple_strtoul(buf, NULL, 10);
371 if (state == 1) {
372 ud->ignore_driver = 1;
373 device_release_driver(dev);
374 } else if (state == 0)
375 ud->ignore_driver = 0;
377 return count;
379 static ssize_t fw_get_ignore_driver(struct device *dev, struct device_attribute *attr, char *buf)
381 struct unit_directory *ud = container_of(dev, struct unit_directory, device);
383 return sprintf(buf, "%d\n", ud->ignore_driver);
385 static DEVICE_ATTR(ignore_driver, S_IWUSR | S_IRUGO, fw_get_ignore_driver, fw_set_ignore_driver);
388 static ssize_t fw_set_destroy_node(struct bus_type *bus, const char *buf, size_t count)
390 struct node_entry *ne;
391 u64 guid = (u64)simple_strtoull(buf, NULL, 16);
393 ne = find_entry_by_guid(guid);
395 if (ne == NULL || !ne->in_limbo)
396 return -EINVAL;
398 nodemgr_remove_ne(ne);
400 return count;
402 static ssize_t fw_get_destroy_node(struct bus_type *bus, char *buf)
404 return sprintf(buf, "You can destroy in_limbo nodes by writing their GUID to this file\n");
406 static BUS_ATTR(destroy_node, S_IWUSR | S_IRUGO, fw_get_destroy_node, fw_set_destroy_node);
409 static ssize_t fw_set_rescan(struct bus_type *bus, const char *buf,
410 size_t count)
412 int error = 0;
414 if (simple_strtoul(buf, NULL, 10) == 1)
415 error = bus_rescan_devices(&ieee1394_bus_type);
416 return error ? error : count;
418 static ssize_t fw_get_rescan(struct bus_type *bus, char *buf)
420 return sprintf(buf, "You can force a rescan of the bus for "
421 "drivers by writing a 1 to this file\n");
423 static BUS_ATTR(rescan, S_IWUSR | S_IRUGO, fw_get_rescan, fw_set_rescan);
426 static ssize_t fw_set_ignore_drivers(struct bus_type *bus, const char *buf, size_t count)
428 int state = simple_strtoul(buf, NULL, 10);
430 if (state == 1)
431 ignore_drivers = 1;
432 else if (state == 0)
433 ignore_drivers = 0;
435 return count;
437 static ssize_t fw_get_ignore_drivers(struct bus_type *bus, char *buf)
439 return sprintf(buf, "%d\n", ignore_drivers);
441 static BUS_ATTR(ignore_drivers, S_IWUSR | S_IRUGO, fw_get_ignore_drivers, fw_set_ignore_drivers);
444 struct bus_attribute *const fw_bus_attrs[] = {
445 &bus_attr_destroy_node,
446 &bus_attr_rescan,
447 &bus_attr_ignore_drivers,
448 NULL
452 fw_attr(ne, struct node_entry, capabilities, unsigned int, "0x%06x\n")
453 fw_attr(ne, struct node_entry, nodeid, unsigned int, "0x%04x\n")
455 fw_attr(ne, struct node_entry, vendor_id, unsigned int, "0x%06x\n")
456 fw_attr_td(ne, struct node_entry, vendor_name_kv)
458 fw_attr(ne, struct node_entry, guid, unsigned long long, "0x%016Lx\n")
459 fw_attr(ne, struct node_entry, guid_vendor_id, unsigned int, "0x%06x\n")
460 fw_attr(ne, struct node_entry, in_limbo, int, "%d\n");
462 static struct device_attribute *const fw_ne_attrs[] = {
463 &dev_attr_ne_guid,
464 &dev_attr_ne_guid_vendor_id,
465 &dev_attr_ne_capabilities,
466 &dev_attr_ne_vendor_id,
467 &dev_attr_ne_nodeid,
468 &dev_attr_bus_options,
469 #ifdef HPSB_DEBUG_TLABELS
470 &dev_attr_tlabels_free,
471 &dev_attr_tlabels_mask,
472 #endif
477 fw_attr(ud, struct unit_directory, address, unsigned long long, "0x%016Lx\n")
478 fw_attr(ud, struct unit_directory, length, int, "%d\n")
479 /* These are all dependent on the value being provided */
480 fw_attr(ud, struct unit_directory, vendor_id, unsigned int, "0x%06x\n")
481 fw_attr(ud, struct unit_directory, model_id, unsigned int, "0x%06x\n")
482 fw_attr(ud, struct unit_directory, specifier_id, unsigned int, "0x%06x\n")
483 fw_attr(ud, struct unit_directory, version, unsigned int, "0x%06x\n")
484 fw_attr_td(ud, struct unit_directory, vendor_name_kv)
485 fw_attr_td(ud, struct unit_directory, model_name_kv)
487 static struct device_attribute *const fw_ud_attrs[] = {
488 &dev_attr_ud_address,
489 &dev_attr_ud_length,
490 &dev_attr_ignore_driver,
494 fw_attr(host, struct hpsb_host, node_count, int, "%d\n")
495 fw_attr(host, struct hpsb_host, selfid_count, int, "%d\n")
496 fw_attr(host, struct hpsb_host, nodes_active, int, "%d\n")
497 fw_attr(host, struct hpsb_host, in_bus_reset, int, "%d\n")
498 fw_attr(host, struct hpsb_host, is_root, int, "%d\n")
499 fw_attr(host, struct hpsb_host, is_cycmst, int, "%d\n")
500 fw_attr(host, struct hpsb_host, is_irm, int, "%d\n")
501 fw_attr(host, struct hpsb_host, is_busmgr, int, "%d\n")
503 static struct device_attribute *const fw_host_attrs[] = {
504 &dev_attr_host_node_count,
505 &dev_attr_host_selfid_count,
506 &dev_attr_host_nodes_active,
507 &dev_attr_host_in_bus_reset,
508 &dev_attr_host_is_root,
509 &dev_attr_host_is_cycmst,
510 &dev_attr_host_is_irm,
511 &dev_attr_host_is_busmgr,
515 static ssize_t fw_show_drv_device_ids(struct device_driver *drv, char *buf)
517 struct hpsb_protocol_driver *driver;
518 struct ieee1394_device_id *id;
519 int length = 0;
520 char *scratch = buf;
522 driver = container_of(drv, struct hpsb_protocol_driver, driver);
524 for (id = driver->id_table; id->match_flags != 0; id++) {
525 int need_coma = 0;
527 if (id->match_flags & IEEE1394_MATCH_VENDOR_ID) {
528 length += sprintf(scratch, "vendor_id=0x%06x", id->vendor_id);
529 scratch = buf + length;
530 need_coma++;
533 if (id->match_flags & IEEE1394_MATCH_MODEL_ID) {
534 length += sprintf(scratch, "%smodel_id=0x%06x",
535 need_coma++ ? "," : "",
536 id->model_id);
537 scratch = buf + length;
540 if (id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) {
541 length += sprintf(scratch, "%sspecifier_id=0x%06x",
542 need_coma++ ? "," : "",
543 id->specifier_id);
544 scratch = buf + length;
547 if (id->match_flags & IEEE1394_MATCH_VERSION) {
548 length += sprintf(scratch, "%sversion=0x%06x",
549 need_coma++ ? "," : "",
550 id->version);
551 scratch = buf + length;
554 if (need_coma) {
555 *scratch++ = '\n';
556 length++;
560 return length;
562 static DRIVER_ATTR(device_ids,S_IRUGO,fw_show_drv_device_ids,NULL);
565 fw_drv_attr(name, const char *, "%s\n")
567 static struct driver_attribute *const fw_drv_attrs[] = {
568 &driver_attr_drv_name,
569 &driver_attr_device_ids,
573 static void nodemgr_create_drv_files(struct hpsb_protocol_driver *driver)
575 struct device_driver *drv = &driver->driver;
576 int i;
578 for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
579 if (driver_create_file(drv, fw_drv_attrs[i]))
580 goto fail;
581 return;
582 fail:
583 HPSB_ERR("Failed to add sysfs attribute");
587 static void nodemgr_remove_drv_files(struct hpsb_protocol_driver *driver)
589 struct device_driver *drv = &driver->driver;
590 int i;
592 for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
593 driver_remove_file(drv, fw_drv_attrs[i]);
597 static void nodemgr_create_ne_dev_files(struct node_entry *ne)
599 struct device *dev = &ne->device;
600 int i;
602 for (i = 0; i < ARRAY_SIZE(fw_ne_attrs); i++)
603 if (device_create_file(dev, fw_ne_attrs[i]))
604 goto fail;
605 return;
606 fail:
607 HPSB_ERR("Failed to add sysfs attribute");
611 static void nodemgr_create_host_dev_files(struct hpsb_host *host)
613 struct device *dev = &host->device;
614 int i;
616 for (i = 0; i < ARRAY_SIZE(fw_host_attrs); i++)
617 if (device_create_file(dev, fw_host_attrs[i]))
618 goto fail;
619 return;
620 fail:
621 HPSB_ERR("Failed to add sysfs attribute");
625 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host,
626 nodeid_t nodeid);
628 static void nodemgr_update_host_dev_links(struct hpsb_host *host)
630 struct device *dev = &host->device;
631 struct node_entry *ne;
633 sysfs_remove_link(&dev->kobj, "irm_id");
634 sysfs_remove_link(&dev->kobj, "busmgr_id");
635 sysfs_remove_link(&dev->kobj, "host_id");
637 if ((ne = find_entry_by_nodeid(host, host->irm_id)) &&
638 sysfs_create_link(&dev->kobj, &ne->device.kobj, "irm_id"))
639 goto fail;
640 if ((ne = find_entry_by_nodeid(host, host->busmgr_id)) &&
641 sysfs_create_link(&dev->kobj, &ne->device.kobj, "busmgr_id"))
642 goto fail;
643 if ((ne = find_entry_by_nodeid(host, host->node_id)) &&
644 sysfs_create_link(&dev->kobj, &ne->device.kobj, "host_id"))
645 goto fail;
646 return;
647 fail:
648 HPSB_ERR("Failed to update sysfs attributes for host %d", host->id);
651 static void nodemgr_create_ud_dev_files(struct unit_directory *ud)
653 struct device *dev = &ud->device;
654 int i;
656 for (i = 0; i < ARRAY_SIZE(fw_ud_attrs); i++)
657 if (device_create_file(dev, fw_ud_attrs[i]))
658 goto fail;
659 if (ud->flags & UNIT_DIRECTORY_SPECIFIER_ID)
660 if (device_create_file(dev, &dev_attr_ud_specifier_id))
661 goto fail;
662 if (ud->flags & UNIT_DIRECTORY_VERSION)
663 if (device_create_file(dev, &dev_attr_ud_version))
664 goto fail;
665 if (ud->flags & UNIT_DIRECTORY_VENDOR_ID) {
666 if (device_create_file(dev, &dev_attr_ud_vendor_id))
667 goto fail;
668 if (ud->vendor_name_kv &&
669 device_create_file(dev, &dev_attr_ud_vendor_name_kv))
670 goto fail;
672 if (ud->flags & UNIT_DIRECTORY_MODEL_ID) {
673 if (device_create_file(dev, &dev_attr_ud_model_id))
674 goto fail;
675 if (ud->model_name_kv &&
676 device_create_file(dev, &dev_attr_ud_model_name_kv))
677 goto fail;
679 return;
680 fail:
681 HPSB_ERR("Failed to add sysfs attribute");
685 static int nodemgr_bus_match(struct device * dev, struct device_driver * drv)
687 struct hpsb_protocol_driver *driver;
688 struct unit_directory *ud;
689 struct ieee1394_device_id *id;
691 /* We only match unit directories */
692 if (dev->platform_data != &nodemgr_ud_platform_data)
693 return 0;
695 ud = container_of(dev, struct unit_directory, device);
696 if (ud->ne->in_limbo || ud->ignore_driver)
697 return 0;
699 /* We only match drivers of type hpsb_protocol_driver */
700 if (drv == &nodemgr_mid_layer_driver)
701 return 0;
703 driver = container_of(drv, struct hpsb_protocol_driver, driver);
704 for (id = driver->id_table; id->match_flags != 0; id++) {
705 if ((id->match_flags & IEEE1394_MATCH_VENDOR_ID) &&
706 id->vendor_id != ud->vendor_id)
707 continue;
709 if ((id->match_flags & IEEE1394_MATCH_MODEL_ID) &&
710 id->model_id != ud->model_id)
711 continue;
713 if ((id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) &&
714 id->specifier_id != ud->specifier_id)
715 continue;
717 if ((id->match_flags & IEEE1394_MATCH_VERSION) &&
718 id->version != ud->version)
719 continue;
721 return 1;
724 return 0;
728 static DEFINE_MUTEX(nodemgr_serialize_remove_uds);
730 static void nodemgr_remove_uds(struct node_entry *ne)
732 struct device *dev;
733 struct unit_directory *tmp, *ud;
735 /* Iteration over nodemgr_ud_class.devices has to be protected by
736 * nodemgr_ud_class.sem, but device_unregister() will eventually
737 * take nodemgr_ud_class.sem too. Therefore pick out one ud at a time,
738 * release the semaphore, and then unregister the ud. Since this code
739 * may be called from other contexts besides the knodemgrds, protect the
740 * gap after release of the semaphore by nodemgr_serialize_remove_uds.
742 mutex_lock(&nodemgr_serialize_remove_uds);
743 for (;;) {
744 ud = NULL;
745 down(&nodemgr_ud_class.sem);
746 list_for_each_entry(dev, &nodemgr_ud_class.devices, node) {
747 tmp = container_of(dev, struct unit_directory,
748 unit_dev);
749 if (tmp->ne == ne) {
750 ud = tmp;
751 break;
754 up(&nodemgr_ud_class.sem);
755 if (ud == NULL)
756 break;
757 device_unregister(&ud->unit_dev);
758 device_unregister(&ud->device);
760 mutex_unlock(&nodemgr_serialize_remove_uds);
764 static void nodemgr_remove_ne(struct node_entry *ne)
766 struct device *dev;
768 dev = get_device(&ne->device);
769 if (!dev)
770 return;
772 HPSB_DEBUG("Node removed: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
773 NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
774 nodemgr_remove_uds(ne);
776 device_unregister(&ne->node_dev);
777 device_unregister(dev);
779 put_device(dev);
782 static int __nodemgr_remove_host_dev(struct device *dev, void *data)
784 if (dev->bus == &ieee1394_bus_type)
785 nodemgr_remove_ne(container_of(dev, struct node_entry,
786 device));
787 return 0;
790 static void nodemgr_remove_host_dev(struct device *dev)
792 WARN_ON(device_for_each_child(dev, NULL, __nodemgr_remove_host_dev));
793 sysfs_remove_link(&dev->kobj, "irm_id");
794 sysfs_remove_link(&dev->kobj, "busmgr_id");
795 sysfs_remove_link(&dev->kobj, "host_id");
799 static void nodemgr_update_bus_options(struct node_entry *ne)
801 #ifdef CONFIG_IEEE1394_VERBOSEDEBUG
802 static const u16 mr[] = { 4, 64, 1024, 0};
803 #endif
804 quadlet_t busoptions = be32_to_cpu(ne->csr->bus_info_data[2]);
806 ne->busopt.irmc = (busoptions >> 31) & 1;
807 ne->busopt.cmc = (busoptions >> 30) & 1;
808 ne->busopt.isc = (busoptions >> 29) & 1;
809 ne->busopt.bmc = (busoptions >> 28) & 1;
810 ne->busopt.pmc = (busoptions >> 27) & 1;
811 ne->busopt.cyc_clk_acc = (busoptions >> 16) & 0xff;
812 ne->busopt.max_rec = 1 << (((busoptions >> 12) & 0xf) + 1);
813 ne->busopt.max_rom = (busoptions >> 8) & 0x3;
814 ne->busopt.generation = (busoptions >> 4) & 0xf;
815 ne->busopt.lnkspd = busoptions & 0x7;
817 HPSB_VERBOSE("NodeMgr: raw=0x%08x irmc=%d cmc=%d isc=%d bmc=%d pmc=%d "
818 "cyc_clk_acc=%d max_rec=%d max_rom=%d gen=%d lspd=%d",
819 busoptions, ne->busopt.irmc, ne->busopt.cmc,
820 ne->busopt.isc, ne->busopt.bmc, ne->busopt.pmc,
821 ne->busopt.cyc_clk_acc, ne->busopt.max_rec,
822 mr[ne->busopt.max_rom],
823 ne->busopt.generation, ne->busopt.lnkspd);
827 static struct node_entry *nodemgr_create_node(octlet_t guid, struct csr1212_csr *csr,
828 struct host_info *hi, nodeid_t nodeid,
829 unsigned int generation)
831 struct hpsb_host *host = hi->host;
832 struct node_entry *ne;
834 ne = kzalloc(sizeof(*ne), GFP_KERNEL);
835 if (!ne)
836 goto fail_alloc;
838 ne->host = host;
839 ne->nodeid = nodeid;
840 ne->generation = generation;
841 ne->needs_probe = 1;
843 ne->guid = guid;
844 ne->guid_vendor_id = (guid >> 40) & 0xffffff;
845 ne->csr = csr;
847 memcpy(&ne->device, &nodemgr_dev_template_ne,
848 sizeof(ne->device));
849 ne->device.parent = &host->device;
850 snprintf(ne->device.bus_id, BUS_ID_SIZE, "%016Lx",
851 (unsigned long long)(ne->guid));
853 ne->node_dev.parent = &ne->device;
854 ne->node_dev.class = &nodemgr_ne_class;
855 snprintf(ne->node_dev.bus_id, BUS_ID_SIZE, "%016Lx",
856 (unsigned long long)(ne->guid));
858 if (device_register(&ne->device))
859 goto fail_devreg;
860 if (device_register(&ne->node_dev))
861 goto fail_classdevreg;
862 get_device(&ne->device);
864 nodemgr_create_ne_dev_files(ne);
866 nodemgr_update_bus_options(ne);
868 HPSB_DEBUG("%s added: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
869 (host->node_id == nodeid) ? "Host" : "Node",
870 NODE_BUS_ARGS(host, nodeid), (unsigned long long)guid);
872 return ne;
874 fail_classdevreg:
875 device_unregister(&ne->device);
876 fail_devreg:
877 kfree(ne);
878 fail_alloc:
879 HPSB_ERR("Failed to create node ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
880 NODE_BUS_ARGS(host, nodeid), (unsigned long long)guid);
882 return NULL;
886 static struct node_entry *find_entry_by_guid(u64 guid)
888 struct device *dev;
889 struct node_entry *ne, *ret_ne = NULL;
891 down(&nodemgr_ne_class.sem);
892 list_for_each_entry(dev, &nodemgr_ne_class.devices, node) {
893 ne = container_of(dev, struct node_entry, node_dev);
895 if (ne->guid == guid) {
896 ret_ne = ne;
897 break;
900 up(&nodemgr_ne_class.sem);
902 return ret_ne;
906 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host,
907 nodeid_t nodeid)
909 struct device *dev;
910 struct node_entry *ne, *ret_ne = NULL;
912 down(&nodemgr_ne_class.sem);
913 list_for_each_entry(dev, &nodemgr_ne_class.devices, node) {
914 ne = container_of(dev, struct node_entry, node_dev);
916 if (ne->host == host && ne->nodeid == nodeid) {
917 ret_ne = ne;
918 break;
921 up(&nodemgr_ne_class.sem);
923 return ret_ne;
927 static void nodemgr_register_device(struct node_entry *ne,
928 struct unit_directory *ud, struct device *parent)
930 memcpy(&ud->device, &nodemgr_dev_template_ud,
931 sizeof(ud->device));
933 ud->device.parent = parent;
935 snprintf(ud->device.bus_id, BUS_ID_SIZE, "%s-%u",
936 ne->device.bus_id, ud->id);
938 ud->unit_dev.parent = &ud->device;
939 ud->unit_dev.class = &nodemgr_ud_class;
940 snprintf(ud->unit_dev.bus_id, BUS_ID_SIZE, "%s-%u",
941 ne->device.bus_id, ud->id);
943 if (device_register(&ud->device))
944 goto fail_devreg;
945 if (device_register(&ud->unit_dev))
946 goto fail_classdevreg;
947 get_device(&ud->device);
949 nodemgr_create_ud_dev_files(ud);
951 return;
953 fail_classdevreg:
954 device_unregister(&ud->device);
955 fail_devreg:
956 HPSB_ERR("Failed to create unit %s", ud->device.bus_id);
960 /* This implementation currently only scans the config rom and its
961 * immediate unit directories looking for software_id and
962 * software_version entries, in order to get driver autoloading working. */
963 static struct unit_directory *nodemgr_process_unit_directory
964 (struct host_info *hi, struct node_entry *ne, struct csr1212_keyval *ud_kv,
965 unsigned int *id, struct unit_directory *parent)
967 struct unit_directory *ud;
968 struct unit_directory *ud_child = NULL;
969 struct csr1212_dentry *dentry;
970 struct csr1212_keyval *kv;
971 u8 last_key_id = 0;
973 ud = kzalloc(sizeof(*ud), GFP_KERNEL);
974 if (!ud)
975 goto unit_directory_error;
977 ud->ne = ne;
978 ud->ignore_driver = ignore_drivers;
979 ud->address = ud_kv->offset + CSR1212_REGISTER_SPACE_BASE;
980 ud->directory_id = ud->address & 0xffffff;
981 ud->ud_kv = ud_kv;
982 ud->id = (*id)++;
984 csr1212_for_each_dir_entry(ne->csr, kv, ud_kv, dentry) {
985 switch (kv->key.id) {
986 case CSR1212_KV_ID_VENDOR:
987 if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
988 ud->vendor_id = kv->value.immediate;
989 ud->flags |= UNIT_DIRECTORY_VENDOR_ID;
991 break;
993 case CSR1212_KV_ID_MODEL:
994 ud->model_id = kv->value.immediate;
995 ud->flags |= UNIT_DIRECTORY_MODEL_ID;
996 break;
998 case CSR1212_KV_ID_SPECIFIER_ID:
999 ud->specifier_id = kv->value.immediate;
1000 ud->flags |= UNIT_DIRECTORY_SPECIFIER_ID;
1001 break;
1003 case CSR1212_KV_ID_VERSION:
1004 ud->version = kv->value.immediate;
1005 ud->flags |= UNIT_DIRECTORY_VERSION;
1006 break;
1008 case CSR1212_KV_ID_DESCRIPTOR:
1009 if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
1010 CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
1011 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
1012 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
1013 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
1014 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
1015 switch (last_key_id) {
1016 case CSR1212_KV_ID_VENDOR:
1017 csr1212_keep_keyval(kv);
1018 ud->vendor_name_kv = kv;
1019 break;
1021 case CSR1212_KV_ID_MODEL:
1022 csr1212_keep_keyval(kv);
1023 ud->model_name_kv = kv;
1024 break;
1027 } /* else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) ... */
1028 break;
1030 case CSR1212_KV_ID_DEPENDENT_INFO:
1031 /* Logical Unit Number */
1032 if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1033 if (ud->flags & UNIT_DIRECTORY_HAS_LUN) {
1034 ud_child = kmemdup(ud, sizeof(*ud_child), GFP_KERNEL);
1035 if (!ud_child)
1036 goto unit_directory_error;
1037 nodemgr_register_device(ne, ud_child, &ne->device);
1038 ud_child = NULL;
1040 ud->id = (*id)++;
1042 ud->lun = kv->value.immediate;
1043 ud->flags |= UNIT_DIRECTORY_HAS_LUN;
1045 /* Logical Unit Directory */
1046 } else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) {
1047 /* This should really be done in SBP2 as this is
1048 * doing SBP2 specific parsing.
1051 /* first register the parent unit */
1052 ud->flags |= UNIT_DIRECTORY_HAS_LUN_DIRECTORY;
1053 if (ud->device.bus != &ieee1394_bus_type)
1054 nodemgr_register_device(ne, ud, &ne->device);
1056 /* process the child unit */
1057 ud_child = nodemgr_process_unit_directory(hi, ne, kv, id, ud);
1059 if (ud_child == NULL)
1060 break;
1062 /* inherit unspecified values, the driver core picks it up */
1063 if ((ud->flags & UNIT_DIRECTORY_MODEL_ID) &&
1064 !(ud_child->flags & UNIT_DIRECTORY_MODEL_ID))
1066 ud_child->flags |= UNIT_DIRECTORY_MODEL_ID;
1067 ud_child->model_id = ud->model_id;
1069 if ((ud->flags & UNIT_DIRECTORY_SPECIFIER_ID) &&
1070 !(ud_child->flags & UNIT_DIRECTORY_SPECIFIER_ID))
1072 ud_child->flags |= UNIT_DIRECTORY_SPECIFIER_ID;
1073 ud_child->specifier_id = ud->specifier_id;
1075 if ((ud->flags & UNIT_DIRECTORY_VERSION) &&
1076 !(ud_child->flags & UNIT_DIRECTORY_VERSION))
1078 ud_child->flags |= UNIT_DIRECTORY_VERSION;
1079 ud_child->version = ud->version;
1082 /* register the child unit */
1083 ud_child->flags |= UNIT_DIRECTORY_LUN_DIRECTORY;
1084 nodemgr_register_device(ne, ud_child, &ud->device);
1087 break;
1089 case CSR1212_KV_ID_DIRECTORY_ID:
1090 ud->directory_id = kv->value.immediate;
1091 break;
1093 default:
1094 break;
1096 last_key_id = kv->key.id;
1099 /* do not process child units here and only if not already registered */
1100 if (!parent && ud->device.bus != &ieee1394_bus_type)
1101 nodemgr_register_device(ne, ud, &ne->device);
1103 return ud;
1105 unit_directory_error:
1106 kfree(ud);
1107 return NULL;
1111 static void nodemgr_process_root_directory(struct host_info *hi, struct node_entry *ne)
1113 unsigned int ud_id = 0;
1114 struct csr1212_dentry *dentry;
1115 struct csr1212_keyval *kv, *vendor_name_kv = NULL;
1116 u8 last_key_id = 0;
1118 ne->needs_probe = 0;
1120 csr1212_for_each_dir_entry(ne->csr, kv, ne->csr->root_kv, dentry) {
1121 switch (kv->key.id) {
1122 case CSR1212_KV_ID_VENDOR:
1123 ne->vendor_id = kv->value.immediate;
1124 break;
1126 case CSR1212_KV_ID_NODE_CAPABILITIES:
1127 ne->capabilities = kv->value.immediate;
1128 break;
1130 case CSR1212_KV_ID_UNIT:
1131 nodemgr_process_unit_directory(hi, ne, kv, &ud_id, NULL);
1132 break;
1134 case CSR1212_KV_ID_DESCRIPTOR:
1135 if (last_key_id == CSR1212_KV_ID_VENDOR) {
1136 if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
1137 CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
1138 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
1139 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
1140 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
1141 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
1142 csr1212_keep_keyval(kv);
1143 vendor_name_kv = kv;
1146 break;
1148 last_key_id = kv->key.id;
1151 if (ne->vendor_name_kv) {
1152 kv = ne->vendor_name_kv;
1153 ne->vendor_name_kv = vendor_name_kv;
1154 csr1212_release_keyval(kv);
1155 } else if (vendor_name_kv) {
1156 ne->vendor_name_kv = vendor_name_kv;
1157 if (device_create_file(&ne->device,
1158 &dev_attr_ne_vendor_name_kv) != 0)
1159 HPSB_ERR("Failed to add sysfs attribute");
1163 #ifdef CONFIG_HOTPLUG
1165 static int nodemgr_uevent(struct device *dev, struct kobj_uevent_env *env)
1167 struct unit_directory *ud;
1168 int retval = 0;
1169 /* ieee1394:venNmoNspNverN */
1170 char buf[8 + 1 + 3 + 8 + 2 + 8 + 2 + 8 + 3 + 8 + 1];
1172 if (!dev)
1173 return -ENODEV;
1175 ud = container_of(dev, struct unit_directory, unit_dev);
1177 if (ud->ne->in_limbo || ud->ignore_driver)
1178 return -ENODEV;
1180 #define PUT_ENVP(fmt,val) \
1181 do { \
1182 retval = add_uevent_var(env, fmt, val); \
1183 if (retval) \
1184 return retval; \
1185 } while (0)
1187 PUT_ENVP("VENDOR_ID=%06x", ud->vendor_id);
1188 PUT_ENVP("MODEL_ID=%06x", ud->model_id);
1189 PUT_ENVP("GUID=%016Lx", (unsigned long long)ud->ne->guid);
1190 PUT_ENVP("SPECIFIER_ID=%06x", ud->specifier_id);
1191 PUT_ENVP("VERSION=%06x", ud->version);
1192 snprintf(buf, sizeof(buf), "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
1193 ud->vendor_id,
1194 ud->model_id,
1195 ud->specifier_id,
1196 ud->version);
1197 PUT_ENVP("MODALIAS=%s", buf);
1199 #undef PUT_ENVP
1201 return 0;
1204 #else
1206 static int nodemgr_uevent(struct device *dev, struct kobj_uevent_env *env)
1208 return -ENODEV;
1211 #endif /* CONFIG_HOTPLUG */
1214 int __hpsb_register_protocol(struct hpsb_protocol_driver *drv,
1215 struct module *owner)
1217 int error;
1219 drv->driver.bus = &ieee1394_bus_type;
1220 drv->driver.owner = owner;
1221 drv->driver.name = drv->name;
1223 /* This will cause a probe for devices */
1224 error = driver_register(&drv->driver);
1225 if (!error)
1226 nodemgr_create_drv_files(drv);
1227 return error;
1230 void hpsb_unregister_protocol(struct hpsb_protocol_driver *driver)
1232 nodemgr_remove_drv_files(driver);
1233 /* This will subsequently disconnect all devices that our driver
1234 * is attached to. */
1235 driver_unregister(&driver->driver);
1240 * This function updates nodes that were present on the bus before the
1241 * reset and still are after the reset. The nodeid and the config rom
1242 * may have changed, and the drivers managing this device must be
1243 * informed that this device just went through a bus reset, to allow
1244 * the to take whatever actions required.
1246 static void nodemgr_update_node(struct node_entry *ne, struct csr1212_csr *csr,
1247 struct host_info *hi, nodeid_t nodeid,
1248 unsigned int generation)
1250 if (ne->nodeid != nodeid) {
1251 HPSB_DEBUG("Node changed: " NODE_BUS_FMT " -> " NODE_BUS_FMT,
1252 NODE_BUS_ARGS(ne->host, ne->nodeid),
1253 NODE_BUS_ARGS(ne->host, nodeid));
1254 ne->nodeid = nodeid;
1257 if (ne->busopt.generation != ((be32_to_cpu(csr->bus_info_data[2]) >> 4) & 0xf)) {
1258 kfree(ne->csr->private);
1259 csr1212_destroy_csr(ne->csr);
1260 ne->csr = csr;
1262 /* If the node's configrom generation has changed, we
1263 * unregister all the unit directories. */
1264 nodemgr_remove_uds(ne);
1266 nodemgr_update_bus_options(ne);
1268 /* Mark the node as new, so it gets re-probed */
1269 ne->needs_probe = 1;
1270 } else {
1271 /* old cache is valid, so update its generation */
1272 struct nodemgr_csr_info *ci = ne->csr->private;
1273 ci->generation = generation;
1274 /* free the partially filled now unneeded new cache */
1275 kfree(csr->private);
1276 csr1212_destroy_csr(csr);
1279 if (ne->in_limbo)
1280 nodemgr_resume_ne(ne);
1282 /* Mark the node current */
1283 ne->generation = generation;
1288 static void nodemgr_node_scan_one(struct host_info *hi,
1289 nodeid_t nodeid, int generation)
1291 struct hpsb_host *host = hi->host;
1292 struct node_entry *ne;
1293 octlet_t guid;
1294 struct csr1212_csr *csr;
1295 struct nodemgr_csr_info *ci;
1296 u8 *speed;
1298 ci = kmalloc(sizeof(*ci), GFP_KERNEL);
1299 if (!ci)
1300 return;
1302 ci->host = host;
1303 ci->nodeid = nodeid;
1304 ci->generation = generation;
1306 /* Prepare for speed probe which occurs when reading the ROM */
1307 speed = &(host->speed[NODEID_TO_NODE(nodeid)]);
1308 if (*speed > host->csr.lnk_spd)
1309 *speed = host->csr.lnk_spd;
1310 ci->speed_unverified = *speed > IEEE1394_SPEED_100;
1312 /* We need to detect when the ConfigROM's generation has changed,
1313 * so we only update the node's info when it needs to be. */
1315 csr = csr1212_create_csr(&nodemgr_csr_ops, 5 * sizeof(quadlet_t), ci);
1316 if (!csr || csr1212_parse_csr(csr) != CSR1212_SUCCESS) {
1317 HPSB_ERR("Error parsing configrom for node " NODE_BUS_FMT,
1318 NODE_BUS_ARGS(host, nodeid));
1319 if (csr)
1320 csr1212_destroy_csr(csr);
1321 kfree(ci);
1322 return;
1325 if (csr->bus_info_data[1] != IEEE1394_BUSID_MAGIC) {
1326 /* This isn't a 1394 device, but we let it slide. There
1327 * was a report of a device with broken firmware which
1328 * reported '2394' instead of '1394', which is obviously a
1329 * mistake. One would hope that a non-1394 device never
1330 * gets connected to Firewire bus. If someone does, we
1331 * shouldn't be held responsible, so we'll allow it with a
1332 * warning. */
1333 HPSB_WARN("Node " NODE_BUS_FMT " has invalid busID magic [0x%08x]",
1334 NODE_BUS_ARGS(host, nodeid), csr->bus_info_data[1]);
1337 guid = ((u64)be32_to_cpu(csr->bus_info_data[3]) << 32) | be32_to_cpu(csr->bus_info_data[4]);
1338 ne = find_entry_by_guid(guid);
1340 if (ne && ne->host != host && ne->in_limbo) {
1341 /* Must have moved this device from one host to another */
1342 nodemgr_remove_ne(ne);
1343 ne = NULL;
1346 if (!ne)
1347 nodemgr_create_node(guid, csr, hi, nodeid, generation);
1348 else
1349 nodemgr_update_node(ne, csr, hi, nodeid, generation);
1353 static void nodemgr_node_scan(struct host_info *hi, int generation)
1355 int count;
1356 struct hpsb_host *host = hi->host;
1357 struct selfid *sid = (struct selfid *)host->topology_map;
1358 nodeid_t nodeid = LOCAL_BUS;
1360 /* Scan each node on the bus */
1361 for (count = host->selfid_count; count; count--, sid++) {
1362 if (sid->extended)
1363 continue;
1365 if (!sid->link_active) {
1366 nodeid++;
1367 continue;
1369 nodemgr_node_scan_one(hi, nodeid++, generation);
1374 static void nodemgr_suspend_ne(struct node_entry *ne)
1376 struct device *dev;
1377 struct unit_directory *ud;
1378 struct device_driver *drv;
1379 int error;
1381 HPSB_DEBUG("Node suspended: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
1382 NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
1384 ne->in_limbo = 1;
1385 WARN_ON(device_create_file(&ne->device, &dev_attr_ne_in_limbo));
1387 down(&nodemgr_ud_class.sem);
1388 list_for_each_entry(dev, &nodemgr_ud_class.devices, node) {
1389 ud = container_of(dev, struct unit_directory, unit_dev);
1390 if (ud->ne != ne)
1391 continue;
1393 drv = get_driver(ud->device.driver);
1394 if (!drv)
1395 continue;
1397 error = 1; /* release if suspend is not implemented */
1398 if (drv->suspend) {
1399 down(&ud->device.sem);
1400 error = drv->suspend(&ud->device, PMSG_SUSPEND);
1401 up(&ud->device.sem);
1403 if (error)
1404 device_release_driver(&ud->device);
1405 put_driver(drv);
1407 up(&nodemgr_ud_class.sem);
1411 static void nodemgr_resume_ne(struct node_entry *ne)
1413 struct device *dev;
1414 struct unit_directory *ud;
1415 struct device_driver *drv;
1417 ne->in_limbo = 0;
1418 device_remove_file(&ne->device, &dev_attr_ne_in_limbo);
1420 down(&nodemgr_ud_class.sem);
1421 list_for_each_entry(dev, &nodemgr_ud_class.devices, node) {
1422 ud = container_of(dev, struct unit_directory, unit_dev);
1423 if (ud->ne != ne)
1424 continue;
1426 drv = get_driver(ud->device.driver);
1427 if (!drv)
1428 continue;
1430 if (drv->resume) {
1431 down(&ud->device.sem);
1432 drv->resume(&ud->device);
1433 up(&ud->device.sem);
1435 put_driver(drv);
1437 up(&nodemgr_ud_class.sem);
1439 HPSB_DEBUG("Node resumed: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
1440 NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
1444 static void nodemgr_update_pdrv(struct node_entry *ne)
1446 struct device *dev;
1447 struct unit_directory *ud;
1448 struct device_driver *drv;
1449 struct hpsb_protocol_driver *pdrv;
1450 int error;
1452 down(&nodemgr_ud_class.sem);
1453 list_for_each_entry(dev, &nodemgr_ud_class.devices, node) {
1454 ud = container_of(dev, struct unit_directory, unit_dev);
1455 if (ud->ne != ne)
1456 continue;
1458 drv = get_driver(ud->device.driver);
1459 if (!drv)
1460 continue;
1462 error = 0;
1463 pdrv = container_of(drv, struct hpsb_protocol_driver, driver);
1464 if (pdrv->update) {
1465 down(&ud->device.sem);
1466 error = pdrv->update(ud);
1467 up(&ud->device.sem);
1469 if (error)
1470 device_release_driver(&ud->device);
1471 put_driver(drv);
1473 up(&nodemgr_ud_class.sem);
1477 /* Write the BROADCAST_CHANNEL as per IEEE1394a 8.3.2.3.11 and 8.4.2.3. This
1478 * seems like an optional service but in the end it is practically mandatory
1479 * as a consequence of these clauses.
1481 * Note that we cannot do a broadcast write to all nodes at once because some
1482 * pre-1394a devices would hang. */
1483 static void nodemgr_irm_write_bc(struct node_entry *ne, int generation)
1485 const u64 bc_addr = (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL);
1486 quadlet_t bc_remote, bc_local;
1487 int error;
1489 if (!ne->host->is_irm || ne->generation != generation ||
1490 ne->nodeid == ne->host->node_id)
1491 return;
1493 bc_local = cpu_to_be32(ne->host->csr.broadcast_channel);
1495 /* Check if the register is implemented and 1394a compliant. */
1496 error = hpsb_read(ne->host, ne->nodeid, generation, bc_addr, &bc_remote,
1497 sizeof(bc_remote));
1498 if (!error && bc_remote & cpu_to_be32(0x80000000) &&
1499 bc_remote != bc_local)
1500 hpsb_node_write(ne, bc_addr, &bc_local, sizeof(bc_local));
1504 static void nodemgr_probe_ne(struct host_info *hi, struct node_entry *ne, int generation)
1506 struct device *dev;
1508 if (ne->host != hi->host || ne->in_limbo)
1509 return;
1511 dev = get_device(&ne->device);
1512 if (!dev)
1513 return;
1515 nodemgr_irm_write_bc(ne, generation);
1517 /* If "needs_probe", then this is either a new or changed node we
1518 * rescan totally. If the generation matches for an existing node
1519 * (one that existed prior to the bus reset) we send update calls
1520 * down to the drivers. Otherwise, this is a dead node and we
1521 * suspend it. */
1522 if (ne->needs_probe)
1523 nodemgr_process_root_directory(hi, ne);
1524 else if (ne->generation == generation)
1525 nodemgr_update_pdrv(ne);
1526 else
1527 nodemgr_suspend_ne(ne);
1529 put_device(dev);
1533 static void nodemgr_node_probe(struct host_info *hi, int generation)
1535 struct hpsb_host *host = hi->host;
1536 struct device *dev;
1537 struct node_entry *ne;
1539 /* Do some processing of the nodes we've probed. This pulls them
1540 * into the sysfs layer if needed, and can result in processing of
1541 * unit-directories, or just updating the node and it's
1542 * unit-directories.
1544 * Run updates before probes. Usually, updates are time-critical
1545 * while probes are time-consuming. (Well, those probes need some
1546 * improvement...) */
1548 down(&nodemgr_ne_class.sem);
1549 list_for_each_entry(dev, &nodemgr_ne_class.devices, node) {
1550 ne = container_of(dev, struct node_entry, node_dev);
1551 if (!ne->needs_probe)
1552 nodemgr_probe_ne(hi, ne, generation);
1554 list_for_each_entry(dev, &nodemgr_ne_class.devices, node) {
1555 ne = container_of(dev, struct node_entry, node_dev);
1556 if (ne->needs_probe)
1557 nodemgr_probe_ne(hi, ne, generation);
1559 up(&nodemgr_ne_class.sem);
1562 /* If we had a bus reset while we were scanning the bus, it is
1563 * possible that we did not probe all nodes. In that case, we
1564 * skip the clean up for now, since we could remove nodes that
1565 * were still on the bus. Another bus scan is pending which will
1566 * do the clean up eventually.
1568 * Now let's tell the bus to rescan our devices. This may seem
1569 * like overhead, but the driver-model core will only scan a
1570 * device for a driver when either the device is added, or when a
1571 * new driver is added. A bus reset is a good reason to rescan
1572 * devices that were there before. For example, an sbp2 device
1573 * may become available for login, if the host that held it was
1574 * just removed. */
1576 if (generation == get_hpsb_generation(host))
1577 if (bus_rescan_devices(&ieee1394_bus_type))
1578 HPSB_DEBUG("bus_rescan_devices had an error");
1581 static int nodemgr_send_resume_packet(struct hpsb_host *host)
1583 struct hpsb_packet *packet;
1584 int error = -ENOMEM;
1586 packet = hpsb_make_phypacket(host,
1587 EXTPHYPACKET_TYPE_RESUME |
1588 NODEID_TO_NODE(host->node_id) << PHYPACKET_PORT_SHIFT);
1589 if (packet) {
1590 packet->no_waiter = 1;
1591 packet->generation = get_hpsb_generation(host);
1592 error = hpsb_send_packet(packet);
1594 if (error)
1595 HPSB_WARN("fw-host%d: Failed to broadcast resume packet",
1596 host->id);
1597 return error;
1600 /* Perform a few high-level IRM responsibilities. */
1601 static int nodemgr_do_irm_duties(struct hpsb_host *host, int cycles)
1603 quadlet_t bc;
1605 /* if irm_id == -1 then there is no IRM on this bus */
1606 if (!host->is_irm || host->irm_id == (nodeid_t)-1)
1607 return 1;
1609 /* We are a 1394a-2000 compliant IRM. Set the validity bit. */
1610 host->csr.broadcast_channel |= 0x40000000;
1612 /* If there is no bus manager then we should set the root node's
1613 * force_root bit to promote bus stability per the 1394
1614 * spec. (8.4.2.6) */
1615 if (host->busmgr_id == 0xffff && host->node_count > 1)
1617 u16 root_node = host->node_count - 1;
1619 /* get cycle master capability flag from root node */
1620 if (host->is_cycmst ||
1621 (!hpsb_read(host, LOCAL_BUS | root_node, get_hpsb_generation(host),
1622 (CSR_REGISTER_BASE + CSR_CONFIG_ROM + 2 * sizeof(quadlet_t)),
1623 &bc, sizeof(quadlet_t)) &&
1624 be32_to_cpu(bc) & 1 << CSR_CMC_SHIFT))
1625 hpsb_send_phy_config(host, root_node, -1);
1626 else {
1627 HPSB_DEBUG("The root node is not cycle master capable; "
1628 "selecting a new root node and resetting...");
1630 if (cycles >= 5) {
1631 /* Oh screw it! Just leave the bus as it is */
1632 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1633 return 1;
1636 hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1637 hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1639 return 0;
1643 /* Some devices suspend their ports while being connected to an inactive
1644 * host adapter, i.e. if connected before the low-level driver is
1645 * loaded. They become visible either when physically unplugged and
1646 * replugged, or when receiving a resume packet. Send one once. */
1647 if (!host->resume_packet_sent && !nodemgr_send_resume_packet(host))
1648 host->resume_packet_sent = 1;
1650 return 1;
1653 /* We need to ensure that if we are not the IRM, that the IRM node is capable of
1654 * everything we can do, otherwise issue a bus reset and try to become the IRM
1655 * ourselves. */
1656 static int nodemgr_check_irm_capability(struct hpsb_host *host, int cycles)
1658 quadlet_t bc;
1659 int status;
1661 if (hpsb_disable_irm || host->is_irm)
1662 return 1;
1664 status = hpsb_read(host, LOCAL_BUS | (host->irm_id),
1665 get_hpsb_generation(host),
1666 (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL),
1667 &bc, sizeof(quadlet_t));
1669 if (status < 0 || !(be32_to_cpu(bc) & 0x80000000)) {
1670 /* The current irm node does not have a valid BROADCAST_CHANNEL
1671 * register and we do, so reset the bus with force_root set */
1672 HPSB_DEBUG("Current remote IRM is not 1394a-2000 compliant, resetting...");
1674 if (cycles >= 5) {
1675 /* Oh screw it! Just leave the bus as it is */
1676 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1677 return 1;
1680 hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1681 hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1683 return 0;
1686 return 1;
1689 static int nodemgr_host_thread(void *__hi)
1691 struct host_info *hi = (struct host_info *)__hi;
1692 struct hpsb_host *host = hi->host;
1693 unsigned int g, generation = 0;
1694 int i, reset_cycles = 0;
1696 set_freezable();
1697 /* Setup our device-model entries */
1698 nodemgr_create_host_dev_files(host);
1700 for (;;) {
1701 /* Sleep until next bus reset */
1702 set_current_state(TASK_INTERRUPTIBLE);
1703 if (get_hpsb_generation(host) == generation &&
1704 !kthread_should_stop())
1705 schedule();
1706 __set_current_state(TASK_RUNNING);
1708 /* Thread may have been woken up to freeze or to exit */
1709 if (try_to_freeze())
1710 continue;
1711 if (kthread_should_stop())
1712 goto exit;
1714 /* Pause for 1/4 second in 1/16 second intervals,
1715 * to make sure things settle down. */
1716 g = get_hpsb_generation(host);
1717 for (i = 0; i < 4 ; i++) {
1718 msleep_interruptible(63);
1719 if (kthread_should_stop())
1720 goto exit;
1722 /* Now get the generation in which the node ID's we collect
1723 * are valid. During the bus scan we will use this generation
1724 * for the read transactions, so that if another reset occurs
1725 * during the scan the transactions will fail instead of
1726 * returning bogus data. */
1727 generation = get_hpsb_generation(host);
1729 /* If we get a reset before we are done waiting, then
1730 * start the waiting over again */
1731 if (generation != g)
1732 g = generation, i = 0;
1735 if (!nodemgr_check_irm_capability(host, reset_cycles) ||
1736 !nodemgr_do_irm_duties(host, reset_cycles)) {
1737 reset_cycles++;
1738 continue;
1740 reset_cycles = 0;
1742 /* Scan our nodes to get the bus options and create node
1743 * entries. This does not do the sysfs stuff, since that
1744 * would trigger uevents and such, which is a bad idea at
1745 * this point. */
1746 nodemgr_node_scan(hi, generation);
1748 /* This actually does the full probe, with sysfs
1749 * registration. */
1750 nodemgr_node_probe(hi, generation);
1752 /* Update some of our sysfs symlinks */
1753 nodemgr_update_host_dev_links(host);
1755 exit:
1756 HPSB_VERBOSE("NodeMgr: Exiting thread");
1757 return 0;
1761 * nodemgr_for_each_host - call a function for each IEEE 1394 host
1762 * @data: an address to supply to the callback
1763 * @cb: function to call for each host
1765 * Iterate the hosts, calling a given function with supplied data for each host.
1766 * If the callback fails on a host, i.e. if it returns a non-zero value, the
1767 * iteration is stopped.
1769 * Return value: 0 on success, non-zero on failure (same as returned by last run
1770 * of the callback).
1772 int nodemgr_for_each_host(void *data, int (*cb)(struct hpsb_host *, void *))
1774 struct device *dev;
1775 struct hpsb_host *host;
1776 int error = 0;
1778 down(&hpsb_host_class.sem);
1779 list_for_each_entry(dev, &hpsb_host_class.devices, node) {
1780 host = container_of(dev, struct hpsb_host, host_dev);
1782 if ((error = cb(host, data)))
1783 break;
1785 up(&hpsb_host_class.sem);
1787 return error;
1790 /* The following two convenience functions use a struct node_entry
1791 * for addressing a node on the bus. They are intended for use by any
1792 * process context, not just the nodemgr thread, so we need to be a
1793 * little careful when reading out the node ID and generation. The
1794 * thing that can go wrong is that we get the node ID, then a bus
1795 * reset occurs, and then we read the generation. The node ID is
1796 * possibly invalid, but the generation is current, and we end up
1797 * sending a packet to a the wrong node.
1799 * The solution is to make sure we read the generation first, so that
1800 * if a reset occurs in the process, we end up with a stale generation
1801 * and the transactions will fail instead of silently using wrong node
1802 * ID's.
1806 * hpsb_node_fill_packet - fill some destination information into a packet
1807 * @ne: destination node
1808 * @packet: packet to fill in
1810 * This will fill in the given, pre-initialised hpsb_packet with the current
1811 * information from the node entry (host, node ID, bus generation number).
1813 void hpsb_node_fill_packet(struct node_entry *ne, struct hpsb_packet *packet)
1815 packet->host = ne->host;
1816 packet->generation = ne->generation;
1817 barrier();
1818 packet->node_id = ne->nodeid;
1821 int hpsb_node_write(struct node_entry *ne, u64 addr,
1822 quadlet_t *buffer, size_t length)
1824 unsigned int generation = ne->generation;
1826 barrier();
1827 return hpsb_write(ne->host, ne->nodeid, generation,
1828 addr, buffer, length);
1831 static void nodemgr_add_host(struct hpsb_host *host)
1833 struct host_info *hi;
1835 hi = hpsb_create_hostinfo(&nodemgr_highlevel, host, sizeof(*hi));
1836 if (!hi) {
1837 HPSB_ERR("NodeMgr: out of memory in add host");
1838 return;
1840 hi->host = host;
1841 hi->thread = kthread_run(nodemgr_host_thread, hi, "knodemgrd_%d",
1842 host->id);
1843 if (IS_ERR(hi->thread)) {
1844 HPSB_ERR("NodeMgr: cannot start thread for host %d", host->id);
1845 hpsb_destroy_hostinfo(&nodemgr_highlevel, host);
1849 static void nodemgr_host_reset(struct hpsb_host *host)
1851 struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1853 if (hi) {
1854 HPSB_VERBOSE("NodeMgr: Processing reset for host %d", host->id);
1855 wake_up_process(hi->thread);
1859 static void nodemgr_remove_host(struct hpsb_host *host)
1861 struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1863 if (hi) {
1864 kthread_stop(hi->thread);
1865 nodemgr_remove_host_dev(&host->device);
1869 static struct hpsb_highlevel nodemgr_highlevel = {
1870 .name = "Node manager",
1871 .add_host = nodemgr_add_host,
1872 .host_reset = nodemgr_host_reset,
1873 .remove_host = nodemgr_remove_host,
1876 int init_ieee1394_nodemgr(void)
1878 int error;
1880 error = class_register(&nodemgr_ne_class);
1881 if (error)
1882 goto fail_ne;
1883 error = class_register(&nodemgr_ud_class);
1884 if (error)
1885 goto fail_ud;
1886 error = driver_register(&nodemgr_mid_layer_driver);
1887 if (error)
1888 goto fail_ml;
1889 /* This driver is not used if nodemgr is off (disable_nodemgr=1). */
1890 nodemgr_dev_template_host.driver = &nodemgr_mid_layer_driver;
1892 hpsb_register_highlevel(&nodemgr_highlevel);
1893 return 0;
1895 fail_ml:
1896 class_unregister(&nodemgr_ud_class);
1897 fail_ud:
1898 class_unregister(&nodemgr_ne_class);
1899 fail_ne:
1900 return error;
1903 void cleanup_ieee1394_nodemgr(void)
1905 hpsb_unregister_highlevel(&nodemgr_highlevel);
1906 driver_unregister(&nodemgr_mid_layer_driver);
1907 class_unregister(&nodemgr_ud_class);
1908 class_unregister(&nodemgr_ne_class);