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