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         HRTIMER_MODE_REL_PINNED = HRTIMER_MODE_REL,
  40 };
  41
  42 enum hrtimer_restart {
  43         HRTIMER_RESTART,
  44         HRTIMER_NORESTART,
  45 };
  46
  47 struct hrtimer {
  48         enum hrtimer_restart (*function)(struct hrtimer *);
  49         struct mtx mtx;
  50         struct callout callout;
  51         s64 expires;    /* relative time in nanoseconds */
  52         s64 precision;  /* in nanoseconds */
  53 };
  54
  55 #define hrtimer_active(hrtimer) linux_hrtimer_active(hrtimer)
  56 #define hrtimer_cancel(hrtimer) linux_hrtimer_cancel(hrtimer)
  57
  58 #define hrtimer_init(hrtimer, clock, mode) do {                 \
  59         CTASSERT((clock) == CLOCK_MONOTONIC);                   \
  60         CTASSERT((mode) == HRTIMER_MODE_REL);                   \
  61         linux_hrtimer_init(hrtimer);                            \
  62 } while (0)
  63
  64 #define hrtimer_set_expires(hrtimer, time)                      \
  65         linux_hrtimer_set_expires(hrtimer, time)
  66
  67 #define hrtimer_start(hrtimer, time, mode) do {                 \
  68         CTASSERT((mode) == HRTIMER_MODE_REL);                   \
  69         linux_hrtimer_start(hrtimer, time);                     \
  70 } while (0)
  71
  72 #define hrtimer_start_range_ns(hrtimer, time, prec, mode) do {  \
  73         CTASSERT((mode) == HRTIMER_MODE_REL);                   \
  74         linux_hrtimer_start_range_ns(hrtimer, time, prec);      \
  75 } while (0)
  76
  77 #define hrtimer_forward_now(hrtimer, interval) do {             \
  78         linux_hrtimer_forward_now(hrtimer, interval);           \
  79 } while (0)
  80
  81 bool    linux_hrtimer_active(struct hrtimer *);
  82 int     linux_hrtimer_cancel(struct hrtimer *);
  83 void    linux_hrtimer_init(struct hrtimer *);
  84 void    linux_hrtimer_set_expires(struct hrtimer *, ktime_t);
  85 void    linux_hrtimer_start(struct hrtimer *, ktime_t);
  86 void    linux_hrtimer_start_range_ns(struct hrtimer *, ktime_t, int64_t);
  87 void    linux_hrtimer_forward_now(struct hrtimer *, ktime_t);
  88
  89 #endif /* _LINUX_HRTIMER_H_ */