17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
53c4226f9Spjha  * Common Development and Distribution License (the "License").
63c4226f9Spjha  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
217c478bd9Sstevel@tonic-gate /*
22e37c6c37Scth  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
237c478bd9Sstevel@tonic-gate  * Use is subject to license terms.
247c478bd9Sstevel@tonic-gate  */
257c478bd9Sstevel@tonic-gate 
267c478bd9Sstevel@tonic-gate #ifndef	_LIBDEVINFO_H
277c478bd9Sstevel@tonic-gate #define	_LIBDEVINFO_H
287c478bd9Sstevel@tonic-gate 
297c478bd9Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
307c478bd9Sstevel@tonic-gate 
31facf4a8dSllai #ifdef	__cplusplus
32facf4a8dSllai extern "C" {
33facf4a8dSllai #endif
34facf4a8dSllai 
357c478bd9Sstevel@tonic-gate #include <errno.h>
36facf4a8dSllai #include <libnvpair.h>
377c478bd9Sstevel@tonic-gate #include <sys/param.h>
387c478bd9Sstevel@tonic-gate #include <sys/sunddi.h>
397c478bd9Sstevel@tonic-gate #include <sys/sunmdi.h>
407c478bd9Sstevel@tonic-gate #include <sys/openpromio.h>
417c478bd9Sstevel@tonic-gate #include <sys/ddi_impldefs.h>
427c478bd9Sstevel@tonic-gate #include <sys/devinfo_impl.h>
437c478bd9Sstevel@tonic-gate #include <limits.h>
447c478bd9Sstevel@tonic-gate 
457c478bd9Sstevel@tonic-gate /*
467c478bd9Sstevel@tonic-gate  * flags for di_walk_node
477c478bd9Sstevel@tonic-gate  */
487c478bd9Sstevel@tonic-gate #define	DI_WALK_CLDFIRST	0
497c478bd9Sstevel@tonic-gate #define	DI_WALK_SIBFIRST	1
507c478bd9Sstevel@tonic-gate #define	DI_WALK_LINKGEN		2
517c478bd9Sstevel@tonic-gate 
527c478bd9Sstevel@tonic-gate #define	DI_WALK_MASK		0xf
537c478bd9Sstevel@tonic-gate 
547c478bd9Sstevel@tonic-gate /*
557c478bd9Sstevel@tonic-gate  * flags for di_walk_link
567c478bd9Sstevel@tonic-gate  */
577c478bd9Sstevel@tonic-gate #define	DI_LINK_SRC		1
587c478bd9Sstevel@tonic-gate #define	DI_LINK_TGT		2
597c478bd9Sstevel@tonic-gate 
607c478bd9Sstevel@tonic-gate /*
617c478bd9Sstevel@tonic-gate  * return code for node_callback
627c478bd9Sstevel@tonic-gate  */
637c478bd9Sstevel@tonic-gate #define	DI_WALK_CONTINUE	0
647c478bd9Sstevel@tonic-gate #define	DI_WALK_PRUNESIB	-1
657c478bd9Sstevel@tonic-gate #define	DI_WALK_PRUNECHILD	-2
667c478bd9Sstevel@tonic-gate #define	DI_WALK_TERMINATE	-3
677c478bd9Sstevel@tonic-gate 
687c478bd9Sstevel@tonic-gate /*
697c478bd9Sstevel@tonic-gate  * flags for di_walk_minor
707c478bd9Sstevel@tonic-gate  */
717c478bd9Sstevel@tonic-gate #define	DI_CHECK_ALIAS		0x10
727c478bd9Sstevel@tonic-gate #define	DI_CHECK_INTERNAL_PATH	0x20
737c478bd9Sstevel@tonic-gate 
747c478bd9Sstevel@tonic-gate #define	DI_CHECK_MASK		0xf0
757c478bd9Sstevel@tonic-gate 
767c478bd9Sstevel@tonic-gate /* nodeid types */
777c478bd9Sstevel@tonic-gate #define	DI_PSEUDO_NODEID	-1
787c478bd9Sstevel@tonic-gate #define	DI_SID_NODEID		-2
797c478bd9Sstevel@tonic-gate #define	DI_PROM_NODEID		-3
807c478bd9Sstevel@tonic-gate 
817c478bd9Sstevel@tonic-gate /* node & device states */
827c478bd9Sstevel@tonic-gate #define	DI_DRIVER_DETACHED	0x8000
837c478bd9Sstevel@tonic-gate #define	DI_DEVICE_OFFLINE	0x1
847c478bd9Sstevel@tonic-gate #define	DI_DEVICE_DOWN		0x2
85*25c6ff4bSstephh #define	DI_DEVICE_DEGRADED	0x4
867c478bd9Sstevel@tonic-gate #define	DI_BUS_QUIESCED		0x100
877c478bd9Sstevel@tonic-gate #define	DI_BUS_DOWN		0x200
887c478bd9Sstevel@tonic-gate 
897c478bd9Sstevel@tonic-gate /* property types */
907c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_BOOLEAN	0
917c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_INT	1
927c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_STRING	2
937c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_BYTE	3
947c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_UNKNOWN	4
957c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_UNDEF_IT	5
967c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_INT64	6
977c478bd9Sstevel@tonic-gate 
987c478bd9Sstevel@tonic-gate /* private macro for checking if a prop type is valid */
997c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_VALID(type) \
1007c478bd9Sstevel@tonic-gate 	((((type) >= DI_PROP_TYPE_INT) && ((type) <= DI_PROP_TYPE_BYTE)) || \
1017c478bd9Sstevel@tonic-gate 	    ((type) == DI_PROP_TYPE_INT64))
1027c478bd9Sstevel@tonic-gate 
1037c478bd9Sstevel@tonic-gate /* opaque handles */
104602ca9eaScth typedef struct di_node		*di_node_t;		/* node */
105602ca9eaScth typedef struct di_minor		*di_minor_t;		/* minor_node */
106602ca9eaScth typedef struct di_path		*di_path_t;		/* path_node */
107602ca9eaScth typedef struct di_link		*di_link_t;		/* link */
108602ca9eaScth typedef struct di_lnode		*di_lnode_t;		/* endpoint */
109602ca9eaScth typedef struct di_devlink	*di_devlink_t;		/* devlink */
110602ca9eaScth 
111602ca9eaScth typedef struct di_prop		*di_prop_t;		/* node property */
112602ca9eaScth typedef struct di_path_prop	*di_path_prop_t;	/* path property */
113602ca9eaScth typedef struct di_prom_prop	*di_prom_prop_t;	/* prom property */
114602ca9eaScth 
115602ca9eaScth typedef struct di_prom_handle	*di_prom_handle_t;	/* prom snapshot */
1167c478bd9Sstevel@tonic-gate typedef struct di_devlink_handle *di_devlink_handle_t;	/* devlink snapshot */
117602ca9eaScth 
1187c478bd9Sstevel@tonic-gate 
1197c478bd9Sstevel@tonic-gate /*
1207c478bd9Sstevel@tonic-gate  * Null handles to make handles really opaque
1217c478bd9Sstevel@tonic-gate  */
122602ca9eaScth #define	DI_NODE_NIL		NULL
123602ca9eaScth #define	DI_MINOR_NIL		NULL
124602ca9eaScth #define	DI_PATH_NIL		NULL
125602ca9eaScth #define	DI_LINK_NIL		NULL
126602ca9eaScth #define	DI_LNODE_NIL		NULL
127602ca9eaScth #define	DI_PROP_NIL		NULL
1287c478bd9Sstevel@tonic-gate #define	DI_PROM_PROP_NIL	NULL
1297c478bd9Sstevel@tonic-gate #define	DI_PROM_HANDLE_NIL	NULL
1307c478bd9Sstevel@tonic-gate 
1313ebafc43Sjveta /*
1323ebafc43Sjveta  * IEEE 1275 properties and other standardized property names
1333ebafc43Sjveta  */
1343ebafc43Sjveta #define	DI_PROP_FIRST_CHAS	"first-in-chassis"
1353ebafc43Sjveta #define	DI_PROP_SLOT_NAMES	"slot-names"
1363ebafc43Sjveta #define	DI_PROP_PHYS_SLOT	"physical-slot#"
1373ebafc43Sjveta #define	DI_PROP_DEV_TYPE	"device_type"
1383ebafc43Sjveta #define	DI_PROP_BUS_RANGE	"bus-range"
1393ebafc43Sjveta #define	DI_PROP_SERID		"serialid#"
1403ebafc43Sjveta #define	DI_PROP_REG		"reg"
1413ebafc43Sjveta #define	DI_PROP_AP_NAMES	"ap-names"
1423ebafc43Sjveta 
1437c478bd9Sstevel@tonic-gate /* Interface Prototypes */
1447c478bd9Sstevel@tonic-gate 
1457c478bd9Sstevel@tonic-gate /*
1467c478bd9Sstevel@tonic-gate  * Snapshot initialization and cleanup
1477c478bd9Sstevel@tonic-gate  */
148602ca9eaScth extern di_node_t	di_init(const char *phys_path, uint_t flag);
149602ca9eaScth extern void		di_fini(di_node_t root);
1507c478bd9Sstevel@tonic-gate 
1517c478bd9Sstevel@tonic-gate /*
152602ca9eaScth  * node: traversal, data access, and parameters
1537c478bd9Sstevel@tonic-gate  */
154602ca9eaScth extern int		di_walk_node(di_node_t root, uint_t flag, void *arg,
155602ca9eaScth 			    int (*node_callback)(di_node_t node, void *arg));
156602ca9eaScth 
157602ca9eaScth extern di_node_t	di_drv_first_node(const char *drv_name, di_node_t root);
158602ca9eaScth extern di_node_t	di_drv_next_node(di_node_t node);
159602ca9eaScth 
160602ca9eaScth extern di_node_t	di_parent_node(di_node_t node);
161602ca9eaScth extern di_node_t	di_sibling_node(di_node_t node);
162602ca9eaScth extern di_node_t	di_child_node(di_node_t node);
163602ca9eaScth 
164602ca9eaScth extern char		*di_node_name(di_node_t node);
165602ca9eaScth extern char		*di_bus_addr(di_node_t node);
166602ca9eaScth extern char		*di_binding_name(di_node_t node);
167602ca9eaScth extern int		di_compatible_names(di_node_t, char **names);
168602ca9eaScth extern int		di_instance(di_node_t node);
169602ca9eaScth extern int		di_nodeid(di_node_t node);
170602ca9eaScth extern int		di_driver_major(di_node_t node);
171602ca9eaScth extern uint_t		di_state(di_node_t node);
172602ca9eaScth extern ddi_node_state_t	di_node_state(di_node_t node);
173602ca9eaScth extern ddi_devid_t	di_devid(di_node_t node);
174602ca9eaScth extern char		*di_driver_name(di_node_t node);
175602ca9eaScth extern uint_t		di_driver_ops(di_node_t node);
176602ca9eaScth 
177602ca9eaScth extern void		di_node_private_set(di_node_t node, void *data);
178602ca9eaScth extern void		*di_node_private_get(di_node_t node);
179602ca9eaScth 
180602ca9eaScth extern char		*di_devfs_path(di_node_t node);
181602ca9eaScth extern char		*di_devfs_minor_path(di_minor_t minor);
182602ca9eaScth extern void		di_devfs_path_free(char *path_buf);
1837c478bd9Sstevel@tonic-gate 
1847c478bd9Sstevel@tonic-gate /*
185602ca9eaScth  * path_node: traversal, data access, and parameters
1867c478bd9Sstevel@tonic-gate  */
187602ca9eaScth extern di_path_t	di_path_phci_next_path(di_node_t node, di_path_t);
188602ca9eaScth extern di_path_t	di_path_client_next_path(di_node_t node, di_path_t);
1897c478bd9Sstevel@tonic-gate 
190602ca9eaScth extern di_node_t	di_path_phci_node(di_path_t path);
191602ca9eaScth extern di_node_t	di_path_client_node(di_path_t path);
1927c478bd9Sstevel@tonic-gate 
193602ca9eaScth extern char		*di_path_node_name(di_path_t path);
194602ca9eaScth extern char		*di_path_bus_addr(di_path_t path);
195602ca9eaScth extern int		di_path_instance(di_path_t path);
196602ca9eaScth extern di_path_state_t	di_path_state(di_path_t path);
1977c478bd9Sstevel@tonic-gate 
198602ca9eaScth extern char		*di_path_devfs_path(di_path_t path);
199602ca9eaScth extern char		*di_path_client_devfs_path(di_path_t path);
2007c478bd9Sstevel@tonic-gate 
201602ca9eaScth extern void		di_path_private_set(di_path_t path, void *data);
202602ca9eaScth extern void		*di_path_private_get(di_path_t path);
2037c478bd9Sstevel@tonic-gate 
2047c478bd9Sstevel@tonic-gate /*
205602ca9eaScth  * minor_node: traversal, data access, and parameters
2067c478bd9Sstevel@tonic-gate  */
207602ca9eaScth extern int		di_walk_minor(di_node_t root, const char *minortype,
208602ca9eaScth 			    uint_t flag, void *arg,
209602ca9eaScth 			    int (*minor_callback)(di_node_t node,
210602ca9eaScth 			    di_minor_t minor, void *arg));
2117c478bd9Sstevel@tonic-gate extern di_minor_t	di_minor_next(di_node_t node, di_minor_t minor);
212602ca9eaScth 
2137c478bd9Sstevel@tonic-gate extern di_node_t	di_minor_devinfo(di_minor_t minor);
2147c478bd9Sstevel@tonic-gate extern ddi_minor_type	di_minor_type(di_minor_t minor);
2157c478bd9Sstevel@tonic-gate extern char		*di_minor_name(di_minor_t minor);
2167c478bd9Sstevel@tonic-gate extern dev_t		di_minor_devt(di_minor_t minor);
2177c478bd9Sstevel@tonic-gate extern int		di_minor_spectype(di_minor_t minor);
2187c478bd9Sstevel@tonic-gate extern char		*di_minor_nodetype(di_minor_t node);
2197c478bd9Sstevel@tonic-gate 
220602ca9eaScth extern void		di_minor_private_set(di_minor_t minor, void *data);
221602ca9eaScth extern void		*di_minor_private_get(di_minor_t minor);
222602ca9eaScth 
2237c478bd9Sstevel@tonic-gate /*
224602ca9eaScth  * node: property access
2257c478bd9Sstevel@tonic-gate  */
226602ca9eaScth extern di_prop_t	di_prop_next(di_node_t node, di_prop_t prop);
227602ca9eaScth 
228602ca9eaScth extern char		*di_prop_name(di_prop_t prop);
229602ca9eaScth extern int		di_prop_type(di_prop_t prop);
230602ca9eaScth extern dev_t		di_prop_devt(di_prop_t prop);
231602ca9eaScth 
232602ca9eaScth extern int		di_prop_ints(di_prop_t prop, int **prop_data);
233602ca9eaScth extern int		di_prop_int64(di_prop_t prop, int64_t **prop_data);
234602ca9eaScth extern int		di_prop_strings(di_prop_t prop, char **prop_data);
235602ca9eaScth extern int		di_prop_bytes(di_prop_t prop, uchar_t **prop_data);
236602ca9eaScth 
237602ca9eaScth extern int		di_prop_lookup_bytes(dev_t dev, di_node_t node,
238602ca9eaScth 			    const char *prop_name, uchar_t **prop_data);
239602ca9eaScth extern int		di_prop_lookup_ints(dev_t dev, di_node_t node,
240602ca9eaScth 			    const char *prop_name, int **prop_data);
241602ca9eaScth extern int		di_prop_lookup_int64(dev_t dev, di_node_t node,
242602ca9eaScth 			    const char *prop_name, int64_t **prop_data);
243602ca9eaScth extern int		di_prop_lookup_strings(dev_t dev, di_node_t node,
244602ca9eaScth 			    const char *prop_name, char **prop_data);
2457c478bd9Sstevel@tonic-gate 
2467c478bd9Sstevel@tonic-gate /*
247602ca9eaScth  * prom_node: property access
2487c478bd9Sstevel@tonic-gate  */
249602ca9eaScth extern di_prom_handle_t	di_prom_init(void);
250602ca9eaScth extern void		di_prom_fini(di_prom_handle_t ph);
251602ca9eaScth 
252602ca9eaScth extern di_prom_prop_t	di_prom_prop_next(di_prom_handle_t ph, di_node_t node,
253602ca9eaScth 			    di_prom_prop_t prom_prop);
254602ca9eaScth 
255602ca9eaScth extern char		*di_prom_prop_name(di_prom_prop_t prom_prop);
256602ca9eaScth extern int		di_prom_prop_data(di_prom_prop_t prop,
257602ca9eaScth 			    uchar_t **prom_prop_data);
258602ca9eaScth 
259602ca9eaScth extern int		di_prom_prop_lookup_ints(di_prom_handle_t prom,
260602ca9eaScth 			    di_node_t node, const char *prom_prop_name,
261602ca9eaScth 			    int **prom_prop_data);
262602ca9eaScth extern int		di_prom_prop_lookup_strings(di_prom_handle_t prom,
263602ca9eaScth 			    di_node_t node, const char *prom_prop_name,
264602ca9eaScth 			    char **prom_prop_data);
265602ca9eaScth extern int		di_prom_prop_lookup_bytes(di_prom_handle_t prom,
266602ca9eaScth 			    di_node_t node, const char *prom_prop_name,
267602ca9eaScth 			    uchar_t **prom_prop_data);
2687c478bd9Sstevel@tonic-gate 
269602ca9eaScth /*
270602ca9eaScth  * path_node: property access
271602ca9eaScth  */
272602ca9eaScth extern di_path_prop_t	di_path_prop_next(di_path_t path, di_path_prop_t prop);
273602ca9eaScth 
274602ca9eaScth extern char		*di_path_prop_name(di_path_prop_t prop);
275602ca9eaScth extern int		di_path_prop_type(di_path_prop_t prop);
276602ca9eaScth extern int		di_path_prop_len(di_path_prop_t prop);
277602ca9eaScth 
278602ca9eaScth extern int		di_path_prop_bytes(di_path_prop_t prop,
279602ca9eaScth 			    uchar_t **prop_data);
280602ca9eaScth extern int		di_path_prop_ints(di_path_prop_t prop,
281602ca9eaScth 			    int **prop_data);
282602ca9eaScth extern int		di_path_prop_int64s(di_path_prop_t prop,
283602ca9eaScth 			    int64_t **prop_data);
284602ca9eaScth extern int		di_path_prop_strings(di_path_prop_t prop,
285602ca9eaScth 			    char **prop_data);
286602ca9eaScth 
287602ca9eaScth extern int		di_path_prop_lookup_bytes(di_path_t path,
288602ca9eaScth 			    const char *prop_name, uchar_t **prop_data);
289602ca9eaScth extern int		di_path_prop_lookup_ints(di_path_t path,
290602ca9eaScth 			    const char *prop_name, int **prop_data);
291602ca9eaScth extern int		di_path_prop_lookup_int64s(di_path_t path,
292602ca9eaScth 			    const char *prop_name, int64_t **prop_data);
293602ca9eaScth extern int		di_path_prop_lookup_strings(di_path_t path,
294602ca9eaScth 			    const char *prop_name, char **prop_data);
2957c478bd9Sstevel@tonic-gate 
296602ca9eaScth /*
297602ca9eaScth  * layering link/lnode: traversal, data access, and parameters
298602ca9eaScth  */
299602ca9eaScth extern int		di_walk_link(di_node_t root, uint_t flag,
300602ca9eaScth 			    uint_t endpoint, void *arg,
301602ca9eaScth 			    int (*link_callback)(di_link_t link, void *arg));
302602ca9eaScth extern int		di_walk_lnode(di_node_t root, uint_t flag, void *arg,
303602ca9eaScth 			    int (*lnode_callback)(di_lnode_t lnode, void *arg));
304602ca9eaScth 
305602ca9eaScth extern di_link_t	di_link_next_by_node(di_node_t node,
306602ca9eaScth 			    di_link_t link, uint_t endpoint);
307602ca9eaScth extern di_link_t	di_link_next_by_lnode(di_lnode_t lnode,
308602ca9eaScth 			    di_link_t link, uint_t endpoint);
309602ca9eaScth extern di_lnode_t	di_lnode_next(di_node_t node, di_lnode_t lnode);
310602ca9eaScth extern char		*di_lnode_name(di_lnode_t lnode);
311602ca9eaScth 
312602ca9eaScth extern int		di_link_spectype(di_link_t link);
313602ca9eaScth extern di_lnode_t	di_link_to_lnode(di_link_t link, uint_t endpoint);
314602ca9eaScth 
315602ca9eaScth extern di_node_t	di_lnode_devinfo(di_lnode_t lnode);
316602ca9eaScth extern int		di_lnode_devt(di_lnode_t lnode, dev_t *devt);
317602ca9eaScth 
318602ca9eaScth extern void		di_link_private_set(di_link_t link, void *data);
319602ca9eaScth extern void		*di_link_private_get(di_link_t link);
320602ca9eaScth extern void		di_lnode_private_set(di_lnode_t lnode, void *data);
321602ca9eaScth extern void		*di_lnode_private_get(di_lnode_t lnode);
3227c478bd9Sstevel@tonic-gate 
3237c478bd9Sstevel@tonic-gate 
3247c478bd9Sstevel@tonic-gate /*
3257c478bd9Sstevel@tonic-gate  * Private interfaces
3267c478bd9Sstevel@tonic-gate  *
3277c478bd9Sstevel@tonic-gate  * The interfaces and structures below are private to this implementation
3287c478bd9Sstevel@tonic-gate  * of Solaris and are subject to change at any time without notice.
3297c478bd9Sstevel@tonic-gate  *
330602ca9eaScth  * Applications and drivers using these interfaces may fail
3317c478bd9Sstevel@tonic-gate  * to run on future releases.
3327c478bd9Sstevel@tonic-gate  */
3333ebafc43Sjveta extern di_prop_t di_prop_find(dev_t match_dev, di_node_t node,
3343ebafc43Sjveta     const char *name);
335602ca9eaScth extern int di_devfs_path_match(const char *dp1, const char *dp2);
336602ca9eaScth 
337602ca9eaScth extern di_node_t	di_vhci_first_node(di_node_t root);
338602ca9eaScth extern di_node_t	di_vhci_next_node(di_node_t node);
339602ca9eaScth extern di_node_t	di_phci_first_node(di_node_t vhci_node);
340602ca9eaScth extern di_node_t	di_phci_next_node(di_node_t node);
3413ebafc43Sjveta 
3423ebafc43Sjveta /*
3433ebafc43Sjveta  * Interfaces for handling IEEE 1275 and other standardized properties
3443ebafc43Sjveta  */
3453ebafc43Sjveta 
3463ebafc43Sjveta /* structure for a single slot */
3473ebafc43Sjveta typedef struct di_slot_name {
3483ebafc43Sjveta 	int num;	/* corresponding pci device number */
3493ebafc43Sjveta 	char *name;
3503ebafc43Sjveta } di_slot_name_t;
3513ebafc43Sjveta 
3523ebafc43Sjveta extern void di_slot_names_free(int count, di_slot_name_t *slot_names);
3533ebafc43Sjveta extern int di_slot_names_decode(uchar_t *rawdata, int rawlen,
3543ebafc43Sjveta     di_slot_name_t **prop_data);
3553ebafc43Sjveta extern int di_prop_slot_names(di_prop_t prop, di_slot_name_t **prop_data);
3563ebafc43Sjveta extern int di_prom_prop_slot_names(di_prom_prop_t prom_prop,
3573ebafc43Sjveta     di_slot_name_t **prop_data);
3583ebafc43Sjveta extern int di_prop_lookup_slot_names(dev_t dev, di_node_t node,
3593ebafc43Sjveta     di_slot_name_t **prop_data);
3603ebafc43Sjveta extern int di_prom_prop_lookup_slot_names(di_prom_handle_t ph, di_node_t node,
3613ebafc43Sjveta     di_slot_name_t **prop_data);
3623ebafc43Sjveta 
3637c478bd9Sstevel@tonic-gate /*
364602ca9eaScth  * XXX Remove the private di_path_(addr,next,next_phci,next_client) interfaces
365602ca9eaScth  * below after NWS consolidation switches to using di_path_bus_addr,
366602ca9eaScth  * di_path_phci_next_path, and di_path_client_next_path per CR6638521.
3677c478bd9Sstevel@tonic-gate  */
368602ca9eaScth extern char *di_path_addr(di_path_t path, char *buf);
3697c478bd9Sstevel@tonic-gate extern di_path_t di_path_next(di_node_t node, di_path_t path);
3707c478bd9Sstevel@tonic-gate extern di_path_t di_path_next_phci(di_node_t node, di_path_t path);
3717c478bd9Sstevel@tonic-gate extern di_path_t di_path_next_client(di_node_t node, di_path_t path);
3727c478bd9Sstevel@tonic-gate 
3737c478bd9Sstevel@tonic-gate /*
3747c478bd9Sstevel@tonic-gate  * Interfaces for private data
3757c478bd9Sstevel@tonic-gate  */
3767c478bd9Sstevel@tonic-gate extern di_node_t di_init_driver(const char *drv_name, uint_t flag);
3777c478bd9Sstevel@tonic-gate extern di_node_t di_init_impl(const char *phys_path, uint_t flag,
3787c478bd9Sstevel@tonic-gate     struct di_priv_data *priv_data);
3797c478bd9Sstevel@tonic-gate 
3807c478bd9Sstevel@tonic-gate /*
3817c478bd9Sstevel@tonic-gate  * Prtconf needs to know property lists, raw prop_data, and private data
3827c478bd9Sstevel@tonic-gate  */
3837c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_drv_next(di_node_t node, di_prop_t prop);
3847c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_sys_next(di_node_t node, di_prop_t prop);
3857c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_global_next(di_node_t node, di_prop_t prop);
3867c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_hw_next(di_node_t node, di_prop_t prop);
3877c478bd9Sstevel@tonic-gate 
3887c478bd9Sstevel@tonic-gate extern int di_prop_rawdata(di_prop_t prop, uchar_t **prop_data);
3897c478bd9Sstevel@tonic-gate extern void *di_parent_private_data(di_node_t node);
3907c478bd9Sstevel@tonic-gate extern void *di_driver_private_data(di_node_t node);
3917c478bd9Sstevel@tonic-gate 
39225e8c5aaSvikram /*
39325e8c5aaSvikram  * The value of the dip's devi_flags field
39425e8c5aaSvikram  */
39525e8c5aaSvikram uint_t di_flags(di_node_t node);
39625e8c5aaSvikram 
3977c478bd9Sstevel@tonic-gate /*
3987c478bd9Sstevel@tonic-gate  * Types of links for devlink lookup
3997c478bd9Sstevel@tonic-gate  */
4007c478bd9Sstevel@tonic-gate #define	DI_PRIMARY_LINK		0x01
4017c478bd9Sstevel@tonic-gate #define	DI_SECONDARY_LINK	0x02
4027c478bd9Sstevel@tonic-gate #define	DI_LINK_TYPES		0x03
4037c478bd9Sstevel@tonic-gate 
4047c478bd9Sstevel@tonic-gate /*
4057c478bd9Sstevel@tonic-gate  * Flag for di_devlink_init()
4067c478bd9Sstevel@tonic-gate  */
4077c478bd9Sstevel@tonic-gate #define	DI_MAKE_LINK	0x01
4087c478bd9Sstevel@tonic-gate 
4097c478bd9Sstevel@tonic-gate /*
4107c478bd9Sstevel@tonic-gate  * Flag for di_devlink_close()
4117c478bd9Sstevel@tonic-gate  */
4127c478bd9Sstevel@tonic-gate #define	DI_LINK_ERROR	0x01
4137c478bd9Sstevel@tonic-gate 
4147c478bd9Sstevel@tonic-gate /*
4157c478bd9Sstevel@tonic-gate  * For devfsadm synchronous link creation interfaces
4167c478bd9Sstevel@tonic-gate  */
4177c478bd9Sstevel@tonic-gate #define	DEVFSADM_SYNCH_DOOR	".devfsadm_synch_door"
4187c478bd9Sstevel@tonic-gate 
4197c478bd9Sstevel@tonic-gate /*
4207c478bd9Sstevel@tonic-gate  * devlink create argument
4217c478bd9Sstevel@tonic-gate  */
4227c478bd9Sstevel@tonic-gate struct dca_off {
4237c478bd9Sstevel@tonic-gate 	uint32_t	dca_root;
4247c478bd9Sstevel@tonic-gate 	uint32_t	dca_minor;
4257c478bd9Sstevel@tonic-gate 	uint32_t	dca_driver;
4267c478bd9Sstevel@tonic-gate 	int		dca_error;
4277c478bd9Sstevel@tonic-gate 	int		dca_flags;
4287c478bd9Sstevel@tonic-gate 	char		dca_name[PATH_MAX+MAXNAMELEN];
4297c478bd9Sstevel@tonic-gate };
4307c478bd9Sstevel@tonic-gate 
4317c478bd9Sstevel@tonic-gate extern di_devlink_handle_t di_devlink_init(const char *name, uint_t flags);
4327c478bd9Sstevel@tonic-gate extern int di_devlink_walk(di_devlink_handle_t hdl, const char *re,
4337c478bd9Sstevel@tonic-gate     const char *minor_path, uint_t flags, void *arg,
4347c478bd9Sstevel@tonic-gate     int (*devlink_callback)(di_devlink_t, void *));
4357c478bd9Sstevel@tonic-gate extern const char *di_devlink_path(di_devlink_t devlink);
4367c478bd9Sstevel@tonic-gate extern const char *di_devlink_content(di_devlink_t devlink);
4377c478bd9Sstevel@tonic-gate extern int di_devlink_type(di_devlink_t devlink);
4387c478bd9Sstevel@tonic-gate extern di_devlink_t di_devlink_dup(di_devlink_t devlink);
4397c478bd9Sstevel@tonic-gate extern int di_devlink_free(di_devlink_t devlink);
4407c478bd9Sstevel@tonic-gate extern int di_devlink_fini(di_devlink_handle_t *hdlp);
4417c478bd9Sstevel@tonic-gate 
4427c478bd9Sstevel@tonic-gate extern di_devlink_handle_t di_devlink_open(const char *root_dir, uint_t flags);
4437c478bd9Sstevel@tonic-gate extern int di_devlink_close(di_devlink_handle_t *pp, int flag);
4447c478bd9Sstevel@tonic-gate extern int di_devlink_rm_link(di_devlink_handle_t hdp, const char *link);
4457c478bd9Sstevel@tonic-gate extern int di_devlink_add_link(di_devlink_handle_t hdp, const char *link,
4467c478bd9Sstevel@tonic-gate     const char *content, int flags);
4477c478bd9Sstevel@tonic-gate extern int di_devlink_update(di_devlink_handle_t hdp);
4487c478bd9Sstevel@tonic-gate extern di_devlink_handle_t di_devlink_init_root(const char *root,
4497c478bd9Sstevel@tonic-gate     const char *name, uint_t flags);
4507c478bd9Sstevel@tonic-gate extern int di_devlink_cache_walk(di_devlink_handle_t hdp, const char *re,
4517c478bd9Sstevel@tonic-gate     const char *path, uint_t flags, void *arg,
4527c478bd9Sstevel@tonic-gate     int (*devlink_callback)(di_devlink_t, void *));
4537c478bd9Sstevel@tonic-gate 
45425e8c5aaSvikram /*
45525e8c5aaSvikram  * Private interfaces for I/O retire
45625e8c5aaSvikram  */
45725e8c5aaSvikram typedef struct di_retire {
45825e8c5aaSvikram 	void	*rt_hdl;
45925e8c5aaSvikram 	void	(*rt_abort)(void *hdl, const char *format, ...);
46025e8c5aaSvikram 	void	(*rt_debug)(void *hdl, const char *format, ...);
46125e8c5aaSvikram } di_retire_t;
46225e8c5aaSvikram 
46325e8c5aaSvikram extern int di_retire_device(char *path, di_retire_t *dp, int flags);
46425e8c5aaSvikram extern int di_unretire_device(char *path, di_retire_t *dp);
46525e8c5aaSvikram extern uint_t di_retired(di_node_t node);
46625e8c5aaSvikram 
4677c478bd9Sstevel@tonic-gate /*
4687c478bd9Sstevel@tonic-gate  * Private interfaces for /etc/logindevperm
4697c478bd9Sstevel@tonic-gate  */
4707c478bd9Sstevel@tonic-gate extern int di_devperm_login(const char *, uid_t, gid_t, void (*)(char *));
4717c478bd9Sstevel@tonic-gate extern int di_devperm_logout(const char *);
4727c478bd9Sstevel@tonic-gate 
4737c478bd9Sstevel@tonic-gate /*
474602ca9eaScth  * Private interface for looking up, by path string, a node/path/minor
475602ca9eaScth  * in a snapshot.
4767c478bd9Sstevel@tonic-gate  */
477602ca9eaScth extern di_path_t di_lookup_path(di_node_t root, char *path);
4787c478bd9Sstevel@tonic-gate extern di_node_t di_lookup_node(di_node_t root, char *path);
4797c478bd9Sstevel@tonic-gate 
4803c4226f9Spjha /*
4813c4226f9Spjha  * Private hotplug interfaces to be used between cfgadm pci plugin and
4823c4226f9Spjha  * devfsadm link generator.
4833c4226f9Spjha  */
4843c4226f9Spjha extern char *di_dli_name(char *);
4853c4226f9Spjha extern int di_dli_openr(char *);
4863c4226f9Spjha extern int di_dli_openw(char *);
4873c4226f9Spjha extern void di_dli_close(int);
4883c4226f9Spjha 
489facf4a8dSllai /*
490facf4a8dSllai  * Private interface for parsing devname binding info
491facf4a8dSllai  */
492facf4a8dSllai extern void di_devname_print_mapinfo(nvlist_t *);
493facf4a8dSllai extern int di_devname_get_mapinfo(char *, nvlist_t **);
494facf4a8dSllai extern int di_devname_get_mapent(char *, char *, nvlist_t **);
495facf4a8dSllai extern int di_devname_action_on_key(nvlist_t *, uint8_t, char *, void *);
496facf4a8dSllai 
4971aef0e11Sjg /*
4981aef0e11Sjg  * Private interface for parsing path_to_inst binding file
4991aef0e11Sjg  */
5001aef0e11Sjg extern int devfs_parse_binding_file(const char *,
5011aef0e11Sjg 	int (*)(void *, const char *, int, const char *), void *);
5021aef0e11Sjg extern int devfs_walk_minor_nodes(const char *,
5031aef0e11Sjg 	int (*)(void *, const char *), void *);
5041aef0e11Sjg 
505facf4a8dSllai /*
506facf4a8dSllai  * finddev - alternate readdir to discover only /dev persisted device names
507facf4a8dSllai  */
508facf4a8dSllai typedef struct __finddevhdl *finddevhdl_t;
509facf4a8dSllai 
510facf4a8dSllai extern int		device_exists(const char *);
511facf4a8dSllai extern int		finddev_readdir(const char *, finddevhdl_t *);
512e37c6c37Scth extern int		finddev_emptydir(const char *);
513facf4a8dSllai extern void		finddev_close(finddevhdl_t);
514facf4a8dSllai extern const char	*finddev_next(finddevhdl_t);
515facf4a8dSllai 
516facf4a8dSllai 
517facf4a8dSllai /*
518facf4a8dSllai  * Private interfaces for non-global /dev profile
519facf4a8dSllai  */
520facf4a8dSllai typedef struct __di_prof	*di_prof_t;
521facf4a8dSllai 
522facf4a8dSllai extern int	di_prof_init(const char *mountpt, di_prof_t *);
523facf4a8dSllai extern void	di_prof_fini(di_prof_t);
524facf4a8dSllai extern int	di_prof_commit(di_prof_t);
525facf4a8dSllai extern int	di_prof_add_dev(di_prof_t, const char *);
526facf4a8dSllai extern int	di_prof_add_exclude(di_prof_t, const char *);
527facf4a8dSllai extern int	di_prof_add_symlink(di_prof_t, const char *, const char *);
528facf4a8dSllai extern int	di_prof_add_map(di_prof_t, const char *, const char *);
529facf4a8dSllai 
530a08731ecScth /*
531a08731ecScth  * Private interfaces for <driver><instance><minor> to path conversion.
532a08731ecScth  * NOTE: These interfaces do not require or cause attach.  The implementation
533a08731ecScth  * uses the kernel instance-tree (/etc/path_to_inst) and the di_devlinks
534a08731ecScth  * database information.
535a08731ecScth  */
536a08731ecScth typedef struct __di_dim	*di_dim_t;
537a08731ecScth 
538a08731ecScth extern di_dim_t	di_dim_init();
539a08731ecScth extern void	di_dim_fini(di_dim_t);
540a08731ecScth extern char	*di_dim_path_devices(di_dim_t,
541a08731ecScth 		    char *drv_name, int instance, char *minor_name);
542a08731ecScth extern char	*di_dim_path_dev(di_dim_t,
543a08731ecScth 		    char *drv_name, int instance, char *minor_name);
544a08731ecScth 
545a08731ecScth 
5467c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
5477c478bd9Sstevel@tonic-gate }
5487c478bd9Sstevel@tonic-gate #endif
5497c478bd9Sstevel@tonic-gate 
5507c478bd9Sstevel@tonic-gate #endif	/* _LIBDEVINFO_H */
551