1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
63 #ifndef __iwl_op_mode_h__
64 #define __iwl_op_mode_h__
69 struct iwl_device_cmd
;
70 struct iwl_rx_cmd_buffer
;
75 * DOC: Operational mode - what is it ?
77 * The operational mode (a.k.a. op_mode) is the layer that implements
78 * mac80211's handlers. It knows two APIs: mac80211's and the fw's. It uses
79 * the transport API to access the HW. The op_mode doesn't need to know how the
80 * underlying HW works, since the transport layer takes care of that.
82 * There can be several op_mode: i.e. different fw APIs will require two
83 * different op_modes. This is why the op_mode is virtualized.
87 * DOC: Life cycle of the Operational mode
89 * The operational mode has a very simple life cycle.
91 * 1) The driver layer (iwl-drv.c) chooses the op_mode based on the
92 * capabilities advertized by the fw file (in TLV format).
93 * 2) The driver layer starts the op_mode (ops->start)
94 * 3) The op_mode registers registers mac80211
95 * 4) The op_mode is governed by mac80211
96 * 5) The driver layer stops the op_mode
100 * struct iwl_op_mode_ops - op_mode specific operations
102 * The op_mode exports its ops so that external components can start it and
103 * interact with it. The driver layer typically calls the start and stop
104 * handlers, the transport layer calls the others.
106 * All the handlers MUST be implemented
108 * @start: start the op_mode. The transport layer is already allocated.
110 * @stop: stop the op_mode. Must free all the memory allocated.
112 * @rx: Rx notification to the op_mode. rxb is the Rx buffer itself. Cmd is the
113 * HCMD the this Rx responds to.
114 * Must be atomic and called with BH disabled.
115 * @queue_full: notifies that a HW queue is full.
116 * Must be atomic and called with BH disabled.
117 * @queue_not_full: notifies that a HW queue is not full any more.
118 * Must be atomic and called with BH disabled.
119 * @hw_rf_kill:notifies of a change in the HW rf kill switch. True means that
120 * the radio is killed. Must be atomic.
121 * @free_skb: allows the transport layer to free skbs that haven't been
122 * reclaimed by the op_mode. This can happen when the driver is freed and
123 * there are Tx packets pending in the transport layer.
125 * @nic_error: error notification. Must be atomic and must be called with BH
127 * @cmd_queue_full: Called when the command queue gets full. Must be atomic and
128 * called with BH disabled.
129 * @nic_config: configure NIC, called before firmware is started.
131 * @wimax_active: invoked when WiMax becomes active. Must be atomic and called
134 struct iwl_op_mode_ops
{
135 struct iwl_op_mode
*(*start
)(struct iwl_trans
*trans
,
136 const struct iwl_cfg
*cfg
,
137 const struct iwl_fw
*fw
);
138 void (*stop
)(struct iwl_op_mode
*op_mode
);
139 int (*rx
)(struct iwl_op_mode
*op_mode
, struct iwl_rx_cmd_buffer
*rxb
,
140 struct iwl_device_cmd
*cmd
);
141 void (*queue_full
)(struct iwl_op_mode
*op_mode
, int queue
);
142 void (*queue_not_full
)(struct iwl_op_mode
*op_mode
, int queue
);
143 void (*hw_rf_kill
)(struct iwl_op_mode
*op_mode
, bool state
);
144 void (*free_skb
)(struct iwl_op_mode
*op_mode
, struct sk_buff
*skb
);
145 void (*nic_error
)(struct iwl_op_mode
*op_mode
);
146 void (*cmd_queue_full
)(struct iwl_op_mode
*op_mode
);
147 void (*nic_config
)(struct iwl_op_mode
*op_mode
);
148 void (*wimax_active
)(struct iwl_op_mode
*op_mode
);
151 int iwl_opmode_register(const char *name
, const struct iwl_op_mode_ops
*ops
);
152 void iwl_opmode_deregister(const char *name
);
155 * struct iwl_op_mode - operational mode
157 * This holds an implementation of the mac80211 / fw API.
159 * @ops - pointer to its own ops
162 const struct iwl_op_mode_ops
*ops
;
163 const struct iwl_trans
*trans
;
165 char op_mode_specific
[0] __aligned(sizeof(void *));
168 static inline void iwl_op_mode_stop(struct iwl_op_mode
*op_mode
)
171 op_mode
->ops
->stop(op_mode
);
174 static inline int iwl_op_mode_rx(struct iwl_op_mode
*op_mode
,
175 struct iwl_rx_cmd_buffer
*rxb
,
176 struct iwl_device_cmd
*cmd
)
178 return op_mode
->ops
->rx(op_mode
, rxb
, cmd
);
181 static inline void iwl_op_mode_queue_full(struct iwl_op_mode
*op_mode
,
184 op_mode
->ops
->queue_full(op_mode
, queue
);
187 static inline void iwl_op_mode_queue_not_full(struct iwl_op_mode
*op_mode
,
190 op_mode
->ops
->queue_not_full(op_mode
, queue
);
193 static inline void iwl_op_mode_hw_rf_kill(struct iwl_op_mode
*op_mode
,
196 op_mode
->ops
->hw_rf_kill(op_mode
, state
);
199 static inline void iwl_op_mode_free_skb(struct iwl_op_mode
*op_mode
,
202 op_mode
->ops
->free_skb(op_mode
, skb
);
205 static inline void iwl_op_mode_nic_error(struct iwl_op_mode
*op_mode
)
207 op_mode
->ops
->nic_error(op_mode
);
210 static inline void iwl_op_mode_cmd_queue_full(struct iwl_op_mode
*op_mode
)
212 op_mode
->ops
->cmd_queue_full(op_mode
);
215 static inline void iwl_op_mode_nic_config(struct iwl_op_mode
*op_mode
)
218 op_mode
->ops
->nic_config(op_mode
);
221 static inline void iwl_op_mode_wimax_active(struct iwl_op_mode
*op_mode
)
223 op_mode
->ops
->wimax_active(op_mode
);
226 #endif /* __iwl_op_mode_h__ */
This page took 0.060956 seconds and 5 git commands to generate.