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
857c478bd9Sstevel@tonic-gate #define	DI_BUS_QUIESCED		0x100
867c478bd9Sstevel@tonic-gate #define	DI_BUS_DOWN		0x200
877c478bd9Sstevel@tonic-gate 
887c478bd9Sstevel@tonic-gate /* property types */
897c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_BOOLEAN	0
907c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_INT	1
917c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_STRING	2
927c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_BYTE	3
937c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_UNKNOWN	4
947c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_UNDEF_IT	5
957c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_INT64	6
967c478bd9Sstevel@tonic-gate 
977c478bd9Sstevel@tonic-gate /* private macro for checking if a prop type is valid */
987c478bd9Sstevel@tonic-gate #define	DI_PROP_TYPE_VALID(type) \
997c478bd9Sstevel@tonic-gate 	((((type) >= DI_PROP_TYPE_INT) && ((type) <= DI_PROP_TYPE_BYTE)) || \
1007c478bd9Sstevel@tonic-gate 	    ((type) == DI_PROP_TYPE_INT64))
1017c478bd9Sstevel@tonic-gate 
1027c478bd9Sstevel@tonic-gate /* opaque handles */
103*602ca9eaScth typedef struct di_node		*di_node_t;		/* node */
104*602ca9eaScth typedef struct di_minor		*di_minor_t;		/* minor_node */
105*602ca9eaScth typedef struct di_path		*di_path_t;		/* path_node */
106*602ca9eaScth typedef struct di_link		*di_link_t;		/* link */
107*602ca9eaScth typedef struct di_lnode		*di_lnode_t;		/* endpoint */
108*602ca9eaScth typedef struct di_devlink	*di_devlink_t;		/* devlink */
109*602ca9eaScth 
110*602ca9eaScth typedef struct di_prop		*di_prop_t;		/* node property */
111*602ca9eaScth typedef struct di_path_prop	*di_path_prop_t;	/* path property */
112*602ca9eaScth typedef struct di_prom_prop	*di_prom_prop_t;	/* prom property */
113*602ca9eaScth 
114*602ca9eaScth typedef struct di_prom_handle	*di_prom_handle_t;	/* prom snapshot */
1157c478bd9Sstevel@tonic-gate typedef struct di_devlink_handle *di_devlink_handle_t;	/* devlink snapshot */
116*602ca9eaScth 
1177c478bd9Sstevel@tonic-gate 
1187c478bd9Sstevel@tonic-gate /*
1197c478bd9Sstevel@tonic-gate  * Null handles to make handles really opaque
1207c478bd9Sstevel@tonic-gate  */
121*602ca9eaScth #define	DI_NODE_NIL		NULL
122*602ca9eaScth #define	DI_MINOR_NIL		NULL
123*602ca9eaScth #define	DI_PATH_NIL		NULL
124*602ca9eaScth #define	DI_LINK_NIL		NULL
125*602ca9eaScth #define	DI_LNODE_NIL		NULL
126*602ca9eaScth #define	DI_PROP_NIL		NULL
1277c478bd9Sstevel@tonic-gate #define	DI_PROM_PROP_NIL	NULL
1287c478bd9Sstevel@tonic-gate #define	DI_PROM_HANDLE_NIL	NULL
1297c478bd9Sstevel@tonic-gate 
1303ebafc43Sjveta /*
1313ebafc43Sjveta  * IEEE 1275 properties and other standardized property names
1323ebafc43Sjveta  */
1333ebafc43Sjveta #define	DI_PROP_FIRST_CHAS	"first-in-chassis"
1343ebafc43Sjveta #define	DI_PROP_SLOT_NAMES	"slot-names"
1353ebafc43Sjveta #define	DI_PROP_PHYS_SLOT	"physical-slot#"
1363ebafc43Sjveta #define	DI_PROP_DEV_TYPE	"device_type"
1373ebafc43Sjveta #define	DI_PROP_BUS_RANGE	"bus-range"
1383ebafc43Sjveta #define	DI_PROP_SERID		"serialid#"
1393ebafc43Sjveta #define	DI_PROP_REG		"reg"
1403ebafc43Sjveta #define	DI_PROP_AP_NAMES	"ap-names"
1413ebafc43Sjveta 
1427c478bd9Sstevel@tonic-gate /* Interface Prototypes */
1437c478bd9Sstevel@tonic-gate 
1447c478bd9Sstevel@tonic-gate /*
1457c478bd9Sstevel@tonic-gate  * Snapshot initialization and cleanup
1467c478bd9Sstevel@tonic-gate  */
147*602ca9eaScth extern di_node_t	di_init(const char *phys_path, uint_t flag);
148*602ca9eaScth extern void		di_fini(di_node_t root);
1497c478bd9Sstevel@tonic-gate 
1507c478bd9Sstevel@tonic-gate /*
151*602ca9eaScth  * node: traversal, data access, and parameters
1527c478bd9Sstevel@tonic-gate  */
153*602ca9eaScth extern int		di_walk_node(di_node_t root, uint_t flag, void *arg,
154*602ca9eaScth 			    int (*node_callback)(di_node_t node, void *arg));
155*602ca9eaScth 
156*602ca9eaScth extern di_node_t	di_drv_first_node(const char *drv_name, di_node_t root);
157*602ca9eaScth extern di_node_t	di_drv_next_node(di_node_t node);
158*602ca9eaScth 
159*602ca9eaScth extern di_node_t	di_parent_node(di_node_t node);
160*602ca9eaScth extern di_node_t	di_sibling_node(di_node_t node);
161*602ca9eaScth extern di_node_t	di_child_node(di_node_t node);
162*602ca9eaScth 
163*602ca9eaScth extern char		*di_node_name(di_node_t node);
164*602ca9eaScth extern char		*di_bus_addr(di_node_t node);
165*602ca9eaScth extern char		*di_binding_name(di_node_t node);
166*602ca9eaScth extern int		di_compatible_names(di_node_t, char **names);
167*602ca9eaScth extern int		di_instance(di_node_t node);
168*602ca9eaScth extern int		di_nodeid(di_node_t node);
169*602ca9eaScth extern int		di_driver_major(di_node_t node);
170*602ca9eaScth extern uint_t		di_state(di_node_t node);
171*602ca9eaScth extern ddi_node_state_t	di_node_state(di_node_t node);
172*602ca9eaScth extern ddi_devid_t	di_devid(di_node_t node);
173*602ca9eaScth extern char		*di_driver_name(di_node_t node);
174*602ca9eaScth extern uint_t		di_driver_ops(di_node_t node);
175*602ca9eaScth 
176*602ca9eaScth extern void		di_node_private_set(di_node_t node, void *data);
177*602ca9eaScth extern void		*di_node_private_get(di_node_t node);
178*602ca9eaScth 
179*602ca9eaScth extern char		*di_devfs_path(di_node_t node);
180*602ca9eaScth extern char		*di_devfs_minor_path(di_minor_t minor);
181*602ca9eaScth extern void		di_devfs_path_free(char *path_buf);
1827c478bd9Sstevel@tonic-gate 
1837c478bd9Sstevel@tonic-gate /*
184*602ca9eaScth  * path_node: traversal, data access, and parameters
1857c478bd9Sstevel@tonic-gate  */
186*602ca9eaScth extern di_path_t	di_path_phci_next_path(di_node_t node, di_path_t);
187*602ca9eaScth extern di_path_t	di_path_client_next_path(di_node_t node, di_path_t);
1887c478bd9Sstevel@tonic-gate 
189*602ca9eaScth extern di_node_t	di_path_phci_node(di_path_t path);
190*602ca9eaScth extern di_node_t	di_path_client_node(di_path_t path);
1917c478bd9Sstevel@tonic-gate 
192*602ca9eaScth extern char		*di_path_node_name(di_path_t path);
193*602ca9eaScth extern char		*di_path_bus_addr(di_path_t path);
194*602ca9eaScth extern int		di_path_instance(di_path_t path);
195*602ca9eaScth extern di_path_state_t	di_path_state(di_path_t path);
1967c478bd9Sstevel@tonic-gate 
197*602ca9eaScth extern char		*di_path_devfs_path(di_path_t path);
198*602ca9eaScth extern char		*di_path_client_devfs_path(di_path_t path);
1997c478bd9Sstevel@tonic-gate 
200*602ca9eaScth extern void		di_path_private_set(di_path_t path, void *data);
201*602ca9eaScth extern void		*di_path_private_get(di_path_t path);
2027c478bd9Sstevel@tonic-gate 
2037c478bd9Sstevel@tonic-gate /*
204*602ca9eaScth  * minor_node: traversal, data access, and parameters
2057c478bd9Sstevel@tonic-gate  */
206*602ca9eaScth extern int		di_walk_minor(di_node_t root, const char *minortype,
207*602ca9eaScth 			    uint_t flag, void *arg,
208*602ca9eaScth 			    int (*minor_callback)(di_node_t node,
209*602ca9eaScth 			    di_minor_t minor, void *arg));
2107c478bd9Sstevel@tonic-gate extern di_minor_t	di_minor_next(di_node_t node, di_minor_t minor);
211*602ca9eaScth 
2127c478bd9Sstevel@tonic-gate extern di_node_t	di_minor_devinfo(di_minor_t minor);
2137c478bd9Sstevel@tonic-gate extern ddi_minor_type	di_minor_type(di_minor_t minor);
2147c478bd9Sstevel@tonic-gate extern char		*di_minor_name(di_minor_t minor);
2157c478bd9Sstevel@tonic-gate extern dev_t		di_minor_devt(di_minor_t minor);
2167c478bd9Sstevel@tonic-gate extern int		di_minor_spectype(di_minor_t minor);
2177c478bd9Sstevel@tonic-gate extern char		*di_minor_nodetype(di_minor_t node);
2187c478bd9Sstevel@tonic-gate 
219*602ca9eaScth extern void		di_minor_private_set(di_minor_t minor, void *data);
220*602ca9eaScth extern void		*di_minor_private_get(di_minor_t minor);
221*602ca9eaScth 
2227c478bd9Sstevel@tonic-gate /*
223*602ca9eaScth  * node: property access
2247c478bd9Sstevel@tonic-gate  */
225*602ca9eaScth extern di_prop_t	di_prop_next(di_node_t node, di_prop_t prop);
226*602ca9eaScth 
227*602ca9eaScth extern char		*di_prop_name(di_prop_t prop);
228*602ca9eaScth extern int		di_prop_type(di_prop_t prop);
229*602ca9eaScth extern dev_t		di_prop_devt(di_prop_t prop);
230*602ca9eaScth 
231*602ca9eaScth extern int		di_prop_ints(di_prop_t prop, int **prop_data);
232*602ca9eaScth extern int		di_prop_int64(di_prop_t prop, int64_t **prop_data);
233*602ca9eaScth extern int		di_prop_strings(di_prop_t prop, char **prop_data);
234*602ca9eaScth extern int		di_prop_bytes(di_prop_t prop, uchar_t **prop_data);
235*602ca9eaScth 
236*602ca9eaScth extern int		di_prop_lookup_bytes(dev_t dev, di_node_t node,
237*602ca9eaScth 			    const char *prop_name, uchar_t **prop_data);
238*602ca9eaScth extern int		di_prop_lookup_ints(dev_t dev, di_node_t node,
239*602ca9eaScth 			    const char *prop_name, int **prop_data);
240*602ca9eaScth extern int		di_prop_lookup_int64(dev_t dev, di_node_t node,
241*602ca9eaScth 			    const char *prop_name, int64_t **prop_data);
242*602ca9eaScth extern int		di_prop_lookup_strings(dev_t dev, di_node_t node,
243*602ca9eaScth 			    const char *prop_name, char **prop_data);
2447c478bd9Sstevel@tonic-gate 
2457c478bd9Sstevel@tonic-gate /*
246*602ca9eaScth  * prom_node: property access
2477c478bd9Sstevel@tonic-gate  */
248*602ca9eaScth extern di_prom_handle_t	di_prom_init(void);
249*602ca9eaScth extern void		di_prom_fini(di_prom_handle_t ph);
250*602ca9eaScth 
251*602ca9eaScth extern di_prom_prop_t	di_prom_prop_next(di_prom_handle_t ph, di_node_t node,
252*602ca9eaScth 			    di_prom_prop_t prom_prop);
253*602ca9eaScth 
254*602ca9eaScth extern char		*di_prom_prop_name(di_prom_prop_t prom_prop);
255*602ca9eaScth extern int		di_prom_prop_data(di_prom_prop_t prop,
256*602ca9eaScth 			    uchar_t **prom_prop_data);
257*602ca9eaScth 
258*602ca9eaScth extern int		di_prom_prop_lookup_ints(di_prom_handle_t prom,
259*602ca9eaScth 			    di_node_t node, const char *prom_prop_name,
260*602ca9eaScth 			    int **prom_prop_data);
261*602ca9eaScth extern int		di_prom_prop_lookup_strings(di_prom_handle_t prom,
262*602ca9eaScth 			    di_node_t node, const char *prom_prop_name,
263*602ca9eaScth 			    char **prom_prop_data);
264*602ca9eaScth extern int		di_prom_prop_lookup_bytes(di_prom_handle_t prom,
265*602ca9eaScth 			    di_node_t node, const char *prom_prop_name,
266*602ca9eaScth 			    uchar_t **prom_prop_data);
2677c478bd9Sstevel@tonic-gate 
268*602ca9eaScth /*
269*602ca9eaScth  * path_node: property access
270*602ca9eaScth  */
271*602ca9eaScth extern di_path_prop_t	di_path_prop_next(di_path_t path, di_path_prop_t prop);
272*602ca9eaScth 
273*602ca9eaScth extern char		*di_path_prop_name(di_path_prop_t prop);
274*602ca9eaScth extern int		di_path_prop_type(di_path_prop_t prop);
275*602ca9eaScth extern int		di_path_prop_len(di_path_prop_t prop);
276*602ca9eaScth 
277*602ca9eaScth extern int		di_path_prop_bytes(di_path_prop_t prop,
278*602ca9eaScth 			    uchar_t **prop_data);
279*602ca9eaScth extern int		di_path_prop_ints(di_path_prop_t prop,
280*602ca9eaScth 			    int **prop_data);
281*602ca9eaScth extern int		di_path_prop_int64s(di_path_prop_t prop,
282*602ca9eaScth 			    int64_t **prop_data);
283*602ca9eaScth extern int		di_path_prop_strings(di_path_prop_t prop,
284*602ca9eaScth 			    char **prop_data);
285*602ca9eaScth 
286*602ca9eaScth extern int		di_path_prop_lookup_bytes(di_path_t path,
287*602ca9eaScth 			    const char *prop_name, uchar_t **prop_data);
288*602ca9eaScth extern int		di_path_prop_lookup_ints(di_path_t path,
289*602ca9eaScth 			    const char *prop_name, int **prop_data);
290*602ca9eaScth extern int		di_path_prop_lookup_int64s(di_path_t path,
291*602ca9eaScth 			    const char *prop_name, int64_t **prop_data);
292*602ca9eaScth extern int		di_path_prop_lookup_strings(di_path_t path,
293*602ca9eaScth 			    const char *prop_name, char **prop_data);
2947c478bd9Sstevel@tonic-gate 
295*602ca9eaScth /*
296*602ca9eaScth  * layering link/lnode: traversal, data access, and parameters
297*602ca9eaScth  */
298*602ca9eaScth extern int		di_walk_link(di_node_t root, uint_t flag,
299*602ca9eaScth 			    uint_t endpoint, void *arg,
300*602ca9eaScth 			    int (*link_callback)(di_link_t link, void *arg));
301*602ca9eaScth extern int		di_walk_lnode(di_node_t root, uint_t flag, void *arg,
302*602ca9eaScth 			    int (*lnode_callback)(di_lnode_t lnode, void *arg));
303*602ca9eaScth 
304*602ca9eaScth extern di_link_t	di_link_next_by_node(di_node_t node,
305*602ca9eaScth 			    di_link_t link, uint_t endpoint);
306*602ca9eaScth extern di_link_t	di_link_next_by_lnode(di_lnode_t lnode,
307*602ca9eaScth 			    di_link_t link, uint_t endpoint);
308*602ca9eaScth extern di_lnode_t	di_lnode_next(di_node_t node, di_lnode_t lnode);
309*602ca9eaScth extern char		*di_lnode_name(di_lnode_t lnode);
310*602ca9eaScth 
311*602ca9eaScth extern int		di_link_spectype(di_link_t link);
312*602ca9eaScth extern di_lnode_t	di_link_to_lnode(di_link_t link, uint_t endpoint);
313*602ca9eaScth 
314*602ca9eaScth extern di_node_t	di_lnode_devinfo(di_lnode_t lnode);
315*602ca9eaScth extern int		di_lnode_devt(di_lnode_t lnode, dev_t *devt);
316*602ca9eaScth 
317*602ca9eaScth extern void		di_link_private_set(di_link_t link, void *data);
318*602ca9eaScth extern void		*di_link_private_get(di_link_t link);
319*602ca9eaScth extern void		di_lnode_private_set(di_lnode_t lnode, void *data);
320*602ca9eaScth extern void		*di_lnode_private_get(di_lnode_t lnode);
3217c478bd9Sstevel@tonic-gate 
3227c478bd9Sstevel@tonic-gate 
3237c478bd9Sstevel@tonic-gate /*
3247c478bd9Sstevel@tonic-gate  * Private interfaces
3257c478bd9Sstevel@tonic-gate  *
3267c478bd9Sstevel@tonic-gate  * The interfaces and structures below are private to this implementation
3277c478bd9Sstevel@tonic-gate  * of Solaris and are subject to change at any time without notice.
3287c478bd9Sstevel@tonic-gate  *
329*602ca9eaScth  * Applications and drivers using these interfaces may fail
3307c478bd9Sstevel@tonic-gate  * to run on future releases.
3317c478bd9Sstevel@tonic-gate  */
3323ebafc43Sjveta extern di_prop_t di_prop_find(dev_t match_dev, di_node_t node,
3333ebafc43Sjveta     const char *name);
334*602ca9eaScth extern int di_devfs_path_match(const char *dp1, const char *dp2);
335*602ca9eaScth 
336*602ca9eaScth extern di_node_t	di_vhci_first_node(di_node_t root);
337*602ca9eaScth extern di_node_t	di_vhci_next_node(di_node_t node);
338*602ca9eaScth extern di_node_t	di_phci_first_node(di_node_t vhci_node);
339*602ca9eaScth extern di_node_t	di_phci_next_node(di_node_t node);
3403ebafc43Sjveta 
3413ebafc43Sjveta /*
3423ebafc43Sjveta  * Interfaces for handling IEEE 1275 and other standardized properties
3433ebafc43Sjveta  */
3443ebafc43Sjveta 
3453ebafc43Sjveta /* structure for a single slot */
3463ebafc43Sjveta typedef struct di_slot_name {
3473ebafc43Sjveta 	int num;	/* corresponding pci device number */
3483ebafc43Sjveta 	char *name;
3493ebafc43Sjveta } di_slot_name_t;
3503ebafc43Sjveta 
3513ebafc43Sjveta extern void di_slot_names_free(int count, di_slot_name_t *slot_names);
3523ebafc43Sjveta extern int di_slot_names_decode(uchar_t *rawdata, int rawlen,
3533ebafc43Sjveta     di_slot_name_t **prop_data);
3543ebafc43Sjveta extern int di_prop_slot_names(di_prop_t prop, di_slot_name_t **prop_data);
3553ebafc43Sjveta extern int di_prom_prop_slot_names(di_prom_prop_t prom_prop,
3563ebafc43Sjveta     di_slot_name_t **prop_data);
3573ebafc43Sjveta extern int di_prop_lookup_slot_names(dev_t dev, di_node_t node,
3583ebafc43Sjveta     di_slot_name_t **prop_data);
3593ebafc43Sjveta extern int di_prom_prop_lookup_slot_names(di_prom_handle_t ph, di_node_t node,
3603ebafc43Sjveta     di_slot_name_t **prop_data);
3613ebafc43Sjveta 
3627c478bd9Sstevel@tonic-gate /*
363*602ca9eaScth  * XXX Remove the private di_path_(addr,next,next_phci,next_client) interfaces
364*602ca9eaScth  * below after NWS consolidation switches to using di_path_bus_addr,
365*602ca9eaScth  * di_path_phci_next_path, and di_path_client_next_path per CR6638521.
3667c478bd9Sstevel@tonic-gate  */
367*602ca9eaScth extern char *di_path_addr(di_path_t path, char *buf);
3687c478bd9Sstevel@tonic-gate extern di_path_t di_path_next(di_node_t node, di_path_t path);
3697c478bd9Sstevel@tonic-gate extern di_path_t di_path_next_phci(di_node_t node, di_path_t path);
3707c478bd9Sstevel@tonic-gate extern di_path_t di_path_next_client(di_node_t node, di_path_t path);
3717c478bd9Sstevel@tonic-gate 
3727c478bd9Sstevel@tonic-gate /*
3737c478bd9Sstevel@tonic-gate  * Interfaces for private data
3747c478bd9Sstevel@tonic-gate  */
3757c478bd9Sstevel@tonic-gate extern di_node_t di_init_driver(const char *drv_name, uint_t flag);
3767c478bd9Sstevel@tonic-gate extern di_node_t di_init_impl(const char *phys_path, uint_t flag,
3777c478bd9Sstevel@tonic-gate     struct di_priv_data *priv_data);
3787c478bd9Sstevel@tonic-gate 
3797c478bd9Sstevel@tonic-gate /*
3807c478bd9Sstevel@tonic-gate  * Prtconf needs to know property lists, raw prop_data, and private data
3817c478bd9Sstevel@tonic-gate  */
3827c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_drv_next(di_node_t node, di_prop_t prop);
3837c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_sys_next(di_node_t node, di_prop_t prop);
3847c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_global_next(di_node_t node, di_prop_t prop);
3857c478bd9Sstevel@tonic-gate extern di_prop_t di_prop_hw_next(di_node_t node, di_prop_t prop);
3867c478bd9Sstevel@tonic-gate 
3877c478bd9Sstevel@tonic-gate extern int di_prop_rawdata(di_prop_t prop, uchar_t **prop_data);
3887c478bd9Sstevel@tonic-gate extern void *di_parent_private_data(di_node_t node);
3897c478bd9Sstevel@tonic-gate extern void *di_driver_private_data(di_node_t node);
3907c478bd9Sstevel@tonic-gate 
39125e8c5aaSvikram /*
39225e8c5aaSvikram  * The value of the dip's devi_flags field
39325e8c5aaSvikram  */
39425e8c5aaSvikram uint_t di_flags(di_node_t node);
39525e8c5aaSvikram 
3967c478bd9Sstevel@tonic-gate /*
3977c478bd9Sstevel@tonic-gate  * Types of links for devlink lookup
3987c478bd9Sstevel@tonic-gate  */
3997c478bd9Sstevel@tonic-gate #define	DI_PRIMARY_LINK		0x01
4007c478bd9Sstevel@tonic-gate #define	DI_SECONDARY_LINK	0x02
4017c478bd9Sstevel@tonic-gate #define	DI_LINK_TYPES		0x03
4027c478bd9Sstevel@tonic-gate 
4037c478bd9Sstevel@tonic-gate /*
4047c478bd9Sstevel@tonic-gate  * Flag for di_devlink_init()
4057c478bd9Sstevel@tonic-gate  */
4067c478bd9Sstevel@tonic-gate #define	DI_MAKE_LINK	0x01
4077c478bd9Sstevel@tonic-gate 
4087c478bd9Sstevel@tonic-gate /*
4097c478bd9Sstevel@tonic-gate  * Flag for di_devlink_close()
4107c478bd9Sstevel@tonic-gate  */
4117c478bd9Sstevel@tonic-gate #define	DI_LINK_ERROR	0x01
4127c478bd9Sstevel@tonic-gate 
4137c478bd9Sstevel@tonic-gate /*
4147c478bd9Sstevel@tonic-gate  * For devfsadm synchronous link creation interfaces
4157c478bd9Sstevel@tonic-gate  */
4167c478bd9Sstevel@tonic-gate #define	DEVFSADM_SYNCH_DOOR	".devfsadm_synch_door"
4177c478bd9Sstevel@tonic-gate 
4187c478bd9Sstevel@tonic-gate /*
4197c478bd9Sstevel@tonic-gate  * devlink create argument
4207c478bd9Sstevel@tonic-gate  */
4217c478bd9Sstevel@tonic-gate struct dca_off {
4227c478bd9Sstevel@tonic-gate 	uint32_t	dca_root;
4237c478bd9Sstevel@tonic-gate 	uint32_t	dca_minor;
4247c478bd9Sstevel@tonic-gate 	uint32_t	dca_driver;
4257c478bd9Sstevel@tonic-gate 	int		dca_error;
4267c478bd9Sstevel@tonic-gate 	int		dca_flags;
4277c478bd9Sstevel@tonic-gate 	char		dca_name[PATH_MAX+MAXNAMELEN];
4287c478bd9Sstevel@tonic-gate };
4297c478bd9Sstevel@tonic-gate 
4307c478bd9Sstevel@tonic-gate extern di_devlink_handle_t di_devlink_init(const char *name, uint_t flags);
4317c478bd9Sstevel@tonic-gate extern int di_devlink_walk(di_devlink_handle_t hdl, const char *re,
4327c478bd9Sstevel@tonic-gate     const char *minor_path, uint_t flags, void *arg,
4337c478bd9Sstevel@tonic-gate     int (*devlink_callback)(di_devlink_t, void *));
4347c478bd9Sstevel@tonic-gate extern const char *di_devlink_path(di_devlink_t devlink);
4357c478bd9Sstevel@tonic-gate extern const char *di_devlink_content(di_devlink_t devlink);
4367c478bd9Sstevel@tonic-gate extern int di_devlink_type(di_devlink_t devlink);
4377c478bd9Sstevel@tonic-gate extern di_devlink_t di_devlink_dup(di_devlink_t devlink);
4387c478bd9Sstevel@tonic-gate extern int di_devlink_free(di_devlink_t devlink);
4397c478bd9Sstevel@tonic-gate extern int di_devlink_fini(di_devlink_handle_t *hdlp);
4407c478bd9Sstevel@tonic-gate 
4417c478bd9Sstevel@tonic-gate extern di_devlink_handle_t di_devlink_open(const char *root_dir, uint_t flags);
4427c478bd9Sstevel@tonic-gate extern int di_devlink_close(di_devlink_handle_t *pp, int flag);
4437c478bd9Sstevel@tonic-gate extern int di_devlink_rm_link(di_devlink_handle_t hdp, const char *link);
4447c478bd9Sstevel@tonic-gate extern int di_devlink_add_link(di_devlink_handle_t hdp, const char *link,
4457c478bd9Sstevel@tonic-gate     const char *content, int flags);
4467c478bd9Sstevel@tonic-gate extern int di_devlink_update(di_devlink_handle_t hdp);
4477c478bd9Sstevel@tonic-gate extern di_devlink_handle_t di_devlink_init_root(const char *root,
4487c478bd9Sstevel@tonic-gate     const char *name, uint_t flags);
4497c478bd9Sstevel@tonic-gate extern int di_devlink_cache_walk(di_devlink_handle_t hdp, const char *re,
4507c478bd9Sstevel@tonic-gate     const char *path, uint_t flags, void *arg,
4517c478bd9Sstevel@tonic-gate     int (*devlink_callback)(di_devlink_t, void *));
4527c478bd9Sstevel@tonic-gate 
45325e8c5aaSvikram /*
45425e8c5aaSvikram  * Private interfaces for I/O retire
45525e8c5aaSvikram  */
45625e8c5aaSvikram typedef struct di_retire {
45725e8c5aaSvikram 	void	*rt_hdl;
45825e8c5aaSvikram 	void	(*rt_abort)(void *hdl, const char *format, ...);
45925e8c5aaSvikram 	void	(*rt_debug)(void *hdl, const char *format, ...);
46025e8c5aaSvikram } di_retire_t;
46125e8c5aaSvikram 
46225e8c5aaSvikram extern int di_retire_device(char *path, di_retire_t *dp, int flags);
46325e8c5aaSvikram extern int di_unretire_device(char *path, di_retire_t *dp);
46425e8c5aaSvikram extern uint_t di_retired(di_node_t node);
46525e8c5aaSvikram 
4667c478bd9Sstevel@tonic-gate /*
4677c478bd9Sstevel@tonic-gate  * Private interfaces for /etc/logindevperm
4687c478bd9Sstevel@tonic-gate  */
4697c478bd9Sstevel@tonic-gate extern int di_devperm_login(const char *, uid_t, gid_t, void (*)(char *));
4707c478bd9Sstevel@tonic-gate extern int di_devperm_logout(const char *);
4717c478bd9Sstevel@tonic-gate 
4727c478bd9Sstevel@tonic-gate /*
473*602ca9eaScth  * Private interface for looking up, by path string, a node/path/minor
474*602ca9eaScth  * in a snapshot.
4757c478bd9Sstevel@tonic-gate  */
476*602ca9eaScth extern di_path_t di_lookup_path(di_node_t root, char *path);
4777c478bd9Sstevel@tonic-gate extern di_node_t di_lookup_node(di_node_t root, char *path);
4787c478bd9Sstevel@tonic-gate 
4793c4226f9Spjha /*
4803c4226f9Spjha  * Private hotplug interfaces to be used between cfgadm pci plugin and
4813c4226f9Spjha  * devfsadm link generator.
4823c4226f9Spjha  */
4833c4226f9Spjha extern char *di_dli_name(char *);
4843c4226f9Spjha extern int di_dli_openr(char *);
4853c4226f9Spjha extern int di_dli_openw(char *);
4863c4226f9Spjha extern void di_dli_close(int);
4873c4226f9Spjha 
488facf4a8dSllai /*
489facf4a8dSllai  * Private interface for parsing devname binding info
490facf4a8dSllai  */
491facf4a8dSllai extern void di_devname_print_mapinfo(nvlist_t *);
492facf4a8dSllai extern int di_devname_get_mapinfo(char *, nvlist_t **);
493facf4a8dSllai extern int di_devname_get_mapent(char *, char *, nvlist_t **);
494facf4a8dSllai extern int di_devname_action_on_key(nvlist_t *, uint8_t, char *, void *);
495facf4a8dSllai 
4961aef0e11Sjg /*
4971aef0e11Sjg  * Private interface for parsing path_to_inst binding file
4981aef0e11Sjg  */
4991aef0e11Sjg extern int devfs_parse_binding_file(const char *,
5001aef0e11Sjg 	int (*)(void *, const char *, int, const char *), void *);
5011aef0e11Sjg extern int devfs_walk_minor_nodes(const char *,
5021aef0e11Sjg 	int (*)(void *, const char *), void *);
5031aef0e11Sjg 
504facf4a8dSllai /*
505facf4a8dSllai  * finddev - alternate readdir to discover only /dev persisted device names
506facf4a8dSllai  */
507facf4a8dSllai typedef struct __finddevhdl *finddevhdl_t;
508facf4a8dSllai 
509facf4a8dSllai extern int		device_exists(const char *);
510facf4a8dSllai extern int		finddev_readdir(const char *, finddevhdl_t *);
511e37c6c37Scth extern int		finddev_emptydir(const char *);
512facf4a8dSllai extern void		finddev_close(finddevhdl_t);
513facf4a8dSllai extern const char	*finddev_next(finddevhdl_t);
514facf4a8dSllai 
515facf4a8dSllai 
516facf4a8dSllai /*
517facf4a8dSllai  * Private interfaces for non-global /dev profile
518facf4a8dSllai  */
519facf4a8dSllai typedef struct __di_prof	*di_prof_t;
520facf4a8dSllai 
521facf4a8dSllai extern int	di_prof_init(const char *mountpt, di_prof_t *);
522facf4a8dSllai extern void	di_prof_fini(di_prof_t);
523facf4a8dSllai extern int	di_prof_commit(di_prof_t);
524facf4a8dSllai extern int	di_prof_add_dev(di_prof_t, const char *);
525facf4a8dSllai extern int	di_prof_add_exclude(di_prof_t, const char *);
526facf4a8dSllai extern int	di_prof_add_symlink(di_prof_t, const char *, const char *);
527facf4a8dSllai extern int	di_prof_add_map(di_prof_t, const char *, const char *);
528facf4a8dSllai 
529a08731ecScth /*
530a08731ecScth  * Private interfaces for <driver><instance><minor> to path conversion.
531a08731ecScth  * NOTE: These interfaces do not require or cause attach.  The implementation
532a08731ecScth  * uses the kernel instance-tree (/etc/path_to_inst) and the di_devlinks
533a08731ecScth  * database information.
534a08731ecScth  */
535a08731ecScth typedef struct __di_dim	*di_dim_t;
536a08731ecScth 
537a08731ecScth extern di_dim_t	di_dim_init();
538a08731ecScth extern void	di_dim_fini(di_dim_t);
539a08731ecScth extern char	*di_dim_path_devices(di_dim_t,
540a08731ecScth 		    char *drv_name, int instance, char *minor_name);
541a08731ecScth extern char	*di_dim_path_dev(di_dim_t,
542a08731ecScth 		    char *drv_name, int instance, char *minor_name);
543a08731ecScth 
544a08731ecScth 
5457c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
5467c478bd9Sstevel@tonic-gate }
5477c478bd9Sstevel@tonic-gate #endif
5487c478bd9Sstevel@tonic-gate 
5497c478bd9Sstevel@tonic-gate #endif	/* _LIBDEVINFO_H */
550