diff options
-rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 8 | ||||
-rw-r--r-- | drivers/input/ff-core.c | 4 | ||||
-rw-r--r-- | drivers/input/ff-memless.c | 2 | ||||
-rw-r--r-- | include/linux/input.h | 18 |
4 files changed, 20 insertions, 12 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index a166675c4303..a1af278f9901 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl | |||
@@ -533,4 +533,12 @@ X!Idrivers/video/console/fonts.c | |||
533 | --> | 533 | --> |
534 | </sect1> | 534 | </sect1> |
535 | </chapter> | 535 | </chapter> |
536 | |||
537 | <chapter id="input_subsystem"> | ||
538 | <title>Input Subsystem</title> | ||
539 | !Iinclude/linux/input.h | ||
540 | !Edrivers/input/input.c | ||
541 | !Edrivers/input/ff-core.c | ||
542 | !Edrivers/input/ff-memless.c | ||
543 | </chapter> | ||
536 | </book> | 544 | </book> |
diff --git a/drivers/input/ff-core.c b/drivers/input/ff-core.c index 35656cadc914..783b3412cead 100644 --- a/drivers/input/ff-core.c +++ b/drivers/input/ff-core.c | |||
@@ -203,7 +203,7 @@ static int erase_effect(struct input_dev *dev, int effect_id, | |||
203 | } | 203 | } |
204 | 204 | ||
205 | /** | 205 | /** |
206 | * input_ff_erase - erase an effect from device | 206 | * input_ff_erase - erase a force-feedback effect from device |
207 | * @dev: input device to erase effect from | 207 | * @dev: input device to erase effect from |
208 | * @effect_id: id of the ffect to be erased | 208 | * @effect_id: id of the ffect to be erased |
209 | * @file: purported owner of the request | 209 | * @file: purported owner of the request |
@@ -347,7 +347,7 @@ EXPORT_SYMBOL_GPL(input_ff_create); | |||
347 | 347 | ||
348 | /** | 348 | /** |
349 | * input_ff_free() - frees force feedback portion of input device | 349 | * input_ff_free() - frees force feedback portion of input device |
350 | * @dev: input device supporintg force feedback | 350 | * @dev: input device supporting force feedback |
351 | * | 351 | * |
352 | * This function is only needed in error path as input core will | 352 | * This function is only needed in error path as input core will |
353 | * automatically free force feedback structures when device is | 353 | * automatically free force feedback structures when device is |
diff --git a/drivers/input/ff-memless.c b/drivers/input/ff-memless.c index cd8b7297e6df..eba18b6ac5e4 100644 --- a/drivers/input/ff-memless.c +++ b/drivers/input/ff-memless.c | |||
@@ -460,7 +460,7 @@ static void ml_ff_destroy(struct ff_device *ff) | |||
460 | } | 460 | } |
461 | 461 | ||
462 | /** | 462 | /** |
463 | * input_ff_create_memless() - create memoryless FF device | 463 | * input_ff_create_memless() - create memoryless force-feedback device |
464 | * @dev: input device supporting force-feedback | 464 | * @dev: input device supporting force-feedback |
465 | * @data: driver-specific data to be passed into @play_effect | 465 | * @data: driver-specific data to be passed into @play_effect |
466 | * @play_effect: driver-specific method for playing FF effect | 466 | * @play_effect: driver-specific method for playing FF effect |
diff --git a/include/linux/input.h b/include/linux/input.h index c38507ba38b5..4e61158b06a0 100644 --- a/include/linux/input.h +++ b/include/linux/input.h | |||
@@ -663,7 +663,7 @@ struct input_absinfo { | |||
663 | #define BUS_GSC 0x1A | 663 | #define BUS_GSC 0x1A |
664 | 664 | ||
665 | /* | 665 | /* |
666 | * Values describing the status of an effect | 666 | * Values describing the status of a force-feedback effect |
667 | */ | 667 | */ |
668 | #define FF_STATUS_STOPPED 0x00 | 668 | #define FF_STATUS_STOPPED 0x00 |
669 | #define FF_STATUS_PLAYING 0x01 | 669 | #define FF_STATUS_PLAYING 0x01 |
@@ -680,7 +680,7 @@ struct input_absinfo { | |||
680 | */ | 680 | */ |
681 | 681 | ||
682 | /** | 682 | /** |
683 | * struct ff_replay - defines scheduling of the effect | 683 | * struct ff_replay - defines scheduling of the force-feedback effect |
684 | * @length: duration of the effect | 684 | * @length: duration of the effect |
685 | * @delay: delay before effect should start playing | 685 | * @delay: delay before effect should start playing |
686 | */ | 686 | */ |
@@ -690,7 +690,7 @@ struct ff_replay { | |||
690 | }; | 690 | }; |
691 | 691 | ||
692 | /** | 692 | /** |
693 | * struct ff_trigger - defines what triggers the effect | 693 | * struct ff_trigger - defines what triggers the force-feedback effect |
694 | * @button: number of the button triggering the effect | 694 | * @button: number of the button triggering the effect |
695 | * @interval: controls how soon the effect can be re-triggered | 695 | * @interval: controls how soon the effect can be re-triggered |
696 | */ | 696 | */ |
@@ -700,7 +700,7 @@ struct ff_trigger { | |||
700 | }; | 700 | }; |
701 | 701 | ||
702 | /** | 702 | /** |
703 | * struct ff_envelope - generic effect envelope | 703 | * struct ff_envelope - generic force-feedback effect envelope |
704 | * @attack_length: duration of the attack (ms) | 704 | * @attack_length: duration of the attack (ms) |
705 | * @attack_level: level at the beginning of the attack | 705 | * @attack_level: level at the beginning of the attack |
706 | * @fade_length: duration of fade (ms) | 706 | * @fade_length: duration of fade (ms) |
@@ -719,7 +719,7 @@ struct ff_envelope { | |||
719 | }; | 719 | }; |
720 | 720 | ||
721 | /** | 721 | /** |
722 | * struct ff_constant_effect - defines parameters of a constant effect | 722 | * struct ff_constant_effect - defines parameters of a constant force-feedback effect |
723 | * @level: strength of the effect; may be negative | 723 | * @level: strength of the effect; may be negative |
724 | * @envelope: envelope data | 724 | * @envelope: envelope data |
725 | */ | 725 | */ |
@@ -729,7 +729,7 @@ struct ff_constant_effect { | |||
729 | }; | 729 | }; |
730 | 730 | ||
731 | /** | 731 | /** |
732 | * struct ff_ramp_effect - defines parameters of a ramp effect | 732 | * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect |
733 | * @start_level: beginning strength of the effect; may be negative | 733 | * @start_level: beginning strength of the effect; may be negative |
734 | * @end_level: final strength of the effect; may be negative | 734 | * @end_level: final strength of the effect; may be negative |
735 | * @envelope: envelope data | 735 | * @envelope: envelope data |
@@ -741,7 +741,7 @@ struct ff_ramp_effect { | |||
741 | }; | 741 | }; |
742 | 742 | ||
743 | /** | 743 | /** |
744 | * struct ff_condition_effect - defines a spring or friction effect | 744 | * struct ff_condition_effect - defines a spring or friction force-feedback effect |
745 | * @right_saturation: maximum level when joystick moved all way to the right | 745 | * @right_saturation: maximum level when joystick moved all way to the right |
746 | * @left_saturation: same for the left side | 746 | * @left_saturation: same for the left side |
747 | * @right_coeff: controls how fast the force grows when the joystick moves | 747 | * @right_coeff: controls how fast the force grows when the joystick moves |
@@ -762,7 +762,7 @@ struct ff_condition_effect { | |||
762 | }; | 762 | }; |
763 | 763 | ||
764 | /** | 764 | /** |
765 | * struct ff_periodic_effect - defines parameters of a periodic effect | 765 | * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect |
766 | * @waveform: kind of the effect (wave) | 766 | * @waveform: kind of the effect (wave) |
767 | * @period: period of the wave (ms) | 767 | * @period: period of the wave (ms) |
768 | * @magnitude: peak value | 768 | * @magnitude: peak value |
@@ -793,7 +793,7 @@ struct ff_periodic_effect { | |||
793 | }; | 793 | }; |
794 | 794 | ||
795 | /** | 795 | /** |
796 | * struct ff_rumble_effect - defines parameters of a periodic effect | 796 | * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect |
797 | * @strong_magnitude: magnitude of the heavy motor | 797 | * @strong_magnitude: magnitude of the heavy motor |
798 | * @weak_magnitude: magnitude of the light one | 798 | * @weak_magnitude: magnitude of the light one |
799 | * | 799 | * |