rfkill.h 5.26 KB
Newer Older
1
2
3
4
#ifndef __RFKILL_H
#define __RFKILL_H

/*
5
 * Copyright (C) 2006 - 2007 Ivo van Doorn
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 * Copyright (C) 2007 Dmitry Torokhov
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the
 * Free Software Foundation, Inc.,
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/device.h>
29
#include <linux/leds.h>
30
31
32

/**
 * enum rfkill_type - type of rfkill switch.
33
34
35
 * RFKILL_TYPE_WLAN: switch is on a 802.11 wireless network device.
 * RFKILL_TYPE_BLUETOOTH: switch is on a bluetooth device.
 * RFKILL_TYPE_UWB: switch is on a ultra wideband device.
36
 * RFKILL_TYPE_WIMAX: switch is on a WiMAX device.
37
 * RFKILL_TYPE_WWAN: switch is on a wireless WAN device.
38
39
 */
enum rfkill_type {
Ivo van Doorn's avatar
Ivo van Doorn committed
40
41
	RFKILL_TYPE_WLAN ,
	RFKILL_TYPE_BLUETOOTH,
42
	RFKILL_TYPE_UWB,
43
	RFKILL_TYPE_WIMAX,
44
	RFKILL_TYPE_WWAN,
Ivo van Doorn's avatar
Ivo van Doorn committed
45
	RFKILL_TYPE_MAX,
46
47
48
};

enum rfkill_state {
49
50
51
	RFKILL_STATE_SOFT_BLOCKED = 0,	/* Radio output blocked */
	RFKILL_STATE_UNBLOCKED    = 1,	/* Radio output allowed */
	RFKILL_STATE_HARD_BLOCKED = 2,	/* Output blocked, non-overrideable */
52
53
};

54
55
56
57
58
59
60
61
/*
 * These are DEPRECATED, drivers using them should be verified to
 * comply with the rfkill usage guidelines in Documentation/rfkill.txt
 * and then converted to use the new names for rfkill_state
 */
#define RFKILL_STATE_OFF RFKILL_STATE_SOFT_BLOCKED
#define RFKILL_STATE_ON  RFKILL_STATE_UNBLOCKED

62
63
64
65
66
/**
 * struct rfkill - rfkill control structure.
 * @name: Name of the switch.
 * @type: Radio type which the button controls, the value stored
 *	here should be a value from enum rfkill_type.
67
 * @state: State of the switch, "UNBLOCKED" means radio can operate.
68
69
 * @user_claim_unsupported: Whether the hardware supports exclusive
 *	RF-kill control by userspace. Set this before registering.
70
 * @user_claim: Set when the switch is controlled exlusively by userspace.
71
72
 * @mutex: Guards switch state transitions.  It serializes callbacks
 *	and also protects the state.
73
74
75
 * @data: Pointer to the RF button drivers private data which will be
 *	passed along when toggling radio state.
 * @toggle_radio(): Mandatory handler to control state of the radio.
76
77
 *	only RFKILL_STATE_SOFT_BLOCKED and RFKILL_STATE_UNBLOCKED are
 *	valid parameters.
78
79
 * @get_state(): handler to read current radio state from hardware,
 *      may be called from atomic context, should return 0 on success.
80
81
 *      Either this handler OR judicious use of rfkill_force_state() is
 *      MANDATORY for any driver capable of RFKILL_STATE_HARD_BLOCKED.
82
 * @led_trigger: A LED trigger for this button's LED.
83
84
85
86
87
88
89
 * @dev: Device structure integrating the switch into device tree.
 * @node: Used to place switch into list of all switches known to the
 *	the system.
 *
 * This structure represents a RF switch located on a network device.
 */
struct rfkill {
90
	const char *name;
91
92
	enum rfkill_type type;

93
	bool user_claim_unsupported;
94
95
	bool user_claim;

96
97
	/* the mutex serializes callbacks and also protects
	 * the state */
98
	struct mutex mutex;
99
	enum rfkill_state state;
100
101
	void *data;
	int (*toggle_radio)(void *data, enum rfkill_state state);
102
	int (*get_state)(void *data, enum rfkill_state *state);
103

104
105
106
107
#ifdef CONFIG_RFKILL_LEDS
	struct led_trigger led_trigger;
#endif

108
109
110
111
112
	struct device dev;
	struct list_head node;
};
#define to_rfkill(d)	container_of(d, struct rfkill, dev)

113
114
struct rfkill * __must_check rfkill_allocate(struct device *parent,
					     enum rfkill_type type);
115
void rfkill_free(struct rfkill *rfkill);
116
int __must_check rfkill_register(struct rfkill *rfkill);
117
118
void rfkill_unregister(struct rfkill *rfkill);

119
int rfkill_force_state(struct rfkill *rfkill, enum rfkill_state state);
120
int rfkill_set_default(enum rfkill_type type, enum rfkill_state state);
121

122
123
124
125
126
127
128
129
130
131
132
133
134
/**
 * rfkill_state_complement - return complementar state
 * @state: state to return the complement of
 *
 * Returns RFKILL_STATE_SOFT_BLOCKED if @state is RFKILL_STATE_UNBLOCKED,
 * returns RFKILL_STATE_UNBLOCKED otherwise.
 */
static inline enum rfkill_state rfkill_state_complement(enum rfkill_state state)
{
	return (state == RFKILL_STATE_UNBLOCKED) ?
		RFKILL_STATE_SOFT_BLOCKED : RFKILL_STATE_UNBLOCKED;
}

135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/**
 * rfkill_get_led_name - Get the LED trigger name for the button's LED.
 * This function might return a NULL pointer if registering of the
 * LED trigger failed.
 * Use this as "default_trigger" for the LED.
 */
static inline char *rfkill_get_led_name(struct rfkill *rfkill)
{
#ifdef CONFIG_RFKILL_LEDS
	return (char *)(rfkill->led_trigger.name);
#else
	return NULL;
#endif
}

150
151
152
153
154
155
156
/* rfkill notification chain */
#define RFKILL_STATE_CHANGED		0x0001	/* state of a normal rfkill
						   switch has changed */

int register_rfkill_notifier(struct notifier_block *nb);
int unregister_rfkill_notifier(struct notifier_block *nb);

157
#endif /* RFKILL_H */