1/*********************************************************************
2 *
3 * Filename:      timer.h
4 * Version:
5 * Description:
6 * Status:        Experimental.
7 * Author:        Dag Brattli <dagb@cs.uit.no>
8 * Created at:    Sat Aug 16 00:59:29 1997
9 * Modified at:   Thu Oct  7 12:25:24 1999
10 * Modified by:   Dag Brattli <dagb@cs.uit.no>
11 *
12 *     Copyright (c) 1997, 1998-1999 Dag Brattli <dagb@cs.uit.no>,
13 *     All Rights Reserved.
14 *     Copyright (c) 2000-2002 Jean Tourrilhes <jt@hpl.hp.com>
15 *
16 *     This program is free software; you can redistribute it and/or
17 *     modify it under the terms of the GNU General Public License as
18 *     published by the Free Software Foundation; either version 2 of
19 *     the License, or (at your option) any later version.
20 *
21 *     Neither Dag Brattli nor University of Tromsø admit liability nor
22 *     provide warranty for any of this software. This material is
23 *     provided "AS-IS" and at no charge.
24 *
25 ********************************************************************/
26
27#ifndef TIMER_H
28#define TIMER_H
29
30#include <linux/timer.h>
31#include <linux/jiffies.h>
32
33#include <asm/param.h>  /* for HZ */
34
35#include <net/irda/irda.h>
36
37/* A few forward declarations (to make compiler happy) */
38struct irlmp_cb;
39struct irlap_cb;
40struct lsap_cb;
41struct lap_cb;
42
43/*
44 *  Timeout definitions, some defined in IrLAP 6.13.5 - p. 92
45 */
46#define POLL_TIMEOUT        (450*HZ/1000)    /* Must never exceed 500 ms */
47#define FINAL_TIMEOUT       (500*HZ/1000)    /* Must never exceed 500 ms */
48
49/*
50 *  Normally twice of p-timer. Note 3, IrLAP 6.3.11.2 - p. 60 suggests
51 *  at least twice duration of the P-timer.
52 */
53#define WD_TIMEOUT          (POLL_TIMEOUT*2)
54
55#define MEDIABUSY_TIMEOUT   (500*HZ/1000)    /* 500 msec */
56#define SMALLBUSY_TIMEOUT   (100*HZ/1000)    /* 100 msec - IrLAP 6.13.4 */
57
58/*
59 *  Slot timer must never exceed 85 ms, and must always be at least 25 ms,
60 *  suggested to  75-85 msec by IrDA lite. This doesn't work with a lot of
61 *  devices, and other stackes uses a lot more, so it's best we do it as well
62 *  (Note : this is the default value and sysctl overides it - Jean II)
63 */
64#define SLOT_TIMEOUT            (90*HZ/1000)
65
66/*
67 *  The latest discovery frame (XID) is longer due to the extra discovery
68 *  information (hints, device name...). This is its extra length.
69 *  We use that when setting the query timeout. Jean II
70 */
71#define XIDEXTRA_TIMEOUT        (34*HZ/1000)  /* 34 msec */
72
73#define WATCHDOG_TIMEOUT        (20*HZ)       /* 20 sec */
74
75typedef void (*TIMER_CALLBACK)(void *);
76
77static inline void irda_start_timer(struct timer_list *ptimer, int timeout,
78				    void* data, TIMER_CALLBACK callback)
79{
80	ptimer->function = (void (*)(unsigned long)) callback;
81	ptimer->data = (unsigned long) data;
82
83	/* Set new value for timer (update or add timer).
84	 * We use mod_timer() because it's more efficient and also
85	 * safer with respect to race conditions - Jean II */
86	mod_timer(ptimer, jiffies + timeout);
87}
88
89
90void irlap_start_slot_timer(struct irlap_cb *self, int timeout);
91void irlap_start_query_timer(struct irlap_cb *self, int S, int s);
92void irlap_start_final_timer(struct irlap_cb *self, int timeout);
93void irlap_start_wd_timer(struct irlap_cb *self, int timeout);
94void irlap_start_backoff_timer(struct irlap_cb *self, int timeout);
95
96void irlap_start_mbusy_timer(struct irlap_cb *self, int timeout);
97void irlap_stop_mbusy_timer(struct irlap_cb *);
98
99void irlmp_start_watchdog_timer(struct lsap_cb *, int timeout);
100void irlmp_start_discovery_timer(struct irlmp_cb *, int timeout);
101void irlmp_start_idle_timer(struct lap_cb *, int timeout);
102void irlmp_stop_idle_timer(struct lap_cb *self);
103
104#endif
105
106