xref: /titanic_41/usr/src/uts/common/avs/ns/unistat/spcs_s.h (revision fcf3ce441efd61da9bb2884968af01cb7c1452cc)
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SPCS_S_H
27 #define	_SPCS_S_H
28 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 
33 /*
34  *	SPCS Uniform status handling public definitions
35  *	@author Soper
36  *	@version PROTOTYPE
37  */
38 
39 
40 
41 
42 /*
43  *	Function returned normally, no status info available (== 0)
44  */
45 #define	SPCS_S_OK 0
46 
47 /*
48  *	Function returned abnormally, status info available (== -1)
49  */
50 #define	SPCS_S_ERROR -1
51 
52 /*
53  *	The maximum status line character array length (== 1024)
54  *	@see spcs_s_string
55  */
56 #define	SPCS_S_MAXLINE	1024
57 
58 /*
59  *	The maximum number of "%s" format descriptors in status message
60  *	text and data parameters that can be passed along with status
61  *	@see spcs_s_string
62  */
63 #define	SPCS_S_MAXSUPP	8
64 
65 /*
66  *	The opaque status information type
67  */
68 typedef uintptr_t spcs_s_info_t;
69 
70 /*
71  *	The status information type as a 32 bit entity for model conversions
72  */
73 typedef uint32_t spcs_s_info32_t;
74 
75 /*
76  *	The type of bytestream data (see spcs_s_add_bytestream() )
77  */
78 typedef uchar_t *spcs_s_bytestream_ptr_t;
79 
80 /*
81  *	The type of a status code
82  */
83 typedef int spcs_s_status_t;
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif /* _SPCS_S_H */
90