Input: add to kernel-api docbook

Add input subsystem to kernel-api docbook.
Enhance some function and parameter comments.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Dmitry Torokhov <dtor@mail.ru>
This commit is contained in:
Randy Dunlap 2006-11-24 00:43:09 -05:00 committed by Dmitry Torokhov
parent f9705fcb98
commit e4477d2d1b
4 changed files with 20 additions and 12 deletions

View file

@ -533,4 +533,12 @@ X!Idrivers/video/console/fonts.c
--> -->
</sect1> </sect1>
</chapter> </chapter>
<chapter id="input_subsystem">
<title>Input Subsystem</title>
!Iinclude/linux/input.h
!Edrivers/input/input.c
!Edrivers/input/ff-core.c
!Edrivers/input/ff-memless.c
</chapter>
</book> </book>

View file

@ -203,7 +203,7 @@ static int erase_effect(struct input_dev *dev, int effect_id,
} }
/** /**
* input_ff_erase - erase an effect from device * input_ff_erase - erase a force-feedback effect from device
* @dev: input device to erase effect from * @dev: input device to erase effect from
* @effect_id: id of the ffect to be erased * @effect_id: id of the ffect to be erased
* @file: purported owner of the request * @file: purported owner of the request
@ -347,7 +347,7 @@ EXPORT_SYMBOL_GPL(input_ff_create);
/** /**
* input_ff_free() - frees force feedback portion of input device * input_ff_free() - frees force feedback portion of input device
* @dev: input device supporintg force feedback * @dev: input device supporting force feedback
* *
* This function is only needed in error path as input core will * This function is only needed in error path as input core will
* automatically free force feedback structures when device is * automatically free force feedback structures when device is

View file

@ -460,7 +460,7 @@ static void ml_ff_destroy(struct ff_device *ff)
} }
/** /**
* input_ff_create_memless() - create memoryless FF device * input_ff_create_memless() - create memoryless force-feedback device
* @dev: input device supporting force-feedback * @dev: input device supporting force-feedback
* @data: driver-specific data to be passed into @play_effect * @data: driver-specific data to be passed into @play_effect
* @play_effect: driver-specific method for playing FF effect * @play_effect: driver-specific method for playing FF effect

View file

@ -663,7 +663,7 @@ struct input_absinfo {
#define BUS_GSC 0x1A #define BUS_GSC 0x1A
/* /*
* Values describing the status of an effect * Values describing the status of a force-feedback effect
*/ */
#define FF_STATUS_STOPPED 0x00 #define FF_STATUS_STOPPED 0x00
#define FF_STATUS_PLAYING 0x01 #define FF_STATUS_PLAYING 0x01
@ -680,7 +680,7 @@ struct input_absinfo {
*/ */
/** /**
* struct ff_replay - defines scheduling of the effect * struct ff_replay - defines scheduling of the force-feedback effect
* @length: duration of the effect * @length: duration of the effect
* @delay: delay before effect should start playing * @delay: delay before effect should start playing
*/ */
@ -690,7 +690,7 @@ struct ff_replay {
}; };
/** /**
* struct ff_trigger - defines what triggers the effect * struct ff_trigger - defines what triggers the force-feedback effect
* @button: number of the button triggering the effect * @button: number of the button triggering the effect
* @interval: controls how soon the effect can be re-triggered * @interval: controls how soon the effect can be re-triggered
*/ */
@ -700,7 +700,7 @@ struct ff_trigger {
}; };
/** /**
* struct ff_envelope - generic effect envelope * struct ff_envelope - generic force-feedback effect envelope
* @attack_length: duration of the attack (ms) * @attack_length: duration of the attack (ms)
* @attack_level: level at the beginning of the attack * @attack_level: level at the beginning of the attack
* @fade_length: duration of fade (ms) * @fade_length: duration of fade (ms)
@ -719,7 +719,7 @@ struct ff_envelope {
}; };
/** /**
* struct ff_constant_effect - defines parameters of a constant effect * struct ff_constant_effect - defines parameters of a constant force-feedback effect
* @level: strength of the effect; may be negative * @level: strength of the effect; may be negative
* @envelope: envelope data * @envelope: envelope data
*/ */
@ -729,7 +729,7 @@ struct ff_constant_effect {
}; };
/** /**
* struct ff_ramp_effect - defines parameters of a ramp effect * struct ff_ramp_effect - defines parameters of a ramp force-feedback effect
* @start_level: beginning strength of the effect; may be negative * @start_level: beginning strength of the effect; may be negative
* @end_level: final strength of the effect; may be negative * @end_level: final strength of the effect; may be negative
* @envelope: envelope data * @envelope: envelope data
@ -741,7 +741,7 @@ struct ff_ramp_effect {
}; };
/** /**
* struct ff_condition_effect - defines a spring or friction effect * struct ff_condition_effect - defines a spring or friction force-feedback effect
* @right_saturation: maximum level when joystick moved all way to the right * @right_saturation: maximum level when joystick moved all way to the right
* @left_saturation: same for the left side * @left_saturation: same for the left side
* @right_coeff: controls how fast the force grows when the joystick moves * @right_coeff: controls how fast the force grows when the joystick moves
@ -762,7 +762,7 @@ struct ff_condition_effect {
}; };
/** /**
* struct ff_periodic_effect - defines parameters of a periodic effect * struct ff_periodic_effect - defines parameters of a periodic force-feedback effect
* @waveform: kind of the effect (wave) * @waveform: kind of the effect (wave)
* @period: period of the wave (ms) * @period: period of the wave (ms)
* @magnitude: peak value * @magnitude: peak value
@ -793,7 +793,7 @@ struct ff_periodic_effect {
}; };
/** /**
* struct ff_rumble_effect - defines parameters of a periodic effect * struct ff_rumble_effect - defines parameters of a periodic force-feedback effect
* @strong_magnitude: magnitude of the heavy motor * @strong_magnitude: magnitude of the heavy motor
* @weak_magnitude: magnitude of the light one * @weak_magnitude: magnitude of the light one
* *