xref: /illumos-gate/usr/src/lib/fm/topo/libtopo/common/topo_file.h (revision a07094369b21309434206d9b3601d162693466fc)
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 2006 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _TOPO_FILE_H
28 #define	_TOPO_FILE_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <topo_parse.h>
33 
34 #ifdef	__cplusplus
35 extern "C" {
36 #endif
37 
38 /*
39  *  We support loading topology from a file.  The topo_tree routines
40  *  don't need to know anymore than to call topo_file_load() to try to
41  *  load the topology initially, and topo_file_unload() to clean up.
42  */
43 typedef struct topo_file {
44 	/*
45 	 * Currently we directly parse xml into topology nodes.  The
46 	 * tf_info_t is created and used by the xml parsing routines.
47 	 */
48 	tf_info_t *tf_fileinfo;
49 	/*
50 	 * Module on whose behalf the enumeration-from-file is occuring.
51 	 */
52 	topo_mod_t *tf_mod;
53 } topo_file_t;
54 
55 #ifdef	__cplusplus
56 }
57 #endif
58 
59 #endif	/* _TOPO_FILE_H */
60