Commit | Line | Data |
---|---|---|
d0f76d68 EG |
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 <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) 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; | |
ed277c93 | 68 | struct sk_buff; |
db70f290 EG |
69 | struct iwl_device_cmd; |
70 | struct iwl_rx_mem_buffer; | |
d0f76d68 EG |
71 | |
72 | /** | |
73 | * struct iwl_op_mode_ops - op_mode specific operations | |
74 | * | |
75 | * All the handlers MUST be implemented | |
76 | * | |
77 | * @start: start the op_mode | |
78 | * May sleep | |
79 | * @stop: stop the op_mode | |
80 | * May sleep | |
db70f290 EG |
81 | * @rx: Rx notification to the op_mode. rxb is the Rx buffer itself. Cmd is the |
82 | * HCMD the this Rx responds to. | |
02e38358 EG |
83 | * @queue_full: notifies that a HW queue is full. Ac is the ac of the queue |
84 | * Must be atomic | |
85 | * @queue_not_full: notifies that a HW queue is not full any more. | |
86 | * Ac is the ac of the queue. Must be atomic | |
7120d989 EG |
87 | * @hw_rf_kill:notifies of a change in the HW rf kill switch. True means that |
88 | * the radio is killed. Must be atomic. | |
ed277c93 EG |
89 | * @free_skb: allows the transport layer to free skbs that haven't been |
90 | * reclaimed by the op_mode. This can happen when the driver is freed and | |
91 | * there are Tx packets pending in the transport layer. | |
92 | * Must be atomic | |
d0f76d68 EG |
93 | */ |
94 | struct iwl_op_mode_ops { | |
95 | struct iwl_op_mode *(*start)(struct iwl_trans *trans); | |
96 | void (*stop)(struct iwl_op_mode *op_mode); | |
db70f290 EG |
97 | int (*rx)(struct iwl_op_mode *op_mode, struct iwl_rx_mem_buffer *rxb, |
98 | struct iwl_device_cmd *cmd); | |
02e38358 EG |
99 | void (*queue_full)(struct iwl_op_mode *op_mode, u8 ac); |
100 | void (*queue_not_full)(struct iwl_op_mode *op_mode, u8 ac); | |
7120d989 | 101 | void (*hw_rf_kill)(struct iwl_op_mode *op_mode, bool state); |
ed277c93 | 102 | void (*free_skb)(struct iwl_op_mode *op_mode, struct sk_buff *skb); |
d0f76d68 EG |
103 | }; |
104 | ||
105 | /** | |
106 | * struct iwl_op_mode - operational mode | |
107 | * | |
108 | * This holds an implementation of the mac80211 / fw API. | |
109 | * | |
110 | * @ops - pointer to its own ops | |
111 | */ | |
112 | struct iwl_op_mode { | |
113 | const struct iwl_op_mode_ops *ops; | |
114 | const struct iwl_trans *trans; | |
115 | ||
116 | char op_mode_specific[0] __aligned(sizeof(void *)); | |
117 | }; | |
118 | ||
119 | static inline void iwl_op_mode_stop(struct iwl_op_mode *op_mode) | |
120 | { | |
121 | op_mode->ops->stop(op_mode); | |
122 | } | |
123 | ||
db70f290 EG |
124 | static inline int iwl_op_mode_rx(struct iwl_op_mode *op_mode, |
125 | struct iwl_rx_mem_buffer *rxb, | |
126 | struct iwl_device_cmd *cmd) | |
127 | { | |
128 | return op_mode->ops->rx(op_mode, rxb, cmd); | |
129 | } | |
130 | ||
02e38358 EG |
131 | static inline void iwl_op_mode_queue_full(struct iwl_op_mode *op_mode, u8 ac) |
132 | { | |
133 | op_mode->ops->queue_full(op_mode, ac); | |
134 | } | |
135 | ||
136 | static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode *op_mode, | |
137 | u8 ac) | |
138 | { | |
139 | op_mode->ops->queue_not_full(op_mode, ac); | |
140 | } | |
141 | ||
7120d989 EG |
142 | static inline void iwl_op_mode_hw_rf_kill(struct iwl_op_mode *op_mode, |
143 | bool state) | |
144 | { | |
145 | op_mode->ops->hw_rf_kill(op_mode, state); | |
146 | } | |
147 | ||
ed277c93 EG |
148 | static inline void iwl_op_mode_free_skb(struct iwl_op_mode *op_mode, |
149 | struct sk_buff *skb) | |
150 | { | |
151 | op_mode->ops->free_skb(op_mode, skb); | |
152 | } | |
153 | ||
d0f76d68 EG |
154 | /***************************************************** |
155 | * Op mode layers implementations | |
156 | ******************************************************/ | |
157 | extern const struct iwl_op_mode_ops iwl_dvm_ops; | |
158 | ||
159 | #endif /* __iwl_op_mode_h__ */ |