xref: /freebsd/sys/net80211/ieee80211_power.h (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 #ifndef _NET80211_IEEE80211_POWER_H_
30 #define _NET80211_IEEE80211_POWER_H_
31 
32 struct ieee80211com;
33 struct ieee80211vap;
34 struct ieee80211_node;
35 struct mbuf;
36 
37 /*
38  * Power save packet queues.  There are two queues, one
39  * for frames coming from the net80211 layer and the other
40  * for frames that come from the driver. Frames from the
41  * driver are expected to have M_ENCAP marked to indicate
42  * they have already been encapsulated and are treated as
43  * higher priority: they are sent first when flushing the
44  * queue on a power save state change or in response to a
45  * ps-poll frame.
46  *
47  * Note that frames sent from the high priority queue are
48  * fed directly to the driver without going through
49  * ieee80211_start again; drivers that send up encap'd
50  * frames are required to handle them when they come back.
51  */
52 struct ieee80211_psq {
53 	ieee80211_psq_lock_t psq_lock;
54 	int	psq_len;
55 	int	psq_maxlen;
56 	int	psq_drops;
57 	struct ieee80211_psq_head {
58 		struct mbuf *head;
59 		struct mbuf *tail;
60 		int len;
61 	} psq_head[2];			/* 2 priorities */
62 };
63 
64 void	ieee80211_psq_init(struct ieee80211_psq *, const char *);
65 void	ieee80211_psq_cleanup(struct ieee80211_psq *);
66 
67 void	ieee80211_power_attach(struct ieee80211com *);
68 void	ieee80211_power_detach(struct ieee80211com *);
69 void	ieee80211_power_vattach(struct ieee80211vap *);
70 void	ieee80211_power_vdetach(struct ieee80211vap *);
71 void	ieee80211_power_latevattach(struct ieee80211vap *);
72 
73 struct mbuf *ieee80211_node_psq_dequeue(struct ieee80211_node *ni, int *qlen);
74 int	ieee80211_node_psq_drain(struct ieee80211_node *);
75 int	ieee80211_node_psq_age(struct ieee80211_node *);
76 
77 /*
78  * Don't call these directly from the stack; they are vap methods
79  * that should be overridden.
80  */
81 int	ieee80211_pwrsave(struct ieee80211_node *, struct mbuf *);
82 void	ieee80211_node_pwrsave(struct ieee80211_node *, int enable);
83 void	ieee80211_sta_pwrsave(struct ieee80211vap *, int enable);
84 void	ieee80211_sta_tim_notify(struct ieee80211vap *vap, int set);
85 void	ieee80211_sta_ps_timer_check(struct ieee80211vap *vap);
86 
87 /* XXX what's this? */
88 void	ieee80211_power_poll(struct ieee80211com *);
89 #endif /* _NET80211_IEEE80211_POWER_H_ */
90