xref: /onnv-gate/usr/src/lib/fm/libdiagcode/common/diagcode.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	_FM_DIAGCODE_H
28*0Sstevel@tonic-gate #define	_FM_DIAGCODE_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  * The following interfaces are private to Sun and should
40*0Sstevel@tonic-gate  * not be used by applications developed outside of Sun.
41*0Sstevel@tonic-gate  * They may change incompatibly or go away without notice.
42*0Sstevel@tonic-gate  */
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate #define	FM_DC_VERSION   1	/* pass to fm_dc_opendict() */
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate typedef struct fm_dc_handle fm_dc_handle_t;
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate /* open a dictionary, return opaque handle */
49*0Sstevel@tonic-gate fm_dc_handle_t *fm_dc_opendict(int version, const char *dirpath,
50*0Sstevel@tonic-gate     const char *dictname);
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /* close a dictionary */
53*0Sstevel@tonic-gate void fm_dc_closedict(fm_dc_handle_t *dhp);
54*0Sstevel@tonic-gate 
55*0Sstevel@tonic-gate /* return maximum length (in bytes) of diagcodes for a given dictionary */
56*0Sstevel@tonic-gate size_t fm_dc_codelen(fm_dc_handle_t *dhp);
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate /* return number of strings in key for a given dictionary, plus 1 for null */
59*0Sstevel@tonic-gate int fm_dc_maxkey(fm_dc_handle_t *dhp);
60*0Sstevel@tonic-gate 
61*0Sstevel@tonic-gate /* given a key, construct a diagcode */
62*0Sstevel@tonic-gate int fm_dc_key2code(fm_dc_handle_t *dhp,
63*0Sstevel@tonic-gate     const char *key[], char *code, size_t maxcode);
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate /* given a diagcode, return the key (array of strings) */
66*0Sstevel@tonic-gate int fm_dc_code2key(fm_dc_handle_t *dhp, const char *code,
67*0Sstevel@tonic-gate     char *key[], int maxkey);
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate /* return the right-hand side of a names property from the dict header */
70*0Sstevel@tonic-gate const char *fm_dc_getprop(fm_dc_handle_t *dhp, const char *name);
71*0Sstevel@tonic-gate 
72*0Sstevel@tonic-gate #ifdef	__cplusplus
73*0Sstevel@tonic-gate }
74*0Sstevel@tonic-gate #endif
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate #endif	/* _FM_DIAGCODE_H */
77