blob: 0ce5e0b52dbdef816607be8beae4c1b620b8b95a [file] [log] [blame]
Ivo van Doorncf4328c2007-05-07 00:34:20 -07001#ifndef __RFKILL_H
2#define __RFKILL_H
3
4/*
Ivo van Doornfe242cf2007-09-27 14:57:05 -07005 * Copyright (C) 2006 - 2007 Ivo van Doorn
Ivo van Doorncf4328c2007-05-07 00:34:20 -07006 * Copyright (C) 2007 Dmitry Torokhov
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the
20 * Free Software Foundation, Inc.,
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 */
23
24#include <linux/types.h>
25#include <linux/kernel.h>
26#include <linux/list.h>
27#include <linux/mutex.h>
28#include <linux/device.h>
Michael Buesch135900c2007-09-27 21:33:12 +020029#include <linux/leds.h>
Ivo van Doorncf4328c2007-05-07 00:34:20 -070030
31/**
32 * enum rfkill_type - type of rfkill switch.
Michael Buesch279632b2007-09-27 14:42:42 +020033 * RFKILL_TYPE_WLAN: switch is on a 802.11 wireless network device.
34 * RFKILL_TYPE_BLUETOOTH: switch is on a bluetooth device.
35 * RFKILL_TYPE_UWB: switch is on a ultra wideband device.
Ivo van Doorncf4328c2007-05-07 00:34:20 -070036 */
37enum rfkill_type {
Ivo van Doorn234a0ca2007-09-13 09:20:42 +020038 RFKILL_TYPE_WLAN ,
39 RFKILL_TYPE_BLUETOOTH,
Ivo van Doorne06654862007-09-13 09:21:31 +020040 RFKILL_TYPE_UWB,
Ivo van Doorn234a0ca2007-09-13 09:20:42 +020041 RFKILL_TYPE_MAX,
Ivo van Doorncf4328c2007-05-07 00:34:20 -070042};
43
44enum rfkill_state {
45 RFKILL_STATE_OFF = 0,
46 RFKILL_STATE_ON = 1,
47};
48
49/**
50 * struct rfkill - rfkill control structure.
51 * @name: Name of the switch.
52 * @type: Radio type which the button controls, the value stored
53 * here should be a value from enum rfkill_type.
54 * @state: State of the switch (on/off).
Michael Buesch20405c02007-09-27 21:34:23 +020055 * @user_claim_unsupported: Whether the hardware supports exclusive
56 * RF-kill control by userspace. Set this before registering.
Ivo van Doorncf4328c2007-05-07 00:34:20 -070057 * @user_claim: Set when the switch is controlled exlusively by userspace.
58 * @mutex: Guards switch state transitions
59 * @data: Pointer to the RF button drivers private data which will be
60 * passed along when toggling radio state.
61 * @toggle_radio(): Mandatory handler to control state of the radio.
Michael Buesch135900c2007-09-27 21:33:12 +020062 * @led_trigger: A LED trigger for this button's LED.
Ivo van Doorncf4328c2007-05-07 00:34:20 -070063 * @dev: Device structure integrating the switch into device tree.
64 * @node: Used to place switch into list of all switches known to the
65 * the system.
66 *
67 * This structure represents a RF switch located on a network device.
68 */
69struct rfkill {
Ivo van Doornc36befb2007-06-05 00:04:46 -070070 const char *name;
Ivo van Doorncf4328c2007-05-07 00:34:20 -070071 enum rfkill_type type;
72
73 enum rfkill_state state;
Michael Buesch20405c02007-09-27 21:34:23 +020074 bool user_claim_unsupported;
Ivo van Doorncf4328c2007-05-07 00:34:20 -070075 bool user_claim;
76
77 struct mutex mutex;
78
79 void *data;
80 int (*toggle_radio)(void *data, enum rfkill_state state);
81
Michael Buesch135900c2007-09-27 21:33:12 +020082#ifdef CONFIG_RFKILL_LEDS
83 struct led_trigger led_trigger;
84#endif
85
Ivo van Doorncf4328c2007-05-07 00:34:20 -070086 struct device dev;
87 struct list_head node;
88};
89#define to_rfkill(d) container_of(d, struct rfkill, dev)
90
91struct rfkill *rfkill_allocate(struct device *parent, enum rfkill_type type);
92void rfkill_free(struct rfkill *rfkill);
93int rfkill_register(struct rfkill *rfkill);
94void rfkill_unregister(struct rfkill *rfkill);
95
Michael Buesch135900c2007-09-27 21:33:12 +020096/**
97 * rfkill_get_led_name - Get the LED trigger name for the button's LED.
98 * This function might return a NULL pointer if registering of the
99 * LED trigger failed.
100 * Use this as "default_trigger" for the LED.
101 */
102static inline char *rfkill_get_led_name(struct rfkill *rfkill)
103{
104#ifdef CONFIG_RFKILL_LEDS
105 return (char *)(rfkill->led_trigger.name);
106#else
107 return NULL;
108#endif
109}
110
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700111#endif /* RFKILL_H */