1 /* 2 * CDDL HEADER START 3 * 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. 7 * 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. 12 * 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] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_AUTOCONF_H 27 #define _SYS_AUTOCONF_H 28 29 30 /* Derived from autoconf.h, SunOS 4.1.1 1.15 */ 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif 35 36 /* 37 * This defines a parallel structure to the devops list. 38 */ 39 40 #include <sys/dditypes.h> 41 #include <sys/devops.h> 42 #include <sys/mutex.h> 43 #include <sys/thread.h> 44 #include <sys/obpdefs.h> 45 #include <sys/systm.h> 46 #include <sys/hwconf.h> 47 48 struct devnames { 49 char *dn_name; /* Name of this driver */ 50 int dn_flags; /* per-driver flags, see below */ 51 struct par_list *dn_pl; /* parent list, for making devinfos */ 52 kmutex_t dn_lock; /* Per driver lock (see below) */ 53 dev_info_t *dn_head; /* Head of instance list */ 54 int dn_instance; /* Next instance no. to assign */ 55 void *dn_inlist; /* instance # nodes for this driver */ 56 ddi_prop_list_t *dn_global_prop_ptr; /* per-driver global properties */ 57 kcondvar_t dn_wait; /* for ddi_hold_installed_driver */ 58 kthread_id_t dn_busy_thread; /* for debugging only */ 59 struct mperm *dn_mperm; /* minor permissions */ 60 struct mperm *dn_mperm_wild; /* default minor permission */ 61 struct mperm *dn_mperm_clone; /* minor permission, clone use */ 62 }; 63 64 /* 65 * dn_lock is used to protect the driver initialization/loading 66 * from fini/unloading. It also protects each drivers devops 67 * reference count, the dn_flags, and the dn_head linked list of 68 * driver instances. The busy_changing bit is used to avoid 69 * recursive calls to ddi_hold_installed_driver to hold the 70 * same driver. 71 */ 72 73 /* 74 * Defines for dn_flags. 75 */ 76 #define DN_CONF_PARSED 0x0001 77 #define DN_DRIVER_BUSY 0x0002 /* for ddi_hold_installed_driver */ 78 #define DN_DRIVER_HELD 0x0020 /* held via ddi_hold_installed_driver */ 79 #define DN_TAKEN_GETUDEV 0x0040 /* getudev() used this entry */ 80 #define DN_DRIVER_REMOVED 0x0080 /* driver entry removed */ 81 82 #define DN_FORCE_ATTACH 0x0100 /* DDI_FORCEATTACH prop */ 83 #define DN_LEAF_DRIVER 0x0200 /* this is a leaf driver */ 84 #define DN_NETWORK_DRIVER 0x0400 /* network interface driver */ 85 #define DN_NO_AUTODETACH 0x0800 /* no autodetach */ 86 #define DN_GLDV3_DRIVER 0x1000 /* gldv3 (Nemo) driver */ 87 #define DN_PHCI_DRIVER 0x2000 /* pHCI driver */ 88 #define DN_OPEN_RETURNS_EINTR 0x4000 /* DDI_OPEN_RETURNS_EINTR prop */ 89 #define DN_SCSI_SIZE_CLEAN 0x8000 /* driver is scsi_size_clean() */ 90 91 #ifdef _KERNEL 92 93 /* 94 * Debugging flags and macros 95 */ 96 #define DDI_AUDIT 0x0001 97 #define DDI_DEBUG 0x0002 98 #define DDI_MTCONFIG 0x0004 99 #define DDI_DEBUG_BOOTMOD 0x0008 /* module loading to mount root */ 100 #define DDI_DEBUG_COMPAT 0x0010 /* ddi_hold_install_driver */ 101 #define LDI_DBG_OPENCLOSE 0x0020 /* ldi open/close info */ 102 #define LDI_DBG_ALLOCFREE 0x0040 /* ldi ident alloc/free info */ 103 #define LDI_DBG_STREAMS 0x0080 /* ldi streams link/unlink */ 104 #define LDI_DBG_EVENTCB 0x0100 /* ldi event callback info */ 105 #define DDI_INTR_API 0x0200 /* interrupt interface messages */ 106 #define DDI_INTR_IMPL 0x0400 /* interrupt implementation msgs */ 107 #define DDI_INTR_NEXUS 0x0800 /* interrupt messages from nexuses */ 108 #define DDI_DBG_RETIRE 0x1000 /* Retire related messages */ 109 #define DDI_DBG_RTR_VRBOSE 0x2000 /* Verbose Retire messages */ 110 #define DDI_DBG_RTR_TRACE 0x4000 /* Trace Retire messages */ 111 #define LDI_EV_DEBUG 0x8000 /* LDI events debug messages */ 112 #define LDI_EV_TRACE 0x10000 /* LDI events trace messages */ 113 #define DDI_INTR_IRM 0x20000 /* interrupt resource management */ 114 115 extern int ddidebug; 116 117 #ifdef DEBUG 118 #define NDI_CONFIG_DEBUG(args) if (ddidebug & DDI_DEBUG) cmn_err args 119 #define BMDPRINTF(args) if (ddidebug & DDI_DEBUG_BOOTMOD) printf args 120 #define DCOMPATPRINTF(args) if (ddidebug & DDI_DEBUG_COMPAT) cmn_err args 121 #define LDI_OPENCLOSE(args) if (ddidebug & LDI_DBG_OPENCLOSE) cmn_err args 122 #define LDI_ALLOCFREE(args) if (ddidebug & LDI_DBG_ALLOCFREE) cmn_err args 123 #define LDI_STREAMS_LNK(args) if (ddidebug & LDI_DBG_STREAMS) cmn_err args 124 #define LDI_EVENTCB(args) if (ddidebug & LDI_DBG_EVENTCB) cmn_err args 125 #define DDI_INTR_APIDBG(args) if (ddidebug & DDI_INTR_API) cmn_err args 126 #define DDI_INTR_IMPLDBG(args) if (ddidebug & DDI_INTR_IMPL) cmn_err args 127 #define DDI_INTR_NEXDBG(args) if (ddidebug & DDI_INTR_NEXUS) cmn_err args 128 #define RIO_DEBUG(args) if (ddidebug & DDI_DBG_RETIRE) cmn_err args 129 #define RIO_VERBOSE(args) if (ddidebug & DDI_DBG_RTR_VRBOSE) cmn_err args 130 #define RIO_TRACE(args) if (ddidebug & DDI_DBG_RTR_TRACE) cmn_err args 131 #define LDI_EVDBG(args) if (ddidebug & LDI_EV_DEBUG) cmn_err args 132 #define LDI_EVTRC(args) if (ddidebug & LDI_EV_TRACE) cmn_err args 133 #define DDI_INTR_IRMDBG(args) if (ddidebug & DDI_INTR_IRM) cmn_err args 134 #else 135 #define NDI_CONFIG_DEBUG(args) 136 #define BMDPRINTF(args) 137 #define DCOMPATPRINTF(args) 138 #define LDI_OPENCLOSE(args) 139 #define LDI_ALLOCFREE(args) 140 #define LDI_STREAMS_LNK(args) 141 #define LDI_EVENTCB(args) 142 #define DDI_INTR_APIDBG(args) 143 #define DDI_INTR_IMPLDBG(args) 144 #define DDI_INTR_NEXDBG(args) 145 #define RIO_DEBUG(args) if (ddidebug & DDI_DBG_RETIRE) cmn_err args 146 #define RIO_VERBOSE(args) if (ddidebug & DDI_DBG_RTR_VRBOSE) cmn_err args 147 #define RIO_TRACE(args) if (ddidebug & DDI_DBG_RTR_TRACE) cmn_err args 148 #define LDI_EVDBG(args) if (ddidebug & LDI_EV_DEBUG) cmn_err args 149 #define LDI_EVTRC(args) if (ddidebug & LDI_EV_TRACE) cmn_err args 150 #define DDI_INTR_IRMDBG(args) 151 #endif 152 153 154 /* 155 * DDI configuration logs 156 */ 157 #define DDI_STACK_DEPTH 14 158 159 typedef struct devinfo_audit { 160 dev_info_t *da_devinfo; /* address of devinfo node */ 161 hrtime_t da_timestamp; /* audit time */ 162 kthread_id_t da_thread; /* thread of transaction */ 163 struct devinfo_audit *da_lastlog; /* last log of state change */ 164 ddi_node_state_t da_node_state; /* devinfo state at log time */ 165 int da_device_state; /* device state */ 166 int da_depth; 167 pc_t da_stack[DDI_STACK_DEPTH]; 168 } devinfo_audit_t; 169 170 typedef struct { 171 kmutex_t dh_lock; 172 int dh_max; 173 int dh_curr; 174 int dh_hits; 175 devinfo_audit_t dh_entry[1]; 176 } devinfo_log_header_t; 177 178 struct di_cache { 179 uint32_t cache_valid; /* no lock needed - field atomic updt */ 180 kmutex_t cache_lock; /* protects fields below */ 181 void *cache_data; 182 size_t cache_size; 183 }; 184 185 extern struct di_cache di_cache; 186 extern int di_cache_debug; 187 extern volatile ulong_t devtree_gen; 188 189 /* 190 * Special dev_info nodes 191 */ 192 #define PSEUDO_PATH "/"DEVI_PSEUDO_NEXNAME 193 #define CLONE_PATH PSEUDO_PATH"/clone@0" 194 195 #define DI_CACHE_FILE "/etc/devices/snapshot_cache" 196 #define DI_CACHE_TEMP DI_CACHE_FILE".tmp" 197 198 extern dev_info_t *options_dip; 199 extern dev_info_t *pseudo_dip; 200 extern dev_info_t *clone_dip; 201 extern major_t clone_major; 202 extern major_t mm_major; 203 extern major_t nulldriver_major; 204 205 extern struct devnames *devnamesp; 206 extern struct devnames orphanlist; 207 208 extern struct dev_ops nodev_ops, mod_nodev_ops; 209 210 /* 211 * Obsolete interface, no longer used, to be removed. 212 * Retained only for driver compatibility. 213 */ 214 extern krwlock_t devinfo_tree_lock; /* obsolete */ 215 216 /* 217 * Acquires dn_lock, as above. 218 */ 219 #define LOCK_DEV_OPS(lp) mutex_enter((lp)) 220 #define UNLOCK_DEV_OPS(lp) mutex_exit((lp)) 221 222 /* 223 * Not to be used without obtaining the per-driver lock. 224 */ 225 #define INCR_DEV_OPS_REF(opsp) (opsp)->devo_refcnt++ 226 #define DECR_DEV_OPS_REF(opsp) (opsp)->devo_refcnt-- 227 #define CB_DRV_INSTALLED(opsp) ((opsp) != &nodev_ops && \ 228 (opsp) != &mod_nodev_ops) 229 #define DRV_UNLOADABLE(opsp) ((opsp)->devo_refcnt == 0) 230 #define DEV_OPS_HELD(opsp) ((opsp)->devo_refcnt > 0) 231 #define NEXUS_DRV(opsp) ((opsp)->devo_bus_ops != NULL) 232 #define NETWORK_DRV(major) (devnamesp[major].dn_flags & DN_NETWORK_DRIVER) 233 #define GLDV3_DRV(major) (devnamesp[major].dn_flags & DN_GLDV3_DRIVER) 234 235 extern void impl_rem_dev_props(dev_info_t *); 236 extern void add_class(char *, char *); 237 238 extern int make_mbind(char *, int, char *, struct bind **); 239 extern void delete_mbind(char *, struct bind **); 240 extern void purge_mbind(int, struct bind **); 241 242 extern void configure(void); 243 #if defined(__sparc) 244 extern void setcputype(void); 245 #endif 246 extern void devtree_freeze(void); 247 extern void reset_leaves(void); 248 extern void quiesce_devices(dev_info_t *, void *); 249 250 extern void setup_ddi(void); 251 extern void setup_ddi_poststartup(void); 252 extern void impl_ddi_callback_init(void); 253 extern void impl_fix_props(dev_info_t *, dev_info_t *, char *, int, caddr_t); 254 extern int impl_check_cpu(dev_info_t *); 255 extern int check_status(int, char *, dev_info_t *); 256 257 extern int exclude_settrap(int); 258 extern int exclude_level(int); 259 260 extern major_t path_to_major(char *); 261 extern void i_ddi_node_cache_init(void); 262 extern dev_info_t *i_ddi_alloc_node(dev_info_t *, char *, pnode_t, int, 263 ddi_prop_t *, int); 264 extern void i_ddi_forceattach_drivers(void); 265 extern int i_ddi_io_initialized(void); 266 extern dev_info_t *i_ddi_create_branch(dev_info_t *, int); 267 extern void i_ddi_add_devimap(dev_info_t *dip); 268 extern void i_ddi_di_cache_invalidate(void); 269 extern void i_ddi_di_cache_free(struct di_cache *cache); 270 271 /* devname_state - for /dev to denote reconfig and system available */ 272 #define DS_RECONFIG 0x01 /* reconfig boot */ 273 #define DS_SYSAVAIL 0x02 /* implicit reconfig enabled */ 274 275 extern int i_ddi_sysavail(void); 276 extern int i_ddi_reconfig(void); 277 extern void i_ddi_set_sysavail(void); 278 extern void i_ddi_set_reconfig(void); 279 280 /* I/O retire related */ 281 extern int e_ddi_retire_device(char *path, char **cons_array); 282 extern int e_ddi_unretire_device(char *path); 283 extern int e_ddi_mark_retiring(dev_info_t *dip, void *arg); 284 extern int e_ddi_retire_notify(dev_info_t *dip, void *arg); 285 extern int e_ddi_retire_finalize(dev_info_t *dip, void *arg); 286 extern void e_ddi_degrade_finalize(dev_info_t *dip); 287 extern void e_ddi_undegrade_finalize(dev_info_t *dip); 288 289 extern int check_driver_quiesce(dev_info_t *dip, void *arg); 290 291 #endif /* _KERNEL */ 292 293 #ifdef __cplusplus 294 } 295 #endif 296 297 #endif /* _SYS_AUTOCONF_H */ 298