luck/tmp_suning_uos_patched
1
0
Fork 1
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

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

Fix kernel-doc notation in the added files.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Randy Dunlap 2010-10-26 14:17:25 -07:00 committed by Linus Torvalds
parent 003bb8ab7c
commit ee2f154a59
3 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/DocBook/device-drivers.tmpl
View File

@ -51,7 +51,12 @@
<sect1><title>Delaying, scheduling, and timer routines</title> <sect1><title>Delaying, scheduling, and timer routines</title>
!Iinclude/linux/sched.h !Iinclude/linux/sched.h
!Ekernel/sched.c !Ekernel/sched.c
!Iinclude/linux/completion.h
!Ekernel/timer.c !Ekernel/timer.c
</sect1>
<sect1><title>Wait queues and Wake events</title>
!Iinclude/linux/wait.h
!Ekernel/wait.c
</sect1> </sect1>
<sect1><title>High-resolution timers</title> <sect1><title>High-resolution timers</title>
!Iinclude/linux/ktime.h !Iinclude/linux/ktime.h

10
include/linux/completion.h
View File

@ -10,7 +10,7 @@
#include <linux/wait.h> #include <linux/wait.h>
/** /*
* struct completion - structure used to maintain state for a "completion" * struct completion - structure used to maintain state for a "completion"
* *
* This is the opaque structure used to maintain the 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; }) ({ 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 * @work: identifier for the completion structure
* *
* This macro declares and initializes a completion structure. Generally used * This macro declares and initializes a completion structure. Generally used
@ -50,7 +50,7 @@ struct completion {
* are on the kernel stack: * 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 * @work: identifier for the completion structure
* *
* This macro declares and initializes a completion structure on the kernel * This macro declares and initializes a completion structure on the kernel
@ -64,7 +64,7 @@ struct completion {
#endif #endif
/** /**
* init_completion: - Initialize a dynamically allocated completion * init_completion - Initialize a dynamically allocated completion
* @x: completion structure that is to be initialized * @x: completion structure that is to be initialized
* *
* This inline function will initialize a dynamically created completion * This inline function will initialize a dynamically created completion
@ -92,7 +92,7 @@ extern void complete(struct completion *);
extern void complete_all(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 * @x: completion structure to be reinitialized
* *
* This macro should be used to reinitialize a completion structure so it can * This macro should be used to reinitialize a completion structure so it can

6
kernel/wait.c
View File

@ -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); EXPORT_SYMBOL(prepare_to_wait_exclusive);
/* /**
* finish_wait - clean up after waiting in a queue * finish_wait - clean up after waiting in a queue
* @q: waitqueue waited on * @q: waitqueue waited on
* @wait: wait descriptor * @wait: wait descriptor
@ -127,11 +127,11 @@ void finish_wait(wait_queue_head_t *q, wait_queue_t *wait)
} }
EXPORT_SYMBOL(finish_wait); EXPORT_SYMBOL(finish_wait);
/* /**
* abort_exclusive_wait - abort exclusive waiting in a queue * abort_exclusive_wait - abort exclusive waiting in a queue
* @q: waitqueue waited on * @q: waitqueue waited on
* @wait: wait descriptor * @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 * @key: key to identify a wait bit queue or %NULL
* *
* Sets current thread back to running state and removes * Sets current thread back to running state and removes