[retry] Use a separate flag to indicate that a retry timer is running
[people/mcb30/gpxe.git] / src / include / gpxe / retry.h
1 #ifndef _GPXE_RETRY_H
2 #define _GPXE_RETRY_H
3
4 /** @file
5  *
6  * Retry timers
7  *
8  */
9
10 #include <gpxe/list.h>
11
12 /** Default timeout value */
13 #define DEFAULT_MIN_TIMEOUT ( TICKS_PER_SEC / 4 )
14
15 /** Limit after which the timeout will be deemed permanent */
16 #define DEFAULT_MAX_TIMEOUT ( 10 * TICKS_PER_SEC )
17
18 /** A retry timer */
19 struct retry_timer {
20         /** List of active timers */
21         struct list_head list;
22         /** Timer is currently running */
23         unsigned int running;
24         /** Timeout value (in ticks) */
25         unsigned long timeout;
26         /** Minimum timeout value (in ticks)
27          *
28          * A value of zero means "use default timeout."
29          */
30         unsigned long min_timeout;
31         /** Maximum timeout value before failure (in ticks)
32          *
33          * A value of zero means "use default timeout."
34          */
35         unsigned long max_timeout;
36         /** Start time (in ticks) */
37         unsigned long start;
38         /** Retry count */
39         unsigned int count;
40         /** Timer expired callback
41          *
42          * @v timer     Retry timer
43          * @v fail      Failure indicator
44          *
45          * The timer will already be stopped when this method is
46          * called.  The failure indicator will be True if the retry
47          * timeout has already exceeded @c MAX_TIMEOUT.
48          */
49         void ( * expired ) ( struct retry_timer *timer, int over );
50 };
51
52 extern void start_timer ( struct retry_timer *timer );
53 extern void start_timer_fixed ( struct retry_timer *timer,
54                                 unsigned long timeout );
55 extern void stop_timer ( struct retry_timer *timer );
56
57 /**
58  * Start timer with no delay
59  *
60  * @v timer             Retry timer
61  *
62  * This starts the timer running with a zero timeout value.
63  */
64 static inline void start_timer_nodelay ( struct retry_timer *timer ) {
65         start_timer_fixed ( timer, 0 );
66 }
67
68 /**
69  * Test to see if timer is currently running
70  *
71  * @v timer             Retry timer
72  * @ret running         Non-zero if timer is running
73  */
74 static inline __attribute__ (( always_inline )) unsigned long
75 timer_running ( struct retry_timer *timer ) {
76         return ( timer->running );
77 }
78
79 #endif /* _GPXE_RETRY_H */