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