rfkill: preserve state across suspend
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / net / rfkill / rfkill.c
blob5ad411d3e8f80305327e4661dfade7fbc96ef0b0
1 /*
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_global_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 struct rfkill_gsw_state {
48 enum rfkill_state current_state;
49 enum rfkill_state default_state;
52 static struct rfkill_gsw_state rfkill_global_states[RFKILL_TYPE_MAX];
53 static unsigned long rfkill_states_lockdflt[BITS_TO_LONGS(RFKILL_TYPE_MAX)];
54 static bool rfkill_epo_lock_active;
56 static BLOCKING_NOTIFIER_HEAD(rfkill_notifier_list);
59 /**
60 * register_rfkill_notifier - Add notifier to rfkill notifier chain
61 * @nb: pointer to the new entry to add to the chain
63 * See blocking_notifier_chain_register() for return value and further
64 * observations.
66 * Adds a notifier to the rfkill notifier chain. The chain will be
67 * called with a pointer to the relevant rfkill structure as a parameter,
68 * refer to include/linux/rfkill.h for the possible events.
70 * Notifiers added to this chain are to always return NOTIFY_DONE. This
71 * chain is a blocking notifier chain: notifiers can sleep.
73 * Calls to this chain may have been done through a workqueue. One must
74 * assume unordered asynchronous behaviour, there is no way to know if
75 * actions related to the event that generated the notification have been
76 * carried out already.
78 int register_rfkill_notifier(struct notifier_block *nb)
80 BUG_ON(!nb);
81 return blocking_notifier_chain_register(&rfkill_notifier_list, nb);
83 EXPORT_SYMBOL_GPL(register_rfkill_notifier);
85 /**
86 * unregister_rfkill_notifier - remove notifier from rfkill notifier chain
87 * @nb: pointer to the entry to remove from the chain
89 * See blocking_notifier_chain_unregister() for return value and further
90 * observations.
92 * Removes a notifier from the rfkill notifier chain.
94 int unregister_rfkill_notifier(struct notifier_block *nb)
96 BUG_ON(!nb);
97 return blocking_notifier_chain_unregister(&rfkill_notifier_list, nb);
99 EXPORT_SYMBOL_GPL(unregister_rfkill_notifier);
102 static void rfkill_led_trigger(struct rfkill *rfkill,
103 enum rfkill_state state)
105 #ifdef CONFIG_RFKILL_LEDS
106 struct led_trigger *led = &rfkill->led_trigger;
108 if (!led->name)
109 return;
110 if (state != RFKILL_STATE_UNBLOCKED)
111 led_trigger_event(led, LED_OFF);
112 else
113 led_trigger_event(led, LED_FULL);
114 #endif /* CONFIG_RFKILL_LEDS */
117 #ifdef CONFIG_RFKILL_LEDS
118 static void rfkill_led_trigger_activate(struct led_classdev *led)
120 struct rfkill *rfkill = container_of(led->trigger,
121 struct rfkill, led_trigger);
123 rfkill_led_trigger(rfkill, rfkill->state);
125 #endif /* CONFIG_RFKILL_LEDS */
127 static void notify_rfkill_state_change(struct rfkill *rfkill)
129 rfkill_led_trigger(rfkill, rfkill->state);
130 blocking_notifier_call_chain(&rfkill_notifier_list,
131 RFKILL_STATE_CHANGED,
132 rfkill);
135 static void update_rfkill_state(struct rfkill *rfkill)
137 enum rfkill_state newstate, oldstate;
139 if (rfkill->get_state) {
140 mutex_lock(&rfkill->mutex);
141 if (!rfkill->get_state(rfkill->data, &newstate)) {
142 oldstate = rfkill->state;
143 rfkill->state = newstate;
144 if (oldstate != newstate)
145 notify_rfkill_state_change(rfkill);
147 mutex_unlock(&rfkill->mutex);
152 * rfkill_toggle_radio - wrapper for toggle_radio hook
153 * @rfkill: the rfkill struct to use
154 * @force: calls toggle_radio even if cache says it is not needed,
155 * and also makes sure notifications of the state will be
156 * sent even if it didn't change
157 * @state: the new state to call toggle_radio() with
159 * Calls rfkill->toggle_radio, enforcing the API for toggle_radio
160 * calls and handling all the red tape such as issuing notifications
161 * if the call is successful.
163 * Suspended devices are not touched at all, and -EAGAIN is returned.
165 * Note that the @force parameter cannot override a (possibly cached)
166 * state of RFKILL_STATE_HARD_BLOCKED. Any device making use of
167 * RFKILL_STATE_HARD_BLOCKED implements either get_state() or
168 * rfkill_force_state(), so the cache either is bypassed or valid.
170 * Note that we do call toggle_radio for RFKILL_STATE_SOFT_BLOCKED
171 * even if the radio is in RFKILL_STATE_HARD_BLOCKED state, so as to
172 * give the driver a hint that it should double-BLOCK the transmitter.
174 * Caller must have acquired rfkill->mutex.
176 static int rfkill_toggle_radio(struct rfkill *rfkill,
177 enum rfkill_state state,
178 int force)
180 int retval = 0;
181 enum rfkill_state oldstate, newstate;
183 if (unlikely(rfkill->dev.power.power_state.event & PM_EVENT_SLEEP))
184 return -EBUSY;
186 oldstate = rfkill->state;
188 if (rfkill->get_state && !force &&
189 !rfkill->get_state(rfkill->data, &newstate))
190 rfkill->state = newstate;
192 switch (state) {
193 case RFKILL_STATE_HARD_BLOCKED:
194 /* typically happens when refreshing hardware state,
195 * such as on resume */
196 state = RFKILL_STATE_SOFT_BLOCKED;
197 break;
198 case RFKILL_STATE_UNBLOCKED:
199 /* force can't override this, only rfkill_force_state() can */
200 if (rfkill->state == RFKILL_STATE_HARD_BLOCKED)
201 return -EPERM;
202 break;
203 case RFKILL_STATE_SOFT_BLOCKED:
204 /* nothing to do, we want to give drivers the hint to double
205 * BLOCK even a transmitter that is already in state
206 * RFKILL_STATE_HARD_BLOCKED */
207 break;
208 default:
209 WARN(1, KERN_WARNING
210 "rfkill: illegal state %d passed as parameter "
211 "to rfkill_toggle_radio\n", state);
212 return -EINVAL;
215 if (force || state != rfkill->state) {
216 retval = rfkill->toggle_radio(rfkill->data, state);
217 /* never allow a HARD->SOFT downgrade! */
218 if (!retval && rfkill->state != RFKILL_STATE_HARD_BLOCKED)
219 rfkill->state = state;
222 if (force || rfkill->state != oldstate)
223 notify_rfkill_state_change(rfkill);
225 return retval;
229 * __rfkill_switch_all - Toggle state of all switches of given type
230 * @type: type of interfaces to be affected
231 * @state: the new state
233 * This function toggles the state of all switches of given type,
234 * unless a specific switch is claimed by userspace (in which case,
235 * that switch is left alone) or suspended.
237 * Caller must have acquired rfkill_global_mutex.
239 static void __rfkill_switch_all(const enum rfkill_type type,
240 const enum rfkill_state state)
242 struct rfkill *rfkill;
244 if (WARN((state >= RFKILL_STATE_MAX || type >= RFKILL_TYPE_MAX),
245 KERN_WARNING
246 "rfkill: illegal state %d or type %d "
247 "passed as parameter to __rfkill_switch_all\n",
248 state, type))
249 return;
251 rfkill_global_states[type].current_state = state;
252 list_for_each_entry(rfkill, &rfkill_list, node) {
253 if ((!rfkill->user_claim) && (rfkill->type == type)) {
254 mutex_lock(&rfkill->mutex);
255 rfkill_toggle_radio(rfkill, state, 0);
256 mutex_unlock(&rfkill->mutex);
262 * rfkill_switch_all - Toggle state of all switches of given type
263 * @type: type of interfaces to be affected
264 * @state: the new state
266 * Acquires rfkill_global_mutex and calls __rfkill_switch_all(@type, @state).
267 * Please refer to __rfkill_switch_all() for details.
269 * Does nothing if the EPO lock is active.
271 void rfkill_switch_all(enum rfkill_type type, enum rfkill_state state)
273 mutex_lock(&rfkill_global_mutex);
274 if (!rfkill_epo_lock_active)
275 __rfkill_switch_all(type, state);
276 mutex_unlock(&rfkill_global_mutex);
278 EXPORT_SYMBOL(rfkill_switch_all);
281 * rfkill_epo - emergency power off all transmitters
283 * This kicks all non-suspended rfkill devices to RFKILL_STATE_SOFT_BLOCKED,
284 * ignoring everything in its path but rfkill_global_mutex and rfkill->mutex.
286 * The global state before the EPO is saved and can be restored later
287 * using rfkill_restore_states().
289 void rfkill_epo(void)
291 struct rfkill *rfkill;
292 int i;
294 mutex_lock(&rfkill_global_mutex);
296 rfkill_epo_lock_active = true;
297 list_for_each_entry(rfkill, &rfkill_list, node) {
298 mutex_lock(&rfkill->mutex);
299 rfkill_toggle_radio(rfkill, RFKILL_STATE_SOFT_BLOCKED, 1);
300 mutex_unlock(&rfkill->mutex);
302 for (i = 0; i < RFKILL_TYPE_MAX; i++) {
303 rfkill_global_states[i].default_state =
304 rfkill_global_states[i].current_state;
305 rfkill_global_states[i].current_state =
306 RFKILL_STATE_SOFT_BLOCKED;
308 mutex_unlock(&rfkill_global_mutex);
310 EXPORT_SYMBOL_GPL(rfkill_epo);
313 * rfkill_restore_states - restore global states
315 * Restore (and sync switches to) the global state from the
316 * states in rfkill_default_states. This can undo the effects of
317 * a call to rfkill_epo().
319 void rfkill_restore_states(void)
321 int i;
323 mutex_lock(&rfkill_global_mutex);
325 rfkill_epo_lock_active = false;
326 for (i = 0; i < RFKILL_TYPE_MAX; i++)
327 __rfkill_switch_all(i, rfkill_global_states[i].default_state);
328 mutex_unlock(&rfkill_global_mutex);
330 EXPORT_SYMBOL_GPL(rfkill_restore_states);
333 * rfkill_remove_epo_lock - unlock state changes
335 * Used by rfkill-input manually unlock state changes, when
336 * the EPO switch is deactivated.
338 void rfkill_remove_epo_lock(void)
340 mutex_lock(&rfkill_global_mutex);
341 rfkill_epo_lock_active = false;
342 mutex_unlock(&rfkill_global_mutex);
344 EXPORT_SYMBOL_GPL(rfkill_remove_epo_lock);
347 * rfkill_is_epo_lock_active - returns true EPO is active
349 * Returns 0 (false) if there is NOT an active EPO contidion,
350 * and 1 (true) if there is an active EPO contition, which
351 * locks all radios in one of the BLOCKED states.
353 * Can be called in atomic context.
355 bool rfkill_is_epo_lock_active(void)
357 return rfkill_epo_lock_active;
359 EXPORT_SYMBOL_GPL(rfkill_is_epo_lock_active);
362 * rfkill_get_global_state - returns global state for a type
363 * @type: the type to get the global state of
365 * Returns the current global state for a given wireless
366 * device type.
368 enum rfkill_state rfkill_get_global_state(const enum rfkill_type type)
370 return rfkill_global_states[type].current_state;
372 EXPORT_SYMBOL_GPL(rfkill_get_global_state);
375 * rfkill_force_state - Force the internal rfkill radio state
376 * @rfkill: pointer to the rfkill class to modify.
377 * @state: the current radio state the class should be forced to.
379 * This function updates the internal state of the radio cached
380 * by the rfkill class. It should be used when the driver gets
381 * a notification by the firmware/hardware of the current *real*
382 * state of the radio rfkill switch.
384 * Devices which are subject to external changes on their rfkill
385 * state (such as those caused by a hardware rfkill line) MUST
386 * have their driver arrange to call rfkill_force_state() as soon
387 * as possible after such a change.
389 * This function may not be called from an atomic context.
391 int rfkill_force_state(struct rfkill *rfkill, enum rfkill_state state)
393 enum rfkill_state oldstate;
395 BUG_ON(!rfkill);
396 if (WARN((state >= RFKILL_STATE_MAX),
397 KERN_WARNING
398 "rfkill: illegal state %d passed as parameter "
399 "to rfkill_force_state\n", state))
400 return -EINVAL;
402 mutex_lock(&rfkill->mutex);
404 oldstate = rfkill->state;
405 rfkill->state = state;
407 if (state != oldstate)
408 notify_rfkill_state_change(rfkill);
410 mutex_unlock(&rfkill->mutex);
412 return 0;
414 EXPORT_SYMBOL(rfkill_force_state);
416 static ssize_t rfkill_name_show(struct device *dev,
417 struct device_attribute *attr,
418 char *buf)
420 struct rfkill *rfkill = to_rfkill(dev);
422 return sprintf(buf, "%s\n", rfkill->name);
425 static const char *rfkill_get_type_str(enum rfkill_type type)
427 switch (type) {
428 case RFKILL_TYPE_WLAN:
429 return "wlan";
430 case RFKILL_TYPE_BLUETOOTH:
431 return "bluetooth";
432 case RFKILL_TYPE_UWB:
433 return "ultrawideband";
434 case RFKILL_TYPE_WIMAX:
435 return "wimax";
436 case RFKILL_TYPE_WWAN:
437 return "wwan";
438 default:
439 BUG();
443 static ssize_t rfkill_type_show(struct device *dev,
444 struct device_attribute *attr,
445 char *buf)
447 struct rfkill *rfkill = to_rfkill(dev);
449 return sprintf(buf, "%s\n", rfkill_get_type_str(rfkill->type));
452 static ssize_t rfkill_state_show(struct device *dev,
453 struct device_attribute *attr,
454 char *buf)
456 struct rfkill *rfkill = to_rfkill(dev);
458 update_rfkill_state(rfkill);
459 return sprintf(buf, "%d\n", rfkill->state);
462 static ssize_t rfkill_state_store(struct device *dev,
463 struct device_attribute *attr,
464 const char *buf, size_t count)
466 struct rfkill *rfkill = to_rfkill(dev);
467 unsigned long state;
468 int error;
470 if (!capable(CAP_NET_ADMIN))
471 return -EPERM;
473 error = strict_strtoul(buf, 0, &state);
474 if (error)
475 return error;
477 /* RFKILL_STATE_HARD_BLOCKED is illegal here... */
478 if (state != RFKILL_STATE_UNBLOCKED &&
479 state != RFKILL_STATE_SOFT_BLOCKED)
480 return -EINVAL;
482 error = mutex_lock_killable(&rfkill->mutex);
483 if (error)
484 return error;
486 if (!rfkill_epo_lock_active)
487 error = rfkill_toggle_radio(rfkill, state, 0);
488 else
489 error = -EPERM;
491 mutex_unlock(&rfkill->mutex);
493 return error ? error : count;
496 static ssize_t rfkill_claim_show(struct device *dev,
497 struct device_attribute *attr,
498 char *buf)
500 struct rfkill *rfkill = to_rfkill(dev);
502 return sprintf(buf, "%d\n", rfkill->user_claim);
505 static ssize_t rfkill_claim_store(struct device *dev,
506 struct device_attribute *attr,
507 const char *buf, size_t count)
509 struct rfkill *rfkill = to_rfkill(dev);
510 unsigned long claim_tmp;
511 bool claim;
512 int error;
514 if (!capable(CAP_NET_ADMIN))
515 return -EPERM;
517 if (rfkill->user_claim_unsupported)
518 return -EOPNOTSUPP;
520 error = strict_strtoul(buf, 0, &claim_tmp);
521 if (error)
522 return error;
523 claim = !!claim_tmp;
526 * Take the global lock to make sure the kernel is not in
527 * the middle of rfkill_switch_all
529 error = mutex_lock_killable(&rfkill_global_mutex);
530 if (error)
531 return error;
533 if (rfkill->user_claim != claim) {
534 if (!claim && !rfkill_epo_lock_active) {
535 mutex_lock(&rfkill->mutex);
536 rfkill_toggle_radio(rfkill,
537 rfkill_global_states[rfkill->type].current_state,
539 mutex_unlock(&rfkill->mutex);
541 rfkill->user_claim = claim;
544 mutex_unlock(&rfkill_global_mutex);
546 return error ? error : count;
549 static struct device_attribute rfkill_dev_attrs[] = {
550 __ATTR(name, S_IRUGO, rfkill_name_show, NULL),
551 __ATTR(type, S_IRUGO, rfkill_type_show, NULL),
552 __ATTR(state, S_IRUGO|S_IWUSR, rfkill_state_show, rfkill_state_store),
553 __ATTR(claim, S_IRUGO|S_IWUSR, rfkill_claim_show, rfkill_claim_store),
554 __ATTR_NULL
557 static void rfkill_release(struct device *dev)
559 struct rfkill *rfkill = to_rfkill(dev);
561 kfree(rfkill);
562 module_put(THIS_MODULE);
565 #ifdef CONFIG_PM
566 static int rfkill_suspend(struct device *dev, pm_message_t state)
568 struct rfkill *rfkill = to_rfkill(dev);
570 /* mark class device as suspended */
571 if (dev->power.power_state.event != state.event)
572 dev->power.power_state = state;
574 /* store state for the resume handler */
575 rfkill->state_for_resume = rfkill->state;
577 return 0;
580 static int rfkill_resume(struct device *dev)
582 struct rfkill *rfkill = to_rfkill(dev);
584 if (dev->power.power_state.event != PM_EVENT_ON) {
585 mutex_lock(&rfkill->mutex);
587 dev->power.power_state.event = PM_EVENT_ON;
590 * If we are under EPO, kick transmitter offline,
591 * otherwise restore to pre-suspend state.
593 * Issue a notification in any case
595 rfkill_toggle_radio(rfkill,
596 rfkill_epo_lock_active ?
597 RFKILL_STATE_SOFT_BLOCKED :
598 rfkill->state_for_resume,
601 mutex_unlock(&rfkill->mutex);
604 return 0;
606 #else
607 #define rfkill_suspend NULL
608 #define rfkill_resume NULL
609 #endif
611 static int rfkill_blocking_uevent_notifier(struct notifier_block *nb,
612 unsigned long eventid,
613 void *data)
615 struct rfkill *rfkill = (struct rfkill *)data;
617 switch (eventid) {
618 case RFKILL_STATE_CHANGED:
619 kobject_uevent(&rfkill->dev.kobj, KOBJ_CHANGE);
620 break;
621 default:
622 break;
625 return NOTIFY_DONE;
628 static struct notifier_block rfkill_blocking_uevent_nb = {
629 .notifier_call = rfkill_blocking_uevent_notifier,
630 .priority = 0,
633 static int rfkill_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
635 struct rfkill *rfkill = to_rfkill(dev);
636 int error;
638 error = add_uevent_var(env, "RFKILL_NAME=%s", rfkill->name);
639 if (error)
640 return error;
641 error = add_uevent_var(env, "RFKILL_TYPE=%s",
642 rfkill_get_type_str(rfkill->type));
643 if (error)
644 return error;
645 error = add_uevent_var(env, "RFKILL_STATE=%d", rfkill->state);
646 return error;
649 static struct class rfkill_class = {
650 .name = "rfkill",
651 .dev_release = rfkill_release,
652 .dev_attrs = rfkill_dev_attrs,
653 .suspend = rfkill_suspend,
654 .resume = rfkill_resume,
655 .dev_uevent = rfkill_dev_uevent,
658 static int rfkill_check_duplicity(const struct rfkill *rfkill)
660 struct rfkill *p;
661 unsigned long seen[BITS_TO_LONGS(RFKILL_TYPE_MAX)];
663 memset(seen, 0, sizeof(seen));
665 list_for_each_entry(p, &rfkill_list, node) {
666 if (WARN((p == rfkill), KERN_WARNING
667 "rfkill: illegal attempt to register "
668 "an already registered rfkill struct\n"))
669 return -EEXIST;
670 set_bit(p->type, seen);
673 /* 0: first switch of its kind */
674 return (test_bit(rfkill->type, seen)) ? 1 : 0;
677 static int rfkill_add_switch(struct rfkill *rfkill)
679 int error;
681 mutex_lock(&rfkill_global_mutex);
683 error = rfkill_check_duplicity(rfkill);
684 if (error < 0)
685 goto unlock_out;
687 if (!error) {
688 /* lock default after first use */
689 set_bit(rfkill->type, rfkill_states_lockdflt);
690 rfkill_global_states[rfkill->type].current_state =
691 rfkill_global_states[rfkill->type].default_state;
694 rfkill_toggle_radio(rfkill,
695 rfkill_global_states[rfkill->type].current_state,
698 list_add_tail(&rfkill->node, &rfkill_list);
700 error = 0;
701 unlock_out:
702 mutex_unlock(&rfkill_global_mutex);
704 return error;
707 static void rfkill_remove_switch(struct rfkill *rfkill)
709 mutex_lock(&rfkill_global_mutex);
710 list_del_init(&rfkill->node);
711 mutex_unlock(&rfkill_global_mutex);
713 mutex_lock(&rfkill->mutex);
714 rfkill_toggle_radio(rfkill, RFKILL_STATE_SOFT_BLOCKED, 1);
715 mutex_unlock(&rfkill->mutex);
719 * rfkill_allocate - allocate memory for rfkill structure.
720 * @parent: device that has rf switch on it
721 * @type: type of the switch (RFKILL_TYPE_*)
723 * This function should be called by the network driver when it needs
724 * rfkill structure. Once the structure is allocated the driver should
725 * finish its initialization by setting the name, private data, enable_radio
726 * and disable_radio methods and then register it with rfkill_register().
728 * NOTE: If registration fails the structure shoudl be freed by calling
729 * rfkill_free() otherwise rfkill_unregister() should be used.
731 struct rfkill * __must_check rfkill_allocate(struct device *parent,
732 enum rfkill_type type)
734 struct rfkill *rfkill;
735 struct device *dev;
737 if (WARN((type >= RFKILL_TYPE_MAX),
738 KERN_WARNING
739 "rfkill: illegal type %d passed as parameter "
740 "to rfkill_allocate\n", type))
741 return NULL;
743 rfkill = kzalloc(sizeof(struct rfkill), GFP_KERNEL);
744 if (!rfkill)
745 return NULL;
747 mutex_init(&rfkill->mutex);
748 INIT_LIST_HEAD(&rfkill->node);
749 rfkill->type = type;
751 dev = &rfkill->dev;
752 dev->class = &rfkill_class;
753 dev->parent = parent;
754 device_initialize(dev);
756 __module_get(THIS_MODULE);
758 return rfkill;
760 EXPORT_SYMBOL(rfkill_allocate);
763 * rfkill_free - Mark rfkill structure for deletion
764 * @rfkill: rfkill structure to be destroyed
766 * Decrements reference count of the rfkill structure so it is destroyed.
767 * Note that rfkill_free() should _not_ be called after rfkill_unregister().
769 void rfkill_free(struct rfkill *rfkill)
771 if (rfkill)
772 put_device(&rfkill->dev);
774 EXPORT_SYMBOL(rfkill_free);
776 static void rfkill_led_trigger_register(struct rfkill *rfkill)
778 #ifdef CONFIG_RFKILL_LEDS
779 int error;
781 if (!rfkill->led_trigger.name)
782 rfkill->led_trigger.name = dev_name(&rfkill->dev);
783 if (!rfkill->led_trigger.activate)
784 rfkill->led_trigger.activate = rfkill_led_trigger_activate;
785 error = led_trigger_register(&rfkill->led_trigger);
786 if (error)
787 rfkill->led_trigger.name = NULL;
788 #endif /* CONFIG_RFKILL_LEDS */
791 static void rfkill_led_trigger_unregister(struct rfkill *rfkill)
793 #ifdef CONFIG_RFKILL_LEDS
794 if (rfkill->led_trigger.name) {
795 led_trigger_unregister(&rfkill->led_trigger);
796 rfkill->led_trigger.name = NULL;
798 #endif
802 * rfkill_register - Register a rfkill structure.
803 * @rfkill: rfkill structure to be registered
805 * This function should be called by the network driver when the rfkill
806 * structure needs to be registered. Immediately from registration the
807 * switch driver should be able to service calls to toggle_radio.
809 int __must_check rfkill_register(struct rfkill *rfkill)
811 static atomic_t rfkill_no = ATOMIC_INIT(0);
812 struct device *dev = &rfkill->dev;
813 int error;
815 if (WARN((!rfkill || !rfkill->toggle_radio ||
816 rfkill->type >= RFKILL_TYPE_MAX ||
817 rfkill->state >= RFKILL_STATE_MAX),
818 KERN_WARNING
819 "rfkill: attempt to register a "
820 "badly initialized rfkill struct\n"))
821 return -EINVAL;
823 dev_set_name(dev, "rfkill%ld", (long)atomic_inc_return(&rfkill_no) - 1);
825 rfkill_led_trigger_register(rfkill);
827 error = rfkill_add_switch(rfkill);
828 if (error) {
829 rfkill_led_trigger_unregister(rfkill);
830 return error;
833 error = device_add(dev);
834 if (error) {
835 rfkill_remove_switch(rfkill);
836 rfkill_led_trigger_unregister(rfkill);
837 return error;
840 return 0;
842 EXPORT_SYMBOL(rfkill_register);
845 * rfkill_unregister - Unregister a rfkill structure.
846 * @rfkill: rfkill structure to be unregistered
848 * This function should be called by the network driver during device
849 * teardown to destroy rfkill structure. Note that rfkill_free() should
850 * _not_ be called after rfkill_unregister().
852 void rfkill_unregister(struct rfkill *rfkill)
854 BUG_ON(!rfkill);
855 device_del(&rfkill->dev);
856 rfkill_remove_switch(rfkill);
857 rfkill_led_trigger_unregister(rfkill);
858 put_device(&rfkill->dev);
860 EXPORT_SYMBOL(rfkill_unregister);
863 * rfkill_set_default - set initial value for a switch type
864 * @type - the type of switch to set the default state of
865 * @state - the new default state for that group of switches
867 * Sets the initial state rfkill should use for a given type.
868 * The following initial states are allowed: RFKILL_STATE_SOFT_BLOCKED
869 * and RFKILL_STATE_UNBLOCKED.
871 * This function is meant to be used by platform drivers for platforms
872 * that can save switch state across power down/reboot.
874 * The default state for each switch type can be changed exactly once.
875 * After a switch of that type is registered, the default state cannot
876 * be changed anymore. This guards against multiple drivers it the
877 * same platform trying to set the initial switch default state, which
878 * is not allowed.
880 * Returns -EPERM if the state has already been set once or is in use,
881 * so drivers likely want to either ignore or at most printk(KERN_NOTICE)
882 * if this function returns -EPERM.
884 * Returns 0 if the new default state was set, or an error if it
885 * could not be set.
887 int rfkill_set_default(enum rfkill_type type, enum rfkill_state state)
889 int error;
891 if (WARN((type >= RFKILL_TYPE_MAX ||
892 (state != RFKILL_STATE_SOFT_BLOCKED &&
893 state != RFKILL_STATE_UNBLOCKED)),
894 KERN_WARNING
895 "rfkill: illegal state %d or type %d passed as "
896 "parameter to rfkill_set_default\n", state, type))
897 return -EINVAL;
899 mutex_lock(&rfkill_global_mutex);
901 if (!test_and_set_bit(type, rfkill_states_lockdflt)) {
902 rfkill_global_states[type].default_state = state;
903 rfkill_global_states[type].current_state = state;
904 error = 0;
905 } else
906 error = -EPERM;
908 mutex_unlock(&rfkill_global_mutex);
909 return error;
911 EXPORT_SYMBOL_GPL(rfkill_set_default);
914 * Rfkill module initialization/deinitialization.
916 static int __init rfkill_init(void)
918 int error;
919 int i;
921 /* RFKILL_STATE_HARD_BLOCKED is illegal here... */
922 if (rfkill_default_state != RFKILL_STATE_SOFT_BLOCKED &&
923 rfkill_default_state != RFKILL_STATE_UNBLOCKED)
924 return -EINVAL;
926 for (i = 0; i < RFKILL_TYPE_MAX; i++)
927 rfkill_global_states[i].default_state = rfkill_default_state;
929 error = class_register(&rfkill_class);
930 if (error) {
931 printk(KERN_ERR "rfkill: unable to register rfkill class\n");
932 return error;
935 register_rfkill_notifier(&rfkill_blocking_uevent_nb);
937 return 0;
940 static void __exit rfkill_exit(void)
942 unregister_rfkill_notifier(&rfkill_blocking_uevent_nb);
943 class_unregister(&rfkill_class);
946 subsys_initcall(rfkill_init);
947 module_exit(rfkill_exit);