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