998 obsolete DMA driver interfaces should be removed
[unleashed.git] / usr / src / uts / common / os / devcfg.c
blobd11c6fb7b77d5e6b2ada72ed5e39521c5efaf9aa
1 /*
2 * CDDL HEADER START
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
19 * CDDL HEADER END
22 * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright 2012 Nexenta Systems, Inc. All rights reserved.
24 * Copyright 2012 Garrett D'Amore <garrett@damore.org>. All rights reserved.
27 #include <sys/note.h>
28 #include <sys/t_lock.h>
29 #include <sys/cmn_err.h>
30 #include <sys/instance.h>
31 #include <sys/conf.h>
32 #include <sys/stat.h>
33 #include <sys/ddi.h>
34 #include <sys/hwconf.h>
35 #include <sys/sunddi.h>
36 #include <sys/sunndi.h>
37 #include <sys/ddi_impldefs.h>
38 #include <sys/ndi_impldefs.h>
39 #include <sys/modctl.h>
40 #include <sys/contract/device_impl.h>
41 #include <sys/dacf.h>
42 #include <sys/promif.h>
43 #include <sys/pci.h>
44 #include <sys/cpuvar.h>
45 #include <sys/pathname.h>
46 #include <sys/taskq.h>
47 #include <sys/sysevent.h>
48 #include <sys/sunmdi.h>
49 #include <sys/stream.h>
50 #include <sys/strsubr.h>
51 #include <sys/fs/snode.h>
52 #include <sys/fs/dv_node.h>
53 #include <sys/reboot.h>
54 #include <sys/sysmacros.h>
55 #include <sys/systm.h>
56 #include <sys/fs/sdev_impl.h>
57 #include <sys/sunldi.h>
58 #include <sys/sunldi_impl.h>
59 #include <sys/bootprops.h>
60 #include <sys/varargs.h>
61 #include <sys/modhash.h>
62 #include <sys/instance.h>
64 #if defined(__amd64) && !defined(__xpv)
65 #include <sys/iommulib.h>
66 #endif
68 #ifdef DEBUG
69 int ddidebug = DDI_AUDIT;
70 #else
71 int ddidebug = 0;
72 #endif
74 #define MT_CONFIG_OP 0
75 #define MT_UNCONFIG_OP 1
77 /* Multi-threaded configuration */
78 struct mt_config_handle {
79 kmutex_t mtc_lock;
80 kcondvar_t mtc_cv;
81 int mtc_thr_count;
82 dev_info_t *mtc_pdip; /* parent dip for mt_config_children */
83 dev_info_t **mtc_fdip; /* "a" dip where unconfigure failed */
84 major_t mtc_parmajor; /* parent major for mt_config_driver */
85 major_t mtc_major;
86 int mtc_flags;
87 int mtc_op; /* config or unconfig */
88 int mtc_error; /* operation error */
89 struct brevq_node **mtc_brevqp; /* outstanding branch events queue */
90 #ifdef DEBUG
91 int total_time;
92 timestruc_t start_time;
93 #endif /* DEBUG */
96 struct devi_nodeid {
97 pnode_t nodeid;
98 dev_info_t *dip;
99 struct devi_nodeid *next;
102 struct devi_nodeid_list {
103 kmutex_t dno_lock; /* Protects other fields */
104 struct devi_nodeid *dno_head; /* list of devi nodeid elements */
105 struct devi_nodeid *dno_free; /* Free list */
106 uint_t dno_list_length; /* number of dips in list */
109 /* used to keep track of branch remove events to be generated */
110 struct brevq_node {
111 char *brn_deviname;
112 struct brevq_node *brn_sibling;
113 struct brevq_node *brn_child;
116 static struct devi_nodeid_list devi_nodeid_list;
117 static struct devi_nodeid_list *devimap = &devi_nodeid_list;
120 * Well known nodes which are attached first at boot time.
122 dev_info_t *top_devinfo; /* root of device tree */
123 dev_info_t *options_dip;
124 dev_info_t *pseudo_dip;
125 dev_info_t *clone_dip;
126 dev_info_t *scsi_vhci_dip; /* MPXIO dip */
127 major_t clone_major;
130 * A non-global zone's /dev is derived from the device tree.
131 * This generation number serves to indicate when a zone's
132 * /dev may need to be updated.
134 volatile ulong_t devtree_gen; /* generation number */
136 /* block all future dev_info state changes */
137 hrtime_t volatile devinfo_freeze = 0;
139 /* number of dev_info attaches/detaches currently in progress */
140 static ulong_t devinfo_attach_detach = 0;
142 extern int sys_shutdown;
143 extern kmutex_t global_vhci_lock;
145 /* bitset of DS_SYSAVAIL & DS_RECONFIG - no races, no lock */
146 static int devname_state = 0;
149 * The devinfo snapshot cache and related variables.
150 * The only field in the di_cache structure that needs initialization
151 * is the mutex (cache_lock). However, since this is an adaptive mutex
152 * (MUTEX_DEFAULT) - it is automatically initialized by being allocated
153 * in zeroed memory (static storage class). Therefore no explicit
154 * initialization of the di_cache structure is needed.
156 struct di_cache di_cache = {1};
157 int di_cache_debug = 0;
159 /* For ddvis, which needs pseudo children under PCI */
160 int pci_allow_pseudo_children = 0;
162 /* Allow path-oriented alias driver binding on driver.conf enumerated nodes */
163 int driver_conf_allow_path_alias = 1;
166 * The following switch is for service people, in case a
167 * 3rd party driver depends on identify(9e) being called.
169 int identify_9e = 0;
172 * Add flag so behaviour of preventing attach for retired persistant nodes
173 * can be disabled.
175 int retire_prevents_attach = 1;
177 int mtc_off; /* turn off mt config */
179 int quiesce_debug = 0;
181 boolean_t ddi_aliases_present = B_FALSE;
182 ddi_alias_t ddi_aliases;
183 uint_t tsd_ddi_redirect;
185 #define DDI_ALIAS_HASH_SIZE (2700)
187 static kmem_cache_t *ddi_node_cache; /* devinfo node cache */
188 static devinfo_log_header_t *devinfo_audit_log; /* devinfo log */
189 static int devinfo_log_size; /* size in pages */
191 boolean_t ddi_err_panic = B_FALSE;
193 static int lookup_compatible(dev_info_t *, uint_t);
194 static char *encode_composite_string(char **, uint_t, size_t *, uint_t);
195 static void link_to_driver_list(dev_info_t *);
196 static void unlink_from_driver_list(dev_info_t *);
197 static void add_to_dn_list(struct devnames *, dev_info_t *);
198 static void remove_from_dn_list(struct devnames *, dev_info_t *);
199 static dev_info_t *find_duplicate_child();
200 static void add_global_props(dev_info_t *);
201 static void remove_global_props(dev_info_t *);
202 static int uninit_node(dev_info_t *);
203 static void da_log_init(void);
204 static void da_log_enter(dev_info_t *);
205 static int walk_devs(dev_info_t *, int (*f)(dev_info_t *, void *), void *, int);
206 static int reset_nexus_flags(dev_info_t *, void *);
207 static void ddi_optimize_dtree(dev_info_t *);
208 static int is_leaf_node(dev_info_t *);
209 static struct mt_config_handle *mt_config_init(dev_info_t *, dev_info_t **,
210 int, major_t, int, struct brevq_node **);
211 static void mt_config_children(struct mt_config_handle *);
212 static void mt_config_driver(struct mt_config_handle *);
213 static int mt_config_fini(struct mt_config_handle *);
214 static int devi_unconfig_common(dev_info_t *, dev_info_t **, int, major_t,
215 struct brevq_node **);
216 static int
217 ndi_devi_config_obp_args(dev_info_t *parent, char *devnm,
218 dev_info_t **childp, int flags);
219 static void i_link_vhci_node(dev_info_t *);
220 static void ndi_devi_exit_and_wait(dev_info_t *dip,
221 int circular, clock_t end_time);
222 static int ndi_devi_unbind_driver(dev_info_t *dip);
224 static int i_ddi_check_retire(dev_info_t *dip);
226 static void quiesce_one_device(dev_info_t *, void *);
228 dev_info_t *ddi_alias_redirect(char *alias);
229 char *ddi_curr_redirect(char *currpath);
233 * dev_info cache and node management
236 /* initialize dev_info node cache */
237 void
238 i_ddi_node_cache_init()
240 ASSERT(ddi_node_cache == NULL);
241 ddi_node_cache = kmem_cache_create("dev_info_node_cache",
242 sizeof (struct dev_info), 0, NULL, NULL, NULL, NULL, NULL, 0);
244 if (ddidebug & DDI_AUDIT)
245 da_log_init();
250 * Allocating a dev_info node, callable from interrupt context with KM_NOSLEEP
251 * The allocated node has a reference count of 0.
253 dev_info_t *
254 i_ddi_alloc_node(dev_info_t *pdip, char *node_name, pnode_t nodeid,
255 int instance, ddi_prop_t *sys_prop, int flag)
257 struct dev_info *devi;
258 struct devi_nodeid *elem;
259 static char failed[] = "i_ddi_alloc_node: out of memory";
261 ASSERT(node_name != NULL);
263 if ((devi = kmem_cache_alloc(ddi_node_cache, flag)) == NULL) {
264 cmn_err(CE_NOTE, failed);
265 return (NULL);
268 bzero(devi, sizeof (struct dev_info));
270 if (devinfo_audit_log) {
271 devi->devi_audit = kmem_zalloc(sizeof (devinfo_audit_t), flag);
272 if (devi->devi_audit == NULL)
273 goto fail;
276 if ((devi->devi_node_name = i_ddi_strdup(node_name, flag)) == NULL)
277 goto fail;
279 /* default binding name is node name */
280 devi->devi_binding_name = devi->devi_node_name;
281 devi->devi_major = DDI_MAJOR_T_NONE; /* unbound by default */
284 * Make a copy of system property
286 if (sys_prop &&
287 (devi->devi_sys_prop_ptr = i_ddi_prop_list_dup(sys_prop, flag))
288 == NULL)
289 goto fail;
292 * Assign devi_nodeid, devi_node_class, devi_node_attributes
293 * according to the following algorithm:
295 * nodeid arg node class node attributes
297 * DEVI_PSEUDO_NODEID DDI_NC_PSEUDO A
298 * DEVI_SID_NODEID DDI_NC_PSEUDO A,P
299 * DEVI_SID_HIDDEN_NODEID DDI_NC_PSEUDO A,P,H
300 * DEVI_SID_HP_NODEID DDI_NC_PSEUDO A,P,h
301 * DEVI_SID_HP_HIDDEN_NODEID DDI_NC_PSEUDO A,P,H,h
302 * other DDI_NC_PROM P
304 * Where A = DDI_AUTO_ASSIGNED_NODEID (auto-assign a nodeid)
305 * and P = DDI_PERSISTENT
306 * and H = DDI_HIDDEN_NODE
307 * and h = DDI_HOTPLUG_NODE
309 * auto-assigned nodeids are also auto-freed.
311 devi->devi_node_attributes = 0;
312 switch (nodeid) {
313 case DEVI_SID_HIDDEN_NODEID:
314 devi->devi_node_attributes |= DDI_HIDDEN_NODE;
315 goto sid;
317 case DEVI_SID_HP_NODEID:
318 devi->devi_node_attributes |= DDI_HOTPLUG_NODE;
319 goto sid;
321 case DEVI_SID_HP_HIDDEN_NODEID:
322 devi->devi_node_attributes |= DDI_HIDDEN_NODE;
323 devi->devi_node_attributes |= DDI_HOTPLUG_NODE;
324 goto sid;
326 case DEVI_SID_NODEID:
327 sid: devi->devi_node_attributes |= DDI_PERSISTENT;
328 if ((elem = kmem_zalloc(sizeof (*elem), flag)) == NULL)
329 goto fail;
330 /*FALLTHROUGH*/
332 case DEVI_PSEUDO_NODEID:
333 devi->devi_node_attributes |= DDI_AUTO_ASSIGNED_NODEID;
334 devi->devi_node_class = DDI_NC_PSEUDO;
335 if (impl_ddi_alloc_nodeid(&devi->devi_nodeid)) {
336 panic("i_ddi_alloc_node: out of nodeids");
337 /*NOTREACHED*/
339 break;
341 default:
342 if ((elem = kmem_zalloc(sizeof (*elem), flag)) == NULL)
343 goto fail;
346 * the nodetype is 'prom', try to 'take' the nodeid now.
347 * This requires memory allocation, so check for failure.
349 if (impl_ddi_take_nodeid(nodeid, flag) != 0) {
350 kmem_free(elem, sizeof (*elem));
351 goto fail;
354 devi->devi_nodeid = nodeid;
355 devi->devi_node_class = DDI_NC_PROM;
356 devi->devi_node_attributes = DDI_PERSISTENT;
357 break;
360 if (ndi_dev_is_persistent_node((dev_info_t *)devi)) {
361 mutex_enter(&devimap->dno_lock);
362 elem->next = devimap->dno_free;
363 devimap->dno_free = elem;
364 mutex_exit(&devimap->dno_lock);
368 * Instance is normally initialized to -1. In a few special
369 * cases, the caller may specify an instance (e.g. CPU nodes).
371 devi->devi_instance = instance;
374 * set parent and bus_ctl parent
376 devi->devi_parent = DEVI(pdip);
377 devi->devi_bus_ctl = DEVI(pdip);
379 NDI_CONFIG_DEBUG((CE_CONT,
380 "i_ddi_alloc_node: name=%s id=%d\n", node_name, devi->devi_nodeid));
382 cv_init(&(devi->devi_cv), NULL, CV_DEFAULT, NULL);
383 mutex_init(&(devi->devi_lock), NULL, MUTEX_DEFAULT, NULL);
384 mutex_init(&(devi->devi_pm_lock), NULL, MUTEX_DEFAULT, NULL);
385 mutex_init(&(devi->devi_pm_busy_lock), NULL, MUTEX_DEFAULT, NULL);
387 RIO_TRACE((CE_NOTE, "i_ddi_alloc_node: Initing contract fields: "
388 "dip=%p, name=%s", (void *)devi, node_name));
390 mutex_init(&(devi->devi_ct_lock), NULL, MUTEX_DEFAULT, NULL);
391 cv_init(&(devi->devi_ct_cv), NULL, CV_DEFAULT, NULL);
392 devi->devi_ct_count = -1; /* counter not in use if -1 */
393 list_create(&(devi->devi_ct), sizeof (cont_device_t),
394 offsetof(cont_device_t, cond_next));
396 i_ddi_set_node_state((dev_info_t *)devi, DS_PROTO);
397 da_log_enter((dev_info_t *)devi);
398 return ((dev_info_t *)devi);
400 fail:
401 if (devi->devi_sys_prop_ptr)
402 i_ddi_prop_list_delete(devi->devi_sys_prop_ptr);
403 if (devi->devi_node_name)
404 kmem_free(devi->devi_node_name, strlen(node_name) + 1);
405 if (devi->devi_audit)
406 kmem_free(devi->devi_audit, sizeof (devinfo_audit_t));
407 kmem_cache_free(ddi_node_cache, devi);
408 cmn_err(CE_NOTE, failed);
409 return (NULL);
413 * free a dev_info structure.
414 * NB. Not callable from interrupt since impl_ddi_free_nodeid may block.
416 void
417 i_ddi_free_node(dev_info_t *dip)
419 struct dev_info *devi = DEVI(dip);
420 struct devi_nodeid *elem;
422 ASSERT(devi->devi_ref == 0);
423 ASSERT(devi->devi_addr == NULL);
424 ASSERT(devi->devi_node_state == DS_PROTO);
425 ASSERT(devi->devi_child == NULL);
426 ASSERT(devi->devi_hp_hdlp == NULL);
428 /* free devi_addr_buf allocated by ddi_set_name_addr() */
429 if (devi->devi_addr_buf)
430 kmem_free(devi->devi_addr_buf, 2 * MAXNAMELEN);
432 if (i_ndi_dev_is_auto_assigned_node(dip))
433 impl_ddi_free_nodeid(DEVI(dip)->devi_nodeid);
435 if (ndi_dev_is_persistent_node(dip)) {
436 mutex_enter(&devimap->dno_lock);
437 ASSERT(devimap->dno_free);
438 elem = devimap->dno_free;
439 devimap->dno_free = elem->next;
440 mutex_exit(&devimap->dno_lock);
441 kmem_free(elem, sizeof (*elem));
444 if (DEVI(dip)->devi_compat_names)
445 kmem_free(DEVI(dip)->devi_compat_names,
446 DEVI(dip)->devi_compat_length);
447 if (DEVI(dip)->devi_rebinding_name)
448 kmem_free(DEVI(dip)->devi_rebinding_name,
449 strlen(DEVI(dip)->devi_rebinding_name) + 1);
451 ddi_prop_remove_all(dip); /* remove driver properties */
452 if (devi->devi_sys_prop_ptr)
453 i_ddi_prop_list_delete(devi->devi_sys_prop_ptr);
454 if (devi->devi_hw_prop_ptr)
455 i_ddi_prop_list_delete(devi->devi_hw_prop_ptr);
457 if (DEVI(dip)->devi_devid_str)
458 ddi_devid_str_free(DEVI(dip)->devi_devid_str);
460 i_ddi_set_node_state(dip, DS_INVAL);
461 da_log_enter(dip);
462 if (devi->devi_audit) {
463 kmem_free(devi->devi_audit, sizeof (devinfo_audit_t));
465 if (devi->devi_device_class)
466 kmem_free(devi->devi_device_class,
467 strlen(devi->devi_device_class) + 1);
468 cv_destroy(&(devi->devi_cv));
469 mutex_destroy(&(devi->devi_lock));
470 mutex_destroy(&(devi->devi_pm_lock));
471 mutex_destroy(&(devi->devi_pm_busy_lock));
473 RIO_TRACE((CE_NOTE, "i_ddi_free_node: destroying contract fields: "
474 "dip=%p", (void *)dip));
475 contract_device_remove_dip(dip);
476 ASSERT(devi->devi_ct_count == -1);
477 ASSERT(list_is_empty(&(devi->devi_ct)));
478 cv_destroy(&(devi->devi_ct_cv));
479 list_destroy(&(devi->devi_ct));
480 /* free this last since contract_device_remove_dip() uses it */
481 mutex_destroy(&(devi->devi_ct_lock));
482 RIO_TRACE((CE_NOTE, "i_ddi_free_node: destroyed all contract fields: "
483 "dip=%p, name=%s", (void *)dip, devi->devi_node_name));
485 kmem_free(devi->devi_node_name, strlen(devi->devi_node_name) + 1);
487 /* free event data */
488 if (devi->devi_ev_path)
489 kmem_free(devi->devi_ev_path, MAXPATHLEN);
491 kmem_cache_free(ddi_node_cache, devi);
496 * Node state transitions
500 * Change the node name
503 ndi_devi_set_nodename(dev_info_t *dip, char *name, int flags)
505 _NOTE(ARGUNUSED(flags))
506 char *nname, *oname;
508 ASSERT(dip && name);
510 oname = DEVI(dip)->devi_node_name;
511 if (strcmp(oname, name) == 0)
512 return (DDI_SUCCESS);
515 * pcicfg_fix_ethernet requires a name change after node
516 * is linked into the tree. When pcicfg is fixed, we
517 * should only allow name change in DS_PROTO state.
519 if (i_ddi_node_state(dip) >= DS_BOUND) {
521 * Don't allow name change once node is bound
523 cmn_err(CE_NOTE,
524 "ndi_devi_set_nodename: node already bound dip = %p,"
525 " %s -> %s", (void *)dip, ddi_node_name(dip), name);
526 return (NDI_FAILURE);
529 nname = i_ddi_strdup(name, KM_SLEEP);
530 DEVI(dip)->devi_node_name = nname;
531 i_ddi_set_binding_name(dip, nname);
532 kmem_free(oname, strlen(oname) + 1);
534 da_log_enter(dip);
535 return (NDI_SUCCESS);
538 void
539 i_ddi_add_devimap(dev_info_t *dip)
541 struct devi_nodeid *elem;
543 ASSERT(dip);
545 if (!ndi_dev_is_persistent_node(dip))
546 return;
548 ASSERT(ddi_get_parent(dip) == NULL || (DEVI_VHCI_NODE(dip)) ||
549 DEVI_BUSY_OWNED(ddi_get_parent(dip)));
551 mutex_enter(&devimap->dno_lock);
553 ASSERT(devimap->dno_free);
555 elem = devimap->dno_free;
556 devimap->dno_free = elem->next;
558 elem->nodeid = ddi_get_nodeid(dip);
559 elem->dip = dip;
560 elem->next = devimap->dno_head;
561 devimap->dno_head = elem;
563 devimap->dno_list_length++;
565 mutex_exit(&devimap->dno_lock);
568 static int
569 i_ddi_remove_devimap(dev_info_t *dip)
571 struct devi_nodeid *prev, *elem;
572 static const char *fcn = "i_ddi_remove_devimap";
574 ASSERT(dip);
576 if (!ndi_dev_is_persistent_node(dip))
577 return (DDI_SUCCESS);
579 mutex_enter(&devimap->dno_lock);
582 * The following check is done with dno_lock held
583 * to prevent race between dip removal and
584 * e_ddi_prom_node_to_dip()
586 if (e_ddi_devi_holdcnt(dip)) {
587 mutex_exit(&devimap->dno_lock);
588 return (DDI_FAILURE);
591 ASSERT(devimap->dno_head);
592 ASSERT(devimap->dno_list_length > 0);
594 prev = NULL;
595 for (elem = devimap->dno_head; elem; elem = elem->next) {
596 if (elem->dip == dip) {
597 ASSERT(elem->nodeid == ddi_get_nodeid(dip));
598 break;
600 prev = elem;
603 if (elem && prev)
604 prev->next = elem->next;
605 else if (elem)
606 devimap->dno_head = elem->next;
607 else
608 panic("%s: devinfo node(%p) not found",
609 fcn, (void *)dip);
611 devimap->dno_list_length--;
613 elem->nodeid = 0;
614 elem->dip = NULL;
616 elem->next = devimap->dno_free;
617 devimap->dno_free = elem;
619 mutex_exit(&devimap->dno_lock);
621 return (DDI_SUCCESS);
625 * Link this node into the devinfo tree and add to orphan list
626 * Not callable from interrupt context
628 static void
629 link_node(dev_info_t *dip)
631 struct dev_info *devi = DEVI(dip);
632 struct dev_info *parent = devi->devi_parent;
633 dev_info_t **dipp;
635 ASSERT(parent); /* never called for root node */
637 NDI_CONFIG_DEBUG((CE_CONT, "link_node: parent = %s child = %s\n",
638 parent->devi_node_name, devi->devi_node_name));
641 * Hold the global_vhci_lock before linking any direct
642 * children of rootnex driver. This special lock protects
643 * linking and unlinking for rootnext direct children.
645 if ((dev_info_t *)parent == ddi_root_node())
646 mutex_enter(&global_vhci_lock);
649 * attach the node to end of the list unless the node is already there
651 dipp = (dev_info_t **)(&DEVI(parent)->devi_child);
652 while (*dipp && (*dipp != dip)) {
653 dipp = (dev_info_t **)(&DEVI(*dipp)->devi_sibling);
655 ASSERT(*dipp == NULL); /* node is not linked */
658 * Now that we are in the tree, update the devi-nodeid map.
660 i_ddi_add_devimap(dip);
663 * This is a temporary workaround for Bug 4618861.
664 * We keep the scsi_vhci nexus node on the left side of the devinfo
665 * tree (under the root nexus driver), so that virtual nodes under
666 * scsi_vhci will be SUSPENDed first and RESUMEd last. This ensures
667 * that the pHCI nodes are active during times when their clients
668 * may be depending on them. This workaround embodies the knowledge
669 * that system PM and CPR both traverse the tree left-to-right during
670 * SUSPEND and right-to-left during RESUME.
671 * Extending the workaround to IB Nexus/VHCI
672 * driver also.
674 if (strcmp(devi->devi_binding_name, "scsi_vhci") == 0) {
675 /* Add scsi_vhci to beginning of list */
676 ASSERT((dev_info_t *)parent == top_devinfo);
677 /* scsi_vhci under rootnex */
678 devi->devi_sibling = parent->devi_child;
679 parent->devi_child = devi;
680 } else if (strcmp(devi->devi_binding_name, "ib") == 0) {
681 i_link_vhci_node(dip);
682 } else {
683 /* Add to end of list */
684 *dipp = dip;
685 DEVI(dip)->devi_sibling = NULL;
689 * Release the global_vhci_lock before linking any direct
690 * children of rootnex driver.
692 if ((dev_info_t *)parent == ddi_root_node())
693 mutex_exit(&global_vhci_lock);
695 /* persistent nodes go on orphan list */
696 if (ndi_dev_is_persistent_node(dip))
697 add_to_dn_list(&orphanlist, dip);
701 * Unlink this node from the devinfo tree
703 static int
704 unlink_node(dev_info_t *dip)
706 struct dev_info *devi = DEVI(dip);
707 struct dev_info *parent = devi->devi_parent;
708 dev_info_t **dipp;
709 ddi_hp_cn_handle_t *hdlp;
711 ASSERT(parent != NULL);
712 ASSERT(devi->devi_node_state == DS_LINKED);
714 NDI_CONFIG_DEBUG((CE_CONT, "unlink_node: name = %s\n",
715 ddi_node_name(dip)));
717 /* check references */
718 if (devi->devi_ref || i_ddi_remove_devimap(dip) != DDI_SUCCESS)
719 return (DDI_FAILURE);
722 * Hold the global_vhci_lock before linking any direct
723 * children of rootnex driver.
725 if ((dev_info_t *)parent == ddi_root_node())
726 mutex_enter(&global_vhci_lock);
728 dipp = (dev_info_t **)(&DEVI(parent)->devi_child);
729 while (*dipp && (*dipp != dip)) {
730 dipp = (dev_info_t **)(&DEVI(*dipp)->devi_sibling);
732 if (*dipp) {
733 *dipp = (dev_info_t *)(devi->devi_sibling);
734 devi->devi_sibling = NULL;
735 } else {
736 NDI_CONFIG_DEBUG((CE_NOTE, "unlink_node: %s not linked",
737 devi->devi_node_name));
741 * Release the global_vhci_lock before linking any direct
742 * children of rootnex driver.
744 if ((dev_info_t *)parent == ddi_root_node())
745 mutex_exit(&global_vhci_lock);
747 /* Remove node from orphan list */
748 if (ndi_dev_is_persistent_node(dip)) {
749 remove_from_dn_list(&orphanlist, dip);
752 /* Update parent's hotplug handle list */
753 for (hdlp = DEVI(parent)->devi_hp_hdlp; hdlp; hdlp = hdlp->next) {
754 if (hdlp->cn_info.cn_child == dip)
755 hdlp->cn_info.cn_child = NULL;
757 return (DDI_SUCCESS);
761 * Bind this devinfo node to a driver. If compat is NON-NULL, try that first.
762 * Else, use the node-name.
764 * NOTE: IEEE1275 specifies that nodename should be tried before compatible.
765 * Solaris implementation binds nodename after compatible.
767 * If we find a binding,
768 * - set the binding name to the string,
769 * - set major number to driver major
771 * If we don't find a binding,
772 * - return failure
774 static int
775 bind_node(dev_info_t *dip)
777 char *p = NULL;
778 major_t major = DDI_MAJOR_T_NONE;
779 struct dev_info *devi = DEVI(dip);
780 dev_info_t *parent = ddi_get_parent(dip);
782 ASSERT(devi->devi_node_state == DS_LINKED);
784 NDI_CONFIG_DEBUG((CE_CONT, "bind_node: 0x%p(name = %s)\n",
785 (void *)dip, ddi_node_name(dip)));
787 mutex_enter(&DEVI(dip)->devi_lock);
788 if (DEVI(dip)->devi_flags & DEVI_NO_BIND) {
789 mutex_exit(&DEVI(dip)->devi_lock);
790 return (DDI_FAILURE);
792 mutex_exit(&DEVI(dip)->devi_lock);
794 /* find the driver with most specific binding using compatible */
795 major = ddi_compatible_driver_major(dip, &p);
796 if (major == DDI_MAJOR_T_NONE)
797 return (DDI_FAILURE);
799 devi->devi_major = major;
800 if (p != NULL) {
801 i_ddi_set_binding_name(dip, p);
802 NDI_CONFIG_DEBUG((CE_CONT, "bind_node: %s bound to %s\n",
803 devi->devi_node_name, p));
806 /* Link node to per-driver list */
807 link_to_driver_list(dip);
810 * reset parent flag so that nexus will merge .conf props
812 if (ndi_dev_is_persistent_node(dip)) {
813 mutex_enter(&DEVI(parent)->devi_lock);
814 DEVI(parent)->devi_flags &=
815 ~(DEVI_ATTACHED_CHILDREN|DEVI_MADE_CHILDREN);
816 mutex_exit(&DEVI(parent)->devi_lock);
818 return (DDI_SUCCESS);
822 * Unbind this devinfo node
823 * Called before the node is destroyed or driver is removed from system
825 static int
826 unbind_node(dev_info_t *dip)
828 ASSERT(DEVI(dip)->devi_node_state == DS_BOUND);
829 ASSERT(DEVI(dip)->devi_major != DDI_MAJOR_T_NONE);
831 /* check references */
832 if (DEVI(dip)->devi_ref)
833 return (DDI_FAILURE);
835 NDI_CONFIG_DEBUG((CE_CONT, "unbind_node: 0x%p(name = %s)\n",
836 (void *)dip, ddi_node_name(dip)));
838 unlink_from_driver_list(dip);
840 DEVI(dip)->devi_major = DDI_MAJOR_T_NONE;
841 DEVI(dip)->devi_binding_name = DEVI(dip)->devi_node_name;
842 return (DDI_SUCCESS);
846 * Initialize a node: calls the parent nexus' bus_ctl ops to do the operation.
847 * Must hold parent and per-driver list while calling this function.
848 * A successful init_node() returns with an active ndi_hold_devi() hold on
849 * the parent.
851 static int
852 init_node(dev_info_t *dip)
854 int error;
855 dev_info_t *pdip = ddi_get_parent(dip);
856 int (*f)(dev_info_t *, dev_info_t *, ddi_ctl_enum_t, void *, void *);
857 char *path;
858 major_t major;
859 ddi_devid_t devid = NULL;
861 ASSERT(i_ddi_node_state(dip) == DS_BOUND);
863 /* should be DS_READY except for pcmcia ... */
864 ASSERT(i_ddi_node_state(pdip) >= DS_PROBED);
866 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
867 (void) ddi_pathname(dip, path);
868 NDI_CONFIG_DEBUG((CE_CONT, "init_node: entry: path %s 0x%p\n",
869 path, (void *)dip));
872 * The parent must have a bus_ctl operation.
874 if ((DEVI(pdip)->devi_ops->devo_bus_ops == NULL) ||
875 (f = DEVI(pdip)->devi_ops->devo_bus_ops->bus_ctl) == NULL) {
876 error = DDI_FAILURE;
877 goto out;
880 add_global_props(dip);
883 * Invoke the parent's bus_ctl operation with the DDI_CTLOPS_INITCHILD
884 * command to transform the child to canonical form 1. If there
885 * is an error, ddi_remove_child should be called, to clean up.
887 error = (*f)(pdip, pdip, DDI_CTLOPS_INITCHILD, dip, NULL);
888 if (error != DDI_SUCCESS) {
889 NDI_CONFIG_DEBUG((CE_CONT, "init_node: %s 0x%p failed\n",
890 path, (void *)dip));
891 remove_global_props(dip);
894 * If a nexus INITCHILD implementation calls ddi_devid_regster()
895 * prior to setting devi_addr, the devid is not recorded in
896 * the devid cache (i.e. DEVI_CACHED_DEVID is not set).
897 * With mpxio, while the vhci client path may be missing
898 * from the cache, phci pathinfo paths may have already be
899 * added to the cache, against the client dip, by use of
900 * e_devid_cache_pathinfo(). Because of this, when INITCHILD
901 * of the client fails, we need to purge the client dip from
902 * the cache even if DEVI_CACHED_DEVID is not set - if only
903 * devi_devid_str is set.
905 mutex_enter(&DEVI(dip)->devi_lock);
906 if ((DEVI(dip)->devi_flags & DEVI_CACHED_DEVID) ||
907 DEVI(dip)->devi_devid_str) {
908 DEVI(dip)->devi_flags &= ~DEVI_CACHED_DEVID;
909 mutex_exit(&DEVI(dip)->devi_lock);
910 ddi_devid_unregister(dip);
911 } else
912 mutex_exit(&DEVI(dip)->devi_lock);
914 /* in case nexus driver didn't clear this field */
915 ddi_set_name_addr(dip, NULL);
916 error = DDI_FAILURE;
917 goto out;
920 ndi_hold_devi(pdip); /* initial hold of parent */
922 /* recompute path after initchild for @addr information */
923 (void) ddi_pathname(dip, path);
925 /* Check for duplicate nodes */
926 if (find_duplicate_child(pdip, dip) != NULL) {
928 * uninit_node() the duplicate - a successful uninit_node()
929 * will release inital hold of parent using ndi_rele_devi().
931 if ((error = uninit_node(dip)) != DDI_SUCCESS) {
932 ndi_rele_devi(pdip); /* release initial hold */
933 cmn_err(CE_WARN, "init_node: uninit of duplicate "
934 "node %s failed", path);
936 NDI_CONFIG_DEBUG((CE_CONT, "init_node: duplicate uninit "
937 "%s 0x%p%s\n", path, (void *)dip,
938 (error == DDI_SUCCESS) ? "" : " failed"));
939 error = DDI_FAILURE;
940 goto out;
944 * If a devid was registered for a DS_BOUND node then the devid_cache
945 * may not have captured the path. Detect this situation and ensure that
946 * the path enters the cache now that devi_addr is established.
948 if (!(DEVI(dip)->devi_flags & DEVI_CACHED_DEVID) &&
949 (ddi_devid_get(dip, &devid) == DDI_SUCCESS)) {
950 if (e_devid_cache_register(dip, devid) == DDI_SUCCESS) {
951 mutex_enter(&DEVI(dip)->devi_lock);
952 DEVI(dip)->devi_flags |= DEVI_CACHED_DEVID;
953 mutex_exit(&DEVI(dip)->devi_lock);
956 ddi_devid_free(devid);
960 * Check to see if we have a path-oriented driver alias that overrides
961 * the current driver binding. If so, we need to rebind. This check
962 * needs to be delayed until after a successful DDI_CTLOPS_INITCHILD,
963 * so the unit-address is established on the last component of the path.
965 * NOTE: Allowing a path-oriented alias to change the driver binding
966 * of a driver.conf node results in non-intuitive property behavior.
967 * We provide a tunable (driver_conf_allow_path_alias) to control
968 * this behavior. See uninit_node() for more details.
970 * NOTE: If you are adding a path-oriented alias for the boot device,
971 * and there is mismatch between OBP and the kernel in regard to
972 * generic name use, like "disk" .vs. "ssd", then you will need
973 * to add a path-oriented alias for both paths.
975 major = ddi_name_to_major(path);
976 if (driver_active(major) && (major != DEVI(dip)->devi_major) &&
977 (ndi_dev_is_persistent_node(dip) || driver_conf_allow_path_alias)) {
979 /* Mark node for rebind processing. */
980 mutex_enter(&DEVI(dip)->devi_lock);
981 DEVI(dip)->devi_flags |= DEVI_REBIND;
982 mutex_exit(&DEVI(dip)->devi_lock);
985 * Add an extra hold on the parent to prevent it from ever
986 * having a zero devi_ref during the child rebind process.
987 * This is necessary to ensure that the parent will never
988 * detach(9E) during the rebind.
990 ndi_hold_devi(pdip); /* extra hold of parent */
993 * uninit_node() current binding - a successful uninit_node()
994 * will release extra hold of parent using ndi_rele_devi().
996 if ((error = uninit_node(dip)) != DDI_SUCCESS) {
997 ndi_rele_devi(pdip); /* release extra hold */
998 ndi_rele_devi(pdip); /* release initial hold */
999 cmn_err(CE_WARN, "init_node: uninit for rebind "
1000 "of node %s failed", path);
1001 goto out;
1004 /* Unbind: demote the node back to DS_LINKED. */
1005 if ((error = ndi_devi_unbind_driver(dip)) != DDI_SUCCESS) {
1006 ndi_rele_devi(pdip); /* release initial hold */
1007 cmn_err(CE_WARN, "init_node: unbind for rebind "
1008 "of node %s failed", path);
1009 goto out;
1012 /* establish rebinding name */
1013 if (DEVI(dip)->devi_rebinding_name == NULL)
1014 DEVI(dip)->devi_rebinding_name =
1015 i_ddi_strdup(path, KM_SLEEP);
1018 * Now that we are demoted and marked for rebind, repromote.
1019 * We need to do this in steps, instead of just calling
1020 * ddi_initchild, so that we can redo the merge operation
1021 * after we are rebound to the path-bound driver.
1023 * Start by rebinding node to the path-bound driver.
1025 if ((error = ndi_devi_bind_driver(dip, 0)) != DDI_SUCCESS) {
1026 ndi_rele_devi(pdip); /* release initial hold */
1027 cmn_err(CE_WARN, "init_node: rebind "
1028 "of node %s failed", path);
1029 goto out;
1033 * If the node is not a driver.conf node then merge
1034 * driver.conf properties from new path-bound driver.conf.
1036 if (ndi_dev_is_persistent_node(dip))
1037 (void) i_ndi_make_spec_children(pdip, 0);
1040 * Now that we have taken care of merge, repromote back
1041 * to DS_INITIALIZED.
1043 error = ddi_initchild(pdip, dip);
1044 NDI_CONFIG_DEBUG((CE_CONT, "init_node: rebind "
1045 "%s 0x%p\n", path, (void *)dip));
1048 * Release our initial hold. If ddi_initchild() was
1049 * successful then it will return with the active hold.
1051 ndi_rele_devi(pdip);
1052 goto out;
1056 * Apply multi-parent/deep-nexus optimization to the new node
1058 DEVI(dip)->devi_instance = e_ddi_assign_instance(dip);
1059 ddi_optimize_dtree(dip);
1060 error = DDI_SUCCESS; /* return with active hold */
1062 out: if (error != DDI_SUCCESS) {
1063 /* On failure ensure that DEVI_REBIND is cleared */
1064 mutex_enter(&DEVI(dip)->devi_lock);
1065 DEVI(dip)->devi_flags &= ~DEVI_REBIND;
1066 mutex_exit(&DEVI(dip)->devi_lock);
1068 kmem_free(path, MAXPATHLEN);
1069 return (error);
1073 * Uninitialize node
1074 * The per-driver list must be held busy during the call.
1075 * A successful uninit_node() releases the init_node() hold on
1076 * the parent by calling ndi_rele_devi().
1078 static int
1079 uninit_node(dev_info_t *dip)
1081 int node_state_entry;
1082 dev_info_t *pdip;
1083 struct dev_ops *ops;
1084 int (*f)();
1085 int error;
1086 char *addr;
1089 * Don't check for references here or else a ref-counted
1090 * dip cannot be downgraded by the framework.
1092 node_state_entry = i_ddi_node_state(dip);
1093 ASSERT((node_state_entry == DS_BOUND) ||
1094 (node_state_entry == DS_INITIALIZED));
1095 pdip = ddi_get_parent(dip);
1096 ASSERT(pdip);
1098 NDI_CONFIG_DEBUG((CE_CONT, "uninit_node: 0x%p(%s%d)\n",
1099 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1101 if (((ops = ddi_get_driver(pdip)) == NULL) ||
1102 (ops->devo_bus_ops == NULL) ||
1103 ((f = ops->devo_bus_ops->bus_ctl) == NULL)) {
1104 return (DDI_FAILURE);
1108 * save the @addr prior to DDI_CTLOPS_UNINITCHILD for use in
1109 * freeing the instance if it succeeds.
1111 if (node_state_entry == DS_INITIALIZED) {
1112 addr = ddi_get_name_addr(dip);
1113 if (addr)
1114 addr = i_ddi_strdup(addr, KM_SLEEP);
1115 } else {
1116 addr = NULL;
1119 error = (*f)(pdip, pdip, DDI_CTLOPS_UNINITCHILD, dip, (void *)NULL);
1120 if (error == DDI_SUCCESS) {
1121 /* ensure that devids are unregistered */
1122 mutex_enter(&DEVI(dip)->devi_lock);
1123 if ((DEVI(dip)->devi_flags & DEVI_CACHED_DEVID)) {
1124 DEVI(dip)->devi_flags &= ~DEVI_CACHED_DEVID;
1125 mutex_exit(&DEVI(dip)->devi_lock);
1126 ddi_devid_unregister(dip);
1127 } else
1128 mutex_exit(&DEVI(dip)->devi_lock);
1130 /* if uninitchild forgot to set devi_addr to NULL do it now */
1131 ddi_set_name_addr(dip, NULL);
1134 * Free instance number. This is a no-op if instance has
1135 * been kept by probe_node(). Avoid free when we are called
1136 * from init_node (DS_BOUND) because the instance has not yet
1137 * been assigned.
1139 if (node_state_entry == DS_INITIALIZED) {
1140 e_ddi_free_instance(dip, addr);
1141 DEVI(dip)->devi_instance = -1;
1144 /* release the init_node hold */
1145 ndi_rele_devi(pdip);
1147 remove_global_props(dip);
1150 * NOTE: The decision on whether to allow a path-oriented
1151 * rebind of a driver.conf enumerated node is made by
1152 * init_node() based on driver_conf_allow_path_alias. The
1153 * rebind code below prevents deletion of system properties
1154 * on driver.conf nodes.
1156 * When driver_conf_allow_path_alias is set, property behavior
1157 * on rebound driver.conf file is non-intuitive. For a
1158 * driver.conf node, the unit-address properties come from
1159 * the driver.conf file as system properties. Removing system
1160 * properties from a driver.conf node makes the node
1161 * useless (we get node without unit-address properties) - so
1162 * we leave system properties in place. The result is a node
1163 * where system properties come from the node being rebound,
1164 * and global properties come from the driver.conf file
1165 * of the driver we are rebinding to. If we could determine
1166 * that the path-oriented alias driver.conf file defined a
1167 * node at the same unit address, it would be best to use
1168 * that node and avoid the non-intuitive property behavior.
1169 * Unfortunately, the current "merge" code does not support
1170 * this, so we live with the non-intuitive property behavior.
1172 if (!((ndi_dev_is_persistent_node(dip) == 0) &&
1173 (DEVI(dip)->devi_flags & DEVI_REBIND)))
1174 e_ddi_prop_remove_all(dip);
1175 } else {
1176 NDI_CONFIG_DEBUG((CE_CONT, "uninit_node failed: 0x%p(%s%d)\n",
1177 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1180 if (addr)
1181 kmem_free(addr, strlen(addr) + 1);
1182 return (error);
1186 * Invoke driver's probe entry point to probe for existence of hardware.
1187 * Keep instance permanent for successful probe and leaf nodes.
1189 * Per-driver list must be held busy while calling this function.
1191 static int
1192 probe_node(dev_info_t *dip)
1194 int rv;
1196 ASSERT(i_ddi_node_state(dip) == DS_INITIALIZED);
1198 NDI_CONFIG_DEBUG((CE_CONT, "probe_node: 0x%p(%s%d)\n",
1199 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1201 /* temporarily hold the driver while we probe */
1202 DEVI(dip)->devi_ops = ndi_hold_driver(dip);
1203 if (DEVI(dip)->devi_ops == NULL) {
1204 NDI_CONFIG_DEBUG((CE_CONT,
1205 "probe_node: 0x%p(%s%d) cannot load driver\n",
1206 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1207 return (DDI_FAILURE);
1210 if (identify_9e != 0)
1211 (void) devi_identify(dip);
1213 rv = devi_probe(dip);
1215 /* release the driver now that probe is complete */
1216 ndi_rele_driver(dip);
1217 DEVI(dip)->devi_ops = NULL;
1219 switch (rv) {
1220 case DDI_PROBE_SUCCESS: /* found */
1221 case DDI_PROBE_DONTCARE: /* ddi_dev_is_sid */
1222 e_ddi_keep_instance(dip); /* persist instance */
1223 rv = DDI_SUCCESS;
1224 break;
1226 case DDI_PROBE_PARTIAL: /* maybe later */
1227 case DDI_PROBE_FAILURE: /* not found */
1228 NDI_CONFIG_DEBUG((CE_CONT,
1229 "probe_node: 0x%p(%s%d) no hardware found%s\n",
1230 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip),
1231 (rv == DDI_PROBE_PARTIAL) ? " yet" : ""));
1232 rv = DDI_FAILURE;
1233 break;
1235 default:
1236 #ifdef DEBUG
1237 cmn_err(CE_WARN, "probe_node: %s%d: illegal probe(9E) value",
1238 ddi_driver_name(dip), ddi_get_instance(dip));
1239 #endif /* DEBUG */
1240 rv = DDI_FAILURE;
1241 break;
1243 return (rv);
1247 * Unprobe a node. Simply reset the node state.
1248 * Per-driver list must be held busy while calling this function.
1250 static int
1251 unprobe_node(dev_info_t *dip)
1253 ASSERT(i_ddi_node_state(dip) == DS_PROBED);
1256 * Don't check for references here or else a ref-counted
1257 * dip cannot be downgraded by the framework.
1260 NDI_CONFIG_DEBUG((CE_CONT, "unprobe_node: 0x%p(name = %s)\n",
1261 (void *)dip, ddi_node_name(dip)));
1262 return (DDI_SUCCESS);
1266 * Attach devinfo node.
1267 * Per-driver list must be held busy.
1269 static int
1270 attach_node(dev_info_t *dip)
1272 int rv;
1274 ASSERT(DEVI_BUSY_OWNED(ddi_get_parent(dip)));
1275 ASSERT(i_ddi_node_state(dip) == DS_PROBED);
1277 NDI_CONFIG_DEBUG((CE_CONT, "attach_node: 0x%p(%s%d)\n",
1278 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1281 * Tell mpxio framework that a node is about to online.
1283 if ((rv = mdi_devi_online(dip, 0)) != NDI_SUCCESS) {
1284 return (DDI_FAILURE);
1287 /* no recursive attachment */
1288 ASSERT(DEVI(dip)->devi_ops == NULL);
1291 * Hold driver the node is bound to.
1293 DEVI(dip)->devi_ops = ndi_hold_driver(dip);
1294 if (DEVI(dip)->devi_ops == NULL) {
1296 * We were able to load driver for probing, so we should
1297 * not get here unless something really bad happened.
1299 cmn_err(CE_WARN, "attach_node: no driver for major %d",
1300 DEVI(dip)->devi_major);
1301 return (DDI_FAILURE);
1304 if (NEXUS_DRV(DEVI(dip)->devi_ops))
1305 DEVI(dip)->devi_taskq = ddi_taskq_create(dip,
1306 "nexus_enum_tq", 1,
1307 TASKQ_DEFAULTPRI, 0);
1309 mutex_enter(&(DEVI(dip)->devi_lock));
1310 DEVI_SET_ATTACHING(dip);
1311 DEVI_SET_NEED_RESET(dip);
1312 mutex_exit(&(DEVI(dip)->devi_lock));
1314 rv = devi_attach(dip, DDI_ATTACH);
1316 mutex_enter(&(DEVI(dip)->devi_lock));
1317 DEVI_CLR_ATTACHING(dip);
1319 if (rv != DDI_SUCCESS) {
1320 DEVI_CLR_NEED_RESET(dip);
1321 mutex_exit(&DEVI(dip)->devi_lock);
1324 * Cleanup dacf reservations
1326 mutex_enter(&dacf_lock);
1327 dacf_clr_rsrvs(dip, DACF_OPID_POSTATTACH);
1328 dacf_clr_rsrvs(dip, DACF_OPID_PREDETACH);
1329 mutex_exit(&dacf_lock);
1330 if (DEVI(dip)->devi_taskq)
1331 ddi_taskq_destroy(DEVI(dip)->devi_taskq);
1332 ddi_remove_minor_node(dip, NULL);
1334 /* release the driver if attach failed */
1335 ndi_rele_driver(dip);
1336 DEVI(dip)->devi_ops = NULL;
1337 NDI_CONFIG_DEBUG((CE_CONT, "attach_node: 0x%p(%s%d) failed\n",
1338 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1339 return (DDI_FAILURE);
1340 } else
1341 mutex_exit(&DEVI(dip)->devi_lock);
1343 /* successful attach, return with driver held */
1345 return (DDI_SUCCESS);
1349 * Detach devinfo node.
1350 * Per-driver list must be held busy.
1352 static int
1353 detach_node(dev_info_t *dip, uint_t flag)
1355 struct devnames *dnp;
1356 int rv;
1358 ASSERT(DEVI_BUSY_OWNED(ddi_get_parent(dip)));
1359 ASSERT(i_ddi_node_state(dip) == DS_ATTACHED);
1361 /* check references */
1362 if (DEVI(dip)->devi_ref)
1363 return (DDI_FAILURE);
1365 NDI_CONFIG_DEBUG((CE_CONT, "detach_node: 0x%p(%s%d)\n",
1366 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1369 * NOTE: If we are processing a pHCI node then the calling code
1370 * must detect this and ndi_devi_enter() in (vHCI, parent(pHCI))
1371 * order unless pHCI and vHCI are siblings. Code paths leading
1372 * here that must ensure this ordering include:
1373 * unconfig_immediate_children(), devi_unconfig_one(),
1374 * ndi_devi_unconfig_one(), ndi_devi_offline().
1376 ASSERT(!MDI_PHCI(dip) ||
1377 (ddi_get_parent(mdi_devi_get_vdip(dip)) == ddi_get_parent(dip)) ||
1378 DEVI_BUSY_OWNED(mdi_devi_get_vdip(dip)));
1380 /* Offline the device node with the mpxio framework. */
1381 if (mdi_devi_offline(dip, flag) != NDI_SUCCESS) {
1382 return (DDI_FAILURE);
1385 /* drain the taskq */
1386 if (DEVI(dip)->devi_taskq)
1387 ddi_taskq_wait(DEVI(dip)->devi_taskq);
1389 rv = devi_detach(dip, DDI_DETACH);
1391 if (rv != DDI_SUCCESS) {
1392 NDI_CONFIG_DEBUG((CE_CONT,
1393 "detach_node: 0x%p(%s%d) failed\n",
1394 (void *)dip, ddi_driver_name(dip), ddi_get_instance(dip)));
1395 return (DDI_FAILURE);
1398 mutex_enter(&(DEVI(dip)->devi_lock));
1399 DEVI_CLR_NEED_RESET(dip);
1400 mutex_exit(&(DEVI(dip)->devi_lock));
1402 #if defined(__amd64) && !defined(__xpv)
1404 * Close any iommulib mediated linkage to an IOMMU
1406 if (IOMMU_USED(dip))
1407 iommulib_nex_close(dip);
1408 #endif
1410 /* destroy the taskq */
1411 if (DEVI(dip)->devi_taskq) {
1412 ddi_taskq_destroy(DEVI(dip)->devi_taskq);
1413 DEVI(dip)->devi_taskq = NULL;
1416 /* Cleanup dacf reservations */
1417 mutex_enter(&dacf_lock);
1418 dacf_clr_rsrvs(dip, DACF_OPID_POSTATTACH);
1419 dacf_clr_rsrvs(dip, DACF_OPID_PREDETACH);
1420 mutex_exit(&dacf_lock);
1422 /* remove any additional flavors that were added */
1423 if (DEVI(dip)->devi_flavorv_n > 1 && DEVI(dip)->devi_flavorv != NULL) {
1424 kmem_free(DEVI(dip)->devi_flavorv,
1425 (DEVI(dip)->devi_flavorv_n - 1) * sizeof (void *));
1426 DEVI(dip)->devi_flavorv = NULL;
1429 /* Remove properties and minor nodes in case driver forgots */
1430 ddi_remove_minor_node(dip, NULL);
1431 ddi_prop_remove_all(dip);
1433 /* a detached node can't have attached or .conf children */
1434 mutex_enter(&DEVI(dip)->devi_lock);
1435 DEVI(dip)->devi_flags &= ~(DEVI_MADE_CHILDREN|DEVI_ATTACHED_CHILDREN);
1436 mutex_exit(&DEVI(dip)->devi_lock);
1439 * If the instance has successfully detached in detach_driver() context,
1440 * clear DN_DRIVER_HELD for correct ddi_hold_installed_driver()
1441 * behavior. Consumers like qassociate() depend on this (via clnopen()).
1443 if (flag & NDI_DETACH_DRIVER) {
1444 dnp = &(devnamesp[DEVI(dip)->devi_major]);
1445 LOCK_DEV_OPS(&dnp->dn_lock);
1446 dnp->dn_flags &= ~DN_DRIVER_HELD;
1447 UNLOCK_DEV_OPS(&dnp->dn_lock);
1450 /* successful detach, release the driver */
1451 ndi_rele_driver(dip);
1452 DEVI(dip)->devi_ops = NULL;
1453 return (DDI_SUCCESS);
1457 * Run dacf post_attach routines
1459 static int
1460 postattach_node(dev_info_t *dip)
1462 int rval;
1465 * For hotplug busses like USB, it's possible that devices
1466 * are removed but dip is still around. We don't want to
1467 * run dacf routines as part of detach failure recovery.
1469 * Pretend success until we figure out how to prevent
1470 * access to such devinfo nodes.
1472 if (DEVI_IS_DEVICE_REMOVED(dip))
1473 return (DDI_SUCCESS);
1476 * if dacf_postattach failed, report it to the framework
1477 * so that it can be retried later at the open time.
1479 mutex_enter(&dacf_lock);
1480 rval = dacfc_postattach(dip);
1481 mutex_exit(&dacf_lock);
1484 * Plumbing during postattach may fail because of the
1485 * underlying device is not ready. This will fail ndi_devi_config()
1486 * in dv_filldir() and a warning message is issued. The message
1487 * from here will explain what happened
1489 if (rval != DACF_SUCCESS) {
1490 cmn_err(CE_WARN, "Postattach failed for %s%d\n",
1491 ddi_driver_name(dip), ddi_get_instance(dip));
1492 return (DDI_FAILURE);
1495 return (DDI_SUCCESS);
1499 * Run dacf pre-detach routines
1501 static int
1502 predetach_node(dev_info_t *dip, uint_t flag)
1504 int ret;
1507 * Don't auto-detach if DDI_FORCEATTACH or DDI_NO_AUTODETACH
1508 * properties are set.
1510 if (flag & NDI_AUTODETACH) {
1511 struct devnames *dnp;
1512 int pflag = DDI_PROP_NOTPROM | DDI_PROP_DONTPASS;
1514 if ((ddi_prop_get_int(DDI_DEV_T_ANY, dip,
1515 pflag, DDI_FORCEATTACH, 0) == 1) ||
1516 (ddi_prop_get_int(DDI_DEV_T_ANY, dip,
1517 pflag, DDI_NO_AUTODETACH, 0) == 1))
1518 return (DDI_FAILURE);
1520 /* check for driver global version of DDI_NO_AUTODETACH */
1521 dnp = &devnamesp[DEVI(dip)->devi_major];
1522 LOCK_DEV_OPS(&dnp->dn_lock);
1523 if (dnp->dn_flags & DN_NO_AUTODETACH) {
1524 UNLOCK_DEV_OPS(&dnp->dn_lock);
1525 return (DDI_FAILURE);
1527 UNLOCK_DEV_OPS(&dnp->dn_lock);
1530 mutex_enter(&dacf_lock);
1531 ret = dacfc_predetach(dip);
1532 mutex_exit(&dacf_lock);
1534 return (ret);
1538 * Wrapper for making multiple state transitions
1542 * i_ndi_config_node: upgrade dev_info node into a specified state.
1543 * It is a bit tricky because the locking protocol changes before and
1544 * after a node is bound to a driver. All locks are held external to
1545 * this function.
1548 i_ndi_config_node(dev_info_t *dip, ddi_node_state_t state, uint_t flag)
1550 _NOTE(ARGUNUSED(flag))
1551 int rv = DDI_SUCCESS;
1553 ASSERT(DEVI_BUSY_OWNED(ddi_get_parent(dip)));
1555 while ((i_ddi_node_state(dip) < state) && (rv == DDI_SUCCESS)) {
1557 /* don't allow any more changes to the device tree */
1558 if (devinfo_freeze) {
1559 rv = DDI_FAILURE;
1560 break;
1563 switch (i_ddi_node_state(dip)) {
1564 case DS_PROTO:
1566 * only caller can reference this node, no external
1567 * locking needed.
1569 link_node(dip);
1570 translate_devid((dev_info_t *)dip);
1571 i_ddi_set_node_state(dip, DS_LINKED);
1572 break;
1573 case DS_LINKED:
1575 * Three code path may attempt to bind a node:
1576 * - boot code
1577 * - add_drv
1578 * - hotplug thread
1579 * Boot code is single threaded, add_drv synchronize
1580 * on a userland lock, and hotplug synchronize on
1581 * hotplug_lk. There could be a race between add_drv
1582 * and hotplug thread. We'll live with this until the
1583 * conversion to top-down loading.
1585 if ((rv = bind_node(dip)) == DDI_SUCCESS)
1586 i_ddi_set_node_state(dip, DS_BOUND);
1588 break;
1589 case DS_BOUND:
1591 * The following transitions synchronizes on the
1592 * per-driver busy changing flag, since we already
1593 * have a driver.
1595 if ((rv = init_node(dip)) == DDI_SUCCESS)
1596 i_ddi_set_node_state(dip, DS_INITIALIZED);
1597 break;
1598 case DS_INITIALIZED:
1599 if ((rv = probe_node(dip)) == DDI_SUCCESS)
1600 i_ddi_set_node_state(dip, DS_PROBED);
1601 break;
1602 case DS_PROBED:
1604 * If node is retired and persistent, then prevent
1605 * attach. We can't do this for non-persistent nodes
1606 * as we would lose evidence that the node existed.
1608 if (i_ddi_check_retire(dip) == 1 &&
1609 ndi_dev_is_persistent_node(dip) &&
1610 retire_prevents_attach == 1) {
1611 rv = DDI_FAILURE;
1612 break;
1614 atomic_add_long(&devinfo_attach_detach, 1);
1615 if ((rv = attach_node(dip)) == DDI_SUCCESS)
1616 i_ddi_set_node_state(dip, DS_ATTACHED);
1617 atomic_add_long(&devinfo_attach_detach, -1);
1618 break;
1619 case DS_ATTACHED:
1620 if ((rv = postattach_node(dip)) == DDI_SUCCESS)
1621 i_ddi_set_node_state(dip, DS_READY);
1622 break;
1623 case DS_READY:
1624 break;
1625 default:
1626 /* should never reach here */
1627 ASSERT("unknown devinfo state");
1631 if (ddidebug & DDI_AUDIT)
1632 da_log_enter(dip);
1633 return (rv);
1637 * i_ndi_unconfig_node: downgrade dev_info node into a specified state.
1640 i_ndi_unconfig_node(dev_info_t *dip, ddi_node_state_t state, uint_t flag)
1642 int rv = DDI_SUCCESS;
1644 ASSERT(DEVI_BUSY_OWNED(ddi_get_parent(dip)));
1646 while ((i_ddi_node_state(dip) > state) && (rv == DDI_SUCCESS)) {
1648 /* don't allow any more changes to the device tree */
1649 if (devinfo_freeze) {
1650 rv = DDI_FAILURE;
1651 break;
1654 switch (i_ddi_node_state(dip)) {
1655 case DS_PROTO:
1656 break;
1657 case DS_LINKED:
1659 * Persistent nodes are only removed by hotplug code
1660 * .conf nodes synchronizes on per-driver list.
1662 if ((rv = unlink_node(dip)) == DDI_SUCCESS)
1663 i_ddi_set_node_state(dip, DS_PROTO);
1664 break;
1665 case DS_BOUND:
1667 * The following transitions synchronizes on the
1668 * per-driver busy changing flag, since we already
1669 * have a driver.
1671 if ((rv = unbind_node(dip)) == DDI_SUCCESS)
1672 i_ddi_set_node_state(dip, DS_LINKED);
1673 break;
1674 case DS_INITIALIZED:
1675 if ((rv = uninit_node(dip)) == DDI_SUCCESS)
1676 i_ddi_set_node_state(dip, DS_BOUND);
1677 break;
1678 case DS_PROBED:
1679 if ((rv = unprobe_node(dip)) == DDI_SUCCESS)
1680 i_ddi_set_node_state(dip, DS_INITIALIZED);
1681 break;
1682 case DS_ATTACHED:
1683 atomic_add_long(&devinfo_attach_detach, 1);
1685 mutex_enter(&(DEVI(dip)->devi_lock));
1686 DEVI_SET_DETACHING(dip);
1687 mutex_exit(&(DEVI(dip)->devi_lock));
1689 membar_enter(); /* ensure visibility for hold_devi */
1691 if ((rv = detach_node(dip, flag)) == DDI_SUCCESS)
1692 i_ddi_set_node_state(dip, DS_PROBED);
1694 mutex_enter(&(DEVI(dip)->devi_lock));
1695 DEVI_CLR_DETACHING(dip);
1696 mutex_exit(&(DEVI(dip)->devi_lock));
1698 atomic_add_long(&devinfo_attach_detach, -1);
1699 break;
1700 case DS_READY:
1701 if ((rv = predetach_node(dip, flag)) == DDI_SUCCESS)
1702 i_ddi_set_node_state(dip, DS_ATTACHED);
1703 break;
1704 default:
1705 ASSERT("unknown devinfo state");
1708 da_log_enter(dip);
1709 return (rv);
1713 * ddi_initchild: transform node to DS_INITIALIZED state
1716 ddi_initchild(dev_info_t *parent, dev_info_t *proto)
1718 int ret, circ;
1720 ndi_devi_enter(parent, &circ);
1721 ret = i_ndi_config_node(proto, DS_INITIALIZED, 0);
1722 ndi_devi_exit(parent, circ);
1724 return (ret);
1728 * ddi_uninitchild: transform node down to DS_BOUND state
1731 ddi_uninitchild(dev_info_t *dip)
1733 int ret, circ;
1734 dev_info_t *parent = ddi_get_parent(dip);
1735 ASSERT(parent);
1737 ndi_devi_enter(parent, &circ);
1738 ret = i_ndi_unconfig_node(dip, DS_BOUND, 0);
1739 ndi_devi_exit(parent, circ);
1741 return (ret);
1745 * i_ddi_attachchild: transform node to DS_READY/i_ddi_devi_attached() state
1747 static int
1748 i_ddi_attachchild(dev_info_t *dip)
1750 dev_info_t *parent = ddi_get_parent(dip);
1751 int ret;
1753 ASSERT(parent && DEVI_BUSY_OWNED(parent));
1755 if ((i_ddi_node_state(dip) < DS_BOUND) || DEVI_IS_DEVICE_OFFLINE(dip))
1756 return (DDI_FAILURE);
1758 ret = i_ndi_config_node(dip, DS_READY, 0);
1759 if (ret == NDI_SUCCESS) {
1760 ret = DDI_SUCCESS;
1761 } else {
1763 * Take it down to DS_INITIALIZED so pm_pre_probe is run
1764 * on the next attach
1766 (void) i_ndi_unconfig_node(dip, DS_INITIALIZED, 0);
1767 ret = DDI_FAILURE;
1770 return (ret);
1774 * i_ddi_detachchild: transform node down to DS_PROBED state
1775 * If it fails, put it back to DS_READY state.
1776 * NOTE: A node that fails detach may be at DS_ATTACHED instead
1777 * of DS_READY for a small amount of time - this is the source of
1778 * transient DS_READY->DS_ATTACHED->DS_READY state changes.
1780 static int
1781 i_ddi_detachchild(dev_info_t *dip, uint_t flags)
1783 dev_info_t *parent = ddi_get_parent(dip);
1784 int ret;
1786 ASSERT(parent && DEVI_BUSY_OWNED(parent));
1788 ret = i_ndi_unconfig_node(dip, DS_PROBED, flags);
1789 if (ret != DDI_SUCCESS)
1790 (void) i_ndi_config_node(dip, DS_READY, 0);
1791 else
1792 /* allow pm_pre_probe to reestablish pm state */
1793 (void) i_ndi_unconfig_node(dip, DS_INITIALIZED, 0);
1794 return (ret);
1798 * Add a child and bind to driver
1800 dev_info_t *
1801 ddi_add_child(dev_info_t *pdip, char *name, uint_t nodeid, uint_t unit)
1803 int circ;
1804 dev_info_t *dip;
1806 /* allocate a new node */
1807 dip = i_ddi_alloc_node(pdip, name, nodeid, (int)unit, NULL, KM_SLEEP);
1809 ndi_devi_enter(pdip, &circ);
1810 (void) i_ndi_config_node(dip, DS_BOUND, 0);
1811 ndi_devi_exit(pdip, circ);
1812 return (dip);
1816 * ddi_remove_child: remove the dip. The parent must be attached and held
1819 ddi_remove_child(dev_info_t *dip, int dummy)
1821 _NOTE(ARGUNUSED(dummy))
1822 int circ, ret;
1823 dev_info_t *parent = ddi_get_parent(dip);
1824 ASSERT(parent);
1826 ndi_devi_enter(parent, &circ);
1829 * If we still have children, for example SID nodes marked
1830 * as persistent but not attached, attempt to remove them.
1832 if (DEVI(dip)->devi_child) {
1833 ret = ndi_devi_unconfig(dip, NDI_DEVI_REMOVE);
1834 if (ret != NDI_SUCCESS) {
1835 ndi_devi_exit(parent, circ);
1836 return (DDI_FAILURE);
1838 ASSERT(DEVI(dip)->devi_child == NULL);
1841 ret = i_ndi_unconfig_node(dip, DS_PROTO, 0);
1842 ndi_devi_exit(parent, circ);
1844 if (ret != DDI_SUCCESS)
1845 return (ret);
1847 ASSERT(i_ddi_node_state(dip) == DS_PROTO);
1848 i_ddi_free_node(dip);
1849 return (DDI_SUCCESS);
1853 * NDI wrappers for ref counting, node allocation, and transitions
1857 * Hold/release the devinfo node itself.
1858 * Caller is assumed to prevent the devi from detaching during this call
1860 void
1861 ndi_hold_devi(dev_info_t *dip)
1863 mutex_enter(&DEVI(dip)->devi_lock);
1864 ASSERT(DEVI(dip)->devi_ref >= 0);
1865 DEVI(dip)->devi_ref++;
1866 membar_enter(); /* make sure stores are flushed */
1867 mutex_exit(&DEVI(dip)->devi_lock);
1870 void
1871 ndi_rele_devi(dev_info_t *dip)
1873 ASSERT(DEVI(dip)->devi_ref > 0);
1875 mutex_enter(&DEVI(dip)->devi_lock);
1876 DEVI(dip)->devi_ref--;
1877 membar_enter(); /* make sure stores are flushed */
1878 mutex_exit(&DEVI(dip)->devi_lock);
1882 e_ddi_devi_holdcnt(dev_info_t *dip)
1884 return (DEVI(dip)->devi_ref);
1888 * Hold/release the driver the devinfo node is bound to.
1890 struct dev_ops *
1891 ndi_hold_driver(dev_info_t *dip)
1893 if (i_ddi_node_state(dip) < DS_BOUND)
1894 return (NULL);
1896 ASSERT(DEVI(dip)->devi_major != -1);
1897 return (mod_hold_dev_by_major(DEVI(dip)->devi_major));
1900 void
1901 ndi_rele_driver(dev_info_t *dip)
1903 ASSERT(i_ddi_node_state(dip) >= DS_BOUND);
1904 mod_rele_dev_by_major(DEVI(dip)->devi_major);
1908 * Single thread entry into devinfo node for modifying its children (devinfo,
1909 * pathinfo, and minor). To verify in ASSERTS use DEVI_BUSY_OWNED macro.
1911 void
1912 ndi_devi_enter(dev_info_t *dip, int *circular)
1914 struct dev_info *devi = DEVI(dip);
1915 ASSERT(dip != NULL);
1917 /* for vHCI, enforce (vHCI, pHCI) ndi_deve_enter() order */
1918 ASSERT(!MDI_VHCI(dip) || (mdi_devi_pdip_entered(dip) == 0) ||
1919 DEVI_BUSY_OWNED(dip));
1921 mutex_enter(&devi->devi_lock);
1922 if (devi->devi_busy_thread == curthread) {
1923 devi->devi_circular++;
1924 } else {
1925 while (DEVI_BUSY_CHANGING(devi) && !panicstr)
1926 cv_wait(&(devi->devi_cv), &(devi->devi_lock));
1927 if (panicstr) {
1928 mutex_exit(&devi->devi_lock);
1929 return;
1931 devi->devi_flags |= DEVI_BUSY;
1932 devi->devi_busy_thread = curthread;
1934 *circular = devi->devi_circular;
1935 mutex_exit(&devi->devi_lock);
1939 * Release ndi_devi_enter or successful ndi_devi_tryenter.
1941 void
1942 ndi_devi_exit(dev_info_t *dip, int circular)
1944 struct dev_info *devi = DEVI(dip);
1945 struct dev_info *vdevi;
1946 ASSERT(dip != NULL);
1948 if (panicstr)
1949 return;
1951 mutex_enter(&(devi->devi_lock));
1952 if (circular != 0) {
1953 devi->devi_circular--;
1954 } else {
1955 devi->devi_flags &= ~DEVI_BUSY;
1956 ASSERT(devi->devi_busy_thread == curthread);
1957 devi->devi_busy_thread = NULL;
1958 cv_broadcast(&(devi->devi_cv));
1960 mutex_exit(&(devi->devi_lock));
1963 * For pHCI exit we issue a broadcast to vHCI for ndi_devi_config_one()
1964 * doing cv_wait on vHCI.
1966 if (MDI_PHCI(dip)) {
1967 vdevi = DEVI(mdi_devi_get_vdip(dip));
1968 if (vdevi) {
1969 mutex_enter(&(vdevi->devi_lock));
1970 if (vdevi->devi_flags & DEVI_PHCI_SIGNALS_VHCI) {
1971 vdevi->devi_flags &= ~DEVI_PHCI_SIGNALS_VHCI;
1972 cv_broadcast(&(vdevi->devi_cv));
1974 mutex_exit(&(vdevi->devi_lock));
1980 * Release ndi_devi_enter and wait for possibility of new children, avoiding
1981 * possibility of missing broadcast before getting to cv_timedwait().
1983 static void
1984 ndi_devi_exit_and_wait(dev_info_t *dip, int circular, clock_t end_time)
1986 struct dev_info *devi = DEVI(dip);
1987 ASSERT(dip != NULL);
1989 if (panicstr)
1990 return;
1993 * We are called to wait for of a new child, and new child can
1994 * only be added if circular is zero.
1996 ASSERT(circular == 0);
1998 /* like ndi_devi_exit with circular of zero */
1999 mutex_enter(&(devi->devi_lock));
2000 devi->devi_flags &= ~DEVI_BUSY;
2001 ASSERT(devi->devi_busy_thread == curthread);
2002 devi->devi_busy_thread = NULL;
2003 cv_broadcast(&(devi->devi_cv));
2005 /* now wait for new children while still holding devi_lock */
2006 (void) cv_timedwait(&devi->devi_cv, &(devi->devi_lock), end_time);
2007 mutex_exit(&(devi->devi_lock));
2011 * Attempt to single thread entry into devinfo node for modifying its children.
2014 ndi_devi_tryenter(dev_info_t *dip, int *circular)
2016 int rval = 1; /* assume we enter */
2017 struct dev_info *devi = DEVI(dip);
2018 ASSERT(dip != NULL);
2020 mutex_enter(&devi->devi_lock);
2021 if (devi->devi_busy_thread == (void *)curthread) {
2022 devi->devi_circular++;
2023 } else {
2024 if (!DEVI_BUSY_CHANGING(devi)) {
2025 devi->devi_flags |= DEVI_BUSY;
2026 devi->devi_busy_thread = (void *)curthread;
2027 } else {
2028 rval = 0; /* devi is busy */
2031 *circular = devi->devi_circular;
2032 mutex_exit(&devi->devi_lock);
2033 return (rval);
2037 * Allocate and initialize a new dev_info structure.
2039 * This routine may be called at interrupt time by a nexus in
2040 * response to a hotplug event, therefore memory allocations are
2041 * not allowed to sleep.
2044 ndi_devi_alloc(dev_info_t *parent, char *node_name, pnode_t nodeid,
2045 dev_info_t **ret_dip)
2047 ASSERT(node_name != NULL);
2048 ASSERT(ret_dip != NULL);
2050 *ret_dip = i_ddi_alloc_node(parent, node_name, nodeid, -1, NULL,
2051 KM_NOSLEEP);
2052 if (*ret_dip == NULL) {
2053 return (NDI_NOMEM);
2056 return (NDI_SUCCESS);
2060 * Allocate and initialize a new dev_info structure
2061 * This routine may sleep and should not be called at interrupt time
2063 void
2064 ndi_devi_alloc_sleep(dev_info_t *parent, char *node_name, pnode_t nodeid,
2065 dev_info_t **ret_dip)
2067 ASSERT(node_name != NULL);
2068 ASSERT(ret_dip != NULL);
2070 *ret_dip = i_ddi_alloc_node(parent, node_name, nodeid, -1, NULL,
2071 KM_SLEEP);
2072 ASSERT(*ret_dip);
2076 * Remove an initialized (but not yet attached) dev_info
2077 * node from it's parent.
2080 ndi_devi_free(dev_info_t *dip)
2082 ASSERT(dip != NULL);
2084 if (i_ddi_node_state(dip) >= DS_INITIALIZED)
2085 return (DDI_FAILURE);
2087 NDI_CONFIG_DEBUG((CE_CONT, "ndi_devi_free: %s%d (%p)\n",
2088 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip));
2090 (void) ddi_remove_child(dip, 0);
2092 return (NDI_SUCCESS);
2096 * ndi_devi_bind_driver() binds a driver to a given device. If it fails
2097 * to bind the driver, it returns an appropriate error back. Some drivers
2098 * may want to know if the actually failed to bind.
2101 ndi_devi_bind_driver(dev_info_t *dip, uint_t flags)
2103 int ret = NDI_FAILURE;
2104 int circ;
2105 dev_info_t *pdip = ddi_get_parent(dip);
2106 ASSERT(pdip);
2108 NDI_CONFIG_DEBUG((CE_CONT,
2109 "ndi_devi_bind_driver: %s%d (%p) flags: %x\n",
2110 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip, flags));
2112 ndi_devi_enter(pdip, &circ);
2113 if (i_ndi_config_node(dip, DS_BOUND, flags) == DDI_SUCCESS)
2114 ret = NDI_SUCCESS;
2115 ndi_devi_exit(pdip, circ);
2117 return (ret);
2121 * ndi_devi_unbind_driver: unbind the dip
2123 static int
2124 ndi_devi_unbind_driver(dev_info_t *dip)
2126 ASSERT(DEVI_BUSY_OWNED(ddi_get_parent(dip)));
2128 return (i_ndi_unconfig_node(dip, DS_LINKED, 0));
2132 * Misc. help routines called by framework only
2136 * Get the state of node
2138 ddi_node_state_t
2139 i_ddi_node_state(dev_info_t *dip)
2141 return (DEVI(dip)->devi_node_state);
2145 * Set the state of node
2147 void
2148 i_ddi_set_node_state(dev_info_t *dip, ddi_node_state_t state)
2150 DEVI(dip)->devi_node_state = state;
2151 membar_enter(); /* make sure stores are flushed */
2155 * Determine if node is attached. The implementation accommodates transient
2156 * DS_READY->DS_ATTACHED->DS_READY state changes. Outside this file, this
2157 * function should be instead of i_ddi_node_state() DS_ATTACHED/DS_READY
2158 * state checks.
2161 i_ddi_devi_attached(dev_info_t *dip)
2163 return (DEVI(dip)->devi_node_state >= DS_ATTACHED);
2167 * Common function for finding a node in a sibling list given name and addr.
2169 * By default, name is matched with devi_node_name. The following
2170 * alternative match strategies are supported:
2172 * FIND_NODE_BY_NODENAME: Match on node name - typical use.
2174 * FIND_NODE_BY_DRIVER: A match on driver name bound to node is conducted.
2175 * This support is used for support of OBP generic names and
2176 * for the conversion from driver names to generic names. When
2177 * more consistency in the generic name environment is achieved
2178 * (and not needed for upgrade) this support can be removed.
2180 * FIND_NODE_BY_ADDR: Match on just the addr.
2181 * This support is only used/needed during boot to match
2182 * a node bound via a path-based driver alias.
2184 * If a child is not named (dev_addr == NULL), there are three
2185 * possible actions:
2187 * (1) skip it
2188 * (2) FIND_ADDR_BY_INIT: bring child to DS_INITIALIZED state
2189 * (3) FIND_ADDR_BY_CALLBACK: use a caller-supplied callback function
2191 #define FIND_NODE_BY_NODENAME 0x01
2192 #define FIND_NODE_BY_DRIVER 0x02
2193 #define FIND_NODE_BY_ADDR 0x04
2194 #define FIND_ADDR_BY_INIT 0x10
2195 #define FIND_ADDR_BY_CALLBACK 0x20
2197 static dev_info_t *
2198 find_sibling(dev_info_t *head, char *cname, char *caddr, uint_t flag,
2199 int (*callback)(dev_info_t *, char *, int))
2201 dev_info_t *dip;
2202 char *addr, *buf;
2203 major_t major;
2204 uint_t by;
2206 /* only one way to find a node */
2207 by = flag &
2208 (FIND_NODE_BY_DRIVER | FIND_NODE_BY_NODENAME | FIND_NODE_BY_ADDR);
2209 ASSERT(by && BIT_ONLYONESET(by));
2211 /* only one way to name a node */
2212 ASSERT(((flag & FIND_ADDR_BY_INIT) == 0) ||
2213 ((flag & FIND_ADDR_BY_CALLBACK) == 0));
2215 if (by == FIND_NODE_BY_DRIVER) {
2216 major = ddi_name_to_major(cname);
2217 if (major == DDI_MAJOR_T_NONE)
2218 return (NULL);
2221 /* preallocate buffer of naming node by callback */
2222 if (flag & FIND_ADDR_BY_CALLBACK)
2223 buf = kmem_alloc(MAXNAMELEN, KM_SLEEP);
2226 * Walk the child list to find a match
2228 if (head == NULL)
2229 return (NULL);
2230 ASSERT(DEVI_BUSY_OWNED(ddi_get_parent(head)));
2231 for (dip = head; dip; dip = ddi_get_next_sibling(dip)) {
2232 if (by == FIND_NODE_BY_NODENAME) {
2233 /* match node name */
2234 if (strcmp(cname, DEVI(dip)->devi_node_name) != 0)
2235 continue;
2236 } else if (by == FIND_NODE_BY_DRIVER) {
2237 /* match driver major */
2238 if (DEVI(dip)->devi_major != major)
2239 continue;
2242 if ((addr = DEVI(dip)->devi_addr) == NULL) {
2243 /* name the child based on the flag */
2244 if (flag & FIND_ADDR_BY_INIT) {
2245 if (ddi_initchild(ddi_get_parent(dip), dip)
2246 != DDI_SUCCESS)
2247 continue;
2248 addr = DEVI(dip)->devi_addr;
2249 } else if (flag & FIND_ADDR_BY_CALLBACK) {
2250 if ((callback == NULL) || (callback(
2251 dip, buf, MAXNAMELEN) != DDI_SUCCESS))
2252 continue;
2253 addr = buf;
2254 } else {
2255 continue; /* skip */
2259 /* match addr */
2260 ASSERT(addr != NULL);
2261 if (strcmp(caddr, addr) == 0)
2262 break; /* node found */
2265 if (flag & FIND_ADDR_BY_CALLBACK)
2266 kmem_free(buf, MAXNAMELEN);
2267 return (dip);
2271 * Find child of pdip with name: cname@caddr
2272 * Called by init_node() to look for duplicate nodes
2274 static dev_info_t *
2275 find_duplicate_child(dev_info_t *pdip, dev_info_t *dip)
2277 dev_info_t *dup;
2278 char *cname = DEVI(dip)->devi_node_name;
2279 char *caddr = DEVI(dip)->devi_addr;
2281 /* search nodes before dip */
2282 dup = find_sibling(ddi_get_child(pdip), cname, caddr,
2283 FIND_NODE_BY_NODENAME, NULL);
2284 if (dup != dip)
2285 return (dup);
2288 * search nodes after dip; normally this is not needed,
2290 return (find_sibling(ddi_get_next_sibling(dip), cname, caddr,
2291 FIND_NODE_BY_NODENAME, NULL));
2295 * Find a child of a given name and address, using a callback to name
2296 * unnamed children. cname is the binding name.
2298 dev_info_t *
2299 ndi_devi_findchild_by_callback(dev_info_t *pdip, char *dname, char *ua,
2300 int (*make_ua)(dev_info_t *, char *, int))
2302 int by = FIND_ADDR_BY_CALLBACK;
2304 ASSERT(DEVI_BUSY_OWNED(pdip));
2305 by |= dname ? FIND_NODE_BY_DRIVER : FIND_NODE_BY_ADDR;
2306 return (find_sibling(ddi_get_child(pdip), dname, ua, by, make_ua));
2310 * Find a child of a given name and address, invoking initchild to name
2311 * unnamed children. cname is the node name.
2313 static dev_info_t *
2314 find_child_by_name(dev_info_t *pdip, char *cname, char *caddr)
2316 dev_info_t *dip;
2318 /* attempt search without changing state of preceding siblings */
2319 dip = find_sibling(ddi_get_child(pdip), cname, caddr,
2320 FIND_NODE_BY_NODENAME, NULL);
2321 if (dip)
2322 return (dip);
2324 return (find_sibling(ddi_get_child(pdip), cname, caddr,
2325 FIND_NODE_BY_NODENAME|FIND_ADDR_BY_INIT, NULL));
2329 * Find a child of a given name and address, invoking initchild to name
2330 * unnamed children. cname is the node name.
2332 static dev_info_t *
2333 find_child_by_driver(dev_info_t *pdip, char *cname, char *caddr)
2335 dev_info_t *dip;
2337 /* attempt search without changing state of preceding siblings */
2338 dip = find_sibling(ddi_get_child(pdip), cname, caddr,
2339 FIND_NODE_BY_DRIVER, NULL);
2340 if (dip)
2341 return (dip);
2343 return (find_sibling(ddi_get_child(pdip), cname, caddr,
2344 FIND_NODE_BY_DRIVER|FIND_ADDR_BY_INIT, NULL));
2348 * Find a child of a given address, invoking initchild to name
2349 * unnamed children. cname is the node name.
2351 * NOTE: This function is only used during boot. One would hope that
2352 * unique sibling unit-addresses on hardware branches of the tree would
2353 * be a requirement to avoid two drivers trying to control the same
2354 * piece of hardware. Unfortunately there are some cases where this
2355 * situation exists (/ssm@0,0/pci@1c,700000 /ssm@0,0/sghsc@1c,700000).
2356 * Until unit-address uniqueness of siblings is guaranteed, use of this
2357 * interface for purposes other than boot should be avoided.
2359 static dev_info_t *
2360 find_child_by_addr(dev_info_t *pdip, char *caddr)
2362 dev_info_t *dip;
2364 /* return NULL if called without a unit-address */
2365 if ((caddr == NULL) || (*caddr == '\0'))
2366 return (NULL);
2368 /* attempt search without changing state of preceding siblings */
2369 dip = find_sibling(ddi_get_child(pdip), NULL, caddr,
2370 FIND_NODE_BY_ADDR, NULL);
2371 if (dip)
2372 return (dip);
2374 return (find_sibling(ddi_get_child(pdip), NULL, caddr,
2375 FIND_NODE_BY_ADDR|FIND_ADDR_BY_INIT, NULL));
2379 * Deleting a property list. Take care, since some property structures
2380 * may not be fully built.
2382 void
2383 i_ddi_prop_list_delete(ddi_prop_t *prop)
2385 while (prop) {
2386 ddi_prop_t *next = prop->prop_next;
2387 if (prop->prop_name)
2388 kmem_free(prop->prop_name, strlen(prop->prop_name) + 1);
2389 if ((prop->prop_len != 0) && prop->prop_val)
2390 kmem_free(prop->prop_val, prop->prop_len);
2391 kmem_free(prop, sizeof (struct ddi_prop));
2392 prop = next;
2397 * Duplicate property list
2399 ddi_prop_t *
2400 i_ddi_prop_list_dup(ddi_prop_t *prop, uint_t flag)
2402 ddi_prop_t *result, *prev, *copy;
2404 if (prop == NULL)
2405 return (NULL);
2407 result = prev = NULL;
2408 for (; prop != NULL; prop = prop->prop_next) {
2409 ASSERT(prop->prop_name != NULL);
2410 copy = kmem_zalloc(sizeof (struct ddi_prop), flag);
2411 if (copy == NULL)
2412 goto fail;
2414 copy->prop_dev = prop->prop_dev;
2415 copy->prop_flags = prop->prop_flags;
2416 copy->prop_name = i_ddi_strdup(prop->prop_name, flag);
2417 if (copy->prop_name == NULL)
2418 goto fail;
2420 if ((copy->prop_len = prop->prop_len) != 0) {
2421 copy->prop_val = kmem_zalloc(prop->prop_len, flag);
2422 if (copy->prop_val == NULL)
2423 goto fail;
2425 bcopy(prop->prop_val, copy->prop_val, prop->prop_len);
2428 if (prev == NULL)
2429 result = prev = copy;
2430 else
2431 prev->prop_next = copy;
2432 prev = copy;
2434 return (result);
2436 fail:
2437 i_ddi_prop_list_delete(result);
2438 return (NULL);
2442 * Create a reference property list, currently used only for
2443 * driver global properties. Created with ref count of 1.
2445 ddi_prop_list_t *
2446 i_ddi_prop_list_create(ddi_prop_t *props)
2448 ddi_prop_list_t *list = kmem_alloc(sizeof (*list), KM_SLEEP);
2449 list->prop_list = props;
2450 list->prop_ref = 1;
2451 return (list);
2455 * Increment/decrement reference count. The reference is
2456 * protected by dn_lock. The only interfaces modifying
2457 * dn_global_prop_ptr is in impl_make[free]_parlist().
2459 void
2460 i_ddi_prop_list_hold(ddi_prop_list_t *prop_list, struct devnames *dnp)
2462 ASSERT(prop_list->prop_ref >= 0);
2463 ASSERT(mutex_owned(&dnp->dn_lock));
2464 prop_list->prop_ref++;
2467 void
2468 i_ddi_prop_list_rele(ddi_prop_list_t *prop_list, struct devnames *dnp)
2470 ASSERT(prop_list->prop_ref > 0);
2471 ASSERT(mutex_owned(&dnp->dn_lock));
2472 prop_list->prop_ref--;
2474 if (prop_list->prop_ref == 0) {
2475 i_ddi_prop_list_delete(prop_list->prop_list);
2476 kmem_free(prop_list, sizeof (*prop_list));
2481 * Free table of classes by drivers
2483 void
2484 i_ddi_free_exported_classes(char **classes, int n)
2486 if ((n == 0) || (classes == NULL))
2487 return;
2489 kmem_free(classes, n * sizeof (char *));
2493 * Get all classes exported by dip
2496 i_ddi_get_exported_classes(dev_info_t *dip, char ***classes)
2498 extern void lock_hw_class_list();
2499 extern void unlock_hw_class_list();
2500 extern int get_class(const char *, char **);
2502 static char *rootclass = "root";
2503 int n = 0, nclass = 0;
2504 char **buf;
2506 ASSERT(i_ddi_node_state(dip) >= DS_BOUND);
2508 if (dip == ddi_root_node()) /* rootnode exports class "root" */
2509 nclass = 1;
2510 lock_hw_class_list();
2511 nclass += get_class(ddi_driver_name(dip), NULL);
2512 if (nclass == 0) {
2513 unlock_hw_class_list();
2514 return (0); /* no class exported */
2517 *classes = buf = kmem_alloc(nclass * sizeof (char *), KM_SLEEP);
2518 if (dip == ddi_root_node()) {
2519 *buf++ = rootclass;
2520 n = 1;
2522 n += get_class(ddi_driver_name(dip), buf);
2523 unlock_hw_class_list();
2525 ASSERT(n == nclass); /* make sure buf wasn't overrun */
2526 return (nclass);
2530 * Helper functions, returns NULL if no memory.
2532 char *
2533 i_ddi_strdup(char *str, uint_t flag)
2535 char *copy;
2537 if (str == NULL)
2538 return (NULL);
2540 copy = kmem_alloc(strlen(str) + 1, flag);
2541 if (copy == NULL)
2542 return (NULL);
2544 (void) strcpy(copy, str);
2545 return (copy);
2549 * Load driver.conf file for major. Load all if major == -1.
2551 * This is called
2552 * - early in boot after devnames array is initialized
2553 * - from vfs code when certain file systems are mounted
2554 * - from add_drv when a new driver is added
2557 i_ddi_load_drvconf(major_t major)
2559 extern int modrootloaded;
2561 major_t low, high, m;
2563 if (major == DDI_MAJOR_T_NONE) {
2564 low = 0;
2565 high = devcnt - 1;
2566 } else {
2567 if (major >= devcnt)
2568 return (EINVAL);
2569 low = high = major;
2572 for (m = low; m <= high; m++) {
2573 struct devnames *dnp = &devnamesp[m];
2574 LOCK_DEV_OPS(&dnp->dn_lock);
2575 dnp->dn_flags &= ~(DN_DRIVER_HELD|DN_DRIVER_INACTIVE);
2576 (void) impl_make_parlist(m);
2577 UNLOCK_DEV_OPS(&dnp->dn_lock);
2580 if (modrootloaded) {
2581 ddi_walk_devs(ddi_root_node(), reset_nexus_flags,
2582 (void *)(uintptr_t)major);
2585 /* build dn_list from old entries in path_to_inst */
2586 e_ddi_unorphan_instance_nos();
2587 return (0);
2591 * Unload a specific driver.conf.
2592 * Don't support unload all because it doesn't make any sense
2595 i_ddi_unload_drvconf(major_t major)
2597 int error;
2598 struct devnames *dnp;
2600 if (major >= devcnt)
2601 return (EINVAL);
2604 * Take the per-driver lock while unloading driver.conf
2606 dnp = &devnamesp[major];
2607 LOCK_DEV_OPS(&dnp->dn_lock);
2608 error = impl_free_parlist(major);
2609 UNLOCK_DEV_OPS(&dnp->dn_lock);
2610 return (error);
2614 * Merge a .conf node. This is called by nexus drivers to augment
2615 * hw node with properties specified in driver.conf file. This function
2616 * takes a callback routine to name nexus children.
2617 * The parent node must be held busy.
2619 * It returns DDI_SUCCESS if the node is merged and DDI_FAILURE otherwise.
2622 ndi_merge_node(dev_info_t *dip, int (*make_ua)(dev_info_t *, char *, int))
2624 dev_info_t *hwdip;
2626 ASSERT(ndi_dev_is_persistent_node(dip) == 0);
2627 ASSERT(ddi_get_name_addr(dip) != NULL);
2629 hwdip = ndi_devi_findchild_by_callback(ddi_get_parent(dip),
2630 ddi_binding_name(dip), ddi_get_name_addr(dip), make_ua);
2633 * Look for the hardware node that is the target of the merge;
2634 * return failure if not found.
2636 if ((hwdip == NULL) || (hwdip == dip)) {
2637 char *buf = kmem_alloc(MAXNAMELEN, KM_SLEEP);
2638 NDI_CONFIG_DEBUG((CE_WARN, "No HW node to merge conf node %s",
2639 ddi_deviname(dip, buf)));
2640 kmem_free(buf, MAXNAMELEN);
2641 return (DDI_FAILURE);
2645 * Make sure the hardware node is uninitialized and has no property.
2646 * This may not be the case if new .conf files are load after some
2647 * hardware nodes have already been initialized and attached.
2649 * N.B. We return success here because the node was *intended*
2650 * to be a merge node because there is a hw node with the name.
2652 mutex_enter(&DEVI(hwdip)->devi_lock);
2653 if (ndi_dev_is_persistent_node(hwdip) == 0) {
2654 char *buf;
2655 mutex_exit(&DEVI(hwdip)->devi_lock);
2657 buf = kmem_alloc(MAXNAMELEN, KM_SLEEP);
2658 NDI_CONFIG_DEBUG((CE_NOTE, "Duplicate .conf node %s",
2659 ddi_deviname(dip, buf)));
2660 kmem_free(buf, MAXNAMELEN);
2661 return (DDI_SUCCESS);
2665 * If it is possible that the hardware has already been touched
2666 * then don't merge.
2668 if (i_ddi_node_state(hwdip) >= DS_INITIALIZED ||
2669 (DEVI(hwdip)->devi_sys_prop_ptr != NULL) ||
2670 (DEVI(hwdip)->devi_drv_prop_ptr != NULL)) {
2671 char *buf;
2672 mutex_exit(&DEVI(hwdip)->devi_lock);
2674 buf = kmem_alloc(MAXNAMELEN, KM_SLEEP);
2675 NDI_CONFIG_DEBUG((CE_NOTE,
2676 "!Cannot merge .conf node %s with hw node %p "
2677 "-- not in proper state",
2678 ddi_deviname(dip, buf), (void *)hwdip));
2679 kmem_free(buf, MAXNAMELEN);
2680 return (DDI_SUCCESS);
2683 mutex_enter(&DEVI(dip)->devi_lock);
2684 DEVI(hwdip)->devi_sys_prop_ptr = DEVI(dip)->devi_sys_prop_ptr;
2685 DEVI(hwdip)->devi_drv_prop_ptr = DEVI(dip)->devi_drv_prop_ptr;
2686 DEVI(dip)->devi_sys_prop_ptr = NULL;
2687 DEVI(dip)->devi_drv_prop_ptr = NULL;
2688 mutex_exit(&DEVI(dip)->devi_lock);
2689 mutex_exit(&DEVI(hwdip)->devi_lock);
2691 return (DDI_SUCCESS);
2695 * Merge a "wildcard" .conf node. This is called by nexus drivers to
2696 * augment a set of hw node with properties specified in driver.conf file.
2697 * The parent node must be held busy.
2699 * There is no failure mode, since the nexus may or may not have child
2700 * node bound the driver specified by the wildcard node.
2702 void
2703 ndi_merge_wildcard_node(dev_info_t *dip)
2705 dev_info_t *hwdip;
2706 dev_info_t *pdip = ddi_get_parent(dip);
2707 major_t major = ddi_driver_major(dip);
2709 /* never attempt to merge a hw node */
2710 ASSERT(ndi_dev_is_persistent_node(dip) == 0);
2711 /* must be bound to a driver major number */
2712 ASSERT(major != DDI_MAJOR_T_NONE);
2715 * Walk the child list to find all nodes bound to major
2716 * and copy properties.
2718 mutex_enter(&DEVI(dip)->devi_lock);
2719 ASSERT(DEVI_BUSY_OWNED(pdip));
2720 for (hwdip = ddi_get_child(pdip); hwdip;
2721 hwdip = ddi_get_next_sibling(hwdip)) {
2723 * Skip nodes not bound to same driver
2725 if (ddi_driver_major(hwdip) != major)
2726 continue;
2729 * Skip .conf nodes
2731 if (ndi_dev_is_persistent_node(hwdip) == 0)
2732 continue;
2735 * Make sure the node is uninitialized and has no property.
2737 mutex_enter(&DEVI(hwdip)->devi_lock);
2738 if (i_ddi_node_state(hwdip) >= DS_INITIALIZED ||
2739 (DEVI(hwdip)->devi_sys_prop_ptr != NULL) ||
2740 (DEVI(hwdip)->devi_drv_prop_ptr != NULL)) {
2741 mutex_exit(&DEVI(hwdip)->devi_lock);
2742 NDI_CONFIG_DEBUG((CE_NOTE, "HW node %p state not "
2743 "suitable for merging wildcard conf node %s",
2744 (void *)hwdip, ddi_node_name(dip)));
2745 continue;
2748 DEVI(hwdip)->devi_sys_prop_ptr =
2749 i_ddi_prop_list_dup(DEVI(dip)->devi_sys_prop_ptr, KM_SLEEP);
2750 DEVI(hwdip)->devi_drv_prop_ptr =
2751 i_ddi_prop_list_dup(DEVI(dip)->devi_drv_prop_ptr, KM_SLEEP);
2752 mutex_exit(&DEVI(hwdip)->devi_lock);
2754 mutex_exit(&DEVI(dip)->devi_lock);
2758 * Return the major number based on the compatible property. This interface
2759 * may be used in situations where we are trying to detect if a better driver
2760 * now exists for a device, so it must use the 'compatible' property. If
2761 * a non-NULL formp is specified and the binding was based on compatible then
2762 * return the pointer to the form used in *formp.
2764 major_t
2765 ddi_compatible_driver_major(dev_info_t *dip, char **formp)
2767 struct dev_info *devi = DEVI(dip);
2768 void *compat;
2769 size_t len;
2770 char *p = NULL;
2771 major_t major = DDI_MAJOR_T_NONE;
2773 if (formp)
2774 *formp = NULL;
2776 if (ddi_prop_exists(DDI_DEV_T_NONE, dip, DDI_PROP_DONTPASS,
2777 "ddi-assigned")) {
2778 major = ddi_name_to_major("nulldriver");
2779 return (major);
2783 * Highest precedence binding is a path-oriented alias. Since this
2784 * requires a 'path', this type of binding occurs via more obtuse
2785 * 'rebind'. The need for a path-oriented alias 'rebind' is detected
2786 * after a successful DDI_CTLOPS_INITCHILD to another driver: this is
2787 * is the first point at which the unit-address (or instance) of the
2788 * last component of the path is available (even though the path is
2789 * bound to the wrong driver at this point).
2791 if (devi->devi_flags & DEVI_REBIND) {
2792 p = devi->devi_rebinding_name;
2793 major = ddi_name_to_major(p);
2794 if (driver_active(major)) {
2795 if (formp)
2796 *formp = p;
2797 return (major);
2801 * If for some reason devi_rebinding_name no longer resolves
2802 * to a proper driver then clear DEVI_REBIND.
2804 mutex_enter(&devi->devi_lock);
2805 devi->devi_flags &= ~DEVI_REBIND;
2806 mutex_exit(&devi->devi_lock);
2809 /* look up compatible property */
2810 (void) lookup_compatible(dip, KM_SLEEP);
2811 compat = (void *)(devi->devi_compat_names);
2812 len = devi->devi_compat_length;
2814 /* find the highest precedence compatible form with a driver binding */
2815 while ((p = prom_decode_composite_string(compat, len, p)) != NULL) {
2816 major = ddi_name_to_major(p);
2817 if (driver_active(major)) {
2818 if (formp)
2819 *formp = p;
2820 return (major);
2825 * none of the compatible forms have a driver binding, see if
2826 * the node name has a driver binding.
2828 major = ddi_name_to_major(ddi_node_name(dip));
2829 if (driver_active(major))
2830 return (major);
2832 /* no driver */
2833 return (DDI_MAJOR_T_NONE);
2837 * Static help functions
2841 * lookup the "compatible" property and cache it's contents in the
2842 * device node.
2844 static int
2845 lookup_compatible(dev_info_t *dip, uint_t flag)
2847 int rv;
2848 int prop_flags;
2849 uint_t ncompatstrs;
2850 char **compatstrpp;
2851 char *di_compat_strp;
2852 size_t di_compat_strlen;
2854 if (DEVI(dip)->devi_compat_names) {
2855 return (DDI_SUCCESS);
2858 prop_flags = DDI_PROP_TYPE_STRING | DDI_PROP_DONTPASS;
2860 if (flag & KM_NOSLEEP) {
2861 prop_flags |= DDI_PROP_DONTSLEEP;
2864 if (ndi_dev_is_prom_node(dip) == 0) {
2865 prop_flags |= DDI_PROP_NOTPROM;
2868 rv = ddi_prop_lookup_common(DDI_DEV_T_ANY, dip, prop_flags,
2869 "compatible", &compatstrpp, &ncompatstrs,
2870 ddi_prop_fm_decode_strings);
2872 if (rv == DDI_PROP_NOT_FOUND) {
2873 return (DDI_SUCCESS);
2876 if (rv != DDI_PROP_SUCCESS) {
2877 return (DDI_FAILURE);
2881 * encode the compatible property data in the dev_info node
2883 rv = DDI_SUCCESS;
2884 if (ncompatstrs != 0) {
2885 di_compat_strp = encode_composite_string(compatstrpp,
2886 ncompatstrs, &di_compat_strlen, flag);
2887 if (di_compat_strp != NULL) {
2888 DEVI(dip)->devi_compat_names = di_compat_strp;
2889 DEVI(dip)->devi_compat_length = di_compat_strlen;
2890 } else {
2891 rv = DDI_FAILURE;
2894 ddi_prop_free(compatstrpp);
2895 return (rv);
2899 * Create a composite string from a list of strings.
2901 * A composite string consists of a single buffer containing one
2902 * or more NULL terminated strings.
2904 static char *
2905 encode_composite_string(char **strings, uint_t nstrings, size_t *retsz,
2906 uint_t flag)
2908 uint_t index;
2909 char **strpp;
2910 uint_t slen;
2911 size_t cbuf_sz = 0;
2912 char *cbuf_p;
2913 char *cbuf_ip;
2915 if (strings == NULL || nstrings == 0 || retsz == NULL) {
2916 return (NULL);
2919 for (index = 0, strpp = strings; index < nstrings; index++)
2920 cbuf_sz += strlen(*(strpp++)) + 1;
2922 if ((cbuf_p = kmem_alloc(cbuf_sz, flag)) == NULL) {
2923 cmn_err(CE_NOTE,
2924 "?failed to allocate device node compatstr");
2925 return (NULL);
2928 cbuf_ip = cbuf_p;
2929 for (index = 0, strpp = strings; index < nstrings; index++) {
2930 slen = strlen(*strpp);
2931 bcopy(*(strpp++), cbuf_ip, slen);
2932 cbuf_ip += slen;
2933 *(cbuf_ip++) = '\0';
2936 *retsz = cbuf_sz;
2937 return (cbuf_p);
2940 static void
2941 link_to_driver_list(dev_info_t *dip)
2943 major_t major = DEVI(dip)->devi_major;
2944 struct devnames *dnp;
2946 ASSERT(major != DDI_MAJOR_T_NONE);
2949 * Remove from orphan list
2951 if (ndi_dev_is_persistent_node(dip)) {
2952 dnp = &orphanlist;
2953 remove_from_dn_list(dnp, dip);
2957 * Add to per driver list
2959 dnp = &devnamesp[major];
2960 add_to_dn_list(dnp, dip);
2963 static void
2964 unlink_from_driver_list(dev_info_t *dip)
2966 major_t major = DEVI(dip)->devi_major;
2967 struct devnames *dnp;
2969 ASSERT(major != DDI_MAJOR_T_NONE);
2972 * Remove from per-driver list
2974 dnp = &devnamesp[major];
2975 remove_from_dn_list(dnp, dip);
2978 * Add to orphan list
2980 if (ndi_dev_is_persistent_node(dip)) {
2981 dnp = &orphanlist;
2982 add_to_dn_list(dnp, dip);
2987 * scan the per-driver list looking for dev_info "dip"
2989 static dev_info_t *
2990 in_dn_list(struct devnames *dnp, dev_info_t *dip)
2992 struct dev_info *idevi;
2994 if ((idevi = DEVI(dnp->dn_head)) == NULL)
2995 return (NULL);
2997 while (idevi) {
2998 if (idevi == DEVI(dip))
2999 return (dip);
3000 idevi = idevi->devi_next;
3002 return (NULL);
3006 * insert devinfo node 'dip' into the per-driver instance list
3007 * headed by 'dnp'
3009 * Nodes on the per-driver list are ordered: HW - SID - PSEUDO. The order is
3010 * required for merging of .conf file data to work properly.
3012 static void
3013 add_to_ordered_dn_list(struct devnames *dnp, dev_info_t *dip)
3015 dev_info_t **dipp;
3017 ASSERT(mutex_owned(&(dnp->dn_lock)));
3019 dipp = &dnp->dn_head;
3020 if (ndi_dev_is_prom_node(dip)) {
3022 * Find the first non-prom node or end of list
3024 while (*dipp && (ndi_dev_is_prom_node(*dipp) != 0)) {
3025 dipp = (dev_info_t **)&DEVI(*dipp)->devi_next;
3027 } else if (ndi_dev_is_persistent_node(dip)) {
3029 * Find the first non-persistent node
3031 while (*dipp && (ndi_dev_is_persistent_node(*dipp) != 0)) {
3032 dipp = (dev_info_t **)&DEVI(*dipp)->devi_next;
3034 } else {
3036 * Find the end of the list
3038 while (*dipp) {
3039 dipp = (dev_info_t **)&DEVI(*dipp)->devi_next;
3043 DEVI(dip)->devi_next = DEVI(*dipp);
3044 *dipp = dip;
3048 * add a list of device nodes to the device node list in the
3049 * devnames structure
3051 static void
3052 add_to_dn_list(struct devnames *dnp, dev_info_t *dip)
3055 * Look to see if node already exists
3057 LOCK_DEV_OPS(&(dnp->dn_lock));
3058 if (in_dn_list(dnp, dip)) {
3059 cmn_err(CE_NOTE, "add_to_dn_list: node %s already in list",
3060 DEVI(dip)->devi_node_name);
3061 } else {
3062 add_to_ordered_dn_list(dnp, dip);
3064 UNLOCK_DEV_OPS(&(dnp->dn_lock));
3067 static void
3068 remove_from_dn_list(struct devnames *dnp, dev_info_t *dip)
3070 dev_info_t **plist;
3072 LOCK_DEV_OPS(&(dnp->dn_lock));
3074 plist = (dev_info_t **)&dnp->dn_head;
3075 while (*plist && (*plist != dip)) {
3076 plist = (dev_info_t **)&DEVI(*plist)->devi_next;
3079 if (*plist != NULL) {
3080 ASSERT(*plist == dip);
3081 *plist = (dev_info_t *)(DEVI(dip)->devi_next);
3082 DEVI(dip)->devi_next = NULL;
3083 } else {
3084 NDI_CONFIG_DEBUG((CE_NOTE,
3085 "remove_from_dn_list: node %s not found in list",
3086 DEVI(dip)->devi_node_name));
3089 UNLOCK_DEV_OPS(&(dnp->dn_lock));
3093 * Add and remove reference driver global property list
3095 static void
3096 add_global_props(dev_info_t *dip)
3098 struct devnames *dnp;
3099 ddi_prop_list_t *plist;
3101 ASSERT(DEVI(dip)->devi_global_prop_list == NULL);
3102 ASSERT(DEVI(dip)->devi_major != DDI_MAJOR_T_NONE);
3104 dnp = &devnamesp[DEVI(dip)->devi_major];
3105 LOCK_DEV_OPS(&dnp->dn_lock);
3106 plist = dnp->dn_global_prop_ptr;
3107 if (plist == NULL) {
3108 UNLOCK_DEV_OPS(&dnp->dn_lock);
3109 return;
3111 i_ddi_prop_list_hold(plist, dnp);
3112 UNLOCK_DEV_OPS(&dnp->dn_lock);
3114 mutex_enter(&DEVI(dip)->devi_lock);
3115 DEVI(dip)->devi_global_prop_list = plist;
3116 mutex_exit(&DEVI(dip)->devi_lock);
3119 static void
3120 remove_global_props(dev_info_t *dip)
3122 ddi_prop_list_t *proplist;
3124 mutex_enter(&DEVI(dip)->devi_lock);
3125 proplist = DEVI(dip)->devi_global_prop_list;
3126 DEVI(dip)->devi_global_prop_list = NULL;
3127 mutex_exit(&DEVI(dip)->devi_lock);
3129 if (proplist) {
3130 major_t major;
3131 struct devnames *dnp;
3133 major = ddi_driver_major(dip);
3134 ASSERT(major != DDI_MAJOR_T_NONE);
3135 dnp = &devnamesp[major];
3136 LOCK_DEV_OPS(&dnp->dn_lock);
3137 i_ddi_prop_list_rele(proplist, dnp);
3138 UNLOCK_DEV_OPS(&dnp->dn_lock);
3142 #ifdef DEBUG
3144 * Set this variable to '0' to disable the optimization,
3145 * and to 2 to print debug message.
3147 static int optimize_dtree = 1;
3149 static void
3150 debug_dtree(dev_info_t *devi, struct dev_info *adevi, char *service)
3152 char *adeviname, *buf;
3155 * Don't print unless optimize dtree is set to 2+
3157 if (optimize_dtree <= 1)
3158 return;
3160 buf = kmem_alloc(MAXNAMELEN, KM_SLEEP);
3161 adeviname = ddi_deviname((dev_info_t *)adevi, buf);
3162 if (*adeviname == '\0')
3163 adeviname = "root";
3165 cmn_err(CE_CONT, "%s %s -> %s\n",
3166 ddi_deviname(devi, buf), service, adeviname);
3168 kmem_free(buf, MAXNAMELEN);
3170 #else /* DEBUG */
3171 #define debug_dtree(a1, a2, a3) /* nothing */
3172 #endif /* DEBUG */
3174 static void
3175 ddi_optimize_dtree(dev_info_t *devi)
3177 struct dev_info *pdevi;
3178 struct bus_ops *b;
3180 pdevi = DEVI(devi)->devi_parent;
3181 ASSERT(pdevi);
3184 * Set the unoptimized values
3186 DEVI(devi)->devi_bus_map_fault = pdevi;
3187 DEVI(devi)->devi_bus_dma_allochdl = pdevi;
3188 DEVI(devi)->devi_bus_dma_freehdl = pdevi;
3189 DEVI(devi)->devi_bus_dma_bindhdl = pdevi;
3190 DEVI(devi)->devi_bus_dma_bindfunc =
3191 pdevi->devi_ops->devo_bus_ops->bus_dma_bindhdl;
3192 DEVI(devi)->devi_bus_dma_unbindhdl = pdevi;
3193 DEVI(devi)->devi_bus_dma_unbindfunc =
3194 pdevi->devi_ops->devo_bus_ops->bus_dma_unbindhdl;
3195 DEVI(devi)->devi_bus_dma_flush = pdevi;
3196 DEVI(devi)->devi_bus_dma_win = pdevi;
3197 DEVI(devi)->devi_bus_dma_ctl = pdevi;
3198 DEVI(devi)->devi_bus_ctl = pdevi;
3200 #ifdef DEBUG
3201 if (optimize_dtree == 0)
3202 return;
3203 #endif /* DEBUG */
3205 b = pdevi->devi_ops->devo_bus_ops;
3207 if (i_ddi_map_fault == b->bus_map_fault) {
3208 DEVI(devi)->devi_bus_map_fault = pdevi->devi_bus_map_fault;
3209 debug_dtree(devi, DEVI(devi)->devi_bus_map_fault,
3210 "bus_map_fault");
3213 if (ddi_dma_allochdl == b->bus_dma_allochdl) {
3214 DEVI(devi)->devi_bus_dma_allochdl =
3215 pdevi->devi_bus_dma_allochdl;
3216 debug_dtree(devi, DEVI(devi)->devi_bus_dma_allochdl,
3217 "bus_dma_allochdl");
3220 if (ddi_dma_freehdl == b->bus_dma_freehdl) {
3221 DEVI(devi)->devi_bus_dma_freehdl = pdevi->devi_bus_dma_freehdl;
3222 debug_dtree(devi, DEVI(devi)->devi_bus_dma_freehdl,
3223 "bus_dma_freehdl");
3226 if (ddi_dma_bindhdl == b->bus_dma_bindhdl) {
3227 DEVI(devi)->devi_bus_dma_bindhdl = pdevi->devi_bus_dma_bindhdl;
3228 DEVI(devi)->devi_bus_dma_bindfunc =
3229 pdevi->devi_bus_dma_bindhdl->devi_ops->
3230 devo_bus_ops->bus_dma_bindhdl;
3231 debug_dtree(devi, DEVI(devi)->devi_bus_dma_bindhdl,
3232 "bus_dma_bindhdl");
3235 if (ddi_dma_unbindhdl == b->bus_dma_unbindhdl) {
3236 DEVI(devi)->devi_bus_dma_unbindhdl =
3237 pdevi->devi_bus_dma_unbindhdl;
3238 DEVI(devi)->devi_bus_dma_unbindfunc =
3239 pdevi->devi_bus_dma_unbindhdl->devi_ops->
3240 devo_bus_ops->bus_dma_unbindhdl;
3241 debug_dtree(devi, DEVI(devi)->devi_bus_dma_unbindhdl,
3242 "bus_dma_unbindhdl");
3245 if (ddi_dma_flush == b->bus_dma_flush) {
3246 DEVI(devi)->devi_bus_dma_flush = pdevi->devi_bus_dma_flush;
3247 debug_dtree(devi, DEVI(devi)->devi_bus_dma_flush,
3248 "bus_dma_flush");
3251 if (ddi_dma_win == b->bus_dma_win) {
3252 DEVI(devi)->devi_bus_dma_win = pdevi->devi_bus_dma_win;
3253 debug_dtree(devi, DEVI(devi)->devi_bus_dma_win,
3254 "bus_dma_win");
3257 if (ddi_dma_mctl == b->bus_dma_ctl) {
3258 DEVI(devi)->devi_bus_dma_ctl = pdevi->devi_bus_dma_ctl;
3259 debug_dtree(devi, DEVI(devi)->devi_bus_dma_ctl, "bus_dma_ctl");
3262 if (ddi_ctlops == b->bus_ctl) {
3263 DEVI(devi)->devi_bus_ctl = pdevi->devi_bus_ctl;
3264 debug_dtree(devi, DEVI(devi)->devi_bus_ctl, "bus_ctl");
3268 #define MIN_DEVINFO_LOG_SIZE max_ncpus
3269 #define MAX_DEVINFO_LOG_SIZE max_ncpus * 10
3271 static void
3272 da_log_init()
3274 devinfo_log_header_t *dh;
3275 int logsize = devinfo_log_size;
3277 if (logsize == 0)
3278 logsize = MIN_DEVINFO_LOG_SIZE;
3279 else if (logsize > MAX_DEVINFO_LOG_SIZE)
3280 logsize = MAX_DEVINFO_LOG_SIZE;
3282 dh = kmem_alloc(logsize * PAGESIZE, KM_SLEEP);
3283 mutex_init(&dh->dh_lock, NULL, MUTEX_DEFAULT, NULL);
3284 dh->dh_max = ((logsize * PAGESIZE) - sizeof (*dh)) /
3285 sizeof (devinfo_audit_t) + 1;
3286 dh->dh_curr = -1;
3287 dh->dh_hits = 0;
3289 devinfo_audit_log = dh;
3293 * Log the stack trace in per-devinfo audit structure and also enter
3294 * it into a system wide log for recording the time history.
3296 static void
3297 da_log_enter(dev_info_t *dip)
3299 devinfo_audit_t *da_log, *da = DEVI(dip)->devi_audit;
3300 devinfo_log_header_t *dh = devinfo_audit_log;
3302 if (devinfo_audit_log == NULL)
3303 return;
3305 ASSERT(da != NULL);
3307 da->da_devinfo = dip;
3308 da->da_timestamp = gethrtime();
3309 da->da_thread = curthread;
3310 da->da_node_state = DEVI(dip)->devi_node_state;
3311 da->da_device_state = DEVI(dip)->devi_state;
3312 da->da_depth = getpcstack(da->da_stack, DDI_STACK_DEPTH);
3315 * Copy into common log and note the location for tracing history
3317 mutex_enter(&dh->dh_lock);
3318 dh->dh_hits++;
3319 dh->dh_curr++;
3320 if (dh->dh_curr >= dh->dh_max)
3321 dh->dh_curr -= dh->dh_max;
3322 da_log = &dh->dh_entry[dh->dh_curr];
3323 mutex_exit(&dh->dh_lock);
3325 bcopy(da, da_log, sizeof (devinfo_audit_t));
3326 da->da_lastlog = da_log;
3329 static void
3330 attach_drivers()
3332 int i;
3333 for (i = 0; i < devcnt; i++) {
3334 struct devnames *dnp = &devnamesp[i];
3335 if ((dnp->dn_flags & DN_FORCE_ATTACH) &&
3336 (ddi_hold_installed_driver((major_t)i) != NULL))
3337 ddi_rele_driver((major_t)i);
3342 * Launch a thread to force attach drivers. This avoids penalty on boot time.
3344 void
3345 i_ddi_forceattach_drivers()
3349 * Attach IB VHCI driver before the force-attach thread attaches the
3350 * IB HCA driver. IB HCA driver will fail if IB Nexus has not yet
3351 * been attached.
3353 (void) ddi_hold_installed_driver(ddi_name_to_major("ib"));
3355 (void) thread_create(NULL, 0, (void (*)())attach_drivers, NULL, 0, &p0,
3356 TS_RUN, minclsyspri);
3360 * This is a private DDI interface for optimizing boot performance.
3361 * I/O subsystem initialization is considered complete when devfsadm
3362 * is executed.
3364 * NOTE: The start of syseventd happens to be a convenient indicator
3365 * of the completion of I/O initialization during boot.
3366 * The implementation should be replaced by something more robust.
3369 i_ddi_io_initialized()
3371 extern int sysevent_daemon_init;
3372 return (sysevent_daemon_init);
3376 * May be used to determine system boot state
3377 * "Available" means the system is for the most part up
3378 * and initialized, with all system services either up or
3379 * capable of being started. This state is set by devfsadm
3380 * during the boot process. The /dev filesystem infers
3381 * from this when implicit reconfig can be performed,
3382 * ie, devfsadm can be invoked. Please avoid making
3383 * further use of this unless it's really necessary.
3386 i_ddi_sysavail()
3388 return (devname_state & DS_SYSAVAIL);
3392 * May be used to determine if boot is a reconfigure boot.
3395 i_ddi_reconfig()
3397 return (devname_state & DS_RECONFIG);
3401 * Note system services are up, inform /dev.
3403 void
3404 i_ddi_set_sysavail()
3406 if ((devname_state & DS_SYSAVAIL) == 0) {
3407 devname_state |= DS_SYSAVAIL;
3408 sdev_devstate_change();
3413 * Note reconfiguration boot, inform /dev.
3415 void
3416 i_ddi_set_reconfig()
3418 if ((devname_state & DS_RECONFIG) == 0) {
3419 devname_state |= DS_RECONFIG;
3420 sdev_devstate_change();
3426 * device tree walking
3429 struct walk_elem {
3430 struct walk_elem *next;
3431 dev_info_t *dip;
3434 static void
3435 free_list(struct walk_elem *list)
3437 while (list) {
3438 struct walk_elem *next = list->next;
3439 kmem_free(list, sizeof (*list));
3440 list = next;
3444 static void
3445 append_node(struct walk_elem **list, dev_info_t *dip)
3447 struct walk_elem *tail;
3448 struct walk_elem *elem = kmem_alloc(sizeof (*elem), KM_SLEEP);
3450 elem->next = NULL;
3451 elem->dip = dip;
3453 if (*list == NULL) {
3454 *list = elem;
3455 return;
3458 tail = *list;
3459 while (tail->next)
3460 tail = tail->next;
3462 tail->next = elem;
3466 * The implementation of ddi_walk_devs().
3468 static int
3469 walk_devs(dev_info_t *dip, int (*f)(dev_info_t *, void *), void *arg,
3470 int do_locking)
3472 struct walk_elem *head = NULL;
3475 * Do it in two passes. First pass invoke callback on each
3476 * dip on the sibling list. Second pass invoke callback on
3477 * children of each dip.
3479 while (dip) {
3480 switch ((*f)(dip, arg)) {
3481 case DDI_WALK_TERMINATE:
3482 free_list(head);
3483 return (DDI_WALK_TERMINATE);
3485 case DDI_WALK_PRUNESIB:
3486 /* ignore sibling by setting dip to NULL */
3487 append_node(&head, dip);
3488 dip = NULL;
3489 break;
3491 case DDI_WALK_PRUNECHILD:
3492 /* don't worry about children */
3493 dip = ddi_get_next_sibling(dip);
3494 break;
3496 case DDI_WALK_CONTINUE:
3497 default:
3498 append_node(&head, dip);
3499 dip = ddi_get_next_sibling(dip);
3500 break;
3505 /* second pass */
3506 while (head) {
3507 int circ;
3508 struct walk_elem *next = head->next;
3510 if (do_locking)
3511 ndi_devi_enter(head->dip, &circ);
3512 if (walk_devs(ddi_get_child(head->dip), f, arg, do_locking) ==
3513 DDI_WALK_TERMINATE) {
3514 if (do_locking)
3515 ndi_devi_exit(head->dip, circ);
3516 free_list(head);
3517 return (DDI_WALK_TERMINATE);
3519 if (do_locking)
3520 ndi_devi_exit(head->dip, circ);
3521 kmem_free(head, sizeof (*head));
3522 head = next;
3525 return (DDI_WALK_CONTINUE);
3529 * This general-purpose routine traverses the tree of dev_info nodes,
3530 * starting from the given node, and calls the given function for each
3531 * node that it finds with the current node and the pointer arg (which
3532 * can point to a structure of information that the function
3533 * needs) as arguments.
3535 * It does the walk a layer at a time, not depth-first. The given function
3536 * must return one of the following values:
3537 * DDI_WALK_CONTINUE
3538 * DDI_WALK_PRUNESIB
3539 * DDI_WALK_PRUNECHILD
3540 * DDI_WALK_TERMINATE
3542 * N.B. Since we walk the sibling list, the caller must ensure that
3543 * the parent of dip is held against changes, unless the parent
3544 * is rootnode. ndi_devi_enter() on the parent is sufficient.
3546 * To avoid deadlock situations, caller must not attempt to
3547 * configure/unconfigure/remove device node in (*f)(), nor should
3548 * it attempt to recurse on other nodes in the system. Any
3549 * ndi_devi_enter() done by (*f)() must occur 'at-or-below' the
3550 * node entered prior to ddi_walk_devs(). Furthermore, if (*f)()
3551 * does any multi-threading (in framework *or* in driver) then the
3552 * ndi_devi_enter() calls done by dependent threads must be
3553 * 'strictly-below'.
3555 * This is not callable from device autoconfiguration routines.
3556 * They include, but not limited to, _init(9e), _fini(9e), probe(9e),
3557 * attach(9e), and detach(9e).
3560 void
3561 ddi_walk_devs(dev_info_t *dip, int (*f)(dev_info_t *, void *), void *arg)
3564 ASSERT(dip == NULL || ddi_get_parent(dip) == NULL ||
3565 DEVI_BUSY_OWNED(ddi_get_parent(dip)));
3567 (void) walk_devs(dip, f, arg, 1);
3571 * This is a general-purpose routine traverses the per-driver list
3572 * and calls the given function for each node. must return one of
3573 * the following values:
3574 * DDI_WALK_CONTINUE
3575 * DDI_WALK_TERMINATE
3577 * N.B. The same restrictions from ddi_walk_devs() apply.
3580 void
3581 e_ddi_walk_driver(char *drv, int (*f)(dev_info_t *, void *), void *arg)
3583 major_t major;
3584 struct devnames *dnp;
3585 dev_info_t *dip;
3587 major = ddi_name_to_major(drv);
3588 if (major == DDI_MAJOR_T_NONE)
3589 return;
3591 dnp = &devnamesp[major];
3592 LOCK_DEV_OPS(&dnp->dn_lock);
3593 dip = dnp->dn_head;
3594 while (dip) {
3595 ndi_hold_devi(dip);
3596 UNLOCK_DEV_OPS(&dnp->dn_lock);
3597 if ((*f)(dip, arg) == DDI_WALK_TERMINATE) {
3598 ndi_rele_devi(dip);
3599 return;
3601 LOCK_DEV_OPS(&dnp->dn_lock);
3602 ndi_rele_devi(dip);
3603 dip = ddi_get_next(dip);
3605 UNLOCK_DEV_OPS(&dnp->dn_lock);
3609 * argument to i_find_devi, a devinfo node search callback function.
3611 struct match_info {
3612 dev_info_t *dip; /* result */
3613 char *nodename; /* if non-null, nodename must match */
3614 int instance; /* if != -1, instance must match */
3615 int attached; /* if != 0, i_ddi_devi_attached() */
3618 static int
3619 i_find_devi(dev_info_t *dip, void *arg)
3621 struct match_info *info = (struct match_info *)arg;
3623 if (((info->nodename == NULL) ||
3624 (strcmp(ddi_node_name(dip), info->nodename) == 0)) &&
3625 ((info->instance == -1) ||
3626 (ddi_get_instance(dip) == info->instance)) &&
3627 ((info->attached == 0) || i_ddi_devi_attached(dip))) {
3628 info->dip = dip;
3629 ndi_hold_devi(dip);
3630 return (DDI_WALK_TERMINATE);
3633 return (DDI_WALK_CONTINUE);
3637 * Find dip with a known node name and instance and return with it held
3639 dev_info_t *
3640 ddi_find_devinfo(char *nodename, int instance, int attached)
3642 struct match_info info;
3644 info.nodename = nodename;
3645 info.instance = instance;
3646 info.attached = attached;
3647 info.dip = NULL;
3649 ddi_walk_devs(ddi_root_node(), i_find_devi, &info);
3650 return (info.dip);
3653 extern ib_boot_prop_t *iscsiboot_prop;
3654 static void
3655 i_ddi_parse_iscsi_name(char *name, char **nodename, char **addrname,
3656 char **minorname)
3658 char *cp, *colon;
3659 static char nulladdrname[] = "";
3661 /* default values */
3662 if (nodename)
3663 *nodename = name;
3664 if (addrname)
3665 *addrname = nulladdrname;
3666 if (minorname)
3667 *minorname = NULL;
3669 cp = colon = name;
3670 while (*cp != '\0') {
3671 if (addrname && *cp == '@') {
3672 *addrname = cp + 1;
3673 *cp = '\0';
3674 } else if (minorname && *cp == ':') {
3675 *minorname = cp + 1;
3676 colon = cp;
3678 ++cp;
3680 if (colon != name) {
3681 *colon = '\0';
3686 * Parse for name, addr, and minor names. Some args may be NULL.
3688 void
3689 i_ddi_parse_name(char *name, char **nodename, char **addrname, char **minorname)
3691 char *cp;
3692 static char nulladdrname[] = "";
3694 /* default values */
3695 if (nodename)
3696 *nodename = name;
3697 if (addrname)
3698 *addrname = nulladdrname;
3699 if (minorname)
3700 *minorname = NULL;
3702 cp = name;
3703 while (*cp != '\0') {
3704 if (addrname && *cp == '@') {
3705 *addrname = cp + 1;
3706 *cp = '\0';
3707 } else if (minorname && *cp == ':') {
3708 *minorname = cp + 1;
3709 *cp = '\0';
3711 ++cp;
3715 static char *
3716 child_path_to_driver(dev_info_t *parent, char *child_name, char *unit_address)
3718 char *p, *drvname = NULL;
3719 major_t maj;
3722 * Construct the pathname and ask the implementation
3723 * if it can do a driver = f(pathname) for us, if not
3724 * we'll just default to using the node-name that
3725 * was given to us. We want to do this first to
3726 * allow the platform to use 'generic' names for
3727 * legacy device drivers.
3729 p = kmem_zalloc(MAXPATHLEN, KM_SLEEP);
3730 (void) ddi_pathname(parent, p);
3731 (void) strcat(p, "/");
3732 (void) strcat(p, child_name);
3733 if (unit_address && *unit_address) {
3734 (void) strcat(p, "@");
3735 (void) strcat(p, unit_address);
3739 * Get the binding. If there is none, return the child_name
3740 * and let the caller deal with it.
3742 maj = path_to_major(p);
3744 kmem_free(p, MAXPATHLEN);
3746 if (maj != DDI_MAJOR_T_NONE)
3747 drvname = ddi_major_to_name(maj);
3748 if (drvname == NULL)
3749 drvname = child_name;
3751 return (drvname);
3755 #define PCI_EX_CLASS "pciexclass"
3756 #define PCI_EX "pciex"
3757 #define PCI_CLASS "pciclass"
3758 #define PCI "pci"
3761 ddi_is_pci_dip(dev_info_t *dip)
3763 char *prop = NULL;
3765 if (ddi_prop_lookup_string(DDI_DEV_T_ANY, dip, DDI_PROP_DONTPASS,
3766 "compatible", &prop) == DDI_PROP_SUCCESS) {
3767 ASSERT(prop);
3768 if (strncmp(prop, PCI_EX_CLASS, sizeof (PCI_EX_CLASS) - 1)
3769 == 0 ||
3770 strncmp(prop, PCI_EX, sizeof (PCI_EX)- 1)
3771 == 0 ||
3772 strncmp(prop, PCI_CLASS, sizeof (PCI_CLASS) - 1)
3773 == 0 ||
3774 strncmp(prop, PCI, sizeof (PCI) - 1)
3775 == 0) {
3776 ddi_prop_free(prop);
3777 return (1);
3781 if (prop != NULL) {
3782 ddi_prop_free(prop);
3785 return (0);
3789 * Given the pathname of a device, fill in the dev_info_t value and/or the
3790 * dev_t value and/or the spectype, depending on which parameters are non-NULL.
3791 * If there is an error, this function returns -1.
3793 * NOTE: If this function returns the dev_info_t structure, then it
3794 * does so with a hold on the devi. Caller should ensure that they get
3795 * decremented via ddi_release_devi() or ndi_rele_devi();
3797 * This function can be invoked in the boot case for a pathname without
3798 * device argument (:xxxx), traditionally treated as a minor name.
3799 * In this case, we do the following
3800 * (1) search the minor node of type DDM_DEFAULT.
3801 * (2) if no DDM_DEFAULT minor exists, then the first non-alias minor is chosen.
3802 * (3) if neither exists, a dev_t is faked with minor number = instance.
3803 * As of S9 FCS, no instance of #1 exists. #2 is used by several platforms
3804 * to default the boot partition to :a possibly by other OBP definitions.
3805 * #3 is used for booting off network interfaces, most SPARC network
3806 * drivers support Style-2 only, so only DDM_ALIAS minor exists.
3808 * It is possible for OBP to present device args at the end of the path as
3809 * well as in the middle. For example, with IB the following strings are
3810 * valid boot paths.
3811 * a /pci@8,700000/ib@1,2:port=1,pkey=ff,dhcp,...
3812 * b /pci@8,700000/ib@1,1:port=1/ioc@xxxxxx,yyyyyyy:dhcp
3813 * Case (a), we first look for minor node "port=1,pkey...".
3814 * Failing that, we will pass "port=1,pkey..." to the bus_config
3815 * entry point of ib (HCA) driver.
3816 * Case (b), configure ib@1,1 as usual. Then invoke ib's bus_config
3817 * with argument "ioc@xxxxxxx,yyyyyyy:port=1". After configuring
3818 * the ioc, look for minor node dhcp. If not found, pass ":dhcp"
3819 * to ioc's bus_config entry point.
3822 resolve_pathname(char *pathname,
3823 dev_info_t **dipp, dev_t *devtp, int *spectypep)
3825 int error;
3826 dev_info_t *parent, *child;
3827 struct pathname pn;
3828 char *component, *config_name;
3829 char *minorname = NULL;
3830 char *prev_minor = NULL;
3831 dev_t devt = NODEV;
3832 int spectype;
3833 struct ddi_minor_data *dmn;
3834 int circ;
3836 if (*pathname != '/')
3837 return (EINVAL);
3838 parent = ddi_root_node(); /* Begin at the top of the tree */
3840 if (error = pn_get(pathname, UIO_SYSSPACE, &pn))
3841 return (error);
3842 pn_skipslash(&pn);
3844 ASSERT(i_ddi_devi_attached(parent));
3845 ndi_hold_devi(parent);
3847 component = kmem_alloc(MAXNAMELEN, KM_SLEEP);
3848 config_name = kmem_alloc(MAXNAMELEN, KM_SLEEP);
3850 while (pn_pathleft(&pn)) {
3851 /* remember prev minor (:xxx) in the middle of path */
3852 if (minorname)
3853 prev_minor = i_ddi_strdup(minorname, KM_SLEEP);
3855 /* Get component and chop off minorname */
3856 (void) pn_getcomponent(&pn, component);
3857 if ((iscsiboot_prop != NULL) &&
3858 (strcmp((DEVI(parent)->devi_node_name), "iscsi") == 0)) {
3859 i_ddi_parse_iscsi_name(component, NULL, NULL,
3860 &minorname);
3861 } else {
3862 i_ddi_parse_name(component, NULL, NULL, &minorname);
3864 if (prev_minor == NULL) {
3865 (void) snprintf(config_name, MAXNAMELEN, "%s",
3866 component);
3867 } else {
3868 (void) snprintf(config_name, MAXNAMELEN, "%s:%s",
3869 component, prev_minor);
3870 kmem_free(prev_minor, strlen(prev_minor) + 1);
3871 prev_minor = NULL;
3875 * Find and configure the child
3877 if (ndi_devi_config_one(parent, config_name, &child,
3878 NDI_PROMNAME | NDI_NO_EVENT) != NDI_SUCCESS) {
3879 ndi_rele_devi(parent);
3880 pn_free(&pn);
3881 kmem_free(component, MAXNAMELEN);
3882 kmem_free(config_name, MAXNAMELEN);
3883 return (-1);
3886 ASSERT(i_ddi_devi_attached(child));
3887 ndi_rele_devi(parent);
3888 parent = child;
3889 pn_skipslash(&pn);
3893 * First look for a minor node matching minorname.
3894 * Failing that, try to pass minorname to bus_config().
3896 if (minorname && i_ddi_minorname_to_devtspectype(parent,
3897 minorname, &devt, &spectype) == DDI_FAILURE) {
3898 (void) snprintf(config_name, MAXNAMELEN, "%s", minorname);
3899 if (ndi_devi_config_obp_args(parent,
3900 config_name, &child, 0) != NDI_SUCCESS) {
3901 ndi_rele_devi(parent);
3902 pn_free(&pn);
3903 kmem_free(component, MAXNAMELEN);
3904 kmem_free(config_name, MAXNAMELEN);
3905 NDI_CONFIG_DEBUG((CE_NOTE,
3906 "%s: minor node not found\n", pathname));
3907 return (-1);
3909 minorname = NULL; /* look for default minor */
3910 ASSERT(i_ddi_devi_attached(child));
3911 ndi_rele_devi(parent);
3912 parent = child;
3915 if (devtp || spectypep) {
3916 if (minorname == NULL) {
3918 * Search for a default entry with an active
3919 * ndi_devi_enter to protect the devi_minor list.
3921 ndi_devi_enter(parent, &circ);
3922 for (dmn = DEVI(parent)->devi_minor; dmn;
3923 dmn = dmn->next) {
3924 if (dmn->type == DDM_DEFAULT) {
3925 devt = dmn->ddm_dev;
3926 spectype = dmn->ddm_spec_type;
3927 break;
3931 if (devt == NODEV) {
3933 * No default minor node, try the first one;
3934 * else, assume 1-1 instance-minor mapping
3936 dmn = DEVI(parent)->devi_minor;
3937 if (dmn && ((dmn->type == DDM_MINOR) ||
3938 (dmn->type == DDM_INTERNAL_PATH))) {
3939 devt = dmn->ddm_dev;
3940 spectype = dmn->ddm_spec_type;
3941 } else {
3942 devt = makedevice(
3943 DEVI(parent)->devi_major,
3944 ddi_get_instance(parent));
3945 spectype = S_IFCHR;
3948 ndi_devi_exit(parent, circ);
3950 if (devtp)
3951 *devtp = devt;
3952 if (spectypep)
3953 *spectypep = spectype;
3956 pn_free(&pn);
3957 kmem_free(component, MAXNAMELEN);
3958 kmem_free(config_name, MAXNAMELEN);
3961 * If there is no error, return the appropriate parameters
3963 if (dipp != NULL)
3964 *dipp = parent;
3965 else {
3967 * We should really keep the ref count to keep the node from
3968 * detaching but ddi_pathname_to_dev_t() specifies a NULL dipp,
3969 * so we have no way of passing back the held dip. Not holding
3970 * the dip allows detaches to occur - which can cause problems
3971 * for subsystems which call ddi_pathname_to_dev_t (console).
3973 * Instead of holding the dip, we place a ddi-no-autodetach
3974 * property on the node to prevent auto detaching.
3976 * The right fix is to remove ddi_pathname_to_dev_t and replace
3977 * it, and all references, with a call that specifies a dipp.
3978 * In addition, the callers of this new interfaces would then
3979 * need to call ndi_rele_devi when the reference is complete.
3982 (void) ddi_prop_update_int(DDI_DEV_T_NONE, parent,
3983 DDI_NO_AUTODETACH, 1);
3984 ndi_rele_devi(parent);
3987 return (0);
3991 * Given the pathname of a device, return the dev_t of the corresponding
3992 * device. Returns NODEV on failure.
3994 * Note that this call sets the DDI_NO_AUTODETACH property on the devinfo node.
3996 dev_t
3997 ddi_pathname_to_dev_t(char *pathname)
3999 dev_t devt;
4000 int error;
4002 error = resolve_pathname(pathname, NULL, &devt, NULL);
4004 return (error ? NODEV : devt);
4008 * Translate a prom pathname to kernel devfs pathname.
4009 * Caller is assumed to allocate devfspath memory of
4010 * size at least MAXPATHLEN
4012 * The prom pathname may not include minor name, but
4013 * devfs pathname has a minor name portion.
4016 i_ddi_prompath_to_devfspath(char *prompath, char *devfspath)
4018 dev_t devt = (dev_t)NODEV;
4019 dev_info_t *dip = NULL;
4020 char *minor_name = NULL;
4021 int spectype;
4022 int error;
4023 int circ;
4025 error = resolve_pathname(prompath, &dip, &devt, &spectype);
4026 if (error)
4027 return (DDI_FAILURE);
4028 ASSERT(dip && devt != NODEV);
4031 * Get in-kernel devfs pathname
4033 (void) ddi_pathname(dip, devfspath);
4035 ndi_devi_enter(dip, &circ);
4036 minor_name = i_ddi_devtspectype_to_minorname(dip, devt, spectype);
4037 if (minor_name) {
4038 (void) strcat(devfspath, ":");
4039 (void) strcat(devfspath, minor_name);
4040 } else {
4042 * If minor_name is NULL, we have an alias minor node.
4043 * So manufacture a path to the corresponding clone minor.
4045 (void) snprintf(devfspath, MAXPATHLEN, "%s:%s",
4046 CLONE_PATH, ddi_driver_name(dip));
4048 ndi_devi_exit(dip, circ);
4050 /* release hold from resolve_pathname() */
4051 ndi_rele_devi(dip);
4052 return (0);
4056 * This function is intended to identify drivers that must quiesce for fast
4057 * reboot to succeed. It does not claim to have more knowledge about the device
4058 * than its driver. If a driver has implemented quiesce(), it will be invoked;
4059 * if a so identified driver does not manage any device that needs to be
4060 * quiesced, it must explicitly set its devo_quiesce dev_op to
4061 * ddi_quiesce_not_needed.
4063 static int skip_pseudo = 1; /* Skip pseudo devices */
4064 static int skip_non_hw = 1; /* Skip devices with no hardware property */
4065 static int
4066 should_implement_quiesce(dev_info_t *dip)
4068 struct dev_info *devi = DEVI(dip);
4069 dev_info_t *pdip;
4072 * If dip is pseudo and skip_pseudo is set, driver doesn't have to
4073 * implement quiesce().
4075 if (skip_pseudo &&
4076 strncmp(ddi_binding_name(dip), "pseudo", sizeof ("pseudo")) == 0)
4077 return (0);
4080 * If parent dip is pseudo and skip_pseudo is set, driver doesn't have
4081 * to implement quiesce().
4083 if (skip_pseudo && (pdip = ddi_get_parent(dip)) != NULL &&
4084 strncmp(ddi_binding_name(pdip), "pseudo", sizeof ("pseudo")) == 0)
4085 return (0);
4088 * If not attached, driver doesn't have to implement quiesce().
4090 if (!i_ddi_devi_attached(dip))
4091 return (0);
4094 * If dip has no hardware property and skip_non_hw is set,
4095 * driver doesn't have to implement quiesce().
4097 if (skip_non_hw && devi->devi_hw_prop_ptr == NULL)
4098 return (0);
4100 return (1);
4103 static int
4104 driver_has_quiesce(struct dev_ops *ops)
4106 if ((ops->devo_rev >= 4) && (ops->devo_quiesce != nodev) &&
4107 (ops->devo_quiesce != NULL) && (ops->devo_quiesce != nulldev) &&
4108 (ops->devo_quiesce != ddi_quiesce_not_supported))
4109 return (1);
4110 else
4111 return (0);
4115 * Check to see if a driver has implemented the quiesce() DDI function.
4118 check_driver_quiesce(dev_info_t *dip, void *arg)
4120 struct dev_ops *ops;
4122 if (!should_implement_quiesce(dip))
4123 return (DDI_WALK_CONTINUE);
4125 if ((ops = ddi_get_driver(dip)) == NULL)
4126 return (DDI_WALK_CONTINUE);
4128 if (driver_has_quiesce(ops)) {
4129 if ((quiesce_debug & 0x2) == 0x2) {
4130 if (ops->devo_quiesce == ddi_quiesce_not_needed)
4131 cmn_err(CE_CONT, "%s does not need to be "
4132 "quiesced", ddi_driver_name(dip));
4133 else
4134 cmn_err(CE_CONT, "%s has quiesce routine",
4135 ddi_driver_name(dip));
4137 } else {
4138 if (arg != NULL)
4139 *((int *)arg) = -1;
4140 cmn_err(CE_WARN, "%s has no quiesce()", ddi_driver_name(dip));
4143 return (DDI_WALK_CONTINUE);
4147 * Quiesce device.
4149 static void
4150 quiesce_one_device(dev_info_t *dip, void *arg)
4152 struct dev_ops *ops;
4153 int should_quiesce = 0;
4156 * If the device is not attached it doesn't need to be quiesced.
4158 if (!i_ddi_devi_attached(dip))
4159 return;
4161 if ((ops = ddi_get_driver(dip)) == NULL)
4162 return;
4164 should_quiesce = should_implement_quiesce(dip);
4167 * If there's an implementation of quiesce(), always call it even if
4168 * some of the drivers don't have quiesce() or quiesce() have failed
4169 * so we can do force fast reboot. The implementation of quiesce()
4170 * should not negatively affect a regular reboot.
4172 if (driver_has_quiesce(ops)) {
4173 int rc = DDI_SUCCESS;
4175 if (ops->devo_quiesce == ddi_quiesce_not_needed)
4176 return;
4178 rc = devi_quiesce(dip);
4180 if (rc != DDI_SUCCESS && should_quiesce) {
4181 #ifdef DEBUG
4182 cmn_err(CE_WARN, "quiesce() failed for %s%d",
4183 ddi_driver_name(dip), ddi_get_instance(dip));
4184 #endif /* DEBUG */
4185 if (arg != NULL)
4186 *((int *)arg) = -1;
4188 } else if (should_quiesce && arg != NULL) {
4189 *((int *)arg) = -1;
4194 * Traverse the dev info tree in a breadth-first manner so that we quiesce
4195 * children first. All subtrees under the parent of dip will be quiesced.
4197 void
4198 quiesce_devices(dev_info_t *dip, void *arg)
4201 * if we're reached here, the device tree better not be changing.
4202 * so either devinfo_freeze better be set or we better be panicing.
4204 ASSERT(devinfo_freeze || panicstr);
4206 for (; dip != NULL; dip = ddi_get_next_sibling(dip)) {
4207 quiesce_devices(ddi_get_child(dip), arg);
4209 quiesce_one_device(dip, arg);
4214 * Reset all the pure leaf drivers on the system at halt time
4216 static int
4217 reset_leaf_device(dev_info_t *dip, void *arg)
4219 _NOTE(ARGUNUSED(arg))
4220 struct dev_ops *ops;
4222 /* if the device doesn't need to be reset then there's nothing to do */
4223 if (!DEVI_NEED_RESET(dip))
4224 return (DDI_WALK_CONTINUE);
4227 * if the device isn't a char/block device or doesn't have a
4228 * reset entry point then there's nothing to do.
4230 ops = ddi_get_driver(dip);
4231 if ((ops == NULL) || (ops->devo_cb_ops == NULL) ||
4232 (ops->devo_reset == nodev) || (ops->devo_reset == nulldev) ||
4233 (ops->devo_reset == NULL))
4234 return (DDI_WALK_CONTINUE);
4236 if (DEVI_IS_ATTACHING(dip) || DEVI_IS_DETACHING(dip)) {
4237 static char path[MAXPATHLEN];
4240 * bad news, this device has blocked in it's attach or
4241 * detach routine, which means it not safe to call it's
4242 * devo_reset() entry point.
4244 cmn_err(CE_WARN, "unable to reset device: %s",
4245 ddi_pathname(dip, path));
4246 return (DDI_WALK_CONTINUE);
4249 NDI_CONFIG_DEBUG((CE_NOTE, "resetting %s%d\n",
4250 ddi_driver_name(dip), ddi_get_instance(dip)));
4252 (void) devi_reset(dip, DDI_RESET_FORCE);
4253 return (DDI_WALK_CONTINUE);
4256 void
4257 reset_leaves(void)
4260 * if we're reached here, the device tree better not be changing.
4261 * so either devinfo_freeze better be set or we better be panicing.
4263 ASSERT(devinfo_freeze || panicstr);
4265 (void) walk_devs(top_devinfo, reset_leaf_device, NULL, 0);
4270 * devtree_freeze() must be called before quiesce_devices() and reset_leaves()
4271 * during a normal system shutdown. It attempts to ensure that there are no
4272 * outstanding attach or detach operations in progress when quiesce_devices() or
4273 * reset_leaves()is invoked. It must be called before the system becomes
4274 * single-threaded because device attach and detach are multi-threaded
4275 * operations. (note that during system shutdown the system doesn't actually
4276 * become single-thread since other threads still exist, but the shutdown thread
4277 * will disable preemption for itself, raise it's pil, and stop all the other
4278 * cpus in the system there by effectively making the system single-threaded.)
4280 void
4281 devtree_freeze(void)
4283 int delayed = 0;
4285 /* if we're panicing then the device tree isn't going to be changing */
4286 if (panicstr)
4287 return;
4289 /* stop all dev_info state changes in the device tree */
4290 devinfo_freeze = gethrtime();
4293 * if we're not panicing and there are on-going attach or detach
4294 * operations, wait for up to 3 seconds for them to finish. This
4295 * is a randomly chosen interval but this should be ok because:
4296 * - 3 seconds is very small relative to the deadman timer.
4297 * - normal attach and detach operations should be very quick.
4298 * - attach and detach operations are fairly rare.
4300 while (!panicstr && atomic_add_long_nv(&devinfo_attach_detach, 0) &&
4301 (delayed < 3)) {
4302 delayed += 1;
4304 /* do a sleeping wait for one second */
4305 ASSERT(!servicing_interrupt());
4306 delay(drv_usectohz(MICROSEC));
4310 static int
4311 bind_dip(dev_info_t *dip, void *arg)
4313 _NOTE(ARGUNUSED(arg))
4314 char *path;
4315 major_t major, pmajor;
4318 * If the node is currently bound to the wrong driver, try to unbind
4319 * so that we can rebind to the correct driver.
4321 if (i_ddi_node_state(dip) >= DS_BOUND) {
4322 major = ddi_compatible_driver_major(dip, NULL);
4323 if ((DEVI(dip)->devi_major == major) &&
4324 (i_ddi_node_state(dip) >= DS_INITIALIZED)) {
4326 * Check for a path-oriented driver alias that
4327 * takes precedence over current driver binding.
4329 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
4330 (void) ddi_pathname(dip, path);
4331 pmajor = ddi_name_to_major(path);
4332 if (driver_active(pmajor))
4333 major = pmajor;
4334 kmem_free(path, MAXPATHLEN);
4337 /* attempt unbind if current driver is incorrect */
4338 if (driver_active(major) &&
4339 (major != DEVI(dip)->devi_major))
4340 (void) ndi_devi_unbind_driver(dip);
4343 /* If unbound, try to bind to a driver */
4344 if (i_ddi_node_state(dip) < DS_BOUND)
4345 (void) ndi_devi_bind_driver(dip, 0);
4347 return (DDI_WALK_CONTINUE);
4350 void
4351 i_ddi_bind_devs(void)
4353 /* flush devfs so that ndi_devi_unbind_driver will work when possible */
4354 (void) devfs_clean(top_devinfo, NULL, 0);
4356 ddi_walk_devs(top_devinfo, bind_dip, (void *)NULL);
4359 /* callback data for unbind_children_by_alias() */
4360 typedef struct unbind_data {
4361 major_t drv_major;
4362 char *drv_alias;
4363 int ndevs_bound;
4364 int unbind_errors;
4365 } unbind_data_t;
4368 * A utility function provided for testing and support convenience
4369 * Called for each device during an upgrade_drv -d bound to the alias
4370 * that cannot be unbound due to device in use.
4372 static void
4373 unbind_alias_dev_in_use(dev_info_t *dip, char *alias)
4375 if (moddebug & MODDEBUG_BINDING) {
4376 cmn_err(CE_CONT, "%s%d: state %d: bound to %s\n",
4377 ddi_driver_name(dip), ddi_get_instance(dip),
4378 i_ddi_node_state(dip), alias);
4383 * walkdevs callback for unbind devices bound to specific driver
4384 * and alias. Invoked within the context of update_drv -d <alias>.
4386 static int
4387 unbind_children_by_alias(dev_info_t *dip, void *arg)
4389 int circ;
4390 dev_info_t *cdip;
4391 dev_info_t *next;
4392 unbind_data_t *ub = (unbind_data_t *)(uintptr_t)arg;
4393 int rv;
4396 * We are called from update_drv to try to unbind a specific
4397 * set of aliases for a driver. Unbind what persistent nodes
4398 * we can, and return the number of nodes which cannot be unbound.
4399 * If not all nodes can be unbound, update_drv leaves the
4400 * state of the driver binding files unchanged, except in
4401 * the case of -f.
4403 ndi_devi_enter(dip, &circ);
4404 for (cdip = ddi_get_child(dip); cdip; cdip = next) {
4405 next = ddi_get_next_sibling(cdip);
4406 if ((ddi_driver_major(cdip) != ub->drv_major) ||
4407 (strcmp(DEVI(cdip)->devi_node_name, ub->drv_alias) != 0))
4408 continue;
4409 if (i_ddi_node_state(cdip) >= DS_BOUND) {
4410 rv = ndi_devi_unbind_driver(cdip);
4411 if (rv != DDI_SUCCESS ||
4412 (i_ddi_node_state(cdip) >= DS_BOUND)) {
4413 unbind_alias_dev_in_use(cdip, ub->drv_alias);
4414 ub->ndevs_bound++;
4415 continue;
4417 if (ndi_dev_is_persistent_node(cdip) == 0)
4418 (void) ddi_remove_child(cdip, 0);
4421 ndi_devi_exit(dip, circ);
4423 return (DDI_WALK_CONTINUE);
4427 * Unbind devices by driver & alias
4428 * Context: update_drv [-f] -d -i <alias> <driver>
4431 i_ddi_unbind_devs_by_alias(major_t major, char *alias)
4433 unbind_data_t *ub;
4434 int rv;
4436 ub = kmem_zalloc(sizeof (*ub), KM_SLEEP);
4437 ub->drv_major = major;
4438 ub->drv_alias = alias;
4439 ub->ndevs_bound = 0;
4440 ub->unbind_errors = 0;
4442 /* flush devfs so that ndi_devi_unbind_driver will work when possible */
4443 (void) devfs_clean(top_devinfo, NULL, 0);
4444 ddi_walk_devs(top_devinfo, unbind_children_by_alias,
4445 (void *)(uintptr_t)ub);
4447 /* return the number of devices remaining bound to the alias */
4448 rv = ub->ndevs_bound + ub->unbind_errors;
4449 kmem_free(ub, sizeof (*ub));
4450 return (rv);
4454 * walkdevs callback for unbind devices by driver
4456 static int
4457 unbind_children_by_driver(dev_info_t *dip, void *arg)
4459 int circ;
4460 dev_info_t *cdip;
4461 dev_info_t *next;
4462 major_t major = (major_t)(uintptr_t)arg;
4463 int rv;
4466 * We are called either from rem_drv or update_drv when reloading
4467 * a driver.conf file. In either case, we unbind persistent nodes
4468 * and destroy .conf nodes. In the case of rem_drv, this will be
4469 * the final state. In the case of update_drv, i_ddi_bind_devs()
4470 * may be invoked later to re-enumerate (new) driver.conf rebind
4471 * persistent nodes.
4473 ndi_devi_enter(dip, &circ);
4474 for (cdip = ddi_get_child(dip); cdip; cdip = next) {
4475 next = ddi_get_next_sibling(cdip);
4476 if (ddi_driver_major(cdip) != major)
4477 continue;
4478 if (i_ddi_node_state(cdip) >= DS_BOUND) {
4479 rv = ndi_devi_unbind_driver(cdip);
4480 if (rv == DDI_FAILURE ||
4481 (i_ddi_node_state(cdip) >= DS_BOUND))
4482 continue;
4483 if (ndi_dev_is_persistent_node(cdip) == 0)
4484 (void) ddi_remove_child(cdip, 0);
4487 ndi_devi_exit(dip, circ);
4489 return (DDI_WALK_CONTINUE);
4493 * Unbind devices by driver
4494 * Context: rem_drv or unload driver.conf
4496 void
4497 i_ddi_unbind_devs(major_t major)
4499 /* flush devfs so that ndi_devi_unbind_driver will work when possible */
4500 (void) devfs_clean(top_devinfo, NULL, 0);
4501 ddi_walk_devs(top_devinfo, unbind_children_by_driver,
4502 (void *)(uintptr_t)major);
4506 * I/O Hotplug control
4510 * create and attach a dev_info node from a .conf file spec
4512 static void
4513 init_spec_child(dev_info_t *pdip, struct hwc_spec *specp, uint_t flags)
4515 _NOTE(ARGUNUSED(flags))
4516 dev_info_t *dip;
4517 char *node_name;
4519 if (((node_name = specp->hwc_devi_name) == NULL) ||
4520 (ddi_name_to_major(node_name) == DDI_MAJOR_T_NONE)) {
4521 char *tmp = node_name;
4522 if (tmp == NULL)
4523 tmp = "<none>";
4524 cmn_err(CE_CONT,
4525 "init_spec_child: parent=%s, bad spec (%s)\n",
4526 ddi_node_name(pdip), tmp);
4527 return;
4530 dip = i_ddi_alloc_node(pdip, node_name, (pnode_t)DEVI_PSEUDO_NODEID,
4531 -1, specp->hwc_devi_sys_prop_ptr, KM_SLEEP);
4533 if (dip == NULL)
4534 return;
4536 if (ddi_initchild(pdip, dip) != DDI_SUCCESS)
4537 (void) ddi_remove_child(dip, 0);
4541 * Lookup hwc specs from hash tables and make children from the spec
4542 * Because some .conf children are "merge" nodes, we also initialize
4543 * .conf children to merge properties onto hardware nodes.
4545 * The pdip must be held busy.
4548 i_ndi_make_spec_children(dev_info_t *pdip, uint_t flags)
4550 extern struct hwc_spec *hwc_get_child_spec(dev_info_t *, major_t);
4551 int circ;
4552 struct hwc_spec *list, *spec;
4554 ndi_devi_enter(pdip, &circ);
4555 if (DEVI(pdip)->devi_flags & DEVI_MADE_CHILDREN) {
4556 ndi_devi_exit(pdip, circ);
4557 return (DDI_SUCCESS);
4560 list = hwc_get_child_spec(pdip, DDI_MAJOR_T_NONE);
4561 for (spec = list; spec != NULL; spec = spec->hwc_next) {
4562 init_spec_child(pdip, spec, flags);
4564 hwc_free_spec_list(list);
4566 mutex_enter(&DEVI(pdip)->devi_lock);
4567 DEVI(pdip)->devi_flags |= DEVI_MADE_CHILDREN;
4568 mutex_exit(&DEVI(pdip)->devi_lock);
4569 ndi_devi_exit(pdip, circ);
4570 return (DDI_SUCCESS);
4574 * Run initchild on all child nodes such that instance assignment
4575 * for multiport network cards are contiguous.
4577 * The pdip must be held busy.
4579 static void
4580 i_ndi_init_hw_children(dev_info_t *pdip, uint_t flags)
4582 dev_info_t *dip;
4584 ASSERT(DEVI(pdip)->devi_flags & DEVI_MADE_CHILDREN);
4586 /* contiguous instance assignment */
4587 e_ddi_enter_instance();
4588 dip = ddi_get_child(pdip);
4589 while (dip) {
4590 if (ndi_dev_is_persistent_node(dip))
4591 (void) i_ndi_config_node(dip, DS_INITIALIZED, flags);
4592 dip = ddi_get_next_sibling(dip);
4594 e_ddi_exit_instance();
4598 * report device status
4600 static void
4601 i_ndi_devi_report_status_change(dev_info_t *dip, char *path)
4603 char *status;
4605 if (!DEVI_NEED_REPORT(dip) ||
4606 (i_ddi_node_state(dip) < DS_INITIALIZED) ||
4607 ndi_dev_is_hidden_node(dip)) {
4608 return;
4611 /* Invalidate the devinfo snapshot cache */
4612 i_ddi_di_cache_invalidate();
4614 if (DEVI_IS_DEVICE_REMOVED(dip)) {
4615 status = "removed";
4616 } else if (DEVI_IS_DEVICE_OFFLINE(dip)) {
4617 status = "offline";
4618 } else if (DEVI_IS_DEVICE_DOWN(dip)) {
4619 status = "down";
4620 } else if (DEVI_IS_BUS_QUIESCED(dip)) {
4621 status = "quiesced";
4622 } else if (DEVI_IS_BUS_DOWN(dip)) {
4623 status = "down";
4624 } else if (i_ddi_devi_attached(dip)) {
4625 status = "online";
4626 } else {
4627 status = "unknown";
4630 if (path == NULL) {
4631 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
4632 cmn_err(CE_CONT, "?%s (%s%d) %s\n",
4633 ddi_pathname(dip, path), ddi_driver_name(dip),
4634 ddi_get_instance(dip), status);
4635 kmem_free(path, MAXPATHLEN);
4636 } else {
4637 cmn_err(CE_CONT, "?%s (%s%d) %s\n",
4638 path, ddi_driver_name(dip),
4639 ddi_get_instance(dip), status);
4642 mutex_enter(&(DEVI(dip)->devi_lock));
4643 DEVI_REPORT_DONE(dip);
4644 mutex_exit(&(DEVI(dip)->devi_lock));
4648 * log a notification that a dev_info node has been configured.
4650 static int
4651 i_log_devfs_add_devinfo(dev_info_t *dip, uint_t flags)
4653 int se_err;
4654 char *pathname;
4655 sysevent_t *ev;
4656 sysevent_id_t eid;
4657 sysevent_value_t se_val;
4658 sysevent_attr_list_t *ev_attr_list = NULL;
4659 char *class_name;
4660 int no_transport = 0;
4662 ASSERT(dip && ddi_get_parent(dip) &&
4663 DEVI_BUSY_OWNED(ddi_get_parent(dip)));
4665 /* do not generate ESC_DEVFS_DEVI_ADD event during boot */
4666 if (!i_ddi_io_initialized())
4667 return (DDI_SUCCESS);
4669 /* Invalidate the devinfo snapshot cache */
4670 i_ddi_di_cache_invalidate();
4672 ev = sysevent_alloc(EC_DEVFS, ESC_DEVFS_DEVI_ADD, EP_DDI, SE_SLEEP);
4674 pathname = kmem_alloc(MAXPATHLEN, KM_SLEEP);
4676 (void) ddi_pathname(dip, pathname);
4677 ASSERT(strlen(pathname));
4679 se_val.value_type = SE_DATA_TYPE_STRING;
4680 se_val.value.sv_string = pathname;
4681 if (sysevent_add_attr(&ev_attr_list, DEVFS_PATHNAME,
4682 &se_val, SE_SLEEP) != 0) {
4683 goto fail;
4686 /* add the device class attribute */
4687 if ((class_name = i_ddi_devi_class(dip)) != NULL) {
4688 se_val.value_type = SE_DATA_TYPE_STRING;
4689 se_val.value.sv_string = class_name;
4691 if (sysevent_add_attr(&ev_attr_list,
4692 DEVFS_DEVI_CLASS, &se_val, SE_SLEEP) != 0) {
4693 sysevent_free_attr(ev_attr_list);
4694 goto fail;
4699 * must log a branch event too unless NDI_BRANCH_EVENT_OP is set,
4700 * in which case the branch event will be logged by the caller
4701 * after the entire branch has been configured.
4703 if ((flags & NDI_BRANCH_EVENT_OP) == 0) {
4705 * Instead of logging a separate branch event just add
4706 * DEVFS_BRANCH_EVENT attribute. It indicates devfsadmd to
4707 * generate a EC_DEV_BRANCH event.
4709 se_val.value_type = SE_DATA_TYPE_INT32;
4710 se_val.value.sv_int32 = 1;
4711 if (sysevent_add_attr(&ev_attr_list,
4712 DEVFS_BRANCH_EVENT, &se_val, SE_SLEEP) != 0) {
4713 sysevent_free_attr(ev_attr_list);
4714 goto fail;
4718 if (sysevent_attach_attributes(ev, ev_attr_list) != 0) {
4719 sysevent_free_attr(ev_attr_list);
4720 goto fail;
4723 if ((se_err = log_sysevent(ev, SE_SLEEP, &eid)) != 0) {
4724 if (se_err == SE_NO_TRANSPORT)
4725 no_transport = 1;
4726 goto fail;
4729 sysevent_free(ev);
4730 kmem_free(pathname, MAXPATHLEN);
4732 return (DDI_SUCCESS);
4734 fail:
4735 cmn_err(CE_WARN, "failed to log ESC_DEVFS_DEVI_ADD event for %s%s",
4736 pathname, (no_transport) ? " (syseventd not responding)" : "");
4738 cmn_err(CE_WARN, "/dev may not be current for driver %s. "
4739 "Run devfsadm -i %s",
4740 ddi_driver_name(dip), ddi_driver_name(dip));
4742 sysevent_free(ev);
4743 kmem_free(pathname, MAXPATHLEN);
4744 return (DDI_SUCCESS);
4748 * log a notification that a dev_info node has been unconfigured.
4750 static int
4751 i_log_devfs_remove_devinfo(char *pathname, char *class_name, char *driver_name,
4752 int instance, uint_t flags)
4754 sysevent_t *ev;
4755 sysevent_id_t eid;
4756 sysevent_value_t se_val;
4757 sysevent_attr_list_t *ev_attr_list = NULL;
4758 int se_err;
4759 int no_transport = 0;
4761 if (!i_ddi_io_initialized())
4762 return (DDI_SUCCESS);
4764 /* Invalidate the devinfo snapshot cache */
4765 i_ddi_di_cache_invalidate();
4767 ev = sysevent_alloc(EC_DEVFS, ESC_DEVFS_DEVI_REMOVE, EP_DDI, SE_SLEEP);
4769 se_val.value_type = SE_DATA_TYPE_STRING;
4770 se_val.value.sv_string = pathname;
4771 if (sysevent_add_attr(&ev_attr_list, DEVFS_PATHNAME,
4772 &se_val, SE_SLEEP) != 0) {
4773 goto fail;
4776 if (class_name) {
4777 /* add the device class, driver name and instance attributes */
4779 se_val.value_type = SE_DATA_TYPE_STRING;
4780 se_val.value.sv_string = class_name;
4781 if (sysevent_add_attr(&ev_attr_list,
4782 DEVFS_DEVI_CLASS, &se_val, SE_SLEEP) != 0) {
4783 sysevent_free_attr(ev_attr_list);
4784 goto fail;
4787 se_val.value_type = SE_DATA_TYPE_STRING;
4788 se_val.value.sv_string = driver_name;
4789 if (sysevent_add_attr(&ev_attr_list,
4790 DEVFS_DRIVER_NAME, &se_val, SE_SLEEP) != 0) {
4791 sysevent_free_attr(ev_attr_list);
4792 goto fail;
4795 se_val.value_type = SE_DATA_TYPE_INT32;
4796 se_val.value.sv_int32 = instance;
4797 if (sysevent_add_attr(&ev_attr_list,
4798 DEVFS_INSTANCE, &se_val, SE_SLEEP) != 0) {
4799 sysevent_free_attr(ev_attr_list);
4800 goto fail;
4805 * must log a branch event too unless NDI_BRANCH_EVENT_OP is set,
4806 * in which case the branch event will be logged by the caller
4807 * after the entire branch has been unconfigured.
4809 if ((flags & NDI_BRANCH_EVENT_OP) == 0) {
4811 * Instead of logging a separate branch event just add
4812 * DEVFS_BRANCH_EVENT attribute. It indicates devfsadmd to
4813 * generate a EC_DEV_BRANCH event.
4815 se_val.value_type = SE_DATA_TYPE_INT32;
4816 se_val.value.sv_int32 = 1;
4817 if (sysevent_add_attr(&ev_attr_list,
4818 DEVFS_BRANCH_EVENT, &se_val, SE_SLEEP) != 0) {
4819 sysevent_free_attr(ev_attr_list);
4820 goto fail;
4824 if (sysevent_attach_attributes(ev, ev_attr_list) != 0) {
4825 sysevent_free_attr(ev_attr_list);
4826 goto fail;
4829 if ((se_err = log_sysevent(ev, SE_SLEEP, &eid)) != 0) {
4830 if (se_err == SE_NO_TRANSPORT)
4831 no_transport = 1;
4832 goto fail;
4835 sysevent_free(ev);
4836 return (DDI_SUCCESS);
4838 fail:
4839 sysevent_free(ev);
4840 cmn_err(CE_WARN, "failed to log ESC_DEVFS_DEVI_REMOVE event for %s%s",
4841 pathname, (no_transport) ? " (syseventd not responding)" : "");
4842 return (DDI_SUCCESS);
4845 static void
4846 i_ddi_log_devfs_device_remove(dev_info_t *dip)
4848 char *path;
4850 ASSERT(dip && ddi_get_parent(dip) &&
4851 DEVI_BUSY_OWNED(ddi_get_parent(dip)));
4852 ASSERT(DEVI_IS_DEVICE_REMOVED(dip));
4854 ASSERT(i_ddi_node_state(dip) >= DS_INITIALIZED);
4855 if (i_ddi_node_state(dip) < DS_INITIALIZED)
4856 return;
4858 /* Inform LDI_EV_DEVICE_REMOVE callbacks. */
4859 ldi_invoke_finalize(dip, DDI_DEV_T_ANY, 0, LDI_EV_DEVICE_REMOVE,
4860 LDI_EV_SUCCESS, NULL);
4862 /* Generate EC_DEVFS_DEVI_REMOVE sysevent. */
4863 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
4864 (void) i_log_devfs_remove_devinfo(ddi_pathname(dip, path),
4865 i_ddi_devi_class(dip), (char *)ddi_driver_name(dip),
4866 ddi_get_instance(dip), 0);
4867 kmem_free(path, MAXPATHLEN);
4870 static void
4871 i_ddi_log_devfs_device_insert(dev_info_t *dip)
4873 ASSERT(dip && ddi_get_parent(dip) &&
4874 DEVI_BUSY_OWNED(ddi_get_parent(dip)));
4875 ASSERT(!DEVI_IS_DEVICE_REMOVED(dip));
4877 (void) i_log_devfs_add_devinfo(dip, 0);
4882 * log an event that a dev_info branch has been configured or unconfigured.
4884 static int
4885 i_log_devfs_branch(char *node_path, char *subclass)
4887 int se_err;
4888 sysevent_t *ev;
4889 sysevent_id_t eid;
4890 sysevent_value_t se_val;
4891 sysevent_attr_list_t *ev_attr_list = NULL;
4892 int no_transport = 0;
4894 /* do not generate the event during boot */
4895 if (!i_ddi_io_initialized())
4896 return (DDI_SUCCESS);
4898 /* Invalidate the devinfo snapshot cache */
4899 i_ddi_di_cache_invalidate();
4901 ev = sysevent_alloc(EC_DEVFS, subclass, EP_DDI, SE_SLEEP);
4903 se_val.value_type = SE_DATA_TYPE_STRING;
4904 se_val.value.sv_string = node_path;
4906 if (sysevent_add_attr(&ev_attr_list, DEVFS_PATHNAME,
4907 &se_val, SE_SLEEP) != 0) {
4908 goto fail;
4911 if (sysevent_attach_attributes(ev, ev_attr_list) != 0) {
4912 sysevent_free_attr(ev_attr_list);
4913 goto fail;
4916 if ((se_err = log_sysevent(ev, SE_SLEEP, &eid)) != 0) {
4917 if (se_err == SE_NO_TRANSPORT)
4918 no_transport = 1;
4919 goto fail;
4922 sysevent_free(ev);
4923 return (DDI_SUCCESS);
4925 fail:
4926 cmn_err(CE_WARN, "failed to log %s branch event for %s%s",
4927 subclass, node_path,
4928 (no_transport) ? " (syseventd not responding)" : "");
4930 sysevent_free(ev);
4931 return (DDI_FAILURE);
4935 * log an event that a dev_info tree branch has been configured.
4937 static int
4938 i_log_devfs_branch_add(dev_info_t *dip)
4940 char *node_path;
4941 int rv;
4943 node_path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
4944 (void) ddi_pathname(dip, node_path);
4945 rv = i_log_devfs_branch(node_path, ESC_DEVFS_BRANCH_ADD);
4946 kmem_free(node_path, MAXPATHLEN);
4948 return (rv);
4952 * log an event that a dev_info tree branch has been unconfigured.
4954 static int
4955 i_log_devfs_branch_remove(char *node_path)
4957 return (i_log_devfs_branch(node_path, ESC_DEVFS_BRANCH_REMOVE));
4961 * enqueue the dip's deviname on the branch event queue.
4963 static struct brevq_node *
4964 brevq_enqueue(struct brevq_node **brevqp, dev_info_t *dip,
4965 struct brevq_node *child)
4967 struct brevq_node *brn;
4968 char *deviname;
4970 deviname = kmem_alloc(MAXNAMELEN, KM_SLEEP);
4971 (void) ddi_deviname(dip, deviname);
4973 brn = kmem_zalloc(sizeof (*brn), KM_SLEEP);
4974 brn->brn_deviname = i_ddi_strdup(deviname, KM_SLEEP);
4975 kmem_free(deviname, MAXNAMELEN);
4976 brn->brn_child = child;
4977 brn->brn_sibling = *brevqp;
4978 *brevqp = brn;
4980 return (brn);
4984 * free the memory allocated for the elements on the branch event queue.
4986 static void
4987 free_brevq(struct brevq_node *brevq)
4989 struct brevq_node *brn, *next_brn;
4991 for (brn = brevq; brn != NULL; brn = next_brn) {
4992 next_brn = brn->brn_sibling;
4993 ASSERT(brn->brn_child == NULL);
4994 kmem_free(brn->brn_deviname, strlen(brn->brn_deviname) + 1);
4995 kmem_free(brn, sizeof (*brn));
5000 * log the events queued up on the branch event queue and free the
5001 * associated memory.
5003 * node_path must have been allocated with at least MAXPATHLEN bytes.
5005 static void
5006 log_and_free_brevq(char *node_path, struct brevq_node *brevq)
5008 struct brevq_node *brn;
5009 char *p;
5011 p = node_path + strlen(node_path);
5012 for (brn = brevq; brn != NULL; brn = brn->brn_sibling) {
5013 (void) strcpy(p, brn->brn_deviname);
5014 (void) i_log_devfs_branch_remove(node_path);
5016 *p = '\0';
5018 free_brevq(brevq);
5022 * log the events queued up on the branch event queue and free the
5023 * associated memory. Same as the previous function but operates on dip.
5025 static void
5026 log_and_free_brevq_dip(dev_info_t *dip, struct brevq_node *brevq)
5028 char *path;
5030 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
5031 (void) ddi_pathname(dip, path);
5032 log_and_free_brevq(path, brevq);
5033 kmem_free(path, MAXPATHLEN);
5037 * log the outstanding branch remove events for the grand children of the dip
5038 * and free the associated memory.
5040 static void
5041 log_and_free_br_events_on_grand_children(dev_info_t *dip,
5042 struct brevq_node *brevq)
5044 struct brevq_node *brn;
5045 char *path;
5046 char *p;
5048 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
5049 (void) ddi_pathname(dip, path);
5050 p = path + strlen(path);
5051 for (brn = brevq; brn != NULL; brn = brn->brn_sibling) {
5052 if (brn->brn_child) {
5053 (void) strcpy(p, brn->brn_deviname);
5054 /* now path contains the node path to the dip's child */
5055 log_and_free_brevq(path, brn->brn_child);
5056 brn->brn_child = NULL;
5059 kmem_free(path, MAXPATHLEN);
5063 * log and cleanup branch remove events for the grand children of the dip.
5065 static void
5066 cleanup_br_events_on_grand_children(dev_info_t *dip, struct brevq_node **brevqp)
5068 dev_info_t *child;
5069 struct brevq_node *brevq, *brn, *prev_brn, *next_brn;
5070 char *path;
5071 int circ;
5073 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
5074 prev_brn = NULL;
5075 brevq = *brevqp;
5077 ndi_devi_enter(dip, &circ);
5078 for (brn = brevq; brn != NULL; brn = next_brn) {
5079 next_brn = brn->brn_sibling;
5080 for (child = ddi_get_child(dip); child != NULL;
5081 child = ddi_get_next_sibling(child)) {
5082 if (i_ddi_node_state(child) >= DS_INITIALIZED) {
5083 (void) ddi_deviname(child, path);
5084 if (strcmp(path, brn->brn_deviname) == 0)
5085 break;
5089 if (child != NULL && !(DEVI_EVREMOVE(child))) {
5091 * Event state is not REMOVE. So branch remove event
5092 * is not going be generated on brn->brn_child.
5093 * If any branch remove events were queued up on
5094 * brn->brn_child log them and remove the brn
5095 * from the queue.
5097 if (brn->brn_child) {
5098 (void) ddi_pathname(dip, path);
5099 (void) strcat(path, brn->brn_deviname);
5100 log_and_free_brevq(path, brn->brn_child);
5103 if (prev_brn)
5104 prev_brn->brn_sibling = next_brn;
5105 else
5106 *brevqp = next_brn;
5108 kmem_free(brn->brn_deviname,
5109 strlen(brn->brn_deviname) + 1);
5110 kmem_free(brn, sizeof (*brn));
5111 } else {
5113 * Free up the outstanding branch remove events
5114 * queued on brn->brn_child since brn->brn_child
5115 * itself is eligible for branch remove event.
5117 if (brn->brn_child) {
5118 free_brevq(brn->brn_child);
5119 brn->brn_child = NULL;
5121 prev_brn = brn;
5125 ndi_devi_exit(dip, circ);
5126 kmem_free(path, MAXPATHLEN);
5129 static int
5130 need_remove_event(dev_info_t *dip, int flags)
5132 if ((flags & (NDI_NO_EVENT | NDI_AUTODETACH)) == 0 &&
5133 (flags & (NDI_DEVI_OFFLINE | NDI_UNCONFIG | NDI_DEVI_REMOVE)) &&
5134 !(DEVI_EVREMOVE(dip)))
5135 return (1);
5136 else
5137 return (0);
5141 * Unconfigure children/descendants of the dip.
5143 * If the operation involves a branch event NDI_BRANCH_EVENT_OP is set
5144 * through out the unconfiguration. On successful return *brevqp is set to
5145 * a queue of dip's child devinames for which branch remove events need
5146 * to be generated.
5148 static int
5149 devi_unconfig_branch(dev_info_t *dip, dev_info_t **dipp, int flags,
5150 struct brevq_node **brevqp)
5152 int rval;
5154 *brevqp = NULL;
5156 if ((!(flags & NDI_BRANCH_EVENT_OP)) && need_remove_event(dip, flags))
5157 flags |= NDI_BRANCH_EVENT_OP;
5159 if (flags & NDI_BRANCH_EVENT_OP) {
5160 rval = devi_unconfig_common(dip, dipp, flags, DDI_MAJOR_T_NONE,
5161 brevqp);
5163 if (rval != NDI_SUCCESS && (*brevqp)) {
5164 log_and_free_brevq_dip(dip, *brevqp);
5165 *brevqp = NULL;
5167 } else
5168 rval = devi_unconfig_common(dip, dipp, flags, DDI_MAJOR_T_NONE,
5169 NULL);
5171 return (rval);
5175 * If the dip is already bound to a driver transition to DS_INITIALIZED
5176 * in order to generate an event in the case where the node was left in
5177 * DS_BOUND state since boot (never got attached) and the node is now
5178 * being offlined.
5180 static void
5181 init_bound_node_ev(dev_info_t *pdip, dev_info_t *dip, int flags)
5183 if (need_remove_event(dip, flags) &&
5184 i_ddi_node_state(dip) == DS_BOUND &&
5185 i_ddi_devi_attached(pdip) && !DEVI_IS_DEVICE_OFFLINE(dip))
5186 (void) ddi_initchild(pdip, dip);
5190 * attach a node/branch with parent already held busy
5192 static int
5193 devi_attach_node(dev_info_t *dip, uint_t flags)
5195 dev_info_t *pdip = ddi_get_parent(dip);
5197 ASSERT(pdip && DEVI_BUSY_OWNED(pdip));
5199 mutex_enter(&(DEVI(dip)->devi_lock));
5200 if (flags & NDI_DEVI_ONLINE) {
5201 if (!i_ddi_devi_attached(dip))
5202 DEVI_SET_REPORT(dip);
5203 DEVI_SET_DEVICE_ONLINE(dip);
5205 if (DEVI_IS_DEVICE_OFFLINE(dip)) {
5206 mutex_exit(&(DEVI(dip)->devi_lock));
5207 return (NDI_FAILURE);
5209 mutex_exit(&(DEVI(dip)->devi_lock));
5211 if (i_ddi_attachchild(dip) != DDI_SUCCESS) {
5212 mutex_enter(&(DEVI(dip)->devi_lock));
5213 DEVI_SET_EVUNINIT(dip);
5214 mutex_exit(&(DEVI(dip)->devi_lock));
5216 if (ndi_dev_is_persistent_node(dip))
5217 (void) ddi_uninitchild(dip);
5218 else {
5220 * Delete .conf nodes and nodes that are not
5221 * well formed.
5223 (void) ddi_remove_child(dip, 0);
5225 return (NDI_FAILURE);
5228 i_ndi_devi_report_status_change(dip, NULL);
5231 * log an event, but not during devfs lookups in which case
5232 * NDI_NO_EVENT is set.
5234 if ((flags & NDI_NO_EVENT) == 0 && !(DEVI_EVADD(dip))) {
5235 (void) i_log_devfs_add_devinfo(dip, flags);
5237 mutex_enter(&(DEVI(dip)->devi_lock));
5238 DEVI_SET_EVADD(dip);
5239 mutex_exit(&(DEVI(dip)->devi_lock));
5240 } else if (!(flags & NDI_NO_EVENT_STATE_CHNG)) {
5241 mutex_enter(&(DEVI(dip)->devi_lock));
5242 DEVI_SET_EVADD(dip);
5243 mutex_exit(&(DEVI(dip)->devi_lock));
5246 return (NDI_SUCCESS);
5249 /* internal function to config immediate children */
5250 static int
5251 config_immediate_children(dev_info_t *pdip, uint_t flags, major_t major)
5253 dev_info_t *child, *next;
5254 int circ;
5256 ASSERT(i_ddi_devi_attached(pdip));
5258 if (!NEXUS_DRV(ddi_get_driver(pdip)))
5259 return (NDI_SUCCESS);
5261 NDI_CONFIG_DEBUG((CE_CONT,
5262 "config_immediate_children: %s%d (%p), flags=%x\n",
5263 ddi_driver_name(pdip), ddi_get_instance(pdip),
5264 (void *)pdip, flags));
5266 ndi_devi_enter(pdip, &circ);
5268 if (flags & NDI_CONFIG_REPROBE) {
5269 mutex_enter(&DEVI(pdip)->devi_lock);
5270 DEVI(pdip)->devi_flags &= ~DEVI_MADE_CHILDREN;
5271 mutex_exit(&DEVI(pdip)->devi_lock);
5273 (void) i_ndi_make_spec_children(pdip, flags);
5274 i_ndi_init_hw_children(pdip, flags);
5276 child = ddi_get_child(pdip);
5277 while (child) {
5278 /* NOTE: devi_attach_node() may remove the dip */
5279 next = ddi_get_next_sibling(child);
5282 * Configure all nexus nodes or leaf nodes with
5283 * matching driver major
5285 if ((major == DDI_MAJOR_T_NONE) ||
5286 (major == ddi_driver_major(child)) ||
5287 ((flags & NDI_CONFIG) && (is_leaf_node(child) == 0)))
5288 (void) devi_attach_node(child, flags);
5289 child = next;
5292 ndi_devi_exit(pdip, circ);
5294 return (NDI_SUCCESS);
5297 /* internal function to config grand children */
5298 static int
5299 config_grand_children(dev_info_t *pdip, uint_t flags, major_t major)
5301 struct mt_config_handle *hdl;
5303 /* multi-threaded configuration of child nexus */
5304 hdl = mt_config_init(pdip, NULL, flags, major, MT_CONFIG_OP, NULL);
5305 mt_config_children(hdl);
5307 return (mt_config_fini(hdl)); /* wait for threads to exit */
5311 * Common function for device tree configuration,
5312 * either BUS_CONFIG_ALL or BUS_CONFIG_DRIVER.
5313 * The NDI_CONFIG flag causes recursive configuration of
5314 * grandchildren, devfs usage should not recurse.
5316 static int
5317 devi_config_common(dev_info_t *dip, int flags, major_t major)
5319 int error;
5320 int (*f)();
5322 if (!i_ddi_devi_attached(dip))
5323 return (NDI_FAILURE);
5325 if (pm_pre_config(dip, NULL) != DDI_SUCCESS)
5326 return (NDI_FAILURE);
5328 if ((DEVI(dip)->devi_ops->devo_bus_ops == NULL) ||
5329 (DEVI(dip)->devi_ops->devo_bus_ops->busops_rev < BUSO_REV_5) ||
5330 (f = DEVI(dip)->devi_ops->devo_bus_ops->bus_config) == NULL) {
5331 error = config_immediate_children(dip, flags, major);
5332 } else {
5333 /* call bus_config entry point */
5334 ddi_bus_config_op_t bus_op = (major == DDI_MAJOR_T_NONE) ?
5335 BUS_CONFIG_ALL : BUS_CONFIG_DRIVER;
5336 error = (*f)(dip,
5337 flags, bus_op, (void *)(uintptr_t)major, NULL, 0);
5340 if (error) {
5341 pm_post_config(dip, NULL);
5342 return (error);
5346 * Some callers, notably SCSI, need to mark the devfs cache
5347 * to be rebuilt together with the config operation.
5349 if (flags & NDI_DEVFS_CLEAN)
5350 (void) devfs_clean(dip, NULL, 0);
5352 if (flags & NDI_CONFIG)
5353 (void) config_grand_children(dip, flags, major);
5355 pm_post_config(dip, NULL);
5357 return (NDI_SUCCESS);
5361 * Framework entry point for BUS_CONFIG_ALL
5364 ndi_devi_config(dev_info_t *dip, int flags)
5366 NDI_CONFIG_DEBUG((CE_CONT,
5367 "ndi_devi_config: par = %s%d (%p), flags = 0x%x\n",
5368 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip, flags));
5370 return (devi_config_common(dip, flags, DDI_MAJOR_T_NONE));
5374 * Framework entry point for BUS_CONFIG_DRIVER, bound to major
5377 ndi_devi_config_driver(dev_info_t *dip, int flags, major_t major)
5379 /* don't abuse this function */
5380 ASSERT(major != DDI_MAJOR_T_NONE);
5382 NDI_CONFIG_DEBUG((CE_CONT,
5383 "ndi_devi_config_driver: par = %s%d (%p), flags = 0x%x\n",
5384 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip, flags));
5386 return (devi_config_common(dip, flags, major));
5390 * Called by nexus drivers to configure its children.
5392 static int
5393 devi_config_one(dev_info_t *pdip, char *devnm, dev_info_t **cdipp,
5394 uint_t flags, clock_t timeout)
5396 dev_info_t *vdip = NULL;
5397 char *drivername = NULL;
5398 int find_by_addr = 0;
5399 char *name, *addr;
5400 int v_circ, p_circ;
5401 clock_t end_time; /* 60 sec */
5402 int probed;
5403 dev_info_t *cdip;
5404 mdi_pathinfo_t *cpip;
5406 *cdipp = NULL;
5408 if (!NEXUS_DRV(ddi_get_driver(pdip)))
5409 return (NDI_FAILURE);
5411 /* split name into "name@addr" parts */
5412 i_ddi_parse_name(devnm, &name, &addr, NULL);
5415 * If the nexus is a pHCI and we are not processing a pHCI from
5416 * mdi bus_config code then we need to know the vHCI.
5418 if (MDI_PHCI(pdip))
5419 vdip = mdi_devi_get_vdip(pdip);
5422 * We may have a genericname on a system that creates drivername
5423 * nodes (from .conf files). Find the drivername by nodeid. If we
5424 * can't find a node with devnm as the node name then we search by
5425 * drivername. This allows an implementation to supply a genericly
5426 * named boot path (disk) and locate drivename nodes (sd). The
5427 * NDI_PROMNAME flag does not apply to /devices/pseudo paths.
5429 if ((flags & NDI_PROMNAME) && (pdip != pseudo_dip)) {
5430 drivername = child_path_to_driver(pdip, name, addr);
5431 find_by_addr = 1;
5435 * Determine end_time: This routine should *not* be called with a
5436 * constant non-zero timeout argument, the caller should be adjusting
5437 * the timeout argument relative to when it *started* its asynchronous
5438 * enumeration.
5440 if (timeout > 0)
5441 end_time = ddi_get_lbolt() + timeout;
5443 for (;;) {
5445 * For pHCI, enter (vHCI, pHCI) and search for pathinfo/client
5446 * child - break out of for(;;) loop if child found.
5447 * NOTE: Lock order for ndi_devi_enter is (vHCI, pHCI).
5449 if (vdip) {
5450 /* use mdi_devi_enter ordering */
5451 ndi_devi_enter(vdip, &v_circ);
5452 ndi_devi_enter(pdip, &p_circ);
5453 cpip = mdi_pi_find(pdip, NULL, addr);
5454 cdip = mdi_pi_get_client(cpip);
5455 if (cdip)
5456 break;
5457 } else
5458 ndi_devi_enter(pdip, &p_circ);
5461 * When not a vHCI or not all pHCI devices are required to
5462 * enumerated under the vHCI (NDI_MDI_FALLBACK) search for
5463 * devinfo child.
5465 if ((vdip == NULL) || (flags & NDI_MDI_FALLBACK)) {
5466 /* determine if .conf nodes already built */
5467 probed = (DEVI(pdip)->devi_flags & DEVI_MADE_CHILDREN);
5470 * Search for child by name, if not found then search
5471 * for a node bound to the drivername driver with the
5472 * specified "@addr". Break out of for(;;) loop if
5473 * child found. To support path-oriented aliases
5474 * binding on boot-device, we do a search_by_addr too.
5476 again: (void) i_ndi_make_spec_children(pdip, flags);
5477 cdip = find_child_by_name(pdip, name, addr);
5478 if ((cdip == NULL) && drivername)
5479 cdip = find_child_by_driver(pdip,
5480 drivername, addr);
5481 if ((cdip == NULL) && find_by_addr)
5482 cdip = find_child_by_addr(pdip, addr);
5483 if (cdip)
5484 break;
5487 * determine if we should reenumerate .conf nodes
5488 * and look for child again.
5490 if (probed &&
5491 i_ddi_io_initialized() &&
5492 (flags & NDI_CONFIG_REPROBE) &&
5493 ((timeout <= 0) || (ddi_get_lbolt() >= end_time))) {
5494 probed = 0;
5495 mutex_enter(&DEVI(pdip)->devi_lock);
5496 DEVI(pdip)->devi_flags &= ~DEVI_MADE_CHILDREN;
5497 mutex_exit(&DEVI(pdip)->devi_lock);
5498 goto again;
5502 /* break out of for(;;) if time expired */
5503 if ((timeout <= 0) || (ddi_get_lbolt() >= end_time))
5504 break;
5507 * Child not found, exit and wait for asynchronous enumeration
5508 * to add child (or timeout). The addition of a new child (vhci
5509 * or phci) requires the asynchronous enumeration thread to
5510 * ndi_devi_enter/ndi_devi_exit. This exit will signal devi_cv
5511 * and cause us to return from ndi_devi_exit_and_wait, after
5512 * which we loop and search for the requested child again.
5514 NDI_DEBUG(flags, (CE_CONT,
5515 "%s%d: waiting for child %s@%s, timeout %ld",
5516 ddi_driver_name(pdip), ddi_get_instance(pdip),
5517 name, addr, timeout));
5518 if (vdip) {
5520 * Mark vHCI for pHCI ndi_devi_exit broadcast.
5522 mutex_enter(&DEVI(vdip)->devi_lock);
5523 DEVI(vdip)->devi_flags |=
5524 DEVI_PHCI_SIGNALS_VHCI;
5525 mutex_exit(&DEVI(vdip)->devi_lock);
5526 ndi_devi_exit(pdip, p_circ);
5529 * NB: There is a small race window from above
5530 * ndi_devi_exit() of pdip to cv_wait() in
5531 * ndi_devi_exit_and_wait() which can result in
5532 * not immediately finding a new pHCI child
5533 * of a pHCI that uses NDI_MDI_FAILBACK.
5535 ndi_devi_exit_and_wait(vdip, v_circ, end_time);
5536 } else {
5537 ndi_devi_exit_and_wait(pdip, p_circ, end_time);
5541 /* done with paddr, fixup i_ddi_parse_name '@'->'\0' change */
5542 if (addr && *addr != '\0')
5543 *(addr - 1) = '@';
5545 /* attach and hold the child, returning pointer to child */
5546 if (cdip && (devi_attach_node(cdip, flags) == NDI_SUCCESS)) {
5547 ndi_hold_devi(cdip);
5548 *cdipp = cdip;
5551 ndi_devi_exit(pdip, p_circ);
5552 if (vdip)
5553 ndi_devi_exit(vdip, v_circ);
5554 return (*cdipp ? NDI_SUCCESS : NDI_FAILURE);
5558 * Enumerate and attach a child specified by name 'devnm'.
5559 * Called by devfs lookup and DR to perform a BUS_CONFIG_ONE.
5560 * Note: devfs does not make use of NDI_CONFIG to configure
5561 * an entire branch.
5564 ndi_devi_config_one(dev_info_t *pdip, char *devnm, dev_info_t **dipp, int flags)
5566 int error;
5567 int (*f)();
5568 char *nmdup;
5569 int duplen;
5570 int branch_event = 0;
5572 ASSERT(pdip);
5573 ASSERT(devnm);
5574 ASSERT(dipp);
5575 ASSERT(i_ddi_devi_attached(pdip));
5577 NDI_CONFIG_DEBUG((CE_CONT,
5578 "ndi_devi_config_one: par = %s%d (%p), child = %s\n",
5579 ddi_driver_name(pdip), ddi_get_instance(pdip),
5580 (void *)pdip, devnm));
5582 *dipp = NULL;
5584 if (pm_pre_config(pdip, devnm) != DDI_SUCCESS) {
5585 cmn_err(CE_WARN, "preconfig failed: %s", devnm);
5586 return (NDI_FAILURE);
5589 if ((flags & (NDI_NO_EVENT | NDI_BRANCH_EVENT_OP)) == 0 &&
5590 (flags & NDI_CONFIG)) {
5591 flags |= NDI_BRANCH_EVENT_OP;
5592 branch_event = 1;
5595 nmdup = strdup(devnm);
5596 duplen = strlen(devnm) + 1;
5598 if ((DEVI(pdip)->devi_ops->devo_bus_ops == NULL) ||
5599 (DEVI(pdip)->devi_ops->devo_bus_ops->busops_rev < BUSO_REV_5) ||
5600 (f = DEVI(pdip)->devi_ops->devo_bus_ops->bus_config) == NULL) {
5601 error = devi_config_one(pdip, devnm, dipp, flags, 0);
5602 } else {
5603 /* call bus_config entry point */
5604 error = (*f)(pdip, flags, BUS_CONFIG_ONE, (void *)devnm, dipp);
5607 if (error) {
5608 *dipp = NULL;
5612 * if we fail to lookup and this could be an alias, lookup currdip
5613 * To prevent recursive lookups into the same hash table, only
5614 * do the currdip lookups once the hash table init is complete.
5615 * Use tsd so that redirection doesn't recurse
5617 if (error) {
5618 char *alias = kmem_alloc(MAXPATHLEN, KM_NOSLEEP);
5619 if (alias == NULL) {
5620 ddi_err(DER_PANIC, pdip, "alias alloc failed: %s",
5621 nmdup);
5623 (void) ddi_pathname(pdip, alias);
5624 (void) strlcat(alias, "/", MAXPATHLEN);
5625 (void) strlcat(alias, nmdup, MAXPATHLEN);
5627 *dipp = ddi_alias_redirect(alias);
5628 error = (*dipp ? NDI_SUCCESS : NDI_FAILURE);
5630 kmem_free(alias, MAXPATHLEN);
5632 kmem_free(nmdup, duplen);
5634 if (error || !(flags & NDI_CONFIG)) {
5635 pm_post_config(pdip, devnm);
5636 return (error);
5640 * DR usage (i.e. call with NDI_CONFIG) recursively configures
5641 * grandchildren, performing a BUS_CONFIG_ALL from the node attached
5642 * by the BUS_CONFIG_ONE.
5644 ASSERT(*dipp);
5645 error = devi_config_common(*dipp, flags, DDI_MAJOR_T_NONE);
5647 pm_post_config(pdip, devnm);
5649 if (branch_event)
5650 (void) i_log_devfs_branch_add(*dipp);
5652 return (error);
5656 * Enumerate and attach a child specified by name 'devnm'.
5657 * Called during configure the OBP options. This configures
5658 * only one node.
5660 static int
5661 ndi_devi_config_obp_args(dev_info_t *parent, char *devnm,
5662 dev_info_t **childp, int flags)
5664 int error;
5665 int (*f)();
5667 ASSERT(childp);
5668 ASSERT(i_ddi_devi_attached(parent));
5670 NDI_CONFIG_DEBUG((CE_CONT, "ndi_devi_config_obp_args: "
5671 "par = %s%d (%p), child = %s\n", ddi_driver_name(parent),
5672 ddi_get_instance(parent), (void *)parent, devnm));
5674 if ((DEVI(parent)->devi_ops->devo_bus_ops == NULL) ||
5675 (DEVI(parent)->devi_ops->devo_bus_ops->busops_rev < BUSO_REV_5) ||
5676 (f = DEVI(parent)->devi_ops->devo_bus_ops->bus_config) == NULL) {
5677 error = NDI_FAILURE;
5678 } else {
5679 /* call bus_config entry point */
5680 error = (*f)(parent, flags,
5681 BUS_CONFIG_OBP_ARGS, (void *)devnm, childp);
5683 return (error);
5687 * Pay attention, the following is a bit tricky:
5688 * There are three possible cases when constraints are applied
5690 * - A constraint is applied and the offline is disallowed.
5691 * Simply return failure and block the offline
5693 * - A constraint is applied and the offline is allowed.
5694 * Mark the dip as having passed the constraint and allow
5695 * offline to proceed.
5697 * - A constraint is not applied. Allow the offline to proceed for now.
5699 * In the latter two cases we allow the offline to proceed. If the
5700 * offline succeeds (no users) everything is fine. It is ok for an unused
5701 * device to be offlined even if no constraints were imposed on the offline.
5702 * If the offline fails because there are users, we look at the constraint
5703 * flag on the dip. If the constraint flag is set (implying that it passed
5704 * a constraint) we allow the dip to be retired. If not, we don't allow
5705 * the retire. This ensures that we don't allow unconstrained retire.
5708 e_ddi_offline_notify(dev_info_t *dip)
5710 int retval;
5711 int constraint;
5712 int failure;
5714 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_notify(): entered: dip=%p",
5715 (void *) dip));
5717 constraint = 0;
5718 failure = 0;
5721 * Start with userland constraints first - applied via device contracts
5723 retval = contract_device_offline(dip, DDI_DEV_T_ANY, 0);
5724 switch (retval) {
5725 case CT_NACK:
5726 RIO_DEBUG((CE_NOTE, "Received NACK for dip=%p", (void *)dip));
5727 failure = 1;
5728 goto out;
5729 case CT_ACK:
5730 constraint = 1;
5731 RIO_DEBUG((CE_NOTE, "Received ACK for dip=%p", (void *)dip));
5732 break;
5733 case CT_NONE:
5734 /* no contracts */
5735 RIO_DEBUG((CE_NOTE, "No contracts on dip=%p", (void *)dip));
5736 break;
5737 default:
5738 ASSERT(retval == CT_NONE);
5742 * Next, use LDI to impose kernel constraints
5744 retval = ldi_invoke_notify(dip, DDI_DEV_T_ANY, 0, LDI_EV_OFFLINE, NULL);
5745 switch (retval) {
5746 case LDI_EV_FAILURE:
5747 contract_device_negend(dip, DDI_DEV_T_ANY, 0, CT_EV_FAILURE);
5748 RIO_DEBUG((CE_NOTE, "LDI callback failed on dip=%p",
5749 (void *)dip));
5750 failure = 1;
5751 goto out;
5752 case LDI_EV_SUCCESS:
5753 constraint = 1;
5754 RIO_DEBUG((CE_NOTE, "LDI callback success on dip=%p",
5755 (void *)dip));
5756 break;
5757 case LDI_EV_NONE:
5758 /* no matching LDI callbacks */
5759 RIO_DEBUG((CE_NOTE, "No LDI callbacks for dip=%p",
5760 (void *)dip));
5761 break;
5762 default:
5763 ASSERT(retval == LDI_EV_NONE);
5766 out:
5767 mutex_enter(&(DEVI(dip)->devi_lock));
5768 if ((DEVI(dip)->devi_flags & DEVI_RETIRING) && failure) {
5769 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_notify(): setting "
5770 "BLOCKED flag. dip=%p", (void *)dip));
5771 DEVI(dip)->devi_flags |= DEVI_R_BLOCKED;
5772 if (DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT) {
5773 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_notify(): "
5774 "blocked. clearing RCM CONSTRAINT flag. dip=%p",
5775 (void *)dip));
5776 DEVI(dip)->devi_flags &= ~DEVI_R_CONSTRAINT;
5778 } else if ((DEVI(dip)->devi_flags & DEVI_RETIRING) && constraint) {
5779 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_notify(): setting "
5780 "CONSTRAINT flag. dip=%p", (void *)dip));
5781 DEVI(dip)->devi_flags |= DEVI_R_CONSTRAINT;
5782 } else if ((DEVI(dip)->devi_flags & DEVI_RETIRING) &&
5783 ((DEVI(dip)->devi_ops != NULL &&
5784 DEVI(dip)->devi_ops->devo_bus_ops != NULL) ||
5785 DEVI(dip)->devi_ref == 0)) {
5786 /* also allow retire if nexus or if device is not in use */
5787 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_notify(): device not in "
5788 "use. Setting CONSTRAINT flag. dip=%p", (void *)dip));
5789 DEVI(dip)->devi_flags |= DEVI_R_CONSTRAINT;
5790 } else {
5792 * Note: We cannot ASSERT here that DEVI_R_CONSTRAINT is
5793 * not set, since other sources (such as RCM) may have
5794 * set the flag.
5796 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_notify(): not setting "
5797 "constraint flag. dip=%p", (void *)dip));
5799 mutex_exit(&(DEVI(dip)->devi_lock));
5802 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_notify(): exit: dip=%p",
5803 (void *) dip));
5805 return (failure ? DDI_FAILURE : DDI_SUCCESS);
5808 void
5809 e_ddi_offline_finalize(dev_info_t *dip, int result)
5811 RIO_DEBUG((CE_NOTE, "e_ddi_offline_finalize(): entry: result=%s, "
5812 "dip=%p", result == DDI_SUCCESS ? "SUCCESS" : "FAILURE",
5813 (void *)dip));
5815 contract_device_negend(dip, DDI_DEV_T_ANY, 0, result == DDI_SUCCESS ?
5816 CT_EV_SUCCESS : CT_EV_FAILURE);
5818 ldi_invoke_finalize(dip, DDI_DEV_T_ANY, 0,
5819 LDI_EV_OFFLINE, result == DDI_SUCCESS ?
5820 LDI_EV_SUCCESS : LDI_EV_FAILURE, NULL);
5822 RIO_VERBOSE((CE_NOTE, "e_ddi_offline_finalize(): exit: dip=%p",
5823 (void *)dip));
5826 void
5827 e_ddi_degrade_finalize(dev_info_t *dip)
5829 RIO_DEBUG((CE_NOTE, "e_ddi_degrade_finalize(): entry: "
5830 "result always = DDI_SUCCESS, dip=%p", (void *)dip));
5832 contract_device_degrade(dip, DDI_DEV_T_ANY, 0);
5833 contract_device_negend(dip, DDI_DEV_T_ANY, 0, CT_EV_SUCCESS);
5835 ldi_invoke_finalize(dip, DDI_DEV_T_ANY, 0, LDI_EV_DEGRADE,
5836 LDI_EV_SUCCESS, NULL);
5838 RIO_VERBOSE((CE_NOTE, "e_ddi_degrade_finalize(): exit: dip=%p",
5839 (void *)dip));
5842 void
5843 e_ddi_undegrade_finalize(dev_info_t *dip)
5845 RIO_DEBUG((CE_NOTE, "e_ddi_undegrade_finalize(): entry: "
5846 "result always = DDI_SUCCESS, dip=%p", (void *)dip));
5848 contract_device_undegrade(dip, DDI_DEV_T_ANY, 0);
5849 contract_device_negend(dip, DDI_DEV_T_ANY, 0, CT_EV_SUCCESS);
5851 RIO_VERBOSE((CE_NOTE, "e_ddi_undegrade_finalize(): exit: dip=%p",
5852 (void *)dip));
5856 * detach a node with parent already held busy
5858 static int
5859 devi_detach_node(dev_info_t *dip, uint_t flags)
5861 dev_info_t *pdip = ddi_get_parent(dip);
5862 int ret = NDI_SUCCESS;
5863 ddi_eventcookie_t cookie;
5864 char *path = NULL;
5865 char *class = NULL;
5866 char *driver = NULL;
5867 int instance = -1;
5868 int post_event = 0;
5870 ASSERT(pdip && DEVI_BUSY_OWNED(pdip));
5873 * Invoke notify if offlining
5875 if (flags & NDI_DEVI_OFFLINE) {
5876 RIO_DEBUG((CE_NOTE, "devi_detach_node: offlining dip=%p",
5877 (void *)dip));
5878 if (e_ddi_offline_notify(dip) != DDI_SUCCESS) {
5879 RIO_DEBUG((CE_NOTE, "devi_detach_node: offline NACKed"
5880 "dip=%p", (void *)dip));
5881 return (NDI_FAILURE);
5885 if (flags & NDI_POST_EVENT) {
5886 if (i_ddi_devi_attached(pdip)) {
5887 if (ddi_get_eventcookie(dip, DDI_DEVI_REMOVE_EVENT,
5888 &cookie) == NDI_SUCCESS)
5889 (void) ndi_post_event(dip, dip, cookie, NULL);
5893 if (i_ddi_detachchild(dip, flags) != DDI_SUCCESS) {
5894 if (flags & NDI_DEVI_OFFLINE) {
5895 RIO_DEBUG((CE_NOTE, "devi_detach_node: offline failed."
5896 " Calling e_ddi_offline_finalize with result=%d. "
5897 "dip=%p", DDI_FAILURE, (void *)dip));
5898 e_ddi_offline_finalize(dip, DDI_FAILURE);
5900 return (NDI_FAILURE);
5903 if (flags & NDI_DEVI_OFFLINE) {
5904 RIO_DEBUG((CE_NOTE, "devi_detach_node: offline succeeded."
5905 " Calling e_ddi_offline_finalize with result=%d, "
5906 "dip=%p", DDI_SUCCESS, (void *)dip));
5907 e_ddi_offline_finalize(dip, DDI_SUCCESS);
5910 if (flags & NDI_AUTODETACH)
5911 return (NDI_SUCCESS);
5914 * For DR, even bound nodes may need to have offline
5915 * flag set.
5917 if (flags & NDI_DEVI_OFFLINE) {
5918 mutex_enter(&(DEVI(dip)->devi_lock));
5919 DEVI_SET_DEVICE_OFFLINE(dip);
5920 mutex_exit(&(DEVI(dip)->devi_lock));
5923 if (i_ddi_node_state(dip) == DS_INITIALIZED) {
5924 struct dev_info *devi = DEVI(dip);
5926 if (devi->devi_ev_path == NULL) {
5927 devi->devi_ev_path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
5928 (void) ddi_pathname(dip, devi->devi_ev_path);
5930 if (flags & NDI_DEVI_OFFLINE)
5931 i_ndi_devi_report_status_change(dip,
5932 devi->devi_ev_path);
5934 if (need_remove_event(dip, flags)) {
5936 * instance and path data are lost in call to
5937 * ddi_uninitchild
5939 devi->devi_ev_instance = ddi_get_instance(dip);
5941 mutex_enter(&(DEVI(dip)->devi_lock));
5942 DEVI_SET_EVREMOVE(dip);
5943 mutex_exit(&(DEVI(dip)->devi_lock));
5947 if (flags & (NDI_UNCONFIG | NDI_DEVI_REMOVE)) {
5948 ret = ddi_uninitchild(dip);
5949 if (ret == NDI_SUCCESS) {
5951 * Remove uninitialized pseudo nodes because
5952 * system props are lost and the node cannot be
5953 * reattached.
5955 if (!ndi_dev_is_persistent_node(dip))
5956 flags |= NDI_DEVI_REMOVE;
5958 if (flags & NDI_DEVI_REMOVE) {
5960 * NOTE: If there is a consumer of LDI events,
5961 * ddi_uninitchild above would have failed
5962 * because of active devi_ref from ldi_open().
5965 if (DEVI_EVREMOVE(dip)) {
5966 path = i_ddi_strdup(
5967 DEVI(dip)->devi_ev_path,
5968 KM_SLEEP);
5969 class =
5970 i_ddi_strdup(i_ddi_devi_class(dip),
5971 KM_SLEEP);
5972 driver =
5973 i_ddi_strdup(
5974 (char *)ddi_driver_name(dip),
5975 KM_SLEEP);
5976 instance = DEVI(dip)->devi_ev_instance;
5977 post_event = 1;
5980 ret = ddi_remove_child(dip, 0);
5981 if (post_event && ret == NDI_SUCCESS) {
5982 /* Generate EC_DEVFS_DEVI_REMOVE */
5983 (void) i_log_devfs_remove_devinfo(path,
5984 class, driver, instance, flags);
5991 if (path)
5992 strfree(path);
5993 if (class)
5994 strfree(class);
5995 if (driver)
5996 strfree(driver);
5998 return (ret);
6002 * unconfigure immediate children of bus nexus device
6004 static int
6005 unconfig_immediate_children(
6006 dev_info_t *dip,
6007 dev_info_t **dipp,
6008 int flags,
6009 major_t major)
6011 int rv = NDI_SUCCESS;
6012 int circ, vcirc;
6013 dev_info_t *child;
6014 dev_info_t *vdip = NULL;
6015 dev_info_t *next;
6017 ASSERT(dipp == NULL || *dipp == NULL);
6020 * Scan forward to see if we will be processing a pHCI child. If we
6021 * have a child that is a pHCI and vHCI and pHCI are not siblings then
6022 * enter vHCI before parent(pHCI) to prevent deadlock with mpxio
6023 * Client power management operations.
6025 ndi_devi_enter(dip, &circ);
6026 for (child = ddi_get_child(dip); child;
6027 child = ddi_get_next_sibling(child)) {
6028 /* skip same nodes we skip below */
6029 if (((major != DDI_MAJOR_T_NONE) &&
6030 (major != ddi_driver_major(child))) ||
6031 ((flags & NDI_AUTODETACH) && !is_leaf_node(child)))
6032 continue;
6034 if (MDI_PHCI(child)) {
6035 vdip = mdi_devi_get_vdip(child);
6037 * If vHCI and vHCI is not a sibling of pHCI
6038 * then enter in (vHCI, parent(pHCI)) order.
6040 if (vdip && (ddi_get_parent(vdip) != dip)) {
6041 ndi_devi_exit(dip, circ);
6043 /* use mdi_devi_enter ordering */
6044 ndi_devi_enter(vdip, &vcirc);
6045 ndi_devi_enter(dip, &circ);
6046 break;
6047 } else
6048 vdip = NULL;
6052 child = ddi_get_child(dip);
6053 while (child) {
6054 next = ddi_get_next_sibling(child);
6056 if ((major != DDI_MAJOR_T_NONE) &&
6057 (major != ddi_driver_major(child))) {
6058 child = next;
6059 continue;
6062 /* skip nexus nodes during autodetach */
6063 if ((flags & NDI_AUTODETACH) && !is_leaf_node(child)) {
6064 child = next;
6065 continue;
6068 if (devi_detach_node(child, flags) != NDI_SUCCESS) {
6069 if (dipp && *dipp == NULL) {
6070 ndi_hold_devi(child);
6071 *dipp = child;
6073 rv = NDI_FAILURE;
6077 * Continue upon failure--best effort algorithm
6079 child = next;
6082 ndi_devi_exit(dip, circ);
6083 if (vdip)
6084 ndi_devi_exit(vdip, vcirc);
6086 return (rv);
6090 * unconfigure grand children of bus nexus device
6092 static int
6093 unconfig_grand_children(
6094 dev_info_t *dip,
6095 dev_info_t **dipp,
6096 int flags,
6097 major_t major,
6098 struct brevq_node **brevqp)
6100 struct mt_config_handle *hdl;
6102 if (brevqp)
6103 *brevqp = NULL;
6105 /* multi-threaded configuration of child nexus */
6106 hdl = mt_config_init(dip, dipp, flags, major, MT_UNCONFIG_OP, brevqp);
6107 mt_config_children(hdl);
6109 return (mt_config_fini(hdl)); /* wait for threads to exit */
6113 * Unconfigure children/descendants of the dip.
6115 * If brevqp is not NULL, on return *brevqp is set to a queue of dip's
6116 * child devinames for which branch remove events need to be generated.
6118 static int
6119 devi_unconfig_common(
6120 dev_info_t *dip,
6121 dev_info_t **dipp,
6122 int flags,
6123 major_t major,
6124 struct brevq_node **brevqp)
6126 int rv;
6127 int pm_cookie;
6128 int (*f)();
6129 ddi_bus_config_op_t bus_op;
6131 if (dipp)
6132 *dipp = NULL;
6133 if (brevqp)
6134 *brevqp = NULL;
6137 * Power up the dip if it is powered off. If the flag bit
6138 * NDI_AUTODETACH is set and the dip is not at its full power,
6139 * skip the rest of the branch.
6141 if (pm_pre_unconfig(dip, flags, &pm_cookie, NULL) != DDI_SUCCESS)
6142 return ((flags & NDI_AUTODETACH) ? NDI_SUCCESS :
6143 NDI_FAILURE);
6146 * Some callers, notably SCSI, need to clear out the devfs
6147 * cache together with the unconfig to prevent stale entries.
6149 if (flags & NDI_DEVFS_CLEAN)
6150 (void) devfs_clean(dip, NULL, 0);
6152 rv = unconfig_grand_children(dip, dipp, flags, major, brevqp);
6154 if ((rv != NDI_SUCCESS) && ((flags & NDI_AUTODETACH) == 0)) {
6155 if (brevqp && *brevqp) {
6156 log_and_free_br_events_on_grand_children(dip, *brevqp);
6157 free_brevq(*brevqp);
6158 *brevqp = NULL;
6160 pm_post_unconfig(dip, pm_cookie, NULL);
6161 return (rv);
6164 if (dipp && *dipp) {
6165 ndi_rele_devi(*dipp);
6166 *dipp = NULL;
6170 * It is possible to have a detached nexus with children
6171 * and grandchildren (for example: a branch consisting
6172 * entirely of bound nodes.) Since the nexus is detached
6173 * the bus_unconfig entry point cannot be used to remove
6174 * or unconfigure the descendants.
6176 if (!i_ddi_devi_attached(dip) ||
6177 (DEVI(dip)->devi_ops->devo_bus_ops == NULL) ||
6178 (DEVI(dip)->devi_ops->devo_bus_ops->busops_rev < BUSO_REV_5) ||
6179 (f = DEVI(dip)->devi_ops->devo_bus_ops->bus_unconfig) == NULL) {
6180 rv = unconfig_immediate_children(dip, dipp, flags, major);
6181 } else {
6183 * call bus_unconfig entry point
6184 * It should reset nexus flags if unconfigure succeeds.
6186 bus_op = (major == DDI_MAJOR_T_NONE) ?
6187 BUS_UNCONFIG_ALL : BUS_UNCONFIG_DRIVER;
6188 rv = (*f)(dip, flags, bus_op, (void *)(uintptr_t)major);
6191 pm_post_unconfig(dip, pm_cookie, NULL);
6193 if (brevqp && *brevqp)
6194 cleanup_br_events_on_grand_children(dip, brevqp);
6196 return (rv);
6200 * called by devfs/framework to unconfigure children bound to major
6201 * If NDI_AUTODETACH is specified, this is invoked by either the
6202 * moduninstall daemon or the modunload -i 0 command.
6205 ndi_devi_unconfig_driver(dev_info_t *dip, int flags, major_t major)
6207 NDI_CONFIG_DEBUG((CE_CONT,
6208 "ndi_devi_unconfig_driver: par = %s%d (%p), flags = 0x%x\n",
6209 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip, flags));
6211 return (devi_unconfig_common(dip, NULL, flags, major, NULL));
6215 ndi_devi_unconfig(dev_info_t *dip, int flags)
6217 NDI_CONFIG_DEBUG((CE_CONT,
6218 "ndi_devi_unconfig: par = %s%d (%p), flags = 0x%x\n",
6219 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip, flags));
6221 return (devi_unconfig_common(dip, NULL, flags, DDI_MAJOR_T_NONE, NULL));
6225 e_ddi_devi_unconfig(dev_info_t *dip, dev_info_t **dipp, int flags)
6227 NDI_CONFIG_DEBUG((CE_CONT,
6228 "e_ddi_devi_unconfig: par = %s%d (%p), flags = 0x%x\n",
6229 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip, flags));
6231 return (devi_unconfig_common(dip, dipp, flags, DDI_MAJOR_T_NONE, NULL));
6235 * Unconfigure child by name
6237 static int
6238 devi_unconfig_one(dev_info_t *pdip, char *devnm, int flags)
6240 int rv, circ;
6241 dev_info_t *child;
6242 dev_info_t *vdip = NULL;
6243 int v_circ;
6245 ndi_devi_enter(pdip, &circ);
6246 child = ndi_devi_findchild(pdip, devnm);
6249 * If child is pHCI and vHCI and pHCI are not siblings then enter vHCI
6250 * before parent(pHCI) to avoid deadlock with mpxio Client power
6251 * management operations.
6253 if (child && MDI_PHCI(child)) {
6254 vdip = mdi_devi_get_vdip(child);
6255 if (vdip && (ddi_get_parent(vdip) != pdip)) {
6256 ndi_devi_exit(pdip, circ);
6258 /* use mdi_devi_enter ordering */
6259 ndi_devi_enter(vdip, &v_circ);
6260 ndi_devi_enter(pdip, &circ);
6261 child = ndi_devi_findchild(pdip, devnm);
6262 } else
6263 vdip = NULL;
6266 if (child) {
6267 rv = devi_detach_node(child, flags);
6268 } else {
6269 NDI_CONFIG_DEBUG((CE_CONT,
6270 "devi_unconfig_one: %s not found\n", devnm));
6271 rv = NDI_SUCCESS;
6274 ndi_devi_exit(pdip, circ);
6275 if (vdip)
6276 ndi_devi_exit(vdip, v_circ);
6278 return (rv);
6282 ndi_devi_unconfig_one(
6283 dev_info_t *pdip,
6284 char *devnm,
6285 dev_info_t **dipp,
6286 int flags)
6288 int (*f)();
6289 int circ, rv;
6290 int pm_cookie;
6291 dev_info_t *child;
6292 dev_info_t *vdip = NULL;
6293 int v_circ;
6294 struct brevq_node *brevq = NULL;
6296 ASSERT(i_ddi_devi_attached(pdip));
6298 NDI_CONFIG_DEBUG((CE_CONT,
6299 "ndi_devi_unconfig_one: par = %s%d (%p), child = %s\n",
6300 ddi_driver_name(pdip), ddi_get_instance(pdip),
6301 (void *)pdip, devnm));
6303 if (pm_pre_unconfig(pdip, flags, &pm_cookie, devnm) != DDI_SUCCESS)
6304 return (NDI_FAILURE);
6306 if (dipp)
6307 *dipp = NULL;
6309 ndi_devi_enter(pdip, &circ);
6310 child = ndi_devi_findchild(pdip, devnm);
6313 * If child is pHCI and vHCI and pHCI are not siblings then enter vHCI
6314 * before parent(pHCI) to avoid deadlock with mpxio Client power
6315 * management operations.
6317 if (child && MDI_PHCI(child)) {
6318 vdip = mdi_devi_get_vdip(child);
6319 if (vdip && (ddi_get_parent(vdip) != pdip)) {
6320 ndi_devi_exit(pdip, circ);
6322 /* use mdi_devi_enter ordering */
6323 ndi_devi_enter(vdip, &v_circ);
6324 ndi_devi_enter(pdip, &circ);
6325 child = ndi_devi_findchild(pdip, devnm);
6326 } else
6327 vdip = NULL;
6330 if (child == NULL) {
6331 NDI_CONFIG_DEBUG((CE_CONT, "ndi_devi_unconfig_one: %s"
6332 " not found\n", devnm));
6333 rv = NDI_SUCCESS;
6334 goto out;
6338 * Unconfigure children/descendants of named child
6340 rv = devi_unconfig_branch(child, dipp, flags | NDI_UNCONFIG, &brevq);
6341 if (rv != NDI_SUCCESS)
6342 goto out;
6344 init_bound_node_ev(pdip, child, flags);
6346 if ((DEVI(pdip)->devi_ops->devo_bus_ops == NULL) ||
6347 (DEVI(pdip)->devi_ops->devo_bus_ops->busops_rev < BUSO_REV_5) ||
6348 (f = DEVI(pdip)->devi_ops->devo_bus_ops->bus_unconfig) == NULL) {
6349 rv = devi_detach_node(child, flags);
6350 } else {
6351 /* call bus_config entry point */
6352 rv = (*f)(pdip, flags, BUS_UNCONFIG_ONE, (void *)devnm);
6355 if (brevq) {
6356 if (rv != NDI_SUCCESS)
6357 log_and_free_brevq_dip(child, brevq);
6358 else
6359 free_brevq(brevq);
6362 if (dipp && rv != NDI_SUCCESS) {
6363 ndi_hold_devi(child);
6364 ASSERT(*dipp == NULL);
6365 *dipp = child;
6368 out:
6369 ndi_devi_exit(pdip, circ);
6370 if (vdip)
6371 ndi_devi_exit(vdip, v_circ);
6373 pm_post_unconfig(pdip, pm_cookie, devnm);
6375 return (rv);
6378 struct async_arg {
6379 dev_info_t *dip;
6380 uint_t flags;
6384 * Common async handler for:
6385 * ndi_devi_bind_driver_async
6386 * ndi_devi_online_async
6388 static int
6389 i_ndi_devi_async_common(dev_info_t *dip, uint_t flags, void (*func)())
6391 int tqflag;
6392 int kmflag;
6393 struct async_arg *arg;
6394 dev_info_t *pdip = ddi_get_parent(dip);
6396 ASSERT(pdip);
6397 ASSERT(DEVI(pdip)->devi_taskq);
6398 ASSERT(ndi_dev_is_persistent_node(dip));
6400 if (flags & NDI_NOSLEEP) {
6401 kmflag = KM_NOSLEEP;
6402 tqflag = TQ_NOSLEEP;
6403 } else {
6404 kmflag = KM_SLEEP;
6405 tqflag = TQ_SLEEP;
6408 arg = kmem_alloc(sizeof (*arg), kmflag);
6409 if (arg == NULL)
6410 goto fail;
6412 arg->flags = flags;
6413 arg->dip = dip;
6414 if (ddi_taskq_dispatch(DEVI(pdip)->devi_taskq, func, arg, tqflag) ==
6415 DDI_SUCCESS) {
6416 return (NDI_SUCCESS);
6419 fail:
6420 NDI_CONFIG_DEBUG((CE_CONT, "%s%d: ddi_taskq_dispatch failed",
6421 ddi_driver_name(pdip), ddi_get_instance(pdip)));
6423 if (arg)
6424 kmem_free(arg, sizeof (*arg));
6425 return (NDI_FAILURE);
6428 static void
6429 i_ndi_devi_bind_driver_cb(struct async_arg *arg)
6431 (void) ndi_devi_bind_driver(arg->dip, arg->flags);
6432 kmem_free(arg, sizeof (*arg));
6436 ndi_devi_bind_driver_async(dev_info_t *dip, uint_t flags)
6438 return (i_ndi_devi_async_common(dip, flags,
6439 (void (*)())i_ndi_devi_bind_driver_cb));
6443 * place the devinfo in the ONLINE state.
6446 ndi_devi_online(dev_info_t *dip, uint_t flags)
6448 int circ, rv;
6449 dev_info_t *pdip = ddi_get_parent(dip);
6450 int branch_event = 0;
6452 ASSERT(pdip);
6454 NDI_CONFIG_DEBUG((CE_CONT, "ndi_devi_online: %s%d (%p)\n",
6455 ddi_driver_name(dip), ddi_get_instance(dip), (void *)dip));
6457 ndi_devi_enter(pdip, &circ);
6458 /* bind child before merging .conf nodes */
6459 rv = i_ndi_config_node(dip, DS_BOUND, flags);
6460 if (rv != NDI_SUCCESS) {
6461 ndi_devi_exit(pdip, circ);
6462 return (rv);
6465 /* merge .conf properties */
6466 (void) i_ndi_make_spec_children(pdip, flags);
6468 flags |= (NDI_DEVI_ONLINE | NDI_CONFIG);
6470 if (flags & NDI_NO_EVENT) {
6472 * Caller is specifically asking for not to generate an event.
6473 * Set the following flag so that devi_attach_node() don't
6474 * change the event state.
6476 flags |= NDI_NO_EVENT_STATE_CHNG;
6479 if ((flags & (NDI_NO_EVENT | NDI_BRANCH_EVENT_OP)) == 0 &&
6480 ((flags & NDI_CONFIG) || DEVI_NEED_NDI_CONFIG(dip))) {
6481 flags |= NDI_BRANCH_EVENT_OP;
6482 branch_event = 1;
6486 * devi_attach_node() may remove dip on failure
6488 if ((rv = devi_attach_node(dip, flags)) == NDI_SUCCESS) {
6489 if ((flags & NDI_CONFIG) || DEVI_NEED_NDI_CONFIG(dip)) {
6491 * Hold the attached dip, and exit the parent while
6492 * we drive configuration of children below the
6493 * attached dip.
6495 ndi_hold_devi(dip);
6496 ndi_devi_exit(pdip, circ);
6498 (void) ndi_devi_config(dip, flags);
6500 ndi_devi_enter(pdip, &circ);
6501 ndi_rele_devi(dip);
6504 if (branch_event)
6505 (void) i_log_devfs_branch_add(dip);
6508 ndi_devi_exit(pdip, circ);
6511 * Notify devfs that we have a new node. Devfs needs to invalidate
6512 * cached directory contents.
6514 * For PCMCIA devices, it is possible the pdip is not fully
6515 * attached. In this case, calling back into devfs will
6516 * result in a loop or assertion error. Hence, the check
6517 * on node state.
6519 * If we own parent lock, this is part of a branch operation.
6520 * We skip the devfs_clean() step because the cache invalidation
6521 * is done higher up in the device tree.
6523 if (rv == NDI_SUCCESS && i_ddi_devi_attached(pdip) &&
6524 !DEVI_BUSY_OWNED(pdip))
6525 (void) devfs_clean(pdip, NULL, 0);
6526 return (rv);
6529 static void
6530 i_ndi_devi_online_cb(struct async_arg *arg)
6532 (void) ndi_devi_online(arg->dip, arg->flags);
6533 kmem_free(arg, sizeof (*arg));
6537 ndi_devi_online_async(dev_info_t *dip, uint_t flags)
6539 /* mark child as need config if requested. */
6540 if (flags & NDI_CONFIG) {
6541 mutex_enter(&(DEVI(dip)->devi_lock));
6542 DEVI_SET_NDI_CONFIG(dip);
6543 mutex_exit(&(DEVI(dip)->devi_lock));
6546 return (i_ndi_devi_async_common(dip, flags,
6547 (void (*)())i_ndi_devi_online_cb));
6551 * Take a device node Offline
6552 * To take a device Offline means to detach the device instance from
6553 * the driver and prevent devfs requests from re-attaching the device
6554 * instance.
6556 * The flag NDI_DEVI_REMOVE causes removes the device node from
6557 * the driver list and the device tree. In this case, the device
6558 * is assumed to be removed from the system.
6561 ndi_devi_offline(dev_info_t *dip, uint_t flags)
6563 int circ, rval = 0;
6564 dev_info_t *pdip = ddi_get_parent(dip);
6565 dev_info_t *vdip = NULL;
6566 int v_circ;
6567 struct brevq_node *brevq = NULL;
6569 ASSERT(pdip);
6571 flags |= NDI_DEVI_OFFLINE;
6574 * If child is pHCI and vHCI and pHCI are not siblings then enter vHCI
6575 * before parent(pHCI) to avoid deadlock with mpxio Client power
6576 * management operations.
6578 if (MDI_PHCI(dip)) {
6579 vdip = mdi_devi_get_vdip(dip);
6580 if (vdip && (ddi_get_parent(vdip) != pdip))
6581 ndi_devi_enter(vdip, &v_circ);
6582 else
6583 vdip = NULL;
6585 ndi_devi_enter(pdip, &circ);
6587 if (i_ddi_devi_attached(dip)) {
6589 * If dip is in DS_READY state, there may be cached dv_nodes
6590 * referencing this dip, so we invoke devfs code path.
6591 * Note that we must release busy changing on pdip to
6592 * avoid deadlock against devfs.
6594 char *devname = kmem_alloc(MAXNAMELEN + 1, KM_SLEEP);
6595 (void) ddi_deviname(dip, devname);
6597 ndi_devi_exit(pdip, circ);
6598 if (vdip)
6599 ndi_devi_exit(vdip, v_circ);
6602 * If we are explictly told to clean, then clean. If we own the
6603 * parent lock then this is part of a branch operation, and we
6604 * skip the devfs_clean() step.
6606 * NOTE: A thread performing a devfs file system lookup/
6607 * bus_config can't call devfs_clean to unconfig without
6608 * causing rwlock problems in devfs. For ndi_devi_offline, this
6609 * means that the NDI_DEVFS_CLEAN flag is safe from ioctl code
6610 * or from an async hotplug thread, but is not safe from a
6611 * nexus driver's bus_config implementation.
6613 if ((flags & NDI_DEVFS_CLEAN) ||
6614 (!DEVI_BUSY_OWNED(pdip)))
6615 (void) devfs_clean(pdip, devname + 1, DV_CLEAN_FORCE);
6617 kmem_free(devname, MAXNAMELEN + 1);
6619 rval = devi_unconfig_branch(dip, NULL, flags|NDI_UNCONFIG,
6620 &brevq);
6622 if (rval)
6623 return (NDI_FAILURE);
6625 if (vdip)
6626 ndi_devi_enter(vdip, &v_circ);
6627 ndi_devi_enter(pdip, &circ);
6630 init_bound_node_ev(pdip, dip, flags);
6632 rval = devi_detach_node(dip, flags);
6633 if (brevq) {
6634 if (rval != NDI_SUCCESS)
6635 log_and_free_brevq_dip(dip, brevq);
6636 else
6637 free_brevq(brevq);
6640 ndi_devi_exit(pdip, circ);
6641 if (vdip)
6642 ndi_devi_exit(vdip, v_circ);
6644 return (rval);
6648 * Find the child dev_info node of parent nexus 'p' whose unit address
6649 * matches "cname@caddr". Recommend use of ndi_devi_findchild() instead.
6651 dev_info_t *
6652 ndi_devi_find(dev_info_t *pdip, char *cname, char *caddr)
6654 dev_info_t *child;
6655 int circ;
6657 if (pdip == NULL || cname == NULL || caddr == NULL)
6658 return ((dev_info_t *)NULL);
6660 ndi_devi_enter(pdip, &circ);
6661 child = find_sibling(ddi_get_child(pdip), cname, caddr,
6662 FIND_NODE_BY_NODENAME, NULL);
6663 ndi_devi_exit(pdip, circ);
6664 return (child);
6668 * Find the child dev_info node of parent nexus 'p' whose unit address
6669 * matches devname "name@addr". Permits caller to hold the parent.
6671 dev_info_t *
6672 ndi_devi_findchild(dev_info_t *pdip, char *devname)
6674 dev_info_t *child;
6675 char *cname, *caddr;
6676 char *devstr;
6678 ASSERT(DEVI_BUSY_OWNED(pdip));
6680 devstr = i_ddi_strdup(devname, KM_SLEEP);
6681 i_ddi_parse_name(devstr, &cname, &caddr, NULL);
6683 if (cname == NULL || caddr == NULL) {
6684 kmem_free(devstr, strlen(devname)+1);
6685 return ((dev_info_t *)NULL);
6688 child = find_sibling(ddi_get_child(pdip), cname, caddr,
6689 FIND_NODE_BY_NODENAME, NULL);
6690 kmem_free(devstr, strlen(devname)+1);
6691 return (child);
6695 * Misc. routines called by framework only
6699 * Clear the DEVI_MADE_CHILDREN/DEVI_ATTACHED_CHILDREN flags
6700 * if new child spec has been added.
6702 static int
6703 reset_nexus_flags(dev_info_t *dip, void *arg)
6705 struct hwc_spec *list;
6706 int circ;
6708 if (((DEVI(dip)->devi_flags & DEVI_MADE_CHILDREN) == 0) ||
6709 ((list = hwc_get_child_spec(dip, (major_t)(uintptr_t)arg)) == NULL))
6710 return (DDI_WALK_CONTINUE);
6712 hwc_free_spec_list(list);
6714 /* coordinate child state update */
6715 ndi_devi_enter(dip, &circ);
6716 mutex_enter(&DEVI(dip)->devi_lock);
6717 DEVI(dip)->devi_flags &= ~(DEVI_MADE_CHILDREN | DEVI_ATTACHED_CHILDREN);
6718 mutex_exit(&DEVI(dip)->devi_lock);
6719 ndi_devi_exit(dip, circ);
6721 return (DDI_WALK_CONTINUE);
6725 * Helper functions, returns NULL if no memory.
6729 * path_to_major:
6731 * Return an alternate driver name binding for the leaf device
6732 * of the given pathname, if there is one. The purpose of this
6733 * function is to deal with generic pathnames. The default action
6734 * for platforms that can't do this (ie: x86 or any platform that
6735 * does not have prom_finddevice functionality, which matches
6736 * nodenames and unit-addresses without the drivers participation)
6737 * is to return DDI_MAJOR_T_NONE.
6739 * Used in loadrootmodules() in the swapgeneric module to
6740 * associate a given pathname with a given leaf driver.
6743 major_t
6744 path_to_major(char *path)
6746 dev_info_t *dip;
6747 char *p, *q;
6748 pnode_t nodeid;
6749 major_t major;
6751 /* check for path-oriented alias */
6752 major = ddi_name_to_major(path);
6753 if (driver_active(major)) {
6754 NDI_CONFIG_DEBUG((CE_NOTE, "path_to_major: %s path bound %s\n",
6755 path, ddi_major_to_name(major)));
6756 return (major);
6760 * Get the nodeid of the given pathname, if such a mapping exists.
6762 dip = NULL;
6763 nodeid = prom_finddevice(path);
6764 if (nodeid != OBP_BADNODE) {
6766 * Find the nodeid in our copy of the device tree and return
6767 * whatever name we used to bind this node to a driver.
6769 dip = e_ddi_nodeid_to_dip(nodeid);
6772 if (dip == NULL) {
6773 NDI_CONFIG_DEBUG((CE_WARN,
6774 "path_to_major: can't bind <%s>\n", path));
6775 return (DDI_MAJOR_T_NONE);
6779 * If we're bound to something other than the nodename,
6780 * note that in the message buffer and system log.
6782 p = ddi_binding_name(dip);
6783 q = ddi_node_name(dip);
6784 if (p && q && (strcmp(p, q) != 0))
6785 NDI_CONFIG_DEBUG((CE_NOTE, "path_to_major: %s bound to %s\n",
6786 path, p));
6788 major = ddi_name_to_major(p);
6790 ndi_rele_devi(dip); /* release e_ddi_nodeid_to_dip hold */
6792 return (major);
6796 * Return the held dip for the specified major and instance, attempting to do
6797 * an attach if specified. Return NULL if the devi can't be found or put in
6798 * the proper state. The caller must release the hold via ddi_release_devi if
6799 * a non-NULL value is returned.
6801 * Some callers expect to be able to perform a hold_devi() while in a context
6802 * where using ndi_devi_enter() to ensure the hold might cause deadlock (see
6803 * open-from-attach code in consconfig_dacf.c). Such special-case callers
6804 * must ensure that an ndi_devi_enter(parent)/ndi_hold_devi() from a safe
6805 * context is already active. The hold_devi() implementation must accommodate
6806 * these callers.
6808 static dev_info_t *
6809 hold_devi(major_t major, int instance, int flags)
6811 struct devnames *dnp;
6812 dev_info_t *dip;
6813 char *path;
6814 char *vpath;
6816 if ((major >= devcnt) || (instance == -1))
6817 return (NULL);
6819 /* try to find the instance in the per driver list */
6820 dnp = &(devnamesp[major]);
6821 LOCK_DEV_OPS(&(dnp->dn_lock));
6822 for (dip = dnp->dn_head; dip;
6823 dip = (dev_info_t *)DEVI(dip)->devi_next) {
6824 /* skip node if instance field is not valid */
6825 if (i_ddi_node_state(dip) < DS_INITIALIZED)
6826 continue;
6828 /* look for instance match */
6829 if (DEVI(dip)->devi_instance == instance) {
6831 * To accommodate callers that can't block in
6832 * ndi_devi_enter() we do an ndi_hold_devi(), and
6833 * afterwards check that the node is in a state where
6834 * the hold prevents detach(). If we did not manage to
6835 * prevent detach then we ndi_rele_devi() and perform
6836 * the slow path below (which can result in a blocking
6837 * ndi_devi_enter() while driving attach top-down).
6838 * This code depends on the ordering of
6839 * DEVI_SET_DETACHING and the devi_ref check in the
6840 * detach_node() code path.
6842 ndi_hold_devi(dip);
6843 if (i_ddi_devi_attached(dip) &&
6844 !DEVI_IS_DETACHING(dip)) {
6845 UNLOCK_DEV_OPS(&(dnp->dn_lock));
6846 return (dip); /* fast-path with devi held */
6848 ndi_rele_devi(dip);
6850 /* try slow-path */
6851 dip = NULL;
6852 break;
6855 ASSERT(dip == NULL);
6856 UNLOCK_DEV_OPS(&(dnp->dn_lock));
6858 if (flags & E_DDI_HOLD_DEVI_NOATTACH)
6859 return (NULL); /* told not to drive attach */
6861 /* slow-path may block, so it should not occur from interrupt */
6862 ASSERT(!servicing_interrupt());
6863 if (servicing_interrupt())
6864 return (NULL);
6866 /* reconstruct the path and drive attach by path through devfs. */
6867 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
6868 if (e_ddi_majorinstance_to_path(major, instance, path) == 0) {
6869 dip = e_ddi_hold_devi_by_path(path, flags);
6872 * Verify that we got the correct device - a path_to_inst file
6873 * with a bogus/corrupt path (or a nexus that changes its
6874 * unit-address format) could result in an incorrect answer
6876 * Verify major, instance, and path.
6878 vpath = kmem_alloc(MAXPATHLEN, KM_SLEEP);
6879 if (dip &&
6880 ((DEVI(dip)->devi_major != major) ||
6881 ((DEVI(dip)->devi_instance != instance)) ||
6882 (strcmp(path, ddi_pathname(dip, vpath)) != 0))) {
6883 ndi_rele_devi(dip);
6884 dip = NULL; /* no answer better than wrong answer */
6886 kmem_free(vpath, MAXPATHLEN);
6888 kmem_free(path, MAXPATHLEN);
6889 return (dip); /* with devi held */
6893 * The {e_}ddi_hold_devi{_by_{instance|dev|path}} hold the devinfo node
6894 * associated with the specified arguments. This hold should be released
6895 * by calling ddi_release_devi.
6897 * The E_DDI_HOLD_DEVI_NOATTACH flag argument allows the caller to to specify
6898 * a failure return if the node is not already attached.
6900 * NOTE: by the time we make e_ddi_hold_devi public, we should be able to reuse
6901 * ddi_hold_devi again.
6903 dev_info_t *
6904 ddi_hold_devi_by_instance(major_t major, int instance, int flags)
6906 return (hold_devi(major, instance, flags));
6909 dev_info_t *
6910 e_ddi_hold_devi_by_dev(dev_t dev, int flags)
6912 major_t major = getmajor(dev);
6913 dev_info_t *dip;
6914 struct dev_ops *ops;
6915 dev_info_t *ddip = NULL;
6917 dip = hold_devi(major, dev_to_instance(dev), flags);
6920 * The rest of this routine is legacy support for drivers that
6921 * have broken DDI_INFO_DEVT2INSTANCE implementations but may have
6922 * functional DDI_INFO_DEVT2DEVINFO implementations. This code will
6923 * diagnose inconsistency and, for maximum compatibility with legacy
6924 * drivers, give preference to the drivers DDI_INFO_DEVT2DEVINFO
6925 * implementation over the above derived dip based the driver's
6926 * DDI_INFO_DEVT2INSTANCE implementation. This legacy support should
6927 * be removed when DDI_INFO_DEVT2DEVINFO is deprecated.
6929 * NOTE: The following code has a race condition. DEVT2DEVINFO
6930 * returns a dip which is not held. By the time we ref ddip,
6931 * it could have been freed. The saving grace is that for
6932 * most drivers, the dip returned from hold_devi() is the
6933 * same one as the one returned by DEVT2DEVINFO, so we are
6934 * safe for drivers with the correct getinfo(9e) impl.
6936 if (((ops = ddi_hold_driver(major)) != NULL) &&
6937 CB_DRV_INSTALLED(ops) && ops->devo_getinfo) {
6938 if ((*ops->devo_getinfo)(NULL, DDI_INFO_DEVT2DEVINFO,
6939 (void *)dev, (void **)&ddip) != DDI_SUCCESS)
6940 ddip = NULL;
6943 /* give preference to the driver returned DEVT2DEVINFO dip */
6944 if (ddip && (dip != ddip)) {
6945 #ifdef DEBUG
6946 cmn_err(CE_WARN, "%s: inconsistent getinfo(9E) implementation",
6947 ddi_driver_name(ddip));
6948 #endif /* DEBUG */
6949 ndi_hold_devi(ddip);
6950 if (dip)
6951 ndi_rele_devi(dip);
6952 dip = ddip;
6955 if (ops)
6956 ddi_rele_driver(major);
6958 return (dip);
6962 * For compatibility only. Do not call this function!
6964 dev_info_t *
6965 e_ddi_get_dev_info(dev_t dev, vtype_t type)
6967 dev_info_t *dip = NULL;
6968 if (getmajor(dev) >= devcnt)
6969 return (NULL);
6971 switch (type) {
6972 case VCHR:
6973 case VBLK:
6974 dip = e_ddi_hold_devi_by_dev(dev, 0);
6975 default:
6976 break;
6980 * For compatibility reasons, we can only return the dip with
6981 * the driver ref count held. This is not a safe thing to do.
6982 * For certain broken third-party software, we are willing
6983 * to venture into unknown territory.
6985 if (dip) {
6986 (void) ndi_hold_driver(dip);
6987 ndi_rele_devi(dip);
6989 return (dip);
6992 dev_info_t *
6993 e_ddi_hold_devi_by_path(char *path, int flags)
6995 dev_info_t *dip;
6997 /* can't specify NOATTACH by path */
6998 ASSERT(!(flags & E_DDI_HOLD_DEVI_NOATTACH));
7000 return (resolve_pathname(path, &dip, NULL, NULL) ? NULL : dip);
7003 void
7004 e_ddi_hold_devi(dev_info_t *dip)
7006 ndi_hold_devi(dip);
7009 void
7010 ddi_release_devi(dev_info_t *dip)
7012 ndi_rele_devi(dip);
7016 * Associate a streams queue with a devinfo node
7017 * NOTE: This function is called by STREAM driver's put procedure.
7018 * It cannot block.
7020 void
7021 ddi_assoc_queue_with_devi(queue_t *q, dev_info_t *dip)
7023 queue_t *rq = _RD(q);
7024 struct stdata *stp;
7025 vnode_t *vp;
7027 /* set flag indicating that ddi_assoc_queue_with_devi was called */
7028 mutex_enter(QLOCK(rq));
7029 rq->q_flag |= _QASSOCIATED;
7030 mutex_exit(QLOCK(rq));
7032 /* get the vnode associated with the queue */
7033 stp = STREAM(rq);
7034 vp = stp->sd_vnode;
7035 ASSERT(vp);
7037 /* change the hardware association of the vnode */
7038 spec_assoc_vp_with_devi(vp, dip);
7042 * ddi_install_driver(name)
7044 * Driver installation is currently a byproduct of driver loading. This
7045 * may change.
7048 ddi_install_driver(char *name)
7050 major_t major = ddi_name_to_major(name);
7052 if ((major == DDI_MAJOR_T_NONE) ||
7053 (ddi_hold_installed_driver(major) == NULL)) {
7054 return (DDI_FAILURE);
7056 ddi_rele_driver(major);
7057 return (DDI_SUCCESS);
7060 struct dev_ops *
7061 ddi_hold_driver(major_t major)
7063 return (mod_hold_dev_by_major(major));
7067 void
7068 ddi_rele_driver(major_t major)
7070 mod_rele_dev_by_major(major);
7075 * This is called during boot to force attachment order of special dips
7076 * dip must be referenced via ndi_hold_devi()
7079 i_ddi_attach_node_hierarchy(dev_info_t *dip)
7081 dev_info_t *parent;
7082 int ret, circ;
7085 * Recurse up until attached parent is found.
7087 if (i_ddi_devi_attached(dip))
7088 return (DDI_SUCCESS);
7089 parent = ddi_get_parent(dip);
7090 if (i_ddi_attach_node_hierarchy(parent) != DDI_SUCCESS)
7091 return (DDI_FAILURE);
7094 * Come top-down, expanding .conf nodes under this parent
7095 * and driving attach.
7097 ndi_devi_enter(parent, &circ);
7098 (void) i_ndi_make_spec_children(parent, 0);
7099 ret = i_ddi_attachchild(dip);
7100 ndi_devi_exit(parent, circ);
7102 return (ret);
7105 /* keep this function static */
7106 static int
7107 attach_driver_nodes(major_t major)
7109 struct devnames *dnp;
7110 dev_info_t *dip;
7111 int error = DDI_FAILURE;
7113 dnp = &devnamesp[major];
7114 LOCK_DEV_OPS(&dnp->dn_lock);
7115 dip = dnp->dn_head;
7116 while (dip) {
7117 ndi_hold_devi(dip);
7118 UNLOCK_DEV_OPS(&dnp->dn_lock);
7119 if (i_ddi_attach_node_hierarchy(dip) == DDI_SUCCESS)
7120 error = DDI_SUCCESS;
7122 * Set the 'ddi-config-driver-node' property on a nexus
7123 * node to cause attach_driver_nodes() to configure all
7124 * immediate children of the nexus. This property should
7125 * be set on nodes with immediate children that bind to
7126 * the same driver as parent.
7128 if ((error == DDI_SUCCESS) && (ddi_prop_exists(DDI_DEV_T_ANY,
7129 dip, DDI_PROP_DONTPASS, "ddi-config-driver-node"))) {
7130 (void) ndi_devi_config(dip, NDI_NO_EVENT);
7132 LOCK_DEV_OPS(&dnp->dn_lock);
7133 ndi_rele_devi(dip);
7134 dip = ddi_get_next(dip);
7136 if (error == DDI_SUCCESS)
7137 dnp->dn_flags |= DN_NO_AUTODETACH;
7138 UNLOCK_DEV_OPS(&dnp->dn_lock);
7141 return (error);
7145 * i_ddi_attach_hw_nodes configures and attaches all hw nodes
7146 * bound to a specific driver. This function replaces calls to
7147 * ddi_hold_installed_driver() for drivers with no .conf
7148 * enumerated nodes.
7150 * This facility is typically called at boot time to attach
7151 * platform-specific hardware nodes, such as ppm nodes on xcal
7152 * and grover and keyswitch nodes on cherrystone. It does not
7153 * deal with .conf enumerated node. Calling it beyond the boot
7154 * process is strongly discouraged.
7157 i_ddi_attach_hw_nodes(char *driver)
7159 major_t major;
7161 major = ddi_name_to_major(driver);
7162 if (major == DDI_MAJOR_T_NONE)
7163 return (DDI_FAILURE);
7165 return (attach_driver_nodes(major));
7169 * i_ddi_attach_pseudo_node configures pseudo drivers which
7170 * has a single node. The .conf nodes must be enumerated
7171 * before calling this interface. The dip is held attached
7172 * upon returning.
7174 * This facility should only be called only at boot time
7175 * by the I/O framework.
7177 dev_info_t *
7178 i_ddi_attach_pseudo_node(char *driver)
7180 major_t major;
7181 dev_info_t *dip;
7183 major = ddi_name_to_major(driver);
7184 if (major == DDI_MAJOR_T_NONE)
7185 return (NULL);
7187 if (attach_driver_nodes(major) != DDI_SUCCESS)
7188 return (NULL);
7190 dip = devnamesp[major].dn_head;
7191 ASSERT(dip && ddi_get_next(dip) == NULL);
7192 ndi_hold_devi(dip);
7193 return (dip);
7196 static void
7197 diplist_to_parent_major(dev_info_t *head, char parents[])
7199 major_t major;
7200 dev_info_t *dip, *pdip;
7202 for (dip = head; dip != NULL; dip = ddi_get_next(dip)) {
7203 pdip = ddi_get_parent(dip);
7204 ASSERT(pdip); /* disallow rootnex.conf nodes */
7205 major = ddi_driver_major(pdip);
7206 if ((major != DDI_MAJOR_T_NONE) && parents[major] == 0)
7207 parents[major] = 1;
7212 * Call ddi_hold_installed_driver() on each parent major
7213 * and invoke mt_config_driver() to attach child major.
7214 * This is part of the implementation of ddi_hold_installed_driver.
7216 static int
7217 attach_driver_by_parent(major_t child_major, char parents[])
7219 major_t par_major;
7220 struct mt_config_handle *hdl;
7221 int flags = NDI_DEVI_PERSIST | NDI_NO_EVENT;
7223 hdl = mt_config_init(NULL, NULL, flags, child_major, MT_CONFIG_OP,
7224 NULL);
7225 for (par_major = 0; par_major < devcnt; par_major++) {
7226 /* disallow recursion on the same driver */
7227 if (parents[par_major] == 0 || par_major == child_major)
7228 continue;
7229 if (ddi_hold_installed_driver(par_major) == NULL)
7230 continue;
7231 hdl->mtc_parmajor = par_major;
7232 mt_config_driver(hdl);
7233 ddi_rele_driver(par_major);
7235 (void) mt_config_fini(hdl);
7237 return (i_ddi_devs_attached(child_major));
7241 i_ddi_devs_attached(major_t major)
7243 dev_info_t *dip;
7244 struct devnames *dnp;
7245 int error = DDI_FAILURE;
7247 /* check for attached instances */
7248 dnp = &devnamesp[major];
7249 LOCK_DEV_OPS(&dnp->dn_lock);
7250 for (dip = dnp->dn_head; dip != NULL; dip = ddi_get_next(dip)) {
7251 if (i_ddi_devi_attached(dip)) {
7252 error = DDI_SUCCESS;
7253 break;
7256 UNLOCK_DEV_OPS(&dnp->dn_lock);
7258 return (error);
7262 i_ddi_minor_node_count(dev_info_t *ddip, const char *node_type)
7264 int circ;
7265 struct ddi_minor_data *dp;
7266 int count = 0;
7268 ndi_devi_enter(ddip, &circ);
7269 for (dp = DEVI(ddip)->devi_minor; dp != NULL; dp = dp->next) {
7270 if (strcmp(dp->ddm_node_type, node_type) == 0)
7271 count++;
7273 ndi_devi_exit(ddip, circ);
7274 return (count);
7278 * ddi_hold_installed_driver configures and attaches all
7279 * instances of the specified driver. To accomplish this
7280 * it configures and attaches all possible parents of
7281 * the driver, enumerated both in h/w nodes and in the
7282 * driver's .conf file.
7284 * NOTE: This facility is for compatibility purposes only and will
7285 * eventually go away. Its usage is strongly discouraged.
7287 static void
7288 enter_driver(struct devnames *dnp)
7290 mutex_enter(&dnp->dn_lock);
7291 ASSERT(dnp->dn_busy_thread != curthread);
7292 while (dnp->dn_flags & DN_DRIVER_BUSY)
7293 cv_wait(&dnp->dn_wait, &dnp->dn_lock);
7294 dnp->dn_flags |= DN_DRIVER_BUSY;
7295 dnp->dn_busy_thread = curthread;
7296 mutex_exit(&dnp->dn_lock);
7299 static void
7300 exit_driver(struct devnames *dnp)
7302 mutex_enter(&dnp->dn_lock);
7303 ASSERT(dnp->dn_busy_thread == curthread);
7304 dnp->dn_flags &= ~DN_DRIVER_BUSY;
7305 dnp->dn_busy_thread = NULL;
7306 cv_broadcast(&dnp->dn_wait);
7307 mutex_exit(&dnp->dn_lock);
7310 struct dev_ops *
7311 ddi_hold_installed_driver(major_t major)
7313 struct dev_ops *ops;
7314 struct devnames *dnp;
7315 char *parents;
7316 int error;
7318 ops = ddi_hold_driver(major);
7319 if (ops == NULL)
7320 return (NULL);
7323 * Return immediately if all the attach operations associated
7324 * with a ddi_hold_installed_driver() call have already been done.
7326 dnp = &devnamesp[major];
7327 enter_driver(dnp);
7328 ASSERT(driver_active(major));
7330 if (dnp->dn_flags & DN_DRIVER_HELD) {
7331 exit_driver(dnp);
7332 if (i_ddi_devs_attached(major) == DDI_SUCCESS)
7333 return (ops);
7334 ddi_rele_driver(major);
7335 return (NULL);
7338 LOCK_DEV_OPS(&dnp->dn_lock);
7339 dnp->dn_flags |= (DN_DRIVER_HELD | DN_NO_AUTODETACH);
7340 UNLOCK_DEV_OPS(&dnp->dn_lock);
7342 DCOMPATPRINTF((CE_CONT,
7343 "ddi_hold_installed_driver: %s\n", dnp->dn_name));
7346 * When the driver has no .conf children, it is sufficient
7347 * to attach existing nodes in the device tree. Nodes not
7348 * enumerated by the OBP are not attached.
7350 if (dnp->dn_pl == NULL) {
7351 if (attach_driver_nodes(major) == DDI_SUCCESS) {
7352 exit_driver(dnp);
7353 return (ops);
7355 exit_driver(dnp);
7356 ddi_rele_driver(major);
7357 return (NULL);
7361 * Driver has .conf nodes. We find all possible parents
7362 * and recursively all ddi_hold_installed_driver on the
7363 * parent driver; then we invoke ndi_config_driver()
7364 * on all possible parent node in parallel to speed up
7365 * performance.
7367 parents = kmem_zalloc(devcnt * sizeof (char), KM_SLEEP);
7369 LOCK_DEV_OPS(&dnp->dn_lock);
7370 /* find .conf parents */
7371 (void) impl_parlist_to_major(dnp->dn_pl, parents);
7372 /* find hw node parents */
7373 diplist_to_parent_major(dnp->dn_head, parents);
7374 UNLOCK_DEV_OPS(&dnp->dn_lock);
7376 error = attach_driver_by_parent(major, parents);
7377 kmem_free(parents, devcnt * sizeof (char));
7378 if (error == DDI_SUCCESS) {
7379 exit_driver(dnp);
7380 return (ops);
7383 exit_driver(dnp);
7384 ddi_rele_driver(major);
7385 return (NULL);
7389 * Default bus_config entry point for nexus drivers
7392 ndi_busop_bus_config(dev_info_t *pdip, uint_t flags, ddi_bus_config_op_t op,
7393 void *arg, dev_info_t **child, clock_t timeout)
7395 major_t major;
7398 * A timeout of 30 minutes or more is probably a mistake
7399 * This is intended to catch uses where timeout is in
7400 * the wrong units. timeout must be in units of ticks.
7402 ASSERT(timeout < SEC_TO_TICK(1800));
7404 major = DDI_MAJOR_T_NONE;
7405 switch (op) {
7406 case BUS_CONFIG_ONE:
7407 NDI_DEBUG(flags, (CE_CONT, "%s%d: bus config %s timeout=%ld\n",
7408 ddi_driver_name(pdip), ddi_get_instance(pdip),
7409 (char *)arg, timeout));
7410 return (devi_config_one(pdip, (char *)arg, child, flags,
7411 timeout));
7413 case BUS_CONFIG_DRIVER:
7414 major = (major_t)(uintptr_t)arg;
7415 /*FALLTHROUGH*/
7416 case BUS_CONFIG_ALL:
7417 NDI_DEBUG(flags, (CE_CONT, "%s%d: bus config timeout=%ld\n",
7418 ddi_driver_name(pdip), ddi_get_instance(pdip),
7419 timeout));
7420 if (timeout > 0) {
7421 NDI_DEBUG(flags, (CE_CONT,
7422 "%s%d: bus config all timeout=%ld\n",
7423 ddi_driver_name(pdip), ddi_get_instance(pdip),
7424 timeout));
7425 delay(timeout);
7427 return (config_immediate_children(pdip, flags, major));
7429 default:
7430 return (NDI_FAILURE);
7432 /*NOTREACHED*/
7436 * Default busop bus_unconfig handler for nexus drivers
7439 ndi_busop_bus_unconfig(dev_info_t *pdip, uint_t flags, ddi_bus_config_op_t op,
7440 void *arg)
7442 major_t major;
7444 major = DDI_MAJOR_T_NONE;
7445 switch (op) {
7446 case BUS_UNCONFIG_ONE:
7447 NDI_DEBUG(flags, (CE_CONT, "%s%d: bus unconfig %s\n",
7448 ddi_driver_name(pdip), ddi_get_instance(pdip),
7449 (char *)arg));
7450 return (devi_unconfig_one(pdip, (char *)arg, flags));
7452 case BUS_UNCONFIG_DRIVER:
7453 major = (major_t)(uintptr_t)arg;
7454 /*FALLTHROUGH*/
7455 case BUS_UNCONFIG_ALL:
7456 NDI_DEBUG(flags, (CE_CONT, "%s%d: bus unconfig all\n",
7457 ddi_driver_name(pdip), ddi_get_instance(pdip)));
7458 return (unconfig_immediate_children(pdip, NULL, flags, major));
7460 default:
7461 return (NDI_FAILURE);
7463 /*NOTREACHED*/
7467 * dummy functions to be removed
7469 void
7470 impl_rem_dev_props(dev_info_t *dip)
7472 _NOTE(ARGUNUSED(dip))
7473 /* do nothing */
7477 * Determine if a node is a leaf node. If not sure, return false (0).
7479 static int
7480 is_leaf_node(dev_info_t *dip)
7482 major_t major = ddi_driver_major(dip);
7484 if (major == DDI_MAJOR_T_NONE)
7485 return (0);
7487 return (devnamesp[major].dn_flags & DN_LEAF_DRIVER);
7491 * Multithreaded [un]configuration
7493 static struct mt_config_handle *
7494 mt_config_init(dev_info_t *pdip, dev_info_t **dipp, int flags,
7495 major_t major, int op, struct brevq_node **brevqp)
7497 struct mt_config_handle *hdl = kmem_alloc(sizeof (*hdl), KM_SLEEP);
7499 mutex_init(&hdl->mtc_lock, NULL, MUTEX_DEFAULT, NULL);
7500 cv_init(&hdl->mtc_cv, NULL, CV_DEFAULT, NULL);
7501 hdl->mtc_pdip = pdip;
7502 hdl->mtc_fdip = dipp;
7503 hdl->mtc_parmajor = DDI_MAJOR_T_NONE;
7504 hdl->mtc_flags = flags;
7505 hdl->mtc_major = major;
7506 hdl->mtc_thr_count = 0;
7507 hdl->mtc_op = op;
7508 hdl->mtc_error = 0;
7509 hdl->mtc_brevqp = brevqp;
7511 #ifdef DEBUG
7512 gethrestime(&hdl->start_time);
7513 hdl->total_time = 0;
7514 #endif /* DEBUG */
7516 return (hdl);
7519 #ifdef DEBUG
7520 static int
7521 time_diff_in_msec(timestruc_t start, timestruc_t end)
7523 int nsec, sec;
7525 sec = end.tv_sec - start.tv_sec;
7526 nsec = end.tv_nsec - start.tv_nsec;
7527 if (nsec < 0) {
7528 nsec += NANOSEC;
7529 sec -= 1;
7532 return (sec * (NANOSEC >> 20) + (nsec >> 20));
7535 #endif /* DEBUG */
7537 static int
7538 mt_config_fini(struct mt_config_handle *hdl)
7540 int rv;
7541 #ifdef DEBUG
7542 int real_time;
7543 timestruc_t end_time;
7544 #endif /* DEBUG */
7546 mutex_enter(&hdl->mtc_lock);
7547 while (hdl->mtc_thr_count > 0)
7548 cv_wait(&hdl->mtc_cv, &hdl->mtc_lock);
7549 rv = hdl->mtc_error;
7550 mutex_exit(&hdl->mtc_lock);
7552 #ifdef DEBUG
7553 gethrestime(&end_time);
7554 real_time = time_diff_in_msec(hdl->start_time, end_time);
7555 if ((ddidebug & DDI_MTCONFIG) && hdl->mtc_pdip)
7556 cmn_err(CE_NOTE,
7557 "config %s%d: total time %d msec, real time %d msec",
7558 ddi_driver_name(hdl->mtc_pdip),
7559 ddi_get_instance(hdl->mtc_pdip),
7560 hdl->total_time, real_time);
7561 #endif /* DEBUG */
7563 cv_destroy(&hdl->mtc_cv);
7564 mutex_destroy(&hdl->mtc_lock);
7565 kmem_free(hdl, sizeof (*hdl));
7567 return (rv);
7570 struct mt_config_data {
7571 struct mt_config_handle *mtc_hdl;
7572 dev_info_t *mtc_dip;
7573 major_t mtc_major;
7574 int mtc_flags;
7575 struct brevq_node *mtc_brn;
7576 struct mt_config_data *mtc_next;
7579 static void
7580 mt_config_thread(void *arg)
7582 struct mt_config_data *mcd = (struct mt_config_data *)arg;
7583 struct mt_config_handle *hdl = mcd->mtc_hdl;
7584 dev_info_t *dip = mcd->mtc_dip;
7585 dev_info_t *rdip, **dipp;
7586 major_t major = mcd->mtc_major;
7587 int flags = mcd->mtc_flags;
7588 int rv = 0;
7590 #ifdef DEBUG
7591 timestruc_t start_time, end_time;
7592 gethrestime(&start_time);
7593 #endif /* DEBUG */
7595 rdip = NULL;
7596 dipp = hdl->mtc_fdip ? &rdip : NULL;
7598 switch (hdl->mtc_op) {
7599 case MT_CONFIG_OP:
7600 rv = devi_config_common(dip, flags, major);
7601 break;
7602 case MT_UNCONFIG_OP:
7603 if (mcd->mtc_brn) {
7604 struct brevq_node *brevq = NULL;
7605 rv = devi_unconfig_common(dip, dipp, flags, major,
7606 &brevq);
7607 mcd->mtc_brn->brn_child = brevq;
7608 } else
7609 rv = devi_unconfig_common(dip, dipp, flags, major,
7610 NULL);
7611 break;
7614 mutex_enter(&hdl->mtc_lock);
7615 #ifdef DEBUG
7616 gethrestime(&end_time);
7617 hdl->total_time += time_diff_in_msec(start_time, end_time);
7618 #endif /* DEBUG */
7620 if ((rv != NDI_SUCCESS) && (hdl->mtc_error == 0)) {
7621 hdl->mtc_error = rv;
7622 #ifdef DEBUG
7623 if ((ddidebug & DDI_DEBUG) && (major != DDI_MAJOR_T_NONE)) {
7624 char *path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
7626 (void) ddi_pathname(dip, path);
7627 cmn_err(CE_NOTE, "mt_config_thread: "
7628 "op %d.%d.%x at %s failed %d",
7629 hdl->mtc_op, major, flags, path, rv);
7630 kmem_free(path, MAXPATHLEN);
7632 #endif /* DEBUG */
7635 if (hdl->mtc_fdip && *hdl->mtc_fdip == NULL) {
7636 *hdl->mtc_fdip = rdip;
7637 rdip = NULL;
7640 if (rdip) {
7641 ASSERT(rv != NDI_SUCCESS);
7642 ndi_rele_devi(rdip);
7645 ndi_rele_devi(dip);
7647 if (--hdl->mtc_thr_count == 0)
7648 cv_broadcast(&hdl->mtc_cv);
7649 mutex_exit(&hdl->mtc_lock);
7650 kmem_free(mcd, sizeof (*mcd));
7654 * Multi-threaded config/unconfig of child nexus
7656 static void
7657 mt_config_children(struct mt_config_handle *hdl)
7659 dev_info_t *pdip = hdl->mtc_pdip;
7660 major_t major = hdl->mtc_major;
7661 dev_info_t *dip;
7662 int circ;
7663 struct brevq_node *brn;
7664 struct mt_config_data *mcd_head = NULL;
7665 struct mt_config_data *mcd_tail = NULL;
7666 struct mt_config_data *mcd;
7667 #ifdef DEBUG
7668 timestruc_t end_time;
7670 /* Update total_time in handle */
7671 gethrestime(&end_time);
7672 hdl->total_time += time_diff_in_msec(hdl->start_time, end_time);
7673 #endif
7675 ndi_devi_enter(pdip, &circ);
7676 dip = ddi_get_child(pdip);
7677 while (dip) {
7678 if (hdl->mtc_op == MT_UNCONFIG_OP && hdl->mtc_brevqp &&
7679 !(DEVI_EVREMOVE(dip)) &&
7680 i_ddi_node_state(dip) >= DS_INITIALIZED) {
7682 * Enqueue this dip's deviname.
7683 * No need to hold a lock while enqueuing since this
7684 * is the only thread doing the enqueue and no one
7685 * walks the queue while we are in multithreaded
7686 * unconfiguration.
7688 brn = brevq_enqueue(hdl->mtc_brevqp, dip, NULL);
7689 } else
7690 brn = NULL;
7693 * Hold the child that we are processing so he does not get
7694 * removed. The corrisponding ndi_rele_devi() for children
7695 * that are not being skipped is done at the end of
7696 * mt_config_thread().
7698 ndi_hold_devi(dip);
7701 * skip leaf nodes and (for configure) nodes not
7702 * fully attached.
7704 if (is_leaf_node(dip) ||
7705 (hdl->mtc_op == MT_CONFIG_OP &&
7706 i_ddi_node_state(dip) < DS_READY)) {
7707 ndi_rele_devi(dip);
7708 dip = ddi_get_next_sibling(dip);
7709 continue;
7712 mcd = kmem_alloc(sizeof (*mcd), KM_SLEEP);
7713 mcd->mtc_dip = dip;
7714 mcd->mtc_hdl = hdl;
7715 mcd->mtc_brn = brn;
7718 * Switch a 'driver' operation to an 'all' operation below a
7719 * node bound to the driver.
7721 if ((major == DDI_MAJOR_T_NONE) ||
7722 (major == ddi_driver_major(dip)))
7723 mcd->mtc_major = DDI_MAJOR_T_NONE;
7724 else
7725 mcd->mtc_major = major;
7728 * The unconfig-driver to unconfig-all conversion above
7729 * constitutes an autodetach for NDI_DETACH_DRIVER calls,
7730 * set NDI_AUTODETACH.
7732 mcd->mtc_flags = hdl->mtc_flags;
7733 if ((mcd->mtc_flags & NDI_DETACH_DRIVER) &&
7734 (hdl->mtc_op == MT_UNCONFIG_OP) &&
7735 (major == ddi_driver_major(pdip)))
7736 mcd->mtc_flags |= NDI_AUTODETACH;
7738 mutex_enter(&hdl->mtc_lock);
7739 hdl->mtc_thr_count++;
7740 mutex_exit(&hdl->mtc_lock);
7743 * Add to end of list to process after ndi_devi_exit to avoid
7744 * locking differences depending on value of mtc_off.
7746 mcd->mtc_next = NULL;
7747 if (mcd_head == NULL)
7748 mcd_head = mcd;
7749 else
7750 mcd_tail->mtc_next = mcd;
7751 mcd_tail = mcd;
7753 dip = ddi_get_next_sibling(dip);
7755 ndi_devi_exit(pdip, circ);
7757 /* go through the list of held children */
7758 for (mcd = mcd_head; mcd; mcd = mcd_head) {
7759 mcd_head = mcd->mtc_next;
7760 if (mtc_off || (mcd->mtc_flags & NDI_MTC_OFF))
7761 mt_config_thread(mcd);
7762 else
7763 (void) thread_create(NULL, 0, mt_config_thread, mcd,
7764 0, &p0, TS_RUN, minclsyspri);
7768 static void
7769 mt_config_driver(struct mt_config_handle *hdl)
7771 major_t par_major = hdl->mtc_parmajor;
7772 major_t major = hdl->mtc_major;
7773 struct devnames *dnp = &devnamesp[par_major];
7774 dev_info_t *dip;
7775 struct mt_config_data *mcd_head = NULL;
7776 struct mt_config_data *mcd_tail = NULL;
7777 struct mt_config_data *mcd;
7778 #ifdef DEBUG
7779 timestruc_t end_time;
7781 /* Update total_time in handle */
7782 gethrestime(&end_time);
7783 hdl->total_time += time_diff_in_msec(hdl->start_time, end_time);
7784 #endif
7785 ASSERT(par_major != DDI_MAJOR_T_NONE);
7786 ASSERT(major != DDI_MAJOR_T_NONE);
7788 LOCK_DEV_OPS(&dnp->dn_lock);
7789 dip = devnamesp[par_major].dn_head;
7790 while (dip) {
7792 * Hold the child that we are processing so he does not get
7793 * removed. The corrisponding ndi_rele_devi() for children
7794 * that are not being skipped is done at the end of
7795 * mt_config_thread().
7797 ndi_hold_devi(dip);
7799 /* skip leaf nodes and nodes not fully attached */
7800 if (!i_ddi_devi_attached(dip) || is_leaf_node(dip)) {
7801 ndi_rele_devi(dip);
7802 dip = ddi_get_next(dip);
7803 continue;
7806 mcd = kmem_alloc(sizeof (*mcd), KM_SLEEP);
7807 mcd->mtc_dip = dip;
7808 mcd->mtc_hdl = hdl;
7809 mcd->mtc_major = major;
7810 mcd->mtc_flags = hdl->mtc_flags;
7812 mutex_enter(&hdl->mtc_lock);
7813 hdl->mtc_thr_count++;
7814 mutex_exit(&hdl->mtc_lock);
7817 * Add to end of list to process after UNLOCK_DEV_OPS to avoid
7818 * locking differences depending on value of mtc_off.
7820 mcd->mtc_next = NULL;
7821 if (mcd_head == NULL)
7822 mcd_head = mcd;
7823 else
7824 mcd_tail->mtc_next = mcd;
7825 mcd_tail = mcd;
7827 dip = ddi_get_next(dip);
7829 UNLOCK_DEV_OPS(&dnp->dn_lock);
7831 /* go through the list of held children */
7832 for (mcd = mcd_head; mcd; mcd = mcd_head) {
7833 mcd_head = mcd->mtc_next;
7834 if (mtc_off || (mcd->mtc_flags & NDI_MTC_OFF))
7835 mt_config_thread(mcd);
7836 else
7837 (void) thread_create(NULL, 0, mt_config_thread, mcd,
7838 0, &p0, TS_RUN, minclsyspri);
7843 * Given the nodeid for a persistent (PROM or SID) node, return
7844 * the corresponding devinfo node
7845 * NOTE: This function will return NULL for .conf nodeids.
7847 dev_info_t *
7848 e_ddi_nodeid_to_dip(pnode_t nodeid)
7850 dev_info_t *dip = NULL;
7851 struct devi_nodeid *prev, *elem;
7853 mutex_enter(&devimap->dno_lock);
7855 prev = NULL;
7856 for (elem = devimap->dno_head; elem; elem = elem->next) {
7857 if (elem->nodeid == nodeid) {
7858 ndi_hold_devi(elem->dip);
7859 dip = elem->dip;
7860 break;
7862 prev = elem;
7866 * Move to head for faster lookup next time
7868 if (elem && prev) {
7869 prev->next = elem->next;
7870 elem->next = devimap->dno_head;
7871 devimap->dno_head = elem;
7874 mutex_exit(&devimap->dno_lock);
7875 return (dip);
7878 static void
7879 free_cache_task(void *arg)
7881 ASSERT(arg == NULL);
7883 mutex_enter(&di_cache.cache_lock);
7886 * The cache can be invalidated without holding the lock
7887 * but it can be made valid again only while the lock is held.
7888 * So if the cache is invalid when the lock is held, it will
7889 * stay invalid until lock is released.
7891 if (!di_cache.cache_valid)
7892 i_ddi_di_cache_free(&di_cache);
7894 mutex_exit(&di_cache.cache_lock);
7896 if (di_cache_debug)
7897 cmn_err(CE_NOTE, "system_taskq: di_cache freed");
7900 extern int modrootloaded;
7902 void
7903 i_ddi_di_cache_free(struct di_cache *cache)
7905 int error;
7906 extern int sys_shutdown;
7908 ASSERT(mutex_owned(&cache->cache_lock));
7910 if (cache->cache_size) {
7911 ASSERT(cache->cache_size > 0);
7912 ASSERT(cache->cache_data);
7914 kmem_free(cache->cache_data, cache->cache_size);
7915 cache->cache_data = NULL;
7916 cache->cache_size = 0;
7918 if (di_cache_debug)
7919 cmn_err(CE_NOTE, "i_ddi_di_cache_free: freed cachemem");
7920 } else {
7921 ASSERT(cache->cache_data == NULL);
7922 if (di_cache_debug)
7923 cmn_err(CE_NOTE, "i_ddi_di_cache_free: NULL cache");
7926 if (!modrootloaded || rootvp == NULL ||
7927 vn_is_readonly(rootvp) || sys_shutdown) {
7928 if (di_cache_debug) {
7929 cmn_err(CE_WARN, "/ not mounted/RDONLY. Skip unlink");
7931 return;
7934 error = vn_remove(DI_CACHE_FILE, UIO_SYSSPACE, RMFILE);
7935 if (di_cache_debug && error && error != ENOENT) {
7936 cmn_err(CE_WARN, "%s: unlink failed: %d", DI_CACHE_FILE, error);
7937 } else if (di_cache_debug && !error) {
7938 cmn_err(CE_NOTE, "i_ddi_di_cache_free: unlinked cache file");
7942 void
7943 i_ddi_di_cache_invalidate()
7945 int cache_valid;
7947 if (!modrootloaded || !i_ddi_io_initialized()) {
7948 if (di_cache_debug)
7949 cmn_err(CE_NOTE, "I/O not inited. Skipping invalidate");
7950 return;
7953 /* Increment devtree generation number. */
7954 atomic_inc_ulong(&devtree_gen);
7956 /* Invalidate the in-core cache and dispatch free on valid->invalid */
7957 cache_valid = atomic_swap_uint(&di_cache.cache_valid, 0);
7958 if (cache_valid) {
7960 * This is an optimization to start cleaning up a cached
7961 * snapshot early. For this reason, it is OK for
7962 * taskq_dispatach to fail (and it is OK to not track calling
7963 * context relative to sleep, and assume NOSLEEP).
7965 (void) taskq_dispatch(system_taskq, free_cache_task, NULL,
7966 TQ_NOSLEEP);
7969 if (di_cache_debug) {
7970 cmn_err(CE_NOTE, "invalidation");
7975 static void
7976 i_bind_vhci_node(dev_info_t *dip)
7978 DEVI(dip)->devi_major = ddi_name_to_major(ddi_node_name(dip));
7979 i_ddi_set_node_state(dip, DS_BOUND);
7982 static char vhci_node_addr[2];
7984 static int
7985 i_init_vhci_node(dev_info_t *dip)
7987 add_global_props(dip);
7988 DEVI(dip)->devi_ops = ndi_hold_driver(dip);
7989 if (DEVI(dip)->devi_ops == NULL)
7990 return (-1);
7992 DEVI(dip)->devi_instance = e_ddi_assign_instance(dip);
7993 e_ddi_keep_instance(dip);
7994 vhci_node_addr[0] = '\0';
7995 ddi_set_name_addr(dip, vhci_node_addr);
7996 i_ddi_set_node_state(dip, DS_INITIALIZED);
7997 return (0);
8000 static void
8001 i_link_vhci_node(dev_info_t *dip)
8003 ASSERT(MUTEX_HELD(&global_vhci_lock));
8006 * scsi_vhci should be kept left most of the device tree.
8008 if (scsi_vhci_dip) {
8009 DEVI(dip)->devi_sibling = DEVI(scsi_vhci_dip)->devi_sibling;
8010 DEVI(scsi_vhci_dip)->devi_sibling = DEVI(dip);
8011 } else {
8012 DEVI(dip)->devi_sibling = DEVI(top_devinfo)->devi_child;
8013 DEVI(top_devinfo)->devi_child = DEVI(dip);
8019 * This a special routine to enumerate vhci node (child of rootnex
8020 * node) without holding the ndi_devi_enter() lock. The device node
8021 * is allocated, initialized and brought into DS_READY state before
8022 * inserting into the device tree. The VHCI node is handcrafted
8023 * here to bring the node to DS_READY, similar to rootnex node.
8025 * The global_vhci_lock protects linking the node into the device
8026 * as same lock is held before linking/unlinking any direct child
8027 * of rootnex children.
8029 * This routine is a workaround to handle a possible deadlock
8030 * that occurs while trying to enumerate node in a different sub-tree
8031 * during _init/_attach entry points.
8033 /*ARGSUSED*/
8034 dev_info_t *
8035 ndi_devi_config_vhci(char *drvname, int flags)
8037 struct devnames *dnp;
8038 dev_info_t *dip;
8039 major_t major = ddi_name_to_major(drvname);
8041 if (major == -1)
8042 return (NULL);
8044 /* Make sure we create the VHCI node only once */
8045 dnp = &devnamesp[major];
8046 LOCK_DEV_OPS(&dnp->dn_lock);
8047 if (dnp->dn_head) {
8048 dip = dnp->dn_head;
8049 UNLOCK_DEV_OPS(&dnp->dn_lock);
8050 return (dip);
8052 UNLOCK_DEV_OPS(&dnp->dn_lock);
8054 /* Allocate the VHCI node */
8055 ndi_devi_alloc_sleep(top_devinfo, drvname, DEVI_SID_NODEID, &dip);
8056 ndi_hold_devi(dip);
8058 /* Mark the node as VHCI */
8059 DEVI(dip)->devi_node_attributes |= DDI_VHCI_NODE;
8061 i_ddi_add_devimap(dip);
8062 i_bind_vhci_node(dip);
8063 if (i_init_vhci_node(dip) == -1) {
8064 ndi_rele_devi(dip);
8065 (void) ndi_devi_free(dip);
8066 return (NULL);
8069 mutex_enter(&(DEVI(dip)->devi_lock));
8070 DEVI_SET_ATTACHING(dip);
8071 mutex_exit(&(DEVI(dip)->devi_lock));
8073 if (devi_attach(dip, DDI_ATTACH) != DDI_SUCCESS) {
8074 cmn_err(CE_CONT, "Could not attach %s driver", drvname);
8075 e_ddi_free_instance(dip, vhci_node_addr);
8076 ndi_rele_devi(dip);
8077 (void) ndi_devi_free(dip);
8078 return (NULL);
8080 mutex_enter(&(DEVI(dip)->devi_lock));
8081 DEVI_CLR_ATTACHING(dip);
8082 mutex_exit(&(DEVI(dip)->devi_lock));
8084 mutex_enter(&global_vhci_lock);
8085 i_link_vhci_node(dip);
8086 mutex_exit(&global_vhci_lock);
8087 i_ddi_set_node_state(dip, DS_READY);
8089 LOCK_DEV_OPS(&dnp->dn_lock);
8090 dnp->dn_flags |= DN_DRIVER_HELD;
8091 dnp->dn_head = dip;
8092 UNLOCK_DEV_OPS(&dnp->dn_lock);
8094 i_ndi_devi_report_status_change(dip, NULL);
8096 return (dip);
8100 * Maintain DEVI_DEVICE_REMOVED hotplug devi_state for remove/reinsert hotplug
8101 * of open devices. Currently, because of tight coupling between the devfs file
8102 * system and the Solaris device tree, a driver can't always make the device
8103 * tree state (esp devi_node_state) match device hardware hotplug state. Until
8104 * resolved, to overcome this deficiency we use the following interfaces that
8105 * maintain the DEVI_DEVICE_REMOVED devi_state status bit. These interface
8106 * report current state, and drive operation (like events and cache
8107 * invalidation) when a driver changes remove/insert state of an open device.
8109 * The ndi_devi_device_isremoved() returns 1 if the device is currently removed.
8111 * The ndi_devi_device_remove() interface declares the device as removed, and
8112 * returns 1 if there was a state change associated with this declaration.
8114 * The ndi_devi_device_insert() declares the device as inserted, and returns 1
8115 * if there was a state change associated with this declaration.
8118 ndi_devi_device_isremoved(dev_info_t *dip)
8120 return (DEVI_IS_DEVICE_REMOVED(dip));
8124 ndi_devi_device_remove(dev_info_t *dip)
8126 ASSERT(dip && ddi_get_parent(dip) &&
8127 DEVI_BUSY_OWNED(ddi_get_parent(dip)));
8129 /* Return if already marked removed. */
8130 if (ndi_devi_device_isremoved(dip))
8131 return (0);
8133 /* Mark the device as having been physically removed. */
8134 mutex_enter(&(DEVI(dip)->devi_lock));
8135 ndi_devi_set_hidden(dip); /* invisible: lookup/snapshot */
8136 DEVI_SET_DEVICE_REMOVED(dip);
8137 DEVI_SET_EVREMOVE(dip); /* this clears EVADD too */
8138 mutex_exit(&(DEVI(dip)->devi_lock));
8140 /* report remove (as 'removed') */
8141 i_ndi_devi_report_status_change(dip, NULL);
8144 * Invalidate the cache to ensure accurate
8145 * (di_state() & DI_DEVICE_REMOVED).
8147 i_ddi_di_cache_invalidate();
8150 * Generate sysevent for those interested in removal (either
8151 * directly via private EC_DEVFS or indirectly via devfsadmd
8152 * generated EC_DEV). This will generate LDI DEVICE_REMOVE
8153 * event too.
8155 i_ddi_log_devfs_device_remove(dip);
8157 return (1); /* DEVICE_REMOVED state changed */
8161 ndi_devi_device_insert(dev_info_t *dip)
8163 ASSERT(dip && ddi_get_parent(dip) &&
8164 DEVI_BUSY_OWNED(ddi_get_parent(dip)));
8166 /* Return if not marked removed. */
8167 if (!ndi_devi_device_isremoved(dip))
8168 return (0);
8170 /* Mark the device as having been physically reinserted. */
8171 mutex_enter(&(DEVI(dip)->devi_lock));
8172 ndi_devi_clr_hidden(dip); /* visible: lookup/snapshot */
8173 DEVI_SET_DEVICE_REINSERTED(dip);
8174 DEVI_SET_EVADD(dip); /* this clears EVREMOVE too */
8175 mutex_exit(&(DEVI(dip)->devi_lock));
8177 /* report insert (as 'online') */
8178 i_ndi_devi_report_status_change(dip, NULL);
8181 * Invalidate the cache to ensure accurate
8182 * (di_state() & DI_DEVICE_REMOVED).
8184 i_ddi_di_cache_invalidate();
8187 * Generate sysevent for those interested in removal (either directly
8188 * via EC_DEVFS or indirectly via devfsadmd generated EC_DEV).
8190 i_ddi_log_devfs_device_insert(dip);
8192 return (1); /* DEVICE_REMOVED state changed */
8196 * ibt_hw_is_present() returns 0 when there is no IB hardware actively
8197 * running. This is primarily useful for modules like rpcmod which
8198 * needs a quick check to decide whether or not it should try to use
8199 * InfiniBand
8201 int ib_hw_status = 0;
8203 ibt_hw_is_present()
8205 return (ib_hw_status);
8209 * ASSERT that constraint flag is not set and then set the "retire attempt"
8210 * flag.
8213 e_ddi_mark_retiring(dev_info_t *dip, void *arg)
8215 char **cons_array = (char **)arg;
8216 char *path;
8217 int constraint;
8218 int i;
8220 constraint = 0;
8221 if (cons_array) {
8222 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
8223 (void) ddi_pathname(dip, path);
8224 for (i = 0; cons_array[i] != NULL; i++) {
8225 if (strcmp(path, cons_array[i]) == 0) {
8226 constraint = 1;
8227 break;
8230 kmem_free(path, MAXPATHLEN);
8233 mutex_enter(&DEVI(dip)->devi_lock);
8234 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT));
8235 DEVI(dip)->devi_flags |= DEVI_RETIRING;
8236 if (constraint)
8237 DEVI(dip)->devi_flags |= DEVI_R_CONSTRAINT;
8238 mutex_exit(&DEVI(dip)->devi_lock);
8240 RIO_VERBOSE((CE_NOTE, "marked dip as undergoing retire process dip=%p",
8241 (void *)dip));
8243 if (constraint)
8244 RIO_DEBUG((CE_NOTE, "marked dip as constrained, dip=%p",
8245 (void *)dip));
8247 if (MDI_PHCI(dip))
8248 mdi_phci_mark_retiring(dip, cons_array);
8250 return (DDI_WALK_CONTINUE);
8253 static void
8254 free_array(char **cons_array)
8256 int i;
8258 if (cons_array == NULL)
8259 return;
8261 for (i = 0; cons_array[i] != NULL; i++) {
8262 kmem_free(cons_array[i], strlen(cons_array[i]) + 1);
8264 kmem_free(cons_array, (i+1) * sizeof (char *));
8268 * Walk *every* node in subtree and check if it blocks, allows or has no
8269 * comment on a proposed retire.
8272 e_ddi_retire_notify(dev_info_t *dip, void *arg)
8274 int *constraint = (int *)arg;
8276 RIO_DEBUG((CE_NOTE, "retire notify: dip = %p", (void *)dip));
8278 (void) e_ddi_offline_notify(dip);
8280 mutex_enter(&(DEVI(dip)->devi_lock));
8281 if (!(DEVI(dip)->devi_flags & DEVI_RETIRING)) {
8282 RIO_DEBUG((CE_WARN, "retire notify: dip in retire "
8283 "subtree is not marked: dip = %p", (void *)dip));
8284 *constraint = 0;
8285 } else if (DEVI(dip)->devi_flags & DEVI_R_BLOCKED) {
8286 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT));
8287 RIO_DEBUG((CE_NOTE, "retire notify: BLOCKED: dip = %p",
8288 (void *)dip));
8289 *constraint = 0;
8290 } else if (!(DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT)) {
8291 RIO_DEBUG((CE_NOTE, "retire notify: NO CONSTRAINT: "
8292 "dip = %p", (void *)dip));
8293 *constraint = 0;
8294 } else {
8295 RIO_DEBUG((CE_NOTE, "retire notify: CONSTRAINT set: "
8296 "dip = %p", (void *)dip));
8298 mutex_exit(&DEVI(dip)->devi_lock);
8300 if (MDI_PHCI(dip))
8301 mdi_phci_retire_notify(dip, constraint);
8303 return (DDI_WALK_CONTINUE);
8307 e_ddi_retire_finalize(dev_info_t *dip, void *arg)
8309 int constraint = *(int *)arg;
8310 int finalize;
8311 int phci_only;
8313 mutex_enter(&DEVI(dip)->devi_lock);
8314 if (!(DEVI(dip)->devi_flags & DEVI_RETIRING)) {
8315 RIO_DEBUG((CE_WARN,
8316 "retire: unmarked dip(%p) in retire subtree",
8317 (void *)dip));
8318 ASSERT(!(DEVI(dip)->devi_flags & DEVI_RETIRED));
8319 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT));
8320 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_BLOCKED));
8321 mutex_exit(&DEVI(dip)->devi_lock);
8322 return (DDI_WALK_CONTINUE);
8326 * retire the device if constraints have been applied
8327 * or if the device is not in use
8329 finalize = 0;
8330 if (constraint) {
8331 ASSERT(DEVI_BUSY_OWNED(ddi_get_parent(dip)));
8333 ASSERT(DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT);
8334 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_BLOCKED));
8335 DEVI(dip)->devi_flags &= ~DEVI_R_CONSTRAINT;
8336 DEVI(dip)->devi_flags &= ~DEVI_RETIRING;
8337 DEVI(dip)->devi_flags |= DEVI_RETIRED;
8338 mutex_exit(&DEVI(dip)->devi_lock);
8339 (void) spec_fence_snode(dip, NULL);
8340 RIO_DEBUG((CE_NOTE, "Fenced off: dip = %p", (void *)dip));
8341 e_ddi_offline_finalize(dip, DDI_SUCCESS);
8342 } else {
8343 if (DEVI(dip)->devi_flags & DEVI_R_BLOCKED) {
8344 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT));
8345 DEVI(dip)->devi_flags &= ~DEVI_R_BLOCKED;
8346 DEVI(dip)->devi_flags &= ~DEVI_RETIRING;
8347 /* we have already finalized during notify */
8348 } else if (DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT) {
8349 DEVI(dip)->devi_flags &= ~DEVI_R_CONSTRAINT;
8350 DEVI(dip)->devi_flags &= ~DEVI_RETIRING;
8351 finalize = 1;
8352 } else {
8353 DEVI(dip)->devi_flags &= ~DEVI_RETIRING;
8355 * even if no contracts, need to call finalize
8356 * to clear the contract barrier on the dip
8358 finalize = 1;
8360 mutex_exit(&DEVI(dip)->devi_lock);
8361 RIO_DEBUG((CE_NOTE, "finalize: NOT retired: dip = %p",
8362 (void *)dip));
8363 if (finalize)
8364 e_ddi_offline_finalize(dip, DDI_FAILURE);
8368 * phci_only variable indicates no client checking, just
8369 * offline the PHCI. We set that to 0 to enable client
8370 * checking
8372 phci_only = 0;
8373 if (MDI_PHCI(dip))
8374 mdi_phci_retire_finalize(dip, phci_only, arg);
8376 return (DDI_WALK_CONTINUE);
8380 * Returns
8381 * DDI_SUCCESS if constraints allow retire
8382 * DDI_FAILURE if constraints don't allow retire.
8383 * cons_array is a NULL terminated array of node paths for
8384 * which constraints have already been applied.
8387 e_ddi_retire_device(char *path, char **cons_array)
8389 dev_info_t *dip;
8390 dev_info_t *pdip;
8391 int circ;
8392 int circ2;
8393 int constraint;
8394 char *devnm;
8397 * First, lookup the device
8399 dip = e_ddi_hold_devi_by_path(path, 0);
8400 if (dip == NULL) {
8402 * device does not exist. This device cannot be
8403 * a critical device since it is not in use. Thus
8404 * this device is always retireable. Return DDI_SUCCESS
8405 * to indicate this. If this device is ever
8406 * instantiated, I/O framework will consult the
8407 * the persistent retire store, mark it as
8408 * retired and fence it off.
8410 RIO_DEBUG((CE_NOTE, "Retire device: device doesn't exist."
8411 " NOP. Just returning SUCCESS. path=%s", path));
8412 free_array(cons_array);
8413 return (DDI_SUCCESS);
8416 RIO_DEBUG((CE_NOTE, "Retire device: found dip = %p.", (void *)dip));
8418 pdip = ddi_get_parent(dip);
8419 ndi_hold_devi(pdip);
8422 * Run devfs_clean() in case dip has no constraints and is
8423 * not in use, so is retireable but there are dv_nodes holding
8424 * ref-count on the dip. Note that devfs_clean() always returns
8425 * success.
8427 devnm = kmem_alloc(MAXNAMELEN + 1, KM_SLEEP);
8428 (void) ddi_deviname(dip, devnm);
8429 (void) devfs_clean(pdip, devnm + 1, DV_CLEAN_FORCE);
8430 kmem_free(devnm, MAXNAMELEN + 1);
8432 ndi_devi_enter(pdip, &circ);
8434 /* release hold from e_ddi_hold_devi_by_path */
8435 ndi_rele_devi(dip);
8438 * If it cannot make a determination, is_leaf_node() assumes
8439 * dip is a nexus.
8441 (void) e_ddi_mark_retiring(dip, cons_array);
8442 if (!is_leaf_node(dip)) {
8443 ndi_devi_enter(dip, &circ2);
8444 ddi_walk_devs(ddi_get_child(dip), e_ddi_mark_retiring,
8445 cons_array);
8446 ndi_devi_exit(dip, circ2);
8448 free_array(cons_array);
8451 * apply constraints
8453 RIO_DEBUG((CE_NOTE, "retire: subtree retire notify: path = %s", path));
8455 constraint = 1; /* assume constraints allow retire */
8456 (void) e_ddi_retire_notify(dip, &constraint);
8457 if (!is_leaf_node(dip)) {
8458 ndi_devi_enter(dip, &circ2);
8459 ddi_walk_devs(ddi_get_child(dip), e_ddi_retire_notify,
8460 &constraint);
8461 ndi_devi_exit(dip, circ2);
8465 * Now finalize the retire
8467 (void) e_ddi_retire_finalize(dip, &constraint);
8468 if (!is_leaf_node(dip)) {
8469 ndi_devi_enter(dip, &circ2);
8470 ddi_walk_devs(ddi_get_child(dip), e_ddi_retire_finalize,
8471 &constraint);
8472 ndi_devi_exit(dip, circ2);
8475 if (!constraint) {
8476 RIO_DEBUG((CE_WARN, "retire failed: path = %s", path));
8477 } else {
8478 RIO_DEBUG((CE_NOTE, "retire succeeded: path = %s", path));
8481 ndi_devi_exit(pdip, circ);
8482 ndi_rele_devi(pdip);
8483 return (constraint ? DDI_SUCCESS : DDI_FAILURE);
8486 static int
8487 unmark_and_unfence(dev_info_t *dip, void *arg)
8489 char *path = (char *)arg;
8491 ASSERT(path);
8493 (void) ddi_pathname(dip, path);
8495 mutex_enter(&DEVI(dip)->devi_lock);
8496 DEVI(dip)->devi_flags &= ~DEVI_RETIRED;
8497 DEVI_SET_DEVICE_ONLINE(dip);
8498 mutex_exit(&DEVI(dip)->devi_lock);
8500 RIO_VERBOSE((CE_NOTE, "Cleared RETIRED flag: dip=%p, path=%s",
8501 (void *)dip, path));
8503 (void) spec_unfence_snode(dip);
8504 RIO_DEBUG((CE_NOTE, "Unfenced device: %s", path));
8506 if (MDI_PHCI(dip))
8507 mdi_phci_unretire(dip);
8509 return (DDI_WALK_CONTINUE);
8512 struct find_dip {
8513 char *fd_buf;
8514 char *fd_path;
8515 dev_info_t *fd_dip;
8518 static int
8519 find_dip_fcn(dev_info_t *dip, void *arg)
8521 struct find_dip *findp = (struct find_dip *)arg;
8523 (void) ddi_pathname(dip, findp->fd_buf);
8525 if (strcmp(findp->fd_path, findp->fd_buf) != 0)
8526 return (DDI_WALK_CONTINUE);
8528 ndi_hold_devi(dip);
8529 findp->fd_dip = dip;
8531 return (DDI_WALK_TERMINATE);
8535 e_ddi_unretire_device(char *path)
8537 int circ;
8538 int circ2;
8539 char *path2;
8540 dev_info_t *pdip;
8541 dev_info_t *dip;
8542 struct find_dip find_dip;
8544 ASSERT(path);
8545 ASSERT(*path == '/');
8547 if (strcmp(path, "/") == 0) {
8548 cmn_err(CE_WARN, "Root node cannot be retired. Skipping "
8549 "device unretire: %s", path);
8550 return (0);
8554 * We can't lookup the dip (corresponding to path) via
8555 * e_ddi_hold_devi_by_path() because the dip may be offline
8556 * and may not attach. Use ddi_walk_devs() instead;
8558 find_dip.fd_buf = kmem_alloc(MAXPATHLEN, KM_SLEEP);
8559 find_dip.fd_path = path;
8560 find_dip.fd_dip = NULL;
8562 pdip = ddi_root_node();
8564 ndi_devi_enter(pdip, &circ);
8565 ddi_walk_devs(ddi_get_child(pdip), find_dip_fcn, &find_dip);
8566 ndi_devi_exit(pdip, circ);
8568 kmem_free(find_dip.fd_buf, MAXPATHLEN);
8570 if (find_dip.fd_dip == NULL) {
8571 cmn_err(CE_WARN, "Device not found in device tree. Skipping "
8572 "device unretire: %s", path);
8573 return (0);
8576 dip = find_dip.fd_dip;
8578 pdip = ddi_get_parent(dip);
8580 ndi_hold_devi(pdip);
8582 ndi_devi_enter(pdip, &circ);
8584 path2 = kmem_alloc(MAXPATHLEN, KM_SLEEP);
8586 (void) unmark_and_unfence(dip, path2);
8587 if (!is_leaf_node(dip)) {
8588 ndi_devi_enter(dip, &circ2);
8589 ddi_walk_devs(ddi_get_child(dip), unmark_and_unfence, path2);
8590 ndi_devi_exit(dip, circ2);
8593 kmem_free(path2, MAXPATHLEN);
8595 /* release hold from find_dip_fcn() */
8596 ndi_rele_devi(dip);
8598 ndi_devi_exit(pdip, circ);
8600 ndi_rele_devi(pdip);
8602 return (0);
8606 * Called before attach on a dip that has been retired.
8608 static int
8609 mark_and_fence(dev_info_t *dip, void *arg)
8611 char *fencepath = (char *)arg;
8614 * We have already decided to retire this device. The various
8615 * constraint checking should not be set.
8616 * NOTE that the retire flag may already be set due to
8617 * fenced -> detach -> fenced transitions.
8619 mutex_enter(&DEVI(dip)->devi_lock);
8620 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_CONSTRAINT));
8621 ASSERT(!(DEVI(dip)->devi_flags & DEVI_R_BLOCKED));
8622 ASSERT(!(DEVI(dip)->devi_flags & DEVI_RETIRING));
8623 DEVI(dip)->devi_flags |= DEVI_RETIRED;
8624 mutex_exit(&DEVI(dip)->devi_lock);
8625 RIO_VERBOSE((CE_NOTE, "marked as RETIRED dip=%p", (void *)dip));
8627 if (fencepath) {
8628 (void) spec_fence_snode(dip, NULL);
8629 RIO_DEBUG((CE_NOTE, "Fenced: %s",
8630 ddi_pathname(dip, fencepath)));
8633 return (DDI_WALK_CONTINUE);
8637 * Checks the retire database and:
8639 * - if device is present in the retire database, marks the device retired
8640 * and fences it off.
8641 * - if device is not in retire database, allows the device to attach normally
8643 * To be called only by framework attach code on first attach attempt.
8646 static int
8647 i_ddi_check_retire(dev_info_t *dip)
8649 char *path;
8650 dev_info_t *pdip;
8651 int circ;
8652 int phci_only;
8653 int constraint;
8655 pdip = ddi_get_parent(dip);
8658 * Root dip is treated special and doesn't take this code path.
8659 * Also root can never be retired.
8661 ASSERT(pdip);
8662 ASSERT(DEVI_BUSY_OWNED(pdip));
8663 ASSERT(i_ddi_node_state(dip) < DS_ATTACHED);
8665 path = kmem_alloc(MAXPATHLEN, KM_SLEEP);
8667 (void) ddi_pathname(dip, path);
8669 RIO_VERBOSE((CE_NOTE, "Checking if dip should attach: dip=%p, path=%s",
8670 (void *)dip, path));
8673 * Check if this device is in the "retired" store i.e. should
8674 * be retired. If not, we have nothing to do.
8676 if (e_ddi_device_retired(path) == 0) {
8677 RIO_VERBOSE((CE_NOTE, "device is NOT retired: path=%s", path));
8678 if (DEVI(dip)->devi_flags & DEVI_RETIRED)
8679 (void) e_ddi_unretire_device(path);
8680 kmem_free(path, MAXPATHLEN);
8681 return (0);
8684 RIO_DEBUG((CE_NOTE, "attach: device is retired: path=%s", path));
8687 * Mark dips and fence off snodes (if any)
8689 RIO_DEBUG((CE_NOTE, "attach: Mark and fence subtree: path=%s", path));
8690 (void) mark_and_fence(dip, path);
8691 if (!is_leaf_node(dip)) {
8692 ndi_devi_enter(dip, &circ);
8693 ddi_walk_devs(ddi_get_child(dip), mark_and_fence, path);
8694 ndi_devi_exit(dip, circ);
8697 kmem_free(path, MAXPATHLEN);
8700 * We don't want to check the client. We just want to
8701 * offline the PHCI
8703 phci_only = 1;
8704 constraint = 1;
8705 if (MDI_PHCI(dip))
8706 mdi_phci_retire_finalize(dip, phci_only, &constraint);
8707 return (1);
8711 #define VAL_ALIAS(array, x) (strlen(array[x].pair_alias))
8712 #define VAL_CURR(array, x) (strlen(array[x].pair_curr))
8713 #define SWAP(array, x, y) \
8715 alias_pair_t tmpair = array[x]; \
8716 array[x] = array[y]; \
8717 array[y] = tmpair; \
8720 static int
8721 partition_curr(alias_pair_t *array, int start, int end)
8723 int i = start - 1;
8724 int j = end + 1;
8725 int pivot = start;
8727 for (;;) {
8728 do {
8729 j--;
8730 } while (VAL_CURR(array, j) > VAL_CURR(array, pivot));
8732 do {
8733 i++;
8734 } while (VAL_CURR(array, i) < VAL_CURR(array, pivot));
8736 if (i < j)
8737 SWAP(array, i, j)
8738 else
8739 return (j);
8743 static int
8744 partition_aliases(alias_pair_t *array, int start, int end)
8746 int i = start - 1;
8747 int j = end + 1;
8748 int pivot = start;
8750 for (;;) {
8751 do {
8752 j--;
8753 } while (VAL_ALIAS(array, j) > VAL_ALIAS(array, pivot));
8755 do {
8756 i++;
8757 } while (VAL_ALIAS(array, i) < VAL_ALIAS(array, pivot));
8759 if (i < j)
8760 SWAP(array, i, j)
8761 else
8762 return (j);
8765 static void
8766 sort_alias_pairs(alias_pair_t *array, int start, int end)
8768 int mid;
8770 if (start < end) {
8771 mid = partition_aliases(array, start, end);
8772 sort_alias_pairs(array, start, mid);
8773 sort_alias_pairs(array, mid + 1, end);
8777 static void
8778 sort_curr_pairs(alias_pair_t *array, int start, int end)
8780 int mid;
8782 if (start < end) {
8783 mid = partition_curr(array, start, end);
8784 sort_curr_pairs(array, start, mid);
8785 sort_curr_pairs(array, mid + 1, end);
8789 static void
8790 create_sorted_pairs(plat_alias_t *pali, int npali)
8792 int i;
8793 int j;
8794 int k;
8795 int count;
8797 count = 0;
8798 for (i = 0; i < npali; i++) {
8799 count += pali[i].pali_naliases;
8802 ddi_aliases.dali_alias_pairs = kmem_zalloc(
8803 (sizeof (alias_pair_t)) * count, KM_NOSLEEP);
8804 if (ddi_aliases.dali_alias_pairs == NULL) {
8805 cmn_err(CE_PANIC, "alias path-pair alloc failed");
8806 /*NOTREACHED*/
8809 ddi_aliases.dali_curr_pairs = kmem_zalloc(
8810 (sizeof (alias_pair_t)) * count, KM_NOSLEEP);
8811 if (ddi_aliases.dali_curr_pairs == NULL) {
8812 cmn_err(CE_PANIC, "curr path-pair alloc failed");
8813 /*NOTREACHED*/
8816 for (i = 0, k = 0; i < npali; i++) {
8817 for (j = 0; j < pali[i].pali_naliases; j++, k++) {
8818 ddi_aliases.dali_alias_pairs[k].pair_curr =
8819 ddi_aliases.dali_curr_pairs[k].pair_curr =
8820 pali[i].pali_current;
8821 ddi_aliases.dali_alias_pairs[k].pair_alias =
8822 ddi_aliases.dali_curr_pairs[k].pair_alias =
8823 pali[i].pali_aliases[j];
8827 ASSERT(k == count);
8829 ddi_aliases.dali_num_pairs = count;
8831 /* Now sort the array based on length of pair_alias */
8832 sort_alias_pairs(ddi_aliases.dali_alias_pairs, 0, count - 1);
8833 sort_curr_pairs(ddi_aliases.dali_curr_pairs, 0, count - 1);
8836 void
8837 ddi_register_aliases(plat_alias_t *pali, uint64_t npali)
8840 ASSERT((pali == NULL) ^ (npali != 0));
8842 if (npali == 0) {
8843 ddi_err(DER_PANIC, NULL, "npali == 0");
8844 /*NOTREACHED*/
8847 if (ddi_aliases_present == B_TRUE) {
8848 ddi_err(DER_PANIC, NULL, "multiple init");
8849 /*NOTREACHED*/
8852 ddi_aliases.dali_alias_TLB = mod_hash_create_strhash(
8853 "ddi-alias-tlb", DDI_ALIAS_HASH_SIZE, mod_hash_null_valdtor);
8854 if (ddi_aliases.dali_alias_TLB == NULL) {
8855 ddi_err(DER_PANIC, NULL, "alias TLB hash alloc failed");
8856 /*NOTREACHED*/
8859 ddi_aliases.dali_curr_TLB = mod_hash_create_strhash(
8860 "ddi-curr-tlb", DDI_ALIAS_HASH_SIZE, mod_hash_null_valdtor);
8861 if (ddi_aliases.dali_curr_TLB == NULL) {
8862 ddi_err(DER_PANIC, NULL, "curr TLB hash alloc failed");
8863 /*NOTREACHED*/
8866 create_sorted_pairs(pali, npali);
8868 tsd_create(&tsd_ddi_redirect, NULL);
8870 ddi_aliases_present = B_TRUE;
8873 static dev_info_t *
8874 path_to_dip(char *path)
8876 dev_info_t *currdip;
8877 int error;
8878 char *pdup;
8880 pdup = ddi_strdup(path, KM_NOSLEEP);
8881 if (pdup == NULL) {
8882 cmn_err(CE_PANIC, "path strdup failed: %s", path);
8883 /*NOTREACHED*/
8886 error = resolve_pathname(pdup, &currdip, NULL, NULL);
8888 kmem_free(pdup, strlen(path) + 1);
8890 return (error ? NULL : currdip);
8893 dev_info_t *
8894 ddi_alias_to_currdip(char *alias, int i)
8896 alias_pair_t *pair;
8897 char *curr;
8898 dev_info_t *currdip = NULL;
8899 char *aliasdup;
8900 int rv, len;
8902 pair = &(ddi_aliases.dali_alias_pairs[i]);
8903 len = strlen(pair->pair_alias);
8905 curr = NULL;
8906 aliasdup = ddi_strdup(alias, KM_NOSLEEP);
8907 if (aliasdup == NULL) {
8908 cmn_err(CE_PANIC, "aliasdup alloc failed");
8909 /*NOTREACHED*/
8912 if (strncmp(alias, pair->pair_alias, len) != 0)
8913 goto out;
8915 if (alias[len] != '/' && alias[len] != '\0')
8916 goto out;
8918 curr = kmem_alloc(MAXPATHLEN, KM_NOSLEEP);
8919 if (curr == NULL) {
8920 cmn_err(CE_PANIC, "curr alloc failed");
8921 /*NOTREACHED*/
8923 (void) strlcpy(curr, pair->pair_curr, MAXPATHLEN);
8924 if (alias[len] == '/') {
8925 (void) strlcat(curr, "/", MAXPATHLEN);
8926 (void) strlcat(curr, &alias[len + 1], MAXPATHLEN);
8929 currdip = path_to_dip(curr);
8931 out:
8932 if (currdip) {
8933 rv = mod_hash_insert(ddi_aliases.dali_alias_TLB,
8934 (mod_hash_key_t)aliasdup, (mod_hash_val_t)curr);
8935 if (rv != 0) {
8936 kmem_free(curr, MAXPATHLEN);
8937 strfree(aliasdup);
8939 } else {
8940 rv = mod_hash_insert(ddi_aliases.dali_alias_TLB,
8941 (mod_hash_key_t)aliasdup, (mod_hash_val_t)NULL);
8942 if (rv != 0) {
8943 strfree(aliasdup);
8945 if (curr)
8946 kmem_free(curr, MAXPATHLEN);
8949 return (currdip);
8952 char *
8953 ddi_curr_to_alias(char *curr, int i)
8955 alias_pair_t *pair;
8956 char *alias;
8957 char *currdup;
8958 int len;
8959 int rv;
8961 pair = &(ddi_aliases.dali_curr_pairs[i]);
8963 len = strlen(pair->pair_curr);
8965 alias = NULL;
8967 currdup = ddi_strdup(curr, KM_NOSLEEP);
8968 if (currdup == NULL) {
8969 cmn_err(CE_PANIC, "currdup alloc failed");
8970 /*NOTREACHED*/
8973 if (strncmp(curr, pair->pair_curr, len) != 0)
8974 goto out;
8976 if (curr[len] != '/' && curr[len] != '\0')
8977 goto out;
8979 alias = kmem_alloc(MAXPATHLEN, KM_NOSLEEP);
8980 if (alias == NULL) {
8981 cmn_err(CE_PANIC, "alias alloc failed");
8982 /*NOTREACHED*/
8985 (void) strlcpy(alias, pair->pair_alias, MAXPATHLEN);
8986 if (curr[len] == '/') {
8987 (void) strlcat(alias, "/", MAXPATHLEN);
8988 (void) strlcat(alias, &curr[len + 1], MAXPATHLEN);
8991 if (e_ddi_path_to_instance(alias) == NULL) {
8992 kmem_free(alias, MAXPATHLEN);
8993 alias = NULL;
8996 out:
8997 rv = mod_hash_insert(ddi_aliases.dali_curr_TLB,
8998 (mod_hash_key_t)currdup, (mod_hash_val_t)alias);
8999 if (rv != 0) {
9000 strfree(currdup);
9003 return (alias);
9006 dev_info_t *
9007 ddi_alias_redirect(char *alias)
9009 char *curr;
9010 dev_info_t *currdip;
9011 int i;
9013 if (ddi_aliases_present == B_FALSE)
9014 return (NULL);
9016 if (tsd_get(tsd_ddi_redirect))
9017 return (NULL);
9019 (void) tsd_set(tsd_ddi_redirect, (void *)1);
9021 ASSERT(ddi_aliases.dali_alias_TLB);
9022 ASSERT(ddi_aliases.dali_alias_pairs);
9024 curr = NULL;
9025 if (mod_hash_find(ddi_aliases.dali_alias_TLB,
9026 (mod_hash_key_t)alias, (mod_hash_val_t *)&curr) == 0) {
9027 currdip = curr ? path_to_dip(curr) : NULL;
9028 goto out;
9031 /* The TLB has no translation, do it the hard way */
9032 currdip = NULL;
9033 for (i = ddi_aliases.dali_num_pairs - 1; i >= 0; i--) {
9034 currdip = ddi_alias_to_currdip(alias, i);
9035 if (currdip)
9036 break;
9038 out:
9039 (void) tsd_set(tsd_ddi_redirect, NULL);
9041 return (currdip);
9044 char *
9045 ddi_curr_redirect(char *curr)
9047 char *alias;
9048 int i;
9050 if (ddi_aliases_present == B_FALSE)
9051 return (NULL);
9053 if (tsd_get(tsd_ddi_redirect))
9054 return (NULL);
9056 (void) tsd_set(tsd_ddi_redirect, (void *)1);
9058 ASSERT(ddi_aliases.dali_curr_TLB);
9059 ASSERT(ddi_aliases.dali_curr_pairs);
9061 alias = NULL;
9062 if (mod_hash_find(ddi_aliases.dali_curr_TLB,
9063 (mod_hash_key_t)curr, (mod_hash_val_t *)&alias) == 0) {
9064 goto out;
9068 /* The TLB has no translation, do it the slow way */
9069 alias = NULL;
9070 for (i = ddi_aliases.dali_num_pairs - 1; i >= 0; i--) {
9071 alias = ddi_curr_to_alias(curr, i);
9072 if (alias)
9073 break;
9076 out:
9077 (void) tsd_set(tsd_ddi_redirect, NULL);
9079 return (alias);
9082 void
9083 ddi_err(ddi_err_t ade, dev_info_t *rdip, const char *fmt, ...)
9085 va_list ap;
9086 char strbuf[256];
9087 char *buf;
9088 size_t buflen, tlen;
9089 int ce;
9090 int de;
9091 const char *fmtbad = "Invalid arguments to ddi_err()";
9093 de = DER_CONT;
9094 strbuf[1] = '\0';
9096 switch (ade) {
9097 case DER_CONS:
9098 strbuf[0] = '^';
9099 break;
9100 case DER_LOG:
9101 strbuf[0] = '!';
9102 break;
9103 case DER_VERB:
9104 strbuf[0] = '?';
9105 break;
9106 default:
9107 strbuf[0] = '\0';
9108 de = ade;
9109 break;
9112 tlen = strlen(strbuf);
9113 buf = strbuf + tlen;
9114 buflen = sizeof (strbuf) - tlen;
9116 if (rdip && ddi_get_instance(rdip) == -1) {
9117 (void) snprintf(buf, buflen, "%s: ",
9118 ddi_driver_name(rdip));
9119 } else if (rdip) {
9120 (void) snprintf(buf, buflen, "%s%d: ",
9121 ddi_driver_name(rdip), ddi_get_instance(rdip));
9124 tlen = strlen(strbuf);
9125 buf = strbuf + tlen;
9126 buflen = sizeof (strbuf) - tlen;
9128 va_start(ap, fmt);
9129 switch (de) {
9130 case DER_CONT:
9131 (void) vsnprintf(buf, buflen, fmt, ap);
9132 if (ade != DER_CONT) {
9133 (void) strlcat(strbuf, "\n", sizeof (strbuf));
9135 ce = CE_CONT;
9136 break;
9137 case DER_NOTE:
9138 (void) vsnprintf(buf, buflen, fmt, ap);
9139 ce = CE_NOTE;
9140 break;
9141 case DER_WARN:
9142 (void) vsnprintf(buf, buflen, fmt, ap);
9143 ce = CE_WARN;
9144 break;
9145 case DER_MODE:
9146 (void) vsnprintf(buf, buflen, fmt, ap);
9147 if (ddi_err_panic == B_TRUE) {
9148 ce = CE_PANIC;
9149 } else {
9150 ce = CE_WARN;
9152 break;
9153 case DER_DEBUG:
9154 (void) snprintf(buf, buflen, "DEBUG: ");
9155 tlen = strlen("DEBUG: ");
9156 (void) vsnprintf(buf + tlen, buflen - tlen, fmt, ap);
9157 ce = CE_CONT;
9158 break;
9159 case DER_PANIC:
9160 (void) vsnprintf(buf, buflen, fmt, ap);
9161 ce = CE_PANIC;
9162 break;
9163 case DER_INVALID:
9164 default:
9165 (void) snprintf(buf, buflen, fmtbad);
9166 tlen = strlen(fmtbad);
9167 (void) vsnprintf(buf + tlen, buflen - tlen, fmt, ap);
9168 ce = CE_PANIC;
9169 break;
9171 va_end(ap);
9173 cmn_err(ce, strbuf);
9176 /*ARGSUSED*/
9177 void
9178 ddi_mem_update(uint64_t addr, uint64_t size)
9180 #if defined(__x86) && !defined(__xpv)
9181 extern void immu_physmem_update(uint64_t addr, uint64_t size);
9182 immu_physmem_update(addr, size);
9183 #else
9184 /*LINTED*/
9186 #endif