usr.sbin/cpucontrol/cpucontrol.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  * $FreeBSD$
  28  */
  29
  30 #ifndef CPUCONTROL_H
  31 #define CPUCONTROL_H
  32
  33 #include <stddef.h>
  34
  35 typedef int ucode_probe_t(int fd);
  36 struct ucode_update_params {
  37         int devfd;              /* RDWR handle to cpucontrol device */
  38         const void *fwimage;    /* READ mapping of firmware image */
  39         size_t fwsize;          /* Non-zero size of firmware image */
  40         const char *dev_path;   /* cpucontrol device path, for logging */
  41         const char *fw_path;    /* firmware image path, for logging */
  42 };
  43 typedef void ucode_update_t(const struct ucode_update_params *params);
  44
  45 extern int verbosity_level;
  46
  47 #ifdef DEBUG
  48 # define WARNX(level, ...)                                      \
  49         if ((level) <= verbosity_level) {                       \
  50                 fprintf(stderr, "%s:%d ", __FILE__, __LINE__);  \
  51                 warnx(__VA_ARGS__);                             \
  52         }
  53 # define WARN(level, ...)                                       \
  54         if ((level) <= verbosity_level) {                       \
  55                 fprintf(stderr, "%s:%d ", __FILE__, __LINE__);  \
  56                 warn(__VA_ARGS__);                              \
  57         }
  58 #else
  59 # define WARNX(level, ...)                                      \
  60         if ((level) <= verbosity_level)                         \
  61                 warnx(__VA_ARGS__);
  62 # define WARN(level, ...)                                       \
  63         if ((level) <= verbosity_level)                         \
  64                 warn(__VA_ARGS__);
  65 #endif
  66
  67 #endif /* !CPUCONTROL_H */