sys/compat/linuxkpi/common/include/linux/hrtimer.h

   1 /*-
   2  * Copyright (c) 2017 Mark Johnston <markj@FreeBSD.org>
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice unmodified, this list of conditions, and the following
   9  *    disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * $FreeBSD$
  26  */
  27
  28 #ifndef _LINUX_HRTIMER_H_
  29 #define _LINUX_HRTIMER_H_
  30
  31 #include <sys/_callout.h>
  32 #include <sys/_mutex.h>
  33
  34 #include <linux/ktime.h>
  35 #include <linux/timer.h>
  36
  37 enum hrtimer_mode {
  38         HRTIMER_MODE_REL,
  39 };
  40
  41 enum hrtimer_restart {
  42         HRTIMER_RESTART,
  43         HRTIMER_NORESTART,
  44 };
  45
  46 struct hrtimer {
  47         enum hrtimer_restart (*function)(struct hrtimer *);
  48         struct mtx mtx;
  49         struct callout callout;
  50 };
  51
  52 #define hrtimer_active(hrtimer) linux_hrtimer_active(hrtimer)
  53 #define hrtimer_cancel(hrtimer) linux_hrtimer_cancel(hrtimer)
  54 #define hrtimer_init(hrtimer, clock, mode) do {                 \
  55         CTASSERT((clock) == CLOCK_MONOTONIC);                   \
  56         CTASSERT((mode) == HRTIMER_MODE_REL);                   \
  57         linux_hrtimer_init(hrtimer);                            \
  58 } while (0)
  59 #define hrtimer_set_expires(hrtimer, time)                      \
  60         linux_hrtimer_set_expires(hrtimer, time)
  61 #define hrtimer_start(hrtimer, time, mode) do {                 \
  62         CTASSERT((mode) == HRTIMER_MODE_REL);                   \
  63         linux_hrtimer_start(hrtimer, time);                     \
  64 } while (0)
  65 #define hrtimer_start_range_ns(hrtimer, time, prec, mode) do {  \
  66         CTASSERT((mode) == HRTIMER_MODE_REL);                   \
  67         linux_hrtimer_start_range_ns(hrtimer, time, prec);      \
  68 } while (0)
  69
  70 bool    linux_hrtimer_active(struct hrtimer *);
  71 int     linux_hrtimer_cancel(struct hrtimer *);
  72 void    linux_hrtimer_init(struct hrtimer *);
  73 void    linux_hrtimer_set_expires(struct hrtimer *, ktime_t);
  74 void    linux_hrtimer_start(struct hrtimer *, ktime_t);
  75 void    linux_hrtimer_start_range_ns(struct hrtimer *, ktime_t, int64_t);
  76
  77 #endif /* _LINUX_HRTIMER_H_ */