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.
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 <linux/semaphore.h>
22 #include <asm/atomic.h>
25 #include "highlevel.h"
28 #include "ieee1394_core.h"
29 #include "ieee1394_hotplug.h"
30 #include "ieee1394_types.h"
31 #include "ieee1394_transactions.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;
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,
56 u8 i, *speed, old_speed, good_speed;
59 speed = &(ci->host->speed[NODEID_TO_NODE(ci->nodeid)]);
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++) {
69 error = hpsb_read(ci->host, ci->nodeid, ci->generation, addr,
70 &q, sizeof(quadlet_t));
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]);
81 ci->speed_unverified = 0;
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;
95 error = hpsb_read(ci->host, ci->nodeid, ci->generation, addr,
98 ci->speed_unverified = 0;
101 /* Give up after 3rd failure. */
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);
112 if (msleep_interruptible(334))
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.
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_reactivate_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 = {
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 = {
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);
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);
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);
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,
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)\
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)\
280 class_type *class = container_of(dev, class_type, device); \
281 len = (class->td_kv->value.leaf.len - 2) * sizeof(quadlet_t); \
283 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_DATA(class->td_kv), \
285 while (buf[len - 1] == '\0') \
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",
317 ne->busopt.cmc, ne->busopt.isc, ne->busopt.bmc,
318 ne->busopt.pmc, ne->busopt.generation, ne->busopt.lnkspd,
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);
332 unsigned long *tp = ne->host->tl_pool[NODEID_TO_NODE(ne->nodeid)].map;
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);
349 unsigned long *tp = ne->host->tl_pool[NODEID_TO_NODE(ne->nodeid)].map;
352 spin_lock_irqsave(&hpsb_tlabel_lock, flags);
353 #if (BITS_PER_LONG <= 32)
354 tm = ((u64)tp[0] << 32) + tp[1];
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);
372 ud->ignore_driver = 1;
373 device_release_driver(dev);
374 } else if (state == 0)
375 ud->ignore_driver = 0;
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)
398 nodemgr_remove_ne(ne);
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,
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);
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,
447 &bus_attr_ignore_drivers,
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[] = {
464 &dev_attr_ne_guid_vendor_id,
465 &dev_attr_ne_capabilities,
466 &dev_attr_ne_vendor_id,
468 &dev_attr_bus_options,
469 #ifdef HPSB_DEBUG_TLABELS
470 &dev_attr_tlabels_free,
471 &dev_attr_tlabels_mask,
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,
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;
522 driver = container_of(drv, struct hpsb_protocol_driver, driver);
523 id = driver->id_table;
527 for (; id->match_flags != 0; id++) {
530 if (id->match_flags & IEEE1394_MATCH_VENDOR_ID) {
531 length += sprintf(scratch, "vendor_id=0x%06x", id->vendor_id);
532 scratch = buf + length;
536 if (id->match_flags & IEEE1394_MATCH_MODEL_ID) {
537 length += sprintf(scratch, "%smodel_id=0x%06x",
538 need_coma++ ? "," : "",
540 scratch = buf + length;
543 if (id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) {
544 length += sprintf(scratch, "%sspecifier_id=0x%06x",
545 need_coma++ ? "," : "",
547 scratch = buf + length;
550 if (id->match_flags & IEEE1394_MATCH_VERSION) {
551 length += sprintf(scratch, "%sversion=0x%06x",
552 need_coma++ ? "," : "",
554 scratch = buf + length;
565 static DRIVER_ATTR(device_ids,S_IRUGO,fw_show_drv_device_ids,NULL);
568 fw_drv_attr(name, const char *, "%s\n")
570 static struct driver_attribute *const fw_drv_attrs[] = {
571 &driver_attr_drv_name,
572 &driver_attr_device_ids,
576 static void nodemgr_create_drv_files(struct hpsb_protocol_driver *driver)
578 struct device_driver *drv = &driver->driver;
581 for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
582 if (driver_create_file(drv, fw_drv_attrs[i]))
586 HPSB_ERR("Failed to add sysfs attribute");
590 static void nodemgr_remove_drv_files(struct hpsb_protocol_driver *driver)
592 struct device_driver *drv = &driver->driver;
595 for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
596 driver_remove_file(drv, fw_drv_attrs[i]);
600 static void nodemgr_create_ne_dev_files(struct node_entry *ne)
602 struct device *dev = &ne->device;
605 for (i = 0; i < ARRAY_SIZE(fw_ne_attrs); i++)
606 if (device_create_file(dev, fw_ne_attrs[i]))
610 HPSB_ERR("Failed to add sysfs attribute");
614 static void nodemgr_create_host_dev_files(struct hpsb_host *host)
616 struct device *dev = &host->device;
619 for (i = 0; i < ARRAY_SIZE(fw_host_attrs); i++)
620 if (device_create_file(dev, fw_host_attrs[i]))
624 HPSB_ERR("Failed to add sysfs attribute");
628 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host,
631 static void nodemgr_update_host_dev_links(struct hpsb_host *host)
633 struct device *dev = &host->device;
634 struct node_entry *ne;
636 sysfs_remove_link(&dev->kobj, "irm_id");
637 sysfs_remove_link(&dev->kobj, "busmgr_id");
638 sysfs_remove_link(&dev->kobj, "host_id");
640 if ((ne = find_entry_by_nodeid(host, host->irm_id)) &&
641 sysfs_create_link(&dev->kobj, &ne->device.kobj, "irm_id"))
643 if ((ne = find_entry_by_nodeid(host, host->busmgr_id)) &&
644 sysfs_create_link(&dev->kobj, &ne->device.kobj, "busmgr_id"))
646 if ((ne = find_entry_by_nodeid(host, host->node_id)) &&
647 sysfs_create_link(&dev->kobj, &ne->device.kobj, "host_id"))
651 HPSB_ERR("Failed to update sysfs attributes for host %d", host->id);
654 static void nodemgr_create_ud_dev_files(struct unit_directory *ud)
656 struct device *dev = &ud->device;
659 for (i = 0; i < ARRAY_SIZE(fw_ud_attrs); i++)
660 if (device_create_file(dev, fw_ud_attrs[i]))
662 if (ud->flags & UNIT_DIRECTORY_SPECIFIER_ID)
663 if (device_create_file(dev, &dev_attr_ud_specifier_id))
665 if (ud->flags & UNIT_DIRECTORY_VERSION)
666 if (device_create_file(dev, &dev_attr_ud_version))
668 if (ud->flags & UNIT_DIRECTORY_VENDOR_ID) {
669 if (device_create_file(dev, &dev_attr_ud_vendor_id))
671 if (ud->vendor_name_kv &&
672 device_create_file(dev, &dev_attr_ud_vendor_name_kv))
675 if (ud->flags & UNIT_DIRECTORY_MODEL_ID) {
676 if (device_create_file(dev, &dev_attr_ud_model_id))
678 if (ud->model_name_kv &&
679 device_create_file(dev, &dev_attr_ud_model_name_kv))
684 HPSB_ERR("Failed to add sysfs attribute");
688 static int nodemgr_bus_match(struct device * dev, struct device_driver * drv)
690 struct hpsb_protocol_driver *driver;
691 struct unit_directory *ud;
692 struct ieee1394_device_id *id;
694 /* We only match unit directories */
695 if (dev->platform_data != &nodemgr_ud_platform_data)
698 ud = container_of(dev, struct unit_directory, device);
699 if (ud->ne->in_limbo || ud->ignore_driver)
702 /* We only match drivers of type hpsb_protocol_driver */
703 if (drv == &nodemgr_mid_layer_driver)
706 driver = container_of(drv, struct hpsb_protocol_driver, driver);
707 id = driver->id_table;
711 for (; id->match_flags != 0; id++) {
712 if ((id->match_flags & IEEE1394_MATCH_VENDOR_ID) &&
713 id->vendor_id != ud->vendor_id)
716 if ((id->match_flags & IEEE1394_MATCH_MODEL_ID) &&
717 id->model_id != ud->model_id)
720 if ((id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) &&
721 id->specifier_id != ud->specifier_id)
724 if ((id->match_flags & IEEE1394_MATCH_VERSION) &&
725 id->version != ud->version)
735 static DEFINE_MUTEX(nodemgr_serialize_remove_uds);
737 static int match_ne(struct device *dev, void *data)
739 struct unit_directory *ud;
740 struct node_entry *ne = data;
742 ud = container_of(dev, struct unit_directory, unit_dev);
746 static void nodemgr_remove_uds(struct node_entry *ne)
749 struct unit_directory *ud;
751 /* Use class_find device to iterate the devices. Since this code
752 * may be called from other contexts besides the knodemgrds,
753 * protect it by nodemgr_serialize_remove_uds.
755 mutex_lock(&nodemgr_serialize_remove_uds);
757 dev = class_find_device(&nodemgr_ud_class, NULL, ne, match_ne);
760 ud = container_of(dev, struct unit_directory, unit_dev);
762 device_unregister(&ud->unit_dev);
763 device_unregister(&ud->device);
765 mutex_unlock(&nodemgr_serialize_remove_uds);
769 static void nodemgr_remove_ne(struct node_entry *ne)
773 dev = get_device(&ne->device);
777 HPSB_DEBUG("Node removed: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
778 NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
779 nodemgr_remove_uds(ne);
781 device_unregister(&ne->node_dev);
782 device_unregister(dev);
787 static int remove_host_dev(struct device *dev, void *data)
789 if (dev->bus == &ieee1394_bus_type)
790 nodemgr_remove_ne(container_of(dev, struct node_entry,
795 static void nodemgr_remove_host_dev(struct device *dev)
797 device_for_each_child(dev, NULL, remove_host_dev);
798 sysfs_remove_link(&dev->kobj, "irm_id");
799 sysfs_remove_link(&dev->kobj, "busmgr_id");
800 sysfs_remove_link(&dev->kobj, "host_id");
804 static void nodemgr_update_bus_options(struct node_entry *ne)
806 #ifdef CONFIG_IEEE1394_VERBOSEDEBUG
807 static const u16 mr[] = { 4, 64, 1024, 0};
809 quadlet_t busoptions = be32_to_cpu(ne->csr->bus_info_data[2]);
811 ne->busopt.irmc = (busoptions >> 31) & 1;
812 ne->busopt.cmc = (busoptions >> 30) & 1;
813 ne->busopt.isc = (busoptions >> 29) & 1;
814 ne->busopt.bmc = (busoptions >> 28) & 1;
815 ne->busopt.pmc = (busoptions >> 27) & 1;
816 ne->busopt.cyc_clk_acc = (busoptions >> 16) & 0xff;
817 ne->busopt.max_rec = 1 << (((busoptions >> 12) & 0xf) + 1);
818 ne->busopt.max_rom = (busoptions >> 8) & 0x3;
819 ne->busopt.generation = (busoptions >> 4) & 0xf;
820 ne->busopt.lnkspd = busoptions & 0x7;
822 HPSB_VERBOSE("NodeMgr: raw=0x%08x irmc=%d cmc=%d isc=%d bmc=%d pmc=%d "
823 "cyc_clk_acc=%d max_rec=%d max_rom=%d gen=%d lspd=%d",
824 busoptions, ne->busopt.irmc, ne->busopt.cmc,
825 ne->busopt.isc, ne->busopt.bmc, ne->busopt.pmc,
826 ne->busopt.cyc_clk_acc, ne->busopt.max_rec,
827 mr[ne->busopt.max_rom],
828 ne->busopt.generation, ne->busopt.lnkspd);
832 static struct node_entry *nodemgr_create_node(octlet_t guid,
833 struct csr1212_csr *csr, struct hpsb_host *host,
834 nodeid_t nodeid, unsigned int generation)
836 struct node_entry *ne;
838 ne = kzalloc(sizeof(*ne), GFP_KERNEL);
844 ne->generation = generation;
845 ne->needs_probe = true;
848 ne->guid_vendor_id = (guid >> 40) & 0xffffff;
851 memcpy(&ne->device, &nodemgr_dev_template_ne,
853 ne->device.parent = &host->device;
854 snprintf(ne->device.bus_id, BUS_ID_SIZE, "%016Lx",
855 (unsigned long long)(ne->guid));
857 ne->node_dev.parent = &ne->device;
858 ne->node_dev.class = &nodemgr_ne_class;
859 snprintf(ne->node_dev.bus_id, BUS_ID_SIZE, "%016Lx",
860 (unsigned long long)(ne->guid));
862 if (device_register(&ne->device))
864 if (device_register(&ne->node_dev))
865 goto fail_classdevreg;
866 get_device(&ne->device);
868 nodemgr_create_ne_dev_files(ne);
870 nodemgr_update_bus_options(ne);
872 HPSB_DEBUG("%s added: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
873 (host->node_id == nodeid) ? "Host" : "Node",
874 NODE_BUS_ARGS(host, nodeid), (unsigned long long)guid);
879 device_unregister(&ne->device);
883 HPSB_ERR("Failed to create node ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
884 NODE_BUS_ARGS(host, nodeid), (unsigned long long)guid);
889 static int match_ne_guid(struct device *dev, void *data)
891 struct node_entry *ne;
894 ne = container_of(dev, struct node_entry, node_dev);
895 return ne->guid == *guid;
898 static struct node_entry *find_entry_by_guid(u64 guid)
901 struct node_entry *ne;
903 dev = class_find_device(&nodemgr_ne_class, NULL, &guid, match_ne_guid);
906 ne = container_of(dev, struct node_entry, node_dev);
912 struct match_nodeid_parameter {
913 struct hpsb_host *host;
917 static int match_ne_nodeid(struct device *dev, void *data)
920 struct node_entry *ne;
921 struct match_nodeid_parameter *p = data;
925 ne = container_of(dev, struct node_entry, node_dev);
926 if (ne->host == p->host && ne->nodeid == p->nodeid)
932 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host,
936 struct node_entry *ne;
937 struct match_nodeid_parameter p;
942 dev = class_find_device(&nodemgr_ne_class, NULL, &p, match_ne_nodeid);
945 ne = container_of(dev, struct node_entry, node_dev);
952 static void nodemgr_register_device(struct node_entry *ne,
953 struct unit_directory *ud, struct device *parent)
955 memcpy(&ud->device, &nodemgr_dev_template_ud,
958 ud->device.parent = parent;
960 snprintf(ud->device.bus_id, BUS_ID_SIZE, "%s-%u",
961 ne->device.bus_id, ud->id);
963 ud->unit_dev.parent = &ud->device;
964 ud->unit_dev.class = &nodemgr_ud_class;
965 snprintf(ud->unit_dev.bus_id, BUS_ID_SIZE, "%s-%u",
966 ne->device.bus_id, ud->id);
968 if (device_register(&ud->device))
970 if (device_register(&ud->unit_dev))
971 goto fail_classdevreg;
972 get_device(&ud->device);
974 nodemgr_create_ud_dev_files(ud);
979 device_unregister(&ud->device);
981 HPSB_ERR("Failed to create unit %s", ud->device.bus_id);
985 /* This implementation currently only scans the config rom and its
986 * immediate unit directories looking for software_id and
987 * software_version entries, in order to get driver autoloading working. */
988 static struct unit_directory *nodemgr_process_unit_directory
989 (struct node_entry *ne, struct csr1212_keyval *ud_kv,
990 unsigned int *id, struct unit_directory *parent)
992 struct unit_directory *ud;
993 struct unit_directory *ud_child = NULL;
994 struct csr1212_dentry *dentry;
995 struct csr1212_keyval *kv;
998 ud = kzalloc(sizeof(*ud), GFP_KERNEL);
1000 goto unit_directory_error;
1003 ud->ignore_driver = ignore_drivers;
1004 ud->address = ud_kv->offset + CSR1212_REGISTER_SPACE_BASE;
1005 ud->directory_id = ud->address & 0xffffff;
1009 csr1212_for_each_dir_entry(ne->csr, kv, ud_kv, dentry) {
1010 switch (kv->key.id) {
1011 case CSR1212_KV_ID_VENDOR:
1012 if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1013 ud->vendor_id = kv->value.immediate;
1014 ud->flags |= UNIT_DIRECTORY_VENDOR_ID;
1018 case CSR1212_KV_ID_MODEL:
1019 ud->model_id = kv->value.immediate;
1020 ud->flags |= UNIT_DIRECTORY_MODEL_ID;
1023 case CSR1212_KV_ID_SPECIFIER_ID:
1024 ud->specifier_id = kv->value.immediate;
1025 ud->flags |= UNIT_DIRECTORY_SPECIFIER_ID;
1028 case CSR1212_KV_ID_VERSION:
1029 ud->version = kv->value.immediate;
1030 ud->flags |= UNIT_DIRECTORY_VERSION;
1033 case CSR1212_KV_ID_DESCRIPTOR:
1034 if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
1035 CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
1036 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
1037 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
1038 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
1039 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
1040 switch (last_key_id) {
1041 case CSR1212_KV_ID_VENDOR:
1042 csr1212_keep_keyval(kv);
1043 ud->vendor_name_kv = kv;
1046 case CSR1212_KV_ID_MODEL:
1047 csr1212_keep_keyval(kv);
1048 ud->model_name_kv = kv;
1052 } /* else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) ... */
1055 case CSR1212_KV_ID_DEPENDENT_INFO:
1056 /* Logical Unit Number */
1057 if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
1058 if (ud->flags & UNIT_DIRECTORY_HAS_LUN) {
1059 ud_child = kmemdup(ud, sizeof(*ud_child), GFP_KERNEL);
1061 goto unit_directory_error;
1062 nodemgr_register_device(ne, ud_child, &ne->device);
1067 ud->lun = kv->value.immediate;
1068 ud->flags |= UNIT_DIRECTORY_HAS_LUN;
1070 /* Logical Unit Directory */
1071 } else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) {
1072 /* This should really be done in SBP2 as this is
1073 * doing SBP2 specific parsing.
1076 /* first register the parent unit */
1077 ud->flags |= UNIT_DIRECTORY_HAS_LUN_DIRECTORY;
1078 if (ud->device.bus != &ieee1394_bus_type)
1079 nodemgr_register_device(ne, ud, &ne->device);
1081 /* process the child unit */
1082 ud_child = nodemgr_process_unit_directory(ne, kv, id, ud);
1084 if (ud_child == NULL)
1087 /* inherit unspecified values, the driver core picks it up */
1088 if ((ud->flags & UNIT_DIRECTORY_MODEL_ID) &&
1089 !(ud_child->flags & UNIT_DIRECTORY_MODEL_ID))
1091 ud_child->flags |= UNIT_DIRECTORY_MODEL_ID;
1092 ud_child->model_id = ud->model_id;
1094 if ((ud->flags & UNIT_DIRECTORY_SPECIFIER_ID) &&
1095 !(ud_child->flags & UNIT_DIRECTORY_SPECIFIER_ID))
1097 ud_child->flags |= UNIT_DIRECTORY_SPECIFIER_ID;
1098 ud_child->specifier_id = ud->specifier_id;
1100 if ((ud->flags & UNIT_DIRECTORY_VERSION) &&
1101 !(ud_child->flags & UNIT_DIRECTORY_VERSION))
1103 ud_child->flags |= UNIT_DIRECTORY_VERSION;
1104 ud_child->version = ud->version;
1107 /* register the child unit */
1108 ud_child->flags |= UNIT_DIRECTORY_LUN_DIRECTORY;
1109 nodemgr_register_device(ne, ud_child, &ud->device);
1114 case CSR1212_KV_ID_DIRECTORY_ID:
1115 ud->directory_id = kv->value.immediate;
1121 last_key_id = kv->key.id;
1124 /* do not process child units here and only if not already registered */
1125 if (!parent && ud->device.bus != &ieee1394_bus_type)
1126 nodemgr_register_device(ne, ud, &ne->device);
1130 unit_directory_error:
1136 static void nodemgr_process_root_directory(struct node_entry *ne)
1138 unsigned int ud_id = 0;
1139 struct csr1212_dentry *dentry;
1140 struct csr1212_keyval *kv, *vendor_name_kv = NULL;
1143 ne->needs_probe = false;
1145 csr1212_for_each_dir_entry(ne->csr, kv, ne->csr->root_kv, dentry) {
1146 switch (kv->key.id) {
1147 case CSR1212_KV_ID_VENDOR:
1148 ne->vendor_id = kv->value.immediate;
1151 case CSR1212_KV_ID_NODE_CAPABILITIES:
1152 ne->capabilities = kv->value.immediate;
1155 case CSR1212_KV_ID_UNIT:
1156 nodemgr_process_unit_directory(ne, kv, &ud_id, NULL);
1159 case CSR1212_KV_ID_DESCRIPTOR:
1160 if (last_key_id == CSR1212_KV_ID_VENDOR) {
1161 if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
1162 CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
1163 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
1164 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
1165 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
1166 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
1167 csr1212_keep_keyval(kv);
1168 vendor_name_kv = kv;
1173 last_key_id = kv->key.id;
1176 if (ne->vendor_name_kv) {
1177 kv = ne->vendor_name_kv;
1178 ne->vendor_name_kv = vendor_name_kv;
1179 csr1212_release_keyval(kv);
1180 } else if (vendor_name_kv) {
1181 ne->vendor_name_kv = vendor_name_kv;
1182 if (device_create_file(&ne->device,
1183 &dev_attr_ne_vendor_name_kv) != 0)
1184 HPSB_ERR("Failed to add sysfs attribute");
1188 #ifdef CONFIG_HOTPLUG
1190 static int nodemgr_uevent(struct device *dev, struct kobj_uevent_env *env)
1192 struct unit_directory *ud;
1194 /* ieee1394:venNmoNspNverN */
1195 char buf[8 + 1 + 3 + 8 + 2 + 8 + 2 + 8 + 3 + 8 + 1];
1200 ud = container_of(dev, struct unit_directory, unit_dev);
1202 if (ud->ne->in_limbo || ud->ignore_driver)
1205 #define PUT_ENVP(fmt,val) \
1207 retval = add_uevent_var(env, fmt, val); \
1212 PUT_ENVP("VENDOR_ID=%06x", ud->vendor_id);
1213 PUT_ENVP("MODEL_ID=%06x", ud->model_id);
1214 PUT_ENVP("GUID=%016Lx", (unsigned long long)ud->ne->guid);
1215 PUT_ENVP("SPECIFIER_ID=%06x", ud->specifier_id);
1216 PUT_ENVP("VERSION=%06x", ud->version);
1217 snprintf(buf, sizeof(buf), "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
1222 PUT_ENVP("MODALIAS=%s", buf);
1231 static int nodemgr_uevent(struct device *dev, struct kobj_uevent_env *env)
1236 #endif /* CONFIG_HOTPLUG */
1239 int __hpsb_register_protocol(struct hpsb_protocol_driver *drv,
1240 struct module *owner)
1244 drv->driver.bus = &ieee1394_bus_type;
1245 drv->driver.owner = owner;
1246 drv->driver.name = drv->name;
1248 /* This will cause a probe for devices */
1249 error = driver_register(&drv->driver);
1251 nodemgr_create_drv_files(drv);
1255 void hpsb_unregister_protocol(struct hpsb_protocol_driver *driver)
1257 nodemgr_remove_drv_files(driver);
1258 /* This will subsequently disconnect all devices that our driver
1259 * is attached to. */
1260 driver_unregister(&driver->driver);
1265 * This function updates nodes that were present on the bus before the
1266 * reset and still are after the reset. The nodeid and the config rom
1267 * may have changed, and the drivers managing this device must be
1268 * informed that this device just went through a bus reset, to allow
1269 * the to take whatever actions required.
1271 static void nodemgr_update_node(struct node_entry *ne, struct csr1212_csr *csr,
1272 nodeid_t nodeid, unsigned int generation)
1274 if (ne->nodeid != nodeid) {
1275 HPSB_DEBUG("Node changed: " NODE_BUS_FMT " -> " NODE_BUS_FMT,
1276 NODE_BUS_ARGS(ne->host, ne->nodeid),
1277 NODE_BUS_ARGS(ne->host, nodeid));
1278 ne->nodeid = nodeid;
1281 if (ne->busopt.generation != ((be32_to_cpu(csr->bus_info_data[2]) >> 4) & 0xf)) {
1282 kfree(ne->csr->private);
1283 csr1212_destroy_csr(ne->csr);
1286 /* If the node's configrom generation has changed, we
1287 * unregister all the unit directories. */
1288 nodemgr_remove_uds(ne);
1290 nodemgr_update_bus_options(ne);
1292 /* Mark the node as new, so it gets re-probed */
1293 ne->needs_probe = true;
1295 /* old cache is valid, so update its generation */
1296 struct nodemgr_csr_info *ci = ne->csr->private;
1297 ci->generation = generation;
1298 /* free the partially filled now unneeded new cache */
1299 kfree(csr->private);
1300 csr1212_destroy_csr(csr);
1304 nodemgr_reactivate_ne(ne);
1306 /* Mark the node current */
1307 ne->generation = generation;
1312 static void nodemgr_node_scan_one(struct hpsb_host *host,
1313 nodeid_t nodeid, int generation)
1315 struct node_entry *ne;
1317 struct csr1212_csr *csr;
1318 struct nodemgr_csr_info *ci;
1321 ci = kmalloc(sizeof(*ci), GFP_KERNEL);
1326 ci->nodeid = nodeid;
1327 ci->generation = generation;
1329 /* Prepare for speed probe which occurs when reading the ROM */
1330 speed = &(host->speed[NODEID_TO_NODE(nodeid)]);
1331 if (*speed > host->csr.lnk_spd)
1332 *speed = host->csr.lnk_spd;
1333 ci->speed_unverified = *speed > IEEE1394_SPEED_100;
1335 /* We need to detect when the ConfigROM's generation has changed,
1336 * so we only update the node's info when it needs to be. */
1338 csr = csr1212_create_csr(&nodemgr_csr_ops, 5 * sizeof(quadlet_t), ci);
1339 if (!csr || csr1212_parse_csr(csr) != CSR1212_SUCCESS) {
1340 HPSB_ERR("Error parsing configrom for node " NODE_BUS_FMT,
1341 NODE_BUS_ARGS(host, nodeid));
1343 csr1212_destroy_csr(csr);
1348 if (csr->bus_info_data[1] != IEEE1394_BUSID_MAGIC) {
1349 /* This isn't a 1394 device, but we let it slide. There
1350 * was a report of a device with broken firmware which
1351 * reported '2394' instead of '1394', which is obviously a
1352 * mistake. One would hope that a non-1394 device never
1353 * gets connected to Firewire bus. If someone does, we
1354 * shouldn't be held responsible, so we'll allow it with a
1356 HPSB_WARN("Node " NODE_BUS_FMT " has invalid busID magic [0x%08x]",
1357 NODE_BUS_ARGS(host, nodeid), csr->bus_info_data[1]);
1360 guid = ((u64)be32_to_cpu(csr->bus_info_data[3]) << 32) | be32_to_cpu(csr->bus_info_data[4]);
1361 ne = find_entry_by_guid(guid);
1363 if (ne && ne->host != host && ne->in_limbo) {
1364 /* Must have moved this device from one host to another */
1365 nodemgr_remove_ne(ne);
1370 nodemgr_create_node(guid, csr, host, nodeid, generation);
1372 nodemgr_update_node(ne, csr, nodeid, generation);
1376 static void nodemgr_node_scan(struct hpsb_host *host, int generation)
1379 struct selfid *sid = (struct selfid *)host->topology_map;
1380 nodeid_t nodeid = LOCAL_BUS;
1382 /* Scan each node on the bus */
1383 for (count = host->selfid_count; count; count--, sid++) {
1387 if (!sid->link_active) {
1391 nodemgr_node_scan_one(host, nodeid++, generation);
1395 static int pause_ne(struct device *dev, void *data)
1397 struct unit_directory *ud;
1398 struct device_driver *drv;
1399 struct node_entry *ne = data;
1402 ud = container_of(dev, struct unit_directory, unit_dev);
1404 drv = get_driver(ud->device.driver);
1406 error = 1; /* release if suspend is not implemented */
1408 down(&ud->device.sem);
1409 error = drv->suspend(&ud->device, PMSG_SUSPEND);
1410 up(&ud->device.sem);
1413 device_release_driver(&ud->device);
1421 static void nodemgr_pause_ne(struct node_entry *ne)
1423 HPSB_DEBUG("Node suspended: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
1424 NODE_BUS_ARGS(ne->host, ne->nodeid),
1425 (unsigned long long)ne->guid);
1428 WARN_ON(device_create_file(&ne->device, &dev_attr_ne_in_limbo));
1430 class_for_each_device(&nodemgr_ud_class, NULL, ne, pause_ne);
1433 static int reactivate_ne(struct device *dev, void *data)
1435 struct unit_directory *ud;
1436 struct device_driver *drv;
1437 struct node_entry *ne = data;
1439 ud = container_of(dev, struct unit_directory, unit_dev);
1441 drv = get_driver(ud->device.driver);
1444 down(&ud->device.sem);
1445 drv->resume(&ud->device);
1446 up(&ud->device.sem);
1455 static void nodemgr_reactivate_ne(struct node_entry *ne)
1458 device_remove_file(&ne->device, &dev_attr_ne_in_limbo);
1460 class_for_each_device(&nodemgr_ud_class, NULL, ne, reactivate_ne);
1461 HPSB_DEBUG("Node resumed: ID:BUS[" NODE_BUS_FMT "] GUID[%016Lx]",
1462 NODE_BUS_ARGS(ne->host, ne->nodeid),
1463 (unsigned long long)ne->guid);
1466 static int update_pdrv(struct device *dev, void *data)
1468 struct unit_directory *ud;
1469 struct device_driver *drv;
1470 struct hpsb_protocol_driver *pdrv;
1471 struct node_entry *ne = data;
1474 ud = container_of(dev, struct unit_directory, unit_dev);
1476 drv = get_driver(ud->device.driver);
1479 pdrv = container_of(drv, struct hpsb_protocol_driver,
1482 down(&ud->device.sem);
1483 error = pdrv->update(ud);
1484 up(&ud->device.sem);
1487 device_release_driver(&ud->device);
1495 static void nodemgr_update_pdrv(struct node_entry *ne)
1497 class_for_each_device(&nodemgr_ud_class, NULL, ne, update_pdrv);
1501 /* Write the BROADCAST_CHANNEL as per IEEE1394a 8.3.2.3.11 and 8.4.2.3. This
1502 * seems like an optional service but in the end it is practically mandatory
1503 * as a consequence of these clauses.
1505 * Note that we cannot do a broadcast write to all nodes at once because some
1506 * pre-1394a devices would hang. */
1507 static void nodemgr_irm_write_bc(struct node_entry *ne, int generation)
1509 const u64 bc_addr = (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL);
1510 quadlet_t bc_remote, bc_local;
1513 if (!ne->host->is_irm || ne->generation != generation ||
1514 ne->nodeid == ne->host->node_id)
1517 bc_local = cpu_to_be32(ne->host->csr.broadcast_channel);
1519 /* Check if the register is implemented and 1394a compliant. */
1520 error = hpsb_read(ne->host, ne->nodeid, generation, bc_addr, &bc_remote,
1522 if (!error && bc_remote & cpu_to_be32(0x80000000) &&
1523 bc_remote != bc_local)
1524 hpsb_node_write(ne, bc_addr, &bc_local, sizeof(bc_local));
1528 static void nodemgr_probe_ne(struct hpsb_host *host, struct node_entry *ne,
1533 if (ne->host != host || ne->in_limbo)
1536 dev = get_device(&ne->device);
1540 nodemgr_irm_write_bc(ne, generation);
1542 /* If "needs_probe", then this is either a new or changed node we
1543 * rescan totally. If the generation matches for an existing node
1544 * (one that existed prior to the bus reset) we send update calls
1545 * down to the drivers. Otherwise, this is a dead node and we
1547 if (ne->needs_probe)
1548 nodemgr_process_root_directory(ne);
1549 else if (ne->generation == generation)
1550 nodemgr_update_pdrv(ne);
1552 nodemgr_pause_ne(ne);
1557 struct node_probe_parameter {
1558 struct hpsb_host *host;
1563 static int node_probe(struct device *dev, void *data)
1565 struct node_probe_parameter *p = data;
1566 struct node_entry *ne;
1568 if (p->generation != get_hpsb_generation(p->host))
1571 ne = container_of(dev, struct node_entry, node_dev);
1572 if (ne->needs_probe == p->probe_now)
1573 nodemgr_probe_ne(p->host, ne, p->generation);
1577 static void nodemgr_node_probe(struct hpsb_host *host, int generation)
1579 struct node_probe_parameter p;
1582 p.generation = generation;
1584 * Do some processing of the nodes we've probed. This pulls them
1585 * into the sysfs layer if needed, and can result in processing of
1586 * unit-directories, or just updating the node and it's
1589 * Run updates before probes. Usually, updates are time-critical
1590 * while probes are time-consuming.
1592 * Meanwhile, another bus reset may have happened. In this case we
1593 * skip everything here and let the next bus scan handle it.
1594 * Otherwise we may prematurely remove nodes which are still there.
1596 p.probe_now = false;
1597 if (class_for_each_device(&nodemgr_ne_class, NULL, &p, node_probe) != 0)
1601 if (class_for_each_device(&nodemgr_ne_class, NULL, &p, node_probe) != 0)
1604 * Now let's tell the bus to rescan our devices. This may seem
1605 * like overhead, but the driver-model core will only scan a
1606 * device for a driver when either the device is added, or when a
1607 * new driver is added. A bus reset is a good reason to rescan
1608 * devices that were there before. For example, an sbp2 device
1609 * may become available for login, if the host that held it was
1612 if (bus_rescan_devices(&ieee1394_bus_type) != 0)
1613 HPSB_DEBUG("bus_rescan_devices had an error");
1616 static int nodemgr_send_resume_packet(struct hpsb_host *host)
1618 struct hpsb_packet *packet;
1619 int error = -ENOMEM;
1621 packet = hpsb_make_phypacket(host,
1622 EXTPHYPACKET_TYPE_RESUME |
1623 NODEID_TO_NODE(host->node_id) << PHYPACKET_PORT_SHIFT);
1625 packet->no_waiter = 1;
1626 packet->generation = get_hpsb_generation(host);
1627 error = hpsb_send_packet(packet);
1630 HPSB_WARN("fw-host%d: Failed to broadcast resume packet",
1635 /* Perform a few high-level IRM responsibilities. */
1636 static int nodemgr_do_irm_duties(struct hpsb_host *host, int cycles)
1640 /* if irm_id == -1 then there is no IRM on this bus */
1641 if (!host->is_irm || host->irm_id == (nodeid_t)-1)
1644 /* We are a 1394a-2000 compliant IRM. Set the validity bit. */
1645 host->csr.broadcast_channel |= 0x40000000;
1647 /* If there is no bus manager then we should set the root node's
1648 * force_root bit to promote bus stability per the 1394
1649 * spec. (8.4.2.6) */
1650 if (host->busmgr_id == 0xffff && host->node_count > 1)
1652 u16 root_node = host->node_count - 1;
1654 /* get cycle master capability flag from root node */
1655 if (host->is_cycmst ||
1656 (!hpsb_read(host, LOCAL_BUS | root_node, get_hpsb_generation(host),
1657 (CSR_REGISTER_BASE + CSR_CONFIG_ROM + 2 * sizeof(quadlet_t)),
1658 &bc, sizeof(quadlet_t)) &&
1659 be32_to_cpu(bc) & 1 << CSR_CMC_SHIFT))
1660 hpsb_send_phy_config(host, root_node, -1);
1662 HPSB_DEBUG("The root node is not cycle master capable; "
1663 "selecting a new root node and resetting...");
1666 /* Oh screw it! Just leave the bus as it is */
1667 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1671 hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1672 hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1678 /* Some devices suspend their ports while being connected to an inactive
1679 * host adapter, i.e. if connected before the low-level driver is
1680 * loaded. They become visible either when physically unplugged and
1681 * replugged, or when receiving a resume packet. Send one once. */
1682 if (!host->resume_packet_sent && !nodemgr_send_resume_packet(host))
1683 host->resume_packet_sent = 1;
1688 /* We need to ensure that if we are not the IRM, that the IRM node is capable of
1689 * everything we can do, otherwise issue a bus reset and try to become the IRM
1691 static int nodemgr_check_irm_capability(struct hpsb_host *host, int cycles)
1696 if (hpsb_disable_irm || host->is_irm)
1699 status = hpsb_read(host, LOCAL_BUS | (host->irm_id),
1700 get_hpsb_generation(host),
1701 (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL),
1702 &bc, sizeof(quadlet_t));
1704 if (status < 0 || !(be32_to_cpu(bc) & 0x80000000)) {
1705 /* The current irm node does not have a valid BROADCAST_CHANNEL
1706 * register and we do, so reset the bus with force_root set */
1707 HPSB_DEBUG("Current remote IRM is not 1394a-2000 compliant, resetting...");
1710 /* Oh screw it! Just leave the bus as it is */
1711 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1715 hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1716 hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1724 static int nodemgr_host_thread(void *data)
1726 struct hpsb_host *host = data;
1727 unsigned int g, generation = 0;
1728 int i, reset_cycles = 0;
1731 /* Setup our device-model entries */
1732 nodemgr_create_host_dev_files(host);
1735 /* Sleep until next bus reset */
1736 set_current_state(TASK_INTERRUPTIBLE);
1737 if (get_hpsb_generation(host) == generation &&
1738 !kthread_should_stop())
1740 __set_current_state(TASK_RUNNING);
1742 /* Thread may have been woken up to freeze or to exit */
1743 if (try_to_freeze())
1745 if (kthread_should_stop())
1748 /* Pause for 1/4 second in 1/16 second intervals,
1749 * to make sure things settle down. */
1750 g = get_hpsb_generation(host);
1751 for (i = 0; i < 4 ; i++) {
1752 msleep_interruptible(63);
1753 if (kthread_should_stop())
1756 /* Now get the generation in which the node ID's we collect
1757 * are valid. During the bus scan we will use this generation
1758 * for the read transactions, so that if another reset occurs
1759 * during the scan the transactions will fail instead of
1760 * returning bogus data. */
1761 generation = get_hpsb_generation(host);
1763 /* If we get a reset before we are done waiting, then
1764 * start the waiting over again */
1765 if (generation != g)
1766 g = generation, i = 0;
1769 if (!nodemgr_check_irm_capability(host, reset_cycles) ||
1770 !nodemgr_do_irm_duties(host, reset_cycles)) {
1776 /* Scan our nodes to get the bus options and create node
1777 * entries. This does not do the sysfs stuff, since that
1778 * would trigger uevents and such, which is a bad idea at
1780 nodemgr_node_scan(host, generation);
1782 /* This actually does the full probe, with sysfs
1784 nodemgr_node_probe(host, generation);
1786 /* Update some of our sysfs symlinks */
1787 nodemgr_update_host_dev_links(host);
1790 HPSB_VERBOSE("NodeMgr: Exiting thread");
1794 struct per_host_parameter {
1796 int (*cb)(struct hpsb_host *, void *);
1799 static int per_host(struct device *dev, void *data)
1801 struct hpsb_host *host;
1802 struct per_host_parameter *p = data;
1804 host = container_of(dev, struct hpsb_host, host_dev);
1805 return p->cb(host, p->data);
1809 * nodemgr_for_each_host - call a function for each IEEE 1394 host
1810 * @data: an address to supply to the callback
1811 * @cb: function to call for each host
1813 * Iterate the hosts, calling a given function with supplied data for each host.
1814 * If the callback fails on a host, i.e. if it returns a non-zero value, the
1815 * iteration is stopped.
1817 * Return value: 0 on success, non-zero on failure (same as returned by last run
1820 int nodemgr_for_each_host(void *data, int (*cb)(struct hpsb_host *, void *))
1822 struct per_host_parameter p;
1826 return class_for_each_device(&hpsb_host_class, NULL, &p, per_host);
1829 /* The following two convenience functions use a struct node_entry
1830 * for addressing a node on the bus. They are intended for use by any
1831 * process context, not just the nodemgr thread, so we need to be a
1832 * little careful when reading out the node ID and generation. The
1833 * thing that can go wrong is that we get the node ID, then a bus
1834 * reset occurs, and then we read the generation. The node ID is
1835 * possibly invalid, but the generation is current, and we end up
1836 * sending a packet to a the wrong node.
1838 * The solution is to make sure we read the generation first, so that
1839 * if a reset occurs in the process, we end up with a stale generation
1840 * and the transactions will fail instead of silently using wrong node
1845 * hpsb_node_fill_packet - fill some destination information into a packet
1846 * @ne: destination node
1847 * @packet: packet to fill in
1849 * This will fill in the given, pre-initialised hpsb_packet with the current
1850 * information from the node entry (host, node ID, bus generation number).
1852 void hpsb_node_fill_packet(struct node_entry *ne, struct hpsb_packet *packet)
1854 packet->host = ne->host;
1855 packet->generation = ne->generation;
1857 packet->node_id = ne->nodeid;
1860 int hpsb_node_write(struct node_entry *ne, u64 addr,
1861 quadlet_t *buffer, size_t length)
1863 unsigned int generation = ne->generation;
1866 return hpsb_write(ne->host, ne->nodeid, generation,
1867 addr, buffer, length);
1870 static void nodemgr_add_host(struct hpsb_host *host)
1872 struct host_info *hi;
1874 hi = hpsb_create_hostinfo(&nodemgr_highlevel, host, sizeof(*hi));
1876 HPSB_ERR("NodeMgr: out of memory in add host");
1880 hi->thread = kthread_run(nodemgr_host_thread, host, "knodemgrd_%d",
1882 if (IS_ERR(hi->thread)) {
1883 HPSB_ERR("NodeMgr: cannot start thread for host %d", host->id);
1884 hpsb_destroy_hostinfo(&nodemgr_highlevel, host);
1888 static void nodemgr_host_reset(struct hpsb_host *host)
1890 struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1893 HPSB_VERBOSE("NodeMgr: Processing reset for host %d", host->id);
1894 wake_up_process(hi->thread);
1898 static void nodemgr_remove_host(struct hpsb_host *host)
1900 struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1903 kthread_stop(hi->thread);
1904 nodemgr_remove_host_dev(&host->device);
1908 static struct hpsb_highlevel nodemgr_highlevel = {
1909 .name = "Node manager",
1910 .add_host = nodemgr_add_host,
1911 .host_reset = nodemgr_host_reset,
1912 .remove_host = nodemgr_remove_host,
1915 int init_ieee1394_nodemgr(void)
1919 error = class_register(&nodemgr_ne_class);
1922 error = class_register(&nodemgr_ud_class);
1925 error = driver_register(&nodemgr_mid_layer_driver);
1928 /* This driver is not used if nodemgr is off (disable_nodemgr=1). */
1929 nodemgr_dev_template_host.driver = &nodemgr_mid_layer_driver;
1931 hpsb_register_highlevel(&nodemgr_highlevel);
1935 class_unregister(&nodemgr_ud_class);
1937 class_unregister(&nodemgr_ne_class);
1942 void cleanup_ieee1394_nodemgr(void)
1944 hpsb_unregister_highlevel(&nodemgr_highlevel);
1945 driver_unregister(&nodemgr_mid_layer_driver);
1946 class_unregister(&nodemgr_ud_class);
1947 class_unregister(&nodemgr_ne_class);