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