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, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_LIBDEVINFO_H
28 #define	_LIBDEVINFO_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <errno.h>
33 #include <sys/param.h>
34 #include <sys/sunddi.h>
35 #include <sys/sunmdi.h>
36 #include <sys/openpromio.h>
37 #include <sys/ddi_impldefs.h>
38 #include <sys/devinfo_impl.h>
39 #include <limits.h>
40 
41 #ifdef	__cplusplus
42 extern "C" {
43 #endif
44 
45 /*
46  * flags for di_walk_node
47  */
48 #define	DI_WALK_CLDFIRST	0
49 #define	DI_WALK_SIBFIRST	1
50 #define	DI_WALK_LINKGEN		2
51 
52 #define	DI_WALK_MASK		0xf
53 
54 /*
55  * flags for di_walk_link
56  */
57 #define	DI_LINK_SRC		1
58 #define	DI_LINK_TGT		2
59 
60 /*
61  * return code for node_callback
62  */
63 #define	DI_WALK_CONTINUE	0
64 #define	DI_WALK_PRUNESIB	-1
65 #define	DI_WALK_PRUNECHILD	-2
66 #define	DI_WALK_TERMINATE	-3
67 
68 /*
69  * flags for di_walk_minor
70  */
71 #define	DI_CHECK_ALIAS		0x10
72 #define	DI_CHECK_INTERNAL_PATH	0x20
73 
74 #define	DI_CHECK_MASK		0xf0
75 
76 /* nodeid types */
77 #define	DI_PSEUDO_NODEID	-1
78 #define	DI_SID_NODEID		-2
79 #define	DI_PROM_NODEID		-3
80 
81 /* node & device states */
82 #define	DI_DRIVER_DETACHED	0x8000
83 #define	DI_DEVICE_OFFLINE	0x1
84 #define	DI_DEVICE_DOWN		0x2
85 #define	DI_BUS_QUIESCED		0x100
86 #define	DI_BUS_DOWN		0x200
87 
88 /* property types */
89 #define	DI_PROP_TYPE_BOOLEAN	0
90 #define	DI_PROP_TYPE_INT	1
91 #define	DI_PROP_TYPE_STRING	2
92 #define	DI_PROP_TYPE_BYTE	3
93 #define	DI_PROP_TYPE_UNKNOWN	4
94 #define	DI_PROP_TYPE_UNDEF_IT	5
95 #define	DI_PROP_TYPE_INT64	6
96 
97 /* private macro for checking if a prop type is valid */
98 #define	DI_PROP_TYPE_VALID(type) \
99 	((((type) >= DI_PROP_TYPE_INT) && ((type) <= DI_PROP_TYPE_BYTE)) || \
100 	    ((type) == DI_PROP_TYPE_INT64))
101 
102 /* opaque handles */
103 
104 typedef struct di_node *di_node_t;	/* opaque handle to node */
105 typedef struct di_minor *di_minor_t;	/* opaque handle to minor node */
106 typedef struct di_prop *di_prop_t;	/* opaque handle to property */
107 typedef struct di_prom_prop *di_prom_prop_t;	/* opaque handle to prom prop */
108 typedef struct di_prom_handle *di_prom_handle_t;	/* opaque handle */
109 typedef struct di_path *di_path_t;	/* opaque handle */
110 typedef struct di_path_prop *di_path_prop_t;	/* opaque handle */
111 
112 typedef struct di_devlink_handle *di_devlink_handle_t;	/* devlink snapshot */
113 typedef struct di_devlink *di_devlink_t;	/* opaque handle to devlink */
114 typedef struct di_link *di_link_t;	/* opaque handle to link */
115 typedef struct di_lnode *di_lnode_t; /* opaque handle to endpoint */
116 
117 /*
118  * Null handles to make handles really opaque
119  */
120 #define	DI_NODE_NIL	NULL
121 #define	DI_LINK_NIL	NULL
122 #define	DI_LNODE_NIL	NULL
123 #define	DI_MINOR_NIL	NULL
124 #define	DI_PROP_NIL	NULL
125 #define	DI_PROM_PROP_NIL	NULL
126 #define	DI_PROM_HANDLE_NIL	NULL
127 #define	DI_PATH_NIL	NULL
128 
129 /* Interface Prototypes */
130 
131 /*
132  * Snapshot initialization and cleanup
133  */
134 extern di_node_t di_init(const char *phys_path, uint_t flag);
135 extern void di_fini(di_node_t root);
136 
137 /*
138  * tree traversal
139  */
140 extern di_node_t di_parent_node(di_node_t node);
141 extern di_node_t di_sibling_node(di_node_t node);
142 extern di_node_t di_child_node(di_node_t node);
143 extern di_node_t di_drv_first_node(const char *drv_name, di_node_t root);
144 extern di_node_t di_drv_next_node(di_node_t node);
145 extern di_node_t di_vhci_first_node(di_node_t root);
146 extern di_node_t di_vhci_next_node(di_node_t node);
147 extern di_node_t di_phci_first_node(di_node_t vhci_node);
148 extern di_node_t di_phci_next_node(di_node_t node);
149 
150 /*
151  * tree walking assistants
152  */
153 extern int di_walk_node(di_node_t root, uint_t flag, void *arg,
154     int (*node_callback)(di_node_t node, void *arg));
155 extern int di_walk_minor(di_node_t root, const char *minortype, uint_t flag,
156     void *arg, int (*minor_callback)(di_node_t node, di_minor_t minor,
157     void *arg));
158 extern int di_walk_link(di_node_t root, uint_t flag, uint_t endpoint,
159     void *arg, int (*link_callback)(di_link_t link, void *arg));
160 extern int di_walk_lnode(di_node_t root, uint_t flag,
161     void *arg, int (*lnode_callback)(di_lnode_t lnode, void *arg));
162 
163 extern void di_node_private_set(di_node_t node, void *data);
164 extern void *di_node_private_get(di_node_t node);
165 extern void di_minor_private_set(di_minor_t minor, void *data);
166 extern void *di_minor_private_get(di_minor_t minor);
167 extern void di_lnode_private_set(di_lnode_t lnode, void *data);
168 extern void *di_lnode_private_get(di_lnode_t lnode);
169 extern void di_link_private_set(di_link_t link, void *data);
170 extern void *di_link_private_get(di_link_t link);
171 
172 /*
173  * generic node parameters
174  */
175 extern char *di_node_name(di_node_t node);
176 extern char *di_bus_addr(di_node_t node);
177 extern char *di_binding_name(di_node_t node);
178 extern int di_compatible_names(di_node_t, char **names);
179 extern int di_instance(di_node_t node);
180 extern int di_nodeid(di_node_t node);
181 extern int di_driver_major(di_node_t node);
182 extern uint_t di_state(di_node_t node);
183 extern ddi_node_state_t di_node_state(di_node_t node);
184 extern ddi_devid_t di_devid(di_node_t node);
185 
186 extern char *di_driver_name(di_node_t node);
187 extern uint_t di_driver_ops(di_node_t node);
188 
189 extern char *di_devfs_path(di_node_t node);
190 extern char *di_devfs_minor_path(di_minor_t minor);
191 
192 extern void di_devfs_path_free(char *path_buf);
193 
194 /*
195  * layering data access
196  */
197 extern di_link_t	di_link_next_by_node(di_node_t node,
198     di_link_t link, uint_t endpoint);
199 extern di_link_t	di_link_next_by_lnode(di_lnode_t lnode,
200     di_link_t link, uint_t endpoint);
201 extern di_lnode_t	di_link_to_lnode(di_link_t link, uint_t endpoint);
202 
203 extern di_lnode_t	di_lnode_next(di_node_t node, di_lnode_t lnode);
204 extern char		*di_lnode_name(di_lnode_t lnode);
205 extern di_node_t	di_lnode_devinfo(di_lnode_t lnode);
206 extern int		di_lnode_devt(di_lnode_t lnode, dev_t *devt);
207 
208 extern int		di_link_spectype(di_link_t link);
209 
210 /*
211  * minor data access
212  */
213 extern di_minor_t	di_minor_next(di_node_t node, di_minor_t minor);
214 extern di_node_t	di_minor_devinfo(di_minor_t minor);
215 extern ddi_minor_type	di_minor_type(di_minor_t minor);
216 extern char		*di_minor_name(di_minor_t minor);
217 extern dev_t		di_minor_devt(di_minor_t minor);
218 extern int		di_minor_spectype(di_minor_t minor);
219 extern char		*di_minor_nodetype(di_minor_t node);
220 
221 /*
222  * Software property access
223  */
224 extern di_prop_t di_prop_next(di_node_t node, di_prop_t prop);
225 extern dev_t di_prop_devt(di_prop_t prop);
226 extern char *di_prop_name(di_prop_t prop);
227 extern int di_prop_type(di_prop_t prop);
228 extern int di_prop_ints(di_prop_t prop, int **prop_data);
229 extern int di_prop_int64(di_prop_t prop, int64_t **prop_data);
230 extern int di_prop_strings(di_prop_t prop, char **prop_data);
231 extern int di_prop_bytes(di_prop_t prop, uchar_t **prop_data);
232 extern int di_prop_lookup_ints(dev_t dev, di_node_t node,
233     const char *prop_name, int **prop_data);
234 extern int di_prop_lookup_int64(dev_t dev, di_node_t node,
235     const char *prop_name, int64_t **prop_data);
236 extern int di_prop_lookup_strings(dev_t dev, di_node_t node,
237     const char *prop_name, char **prop_data);
238 extern int di_prop_lookup_bytes(dev_t dev, di_node_t node,
239     const char *prop_name, uchar_t **prop_data);
240 
241 /*
242  * PROM property access
243  */
244 extern di_prom_handle_t di_prom_init(void);
245 extern void di_prom_fini(di_prom_handle_t ph);
246 
247 extern di_prom_prop_t di_prom_prop_next(di_prom_handle_t ph, di_node_t node,
248     di_prom_prop_t prom_prop);
249 
250 extern char *di_prom_prop_name(di_prom_prop_t prom_prop);
251 extern int di_prom_prop_data(di_prom_prop_t prop, uchar_t **prom_prop_data);
252 
253 extern int di_prom_prop_lookup_ints(di_prom_handle_t prom, di_node_t node,
254     const char *prom_prop_name, int **prom_prop_data);
255 extern int di_prom_prop_lookup_strings(di_prom_handle_t prom, di_node_t node,
256     const char *prom_prop_name, char **prom_prop_data);
257 extern int di_prom_prop_lookup_bytes(di_prom_handle_t prom, di_node_t node,
258     const char *prom_prop_name, uchar_t **prom_prop_data);
259 
260 /*
261  * Private interfaces
262  *
263  * The interfaces and structures below are private to this implementation
264  * of Solaris and are subject to change at any time without notice.
265  *
266  * Applications and drivers using these interfaces will fail
267  * to run on future releases.
268  */
269 
270 /*
271  * Interfaces for accessing I/O multipathing data
272  */
273 /* XXX remove di_path_next() after updating NWS consolidation */
274 extern di_path_t di_path_next(di_node_t node, di_path_t path);
275 extern di_path_t di_path_next_phci(di_node_t node, di_path_t path);
276 extern di_path_t di_path_next_client(di_node_t node, di_path_t path);
277 extern di_path_state_t di_path_state(di_path_t path);
278 extern char *di_path_addr(di_path_t path, char *buf);
279 extern di_node_t di_path_client_node(di_path_t path);
280 extern void di_path_client_path(di_path_t path, char *buf);
281 extern di_node_t di_path_phci_node(di_path_t path);
282 extern void di_path_phci_path(di_path_t path, char *buf);
283 extern di_path_prop_t di_path_prop_next(di_path_t path, di_path_prop_t prop);
284 extern char *di_path_prop_name(di_path_prop_t prop);
285 extern int di_path_prop_type(di_path_prop_t prop);
286 extern int di_path_prop_len(di_path_prop_t prop);
287 extern int di_path_prop_bytes(di_path_prop_t prop, uchar_t **prop_data);
288 extern int di_path_prop_ints(di_path_prop_t prop, int **prop_data);
289 extern int di_path_prop_int64s(di_path_prop_t prop, int64_t **prop_data);
290 extern int di_path_prop_strings(di_path_prop_t prop, char **prop_data);
291 extern int di_path_prop_lookup_bytes(di_path_t path, const char *prop_name,
292     uchar_t **prop_data);
293 extern int di_path_prop_lookup_ints(di_path_t path, const char *prop_name,
294     int **prop_data);
295 extern int di_path_prop_lookup_int64s(di_path_t path, const char *prop_name,
296     int64_t **prop_data);
297 extern int di_path_prop_lookup_strings(di_path_t path, const char *prop_name,
298     char **prop_data);
299 
300 
301 /*
302  * Interfaces for private data
303  */
304 extern di_node_t di_init_driver(const char *drv_name, uint_t flag);
305 extern di_node_t di_init_impl(const char *phys_path, uint_t flag,
306     struct di_priv_data *priv_data);
307 
308 /*
309  * Prtconf needs to know property lists, raw prop_data, and private data
310  */
311 extern di_prop_t di_prop_drv_next(di_node_t node, di_prop_t prop);
312 extern di_prop_t di_prop_sys_next(di_node_t node, di_prop_t prop);
313 extern di_prop_t di_prop_global_next(di_node_t node, di_prop_t prop);
314 extern di_prop_t di_prop_hw_next(di_node_t node, di_prop_t prop);
315 
316 extern int di_prop_rawdata(di_prop_t prop, uchar_t **prop_data);
317 extern void *di_parent_private_data(di_node_t node);
318 extern void *di_driver_private_data(di_node_t node);
319 
320 /*
321  * Types of links for devlink lookup
322  */
323 #define	DI_PRIMARY_LINK		0x01
324 #define	DI_SECONDARY_LINK	0x02
325 #define	DI_LINK_TYPES		0x03
326 
327 /*
328  * Flag for di_devlink_init()
329  */
330 #define	DI_MAKE_LINK	0x01
331 
332 /*
333  * Flag for di_devlink_close()
334  */
335 #define	DI_LINK_ERROR	0x01
336 
337 /*
338  * For devfsadm synchronous link creation interfaces
339  */
340 #define	DEVFSADM_SYNCH_DOOR	".devfsadm_synch_door"
341 
342 /*
343  * devlink create argument
344  */
345 struct dca_off {
346 	uint32_t	dca_root;
347 	uint32_t	dca_minor;
348 	uint32_t	dca_driver;
349 	int		dca_error;
350 	int		dca_flags;
351 	char		dca_name[PATH_MAX+MAXNAMELEN];
352 };
353 
354 extern di_devlink_handle_t di_devlink_init(const char *name, uint_t flags);
355 extern int di_devlink_walk(di_devlink_handle_t hdl, const char *re,
356     const char *minor_path, uint_t flags, void *arg,
357     int (*devlink_callback)(di_devlink_t, void *));
358 extern const char *di_devlink_path(di_devlink_t devlink);
359 extern const char *di_devlink_content(di_devlink_t devlink);
360 extern int di_devlink_type(di_devlink_t devlink);
361 extern di_devlink_t di_devlink_dup(di_devlink_t devlink);
362 extern int di_devlink_free(di_devlink_t devlink);
363 extern int di_devlink_fini(di_devlink_handle_t *hdlp);
364 
365 extern di_devlink_handle_t di_devlink_open(const char *root_dir, uint_t flags);
366 extern int di_devlink_close(di_devlink_handle_t *pp, int flag);
367 extern int di_devlink_rm_link(di_devlink_handle_t hdp, const char *link);
368 extern int di_devlink_add_link(di_devlink_handle_t hdp, const char *link,
369     const char *content, int flags);
370 extern int di_devlink_update(di_devlink_handle_t hdp);
371 extern di_devlink_handle_t di_devlink_init_root(const char *root,
372     const char *name, uint_t flags);
373 extern int di_devlink_cache_walk(di_devlink_handle_t hdp, const char *re,
374     const char *path, uint_t flags, void *arg,
375     int (*devlink_callback)(di_devlink_t, void *));
376 
377 /*
378  * Private interfaces for /etc/logindevperm
379  */
380 extern int di_devperm_login(const char *, uid_t, gid_t, void (*)(char *));
381 extern int di_devperm_logout(const char *);
382 
383 /*
384  * Private interface for looking up a node in a snapshot
385  */
386 extern di_node_t di_lookup_node(di_node_t root, char *path);
387 
388 #ifdef	__cplusplus
389 }
390 #endif
391 
392 #endif	/* _LIBDEVINFO_H */
393