1 /*
2  * Copyright (C) 2006 - 2007 Ivo van Doorn
3  * Copyright (C) 2007 Dmitry Torokhov
4  * Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 #ifndef __RFKILL_H
19 #define __RFKILL_H
20 
21 #include <uapi/linux/rfkill.h>
22 
23 /* don't allow anyone to use these in the kernel */
24 enum rfkill_user_states {
25 	RFKILL_USER_STATE_SOFT_BLOCKED	= RFKILL_STATE_SOFT_BLOCKED,
26 	RFKILL_USER_STATE_UNBLOCKED	= RFKILL_STATE_UNBLOCKED,
27 	RFKILL_USER_STATE_HARD_BLOCKED	= RFKILL_STATE_HARD_BLOCKED,
28 };
29 #undef RFKILL_STATE_SOFT_BLOCKED
30 #undef RFKILL_STATE_UNBLOCKED
31 #undef RFKILL_STATE_HARD_BLOCKED
32 
33 #include <linux/kernel.h>
34 #include <linux/list.h>
35 #include <linux/mutex.h>
36 #include <linux/leds.h>
37 #include <linux/err.h>
38 
39 struct device;
40 /* this is opaque */
41 struct rfkill;
42 
43 /**
44  * struct rfkill_ops - rfkill driver methods
45  *
46  * @poll: poll the rfkill block state(s) -- only assign this method
47  *	when you need polling. When called, simply call one of the
48  *	rfkill_set{,_hw,_sw}_state family of functions. If the hw
49  *	is getting unblocked you need to take into account the return
50  *	value of those functions to make sure the software block is
51  *	properly used.
52  * @query: query the rfkill block state(s) and call exactly one of the
53  *	rfkill_set{,_hw,_sw}_state family of functions. Assign this
54  *	method if input events can cause hardware state changes to make
55  *	the rfkill core query your driver before setting a requested
56  *	block.
57  * @set_block: turn the transmitter on (blocked == false) or off
58  *	(blocked == true) -- ignore and return 0 when hard blocked.
59  *	This callback must be assigned.
60  */
61 struct rfkill_ops {
62 	void	(*poll)(struct rfkill *rfkill, void *data);
63 	void	(*query)(struct rfkill *rfkill, void *data);
64 	int	(*set_block)(void *data, bool blocked);
65 };
66 
67 #if defined(CONFIG_RFKILL) || defined(CONFIG_RFKILL_MODULE)
68 /**
69  * rfkill_alloc - Allocate rfkill structure
70  * @name: name of the struct -- the string is not copied internally
71  * @parent: device that has rf switch on it
72  * @type: type of the switch (RFKILL_TYPE_*)
73  * @ops: rfkill methods
74  * @ops_data: data passed to each method
75  *
76  * This function should be called by the transmitter driver to allocate an
77  * rfkill structure. Returns %NULL on failure.
78  */
79 struct rfkill * __must_check rfkill_alloc(const char *name,
80 					  struct device *parent,
81 					  const enum rfkill_type type,
82 					  const struct rfkill_ops *ops,
83 					  void *ops_data);
84 
85 /**
86  * rfkill_register - Register a rfkill structure.
87  * @rfkill: rfkill structure to be registered
88  *
89  * This function should be called by the transmitter driver to register
90  * the rfkill structure. Before calling this function the driver needs
91  * to be ready to service method calls from rfkill.
92  *
93  * If rfkill_init_sw_state() is not called before registration,
94  * set_block() will be called to initialize the software blocked state
95  * to a default value.
96  *
97  * If the hardware blocked state is not set before registration,
98  * it is assumed to be unblocked.
99  */
100 int __must_check rfkill_register(struct rfkill *rfkill);
101 
102 /**
103  * rfkill_pause_polling(struct rfkill *rfkill)
104  *
105  * Pause polling -- say transmitter is off for other reasons.
106  * NOTE: not necessary for suspend/resume -- in that case the
107  * core stops polling anyway (but will also correctly handle
108  * the case of polling having been paused before suspend.)
109  */
110 void rfkill_pause_polling(struct rfkill *rfkill);
111 
112 /**
113  * rfkill_resume_polling(struct rfkill *rfkill)
114  *
115  * Resume polling
116  * NOTE: not necessary for suspend/resume -- in that case the
117  * core stops polling anyway
118  */
119 void rfkill_resume_polling(struct rfkill *rfkill);
120 
121 
122 /**
123  * rfkill_unregister - Unregister a rfkill structure.
124  * @rfkill: rfkill structure to be unregistered
125  *
126  * This function should be called by the network driver during device
127  * teardown to destroy rfkill structure. Until it returns, the driver
128  * needs to be able to service method calls.
129  */
130 void rfkill_unregister(struct rfkill *rfkill);
131 
132 /**
133  * rfkill_destroy - Free rfkill structure
134  * @rfkill: rfkill structure to be destroyed
135  *
136  * Destroys the rfkill structure.
137  */
138 void rfkill_destroy(struct rfkill *rfkill);
139 
140 /**
141  * rfkill_set_hw_state_reason - Set the internal rfkill hardware block state
142  *	with a reason
143  * @rfkill: pointer to the rfkill class to modify.
144  * @blocked: the current hardware block state to set
145  * @reason: one of &enum rfkill_hard_block_reasons
146  *
147  * Prefer to use rfkill_set_hw_state if you don't need any special reason.
148  */
149 bool rfkill_set_hw_state_reason(struct rfkill *rfkill,
150 				bool blocked,
151 				enum rfkill_hard_block_reasons reason);
152 /**
153  * rfkill_set_hw_state - Set the internal rfkill hardware block state
154  * @rfkill: pointer to the rfkill class to modify.
155  * @blocked: the current hardware block state to set
156  *
157  * rfkill drivers that get events when the hard-blocked state changes
158  * use this function to notify the rfkill core (and through that also
159  * userspace) of the current state.  They should also use this after
160  * resume if the state could have changed.
161  *
162  * You need not (but may) call this function if poll_state is assigned.
163  *
164  * This function can be called in any context, even from within rfkill
165  * callbacks.
166  *
167  * The function returns the combined block state (true if transmitter
168  * should be blocked) so that drivers need not keep track of the soft
169  * block state -- which they might not be able to.
170  */
rfkill_set_hw_state(struct rfkill * rfkill,bool blocked)171 static inline bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked)
172 {
173 	return rfkill_set_hw_state_reason(rfkill, blocked,
174 					  RFKILL_HARD_BLOCK_SIGNAL);
175 }
176 
177 /**
178  * rfkill_set_sw_state - Set the internal rfkill software block state
179  * @rfkill: pointer to the rfkill class to modify.
180  * @blocked: the current software block state to set
181  *
182  * rfkill drivers that get events when the soft-blocked state changes
183  * (yes, some platforms directly act on input but allow changing again)
184  * use this function to notify the rfkill core (and through that also
185  * userspace) of the current state.
186  *
187  * Drivers should also call this function after resume if the state has
188  * been changed by the user.  This only makes sense for "persistent"
189  * devices (see rfkill_init_sw_state()).
190  *
191  * This function can be called in any context, even from within rfkill
192  * callbacks.
193  *
194  * The function returns the combined block state (true if transmitter
195  * should be blocked).
196  */
197 bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);
198 
199 /**
200  * rfkill_init_sw_state - Initialize persistent software block state
201  * @rfkill: pointer to the rfkill class to modify.
202  * @blocked: the current software block state to set
203  *
204  * rfkill drivers that preserve their software block state over power off
205  * use this function to notify the rfkill core (and through that also
206  * userspace) of their initial state.  It should only be used before
207  * registration.
208  *
209  * In addition, it marks the device as "persistent", an attribute which
210  * can be read by userspace.  Persistent devices are expected to preserve
211  * their own state when suspended.
212  */
213 void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked);
214 
215 /**
216  * rfkill_set_states - Set the internal rfkill block states
217  * @rfkill: pointer to the rfkill class to modify.
218  * @sw: the current software block state to set
219  * @hw: the current hardware block state to set
220  *
221  * This function can be called in any context, even from within rfkill
222  * callbacks.
223  */
224 void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);
225 
226 /**
227  * rfkill_blocked - Query rfkill block state
228  *
229  * @rfkill: rfkill struct to query
230  */
231 bool rfkill_blocked(struct rfkill *rfkill);
232 
233 /**
234  * rfkill_soft_blocked - Query soft rfkill block state
235  *
236  * @rfkill: rfkill struct to query
237  */
238 bool rfkill_soft_blocked(struct rfkill *rfkill);
239 
240 /**
241  * rfkill_find_type - Helper for finding rfkill type by name
242  * @name: the name of the type
243  *
244  * Returns enum rfkill_type that corresponds to the name.
245  */
246 enum rfkill_type rfkill_find_type(const char *name);
247 
248 #else /* !RFKILL */
249 static inline struct rfkill * __must_check
rfkill_alloc(const char * name,struct device * parent,const enum rfkill_type type,const struct rfkill_ops * ops,void * ops_data)250 rfkill_alloc(const char *name,
251 	     struct device *parent,
252 	     const enum rfkill_type type,
253 	     const struct rfkill_ops *ops,
254 	     void *ops_data)
255 {
256 	return ERR_PTR(-ENODEV);
257 }
258 
rfkill_register(struct rfkill * rfkill)259 static inline int __must_check rfkill_register(struct rfkill *rfkill)
260 {
261 	if (rfkill == ERR_PTR(-ENODEV))
262 		return 0;
263 	return -EINVAL;
264 }
265 
rfkill_pause_polling(struct rfkill * rfkill)266 static inline void rfkill_pause_polling(struct rfkill *rfkill)
267 {
268 }
269 
rfkill_resume_polling(struct rfkill * rfkill)270 static inline void rfkill_resume_polling(struct rfkill *rfkill)
271 {
272 }
273 
rfkill_unregister(struct rfkill * rfkill)274 static inline void rfkill_unregister(struct rfkill *rfkill)
275 {
276 }
277 
rfkill_destroy(struct rfkill * rfkill)278 static inline void rfkill_destroy(struct rfkill *rfkill)
279 {
280 }
281 
rfkill_set_hw_state_reason(struct rfkill * rfkill,bool blocked,enum rfkill_hard_block_reasons reason)282 static inline bool rfkill_set_hw_state_reason(struct rfkill *rfkill,
283 					      bool blocked,
284 					      enum rfkill_hard_block_reasons reason)
285 {
286 	return blocked;
287 }
288 
rfkill_set_hw_state(struct rfkill * rfkill,bool blocked)289 static inline bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked)
290 {
291 	return blocked;
292 }
293 
rfkill_set_sw_state(struct rfkill * rfkill,bool blocked)294 static inline bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked)
295 {
296 	return blocked;
297 }
298 
rfkill_init_sw_state(struct rfkill * rfkill,bool blocked)299 static inline void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked)
300 {
301 }
302 
rfkill_set_states(struct rfkill * rfkill,bool sw,bool hw)303 static inline void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw)
304 {
305 }
306 
rfkill_blocked(struct rfkill * rfkill)307 static inline bool rfkill_blocked(struct rfkill *rfkill)
308 {
309 	return false;
310 }
311 
rfkill_soft_blocked(struct rfkill * rfkill)312 static inline bool rfkill_soft_blocked(struct rfkill *rfkill)
313 {
314 	return false;
315 }
316 
rfkill_find_type(const char * name)317 static inline enum rfkill_type rfkill_find_type(const char *name)
318 {
319 	return RFKILL_TYPE_ALL;
320 }
321 
322 #endif /* RFKILL || RFKILL_MODULE */
323 
324 
325 #ifdef CONFIG_RFKILL_LEDS
326 /**
327  * rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED.
328  * This function might return a NULL pointer if registering of the
329  * LED trigger failed. Use this as "default_trigger" for the LED.
330  */
331 const char *rfkill_get_led_trigger_name(struct rfkill *rfkill);
332 
333 /**
334  * rfkill_set_led_trigger_name - Set the LED trigger name
335  * @rfkill: rfkill struct
336  * @name: LED trigger name
337  *
338  * This function sets the LED trigger name of the radio LED
339  * trigger that rfkill creates. It is optional, but if called
340  * must be called before rfkill_register() to be effective.
341  */
342 void rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name);
343 #else
rfkill_get_led_trigger_name(struct rfkill * rfkill)344 static inline const char *rfkill_get_led_trigger_name(struct rfkill *rfkill)
345 {
346 	return NULL;
347 }
348 
349 static inline void
rfkill_set_led_trigger_name(struct rfkill * rfkill,const char * name)350 rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name)
351 {
352 }
353 #endif
354 
355 #endif /* RFKILL_H */
356