Commit 0f687e9a authored by Henrique de Moraes Holschuh's avatar Henrique de Moraes Holschuh Committed by John W. Linville
Browse files

rfkill: some minor kernel-doc changes for rfkill_toggle_radio 



Improve rfkill_toggle_radio's kernel-doc header a bit.

Signed-off-by: default avatarHenrique de Moraes Holschuh <hmh@hmh.eng.br>
Acked-by: default avatarIvo van Doorn <IvDoorn@gmail.com>
Signed-off-by: default avatarJohn W. Linville <linville@tuxdriver.com>
parent e4abd4d4

net/rfkill/rfkill.c

+7 −5
Original line number Diff line number Diff line
@@ -130,17 +130,19 @@ static void update_rfkill_state(struct rfkill *rfkill) 


/**

 * rfkill_toggle_radio - wrapper for toggle_radio hook

 * calls toggle_radio taking into account a lot of "small"

 * details.

 *

 * @rfkill: the rfkill struct to use

 * @force: calls toggle_radio even if cache says it is not needed,

 *	and also makes sure notifications of the state will be

 *	sent even if it didn't change

 * @state: the new state to call toggle_radio() with

 *

 * This wrappen protects and enforces the API for toggle_radio

 * calls.  Note that @force cannot override a (possibly cached)

 * state of RFKILL_STATE_HARD_BLOCKED.  Any device making use of

 * Calls rfkill->toggle_radio, enforcing the API for toggle_radio

 * calls and handling all the red tape such as issuing notifications

 * if the call is successful.

 *

 * Note that @force cannot override a (possibly cached) state of

 * RFKILL_STATE_HARD_BLOCKED.  Any device making use of

 * RFKILL_STATE_HARD_BLOCKED implements either get_state() or

 * rfkill_force_state(), so the cache either is bypassed or valid.

 *