Commit | Line | Data |
---|---|---|
8ca151b5 JB |
1 | /****************************************************************************** |
2 | * | |
3 | * This file is provided under a dual BSD/GPLv2 license. When using or | |
4 | * redistributing this file, you may do so under either license. | |
5 | * | |
6 | * GPL LICENSE SUMMARY | |
7 | * | |
8 | * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved. | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of version 2 of the GNU General Public License as | |
12 | * published by the Free Software Foundation. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, but | |
15 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | * General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, | |
22 | * USA | |
23 | * | |
24 | * The full GNU General Public License is included in this distribution | |
410dc5aa | 25 | * in the file called COPYING. |
8ca151b5 JB |
26 | * |
27 | * Contact Information: | |
28 | * Intel Linux Wireless <ilw@linux.intel.com> | |
29 | * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 | |
30 | * | |
31 | * BSD LICENSE | |
32 | * | |
33 | * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved. | |
34 | * All rights reserved. | |
35 | * | |
36 | * Redistribution and use in source and binary forms, with or without | |
37 | * modification, are permitted provided that the following conditions | |
38 | * are met: | |
39 | * | |
40 | * * Redistributions of source code must retain the above copyright | |
41 | * notice, this list of conditions and the following disclaimer. | |
42 | * * Redistributions in binary form must reproduce the above copyright | |
43 | * notice, this list of conditions and the following disclaimer in | |
44 | * the documentation and/or other materials provided with the | |
45 | * distribution. | |
46 | * * Neither the name Intel Corporation nor the names of its | |
47 | * contributors may be used to endorse or promote products derived | |
48 | * from this software without specific prior written permission. | |
49 | * | |
50 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
51 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
52 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
53 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
54 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
55 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
56 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
57 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
58 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
59 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
60 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
61 | * | |
62 | *****************************************************************************/ | |
63 | ||
64 | #ifndef __time_event_h__ | |
65 | #define __time_event_h__ | |
66 | ||
67 | #include "fw-api.h" | |
68 | ||
69 | #include "mvm.h" | |
70 | ||
71 | /** | |
72 | * DOC: Time Events - what is it? | |
73 | * | |
74 | * Time Events are a fw feature that allows the driver to control the presence | |
75 | * of the device on the channel. Since the fw supports multiple channels | |
76 | * concurrently, the fw may choose to jump to another channel at any time. | |
77 | * In order to make sure that the fw is on a specific channel at a certain time | |
78 | * and for a certain duration, the driver needs to issue a time event. | |
79 | * | |
80 | * The simplest example is for BSS association. The driver issues a time event, | |
81 | * waits for it to start, and only then tells mac80211 that we can start the | |
82 | * association. This way, we make sure that the association will be done | |
83 | * smoothly and won't be interrupted by channel switch decided within the fw. | |
84 | */ | |
85 | ||
86 | /** | |
87 | * DOC: The flow against the fw | |
88 | * | |
89 | * When the driver needs to make sure we are in a certain channel, at a certain | |
90 | * time and for a certain duration, it sends a Time Event. The flow against the | |
91 | * fw goes like this: | |
92 | * 1) Driver sends a TIME_EVENT_CMD to the fw | |
93 | * 2) Driver gets the response for that command. This response contains the | |
94 | * Unique ID (UID) of the event. | |
95 | * 3) The fw sends notification when the event starts. | |
96 | * | |
97 | * Of course the API provides various options that allow to cover parameters | |
98 | * of the flow. | |
99 | * What is the duration of the event? | |
100 | * What is the start time of the event? | |
101 | * Is there an end-time for the event? | |
102 | * How much can the event be delayed? | |
103 | * Can the event be split? | |
104 | * If yes what is the maximal number of chunks? | |
105 | * etc... | |
106 | */ | |
107 | ||
108 | /** | |
109 | * DOC: Abstraction to the driver | |
110 | * | |
111 | * In order to simplify the use of time events to the rest of the driver, | |
112 | * we abstract the use of time events. This component provides the functions | |
113 | * needed by the driver. | |
114 | */ | |
115 | ||
116 | #define IWL_MVM_TE_SESSION_PROTECTION_MAX_TIME_MS 500 | |
117 | #define IWL_MVM_TE_SESSION_PROTECTION_MIN_TIME_MS 400 | |
118 | ||
119 | /** | |
120 | * iwl_mvm_protect_session - start / extend the session protection. | |
121 | * @mvm: the mvm component | |
122 | * @vif: the virtual interface for which the session is issued | |
123 | * @duration: the duration of the session in TU. | |
124 | * @min_duration: will start a new session if the current session will end | |
125 | * in less than min_duration. | |
126 | * | |
127 | * This function can be used to start a session protection which means that the | |
128 | * fw will stay on the channel for %duration_ms milliseconds. This function | |
129 | * will block (sleep) until the session starts. This function can also be used | |
130 | * to extend a currently running session. | |
131 | * This function is meant to be used for BSS association for example, where we | |
132 | * want to make sure that the fw stays on the channel during the association. | |
133 | */ | |
134 | void iwl_mvm_protect_session(struct iwl_mvm *mvm, | |
135 | struct ieee80211_vif *vif, | |
136 | u32 duration, u32 min_duration); | |
137 | ||
138 | /** | |
139 | * iwl_mvm_stop_session_protection - cancel the session protection. | |
140 | * @mvm: the mvm component | |
141 | * @vif: the virtual interface for which the session is issued | |
142 | * | |
143 | * This functions cancels the session protection which is an act of good | |
144 | * citizenship. If it is not needed any more it should be cancelled because | |
145 | * the other bindings wait for the medium during that time. | |
146 | * This funtions doesn't sleep. | |
147 | */ | |
148 | void iwl_mvm_stop_session_protection(struct iwl_mvm *mvm, | |
149 | struct ieee80211_vif *vif); | |
150 | ||
151 | /* | |
152 | * iwl_mvm_rx_time_event_notif - handles %TIME_EVENT_NOTIFICATION. | |
153 | */ | |
154 | int iwl_mvm_rx_time_event_notif(struct iwl_mvm *mvm, | |
155 | struct iwl_rx_cmd_buffer *rxb, | |
156 | struct iwl_device_cmd *cmd); | |
157 | ||
158 | /** | |
159 | * iwl_mvm_start_p2p_roc - start remain on channel for p2p device functionlity | |
160 | * @mvm: the mvm component | |
161 | * @vif: the virtual interface for which the roc is requested. It is assumed | |
162 | * that the vif type is NL80211_IFTYPE_P2P_DEVICE | |
163 | * @duration: the requested duration in millisecond for the fw to be on the | |
164 | * channel that is bound to the vif. | |
165 | * | |
166 | * This function can be used to issue a remain on channel session, | |
167 | * which means that the fw will stay in the channel for the request %duration | |
168 | * milliseconds. The function is async, meaning that it only issues the ROC | |
169 | * request but does not wait for it to start. Once the FW is ready to serve the | |
170 | * ROC request, it will issue a notification to the driver that it is on the | |
171 | * requested channel. Once the FW completes the ROC request it will issue | |
172 | * another notification to the driver. | |
173 | */ | |
174 | int iwl_mvm_start_p2p_roc(struct iwl_mvm *mvm, struct ieee80211_vif *vif, | |
175 | int duration); | |
176 | ||
177 | /** | |
178 | * iwl_mvm_stop_p2p_roc - stop remain on channel for p2p device functionlity | |
179 | * @mvm: the mvm component | |
180 | * | |
181 | * This function can be used to cancel an ongoing ROC session. | |
182 | * The function is async, it will instruct the FW to stop serving the ROC | |
183 | * session, but will not wait for the actual stopping of the session. | |
184 | */ | |
185 | void iwl_mvm_stop_p2p_roc(struct iwl_mvm *mvm); | |
186 | ||
187 | /** | |
188 | * iwl_mvm_remove_time_event - general function to clean up of time event | |
189 | * @mvm: the mvm component | |
190 | * @vif: the vif to which the time event belongs | |
191 | * @te_data: the time event data that corresponds to that time event | |
192 | * | |
193 | * This function can be used to cancel a time event regardless its type. | |
194 | * It is useful for cleaning up time events running before removing an | |
195 | * interface. | |
196 | */ | |
197 | void iwl_mvm_remove_time_event(struct iwl_mvm *mvm, | |
198 | struct iwl_mvm_vif *mvmvif, | |
199 | struct iwl_mvm_time_event_data *te_data); | |
200 | ||
201 | /** | |
202 | * iwl_mvm_te_clear_data - remove time event from list | |
203 | * @mvm: the mvm component | |
204 | * @te_data: the time event data to remove | |
205 | * | |
206 | * This function is mostly internal, it is made available here only | |
207 | * for firmware restart purposes. | |
208 | */ | |
209 | void iwl_mvm_te_clear_data(struct iwl_mvm *mvm, | |
210 | struct iwl_mvm_time_event_data *te_data); | |
211 | ||
212 | void iwl_mvm_roc_done_wk(struct work_struct *wk); | |
213 | ||
214 | #endif /* __time_event_h__ */ |