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