xref: /onnv-gate/usr/src/common/elfcap/elfcap.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _ELFCAP_DOT_H
28*0Sstevel@tonic-gate #define	_ELFCAP_DOT_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate 
34*0Sstevel@tonic-gate #ifdef	__cplusplus
35*0Sstevel@tonic-gate extern "C" {
36*0Sstevel@tonic-gate #endif
37*0Sstevel@tonic-gate 
38*0Sstevel@tonic-gate /*
39*0Sstevel@tonic-gate  * Define a capabilities descriptor.
40*0Sstevel@tonic-gate  */
41*0Sstevel@tonic-gate typedef	struct {
42*0Sstevel@tonic-gate 	uint64_t	c_val;
43*0Sstevel@tonic-gate 	const char	*c_str;
44*0Sstevel@tonic-gate 	size_t		c_len;
45*0Sstevel@tonic-gate } Cap_desc;
46*0Sstevel@tonic-gate 
47*0Sstevel@tonic-gate /*
48*0Sstevel@tonic-gate  * Define a format descriptor.
49*0Sstevel@tonic-gate  */
50*0Sstevel@tonic-gate typedef struct {
51*0Sstevel@tonic-gate 	const char	*f_str;
52*0Sstevel@tonic-gate 	size_t		f_len;
53*0Sstevel@tonic-gate } Fmt_desc;
54*0Sstevel@tonic-gate 
55*0Sstevel@tonic-gate /*
56*0Sstevel@tonic-gate  * Define valid format values.
57*0Sstevel@tonic-gate  */
58*0Sstevel@tonic-gate #define	CAP_FMT_SNGSPACE	0
59*0Sstevel@tonic-gate #define	CAP_FMT_DBLSPACE	1
60*0Sstevel@tonic-gate #define	CAP_FMT_PIPSPACE	2
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate #define	CAP_MAX_TYPE		CAP_FMT_PIPSPACE
63*0Sstevel@tonic-gate 
64*0Sstevel@tonic-gate /*
65*0Sstevel@tonic-gate  * Define error return values.
66*0Sstevel@tonic-gate  */
67*0Sstevel@tonic-gate #define	CAP_ERR_BUFOVFL		1		/* buffer overfow */
68*0Sstevel@tonic-gate #define	CAP_ERR_INVFMT		2		/* invalid format */
69*0Sstevel@tonic-gate #define	CAP_ERR_UNKTAG		3		/* unknown capabilities tag */
70*0Sstevel@tonic-gate #define	CAP_ERR_UNKMACH		4		/* unknown machine type */
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate extern int	cap_val2str(uint64_t, uint64_t, char *, size_t, int, ushort_t);
74*0Sstevel@tonic-gate extern int	hwcap_1_val2str(uint64_t, char *, size_t, int, ushort_t);
75*0Sstevel@tonic-gate extern int	sfcap_1_val2str(uint64_t, char *, size_t, int, ushort_t);
76*0Sstevel@tonic-gate extern uint64_t	hwcap_1_str2val(const char *, ushort_t mach);
77*0Sstevel@tonic-gate extern uint64_t	sfcap_1_str2val(const char *, ushort_t mach);
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate #ifdef	__cplusplus
80*0Sstevel@tonic-gate }
81*0Sstevel@tonic-gate #endif
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate #endif /* _ELFCAP_DOT_H */
84