~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/rfkill.h

Version: ~ [ linux-5.16-rc3 ] ~ [ linux-5.15.5 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.82 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.162 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.218 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.256 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.291 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.293 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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 - Set the internal rfkill hardware block state
142  * @rfkill: pointer to the rfkill class to modify.
143  * @blocked: the current hardware block state to set
144  *
145  * rfkill drivers that get events when the hard-blocked state changes
146  * use this function to notify the rfkill core (and through that also
147  * userspace) of the current state.  They should also use this after
148  * resume if the state could have changed.
149  *
150  * You need not (but may) call this function if poll_state is assigned.
151  *
152  * This function can be called in any context, even from within rfkill
153  * callbacks.
154  *
155  * The function returns the combined block state (true if transmitter
156  * should be blocked) so that drivers need not keep track of the soft
157  * block state -- which they might not be able to.
158  */
159 bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked);
160 
161 /**
162  * rfkill_set_sw_state - Set the internal rfkill software block state
163  * @rfkill: pointer to the rfkill class to modify.
164  * @blocked: the current software block state to set
165  *
166  * rfkill drivers that get events when the soft-blocked state changes
167  * (yes, some platforms directly act on input but allow changing again)
168  * use this function to notify the rfkill core (and through that also
169  * userspace) of the current state.
170  *
171  * Drivers should also call this function after resume if the state has
172  * been changed by the user.  This only makes sense for "persistent"
173  * devices (see rfkill_init_sw_state()).
174  *
175  * This function can be called in any context, even from within rfkill
176  * callbacks.
177  *
178  * The function returns the combined block state (true if transmitter
179  * should be blocked).
180  */
181 bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);
182 
183 /**
184  * rfkill_init_sw_state - Initialize persistent software block state
185  * @rfkill: pointer to the rfkill class to modify.
186  * @blocked: the current software block state to set
187  *
188  * rfkill drivers that preserve their software block state over power off
189  * use this function to notify the rfkill core (and through that also
190  * userspace) of their initial state.  It should only be used before
191  * registration.
192  *
193  * In addition, it marks the device as "persistent", an attribute which
194  * can be read by userspace.  Persistent devices are expected to preserve
195  * their own state when suspended.
196  */
197 void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked);
198 
199 /**
200  * rfkill_set_states - Set the internal rfkill block states
201  * @rfkill: pointer to the rfkill class to modify.
202  * @sw: the current software block state to set
203  * @hw: the current hardware block state to set
204  *
205  * This function can be called in any context, even from within rfkill
206  * callbacks.
207  */
208 void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);
209 
210 /**
211  * rfkill_blocked - Query rfkill block state
212  *
213  * @rfkill: rfkill struct to query
214  */
215 bool rfkill_blocked(struct rfkill *rfkill);
216 
217 /**
218  * rfkill_find_type - Helper for finding rfkill type by name
219  * @name: the name of the type
220  *
221  * Returns enum rfkill_type that corresponds to the name.
222  */
223 enum rfkill_type rfkill_find_type(const char *name);
224 
225 #else /* !RFKILL */
226 static inline struct rfkill * __must_check
227 rfkill_alloc(const char *name,
228              struct device *parent,
229              const enum rfkill_type type,
230              const struct rfkill_ops *ops,
231              void *ops_data)
232 {
233         return ERR_PTR(-ENODEV);
234 }
235 
236 static inline int __must_check rfkill_register(struct rfkill *rfkill)
237 {
238         if (rfkill == ERR_PTR(-ENODEV))
239                 return 0;
240         return -EINVAL;
241 }
242 
243 static inline void rfkill_pause_polling(struct rfkill *rfkill)
244 {
245 }
246 
247 static inline void rfkill_resume_polling(struct rfkill *rfkill)
248 {
249 }
250 
251 static inline void rfkill_unregister(struct rfkill *rfkill)
252 {
253 }
254 
255 static inline void rfkill_destroy(struct rfkill *rfkill)
256 {
257 }
258 
259 static inline bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked)
260 {
261         return blocked;
262 }
263 
264 static inline bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked)
265 {
266         return blocked;
267 }
268 
269 static inline void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked)
270 {
271 }
272 
273 static inline void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw)
274 {
275 }
276 
277 static inline bool rfkill_blocked(struct rfkill *rfkill)
278 {
279         return false;
280 }
281 
282 static inline enum rfkill_type rfkill_find_type(const char *name)
283 {
284         return RFKILL_TYPE_ALL;
285 }
286 
287 #endif /* RFKILL || RFKILL_MODULE */
288 
289 
290 #ifdef CONFIG_RFKILL_LEDS
291 /**
292  * rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED.
293  * This function might return a NULL pointer if registering of the
294  * LED trigger failed. Use this as "default_trigger" for the LED.
295  */
296 const char *rfkill_get_led_trigger_name(struct rfkill *rfkill);
297 
298 /**
299  * rfkill_set_led_trigger_name - Set the LED trigger name
300  * @rfkill: rfkill struct
301  * @name: LED trigger name
302  *
303  * This function sets the LED trigger name of the radio LED
304  * trigger that rfkill creates. It is optional, but if called
305  * must be called before rfkill_register() to be effective.
306  */
307 void rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name);
308 #else
309 static inline const char *rfkill_get_led_trigger_name(struct rfkill *rfkill)
310 {
311         return NULL;
312 }
313 
314 static inline void
315 rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name)
316 {
317 }
318 #endif
319 
320 #endif /* RFKILL_H */
321 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp