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