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_ON;
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_OFF)
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);
131 static int rfkill_toggle_radio(struct rfkill *rfkill,
132 enum rfkill_state state,
136 enum rfkill_state oldstate, newstate;
138 oldstate = rfkill->state;
140 if (rfkill->get_state && !force &&
141 !rfkill->get_state(rfkill->data, &newstate))
142 rfkill->state = newstate;
144 if (force || state != rfkill->state) {
145 retval = rfkill->toggle_radio(rfkill->data, state);
147 rfkill->state = state;
150 if (force || rfkill->state != oldstate) {
151 rfkill_led_trigger(rfkill, rfkill->state);
152 notify_rfkill_state_change(rfkill);
159 * rfkill_switch_all - Toggle state of all switches of given type
160 * @type: type of interfaces to be affeceted
161 * @state: the new state
163 * This function toggles state of all switches of given type unless
164 * a specific switch is claimed by userspace in which case it is
167 void rfkill_switch_all(enum rfkill_type type, enum rfkill_state state)
169 struct rfkill *rfkill;
171 mutex_lock(&rfkill_mutex);
173 rfkill_states[type] = state;
175 list_for_each_entry(rfkill, &rfkill_list, node) {
176 if ((!rfkill->user_claim) && (rfkill->type == type))
177 rfkill_toggle_radio(rfkill, state, 0);
180 mutex_unlock(&rfkill_mutex);
182 EXPORT_SYMBOL(rfkill_switch_all);
185 * rfkill_force_state - Force the internal rfkill radio state
186 * @rfkill: pointer to the rfkill class to modify.
187 * @state: the current radio state the class should be forced to.
189 * This function updates the internal state of the radio cached
190 * by the rfkill class. It should be used when the driver gets
191 * a notification by the firmware/hardware of the current *real*
192 * state of the radio rfkill switch.
194 * It may not be called from an atomic context.
196 int rfkill_force_state(struct rfkill *rfkill, enum rfkill_state state)
198 enum rfkill_state oldstate;
200 if (state != RFKILL_STATE_OFF &&
201 state != RFKILL_STATE_ON)
204 mutex_lock(&rfkill->mutex);
206 oldstate = rfkill->state;
207 rfkill->state = state;
209 if (state != oldstate)
210 notify_rfkill_state_change(rfkill);
212 mutex_unlock(&rfkill->mutex);
216 EXPORT_SYMBOL(rfkill_force_state);
218 static ssize_t rfkill_name_show(struct device *dev,
219 struct device_attribute *attr,
222 struct rfkill *rfkill = to_rfkill(dev);
224 return sprintf(buf, "%s\n", rfkill->name);
227 static const char *rfkill_get_type_str(enum rfkill_type type)
230 case RFKILL_TYPE_WLAN:
232 case RFKILL_TYPE_BLUETOOTH:
234 case RFKILL_TYPE_UWB:
235 return "ultrawideband";
236 case RFKILL_TYPE_WIMAX:
238 case RFKILL_TYPE_WWAN:
245 static ssize_t rfkill_type_show(struct device *dev,
246 struct device_attribute *attr,
249 struct rfkill *rfkill = to_rfkill(dev);
251 return sprintf(buf, "%s\n", rfkill_get_type_str(rfkill->type));
254 static ssize_t rfkill_state_show(struct device *dev,
255 struct device_attribute *attr,
258 struct rfkill *rfkill = to_rfkill(dev);
260 update_rfkill_state(rfkill);
261 return sprintf(buf, "%d\n", rfkill->state);
264 static ssize_t rfkill_state_store(struct device *dev,
265 struct device_attribute *attr,
266 const char *buf, size_t count)
268 struct rfkill *rfkill = to_rfkill(dev);
269 unsigned int state = simple_strtoul(buf, NULL, 0);
272 if (!capable(CAP_NET_ADMIN))
275 if (mutex_lock_interruptible(&rfkill->mutex))
277 error = rfkill_toggle_radio(rfkill,
278 state ? RFKILL_STATE_ON : RFKILL_STATE_OFF,
280 mutex_unlock(&rfkill->mutex);
282 return error ? error : count;
285 static ssize_t rfkill_claim_show(struct device *dev,
286 struct device_attribute *attr,
289 struct rfkill *rfkill = to_rfkill(dev);
291 return sprintf(buf, "%d", rfkill->user_claim);
294 static ssize_t rfkill_claim_store(struct device *dev,
295 struct device_attribute *attr,
296 const char *buf, size_t count)
298 struct rfkill *rfkill = to_rfkill(dev);
299 bool claim = !!simple_strtoul(buf, NULL, 0);
302 if (!capable(CAP_NET_ADMIN))
306 * Take the global lock to make sure the kernel is not in
307 * the middle of rfkill_switch_all
309 error = mutex_lock_interruptible(&rfkill_mutex);
313 if (rfkill->user_claim_unsupported) {
317 if (rfkill->user_claim != claim) {
319 rfkill_toggle_radio(rfkill,
320 rfkill_states[rfkill->type],
322 rfkill->user_claim = claim;
326 mutex_unlock(&rfkill_mutex);
328 return error ? error : count;
331 static struct device_attribute rfkill_dev_attrs[] = {
332 __ATTR(name, S_IRUGO, rfkill_name_show, NULL),
333 __ATTR(type, S_IRUGO, rfkill_type_show, NULL),
334 __ATTR(state, S_IRUGO|S_IWUSR, rfkill_state_show, rfkill_state_store),
335 __ATTR(claim, S_IRUGO|S_IWUSR, rfkill_claim_show, rfkill_claim_store),
339 static void rfkill_release(struct device *dev)
341 struct rfkill *rfkill = to_rfkill(dev);
344 module_put(THIS_MODULE);
348 static int rfkill_suspend(struct device *dev, pm_message_t state)
350 struct rfkill *rfkill = to_rfkill(dev);
352 if (dev->power.power_state.event != state.event) {
353 if (state.event & PM_EVENT_SLEEP) {
354 /* Stop transmitter, keep state, no notifies */
355 update_rfkill_state(rfkill);
357 mutex_lock(&rfkill->mutex);
358 rfkill->toggle_radio(rfkill->data, RFKILL_STATE_OFF);
359 mutex_unlock(&rfkill->mutex);
362 dev->power.power_state = state;
368 static int rfkill_resume(struct device *dev)
370 struct rfkill *rfkill = to_rfkill(dev);
372 if (dev->power.power_state.event != PM_EVENT_ON) {
373 mutex_lock(&rfkill->mutex);
375 /* restore radio state AND notify everybody */
376 rfkill_toggle_radio(rfkill, rfkill->state, 1);
378 mutex_unlock(&rfkill->mutex);
381 dev->power.power_state = PMSG_ON;
385 #define rfkill_suspend NULL
386 #define rfkill_resume NULL
389 static int rfkill_blocking_uevent_notifier(struct notifier_block *nb,
390 unsigned long eventid,
393 struct rfkill *rfkill = (struct rfkill *)data;
396 case RFKILL_STATE_CHANGED:
397 kobject_uevent(&rfkill->dev.kobj, KOBJ_CHANGE);
406 static struct notifier_block rfkill_blocking_uevent_nb = {
407 .notifier_call = rfkill_blocking_uevent_notifier,
411 static int rfkill_dev_uevent(struct device *dev, struct kobj_uevent_env *env)
413 struct rfkill *rfkill = to_rfkill(dev);
416 error = add_uevent_var(env, "RFKILL_NAME=%s", rfkill->name);
419 error = add_uevent_var(env, "RFKILL_TYPE=%s",
420 rfkill_get_type_str(rfkill->type));
423 error = add_uevent_var(env, "RFKILL_STATE=%d", rfkill->state);
427 static struct class rfkill_class = {
429 .dev_release = rfkill_release,
430 .dev_attrs = rfkill_dev_attrs,
431 .suspend = rfkill_suspend,
432 .resume = rfkill_resume,
433 .dev_uevent = rfkill_dev_uevent,
436 static int rfkill_add_switch(struct rfkill *rfkill)
440 mutex_lock(&rfkill_mutex);
442 error = rfkill_toggle_radio(rfkill, rfkill_states[rfkill->type], 0);
444 list_add_tail(&rfkill->node, &rfkill_list);
446 mutex_unlock(&rfkill_mutex);
451 static void rfkill_remove_switch(struct rfkill *rfkill)
453 mutex_lock(&rfkill_mutex);
454 list_del_init(&rfkill->node);
455 rfkill_toggle_radio(rfkill, RFKILL_STATE_OFF, 1);
456 mutex_unlock(&rfkill_mutex);
460 * rfkill_allocate - allocate memory for rfkill structure.
461 * @parent: device that has rf switch on it
462 * @type: type of the switch (RFKILL_TYPE_*)
464 * This function should be called by the network driver when it needs
465 * rfkill structure. Once the structure is allocated the driver shoud
466 * finish its initialization by setting name, private data, enable_radio
467 * and disable_radio methods and then register it with rfkill_register().
468 * NOTE: If registration fails the structure shoudl be freed by calling
469 * rfkill_free() otherwise rfkill_unregister() should be used.
471 struct rfkill *rfkill_allocate(struct device *parent, enum rfkill_type type)
473 struct rfkill *rfkill;
476 rfkill = kzalloc(sizeof(struct rfkill), GFP_KERNEL);
480 mutex_init(&rfkill->mutex);
481 INIT_LIST_HEAD(&rfkill->node);
485 dev->class = &rfkill_class;
486 dev->parent = parent;
487 device_initialize(dev);
489 __module_get(THIS_MODULE);
493 EXPORT_SYMBOL(rfkill_allocate);
496 * rfkill_free - Mark rfkill structure for deletion
497 * @rfkill: rfkill structure to be destroyed
499 * Decrements reference count of rfkill structure so it is destroyed.
500 * Note that rfkill_free() should _not_ be called after rfkill_unregister().
502 void rfkill_free(struct rfkill *rfkill)
505 put_device(&rfkill->dev);
507 EXPORT_SYMBOL(rfkill_free);
509 static void rfkill_led_trigger_register(struct rfkill *rfkill)
511 #ifdef CONFIG_RFKILL_LEDS
514 rfkill->led_trigger.name = rfkill->dev.bus_id;
515 error = led_trigger_register(&rfkill->led_trigger);
517 rfkill->led_trigger.name = NULL;
518 #endif /* CONFIG_RFKILL_LEDS */
521 static void rfkill_led_trigger_unregister(struct rfkill *rfkill)
523 #ifdef CONFIG_RFKILL_LEDS
524 if (rfkill->led_trigger.name)
525 led_trigger_unregister(&rfkill->led_trigger);
530 * rfkill_register - Register a rfkill structure.
531 * @rfkill: rfkill structure to be registered
533 * This function should be called by the network driver when the rfkill
534 * structure needs to be registered. Immediately from registration the
535 * switch driver should be able to service calls to toggle_radio.
537 int rfkill_register(struct rfkill *rfkill)
539 static atomic_t rfkill_no = ATOMIC_INIT(0);
540 struct device *dev = &rfkill->dev;
543 if (!rfkill->toggle_radio)
545 if (rfkill->type >= RFKILL_TYPE_MAX)
548 snprintf(dev->bus_id, sizeof(dev->bus_id),
549 "rfkill%ld", (long)atomic_inc_return(&rfkill_no) - 1);
551 rfkill_led_trigger_register(rfkill);
553 error = rfkill_add_switch(rfkill);
555 rfkill_led_trigger_unregister(rfkill);
559 error = device_add(dev);
561 rfkill_led_trigger_unregister(rfkill);
562 rfkill_remove_switch(rfkill);
568 EXPORT_SYMBOL(rfkill_register);
571 * rfkill_unregister - Unregister a rfkill structure.
572 * @rfkill: rfkill structure to be unregistered
574 * This function should be called by the network driver during device
575 * teardown to destroy rfkill structure. Note that rfkill_free() should
576 * _not_ be called after rfkill_unregister().
578 void rfkill_unregister(struct rfkill *rfkill)
580 device_del(&rfkill->dev);
581 rfkill_remove_switch(rfkill);
582 rfkill_led_trigger_unregister(rfkill);
583 put_device(&rfkill->dev);
585 EXPORT_SYMBOL(rfkill_unregister);
588 * Rfkill module initialization/deinitialization.
590 static int __init rfkill_init(void)
595 if (rfkill_default_state != RFKILL_STATE_OFF &&
596 rfkill_default_state != RFKILL_STATE_ON)
599 for (i = 0; i < ARRAY_SIZE(rfkill_states); i++)
600 rfkill_states[i] = rfkill_default_state;
602 error = class_register(&rfkill_class);
604 printk(KERN_ERR "rfkill: unable to register rfkill class\n");
608 register_rfkill_notifier(&rfkill_blocking_uevent_nb);
613 static void __exit rfkill_exit(void)
615 unregister_rfkill_notifier(&rfkill_blocking_uevent_nb);
616 class_unregister(&rfkill_class);
619 subsys_initcall(rfkill_init);
620 module_exit(rfkill_exit);