rfkill.h 3.77 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
	RFKILL_STATE_OFF	= 0,	/* Radio output blocked */
	RFKILL_STATE_ON		= 1,	/* Radio output active */
51
52
53
54
55
56
57
};

/**
 * 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.
58
 * @state: State of the switch, "ON" means radio can operate.
59
60
 * @user_claim_unsupported: Whether the hardware supports exclusive
 *	RF-kill control by userspace. Set this before registering.
61
62
63
64
65
 * @user_claim: Set when the switch is controlled exlusively by userspace.
 * @mutex: Guards switch state transitions
 * @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.
66
67
 * @get_state(): handler to read current radio state from hardware,
 *      may be called from atomic context, should return 0 on success.
68
 * @led_trigger: A LED trigger for this button's LED.
69
70
71
72
73
74
75
 * @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 {
76
	const char *name;
77
78
79
	enum rfkill_type type;

	enum rfkill_state state;
80
	bool user_claim_unsupported;
81
82
83
84
85
86
	bool user_claim;

	struct mutex mutex;

	void *data;
	int (*toggle_radio)(void *data, enum rfkill_state state);
87
	int (*get_state)(void *data, enum rfkill_state *state);
88

89
90
91
92
#ifdef CONFIG_RFKILL_LEDS
	struct led_trigger led_trigger;
#endif

93
94
95
96
97
98
99
100
101
102
	struct device dev;
	struct list_head node;
};
#define to_rfkill(d)	container_of(d, struct rfkill, dev)

struct rfkill *rfkill_allocate(struct device *parent, enum rfkill_type type);
void rfkill_free(struct rfkill *rfkill);
int rfkill_register(struct rfkill *rfkill);
void rfkill_unregister(struct rfkill *rfkill);

103
104
int rfkill_force_state(struct rfkill *rfkill, enum rfkill_state state);

105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/**
 * 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
}

120
#endif /* RFKILL_H */