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