Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ee2f154a authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

docbook: add more wait/wake/completion to device-drivers docbook 



Add more wait, wake, and completion interfaces to the device-drivers
docbook.

Fix kernel-doc notation in the added files.

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 003bb8ab

Documentation/DocBook/device-drivers.tmpl

+5 −0
Original line number Diff line number Diff line
@@ -51,7 +51,12 @@ 
     <sect1><title>Delaying, scheduling, and timer routines</title>

!Iinclude/linux/sched.h

!Ekernel/sched.c

!Iinclude/linux/completion.h

!Ekernel/timer.c

     </sect1>

     <sect1><title>Wait queues and Wake events</title>

!Iinclude/linux/wait.h

!Ekernel/wait.c

     </sect1>

     <sect1><title>High-resolution timers</title>

!Iinclude/linux/ktime.h

include/linux/completion.h

+5 −5
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ 


#include <linux/wait.h>



/**

/*

 * struct completion - structure used to maintain state for a "completion"

 *

 * This is the opaque structure used to maintain the state for a "completion".
@@ -34,7 +34,7 @@ struct completion { 
	({ init_completion(&work); work; })



/**

 * DECLARE_COMPLETION: - declare and initialize a completion structure

 * DECLARE_COMPLETION - declare and initialize a completion structure

 * @work:  identifier for the completion structure

 *

 * This macro declares and initializes a completion structure. Generally used
@@ -50,7 +50,7 @@ struct completion { 
 * are on the kernel stack:

 */

/**

 * DECLARE_COMPLETION_ONSTACK: - declare and initialize a completion structure

 * DECLARE_COMPLETION_ONSTACK - declare and initialize a completion structure

 * @work:  identifier for the completion structure

 *

 * This macro declares and initializes a completion structure on the kernel
@@ -64,7 +64,7 @@ struct completion { 
#endif



/**

 * init_completion: - Initialize a dynamically allocated completion

 * init_completion - Initialize a dynamically allocated completion

 * @x:  completion structure that is to be initialized

 *

 * This inline function will initialize a dynamically created completion
@@ -92,7 +92,7 @@ extern void complete(struct completion *); 
extern void complete_all(struct completion *);



/**

 * INIT_COMPLETION: - reinitialize a completion structure

 * INIT_COMPLETION - reinitialize a completion structure

 * @x:  completion structure to be reinitialized

 *

 * This macro should be used to reinitialize a completion structure so it can

kernel/wait.c

+3 −3
Original line number Diff line number Diff line
@@ -92,7 +92,7 @@ prepare_to_wait_exclusive(wait_queue_head_t *q, wait_queue_t *wait, int state) 
}

EXPORT_SYMBOL(prepare_to_wait_exclusive);



/*

/**

 * finish_wait - clean up after waiting in a queue

 * @q: waitqueue waited on

 * @wait: wait descriptor
@@ -127,11 +127,11 @@ void finish_wait(wait_queue_head_t *q, wait_queue_t *wait) 
}

EXPORT_SYMBOL(finish_wait);



/*

/**

 * abort_exclusive_wait - abort exclusive waiting in a queue

 * @q: waitqueue waited on

 * @wait: wait descriptor

 * @state: runstate of the waiter to be woken

 * @mode: runstate of the waiter to be woken

 * @key: key to identify a wait bit queue or %NULL

 *

 * Sets current thread back to running state and removes