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