1 /* SPDX-License-Identifier: GPL-2.0 */
6  * Linux wait-bit related types and methods:
24 typedef int wait_bit_action_f(struct wait_bit_key *key, int mode);
27 …ad *wq_head, struct wait_bit_queue_entry *wbq_entry, wait_bit_action_f *action, unsigned int mode);
28 …ad *wq_head, struct wait_bit_queue_entry *wbq_entry, wait_bit_action_f *action, unsigned int mode);
30 int out_of_line_wait_on_bit(void *word, int, wait_bit_action_f *action, unsigned int mode);
31 int out_of_line_wait_on_bit_timeout(void *word, int, wait_bit_action_f *action, unsigned int mode, …
32 int out_of_line_wait_on_bit_lock(void *word, int, wait_bit_action_f *action, unsigned int mode);
36 int wake_bit_function(struct wait_queue_entry *wq_entry, unsigned mode, int sync, void *key);
49 extern int bit_wait(struct wait_bit_key *key, int mode);
50 extern int bit_wait_io(struct wait_bit_key *key, int mode);
51 extern int bit_wait_timeout(struct wait_bit_key *key, int mode);
52 extern int bit_wait_io_timeout(struct wait_bit_key *key, int mode);
55  * wait_on_bit - wait for a bit to be cleared
58  * @mode: the task state to sleep in
60  * There is a standard hashed waitqueue table for generic use. This
66  * Returned value will be zero if the bit was cleared, or non-zero
67  * if the process received a signal and the mode permitted wakeup
71 wait_on_bit(unsigned long *word, int bit, unsigned mode)  in wait_on_bit()  argument
78 				       mode);  in wait_on_bit()
82  * wait_on_bit_io - wait for a bit to be cleared
85  * @mode: the task state to sleep in
87  * Use the standard hashed waitqueue table to wait for a bit
91  * Returned value will be zero if the bit was cleared, or non-zero
92  * if the process received a signal and the mode permitted wakeup
96 wait_on_bit_io(unsigned long *word, int bit, unsigned mode)  in wait_on_bit_io()  argument
103 				       mode);  in wait_on_bit_io()
107  * wait_on_bit_timeout - wait for a bit to be cleared or a timeout elapses
110  * @mode: the task state to sleep in
113  * Use the standard hashed waitqueue table to wait for a bit
118  * @timeout elapsed, or non-zero if the @timeout elapsed or process
119  * received a signal and the mode permitted wakeup on that signal.
122 wait_on_bit_timeout(unsigned long *word, int bit, unsigned mode,  in wait_on_bit_timeout()  argument
130 					       mode, timeout);  in wait_on_bit_timeout()
134  * wait_on_bit_action - wait for a bit to be cleared
138  * @mode: the task state to sleep in
140  * Use the standard hashed waitqueue table to wait for a bit
145  * Returned value will be zero if the bit was cleared, or non-zero
146  * if the process received a signal and the mode permitted wakeup
151 		   unsigned mode)  in wait_on_bit_action()  argument
156 	return out_of_line_wait_on_bit(word, bit, action, mode);  in wait_on_bit_action()
160  * wait_on_bit_lock - wait for a bit to be cleared, when wanting to set it
163  * @mode: the task state to sleep in
165  * There is a standard hashed waitqueue table for generic use. This
175  * set.  Returns non-zero if a signal was delivered to the process and
176  * the @mode allows that signal to wake the process.
179 wait_on_bit_lock(unsigned long *word, int bit, unsigned mode)  in wait_on_bit_lock()  argument
184 	return out_of_line_wait_on_bit_lock(word, bit, bit_wait, mode);  in wait_on_bit_lock()
188  * wait_on_bit_lock_io - wait for a bit to be cleared, when wanting to set it
191  * @mode: the task state to sleep in
193  * Use the standard hashed waitqueue table to wait for a bit
199  * set.  Returns non-zero if a signal was delivered to the process and
200  * the @mode allows that signal to wake the process.
203 wait_on_bit_lock_io(unsigned long *word, int bit, unsigned mode)  in wait_on_bit_lock_io()  argument
208 	return out_of_line_wait_on_bit_lock(word, bit, bit_wait_io, mode);  in wait_on_bit_lock_io()
212  * wait_on_bit_lock_action - wait for a bit to be cleared, when wanting to set it
216  * @mode: the task state to sleep in
218  * Use the standard hashed waitqueue table to wait for a bit
225  * set.  Returns non-zero if a signal was delivered to the process and
226  * the @mode allows that signal to wake the process.
230 			unsigned mode)  in wait_on_bit_lock_action()  argument
235 	return out_of_line_wait_on_bit_lock(word, bit, action, mode);  in wait_on_bit_lock_action()
322  * clear_and_wake_up_bit - clear a bit and wake up anyone waiting on that bit
328  * non-atomically under a lock.