diff options
| author | Dmitry Torokhov <dmitry.torokhov@gmail.com> | 2009-12-11 21:57:31 -0800 |
|---|---|---|
| committer | Dmitry Torokhov <dmitry.torokhov@gmail.com> | 2009-12-11 23:48:49 -0800 |
| commit | df2d4637b0813e47ad12af3eacf6b5292c0fb164 (patch) | |
| tree | 71401042b4fcc10bc72153f86a540ca20c19241b | |
| parent | 010c33cc7907239ffc8f49f09ccb3dc6d84a0369 (diff) | |
Input: document use of input_event() function
Acked-by: Henrique de Moraes Holschuh <hmh@hmh.eng.br>
Signed-off-by: Dmitry Torokhov <dtor@mail.ru>
| -rw-r--r-- | drivers/input/input.c | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/drivers/input/input.c b/drivers/input/input.c index 5c16001959c..ab060710688 100644 --- a/drivers/input/input.c +++ b/drivers/input/input.c @@ -296,9 +296,15 @@ static void input_handle_event(struct input_dev *dev, * @value: value of the event * * This function should be used by drivers implementing various input - * devices. See also input_inject_event(). + * devices to report input events. See also input_inject_event(). + * + * NOTE: input_event() may be safely used right after input device was + * allocated with input_allocate_device(), even before it is registered + * with input_register_device(), but the event will not reach any of the + * input handlers. Such early invocation of input_event() may be used + * to 'seed' initial state of a switch or initial position of absolute + * axis, etc. */ - void input_event(struct input_dev *dev, unsigned int type, unsigned int code, int value) { |