blob: 2ce29831feb61d9c0d7aefa5f0f3446f17519220 [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
Johannes Berg19d337d2009-06-02 13:01:37 +02007 * Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
Ivo van Doorncf4328c2007-05-07 00:34:20 -07008 *
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
Johannes Bergc64fb012009-06-02 13:01:38 +020025#include <linux/types.h>
Johannes Berg19d337d2009-06-02 13:01:37 +020026
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
Johannes Bergc64fb012009-06-02 13:01:38 +020032/**
33 * enum rfkill_type - type of rfkill switch.
34 *
35 * @RFKILL_TYPE_ALL: toggles all switches (userspace only)
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
42 */
43enum rfkill_type {
44 RFKILL_TYPE_ALL = 0,
45 RFKILL_TYPE_WLAN,
46 RFKILL_TYPE_BLUETOOTH,
47 RFKILL_TYPE_UWB,
48 RFKILL_TYPE_WIMAX,
49 RFKILL_TYPE_WWAN,
50 NUM_RFKILL_TYPES,
51};
52
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 */
60enum 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 */
78struct 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
Johannes Berg19d337d2009-06-02 13:01:37 +020090/* and that's all userspace gets */
91#ifdef __KERNEL__
92/* don't allow anyone to use these in the kernel */
93enum 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
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700102#include <linux/kernel.h>
103#include <linux/list.h>
104#include <linux/mutex.h>
105#include <linux/device.h>
Michael Buesch135900c2007-09-27 21:33:12 +0200106#include <linux/leds.h>
Johannes Berg1506e302009-06-09 17:49:06 -0700107#include <linux/err.h>
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700108
Johannes Berg19d337d2009-06-02 13:01:37 +0200109/* this is opaque */
110struct rfkill;
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700111
112/**
Johannes Berg19d337d2009-06-02 13:01:37 +0200113 * struct rfkill_ops - rfkill driver methods
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700114 *
Johannes Berg19d337d2009-06-02 13:01:37 +0200115 * @poll: poll the rfkill block state(s) -- only assign this method
116 * when you need polling. When called, simply call one of the
117 * rfkill_set{,_hw,_sw}_state family of functions. If the hw
118 * is getting unblocked you need to take into account the return
119 * value of those functions to make sure the software block is
120 * properly used.
121 * @query: query the rfkill block state(s) and call exactly one of the
122 * rfkill_set{,_hw,_sw}_state family of functions. Assign this
123 * method if input events can cause hardware state changes to make
124 * the rfkill core query your driver before setting a requested
125 * block.
126 * @set_block: turn the transmitter on (blocked == false) or off
Johannes Bergc64fb012009-06-02 13:01:38 +0200127 * (blocked == true) -- ignore and return 0 when hard blocked.
Johannes Berg19d337d2009-06-02 13:01:37 +0200128 * This callback must be assigned.
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700129 */
Johannes Berg19d337d2009-06-02 13:01:37 +0200130struct rfkill_ops {
131 void (*poll)(struct rfkill *rfkill, void *data);
132 void (*query)(struct rfkill *rfkill, void *data);
133 int (*set_block)(void *data, bool blocked);
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700134};
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700135
Johannes Berg19d337d2009-06-02 13:01:37 +0200136#if defined(CONFIG_RFKILL) || defined(CONFIG_RFKILL_MODULE)
137/**
138 * rfkill_alloc - allocate rfkill structure
139 * @name: name of the struct -- the string is not copied internally
140 * @parent: device that has rf switch on it
141 * @type: type of the switch (RFKILL_TYPE_*)
142 * @ops: rfkill methods
143 * @ops_data: data passed to each method
144 *
145 * This function should be called by the transmitter driver to allocate an
146 * rfkill structure. Returns %NULL on failure.
147 */
148struct rfkill * __must_check rfkill_alloc(const char *name,
149 struct device *parent,
150 const enum rfkill_type type,
151 const struct rfkill_ops *ops,
152 void *ops_data);
153
154/**
155 * rfkill_register - Register a rfkill structure.
156 * @rfkill: rfkill structure to be registered
157 *
158 * This function should be called by the transmitter driver to register
Alan Jenkinsb3fa1322009-06-08 13:27:27 +0100159 * the rfkill structure. Before calling this function the driver needs
160 * to be ready to service method calls from rfkill.
161 *
Alan Jenkins06d5caf2009-06-16 15:39:51 +0100162 * If rfkill_init_sw_state() is not called before registration,
163 * set_block() will be called to initialize the software blocked state
164 * to a default value.
Alan Jenkinsb3fa1322009-06-08 13:27:27 +0100165 *
166 * If the hardware blocked state is not set before registration,
167 * it is assumed to be unblocked.
Johannes Berg19d337d2009-06-02 13:01:37 +0200168 */
Henrique de Moraes Holschuh77fba132008-08-02 15:10:59 -0300169int __must_check rfkill_register(struct rfkill *rfkill);
Johannes Berg19d337d2009-06-02 13:01:37 +0200170
171/**
172 * rfkill_pause_polling(struct rfkill *rfkill)
173 *
174 * Pause polling -- say transmitter is off for other reasons.
175 * NOTE: not necessary for suspend/resume -- in that case the
176 * core stops polling anyway
177 */
178void rfkill_pause_polling(struct rfkill *rfkill);
179
180/**
181 * rfkill_resume_polling(struct rfkill *rfkill)
182 *
183 * Pause polling -- say transmitter is off for other reasons.
184 * NOTE: not necessary for suspend/resume -- in that case the
185 * core stops polling anyway
186 */
187void rfkill_resume_polling(struct rfkill *rfkill);
188
189
190/**
191 * rfkill_unregister - Unregister a rfkill structure.
192 * @rfkill: rfkill structure to be unregistered
193 *
194 * This function should be called by the network driver during device
195 * teardown to destroy rfkill structure. Until it returns, the driver
196 * needs to be able to service method calls.
197 */
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700198void rfkill_unregister(struct rfkill *rfkill);
199
Michael Buesch135900c2007-09-27 21:33:12 +0200200/**
Johannes Berg19d337d2009-06-02 13:01:37 +0200201 * rfkill_destroy - free rfkill structure
202 * @rfkill: rfkill structure to be destroyed
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -0300203 *
Johannes Berg19d337d2009-06-02 13:01:37 +0200204 * Destroys the rfkill structure.
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -0300205 */
Johannes Berg19d337d2009-06-02 13:01:37 +0200206void rfkill_destroy(struct rfkill *rfkill);
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -0300207
208/**
Johannes Berg19d337d2009-06-02 13:01:37 +0200209 * rfkill_set_hw_state - Set the internal rfkill hardware block state
210 * @rfkill: pointer to the rfkill class to modify.
211 * @state: the current hardware block state to set
212 *
213 * rfkill drivers that get events when the hard-blocked state changes
214 * use this function to notify the rfkill core (and through that also
Alan Jenkins908209c2009-06-08 13:12:23 +0100215 * userspace) of the current state. They should also use this after
Johannes Berg19d337d2009-06-02 13:01:37 +0200216 * resume if the state could have changed.
217 *
218 * You need not (but may) call this function if poll_state is assigned.
219 *
220 * This function can be called in any context, even from within rfkill
221 * callbacks.
222 *
223 * The function returns the combined block state (true if transmitter
224 * should be blocked) so that drivers need not keep track of the soft
225 * block state -- which they might not be able to.
Michael Buesch135900c2007-09-27 21:33:12 +0200226 */
Johannes Berg19d337d2009-06-02 13:01:37 +0200227bool __must_check rfkill_set_hw_state(struct rfkill *rfkill, bool blocked);
228
229/**
230 * rfkill_set_sw_state - Set the internal rfkill software block state
231 * @rfkill: pointer to the rfkill class to modify.
232 * @state: the current software block state to set
233 *
234 * rfkill drivers that get events when the soft-blocked state changes
235 * (yes, some platforms directly act on input but allow changing again)
236 * use this function to notify the rfkill core (and through that also
Alan Jenkins06d5caf2009-06-16 15:39:51 +0100237 * userspace) of the current state.
238 *
239 * Drivers should also call this function after resume if the state has
240 * been changed by the user. This only makes sense for "persistent"
241 * devices (see rfkill_init_sw_state()).
Johannes Berg19d337d2009-06-02 13:01:37 +0200242 *
243 * This function can be called in any context, even from within rfkill
244 * callbacks.
245 *
246 * The function returns the combined block state (true if transmitter
247 * should be blocked).
248 */
249bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);
250
251/**
Alan Jenkins06d5caf2009-06-16 15:39:51 +0100252 * rfkill_init_sw_state - Initialize persistent software block state
253 * @rfkill: pointer to the rfkill class to modify.
254 * @state: the current software block state to set
255 *
256 * rfkill drivers that preserve their software block state over power off
257 * use this function to notify the rfkill core (and through that also
258 * userspace) of their initial state. It should only be used before
259 * registration.
260 *
Alan Jenkins464902e2009-06-16 14:54:04 +0100261 * In addition, it marks the device as "persistent", an attribute which
262 * can be read by userspace. Persistent devices are expected to preserve
263 * their own state when suspended.
Alan Jenkins06d5caf2009-06-16 15:39:51 +0100264 */
265void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked);
266
267/**
Johannes Berg19d337d2009-06-02 13:01:37 +0200268 * rfkill_set_states - Set the internal rfkill block states
269 * @rfkill: pointer to the rfkill class to modify.
270 * @sw: the current software block state to set
271 * @hw: the current hardware block state to set
272 *
273 * This function can be called in any context, even from within rfkill
274 * callbacks.
275 */
276void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);
277
278/**
Johannes Berg60811622009-06-02 13:01:40 +0200279 * rfkill_blocked - query rfkill block
280 *
281 * @rfkill: rfkill struct to query
282 */
283bool rfkill_blocked(struct rfkill *rfkill);
Johannes Berg19d337d2009-06-02 13:01:37 +0200284#else /* !RFKILL */
285static inline struct rfkill * __must_check
286rfkill_alloc(const char *name,
287 struct device *parent,
288 const enum rfkill_type type,
289 const struct rfkill_ops *ops,
290 void *ops_data)
Michael Buesch135900c2007-09-27 21:33:12 +0200291{
Johannes Berg19d337d2009-06-02 13:01:37 +0200292 return ERR_PTR(-ENODEV);
Michael Buesch135900c2007-09-27 21:33:12 +0200293}
294
Johannes Berg19d337d2009-06-02 13:01:37 +0200295static inline int __must_check rfkill_register(struct rfkill *rfkill)
296{
297 if (rfkill == ERR_PTR(-ENODEV))
298 return 0;
299 return -EINVAL;
300}
301
302static inline void rfkill_pause_polling(struct rfkill *rfkill)
303{
304}
305
306static inline void rfkill_resume_polling(struct rfkill *rfkill)
307{
308}
309
310static inline void rfkill_unregister(struct rfkill *rfkill)
311{
312}
313
314static inline void rfkill_destroy(struct rfkill *rfkill)
315{
316}
317
318static inline bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked)
319{
320 return blocked;
321}
322
323static inline bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked)
324{
325 return blocked;
326}
327
Alan Jenkins06d5caf2009-06-16 15:39:51 +0100328static inline void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked)
329{
330}
331
Johannes Berg19d337d2009-06-02 13:01:37 +0200332static inline void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw)
333{
334}
335
Johannes Berg60811622009-06-02 13:01:40 +0200336static inline bool rfkill_blocked(struct rfkill *rfkill)
337{
338 return false;
339}
Johannes Berg19d337d2009-06-02 13:01:37 +0200340#endif /* RFKILL || RFKILL_MODULE */
341
342
343#ifdef CONFIG_RFKILL_LEDS
344/**
345 * rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED.
346 * This function might return a NULL pointer if registering of the
347 * LED trigger failed. Use this as "default_trigger" for the LED.
348 */
349const char *rfkill_get_led_trigger_name(struct rfkill *rfkill);
350
351/**
352 * rfkill_set_led_trigger_name -- set the LED trigger name
353 * @rfkill: rfkill struct
354 * @name: LED trigger name
355 *
356 * This function sets the LED trigger name of the radio LED
357 * trigger that rfkill creates. It is optional, but if called
358 * must be called before rfkill_register() to be effective.
359 */
360void rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name);
361#else
362static inline const char *rfkill_get_led_trigger_name(struct rfkill *rfkill)
363{
364 return NULL;
365}
366
367static inline void
368rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name)
369{
370}
371#endif
372
373#endif /* __KERNEL__ */
374
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700375#endif /* RFKILL_H */