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 (c) 1990, 2010, Oracle and/or its affiliates. All rights reserved. 24 */ 25 26 #ifndef _SYS_SUNDDI_H 27 #define _SYS_SUNDDI_H 28 29 /* 30 * Sun Specific DDI definitions 31 */ 32 33 #include <sys/isa_defs.h> 34 #include <sys/dditypes.h> 35 #include <sys/ddipropdefs.h> 36 #include <sys/devops.h> 37 #include <sys/time.h> 38 #include <sys/cmn_err.h> 39 #include <sys/ddidevmap.h> 40 #include <sys/ddi_impldefs.h> 41 #include <sys/ddi_implfuncs.h> 42 #include <sys/ddi_isa.h> 43 #include <sys/model.h> 44 #include <sys/devctl.h> 45 #if defined(__i386) || defined(__amd64) 46 #include <sys/dma_engine.h> 47 #endif 48 #include <sys/sunpm.h> 49 #include <sys/nvpair.h> 50 #include <sys/sysevent.h> 51 #include <sys/thread.h> 52 #include <sys/stream.h> 53 #if defined(__GNUC__) && defined(_ASM_INLINES) && defined(_KERNEL) 54 #include <asm/sunddi.h> 55 #endif 56 #ifdef _KERNEL 57 #include <sys/ddi_obsolete.h> 58 #endif 59 #include <sys/u8_textprep.h> 60 #include <sys/kiconv.h> 61 62 #ifdef __cplusplus 63 extern "C" { 64 #endif 65 66 /* 67 * Generic Sun DDI definitions. 68 */ 69 70 #define DDI_SUCCESS (0) /* successful return */ 71 #define DDI_FAILURE (-1) /* unsuccessful return */ 72 #define DDI_NOT_WELL_FORMED (-2) /* A dev_info node is not valid */ 73 #define DDI_EAGAIN (-3) /* not enough interrupt resources */ 74 #define DDI_EINVAL (-4) /* invalid request or arguments */ 75 #define DDI_ENOTSUP (-5) /* operation is not supported */ 76 #define DDI_EPENDING (-6) /* operation or an event is pending */ 77 #define DDI_EALREADY (-7) /* operation already in progress */ 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 * o DEVI_SID_HIDDEN_NODEID specifies a hidden node with persistence. 102 * 103 * A node with the 'hidden' attribute will not show up in devinfo snapshots 104 * or in /devices file system. 105 * 106 * A node with the 'persistent' attribute will not be automatically removed by 107 * the framework in the current implementation - driver.conf nodes are without 108 * persistence. 109 * 110 * The actual nodeid value may be assigned by the framework and may be 111 * different than these special values. Drivers may not make assumptions 112 * about the nodeid value that is actually assigned to the node. 113 */ 114 115 #define DEVI_PSEUDO_NODEID ((int)-1) 116 #define DEVI_SID_NODEID ((int)-2) 117 #define DEVI_SID_HIDDEN_NODEID ((int)-3) 118 #define DEVI_SID_HP_NODEID ((int)-4) 119 #define DEVI_SID_HP_HIDDEN_NODEID ((int)-5) 120 121 #define DEVI_PSEUDO_NEXNAME "pseudo" 122 #define DEVI_ISA_NEXNAME "isa" 123 #define DEVI_EISA_NEXNAME "eisa" 124 125 /* 126 * ddi_create_minor_node flags 127 */ 128 #define CLONE_DEV 1 /* device is a clone device */ 129 #define PRIVONLY_DEV 0x10 /* policy-based permissions only */ 130 131 /* 132 * Historical values used for the flag field in ddi_create_minor_node. 133 * Future use of flag bits should avoid these fields to keep binary 134 * compatibility 135 * #define GLOBAL_DEV 0x2 136 * #define NODEBOUND_DEV 0x4 137 * #define NODESPECIFIC_DEV 0x6 138 * #define ENUMERATED_DEV 0x8 139 */ 140 141 /* 142 * Device type defines which are used by the 'node_type' element of the 143 * ddi_minor_data structure 144 */ 145 #define DDI_NT_SERIAL "ddi_serial" /* Serial port */ 146 #define DDI_NT_SERIAL_MB "ddi_serial:mb" /* the 'built-in' serial */ 147 /* ports (the old ttya, b */ 148 /* (,c ,d)) */ 149 #define DDI_NT_SERIAL_DO "ddi_serial:dialout" /* dialout ports */ 150 #define DDI_NT_SERIAL_MB_DO "ddi_serial:dialout,mb" /* dialout for onboard */ 151 /* ports */ 152 #define DDI_NT_SERIAL_LOMCON "ddi_serial:lomcon" /* LOMlite2 console port */ 153 154 /* 155 * *_CHAN disk type devices have channel numbers or target numbers. 156 * (i.e. ipi and scsi devices) 157 */ 158 #define DDI_NT_BLOCK "ddi_block" /* hard disks */ 159 /* 160 * The next define is for block type devices that can possible exist on 161 * a sub-bus like the scsi bus or the ipi channel. The 'disks' program 162 * will pick up on this and create logical names like c0t0d0s0 instead of 163 * c0d0s0 164 */ 165 #define DDI_NT_BLOCK_CHAN "ddi_block:channel" 166 #define DDI_NT_BLOCK_WWN "ddi_block:wwn" 167 #define DDI_NT_CD "ddi_block:cdrom" /* rom drives (cd-rom) */ 168 #define DDI_NT_CD_CHAN "ddi_block:cdrom:channel" /* rom drives (scsi type) */ 169 #define DDI_NT_FD "ddi_block:diskette" /* floppy disks */ 170 171 #define DDI_NT_ENCLOSURE "ddi_enclosure" 172 #define DDI_NT_SCSI_ENCLOSURE "ddi_enclosure:scsi" 173 174 #define DDI_NT_BLOCK_SAS "ddi_block:sas" 175 176 /* 177 * xVM virtual block devices 178 */ 179 #define DDI_NT_BLOCK_XVMD "ddi_block:xvmd" 180 #define DDI_NT_CD_XVMD "ddi_block:cdrom:xvmd" 181 182 183 #define DDI_NT_TAPE "ddi_byte:tape" /* tape drives */ 184 185 #define DDI_NT_NET "ddi_network" /* DLPI network devices */ 186 187 #define DDI_NT_NET_WIFI "ddi_network:wifi" /* wifi devices */ 188 189 #define DDI_NT_DISPLAY "ddi_display" /* display devices */ 190 191 #define DDI_NT_DISPLAY_DRM "ddi_display:drm" /* drm display devices */ 192 193 #define DDI_PSEUDO "ddi_pseudo" /* general pseudo devices */ 194 195 #define DDI_NT_AUDIO "ddi_audio" /* audio device */ 196 197 #define DDI_NT_MOUSE "ddi_mouse" /* mouse device */ 198 199 #define DDI_NT_KEYBOARD "ddi_keyboard" /* keyboard device */ 200 201 #define DDI_NT_PARALLEL "ddi_parallel" /* parallel port */ 202 203 #define DDI_NT_PRINTER "ddi_printer" /* printer device */ 204 205 #define DDI_NT_UGEN "ddi_generic:usb" /* USB generic drv */ 206 207 #define DDI_NT_SMP "ddi_sas_smp" /* smp devcies */ 208 209 #define DDI_NT_NEXUS "ddi_ctl:devctl" /* nexus drivers */ 210 211 #define DDI_NT_SCSI_NEXUS "ddi_ctl:devctl:scsi" /* nexus drivers */ 212 213 #define DDI_NT_SATA_NEXUS "ddi_ctl:devctl:sata" /* nexus drivers */ 214 215 #define DDI_NT_IB_NEXUS "ddi_ctl:devctl:ib" /* nexus drivers */ 216 217 #define DDI_NT_ATTACHMENT_POINT "ddi_ctl:attachment_point" /* attachment pt */ 218 219 #define DDI_NT_SCSI_ATTACHMENT_POINT "ddi_ctl:attachment_point:scsi" 220 /* scsi attachment pt */ 221 222 #define DDI_NT_SATA_ATTACHMENT_POINT "ddi_ctl:attachment_point:sata" 223 /* sata attachment pt */ 224 225 #define DDI_NT_SDCARD_ATTACHMENT_POINT "ddi_ctl:attachment_point:sdcard" 226 /* sdcard attachment pt */ 227 228 #define DDI_NT_PCI_ATTACHMENT_POINT "ddi_ctl:attachment_point:pci" 229 /* PCI attachment pt */ 230 #define DDI_NT_SBD_ATTACHMENT_POINT "ddi_ctl:attachment_point:sbd" 231 /* generic bd attachment pt */ 232 #define DDI_NT_FC_ATTACHMENT_POINT "ddi_ctl:attachment_point:fc" 233 /* FC attachment pt */ 234 #define DDI_NT_USB_ATTACHMENT_POINT "ddi_ctl:attachment_point:usb" 235 /* USB devices */ 236 #define DDI_NT_BLOCK_FABRIC "ddi_block:fabric" 237 /* Fabric Devices */ 238 #define DDI_NT_IB_ATTACHMENT_POINT "ddi_ctl:attachment_point:ib" 239 /* IB devices */ 240 241 #define DDI_NT_AV_ASYNC "ddi_av:async" /* asynchronous AV device */ 242 #define DDI_NT_AV_ISOCH "ddi_av:isoch" /* isochronous AV device */ 243 244 /* Device types used for agpgart driver related devices */ 245 #define DDI_NT_AGP_PSEUDO "ddi_agp:pseudo" /* agpgart pseudo device */ 246 #define DDI_NT_AGP_MASTER "ddi_agp:master" /* agp master device */ 247 #define DDI_NT_AGP_TARGET "ddi_agp:target" /* agp target device */ 248 #define DDI_NT_AGP_CPUGART "ddi_agp:cpugart" /* amd64 on-cpu gart device */ 249 250 #define DDI_NT_REGACC "ddi_tool_reg" /* tool register access */ 251 #define DDI_NT_INTRCTL "ddi_tool_intr" /* tool intr access */ 252 253 /* 254 * DDI event definitions 255 */ 256 #define EC_DEVFS "EC_devfs" /* Event class devfs */ 257 #define EC_DDI "EC_ddi" /* Event class ddi */ 258 259 /* Class devfs subclasses */ 260 #define ESC_DEVFS_MINOR_CREATE "ESC_devfs_minor_create" 261 #define ESC_DEVFS_MINOR_REMOVE "ESC_devfs_minor_remove" 262 #define ESC_DEVFS_DEVI_ADD "ESC_devfs_devi_add" 263 #define ESC_DEVFS_DEVI_REMOVE "ESC_devfs_devi_remove" 264 #define ESC_DEVFS_INSTANCE_MOD "ESC_devfs_instance_mod" 265 #define ESC_DEVFS_BRANCH_ADD "ESC_devfs_branch_add" 266 #define ESC_DEVFS_BRANCH_REMOVE "ESC_devfs_branch_remove" 267 #define ESC_DEVFS_START "ESC_devfs_start" 268 269 /* Class ddi subclasses */ 270 #define ESC_DDI_INITIATOR_REGISTER "ESC_ddi_initiator_register" 271 #define ESC_DDI_INITIATOR_UNREGISTER "ESC_ddi_initiator_unregister" 272 273 /* DDI/NDI event publisher */ 274 #define EP_DDI SUNW_KERN_PUB"ddi" 275 276 /* 277 * devfs event class attributes 278 * 279 * The following attributes are private to EC_DEVFS event data. 280 */ 281 #define DEVFS_DRIVER_NAME "di.driver" 282 #define DEVFS_INSTANCE "di.instance" 283 #define DEVFS_PATHNAME "di.path" 284 #define DEVFS_DEVI_CLASS "di.devi_class" 285 #define DEVFS_BRANCH_EVENT "di.branch_event" 286 #define DEVFS_MINOR_NAME "mi.name" 287 #define DEVFS_MINOR_NODETYPE "mi.nodetype" 288 #define DEVFS_MINOR_ISCLONE "mi.isclone" 289 #define DEVFS_MINOR_MAJNUM "mi.majorno" 290 #define DEVFS_MINOR_MINORNUM "mi.minorno" 291 292 /* 293 * ddi event class payload 294 * 295 * The following attributes are private to EC_DDI event data. 296 */ 297 #define DDI_DRIVER_NAME "ddi.driver" 298 #define DDI_DRIVER_MAJOR "ddi.major" 299 #define DDI_INSTANCE "ddi.instance" 300 #define DDI_PATHNAME "ddi.path" 301 #define DDI_CLASS "ddi.class" 302 303 /* 304 * Fault-related definitions 305 * 306 * The specific numeric values have been chosen to be ordered, but 307 * not consecutive, to allow for future interpolation if required. 308 */ 309 typedef enum { 310 DDI_SERVICE_LOST = -32, 311 DDI_SERVICE_DEGRADED = -16, 312 DDI_SERVICE_UNAFFECTED = 0, 313 DDI_SERVICE_RESTORED = 16 314 } ddi_fault_impact_t; 315 316 typedef enum { 317 DDI_DATAPATH_FAULT = -32, 318 DDI_DEVICE_FAULT = -16, 319 DDI_EXTERNAL_FAULT = 0 320 } ddi_fault_location_t; 321 322 typedef enum { 323 DDI_DEVSTATE_OFFLINE = -32, 324 DDI_DEVSTATE_DOWN = -16, 325 DDI_DEVSTATE_QUIESCED = 0, 326 DDI_DEVSTATE_DEGRADED = 16, 327 DDI_DEVSTATE_UP = 32 328 } ddi_devstate_t; 329 330 #ifdef _KERNEL 331 332 /* 333 * Common property definitions 334 */ 335 #define DDI_FORCEATTACH "ddi-forceattach" 336 #define DDI_NO_AUTODETACH "ddi-no-autodetach" 337 #define DDI_VHCI_CLASS "ddi-vhci-class" 338 #define DDI_NO_ROOT_SUPPORT "ddi-no-root-support" 339 #define DDI_OPEN_RETURNS_EINTR "ddi-open-returns-eintr" 340 #define DDI_DEVID_REGISTRANT "ddi-devid-registrant" 341 342 /* 343 * Values that the function supplied to the dev_info 344 * tree traversal functions defined below must return. 345 */ 346 347 /* 348 * Continue search, if appropriate. 349 */ 350 #define DDI_WALK_CONTINUE 0 351 352 /* 353 * Terminate current depth of traversal. That is, terminate 354 * the current traversal of children nodes, but continue 355 * traversing sibling nodes and their children (if any). 356 */ 357 358 #define DDI_WALK_PRUNECHILD -1 359 360 /* 361 * Terminate current width of traversal. That is, terminate 362 * the current traversal of sibling nodes, but continue with 363 * traversing children nodes and their siblings (if appropriate). 364 */ 365 366 #define DDI_WALK_PRUNESIB -2 367 368 /* 369 * Terminate the entire search. 370 */ 371 372 #define DDI_WALK_TERMINATE -3 373 374 /* 375 * Terminate the entire search because an error occurred in function 376 */ 377 #define DDI_WALK_ERROR -4 378 379 /* 380 * Drivers that are prepared to support full driver layering 381 * should create and export a null-valued property of the following 382 * name. 383 * 384 * Such drivers should be prepared to be called with FKLYR in 385 * the 'flag' argument of their open(9E), close(9E) routines, and 386 * with FKIOCTL in the 'mode' argument of their ioctl(9E) routines. 387 * 388 * See ioctl(9E) and ddi_copyin(9F) for details. 389 */ 390 #define DDI_KERNEL_IOCTL "ddi-kernel-ioctl" 391 392 /* 393 * Model definitions for ddi_mmap_get_model(9F) and ddi_model_convert_from(9F). 394 */ 395 #define DDI_MODEL_MASK DATAMODEL_MASK /* Note: 0x0FF00000 */ 396 #define DDI_MODEL_ILP32 DATAMODEL_ILP32 397 #define DDI_MODEL_LP64 DATAMODEL_LP64 398 #define DDI_MODEL_NATIVE DATAMODEL_NATIVE 399 #define DDI_MODEL_NONE DATAMODEL_NONE 400 401 /* if set to B_TRUE is DER_MODE is equivalent to DERE_PANIC */ 402 extern boolean_t ddi_err_panic; 403 404 /* 405 * Defines for ddi_err(). 406 */ 407 typedef enum { 408 DER_INVALID = 0, /* must be 0 */ 409 DER_CONT = 1, 410 DER_CONS, 411 DER_LOG, 412 DER_VERB, 413 DER_NOTE, 414 DER_WARN, 415 DER_PANIC, 416 DER_MODE, 417 DER_DEBUG 418 } ddi_err_t; 419 420 extern void ddi_err(ddi_err_t de, dev_info_t *rdip, const char *fmt, ...); 421 422 423 extern char *ddi_strdup(const char *str, int flag); 424 extern char *strdup(const char *str); 425 extern void strfree(char *str); 426 427 /* 428 * Functions and data references which really should be in <sys/ddi.h> 429 */ 430 431 extern int maxphys; 432 extern void minphys(struct buf *); 433 extern int physio(int (*)(struct buf *), struct buf *, dev_t, 434 int, void (*)(struct buf *), struct uio *); 435 extern void disksort(struct diskhd *, struct buf *); 436 437 extern size_t strlen(const char *) __PURE; 438 extern size_t strnlen(const char *, size_t) __PURE; 439 extern char *strcpy(char *, const char *); 440 extern char *strncpy(char *, const char *, size_t); 441 /* Need to be consistent with <string.h> C++ definition for strchr() */ 442 #if __cplusplus >= 199711L 443 extern const char *strchr(const char *, int); 444 #ifndef _STRCHR_INLINE 445 #define _STRCHR_INLINE 446 extern "C++" { 447 inline char *strchr(char *__s, int __c) { 448 return (char *)strchr((const char *)__s, __c); 449 } 450 } 451 #endif /* _STRCHR_INLINE */ 452 #else 453 extern char *strchr(const char *, int); 454 #endif /* __cplusplus >= 199711L */ 455 #define DDI_STRSAME(s1, s2) ((*(s1) == *(s2)) && (strcmp((s1), (s2)) == 0)) 456 extern int strcmp(const char *, const char *) __PURE; 457 extern int strncmp(const char *, const char *, size_t) __PURE; 458 extern char *strncat(char *, const char *, size_t); 459 extern size_t strlcat(char *, const char *, size_t); 460 extern size_t strlcpy(char *, const char *, size_t); 461 extern size_t strspn(const char *, const char *); 462 extern int bcmp(const void *, const void *, size_t) __PURE; 463 extern int stoi(char **); 464 extern void numtos(ulong_t, char *); 465 extern void bcopy(const void *, void *, size_t); 466 extern void bzero(void *, size_t); 467 468 extern void *memcpy(void *, const void *, size_t); 469 extern void *memset(void *, int, size_t); 470 extern void *memmove(void *, const void *, size_t); 471 extern int memcmp(const void *, const void *, size_t) __PURE; 472 /* Need to be consistent with <string.h> C++ definition for memchr() */ 473 #if __cplusplus >= 199711L 474 extern const void *memchr(const void *, int, size_t); 475 #ifndef _MEMCHR_INLINE 476 #define _MEMCHR_INLINE 477 extern "C++" { 478 inline void *memchr(void * __s, int __c, size_t __n) { 479 return (void *)memchr((const void *)__s, __c, __n); 480 } 481 } 482 #endif /* _MEMCHR_INLINE */ 483 #else 484 extern void *memchr(const void *, int, size_t); 485 #endif /* __cplusplus >= 199711L */ 486 487 extern int ddi_strtol(const char *, char **, int, long *); 488 extern int ddi_strtoul(const char *, char **, int, unsigned long *); 489 extern int ddi_strtoll(const char *, char **, int, longlong_t *); 490 extern int ddi_strtoull(const char *, char **, int, u_longlong_t *); 491 492 /* 493 * kiconv functions and their macros. 494 */ 495 #define KICONV_IGNORE_NULL (0x0001) 496 #define KICONV_REPLACE_INVALID (0x0002) 497 498 extern kiconv_t kiconv_open(const char *, const char *); 499 extern size_t kiconv(kiconv_t, char **, size_t *, char **, size_t *, int *); 500 extern int kiconv_close(kiconv_t); 501 extern size_t kiconvstr(const char *, const char *, char *, size_t *, char *, 502 size_t *, int, int *); 503 504 /* 505 * ddi_map_regs 506 * 507 * Map in the register set given by rnumber. 508 * The register number determine which register 509 * set will be mapped if more than one exists. 510 * The parent driver gets the information 511 * from parent private data and sets up the 512 * appropriate mappings and returns the kernel 513 * virtual address of the register set in *kaddrp. 514 * The offset specifies an offset into the register 515 * space to start from and len indicates the size 516 * of the area to map. If len and offset are 0 then 517 * the entire space is mapped. It returns DDI_SUCCESS on 518 * success or DDI_FAILURE otherwise. 519 * 520 */ 521 int 522 ddi_map_regs(dev_info_t *dip, uint_t rnumber, caddr_t *kaddrp, 523 off_t offset, off_t len); 524 525 /* 526 * ddi_unmap_regs 527 * 528 * Undo mappings set up by ddi_map_regs. 529 * The register number determines which register 530 * set will be unmapped if more than one exists. 531 * This is provided for drivers preparing 532 * to detach themselves from the system to 533 * allow them to release allocated mappings. 534 * 535 * The kaddrp and len specify the area to be 536 * unmapped. *kaddrp was returned from ddi_map_regs 537 * and len should match what ddi_map_regs was called 538 * with. 539 */ 540 541 void 542 ddi_unmap_regs(dev_info_t *dip, uint_t rnumber, caddr_t *kaddrp, 543 off_t offset, off_t len); 544 545 int 546 ddi_map(dev_info_t *dp, ddi_map_req_t *mp, off_t offset, off_t len, 547 caddr_t *addrp); 548 549 int 550 ddi_apply_range(dev_info_t *dip, dev_info_t *rdip, struct regspec *rp); 551 552 /* 553 * ddi_rnumber_to_regspec: Not for use by leaf drivers. 554 */ 555 struct regspec * 556 ddi_rnumber_to_regspec(dev_info_t *dip, int rnumber); 557 558 int 559 ddi_bus_map(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, off_t offset, 560 off_t len, caddr_t *vaddrp); 561 562 int 563 nullbusmap(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, off_t offset, 564 off_t len, caddr_t *vaddrp); 565 566 int ddi_peek8(dev_info_t *dip, int8_t *addr, int8_t *val_p); 567 int ddi_peek16(dev_info_t *dip, int16_t *addr, int16_t *val_p); 568 int ddi_peek32(dev_info_t *dip, int32_t *addr, int32_t *val_p); 569 int ddi_peek64(dev_info_t *dip, int64_t *addr, int64_t *val_p); 570 571 int ddi_poke8(dev_info_t *dip, int8_t *addr, int8_t val); 572 int ddi_poke16(dev_info_t *dip, int16_t *addr, int16_t val); 573 int ddi_poke32(dev_info_t *dip, int32_t *addr, int32_t val); 574 int ddi_poke64(dev_info_t *dip, int64_t *addr, int64_t val); 575 576 /* 577 * Peek and poke to and from a uio structure in xfersize pieces, 578 * using the parent nexi. 579 */ 580 int ddi_peekpokeio(dev_info_t *devi, struct uio *uio, enum uio_rw rw, 581 caddr_t addr, size_t len, uint_t xfersize); 582 583 /* 584 * Pagesize conversions using the parent nexi 585 */ 586 unsigned long ddi_btop(dev_info_t *dip, unsigned long bytes); 587 unsigned long ddi_btopr(dev_info_t *dip, unsigned long bytes); 588 unsigned long ddi_ptob(dev_info_t *dip, unsigned long pages); 589 590 /* 591 * There are no more "block" interrupt functions, per se. 592 * All thread of control should be done with MP/MT lockings. 593 * 594 * However, there are certain times in which a driver needs 595 * absolutely a critical guaranteed non-preemptable time 596 * in which to execute a few instructions. 597 * 598 * The following pair of functions attempt to guarantee this, 599 * but they are dangerous to use. That is, use them with 600 * extreme care. They do not guarantee to stop other processors 601 * from executing, but they do guarantee that the caller 602 * of ddi_enter_critical will continue to run until the 603 * caller calls ddi_exit_critical. No intervening DDI functions 604 * may be called between an entry and an exit from a critical 605 * region. 606 * 607 * ddi_enter_critical returns an integer identifier which must 608 * be passed to ddi_exit_critical. 609 * 610 * Be very sparing in the use of these functions since it is 611 * likely that absolutely nothing else can occur in the system 612 * whilst in the critical region. 613 */ 614 615 unsigned int 616 ddi_enter_critical(void); 617 618 void 619 ddi_exit_critical(unsigned int); 620 621 /* 622 * devmap functions 623 */ 624 int 625 devmap_setup(dev_t dev, offset_t off, ddi_as_handle_t as, caddr_t *addrp, 626 size_t len, uint_t prot, uint_t maxprot, uint_t flags, 627 struct cred *cred); 628 629 int 630 ddi_devmap_segmap(dev_t dev, off_t off, ddi_as_handle_t as, caddr_t *addrp, 631 off_t len, uint_t prot, uint_t maxprot, uint_t flags, 632 struct cred *cred); 633 634 int 635 devmap_load(devmap_cookie_t dhp, offset_t offset, size_t len, uint_t type, 636 uint_t rw); 637 638 int 639 devmap_unload(devmap_cookie_t dhp, offset_t offset, size_t len); 640 641 int 642 devmap_devmem_setup(devmap_cookie_t dhp, dev_info_t *dip, 643 struct devmap_callback_ctl *callback_ops, 644 uint_t rnumber, offset_t roff, size_t len, uint_t maxprot, 645 uint_t flags, ddi_device_acc_attr_t *accattrp); 646 647 int 648 devmap_umem_setup(devmap_cookie_t dhp, dev_info_t *dip, 649 struct devmap_callback_ctl *callback_ops, 650 ddi_umem_cookie_t cookie, offset_t off, size_t len, uint_t maxprot, 651 uint_t flags, ddi_device_acc_attr_t *accattrp); 652 653 int 654 devmap_devmem_remap(devmap_cookie_t dhp, dev_info_t *dip, 655 uint_t rnumber, offset_t roff, size_t len, uint_t maxprot, 656 uint_t flags, ddi_device_acc_attr_t *accattrp); 657 658 int 659 devmap_umem_remap(devmap_cookie_t dhp, dev_info_t *dip, 660 ddi_umem_cookie_t cookie, offset_t off, size_t len, uint_t maxprot, 661 uint_t flags, ddi_device_acc_attr_t *accattrp); 662 663 void 664 devmap_set_ctx_timeout(devmap_cookie_t dhp, clock_t ticks); 665 666 int 667 devmap_default_access(devmap_cookie_t dhp, void *pvtp, offset_t off, 668 size_t len, uint_t type, uint_t rw); 669 670 int 671 devmap_do_ctxmgt(devmap_cookie_t dhp, void *pvtp, offset_t off, size_t len, 672 uint_t type, uint_t rw, int (*ctxmgt)(devmap_cookie_t, void *, offset_t, 673 size_t, uint_t, uint_t)); 674 675 676 void *ddi_umem_alloc(size_t size, int flag, ddi_umem_cookie_t *cookiep); 677 678 void ddi_umem_free(ddi_umem_cookie_t cookie); 679 680 /* 681 * Functions to lock user memory and do repeated I/O or do devmap_umem_setup 682 */ 683 int 684 ddi_umem_lock(caddr_t addr, size_t size, int flags, ddi_umem_cookie_t *cookie); 685 686 void 687 ddi_umem_unlock(ddi_umem_cookie_t cookie); 688 689 struct buf * 690 ddi_umem_iosetup(ddi_umem_cookie_t cookie, off_t off, size_t len, int direction, 691 dev_t dev, daddr_t blkno, int (*iodone)(struct buf *), int sleepflag); 692 693 /* 694 * Mapping functions 695 */ 696 int 697 ddi_segmap(dev_t dev, off_t offset, struct as *asp, caddr_t *addrp, off_t len, 698 uint_t prot, uint_t maxprot, uint_t flags, cred_t *credp); 699 700 int 701 ddi_segmap_setup(dev_t dev, off_t offset, struct as *as, caddr_t *addrp, 702 off_t len, uint_t prot, uint_t maxprot, uint_t flags, cred_t *cred, 703 ddi_device_acc_attr_t *accattrp, uint_t rnumber); 704 705 int 706 ddi_map_fault(dev_info_t *dip, struct hat *hat, struct seg *seg, caddr_t addr, 707 struct devpage *dp, pfn_t pfn, uint_t prot, uint_t lock); 708 709 int 710 ddi_device_mapping_check(dev_t dev, ddi_device_acc_attr_t *accattrp, 711 uint_t rnumber, uint_t *hat_flags); 712 713 /* 714 * Property functions: See also, ddipropdefs.h. 715 * In general, the underlying driver MUST be held 716 * to call it's property functions. 717 */ 718 719 /* 720 * Used to create, modify, and lookup integer properties 721 */ 722 int ddi_prop_get_int(dev_t match_dev, dev_info_t *dip, uint_t flags, 723 char *name, int defvalue); 724 int64_t ddi_prop_get_int64(dev_t match_dev, dev_info_t *dip, uint_t flags, 725 char *name, int64_t defvalue); 726 int ddi_prop_lookup_int_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 727 char *name, int **data, uint_t *nelements); 728 int ddi_prop_lookup_int64_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 729 char *name, int64_t **data, uint_t *nelements); 730 int ddi_prop_update_int(dev_t match_dev, dev_info_t *dip, 731 char *name, int data); 732 int ddi_prop_update_int64(dev_t match_dev, dev_info_t *dip, 733 char *name, int64_t data); 734 int ddi_prop_update_int_array(dev_t match_dev, dev_info_t *dip, 735 char *name, int *data, uint_t nelements); 736 int ddi_prop_update_int64_array(dev_t match_dev, dev_info_t *dip, 737 char *name, int64_t *data, uint_t nelements); 738 /* 739 * Used to create, modify, and lookup string properties 740 */ 741 int ddi_prop_lookup_string(dev_t match_dev, dev_info_t *dip, uint_t flags, 742 char *name, char **data); 743 int ddi_prop_lookup_string_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 744 char *name, char ***data, uint_t *nelements); 745 int ddi_prop_update_string(dev_t match_dev, dev_info_t *dip, 746 char *name, char *data); 747 int ddi_prop_update_string_array(dev_t match_dev, dev_info_t *dip, 748 char *name, char **data, uint_t nelements); 749 750 /* 751 * Used to create, modify, and lookup byte properties 752 */ 753 int ddi_prop_lookup_byte_array(dev_t match_dev, dev_info_t *dip, uint_t flags, 754 char *name, uchar_t **data, uint_t *nelements); 755 int ddi_prop_update_byte_array(dev_t match_dev, dev_info_t *dip, 756 char *name, uchar_t *data, uint_t nelements); 757 758 /* 759 * Used to verify the existence of a property or to see if a boolean 760 * property exists. 761 */ 762 int ddi_prop_exists(dev_t match_dev, dev_info_t *dip, uint_t flags, char *name); 763 764 /* 765 * Used to free the data returned by the above property routines. 766 */ 767 void ddi_prop_free(void *data); 768 769 /* 770 * nopropop: For internal use in `dummy' cb_prop_op functions only 771 */ 772 773 int 774 nopropop(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, int mod_flags, 775 char *name, caddr_t valuep, int *lengthp); 776 777 /* 778 * ddi_prop_op: The basic property operator for drivers. 779 * 780 * In ddi_prop_op, the type of valuep is interpreted based on prop_op: 781 * 782 * prop_op valuep 783 * ------ ------ 784 * 785 * PROP_LEN <unused> 786 * 787 * PROP_LEN_AND_VAL_BUF Pointer to callers buffer 788 * 789 * PROP_LEN_AND_VAL_ALLOC Address of callers pointer (will be set to 790 * address of allocated buffer, if successful) 791 */ 792 793 int 794 ddi_prop_op(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, int mod_flags, 795 char *name, caddr_t valuep, int *lengthp); 796 797 /* ddi_prop_op_size: for drivers that implement size in bytes */ 798 int 799 ddi_prop_op_size(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, 800 int mod_flags, char *name, caddr_t valuep, int *lengthp, 801 uint64_t size64); 802 803 /* ddi_prop_op_size_blksize: like ddi_prop_op_size, in blksize blocks */ 804 int 805 ddi_prop_op_size_blksize(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, 806 int mod_flags, char *name, caddr_t valuep, int *lengthp, 807 uint64_t size64, uint_t blksize); 808 809 /* ddi_prop_op_nblocks: for drivers that implement size in DEV_BSIZE blocks */ 810 int 811 ddi_prop_op_nblocks(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, 812 int mod_flags, char *name, caddr_t valuep, int *lengthp, 813 uint64_t nblocks64); 814 815 /* ddi_prop_op_nblocks_blksize: like ddi_prop_op_nblocks, in blksize blocks */ 816 int 817 ddi_prop_op_nblocks_blksize(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op, 818 int mod_flags, char *name, caddr_t valuep, int *lengthp, 819 uint64_t nblocks64, uint_t blksize); 820 821 /* 822 * Variable length props... 823 */ 824 825 /* 826 * ddi_getlongprop: Get variable length property len+val into a buffer 827 * allocated by property provider via kmem_alloc. Requester 828 * is responsible for freeing returned property via kmem_free. 829 * 830 * Arguments: 831 * 832 * dev: Input: dev_t of property. 833 * dip: Input: dev_info_t pointer of child. 834 * flags: Input: Possible flag modifiers are: 835 * DDI_PROP_DONTPASS: Don't pass to parent if prop not found. 836 * DDI_PROP_CANSLEEP: Memory allocation may sleep. 837 * name: Input: name of property. 838 * valuep: Output: Addr of callers buffer pointer. 839 * lengthp:Output: *lengthp will contain prop length on exit. 840 * 841 * Possible Returns: 842 * 843 * DDI_PROP_SUCCESS: Prop found and returned. 844 * DDI_PROP_NOT_FOUND: Prop not found 845 * DDI_PROP_UNDEFINED: Prop explicitly undefined. 846 * DDI_PROP_NO_MEMORY: Prop found, but unable to alloc mem. 847 */ 848 849 int 850 ddi_getlongprop(dev_t dev, dev_info_t *dip, int flags, 851 char *name, caddr_t valuep, int *lengthp); 852 853 /* 854 * 855 * ddi_getlongprop_buf: Get long prop into pre-allocated callers 856 * buffer. (no memory allocation by provider). 857 * 858 * dev: Input: dev_t of property. 859 * dip: Input: dev_info_t pointer of child. 860 * flags: Input: DDI_PROP_DONTPASS or NULL 861 * name: Input: name of property 862 * valuep: Input: ptr to callers buffer. 863 * lengthp:I/O: ptr to length of callers buffer on entry, 864 * actual length of property on exit. 865 * 866 * Possible returns: 867 * 868 * DDI_PROP_SUCCESS Prop found and returned 869 * DDI_PROP_NOT_FOUND Prop not found 870 * DDI_PROP_UNDEFINED Prop explicitly undefined. 871 * DDI_PROP_BUF_TOO_SMALL Prop found, callers buf too small, 872 * no value returned, but actual prop 873 * length returned in *lengthp 874 * 875 */ 876 877 int 878 ddi_getlongprop_buf(dev_t dev, dev_info_t *dip, int flags, 879 char *name, caddr_t valuep, int *lengthp); 880 881 /* 882 * Integer/boolean sized props. 883 * 884 * Call is value only... returns found boolean or int sized prop value or 885 * defvalue if prop not found or is wrong length or is explicitly undefined. 886 * Only flag is DDI_PROP_DONTPASS... 887 * 888 * By convention, this interface returns boolean (0) sized properties 889 * as value (int)1. 890 */ 891 892 int 893 ddi_getprop(dev_t dev, dev_info_t *dip, int flags, char *name, int defvalue); 894 895 /* 896 * Get prop length interface: flags are 0 or DDI_PROP_DONTPASS 897 * if returns DDI_PROP_SUCCESS, length returned in *lengthp. 898 */ 899 900 int 901 ddi_getproplen(dev_t dev, dev_info_t *dip, int flags, char *name, int *lengthp); 902 903 904 /* 905 * Interface to create/modify a managed property on child's behalf... 906 * Only flag is DDI_PROP_CANSLEEP to allow memory allocation to sleep 907 * if no memory available for internal prop structure. Long property 908 * (non integer sized) value references are not copied. 909 * 910 * Define property with DDI_DEV_T_NONE dev_t for properties not associated 911 * with any particular dev_t. Use the same dev_t when modifying or undefining 912 * a property. 913 * 914 * No guarantee on order of property search, so don't mix the same 915 * property name with wildcard and non-wildcard dev_t's. 916 */ 917 918 /* 919 * ddi_prop_create: Define a managed property: 920 */ 921 922 int 923 ddi_prop_create(dev_t dev, dev_info_t *dip, int flag, 924 char *name, caddr_t value, int length); 925 926 /* 927 * ddi_prop_modify: Modify a managed property value 928 */ 929 930 int 931 ddi_prop_modify(dev_t dev, dev_info_t *dip, int flag, 932 char *name, caddr_t value, int length); 933 934 /* 935 * ddi_prop_remove: Undefine a managed property: 936 */ 937 938 int 939 ddi_prop_remove(dev_t dev, dev_info_t *dip, char *name); 940 941 /* 942 * ddi_prop_remove_all: Used before unloading a driver to remove 943 * all properties. (undefines all dev_t's props.) 944 * Also removes `undefined' prop defs. 945 */ 946 947 void 948 ddi_prop_remove_all(dev_info_t *dip); 949 950 951 /* 952 * ddi_prop_undefine: Explicitly undefine a property. Property 953 * searches which match this property return 954 * the error code DDI_PROP_UNDEFINED. 955 * 956 * Use ddi_prop_remove to negate effect of 957 * ddi_prop_undefine 958 */ 959 960 int 961 ddi_prop_undefine(dev_t dev, dev_info_t *dip, int flag, char *name); 962 963 964 /* 965 * ddi_prop_cache_invalidate 966 * Invalidate a property in the current cached 967 * devinfo snapshot - next cached snapshot will 968 * return the latest property value available. 969 */ 970 void 971 ddi_prop_cache_invalidate(dev_t dev, dev_info_t *dip, char *name, int flags); 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 time_t 1537 ddi_get_time(void); 1538 1539 pid_t 1540 ddi_get_pid(void); 1541 1542 kt_did_t 1543 ddi_get_kt_did(void); 1544 1545 boolean_t 1546 ddi_can_receive_sig(void); 1547 1548 void 1549 swab(void *src, void *dst, size_t nbytes); 1550 1551 int 1552 ddi_create_minor_node(dev_info_t *dip, char *name, int spec_type, 1553 minor_t minor_num, char *node_type, int flag); 1554 1555 int 1556 ddi_create_priv_minor_node(dev_info_t *dip, char *name, int spec_type, 1557 minor_t minor_num, char *node_type, int flag, 1558 const char *rdpriv, const char *wrpriv, mode_t priv_mode); 1559 1560 void 1561 ddi_remove_minor_node(dev_info_t *dip, char *name); 1562 1563 int 1564 ddi_in_panic(void); 1565 1566 int 1567 ddi_streams_driver(dev_info_t *dip); 1568 1569 /* 1570 * DDI wrappers for ffs and fls 1571 */ 1572 int 1573 ddi_ffs(long mask); 1574 1575 int 1576 ddi_fls(long mask); 1577 1578 /* 1579 * The ddi_soft_state* routines comprise generic storage management utilities 1580 * for driver soft state structures. Two types of soft_state indexes are 1581 * supported: 'integer index', and 'string index'. 1582 */ 1583 typedef struct __ddi_soft_state_bystr ddi_soft_state_bystr; 1584 1585 /* 1586 * Initialize a soft_state set, establishing the 'size' of soft state objects 1587 * in the set. 1588 * 1589 * For an 'integer indexed' soft_state set, the initial set will accommodate 1590 * 'n_items' objects - 'n_items' is a hint (i.e. zero is allowed), allocations 1591 * that exceed 'n_items' have additional overhead. 1592 * 1593 * For a 'string indexed' soft_state set, 'n_items' should be the typical 1594 * number of soft state objects in the set - 'n_items' is a hint, there may 1595 * be additional overhead if the hint is too small (and wasted memory if the 1596 * hint is too big). 1597 */ 1598 int 1599 ddi_soft_state_init(void **state_p, size_t size, size_t n_items); 1600 int 1601 ddi_soft_state_bystr_init(ddi_soft_state_bystr **state_p, 1602 size_t size, int n_items); 1603 1604 /* 1605 * Allocate a soft state object associated with either 'integer index' or 1606 * 'string index' from a soft_state set. 1607 */ 1608 int 1609 ddi_soft_state_zalloc(void *state, int item); 1610 int 1611 ddi_soft_state_bystr_zalloc(ddi_soft_state_bystr *state, const char *str); 1612 1613 /* 1614 * Get the pointer to the allocated soft state object associated with 1615 * either 'integer index' or 'string index'. 1616 */ 1617 void * 1618 ddi_get_soft_state(void *state, int item); 1619 void * 1620 ddi_soft_state_bystr_get(ddi_soft_state_bystr *state, const char *str); 1621 1622 /* 1623 * Free the soft state object associated with either 'integer index' 1624 * or 'string index'. 1625 */ 1626 void 1627 ddi_soft_state_free(void *state, int item); 1628 void 1629 ddi_soft_state_bystr_free(ddi_soft_state_bystr *state, const char *str); 1630 1631 /* 1632 * Free the soft state set and any associated soft state objects. 1633 */ 1634 void 1635 ddi_soft_state_fini(void **state_p); 1636 void 1637 ddi_soft_state_bystr_fini(ddi_soft_state_bystr **state_p); 1638 1639 /* 1640 * The ddi_strid_* routines provide string-to-index management utilities. 1641 */ 1642 typedef struct __ddi_strid ddi_strid; 1643 int 1644 ddi_strid_init(ddi_strid **strid_p, int n_items); 1645 id_t 1646 ddi_strid_alloc(ddi_strid *strid, char *str); 1647 id_t 1648 ddi_strid_str2id(ddi_strid *strid, char *str); 1649 char * 1650 ddi_strid_id2str(ddi_strid *strid, id_t id); 1651 void 1652 ddi_strid_free(ddi_strid *strid, id_t id); 1653 void 1654 ddi_strid_fini(ddi_strid **strid_p); 1655 1656 /* 1657 * Set the addr field of the name in dip to name 1658 */ 1659 void 1660 ddi_set_name_addr(dev_info_t *dip, char *name); 1661 1662 /* 1663 * Get the address part of the name. 1664 */ 1665 char * 1666 ddi_get_name_addr(dev_info_t *dip); 1667 1668 void 1669 ddi_set_parent_data(dev_info_t *dip, void *pd); 1670 1671 void * 1672 ddi_get_parent_data(dev_info_t *dip); 1673 1674 int 1675 ddi_initchild(dev_info_t *parent, dev_info_t *proto); 1676 1677 int 1678 ddi_uninitchild(dev_info_t *dip); 1679 1680 major_t 1681 ddi_name_to_major(char *name); 1682 1683 char * 1684 ddi_major_to_name(major_t major); 1685 1686 char * 1687 ddi_deviname(dev_info_t *dip, char *name); 1688 1689 char * 1690 ddi_pathname(dev_info_t *dip, char *path); 1691 1692 char * 1693 ddi_pathname_minor(struct ddi_minor_data *dmdp, char *path); 1694 1695 char * 1696 ddi_pathname_obp(dev_info_t *dip, char *path); 1697 1698 int 1699 ddi_pathname_obp_set(dev_info_t *dip, char *component); 1700 1701 int 1702 ddi_dev_pathname(dev_t devt, int spec_type, char *name); 1703 1704 dev_t 1705 ddi_pathname_to_dev_t(char *pathname); 1706 1707 /* 1708 * High resolution system timer functions. 1709 * 1710 * These functions are already in the kernel (see sys/time.h). 1711 * The ddi supports the notion of a hrtime_t type and the 1712 * functions gethrtime, hrtadd, hrtsub and hrtcmp. 1713 */ 1714 1715 1716 /* 1717 * Nexus wrapper functions 1718 * 1719 * These functions are for entries in a bus nexus driver's bus_ops 1720 * structure for when the driver doesn't have such a function and 1721 * doesn't wish to prohibit such a function from existing. They 1722 * may also be called to start passing a request up the dev_info 1723 * tree. 1724 */ 1725 1726 /* 1727 * bus_ctl wrapper 1728 */ 1729 1730 int 1731 ddi_ctlops(dev_info_t *d, dev_info_t *r, ddi_ctl_enum_t o, void *a, void *v); 1732 1733 /* 1734 * bus_dma_map wrapper 1735 */ 1736 1737 int 1738 ddi_dma_map(dev_info_t *dip, dev_info_t *rdip, 1739 struct ddi_dma_req *dmareqp, ddi_dma_handle_t *handlep); 1740 1741 int 1742 ddi_dma_allochdl(dev_info_t *dip, dev_info_t *rdip, ddi_dma_attr_t *attr, 1743 int (*waitfp)(caddr_t), caddr_t arg, ddi_dma_handle_t *handlep); 1744 1745 int 1746 ddi_dma_freehdl(dev_info_t *dip, dev_info_t *rdip, 1747 ddi_dma_handle_t handle); 1748 1749 int 1750 ddi_dma_bindhdl(dev_info_t *dip, dev_info_t *rdip, 1751 ddi_dma_handle_t handle, struct ddi_dma_req *dmareq, 1752 ddi_dma_cookie_t *cp, uint_t *ccountp); 1753 1754 int 1755 ddi_dma_unbindhdl(dev_info_t *dip, dev_info_t *rdip, 1756 ddi_dma_handle_t handle); 1757 1758 int 1759 ddi_dma_flush(dev_info_t *dip, dev_info_t *rdip, 1760 ddi_dma_handle_t handle, off_t off, size_t len, 1761 uint_t cache_flags); 1762 1763 int 1764 ddi_dma_win(dev_info_t *dip, dev_info_t *rdip, 1765 ddi_dma_handle_t handle, uint_t win, off_t *offp, 1766 size_t *lenp, ddi_dma_cookie_t *cookiep, uint_t *ccountp); 1767 1768 /* 1769 * bus_dma_ctl wrapper 1770 */ 1771 1772 int 1773 ddi_dma_mctl(dev_info_t *dip, dev_info_t *rdip, ddi_dma_handle_t handle, 1774 enum ddi_dma_ctlops request, off_t *offp, size_t *lenp, 1775 caddr_t *objp, uint_t flags); 1776 1777 /* 1778 * dvma support for networking drivers 1779 */ 1780 1781 unsigned long 1782 dvma_pagesize(dev_info_t *dip); 1783 1784 int 1785 dvma_reserve(dev_info_t *dip, ddi_dma_lim_t *limp, uint_t pages, 1786 ddi_dma_handle_t *handlep); 1787 1788 void 1789 dvma_release(ddi_dma_handle_t h); 1790 1791 void 1792 dvma_kaddr_load(ddi_dma_handle_t h, caddr_t a, uint_t len, uint_t index, 1793 ddi_dma_cookie_t *cp); 1794 1795 void 1796 dvma_unload(ddi_dma_handle_t h, uint_t objindex, uint_t type); 1797 1798 void 1799 dvma_sync(ddi_dma_handle_t h, uint_t objindex, uint_t type); 1800 1801 /* 1802 * Layered driver support 1803 */ 1804 1805 extern int ddi_copyin(const void *, void *, size_t, int); 1806 extern int ddi_copyout(const void *, void *, size_t, int); 1807 1808 /* 1809 * Send signals to processes 1810 */ 1811 extern void *proc_ref(void); 1812 extern void proc_unref(void *pref); 1813 extern int proc_signal(void *pref, int sig); 1814 1815 /* I/O port access routines */ 1816 extern uint8_t inb(int port); 1817 extern uint16_t inw(int port); 1818 extern uint32_t inl(int port); 1819 extern void outb(int port, uint8_t value); 1820 extern void outw(int port, uint16_t value); 1821 extern void outl(int port, uint32_t value); 1822 1823 /* 1824 * Console bell routines 1825 */ 1826 extern void ddi_ring_console_bell(clock_t duration); 1827 extern void ddi_set_console_bell(void (*bellfunc)(clock_t duration)); 1828 1829 /* 1830 * Fault-related functions 1831 */ 1832 extern int ddi_check_acc_handle(ddi_acc_handle_t); 1833 extern int ddi_check_dma_handle(ddi_dma_handle_t); 1834 extern void ddi_dev_report_fault(dev_info_t *, ddi_fault_impact_t, 1835 ddi_fault_location_t, const char *); 1836 extern ddi_devstate_t ddi_get_devstate(dev_info_t *); 1837 1838 /* 1839 * Miscellaneous redefines 1840 */ 1841 #define uiophysio physio 1842 1843 /* 1844 * utilities - "reg" mapping and all common portable data access functions 1845 */ 1846 1847 /* 1848 * error code from ddi_regs_map_setup 1849 */ 1850 1851 #define DDI_REGS_ACC_CONFLICT (-10) 1852 1853 /* 1854 * Device address advance flags 1855 */ 1856 1857 #define DDI_DEV_NO_AUTOINCR 0x0000 1858 #define DDI_DEV_AUTOINCR 0x0001 1859 1860 int 1861 ddi_regs_map_setup(dev_info_t *dip, uint_t rnumber, caddr_t *addrp, 1862 offset_t offset, offset_t len, ddi_device_acc_attr_t *accattrp, 1863 ddi_acc_handle_t *handle); 1864 1865 void 1866 ddi_regs_map_free(ddi_acc_handle_t *handle); 1867 1868 /* 1869 * these are the prototypes for the common portable data access functions 1870 */ 1871 1872 uint8_t 1873 ddi_get8(ddi_acc_handle_t handle, uint8_t *addr); 1874 1875 uint16_t 1876 ddi_get16(ddi_acc_handle_t handle, uint16_t *addr); 1877 1878 uint32_t 1879 ddi_get32(ddi_acc_handle_t handle, uint32_t *addr); 1880 1881 uint64_t 1882 ddi_get64(ddi_acc_handle_t handle, uint64_t *addr); 1883 1884 void 1885 ddi_rep_get8(ddi_acc_handle_t handle, uint8_t *host_addr, uint8_t *dev_addr, 1886 size_t repcount, uint_t flags); 1887 1888 void 1889 ddi_rep_get16(ddi_acc_handle_t handle, uint16_t *host_addr, uint16_t *dev_addr, 1890 size_t repcount, uint_t flags); 1891 1892 void 1893 ddi_rep_get32(ddi_acc_handle_t handle, uint32_t *host_addr, uint32_t *dev_addr, 1894 size_t repcount, uint_t flags); 1895 1896 void 1897 ddi_rep_get64(ddi_acc_handle_t handle, uint64_t *host_addr, uint64_t *dev_addr, 1898 size_t repcount, uint_t flags); 1899 1900 void 1901 ddi_put8(ddi_acc_handle_t handle, uint8_t *addr, uint8_t value); 1902 1903 void 1904 ddi_put16(ddi_acc_handle_t handle, uint16_t *addr, uint16_t value); 1905 1906 void 1907 ddi_put32(ddi_acc_handle_t handle, uint32_t *addr, uint32_t value); 1908 1909 void 1910 ddi_put64(ddi_acc_handle_t handle, uint64_t *addr, uint64_t value); 1911 1912 void 1913 ddi_rep_put8(ddi_acc_handle_t handle, uint8_t *host_addr, uint8_t *dev_addr, 1914 size_t repcount, uint_t flags); 1915 void 1916 ddi_rep_put16(ddi_acc_handle_t handle, uint16_t *host_addr, uint16_t *dev_addr, 1917 size_t repcount, uint_t flags); 1918 void 1919 ddi_rep_put32(ddi_acc_handle_t handle, uint32_t *host_addr, uint32_t *dev_addr, 1920 size_t repcount, uint_t flags); 1921 1922 void 1923 ddi_rep_put64(ddi_acc_handle_t handle, uint64_t *host_addr, uint64_t *dev_addr, 1924 size_t repcount, uint_t flags); 1925 1926 /* 1927 * these are special device handling functions 1928 */ 1929 int 1930 ddi_device_zero(ddi_acc_handle_t handle, caddr_t dev_addr, 1931 size_t bytecount, ssize_t dev_advcnt, uint_t dev_datasz); 1932 1933 int 1934 ddi_device_copy( 1935 ddi_acc_handle_t src_handle, caddr_t src_addr, ssize_t src_advcnt, 1936 ddi_acc_handle_t dest_handle, caddr_t dest_addr, ssize_t dest_advcnt, 1937 size_t bytecount, uint_t dev_datasz); 1938 1939 /* 1940 * these are software byte swapping functions 1941 */ 1942 uint16_t 1943 ddi_swap16(uint16_t value); 1944 1945 uint32_t 1946 ddi_swap32(uint32_t value); 1947 1948 uint64_t 1949 ddi_swap64(uint64_t value); 1950 1951 /* 1952 * these are the prototypes for PCI local bus functions 1953 */ 1954 /* 1955 * PCI power management capabilities reporting in addition to those 1956 * provided by the PCI Power Management Specification. 1957 */ 1958 #define PCI_PM_IDLESPEED 0x1 /* clock for idle dev - cap */ 1959 #define PCI_PM_IDLESPEED_ANY (void *)-1 /* any clock for idle dev */ 1960 #define PCI_PM_IDLESPEED_NONE (void *)-2 /* regular clock for idle dev */ 1961 1962 int 1963 pci_config_setup(dev_info_t *dip, ddi_acc_handle_t *handle); 1964 1965 void 1966 pci_config_teardown(ddi_acc_handle_t *handle); 1967 1968 uint8_t 1969 pci_config_get8(ddi_acc_handle_t handle, off_t offset); 1970 1971 uint16_t 1972 pci_config_get16(ddi_acc_handle_t handle, off_t offset); 1973 1974 uint32_t 1975 pci_config_get32(ddi_acc_handle_t handle, off_t offset); 1976 1977 uint64_t 1978 pci_config_get64(ddi_acc_handle_t handle, off_t offset); 1979 1980 void 1981 pci_config_put8(ddi_acc_handle_t handle, off_t offset, uint8_t value); 1982 1983 void 1984 pci_config_put16(ddi_acc_handle_t handle, off_t offset, uint16_t value); 1985 1986 void 1987 pci_config_put32(ddi_acc_handle_t handle, off_t offset, uint32_t value); 1988 1989 void 1990 pci_config_put64(ddi_acc_handle_t handle, off_t offset, uint64_t value); 1991 1992 int 1993 pci_report_pmcap(dev_info_t *dip, int cap, void *arg); 1994 1995 int 1996 pci_restore_config_regs(dev_info_t *dip); 1997 1998 int 1999 pci_save_config_regs(dev_info_t *dip); 2000 2001 void 2002 pci_ereport_setup(dev_info_t *dip); 2003 2004 void 2005 pci_ereport_teardown(dev_info_t *dip); 2006 2007 void 2008 pci_ereport_post(dev_info_t *dip, ddi_fm_error_t *derr, uint16_t *status); 2009 2010 #if defined(__i386) || defined(__amd64) 2011 int 2012 pci_peekpoke_check(dev_info_t *, dev_info_t *, ddi_ctl_enum_t, void *, void *, 2013 int (*handler)(dev_info_t *, dev_info_t *, ddi_ctl_enum_t, void *, 2014 void *), kmutex_t *, kmutex_t *, 2015 void (*scan)(dev_info_t *, ddi_fm_error_t *)); 2016 #endif 2017 2018 void 2019 pci_target_enqueue(uint64_t, char *, char *, uint64_t); 2020 2021 void 2022 pci_targetq_init(void); 2023 2024 int 2025 pci_post_suspend(dev_info_t *dip); 2026 2027 int 2028 pci_pre_resume(dev_info_t *dip); 2029 2030 /* 2031 * the prototype for the C Language Type Model inquiry. 2032 */ 2033 model_t ddi_mmap_get_model(void); 2034 model_t ddi_model_convert_from(model_t); 2035 2036 /* 2037 * these are the prototypes for device id functions. 2038 */ 2039 int 2040 ddi_devid_valid(ddi_devid_t devid); 2041 2042 int 2043 ddi_devid_register(dev_info_t *dip, ddi_devid_t devid); 2044 2045 void 2046 ddi_devid_unregister(dev_info_t *dip); 2047 2048 int 2049 ddi_devid_init(dev_info_t *dip, ushort_t devid_type, ushort_t nbytes, 2050 void *id, ddi_devid_t *ret_devid); 2051 2052 int 2053 ddi_devid_get(dev_info_t *dip, ddi_devid_t *ret_devid); 2054 2055 size_t 2056 ddi_devid_sizeof(ddi_devid_t devid); 2057 2058 void 2059 ddi_devid_free(ddi_devid_t devid); 2060 2061 int 2062 ddi_devid_compare(ddi_devid_t id1, ddi_devid_t id2); 2063 2064 int 2065 ddi_devid_scsi_encode(int version, char *driver_name, 2066 uchar_t *inq, size_t inq_len, uchar_t *inq80, size_t inq80_len, 2067 uchar_t *inq83, size_t inq83_len, ddi_devid_t *ret_devid); 2068 2069 int 2070 ddi_devid_smp_encode(int version, char *driver_name, 2071 char *wwnstr, uchar_t *srmir_buf, size_t srmir_len, 2072 ddi_devid_t *ret_devid); 2073 2074 char 2075 *ddi_devid_to_guid(ddi_devid_t devid); 2076 2077 void 2078 ddi_devid_free_guid(char *guid); 2079 2080 int 2081 ddi_lyr_get_devid(dev_t dev, ddi_devid_t *ret_devid); 2082 2083 int 2084 ddi_lyr_get_minor_name(dev_t dev, int spec_type, char **minor_name); 2085 2086 int 2087 ddi_lyr_devid_to_devlist(ddi_devid_t devid, char *minor_name, int *retndevs, 2088 dev_t **retdevs); 2089 2090 void 2091 ddi_lyr_free_devlist(dev_t *devlist, int ndevs); 2092 2093 char * 2094 ddi_devid_str_encode(ddi_devid_t devid, char *minor_name); 2095 2096 int 2097 ddi_devid_str_decode(char *devidstr, ddi_devid_t *devidp, char **minor_namep); 2098 2099 void 2100 ddi_devid_str_free(char *devidstr); 2101 2102 int 2103 ddi_devid_str_compare(char *id1_str, char *id2_str); 2104 2105 /* 2106 * Event to post to when a devinfo node is removed. 2107 */ 2108 #define DDI_DEVI_REMOVE_EVENT "DDI:DEVI_REMOVE" 2109 #define DDI_DEVI_INSERT_EVENT "DDI:DEVI_INSERT" 2110 #define DDI_DEVI_BUS_RESET_EVENT "DDI:DEVI_BUS_RESET" 2111 #define DDI_DEVI_DEVICE_RESET_EVENT "DDI:DEVI_DEVICE_RESET" 2112 2113 /* 2114 * Invoke bus nexus driver's implementation of the 2115 * (*bus_remove_eventcall)() interface to remove a registered 2116 * callback handler for "event". 2117 */ 2118 int 2119 ddi_remove_event_handler(ddi_callback_id_t id); 2120 2121 /* 2122 * Invoke bus nexus driver's implementation of the 2123 * (*bus_add_eventcall)() interface to register a callback handler 2124 * for "event". 2125 */ 2126 int 2127 ddi_add_event_handler(dev_info_t *dip, ddi_eventcookie_t event, 2128 void (*handler)(dev_info_t *, ddi_eventcookie_t, void *, void *), 2129 void *arg, ddi_callback_id_t *id); 2130 2131 /* 2132 * Return a handle for event "name" by calling up the device tree 2133 * hierarchy via (*bus_get_eventcookie)() interface until claimed 2134 * by a bus nexus or top of dev_info tree is reached. 2135 */ 2136 int 2137 ddi_get_eventcookie(dev_info_t *dip, char *name, 2138 ddi_eventcookie_t *event_cookiep); 2139 2140 /* 2141 * log a system event 2142 */ 2143 int 2144 ddi_log_sysevent(dev_info_t *dip, char *vendor, char *class_name, 2145 char *subclass_name, nvlist_t *attr_list, sysevent_id_t *eidp, 2146 int sleep_flag); 2147 2148 /* 2149 * ddi_log_sysevent() vendors 2150 */ 2151 #define DDI_VENDOR_SUNW "SUNW" 2152 2153 /* 2154 * Opaque task queue handle. 2155 */ 2156 typedef struct ddi_taskq ddi_taskq_t; 2157 2158 /* 2159 * Use default system priority. 2160 */ 2161 #define TASKQ_DEFAULTPRI -1 2162 2163 /* 2164 * Create a task queue 2165 */ 2166 ddi_taskq_t *ddi_taskq_create(dev_info_t *dip, const char *name, 2167 int nthreads, pri_t pri, uint_t cflags); 2168 2169 /* 2170 * destroy a task queue 2171 */ 2172 void ddi_taskq_destroy(ddi_taskq_t *tq); 2173 2174 /* 2175 * Dispatch a task to a task queue 2176 */ 2177 int ddi_taskq_dispatch(ddi_taskq_t *tq, void (* func)(void *), 2178 void *arg, uint_t dflags); 2179 2180 /* 2181 * Wait for all previously scheduled tasks to complete. 2182 */ 2183 void ddi_taskq_wait(ddi_taskq_t *tq); 2184 2185 /* 2186 * Suspend all task execution. 2187 */ 2188 void ddi_taskq_suspend(ddi_taskq_t *tq); 2189 2190 /* 2191 * Resume task execution. 2192 */ 2193 void ddi_taskq_resume(ddi_taskq_t *tq); 2194 2195 /* 2196 * Is task queue suspended? 2197 */ 2198 boolean_t ddi_taskq_suspended(ddi_taskq_t *tq); 2199 2200 /* 2201 * Parse an interface name of the form <alphanumeric>##<numeric> where 2202 * <numeric> is maximal. 2203 */ 2204 int ddi_parse(const char *, char *, uint_t *); 2205 2206 /* 2207 * DDI interrupt priority level 2208 */ 2209 #define DDI_IPL_0 (0) /* kernel context */ 2210 #define DDI_IPL_1 (1) /* interrupt priority level 1 */ 2211 #define DDI_IPL_2 (2) /* interrupt priority level 2 */ 2212 #define DDI_IPL_3 (3) /* interrupt priority level 3 */ 2213 #define DDI_IPL_4 (4) /* interrupt priority level 4 */ 2214 #define DDI_IPL_5 (5) /* interrupt priority level 5 */ 2215 #define DDI_IPL_6 (6) /* interrupt priority level 6 */ 2216 #define DDI_IPL_7 (7) /* interrupt priority level 7 */ 2217 #define DDI_IPL_8 (8) /* interrupt priority level 8 */ 2218 #define DDI_IPL_9 (9) /* interrupt priority level 9 */ 2219 #define DDI_IPL_10 (10) /* interrupt priority level 10 */ 2220 2221 /* 2222 * DDI periodic timeout interface 2223 */ 2224 ddi_periodic_t ddi_periodic_add(void (*)(void *), void *, hrtime_t, int); 2225 void ddi_periodic_delete(ddi_periodic_t); 2226 2227 /* 2228 * Default quiesce(9E) implementation for drivers that don't need to do 2229 * anything. 2230 */ 2231 int ddi_quiesce_not_needed(dev_info_t *); 2232 2233 /* 2234 * Default quiesce(9E) initialization function for drivers that should 2235 * implement quiesce but haven't yet. 2236 */ 2237 int ddi_quiesce_not_supported(dev_info_t *); 2238 2239 /* 2240 * DDI generic callback interface 2241 */ 2242 2243 typedef struct __ddi_cb **ddi_cb_handle_t; 2244 2245 int ddi_cb_register(dev_info_t *dip, ddi_cb_flags_t flags, 2246 ddi_cb_func_t cbfunc, void *arg1, void *arg2, 2247 ddi_cb_handle_t *ret_hdlp); 2248 int ddi_cb_unregister(ddi_cb_handle_t hdl); 2249 2250 /* Notify DDI of memory added */ 2251 void ddi_mem_update(uint64_t addr, uint64_t size); 2252 2253 /* Path alias interfaces */ 2254 typedef struct plat_alias { 2255 char *pali_current; 2256 uint64_t pali_naliases; 2257 char **pali_aliases; 2258 } plat_alias_t; 2259 2260 typedef struct alias_pair { 2261 char *pair_alias; 2262 char *pair_curr; 2263 } alias_pair_t; 2264 2265 extern boolean_t ddi_aliases_present; 2266 2267 typedef struct ddi_alias { 2268 alias_pair_t *dali_alias_pairs; 2269 alias_pair_t *dali_curr_pairs; 2270 int dali_num_pairs; 2271 mod_hash_t *dali_alias_TLB; 2272 mod_hash_t *dali_curr_TLB; 2273 } ddi_alias_t; 2274 2275 extern ddi_alias_t ddi_aliases; 2276 2277 void ddi_register_aliases(plat_alias_t *pali, uint64_t npali); 2278 dev_info_t *ddi_alias_redirect(char *alias); 2279 char *ddi_curr_redirect(char *curr); 2280 2281 #endif /* _KERNEL */ 2282 2283 #ifdef __cplusplus 2284 } 2285 #endif 2286 2287 #endif /* _SYS_SUNDDI_H */ 2288