xref: /freebsd/include/fmtmsg.h (revision 8881d206f4e68b564c2c5f50fc717086fc3e827a)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002 Mike Barcroft <mike@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _FMTMSG_H_
32 #define	_FMTMSG_H_
33 
34 /* Source of condition is... */
35 #define	MM_HARD		0x0001	/* ...hardware. */
36 #define	MM_SOFT		0x0002	/* ...software. */
37 #define	MM_FIRM		0x0004	/* ...firmware. */
38 
39 /* Condition detected by... */
40 #define	MM_APPL		0x0010	/* ...application. */
41 #define	MM_UTIL		0x0020	/* ...utility. */
42 #define	MM_OPSYS	0x0040	/* ...operating system. */
43 
44 /* Display on... */
45 #define	MM_PRINT	0x0100	/* ...standard error. */
46 #define	MM_CONSOLE	0x0200	/* ...system console. */
47 
48 #define	MM_RECOVER	0x1000	/* Recoverable error. */
49 #define	MM_NRECOV	0x2000	/* Non-recoverable error. */
50 
51 /* Severity levels. */
52 #define	MM_NOSEV	0	/* No severity level provided. */
53 #define	MM_HALT		1	/* Error causing application to halt. */
54 #define	MM_ERROR	2	/* Non-fault fault. */
55 #define	MM_WARNING	3	/* Unusual non-error condition. */
56 #define	MM_INFO		4	/* Informative message. */
57 
58 /* Null options. */
59 #define	MM_NULLLBL	(char *)0
60 #define	MM_NULLSEV	0
61 #define	MM_NULLMC	0L
62 #define	MM_NULLTXT	(char *)0
63 #define	MM_NULLACT	(char *)0
64 #define	MM_NULLTAG	(char *)0
65 
66 /* Return values. */
67 #define	MM_OK		0	/* Success. */
68 #define	MM_NOMSG	1	/* Failed to output to stderr. */
69 #define	MM_NOCON	2	/* Failed to output to console. */
70 #define	MM_NOTOK	3	/* Failed to output anything. */
71 
72 int	fmtmsg(long, const char *, int, const char *, const char *,
73 	    const char *);
74 
75 #endif /* !_FMTMSG_H_ */
76