xref: /illumos-gate/usr/src/lib/libfru/include/libfruds.h (revision 1da57d551424de5a9d469760be7c4b4d4f10a755)
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 2000-2002 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_LIBFRUDS_H
28 #define	_LIBFRUDS_H
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 #include <stdarg.h>
35 
36 #include "libfru.h"
37 #include "fru_tag.h"
38 
39 #define	LIBFRU_DS_VER 1
40 
41 /* Tree handle specific to the datasource */
42 typedef uint64_t fru_treehdl_t;
43 typedef uint64_t fru_treeseghdl_t;
44 
45 typedef struct
46 {
47 	int version;
48 
49 /* init */
50 fru_errno_t (*initialize)(int argc, char **argv);
51 fru_errno_t (*shutdown)(void);
52 
53 /* Tree ops */
54 fru_errno_t (*get_root)(fru_treehdl_t *root);
55 fru_errno_t (*get_child)(fru_treehdl_t parent, fru_treehdl_t *child);
56 fru_errno_t (*get_peer)(fru_treehdl_t sibling, fru_treehdl_t *peer);
57 fru_errno_t (*get_parent)(fru_treehdl_t child, fru_treehdl_t *parent);
58 
59 /* Node ops */
60 fru_errno_t (*get_name_from_hdl)(fru_treehdl_t node, char **name);
61 fru_errno_t (*get_node_type)(fru_treehdl_t node, fru_node_t *type);
62 
63 /* Segment ops */
64 fru_errno_t (*get_seg_list)(fru_treehdl_t container, fru_strlist_t *list);
65 fru_errno_t (*get_seg_def)(fru_treehdl_t container, const char *seg_name,
66 		fru_segdef_t *def);
67 fru_errno_t (*add_seg)(fru_treehdl_t container, fru_segdef_t *def);
68 fru_errno_t (*delete_seg)(fru_treehdl_t container, const char *seg_name);
69 fru_errno_t (*for_each_segment)(fru_treehdl_t node,
70 				int (*function)(fru_treeseghdl_t segment,
71 						void *args),
72 				void *args);
73 fru_errno_t (*get_segment_name)(fru_treeseghdl_t segment, char **name);
74 
75 /* Tag ops */
76 fru_errno_t (*add_tag_to_seg)(fru_treehdl_t container, const char *seg_name,
77 		fru_tag_t tag, uint8_t *data, size_t data_len);
78 fru_errno_t (*get_tag_list)(fru_treehdl_t container, const char *seg_name,
79 		fru_tag_t **tags, int *number);
80 fru_errno_t (*get_tag_data)(fru_treehdl_t container, const char *seg_name,
81 		fru_tag_t tag, int instance,
82 		uint8_t **data, size_t *data_len);
83 fru_errno_t (*set_tag_data)(fru_treehdl_t container, const char *seg_name,
84 		fru_tag_t tag, int instance,
85 		uint8_t *data, size_t data_len);
86 fru_errno_t (*delete_tag)(fru_treehdl_t container, const char *seg_name,
87 		fru_tag_t tag, int instance);
88 fru_errno_t (*for_each_packet)(fru_treeseghdl_t segment,
89 				int (*function)(fru_tag_t *tag,
90 						uint8_t *payload,
91 						size_t length, void *args),
92 				void *args);
93 
94 } fru_datasource_t;
95 
96 #ifdef __cplusplus
97 }
98 #endif
99 
100 #endif /* _LIBFRUDS_H */
101