Home | History | Annotate | Line # | Download | only in linux
timer.h revision 1.15
      1  1.15  riastrad /*	$NetBSD: timer.h,v 1.15 2021/12/19 12:01:57 riastradh Exp $	*/
      2   1.2  riastrad 
      3   1.2  riastrad /*-
      4   1.2  riastrad  * Copyright (c) 2013 The NetBSD Foundation, Inc.
      5   1.2  riastrad  * All rights reserved.
      6   1.2  riastrad  *
      7   1.2  riastrad  * This code is derived from software contributed to The NetBSD Foundation
      8   1.2  riastrad  * by Taylor R. Campbell.
      9   1.2  riastrad  *
     10   1.2  riastrad  * Redistribution and use in source and binary forms, with or without
     11   1.2  riastrad  * modification, are permitted provided that the following conditions
     12   1.2  riastrad  * are met:
     13   1.2  riastrad  * 1. Redistributions of source code must retain the above copyright
     14   1.2  riastrad  *    notice, this list of conditions and the following disclaimer.
     15   1.2  riastrad  * 2. Redistributions in binary form must reproduce the above copyright
     16   1.2  riastrad  *    notice, this list of conditions and the following disclaimer in the
     17   1.2  riastrad  *    documentation and/or other materials provided with the distribution.
     18   1.2  riastrad  *
     19   1.2  riastrad  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20   1.2  riastrad  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21   1.2  riastrad  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22   1.2  riastrad  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23   1.2  riastrad  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24   1.2  riastrad  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25   1.2  riastrad  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26   1.2  riastrad  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27   1.2  riastrad  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28   1.2  riastrad  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29   1.2  riastrad  * POSSIBILITY OF SUCH DAMAGE.
     30   1.2  riastrad  */
     31   1.2  riastrad 
     32   1.2  riastrad #ifndef _LINUX_TIMER_H_
     33   1.2  riastrad #define _LINUX_TIMER_H_
     34   1.2  riastrad 
     35   1.2  riastrad #include <sys/callout.h>
     36   1.2  riastrad 
     37   1.2  riastrad #include <linux/jiffies.h>
     38  1.10  riastrad #include <linux/ktime.h>
     39   1.2  riastrad 
     40   1.2  riastrad struct timer_list {
     41   1.2  riastrad 	struct callout tl_callout;
     42   1.2  riastrad };
     43   1.2  riastrad 
     44   1.8  riastrad #define	from_timer(V, T, F)	container_of(T, __typeof__(*(V)), F)
     45   1.8  riastrad 
     46  1.11  riastrad #define	TIMER_IRQSAFE		__BIT(0)
     47  1.11  riastrad 
     48   1.2  riastrad static inline void
     49   1.8  riastrad timer_setup(struct timer_list *timer, void (*fn)(struct timer_list *),
     50  1.12  riastrad     int flags)
     51   1.2  riastrad {
     52   1.2  riastrad 
     53   1.2  riastrad 	callout_init(&timer->tl_callout, 0);
     54   1.2  riastrad 
     55   1.2  riastrad 	/* XXX Super-sketchy casts!  */
     56   1.7  christos 	callout_setfunc(&timer->tl_callout, (void (*)(void *))(void *)fn,
     57  1.12  riastrad 	    (void *)timer);
     58   1.2  riastrad }
     59   1.2  riastrad 
     60  1.13  riastrad static inline int
     61   1.2  riastrad mod_timer(struct timer_list *timer, unsigned long then)
     62   1.2  riastrad {
     63   1.2  riastrad 	const unsigned long now = jiffies;
     64  1.13  riastrad 	int pending;
     65   1.2  riastrad 
     66  1.13  riastrad 	pending = callout_pending(&timer->tl_callout);
     67   1.2  riastrad 	callout_schedule(&timer->tl_callout, (now < then? (then - now) : 0));
     68  1.13  riastrad 	return pending;
     69   1.2  riastrad }
     70   1.2  riastrad 
     71   1.2  riastrad static inline void
     72   1.4  riastrad mod_timer_pinned(struct timer_list *timer, unsigned long then)
     73   1.4  riastrad {
     74   1.4  riastrad 
     75   1.4  riastrad 	/* XXX Stay on the same CPU it was originally on...  */
     76   1.4  riastrad 	mod_timer(timer, then);
     77   1.4  riastrad }
     78   1.4  riastrad 
     79   1.4  riastrad static inline void
     80   1.5  riastrad del_timer(struct timer_list *timer)
     81   1.5  riastrad {
     82   1.5  riastrad 
     83   1.5  riastrad 	callout_stop(&timer->tl_callout);
     84   1.5  riastrad }
     85   1.5  riastrad 
     86  1.15  riastrad static inline int
     87   1.2  riastrad del_timer_sync(struct timer_list *timer)
     88   1.2  riastrad {
     89   1.3  riastrad 
     90  1.15  riastrad 	/*
     91  1.15  riastrad 	 * Linux: `The function returns whether it has deactivated a
     92  1.15  riastrad 	 * pending timer or not.'
     93  1.15  riastrad 	 *
     94  1.15  riastrad 	 * NetBSD: `[callout_halt] will return a non-zero value if the
     95  1.15  riastrad 	 * callout was EXPIRED.', meaning it is no longer pending.
     96  1.15  riastrad 	 */
     97  1.15  riastrad 	return !callout_halt(&timer->tl_callout, NULL);
     98   1.2  riastrad }
     99   1.2  riastrad 
    100   1.5  riastrad static inline bool
    101   1.5  riastrad timer_pending(struct timer_list *timer)
    102   1.5  riastrad {
    103   1.5  riastrad 
    104   1.5  riastrad 	return callout_pending(&timer->tl_callout);
    105   1.5  riastrad }
    106   1.5  riastrad 
    107   1.2  riastrad /*
    108   1.2  riastrad  * XXX This is bogus -- the Linux version does various machinations to
    109   1.2  riastrad  * give some jitter so that stuff doesn't wake up all at once.
    110   1.2  riastrad  */
    111   1.2  riastrad 
    112   1.2  riastrad static inline unsigned long
    113   1.2  riastrad round_jiffies_up(unsigned long j)
    114   1.2  riastrad {
    115   1.2  riastrad 	return roundup(j, hz);
    116   1.2  riastrad }
    117   1.2  riastrad 
    118   1.2  riastrad static inline unsigned long
    119   1.2  riastrad round_jiffies_up_relative(unsigned long j)
    120   1.2  riastrad {
    121   1.2  riastrad 	return roundup(j, hz);
    122   1.2  riastrad }
    123   1.2  riastrad 
    124   1.2  riastrad #endif  /* _LINUX_TIMER_H_ */
    125