082c7fd239f584a14f64604bb65fe770697eda02
[linux-3.10.git] / drivers / ieee1394 / nodemgr.c
1 /*
2  * Node information (ConfigROM) collection and management.
3  *
4  * Copyright (C) 2000           Andreas E. Bombe
5  *               2001-2003      Ben Collins <bcollins@debian.net>
6  *
7  * This code is licensed under the GPL.  See the file COPYING in the root
8  * directory of the kernel sources for details.
9  */
10
11 #include <linux/kernel.h>
12 #include <linux/config.h>
13 #include <linux/list.h>
14 #include <linux/slab.h>
15 #include <linux/smp_lock.h>
16 #include <linux/interrupt.h>
17 #include <linux/kmod.h>
18 #include <linux/completion.h>
19 #include <linux/delay.h>
20 #include <linux/pci.h>
21 #include <linux/moduleparam.h>
22 #include <asm/atomic.h>
23
24 #include "ieee1394_types.h"
25 #include "ieee1394.h"
26 #include "ieee1394_core.h"
27 #include "hosts.h"
28 #include "ieee1394_transactions.h"
29 #include "highlevel.h"
30 #include "csr.h"
31 #include "nodemgr.h"
32
33 static int ignore_drivers;
34 module_param(ignore_drivers, int, 0444);
35 MODULE_PARM_DESC(ignore_drivers, "Disable automatic probing for drivers.");
36
37 struct nodemgr_csr_info {
38         struct hpsb_host *host;
39         nodeid_t nodeid;
40         unsigned int generation;
41 };
42
43
44 static char *nodemgr_find_oui_name(int oui)
45 {
46 #ifdef CONFIG_IEEE1394_OUI_DB
47         extern struct oui_list_struct {
48                 int oui;
49                 char *name;
50         } oui_list[];
51         int i;
52
53         for (i = 0; oui_list[i].name; i++)
54                 if (oui_list[i].oui == oui)
55                         return oui_list[i].name;
56 #endif
57         return NULL;
58 }
59
60
61 static int nodemgr_bus_read(struct csr1212_csr *csr, u64 addr, u16 length,
62                             void *buffer, void *__ci)
63 {
64         struct nodemgr_csr_info *ci = (struct nodemgr_csr_info*)__ci;
65         int i, ret = 0;
66
67         for (i = 1; ; i++) {
68                 ret = hpsb_read(ci->host, ci->nodeid, ci->generation, addr,
69                                 buffer, length);
70                 if (!ret || i == 3)
71                         break;
72
73                 if (msleep_interruptible(334))
74                         return -EINTR;
75         }
76
77         return ret;
78 }
79
80 static int nodemgr_get_max_rom(quadlet_t *bus_info_data, void *__ci)
81 {
82         return (CSR1212_BE32_TO_CPU(bus_info_data[2]) >> 8) & 0x3;
83 }
84
85 static struct csr1212_bus_ops nodemgr_csr_ops = {
86         .bus_read =     nodemgr_bus_read,
87         .get_max_rom =  nodemgr_get_max_rom
88 };
89
90
91 /*
92  * Basically what we do here is start off retrieving the bus_info block.
93  * From there will fill in some info about the node, verify it is of IEEE
94  * 1394 type, and that the crc checks out ok. After that we start off with
95  * the root directory, and subdirectories. To do this, we retrieve the
96  * quadlet header for a directory, find out the length, and retrieve the
97  * complete directory entry (be it a leaf or a directory). We then process
98  * it and add the info to our structure for that particular node.
99  *
100  * We verify CRC's along the way for each directory/block/leaf. The entire
101  * node structure is generic, and simply stores the information in a way
102  * that's easy to parse by the protocol interface.
103  */
104
105 /*
106  * The nodemgr relies heavily on the Driver Model for device callbacks and
107  * driver/device mappings. The old nodemgr used to handle all this itself,
108  * but now we are much simpler because of the LDM.
109  */
110
111 static DECLARE_MUTEX(nodemgr_serialize);
112
113 struct host_info {
114         struct hpsb_host *host;
115         struct list_head list;
116         struct completion exited;
117         struct semaphore reset_sem;
118         int pid;
119         char daemon_name[15];
120         int kill_me;
121 };
122
123 static int nodemgr_bus_match(struct device * dev, struct device_driver * drv);
124 static int nodemgr_uevent(struct class_device *cdev, char **envp, int num_envp,
125                           char *buffer, int buffer_size);
126 static void nodemgr_resume_ne(struct node_entry *ne);
127 static void nodemgr_remove_ne(struct node_entry *ne);
128 static struct node_entry *find_entry_by_guid(u64 guid);
129
130 struct bus_type ieee1394_bus_type = {
131         .name           = "ieee1394",
132         .match          = nodemgr_bus_match,
133 };
134
135 static void host_cls_release(struct class_device *class_dev)
136 {
137         put_device(&container_of((class_dev), struct hpsb_host, class_dev)->device);
138 }
139
140 struct class hpsb_host_class = {
141         .name           = "ieee1394_host",
142         .release        = host_cls_release,
143 };
144
145 static void ne_cls_release(struct class_device *class_dev)
146 {
147         put_device(&container_of((class_dev), struct node_entry, class_dev)->device);
148 }
149
150 static struct class nodemgr_ne_class = {
151         .name           = "ieee1394_node",
152         .release        = ne_cls_release,
153 };
154
155 static void ud_cls_release(struct class_device *class_dev)
156 {
157         put_device(&container_of((class_dev), struct unit_directory, class_dev)->device);
158 }
159
160 /* The name here is only so that unit directory hotplug works with old
161  * style hotplug, which only ever did unit directories anyway. */
162 static struct class nodemgr_ud_class = {
163         .name           = "ieee1394",
164         .release        = ud_cls_release,
165         .uevent         = nodemgr_uevent,
166 };
167
168 static struct hpsb_highlevel nodemgr_highlevel;
169
170
171 static void nodemgr_release_ud(struct device *dev)
172 {
173         struct unit_directory *ud = container_of(dev, struct unit_directory, device);
174
175         if (ud->vendor_name_kv)
176                 csr1212_release_keyval(ud->vendor_name_kv);
177         if (ud->model_name_kv)
178                 csr1212_release_keyval(ud->model_name_kv);
179
180         kfree(ud);
181 }
182
183 static void nodemgr_release_ne(struct device *dev)
184 {
185         struct node_entry *ne = container_of(dev, struct node_entry, device);
186
187         if (ne->vendor_name_kv)
188                 csr1212_release_keyval(ne->vendor_name_kv);
189
190         kfree(ne);
191 }
192
193
194 static void nodemgr_release_host(struct device *dev)
195 {
196         struct hpsb_host *host = container_of(dev, struct hpsb_host, device);
197
198         csr1212_destroy_csr(host->csr.rom);
199
200         kfree(host);
201 }
202
203 static int nodemgr_ud_platform_data;
204
205 static struct device nodemgr_dev_template_ud = {
206         .bus            = &ieee1394_bus_type,
207         .release        = nodemgr_release_ud,
208         .platform_data  = &nodemgr_ud_platform_data,
209 };
210
211 static struct device nodemgr_dev_template_ne = {
212         .bus            = &ieee1394_bus_type,
213         .release        = nodemgr_release_ne,
214 };
215
216 struct device nodemgr_dev_template_host = {
217         .bus            = &ieee1394_bus_type,
218         .release        = nodemgr_release_host,
219 };
220
221
222 #define fw_attr(class, class_type, field, type, format_string)          \
223 static ssize_t fw_show_##class##_##field (struct device *dev, struct device_attribute *attr, char *buf)\
224 {                                                                       \
225         class_type *class;                                              \
226         class = container_of(dev, class_type, device);                  \
227         return sprintf(buf, format_string, (type)class->field);         \
228 }                                                                       \
229 static struct device_attribute dev_attr_##class##_##field = {           \
230         .attr = {.name = __stringify(field), .mode = S_IRUGO },         \
231         .show   = fw_show_##class##_##field,                            \
232 };
233
234 #define fw_attr_td(class, class_type, td_kv)                            \
235 static ssize_t fw_show_##class##_##td_kv (struct device *dev, struct device_attribute *attr, char *buf)\
236 {                                                                       \
237         int len;                                                        \
238         class_type *class = container_of(dev, class_type, device);      \
239         len = (class->td_kv->value.leaf.len - 2) * sizeof(quadlet_t);   \
240         memcpy(buf,                                                     \
241                CSR1212_TEXTUAL_DESCRIPTOR_LEAF_DATA(class->td_kv),      \
242                len);                                                    \
243         while ((buf + len - 1) == '\0')                                 \
244                 len--;                                                  \
245         buf[len++] = '\n';                                              \
246         buf[len] = '\0';                                                \
247         return len;                                                     \
248 }                                                                       \
249 static struct device_attribute dev_attr_##class##_##td_kv = {           \
250         .attr = {.name = __stringify(td_kv), .mode = S_IRUGO },         \
251         .show   = fw_show_##class##_##td_kv,                            \
252 };
253
254
255 #define fw_drv_attr(field, type, format_string)                 \
256 static ssize_t fw_drv_show_##field (struct device_driver *drv, char *buf) \
257 {                                                               \
258         struct hpsb_protocol_driver *driver;                    \
259         driver = container_of(drv, struct hpsb_protocol_driver, driver); \
260         return sprintf(buf, format_string, (type)driver->field);\
261 }                                                               \
262 static struct driver_attribute driver_attr_drv_##field = {      \
263         .attr = {.name = __stringify(field), .mode = S_IRUGO }, \
264         .show   = fw_drv_show_##field,                          \
265 };
266
267
268 static ssize_t fw_show_ne_bus_options(struct device *dev, struct device_attribute *attr, char *buf)
269 {
270         struct node_entry *ne = container_of(dev, struct node_entry, device);
271
272         return sprintf(buf, "IRMC(%d) CMC(%d) ISC(%d) BMC(%d) PMC(%d) GEN(%d) "
273                        "LSPD(%d) MAX_REC(%d) MAX_ROM(%d) CYC_CLK_ACC(%d)\n",
274                        ne->busopt.irmc,
275                        ne->busopt.cmc, ne->busopt.isc, ne->busopt.bmc,
276                        ne->busopt.pmc, ne->busopt.generation, ne->busopt.lnkspd,
277                        ne->busopt.max_rec,
278                        ne->busopt.max_rom,
279                        ne->busopt.cyc_clk_acc);
280 }
281 static DEVICE_ATTR(bus_options,S_IRUGO,fw_show_ne_bus_options,NULL);
282
283
284 static ssize_t fw_show_ne_tlabels_free(struct device *dev, struct device_attribute *attr, char *buf)
285 {
286         struct node_entry *ne = container_of(dev, struct node_entry, device);
287         return sprintf(buf, "%d\n", atomic_read(&ne->tpool->count.count) + 1);
288 }
289 static DEVICE_ATTR(tlabels_free,S_IRUGO,fw_show_ne_tlabels_free,NULL);
290
291
292 static ssize_t fw_show_ne_tlabels_allocations(struct device *dev, struct device_attribute *attr, char *buf)
293 {
294         struct node_entry *ne = container_of(dev, struct node_entry, device);
295         return sprintf(buf, "%u\n", ne->tpool->allocations);
296 }
297 static DEVICE_ATTR(tlabels_allocations,S_IRUGO,fw_show_ne_tlabels_allocations,NULL);
298
299
300 static ssize_t fw_show_ne_tlabels_mask(struct device *dev, struct device_attribute *attr, char *buf)
301 {
302         struct node_entry *ne = container_of(dev, struct node_entry, device);
303 #if (BITS_PER_LONG <= 32)
304         return sprintf(buf, "0x%08lx%08lx\n", ne->tpool->pool[0], ne->tpool->pool[1]);
305 #else
306         return sprintf(buf, "0x%016lx\n", ne->tpool->pool[0]);
307 #endif
308 }
309 static DEVICE_ATTR(tlabels_mask, S_IRUGO, fw_show_ne_tlabels_mask, NULL);
310
311
312 static ssize_t fw_set_ignore_driver(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
313 {
314         struct unit_directory *ud = container_of(dev, struct unit_directory, device);
315         int state = simple_strtoul(buf, NULL, 10);
316
317         if (state == 1) {
318                 down_write(&dev->bus->subsys.rwsem);
319                 device_release_driver(dev);
320                 ud->ignore_driver = 1;
321                 up_write(&dev->bus->subsys.rwsem);
322         } else if (!state)
323                 ud->ignore_driver = 0;
324
325         return count;
326 }
327 static ssize_t fw_get_ignore_driver(struct device *dev, struct device_attribute *attr, char *buf)
328 {
329         struct unit_directory *ud = container_of(dev, struct unit_directory, device);
330
331         return sprintf(buf, "%d\n", ud->ignore_driver);
332 }
333 static DEVICE_ATTR(ignore_driver, S_IWUSR | S_IRUGO, fw_get_ignore_driver, fw_set_ignore_driver);
334
335
336 static ssize_t fw_set_destroy_node(struct bus_type *bus, const char *buf, size_t count)
337 {
338         struct node_entry *ne;
339         u64 guid = (u64)simple_strtoull(buf, NULL, 16);
340
341         ne = find_entry_by_guid(guid);
342
343         if (ne == NULL || !ne->in_limbo)
344                 return -EINVAL;
345
346         nodemgr_remove_ne(ne);
347
348         return count;
349 }
350 static ssize_t fw_get_destroy_node(struct bus_type *bus, char *buf)
351 {
352         return sprintf(buf, "You can destroy in_limbo nodes by writing their GUID to this file\n");
353 }
354 static BUS_ATTR(destroy_node, S_IWUSR | S_IRUGO, fw_get_destroy_node, fw_set_destroy_node);
355
356 static int nodemgr_rescan_bus_thread(void *__unused)
357 {
358         /* No userlevel access needed */
359         daemonize("kfwrescan");
360
361         bus_rescan_devices(&ieee1394_bus_type);
362
363         return 0;
364 }
365
366 static ssize_t fw_set_rescan(struct bus_type *bus, const char *buf, size_t count)
367 {
368         int state = simple_strtoul(buf, NULL, 10);
369
370         /* Don't wait for this, or care about errors. Root could do
371          * something stupid and spawn this a lot of times, but that's
372          * root's fault. */
373         if (state == 1)
374                 kernel_thread(nodemgr_rescan_bus_thread, NULL, CLONE_KERNEL);
375
376         return count;
377 }
378 static ssize_t fw_get_rescan(struct bus_type *bus, char *buf)
379 {
380         return sprintf(buf, "You can force a rescan of the bus for "
381                         "drivers by writing a 1 to this file\n");
382 }
383 static BUS_ATTR(rescan, S_IWUSR | S_IRUGO, fw_get_rescan, fw_set_rescan);
384
385
386 static ssize_t fw_set_ignore_drivers(struct bus_type *bus, const char *buf, size_t count)
387 {
388         int state = simple_strtoul(buf, NULL, 10);
389
390         if (state == 1)
391                 ignore_drivers = 1;
392         else if (!state)
393                 ignore_drivers = 0;
394
395         return count;
396 }
397 static ssize_t fw_get_ignore_drivers(struct bus_type *bus, char *buf)
398 {
399         return sprintf(buf, "%d\n", ignore_drivers);
400 }
401 static BUS_ATTR(ignore_drivers, S_IWUSR | S_IRUGO, fw_get_ignore_drivers, fw_set_ignore_drivers);
402
403
404 struct bus_attribute *const fw_bus_attrs[] = {
405         &bus_attr_destroy_node,
406         &bus_attr_rescan,
407         &bus_attr_ignore_drivers,
408         NULL
409 };
410
411
412 fw_attr(ne, struct node_entry, capabilities, unsigned int, "0x%06x\n")
413 fw_attr(ne, struct node_entry, nodeid, unsigned int, "0x%04x\n")
414
415 fw_attr(ne, struct node_entry, vendor_id, unsigned int, "0x%06x\n")
416 fw_attr_td(ne, struct node_entry, vendor_name_kv)
417 fw_attr(ne, struct node_entry, vendor_oui, const char *, "%s\n")
418
419 fw_attr(ne, struct node_entry, guid, unsigned long long, "0x%016Lx\n")
420 fw_attr(ne, struct node_entry, guid_vendor_id, unsigned int, "0x%06x\n")
421 fw_attr(ne, struct node_entry, guid_vendor_oui, const char *, "%s\n")
422 fw_attr(ne, struct node_entry, in_limbo, int, "%d\n");
423
424 static struct device_attribute *const fw_ne_attrs[] = {
425         &dev_attr_ne_guid,
426         &dev_attr_ne_guid_vendor_id,
427         &dev_attr_ne_capabilities,
428         &dev_attr_ne_vendor_id,
429         &dev_attr_ne_nodeid,
430         &dev_attr_bus_options,
431         &dev_attr_tlabels_free,
432         &dev_attr_tlabels_allocations,
433         &dev_attr_tlabels_mask,
434 };
435
436
437
438 fw_attr(ud, struct unit_directory, address, unsigned long long, "0x%016Lx\n")
439 fw_attr(ud, struct unit_directory, length, int, "%d\n")
440 /* These are all dependent on the value being provided */
441 fw_attr(ud, struct unit_directory, vendor_id, unsigned int, "0x%06x\n")
442 fw_attr(ud, struct unit_directory, model_id, unsigned int, "0x%06x\n")
443 fw_attr(ud, struct unit_directory, specifier_id, unsigned int, "0x%06x\n")
444 fw_attr(ud, struct unit_directory, version, unsigned int, "0x%06x\n")
445 fw_attr_td(ud, struct unit_directory, vendor_name_kv)
446 fw_attr(ud, struct unit_directory, vendor_oui, const char *, "%s\n")
447 fw_attr_td(ud, struct unit_directory, model_name_kv)
448
449 static struct device_attribute *const fw_ud_attrs[] = {
450         &dev_attr_ud_address,
451         &dev_attr_ud_length,
452         &dev_attr_ignore_driver,
453 };
454
455
456 fw_attr(host, struct hpsb_host, node_count, int, "%d\n")
457 fw_attr(host, struct hpsb_host, selfid_count, int, "%d\n")
458 fw_attr(host, struct hpsb_host, nodes_active, int, "%d\n")
459 fw_attr(host, struct hpsb_host, in_bus_reset, int, "%d\n")
460 fw_attr(host, struct hpsb_host, is_root, int, "%d\n")
461 fw_attr(host, struct hpsb_host, is_cycmst, int, "%d\n")
462 fw_attr(host, struct hpsb_host, is_irm, int, "%d\n")
463 fw_attr(host, struct hpsb_host, is_busmgr, int, "%d\n")
464
465 static struct device_attribute *const fw_host_attrs[] = {
466         &dev_attr_host_node_count,
467         &dev_attr_host_selfid_count,
468         &dev_attr_host_nodes_active,
469         &dev_attr_host_in_bus_reset,
470         &dev_attr_host_is_root,
471         &dev_attr_host_is_cycmst,
472         &dev_attr_host_is_irm,
473         &dev_attr_host_is_busmgr,
474 };
475
476
477 static ssize_t fw_show_drv_device_ids(struct device_driver *drv, char *buf)
478 {
479         struct hpsb_protocol_driver *driver;
480         struct ieee1394_device_id *id;
481         int length = 0;
482         char *scratch = buf;
483
484         driver = container_of(drv, struct hpsb_protocol_driver, driver);
485
486         for (id = driver->id_table; id->match_flags != 0; id++) {
487                 int need_coma = 0;
488
489                 if (id->match_flags & IEEE1394_MATCH_VENDOR_ID) {
490                         length += sprintf(scratch, "vendor_id=0x%06x", id->vendor_id);
491                         scratch = buf + length;
492                         need_coma++;
493                 }
494
495                 if (id->match_flags & IEEE1394_MATCH_MODEL_ID) {
496                         length += sprintf(scratch, "%smodel_id=0x%06x",
497                                           need_coma++ ? "," : "",
498                                           id->model_id);
499                         scratch = buf + length;
500                 }
501
502                 if (id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) {
503                         length += sprintf(scratch, "%sspecifier_id=0x%06x",
504                                           need_coma++ ? "," : "",
505                                           id->specifier_id);
506                         scratch = buf + length;
507                 }
508
509                 if (id->match_flags & IEEE1394_MATCH_VERSION) {
510                         length += sprintf(scratch, "%sversion=0x%06x",
511                                           need_coma++ ? "," : "",
512                                           id->version);
513                         scratch = buf + length;
514                 }
515
516                 if (need_coma) {
517                         *scratch++ = '\n';
518                         length++;
519                 }
520         }
521
522         return length;
523 }
524 static DRIVER_ATTR(device_ids,S_IRUGO,fw_show_drv_device_ids,NULL);
525
526
527 fw_drv_attr(name, const char *, "%s\n")
528
529 static struct driver_attribute *const fw_drv_attrs[] = {
530         &driver_attr_drv_name,
531         &driver_attr_device_ids,
532 };
533
534
535 static void nodemgr_create_drv_files(struct hpsb_protocol_driver *driver)
536 {
537         struct device_driver *drv = &driver->driver;
538         int i;
539
540         for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
541                 driver_create_file(drv, fw_drv_attrs[i]);
542 }
543
544
545 static void nodemgr_remove_drv_files(struct hpsb_protocol_driver *driver)
546 {
547         struct device_driver *drv = &driver->driver;
548         int i;
549
550         for (i = 0; i < ARRAY_SIZE(fw_drv_attrs); i++)
551                 driver_remove_file(drv, fw_drv_attrs[i]);
552 }
553
554
555 static void nodemgr_create_ne_dev_files(struct node_entry *ne)
556 {
557         struct device *dev = &ne->device;
558         int i;
559
560         for (i = 0; i < ARRAY_SIZE(fw_ne_attrs); i++)
561                 device_create_file(dev, fw_ne_attrs[i]);
562 }
563
564
565 static void nodemgr_create_host_dev_files(struct hpsb_host *host)
566 {
567         struct device *dev = &host->device;
568         int i;
569
570         for (i = 0; i < ARRAY_SIZE(fw_host_attrs); i++)
571                 device_create_file(dev, fw_host_attrs[i]);
572 }
573
574
575 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host, nodeid_t nodeid);
576
577 static void nodemgr_update_host_dev_links(struct hpsb_host *host)
578 {
579         struct device *dev = &host->device;
580         struct node_entry *ne;
581
582         sysfs_remove_link(&dev->kobj, "irm_id");
583         sysfs_remove_link(&dev->kobj, "busmgr_id");
584         sysfs_remove_link(&dev->kobj, "host_id");
585
586         if ((ne = find_entry_by_nodeid(host, host->irm_id)))
587                 sysfs_create_link(&dev->kobj, &ne->device.kobj, "irm_id");
588         if ((ne = find_entry_by_nodeid(host, host->busmgr_id)))
589                 sysfs_create_link(&dev->kobj, &ne->device.kobj, "busmgr_id");
590         if ((ne = find_entry_by_nodeid(host, host->node_id)))
591                 sysfs_create_link(&dev->kobj, &ne->device.kobj, "host_id");
592 }
593
594 static void nodemgr_create_ud_dev_files(struct unit_directory *ud)
595 {
596         struct device *dev = &ud->device;
597         int i;
598
599         for (i = 0; i < ARRAY_SIZE(fw_ud_attrs); i++)
600                 device_create_file(dev, fw_ud_attrs[i]);
601
602         if (ud->flags & UNIT_DIRECTORY_SPECIFIER_ID)
603                 device_create_file(dev, &dev_attr_ud_specifier_id);
604
605         if (ud->flags & UNIT_DIRECTORY_VERSION)
606                 device_create_file(dev, &dev_attr_ud_version);
607
608         if (ud->flags & UNIT_DIRECTORY_VENDOR_ID) {
609                 device_create_file(dev, &dev_attr_ud_vendor_id);
610                 if (ud->vendor_name_kv)
611                         device_create_file(dev, &dev_attr_ud_vendor_name_kv);
612         }
613
614         if (ud->flags & UNIT_DIRECTORY_MODEL_ID) {
615                 device_create_file(dev, &dev_attr_ud_model_id);
616                 if (ud->model_name_kv)
617                         device_create_file(dev, &dev_attr_ud_model_name_kv);
618         }
619 }
620
621
622 static int nodemgr_bus_match(struct device * dev, struct device_driver * drv)
623 {
624         struct hpsb_protocol_driver *driver;
625         struct unit_directory *ud;
626         struct ieee1394_device_id *id;
627
628         /* We only match unit directories */
629         if (dev->platform_data != &nodemgr_ud_platform_data)
630                 return 0;
631
632         ud = container_of(dev, struct unit_directory, device);
633         driver = container_of(drv, struct hpsb_protocol_driver, driver);
634
635         if (ud->ne->in_limbo || ud->ignore_driver)
636                 return 0;
637
638         for (id = driver->id_table; id->match_flags != 0; id++) {
639                 if ((id->match_flags & IEEE1394_MATCH_VENDOR_ID) &&
640                     id->vendor_id != ud->vendor_id)
641                         continue;
642
643                 if ((id->match_flags & IEEE1394_MATCH_MODEL_ID) &&
644                     id->model_id != ud->model_id)
645                         continue;
646
647                 if ((id->match_flags & IEEE1394_MATCH_SPECIFIER_ID) &&
648                     id->specifier_id != ud->specifier_id)
649                         continue;
650
651                 if ((id->match_flags & IEEE1394_MATCH_VERSION) &&
652                     id->version != ud->version)
653                         continue;
654
655                 return 1;
656         }
657
658         return 0;
659 }
660
661
662 static void nodemgr_remove_uds(struct node_entry *ne)
663 {
664         struct class_device *cdev, *next;
665         struct unit_directory *ud;
666
667         list_for_each_entry_safe(cdev, next, &nodemgr_ud_class.children, node) {
668                 ud = container_of(cdev, struct unit_directory, class_dev);
669
670                 if (ud->ne != ne)
671                         continue;
672
673                 class_device_unregister(&ud->class_dev);
674                 device_unregister(&ud->device);
675         }
676 }
677
678
679 static void nodemgr_remove_ne(struct node_entry *ne)
680 {
681         struct device *dev = &ne->device;
682
683         dev = get_device(&ne->device);
684         if (!dev)
685                 return;
686
687         HPSB_DEBUG("Node removed: ID:BUS[" NODE_BUS_FMT "]  GUID[%016Lx]",
688                    NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
689
690         nodemgr_remove_uds(ne);
691
692         class_device_unregister(&ne->class_dev);
693         device_unregister(dev);
694
695         put_device(dev);
696 }
697
698 static int __nodemgr_remove_host_dev(struct device *dev, void *data)
699 {
700         nodemgr_remove_ne(container_of(dev, struct node_entry, device));
701         return 0;
702 }
703
704 static void nodemgr_remove_host_dev(struct device *dev)
705 {
706         device_for_each_child(dev, NULL, __nodemgr_remove_host_dev);
707         sysfs_remove_link(&dev->kobj, "irm_id");
708         sysfs_remove_link(&dev->kobj, "busmgr_id");
709         sysfs_remove_link(&dev->kobj, "host_id");
710 }
711
712
713 static void nodemgr_update_bus_options(struct node_entry *ne)
714 {
715 #ifdef CONFIG_IEEE1394_VERBOSEDEBUG
716         static const u16 mr[] = { 4, 64, 1024, 0};
717 #endif
718         quadlet_t busoptions = be32_to_cpu(ne->csr->bus_info_data[2]);
719
720         ne->busopt.irmc         = (busoptions >> 31) & 1;
721         ne->busopt.cmc          = (busoptions >> 30) & 1;
722         ne->busopt.isc          = (busoptions >> 29) & 1;
723         ne->busopt.bmc          = (busoptions >> 28) & 1;
724         ne->busopt.pmc          = (busoptions >> 27) & 1;
725         ne->busopt.cyc_clk_acc  = (busoptions >> 16) & 0xff;
726         ne->busopt.max_rec      = 1 << (((busoptions >> 12) & 0xf) + 1);
727         ne->busopt.max_rom      = (busoptions >> 8) & 0x3;
728         ne->busopt.generation   = (busoptions >> 4) & 0xf;
729         ne->busopt.lnkspd       = busoptions & 0x7;
730
731         HPSB_VERBOSE("NodeMgr: raw=0x%08x irmc=%d cmc=%d isc=%d bmc=%d pmc=%d "
732                      "cyc_clk_acc=%d max_rec=%d max_rom=%d gen=%d lspd=%d",
733                      busoptions, ne->busopt.irmc, ne->busopt.cmc,
734                      ne->busopt.isc, ne->busopt.bmc, ne->busopt.pmc,
735                      ne->busopt.cyc_clk_acc, ne->busopt.max_rec,
736                      mr[ne->busopt.max_rom],
737                      ne->busopt.generation, ne->busopt.lnkspd);
738 }
739
740
741 static struct node_entry *nodemgr_create_node(octlet_t guid, struct csr1212_csr *csr,
742                                               struct host_info *hi, nodeid_t nodeid,
743                                               unsigned int generation)
744 {
745         struct hpsb_host *host = hi->host;
746         struct node_entry *ne;
747
748         ne = kzalloc(sizeof(*ne), GFP_KERNEL);
749         if (!ne)
750                 return NULL;
751
752         ne->tpool = &host->tpool[nodeid & NODE_MASK];
753
754         ne->host = host;
755         ne->nodeid = nodeid;
756         ne->generation = generation;
757         ne->needs_probe = 1;
758
759         ne->guid = guid;
760         ne->guid_vendor_id = (guid >> 40) & 0xffffff;
761         ne->guid_vendor_oui = nodemgr_find_oui_name(ne->guid_vendor_id);
762         ne->csr = csr;
763
764         memcpy(&ne->device, &nodemgr_dev_template_ne,
765                sizeof(ne->device));
766         ne->device.parent = &host->device;
767         snprintf(ne->device.bus_id, BUS_ID_SIZE, "%016Lx",
768                  (unsigned long long)(ne->guid));
769
770         ne->class_dev.dev = &ne->device;
771         ne->class_dev.class = &nodemgr_ne_class;
772         snprintf(ne->class_dev.class_id, BUS_ID_SIZE, "%016Lx",
773                  (unsigned long long)(ne->guid));
774
775         device_register(&ne->device);
776         class_device_register(&ne->class_dev);
777         get_device(&ne->device);
778
779         if (ne->guid_vendor_oui)
780                 device_create_file(&ne->device, &dev_attr_ne_guid_vendor_oui);
781         nodemgr_create_ne_dev_files(ne);
782
783         nodemgr_update_bus_options(ne);
784
785         HPSB_DEBUG("%s added: ID:BUS[" NODE_BUS_FMT "]  GUID[%016Lx]",
786                    (host->node_id == nodeid) ? "Host" : "Node",
787                    NODE_BUS_ARGS(host, nodeid), (unsigned long long)guid);
788
789         return ne;
790 }
791
792
793 static struct node_entry *find_entry_by_guid(u64 guid)
794 {
795         struct class *class = &nodemgr_ne_class;
796         struct class_device *cdev;
797         struct node_entry *ne, *ret_ne = NULL;
798
799         down_read(&class->subsys.rwsem);
800         list_for_each_entry(cdev, &class->children, node) {
801                 ne = container_of(cdev, struct node_entry, class_dev);
802
803                 if (ne->guid == guid) {
804                         ret_ne = ne;
805                         break;
806                 }
807         }
808         up_read(&class->subsys.rwsem);
809
810         return ret_ne;
811 }
812
813
814 static struct node_entry *find_entry_by_nodeid(struct hpsb_host *host, nodeid_t nodeid)
815 {
816         struct class *class = &nodemgr_ne_class;
817         struct class_device *cdev;
818         struct node_entry *ne, *ret_ne = NULL;
819
820         down_read(&class->subsys.rwsem);
821         list_for_each_entry(cdev, &class->children, node) {
822                 ne = container_of(cdev, struct node_entry, class_dev);
823
824                 if (ne->host == host && ne->nodeid == nodeid) {
825                         ret_ne = ne;
826                         break;
827                 }
828         }
829         up_read(&class->subsys.rwsem);
830
831         return ret_ne;
832 }
833
834
835 static void nodemgr_register_device(struct node_entry *ne, 
836         struct unit_directory *ud, struct device *parent)
837 {
838         memcpy(&ud->device, &nodemgr_dev_template_ud,
839                sizeof(ud->device));
840
841         ud->device.parent = parent;
842
843         snprintf(ud->device.bus_id, BUS_ID_SIZE, "%s-%u",
844                  ne->device.bus_id, ud->id);
845
846         ud->class_dev.dev = &ud->device;
847         ud->class_dev.class = &nodemgr_ud_class;
848         snprintf(ud->class_dev.class_id, BUS_ID_SIZE, "%s-%u",
849                  ne->device.bus_id, ud->id);
850
851         device_register(&ud->device);
852         class_device_register(&ud->class_dev);
853         get_device(&ud->device);
854
855         if (ud->vendor_oui)
856                 device_create_file(&ud->device, &dev_attr_ud_vendor_oui);
857         nodemgr_create_ud_dev_files(ud);
858 }       
859
860
861 /* This implementation currently only scans the config rom and its
862  * immediate unit directories looking for software_id and
863  * software_version entries, in order to get driver autoloading working. */
864 static struct unit_directory *nodemgr_process_unit_directory
865         (struct host_info *hi, struct node_entry *ne, struct csr1212_keyval *ud_kv,
866          unsigned int *id, struct unit_directory *parent)
867 {
868         struct unit_directory *ud;
869         struct unit_directory *ud_child = NULL;
870         struct csr1212_dentry *dentry;
871         struct csr1212_keyval *kv;
872         u8 last_key_id = 0;
873
874         ud = kzalloc(sizeof(*ud), GFP_KERNEL);
875         if (!ud)
876                 goto unit_directory_error;
877
878         ud->ne = ne;
879         ud->ignore_driver = ignore_drivers;
880         ud->address = ud_kv->offset + CSR1212_CONFIG_ROM_SPACE_BASE;
881         ud->ud_kv = ud_kv;
882         ud->id = (*id)++;
883
884         csr1212_for_each_dir_entry(ne->csr, kv, ud_kv, dentry) {
885                 switch (kv->key.id) {
886                 case CSR1212_KV_ID_VENDOR:
887                         if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
888                                 ud->vendor_id = kv->value.immediate;
889                                 ud->flags |= UNIT_DIRECTORY_VENDOR_ID;
890
891                                 if (ud->vendor_id)
892                                         ud->vendor_oui = nodemgr_find_oui_name(ud->vendor_id);
893                         }
894                         break;
895
896                 case CSR1212_KV_ID_MODEL:
897                         ud->model_id = kv->value.immediate;
898                         ud->flags |= UNIT_DIRECTORY_MODEL_ID;
899                         break;
900
901                 case CSR1212_KV_ID_SPECIFIER_ID:
902                         ud->specifier_id = kv->value.immediate;
903                         ud->flags |= UNIT_DIRECTORY_SPECIFIER_ID;
904                         break;
905
906                 case CSR1212_KV_ID_VERSION:
907                         ud->version = kv->value.immediate;
908                         ud->flags |= UNIT_DIRECTORY_VERSION;
909                         break;
910
911                 case CSR1212_KV_ID_DESCRIPTOR:
912                         if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
913                             CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
914                             CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
915                             CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
916                             CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
917                             CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
918                                 switch (last_key_id) {
919                                 case CSR1212_KV_ID_VENDOR:
920                                         ud->vendor_name_kv = kv;
921                                         csr1212_keep_keyval(kv);
922                                         break;
923
924                                 case CSR1212_KV_ID_MODEL:
925                                         ud->model_name_kv = kv;
926                                         csr1212_keep_keyval(kv);
927                                         break;
928
929                                 }
930                         } /* else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) ... */
931                         break;
932
933                 case CSR1212_KV_ID_DEPENDENT_INFO:
934                         /* Logical Unit Number */
935                         if (kv->key.type == CSR1212_KV_TYPE_IMMEDIATE) {
936                                 if (ud->flags & UNIT_DIRECTORY_HAS_LUN) {
937                                         ud_child = kmalloc(sizeof(*ud_child), GFP_KERNEL);
938                                         if (!ud_child)
939                                                 goto unit_directory_error;
940                                         memcpy(ud_child, ud, sizeof(*ud_child));
941                                         nodemgr_register_device(ne, ud_child, &ne->device);
942                                         ud_child = NULL;
943                                         
944                                         ud->id = (*id)++;
945                                 }
946                                 ud->lun = kv->value.immediate;
947                                 ud->flags |= UNIT_DIRECTORY_HAS_LUN;
948
949                         /* Logical Unit Directory */
950                         } else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) {
951                                 /* This should really be done in SBP2 as this is
952                                  * doing SBP2 specific parsing.
953                                  */
954                                 
955                                 /* first register the parent unit */
956                                 ud->flags |= UNIT_DIRECTORY_HAS_LUN_DIRECTORY;
957                                 if (ud->device.bus != &ieee1394_bus_type)
958                                         nodemgr_register_device(ne, ud, &ne->device);
959                                 
960                                 /* process the child unit */
961                                 ud_child = nodemgr_process_unit_directory(hi, ne, kv, id, ud);
962
963                                 if (ud_child == NULL)
964                                         break;
965                                 
966                                 /* inherit unspecified values, the driver core picks it up */
967                                 if ((ud->flags & UNIT_DIRECTORY_MODEL_ID) &&
968                                     !(ud_child->flags & UNIT_DIRECTORY_MODEL_ID))
969                                 {
970                                         ud_child->flags |=  UNIT_DIRECTORY_MODEL_ID;
971                                         ud_child->model_id = ud->model_id;
972                                 }
973                                 if ((ud->flags & UNIT_DIRECTORY_SPECIFIER_ID) &&
974                                     !(ud_child->flags & UNIT_DIRECTORY_SPECIFIER_ID))
975                                 {
976                                         ud_child->flags |=  UNIT_DIRECTORY_SPECIFIER_ID;
977                                         ud_child->specifier_id = ud->specifier_id;
978                                 }
979                                 if ((ud->flags & UNIT_DIRECTORY_VERSION) &&
980                                     !(ud_child->flags & UNIT_DIRECTORY_VERSION))
981                                 {
982                                         ud_child->flags |=  UNIT_DIRECTORY_VERSION;
983                                         ud_child->version = ud->version;
984                                 }
985                                 
986                                 /* register the child unit */
987                                 ud_child->flags |= UNIT_DIRECTORY_LUN_DIRECTORY;
988                                 nodemgr_register_device(ne, ud_child, &ud->device);
989                         }
990
991                         break;
992
993                 default:
994                         break;
995                 }
996                 last_key_id = kv->key.id;
997         }
998         
999         /* do not process child units here and only if not already registered */
1000         if (!parent && ud->device.bus != &ieee1394_bus_type)
1001                 nodemgr_register_device(ne, ud, &ne->device);
1002
1003         return ud;
1004
1005 unit_directory_error:
1006         kfree(ud);
1007         return NULL;
1008 }
1009
1010
1011 static void nodemgr_process_root_directory(struct host_info *hi, struct node_entry *ne)
1012 {
1013         unsigned int ud_id = 0;
1014         struct csr1212_dentry *dentry;
1015         struct csr1212_keyval *kv;
1016         u8 last_key_id = 0;
1017
1018         ne->needs_probe = 0;
1019
1020         csr1212_for_each_dir_entry(ne->csr, kv, ne->csr->root_kv, dentry) {
1021                 switch (kv->key.id) {
1022                 case CSR1212_KV_ID_VENDOR:
1023                         ne->vendor_id = kv->value.immediate;
1024
1025                         if (ne->vendor_id)
1026                                 ne->vendor_oui = nodemgr_find_oui_name(ne->vendor_id);
1027                         break;
1028
1029                 case CSR1212_KV_ID_NODE_CAPABILITIES:
1030                         ne->capabilities = kv->value.immediate;
1031                         break;
1032
1033                 case CSR1212_KV_ID_UNIT:
1034                         nodemgr_process_unit_directory(hi, ne, kv, &ud_id, NULL);
1035                         break;
1036
1037                 case CSR1212_KV_ID_DESCRIPTOR:
1038                         if (last_key_id == CSR1212_KV_ID_VENDOR) {
1039                                 if (kv->key.type == CSR1212_KV_TYPE_LEAF &&
1040                                     CSR1212_DESCRIPTOR_LEAF_TYPE(kv) == 0 &&
1041                                     CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv) == 0 &&
1042                                     CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv) == 0 &&
1043                                     CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv) == 0 &&
1044                                     CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv) == 0) {
1045                                         ne->vendor_name_kv = kv;
1046                                         csr1212_keep_keyval(kv);
1047                                 }
1048                         }
1049                         break;
1050                 }
1051                 last_key_id = kv->key.id;
1052         }
1053
1054         if (ne->vendor_oui)
1055                 device_create_file(&ne->device, &dev_attr_ne_vendor_oui);
1056         if (ne->vendor_name_kv)
1057                 device_create_file(&ne->device, &dev_attr_ne_vendor_name_kv);
1058 }
1059
1060 #ifdef CONFIG_HOTPLUG
1061
1062 static int nodemgr_uevent(struct class_device *cdev, char **envp, int num_envp,
1063                           char *buffer, int buffer_size)
1064 {
1065         struct unit_directory *ud;
1066         int i = 0;
1067         int length = 0;
1068         /* ieee1394:venNmoNspNverN */
1069         char buf[8 + 1 + 3 + 8 + 2 + 8 + 2 + 8 + 3 + 8 + 1];
1070
1071         if (!cdev)
1072                 return -ENODEV;
1073
1074         ud = container_of(cdev, struct unit_directory, class_dev);
1075
1076         if (ud->ne->in_limbo || ud->ignore_driver)
1077                 return -ENODEV;
1078
1079 #define PUT_ENVP(fmt,val)                                       \
1080 do {                                                            \
1081         int printed;                                            \
1082         envp[i++] = buffer;                                     \
1083         printed = snprintf(buffer, buffer_size - length,        \
1084                            fmt, val);                           \
1085         if ((buffer_size - (length+printed) <= 0) || (i >= num_envp))   \
1086                 return -ENOMEM;                                 \
1087         length += printed+1;                                    \
1088         buffer += printed+1;                                    \
1089 } while (0)
1090
1091         PUT_ENVP("VENDOR_ID=%06x", ud->vendor_id);
1092         PUT_ENVP("MODEL_ID=%06x", ud->model_id);
1093         PUT_ENVP("GUID=%016Lx", (unsigned long long)ud->ne->guid);
1094         PUT_ENVP("SPECIFIER_ID=%06x", ud->specifier_id);
1095         PUT_ENVP("VERSION=%06x", ud->version);
1096         snprintf(buf, sizeof(buf), "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
1097                         ud->vendor_id,
1098                         ud->model_id,
1099                         ud->specifier_id,
1100                         ud->version);
1101         PUT_ENVP("MODALIAS=%s", buf);
1102
1103 #undef PUT_ENVP
1104
1105         envp[i] = NULL;
1106
1107         return 0;
1108 }
1109
1110 #else
1111
1112 static int nodemgr_uevent(struct class_device *cdev, char **envp, int num_envp,
1113                           char *buffer, int buffer_size)
1114 {
1115         return -ENODEV;
1116 }
1117
1118 #endif /* CONFIG_HOTPLUG */
1119
1120
1121 int hpsb_register_protocol(struct hpsb_protocol_driver *driver)
1122 {
1123         int ret;
1124
1125         /* This will cause a probe for devices */
1126         ret = driver_register(&driver->driver);
1127         if (!ret)
1128                 nodemgr_create_drv_files(driver);
1129
1130         return ret;
1131 }
1132
1133 void hpsb_unregister_protocol(struct hpsb_protocol_driver *driver)
1134 {
1135         nodemgr_remove_drv_files(driver);
1136         /* This will subsequently disconnect all devices that our driver
1137          * is attached to. */
1138         driver_unregister(&driver->driver);
1139 }
1140
1141
1142 /*
1143  * This function updates nodes that were present on the bus before the
1144  * reset and still are after the reset.  The nodeid and the config rom
1145  * may have changed, and the drivers managing this device must be
1146  * informed that this device just went through a bus reset, to allow
1147  * the to take whatever actions required.
1148  */
1149 static void nodemgr_update_node(struct node_entry *ne, struct csr1212_csr *csr,
1150                                 struct host_info *hi, nodeid_t nodeid,
1151                                 unsigned int generation)
1152 {
1153         if (ne->nodeid != nodeid) {
1154                 HPSB_DEBUG("Node changed: " NODE_BUS_FMT " -> " NODE_BUS_FMT,
1155                            NODE_BUS_ARGS(ne->host, ne->nodeid),
1156                            NODE_BUS_ARGS(ne->host, nodeid));
1157                 ne->nodeid = nodeid;
1158         }
1159
1160         if (ne->busopt.generation != ((be32_to_cpu(csr->bus_info_data[2]) >> 4) & 0xf)) {
1161                 kfree(ne->csr->private);
1162                 csr1212_destroy_csr(ne->csr);
1163                 ne->csr = csr;
1164
1165                 /* If the node's configrom generation has changed, we
1166                  * unregister all the unit directories. */
1167                 nodemgr_remove_uds(ne);
1168
1169                 nodemgr_update_bus_options(ne);
1170
1171                 /* Mark the node as new, so it gets re-probed */
1172                 ne->needs_probe = 1;
1173         } else {
1174                 /* old cache is valid, so update its generation */
1175                 struct nodemgr_csr_info *ci = ne->csr->private;
1176                 ci->generation = generation;
1177                 /* free the partially filled now unneeded new cache */
1178                 kfree(csr->private);
1179                 csr1212_destroy_csr(csr);
1180         }
1181
1182         if (ne->in_limbo)
1183                 nodemgr_resume_ne(ne);
1184
1185         /* Mark the node current */
1186         ne->generation = generation;
1187 }
1188
1189
1190
1191 static void nodemgr_node_scan_one(struct host_info *hi,
1192                                   nodeid_t nodeid, int generation)
1193 {
1194         struct hpsb_host *host = hi->host;
1195         struct node_entry *ne;
1196         octlet_t guid;
1197         struct csr1212_csr *csr;
1198         struct nodemgr_csr_info *ci;
1199
1200         ci = kmalloc(sizeof(*ci), GFP_KERNEL);
1201         if (!ci)
1202                 return;
1203
1204         ci->host = host;
1205         ci->nodeid = nodeid;
1206         ci->generation = generation;
1207
1208         /* We need to detect when the ConfigROM's generation has changed,
1209          * so we only update the node's info when it needs to be.  */
1210
1211         csr = csr1212_create_csr(&nodemgr_csr_ops, 5 * sizeof(quadlet_t), ci);
1212         if (!csr || csr1212_parse_csr(csr) != CSR1212_SUCCESS) {
1213                 HPSB_ERR("Error parsing configrom for node " NODE_BUS_FMT,
1214                          NODE_BUS_ARGS(host, nodeid));
1215                 if (csr)
1216                         csr1212_destroy_csr(csr);
1217                 kfree(ci);
1218                 return;
1219         }
1220
1221         if (csr->bus_info_data[1] != IEEE1394_BUSID_MAGIC) {
1222                 /* This isn't a 1394 device, but we let it slide. There
1223                  * was a report of a device with broken firmware which
1224                  * reported '2394' instead of '1394', which is obviously a
1225                  * mistake. One would hope that a non-1394 device never
1226                  * gets connected to Firewire bus. If someone does, we
1227                  * shouldn't be held responsible, so we'll allow it with a
1228                  * warning.  */
1229                 HPSB_WARN("Node " NODE_BUS_FMT " has invalid busID magic [0x%08x]",
1230                           NODE_BUS_ARGS(host, nodeid), csr->bus_info_data[1]);
1231         }
1232
1233         guid = ((u64)be32_to_cpu(csr->bus_info_data[3]) << 32) | be32_to_cpu(csr->bus_info_data[4]);
1234         ne = find_entry_by_guid(guid);
1235
1236         if (ne && ne->host != host && ne->in_limbo) {
1237                 /* Must have moved this device from one host to another */
1238                 nodemgr_remove_ne(ne);
1239                 ne = NULL;
1240         }
1241
1242         if (!ne)
1243                 nodemgr_create_node(guid, csr, hi, nodeid, generation);
1244         else
1245                 nodemgr_update_node(ne, csr, hi, nodeid, generation);
1246
1247         return;
1248 }
1249
1250
1251 static void nodemgr_node_scan(struct host_info *hi, int generation)
1252 {
1253         int count;
1254         struct hpsb_host *host = hi->host;
1255         struct selfid *sid = (struct selfid *)host->topology_map;
1256         nodeid_t nodeid = LOCAL_BUS;
1257
1258         /* Scan each node on the bus */
1259         for (count = host->selfid_count; count; count--, sid++) {
1260                 if (sid->extended)
1261                         continue;
1262
1263                 if (!sid->link_active) {
1264                         nodeid++;
1265                         continue;
1266                 }
1267                 nodemgr_node_scan_one(hi, nodeid++, generation);
1268         }
1269 }
1270
1271
1272 static void nodemgr_suspend_ne(struct node_entry *ne)
1273 {
1274         struct class_device *cdev;
1275         struct unit_directory *ud;
1276
1277         HPSB_DEBUG("Node suspended: ID:BUS[" NODE_BUS_FMT "]  GUID[%016Lx]",
1278                    NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
1279
1280         ne->in_limbo = 1;
1281         device_create_file(&ne->device, &dev_attr_ne_in_limbo);
1282
1283         down_write(&ne->device.bus->subsys.rwsem);
1284         list_for_each_entry(cdev, &nodemgr_ud_class.children, node) {
1285                 ud = container_of(cdev, struct unit_directory, class_dev);
1286
1287                 if (ud->ne != ne)
1288                         continue;
1289
1290                 if (ud->device.driver &&
1291                     (!ud->device.driver->suspend ||
1292                       ud->device.driver->suspend(&ud->device, PMSG_SUSPEND)))
1293                         device_release_driver(&ud->device);
1294         }
1295         up_write(&ne->device.bus->subsys.rwsem);
1296 }
1297
1298
1299 static void nodemgr_resume_ne(struct node_entry *ne)
1300 {
1301         struct class_device *cdev;
1302         struct unit_directory *ud;
1303
1304         ne->in_limbo = 0;
1305         device_remove_file(&ne->device, &dev_attr_ne_in_limbo);
1306
1307         down_read(&ne->device.bus->subsys.rwsem);
1308         list_for_each_entry(cdev, &nodemgr_ud_class.children, node) {
1309                 ud = container_of(cdev, struct unit_directory, class_dev);
1310
1311                 if (ud->ne != ne)
1312                         continue;
1313
1314                 if (ud->device.driver && ud->device.driver->resume)
1315                         ud->device.driver->resume(&ud->device);
1316         }
1317         up_read(&ne->device.bus->subsys.rwsem);
1318
1319         HPSB_DEBUG("Node resumed: ID:BUS[" NODE_BUS_FMT "]  GUID[%016Lx]",
1320                    NODE_BUS_ARGS(ne->host, ne->nodeid), (unsigned long long)ne->guid);
1321 }
1322
1323
1324 static void nodemgr_update_pdrv(struct node_entry *ne)
1325 {
1326         struct unit_directory *ud;
1327         struct hpsb_protocol_driver *pdrv;
1328         struct class *class = &nodemgr_ud_class;
1329         struct class_device *cdev;
1330
1331         down_read(&class->subsys.rwsem);
1332         list_for_each_entry(cdev, &class->children, node) {
1333                 ud = container_of(cdev, struct unit_directory, class_dev);
1334                 if (ud->ne != ne || !ud->device.driver)
1335                         continue;
1336
1337                 pdrv = container_of(ud->device.driver, struct hpsb_protocol_driver, driver);
1338
1339                 if (pdrv->update && pdrv->update(ud)) {
1340                         down_write(&ud->device.bus->subsys.rwsem);
1341                         device_release_driver(&ud->device);
1342                         up_write(&ud->device.bus->subsys.rwsem);
1343                 }
1344         }
1345         up_read(&class->subsys.rwsem);
1346 }
1347
1348
1349 /* Write the BROADCAST_CHANNEL as per IEEE1394a 8.3.2.3.11 and 8.4.2.3.  This
1350  * seems like an optional service but in the end it is practically mandatory
1351  * as a consequence of these clauses.
1352  *
1353  * Note that we cannot do a broadcast write to all nodes at once because some
1354  * pre-1394a devices would hang. */
1355 static void nodemgr_irm_write_bc(struct node_entry *ne, int generation)
1356 {
1357         const u64 bc_addr = (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL);
1358         quadlet_t bc_remote, bc_local;
1359         int ret;
1360
1361         if (!ne->host->is_irm || ne->generation != generation ||
1362             ne->nodeid == ne->host->node_id)
1363                 return;
1364
1365         bc_local = cpu_to_be32(ne->host->csr.broadcast_channel);
1366
1367         /* Check if the register is implemented and 1394a compliant. */
1368         ret = hpsb_read(ne->host, ne->nodeid, generation, bc_addr, &bc_remote,
1369                         sizeof(bc_remote));
1370         if (!ret && bc_remote & cpu_to_be32(0x80000000) &&
1371             bc_remote != bc_local)
1372                 hpsb_node_write(ne, bc_addr, &bc_local, sizeof(bc_local));
1373 }
1374
1375
1376 static void nodemgr_probe_ne(struct host_info *hi, struct node_entry *ne, int generation)
1377 {
1378         struct device *dev;
1379
1380         if (ne->host != hi->host || ne->in_limbo)
1381                 return;
1382
1383         dev = get_device(&ne->device);
1384         if (!dev)
1385                 return;
1386
1387         nodemgr_irm_write_bc(ne, generation);
1388
1389         /* If "needs_probe", then this is either a new or changed node we
1390          * rescan totally. If the generation matches for an existing node
1391          * (one that existed prior to the bus reset) we send update calls
1392          * down to the drivers. Otherwise, this is a dead node and we
1393          * suspend it. */
1394         if (ne->needs_probe)
1395                 nodemgr_process_root_directory(hi, ne);
1396         else if (ne->generation == generation)
1397                 nodemgr_update_pdrv(ne);
1398         else
1399                 nodemgr_suspend_ne(ne);
1400
1401         put_device(dev);
1402 }
1403
1404
1405 static void nodemgr_node_probe(struct host_info *hi, int generation)
1406 {
1407         struct hpsb_host *host = hi->host;
1408         struct class *class = &nodemgr_ne_class;
1409         struct class_device *cdev;
1410         struct node_entry *ne;
1411
1412         /* Do some processing of the nodes we've probed. This pulls them
1413          * into the sysfs layer if needed, and can result in processing of
1414          * unit-directories, or just updating the node and it's
1415          * unit-directories.
1416          *
1417          * Run updates before probes. Usually, updates are time-critical
1418          * while probes are time-consuming. (Well, those probes need some
1419          * improvement...) */
1420
1421         down_read(&class->subsys.rwsem);
1422         list_for_each_entry(cdev, &class->children, node) {
1423                 ne = container_of(cdev, struct node_entry, class_dev);
1424                 if (!ne->needs_probe)
1425                         nodemgr_probe_ne(hi, ne, generation);
1426         }
1427         list_for_each_entry(cdev, &class->children, node) {
1428                 ne = container_of(cdev, struct node_entry, class_dev);
1429                 if (ne->needs_probe)
1430                         nodemgr_probe_ne(hi, ne, generation);
1431         }
1432         up_read(&class->subsys.rwsem);
1433
1434
1435         /* If we had a bus reset while we were scanning the bus, it is
1436          * possible that we did not probe all nodes.  In that case, we
1437          * skip the clean up for now, since we could remove nodes that
1438          * were still on the bus.  The bus reset increased hi->reset_sem,
1439          * so there's a bus scan pending which will do the clean up
1440          * eventually.
1441          *
1442          * Now let's tell the bus to rescan our devices. This may seem
1443          * like overhead, but the driver-model core will only scan a
1444          * device for a driver when either the device is added, or when a
1445          * new driver is added. A bus reset is a good reason to rescan
1446          * devices that were there before.  For example, an sbp2 device
1447          * may become available for login, if the host that held it was
1448          * just removed.  */
1449
1450         if (generation == get_hpsb_generation(host))
1451                 bus_rescan_devices(&ieee1394_bus_type);
1452
1453         return;
1454 }
1455
1456 static int nodemgr_send_resume_packet(struct hpsb_host *host)
1457 {
1458         struct hpsb_packet *packet;
1459         int ret = 1;
1460
1461         packet = hpsb_make_phypacket(host,
1462                         EXTPHYPACKET_TYPE_RESUME |
1463                         NODEID_TO_NODE(host->node_id) << PHYPACKET_PORT_SHIFT);
1464         if (packet) {
1465                 packet->no_waiter = 1;
1466                 packet->generation = get_hpsb_generation(host);
1467                 ret = hpsb_send_packet(packet);
1468         }
1469         if (ret)
1470                 HPSB_WARN("fw-host%d: Failed to broadcast resume packet",
1471                           host->id);
1472         return ret;
1473 }
1474
1475 /* Perform a few high-level IRM responsibilities. */
1476 static int nodemgr_do_irm_duties(struct hpsb_host *host, int cycles)
1477 {
1478         quadlet_t bc;
1479
1480         /* if irm_id == -1 then there is no IRM on this bus */
1481         if (!host->is_irm || host->irm_id == (nodeid_t)-1)
1482                 return 1;
1483
1484         /* We are a 1394a-2000 compliant IRM. Set the validity bit. */
1485         host->csr.broadcast_channel |= 0x40000000;
1486
1487         /* If there is no bus manager then we should set the root node's
1488          * force_root bit to promote bus stability per the 1394
1489          * spec. (8.4.2.6) */
1490         if (host->busmgr_id == 0xffff && host->node_count > 1)
1491         {
1492                 u16 root_node = host->node_count - 1;
1493
1494                 /* get cycle master capability flag from root node */
1495                 if (host->is_cycmst ||
1496                     (!hpsb_read(host, LOCAL_BUS | root_node, get_hpsb_generation(host),
1497                                 (CSR_REGISTER_BASE + CSR_CONFIG_ROM + 2 * sizeof(quadlet_t)),
1498                                 &bc, sizeof(quadlet_t)) &&
1499                      be32_to_cpu(bc) & 1 << CSR_CMC_SHIFT))
1500                         hpsb_send_phy_config(host, root_node, -1);
1501                 else {
1502                         HPSB_DEBUG("The root node is not cycle master capable; "
1503                                    "selecting a new root node and resetting...");
1504
1505                         if (cycles >= 5) {
1506                                 /* Oh screw it! Just leave the bus as it is */
1507                                 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1508                                 return 1;
1509                         }
1510
1511                         hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1512                         hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1513
1514                         return 0;
1515                 }
1516         }
1517
1518         /* Some devices suspend their ports while being connected to an inactive
1519          * host adapter, i.e. if connected before the low-level driver is
1520          * loaded.  They become visible either when physically unplugged and
1521          * replugged, or when receiving a resume packet.  Send one once. */
1522         if (!host->resume_packet_sent && !nodemgr_send_resume_packet(host))
1523                 host->resume_packet_sent = 1;
1524
1525         return 1;
1526 }
1527
1528 /* We need to ensure that if we are not the IRM, that the IRM node is capable of
1529  * everything we can do, otherwise issue a bus reset and try to become the IRM
1530  * ourselves. */
1531 static int nodemgr_check_irm_capability(struct hpsb_host *host, int cycles)
1532 {
1533         quadlet_t bc;
1534         int status;
1535
1536         if (hpsb_disable_irm || host->is_irm)
1537                 return 1;
1538
1539         status = hpsb_read(host, LOCAL_BUS | (host->irm_id),
1540                            get_hpsb_generation(host),
1541                            (CSR_REGISTER_BASE | CSR_BROADCAST_CHANNEL),
1542                            &bc, sizeof(quadlet_t));
1543
1544         if (status < 0 || !(be32_to_cpu(bc) & 0x80000000)) {
1545                 /* The current irm node does not have a valid BROADCAST_CHANNEL
1546                  * register and we do, so reset the bus with force_root set */
1547                 HPSB_DEBUG("Current remote IRM is not 1394a-2000 compliant, resetting...");
1548
1549                 if (cycles >= 5) {
1550                         /* Oh screw it! Just leave the bus as it is */
1551                         HPSB_DEBUG("Stopping reset loop for IRM sanity");
1552                         return 1;
1553                 }
1554
1555                 hpsb_send_phy_config(host, NODEID_TO_NODE(host->node_id), -1);
1556                 hpsb_reset_bus(host, LONG_RESET_FORCE_ROOT);
1557
1558                 return 0;
1559         }
1560
1561         return 1;
1562 }
1563
1564 static int nodemgr_host_thread(void *__hi)
1565 {
1566         struct host_info *hi = (struct host_info *)__hi;
1567         struct hpsb_host *host = hi->host;
1568         int reset_cycles = 0;
1569
1570         /* No userlevel access needed */
1571         daemonize(hi->daemon_name);
1572
1573         /* Setup our device-model entries */
1574         nodemgr_create_host_dev_files(host);
1575
1576         /* Sit and wait for a signal to probe the nodes on the bus. This
1577          * happens when we get a bus reset. */
1578         while (1) {
1579                 unsigned int generation = 0;
1580                 int i;
1581
1582                 if (down_interruptible(&hi->reset_sem) ||
1583                     down_interruptible(&nodemgr_serialize)) {
1584                         if (try_to_freeze())
1585                                 continue;
1586                         printk("NodeMgr: received unexpected signal?!\n" );
1587                         break;
1588                 }
1589
1590                 if (hi->kill_me) {
1591                         up(&nodemgr_serialize);
1592                         break;
1593                 }
1594
1595                 /* Pause for 1/4 second in 1/16 second intervals,
1596                  * to make sure things settle down. */
1597                 for (i = 0; i < 4 ; i++) {
1598                         set_current_state(TASK_INTERRUPTIBLE);
1599                         if (msleep_interruptible(63)) {
1600                                 up(&nodemgr_serialize);
1601                                 goto caught_signal;
1602                         }
1603
1604                         /* Now get the generation in which the node ID's we collect
1605                          * are valid.  During the bus scan we will use this generation
1606                          * for the read transactions, so that if another reset occurs
1607                          * during the scan the transactions will fail instead of
1608                          * returning bogus data. */
1609                         generation = get_hpsb_generation(host);
1610
1611                         /* If we get a reset before we are done waiting, then
1612                          * start the the waiting over again */
1613                         while (!down_trylock(&hi->reset_sem))
1614                                 i = 0;
1615
1616                         /* Check the kill_me again */
1617                         if (hi->kill_me) {
1618                                 up(&nodemgr_serialize);
1619                                 goto caught_signal;
1620                         }
1621                 }
1622
1623                 if (!nodemgr_check_irm_capability(host, reset_cycles) ||
1624                     !nodemgr_do_irm_duties(host, reset_cycles)) {
1625                         reset_cycles++;
1626                         up(&nodemgr_serialize);
1627                         continue;
1628                 }
1629                 reset_cycles = 0;
1630
1631                 /* Scan our nodes to get the bus options and create node
1632                  * entries. This does not do the sysfs stuff, since that
1633                  * would trigger uevents and such, which is a bad idea at
1634                  * this point. */
1635                 nodemgr_node_scan(hi, generation);
1636
1637                 /* This actually does the full probe, with sysfs
1638                  * registration. */
1639                 nodemgr_node_probe(hi, generation);
1640
1641                 /* Update some of our sysfs symlinks */
1642                 nodemgr_update_host_dev_links(host);
1643
1644                 up(&nodemgr_serialize);
1645         }
1646
1647 caught_signal:
1648         HPSB_VERBOSE("NodeMgr: Exiting thread");
1649
1650         complete_and_exit(&hi->exited, 0);
1651 }
1652
1653 int nodemgr_for_each_host(void *__data, int (*cb)(struct hpsb_host *, void *))
1654 {
1655         struct class *class = &hpsb_host_class;
1656         struct class_device *cdev;
1657         struct hpsb_host *host;
1658         int error = 0;
1659
1660         down_read(&class->subsys.rwsem);
1661         list_for_each_entry(cdev, &class->children, node) {
1662                 host = container_of(cdev, struct hpsb_host, class_dev);
1663
1664                 if ((error = cb(host, __data)))
1665                         break;
1666         }
1667         up_read(&class->subsys.rwsem);
1668
1669         return error;
1670 }
1671
1672 /* The following four convenience functions use a struct node_entry
1673  * for addressing a node on the bus.  They are intended for use by any
1674  * process context, not just the nodemgr thread, so we need to be a
1675  * little careful when reading out the node ID and generation.  The
1676  * thing that can go wrong is that we get the node ID, then a bus
1677  * reset occurs, and then we read the generation.  The node ID is
1678  * possibly invalid, but the generation is current, and we end up
1679  * sending a packet to a the wrong node.
1680  *
1681  * The solution is to make sure we read the generation first, so that
1682  * if a reset occurs in the process, we end up with a stale generation
1683  * and the transactions will fail instead of silently using wrong node
1684  * ID's.
1685  */
1686
1687 void hpsb_node_fill_packet(struct node_entry *ne, struct hpsb_packet *pkt)
1688 {
1689         pkt->host = ne->host;
1690         pkt->generation = ne->generation;
1691         barrier();
1692         pkt->node_id = ne->nodeid;
1693 }
1694
1695 int hpsb_node_write(struct node_entry *ne, u64 addr,
1696                     quadlet_t *buffer, size_t length)
1697 {
1698         unsigned int generation = ne->generation;
1699
1700         barrier();
1701         return hpsb_write(ne->host, ne->nodeid, generation,
1702                           addr, buffer, length);
1703 }
1704
1705 static void nodemgr_add_host(struct hpsb_host *host)
1706 {
1707         struct host_info *hi;
1708
1709         hi = hpsb_create_hostinfo(&nodemgr_highlevel, host, sizeof(*hi));
1710
1711         if (!hi) {
1712                 HPSB_ERR ("NodeMgr: out of memory in add host");
1713                 return;
1714         }
1715
1716         hi->host = host;
1717         init_completion(&hi->exited);
1718         sema_init(&hi->reset_sem, 0);
1719
1720         sprintf(hi->daemon_name, "knodemgrd_%d", host->id);
1721
1722         hi->pid = kernel_thread(nodemgr_host_thread, hi, CLONE_KERNEL);
1723
1724         if (hi->pid < 0) {
1725                 HPSB_ERR ("NodeMgr: failed to start %s thread for %s",
1726                           hi->daemon_name, host->driver->name);
1727                 hpsb_destroy_hostinfo(&nodemgr_highlevel, host);
1728                 return;
1729         }
1730
1731         return;
1732 }
1733
1734 static void nodemgr_host_reset(struct hpsb_host *host)
1735 {
1736         struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1737
1738         if (hi != NULL) {
1739                 HPSB_VERBOSE("NodeMgr: Processing host reset for %s", hi->daemon_name);
1740                 up(&hi->reset_sem);
1741         } else
1742                 HPSB_ERR ("NodeMgr: could not process reset of unused host");
1743
1744         return;
1745 }
1746
1747 static void nodemgr_remove_host(struct hpsb_host *host)
1748 {
1749         struct host_info *hi = hpsb_get_hostinfo(&nodemgr_highlevel, host);
1750
1751         if (hi) {
1752                 if (hi->pid >= 0) {
1753                         hi->kill_me = 1;
1754                         mb();
1755                         up(&hi->reset_sem);
1756                         wait_for_completion(&hi->exited);
1757                         nodemgr_remove_host_dev(&host->device);
1758                 }
1759         } else
1760                 HPSB_ERR("NodeMgr: host %s does not exist, cannot remove",
1761                          host->driver->name);
1762
1763         return;
1764 }
1765
1766 static struct hpsb_highlevel nodemgr_highlevel = {
1767         .name =         "Node manager",
1768         .add_host =     nodemgr_add_host,
1769         .host_reset =   nodemgr_host_reset,
1770         .remove_host =  nodemgr_remove_host,
1771 };
1772
1773 int init_ieee1394_nodemgr(void)
1774 {
1775         int ret;
1776
1777         ret = class_register(&nodemgr_ne_class);
1778         if (ret < 0)
1779                 return ret;
1780
1781         ret = class_register(&nodemgr_ud_class);
1782         if (ret < 0) {
1783                 class_unregister(&nodemgr_ne_class);
1784                 return ret;
1785         }
1786
1787         hpsb_register_highlevel(&nodemgr_highlevel);
1788
1789         return 0;
1790 }
1791
1792 void cleanup_ieee1394_nodemgr(void)
1793 {
1794         hpsb_unregister_highlevel(&nodemgr_highlevel);
1795
1796         class_unregister(&nodemgr_ud_class);
1797         class_unregister(&nodemgr_ne_class);
1798 }