blob: 164332cbb77c81e7623dc5c9c193739cd7f87313 [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.
Iñaky Pérez-González303d9bf2008-01-23 13:40:27 -080036 * RFKILL_TYPE_WIMAX: switch is on a WiMAX device.
Henrique de Moraes Holschuh477576a2008-06-23 17:23:01 -030037 * RFKILL_TYPE_WWAN: switch is on a wireless WAN device.
Ivo van Doorncf4328c2007-05-07 00:34:20 -070038 */
39enum rfkill_type {
Ivo van Doorn234a0ca2007-09-13 09:20:42 +020040 RFKILL_TYPE_WLAN ,
41 RFKILL_TYPE_BLUETOOTH,
Ivo van Doorne0665482007-09-13 09:21:31 +020042 RFKILL_TYPE_UWB,
Iñaky Pérez-González303d9bf2008-01-23 13:40:27 -080043 RFKILL_TYPE_WIMAX,
Henrique de Moraes Holschuh477576a2008-06-23 17:23:01 -030044 RFKILL_TYPE_WWAN,
Ivo van Doorn234a0ca2007-09-13 09:20:42 +020045 RFKILL_TYPE_MAX,
Ivo van Doorncf4328c2007-05-07 00:34:20 -070046};
47
48enum rfkill_state {
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -030049 RFKILL_STATE_SOFT_BLOCKED = 0, /* Radio output blocked */
50 RFKILL_STATE_UNBLOCKED = 1, /* Radio output allowed */
51 RFKILL_STATE_HARD_BLOCKED = 2, /* Output blocked, non-overrideable */
Henrique de Moraes Holschuh96c87602008-08-02 15:11:00 -030052 RFKILL_STATE_MAX, /* marker for last valid state */
Ivo van Doorncf4328c2007-05-07 00:34:20 -070053};
54
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -030055/*
56 * These are DEPRECATED, drivers using them should be verified to
57 * comply with the rfkill usage guidelines in Documentation/rfkill.txt
58 * and then converted to use the new names for rfkill_state
59 */
60#define RFKILL_STATE_OFF RFKILL_STATE_SOFT_BLOCKED
61#define RFKILL_STATE_ON RFKILL_STATE_UNBLOCKED
62
Ivo van Doorncf4328c2007-05-07 00:34:20 -070063/**
64 * struct rfkill - rfkill control structure.
65 * @name: Name of the switch.
66 * @type: Radio type which the button controls, the value stored
67 * here should be a value from enum rfkill_type.
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -030068 * @state: State of the switch, "UNBLOCKED" means radio can operate.
Michael Buesch20405c02007-09-27 21:34:23 +020069 * @user_claim_unsupported: Whether the hardware supports exclusive
70 * RF-kill control by userspace. Set this before registering.
Ivo van Doorncf4328c2007-05-07 00:34:20 -070071 * @user_claim: Set when the switch is controlled exlusively by userspace.
Henrique de Moraes Holschuhf1b23362008-07-21 21:18:19 -030072 * @mutex: Guards switch state transitions. It serializes callbacks
73 * and also protects the state.
Ivo van Doorncf4328c2007-05-07 00:34:20 -070074 * @data: Pointer to the RF button drivers private data which will be
75 * passed along when toggling radio state.
76 * @toggle_radio(): Mandatory handler to control state of the radio.
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -030077 * only RFKILL_STATE_SOFT_BLOCKED and RFKILL_STATE_UNBLOCKED are
78 * valid parameters.
Henrique de Moraes Holschuh801e49a2008-06-23 17:23:00 -030079 * @get_state(): handler to read current radio state from hardware,
80 * may be called from atomic context, should return 0 on success.
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -030081 * Either this handler OR judicious use of rfkill_force_state() is
82 * MANDATORY for any driver capable of RFKILL_STATE_HARD_BLOCKED.
Michael Buesch135900c2007-09-27 21:33:12 +020083 * @led_trigger: A LED trigger for this button's LED.
Ivo van Doorncf4328c2007-05-07 00:34:20 -070084 * @dev: Device structure integrating the switch into device tree.
85 * @node: Used to place switch into list of all switches known to the
86 * the system.
87 *
88 * This structure represents a RF switch located on a network device.
89 */
90struct rfkill {
Ivo van Doornc36befb2007-06-05 00:04:46 -070091 const char *name;
Ivo van Doorncf4328c2007-05-07 00:34:20 -070092 enum rfkill_type type;
93
Michael Buesch20405c02007-09-27 21:34:23 +020094 bool user_claim_unsupported;
Ivo van Doorncf4328c2007-05-07 00:34:20 -070095 bool user_claim;
96
Henrique de Moraes Holschuhf1b23362008-07-21 21:18:19 -030097 /* the mutex serializes callbacks and also protects
98 * the state */
Ivo van Doorncf4328c2007-05-07 00:34:20 -070099 struct mutex mutex;
Henrique de Moraes Holschuhf1b23362008-07-21 21:18:19 -0300100 enum rfkill_state state;
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700101 void *data;
102 int (*toggle_radio)(void *data, enum rfkill_state state);
Henrique de Moraes Holschuh801e49a2008-06-23 17:23:00 -0300103 int (*get_state)(void *data, enum rfkill_state *state);
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700104
Michael Buesch135900c2007-09-27 21:33:12 +0200105#ifdef CONFIG_RFKILL_LEDS
106 struct led_trigger led_trigger;
107#endif
108
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700109 struct device dev;
110 struct list_head node;
Henrique de Moraes Holschuhf80b5e92008-11-21 20:40:09 -0200111 enum rfkill_state state_for_resume;
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700112};
113#define to_rfkill(d) container_of(d, struct rfkill, dev)
114
Henrique de Moraes Holschuh77fba132008-08-02 15:10:59 -0300115struct rfkill * __must_check rfkill_allocate(struct device *parent,
116 enum rfkill_type type);
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700117void rfkill_free(struct rfkill *rfkill);
Henrique de Moraes Holschuh77fba132008-08-02 15:10:59 -0300118int __must_check rfkill_register(struct rfkill *rfkill);
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700119void rfkill_unregister(struct rfkill *rfkill);
120
Henrique de Moraes Holschuh801e49a2008-06-23 17:23:00 -0300121int rfkill_force_state(struct rfkill *rfkill, enum rfkill_state state);
Henrique de Moraes Holschuh99619202008-08-02 15:10:58 -0300122int rfkill_set_default(enum rfkill_type type, enum rfkill_state state);
Henrique de Moraes Holschuh801e49a2008-06-23 17:23:00 -0300123
Michael Buesch135900c2007-09-27 21:33:12 +0200124/**
Henrique de Moraes Holschuh50056572008-06-23 17:46:42 -0300125 * rfkill_state_complement - return complementar state
126 * @state: state to return the complement of
127 *
128 * Returns RFKILL_STATE_SOFT_BLOCKED if @state is RFKILL_STATE_UNBLOCKED,
129 * returns RFKILL_STATE_UNBLOCKED otherwise.
130 */
131static inline enum rfkill_state rfkill_state_complement(enum rfkill_state state)
132{
133 return (state == RFKILL_STATE_UNBLOCKED) ?
134 RFKILL_STATE_SOFT_BLOCKED : RFKILL_STATE_UNBLOCKED;
135}
136
137/**
Michael Buesch135900c2007-09-27 21:33:12 +0200138 * rfkill_get_led_name - Get the LED trigger name for the button's LED.
139 * This function might return a NULL pointer if registering of the
140 * LED trigger failed.
141 * Use this as "default_trigger" for the LED.
142 */
143static inline char *rfkill_get_led_name(struct rfkill *rfkill)
144{
145#ifdef CONFIG_RFKILL_LEDS
146 return (char *)(rfkill->led_trigger.name);
147#else
148 return NULL;
149#endif
150}
151
Ivo van Doorncf4328c2007-05-07 00:34:20 -0700152#endif /* RFKILL_H */