xref: /freebsd/sys/net80211/ieee80211_power.h (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
1 /*-
2  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following 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 #ifndef _NET80211_IEEE80211_POWER_H_
28 #define _NET80211_IEEE80211_POWER_H_
29 
30 struct ieee80211com;
31 struct ieee80211vap;
32 struct ieee80211_node;
33 struct mbuf;
34 
35 /*
36  * Power save packet queues.  There are two queues, one
37  * for frames coming from the net80211 layer and the other
38  * for frames that come from the driver. Frames from the
39  * driver are expected to have M_ENCAP marked to indicate
40  * they have already been encapsulated and are treated as
41  * higher priority: they are sent first when flushing the
42  * queue on a power save state change or in response to a
43  * ps-poll frame.
44  *
45  * Note that frames sent from the high priority queue are
46  * fed directly to the driver without going through
47  * ieee80211_start again; drivers that send up encap'd
48  * frames are required to handle them when they come back.
49  */
50 struct ieee80211_psq {
51 	ieee80211_psq_lock_t psq_lock;
52 	int	psq_len;
53 	int	psq_maxlen;
54 	int	psq_drops;
55 	struct ieee80211_psq_head {
56 		struct mbuf *head;
57 		struct mbuf *tail;
58 		int len;
59 	} psq_head[2];			/* 2 priorities */
60 };
61 
62 void	ieee80211_psq_init(struct ieee80211_psq *, const char *);
63 void	ieee80211_psq_cleanup(struct ieee80211_psq *);
64 
65 void	ieee80211_power_attach(struct ieee80211com *);
66 void	ieee80211_power_detach(struct ieee80211com *);
67 void	ieee80211_power_vattach(struct ieee80211vap *);
68 void	ieee80211_power_vdetach(struct ieee80211vap *);
69 void	ieee80211_power_latevattach(struct ieee80211vap *);
70 
71 struct mbuf *ieee80211_node_psq_dequeue(struct ieee80211_node *ni, int *qlen);
72 int	ieee80211_node_psq_drain(struct ieee80211_node *);
73 int	ieee80211_node_psq_age(struct ieee80211_node *);
74 
75 /*
76  * Don't call these directly from the stack; they are vap methods
77  * that should be overridden.
78  */
79 int	ieee80211_pwrsave(struct ieee80211_node *, struct mbuf *);
80 void	ieee80211_node_pwrsave(struct ieee80211_node *, int enable);
81 void	ieee80211_sta_pwrsave(struct ieee80211vap *, int enable);
82 void	ieee80211_sta_tim_notify(struct ieee80211vap *vap, int set);
83 void	ieee80211_sta_ps_timer_check(struct ieee80211vap *vap);
84 
85 /* XXX what's this? */
86 void	ieee80211_power_poll(struct ieee80211com *);
87 #endif /* _NET80211_IEEE80211_POWER_H_ */
88