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