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