xref: /freebsd/usr.sbin/cpucontrol/cpucontrol.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2008 Stanislav Sedov <stas@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 ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef CPUCONTROL_H
29 #define	CPUCONTROL_H
30 
31 #include <stddef.h>
32 
33 typedef int ucode_probe_t(int fd);
34 struct ucode_update_params {
35 	int devfd;		/* RDWR handle to cpucontrol device */
36 	const void *fwimage;	/* READ mapping of firmware image */
37 	size_t fwsize;		/* Non-zero size of firmware image */
38 	const char *dev_path;	/* cpucontrol device path, for logging */
39 	const char *fw_path;	/* firmware image path, for logging */
40 };
41 typedef void ucode_update_t(const struct ucode_update_params *params);
42 
43 extern int verbosity_level;
44 
45 #ifdef DEBUG
46 # define WARNX(level, ...)					\
47 	if ((level) <= verbosity_level) {			\
48 		fprintf(stderr, "%s:%d ", __FILE__, __LINE__);	\
49 		warnx(__VA_ARGS__);				\
50 	}
51 # define WARN(level, ...)					\
52 	if ((level) <= verbosity_level) {			\
53 		fprintf(stderr, "%s:%d ", __FILE__, __LINE__);	\
54 		warn(__VA_ARGS__);				\
55 	}
56 #else
57 # define WARNX(level, ...)					\
58 	if ((level) <= verbosity_level)				\
59 		warnx(__VA_ARGS__);
60 # define WARN(level, ...)					\
61 	if ((level) <= verbosity_level)				\
62 		warn(__VA_ARGS__);
63 #endif
64 
65 #endif /* !CPUCONTROL_H */
66