Commit | Line | Data |
---|---|---|
cf4328cd ID |
1 | #ifndef __RFKILL_H |
2 | #define __RFKILL_H | |
3 | ||
4 | /* | |
fe242cfd | 5 | * Copyright (C) 2006 - 2007 Ivo van Doorn |
cf4328cd | 6 | * Copyright (C) 2007 Dmitry Torokhov |
19d337df | 7 | * Copyright 2009 Johannes Berg <johannes@sipsolutions.net> |
cf4328cd ID |
8 | * |
9 | * This program is free software; you can redistribute it and/or modify | |
10 | * it under the terms of the GNU General Public License as published by | |
11 | * the Free Software Foundation; either version 2 of the License, or | |
12 | * (at your option) any later version. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, | |
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | * GNU 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 | |
21 | * Free Software Foundation, Inc., | |
22 | * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
23 | */ | |
24 | ||
c64fb016 | 25 | #include <linux/types.h> |
19d337df JB |
26 | |
27 | /* define userspace visible states */ | |
28 | #define RFKILL_STATE_SOFT_BLOCKED 0 | |
29 | #define RFKILL_STATE_UNBLOCKED 1 | |
30 | #define RFKILL_STATE_HARD_BLOCKED 2 | |
31 | ||
cf4328cd ID |
32 | /** |
33 | * enum rfkill_type - type of rfkill switch. | |
19d337df | 34 | * |
c64fb016 | 35 | * @RFKILL_TYPE_ALL: toggles all switches (userspace only) |
19d337df JB |
36 | * @RFKILL_TYPE_WLAN: switch is on a 802.11 wireless network device. |
37 | * @RFKILL_TYPE_BLUETOOTH: switch is on a bluetooth device. | |
38 | * @RFKILL_TYPE_UWB: switch is on a ultra wideband device. | |
39 | * @RFKILL_TYPE_WIMAX: switch is on a WiMAX device. | |
40 | * @RFKILL_TYPE_WWAN: switch is on a wireless WAN device. | |
41 | * @NUM_RFKILL_TYPES: number of defined rfkill types | |
cf4328cd ID |
42 | */ |
43 | enum rfkill_type { | |
c64fb016 | 44 | RFKILL_TYPE_ALL = 0, |
19d337df | 45 | RFKILL_TYPE_WLAN, |
234a0ca6 | 46 | RFKILL_TYPE_BLUETOOTH, |
e0665486 | 47 | RFKILL_TYPE_UWB, |
303d9bf6 | 48 | RFKILL_TYPE_WIMAX, |
477576a0 | 49 | RFKILL_TYPE_WWAN, |
19d337df | 50 | NUM_RFKILL_TYPES, |
cf4328cd ID |
51 | }; |
52 | ||
c64fb016 JB |
53 | /** |
54 | * enum rfkill_operation - operation types | |
55 | * @RFKILL_OP_ADD: a device was added | |
56 | * @RFKILL_OP_DEL: a device was removed | |
57 | * @RFKILL_OP_CHANGE: a device's state changed -- userspace changes one device | |
58 | * @RFKILL_OP_CHANGE_ALL: userspace changes all devices (of a type, or all) | |
59 | */ | |
60 | enum rfkill_operation { | |
61 | RFKILL_OP_ADD = 0, | |
62 | RFKILL_OP_DEL, | |
63 | RFKILL_OP_CHANGE, | |
64 | RFKILL_OP_CHANGE_ALL, | |
65 | }; | |
66 | ||
67 | /** | |
68 | * struct rfkill_event - events for userspace on /dev/rfkill | |
69 | * @idx: index of dev rfkill | |
70 | * @type: type of the rfkill struct | |
71 | * @op: operation code | |
72 | * @hard: hard state (0/1) | |
73 | * @soft: soft state (0/1) | |
74 | * | |
75 | * Structure used for userspace communication on /dev/rfkill, | |
76 | * used for events from the kernel and control to the kernel. | |
77 | */ | |
78 | struct rfkill_event { | |
79 | __u32 idx; | |
80 | __u8 type; | |
81 | __u8 op; | |
82 | __u8 soft, hard; | |
83 | } __packed; | |
84 | ||
85 | /* ioctl for turning off rfkill-input (if present) */ | |
86 | #define RFKILL_IOC_MAGIC 'R' | |
87 | #define RFKILL_IOC_NOINPUT 1 | |
88 | #define RFKILL_IOCTL_NOINPUT _IO(RFKILL_IOC_MAGIC, RFKILL_IOC_NOINPUT) | |
89 | ||
90 | /* and that's all userspace gets */ | |
91 | #ifdef __KERNEL__ | |
92 | /* don't allow anyone to use these in the kernel */ | |
93 | enum rfkill_user_states { | |
94 | RFKILL_USER_STATE_SOFT_BLOCKED = RFKILL_STATE_SOFT_BLOCKED, | |
95 | RFKILL_USER_STATE_UNBLOCKED = RFKILL_STATE_UNBLOCKED, | |
96 | RFKILL_USER_STATE_HARD_BLOCKED = RFKILL_STATE_HARD_BLOCKED, | |
97 | }; | |
98 | #undef RFKILL_STATE_SOFT_BLOCKED | |
99 | #undef RFKILL_STATE_UNBLOCKED | |
100 | #undef RFKILL_STATE_HARD_BLOCKED | |
101 | ||
102 | #include <linux/types.h> | |
103 | #include <linux/kernel.h> | |
104 | #include <linux/list.h> | |
105 | #include <linux/mutex.h> | |
106 | #include <linux/device.h> | |
107 | #include <linux/leds.h> | |
1506e30b | 108 | #include <linux/err.h> |
c64fb016 | 109 | |
19d337df JB |
110 | /* this is opaque */ |
111 | struct rfkill; | |
112 | ||
113 | /** | |
114 | * struct rfkill_ops - rfkill driver methods | |
115 | * | |
116 | * @poll: poll the rfkill block state(s) -- only assign this method | |
117 | * when you need polling. When called, simply call one of the | |
118 | * rfkill_set{,_hw,_sw}_state family of functions. If the hw | |
119 | * is getting unblocked you need to take into account the return | |
120 | * value of those functions to make sure the software block is | |
121 | * properly used. | |
122 | * @query: query the rfkill block state(s) and call exactly one of the | |
123 | * rfkill_set{,_hw,_sw}_state family of functions. Assign this | |
124 | * method if input events can cause hardware state changes to make | |
125 | * the rfkill core query your driver before setting a requested | |
126 | * block. | |
127 | * @set_block: turn the transmitter on (blocked == false) or off | |
c64fb016 | 128 | * (blocked == true) -- ignore and return 0 when hard blocked. |
19d337df JB |
129 | * This callback must be assigned. |
130 | */ | |
131 | struct rfkill_ops { | |
132 | void (*poll)(struct rfkill *rfkill, void *data); | |
133 | void (*query)(struct rfkill *rfkill, void *data); | |
134 | int (*set_block)(void *data, bool blocked); | |
cf4328cd ID |
135 | }; |
136 | ||
19d337df | 137 | #if defined(CONFIG_RFKILL) || defined(CONFIG_RFKILL_MODULE) |
cf4328cd | 138 | /** |
19d337df JB |
139 | * rfkill_alloc - allocate rfkill structure |
140 | * @name: name of the struct -- the string is not copied internally | |
141 | * @parent: device that has rf switch on it | |
142 | * @type: type of the switch (RFKILL_TYPE_*) | |
143 | * @ops: rfkill methods | |
144 | * @ops_data: data passed to each method | |
145 | * | |
146 | * This function should be called by the transmitter driver to allocate an | |
147 | * rfkill structure. Returns %NULL on failure. | |
cf4328cd | 148 | */ |
19d337df JB |
149 | struct rfkill * __must_check rfkill_alloc(const char *name, |
150 | struct device *parent, | |
151 | const enum rfkill_type type, | |
152 | const struct rfkill_ops *ops, | |
153 | void *ops_data); | |
cf4328cd | 154 | |
19d337df JB |
155 | /** |
156 | * rfkill_register - Register a rfkill structure. | |
157 | * @rfkill: rfkill structure to be registered | |
158 | * | |
159 | * This function should be called by the transmitter driver to register | |
b3fa1329 AJ |
160 | * the rfkill structure. Before calling this function the driver needs |
161 | * to be ready to service method calls from rfkill. | |
162 | * | |
06d5caf4 AJ |
163 | * If rfkill_init_sw_state() is not called before registration, |
164 | * set_block() will be called to initialize the software blocked state | |
165 | * to a default value. | |
b3fa1329 AJ |
166 | * |
167 | * If the hardware blocked state is not set before registration, | |
168 | * it is assumed to be unblocked. | |
19d337df JB |
169 | */ |
170 | int __must_check rfkill_register(struct rfkill *rfkill); | |
135900c1 | 171 | |
19d337df JB |
172 | /** |
173 | * rfkill_pause_polling(struct rfkill *rfkill) | |
174 | * | |
175 | * Pause polling -- say transmitter is off for other reasons. | |
176 | * NOTE: not necessary for suspend/resume -- in that case the | |
177 | * core stops polling anyway | |
178 | */ | |
179 | void rfkill_pause_polling(struct rfkill *rfkill); | |
cf4328cd | 180 | |
19d337df JB |
181 | /** |
182 | * rfkill_resume_polling(struct rfkill *rfkill) | |
183 | * | |
184 | * Pause polling -- say transmitter is off for other reasons. | |
185 | * NOTE: not necessary for suspend/resume -- in that case the | |
186 | * core stops polling anyway | |
187 | */ | |
188 | void rfkill_resume_polling(struct rfkill *rfkill); | |
189 | ||
190 | ||
191 | /** | |
192 | * rfkill_unregister - Unregister a rfkill structure. | |
193 | * @rfkill: rfkill structure to be unregistered | |
194 | * | |
195 | * This function should be called by the network driver during device | |
196 | * teardown to destroy rfkill structure. Until it returns, the driver | |
197 | * needs to be able to service method calls. | |
198 | */ | |
cf4328cd ID |
199 | void rfkill_unregister(struct rfkill *rfkill); |
200 | ||
19d337df JB |
201 | /** |
202 | * rfkill_destroy - free rfkill structure | |
203 | * @rfkill: rfkill structure to be destroyed | |
204 | * | |
205 | * Destroys the rfkill structure. | |
206 | */ | |
207 | void rfkill_destroy(struct rfkill *rfkill); | |
208 | ||
209 | /** | |
210 | * rfkill_set_hw_state - Set the internal rfkill hardware block state | |
211 | * @rfkill: pointer to the rfkill class to modify. | |
212 | * @state: the current hardware block state to set | |
213 | * | |
214 | * rfkill drivers that get events when the hard-blocked state changes | |
215 | * use this function to notify the rfkill core (and through that also | |
908209c1 | 216 | * userspace) of the current state. They should also use this after |
19d337df JB |
217 | * resume if the state could have changed. |
218 | * | |
219 | * You need not (but may) call this function if poll_state is assigned. | |
220 | * | |
221 | * This function can be called in any context, even from within rfkill | |
222 | * callbacks. | |
223 | * | |
224 | * The function returns the combined block state (true if transmitter | |
225 | * should be blocked) so that drivers need not keep track of the soft | |
226 | * block state -- which they might not be able to. | |
227 | */ | |
228 | bool __must_check rfkill_set_hw_state(struct rfkill *rfkill, bool blocked); | |
229 | ||
230 | /** | |
231 | * rfkill_set_sw_state - Set the internal rfkill software block state | |
232 | * @rfkill: pointer to the rfkill class to modify. | |
233 | * @state: the current software block state to set | |
234 | * | |
235 | * rfkill drivers that get events when the soft-blocked state changes | |
236 | * (yes, some platforms directly act on input but allow changing again) | |
237 | * use this function to notify the rfkill core (and through that also | |
06d5caf4 AJ |
238 | * userspace) of the current state. |
239 | * | |
240 | * Drivers should also call this function after resume if the state has | |
241 | * been changed by the user. This only makes sense for "persistent" | |
242 | * devices (see rfkill_init_sw_state()). | |
19d337df JB |
243 | * |
244 | * This function can be called in any context, even from within rfkill | |
245 | * callbacks. | |
246 | * | |
247 | * The function returns the combined block state (true if transmitter | |
248 | * should be blocked). | |
249 | */ | |
250 | bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked); | |
251 | ||
06d5caf4 AJ |
252 | /** |
253 | * rfkill_init_sw_state - Initialize persistent software block state | |
254 | * @rfkill: pointer to the rfkill class to modify. | |
255 | * @state: the current software block state to set | |
256 | * | |
257 | * rfkill drivers that preserve their software block state over power off | |
258 | * use this function to notify the rfkill core (and through that also | |
259 | * userspace) of their initial state. It should only be used before | |
260 | * registration. | |
261 | * | |
464902e8 AJ |
262 | * In addition, it marks the device as "persistent", an attribute which |
263 | * can be read by userspace. Persistent devices are expected to preserve | |
264 | * their own state when suspended. | |
06d5caf4 AJ |
265 | */ |
266 | void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked); | |
267 | ||
19d337df JB |
268 | /** |
269 | * rfkill_set_states - Set the internal rfkill block states | |
270 | * @rfkill: pointer to the rfkill class to modify. | |
271 | * @sw: the current software block state to set | |
272 | * @hw: the current hardware block state to set | |
273 | * | |
274 | * This function can be called in any context, even from within rfkill | |
275 | * callbacks. | |
276 | */ | |
277 | void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw); | |
801e49af | 278 | |
6081162e JB |
279 | /** |
280 | * rfkill_blocked - query rfkill block | |
281 | * | |
282 | * @rfkill: rfkill struct to query | |
283 | */ | |
284 | bool rfkill_blocked(struct rfkill *rfkill); | |
19d337df JB |
285 | #else /* !RFKILL */ |
286 | static inline struct rfkill * __must_check | |
287 | rfkill_alloc(const char *name, | |
288 | struct device *parent, | |
289 | const enum rfkill_type type, | |
290 | const struct rfkill_ops *ops, | |
291 | void *ops_data) | |
292 | { | |
293 | return ERR_PTR(-ENODEV); | |
294 | } | |
295 | ||
296 | static inline int __must_check rfkill_register(struct rfkill *rfkill) | |
297 | { | |
298 | if (rfkill == ERR_PTR(-ENODEV)) | |
299 | return 0; | |
300 | return -EINVAL; | |
301 | } | |
302 | ||
303 | static inline void rfkill_pause_polling(struct rfkill *rfkill) | |
304 | { | |
305 | } | |
306 | ||
307 | static inline void rfkill_resume_polling(struct rfkill *rfkill) | |
308 | { | |
309 | } | |
310 | ||
311 | static inline void rfkill_unregister(struct rfkill *rfkill) | |
312 | { | |
313 | } | |
314 | ||
315 | static inline void rfkill_destroy(struct rfkill *rfkill) | |
316 | { | |
317 | } | |
318 | ||
319 | static inline bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked) | |
320 | { | |
321 | return blocked; | |
322 | } | |
323 | ||
324 | static inline bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked) | |
325 | { | |
326 | return blocked; | |
327 | } | |
328 | ||
06d5caf4 AJ |
329 | static inline void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked) |
330 | { | |
331 | } | |
332 | ||
19d337df JB |
333 | static inline void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw) |
334 | { | |
335 | } | |
336 | ||
6081162e JB |
337 | static inline bool rfkill_blocked(struct rfkill *rfkill) |
338 | { | |
339 | return false; | |
340 | } | |
19d337df JB |
341 | #endif /* RFKILL || RFKILL_MODULE */ |
342 | ||
5005657c | 343 | |
19d337df | 344 | #ifdef CONFIG_RFKILL_LEDS |
135900c1 | 345 | /** |
19d337df | 346 | * rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED. |
135900c1 | 347 | * This function might return a NULL pointer if registering of the |
19d337df | 348 | * LED trigger failed. Use this as "default_trigger" for the LED. |
135900c1 | 349 | */ |
19d337df JB |
350 | const char *rfkill_get_led_trigger_name(struct rfkill *rfkill); |
351 | ||
352 | /** | |
353 | * rfkill_set_led_trigger_name -- set the LED trigger name | |
354 | * @rfkill: rfkill struct | |
355 | * @name: LED trigger name | |
356 | * | |
357 | * This function sets the LED trigger name of the radio LED | |
358 | * trigger that rfkill creates. It is optional, but if called | |
359 | * must be called before rfkill_register() to be effective. | |
360 | */ | |
361 | void rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name); | |
135900c1 | 362 | #else |
19d337df JB |
363 | static inline const char *rfkill_get_led_trigger_name(struct rfkill *rfkill) |
364 | { | |
135900c1 | 365 | return NULL; |
135900c1 MB |
366 | } |
367 | ||
19d337df JB |
368 | static inline void |
369 | rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name) | |
370 | { | |
371 | } | |
372 | #endif | |
373 | ||
374 | #endif /* __KERNEL__ */ | |
375 | ||
cf4328cd | 376 | #endif /* RFKILL_H */ |