aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/rfkill.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/linux/rfkill.h')
-rw-r--r--include/linux/rfkill.h20
1 files changed, 10 insertions, 10 deletions
diff --git a/include/linux/rfkill.h b/include/linux/rfkill.h
index e6a0031d1b1f..8ad2487a86d5 100644
--- a/include/linux/rfkill.h
+++ b/include/linux/rfkill.h
@@ -66,7 +66,7 @@ struct rfkill_ops {
66 66
67#if defined(CONFIG_RFKILL) || defined(CONFIG_RFKILL_MODULE) 67#if defined(CONFIG_RFKILL) || defined(CONFIG_RFKILL_MODULE)
68/** 68/**
69 * rfkill_alloc - allocate rfkill structure 69 * rfkill_alloc - Allocate rfkill structure
70 * @name: name of the struct -- the string is not copied internally 70 * @name: name of the struct -- the string is not copied internally
71 * @parent: device that has rf switch on it 71 * @parent: device that has rf switch on it
72 * @type: type of the switch (RFKILL_TYPE_*) 72 * @type: type of the switch (RFKILL_TYPE_*)
@@ -112,7 +112,7 @@ void rfkill_pause_polling(struct rfkill *rfkill);
112/** 112/**
113 * rfkill_resume_polling(struct rfkill *rfkill) 113 * rfkill_resume_polling(struct rfkill *rfkill)
114 * 114 *
115 * Pause polling -- say transmitter is off for other reasons. 115 * Resume polling
116 * NOTE: not necessary for suspend/resume -- in that case the 116 * NOTE: not necessary for suspend/resume -- in that case the
117 * core stops polling anyway 117 * core stops polling anyway
118 */ 118 */
@@ -130,7 +130,7 @@ void rfkill_resume_polling(struct rfkill *rfkill);
130void rfkill_unregister(struct rfkill *rfkill); 130void rfkill_unregister(struct rfkill *rfkill);
131 131
132/** 132/**
133 * rfkill_destroy - free rfkill structure 133 * rfkill_destroy - Free rfkill structure
134 * @rfkill: rfkill structure to be destroyed 134 * @rfkill: rfkill structure to be destroyed
135 * 135 *
136 * Destroys the rfkill structure. 136 * Destroys the rfkill structure.
@@ -140,7 +140,7 @@ void rfkill_destroy(struct rfkill *rfkill);
140/** 140/**
141 * rfkill_set_hw_state - Set the internal rfkill hardware block state 141 * rfkill_set_hw_state - Set the internal rfkill hardware block state
142 * @rfkill: pointer to the rfkill class to modify. 142 * @rfkill: pointer to the rfkill class to modify.
143 * @state: the current hardware block state to set 143 * @blocked: the current hardware block state to set
144 * 144 *
145 * rfkill drivers that get events when the hard-blocked state changes 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 146 * use this function to notify the rfkill core (and through that also
@@ -161,7 +161,7 @@ bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked);
161/** 161/**
162 * rfkill_set_sw_state - Set the internal rfkill software block state 162 * rfkill_set_sw_state - Set the internal rfkill software block state
163 * @rfkill: pointer to the rfkill class to modify. 163 * @rfkill: pointer to the rfkill class to modify.
164 * @state: the current software block state to set 164 * @blocked: the current software block state to set
165 * 165 *
166 * rfkill drivers that get events when the soft-blocked state changes 166 * rfkill drivers that get events when the soft-blocked state changes
167 * (yes, some platforms directly act on input but allow changing again) 167 * (yes, some platforms directly act on input but allow changing again)
@@ -183,7 +183,7 @@ bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);
183/** 183/**
184 * rfkill_init_sw_state - Initialize persistent software block state 184 * rfkill_init_sw_state - Initialize persistent software block state
185 * @rfkill: pointer to the rfkill class to modify. 185 * @rfkill: pointer to the rfkill class to modify.
186 * @state: the current software block state to set 186 * @blocked: the current software block state to set
187 * 187 *
188 * rfkill drivers that preserve their software block state over power off 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 189 * use this function to notify the rfkill core (and through that also
@@ -208,17 +208,17 @@ void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked);
208void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw); 208void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);
209 209
210/** 210/**
211 * rfkill_blocked - query rfkill block 211 * rfkill_blocked - Query rfkill block state
212 * 212 *
213 * @rfkill: rfkill struct to query 213 * @rfkill: rfkill struct to query
214 */ 214 */
215bool rfkill_blocked(struct rfkill *rfkill); 215bool rfkill_blocked(struct rfkill *rfkill);
216 216
217/** 217/**
218 * rfkill_find_type - Helpper for finding rfkill type by name 218 * rfkill_find_type - Helper for finding rfkill type by name
219 * @name: the name of the type 219 * @name: the name of the type
220 * 220 *
221 * Returns enum rfkill_type that conrresponds the name. 221 * Returns enum rfkill_type that corresponds to the name.
222 */ 222 */
223enum rfkill_type rfkill_find_type(const char *name); 223enum rfkill_type rfkill_find_type(const char *name);
224 224
@@ -296,7 +296,7 @@ static inline enum rfkill_type rfkill_find_type(const char *name)
296const char *rfkill_get_led_trigger_name(struct rfkill *rfkill); 296const char *rfkill_get_led_trigger_name(struct rfkill *rfkill);
297 297
298/** 298/**
299 * rfkill_set_led_trigger_name -- set the LED trigger name 299 * rfkill_set_led_trigger_name - Set the LED trigger name
300 * @rfkill: rfkill struct 300 * @rfkill: rfkill struct
301 * @name: LED trigger name 301 * @name: LED trigger name
302 * 302 *