freebsd-skq/usr.sbin/cpucontrol/cpucontrol.h
cem e2f5b08a30 cpucontrol(8): De-duplicate common update logic
Every µcode-updater must open the cpucontrol devfs node RDWR, open a
firmware file, validate the FW file has a positive length, mmap it, etc.
De-duplicate that identical logic between every individual platform.

Also, constify references to the readonly-mapped firmware files while here.

Sponsored by:	Dell EMC Isilon
2018-11-14 00:21:49 +00:00

68 lines
2.4 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2008 Stanislav Sedov <stas@FreeBSD.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef CPUCONTROL_H
#define CPUCONTROL_H
#include <stddef.h>
typedef int ucode_probe_t(int fd);
struct ucode_update_params {
int devfd; /* RDWR handle to cpucontrol device */
const void *fwimage; /* READ mapping of firmware image */
size_t fwsize; /* Non-zero size of firmware image */
const char *dev_path; /* cpucontrol device path, for logging */
const char *fw_path; /* firmware image path, for logging */
};
typedef void ucode_update_t(const struct ucode_update_params *params);
extern int verbosity_level;
#ifdef DEBUG
# define WARNX(level, ...) \
if ((level) <= verbosity_level) { \
fprintf(stderr, "%s:%d ", __FILE__, __LINE__); \
warnx(__VA_ARGS__); \
}
# define WARN(level, ...) \
if ((level) <= verbosity_level) { \
fprintf(stderr, "%s:%d ", __FILE__, __LINE__); \
warn(__VA_ARGS__); \
}
#else
# define WARNX(level, ...) \
if ((level) <= verbosity_level) \
warnx(__VA_ARGS__);
# define WARN(level, ...) \
if ((level) <= verbosity_level) \
warn(__VA_ARGS__);
#endif
#endif /* !CPUCONTROL_H */