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