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