sys/fs/zfs.h: replace grub in comments.
[unleashed.git] / include / sys / sunddi.h
blobd5e52dbbfcaf6da9eff7e208a6e89fe042d6238f
1 /*
2 * CDDL HEADER START
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.
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.
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]
19 * CDDL HEADER END
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 * Copyright 2016 Nexenta Systems, Inc. All rights reserved.
29 #ifndef _SYS_SUNDDI_H
30 #define _SYS_SUNDDI_H
33 * Sun Specific DDI definitions
36 #include <sys/isa_defs.h>
37 #include <sys/dditypes.h>
38 #include <sys/ddipropdefs.h>
39 #include <sys/devops.h>
40 #include <sys/time.h>
41 #include <sys/cmn_err.h>
42 #include <sys/ddidevmap.h>
43 #include <sys/ddi_impldefs.h>
44 #include <sys/ddi_implfuncs.h>
45 #include <sys/ddi_isa.h>
46 #include <sys/model.h>
47 #include <sys/devctl.h>
48 #if defined(__i386) || defined(__amd64)
49 #include <sys/dma_engine.h>
50 #endif
51 #include <sys/sunpm.h>
52 #include <sys/nvpair.h>
53 #include <sys/sysevent.h>
54 #include <sys/thread.h>
55 #include <sys/stream.h>
56 #if defined(__GNUC__) && defined(_ASM_INLINES) && defined(_KERNEL)
57 #include <asm/sunddi.h>
58 #endif
59 #ifdef _KERNEL
60 #include <sys/ddi_obsolete.h>
61 #endif
62 #include <sys/u8_textprep.h>
63 #include <sys/kiconv.h>
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
70 * Generic Sun DDI definitions.
73 #define DDI_SUCCESS (0) /* successful return */
74 #define DDI_FAILURE (-1) /* unsuccessful return */
75 #define DDI_NOT_WELL_FORMED (-2) /* A dev_info node is not valid */
76 #define DDI_EAGAIN (-3) /* not enough interrupt resources */
77 #define DDI_EINVAL (-4) /* invalid request or arguments */
78 #define DDI_ENOTSUP (-5) /* operation is not supported */
79 #define DDI_EPENDING (-6) /* operation or an event is pending */
80 #define DDI_EALREADY (-7) /* operation already in progress */
83 * General-purpose DDI error return value definitions
85 #define DDI_ENOMEM 1 /* memory not available */
86 #define DDI_EBUSY 2 /* busy */
87 #define DDI_ETRANSPORT 3 /* transport down */
88 #define DDI_ECONTEXT 4 /* context error */
92 * General DDI sleep/nosleep allocation flags
94 #define DDI_SLEEP 0
95 #define DDI_NOSLEEP 1
98 * The following special nodeid values are reserved for use when creating
99 * nodes ONLY. They specify the attributes of the DDI_NC_PSEUDO class node
100 * being created:
102 * o DEVI_PSEUDO_NODEID specifics a node without persistence.
103 * o DEVI_SID_NODEID specifies a node with persistence.
104 * o DEVI_SID_HIDDEN_NODEID specifies a hidden node with persistence.
106 * A node with the 'hidden' attribute will not show up in devinfo snapshots
107 * or in /devices file system.
109 * A node with the 'persistent' attribute will not be automatically removed by
110 * the framework in the current implementation - driver.conf nodes are without
111 * persistence.
113 * The actual nodeid value may be assigned by the framework and may be
114 * different than these special values. Drivers may not make assumptions
115 * about the nodeid value that is actually assigned to the node.
118 #define DEVI_PSEUDO_NODEID ((int)-1)
119 #define DEVI_SID_NODEID ((int)-2)
120 #define DEVI_SID_HIDDEN_NODEID ((int)-3)
121 #define DEVI_SID_HP_NODEID ((int)-4)
122 #define DEVI_SID_HP_HIDDEN_NODEID ((int)-5)
124 #define DEVI_PSEUDO_NEXNAME "pseudo"
125 #define DEVI_ISA_NEXNAME "isa"
126 #define DEVI_EISA_NEXNAME "eisa"
129 * ddi_create_minor_node flags
131 #define CLONE_DEV 1 /* device is a clone device */
132 #define PRIVONLY_DEV 0x10 /* policy-based permissions only */
135 * Historical values used for the flag field in ddi_create_minor_node.
136 * Future use of flag bits should avoid these fields to keep binary
137 * compatibility
138 * #define GLOBAL_DEV 0x2
139 * #define NODEBOUND_DEV 0x4
140 * #define NODESPECIFIC_DEV 0x6
141 * #define ENUMERATED_DEV 0x8
145 * Device type defines which are used by the 'node_type' element of the
146 * ddi_minor_data structure
148 #define DDI_NT_SERIAL "ddi_serial" /* Serial port */
149 #define DDI_NT_SERIAL_MB "ddi_serial:mb" /* the 'built-in' serial */
150 /* ports (the old ttya, b */
151 /* (,c ,d)) */
152 #define DDI_NT_SERIAL_DO "ddi_serial:dialout" /* dialout ports */
153 #define DDI_NT_SERIAL_MB_DO "ddi_serial:dialout,mb" /* dialout for onboard */
154 /* ports */
155 #define DDI_NT_SERIAL_LOMCON "ddi_serial:lomcon" /* LOMlite2 console port */
158 * *_CHAN disk type devices have channel numbers or target numbers.
159 * (i.e. ipi and scsi devices)
161 #define DDI_NT_BLOCK "ddi_block" /* hard disks */
163 * The next define is for block type devices that can possible exist on
164 * a sub-bus like the scsi bus or the ipi channel. The 'disks' program
165 * will pick up on this and create logical names like c0t0d0s0 instead of
166 * c0d0s0
168 #define DDI_NT_BLOCK_CHAN "ddi_block:channel"
169 #define DDI_NT_BLOCK_WWN "ddi_block:wwn"
170 #define DDI_NT_CD "ddi_block:cdrom" /* rom drives (cd-rom) */
171 #define DDI_NT_CD_CHAN "ddi_block:cdrom:channel" /* rom drives (scsi type) */
172 #define DDI_NT_FD "ddi_block:diskette" /* floppy disks */
174 #define DDI_NT_ENCLOSURE "ddi_enclosure"
175 #define DDI_NT_SCSI_ENCLOSURE "ddi_enclosure:scsi"
177 #define DDI_NT_BLOCK_SAS "ddi_block:sas"
178 #define DDI_NT_BLOCK_BLKDEV "ddi_block:blkdev"
181 * xVM virtual block devices
183 #define DDI_NT_BLOCK_XVMD "ddi_block:xvmd"
184 #define DDI_NT_CD_XVMD "ddi_block:cdrom:xvmd"
187 #define DDI_NT_TAPE "ddi_byte:tape" /* tape drives */
189 #define DDI_NT_NET "ddi_network" /* DLPI network devices */
191 #define DDI_NT_NET_WIFI "ddi_network:wifi" /* wifi devices */
193 #define DDI_NT_DISPLAY "ddi_display" /* display devices */
195 #define DDI_NT_DISPLAY_DRM "ddi_display:drm" /* drm display devices */
197 #define DDI_PSEUDO "ddi_pseudo" /* general pseudo devices */
199 #define DDI_NT_AUDIO "ddi_audio" /* audio device */
201 #define DDI_NT_MOUSE "ddi_mouse" /* mouse device */
203 #define DDI_NT_KEYBOARD "ddi_keyboard" /* keyboard device */
205 #define DDI_NT_PARALLEL "ddi_parallel" /* parallel port */
207 #define DDI_NT_PRINTER "ddi_printer" /* printer device */
209 #define DDI_NT_UGEN "ddi_generic:usb" /* USB generic drv */
211 #define DDI_NT_SMP "ddi_sas_smp" /* smp devcies */
213 #define DDI_NT_NEXUS "ddi_ctl:devctl" /* nexus drivers */
215 #define DDI_NT_SCSI_NEXUS "ddi_ctl:devctl:scsi" /* nexus drivers */
217 #define DDI_NT_SATA_NEXUS "ddi_ctl:devctl:sata" /* nexus drivers */
219 #define DDI_NT_IB_NEXUS "ddi_ctl:devctl:ib" /* nexus drivers */
221 #define DDI_NT_ATTACHMENT_POINT "ddi_ctl:attachment_point" /* attachment pt */
223 #define DDI_NT_SCSI_ATTACHMENT_POINT "ddi_ctl:attachment_point:scsi"
224 /* scsi attachment pt */
226 #define DDI_NT_SATA_ATTACHMENT_POINT "ddi_ctl:attachment_point:sata"
227 /* sata attachment pt */
229 #define DDI_NT_SDCARD_ATTACHMENT_POINT "ddi_ctl:attachment_point:sdcard"
230 /* sdcard attachment pt */
232 #define DDI_NT_PCI_ATTACHMENT_POINT "ddi_ctl:attachment_point:pci"
233 /* PCI attachment pt */
234 #define DDI_NT_SBD_ATTACHMENT_POINT "ddi_ctl:attachment_point:sbd"
235 /* generic bd attachment pt */
236 #define DDI_NT_FC_ATTACHMENT_POINT "ddi_ctl:attachment_point:fc"
237 /* FC attachment pt */
238 #define DDI_NT_USB_ATTACHMENT_POINT "ddi_ctl:attachment_point:usb"
239 /* USB devices */
240 #define DDI_NT_BLOCK_FABRIC "ddi_block:fabric"
241 /* Fabric Devices */
242 #define DDI_NT_IB_ATTACHMENT_POINT "ddi_ctl:attachment_point:ib"
243 /* IB devices */
245 #define DDI_NT_AV_ASYNC "ddi_av:async" /* asynchronous AV device */
246 #define DDI_NT_AV_ISOCH "ddi_av:isoch" /* isochronous AV device */
248 /* Device types used for agpgart driver related devices */
249 #define DDI_NT_AGP_PSEUDO "ddi_agp:pseudo" /* agpgart pseudo device */
250 #define DDI_NT_AGP_MASTER "ddi_agp:master" /* agp master device */
251 #define DDI_NT_AGP_TARGET "ddi_agp:target" /* agp target device */
252 #define DDI_NT_AGP_CPUGART "ddi_agp:cpugart" /* amd64 on-cpu gart device */
254 #define DDI_NT_REGACC "ddi_tool_reg" /* tool register access */
255 #define DDI_NT_INTRCTL "ddi_tool_intr" /* tool intr access */
258 * DDI event definitions
260 #define EC_DEVFS "EC_devfs" /* Event class devfs */
261 #define EC_DDI "EC_ddi" /* Event class ddi */
263 /* Class devfs subclasses */
264 #define ESC_DEVFS_MINOR_CREATE "ESC_devfs_minor_create"
265 #define ESC_DEVFS_MINOR_REMOVE "ESC_devfs_minor_remove"
266 #define ESC_DEVFS_DEVI_ADD "ESC_devfs_devi_add"
267 #define ESC_DEVFS_DEVI_REMOVE "ESC_devfs_devi_remove"
268 #define ESC_DEVFS_INSTANCE_MOD "ESC_devfs_instance_mod"
269 #define ESC_DEVFS_BRANCH_ADD "ESC_devfs_branch_add"
270 #define ESC_DEVFS_BRANCH_REMOVE "ESC_devfs_branch_remove"
271 #define ESC_DEVFS_START "ESC_devfs_start"
273 /* Class ddi subclasses */
274 #define ESC_DDI_INITIATOR_REGISTER "ESC_ddi_initiator_register"
275 #define ESC_DDI_INITIATOR_UNREGISTER "ESC_ddi_initiator_unregister"
277 /* DDI/NDI event publisher */
278 #define EP_DDI SUNW_KERN_PUB"ddi"
281 * devfs event class attributes
283 * The following attributes are private to EC_DEVFS event data.
285 #define DEVFS_DRIVER_NAME "di.driver"
286 #define DEVFS_INSTANCE "di.instance"
287 #define DEVFS_PATHNAME "di.path"
288 #define DEVFS_DEVI_CLASS "di.devi_class"
289 #define DEVFS_BRANCH_EVENT "di.branch_event"
290 #define DEVFS_MINOR_NAME "mi.name"
291 #define DEVFS_MINOR_NODETYPE "mi.nodetype"
292 #define DEVFS_MINOR_ISCLONE "mi.isclone"
293 #define DEVFS_MINOR_MAJNUM "mi.majorno"
294 #define DEVFS_MINOR_MINORNUM "mi.minorno"
297 * ddi event class payload
299 * The following attributes are private to EC_DDI event data.
301 #define DDI_DRIVER_NAME "ddi.driver"
302 #define DDI_DRIVER_MAJOR "ddi.major"
303 #define DDI_INSTANCE "ddi.instance"
304 #define DDI_PATHNAME "ddi.path"
305 #define DDI_CLASS "ddi.class"
308 * Fault-related definitions
310 * The specific numeric values have been chosen to be ordered, but
311 * not consecutive, to allow for future interpolation if required.
313 typedef enum {
314 DDI_SERVICE_LOST = -32,
315 DDI_SERVICE_DEGRADED = -16,
316 DDI_SERVICE_UNAFFECTED = 0,
317 DDI_SERVICE_RESTORED = 16
318 } ddi_fault_impact_t;
320 typedef enum {
321 DDI_DATAPATH_FAULT = -32,
322 DDI_DEVICE_FAULT = -16,
323 DDI_EXTERNAL_FAULT = 0
324 } ddi_fault_location_t;
326 typedef enum {
327 DDI_DEVSTATE_OFFLINE = -32,
328 DDI_DEVSTATE_DOWN = -16,
329 DDI_DEVSTATE_QUIESCED = 0,
330 DDI_DEVSTATE_DEGRADED = 16,
331 DDI_DEVSTATE_UP = 32
332 } ddi_devstate_t;
334 #if defined(_KERNEL) || defined(_FAKE_KERNEL)
337 * Common property definitions
339 #define DDI_FORCEATTACH "ddi-forceattach"
340 #define DDI_NO_AUTODETACH "ddi-no-autodetach"
341 #define DDI_VHCI_CLASS "ddi-vhci-class"
342 #define DDI_NO_ROOT_SUPPORT "ddi-no-root-support"
343 #define DDI_OPEN_RETURNS_EINTR "ddi-open-returns-eintr"
344 #define DDI_DEVID_REGISTRANT "ddi-devid-registrant"
347 * Values that the function supplied to the dev_info
348 * tree traversal functions defined below must return.
352 * Continue search, if appropriate.
354 #define DDI_WALK_CONTINUE 0
357 * Terminate current depth of traversal. That is, terminate
358 * the current traversal of children nodes, but continue
359 * traversing sibling nodes and their children (if any).
362 #define DDI_WALK_PRUNECHILD -1
365 * Terminate current width of traversal. That is, terminate
366 * the current traversal of sibling nodes, but continue with
367 * traversing children nodes and their siblings (if appropriate).
370 #define DDI_WALK_PRUNESIB -2
373 * Terminate the entire search.
376 #define DDI_WALK_TERMINATE -3
379 * Terminate the entire search because an error occurred in function
381 #define DDI_WALK_ERROR -4
384 * Drivers that are prepared to support full driver layering
385 * should create and export a null-valued property of the following
386 * name.
388 * Such drivers should be prepared to be called with FKLYR in
389 * the 'flag' argument of their open(9E), close(9E) routines, and
390 * with FKIOCTL in the 'mode' argument of their ioctl(9E) routines.
392 * See ioctl(9E) and ddi_copyin(9F) for details.
394 #define DDI_KERNEL_IOCTL "ddi-kernel-ioctl"
397 * Model definitions for ddi_mmap_get_model(9F) and ddi_model_convert_from(9F).
399 #define DDI_MODEL_MASK DATAMODEL_MASK /* Note: 0x0FF00000 */
400 #define DDI_MODEL_ILP32 DATAMODEL_ILP32
401 #define DDI_MODEL_LP64 DATAMODEL_LP64
402 #define DDI_MODEL_NATIVE DATAMODEL_NATIVE
403 #define DDI_MODEL_NONE DATAMODEL_NONE
405 /* if set to B_TRUE is DER_MODE is equivalent to DERE_PANIC */
406 extern boolean_t ddi_err_panic;
409 * Defines for ddi_err().
411 typedef enum {
412 DER_INVALID = 0, /* must be 0 */
413 DER_CONT = 1,
414 DER_CONS,
415 DER_LOG,
416 DER_VERB,
417 DER_NOTE,
418 DER_WARN,
419 DER_PANIC,
420 DER_MODE,
421 DER_DEBUG
422 } ddi_err_t;
424 extern void ddi_err(ddi_err_t de, dev_info_t *rdip, const char *fmt, ...);
427 extern char *ddi_strdup(const char *str, int flag);
428 extern char *strdup(const char *str);
429 extern void strfree(char *str);
432 * Functions and data references which really should be in <sys/ddi.h>
435 extern int maxphys;
436 extern void minphys(struct buf *);
437 extern int physio(int (*)(struct buf *), struct buf *, dev_t,
438 int, void (*)(struct buf *), struct uio *);
439 extern void disksort(struct diskhd *, struct buf *);
441 extern size_t strlen(const char *) __PURE;
442 extern size_t strnlen(const char *, size_t) __PURE;
443 extern char *strcpy(char *, const char *);
444 extern char *strncpy(char *, const char *, size_t);
445 /* Need to be consistent with <string.h> C++ definition for strchr() */
446 #if __cplusplus >= 199711L
447 extern const char *strchr(const char *, int);
448 #ifndef _STRCHR_INLINE
449 #define _STRCHR_INLINE
450 extern "C++" {
451 inline char *strchr(char *__s, int __c) {
452 return (char *)strchr((const char *)__s, __c);
455 #endif /* _STRCHR_INLINE */
456 #else
457 extern char *strchr(const char *, int);
458 #endif /* __cplusplus >= 199711L */
459 #define DDI_STRSAME(s1, s2) ((*(s1) == *(s2)) && (strcmp((s1), (s2)) == 0))
460 extern int strcmp(const char *, const char *) __PURE;
461 extern int strncmp(const char *, const char *, size_t) __PURE;
462 extern char *strncat(char *, const char *, size_t);
463 extern size_t strlcat(char *, const char *, size_t);
464 extern size_t strlcpy(char *, const char *, size_t);
465 extern size_t strspn(const char *, const char *);
466 extern size_t strcspn(const char *, const char *);
467 extern char *strsep(char **, const char *);
468 extern int bcmp(const void *, const void *, size_t) __PURE;
469 extern int stoi(char **);
470 extern void numtos(ulong_t, char *);
471 extern void bcopy(const void *, void *, size_t);
472 extern void bzero(void *, size_t);
474 extern void *memcpy(void *, const void *, size_t);
475 extern void *memset(void *, int, size_t);
476 extern void *memmove(void *, const void *, size_t);
477 extern int memcmp(const void *, const void *, size_t) __PURE;
478 /* Need to be consistent with <string.h> C++ definition for memchr() */
479 #if __cplusplus >= 199711L
480 extern const void *memchr(const void *, int, size_t);
481 #ifndef _MEMCHR_INLINE
482 #define _MEMCHR_INLINE
483 extern "C++" {
484 inline void *memchr(void * __s, int __c, size_t __n) {
485 return (void *)memchr((const void *)__s, __c, __n);
488 #endif /* _MEMCHR_INLINE */
489 #else
490 extern void *memchr(const void *, int, size_t);
491 #endif /* __cplusplus >= 199711L */
493 extern int ddi_strtol(const char *, char **, int, long *);
494 extern int ddi_strtoul(const char *, char **, int, unsigned long *);
495 extern int ddi_strtoll(const char *, char **, int, longlong_t *);
496 extern int ddi_strtoull(const char *, char **, int, u_longlong_t *);
499 * kiconv functions and their macros.
501 #define KICONV_IGNORE_NULL (0x0001)
502 #define KICONV_REPLACE_INVALID (0x0002)
504 extern kiconv_t kiconv_open(const char *, const char *);
505 extern size_t kiconv(kiconv_t, char **, size_t *, char **, size_t *, int *);
506 extern int kiconv_close(kiconv_t);
507 extern size_t kiconvstr(const char *, const char *, char *, size_t *, char *,
508 size_t *, int, int *);
510 #endif /* _KERNEL || _FAKE_KERNEL */
511 #ifdef _KERNEL
514 * ddi_map_regs
516 * Map in the register set given by rnumber.
517 * The register number determine which register
518 * set will be mapped if more than one exists.
519 * The parent driver gets the information
520 * from parent private data and sets up the
521 * appropriate mappings and returns the kernel
522 * virtual address of the register set in *kaddrp.
523 * The offset specifies an offset into the register
524 * space to start from and len indicates the size
525 * of the area to map. If len and offset are 0 then
526 * the entire space is mapped. It returns DDI_SUCCESS on
527 * success or DDI_FAILURE otherwise.
531 ddi_map_regs(dev_info_t *dip, uint_t rnumber, caddr_t *kaddrp,
532 off_t offset, off_t len);
535 * ddi_unmap_regs
537 * Undo mappings set up by ddi_map_regs.
538 * The register number determines which register
539 * set will be unmapped if more than one exists.
540 * This is provided for drivers preparing
541 * to detach themselves from the system to
542 * allow them to release allocated mappings.
544 * The kaddrp and len specify the area to be
545 * unmapped. *kaddrp was returned from ddi_map_regs
546 * and len should match what ddi_map_regs was called
547 * with.
550 void
551 ddi_unmap_regs(dev_info_t *dip, uint_t rnumber, caddr_t *kaddrp,
552 off_t offset, off_t len);
555 ddi_map(dev_info_t *dp, ddi_map_req_t *mp, off_t offset, off_t len,
556 caddr_t *addrp);
559 ddi_apply_range(dev_info_t *dip, dev_info_t *rdip, struct regspec *rp);
562 * ddi_rnumber_to_regspec: Not for use by leaf drivers.
564 struct regspec *
565 ddi_rnumber_to_regspec(dev_info_t *dip, int rnumber);
568 ddi_bus_map(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, off_t offset,
569 off_t len, caddr_t *vaddrp);
572 nullbusmap(dev_info_t *dip, dev_info_t *rdip, ddi_map_req_t *mp, off_t offset,
573 off_t len, caddr_t *vaddrp);
575 int ddi_peek8(dev_info_t *dip, int8_t *addr, int8_t *val_p);
576 int ddi_peek16(dev_info_t *dip, int16_t *addr, int16_t *val_p);
577 int ddi_peek32(dev_info_t *dip, int32_t *addr, int32_t *val_p);
578 int ddi_peek64(dev_info_t *dip, int64_t *addr, int64_t *val_p);
580 int ddi_poke8(dev_info_t *dip, int8_t *addr, int8_t val);
581 int ddi_poke16(dev_info_t *dip, int16_t *addr, int16_t val);
582 int ddi_poke32(dev_info_t *dip, int32_t *addr, int32_t val);
583 int ddi_poke64(dev_info_t *dip, int64_t *addr, int64_t val);
586 * Peek and poke to and from a uio structure in xfersize pieces,
587 * using the parent nexi.
589 int ddi_peekpokeio(dev_info_t *devi, struct uio *uio, enum uio_rw rw,
590 caddr_t addr, size_t len, uint_t xfersize);
593 * Pagesize conversions using the parent nexi
595 unsigned long ddi_btop(dev_info_t *dip, unsigned long bytes);
596 unsigned long ddi_btopr(dev_info_t *dip, unsigned long bytes);
597 unsigned long ddi_ptob(dev_info_t *dip, unsigned long pages);
600 * There are no more "block" interrupt functions, per se.
601 * All thread of control should be done with MP/MT lockings.
603 * However, there are certain times in which a driver needs
604 * absolutely a critical guaranteed non-preemptable time
605 * in which to execute a few instructions.
607 * The following pair of functions attempt to guarantee this,
608 * but they are dangerous to use. That is, use them with
609 * extreme care. They do not guarantee to stop other processors
610 * from executing, but they do guarantee that the caller
611 * of ddi_enter_critical will continue to run until the
612 * caller calls ddi_exit_critical. No intervening DDI functions
613 * may be called between an entry and an exit from a critical
614 * region.
616 * ddi_enter_critical returns an integer identifier which must
617 * be passed to ddi_exit_critical.
619 * Be very sparing in the use of these functions since it is
620 * likely that absolutely nothing else can occur in the system
621 * whilst in the critical region.
624 unsigned int
625 ddi_enter_critical(void);
627 void
628 ddi_exit_critical(unsigned int);
631 * devmap functions
634 devmap_setup(dev_t dev, offset_t off, ddi_as_handle_t as, caddr_t *addrp,
635 size_t len, uint_t prot, uint_t maxprot, uint_t flags, struct cred *cred);
638 ddi_devmap_segmap(dev_t dev, off_t off, ddi_as_handle_t as, caddr_t *addrp,
639 off_t len, uint_t prot, uint_t maxprot, uint_t flags, struct cred *cred);
642 devmap_load(devmap_cookie_t dhp, offset_t offset, size_t len, uint_t type,
643 uint_t rw);
646 devmap_unload(devmap_cookie_t dhp, offset_t offset, size_t len);
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);
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);
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);
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);
670 void
671 devmap_set_ctx_timeout(devmap_cookie_t dhp, clock_t ticks);
674 devmap_default_access(devmap_cookie_t dhp, void *pvtp, offset_t off,
675 size_t len, uint_t type, uint_t rw);
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));
683 void *ddi_umem_alloc(size_t size, int flag, ddi_umem_cookie_t *cookiep);
685 void ddi_umem_free(ddi_umem_cookie_t cookie);
688 * Functions to lock user memory and do repeated I/O or do devmap_umem_setup
691 ddi_umem_lock(caddr_t addr, size_t size, int flags, ddi_umem_cookie_t *cookie);
693 void
694 ddi_umem_unlock(ddi_umem_cookie_t cookie);
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);
701 * Mapping functions
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);
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);
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);
717 ddi_device_mapping_check(dev_t dev, ddi_device_acc_attr_t *accattrp,
718 uint_t rnumber, uint_t *hat_flags);
721 * Property functions: See also, ddipropdefs.h.
722 * In general, the underlying driver MUST be held
723 * to call it's property functions.
727 * Used to create, modify, and lookup integer properties
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);
746 * Used to create, modify, and lookup string properties
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);
758 * Used to create, modify, and lookup byte properties
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);
766 * Used to verify the existence of a property or to see if a boolean
767 * property exists.
769 int ddi_prop_exists(dev_t match_dev, dev_info_t *dip, uint_t flags, char *name);
772 * Used to free the data returned by the above property routines.
774 void ddi_prop_free(void *data);
777 * nopropop: For internal use in `dummy' cb_prop_op functions only
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);
785 * ddi_prop_op: The basic property operator for drivers.
787 * In ddi_prop_op, the type of valuep is interpreted based on prop_op:
789 * prop_op valuep
790 * ------ ------
792 * PROP_LEN <unused>
794 * PROP_LEN_AND_VAL_BUF Pointer to callers buffer
796 * PROP_LEN_AND_VAL_ALLOC Address of callers pointer (will be set to
797 * address of allocated buffer, if successful)
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);
804 /* ddi_prop_op_size: for drivers that implement size in bytes */
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);
810 /* ddi_prop_op_size_blksize: like ddi_prop_op_size, in blksize blocks */
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);
816 /* ddi_prop_op_nblocks: for drivers that implement size in DEV_BSIZE blocks */
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);
822 /* ddi_prop_op_nblocks_blksize: like ddi_prop_op_nblocks, in blksize blocks */
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);
829 * Variable length props...
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.
837 * Arguments:
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.
848 * Possible Returns:
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.
857 ddi_getlongprop(dev_t dev, dev_info_t *dip, int flags,
858 char *name, caddr_t valuep, int *lengthp);
862 * ddi_getlongprop_buf: Get long prop into pre-allocated callers
863 * buffer. (no memory allocation by provider).
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.
873 * Possible returns:
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
885 ddi_getlongprop_buf(dev_t dev, dev_info_t *dip, int flags,
886 char *name, caddr_t valuep, int *lengthp);
889 * Integer/boolean sized props.
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...
895 * By convention, this interface returns boolean (0) sized properties
896 * as value (int)1.
900 ddi_getprop(dev_t dev, dev_info_t *dip, int flags, char *name, int defvalue);
903 * Get prop length interface: flags are 0 or DDI_PROP_DONTPASS
904 * if returns DDI_PROP_SUCCESS, length returned in *lengthp.
908 ddi_getproplen(dev_t dev, dev_info_t *dip, int flags, char *name, int *lengthp);
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.
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.
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.
926 * ddi_prop_create: Define a managed property:
930 ddi_prop_create(dev_t dev, dev_info_t *dip, int flag,
931 char *name, caddr_t value, int length);
934 * ddi_prop_modify: Modify a managed property value
938 ddi_prop_modify(dev_t dev, dev_info_t *dip, int flag,
939 char *name, caddr_t value, int length);
942 * ddi_prop_remove: Undefine a managed property:
946 ddi_prop_remove(dev_t dev, dev_info_t *dip, char *name);
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.
954 void
955 ddi_prop_remove_all(dev_info_t *dip);
959 * ddi_prop_undefine: Explicitly undefine a property. Property
960 * searches which match this property return
961 * the error code DDI_PROP_UNDEFINED.
963 * Use ddi_prop_remove to negate effect of
964 * ddi_prop_undefine
968 ddi_prop_undefine(dev_t dev, dev_info_t *dip, int flag, char *name);
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.
977 void
978 ddi_prop_cache_invalidate(dev_t dev, dev_info_t *dip, char *name, int flags);
981 * The default ddi_bus_prop_op wrapper...
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);
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.
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.
1011 * It does the walk a layer at a time, not depth-first.
1013 * The given function must return one of the values defined above.
1017 void
1018 ddi_walk_devs(dev_info_t *, int (*)(dev_info_t *, void *), void *);
1021 * Routines to get at elements of the dev_info structure
1025 * ddi_node_name gets the device's 'name' from the device node.
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.
1031 * ddi_get_name is a synonym for ddi_binding_name().
1033 char *
1034 ddi_get_name(dev_info_t *dip);
1036 char *
1037 ddi_binding_name(dev_info_t *dip);
1039 const char *
1040 ddi_driver_name(dev_info_t *dip);
1042 major_t
1043 ddi_driver_major(dev_info_t *dip);
1045 major_t
1046 ddi_compatible_driver_major(dev_info_t *dip, char **formp);
1048 char *
1049 ddi_node_name(dev_info_t *dip);
1052 ddi_get_nodeid(dev_info_t *dip);
1055 ddi_get_instance(dev_info_t *dip);
1057 struct dev_ops *
1058 ddi_get_driver(dev_info_t *dip);
1060 void
1061 ddi_set_driver(dev_info_t *dip, struct dev_ops *devo);
1063 void
1064 ddi_set_driver_private(dev_info_t *dip, void *data);
1066 void *
1067 ddi_get_driver_private(dev_info_t *dip);
1070 * ddi_dev_is_needed tells system that a device is about to use a
1071 * component. Returns when component is ready.
1074 ddi_dev_is_needed(dev_info_t *dip, int cmpt, int level);
1077 * check if DDI_SUSPEND may result in power being removed from a device.
1080 ddi_removing_power(dev_info_t *dip);
1083 * (Obsolete) power entry point
1086 ddi_power(dev_info_t *dip, int cmpt, int level);
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
1093 dev_info_t *
1094 ddi_get_parent(dev_info_t *dip);
1097 * ddi_get_child and ddi_get_next_sibling require that the devinfo
1098 * tree lock be held
1100 dev_info_t *
1101 ddi_get_child(dev_info_t *dip);
1103 dev_info_t *
1104 ddi_get_next_sibling(dev_info_t *dip);
1106 dev_info_t *
1107 ddi_get_next(dev_info_t *dip);
1109 void
1110 ddi_set_next(dev_info_t *dip, dev_info_t *nextdip);
1113 * dev_info manipulation functions
1117 * Add and remove child devices. These are part of the system framework.
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.
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.
1130 dev_info_t *
1131 ddi_add_child(dev_info_t *pdip, char *name, uint_t nodeid, uint_t instance);
1134 ddi_remove_child(dev_info_t *dip, int flag);
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.
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.
1148 * Use of this interface is discouraged, it may be removed in a future release.
1150 struct dev_ops *
1151 ddi_hold_installed_driver(major_t major);
1153 void
1154 ddi_rele_driver(major_t major);
1157 * Attach and hold the specified instance of a driver. The flags argument
1158 * should be zero.
1160 dev_info_t *
1161 ddi_hold_devi_by_instance(major_t major, int instance, int flags);
1163 void
1164 ddi_release_devi(dev_info_t *);
1167 * Associate a streams queue with a devinfo node
1169 void
1170 ddi_assoc_queue_with_devi(queue_t *, dev_info_t *);
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.
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.
1181 ddi_install_driver(char *idstring);
1184 * Routines that return specific nodes
1187 dev_info_t *
1188 ddi_root_node(void);
1191 * Given a name and an instance number, find and return the
1192 * dev_info from the current state of the device tree.
1194 * If instance number is -1, return the first named instance.
1196 * If attached is 1, exclude all nodes that are < DS_ATTACHED
1198 * Requires that the devinfo tree be locked.
1199 * If attached is 1, the driver must be held.
1201 dev_info_t *
1202 ddi_find_devinfo(char *name, int instance, int attached);
1205 * Synchronization of I/O with respect to various
1206 * caches and system write buffers.
1208 * Done at varying points during an I/O transfer (including at the
1209 * removal of an I/O mapping).
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.
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).
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().
1230 * Returns 0 if all caches that exist and are specified by cache_flags
1231 * are successfully operated on, else -1.
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.
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.
1244 * The argument flags specifies what to synchronize (the device's view of
1245 * the object or the cpu's view of the object).
1247 * Inquiring minds want to know when ddi_dma_sync should be used:
1249 * + When an object is mapped for dma, assume that an
1250 * implicit ddi_dma_sync() is done for you.
1252 * + When an object is unmapped (ddi_dma_free()), assume
1253 * that an implicit ddi_dma_sync() is done for you.
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.
1261 * Clearly, only the third case above requires the use of ddi_dma_sync.
1263 * Inquiring minds also want to know which flag to use:
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).
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).
1277 ddi_dma_sync(ddi_dma_handle_t handle, off_t offset, size_t len, uint_t flags);
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.
1289 ddi_dma_burstsizes(ddi_dma_handle_t handle);
1292 * Merge DMA attributes
1295 void
1296 ddi_dma_attr_merge(ddi_dma_attr_t *attr, ddi_dma_attr_t *mod);
1299 * Allocate a DMA handle
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);
1308 * Free DMA handle
1311 void
1312 ddi_dma_free_handle(ddi_dma_handle_t *handlep);
1315 * Allocate memory for DMA transfers
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);
1325 * Free DMA memory
1328 void
1329 ddi_dma_mem_free(ddi_acc_handle_t *hp);
1332 * bind address to a DMA handle
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);
1342 * bind buffer to DMA handle
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);
1351 * unbind mapping object to handle
1355 ddi_dma_unbind_handle(ddi_dma_handle_t handle);
1358 * get next DMA cookie
1361 void
1362 ddi_dma_nextcookie(ddi_dma_handle_t handle, ddi_dma_cookie_t *cookiep);
1365 * get number of DMA windows
1369 ddi_dma_numwin(ddi_dma_handle_t handle, uint_t *nwinp);
1372 * get specific DMA window
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);
1380 * activate 64 bit SBus support
1384 ddi_dma_set_sbus64(ddi_dma_handle_t handle, ulong_t burstsizes);
1387 * Miscellaneous functions
1391 * ddi_report_dev: Report a successful attach.
1394 void
1395 ddi_report_dev(dev_info_t *dev);
1398 * ddi_dev_regsize
1400 * If the device has h/w register(s), report
1401 * the size, in bytes, of the specified one into *resultp.
1403 * Returns DDI_FAILURE if there are not registers,
1404 * or the specified register doesn't exist.
1408 ddi_dev_regsize(dev_info_t *dev, uint_t rnumber, off_t *resultp);
1411 * ddi_dev_nregs
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.
1419 ddi_dev_nregs(dev_info_t *dev, int *resultp);
1422 * ddi_dev_is_sid
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.
1432 ddi_dev_is_sid(dev_info_t *dev);
1435 * ddi_slaveonly
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.
1443 ddi_slaveonly(dev_info_t *);
1447 * ddi_dev_affinity
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.
1458 ddi_dev_affinity(dev_info_t *deva, dev_info_t *devb);
1462 * ddi_set_callback
1464 * Set a function/arg pair into the callback list identified
1465 * by listid. *listid must always initially start out as zero.
1468 void
1469 ddi_set_callback(int (*funcp)(caddr_t), caddr_t arg, uintptr_t *listid);
1472 * ddi_run_callback
1474 * Run the callback list identified by listid.
1477 void
1478 ddi_run_callback(uintptr_t *listid);
1481 * More miscellaneous
1485 nochpoll(dev_t dev, short events, int anyyet, short *reventsp,
1486 struct pollhead **phpp);
1488 dev_info_t *
1489 nodevinfo(dev_t dev, int otyp);
1492 ddi_no_info(dev_info_t *dip, ddi_info_cmd_t infocmd, void *arg, void **result);
1495 ddi_getinfo_1to1(dev_info_t *dip, ddi_info_cmd_t infocmd,
1496 void *arg, void **result);
1499 ddifail(dev_info_t *devi, ddi_attach_cmd_t cmd);
1502 ddi_no_dma_map(dev_info_t *dip, dev_info_t *rdip,
1503 struct ddi_dma_req *dmareqp, ddi_dma_handle_t *handlep);
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);
1510 ddi_no_dma_freehdl(dev_info_t *dip, dev_info_t *rdip,
1511 ddi_dma_handle_t handle);
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);
1519 ddi_no_dma_unbindhdl(dev_info_t *dip, dev_info_t *rdip,
1520 ddi_dma_handle_t handle);
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);
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);
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);
1537 void
1538 ddivoid();
1540 cred_t *
1541 ddi_get_cred(void);
1543 time_t
1544 ddi_get_time(void);
1546 pid_t
1547 ddi_get_pid(void);
1549 kt_did_t
1550 ddi_get_kt_did(void);
1552 boolean_t
1553 ddi_can_receive_sig(void);
1555 void
1556 swab(void *src, void *dst, size_t nbytes);
1559 ddi_create_minor_node(dev_info_t *dip, char *name, int spec_type,
1560 minor_t minor_num, char *node_type, int flag);
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);
1567 void
1568 ddi_remove_minor_node(dev_info_t *dip, char *name);
1571 ddi_in_panic(void);
1574 ddi_streams_driver(dev_info_t *dip);
1577 * DDI wrappers for ffs and fls
1580 ddi_ffs(long mask);
1583 ddi_fls(long mask);
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'.
1590 typedef struct __ddi_soft_state_bystr ddi_soft_state_bystr;
1593 * Initialize a soft_state set, establishing the 'size' of soft state objects
1594 * in the set.
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.
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).
1606 ddi_soft_state_init(void **state_p, size_t size, size_t n_items);
1608 ddi_soft_state_bystr_init(ddi_soft_state_bystr **state_p,
1609 size_t size, int n_items);
1612 * Allocate a soft state object associated with either 'integer index' or
1613 * 'string index' from a soft_state set.
1616 ddi_soft_state_zalloc(void *state, int item);
1618 ddi_soft_state_bystr_zalloc(ddi_soft_state_bystr *state, const char *str);
1621 * Get the pointer to the allocated soft state object associated with
1622 * either 'integer index' or 'string index'.
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);
1630 * Free the soft state object associated with either 'integer index'
1631 * or 'string index'.
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);
1639 * Free the soft state set and any associated soft state objects.
1641 void
1642 ddi_soft_state_fini(void **state_p);
1643 void
1644 ddi_soft_state_bystr_fini(ddi_soft_state_bystr **state_p);
1647 * The ddi_strid_* routines provide string-to-index management utilities.
1649 typedef struct __ddi_strid ddi_strid;
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);
1664 * Set the addr field of the name in dip to name
1666 void
1667 ddi_set_name_addr(dev_info_t *dip, char *name);
1670 * Get the address part of the name.
1672 char *
1673 ddi_get_name_addr(dev_info_t *dip);
1675 void
1676 ddi_set_parent_data(dev_info_t *dip, void *pd);
1678 void *
1679 ddi_get_parent_data(dev_info_t *dip);
1682 ddi_initchild(dev_info_t *parent, dev_info_t *proto);
1685 ddi_uninitchild(dev_info_t *dip);
1687 major_t
1688 ddi_name_to_major(char *name);
1690 char *
1691 ddi_major_to_name(major_t major);
1693 char *
1694 ddi_deviname(dev_info_t *dip, char *name);
1696 char *
1697 ddi_pathname(dev_info_t *dip, char *path);
1699 char *
1700 ddi_pathname_minor(struct ddi_minor_data *dmdp, char *path);
1702 char *
1703 ddi_pathname_obp(dev_info_t *dip, char *path);
1706 ddi_pathname_obp_set(dev_info_t *dip, char *component);
1709 ddi_dev_pathname(dev_t devt, int spec_type, char *name);
1711 dev_t
1712 ddi_pathname_to_dev_t(char *pathname);
1715 * High resolution system timer functions.
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.
1724 * Nexus wrapper functions
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.
1734 * bus_ctl wrapper
1738 ddi_ctlops(dev_info_t *d, dev_info_t *r, ddi_ctl_enum_t o, void *a, void *v);
1741 * bus_dma_map wrapper
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);
1749 ddi_dma_freehdl(dev_info_t *dip, dev_info_t *rdip,
1750 ddi_dma_handle_t handle);
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);
1758 ddi_dma_unbindhdl(dev_info_t *dip, dev_info_t *rdip,
1759 ddi_dma_handle_t handle);
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);
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);
1772 * bus_dma_ctl wrapper
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);
1781 * dvma support for networking drivers
1784 unsigned long
1785 dvma_pagesize(dev_info_t *dip);
1788 dvma_reserve(dev_info_t *dip, ddi_dma_lim_t *limp, uint_t pages,
1789 ddi_dma_handle_t *handlep);
1791 void
1792 dvma_release(ddi_dma_handle_t h);
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);
1798 void
1799 dvma_unload(ddi_dma_handle_t h, uint_t objindex, uint_t type);
1801 void
1802 dvma_sync(ddi_dma_handle_t h, uint_t objindex, uint_t type);
1805 * Layered driver support
1808 extern int ddi_copyin(const void *, void *, size_t, int);
1809 extern int ddi_copyout(const void *, void *, size_t, int);
1812 * Send signals to processes
1814 extern void *proc_ref(void);
1815 extern void proc_unref(void *pref);
1816 extern int proc_signal(void *pref, int sig);
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);
1827 * Console bell routines
1829 extern void ddi_ring_console_bell(clock_t duration);
1830 extern void ddi_set_console_bell(void (*bellfunc)(clock_t duration));
1833 * Fault-related functions
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 *);
1842 * Miscellaneous redefines
1844 #define uiophysio physio
1847 * utilities - "reg" mapping and all common portable data access functions
1851 * error code from ddi_regs_map_setup
1854 #define DDI_REGS_ACC_CONFLICT (-10)
1857 * Device address advance flags
1860 #define DDI_DEV_NO_AUTOINCR 0x0000
1861 #define DDI_DEV_AUTOINCR 0x0001
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);
1868 void
1869 ddi_regs_map_free(ddi_acc_handle_t *handle);
1872 * these are the prototypes for the common portable data access functions
1875 uint8_t
1876 ddi_get8(ddi_acc_handle_t handle, uint8_t *addr);
1878 uint16_t
1879 ddi_get16(ddi_acc_handle_t handle, uint16_t *addr);
1881 uint32_t
1882 ddi_get32(ddi_acc_handle_t handle, uint32_t *addr);
1884 uint64_t
1885 ddi_get64(ddi_acc_handle_t handle, uint64_t *addr);
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);
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);
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);
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);
1903 void
1904 ddi_put8(ddi_acc_handle_t handle, uint8_t *addr, uint8_t value);
1906 void
1907 ddi_put16(ddi_acc_handle_t handle, uint16_t *addr, uint16_t value);
1909 void
1910 ddi_put32(ddi_acc_handle_t handle, uint32_t *addr, uint32_t value);
1912 void
1913 ddi_put64(ddi_acc_handle_t handle, uint64_t *addr, uint64_t value);
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);
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);
1930 * these are special device handling functions
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);
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);
1943 * these are software byte swapping functions
1945 uint16_t
1946 ddi_swap16(uint16_t value);
1948 uint32_t
1949 ddi_swap32(uint32_t value);
1951 uint64_t
1952 ddi_swap64(uint64_t value);
1955 * these are the prototypes for PCI local bus functions
1958 * PCI power management capabilities reporting in addition to those
1959 * provided by the PCI Power Management Specification.
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 */
1966 pci_config_setup(dev_info_t *dip, ddi_acc_handle_t *handle);
1968 void
1969 pci_config_teardown(ddi_acc_handle_t *handle);
1971 uint8_t
1972 pci_config_get8(ddi_acc_handle_t handle, off_t offset);
1974 uint16_t
1975 pci_config_get16(ddi_acc_handle_t handle, off_t offset);
1977 uint32_t
1978 pci_config_get32(ddi_acc_handle_t handle, off_t offset);
1980 uint64_t
1981 pci_config_get64(ddi_acc_handle_t handle, off_t offset);
1983 void
1984 pci_config_put8(ddi_acc_handle_t handle, off_t offset, uint8_t value);
1986 void
1987 pci_config_put16(ddi_acc_handle_t handle, off_t offset, uint16_t value);
1989 void
1990 pci_config_put32(ddi_acc_handle_t handle, off_t offset, uint32_t value);
1992 void
1993 pci_config_put64(ddi_acc_handle_t handle, off_t offset, uint64_t value);
1996 pci_report_pmcap(dev_info_t *dip, int cap, void *arg);
1999 pci_restore_config_regs(dev_info_t *dip);
2002 pci_save_config_regs(dev_info_t *dip);
2004 void
2005 pci_ereport_setup(dev_info_t *dip);
2007 void
2008 pci_ereport_teardown(dev_info_t *dip);
2010 void
2011 pci_ereport_post(dev_info_t *dip, ddi_fm_error_t *derr, uint16_t *status);
2013 #if defined(__i386) || defined(__amd64)
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 *, void *),
2017 kmutex_t *, kmutex_t *, void (*scan)(dev_info_t *, ddi_fm_error_t *));
2018 #endif
2020 void
2021 pci_target_enqueue(uint64_t, char *, char *, uint64_t);
2023 void
2024 pci_targetq_init(void);
2027 pci_post_suspend(dev_info_t *dip);
2030 pci_pre_resume(dev_info_t *dip);
2033 * the prototype for the C Language Type Model inquiry.
2035 model_t ddi_mmap_get_model(void);
2036 model_t ddi_model_convert_from(model_t);
2039 * these are the prototypes for device id functions.
2042 ddi_devid_valid(ddi_devid_t devid);
2045 ddi_devid_register(dev_info_t *dip, ddi_devid_t devid);
2047 void
2048 ddi_devid_unregister(dev_info_t *dip);
2051 ddi_devid_init(dev_info_t *dip, ushort_t devid_type, ushort_t nbytes,
2052 void *id, ddi_devid_t *ret_devid);
2055 ddi_devid_get(dev_info_t *dip, ddi_devid_t *ret_devid);
2057 size_t
2058 ddi_devid_sizeof(ddi_devid_t devid);
2060 void
2061 ddi_devid_free(ddi_devid_t devid);
2064 ddi_devid_compare(ddi_devid_t id1, ddi_devid_t id2);
2067 ddi_devid_scsi_encode(int version, char *driver_name,
2068 uchar_t *inq, size_t inq_len, uchar_t *inq80, size_t inq80_len,
2069 uchar_t *inq83, size_t inq83_len, ddi_devid_t *ret_devid);
2072 ddi_devid_smp_encode(int version, char *driver_name,
2073 char *wwnstr, uchar_t *srmir_buf, size_t srmir_len,
2074 ddi_devid_t *ret_devid);
2076 char
2077 *ddi_devid_to_guid(ddi_devid_t devid);
2079 void
2080 ddi_devid_free_guid(char *guid);
2083 ddi_lyr_get_devid(dev_t dev, ddi_devid_t *ret_devid);
2086 ddi_lyr_get_minor_name(dev_t dev, int spec_type, char **minor_name);
2089 ddi_lyr_devid_to_devlist(ddi_devid_t devid, char *minor_name, int *retndevs,
2090 dev_t **retdevs);
2092 void
2093 ddi_lyr_free_devlist(dev_t *devlist, int ndevs);
2095 char *
2096 ddi_devid_str_encode(ddi_devid_t devid, char *minor_name);
2099 ddi_devid_str_decode(char *devidstr, ddi_devid_t *devidp, char **minor_namep);
2101 void
2102 ddi_devid_str_free(char *devidstr);
2105 ddi_devid_str_compare(char *id1_str, char *id2_str);
2108 * Event to post to when a devinfo node is removed.
2110 #define DDI_DEVI_REMOVE_EVENT "DDI:DEVI_REMOVE"
2111 #define DDI_DEVI_INSERT_EVENT "DDI:DEVI_INSERT"
2112 #define DDI_DEVI_BUS_RESET_EVENT "DDI:DEVI_BUS_RESET"
2113 #define DDI_DEVI_DEVICE_RESET_EVENT "DDI:DEVI_DEVICE_RESET"
2116 * Invoke bus nexus driver's implementation of the
2117 * (*bus_remove_eventcall)() interface to remove a registered
2118 * callback handler for "event".
2121 ddi_remove_event_handler(ddi_callback_id_t id);
2124 * Invoke bus nexus driver's implementation of the
2125 * (*bus_add_eventcall)() interface to register a callback handler
2126 * for "event".
2129 ddi_add_event_handler(dev_info_t *dip, ddi_eventcookie_t event,
2130 void (*handler)(dev_info_t *, ddi_eventcookie_t, void *, void *),
2131 void *arg, ddi_callback_id_t *id);
2134 * Return a handle for event "name" by calling up the device tree
2135 * hierarchy via (*bus_get_eventcookie)() interface until claimed
2136 * by a bus nexus or top of dev_info tree is reached.
2139 ddi_get_eventcookie(dev_info_t *dip, char *name,
2140 ddi_eventcookie_t *event_cookiep);
2143 * log a system event
2146 ddi_log_sysevent(dev_info_t *dip, char *vendor, char *class_name,
2147 char *subclass_name, nvlist_t *attr_list, sysevent_id_t *eidp,
2148 int sleep_flag);
2151 * ddi_log_sysevent() vendors
2153 #define DDI_VENDOR_SUNW "SUNW"
2156 * Opaque task queue handle.
2158 typedef struct ddi_taskq ddi_taskq_t;
2161 * Use default system priority.
2163 #define TASKQ_DEFAULTPRI -1
2166 * Create a task queue
2168 ddi_taskq_t *ddi_taskq_create(dev_info_t *dip, const char *name,
2169 int nthreads, pri_t pri, uint_t cflags);
2172 * destroy a task queue
2174 void ddi_taskq_destroy(ddi_taskq_t *tq);
2177 * Dispatch a task to a task queue
2179 int ddi_taskq_dispatch(ddi_taskq_t *tq, void (* func)(void *),
2180 void *arg, uint_t dflags);
2183 * Wait for all previously scheduled tasks to complete.
2185 void ddi_taskq_wait(ddi_taskq_t *tq);
2188 * Suspend all task execution.
2190 void ddi_taskq_suspend(ddi_taskq_t *tq);
2193 * Resume task execution.
2195 void ddi_taskq_resume(ddi_taskq_t *tq);
2198 * Is task queue suspended?
2200 boolean_t ddi_taskq_suspended(ddi_taskq_t *tq);
2203 * Parse an interface name of the form <alphanumeric>##<numeric> where
2204 * <numeric> is maximal.
2206 int ddi_parse(const char *, char *, uint_t *);
2209 * DDI interrupt priority level
2211 #define DDI_IPL_0 (0) /* kernel context */
2212 #define DDI_IPL_1 (1) /* interrupt priority level 1 */
2213 #define DDI_IPL_2 (2) /* interrupt priority level 2 */
2214 #define DDI_IPL_3 (3) /* interrupt priority level 3 */
2215 #define DDI_IPL_4 (4) /* interrupt priority level 4 */
2216 #define DDI_IPL_5 (5) /* interrupt priority level 5 */
2217 #define DDI_IPL_6 (6) /* interrupt priority level 6 */
2218 #define DDI_IPL_7 (7) /* interrupt priority level 7 */
2219 #define DDI_IPL_8 (8) /* interrupt priority level 8 */
2220 #define DDI_IPL_9 (9) /* interrupt priority level 9 */
2221 #define DDI_IPL_10 (10) /* interrupt priority level 10 */
2224 * DDI periodic timeout interface
2226 ddi_periodic_t ddi_periodic_add(void (*)(void *), void *, hrtime_t, int);
2227 void ddi_periodic_delete(ddi_periodic_t);
2230 * Default quiesce(9E) implementation for drivers that don't need to do
2231 * anything.
2233 int ddi_quiesce_not_needed(dev_info_t *);
2236 * Default quiesce(9E) initialization function for drivers that should
2237 * implement quiesce but haven't yet.
2239 int ddi_quiesce_not_supported(dev_info_t *);
2242 * DDI generic callback interface
2245 typedef struct __ddi_cb **ddi_cb_handle_t;
2247 int ddi_cb_register(dev_info_t *dip, ddi_cb_flags_t flags,
2248 ddi_cb_func_t cbfunc, void *arg1, void *arg2,
2249 ddi_cb_handle_t *ret_hdlp);
2250 int ddi_cb_unregister(ddi_cb_handle_t hdl);
2252 /* Notify DDI of memory added */
2253 void ddi_mem_update(uint64_t addr, uint64_t size);
2255 /* Path alias interfaces */
2256 typedef struct plat_alias {
2257 char *pali_current;
2258 uint64_t pali_naliases;
2259 char **pali_aliases;
2260 } plat_alias_t;
2262 typedef struct alias_pair {
2263 char *pair_alias;
2264 char *pair_curr;
2265 } alias_pair_t;
2267 extern boolean_t ddi_aliases_present;
2269 typedef struct ddi_alias {
2270 alias_pair_t *dali_alias_pairs;
2271 alias_pair_t *dali_curr_pairs;
2272 int dali_num_pairs;
2273 mod_hash_t *dali_alias_TLB;
2274 mod_hash_t *dali_curr_TLB;
2275 } ddi_alias_t;
2277 extern ddi_alias_t ddi_aliases;
2279 void ddi_register_aliases(plat_alias_t *pali, uint64_t npali);
2280 dev_info_t *ddi_alias_redirect(char *alias);
2281 char *ddi_curr_redirect(char *curr);
2283 #endif /* _KERNEL */
2285 #ifdef __cplusplus
2287 #endif
2289 #endif /* _SYS_SUNDDI_H */