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 2010 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_DDI_IMPLDEFS_H 27 #define _SYS_DDI_IMPLDEFS_H 28 29 #include <sys/types.h> 30 #include <sys/param.h> 31 #include <sys/t_lock.h> 32 #include <sys/ddipropdefs.h> 33 #include <sys/devops.h> 34 #include <sys/autoconf.h> 35 #include <sys/mutex.h> 36 #include <vm/page.h> 37 #include <sys/dacf_impl.h> 38 #include <sys/ndifm.h> 39 #include <sys/epm.h> 40 #include <sys/ddidmareq.h> 41 #include <sys/ddi_intr.h> 42 #include <sys/ddi_hp.h> 43 #include <sys/ddi_hp_impl.h> 44 #include <sys/ddi_isa.h> 45 #include <sys/id_space.h> 46 #include <sys/modhash.h> 47 #include <sys/bitset.h> 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 /* 54 * The device id implementation has been switched to be based on properties. 55 * For compatibility with di_devid libdevinfo interface the following 56 * must be defined: 57 */ 58 #define DEVID_COMPATIBILITY ((ddi_devid_t)-1) 59 60 /* 61 * Definitions for node class. 62 * DDI_NC_PROM: a node with a nodeid that may be used in a promif call. 63 * DDI_NC_PSEUDO: a software created node with a software assigned nodeid. 64 */ 65 typedef enum { 66 DDI_NC_PROM = 0, 67 DDI_NC_PSEUDO 68 } ddi_node_class_t; 69 70 /* 71 * Definitions for generic callback mechanism. 72 */ 73 typedef enum { 74 DDI_CB_INTR_ADD, /* More available interrupts */ 75 DDI_CB_INTR_REMOVE /* Fewer available interrupts */ 76 } ddi_cb_action_t; 77 78 typedef enum { 79 DDI_CB_FLAG_INTR = 0x1 /* Driver is IRM aware */ 80 } ddi_cb_flags_t; 81 82 #define DDI_CB_FLAG_VALID(f) ((f) & DDI_CB_FLAG_INTR) 83 84 typedef int (*ddi_cb_func_t)(dev_info_t *dip, ddi_cb_action_t action, 85 void *cbarg, void *arg1, void *arg2); 86 87 typedef struct ddi_cb { 88 uint64_t cb_flags; 89 dev_info_t *cb_dip; 90 ddi_cb_func_t cb_func; 91 void *cb_arg1; 92 void *cb_arg2; 93 } ddi_cb_t; 94 95 /* 96 * dev_info: The main device information structure this is intended to be 97 * opaque to drivers and drivers should use ddi functions to 98 * access *all* driver accessible fields. 99 * 100 * devi_parent_data includes property lists (interrupts, registers, etc.) 101 * devi_driver_data includes whatever the driver wants to place there. 102 */ 103 struct devinfo_audit; 104 105 typedef struct devi_port { 106 union { 107 struct { 108 uint32_t type; 109 uint32_t pad; 110 } port; 111 uint64_t type64; 112 } info; 113 void *priv_p; 114 } devi_port_t; 115 116 typedef struct devi_bus_priv { 117 devi_port_t port_up; 118 devi_port_t port_down; 119 } devi_bus_priv_t; 120 121 struct iommulib_unit; 122 typedef struct iommulib_unit *iommulib_handle_t; 123 typedef uint8_t ndi_flavor_t; 124 struct ddi_hp_cn_handle; 125 126 struct dev_info { 127 128 struct dev_info *devi_parent; /* my parent node in tree */ 129 struct dev_info *devi_child; /* my child list head */ 130 struct dev_info *devi_sibling; /* next element on my level */ 131 132 char *devi_binding_name; /* name used to bind driver: */ 133 /* shared storage, points to */ 134 /* devi_node_name, devi_compat_names */ 135 /* or devi_rebinding_name */ 136 137 char *devi_addr; /* address part of name */ 138 139 int devi_nodeid; /* device nodeid */ 140 int devi_instance; /* device instance number */ 141 142 struct dev_ops *devi_ops; /* driver operations */ 143 144 void *devi_parent_data; /* parent private data */ 145 void *devi_driver_data; /* driver private data */ 146 147 ddi_prop_t *devi_drv_prop_ptr; /* head of driver prop list */ 148 ddi_prop_t *devi_sys_prop_ptr; /* head of system prop list */ 149 150 struct ddi_minor_data *devi_minor; /* head of minor list */ 151 struct dev_info *devi_next; /* Next instance of this device */ 152 kmutex_t devi_lock; /* Protects per-devinfo data */ 153 154 /* logical parents for busop primitives */ 155 156 struct dev_info *devi_bus_map_fault; /* bus_map_fault parent */ 157 struct dev_info *devi_bus_dma_map; /* bus_dma_map parent */ 158 struct dev_info *devi_bus_dma_allochdl; /* bus_dma_newhdl parent */ 159 struct dev_info *devi_bus_dma_freehdl; /* bus_dma_freehdl parent */ 160 struct dev_info *devi_bus_dma_bindhdl; /* bus_dma_bindhdl parent */ 161 struct dev_info *devi_bus_dma_unbindhdl; /* bus_dma_unbindhdl parent */ 162 struct dev_info *devi_bus_dma_flush; /* bus_dma_flush parent */ 163 struct dev_info *devi_bus_dma_win; /* bus_dma_win parent */ 164 struct dev_info *devi_bus_dma_ctl; /* bus_dma_ctl parent */ 165 struct dev_info *devi_bus_ctl; /* bus_ctl parent */ 166 167 ddi_prop_t *devi_hw_prop_ptr; /* head of hw prop list */ 168 169 char *devi_node_name; /* The 'name' of the node */ 170 char *devi_compat_names; /* A list of driver names */ 171 size_t devi_compat_length; /* Size of compat_names */ 172 173 int (*devi_bus_dma_bindfunc)(dev_info_t *, dev_info_t *, 174 ddi_dma_handle_t, struct ddi_dma_req *, ddi_dma_cookie_t *, 175 uint_t *); 176 int (*devi_bus_dma_unbindfunc)(dev_info_t *, dev_info_t *, 177 ddi_dma_handle_t); 178 179 char *devi_devid_str; /* registered device id */ 180 181 /* 182 * power management entries 183 * components exist even if the device is not currently power managed 184 */ 185 struct pm_info *devi_pm_info; /* 0 => dev not power managed */ 186 uint_t devi_pm_flags; /* pm flags */ 187 int devi_pm_num_components; /* number of components */ 188 size_t devi_pm_comp_size; /* size of devi_components */ 189 struct pm_component *devi_pm_components; /* array of pm components */ 190 struct dev_info *devi_pm_ppm; /* ppm attached to this one */ 191 void *devi_pm_ppm_private; /* for use by ppm driver */ 192 int devi_pm_dev_thresh; /* "device" threshold */ 193 uint_t devi_pm_kidsupcnt; /* # of kids powered up */ 194 struct pm_scan *devi_pm_scan; /* pm scan info */ 195 uint_t devi_pm_noinvolpm; /* # of descendents no-invol */ 196 uint_t devi_pm_volpmd; /* # of voluntarily pm'ed */ 197 kmutex_t devi_pm_lock; /* pm lock for state */ 198 kmutex_t devi_pm_busy_lock; /* for component busy count */ 199 200 uint_t devi_state; /* device/bus state flags */ 201 /* see below for definitions */ 202 kcondvar_t devi_cv; /* cv */ 203 int devi_ref; /* reference count */ 204 205 dacf_rsrvlist_t *devi_dacf_tasks; /* dacf reservation queue */ 206 207 ddi_node_class_t devi_node_class; /* Node class */ 208 int devi_node_attributes; /* Node attributes: See below */ 209 210 char *devi_device_class; 211 212 /* 213 * New mpxio kernel hooks entries 214 */ 215 int devi_mdi_component; /* mpxio component type */ 216 void *devi_mdi_client; /* mpxio client information */ 217 void *devi_mdi_xhci; /* vhci/phci info */ 218 219 ddi_prop_list_t *devi_global_prop_list; /* driver global properties */ 220 major_t devi_major; /* driver major number */ 221 ddi_node_state_t devi_node_state; /* state of node */ 222 uint_t devi_flags; /* configuration flags */ 223 int devi_circular; /* for recursive operations */ 224 void *devi_busy_thread; /* thread operating on node */ 225 void *devi_taskq; /* hotplug taskq */ 226 227 /* device driver statistical and audit info */ 228 struct devinfo_audit *devi_audit; /* last state change */ 229 230 /* 231 * FMA support for resource caches and error handlers 232 */ 233 struct i_ddi_fmhdl *devi_fmhdl; 234 235 uint_t devi_cpr_flags; 236 237 /* Owned by DDI interrupt framework */ 238 devinfo_intr_t *devi_intr_p; 239 240 void *devi_nex_pm; /* nexus PM private */ 241 242 char *devi_addr_buf; /* buffer for devi_addr */ 243 244 char *devi_rebinding_name; /* binding_name of rebind */ 245 246 /* For device contracts that have this dip's minor node as resource */ 247 kmutex_t devi_ct_lock; /* contract lock */ 248 kcondvar_t devi_ct_cv; /* contract cv */ 249 int devi_ct_count; /* # of outstanding responses */ 250 int devi_ct_neg; /* neg. occurred on dip */ 251 list_t devi_ct; 252 253 /* owned by bus framework */ 254 devi_bus_priv_t devi_bus; /* bus private data */ 255 256 /* Declarations of the pure dynamic properties to snapshot */ 257 struct i_ddi_prop_dyn *devi_prop_dyn_driver; /* prop_op */ 258 struct i_ddi_prop_dyn *devi_prop_dyn_parent; /* bus_prop_op */ 259 260 /* For x86 (Intel and AMD) IOMMU support */ 261 void *devi_iommu; 262 263 /* IOMMU handle */ 264 iommulib_handle_t devi_iommulib_handle; 265 266 /* Generic callback mechanism */ 267 ddi_cb_t *devi_cb_p; 268 269 /* ndi 'flavors' */ 270 ndi_flavor_t devi_flavor; /* flavor assigned by parent */ 271 ndi_flavor_t devi_flavorv_n; /* number of child-flavors */ 272 void **devi_flavorv; /* child-flavor specific data */ 273 274 /* Owned by hotplug framework */ 275 struct ddi_hp_cn_handle *devi_hp_hdlp; /* hotplug handle list */ 276 }; 277 278 #define DEVI(dev_info_type) ((struct dev_info *)(dev_info_type)) 279 280 /* 281 * NB: The 'name' field, for compatibility with old code (both existing 282 * device drivers and userland code), is now defined as the name used 283 * to bind the node to a device driver, and not the device node name. 284 * If the device node name does not define a binding to a device driver, 285 * and the framework uses a different algorithm to create the binding to 286 * the driver, the node name and binding name will be different. 287 * 288 * Note that this implies that the node name plus instance number does 289 * NOT create a unique driver id; only the binding name plus instance 290 * number creates a unique driver id. 291 * 292 * New code should not use 'devi_name'; use 'devi_binding_name' or 293 * 'devi_node_name' and/or the routines that access those fields. 294 */ 295 296 #define devi_name devi_binding_name 297 298 /* 299 * DDI_CF1, DDI_CF2 and DDI_DRV_UNLOADED are obsolete. They are kept 300 * around to allow legacy drivers to to compile. 301 */ 302 #define DDI_CF1(devi) (DEVI(devi)->devi_addr != NULL) 303 #define DDI_CF2(devi) (DEVI(devi)->devi_ops != NULL) 304 #define DDI_DRV_UNLOADED(devi) (DEVI(devi)->devi_ops == &mod_nodev_ops) 305 306 /* 307 * The device state flags (devi_state) contains information regarding 308 * the state of the device (Online/Offline/Down). For bus nexus 309 * devices, the device state also contains state information regarding 310 * the state of the bus represented by this nexus node. 311 * 312 * Device state information is stored in bits [0-7], bus state in bits 313 * [8-15]. 314 * 315 * NOTE: all devi_state updates should be protected by devi_lock. 316 */ 317 #define DEVI_DEVICE_OFFLINE 0x00000001 318 #define DEVI_DEVICE_DOWN 0x00000002 319 #define DEVI_DEVICE_DEGRADED 0x00000004 320 #define DEVI_DEVICE_REMOVED 0x00000008 /* hardware removed */ 321 322 #define DEVI_BUS_QUIESCED 0x00000100 323 #define DEVI_BUS_DOWN 0x00000200 324 #define DEVI_NDI_CONFIG 0x00000400 /* perform config when attaching */ 325 326 #define DEVI_S_ATTACHING 0x00010000 327 #define DEVI_S_DETACHING 0x00020000 328 #define DEVI_S_ONLINING 0x00040000 329 #define DEVI_S_OFFLINING 0x00080000 330 331 #define DEVI_S_INVOKING_DACF 0x00100000 /* busy invoking a dacf task */ 332 333 #define DEVI_S_UNBOUND 0x00200000 334 #define DEVI_S_REPORT 0x08000000 /* report status change */ 335 336 #define DEVI_S_EVADD 0x10000000 /* state of devfs event */ 337 #define DEVI_S_EVREMOVE 0x20000000 /* state of devfs event */ 338 #define DEVI_S_NEED_RESET 0x40000000 /* devo_reset should be called */ 339 340 /* 341 * Device state macros. 342 * o All SET/CLR/DONE users must protect context with devi_lock. 343 * o DEVI_SET_DEVICE_ONLINE users must do his own DEVI_SET_REPORT. 344 * o DEVI_SET_DEVICE_{DOWN|DEGRADED|UP} should only be used when !OFFLINE. 345 * o DEVI_SET_DEVICE_UP clears DOWN and DEGRADED. 346 */ 347 #define DEVI_IS_DEVICE_OFFLINE(dip) \ 348 ((DEVI(dip)->devi_state & DEVI_DEVICE_OFFLINE) == DEVI_DEVICE_OFFLINE) 349 350 #define DEVI_SET_DEVICE_ONLINE(dip) { \ 351 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 352 if (DEVI(dip)->devi_state & DEVI_DEVICE_DEGRADED) { \ 353 mutex_exit(&DEVI(dip)->devi_lock); \ 354 e_ddi_undegrade_finalize(dip); \ 355 mutex_enter(&DEVI(dip)->devi_lock); \ 356 } \ 357 /* setting ONLINE clears DOWN, DEGRADED, OFFLINE */ \ 358 DEVI(dip)->devi_state &= ~(DEVI_DEVICE_DOWN | \ 359 DEVI_DEVICE_DEGRADED | DEVI_DEVICE_OFFLINE); \ 360 } 361 362 #define DEVI_SET_DEVICE_OFFLINE(dip) { \ 363 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 364 DEVI(dip)->devi_state |= (DEVI_DEVICE_OFFLINE | DEVI_S_REPORT); \ 365 } 366 367 #define DEVI_IS_DEVICE_DOWN(dip) \ 368 ((DEVI(dip)->devi_state & DEVI_DEVICE_DOWN) == DEVI_DEVICE_DOWN) 369 370 #define DEVI_SET_DEVICE_DOWN(dip) { \ 371 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 372 ASSERT(!DEVI_IS_DEVICE_OFFLINE(dip)); \ 373 DEVI(dip)->devi_state |= (DEVI_DEVICE_DOWN | DEVI_S_REPORT); \ 374 } 375 376 #define DEVI_IS_DEVICE_DEGRADED(dip) \ 377 ((DEVI(dip)->devi_state & \ 378 (DEVI_DEVICE_DEGRADED|DEVI_DEVICE_DOWN)) == DEVI_DEVICE_DEGRADED) 379 380 #define DEVI_SET_DEVICE_DEGRADED(dip) { \ 381 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 382 ASSERT(!DEVI_IS_DEVICE_OFFLINE(dip)); \ 383 mutex_exit(&DEVI(dip)->devi_lock); \ 384 e_ddi_degrade_finalize(dip); \ 385 mutex_enter(&DEVI(dip)->devi_lock); \ 386 DEVI(dip)->devi_state |= (DEVI_DEVICE_DEGRADED | DEVI_S_REPORT); \ 387 } 388 389 #define DEVI_SET_DEVICE_UP(dip) { \ 390 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 391 ASSERT(!DEVI_IS_DEVICE_OFFLINE(dip)); \ 392 if (DEVI(dip)->devi_state & DEVI_DEVICE_DEGRADED) { \ 393 mutex_exit(&DEVI(dip)->devi_lock); \ 394 e_ddi_undegrade_finalize(dip); \ 395 mutex_enter(&DEVI(dip)->devi_lock); \ 396 } \ 397 DEVI(dip)->devi_state &= ~(DEVI_DEVICE_DEGRADED | DEVI_DEVICE_DOWN); \ 398 DEVI(dip)->devi_state |= DEVI_S_REPORT; \ 399 } 400 401 /* Device removal and insertion */ 402 #define DEVI_IS_DEVICE_REMOVED(dip) \ 403 ((DEVI(dip)->devi_state & DEVI_DEVICE_REMOVED) == DEVI_DEVICE_REMOVED) 404 405 #define DEVI_SET_DEVICE_REMOVED(dip) { \ 406 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 407 DEVI(dip)->devi_state |= DEVI_DEVICE_REMOVED | DEVI_S_REPORT; \ 408 } 409 410 #define DEVI_SET_DEVICE_REINSERTED(dip) { \ 411 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 412 DEVI(dip)->devi_state &= ~DEVI_DEVICE_REMOVED; \ 413 DEVI(dip)->devi_state |= DEVI_S_REPORT; \ 414 } 415 416 /* Bus state change macros */ 417 #define DEVI_IS_BUS_QUIESCED(dip) \ 418 ((DEVI(dip)->devi_state & DEVI_BUS_QUIESCED) == DEVI_BUS_QUIESCED) 419 420 #define DEVI_SET_BUS_ACTIVE(dip) { \ 421 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 422 DEVI(dip)->devi_state &= ~DEVI_BUS_QUIESCED; \ 423 DEVI(dip)->devi_state |= DEVI_S_REPORT; \ 424 } 425 426 #define DEVI_SET_BUS_QUIESCE(dip) { \ 427 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 428 DEVI(dip)->devi_state |= (DEVI_BUS_QUIESCED | DEVI_S_REPORT); \ 429 } 430 431 #define DEVI_IS_BUS_DOWN(dip) \ 432 ((DEVI(dip)->devi_state & DEVI_BUS_DOWN) == DEVI_BUS_DOWN) 433 434 #define DEVI_SET_BUS_UP(dip) { \ 435 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 436 DEVI(dip)->devi_state &= ~DEVI_BUS_DOWN; \ 437 DEVI(dip)->devi_state |= DEVI_S_REPORT; \ 438 } 439 440 #define DEVI_SET_BUS_DOWN(dip) { \ 441 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 442 DEVI(dip)->devi_state |= (DEVI_BUS_DOWN | DEVI_S_REPORT); \ 443 } 444 445 /* Status change report needed */ 446 #define DEVI_NEED_REPORT(dip) \ 447 ((DEVI(dip)->devi_state & DEVI_S_REPORT) == DEVI_S_REPORT) 448 449 #define DEVI_SET_REPORT(dip) { \ 450 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 451 DEVI(dip)->devi_state |= DEVI_S_REPORT; \ 452 } 453 454 #define DEVI_REPORT_DONE(dip) { \ 455 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 456 DEVI(dip)->devi_state &= ~DEVI_S_REPORT; \ 457 } 458 459 /* Do an NDI_CONFIG for its children */ 460 #define DEVI_NEED_NDI_CONFIG(dip) \ 461 ((DEVI(dip)->devi_state & DEVI_NDI_CONFIG) == DEVI_NDI_CONFIG) 462 463 #define DEVI_SET_NDI_CONFIG(dip) { \ 464 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 465 DEVI(dip)->devi_state |= DEVI_NDI_CONFIG; \ 466 } 467 468 #define DEVI_CLR_NDI_CONFIG(dip) { \ 469 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 470 DEVI(dip)->devi_state &= ~DEVI_NDI_CONFIG; \ 471 } 472 473 /* Attaching or detaching state */ 474 #define DEVI_IS_ATTACHING(dip) \ 475 ((DEVI(dip)->devi_state & DEVI_S_ATTACHING) == DEVI_S_ATTACHING) 476 477 #define DEVI_SET_ATTACHING(dip) { \ 478 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 479 DEVI(dip)->devi_state |= DEVI_S_ATTACHING; \ 480 } 481 482 #define DEVI_CLR_ATTACHING(dip) { \ 483 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 484 DEVI(dip)->devi_state &= ~DEVI_S_ATTACHING; \ 485 } 486 487 #define DEVI_IS_DETACHING(dip) \ 488 ((DEVI(dip)->devi_state & DEVI_S_DETACHING) == DEVI_S_DETACHING) 489 490 #define DEVI_SET_DETACHING(dip) { \ 491 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 492 DEVI(dip)->devi_state |= DEVI_S_DETACHING; \ 493 } 494 495 #define DEVI_CLR_DETACHING(dip) { \ 496 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 497 DEVI(dip)->devi_state &= ~DEVI_S_DETACHING; \ 498 } 499 500 /* Onlining or offlining state */ 501 #define DEVI_IS_ONLINING(dip) \ 502 ((DEVI(dip)->devi_state & DEVI_S_ONLINING) == DEVI_S_ONLINING) 503 504 #define DEVI_SET_ONLINING(dip) { \ 505 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 506 DEVI(dip)->devi_state |= DEVI_S_ONLINING; \ 507 } 508 509 #define DEVI_CLR_ONLINING(dip) { \ 510 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 511 DEVI(dip)->devi_state &= ~DEVI_S_ONLINING; \ 512 } 513 514 #define DEVI_IS_OFFLINING(dip) \ 515 ((DEVI(dip)->devi_state & DEVI_S_OFFLINING) == DEVI_S_OFFLINING) 516 517 #define DEVI_SET_OFFLINING(dip) { \ 518 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 519 DEVI(dip)->devi_state |= DEVI_S_OFFLINING; \ 520 } 521 522 #define DEVI_CLR_OFFLINING(dip) { \ 523 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 524 DEVI(dip)->devi_state &= ~DEVI_S_OFFLINING; \ 525 } 526 527 #define DEVI_IS_IN_RECONFIG(dip) \ 528 (DEVI(dip)->devi_state & (DEVI_S_OFFLINING | DEVI_S_ONLINING)) 529 530 /* Busy invoking a dacf task against this node */ 531 #define DEVI_IS_INVOKING_DACF(dip) \ 532 ((DEVI(dip)->devi_state & DEVI_S_INVOKING_DACF) == DEVI_S_INVOKING_DACF) 533 534 #define DEVI_SET_INVOKING_DACF(dip) { \ 535 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 536 DEVI(dip)->devi_state |= DEVI_S_INVOKING_DACF; \ 537 } 538 539 #define DEVI_CLR_INVOKING_DACF(dip) { \ 540 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 541 DEVI(dip)->devi_state &= ~DEVI_S_INVOKING_DACF; \ 542 } 543 544 /* Events for add/remove */ 545 #define DEVI_EVADD(dip) \ 546 ((DEVI(dip)->devi_state & DEVI_S_EVADD) == DEVI_S_EVADD) 547 548 #define DEVI_SET_EVADD(dip) { \ 549 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 550 DEVI(dip)->devi_state &= ~DEVI_S_EVREMOVE; \ 551 DEVI(dip)->devi_state |= DEVI_S_EVADD; \ 552 } 553 554 #define DEVI_EVREMOVE(dip) \ 555 ((DEVI(dip)->devi_state & DEVI_S_EVREMOVE) == DEVI_S_EVREMOVE) 556 557 #define DEVI_SET_EVREMOVE(dip) { \ 558 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 559 DEVI(dip)->devi_state &= ~DEVI_S_EVADD; \ 560 DEVI(dip)->devi_state |= DEVI_S_EVREMOVE; \ 561 } 562 563 #define DEVI_SET_EVUNINIT(dip) { \ 564 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 565 DEVI(dip)->devi_state &= ~(DEVI_S_EVADD | DEVI_S_EVREMOVE); \ 566 } 567 568 /* Need to call the devo_reset entry point for this device at shutdown */ 569 #define DEVI_NEED_RESET(dip) \ 570 ((DEVI(dip)->devi_state & DEVI_S_NEED_RESET) == DEVI_S_NEED_RESET) 571 572 #define DEVI_SET_NEED_RESET(dip) { \ 573 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 574 DEVI(dip)->devi_state |= DEVI_S_NEED_RESET; \ 575 } 576 577 #define DEVI_CLR_NEED_RESET(dip) { \ 578 ASSERT(mutex_owned(&DEVI(dip)->devi_lock)); \ 579 DEVI(dip)->devi_state &= ~DEVI_S_NEED_RESET; \ 580 } 581 582 /* 583 * devi_flags bits 584 * 585 * NOTE: all devi_state updates should be protected by devi_lock. 586 */ 587 #define DEVI_BUSY 0x00000001 /* busy configuring children */ 588 #define DEVI_MADE_CHILDREN 0x00000002 /* children made from specs */ 589 #define DEVI_ATTACHED_CHILDREN 0x00000004 /* attached all existing children */ 590 #define DEVI_BRANCH_HELD 0x00000008 /* branch rooted at this dip held */ 591 #define DEVI_NO_BIND 0x00000010 /* prevent driver binding */ 592 #define DEVI_REGISTERED_DEVID 0x00000020 /* device registered a devid */ 593 #define DEVI_PHCI_SIGNALS_VHCI 0x00000040 /* pHCI ndi_devi_exit signals vHCI */ 594 #define DEVI_REBIND 0x00000080 /* post initchild driver rebind */ 595 #define DEVI_RETIRED 0x00000100 /* device is retired */ 596 #define DEVI_RETIRING 0x00000200 /* being evaluated for retire */ 597 #define DEVI_R_CONSTRAINT 0x00000400 /* constraints have been applied */ 598 #define DEVI_R_BLOCKED 0x00000800 /* constraints block retire */ 599 #define DEVI_CT_NOP 0x00001000 /* NOP contract event occurred */ 600 #define DEVI_PCI_DEVICE 0x00002000 /* dip is PCI */ 601 602 #define DEVI_BUSY_CHANGING(dip) (DEVI(dip)->devi_flags & DEVI_BUSY) 603 #define DEVI_BUSY_OWNED(dip) (DEVI_BUSY_CHANGING(dip) && \ 604 ((DEVI(dip))->devi_busy_thread == curthread)) 605 606 #define DEVI_IS_PCI(dip) (DEVI(dip)->devi_flags & DEVI_PCI_DEVICE) 607 #define DEVI_SET_PCI(dip) (DEVI(dip)->devi_flags |= (DEVI_PCI_DEVICE)) 608 609 char *i_ddi_devi_class(dev_info_t *); 610 int i_ddi_set_devi_class(dev_info_t *, char *, int); 611 612 /* 613 * This structure represents one piece of bus space occupied by a given 614 * device. It is used in an array for devices with multiple address windows. 615 */ 616 struct regspec { 617 uint_t regspec_bustype; /* cookie for bus type it's on */ 618 uint_t regspec_addr; /* address of reg relative to bus */ 619 uint_t regspec_size; /* size of this register set */ 620 }; 621 622 /* 623 * This structure represents one piece of nexus bus space. 624 * It is used in an array for nexi with multiple bus spaces 625 * to define the childs offsets in the parents bus space. 626 */ 627 struct rangespec { 628 uint_t rng_cbustype; /* Child's address, hi order */ 629 uint_t rng_coffset; /* Child's address, lo order */ 630 uint_t rng_bustype; /* Parent's address, hi order */ 631 uint_t rng_offset; /* Parent's address, lo order */ 632 uint_t rng_size; /* size of space for this entry */ 633 }; 634 635 #ifdef _KERNEL 636 637 typedef enum { 638 DDI_PRE = 0, 639 DDI_POST = 1 640 } ddi_pre_post_t; 641 642 /* 643 * This structure represents notification of a child attach event 644 * These could both be the same if attach/detach commands were in the 645 * same name space. 646 * Note that the target dip is passed as an arg already. 647 */ 648 struct attachspec { 649 ddi_attach_cmd_t cmd; /* type of event */ 650 ddi_pre_post_t when; /* one of DDI_PRE or DDI_POST */ 651 dev_info_t *pdip; /* parent of attaching node */ 652 int result; /* result of attach op (post command only) */ 653 }; 654 655 /* 656 * This structure represents notification of a child detach event 657 * Note that the target dip is passed as an arg already. 658 */ 659 struct detachspec { 660 ddi_detach_cmd_t cmd; /* type of event */ 661 ddi_pre_post_t when; /* one of DDI_PRE or DDI_POST */ 662 dev_info_t *pdip; /* parent of detaching node */ 663 int result; /* result of detach op (post command only) */ 664 }; 665 666 #endif /* _KERNEL */ 667 668 typedef enum { 669 DDM_MINOR = 0, 670 DDM_ALIAS, 671 DDM_DEFAULT, 672 DDM_INTERNAL_PATH 673 } ddi_minor_type; 674 675 /* implementation flags for driver specified device access control */ 676 #define DM_NO_FSPERM 0x1 677 678 struct devplcy; 679 680 struct ddi_minor { 681 char *name; /* name of node */ 682 dev_t dev; /* device number */ 683 int spec_type; /* block or char */ 684 int flags; /* access flags */ 685 char *node_type; /* block, byte, serial, network */ 686 struct devplcy *node_priv; /* privilege for this minor */ 687 mode_t priv_mode; /* default apparent privilege mode */ 688 }; 689 690 /* 691 * devi_node_attributes contains node attributes private to the 692 * ddi implementation. As a consumer, do not use these bit definitions 693 * directly, use the ndi functions that check for the existence of the 694 * specific node attributes. 695 * 696 * DDI_PERSISTENT indicates a 'persistent' node; one that is not 697 * automatically freed by the framework if the driver is unloaded 698 * or the driver fails to attach to this node. 699 * 700 * DDI_AUTO_ASSIGNED_NODEID indicates that the nodeid was auto-assigned 701 * by the framework and should be auto-freed if the node is removed. 702 * 703 * DDI_VHCI_NODE indicates that the node type is VHCI. This flag 704 * must be set by ndi_devi_config_vhci() routine only. 705 * 706 * DDI_HIDDEN_NODE indicates that the node should not show up in snapshots 707 * or in /devices. 708 * 709 * DDI_HOTPLUG_NODE indicates that the node created by nexus hotplug. 710 */ 711 #define DDI_PERSISTENT 0x01 712 #define DDI_AUTO_ASSIGNED_NODEID 0x02 713 #define DDI_VHCI_NODE 0x04 714 #define DDI_HIDDEN_NODE 0x08 715 #define DDI_HOTPLUG_NODE 0x10 716 717 #define DEVI_VHCI_NODE(dip) \ 718 (DEVI(dip)->devi_node_attributes & DDI_VHCI_NODE) 719 720 /* 721 * The ddi_minor_data structure gets filled in by ddi_create_minor_node. 722 * It then gets attached to the devinfo node as a property. 723 */ 724 struct ddi_minor_data { 725 struct ddi_minor_data *next; /* next one in the chain */ 726 dev_info_t *dip; /* pointer to devinfo node */ 727 ddi_minor_type type; /* Following data type */ 728 struct ddi_minor d_minor; /* Actual minor node data */ 729 }; 730 731 #define ddm_name d_minor.name 732 #define ddm_dev d_minor.dev 733 #define ddm_flags d_minor.flags 734 #define ddm_spec_type d_minor.spec_type 735 #define ddm_node_type d_minor.node_type 736 #define ddm_node_priv d_minor.node_priv 737 #define ddm_priv_mode d_minor.priv_mode 738 739 /* 740 * parent private data structure contains register, interrupt, property 741 * and range information. 742 */ 743 struct ddi_parent_private_data { 744 int par_nreg; /* number of regs */ 745 struct regspec *par_reg; /* array of regs */ 746 int par_nintr; /* number of interrupts */ 747 struct intrspec *par_intr; /* array of possible interrupts */ 748 int par_nrng; /* number of ranges */ 749 struct rangespec *par_rng; /* array of ranges */ 750 }; 751 #define DEVI_PD(d) \ 752 ((struct ddi_parent_private_data *)DEVI((d))->devi_parent_data) 753 754 #define sparc_pd_getnreg(dev) (DEVI_PD(dev)->par_nreg) 755 #define sparc_pd_getnintr(dev) (DEVI_PD(dev)->par_nintr) 756 #define sparc_pd_getnrng(dev) (DEVI_PD(dev)->par_nrng) 757 #define sparc_pd_getreg(dev, n) (&DEVI_PD(dev)->par_reg[(n)]) 758 #define sparc_pd_getintr(dev, n) (&DEVI_PD(dev)->par_intr[(n)]) 759 #define sparc_pd_getrng(dev, n) (&DEVI_PD(dev)->par_rng[(n)]) 760 761 #ifdef _KERNEL 762 /* 763 * This data structure is private to the indexed soft state allocator. 764 */ 765 typedef struct i_ddi_soft_state { 766 void **array; /* the array of pointers */ 767 kmutex_t lock; /* serialize access to this struct */ 768 size_t size; /* how many bytes per state struct */ 769 size_t n_items; /* how many structs herein */ 770 struct i_ddi_soft_state *next; /* 'dirty' elements */ 771 } i_ddi_soft_state; 772 773 /* 774 * This data structure is private to the stringhashed soft state allocator. 775 */ 776 typedef struct i_ddi_soft_state_bystr { 777 size_t ss_size; /* how many bytes per state struct */ 778 mod_hash_t *ss_mod_hash; /* hash implementation */ 779 } i_ddi_soft_state_bystr; 780 781 /* 782 * This data structure is private to the ddi_strid_* implementation 783 */ 784 typedef struct i_ddi_strid { 785 size_t strid_chunksz; 786 size_t strid_spacesz; 787 id_space_t *strid_space; 788 mod_hash_t *strid_byid; 789 mod_hash_t *strid_bystr; 790 } i_ddi_strid; 791 #endif /* _KERNEL */ 792 793 /* 794 * Solaris DDI DMA implementation structure and function definitions. 795 * 796 * Note: no callers of DDI functions must depend upon data structures 797 * declared below. They are not guaranteed to remain constant. 798 */ 799 800 /* 801 * Implementation DMA mapping structure. 802 * 803 * The publicly visible ddi_dma_req structure is filled 804 * in by a caller that wishes to map a memory object 805 * for DMA. Internal to this implementation of the public 806 * DDI DMA functions this request structure is put together 807 * with bus nexus specific functions that have additional 808 * information and constraints as to how to go about doing 809 * the requested mapping function 810 * 811 * In this implementation, some of the information from the 812 * original requester is retained throughout the lifetime 813 * of the I/O mapping being active. 814 */ 815 816 /* 817 * This is the implementation specific description 818 * of how we've mapped an object for DMA. 819 */ 820 #if defined(__sparc) 821 typedef struct ddi_dma_impl { 822 /* 823 * DMA mapping information 824 */ 825 ulong_t dmai_mapping; /* mapping cookie */ 826 827 /* 828 * Size of the current mapping, in bytes. 829 * 830 * Note that this is distinct from the size of the object being mapped 831 * for DVMA. We might have only a portion of the object mapped at any 832 * given point in time. 833 */ 834 uint_t dmai_size; 835 836 /* 837 * Offset, in bytes, into object that is currently mapped. 838 */ 839 off_t dmai_offset; 840 841 /* 842 * Information gathered from the original DMA mapping 843 * request and saved for the lifetime of the mapping. 844 */ 845 uint_t dmai_minxfer; 846 uint_t dmai_burstsizes; 847 uint_t dmai_ndvmapages; 848 uint_t dmai_pool; /* cached DVMA space */ 849 uint_t dmai_rflags; /* requester's flags + ours */ 850 uint_t dmai_inuse; /* active handle? */ 851 uint_t dmai_nwin; 852 uint_t dmai_winsize; 853 caddr_t dmai_nexus_private; 854 void *dmai_iopte; 855 uint_t *dmai_sbi; 856 void *dmai_minfo; /* random mapping information */ 857 dev_info_t *dmai_rdip; /* original requester's dev_info_t */ 858 ddi_dma_obj_t dmai_object; /* requester's object */ 859 ddi_dma_attr_t dmai_attr; /* DMA attributes */ 860 ddi_dma_cookie_t *dmai_cookie; /* pointer to first DMA cookie */ 861 862 int (*dmai_fault_check)(struct ddi_dma_impl *handle); 863 void (*dmai_fault_notify)(struct ddi_dma_impl *handle); 864 int dmai_fault; 865 ndi_err_t dmai_error; 866 867 } ddi_dma_impl_t; 868 869 #elif defined(__x86) 870 871 /* 872 * ddi_dma_impl portion that genunix (sunddi.c) depends on. x86 rootnex 873 * implementation specific state is in dmai_private. 874 */ 875 typedef struct ddi_dma_impl { 876 ddi_dma_cookie_t *dmai_cookie; /* array of DMA cookies */ 877 void *dmai_private; 878 879 /* 880 * Information gathered from the original dma mapping 881 * request and saved for the lifetime of the mapping. 882 */ 883 uint_t dmai_minxfer; 884 uint_t dmai_burstsizes; 885 uint_t dmai_rflags; /* requester's flags + ours */ 886 int dmai_nwin; 887 dev_info_t *dmai_rdip; /* original requester's dev_info_t */ 888 889 ddi_dma_attr_t dmai_attr; /* DMA attributes */ 890 891 int (*dmai_fault_check)(struct ddi_dma_impl *handle); 892 void (*dmai_fault_notify)(struct ddi_dma_impl *handle); 893 int dmai_fault; 894 ndi_err_t dmai_error; 895 } ddi_dma_impl_t; 896 897 #else 898 #error "struct ddi_dma_impl not defined for this architecture" 899 #endif /* defined(__sparc) */ 900 901 /* 902 * For now DMA segments share state with the DMA handle 903 */ 904 typedef ddi_dma_impl_t ddi_dma_seg_impl_t; 905 906 /* 907 * These flags use reserved bits from the dma request flags. 908 * 909 * A note about the DMP_NOSYNC flags: the root nexus will 910 * set these as it sees best. If an intermediate nexus 911 * actually needs these operations, then during the unwind 912 * from the call to ddi_dma_bind, the nexus driver *must* 913 * clear the appropriate flag(s). This is because, as an 914 * optimization, ddi_dma_sync(9F) looks at these flags before 915 * deciding to spend the time going back up the tree. 916 */ 917 918 #define _DMCM1 DDI_DMA_RDWR|DDI_DMA_REDZONE|DDI_DMA_PARTIAL 919 #define _DMCM2 DDI_DMA_CONSISTENT|DMP_VMEREQ 920 #define DMP_DDIFLAGS (_DMCM1|_DMCM2) 921 #define DMP_SHADOW 0x20 922 #define DMP_LKIOPB 0x40 923 #define DMP_LKSYSV 0x80 924 #define DMP_IOCACHE 0x100 925 #define DMP_USEHAT 0x200 926 #define DMP_PHYSADDR 0x400 927 #define DMP_INVALID 0x800 928 #define DMP_NOLIMIT 0x1000 929 #define DMP_VMEREQ 0x10000000 930 #define DMP_BYPASSNEXUS 0x20000000 931 #define DMP_NODEVSYNC 0x40000000 932 #define DMP_NOCPUSYNC 0x80000000 933 #define DMP_NOSYNC (DMP_NODEVSYNC|DMP_NOCPUSYNC) 934 935 /* 936 * In order to complete a device to device mapping that 937 * has percolated as high as an IU nexus (gone that high 938 * because the DMA request is a VADDR type), we define 939 * structure to use with the DDI_CTLOPS_DMAPMAPC request 940 * that re-traverses the request tree to finish the 941 * DMA 'mapping' for a device. 942 */ 943 struct dma_phys_mapc { 944 struct ddi_dma_req *dma_req; /* original request */ 945 ddi_dma_impl_t *mp; /* current handle, or none */ 946 int nptes; /* number of ptes */ 947 void *ptes; /* ptes already read */ 948 }; 949 950 #define MAXCALLBACK 20 951 952 /* 953 * Callback definitions 954 */ 955 struct ddi_callback { 956 struct ddi_callback *c_nfree; 957 struct ddi_callback *c_nlist; 958 int (*c_call)(); 959 int c_count; 960 caddr_t c_arg; 961 size_t c_size; 962 }; 963 964 /* 965 * Pure dynamic property declaration. A pure dynamic property is a property 966 * for which a driver's prop_op(9E) implementation will return a value on 967 * demand, but the property name does not exist on a property list (global, 968 * driver, system, or hardware) - the person asking for the value must know 969 * the name and type information. 970 * 971 * For a pure dynamic property to show up in a di_init() devinfo shapshot, the 972 * devinfo driver must know name and type. The i_ddi_prop_dyn_t mechanism 973 * allows a driver to define an array of the name/type information of its 974 * dynamic properties. When a driver declares its dynamic properties in a 975 * i_ddi_prop_dyn_t array, and registers that array using 976 * i_ddi_prop_dyn_driver_set() the devinfo driver has sufficient information 977 * to represent the properties in a snapshot - calling the driver's 978 * prop_op(9E) to obtain values. 979 * 980 * The last element of a i_ddi_prop_dyn_t is detected via a NULL dp_name value. 981 * 982 * A pure dynamic property name associated with a minor_node/dev_t should be 983 * defined with a dp_spec_type of S_IFCHR or S_IFBLK, as appropriate. The 984 * driver's prop_op(9E) entry point will be called for all 985 * ddi_create_minor_node(9F) nodes of the specified spec_type. For a driver 986 * where not all minor_node/dev_t combinations support the same named 987 * properties, it is the responsibility of the prop_op(9E) implementation to 988 * sort out what combinations are appropriate. 989 * 990 * A pure dynamic property of a devinfo node should be defined with a 991 * dp_spec_type of 0. 992 * 993 * NB: Public DDI property interfaces no longer support pure dynamic 994 * properties, but they are still still used. A prime example is the cmlb 995 * implementation of size(9P) properties. Using pure dynamic properties 996 * reduces the space required to maintain per-partition information. Since 997 * there are no public interfaces to create pure dynamic properties, 998 * the i_ddi_prop_dyn_t mechanism should remain private. 999 */ 1000 typedef struct i_ddi_prop_dyn { 1001 char *dp_name; /* name of dynamic property */ 1002 int dp_type; /* DDI_PROP_TYPE_ of property */ 1003 int dp_spec_type; /* 0, S_IFCHR, S_IFBLK */ 1004 } i_ddi_prop_dyn_t; 1005 void i_ddi_prop_dyn_driver_set(dev_info_t *, 1006 i_ddi_prop_dyn_t *); 1007 i_ddi_prop_dyn_t *i_ddi_prop_dyn_driver_get(dev_info_t *); 1008 void i_ddi_prop_dyn_parent_set(dev_info_t *, 1009 i_ddi_prop_dyn_t *); 1010 i_ddi_prop_dyn_t *i_ddi_prop_dyn_parent_get(dev_info_t *); 1011 void i_ddi_prop_dyn_cache_invalidate(dev_info_t *, 1012 i_ddi_prop_dyn_t *); 1013 1014 /* 1015 * Device id - Internal definition. 1016 */ 1017 #define DEVID_MAGIC_MSB 0x69 1018 #define DEVID_MAGIC_LSB 0x64 1019 #define DEVID_REV_MSB 0x00 1020 #define DEVID_REV_LSB 0x01 1021 #define DEVID_HINT_SIZE 4 1022 1023 typedef struct impl_devid { 1024 uchar_t did_magic_hi; /* device id magic # (msb) */ 1025 uchar_t did_magic_lo; /* device id magic # (lsb) */ 1026 uchar_t did_rev_hi; /* device id revision # (msb) */ 1027 uchar_t did_rev_lo; /* device id revision # (lsb) */ 1028 uchar_t did_type_hi; /* device id type (msb) */ 1029 uchar_t did_type_lo; /* device id type (lsb) */ 1030 uchar_t did_len_hi; /* length of devid data (msb) */ 1031 uchar_t did_len_lo; /* length of devid data (lsb) */ 1032 char did_driver[DEVID_HINT_SIZE]; /* driver name - HINT */ 1033 char did_id[1]; /* start of device id data */ 1034 } impl_devid_t; 1035 1036 #define DEVID_GETTYPE(devid) ((ushort_t) \ 1037 (((devid)->did_type_hi << NBBY) + \ 1038 (devid)->did_type_lo)) 1039 1040 #define DEVID_FORMTYPE(devid, type) (devid)->did_type_hi = hibyte((type)); \ 1041 (devid)->did_type_lo = lobyte((type)); 1042 1043 #define DEVID_GETLEN(devid) ((ushort_t) \ 1044 (((devid)->did_len_hi << NBBY) + \ 1045 (devid)->did_len_lo)) 1046 1047 #define DEVID_FORMLEN(devid, len) (devid)->did_len_hi = hibyte((len)); \ 1048 (devid)->did_len_lo = lobyte((len)); 1049 1050 /* 1051 * Per PSARC/1995/352, a binary devid contains fields for <magic number>, 1052 * <revision>, <driver_hint>, <type>, <id_length>, and the <id> itself. 1053 * This proposal would encode the binary devid into a string consisting 1054 * of "<magic><revision>,<driver_hint>@<type><id>" as indicated below 1055 * (<id_length> is rederived from the length of the string 1056 * representation of the <id>): 1057 * 1058 * <magic> ->"id" 1059 * 1060 * <rev> ->"%d" // "0" -> type of DEVID_NONE "id0" 1061 * // NOTE: PSARC/1995/352 <revision> is "1". 1062 * // NOTE: support limited to 10 revisions 1063 * // in current implementation 1064 * 1065 * <driver_hint> ->"%s" // "sd"/"ssd" 1066 * // NOTE: driver names limited to 4 1067 * // characters for <revision> "1" 1068 * 1069 * <type> ->'w' | // DEVID_SCSI3_WWN <hex_id> 1070 * 'W' | // DEVID_SCSI3_WWN <ascii_id> 1071 * 't' | // DEVID_SCSI3_VPD_T10 <hex_id> 1072 * 'T' | // DEVID_SCSI3_VPD_T10 <ascii_id> 1073 * 'x' | // DEVID_SCSI3_VPD_EUI <hex_id> 1074 * 'X' | // DEVID_SCSI3_VPD_EUI <ascii_id> 1075 * 'n' | // DEVID_SCSI3_VPD_NAA <hex_id> 1076 * 'N' | // DEVID_SCSI3_VPD_NAA <ascii_id> 1077 * 's' | // DEVID_SCSI_SERIAL <hex_id> 1078 * 'S' | // DEVID_SCSI_SERIAL <ascii_id> 1079 * 'f' | // DEVID_FAB <hex_id> 1080 * 'F' | // DEVID_FAB <ascii_id> 1081 * 'e' | // DEVID_ENCAP <hex_id> 1082 * 'E' | // DEVID_ENCAP <ascii_id> 1083 * 'a' | // DEVID_ATA_SERIAL <hex_id> 1084 * 'A' | // DEVID_ATA_SERIAL <ascii_id> 1085 * 'u' | // unknown <hex_id> 1086 * 'U' // unknown <ascii_id> 1087 * // NOTE:lower case -> <hex_id> 1088 * // upper case -> <ascii_id> 1089 * // NOTE:this covers all types currently 1090 * // defined for <revision> 1. 1091 * // NOTE:a <type> can be added 1092 * // without changing the <revision>. 1093 * 1094 * <id> -> <ascii_id> | // <type> is upper case 1095 * <hex_id> // <type> is lower case 1096 * 1097 * <ascii_id> // only if all bytes of binary <id> field 1098 * // are in the set: 1099 * // [A-Z][a-z][0-9]+-.= and space and 0x00 1100 * // the encoded form is: 1101 * // [A-Z][a-z][0-9]+-.= and _ and ~ 1102 * // NOTE: ' ' <=> '_', 0x00 <=> '~' 1103 * // these sets are chosen to avoid shell 1104 * // and conflicts with DDI node names. 1105 * 1106 * <hex_id> // if not <ascii_id>; each byte of binary 1107 * // <id> maps a to 2 digit ascii hex 1108 * // representation in the string. 1109 * 1110 * This encoding provides a meaningful correlation between the /devices 1111 * path and the devid string where possible. 1112 * 1113 * Fibre: 1114 * sbus@6,0/SUNW,socal@d,10000/sf@1,0/ssd@w21000020370bb488,0:c,raw 1115 * id1,ssd@w20000020370bb488:c,raw 1116 * 1117 * Copper: 1118 * sbus@7,0/SUNW,fas@3,8800000/sd@a,0:c 1119 * id1,sd@SIBM_____1XY210__________:c 1120 */ 1121 /* determine if a byte of an id meets ASCII representation requirements */ 1122 #define DEVID_IDBYTE_ISASCII(b) ( \ 1123 (((b) >= 'a') && ((b) <= 'z')) || \ 1124 (((b) >= 'A') && ((b) <= 'Z')) || \ 1125 (((b) >= '0') && ((b) <= '9')) || \ 1126 (b == '+') || (b == '-') || (b == '.') || (b == '=') || \ 1127 (b == ' ') || (b == 0x00)) 1128 1129 /* set type to lower case to indicate that the did_id field is ascii */ 1130 #define DEVID_TYPE_SETASCII(c) (c - 0x20) /* 'a' -> 'A' */ 1131 1132 /* determine from type if did_id field is binary or ascii */ 1133 #define DEVID_TYPE_ISASCII(c) (((c) >= 'A') && ((c) <= 'Z')) 1134 1135 /* convert type field from binary to ascii */ 1136 #define DEVID_TYPE_BINTOASCII(b) ( \ 1137 ((b) == DEVID_SCSI3_WWN) ? 'w' : \ 1138 ((b) == DEVID_SCSI3_VPD_T10) ? 't' : \ 1139 ((b) == DEVID_SCSI3_VPD_EUI) ? 'x' : \ 1140 ((b) == DEVID_SCSI3_VPD_NAA) ? 'n' : \ 1141 ((b) == DEVID_SCSI_SERIAL) ? 's' : \ 1142 ((b) == DEVID_FAB) ? 'f' : \ 1143 ((b) == DEVID_ENCAP) ? 'e' : \ 1144 ((b) == DEVID_ATA_SERIAL) ? 'a' : \ 1145 'u') /* unknown */ 1146 1147 /* convert type field from ascii to binary */ 1148 #define DEVID_TYPE_ASCIITOBIN(c) ( \ 1149 (((c) == 'w') || ((c) == 'W')) ? DEVID_SCSI3_WWN : \ 1150 (((c) == 't') || ((c) == 'T')) ? DEVID_SCSI3_VPD_T10 : \ 1151 (((c) == 'x') || ((c) == 'X')) ? DEVID_SCSI3_VPD_EUI : \ 1152 (((c) == 'n') || ((c) == 'N')) ? DEVID_SCSI3_VPD_NAA : \ 1153 (((c) == 's') || ((c) == 'S')) ? DEVID_SCSI_SERIAL : \ 1154 (((c) == 'f') || ((c) == 'F')) ? DEVID_FAB : \ 1155 (((c) == 'e') || ((c) == 'E')) ? DEVID_ENCAP : \ 1156 (((c) == 'a') || ((c) == 'A')) ? DEVID_ATA_SERIAL : \ 1157 DEVID_MAXTYPE +1) /* unknown */ 1158 1159 /* determine if the type should be forced to hex encoding (non-ascii) */ 1160 #define DEVID_TYPE_BIN_FORCEHEX(b) ( \ 1161 ((b) == DEVID_SCSI3_WWN) || \ 1162 ((b) == DEVID_SCSI3_VPD_EUI) || \ 1163 ((b) == DEVID_SCSI3_VPD_NAA) || \ 1164 ((b) == DEVID_FAB)) 1165 1166 /* determine if the type is from a scsi3 vpd */ 1167 #define IS_DEVID_SCSI3_VPD_TYPE(b) ( \ 1168 ((b) == DEVID_SCSI3_VPD_T10) || \ 1169 ((b) == DEVID_SCSI3_VPD_EUI) || \ 1170 ((b) == DEVID_SCSI3_VPD_NAA)) 1171 1172 /* convert rev field from binary to ascii (only supports 10 revs) */ 1173 #define DEVID_REV_BINTOASCII(b) (b + '0') 1174 1175 /* convert rev field from ascii to binary (only supports 10 revs) */ 1176 #define DEVID_REV_ASCIITOBIN(c) (c - '0') 1177 1178 /* name of devid property */ 1179 #define DEVID_PROP_NAME "devid" 1180 1181 /* 1182 * prop_name used by pci_{save,restore}_config_regs() 1183 */ 1184 #define SAVED_CONFIG_REGS "pci-config-regs" 1185 #define SAVED_CONFIG_REGS_MASK "pcie-config-regs-mask" 1186 #define SAVED_CONFIG_REGS_CAPINFO "pci-cap-info" 1187 1188 typedef struct pci_config_header_state { 1189 uint16_t chs_command; 1190 uint8_t chs_cache_line_size; 1191 uint8_t chs_latency_timer; 1192 uint8_t chs_header_type; 1193 uint8_t chs_sec_latency_timer; 1194 uint8_t chs_bridge_control; 1195 uint32_t chs_base0; 1196 uint32_t chs_base1; 1197 uint32_t chs_base2; 1198 uint32_t chs_base3; 1199 uint32_t chs_base4; 1200 uint32_t chs_base5; 1201 } pci_config_header_state_t; 1202 1203 #ifdef _KERNEL 1204 1205 typedef struct pci_cap_save_desc { 1206 uint16_t cap_offset; 1207 uint16_t cap_id; 1208 uint32_t cap_nregs; 1209 } pci_cap_save_desc_t; 1210 1211 typedef struct pci_cap_entry { 1212 uint16_t cap_id; 1213 uint16_t cap_reg; 1214 uint16_t cap_mask; 1215 uint32_t cap_ndwords; 1216 uint32_t (*cap_save_func)(ddi_acc_handle_t confhdl, uint16_t cap_ptr, 1217 uint32_t *regbuf, uint32_t ndwords); 1218 } pci_cap_entry_t; 1219 1220 #endif /* _KERNEL */ 1221 1222 #ifdef __cplusplus 1223 } 1224 #endif 1225 1226 #endif /* _SYS_DDI_IMPLDEFS_H */ 1227