2 * Node information (ConfigROM) collection and management.
4 * Copyright (C) 2000 Andreas E. Bombe
5 * 2001-2003 Ben Collins <bcollins@debian.net>
7 * This code is licensed under the GPL. See the file COPYING in the root
8 * directory of the kernel sources for details.
11 #include <linux/bitmap.h>
12 #include <linux/kernel.h>
13 #include <linux/list.h>
14 #include <linux/slab.h>
15 #include <linux/delay.h>
16 #include <linux/kthread.h>
17 #include <linux/module.h>
18 #include <linux/moduleparam.h>
19 #include <linux/mutex.h>
20 #include <linux/freezer.h>
21 #include <asm/atomic.h>
22 #include <asm/semaphore.h>
25 #include "highlevel.h"
28 #include "ieee1394_core.h"
29 #include "ieee1394_hotplug.h"
30 #include "ieee1394_types.h"
31 #include "ieee1394_transactions.h"
34 static int ignore_drivers
;
35 module_param(ignore_drivers
, int, S_IRUGO
| S_IWUSR
);
36 MODULE_PARM_DESC(ignore_drivers
, "Disable automatic probing for drivers.");
38 struct nodemgr_csr_info
{
39 struct hpsb_host
*host
;
41 unsigned int generation
;
42 unsigned int speed_unverified
:1;
47 * Correct the speed map entry. This is necessary
48 * - for nodes with link speed < phy speed,
49 * - for 1394b nodes with negotiated phy port speed < IEEE1394_SPEED_MAX.
50 * A possible speed is determined by trial and error, using quadlet reads.
52 static int nodemgr_check_speed(struct nodemgr_csr_info
*ci
, u64 addr
,
56 u8 i
, *speed
, old_speed
, good_speed
;
59 speed
= &(ci
->host
->speed
[NODEID_TO_NODE(ci
->nodeid
)]);
61 good_speed
= IEEE1394_SPEED_MAX
+ 1;
63 /* Try every speed from S100 to old_speed.
64 * If we did it the other way around, a too low speed could be caught
65 * if the retry succeeded for some other reason, e.g. because the link
66 * just finished its initialization. */
67 for (i
= IEEE1394_SPEED_100
; i
<= old_speed
; i
++) {
69 error
= hpsb_read(ci
->host
, ci
->nodeid
, ci
->generation
, addr
,
70 &q
, sizeof(quadlet_t
));
76 if (good_speed
<= IEEE1394_SPEED_MAX
) {
77 HPSB_DEBUG("Speed probe of node " NODE_BUS_FMT
" yields %s",
78 NODE_BUS_ARGS(ci
->host
, ci
->nodeid
),
79 hpsb_speedto_str
[good_speed
]);
81 ci
->speed_unverified
= 0;
88 static int nodemgr_bus_read(struct csr1212_csr
*csr
, u64 addr
, u16 length
,
89 void *buffer
, void *__ci
)
91 struct nodemgr_csr_info
*ci
= (struct nodemgr_csr_info
*)__ci
;
95 error
= hpsb_read(ci
->host
, ci
->nodeid
, ci
->generation
, addr
,
98 ci
->speed_unverified
= 0;
101 /* Give up after 3rd failure. */
105 /* The ieee1394_core guessed the node's speed capability from
106 * the self ID. Check whether a lower speed works. */
107 if (ci
->speed_unverified
&& length
== sizeof(quadlet_t
)) {
108 error
= nodemgr_check_speed(ci
, addr
, buffer
);
112 if (msleep_interruptible(334))
118 static int nodemgr_get_max_rom(quadlet_t
*bus_info_data
, void *__ci
)
120 return (be32_to_cpu(bus_info_data
[2]) >> 8) & 0x3;
123 static struct csr1212_bus_ops nodemgr_csr_ops
= {
124 .bus_read
= nodemgr_bus_read
,
125 .get_max_rom
= nodemgr_get_max_rom
130 * Basically what we do here is start off retrieving the bus_info block.
131 * From there will fill in some info about the node, verify it is of IEEE
132 * 1394 type, and that the crc checks out ok. After that we start off with
133 * the root directory, and subdirectories. To do this, we retrieve the
134 * quadlet header for a directory, find out the length, and retrieve the
135 * complete directory entry (be it a leaf or a directory). We then process
136 * it and add the info to our structure for that particular node.
138 * We verify CRC's along the way for each directory/block/leaf. The entire
139 * node structure is generic, and simply stores the information in a way
140 * that's easy to parse by the protocol interface.
144 * The nodemgr relies heavily on the Driver Model for device callbacks and
145 * driver/device mappings. The old nodemgr used to handle all this itself,
146 * but now we are much simpler because of the LDM.
150 struct hpsb_host
*host
;
151 struct list_head list
;
152 struct task_struct
*thread
;
155 static int nodemgr_bus_match(struct device
* dev
, struct device_driver
* drv
);
156 static int nodemgr_uevent(struct device
*dev
, char **envp
, int num_envp
,
157 char *buffer
, int buffer_size
);
158 static void nodemgr_resume_ne(struct node_entry
*ne
);
159 static void nodemgr_remove_ne(struct node_entry
*ne
);
160 static struct node_entry
*find_entry_by_guid(u64 guid
);
162 struct bus_type ieee1394_bus_type
= {
164 .match
= nodemgr_bus_match
,
167 static void host_cls_release(struct device
*dev
)
169 put_device(&container_of((dev
), struct hpsb_host
, host_dev
)->device
);
172 struct class hpsb_host_class
= {
173 .name
= "ieee1394_host",
174 .dev_release
= host_cls_release
,
177 static void ne_cls_release(struct device
*dev
)
179 put_device(&container_of((dev
), struct node_entry
, node_dev
)->device
);
182 static struct class nodemgr_ne_class
= {
183 .name
= "ieee1394_node",
184 .dev_release
= ne_cls_release
,
187 static void ud_cls_release(struct device
*dev
)
189 put_device(&container_of((dev
), struct unit_directory
, unit_dev
)->device
);
192 /* The name here is only so that unit directory hotplug works with old
193 * style hotplug, which only ever did unit directories anyway.
195 static struct class nodemgr_ud_class
= {
197 .dev_release
= ud_cls_release
,
198 .dev_uevent
= nodemgr_uevent
,
201 static struct hpsb_highlevel nodemgr_highlevel
;
204 static void nodemgr_release_ud(struct device
*dev
)
206 struct unit_directory
*ud
= container_of(dev
, struct unit_directory
, device
);
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
);
216 static void nodemgr_release_ne(struct device
*dev
)
218 struct node_entry
*ne
= container_of(dev
, struct node_entry
, device
);
220 if (ne
->vendor_name_kv
)
221 csr1212_release_keyval(ne
->vendor_name_kv
);
227 static void nodemgr_release_host(struct device
*dev
)
229 struct hpsb_host
*host
= container_of(dev
, struct hpsb_host
, device
);
231 csr1212_destroy_csr(host
->csr
.rom
);
236 static int nodemgr_ud_platform_data
;
238 static struct device nodemgr_dev_template_ud
= {
239 .bus
= &ieee1394_bus_type
,
240 .release
= nodemgr_release_ud
,
241 .platform_data
= &nodemgr_ud_platform_data
,
244 static struct device nodemgr_dev_template_ne
= {
245 .bus
= &ieee1394_bus_type
,
246 .release
= nodemgr_release_ne
,
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. */
253 static struct device_driver nodemgr_mid_layer_driver
= {
254 .bus
= &ieee1394_bus_type
,
256 .owner
= THIS_MODULE
,
259 struct device nodemgr_dev_template_host
= {
260 .bus
= &ieee1394_bus_type
,
261 .release
= nodemgr_release_host
,
265 #define fw_attr(class, class_type, field, type, format_string) \
266 static ssize_t fw_show_##class##_##field (struct device *dev, struct device_attribute *attr, char *buf)\
269 class = container_of(dev, class_type, device); \
270 return sprintf(buf, format_string, (type)class->field); \
272 static struct device_attribute dev_attr_##class##_##field = { \
273 .attr = {.name = __stringify(field), .mode = S_IRUGO }, \
274 .show = fw_show_##class##_##field, \
277 #define fw_attr_td(class, class_type, td_kv) \
278 static ssize_t fw_show_##class##_##td_kv (struct device *dev, struct device_attribute *attr, char *buf)\
281 class_type *class = container_of(dev, class_type, device); \
282 len = (class->td_kv->value.leaf.len - 2) * sizeof(quadlet_t); \
284 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_DATA(class->td_kv), \
286 while (buf[len - 1] == '\0') \
292 static struct device_attribute dev_attr_##class##_##td_kv = { \
293 .attr = {.name = __stringify(td_kv), .mode = S_IRUGO }, \
294 .show = fw_show_##class##_##td_kv, \
298 #define fw_drv_attr(field, type, format_string) \
299 static ssize_t fw_drv_show_##field (struct device_driver *drv, char *buf) \
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);\
305 static struct driver_attribute driver_attr_drv_##field = { \
306 .attr = {.name = __stringify(field), .mode = S_IRUGO }, \
307 .show = fw_drv_show_##field, \
311 static ssize_t
fw_show_ne_bus_options(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
313 struct node_entry
*ne
= container_of(dev
, struct node_entry
, device
);
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",
318 ne
->busopt
.cmc
, ne
->busopt
.isc
, ne
->busopt
.bmc
,
319 ne
->busopt
.pmc
, ne
->busopt
.generation
, ne
->busopt
.lnkspd
,
322 ne
->busopt
.cyc_clk_acc
);
324 static DEVICE_ATTR(bus_options
,S_IRUGO
,fw_show_ne_bus_options
,NULL
);
327 #ifdef HPSB_DEBUG_TLABELS
328 static ssize_t
fw_show_ne_tlabels_free(struct device
*dev
,
329 struct device_attribute
*attr
, char *buf
)
331 struct node_entry
*ne
= container_of(dev
, struct node_entry
, device
);
333 unsigned long *tp
= ne
->host
->tl_pool
[NODEID_TO_NODE(ne
->nodeid
)].map
;
336 spin_lock_irqsave(&hpsb_tlabel_lock
, flags
);
337 tf
= 64 - bitmap_weight(tp
, 64);
338 spin_unlock_irqrestore(&hpsb_tlabel_lock
, flags
);
340 return sprintf(buf
, "%d\n", tf
);
342 static DEVICE_ATTR(tlabels_free
,S_IRUGO
,fw_show_ne_tlabels_free
,NULL
);
345 static ssize_t
fw_show_ne_tlabels_mask(struct device
*dev
,
346 struct device_attribute
*attr
, char *buf
)
348 struct node_entry
*ne
= container_of(dev
, struct node_entry
, device
);
350 unsigned long *tp
= ne
->host
->tl_pool
[NODEID_TO_NODE(ne
->nodeid
)].map
;
353 spin_lock_irqsave(&hpsb_tlabel_lock
, flags
);
354 #if (BITS_PER_LONG <= 32)
355 tm
= ((u64
)tp
[0] << 32) + tp
[1];
359 spin_unlock_irqrestore(&hpsb_tlabel_lock
, flags
);
361 return sprintf(buf
, "0x%016llx\n", (unsigned long long)tm
);
363 static DEVICE_ATTR(tlabels_mask
, S_IRUGO
, fw_show_ne_tlabels_mask
, NULL
);
364 #endif /* HPSB_DEBUG_TLABELS */
367 static ssize_t
fw_set_ignore_driver(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
369 struct unit_directory
*ud
= container_of(dev
, struct unit_directory
, device
);
370 int state
= simple_strtoul(buf
, NULL
, 10);
373 ud
->ignore_driver
= 1;
374 device_release_driver(dev
);
375 } else if (state
== 0)
376 ud
->ignore_driver
= 0;
380 static ssize_t
fw_get_ignore_driver(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
382 struct unit_directory
*ud
= container_of(dev
, struct unit_directory
, device
);
384 return sprintf(buf
, "%d\n", ud
->ignore_driver
);
386 static DEVICE_ATTR(ignore_driver
, S_IWUSR
| S_IRUGO
, fw_get_ignore_driver
, fw_set_ignore_driver
);
389 static ssize_t
fw_set_destroy_node(struct bus_type
*bus
, const char *buf
, size_t count
)
391 struct node_entry
*ne
;
392 u64 guid
= (u64
)simple_strtoull(buf
, NULL
, 16);
394 ne
= find_entry_by_guid(guid
);
396 if (ne
== NULL
|| !ne
->in_limbo
)
399 nodemgr_remove_ne(ne
);
403 static ssize_t
fw_get_destroy_node(struct bus_type
*bus
, char *buf
)
405 return sprintf(buf
, "You can destroy in_limbo nodes by writing their GUID to this file\n");
407 static BUS_ATTR(destroy_node
, S_IWUSR
| S_IRUGO
, fw_get_destroy_node
, fw_set_destroy_node
);
410 static ssize_t
fw_set_rescan(struct bus_type
*bus
, const char *buf
,
415 if (simple_strtoul(buf
, NULL
, 10) == 1)
416 error
= bus_rescan_devices(&ieee1394_bus_type
);
417 return error
? error
: count
;
419 static ssize_t
fw_get_rescan(struct bus_type
*bus
, char *buf
)
421 return sprintf(buf
, "You can force a rescan of the bus for "
422 "drivers by writing a 1 to this file\n");
424 static BUS_ATTR(rescan
, S_IWUSR
| S_IRUGO
, fw_get_rescan
, fw_set_rescan
);
427 static ssize_t
fw_set_ignore_drivers(struct bus_type
*bus
, const char *buf
, size_t count
)
429 int state
= simple_strtoul(buf
, NULL
, 10);
438 static ssize_t
fw_get_ignore_drivers(struct bus_type
*bus
, char *buf
)
440 return sprintf(buf
, "%d\n", ignore_drivers
);
442 static BUS_ATTR(ignore_drivers
, S_IWUSR
| S_IRUGO
, fw_get_ignore_drivers
, fw_set_ignore_drivers
);
445 struct bus_attribute
*const fw_bus_attrs
[] = {
446 &bus_attr_destroy_node
,
448 &bus_attr_ignore_drivers
,
453 fw_attr(ne
, struct node_entry
, capabilities
, unsigned int, "0x%06x\n")
454 fw_attr(ne
, struct node_entry
, nodeid
, unsigned int, "0x%04x\n")
456 fw_attr(ne
, struct node_entry
, vendor_id
, unsigned int, "0x%06x\n")
457 fw_attr_td(ne
, struct node_entry
, vendor_name_kv
)
459 fw_attr(ne
, struct node_entry
, guid
, unsigned long long, "0x%016Lx\n")
460 fw_attr(ne
, struct node_entry
, guid_vendor_id
, unsigned int, "0x%06x\n")
461 fw_attr(ne
, struct node_entry
, in_limbo
, int, "%d\n");
463 static struct device_attribute
*const fw_ne_attrs
[] = {
465 &dev_attr_ne_guid_vendor_id
,
466 &dev_attr_ne_capabilities
,
467 &dev_attr_ne_vendor_id
,
469 &dev_attr_bus_options
,
470 #ifdef HPSB_DEBUG_TLABELS
471 &dev_attr_tlabels_free
,
472 &dev_attr_tlabels_mask
,
478 fw_attr(ud
, struct unit_directory
, address
, unsigned long long, "0x%016Lx\n")
479 fw_attr(ud
, struct unit_directory
, length
, int, "%d\n")
480 /* These are all dependent on the value being provided */
481 fw_attr(ud
, struct unit_directory
, vendor_id
, unsigned int, "0x%06x\n")
482 fw_attr(ud
, struct unit_directory
, model_id
, unsigned int, "0x%06x\n")
483 fw_attr(ud
, struct unit_directory
, specifier_id
, unsigned int, "0x%06x\n")
484 fw_attr(ud
, struct unit_directory
, version
, unsigned int, "0x%06x\n")
485 fw_attr_td(ud
, struct unit_directory
, vendor_name_kv
)
486 fw_attr_td(ud
, struct unit_directory
, model_name_kv
)
488 static struct device_attribute
*const fw_ud_attrs
[] = {
489 &dev_attr_ud_address
,
491 &dev_attr_ignore_driver
,
495 fw_attr(host
, struct hpsb_host
, node_count
, int, "%d\n")
496 fw_attr(host
, struct hpsb_host
, selfid_count
, int, "%d\n")
497 fw_attr(host
, struct hpsb_host
, nodes_active
, int, "%d\n")
498 fw_attr(host
, struct hpsb_host
, in_bus_reset
, int, "%d\n")
499 fw_attr(host
, struct hpsb_host
, is_root
, int, "%d\n")
500 fw_attr(host
, struct hpsb_host
, is_cycmst
, int, "%d\n")
501 fw_attr(host
, struct hpsb_host
, is_irm
, int, "%d\n")
502 fw_attr(host
, struct hpsb_host
, is_busmgr
, int, "%d\n")
504 static 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
,
516 static ssize_t
fw_show_drv_device_ids(struct device_driver
*drv
, char *buf
)
518 struct hpsb_protocol_driver
*driver
;
519 struct ieee1394_device_id
*id
;
523 driver
= container_of(drv
, struct hpsb_protocol_driver
, driver
);
525 for (id
= driver
->id_table
; id
->match_flags
!= 0; id
++) {
528 if (id
->match_flags
& IEEE1394_MATCH_VENDOR_ID
) {
529 length
+= sprintf(scratch
, "vendor_id=0x%06x", id
->vendor_id
);
530 scratch
= buf
+ length
;
534 if (id
->match_flags
& IEEE1394_MATCH_MODEL_ID
) {
535 length
+= sprintf(scratch
, "%smodel_id=0x%06x",
536 need_coma
++ ? "," : "",
538 scratch
= buf
+ length
;
541 if (id
->match_flags
& IEEE1394_MATCH_SPECIFIER_ID
) {
542 length
+= sprintf(scratch
, "%sspecifier_id=0x%06x",
543 need_coma
++ ? "," : "",
545 scratch
= buf
+ length
;
548 if (id
->match_flags
& IEEE1394_MATCH_VERSION
) {
549 length
+= sprintf(scratch
, "%sversion=0x%06x",
550 need_coma
++ ? "," : "",
552 scratch
= buf
+ length
;
563 static DRIVER_ATTR(device_ids
,S_IRUGO
,fw_show_drv_device_ids
,NULL
);
566 fw_drv_attr(name
, const char *, "%s\n")
568 static struct driver_attribute
*const fw_drv_attrs
[] = {
569 &driver_attr_drv_name
,
570 &driver_attr_device_ids
,
574 static void nodemgr_create_drv_files(struct hpsb_protocol_driver
*driver
)
576 struct device_driver
*drv
= &driver
->driver
;
579 for (i
= 0; i
< ARRAY_SIZE(fw_drv_attrs
); i
++)
580 if (driver_create_file(drv
, fw_drv_attrs
[i
]))
584 HPSB_ERR("Failed to add sysfs attribute");
588 static void nodemgr_remove_drv_files(struct hpsb_protocol_driver
*driver
)
590 struct device_driver
*drv
= &driver
->driver
;
593 for (i
= 0; i
< ARRAY_SIZE(fw_drv_attrs
); i
++)
594 driver_remove_file(drv
, fw_drv_attrs
[i
]);
598 static void nodemgr_create_ne_dev_files(struct node_entry
*ne
)
600 struct device
*dev
= &ne
->device
;
603 for (i
= 0; i
< ARRAY_SIZE(fw_ne_attrs
); i
++)
604 if (device_create_file(dev
, fw_ne_attrs
[i
]))
608 HPSB_ERR("Failed to add sysfs attribute");
612 static void nodemgr_create_host_dev_files(struct hpsb_host
*host
)
614 struct device
*dev
= &host
->device
;
617 for (i
= 0; i
< ARRAY_SIZE(fw_host_attrs
); i
++)
618 if (device_create_file(dev
, fw_host_attrs
[i
]))
622 HPSB_ERR("Failed to add sysfs attribute");
626 static struct node_entry
*find_entry_by_nodeid(struct hpsb_host
*host
,
629 static void nodemgr_update_host_dev_links(struct hpsb_host
*host
)
631 struct device
*dev
= &host
->device
;
632 struct node_entry
*ne
;
634 sysfs_remove_link(&dev
->kobj
, "irm_id");
635 sysfs_remove_link(&dev
->kobj
, "busmgr_id");
636 sysfs_remove_link(&dev
->kobj
, "host_id");
638 if ((ne
= find_entry_by_nodeid(host
, host
->irm_id
)) &&
639 sysfs_create_link(&dev
->kobj
, &ne
->device
.kobj
, "irm_id"))
641 if ((ne
= find_entry_by_nodeid(host
, host
->busmgr_id
)) &&
642 sysfs_create_link(&dev
->kobj
, &ne
->device
.kobj
, "busmgr_id"))
644 if ((ne
= find_entry_by_nodeid(host
, host
->node_id
)) &&
645 sysfs_create_link(&dev
->kobj
, &ne
->device
.kobj
, "host_id"))
649 HPSB_ERR("Failed to update sysfs attributes for host %d", host
->id
);
652 static void nodemgr_create_ud_dev_files(struct unit_directory
*ud
)
654 struct device
*dev
= &ud
->device
;
657 for (i
= 0; i
< ARRAY_SIZE(fw_ud_attrs
); i
++)
658 if (device_create_file(dev
, fw_ud_attrs
[i
]))
660 if (ud
->flags
& UNIT_DIRECTORY_SPECIFIER_ID
)
661 if (device_create_file(dev
, &dev_attr_ud_specifier_id
))
663 if (ud
->flags
& UNIT_DIRECTORY_VERSION
)
664 if (device_create_file(dev
, &dev_attr_ud_version
))
666 if (ud
->flags
& UNIT_DIRECTORY_VENDOR_ID
) {
667 if (device_create_file(dev
, &dev_attr_ud_vendor_id
))
669 if (ud
->vendor_name_kv
&&
670 device_create_file(dev
, &dev_attr_ud_vendor_name_kv
))
673 if (ud
->flags
& UNIT_DIRECTORY_MODEL_ID
) {
674 if (device_create_file(dev
, &dev_attr_ud_model_id
))
676 if (ud
->model_name_kv
&&
677 device_create_file(dev
, &dev_attr_ud_model_name_kv
))
682 HPSB_ERR("Failed to add sysfs attribute");
686 static int nodemgr_bus_match(struct device
* dev
, struct device_driver
* drv
)
688 struct hpsb_protocol_driver
*driver
;
689 struct unit_directory
*ud
;
690 struct ieee1394_device_id
*id
;
692 /* We only match unit directories */
693 if (dev
->platform_data
!= &nodemgr_ud_platform_data
)
696 ud
= container_of(dev
, struct unit_directory
, device
);
697 if (ud
->ne
->in_limbo
|| ud
->ignore_driver
)
700 /* We only match drivers of type hpsb_protocol_driver */
701 if (drv
== &nodemgr_mid_layer_driver
)
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
)
710 if ((id
->match_flags
& IEEE1394_MATCH_MODEL_ID
) &&
711 id
->model_id
!= ud
->model_id
)
714 if ((id
->match_flags
& IEEE1394_MATCH_SPECIFIER_ID
) &&
715 id
->specifier_id
!= ud
->specifier_id
)
718 if ((id
->match_flags
& IEEE1394_MATCH_VERSION
) &&
719 id
->version
!= ud
->version
)
729 static DEFINE_MUTEX(nodemgr_serialize_remove_uds
);
731 static void nodemgr_remove_uds(struct node_entry
*ne
)
734 struct unit_directory
*tmp
, *ud
;
736 /* Iteration over nodemgr_ud_class.devices has to be protected by
737 * nodemgr_ud_class.sem, but 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.
743 mutex_lock(&nodemgr_serialize_remove_uds
);
746 down(&nodemgr_ud_class
.sem
);
747 list_for_each_entry(dev
, &nodemgr_ud_class
.devices
, node
) {
748 tmp
= container_of(dev
, struct unit_directory
,
755 up(&nodemgr_ud_class
.sem
);
758 device_unregister(&ud
->unit_dev
);
759 device_unregister(&ud
->device
);
761 mutex_unlock(&nodemgr_serialize_remove_uds
);
765 static void nodemgr_remove_ne(struct node_entry
*ne
)
769 dev
= get_device(&ne
->device
);
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 nodemgr_remove_uds(ne
);
777 device_unregister(&ne
->node_dev
);
778 device_unregister(dev
);
783 static int __nodemgr_remove_host_dev(struct device
*dev
, void *data
)
785 if (dev
->bus
== &ieee1394_bus_type
)
786 nodemgr_remove_ne(container_of(dev
, struct node_entry
,
791 static void nodemgr_remove_host_dev(struct device
*dev
)
793 WARN_ON(device_for_each_child(dev
, NULL
, __nodemgr_remove_host_dev
));
794 sysfs_remove_link(&dev
->kobj
, "irm_id");
795 sysfs_remove_link(&dev
->kobj
, "busmgr_id");
796 sysfs_remove_link(&dev
->kobj
, "host_id");
800 static void nodemgr_update_bus_options(struct node_entry
*ne
)
802 #ifdef CONFIG_IEEE1394_VERBOSEDEBUG
803 static const u16 mr
[] = { 4, 64, 1024, 0};
805 quadlet_t busoptions
= be32_to_cpu(ne
->csr
->bus_info_data
[2]);
807 ne
->busopt
.irmc
= (busoptions
>> 31) & 1;
808 ne
->busopt
.cmc
= (busoptions
>> 30) & 1;
809 ne
->busopt
.isc
= (busoptions
>> 29) & 1;
810 ne
->busopt
.bmc
= (busoptions
>> 28) & 1;
811 ne
->busopt
.pmc
= (busoptions
>> 27) & 1;
812 ne
->busopt
.cyc_clk_acc
= (busoptions
>> 16) & 0xff;
813 ne
->busopt
.max_rec
= 1 << (((busoptions
>> 12) & 0xf) + 1);
814 ne
->busopt
.max_rom
= (busoptions
>> 8) & 0x3;
815 ne
->busopt
.generation
= (busoptions
>> 4) & 0xf;
816 ne
->busopt
.lnkspd
= busoptions
& 0x7;
818 HPSB_VERBOSE("NodeMgr: raw=0x%08x irmc=%d cmc=%d isc=%d bmc=%d pmc=%d "
819 "cyc_clk_acc=%d max_rec=%d max_rom=%d gen=%d lspd=%d",
820 busoptions
, ne
->busopt
.irmc
, ne
->busopt
.cmc
,
821 ne
->busopt
.isc
, ne
->busopt
.bmc
, ne
->busopt
.pmc
,
822 ne
->busopt
.cyc_clk_acc
, ne
->busopt
.max_rec
,
823 mr
[ne
->busopt
.max_rom
],
824 ne
->busopt
.generation
, ne
->busopt
.lnkspd
);
828 static struct node_entry
*nodemgr_create_node(octlet_t guid
, struct csr1212_csr
*csr
,
829 struct host_info
*hi
, nodeid_t nodeid
,
830 unsigned int generation
)
832 struct hpsb_host
*host
= hi
->host
;
833 struct node_entry
*ne
;
835 ne
= kzalloc(sizeof(*ne
), GFP_KERNEL
);
841 ne
->generation
= generation
;
845 ne
->guid_vendor_id
= (guid
>> 40) & 0xffffff;
848 memcpy(&ne
->device
, &nodemgr_dev_template_ne
,
850 ne
->device
.parent
= &host
->device
;
851 snprintf(ne
->device
.bus_id
, BUS_ID_SIZE
, "%016Lx",
852 (unsigned long long)(ne
->guid
));
854 ne
->node_dev
.parent
= &ne
->device
;
855 ne
->node_dev
.class = &nodemgr_ne_class
;
856 snprintf(ne
->node_dev
.bus_id
, BUS_ID_SIZE
, "%016Lx",
857 (unsigned long long)(ne
->guid
));
859 if (device_register(&ne
->device
))
861 if (device_register(&ne
->node_dev
))
862 goto fail_classdevreg
;
863 get_device(&ne
->device
);
865 nodemgr_create_ne_dev_files(ne
);
867 nodemgr_update_bus_options(ne
);
869 HPSB_DEBUG("%s added: ID:BUS[" NODE_BUS_FMT
"] GUID[%016Lx]",
870 (host
->node_id
== nodeid
) ? "Host" : "Node",
871 NODE_BUS_ARGS(host
, nodeid
), (unsigned long long)guid
);
876 device_unregister(&ne
->device
);
880 HPSB_ERR("Failed to create node ID:BUS[" NODE_BUS_FMT
"] GUID[%016Lx]",
881 NODE_BUS_ARGS(host
, nodeid
), (unsigned long long)guid
);
887 static struct node_entry
*find_entry_by_guid(u64 guid
)
890 struct node_entry
*ne
, *ret_ne
= NULL
;
892 down(&nodemgr_ne_class
.sem
);
893 list_for_each_entry(dev
, &nodemgr_ne_class
.devices
, node
) {
894 ne
= container_of(dev
, struct node_entry
, node_dev
);
896 if (ne
->guid
== guid
) {
901 up(&nodemgr_ne_class
.sem
);
907 static struct node_entry
*find_entry_by_nodeid(struct hpsb_host
*host
,
911 struct node_entry
*ne
, *ret_ne
= NULL
;
913 down(&nodemgr_ne_class
.sem
);
914 list_for_each_entry(dev
, &nodemgr_ne_class
.devices
, node
) {
915 ne
= container_of(dev
, struct node_entry
, node_dev
);
917 if (ne
->host
== host
&& ne
->nodeid
== nodeid
) {
922 up(&nodemgr_ne_class
.sem
);
928 static void nodemgr_register_device(struct node_entry
*ne
,
929 struct unit_directory
*ud
, struct device
*parent
)
931 memcpy(&ud
->device
, &nodemgr_dev_template_ud
,
934 ud
->device
.parent
= parent
;
936 snprintf(ud
->device
.bus_id
, BUS_ID_SIZE
, "%s-%u",
937 ne
->device
.bus_id
, ud
->id
);
939 ud
->unit_dev
.parent
= &ud
->device
;
940 ud
->unit_dev
.class = &nodemgr_ud_class
;
941 snprintf(ud
->unit_dev
.bus_id
, BUS_ID_SIZE
, "%s-%u",
942 ne
->device
.bus_id
, ud
->id
);
944 if (device_register(&ud
->device
))
946 if (device_register(&ud
->unit_dev
))
947 goto fail_classdevreg
;
948 get_device(&ud
->device
);
950 nodemgr_create_ud_dev_files(ud
);
955 device_unregister(&ud
->device
);
957 HPSB_ERR("Failed to create unit %s", ud
->device
.bus_id
);
961 /* This implementation currently only scans the config rom and its
962 * immediate unit directories looking for software_id and
963 * software_version entries, in order to get driver autoloading working. */
964 static struct unit_directory
*nodemgr_process_unit_directory
965 (struct host_info
*hi
, struct node_entry
*ne
, struct csr1212_keyval
*ud_kv
,
966 unsigned int *id
, struct unit_directory
*parent
)
968 struct unit_directory
*ud
;
969 struct unit_directory
*ud_child
= NULL
;
970 struct csr1212_dentry
*dentry
;
971 struct csr1212_keyval
*kv
;
974 ud
= kzalloc(sizeof(*ud
), GFP_KERNEL
);
976 goto unit_directory_error
;
979 ud
->ignore_driver
= ignore_drivers
;
980 ud
->address
= ud_kv
->offset
+ CSR1212_REGISTER_SPACE_BASE
;
981 ud
->directory_id
= ud
->address
& 0xffffff;
985 csr1212_for_each_dir_entry(ne
->csr
, kv
, ud_kv
, dentry
) {
986 switch (kv
->key
.id
) {
987 case CSR1212_KV_ID_VENDOR
:
988 if (kv
->key
.type
== CSR1212_KV_TYPE_IMMEDIATE
) {
989 ud
->vendor_id
= kv
->value
.immediate
;
990 ud
->flags
|= UNIT_DIRECTORY_VENDOR_ID
;
994 case CSR1212_KV_ID_MODEL
:
995 ud
->model_id
= kv
->value
.immediate
;
996 ud
->flags
|= UNIT_DIRECTORY_MODEL_ID
;
999 case CSR1212_KV_ID_SPECIFIER_ID
:
1000 ud
->specifier_id
= kv
->value
.immediate
;
1001 ud
->flags
|= UNIT_DIRECTORY_SPECIFIER_ID
;
1004 case CSR1212_KV_ID_VERSION
:
1005 ud
->version
= kv
->value
.immediate
;
1006 ud
->flags
|= UNIT_DIRECTORY_VERSION
;
1009 case CSR1212_KV_ID_DESCRIPTOR
:
1010 if (kv
->key
.type
== CSR1212_KV_TYPE_LEAF
&&
1011 CSR1212_DESCRIPTOR_LEAF_TYPE(kv
) == 0 &&
1012 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv
) == 0 &&
1013 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv
) == 0 &&
1014 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv
) == 0 &&
1015 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv
) == 0) {
1016 switch (last_key_id
) {
1017 case CSR1212_KV_ID_VENDOR
:
1018 ud
->vendor_name_kv
= kv
;
1019 csr1212_keep_keyval(kv
);
1022 case CSR1212_KV_ID_MODEL
:
1023 ud
->model_name_kv
= kv
;
1024 csr1212_keep_keyval(kv
);
1028 } /* else if (kv->key.type == CSR1212_KV_TYPE_DIRECTORY) ... */
1031 case CSR1212_KV_ID_DEPENDENT_INFO
:
1032 /* Logical Unit Number */
1033 if (kv
->key
.type
== CSR1212_KV_TYPE_IMMEDIATE
) {
1034 if (ud
->flags
& UNIT_DIRECTORY_HAS_LUN
) {
1035 ud_child
= kmemdup(ud
, sizeof(*ud_child
), GFP_KERNEL
);
1037 goto unit_directory_error
;
1038 nodemgr_register_device(ne
, ud_child
, &ne
->device
);
1043 ud
->lun
= kv
->value
.immediate
;
1044 ud
->flags
|= UNIT_DIRECTORY_HAS_LUN
;
1046 /* Logical Unit Directory */
1047 } else if (kv
->key
.type
== CSR1212_KV_TYPE_DIRECTORY
) {
1048 /* This should really be done in SBP2 as this is
1049 * doing SBP2 specific parsing.
1052 /* first register the parent unit */
1053 ud
->flags
|= UNIT_DIRECTORY_HAS_LUN_DIRECTORY
;
1054 if (ud
->device
.bus
!= &ieee1394_bus_type
)
1055 nodemgr_register_device(ne
, ud
, &ne
->device
);
1057 /* process the child unit */
1058 ud_child
= nodemgr_process_unit_directory(hi
, ne
, kv
, id
, ud
);
1060 if (ud_child
== NULL
)
1063 /* inherit unspecified values, the driver core picks it up */
1064 if ((ud
->flags
& UNIT_DIRECTORY_MODEL_ID
) &&
1065 !(ud_child
->flags
& UNIT_DIRECTORY_MODEL_ID
))
1067 ud_child
->flags
|= UNIT_DIRECTORY_MODEL_ID
;
1068 ud_child
->model_id
= ud
->model_id
;
1070 if ((ud
->flags
& UNIT_DIRECTORY_SPECIFIER_ID
) &&
1071 !(ud_child
->flags
& UNIT_DIRECTORY_SPECIFIER_ID
))
1073 ud_child
->flags
|= UNIT_DIRECTORY_SPECIFIER_ID
;
1074 ud_child
->specifier_id
= ud
->specifier_id
;
1076 if ((ud
->flags
& UNIT_DIRECTORY_VERSION
) &&
1077 !(ud_child
->flags
& UNIT_DIRECTORY_VERSION
))
1079 ud_child
->flags
|= UNIT_DIRECTORY_VERSION
;
1080 ud_child
->version
= ud
->version
;
1083 /* register the child unit */
1084 ud_child
->flags
|= UNIT_DIRECTORY_LUN_DIRECTORY
;
1085 nodemgr_register_device(ne
, ud_child
, &ud
->device
);
1090 case CSR1212_KV_ID_DIRECTORY_ID
:
1091 ud
->directory_id
= kv
->value
.immediate
;
1097 last_key_id
= kv
->key
.id
;
1100 /* do not process child units here and only if not already registered */
1101 if (!parent
&& ud
->device
.bus
!= &ieee1394_bus_type
)
1102 nodemgr_register_device(ne
, ud
, &ne
->device
);
1106 unit_directory_error
:
1112 static void nodemgr_process_root_directory(struct host_info
*hi
, struct node_entry
*ne
)
1114 unsigned int ud_id
= 0;
1115 struct csr1212_dentry
*dentry
;
1116 struct csr1212_keyval
*kv
;
1119 ne
->needs_probe
= 0;
1121 csr1212_for_each_dir_entry(ne
->csr
, kv
, ne
->csr
->root_kv
, dentry
) {
1122 switch (kv
->key
.id
) {
1123 case CSR1212_KV_ID_VENDOR
:
1124 ne
->vendor_id
= kv
->value
.immediate
;
1127 case CSR1212_KV_ID_NODE_CAPABILITIES
:
1128 ne
->capabilities
= kv
->value
.immediate
;
1131 case CSR1212_KV_ID_UNIT
:
1132 nodemgr_process_unit_directory(hi
, ne
, kv
, &ud_id
, NULL
);
1135 case CSR1212_KV_ID_DESCRIPTOR
:
1136 if (last_key_id
== CSR1212_KV_ID_VENDOR
) {
1137 if (kv
->key
.type
== CSR1212_KV_TYPE_LEAF
&&
1138 CSR1212_DESCRIPTOR_LEAF_TYPE(kv
) == 0 &&
1139 CSR1212_DESCRIPTOR_LEAF_SPECIFIER_ID(kv
) == 0 &&
1140 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_WIDTH(kv
) == 0 &&
1141 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_CHAR_SET(kv
) == 0 &&
1142 CSR1212_TEXTUAL_DESCRIPTOR_LEAF_LANGUAGE(kv
) == 0) {
1143 ne
->vendor_name_kv
= kv
;
1144 csr1212_keep_keyval(kv
);
1149 last_key_id
= kv
->key
.id
;
1152 if (ne
->vendor_name_kv
) {
1153 int error
= device_create_file(&ne
->device
,
1154 &dev_attr_ne_vendor_name_kv
);
1156 if (error
&& error
!= -EEXIST
)
1157 HPSB_ERR("Failed to add sysfs attribute");
1161 #ifdef CONFIG_HOTPLUG
1163 static int nodemgr_uevent(struct device
*dev
, char **envp
, int num_envp
,
1164 char *buffer
, int buffer_size
)
1166 struct unit_directory
*ud
;
1170 /* ieee1394:venNmoNspNverN */
1171 char buf
[8 + 1 + 3 + 8 + 2 + 8 + 2 + 8 + 3 + 8 + 1];
1176 ud
= container_of(dev
, struct unit_directory
, unit_dev
);
1178 if (ud
->ne
->in_limbo
|| ud
->ignore_driver
)
1181 #define PUT_ENVP(fmt,val) \
1183 retval = add_uevent_var(envp, num_envp, &i, \
1184 buffer, buffer_size, &length, \
1190 PUT_ENVP("VENDOR_ID=%06x", ud
->vendor_id
);
1191 PUT_ENVP("MODEL_ID=%06x", ud
->model_id
);
1192 PUT_ENVP("GUID=%016Lx", (unsigned long long)ud
->ne
->guid
);
1193 PUT_ENVP("SPECIFIER_ID=%06x", ud
->specifier_id
);
1194 PUT_ENVP("VERSION=%06x", ud
->version
);
1195 snprintf(buf
, sizeof(buf
), "ieee1394:ven%08Xmo%08Xsp%08Xver%08X",
1200 PUT_ENVP("MODALIAS=%s", buf
);
1211 static int nodemgr_uevent(struct device
*dev
, char **envp
, int num_envp
,
1212 char *buffer
, int buffer_size
)
1217 #endif /* CONFIG_HOTPLUG */
1220 int __hpsb_register_protocol(struct hpsb_protocol_driver
*drv
,
1221 struct module
*owner
)
1225 drv
->driver
.bus
= &ieee1394_bus_type
;
1226 drv
->driver
.owner
= owner
;
1227 drv
->driver
.name
= drv
->name
;
1229 /* This will cause a probe for devices */
1230 error
= driver_register(&drv
->driver
);
1232 nodemgr_create_drv_files(drv
);
1236 void hpsb_unregister_protocol(struct hpsb_protocol_driver
*driver
)
1238 nodemgr_remove_drv_files(driver
);
1239 /* This will subsequently disconnect all devices that our driver
1240 * is attached to. */
1241 driver_unregister(&driver
->driver
);
1246 * This function updates nodes that were present on the bus before the
1247 * reset and still are after the reset. The nodeid and the config rom
1248 * may have changed, and the drivers managing this device must be
1249 * informed that this device just went through a bus reset, to allow
1250 * the to take whatever actions required.
1252 static void nodemgr_update_node(struct node_entry
*ne
, struct csr1212_csr
*csr
,
1253 struct host_info
*hi
, nodeid_t nodeid
,
1254 unsigned int generation
)
1256 if (ne
->nodeid
!= nodeid
) {
1257 HPSB_DEBUG("Node changed: " NODE_BUS_FMT
" -> " NODE_BUS_FMT
,
1258 NODE_BUS_ARGS(ne
->host
, ne
->nodeid
),
1259 NODE_BUS_ARGS(ne
->host
, nodeid
));
1260 ne
->nodeid
= nodeid
;
1263 if (ne
->busopt
.generation
!= ((be32_to_cpu(csr
->bus_info_data
[2]) >> 4) & 0xf)) {
1264 kfree(ne
->csr
->private);
1265 csr1212_destroy_csr(ne
->csr
);
1268 /* If the node's configrom generation has changed, we
1269 * unregister all the unit directories. */
1270 nodemgr_remove_uds(ne
);
1272 nodemgr_update_bus_options(ne
);
1274 /* Mark the node as new, so it gets re-probed */
1275 ne
->needs_probe
= 1;
1277 /* old cache is valid, so update its generation */
1278 struct nodemgr_csr_info
*ci
= ne
->csr
->private;
1279 ci
->generation
= generation
;
1280 /* free the partially filled now unneeded new cache */
1281 kfree(csr
->private);
1282 csr1212_destroy_csr(csr
);
1286 nodemgr_resume_ne(ne
);
1288 /* Mark the node current */
1289 ne
->generation
= generation
;
1294 static void nodemgr_node_scan_one(struct host_info
*hi
,
1295 nodeid_t nodeid
, int generation
)
1297 struct hpsb_host
*host
= hi
->host
;
1298 struct node_entry
*ne
;
1300 struct csr1212_csr
*csr
;
1301 struct nodemgr_csr_info
*ci
;
1304 ci
= kmalloc(sizeof(*ci
), GFP_KERNEL
);
1309 ci
->nodeid
= nodeid
;
1310 ci
->generation
= generation
;
1312 /* Prepare for speed probe which occurs when reading the ROM */
1313 speed
= &(host
->speed
[NODEID_TO_NODE(nodeid
)]);
1314 if (*speed
> host
->csr
.lnk_spd
)
1315 *speed
= host
->csr
.lnk_spd
;
1316 ci
->speed_unverified
= *speed
> IEEE1394_SPEED_100
;
1318 /* We need to detect when the ConfigROM's generation has changed,
1319 * so we only update the node's info when it needs to be. */
1321 csr
= csr1212_create_csr(&nodemgr_csr_ops
, 5 * sizeof(quadlet_t
), ci
);
1322 if (!csr
|| csr1212_parse_csr(csr
) != CSR1212_SUCCESS
) {
1323 HPSB_ERR("Error parsing configrom for node " NODE_BUS_FMT
,
1324 NODE_BUS_ARGS(host
, nodeid
));
1326 csr1212_destroy_csr(csr
);
1331 if (csr
->bus_info_data
[1] != IEEE1394_BUSID_MAGIC
) {
1332 /* This isn't a 1394 device, but we let it slide. There
1333 * was a report of a device with broken firmware which
1334 * reported '2394' instead of '1394', which is obviously a
1335 * mistake. One would hope that a non-1394 device never
1336 * gets connected to Firewire bus. If someone does, we
1337 * shouldn't be held responsible, so we'll allow it with a
1339 HPSB_WARN("Node " NODE_BUS_FMT
" has invalid busID magic [0x%08x]",
1340 NODE_BUS_ARGS(host
, nodeid
), csr
->bus_info_data
[1]);
1343 guid
= ((u64
)be32_to_cpu(csr
->bus_info_data
[3]) << 32) | be32_to_cpu(csr
->bus_info_data
[4]);
1344 ne
= find_entry_by_guid(guid
);
1346 if (ne
&& ne
->host
!= host
&& ne
->in_limbo
) {
1347 /* Must have moved this device from one host to another */
1348 nodemgr_remove_ne(ne
);
1353 nodemgr_create_node(guid
, csr
, hi
, nodeid
, generation
);
1355 nodemgr_update_node(ne
, csr
, hi
, nodeid
, generation
);
1359 static void nodemgr_node_scan(struct host_info
*hi
, int generation
)
1362 struct hpsb_host
*host
= hi
->host
;
1363 struct selfid
*sid
= (struct selfid
*)host
->topology_map
;
1364 nodeid_t nodeid
= LOCAL_BUS
;
1366 /* Scan each node on the bus */
1367 for (count
= host
->selfid_count
; count
; count
--, sid
++) {
1371 if (!sid
->link_active
) {
1375 nodemgr_node_scan_one(hi
, nodeid
++, generation
);
1380 static void nodemgr_suspend_ne(struct node_entry
*ne
)
1383 struct unit_directory
*ud
;
1384 struct device_driver
*drv
;
1387 HPSB_DEBUG("Node suspended: ID:BUS[" NODE_BUS_FMT
"] GUID[%016Lx]",
1388 NODE_BUS_ARGS(ne
->host
, ne
->nodeid
), (unsigned long long)ne
->guid
);
1391 WARN_ON(device_create_file(&ne
->device
, &dev_attr_ne_in_limbo
));
1393 down(&nodemgr_ud_class
.sem
);
1394 list_for_each_entry(dev
, &nodemgr_ud_class
.devices
, node
) {
1395 ud
= container_of(dev
, struct unit_directory
, unit_dev
);
1399 drv
= get_driver(ud
->device
.driver
);
1403 error
= 1; /* release if suspend is not implemented */
1405 down(&ud
->device
.sem
);
1406 error
= drv
->suspend(&ud
->device
, PMSG_SUSPEND
);
1407 up(&ud
->device
.sem
);
1410 device_release_driver(&ud
->device
);
1413 up(&nodemgr_ud_class
.sem
);
1417 static void nodemgr_resume_ne(struct node_entry
*ne
)
1420 struct unit_directory
*ud
;
1421 struct device_driver
*drv
;
1424 device_remove_file(&ne
->device
, &dev_attr_ne_in_limbo
);
1426 down(&nodemgr_ud_class
.sem
);
1427 list_for_each_entry(dev
, &nodemgr_ud_class
.devices
, node
) {
1428 ud
= container_of(dev
, struct unit_directory
, unit_dev
);
1432 drv
= get_driver(ud
->device
.driver
);
1437 down(&ud
->device
.sem
);
1438 drv
->resume(&ud
->device
);
1439 up(&ud
->device
.sem
);
1443 up(&nodemgr_ud_class
.sem
);
1445 HPSB_DEBUG("Node resumed: ID:BUS[" NODE_BUS_FMT
"] GUID[%016Lx]",
1446 NODE_BUS_ARGS(ne
->host
, ne
->nodeid
), (unsigned long long)ne
->guid
);
1450 static void nodemgr_update_pdrv(struct node_entry
*ne
)
1453 struct unit_directory
*ud
;
1454 struct device_driver
*drv
;
1455 struct hpsb_protocol_driver
*pdrv
;
1458 down(&nodemgr_ud_class
.sem
);
1459 list_for_each_entry(dev
, &nodemgr_ud_class
.devices
, node
) {
1460 ud
= container_of(dev
, struct unit_directory
, unit_dev
);
1464 drv
= get_driver(ud
->device
.driver
);
1469 pdrv
= container_of(drv
, struct hpsb_protocol_driver
, driver
);
1471 down(&ud
->device
.sem
);
1472 error
= pdrv
->update(ud
);
1473 up(&ud
->device
.sem
);
1476 device_release_driver(&ud
->device
);
1479 up(&nodemgr_ud_class
.sem
);
1483 /* Write the BROADCAST_CHANNEL as per IEEE1394a 8.3.2.3.11 and 8.4.2.3. This
1484 * seems like an optional service but in the end it is practically mandatory
1485 * as a consequence of these clauses.
1487 * Note that we cannot do a broadcast write to all nodes at once because some
1488 * pre-1394a devices would hang. */
1489 static void nodemgr_irm_write_bc(struct node_entry
*ne
, int generation
)
1491 const u64 bc_addr
= (CSR_REGISTER_BASE
| CSR_BROADCAST_CHANNEL
);
1492 quadlet_t bc_remote
, bc_local
;
1495 if (!ne
->host
->is_irm
|| ne
->generation
!= generation
||
1496 ne
->nodeid
== ne
->host
->node_id
)
1499 bc_local
= cpu_to_be32(ne
->host
->csr
.broadcast_channel
);
1501 /* Check if the register is implemented and 1394a compliant. */
1502 error
= hpsb_read(ne
->host
, ne
->nodeid
, generation
, bc_addr
, &bc_remote
,
1504 if (!error
&& bc_remote
& cpu_to_be32(0x80000000) &&
1505 bc_remote
!= bc_local
)
1506 hpsb_node_write(ne
, bc_addr
, &bc_local
, sizeof(bc_local
));
1510 static void nodemgr_probe_ne(struct host_info
*hi
, struct node_entry
*ne
, int generation
)
1514 if (ne
->host
!= hi
->host
|| ne
->in_limbo
)
1517 dev
= get_device(&ne
->device
);
1521 nodemgr_irm_write_bc(ne
, generation
);
1523 /* If "needs_probe", then this is either a new or changed node we
1524 * rescan totally. If the generation matches for an existing node
1525 * (one that existed prior to the bus reset) we send update calls
1526 * down to the drivers. Otherwise, this is a dead node and we
1528 if (ne
->needs_probe
)
1529 nodemgr_process_root_directory(hi
, ne
);
1530 else if (ne
->generation
== generation
)
1531 nodemgr_update_pdrv(ne
);
1533 nodemgr_suspend_ne(ne
);
1539 static void nodemgr_node_probe(struct host_info
*hi
, int generation
)
1541 struct hpsb_host
*host
= hi
->host
;
1543 struct node_entry
*ne
;
1545 /* Do some processing of the nodes we've probed. This pulls them
1546 * into the sysfs layer if needed, and can result in processing of
1547 * unit-directories, or just updating the node and it's
1550 * Run updates before probes. Usually, updates are time-critical
1551 * while probes are time-consuming. (Well, those probes need some
1552 * improvement...) */
1554 down(&nodemgr_ne_class
.sem
);
1555 list_for_each_entry(dev
, &nodemgr_ne_class
.devices
, node
) {
1556 ne
= container_of(dev
, struct node_entry
, node_dev
);
1557 if (!ne
->needs_probe
)
1558 nodemgr_probe_ne(hi
, ne
, generation
);
1560 list_for_each_entry(dev
, &nodemgr_ne_class
.devices
, node
) {
1561 ne
= container_of(dev
, struct node_entry
, node_dev
);
1562 if (ne
->needs_probe
)
1563 nodemgr_probe_ne(hi
, ne
, generation
);
1565 up(&nodemgr_ne_class
.sem
);
1568 /* If we had a bus reset while we were scanning the bus, it is
1569 * possible that we did not probe all nodes. In that case, we
1570 * skip the clean up for now, since we could remove nodes that
1571 * were still on the bus. Another bus scan is pending which will
1572 * do the clean up eventually.
1574 * Now let's tell the bus to rescan our devices. This may seem
1575 * like overhead, but the driver-model core will only scan a
1576 * device for a driver when either the device is added, or when a
1577 * new driver is added. A bus reset is a good reason to rescan
1578 * devices that were there before. For example, an sbp2 device
1579 * may become available for login, if the host that held it was
1582 if (generation
== get_hpsb_generation(host
))
1583 if (bus_rescan_devices(&ieee1394_bus_type
))
1584 HPSB_DEBUG("bus_rescan_devices had an error");
1587 static int nodemgr_send_resume_packet(struct hpsb_host
*host
)
1589 struct hpsb_packet
*packet
;
1590 int error
= -ENOMEM
;
1592 packet
= hpsb_make_phypacket(host
,
1593 EXTPHYPACKET_TYPE_RESUME
|
1594 NODEID_TO_NODE(host
->node_id
) << PHYPACKET_PORT_SHIFT
);
1596 packet
->no_waiter
= 1;
1597 packet
->generation
= get_hpsb_generation(host
);
1598 error
= hpsb_send_packet(packet
);
1601 HPSB_WARN("fw-host%d: Failed to broadcast resume packet",
1606 /* Perform a few high-level IRM responsibilities. */
1607 static int nodemgr_do_irm_duties(struct hpsb_host
*host
, int cycles
)
1611 /* if irm_id == -1 then there is no IRM on this bus */
1612 if (!host
->is_irm
|| host
->irm_id
== (nodeid_t
)-1)
1615 /* We are a 1394a-2000 compliant IRM. Set the validity bit. */
1616 host
->csr
.broadcast_channel
|= 0x40000000;
1618 /* If there is no bus manager then we should set the root node's
1619 * force_root bit to promote bus stability per the 1394
1620 * spec. (8.4.2.6) */
1621 if (host
->busmgr_id
== 0xffff && host
->node_count
> 1)
1623 u16 root_node
= host
->node_count
- 1;
1625 /* get cycle master capability flag from root node */
1626 if (host
->is_cycmst
||
1627 (!hpsb_read(host
, LOCAL_BUS
| root_node
, get_hpsb_generation(host
),
1628 (CSR_REGISTER_BASE
+ CSR_CONFIG_ROM
+ 2 * sizeof(quadlet_t
)),
1629 &bc
, sizeof(quadlet_t
)) &&
1630 be32_to_cpu(bc
) & 1 << CSR_CMC_SHIFT
))
1631 hpsb_send_phy_config(host
, root_node
, -1);
1633 HPSB_DEBUG("The root node is not cycle master capable; "
1634 "selecting a new root node and resetting...");
1637 /* Oh screw it! Just leave the bus as it is */
1638 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1642 hpsb_send_phy_config(host
, NODEID_TO_NODE(host
->node_id
), -1);
1643 hpsb_reset_bus(host
, LONG_RESET_FORCE_ROOT
);
1649 /* Some devices suspend their ports while being connected to an inactive
1650 * host adapter, i.e. if connected before the low-level driver is
1651 * loaded. They become visible either when physically unplugged and
1652 * replugged, or when receiving a resume packet. Send one once. */
1653 if (!host
->resume_packet_sent
&& !nodemgr_send_resume_packet(host
))
1654 host
->resume_packet_sent
= 1;
1659 /* We need to ensure that if we are not the IRM, that the IRM node is capable of
1660 * everything we can do, otherwise issue a bus reset and try to become the IRM
1662 static int nodemgr_check_irm_capability(struct hpsb_host
*host
, int cycles
)
1667 if (hpsb_disable_irm
|| host
->is_irm
)
1670 status
= hpsb_read(host
, LOCAL_BUS
| (host
->irm_id
),
1671 get_hpsb_generation(host
),
1672 (CSR_REGISTER_BASE
| CSR_BROADCAST_CHANNEL
),
1673 &bc
, sizeof(quadlet_t
));
1675 if (status
< 0 || !(be32_to_cpu(bc
) & 0x80000000)) {
1676 /* The current irm node does not have a valid BROADCAST_CHANNEL
1677 * register and we do, so reset the bus with force_root set */
1678 HPSB_DEBUG("Current remote IRM is not 1394a-2000 compliant, resetting...");
1681 /* Oh screw it! Just leave the bus as it is */
1682 HPSB_DEBUG("Stopping reset loop for IRM sanity");
1686 hpsb_send_phy_config(host
, NODEID_TO_NODE(host
->node_id
), -1);
1687 hpsb_reset_bus(host
, LONG_RESET_FORCE_ROOT
);
1695 static int nodemgr_host_thread(void *__hi
)
1697 struct host_info
*hi
= (struct host_info
*)__hi
;
1698 struct hpsb_host
*host
= hi
->host
;
1699 unsigned int g
, generation
= 0;
1700 int i
, reset_cycles
= 0;
1703 /* Setup our device-model entries */
1704 nodemgr_create_host_dev_files(host
);
1707 /* Sleep until next bus reset */
1708 set_current_state(TASK_INTERRUPTIBLE
);
1709 if (get_hpsb_generation(host
) == generation
&&
1710 !kthread_should_stop())
1712 __set_current_state(TASK_RUNNING
);
1714 /* Thread may have been woken up to freeze or to exit */
1715 if (try_to_freeze())
1717 if (kthread_should_stop())
1720 /* Pause for 1/4 second in 1/16 second intervals,
1721 * to make sure things settle down. */
1722 g
= get_hpsb_generation(host
);
1723 for (i
= 0; i
< 4 ; i
++) {
1724 if (msleep_interruptible(63) || kthread_should_stop())
1727 /* Now get the generation in which the node ID's we collect
1728 * are valid. During the bus scan we will use this generation
1729 * for the read transactions, so that if another reset occurs
1730 * during the scan the transactions will fail instead of
1731 * returning bogus data. */
1732 generation
= get_hpsb_generation(host
);
1734 /* If we get a reset before we are done waiting, then
1735 * start the waiting over again */
1736 if (generation
!= g
)
1737 g
= generation
, i
= 0;
1740 if (!nodemgr_check_irm_capability(host
, reset_cycles
) ||
1741 !nodemgr_do_irm_duties(host
, reset_cycles
)) {
1747 /* Scan our nodes to get the bus options and create node
1748 * entries. This does not do the sysfs stuff, since that
1749 * would trigger uevents and such, which is a bad idea at
1751 nodemgr_node_scan(hi
, generation
);
1753 /* This actually does the full probe, with sysfs
1755 nodemgr_node_probe(hi
, generation
);
1757 /* Update some of our sysfs symlinks */
1758 nodemgr_update_host_dev_links(host
);
1761 HPSB_VERBOSE("NodeMgr: Exiting thread");
1766 * nodemgr_for_each_host - call a function for each IEEE 1394 host
1767 * @data: an address to supply to the callback
1768 * @cb: function to call for each host
1770 * Iterate the hosts, calling a given function with supplied data for each host.
1771 * If the callback fails on a host, i.e. if it returns a non-zero value, the
1772 * iteration is stopped.
1774 * Return value: 0 on success, non-zero on failure (same as returned by last run
1777 int nodemgr_for_each_host(void *data
, int (*cb
)(struct hpsb_host
*, void *))
1780 struct hpsb_host
*host
;
1783 down(&hpsb_host_class
.sem
);
1784 list_for_each_entry(dev
, &hpsb_host_class
.devices
, node
) {
1785 host
= container_of(dev
, struct hpsb_host
, host_dev
);
1787 if ((error
= cb(host
, data
)))
1790 up(&hpsb_host_class
.sem
);
1795 /* The following two convenience functions use a struct node_entry
1796 * for addressing a node on the bus. They are intended for use by any
1797 * process context, not just the nodemgr thread, so we need to be a
1798 * little careful when reading out the node ID and generation. The
1799 * thing that can go wrong is that we get the node ID, then a bus
1800 * reset occurs, and then we read the generation. The node ID is
1801 * possibly invalid, but the generation is current, and we end up
1802 * sending a packet to a the wrong node.
1804 * The solution is to make sure we read the generation first, so that
1805 * if a reset occurs in the process, we end up with a stale generation
1806 * and the transactions will fail instead of silently using wrong node
1811 * hpsb_node_fill_packet - fill some destination information into a packet
1812 * @ne: destination node
1813 * @packet: packet to fill in
1815 * This will fill in the given, pre-initialised hpsb_packet with the current
1816 * information from the node entry (host, node ID, bus generation number).
1818 void hpsb_node_fill_packet(struct node_entry
*ne
, struct hpsb_packet
*packet
)
1820 packet
->host
= ne
->host
;
1821 packet
->generation
= ne
->generation
;
1823 packet
->node_id
= ne
->nodeid
;
1826 int hpsb_node_write(struct node_entry
*ne
, u64 addr
,
1827 quadlet_t
*buffer
, size_t length
)
1829 unsigned int generation
= ne
->generation
;
1832 return hpsb_write(ne
->host
, ne
->nodeid
, generation
,
1833 addr
, buffer
, length
);
1836 static void nodemgr_add_host(struct hpsb_host
*host
)
1838 struct host_info
*hi
;
1840 hi
= hpsb_create_hostinfo(&nodemgr_highlevel
, host
, sizeof(*hi
));
1842 HPSB_ERR("NodeMgr: out of memory in add host");
1846 hi
->thread
= kthread_run(nodemgr_host_thread
, hi
, "knodemgrd_%d",
1848 if (IS_ERR(hi
->thread
)) {
1849 HPSB_ERR("NodeMgr: cannot start thread for host %d", host
->id
);
1850 hpsb_destroy_hostinfo(&nodemgr_highlevel
, host
);
1854 static void nodemgr_host_reset(struct hpsb_host
*host
)
1856 struct host_info
*hi
= hpsb_get_hostinfo(&nodemgr_highlevel
, host
);
1859 HPSB_VERBOSE("NodeMgr: Processing reset for host %d", host
->id
);
1860 wake_up_process(hi
->thread
);
1864 static void nodemgr_remove_host(struct hpsb_host
*host
)
1866 struct host_info
*hi
= hpsb_get_hostinfo(&nodemgr_highlevel
, host
);
1869 kthread_stop(hi
->thread
);
1870 nodemgr_remove_host_dev(&host
->device
);
1874 static struct hpsb_highlevel nodemgr_highlevel
= {
1875 .name
= "Node manager",
1876 .add_host
= nodemgr_add_host
,
1877 .host_reset
= nodemgr_host_reset
,
1878 .remove_host
= nodemgr_remove_host
,
1881 int init_ieee1394_nodemgr(void)
1885 error
= class_register(&nodemgr_ne_class
);
1888 error
= class_register(&nodemgr_ud_class
);
1891 error
= driver_register(&nodemgr_mid_layer_driver
);
1894 /* This driver is not used if nodemgr is off (disable_nodemgr=1). */
1895 nodemgr_dev_template_host
.driver
= &nodemgr_mid_layer_driver
;
1897 hpsb_register_highlevel(&nodemgr_highlevel
);
1901 class_unregister(&nodemgr_ud_class
);
1903 class_unregister(&nodemgr_ne_class
);
1908 void cleanup_ieee1394_nodemgr(void)
1910 hpsb_unregister_highlevel(&nodemgr_highlevel
);
1911 driver_unregister(&nodemgr_mid_layer_driver
);
1912 class_unregister(&nodemgr_ud_class
);
1913 class_unregister(&nodemgr_ne_class
);