2 * Copyright (C) 2006 - 2007 Ivo van Doorn
3 * Copyright (C) 2007 Dmitry Torokhov
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the
17 * Free Software Foundation, Inc.,
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/init.h>
24 #include <linux/workqueue.h>
25 #include <linux/capability.h>
26 #include <linux/list.h>
27 #include <linux/mutex.h>
28 #include <linux/rfkill.h>
30 /* Get declaration of rfkill_switch_all() to shut up sparse. */
31 #include "rfkill-input.h"
34 MODULE_AUTHOR("Ivo van Doorn <IvDoorn@gmail.com>");
35 MODULE_VERSION("1.0");
36 MODULE_DESCRIPTION("RF switch support");
37 MODULE_LICENSE("GPL");
39 static LIST_HEAD(rfkill_list); /* list of registered rf switches */
40 static DEFINE_MUTEX(rfkill_mutex);
42 static unsigned int rfkill_default_state = RFKILL_STATE_UNBLOCKED;
43 module_param_named(default_state, rfkill_default_state, uint, 0444);
44 MODULE_PARM_DESC(default_state,
45 "Default initial state for all radio types, 0 = radio off");
47 static enum rfkill_state rfkill_states[RFKILL_TYPE_MAX];
49 static BLOCKING_NOTIFIER_HEAD(rfkill_notifier_list);
53 * register_rfkill_notifier - Add notifier to rfkill notifier chain
54 * @nb: pointer to the new entry to add to the chain
56 * See blocking_notifier_chain_register() for return value and further
59 * Adds a notifier to the rfkill notifier chain. The chain will be
60 * called with a pointer to the relevant rfkill structure as a parameter,
61 * refer to include/linux/rfkill.h for the possible events.
63 * Notifiers added to this chain are to always return NOTIFY_DONE. This
64 * chain is a blocking notifier chain: notifiers can sleep.
66 * Calls to this chain may have been done through a workqueue. One must
67 * assume unordered asynchronous behaviour, there is no way to know if
68 * actions related to the event that generated the notification have been
69 * carried out already.
71 int register_rfkill_notifier(struct notifier_block *nb)
73 return blocking_notifier_chain_register(&rfkill_notifier_list, nb);
75 EXPORT_SYMBOL_GPL(register_rfkill_notifier);
78 * unregister_rfkill_notifier - remove notifier from rfkill notifier chain
79 * @nb: pointer to the entry to remove from the chain
81 * See blocking_notifier_chain_unregister() for return value and further
84 * Removes a notifier from the rfkill notifier chain.
86 int unregister_rfkill_notifier(struct notifier_block *nb)
88 return blocking_notifier_chain_unregister(&rfkill_notifier_list, nb);
90 EXPORT_SYMBOL_GPL(unregister_rfkill_notifier);
93 static void rfkill_led_trigger(struct rfkill *rfkill,
94 enum rfkill_state state)
96 #ifdef CONFIG_RFKILL_LEDS
97 struct led_trigger *led = &rfkill->led_trigger;
101 if (state != RFKILL_STATE_UNBLOCKED)
102 led_trigger_event(led, LED_OFF);
104 led_trigger_event(led, LED_FULL);
105 #endif /* CONFIG_RFKILL_LEDS */
108 static void notify_rfkill_state_change(struct rfkill *rfkill)
110 blocking_notifier_call_chain(&rfkill_notifier_list,
111 RFKILL_STATE_CHANGED,
115 static void update_rfkill_state(struct rfkill *rfkill)
117 enum rfkill_state newstate, oldstate;
119 if (rfkill->get_state) {
120 mutex_lock(&rfkill->mutex);
121 if (!rfkill->get_state(rfkill->data, &newstate)) {
122 oldstate = rfkill->state;
123 rfkill->state = newstate;
124 if (oldstate != newstate)
125 notify_rfkill_state_change(rfkill);
127 mutex_unlock(&rfkill->mutex);
132 * rfkill_toggle_radio - wrapper for toggle_radio hook
133 * calls toggle_radio taking into account a lot of "small"
135 * @rfkill: the rfkill struct to use
136 * @force: calls toggle_radio even if cache says it is not needed,
137 * and also makes sure notifications of the state will be
138 * sent even if it didn't change
139 * @state: the new state to call toggle_radio() with
141 * This wrappen protects and enforces the API for toggle_radio
142 * calls. Note that @force cannot override a (possibly cached)
143 * state of RFKILL_STATE_HARD_BLOCKED. Any device making use of
144 * RFKILL_STATE_HARD_BLOCKED implements either get_state() or
145 * rfkill_force_state(), so the cache either is bypassed or valid.
147 * Note that we do call toggle_radio for RFKILL_STATE_SOFT_BLOCKED
148 * even if the radio is in RFKILL_STATE_HARD_BLOCKED state, so as to
149 * give the driver a hint that it should double-BLOCK the transmitter.
151 * Caller must have aquired rfkill_mutex.
153 static int rfkill_toggle_radio(struct rfkill *rfkill,
154 enum rfkill_state state,
158 enum rfkill_state oldstate, newstate;
160 oldstate = rfkill->state;
162 if (rfkill->get_state && !force &&
163 !rfkill->get_state(rfkill->data, &newstate))
164 rfkill->state = newstate;
167 case RFKILL_STATE_HARD_BLOCKED:
168 /* typically happens when refreshing hardware state,
169 * such as on resume */
170 state = RFKILL_STATE_SOFT_BLOCKED;
172 case RFKILL_STATE_UNBLOCKED:
173 /* force can't override this, only rfkill_force_state() can */
174 if (rfkill->state == RFKILL_STATE_HARD_BLOCKED)
177 case RFKILL_STATE_SOFT_BLOCKED:
178 /* nothing to do, we want to give drivers the hint to double
179 * BLOCK even a transmitter that is already in state
180 * RFKILL_STATE_HARD_BLOCKED */
184 if (force || state != rfkill->state) {
185 retval = rfkill->toggle_radio(rfkill->data, state);
186 /* never allow a HARD->SOFT downgrade! */
187 if (!retval && rfkill->state != RFKILL_STATE_HARD_BLOCKED)
188 rfkill->state = state;
191 if (force || rfkill->state != oldstate) {
192 rfkill_led_trigger(rfkill, rfkill->state);
193 notify_rfkill_state_change(rfkill);
200 * rfkill_switch_all - Toggle state of all switches of given type
201 * @type: type of interfaces to be affeceted
202 * @state: the new state
204 * This function toggles state of all switches of given type unless
205 * a specific switch is claimed by userspace in which case it is
208 void rfkill_switch_all(enum rfkill_type type, enum rfkill_state state)
210 struct rfkill *rfkill;
212 mutex_lock(&rfkill_mutex);
214 rfkill_states[type] = state;
216 list_for_each_entry(rfkill, &rfkill_list, node) {
217 if ((!rfkill->user_claim) && (rfkill->type == type))
218 rfkill_toggle_radio(rfkill, state, 0);
221 mutex_unlock(&rfkill_mutex);
223 EXPORT_SYMBOL(rfkill_switch_all);
226 * rfkill_epo - emergency power off all transmitters
228 * This kicks all rfkill devices to RFKILL_STATE_SOFT_BLOCKED, ignoring
229 * everything in its path but rfkill_mutex.
231 void rfkill_epo(void)
233 struct rfkill *rfkill;
235 mutex_lock(&rfkill_mutex);
236 list_for_each_entry(rfkill, &rfkill_list, node) {
237 rfkill_toggle_radio(rfkill, RFKILL_STATE_SOFT_BLOCKED, 1);
239 mutex_unlock(&rfkill_mutex);
241 EXPORT_SYMBOL_GPL(rfkill_epo);
244 * rfkill_force_state - Force the internal rfkill radio state
245 * @rfkill: pointer to the rfkill class to modify.
246 * @state: the current radio state the class should be forced to.
248 * This function updates the internal state of the radio cached
249 * by the rfkill class. It should be used when the driver gets
250 * a notification by the firmware/hardware of the current *real*
251 * state of the radio rfkill switch.
253 * It may not be called from an atomic context.
255 int rfkill_force_state(struct rfkill *rfkill, enum rfkill_state state)
257 enum rfkill_state oldstate;
259 if (state != RFKILL_STATE_SOFT_BLOCKED &&
260 state != RFKILL_STATE_UNBLOCKED &&
261 state != RFKILL_STATE_HARD_BLOCKED)
264 mutex_lock(&rfkill->mutex);
266 oldstate = rfkill->state;
267 rfkill->state = state;
269 if (state != oldstate)
270 notify_rfkill_state_change(rfkill);
272 mutex_unlock(&rfkill->mutex);
276 EXPORT_SYMBOL(rfkill_force_state);
278 static ssize_t rfkill_name_show(struct device *dev,
279 struct device_attribute *attr,
282 struct rfkill *rfkill = to_rfkill(dev);
284 return sprintf(buf, "%s\n", rfkill->name);
287 static const char *rfkill_get_type_str(enum rfkill_type type)
290 case RFKILL_TYPE_WLAN:
292 case RFKILL_TYPE_BLUETOOTH:
294 case RFKILL_TYPE_UWB:
295 return "ultrawideband";
296 case RFKILL_TYPE_WIMAX:
298 case RFKILL_TYPE_WWAN:
305 static ssize_t rfkill_type_show(struct device *dev,
306 struct device_attribute *attr,
309 struct rfkill *rfkill = to_rfkill(dev);
311 return sprintf(buf, "%s\n", rfkill_get_type_str(rfkill->type));
314 static ssize_t rfkill_state_show(struct device *dev,
315 struct device_attribute *attr,
318 struct rfkill *rfkill = to_rfkill(dev);
320 update_rfkill_state(rfkill);
321 return sprintf(buf, "%d\n", rfkill->state);
324 static ssize_t rfkill_state_store(struct device *dev,
325 struct device_attribute *attr,
326 const char *buf, size_t count)
328 struct rfkill *rfkill = to_rfkill(dev);
329 unsigned int state = simple_strtoul(buf, NULL, 0);
332 if (!capable(CAP_NET_ADMIN))
335 /* RFKILL_STATE_HARD_BLOCKED is illegal here... */
336 if (state != RFKILL_STATE_UNBLOCKED &&
337 state != RFKILL_STATE_SOFT_BLOCKED)
340 if (mutex_lock_interruptible(&rfkill->mutex))
342 error = rfkill_toggle_radio(rfkill, state, 0);
343 mutex_unlock(&rfkill->mutex);
345 return error ? error : count;
348 static ssize_t rfkill_claim_show(struct device *dev,
349 struct device_attribute *attr,
352 struct rfkill *rfkill = to_rfkill(dev);
354 return sprintf(buf, "%d", rfkill->user_claim);
357 static ssize_t rfkill_claim_store(struct device *dev,
358 struct device_attribute *attr,
359 const char *buf, size_t count)
361 struct rfkill *rfkill = to_rfkill(dev);
362 bool claim = !!simple_strtoul(buf, NULL, 0);
365 if (!capable(CAP_NET_ADMIN))
369 * Take the global lock to make sure the kernel is not in
370 * the middle of rfkill_switch_all
372 error = mutex_lock_interruptible(&rfkill_mutex);
376 if (rfkill->user_claim_unsupported) {
380 if (rfkill->user_claim != claim) {
382 rfkill_toggle_radio(rfkill,
383 rfkill_states[rfkill->type],
385 rfkill->user_claim = claim;
389 mutex_unlock(&rfkill_mutex);
391 return error ? error : count;
394 static struct device_attribute rfkill_dev_attrs[] = {
395 __ATTR(name, S_IRUGO, rfkill_name_show, NULL),
396 __ATTR(type, S_IRUGO, rfkill_type_show, NULL),
397 __ATTR(state, S_IRUGO|S_IWUSR, rfkill_state_show, rfkill_state_store),
398 __ATTR(claim, S_IRUGO|S_IWUSR, rfkill_claim_show, rfkill_claim_store),
402 static void rfkill_release(struct device *dev)
404 struct rfkill *rfkill = to_rfkill(dev);
407 module_put(THIS_MODULE);
411 static int rfkill_suspend(struct device *dev, pm_message_t state)
413 struct rfkill *rfkill = to_rfkill(dev);
415 if (dev->power.power_state.event != state.event) {
416 if (state.event & PM_EVENT_SLEEP) {
417 /* Stop transmitter, keep state, no notifies */
418 update_rfkill_state(rfkill);
420 mutex_lock(&rfkill->mutex);
421 rfkill->toggle_radio(rfkill->data,
422 RFKILL_STATE_SOFT_BLOCKED);
423 mutex_unlock(&rfkill->mutex);
426 dev->power.power_state = state;
432 static int rfkill_resume(struct device *dev)
434 struct rfkill *rfkill = to_rfkill(dev);
436 if (dev->power.power_state.event != PM_EVENT_ON) {
437 mutex_lock(&rfkill->mutex);
439 /* restore radio state AND notify everybody */
440 rfkill_toggle_radio(rfkill, rfkill->state, 1);
442 mutex_unlock(&rfkill->mutex);
445 dev->power.power_state = PMSG_ON;
449 #define rfkill_suspend NULL
450 #define rfkill_resume NULL
453 static int rfkill_blocking_uevent_notifier(struct notifier_block *nb,
454 unsigned long eventid,
457 struct rfkill *rfkill = (struct rfkill *)data;
460 case RFKILL_STATE_CHANGED:
461 kobject_uevent(&rfkill->dev.kobj, KOBJ_CHANGE);
470 static struct notifier_block rfkill_blocking_uevent_nb = {
471 .notifier_call = rfkill_blocking_uevent_notifier,
475 static int rfkill_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
477 struct rfkill *rfkill = to_rfkill(dev);
480 error = add_uevent_var(env, "RFKILL_NAME=%s", rfkill->name);
483 error = add_uevent_var(env, "RFKILL_TYPE=%s",
484 rfkill_get_type_str(rfkill->type));
487 error = add_uevent_var(env, "RFKILL_STATE=%d", rfkill->state);
491 static struct class rfkill_class = {
493 .dev_release = rfkill_release,
494 .dev_attrs = rfkill_dev_attrs,
495 .suspend = rfkill_suspend,
496 .resume = rfkill_resume,
497 .dev_uevent = rfkill_dev_uevent,
500 static int rfkill_add_switch(struct rfkill *rfkill)
504 mutex_lock(&rfkill_mutex);
506 error = rfkill_toggle_radio(rfkill, rfkill_states[rfkill->type], 0);
508 list_add_tail(&rfkill->node, &rfkill_list);
510 mutex_unlock(&rfkill_mutex);
515 static void rfkill_remove_switch(struct rfkill *rfkill)
517 mutex_lock(&rfkill_mutex);
518 list_del_init(&rfkill->node);
519 rfkill_toggle_radio(rfkill, RFKILL_STATE_SOFT_BLOCKED, 1);
520 mutex_unlock(&rfkill_mutex);
524 * rfkill_allocate - allocate memory for rfkill structure.
525 * @parent: device that has rf switch on it
526 * @type: type of the switch (RFKILL_TYPE_*)
528 * This function should be called by the network driver when it needs
529 * rfkill structure. Once the structure is allocated the driver shoud
530 * finish its initialization by setting name, private data, enable_radio
531 * and disable_radio methods and then register it with rfkill_register().
532 * NOTE: If registration fails the structure shoudl be freed by calling
533 * rfkill_free() otherwise rfkill_unregister() should be used.
535 struct rfkill *rfkill_allocate(struct device *parent, enum rfkill_type type)
537 struct rfkill *rfkill;
540 rfkill = kzalloc(sizeof(struct rfkill), GFP_KERNEL);
544 mutex_init(&rfkill->mutex);
545 INIT_LIST_HEAD(&rfkill->node);
549 dev->class = &rfkill_class;
550 dev->parent = parent;
551 device_initialize(dev);
553 __module_get(THIS_MODULE);
557 EXPORT_SYMBOL(rfkill_allocate);
560 * rfkill_free - Mark rfkill structure for deletion
561 * @rfkill: rfkill structure to be destroyed
563 * Decrements reference count of rfkill structure so it is destroyed.
564 * Note that rfkill_free() should _not_ be called after rfkill_unregister().
566 void rfkill_free(struct rfkill *rfkill)
569 put_device(&rfkill->dev);
571 EXPORT_SYMBOL(rfkill_free);
573 static void rfkill_led_trigger_register(struct rfkill *rfkill)
575 #ifdef CONFIG_RFKILL_LEDS
578 rfkill->led_trigger.name = rfkill->dev.bus_id;
579 error = led_trigger_register(&rfkill->led_trigger);
581 rfkill->led_trigger.name = NULL;
582 #endif /* CONFIG_RFKILL_LEDS */
585 static void rfkill_led_trigger_unregister(struct rfkill *rfkill)
587 #ifdef CONFIG_RFKILL_LEDS
588 if (rfkill->led_trigger.name)
589 led_trigger_unregister(&rfkill->led_trigger);
594 * rfkill_register - Register a rfkill structure.
595 * @rfkill: rfkill structure to be registered
597 * This function should be called by the network driver when the rfkill
598 * structure needs to be registered. Immediately from registration the
599 * switch driver should be able to service calls to toggle_radio.
601 int rfkill_register(struct rfkill *rfkill)
603 static atomic_t rfkill_no = ATOMIC_INIT(0);
604 struct device *dev = &rfkill->dev;
607 if (!rfkill->toggle_radio)
609 if (rfkill->type >= RFKILL_TYPE_MAX)
612 snprintf(dev->bus_id, sizeof(dev->bus_id),
613 "rfkill%ld", (long)atomic_inc_return(&rfkill_no) - 1);
615 rfkill_led_trigger_register(rfkill);
617 error = rfkill_add_switch(rfkill);
619 rfkill_led_trigger_unregister(rfkill);
623 error = device_add(dev);
625 rfkill_led_trigger_unregister(rfkill);
626 rfkill_remove_switch(rfkill);
632 EXPORT_SYMBOL(rfkill_register);
635 * rfkill_unregister - Unregister a rfkill structure.
636 * @rfkill: rfkill structure to be unregistered
638 * This function should be called by the network driver during device
639 * teardown to destroy rfkill structure. Note that rfkill_free() should
640 * _not_ be called after rfkill_unregister().
642 void rfkill_unregister(struct rfkill *rfkill)
644 device_del(&rfkill->dev);
645 rfkill_remove_switch(rfkill);
646 rfkill_led_trigger_unregister(rfkill);
647 put_device(&rfkill->dev);
649 EXPORT_SYMBOL(rfkill_unregister);
652 * Rfkill module initialization/deinitialization.
654 static int __init rfkill_init(void)
659 /* RFKILL_STATE_HARD_BLOCKED is illegal here... */
660 if (rfkill_default_state != RFKILL_STATE_SOFT_BLOCKED &&
661 rfkill_default_state != RFKILL_STATE_UNBLOCKED)
664 for (i = 0; i < ARRAY_SIZE(rfkill_states); i++)
665 rfkill_states[i] = rfkill_default_state;
667 error = class_register(&rfkill_class);
669 printk(KERN_ERR "rfkill: unable to register rfkill class\n");
673 register_rfkill_notifier(&rfkill_blocking_uevent_nb);
678 static void __exit rfkill_exit(void)
680 unregister_rfkill_notifier(&rfkill_blocking_uevent_nb);
681 class_unregister(&rfkill_class);
684 subsys_initcall(rfkill_init);
685 module_exit(rfkill_exit);