Commit e4477d2d authored by Randy Dunlap's avatar Randy Dunlap Committed by Dmitry Torokhov
Browse files

Input: add to kernel-api docbook 



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

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarDmitry Torokhov <dtor@mail.ru>
parent f9705fcb

Documentation/DocBook/kernel-api.tmpl

+8 −0
Original line number Diff line number Diff line
@@ -533,4 +533,12 @@ X!Idrivers/video/console/fonts.c 
-->

     </sect1>

  </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>

drivers/input/ff-core.c

+2 −2
Original line number Diff line number Diff line
@@ -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

 * @effect_id: id of the ffect to be erased

 * @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

 * @dev: input device supporintg force feedback

 * @dev: input device supporting force feedback

 *

 * This function is only needed in error path as input core will

 * automatically free force feedback structures when device is

drivers/input/ff-memless.c

+1 −1
Original line number Diff line number Diff line
@@ -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

 * @data: driver-specific data to be passed into @play_effect

 * @play_effect: driver-specific method for playing FF effect

include/linux/input.h

+9 −9
Original line number Diff line number Diff line
@@ -663,7 +663,7 @@ struct input_absinfo { 
#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_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

 * @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

 * @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_level: level at the beginning of the attack

 * @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

 * @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

 * @end_level: final strength of the effect; may be negative

 * @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

 * @left_saturation: same for the left side

 * @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)

 * @period: period of the wave (ms)

 * @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

 * @weak_magnitude: magnitude of the light one

 *