Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
iwl-op-mode.h
Go to the documentation of this file.
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) 2007 - 2012 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
25  * in the file called LICENSE.GPL.
26  *
27  * Contact Information:
28  * Intel Linux Wireless <[email protected]>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2005 - 2012 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 #ifndef __iwl_op_mode_h__
64 #define __iwl_op_mode_h__
65 
66 struct iwl_op_mode;
67 struct iwl_trans;
68 struct sk_buff;
69 struct iwl_device_cmd;
70 struct iwl_rx_cmd_buffer;
71 struct iwl_fw;
72 struct iwl_cfg;
73 
135  struct iwl_op_mode *(*start)(struct iwl_trans *trans,
136  const struct iwl_cfg *cfg,
137  const struct iwl_fw *fw,
138  struct dentry *dbgfs_dir);
139  void (*stop)(struct iwl_op_mode *op_mode);
140  int (*rx)(struct iwl_op_mode *op_mode, struct iwl_rx_cmd_buffer *rxb,
141  struct iwl_device_cmd *cmd);
142  void (*queue_full)(struct iwl_op_mode *op_mode, int queue);
143  void (*queue_not_full)(struct iwl_op_mode *op_mode, int queue);
144  void (*hw_rf_kill)(struct iwl_op_mode *op_mode, bool state);
145  void (*free_skb)(struct iwl_op_mode *op_mode, struct sk_buff *skb);
146  void (*nic_error)(struct iwl_op_mode *op_mode);
147  void (*cmd_queue_full)(struct iwl_op_mode *op_mode);
148  void (*nic_config)(struct iwl_op_mode *op_mode);
149  void (*wimax_active)(struct iwl_op_mode *op_mode);
150 };
151 
152 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops);
153 void iwl_opmode_deregister(const char *name);
154 
162 struct iwl_op_mode {
163  const struct iwl_op_mode_ops *ops;
164  const struct iwl_trans *trans;
165 
166  char op_mode_specific[0] __aligned(sizeof(void *));
167 };
168 
169 static inline void iwl_op_mode_stop(struct iwl_op_mode *op_mode)
170 {
171  might_sleep();
172  op_mode->ops->stop(op_mode);
173 }
174 
175 static inline int iwl_op_mode_rx(struct iwl_op_mode *op_mode,
176  struct iwl_rx_cmd_buffer *rxb,
177  struct iwl_device_cmd *cmd)
178 {
179  return op_mode->ops->rx(op_mode, rxb, cmd);
180 }
181 
182 static inline void iwl_op_mode_queue_full(struct iwl_op_mode *op_mode,
183  int queue)
184 {
185  op_mode->ops->queue_full(op_mode, queue);
186 }
187 
188 static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode *op_mode,
189  int queue)
190 {
191  op_mode->ops->queue_not_full(op_mode, queue);
192 }
193 
194 static inline void iwl_op_mode_hw_rf_kill(struct iwl_op_mode *op_mode,
195  bool state)
196 {
197  op_mode->ops->hw_rf_kill(op_mode, state);
198 }
199 
200 static inline void iwl_op_mode_free_skb(struct iwl_op_mode *op_mode,
201  struct sk_buff *skb)
202 {
203  op_mode->ops->free_skb(op_mode, skb);
204 }
205 
206 static inline void iwl_op_mode_nic_error(struct iwl_op_mode *op_mode)
207 {
208  op_mode->ops->nic_error(op_mode);
209 }
210 
211 static inline void iwl_op_mode_cmd_queue_full(struct iwl_op_mode *op_mode)
212 {
213  op_mode->ops->cmd_queue_full(op_mode);
214 }
215 
216 static inline void iwl_op_mode_nic_config(struct iwl_op_mode *op_mode)
217 {
218  might_sleep();
219  op_mode->ops->nic_config(op_mode);
220 }
221 
222 static inline void iwl_op_mode_wimax_active(struct iwl_op_mode *op_mode)
223 {
224  op_mode->ops->wimax_active(op_mode);
225 }
226 
227 #endif /* __iwl_op_mode_h__ */