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 /* 23 * Copyright 2005 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _SYS_SUNDDI_H 28 #define _SYS_SUNDDI_H 29 30 #pragma ident "%Z%%M% %I% %E% SMI" 31 32 /* 33 * Sun Specific DDI definitions 34 */ 35 36 #include <sys/isa_defs.h> 37 #include <sys/dditypes.h> 38 #include <sys/ddipropdefs.h> 39 #include <sys/devops.h> 40 #include <sys/time.h> 41 #include <sys/cmn_err.h> 42 #include <sys/ddidevmap.h> 43 #include <sys/ddi_impldefs.h> 44 #include <sys/ddi_implfuncs.h> 45 #include <sys/ddi_isa.h> 46 #include <sys/model.h> 47 #include <sys/devctl.h> 48 #if defined(__i386) || defined(__amd64) 49 #include <sys/dma_engine.h> 50 #endif 51 #include <sys/sunpm.h> 52 #include <sys/nvpair.h> 53 #include <sys/sysevent.h> 54 #include <sys/thread.h> 55 #include <sys/stream.h> 56 #if defined(__GNUC__) && defined(_ASM_INLINES) && defined(_KERNEL) 57 #include <asm/sunddi.h> 58 #endif 59 #ifdef _KERNEL 60 #include <sys/ddi_obsolete.h> 61 #endif 62 63 #ifdef __cplusplus 64 extern "C" { 65 #endif 66 67 /* 68 * Generic Sun DDI definitions. 69 */ 70 71 #define DDI_SUCCESS (0) /* successful return */ 72 #define DDI_FAILURE (-1) /* unsuccessful return */ 73 #define DDI_NOT_WELL_FORMED (-2) /* A dev_info node is not valid */ 74 #define DDI_EAGAIN (-3) /* not enough interrupt resources */ 75 #define DDI_EINVAL (-4) /* invalid request or arguments */ 76 #define DDI_ENOTSUP (-5) /* operation is not supported */ 77 #define DDI_EPENDING (-6) /* operation or an event is pending */ 78 79 /* 80 * General-purpose DDI error return value definitions 81 */ 82 #define DDI_ENOMEM 1 /* memory not available */ 83 #define DDI_EBUSY 2 /* busy */ 84 #define DDI_ETRANSPORT 3 /* transport down */ 85 #define DDI_ECONTEXT 4 /* context error */ 86 87 88 /* 89 * General DDI sleep/nosleep allocation flags 90 */ 91 #define DDI_SLEEP 0 92 #define DDI_NOSLEEP 1 93 94 /* 95 * The following special nodeid values are reserved for use when creating 96 * nodes ONLY. They specify the attributes of the DDI_NC_PSEUDO class node 97 * being created: 98 * 99 * o DEVI_PSEUDO_NODEID specifics a node without persistence. 100 * o DEVI_SID_NODEID specifies a node with persistence. 101 * 102 * A node with the 'persistent' attribute will not be automatically removed by 103 * the framework in the current implementation - driver.conf nodes are without 104 * persistence. 105 * 106 * The actual nodeid value may be assigned by the framework and may be 107 * different than these special values. Drivers may not make assumptions 108 * about the nodeid value that is actually assigned to the node. 109 */ 110 111 #define DEVI_PSEUDO_NODEID ((int)-1) 112 #define DEVI_SID_NODEID ((int)-2) 113 114 #define DEVI_PSEUDO_NEXNAME "pseudo" 115 #define DEVI_ISA_NEXNAME "isa" 116 #define DEVI_EISA_NEXNAME "eisa" 117 118 /* 119 * ddi_create_minor_node flags 120 */ 121 #define CLONE_DEV 1 /* device is a clone device */ 122 #define PRIVONLY_DEV 0x10 /* policy-based permissions only */ 123 124 /* 125 * Historical values used for the flag field in ddi_create_minor_node. 126 * Future use of flag bits should avoid these fields to keep binary 127 * compatibility 128 * #define GLOBAL_DEV 0x2 129 * #define NODEBOUND_DEV 0x4 130 * #define NODESPECIFIC_DEV 0x6 131 * #define ENUMERATED_DEV 0x8 132 */ 133 134 /* 135 * Device type defines which are used by the 'node_type' element of the 136 * ddi_minor_data structure 137 */ 138 #define DDI_NT_SERIAL "ddi_serial" /* Serial port */ 139 #define DDI_NT_SERIAL_MB "ddi_serial:mb" /* the 'built-in' serial */ 140 /* ports (the old ttya, b */ 141 /* (,c ,d)) */ 142 #define DDI_NT_SERIAL_DO "ddi_serial:dialout" /* dialout ports */ 143 #define DDI_NT_SERIAL_MB_DO "ddi_serial:dialout,mb" /* dialout for onboard */ 144 /* ports */ 145 #define DDI_NT_SERIAL_LOMCON "ddi_serial:lomcon" /* LOMlite2 console port */ 146 147 /* 148 * *_CHAN disk type devices have channel numbers or target numbers. 149 * (i.e. ipi and scsi devices) 150 */ 151 #define DDI_NT_BLOCK "ddi_block" /* hard disks */ 152 /* 153 * The next define is for block type devices that can possible exist on 154 * a sub-bus like the scsi bus or the ipi channel. The 'disks' program 155 * will pick up on this and create logical names like c0t0d0s0 instead of 156 * c0d0s0 157 */ 158 #define DDI_NT_BLOCK_CHAN "ddi_block:channel" 159 #define DDI_NT_BLOCK_WWN "ddi_block:wwn" 160 #define DDI_NT_CD "ddi_block:cdrom" /* rom drives (cd-rom) */ 161 #define DDI_NT_CD_CHAN "ddi_block:cdrom:channel" /* rom drives (scsi type) */ 162 #define DDI_NT_FD "ddi_block:diskette" /* floppy disks */ 163 164 #define DDI_NT_ENCLOSURE "ddi_enclosure" 165 #define DDI_NT_SCSI_ENCLOSURE "ddi_enclosure:scsi" 166 167 168 #define DDI_NT_TAPE "ddi_byte:tape" /* tape drives */ 169 170 #define DDI_NT_NET "ddi_network" /* DLPI network devices */ 171 172 #define DDI_NT_NET_WIFI "ddi_network:wifi" /* wifi devices */ 173 174 #define DDI_NT_MAC "ddi_mac" /* MAC devices */ 175 176 #define DDI_NT_DISPLAY "ddi_display" /* display devices */ 177 178 #define DDI_PSEUDO "ddi_pseudo" /* general pseudo devices */ 179 180 #define DDI_NT_AUDIO "ddi_audio" /* audio device */ 181 182 #define DDI_NT_MOUSE "ddi_mouse" /* mouse device */ 183 184 #define DDI_NT_KEYBOARD "ddi_keyboard" /* keyboard device */ 185 186 #define DDI_NT_PARALLEL "ddi_parallel" /* parallel port */ 187 188 #define DDI_NT_PRINTER "ddi_printer" /* printer device */ 189 190 #define DDI_NT_UGEN "ddi_generic:usb" /* USB generic drv */ 191 192 #define DDI_NT_NEXUS "ddi_ctl:devctl" /* nexus drivers */ 193 194 #define DDI_NT_SCSI_NEXUS "ddi_ctl:devctl:scsi" /* nexus drivers */ 195 196 #define DDI_NT_SATA_NEXUS "ddi_ctl:devctl:sata" /* nexus drivers */ 197 198 #define DDI_NT_ATTACHMENT_POINT "ddi_ctl:attachment_point" /* attachment pt */ 199 200 #define DDI_NT_SCSI_ATTACHMENT_POINT "ddi_ctl:attachment_point:scsi" 201 /* scsi attachment pt */ 202 203 #define DDI_NT_SATA_ATTACHMENT_POINT "ddi_ctl:attachment_point:sata" 204 /* sata attachment pt */ 205 206 #define DDI_NT_PCI_ATTACHMENT_POINT "ddi_ctl:attachment_point:pci" 207 /* PCI attachment pt */ 208 #define DDI_NT_SBD_ATTACHMENT_POINT "ddi_ctl:attachment_point:sbd" 209 /* generic bd attachment pt */ 210 #define DDI_NT_FC_ATTACHMENT_POINT "ddi_ctl:attachment_point:fc" 211 /* FC attachment pt */ 212 #define DDI_NT_USB_ATTACHMENT_POINT "ddi_ctl:attachment_point:usb" 213 /* USB devices */ 214 #define DDI_NT_BLOCK_FABRIC "ddi_block:fabric" 215 /* Fabric Devices */ 216 #define DDI_NT_IB_ATTACHMENT_POINT "ddi_ctl:attachment_point:ib" 217 /* IB devices */ 218 #define DDI_NT_SMARTCARD_READER "ddi_smartcard_reader" /* Smartcard reader */ 219 220 #define DDI_NT_AV_ASYNC "ddi_av:async" /* asynchronous AV device */ 221 #define DDI_NT_AV_ISOCH "ddi_av:isoch" /* isochronous AV device */ 222 223 /* Device types used for agpgart driver related devices */ 224 #define DDI_NT_AGP_PSEUDO "ddi_agp:pseudo" /* agpgart pseudo device */ 225 #define DDI_NT_AGP_MASTER "ddi_agp:master" /* agp master device */ 226 #define DDI_NT_AGP_TARGET "ddi_agp:target" /* agp target device */ 227 #define DDI_NT_AGP_CPUGART "ddi_agp:cpugart" /* amd64 on-cpu gart device */ 228 229 #define DDI_NT_REGACC "ddi_tool_reg" /* tool register access */ 230 #define DDI_NT_INTRCTL "ddi_tool_intr" /* tool intr access */ 231 232 /* 233 * DDI event definitions 234 */ 235 #define EC_DEVFS "EC_devfs" /* Event class devfs */ 236 #define EC_DDI "EC_ddi" /* Event class ddi */ 237 238 /* Class devfs subclasses */ 239 #define ESC_DEVFS_MINOR_CREATE "ESC_devfs_minor_create" 240 #define ESC_DEVFS_MINOR_REMOVE "ESC_devfs_minor_remove" 241 #define ESC_DEVFS_DEVI_ADD "ESC_devfs_devi_add" 242 #define ESC_DEVFS_DEVI_REMOVE "ESC_devfs_devi_remove" 243 #define ESC_DEVFS_INSTANCE_MOD "ESC_devfs_instance_mod" 244 #define ESC_DEVFS_BRANCH_ADD "ESC_devfs_branch_add" 245 #define ESC_DEVFS_BRANCH_REMOVE "ESC_devfs_branch_remove" 246 247 /* Class ddi subclasses */ 248 #define ESC_DDI_INITIATOR_REGISTER "ESC_ddi_initiator_register" 249 #define ESC_DDI_INITIATOR_UNREGISTER "ESC_ddi_initiator_unregister" 250 251 /* DDI/NDI event publisher */ 252 #define EP_DDI SUNW_KERN_PUB"ddi" 253 254 /* 255 * devfs event class attributes 256 * 257 * The following attributes are private to EC_DEVFS event data. 258 */ 259 #define DEVFS_DRIVER_NAME "di.driver" 260 #define DEVFS_INSTANCE "di.instance" 261 #define DEVFS_PATHNAME "di.path" 262 #define DEVFS_DEVI_CLASS "di.devi_class" 263 #define DEVFS_BRANCH_EVENT "di.branch_event" 264 #define DEVFS_MINOR_NAME "mi.name" 265 #define DEVFS_MINOR_NODETYPE "mi.nodetype" 266 #define DEVFS_MINOR_ISCLONE "mi.isclone" 267 #define DEVFS_MINOR_MAJNUM "mi.majorno" 268 #define DEVFS_MINOR_MINORNUM "mi.minorno" 269 270 /* 271 * ddi event class payload 272 * 273 * The following attributes are private to EC_DDI event data. 274 */ 275 #define DDI_DRIVER_NAME "ddi.driver" 276 #define DDI_DRIVER_MAJOR "ddi.major" 277 #define DDI_INSTANCE "ddi.instance" 278 #define DDI_PATHNAME "ddi.path" 279 #define DDI_CLASS "ddi.class" 280 281 /* 282 * Fault-related definitions 283 * 284 * The specific numeric values have been chosen to be ordered, but 285 * not consecutive, to allow for future interpolation if required. 286 */ 287 typedef enum { 288 DDI_SERVICE_LOST = -32, 289 DDI_SERVICE_DEGRADED = -16, 290 DDI_SERVICE_UNAFFECTED = 0, 291 DDI_SERVICE_RESTORED = 16 292 } ddi_fault_impact_t; 293 294 typedef enum { 295 DDI_DATAPATH_FAULT = -32, 296 DDI_DEVICE_FAULT = -16, 297 DDI_EXTERNAL_FAULT = 0 298 } ddi_fault_location_t; 299 300 typedef enum { 301 DDI_DEVSTATE_OFFLINE = -32, 302 DDI_DEVSTATE_DOWN = -16, 303 DDI_DEVSTATE_QUIESCED = 0, 304 DDI_DEVSTATE_DEGRADED = 16, 305 DDI_DEVSTATE_UP = 32 306 } ddi_devstate_t; 307 308 #ifdef _KERNEL 309 310 /* 311 * Common property definitions 312 */ 313 #define DDI_FORCEATTACH "ddi-forceattach" 314 #define DDI_NO_AUTODETACH "ddi-no-autodetach" 315 316 /* 317 * Values that the function supplied to the dev_info 318 * tree traversal functions defined below must return. 319 */ 320 321 /* 322 * Continue search, if appropriate. 323 */ 324 #define DDI_WALK_CONTINUE 0 325 326 /* 327 * Terminate current depth of traversal. That is, terminate 328 * the current traversal of children nodes, but continue 329 * traversing sibling nodes and their children (if any). 330 */ 331 332 #define DDI_WALK_PRUNECHILD -1 333 334 /* 335 * Terminate current width of traversal. That is, terminate 336 * the current traversal of sibling nodes, but continue with 337 * traversing children nodes and their siblings (if appropriate). 338 */ 339 340 #define DDI_WALK_PRUNESIB -2 341 342 /* 343 * Terminate the entire search. 344 */ 345 346 #define DDI_WALK_TERMINATE -3 347 348 /* 349 * Terminate the entire search because an error occurred in function 350 */ 351 #define DDI_WALK_ERROR -4 352 353 /* 354 * Drivers that are prepared to support full driver layering 355 * should create and export a null-valued property of the following 356 * name. 357 * 358 * Such drivers should be prepared to be called with FKLYR in 359 * the 'flag' argument of their open(9E), close(9E) routines, and 360 * with FKIOCTL in the 'mode' argument of their ioctl(9E) routines. 361 * 362 * See ioctl(9E) and ddi_copyin(9F) for details. 363 */ 364 #define DDI_KERNEL_IOCTL "ddi-kernel-ioctl" 365 366 /* 367 * Model definitions for ddi_mmap_get_model(9F) and ddi_model_convert_from(9F). 368 */ 369 #define DDI_MODEL_MASK DATAMODEL_MASK /* Note: 0x0FF00000 */ 370 #define DDI_MODEL_ILP32 DATAMODEL_ILP32 371 #define DDI_MODEL_LP64 DATAMODEL_LP64 372 #define DDI_MODEL_NATIVE DATAMODEL_NATIVE 373 #define DDI_MODEL_NONE DATAMODEL_NONE 374 375 /* 376 * Functions and data references which really should be in <sys/ddi.h> 377 */ 378 379 extern int maxphys; 380 extern void minphys(struct buf *); 381 extern int physio(int (*)(struct buf *), struct buf *, dev_t, 382 int, void (*)(struct buf *), struct uio *); 383 extern void disksort(struct diskhd *, struct buf *); 384 385 extern long strtol(const char *, char **, int); 386 extern unsigned long strtoul(const char *, char **, int); 387 extern size_t strlen(const char *) __PURE; 388 extern char *strcpy(char *, const char *); 389 extern char *strncpy(char *, const char *, size_t); 390 /* Need to be consistent with <string.h> C++ definition for strchr() */ 391 #if __cplusplus >= 199711L 392 extern const char *strchr(const char *, int); 393 #ifndef _STRCHR_INLINE 394 #define _STRCHR_INLINE 395 extern "C++" { 396 inline char *strchr(char *__s, int __c) { 397 return (char *)strchr((const char *)__s, __c); 398 } 399 } 400 #endif /* _STRCHR_INLINE */ 401 #else 402 extern char *strchr(const char *, int); 403 #endif /* __cplusplus >= 199711L */ 404 #define DDI_STRSAME(s1, s2) ((*(s1) == *(s2)) && (strcmp((s1), (s2)) == 0)) 405 extern int strcmp(const char *, const char *) __PURE; 406 extern int strncmp(const char *, const char *, size_t) __PURE; 407 extern char *strncat(char *, const char *, size_t); 408 extern size_t strlcat(char *, const char *, size_t); 409 extern size_t strlcpy(char *, const char *, size_t); 410 extern size_t strspn(const char *, const char *); 411 extern int bcmp(const void *, const void *, size_t) __PURE; 412 extern int stoi(char **); 413 extern void numtos(ulong_t, char *); 414 extern void bcopy(const void *, void *, size_t); 415 extern void bzero(void *, size_t); 416 417 extern void *memcpy(void *, const void *, size_t); 418 extern void *memset(void *, int, size_t); 419 extern void *memmove(void *, const void *, size_t); 420 extern int memcmp(const void *, const void *, size_t) __PURE; 421 /* Need to be consistent with <string.h> C++ definition for memchr() */ 422 #if __cplusplus >= 199711L 423 extern const void *memchr(const void *, int, size_t); 424 #ifndef _MEMCHR_INLINE 425 #define _MEMCHR_INLINE 426 extern "C++" { 427 inline void *memchr(void * __s, int __c, size_t __n) { 428 return (void *)memchr((const void *)__s, __c, __n); 429 } 430 } 431 #endif /* _MEMCHR_INLINE */ 432 #else 433 extern void *memchr(const void *, int, size_t); 434 #endif /* __cplusplus >= 199711L */ 435 436 extern int ddi_strtol(const char *, char **, int, long *); 437 extern int ddi_strtoul(const char *, char **, int, unsigned long *); 438 439 /* 440 * ddi_map_regs 441 * 442 * Map in the register set given by rnumber. 443 * The register number determine which register 444 * set will be mapped if more than one exists. 445 * The parent driver gets the information 446 * from parent private data and sets up the 447 * appropriate mappings and returns the kernel 448 * virtual address of the register set in *kaddrp. 449 * The offset specifies an offset into the register 450 * space to start from and len indicates the size 451 * of the area to map. If len and offset are 0 then 452 * the entire space is mapped. It returns DDI_SUCCESS on 453 * success or DDI_FAILURE otherwise. 454 * 455 */ 456 int 457 ddi_map_regs(dev_info_t *dip, uint_t rnumber, caddr_t *kaddrp, 458 off_t offset, off_t len); 459 460 /* 461 * ddi_unmap_regs 462 * 463 * Undo mappings set up by ddi_map_regs. 464 * The register number determines which register 465 * set will be unmapped if more than one exists. 466 * This is provided for drivers preparing 467 * to detach themselves from the system to 468 * allow them to release allocated mappings. 469 * 470 * The kaddrp and len specify the area to be 471 * unmapped. *kaddrp was returned from ddi_map_regs 472 * and len should match what ddi_map_regs was called 473 * with. 474 */ 475 476 void 477 ddi_unmap_regs(dev_info_t *dip, uint_t rnumber, caddr_t *kaddrp, 478 off_t offset, off_t len); 479 480 int 481 ddi_map(dev_info_t *dp, ddi_map_req_t *mp, off_t offset, off_t len, 482 caddr_t *addrp); 483 484 int 485 ddi_apply_range(dev_info_t *dip, dev_info_t *rdip, struct regspec *rp); 486 487 /* 488 * ddi_rnumber_to_regspec: Not for use by leaf drivers. 489 */ 490 struct regspec * 491 ddi_rnumber_to_regspec(dev_info_t *dip, int rnumber); 492 493 int 494 ddi_bus_map(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, off_t offset, 495 off_t len, caddr_t *vaddrp); 496 497 int 498 nullbusmap(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, off_t offset, 499 off_t len, caddr_t *vaddrp); 500 501 int ddi_peek8(dev_info_t *dip, int8_t *addr, int8_t *val_p); 502 int ddi_peek16(dev_info_t *dip, int16_t *addr, int16_t *val_p); 503 int ddi_peek32(dev_info_t *dip, int32_t *addr, int32_t *val_p); 504 int ddi_peek64(dev_info_t *dip, int64_t *addr, int64_t *val_p); 505 506 int ddi_poke8(dev_info_t *dip, int8_t *addr, int8_t val); 507 int ddi_poke16(dev_info_t *dip, int16_t *addr, int16_t val); 508 int ddi_poke32(dev_info_t *dip, int32_t *addr, int32_t val); 509 int ddi_poke64(dev_info_t *dip, int64_t *addr, int64_t val); 510 511 /* 512 * Peek and poke to and from a uio structure in xfersize pieces, 513 * using the parent nexi. 514 */ 515 int ddi_peekpokeio(dev_info_t *devi, struct uio *uio, enum uio_rw rw, 516 caddr_t addr, size_t len, uint_t xfersize); 517 518 /* 519 * Pagesize conversions using the parent nexi 520 */ 521 unsigned long ddi_btop(dev_info_t *dip, unsigned long bytes); 522 unsigned long ddi_btopr(dev_info_t *dip, unsigned long bytes); 523 unsigned long ddi_ptob(dev_info_t *dip, unsigned long pages); 524 525 /* 526 * There are no more "block" interrupt functions, per se. 527 * All thread of control should be done with MP/MT lockings. 528 * 529 * However, there are certain times in which a driver needs 530 * absolutely a critical guaranteed non-preemptable time 531 * in which to execute a few instructions. 532 * 533 * The following pair of functions attempt to guarantee this, 534 * but they are dangerous to use. That is, use them with 535 * extreme care. They do not guarantee to stop other processors 536 * from executing, but they do guarantee that the caller 537 * of ddi_enter_critical will continue to run until the 538 * caller calls ddi_exit_critical. No intervening DDI functions 539 * may be called between an entry and an exit from a critical 540 * region. 541 * 542 * ddi_enter_critical returns an integer identifier which must 543 * be passed to ddi_exit_critical. 544 * 545 * Be very sparing in the use of these functions since it is 546 * likely that absolutely nothing else can occur in the system 547 * whilst in the critical region. 548 */ 549 550 unsigned int 551 ddi_enter_critical(void); 552 553 void 554 ddi_exit_critical(unsigned int); 555 556 /* 557 * devmap functions 558 */ 559 int 560 devmap_setup(dev_t dev, offset_t off, ddi_as_handle_t as, caddr_t *addrp, 561 size_t len, uint_t prot, uint_t maxprot, uint_t flags, 562 struct cred *cred); 563 564 int 565 ddi_devmap_segmap(dev_t dev, off_t off, ddi_as_handle_t as, caddr_t *addrp, 566 off_t len, uint_t prot, uint_t maxprot, uint_t flags, 567 struct cred *cred); 568 569 int 570 devmap_load(devmap_cookie_t dhp, offset_t offset, size_t len, uint_t type, 571 uint_t rw); 572 573 int 574 devmap_unload(devmap_cookie_t dhp, offset_t offset, size_t len); 575 576 int 577 devmap_devmem_setup(devmap_cookie_t dhp, dev_info_t *dip, 578 struct devmap_callback_ctl *callback_ops, 579 uint_t rnumber, offset_t roff, size_t len, uint_t maxprot, 580 uint_t flags, ddi_device_acc_attr_t *accattrp); 581 582 int 583 devmap_umem_setup(devmap_cookie_t dhp, dev_info_t *dip, 584 struct devmap_callback_ctl *callback_ops, 585 ddi_umem_cookie_t cookie, offset_t off, size_t len, uint_t maxprot, 586 uint_t flags, ddi_device_acc_attr_t *accattrp); 587 588 int 589 devmap_devmem_remap(devmap_cookie_t dhp, dev_info_t *dip, 590 uint_t rnumber, offset_t roff, size_t len, uint_t maxprot, 591 uint_t flags, ddi_device_acc_attr_t *accattrp); 592 593 int 594 devmap_umem_remap(devmap_cookie_t dhp, dev_info_t *dip, 595 ddi_umem_cookie_t cookie, offset_t off, size_t len, uint_t maxprot, 596 uint_t flags, ddi_device_acc_attr_t *accattrp); 597 598 void 599 devmap_set_ctx_timeout(devmap_cookie_t dhp, clock_t ticks); 600 601 int 602 devmap_default_access(devmap_cookie_t dhp, void *pvtp, offset_t off, 603 size_t len, uint_t type, uint_t rw); 604 605 int 606 devmap_do_ctxmgt(devmap_cookie_t dhp, void *pvtp, offset_t off, size_t len, 607 uint_t type, uint_t rw, int (*ctxmgt)(devmap_cookie_t, void *, offset_t, 608 size_t, uint_t, uint_t)); 609 610 611 void *ddi_umem_alloc(size_t size, int flag, ddi_umem_cookie_t *cookiep); 612 613 void ddi_umem_free(ddi_umem_cookie_t cookie); 614 615 /* 616 * Functions to lock user memory and do repeated I/O or do devmap_umem_setup 617 */ 618 int 619 ddi_umem_lock(caddr_t addr, size_t size, int flags, ddi_umem_cookie_t *cookie); 620 621 void 622 ddi_umem_unlock(ddi_umem_cookie_t cookie); 623 624 struct buf * 625 ddi_umem_iosetup(ddi_umem_cookie_t cookie, off_t off, size_t len, int direction, 626 dev_t dev, daddr_t blkno, int (*iodone)(struct buf *), int sleepflag); 627 628 /* 629 * Mapping functions 630 */ 631 int 632 ddi_segmap(dev_t dev, off_t offset, struct as *asp, caddr_t *addrp, off_t len, 633 uint_t prot, uint_t maxprot, uint_t flags, cred_t *credp); 634 635 int 636 ddi_segmap_setup(dev_t dev, off_t offset, struct as *as, caddr_t *addrp, 637 off_t len, uint_t prot, uint_t maxprot, uint_t flags, cred_t *cred, 638 ddi_device_acc_attr_t *accattrp, uint_t rnumber); 639 640 int 641 ddi_map_fault(dev_info_t *dip, struct hat *hat, struct seg *seg, caddr_t addr, 642 struct devpage *dp, pfn_t pfn, uint_t prot, uint_t lock); 643 644 int 645 ddi_device_mapping_check(dev_t dev, ddi_device_acc_attr_t *accattrp, 646 uint_t rnumber, uint_t *hat_flags); 647 648 /* 649 * Property functions: See also, ddipropdefs.h. 650 * In general, the underlying driver MUST be held 651 * to call it's property functions. 652 */ 653 654 /* 655 * Used to create, modify, and lookup integer properties 656 */ 657 int ddi_prop_get_int(dev_t match_dev, dev_info_t *dip, uint_t flags, 658 char *name, int defvalue); 659 int64_t ddi_prop_get_int64(dev_t match_dev, dev_info_t *dip, uint_t flags, 660 char *name, int64_t defvalue); 661 int ddi_prop_lookup_int_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 662 char *name, int **data, uint_t *nelements); 663 int ddi_prop_lookup_int64_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 664 char *name, int64_t **data, uint_t *nelements); 665 int ddi_prop_update_int(dev_t match_dev, dev_info_t *dip, 666 char *name, int data); 667 int ddi_prop_update_int64(dev_t match_dev, dev_info_t *dip, 668 char *name, int64_t data); 669 int ddi_prop_update_int_array(dev_t match_dev, dev_info_t *dip, 670 char *name, int *data, uint_t nelements); 671 int ddi_prop_update_int64_array(dev_t match_dev, dev_info_t *dip, 672 char *name, int64_t *data, uint_t nelements); 673 /* 674 * Used to create, modify, and lookup string properties 675 */ 676 int ddi_prop_lookup_string(dev_t match_dev, dev_info_t *dip, uint_t flags, 677 char *name, char **data); 678 int ddi_prop_lookup_string_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 679 char *name, char ***data, uint_t *nelements); 680 int ddi_prop_update_string(dev_t match_dev, dev_info_t *dip, 681 char *name, char *data); 682 int ddi_prop_update_string_array(dev_t match_dev, dev_info_t *dip, 683 char *name, char **data, uint_t nelements); 684 685 /* 686 * Used to create, modify, and lookup byte properties 687 */ 688 int ddi_prop_lookup_byte_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 689 char *name, uchar_t **data, uint_t *nelements); 690 int ddi_prop_update_byte_array(dev_t match_dev, dev_info_t *dip, 691 char *name, uchar_t *data, uint_t nelements); 692 693 /* 694 * Used to verify the existence of a property or to see if a boolean 695 * property exists. 696 */ 697 int ddi_prop_exists(dev_t match_dev, dev_info_t *dip, uint_t flags, char *name); 698 699 /* 700 * Used to free the data returned by the above property routines. 701 */ 702 void ddi_prop_free(void *data); 703 704 /* 705 * nopropop: For internal use in `dummy' cb_prop_op functions only 706 */ 707 708 int 709 nopropop(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, int mod_flags, 710 char *name, caddr_t valuep, int *lengthp); 711 712 /* 713 * ddi_prop_op: The basic property operator for drivers. 714 * 715 * In ddi_prop_op, the type of valuep is interpreted based on prop_op: 716 * 717 * prop_op valuep 718 * ------ ------ 719 * 720 * PROP_LEN <unused> 721 * 722 * PROP_LEN_AND_VAL_BUF Pointer to callers buffer 723 * 724 * PROP_LEN_AND_VAL_ALLOC Address of callers pointer (will be set to 725 * address of allocated buffer, if successful) 726 */ 727 728 int 729 ddi_prop_op(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, int mod_flags, 730 char *name, caddr_t valuep, int *lengthp); 731 732 /* ddi_prop_op_size: for drivers that implement size in bytes */ 733 int 734 ddi_prop_op_size(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, 735 int mod_flags, char *name, caddr_t valuep, int *lengthp, 736 uint64_t size64); 737 738 /* ddi_prop_op_nblocks: for drivers that implement size in DEV_BSIZE blocks */ 739 int 740 ddi_prop_op_nblocks(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, 741 int mod_flags, char *name, caddr_t valuep, int *lengthp, 742 uint64_t nblocks64); 743 744 /* 745 * Variable length props... 746 */ 747 748 /* 749 * ddi_getlongprop: Get variable length property len+val into a buffer 750 * allocated by property provider via kmem_alloc. Requester 751 * is responsible for freeing returned property via kmem_free. 752 * 753 * Arguments: 754 * 755 * dev: Input: dev_t of property. 756 * dip: Input: dev_info_t pointer of child. 757 * flags: Input: Possible flag modifiers are: 758 * DDI_PROP_DONTPASS: Don't pass to parent if prop not found. 759 * DDI_PROP_CANSLEEP: Memory allocation may sleep. 760 * name: Input: name of property. 761 * valuep: Output: Addr of callers buffer pointer. 762 * lengthp:Output: *lengthp will contain prop length on exit. 763 * 764 * Possible Returns: 765 * 766 * DDI_PROP_SUCCESS: Prop found and returned. 767 * DDI_PROP_NOT_FOUND: Prop not found 768 * DDI_PROP_UNDEFINED: Prop explicitly undefined. 769 * DDI_PROP_NO_MEMORY: Prop found, but unable to alloc mem. 770 */ 771 772 int 773 ddi_getlongprop(dev_t dev, dev_info_t *dip, int flags, 774 char *name, caddr_t valuep, int *lengthp); 775 776 /* 777 * 778 * ddi_getlongprop_buf: Get long prop into pre-allocated callers 779 * buffer. (no memory allocation by provider). 780 * 781 * dev: Input: dev_t of property. 782 * dip: Input: dev_info_t pointer of child. 783 * flags: Input: DDI_PROP_DONTPASS or NULL 784 * name: Input: name of property 785 * valuep: Input: ptr to callers buffer. 786 * lengthp:I/O: ptr to length of callers buffer on entry, 787 * actual length of property on exit. 788 * 789 * Possible returns: 790 * 791 * DDI_PROP_SUCCESS Prop found and returned 792 * DDI_PROP_NOT_FOUND Prop not found 793 * DDI_PROP_UNDEFINED Prop explicitly undefined. 794 * DDI_PROP_BUF_TOO_SMALL Prop found, callers buf too small, 795 * no value returned, but actual prop 796 * length returned in *lengthp 797 * 798 */ 799 800 int 801 ddi_getlongprop_buf(dev_t dev, dev_info_t *dip, int flags, 802 char *name, caddr_t valuep, int *lengthp); 803 804 /* 805 * Integer/boolean sized props. 806 * 807 * Call is value only... returns found boolean or int sized prop value or 808 * defvalue if prop not found or is wrong length or is explicitly undefined. 809 * Only flag is DDI_PROP_DONTPASS... 810 * 811 * By convention, this interface returns boolean (0) sized properties 812 * as value (int)1. 813 */ 814 815 int 816 ddi_getprop(dev_t dev, dev_info_t *dip, int flags, char *name, int defvalue); 817 818 /* 819 * Get prop length interface: flags are 0 or DDI_PROP_DONTPASS 820 * if returns DDI_PROP_SUCCESS, length returned in *lengthp. 821 */ 822 823 int 824 ddi_getproplen(dev_t dev, dev_info_t *dip, int flags, char *name, int *lengthp); 825 826 827 /* 828 * Interface to create/modify a managed property on child's behalf... 829 * Only flag is DDI_PROP_CANSLEEP to allow memory allocation to sleep 830 * if no memory available for internal prop structure. Long property 831 * (non integer sized) value references are not copied. 832 * 833 * Define property with DDI_DEV_T_NONE dev_t for properties not associated 834 * with any particular dev_t. Use the same dev_t when modifying or undefining 835 * a property. 836 * 837 * No guarantee on order of property search, so don't mix the same 838 * property name with wildcard and non-wildcard dev_t's. 839 */ 840 841 /* 842 * ddi_prop_create: Define a managed property: 843 */ 844 845 int 846 ddi_prop_create(dev_t dev, dev_info_t *dip, int flag, 847 char *name, caddr_t value, int length); 848 849 /* 850 * ddi_prop_modify: Modify a managed property value 851 */ 852 853 int 854 ddi_prop_modify(dev_t dev, dev_info_t *dip, int flag, 855 char *name, caddr_t value, int length); 856 857 /* 858 * ddi_prop_remove: Undefine a managed property: 859 */ 860 861 int 862 ddi_prop_remove(dev_t dev, dev_info_t *dip, char *name); 863 864 /* 865 * ddi_prop_remove_all: Used before unloading a driver to remove 866 * all properties. (undefines all dev_t's props.) 867 * Also removes `undefined' prop defs. 868 */ 869 870 void 871 ddi_prop_remove_all(dev_info_t *dip); 872 873 874 /* 875 * ddi_prop_undefine: Explicitly undefine a property. Property 876 * searches which match this property return 877 * the error code DDI_PROP_UNDEFINED. 878 * 879 * Use ddi_prop_remove to negate effect of 880 * ddi_prop_undefine 881 */ 882 883 int 884 ddi_prop_undefine(dev_t dev, dev_info_t *dip, int flag, char *name); 885 886 887 /* 888 * The default ddi_bus_prop_op wrapper... 889 */ 890 891 int 892 ddi_bus_prop_op(dev_t dev, dev_info_t *dip, dev_info_t *ch_dip, 893 ddi_prop_op_t prop_op, int mod_flags, 894 char *name, caddr_t valuep, int *lengthp); 895 896 897 /* 898 * Routines to traverse the tree of dev_info nodes. 899 * The general idea of these functions is to provide 900 * various tree traversal utilities. For each node 901 * that the tree traversal function finds, a caller 902 * supplied function is called with arguments of 903 * the current node and a caller supplied argument. 904 * The caller supplied function should return one 905 * of the integer values defined below which will 906 * indicate to the tree traversal function whether 907 * the traversal should be continued, and if so, how, 908 * or whether the traversal should terminate. 909 */ 910 911 /* 912 * This general-purpose routine traverses the tree of dev_info nodes, 913 * starting from the given node, and calls the given function for each 914 * node that it finds with the current node and the pointer arg (which 915 * can point to a structure of information that the function 916 * needs) as arguments. 917 * 918 * It does the walk a layer at a time, not depth-first. 919 * 920 * The given function must return one of the values defined above. 921 * 922 */ 923 924 void 925 ddi_walk_devs(dev_info_t *, int (*)(dev_info_t *, void *), void *); 926 927 /* 928 * Routines to get at elements of the dev_info structure 929 */ 930 931 /* 932 * ddi_node_name gets the device's 'name' from the device node. 933 * 934 * ddi_binding_name gets the string the OS used to bind the node to a driver, 935 * in certain cases, the binding name may be different from the node name, 936 * if the node name does not name a specific device driver. 937 * 938 * ddi_get_name is a synonym for ddi_binding_name(). 939 */ 940 char * 941 ddi_get_name(dev_info_t *dip); 942 943 char * 944 ddi_binding_name(dev_info_t *dip); 945 946 const char * 947 ddi_driver_name(dev_info_t *dip); 948 949 major_t 950 ddi_driver_major(dev_info_t *dip); 951 952 major_t 953 ddi_compatible_driver_major(dev_info_t *dip, char **formp); 954 955 char * 956 ddi_node_name(dev_info_t *dip); 957 958 int 959 ddi_get_nodeid(dev_info_t *dip); 960 961 int 962 ddi_get_instance(dev_info_t *dip); 963 964 struct dev_ops * 965 ddi_get_driver(dev_info_t *dip); 966 967 void 968 ddi_set_driver(dev_info_t *dip, struct dev_ops *devo); 969 970 void 971 ddi_set_driver_private(dev_info_t *dip, void *data); 972 973 void * 974 ddi_get_driver_private(dev_info_t *dip); 975 976 /* 977 * ddi_dev_is_needed tells system that a device is about to use a 978 * component. Returns when component is ready. 979 */ 980 int 981 ddi_dev_is_needed(dev_info_t *dip, int cmpt, int level); 982 983 /* 984 * check if DDI_SUSPEND may result in power being removed from a device. 985 */ 986 int 987 ddi_removing_power(dev_info_t *dip); 988 989 /* 990 * (Obsolete) power entry point 991 */ 992 int 993 ddi_power(dev_info_t *dip, int cmpt, int level); 994 995 /* 996 * ddi_get_parent requires that the branch of the tree with the 997 * node be held (ddi_hold_installed_driver) or that the devinfo tree 998 * lock be held 999 */ 1000 dev_info_t * 1001 ddi_get_parent(dev_info_t *dip); 1002 1003 /* 1004 * ddi_get_child and ddi_get_next_sibling require that the devinfo 1005 * tree lock be held 1006 */ 1007 dev_info_t * 1008 ddi_get_child(dev_info_t *dip); 1009 1010 dev_info_t * 1011 ddi_get_next_sibling(dev_info_t *dip); 1012 1013 dev_info_t * 1014 ddi_get_next(dev_info_t *dip); 1015 1016 void 1017 ddi_set_next(dev_info_t *dip, dev_info_t *nextdip); 1018 1019 /* 1020 * dev_info manipulation functions 1021 */ 1022 1023 /* 1024 * Add and remove child devices. These are part of the system framework. 1025 * 1026 * ddi_add_child creates a dev_info structure with the passed name, 1027 * nodeid and instance arguments and makes it a child of pdip. Devices 1028 * that are known directly by the hardware have real nodeids; devices 1029 * that are software constructs use the defined DEVI_PSEUDO_NODEID 1030 * for the node id. 1031 * 1032 * ddi_remove_node removes the node from the tree. This fails if this 1033 * child has children. Parent and driver private data should already 1034 * be released (freed) prior to calling this function. If flag is 1035 * non-zero, the child is removed from it's linked list of instances. 1036 */ 1037 dev_info_t * 1038 ddi_add_child(dev_info_t *pdip, char *name, uint_t nodeid, uint_t instance); 1039 1040 int 1041 ddi_remove_child(dev_info_t *dip, int flag); 1042 1043 /* 1044 * Given the major number for a driver, make sure that dev_info nodes 1045 * are created form the driver's hwconf file, the driver for the named 1046 * device is loaded and attached, as well as any drivers for parent devices. 1047 * Return a pointer to the driver's dev_ops struct with the dev_ops held. 1048 * Note - Callers must release the dev_ops with ddi_rele_driver. 1049 * 1050 * When a driver is held, the branch of the devinfo tree from any of the 1051 * drivers devinfos to the root node are automatically held. This only 1052 * applies to tree traversals up (and back down) the tree following the 1053 * parent pointers. 1054 * 1055 * Use of this interface is discouraged, it may be removed in a future release. 1056 */ 1057 struct dev_ops * 1058 ddi_hold_installed_driver(major_t major); 1059 1060 void 1061 ddi_rele_driver(major_t major); 1062 1063 /* 1064 * Attach and hold the specified instance of a driver. The flags argument 1065 * should be zero. 1066 */ 1067 dev_info_t * 1068 ddi_hold_devi_by_instance(major_t major, int instance, int flags); 1069 1070 void 1071 ddi_release_devi(dev_info_t *); 1072 1073 /* 1074 * Associate a streams queue with a devinfo node 1075 */ 1076 void 1077 ddi_assoc_queue_with_devi(queue_t *, dev_info_t *); 1078 1079 /* 1080 * Given the identifier string passed, make sure that dev_info nodes 1081 * are created form the driver's hwconf file, the driver for the named 1082 * device is loaded and attached, as well as any drivers for parent devices. 1083 * 1084 * Note that the driver is not held and is subject to being removed the instant 1085 * this call completes. You probably really want ddi_hold_installed_driver. 1086 */ 1087 int 1088 ddi_install_driver(char *idstring); 1089 1090 /* 1091 * Routines that return specific nodes 1092 */ 1093 1094 dev_info_t * 1095 ddi_root_node(void); 1096 1097 /* 1098 * Given a name and an instance number, find and return the 1099 * dev_info from the current state of the device tree. 1100 * 1101 * If instance number is -1, return the first named instance. 1102 * 1103 * If attached is 1, exclude all nodes that are < DS_ATTACHED 1104 * 1105 * Requires that the devinfo tree be locked. 1106 * If attached is 1, the driver must be held. 1107 */ 1108 dev_info_t * 1109 ddi_find_devinfo(char *name, int instance, int attached); 1110 1111 /* 1112 * Synchronization of I/O with respect to various 1113 * caches and system write buffers. 1114 * 1115 * Done at varying points during an I/O transfer (including at the 1116 * removal of an I/O mapping). 1117 * 1118 * Due to the support of systems with write buffers which may 1119 * not be able to be turned off, this function *must* used at 1120 * any point in which data consistency might be required. 1121 * 1122 * Generally this means that if a memory object has multiple mappings 1123 * (both for I/O, as described by the handle, and the IU, via, e.g. 1124 * a call to ddi_dma_kvaddrp), and one mapping may have been 1125 * used to modify the memory object, this function must be called 1126 * to ensure that the modification of the memory object is 1127 * complete, as well as possibly to inform other mappings of 1128 * the object that any cached references to the object are 1129 * now stale (and flush or invalidate these stale cache references 1130 * as necessary). 1131 * 1132 * The function ddi_dma_sync() provides the general interface with 1133 * respect to this capability. Generally, ddi_dma_free() (below) may 1134 * be used in preference to ddi_dma_sync() as ddi_dma_free() calls 1135 * ddi_dma_sync(). 1136 * 1137 * Returns 0 if all caches that exist and are specified by cache_flags 1138 * are successfully operated on, else -1. 1139 * 1140 * The argument offset specifies an offset into the mapping of the mapped 1141 * object in which to perform the synchronization. It will be silently 1142 * truncated to the granularity of underlying cache line sizes as 1143 * appropriate. 1144 * 1145 * The argument len specifies a length starting from offset in which to 1146 * perform the synchronization. A value of (uint_t) -1 means that the length 1147 * proceeds from offset to the end of the mapping. The length argument 1148 * will silently rounded up to the granularity of underlying cache line 1149 * sizes as appropriate. 1150 * 1151 * The argument flags specifies what to synchronize (the device's view of 1152 * the object or the cpu's view of the object). 1153 * 1154 * Inquiring minds want to know when ddi_dma_sync should be used: 1155 * 1156 * + When an object is mapped for dma, assume that an 1157 * implicit ddi_dma_sync() is done for you. 1158 * 1159 * + When an object is unmapped (ddi_dma_free()), assume 1160 * that an implicit ddi_dma_sync() is done for you. 1161 * 1162 * + At any time between the two times above that the 1163 * memory object may have been modified by either 1164 * the DMA device or a processor and you wish that 1165 * the change be noticed by the master that didn't 1166 * do the modifying. 1167 * 1168 * Clearly, only the third case above requires the use of ddi_dma_sync. 1169 * 1170 * Inquiring minds also want to know which flag to use: 1171 * 1172 * + If you *modify* with a cpu the object, you use 1173 * ddi_dma_sync(...DDI_DMA_SYNC_FORDEV) (you are making sure 1174 * that the DMA device sees the changes you made). 1175 * 1176 * + If you are checking, with the processor, an area 1177 * of the object that the DMA device *may* have modified, 1178 * you use ddi_dma_sync(....DDI_DMA_SYNC_FORCPU) (you are 1179 * making sure that the processor(s) will see the changes 1180 * that the DMA device may have made). 1181 */ 1182 1183 int 1184 ddi_dma_sync(ddi_dma_handle_t handle, off_t offset, size_t len, uint_t flags); 1185 1186 /* 1187 * Return the allowable DMA burst size for the object mapped by handle. 1188 * The burst sizes will returned in an integer that encodes power 1189 * of two burst sizes that are allowed in bit encoded format. For 1190 * example, a transfer that could allow 1, 2, 4, 8 and 32 byte bursts 1191 * would be encoded as 0x2f. A transfer that could be allowed as solely 1192 * a halfword (2 byte) transfers would be returned as 0x2. 1193 */ 1194 1195 int 1196 ddi_dma_burstsizes(ddi_dma_handle_t handle); 1197 1198 /* 1199 * Merge DMA attributes 1200 */ 1201 1202 void 1203 ddi_dma_attr_merge(ddi_dma_attr_t *attr, ddi_dma_attr_t *mod); 1204 1205 /* 1206 * Allocate a DMA handle 1207 */ 1208 1209 int 1210 ddi_dma_alloc_handle(dev_info_t *dip, ddi_dma_attr_t *attr, 1211 int (*waitfp)(caddr_t), caddr_t arg, 1212 ddi_dma_handle_t *handlep); 1213 1214 /* 1215 * Free DMA handle 1216 */ 1217 1218 void 1219 ddi_dma_free_handle(ddi_dma_handle_t *handlep); 1220 1221 /* 1222 * Allocate memory for DMA transfers 1223 */ 1224 1225 int 1226 ddi_dma_mem_alloc(ddi_dma_handle_t handle, size_t length, 1227 ddi_device_acc_attr_t *accattrp, uint_t xfermodes, 1228 int (*waitfp)(caddr_t), caddr_t arg, caddr_t *kaddrp, 1229 size_t *real_length, ddi_acc_handle_t *handlep); 1230 1231 /* 1232 * Free DMA memory 1233 */ 1234 1235 void 1236 ddi_dma_mem_free(ddi_acc_handle_t *hp); 1237 1238 /* 1239 * bind address to a DMA handle 1240 */ 1241 1242 int 1243 ddi_dma_addr_bind_handle(ddi_dma_handle_t handle, struct as *as, 1244 caddr_t addr, size_t len, uint_t flags, 1245 int (*waitfp)(caddr_t), caddr_t arg, 1246 ddi_dma_cookie_t *cookiep, uint_t *ccountp); 1247 1248 /* 1249 * bind buffer to DMA handle 1250 */ 1251 1252 int 1253 ddi_dma_buf_bind_handle(ddi_dma_handle_t handle, struct buf *bp, 1254 uint_t flags, int (*waitfp)(caddr_t), caddr_t arg, 1255 ddi_dma_cookie_t *cookiep, uint_t *ccountp); 1256 1257 /* 1258 * unbind mapping object to handle 1259 */ 1260 1261 int 1262 ddi_dma_unbind_handle(ddi_dma_handle_t handle); 1263 1264 /* 1265 * get next DMA cookie 1266 */ 1267 1268 void 1269 ddi_dma_nextcookie(ddi_dma_handle_t handle, ddi_dma_cookie_t *cookiep); 1270 1271 /* 1272 * get number of DMA windows 1273 */ 1274 1275 int 1276 ddi_dma_numwin(ddi_dma_handle_t handle, uint_t *nwinp); 1277 1278 /* 1279 * get specific DMA window 1280 */ 1281 1282 int 1283 ddi_dma_getwin(ddi_dma_handle_t handle, uint_t win, off_t *offp, 1284 size_t *lenp, ddi_dma_cookie_t *cookiep, uint_t *ccountp); 1285 1286 /* 1287 * activate 64 bit SBus support 1288 */ 1289 1290 int 1291 ddi_dma_set_sbus64(ddi_dma_handle_t handle, ulong_t burstsizes); 1292 1293 /* 1294 * Miscellaneous functions 1295 */ 1296 1297 /* 1298 * ddi_report_dev: Report a successful attach. 1299 */ 1300 1301 void 1302 ddi_report_dev(dev_info_t *dev); 1303 1304 /* 1305 * ddi_dev_regsize 1306 * 1307 * If the device has h/w register(s), report 1308 * the size, in bytes, of the specified one into *resultp. 1309 * 1310 * Returns DDI_FAILURE if there are not registers, 1311 * or the specified register doesn't exist. 1312 */ 1313 1314 int 1315 ddi_dev_regsize(dev_info_t *dev, uint_t rnumber, off_t *resultp); 1316 1317 /* 1318 * ddi_dev_nregs 1319 * 1320 * If the device has h/w register(s), report 1321 * how many of them that there are into resultp. 1322 * Return DDI_FAILURE if the device has no registers. 1323 */ 1324 1325 int 1326 ddi_dev_nregs(dev_info_t *dev, int *resultp); 1327 1328 /* 1329 * ddi_dev_is_sid 1330 * 1331 * If the device is self-identifying, i.e., 1332 * has already been probed by a smart PROM 1333 * (and thus registers are known to be valid) 1334 * return DDI_SUCCESS, else DDI_FAILURE. 1335 */ 1336 1337 1338 int 1339 ddi_dev_is_sid(dev_info_t *dev); 1340 1341 /* 1342 * ddi_slaveonly 1343 * 1344 * If the device is on a bus that precludes 1345 * the device from being either a dma master or 1346 * a dma slave, return DDI_SUCCESS. 1347 */ 1348 1349 int 1350 ddi_slaveonly(dev_info_t *); 1351 1352 1353 /* 1354 * ddi_dev_affinity 1355 * 1356 * Report, via DDI_SUCCESS, whether there exists 1357 * an 'affinity' between two dev_info_t's. An 1358 * affinity is defined to be either a parent-child, 1359 * or a sibling relationship such that the siblings 1360 * or in the same part of the bus they happen to be 1361 * on. 1362 */ 1363 1364 int 1365 ddi_dev_affinity(dev_info_t *deva, dev_info_t *devb); 1366 1367 1368 /* 1369 * ddi_set_callback 1370 * 1371 * Set a function/arg pair into the callback list identified 1372 * by listid. *listid must always initially start out as zero. 1373 */ 1374 1375 void 1376 ddi_set_callback(int (*funcp)(caddr_t), caddr_t arg, uintptr_t *listid); 1377 1378 /* 1379 * ddi_run_callback 1380 * 1381 * Run the callback list identified by listid. 1382 */ 1383 1384 void 1385 ddi_run_callback(uintptr_t *listid); 1386 1387 /* 1388 * More miscellaneous 1389 */ 1390 1391 int 1392 nochpoll(dev_t dev, short events, int anyyet, short *reventsp, 1393 struct pollhead **phpp); 1394 1395 dev_info_t * 1396 nodevinfo(dev_t dev, int otyp); 1397 1398 int 1399 ddi_no_info(dev_info_t *dip, ddi_info_cmd_t infocmd, void *arg, void **result); 1400 1401 int 1402 ddi_getinfo_1to1(dev_info_t *dip, ddi_info_cmd_t infocmd, 1403 void *arg, void **result); 1404 1405 int 1406 ddifail(dev_info_t *devi, ddi_attach_cmd_t cmd); 1407 1408 int 1409 ddi_no_dma_map(dev_info_t *dip, dev_info_t *rdip, 1410 struct ddi_dma_req *dmareqp, ddi_dma_handle_t *handlep); 1411 1412 int 1413 ddi_no_dma_allochdl(dev_info_t *dip, dev_info_t *rdip, ddi_dma_attr_t *attr, 1414 int (*waitfp)(caddr_t), caddr_t arg, ddi_dma_handle_t *handlep); 1415 1416 int 1417 ddi_no_dma_freehdl(dev_info_t *dip, dev_info_t *rdip, 1418 ddi_dma_handle_t handle); 1419 1420 int 1421 ddi_no_dma_bindhdl(dev_info_t *dip, dev_info_t *rdip, 1422 ddi_dma_handle_t handle, struct ddi_dma_req *dmareq, 1423 ddi_dma_cookie_t *cp, uint_t *ccountp); 1424 1425 int 1426 ddi_no_dma_unbindhdl(dev_info_t *dip, dev_info_t *rdip, 1427 ddi_dma_handle_t handle); 1428 1429 int 1430 ddi_no_dma_flush(dev_info_t *dip, dev_info_t *rdip, 1431 ddi_dma_handle_t handle, off_t off, size_t len, 1432 uint_t cache_flags); 1433 1434 int 1435 ddi_no_dma_win(dev_info_t *dip, dev_info_t *rdip, 1436 ddi_dma_handle_t handle, uint_t win, off_t *offp, 1437 size_t *lenp, ddi_dma_cookie_t *cookiep, uint_t *ccountp); 1438 1439 int 1440 ddi_no_dma_mctl(register dev_info_t *dip, dev_info_t *rdip, 1441 ddi_dma_handle_t handle, enum ddi_dma_ctlops request, 1442 off_t *offp, size_t *lenp, caddr_t *objp, uint_t flags); 1443 1444 void 1445 ddivoid(); 1446 1447 cred_t * 1448 ddi_get_cred(void); 1449 1450 clock_t 1451 ddi_get_lbolt(void); 1452 1453 time_t 1454 ddi_get_time(void); 1455 1456 pid_t 1457 ddi_get_pid(void); 1458 1459 kt_did_t 1460 ddi_get_kt_did(void); 1461 1462 boolean_t 1463 ddi_can_receive_sig(void); 1464 1465 void 1466 swab(void *src, void *dst, size_t nbytes); 1467 1468 int 1469 ddi_create_minor_node(dev_info_t *dip, char *name, int spec_type, 1470 minor_t minor_num, char *node_type, int flag); 1471 1472 int 1473 ddi_create_priv_minor_node(dev_info_t *dip, char *name, int spec_type, 1474 minor_t minor_num, char *node_type, int flag, 1475 const char *rdpriv, const char *wrpriv, mode_t priv_mode); 1476 1477 void 1478 ddi_remove_minor_node(dev_info_t *dip, char *name); 1479 1480 int 1481 ddi_in_panic(void); 1482 1483 int 1484 ddi_streams_driver(dev_info_t *dip); 1485 1486 /* 1487 * DDI wrappers for ffs and fls 1488 */ 1489 int 1490 ddi_ffs(long mask); 1491 1492 int 1493 ddi_fls(long mask); 1494 1495 /* 1496 * The next five routines comprise generic storage management utilities 1497 * for driver soft state structures. 1498 */ 1499 1500 /* 1501 * Allocate a set of pointers to 'n_items' objects of size 'size' 1502 * bytes. Each pointer is initialized to nil. 'n_items' is a hint i.e. 1503 * zero is allowed. 1504 */ 1505 int 1506 ddi_soft_state_init(void **state_p, size_t size, size_t n_items); 1507 1508 /* 1509 * Allocate a state structure of size 'size' to be associated 1510 * with item 'item'. 1511 */ 1512 int 1513 ddi_soft_state_zalloc(void *state, int item); 1514 1515 /* 1516 * Fetch a pointer to the allocated soft state structure 1517 * corresponding to 'item.' 1518 */ 1519 void * 1520 ddi_get_soft_state(void *state, int item); 1521 1522 /* 1523 * Free the state structure corresponding to 'item.' 1524 */ 1525 void 1526 ddi_soft_state_free(void *state, int item); 1527 1528 /* 1529 * Free the handle, and any associated soft state structures. 1530 */ 1531 void 1532 ddi_soft_state_fini(void **state_p); 1533 1534 /* 1535 * Set the addr field of the name in dip to name 1536 */ 1537 void 1538 ddi_set_name_addr(dev_info_t *dip, char *name); 1539 1540 /* 1541 * Get the address part of the name. 1542 */ 1543 char * 1544 ddi_get_name_addr(dev_info_t *dip); 1545 1546 void 1547 ddi_set_parent_data(dev_info_t *dip, void *pd); 1548 1549 void * 1550 ddi_get_parent_data(dev_info_t *dip); 1551 1552 int 1553 ddi_initchild(dev_info_t *parent, dev_info_t *proto); 1554 1555 int 1556 ddi_uninitchild(dev_info_t *dip); 1557 1558 major_t 1559 ddi_name_to_major(char *name); 1560 1561 char * 1562 ddi_major_to_name(major_t major); 1563 1564 char * 1565 ddi_deviname(dev_info_t *dip, char *name); 1566 1567 char * 1568 ddi_pathname(dev_info_t *dip, char *path); 1569 1570 int 1571 ddi_dev_pathname(dev_t devt, int spec_type, char *name); 1572 1573 dev_t 1574 ddi_pathname_to_dev_t(char *pathname); 1575 1576 /* 1577 * High resolution system timer functions. 1578 * 1579 * These functions are already in the kernel (see sys/time.h). 1580 * The ddi supports the notion of a hrtime_t type and the 1581 * functions gethrtime, hrtadd, hrtsub and hrtcmp. 1582 */ 1583 1584 1585 /* 1586 * Nexus wrapper functions 1587 * 1588 * These functions are for entries in a bus nexus driver's bus_ops 1589 * structure for when the driver doesn't have such a function and 1590 * doesn't wish to prohibit such a function from existing. They 1591 * may also be called to start passing a request up the dev_info 1592 * tree. 1593 */ 1594 1595 /* 1596 * bus_ctl wrapper 1597 */ 1598 1599 int 1600 ddi_ctlops(dev_info_t *d, dev_info_t *r, ddi_ctl_enum_t o, void *a, void *v); 1601 1602 /* 1603 * bus_dma_map wrapper 1604 */ 1605 1606 int 1607 ddi_dma_map(dev_info_t *dip, dev_info_t *rdip, 1608 struct ddi_dma_req *dmareqp, ddi_dma_handle_t *handlep); 1609 1610 int 1611 ddi_dma_allochdl(dev_info_t *dip, dev_info_t *rdip, ddi_dma_attr_t *attr, 1612 int (*waitfp)(caddr_t), caddr_t arg, ddi_dma_handle_t *handlep); 1613 1614 int 1615 ddi_dma_freehdl(dev_info_t *dip, dev_info_t *rdip, 1616 ddi_dma_handle_t handle); 1617 1618 int 1619 ddi_dma_bindhdl(dev_info_t *dip, dev_info_t *rdip, 1620 ddi_dma_handle_t handle, struct ddi_dma_req *dmareq, 1621 ddi_dma_cookie_t *cp, uint_t *ccountp); 1622 1623 int 1624 ddi_dma_unbindhdl(dev_info_t *dip, dev_info_t *rdip, 1625 ddi_dma_handle_t handle); 1626 1627 int 1628 ddi_dma_flush(dev_info_t *dip, dev_info_t *rdip, 1629 ddi_dma_handle_t handle, off_t off, size_t len, 1630 uint_t cache_flags); 1631 1632 int 1633 ddi_dma_win(dev_info_t *dip, dev_info_t *rdip, 1634 ddi_dma_handle_t handle, uint_t win, off_t *offp, 1635 size_t *lenp, ddi_dma_cookie_t *cookiep, uint_t *ccountp); 1636 1637 /* 1638 * bus_dma_ctl wrapper 1639 */ 1640 1641 int 1642 ddi_dma_mctl(dev_info_t *dip, dev_info_t *rdip, ddi_dma_handle_t handle, 1643 enum ddi_dma_ctlops request, off_t *offp, size_t *lenp, 1644 caddr_t *objp, uint_t flags); 1645 1646 /* 1647 * dvma support for networking drivers 1648 */ 1649 1650 unsigned long 1651 dvma_pagesize(dev_info_t *dip); 1652 1653 int 1654 dvma_reserve(dev_info_t *dip, ddi_dma_lim_t *limp, uint_t pages, 1655 ddi_dma_handle_t *handlep); 1656 1657 void 1658 dvma_release(ddi_dma_handle_t h); 1659 1660 void 1661 dvma_kaddr_load(ddi_dma_handle_t h, caddr_t a, uint_t len, uint_t index, 1662 ddi_dma_cookie_t *cp); 1663 1664 void 1665 dvma_unload(ddi_dma_handle_t h, uint_t objindex, uint_t type); 1666 1667 void 1668 dvma_sync(ddi_dma_handle_t h, uint_t objindex, uint_t type); 1669 1670 /* 1671 * Layered driver support 1672 */ 1673 1674 extern int ddi_copyin(const void *, void *, size_t, int); 1675 extern int ddi_copyout(const void *, void *, size_t, int); 1676 1677 /* 1678 * Send signals to processes 1679 */ 1680 extern void *proc_ref(void); 1681 extern void proc_unref(void *pref); 1682 extern int proc_signal(void *pref, int sig); 1683 1684 /* I/O port access routines */ 1685 extern uint8_t inb(int port); 1686 extern uint16_t inw(int port); 1687 extern uint32_t inl(int port); 1688 extern void outb(int port, uint8_t value); 1689 extern void outw(int port, uint16_t value); 1690 extern void outl(int port, uint32_t value); 1691 1692 /* 1693 * Console bell routines 1694 */ 1695 extern void ddi_ring_console_bell(clock_t duration); 1696 extern void ddi_set_console_bell(void (*bellfunc)(clock_t duration)); 1697 1698 /* 1699 * Fault-related functions 1700 */ 1701 extern int ddi_check_acc_handle(ddi_acc_handle_t); 1702 extern int ddi_check_dma_handle(ddi_dma_handle_t); 1703 extern void ddi_dev_report_fault(dev_info_t *, ddi_fault_impact_t, 1704 ddi_fault_location_t, const char *); 1705 extern ddi_devstate_t ddi_get_devstate(dev_info_t *); 1706 1707 /* 1708 * Miscellaneous redefines 1709 */ 1710 #define uiophysio physio 1711 1712 /* 1713 * utilities - "reg" mapping and all common portable data access functions 1714 */ 1715 1716 /* 1717 * error code from ddi_regs_map_setup 1718 */ 1719 1720 #define DDI_REGS_ACC_CONFLICT (-10) 1721 1722 /* 1723 * Device address advance flags 1724 */ 1725 1726 #define DDI_DEV_NO_AUTOINCR 0x0000 1727 #define DDI_DEV_AUTOINCR 0x0001 1728 1729 int 1730 ddi_regs_map_setup(dev_info_t *dip, uint_t rnumber, caddr_t *addrp, 1731 offset_t offset, offset_t len, ddi_device_acc_attr_t *accattrp, 1732 ddi_acc_handle_t *handle); 1733 1734 void 1735 ddi_regs_map_free(ddi_acc_handle_t *handle); 1736 1737 /* 1738 * these are the prototypes for the common portable data access functions 1739 */ 1740 1741 uint8_t 1742 ddi_get8(ddi_acc_handle_t handle, uint8_t *addr); 1743 1744 uint16_t 1745 ddi_get16(ddi_acc_handle_t handle, uint16_t *addr); 1746 1747 uint32_t 1748 ddi_get32(ddi_acc_handle_t handle, uint32_t *addr); 1749 1750 uint64_t 1751 ddi_get64(ddi_acc_handle_t handle, uint64_t *addr); 1752 1753 void 1754 ddi_rep_get8(ddi_acc_handle_t handle, uint8_t *host_addr, uint8_t *dev_addr, 1755 size_t repcount, uint_t flags); 1756 1757 void 1758 ddi_rep_get16(ddi_acc_handle_t handle, uint16_t *host_addr, uint16_t *dev_addr, 1759 size_t repcount, uint_t flags); 1760 1761 void 1762 ddi_rep_get32(ddi_acc_handle_t handle, uint32_t *host_addr, uint32_t *dev_addr, 1763 size_t repcount, uint_t flags); 1764 1765 void 1766 ddi_rep_get64(ddi_acc_handle_t handle, uint64_t *host_addr, uint64_t *dev_addr, 1767 size_t repcount, uint_t flags); 1768 1769 void 1770 ddi_put8(ddi_acc_handle_t handle, uint8_t *addr, uint8_t value); 1771 1772 void 1773 ddi_put16(ddi_acc_handle_t handle, uint16_t *addr, uint16_t value); 1774 1775 void 1776 ddi_put32(ddi_acc_handle_t handle, uint32_t *addr, uint32_t value); 1777 1778 void 1779 ddi_put64(ddi_acc_handle_t handle, uint64_t *addr, uint64_t value); 1780 1781 void 1782 ddi_rep_put8(ddi_acc_handle_t handle, uint8_t *host_addr, uint8_t *dev_addr, 1783 size_t repcount, uint_t flags); 1784 void 1785 ddi_rep_put16(ddi_acc_handle_t handle, uint16_t *host_addr, uint16_t *dev_addr, 1786 size_t repcount, uint_t flags); 1787 void 1788 ddi_rep_put32(ddi_acc_handle_t handle, uint32_t *host_addr, uint32_t *dev_addr, 1789 size_t repcount, uint_t flags); 1790 1791 void 1792 ddi_rep_put64(ddi_acc_handle_t handle, uint64_t *host_addr, uint64_t *dev_addr, 1793 size_t repcount, uint_t flags); 1794 1795 /* 1796 * these are special device handling functions 1797 */ 1798 int 1799 ddi_device_zero(ddi_acc_handle_t handle, caddr_t dev_addr, 1800 size_t bytecount, ssize_t dev_advcnt, uint_t dev_datasz); 1801 1802 int 1803 ddi_device_copy( 1804 ddi_acc_handle_t src_handle, caddr_t src_addr, ssize_t src_advcnt, 1805 ddi_acc_handle_t dest_handle, caddr_t dest_addr, ssize_t dest_advcnt, 1806 size_t bytecount, uint_t dev_datasz); 1807 1808 /* 1809 * these are software byte swapping functions 1810 */ 1811 uint16_t 1812 ddi_swap16(uint16_t value); 1813 1814 uint32_t 1815 ddi_swap32(uint32_t value); 1816 1817 uint64_t 1818 ddi_swap64(uint64_t value); 1819 1820 /* 1821 * these are the prototypes for PCI local bus functions 1822 */ 1823 /* 1824 * PCI power management capabilities reporting in addition to those 1825 * provided by the PCI Power Management Specification. 1826 */ 1827 #define PCI_PM_IDLESPEED 0x1 /* clock for idle dev - cap */ 1828 #define PCI_PM_IDLESPEED_ANY (void *)-1 /* any clock for idle dev */ 1829 #define PCI_PM_IDLESPEED_NONE (void *)-2 /* regular clock for idle dev */ 1830 1831 int 1832 pci_config_setup(dev_info_t *dip, ddi_acc_handle_t *handle); 1833 1834 void 1835 pci_config_teardown(ddi_acc_handle_t *handle); 1836 1837 uint8_t 1838 pci_config_get8(ddi_acc_handle_t handle, off_t offset); 1839 1840 uint16_t 1841 pci_config_get16(ddi_acc_handle_t handle, off_t offset); 1842 1843 uint32_t 1844 pci_config_get32(ddi_acc_handle_t handle, off_t offset); 1845 1846 uint64_t 1847 pci_config_get64(ddi_acc_handle_t handle, off_t offset); 1848 1849 void 1850 pci_config_put8(ddi_acc_handle_t handle, off_t offset, uint8_t value); 1851 1852 void 1853 pci_config_put16(ddi_acc_handle_t handle, off_t offset, uint16_t value); 1854 1855 void 1856 pci_config_put32(ddi_acc_handle_t handle, off_t offset, uint32_t value); 1857 1858 void 1859 pci_config_put64(ddi_acc_handle_t handle, off_t offset, uint64_t value); 1860 1861 int 1862 pci_report_pmcap(dev_info_t *dip, int cap, void *arg); 1863 1864 int 1865 pci_restore_config_regs(dev_info_t *dip); 1866 1867 int 1868 pci_save_config_regs(dev_info_t *dip); 1869 1870 void 1871 pci_ereport_setup(dev_info_t *dip); 1872 1873 void 1874 pci_ereport_teardown(dev_info_t *dip); 1875 1876 void 1877 pci_ereport_post(dev_info_t *dip, ddi_fm_error_t *derr, uint16_t *status); 1878 1879 void 1880 pci_bdg_ereport_post(dev_info_t *dip, ddi_fm_error_t *derr, uint16_t *status); 1881 1882 int 1883 pci_bdg_check_status(dev_info_t *dip, ddi_fm_error_t *derr, 1884 uint16_t pci_cfg_stat, uint16_t pci_cfg_sec_stat); 1885 1886 /* 1887 * the prototype for the C Language Type Model inquiry. 1888 */ 1889 model_t ddi_mmap_get_model(void); 1890 model_t ddi_model_convert_from(model_t); 1891 1892 /* 1893 * these are the prototypes for device id functions. 1894 */ 1895 int 1896 ddi_devid_valid(ddi_devid_t devid); 1897 1898 int 1899 ddi_devid_register(dev_info_t *dip, ddi_devid_t devid); 1900 1901 void 1902 ddi_devid_unregister(dev_info_t *dip); 1903 1904 int 1905 ddi_devid_init(dev_info_t *dip, ushort_t devid_type, ushort_t nbytes, 1906 void *id, ddi_devid_t *ret_devid); 1907 1908 size_t 1909 ddi_devid_sizeof(ddi_devid_t devid); 1910 1911 void 1912 ddi_devid_free(ddi_devid_t devid); 1913 1914 int 1915 ddi_devid_compare(ddi_devid_t id1, ddi_devid_t id2); 1916 1917 int 1918 ddi_devid_scsi_encode(int version, char *driver_name, 1919 uchar_t *inq, size_t inq_len, uchar_t *inq80, size_t inq80_len, 1920 uchar_t *inq83, size_t inq83_len, ddi_devid_t *ret_devid); 1921 1922 char 1923 *ddi_devid_to_guid(ddi_devid_t devid); 1924 1925 void 1926 ddi_devid_free_guid(char *guid); 1927 1928 int 1929 ddi_lyr_get_devid(dev_t dev, ddi_devid_t *ret_devid); 1930 1931 int 1932 ddi_lyr_get_minor_name(dev_t dev, int spec_type, char **minor_name); 1933 1934 int 1935 ddi_lyr_devid_to_devlist(ddi_devid_t devid, char *minor_name, int *retndevs, 1936 dev_t **retdevs); 1937 1938 void 1939 ddi_lyr_free_devlist(dev_t *devlist, int ndevs); 1940 1941 char * 1942 ddi_devid_str_encode(ddi_devid_t devid, char *minor_name); 1943 1944 int 1945 ddi_devid_str_decode(char *devidstr, ddi_devid_t *devidp, char **minor_namep); 1946 1947 void 1948 ddi_devid_str_free(char *devidstr); 1949 1950 int 1951 ddi_devid_str_compare(char *id1_str, char *id2_str); 1952 1953 /* 1954 * Event to post to when a devinfo node is removed. 1955 */ 1956 #define DDI_DEVI_REMOVE_EVENT "DDI:DEVI_REMOVE" 1957 #define DDI_DEVI_INSERT_EVENT "DDI:DEVI_INSERT" 1958 #define DDI_DEVI_BUS_RESET_EVENT "DDI:DEVI_BUS_RESET" 1959 #define DDI_DEVI_DEVICE_RESET_EVENT "DDI:DEVI_DEVICE_RESET" 1960 1961 /* 1962 * Invoke bus nexus driver's implementation of the 1963 * (*bus_remove_eventcall)() interface to remove a registered 1964 * callback handler for "event". 1965 */ 1966 int 1967 ddi_remove_event_handler(ddi_callback_id_t id); 1968 1969 /* 1970 * Invoke bus nexus driver's implementation of the 1971 * (*bus_add_eventcall)() interface to register a callback handler 1972 * for "event". 1973 */ 1974 int 1975 ddi_add_event_handler(dev_info_t *dip, ddi_eventcookie_t event, 1976 void (*handler)(dev_info_t *, ddi_eventcookie_t, void *, void *), 1977 void *arg, ddi_callback_id_t *id); 1978 1979 /* 1980 * Return a handle for event "name" by calling up the device tree 1981 * hierarchy via (*bus_get_eventcookie)() interface until claimed 1982 * by a bus nexus or top of dev_info tree is reached. 1983 */ 1984 int 1985 ddi_get_eventcookie(dev_info_t *dip, char *name, 1986 ddi_eventcookie_t *event_cookiep); 1987 1988 /* 1989 * log a system event 1990 */ 1991 int 1992 ddi_log_sysevent(dev_info_t *dip, char *vendor, char *class_name, 1993 char *subclass_name, nvlist_t *attr_list, sysevent_id_t *eidp, 1994 int sleep_flag); 1995 1996 /* 1997 * ddi_log_sysevent() vendors 1998 */ 1999 #define DDI_VENDOR_SUNW "SUNW" 2000 2001 /* 2002 * Opaque task queue handle. 2003 */ 2004 typedef struct ddi_taskq ddi_taskq_t; 2005 2006 /* 2007 * Use default system priority. 2008 */ 2009 #define TASKQ_DEFAULTPRI -1 2010 2011 /* 2012 * Create a task queue 2013 */ 2014 ddi_taskq_t *ddi_taskq_create(dev_info_t *dip, const char *name, 2015 int nthreads, pri_t pri, uint_t cflags); 2016 2017 /* 2018 * destroy a task queue 2019 */ 2020 void ddi_taskq_destroy(ddi_taskq_t *tq); 2021 2022 /* 2023 * Dispatch a task to a task queue 2024 */ 2025 int ddi_taskq_dispatch(ddi_taskq_t *tq, void (* func)(void *), 2026 void *arg, uint_t dflags); 2027 2028 /* 2029 * Wait for all previously scheduled tasks to complete. 2030 */ 2031 void ddi_taskq_wait(ddi_taskq_t *tq); 2032 2033 /* 2034 * Suspend all task execution. 2035 */ 2036 void ddi_taskq_suspend(ddi_taskq_t *tq); 2037 2038 /* 2039 * Resume task execution. 2040 */ 2041 void ddi_taskq_resume(ddi_taskq_t *tq); 2042 2043 /* 2044 * Is task queue suspended? 2045 */ 2046 boolean_t ddi_taskq_suspended(ddi_taskq_t *tq); 2047 2048 /* 2049 * Parse an interface name of the form <alphanumeric>##<numeric> where 2050 * <numeric> is maximal. 2051 */ 2052 int ddi_parse(const char *, char *, uint_t *); 2053 2054 #endif /* _KERNEL */ 2055 2056 #ifdef __cplusplus 2057 } 2058 #endif 2059 2060 #endif /* _SYS_SUNDDI_H */ 2061