xref: /illumos-gate/usr/src/lib/libfru/include/libfrup.h (revision ddb365bfc9e868ad24ccdcb0dc91af18b10df082)
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  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_LIBFRUP_H
27 #define	_LIBFRUP_H
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 #include <stdarg.h>
34 
35 #include "libfru.h"
36 #include "../../libfruutils/fru_tag.h"
37 
38 typedef uint64_t fru_seghdl_t;
39 typedef enum {FRU_ENCRYPT, FRU_DECRYPT} fru_encrypt_t;
40 typedef fru_errno_t
41 (*fru_encrypt_func_t)(fru_encrypt_t en_dec, unsigned char *buf, size_t buf_len);
42 
43 /*
44  * Type for pointers to functions for terminating the processing of a node
45  * (after its children have been processed)
46  */
47 typedef void	(*end_node_fp_t)(fru_nodehdl_t node, const char *path,
48 					const char *name, void *args);
49 
50 /*
51  * Project-private exported symbols
52  */
53 extern	fru_encrypt_func_t encrypt_func;
54 
55 extern	fru_errno_t fru_encryption_supported(void);
56 
57 extern	fru_errno_t fru_walk_tree(fru_nodehdl_t node, const char *prior_path,
58 		fru_errno_t (*process_node)(fru_nodehdl_t node,
59 						const char *path,
60 						const char *name, void *args,
61 						end_node_fp_t *end_node,
62 						void **end_args),
63 		void *args);
64 
65 extern	int fru_pathmatch(const char *path, const char *searchpath);
66 
67 extern	fru_errno_t fru_for_each_segment(fru_nodehdl_t node,
68 					int (*function)(fru_seghdl_t segment,
69 						void *args),
70 					void *args);
71 extern	fru_errno_t fru_get_segment_name(fru_seghdl_t segment, char **name);
72 extern	fru_errno_t fru_for_each_packet(fru_seghdl_t segment,
73 				int (*function)(fru_tag_t *tag,
74 						uint8_t *payload,
75 						size_t length, void *args),
76 				void *args);
77 
78 #ifdef __cplusplus
79 }
80 #endif
81 
82 #endif /* _LIBFRUP_H */
83