diff options
| author | Jerzy Kasenberg <jerzy.kasenberg@tieto.com> | 2010-09-22 15:21:12 +0200 |
|---|---|---|
| committer | srinidhi kasagar <srinidhi.kasagar@stericsson.com> | 2010-10-27 16:12:34 +0530 |
| commit | 9dc1517a5dafe35870549fb297f0ab2559563c06 (patch) | |
| tree | 37046d7217e830a87f6203caba34f5703cd1e016 /Documentation | |
| parent | f81a492d98d727a8d0d9ee437adf2c7b776a9ba0 (diff) | |
Timed output vibrator: New functionality.
This patch allows to form the vibration characteristic
using few parameters defined in the platform data:
- boost level and period for start condition
- on level as moderate speed
- off level and period for brake condition
Detailed information can be found here:
Documentation\DocBook\ste_timed_vibra.html
ST-Ericsson ID: CR261901
Change-Id: I3e6f0ce6fa3879897e309240b51e86680698d5cb
Signed-off-by: Grzegorz Sygieda <grzegorz.sygieda@tieto.com>
Signed-off-by: Krzysztof Antonowicz <krzysztof.antonowicz@tieto.com>
Reviewed-on: http://gerrit.lud.stericsson.com/gerrit/3049
Reviewed-by: Jerzy Kasenberg <jerzy.kasenberg@tieto.com>
Tested-by: Jerzy Kasenberg <jerzy.kasenberg@tieto.com>
Reviewed-by: Mattias WALLIN <mattias.wallin@stericsson.com>
Tested-by: build servers
Reviewed-by: Linus WALLEIJ <linus.walleij@stericsson.com>
Signed-off-by: srinidhi kasagar <srinidhi.kasagar@stericsson.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/DocBook/ste_timed_vibra.tmpl | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/Documentation/DocBook/ste_timed_vibra.tmpl b/Documentation/DocBook/ste_timed_vibra.tmpl index 969713286d5..ae9e62c9fb1 100644 --- a/Documentation/DocBook/ste_timed_vibra.tmpl +++ b/Documentation/DocBook/ste_timed_vibra.tmpl @@ -79,13 +79,31 @@ <section id="basic-tutorial"> <title>Basic Tutorial</title> <para> + Before using this driver few parameters shall be defined in the platform data structure: + <itemizedlist> + <listitem><para>Boost level - vibrator speed in the the startup stage</para></listitem> + <listitem><para>Boost time - vibrator startup period</para></listitem> + <listitem><para>On level - vibrator moderate speed</para></listitem> + <listitem><para>On time - vibrator moderate period</para></listitem> + <listitem><para>Off level - vibrator speed in the stop stage</para></listitem> + <listitem><para>Off time - vibrator stop period</para></listitem> + </itemizedlist> + </para> + <para> + NOTE: If the time elapsing between the ON and OFF sequence is smaller than the 'boost' period, + then OFF is delayed until the 'boost' expires. If the time elapsing between the OFF and + ON sequence is smaller than the 'off' period, then ON is delayed until the 'off' period expires. + The ON request when vibrator is in 'boost' or 'on' stage is ignored. + The OFF request when vibrator is in the 'off' stage is ignored. + </para> + <para> To enable the Timed Output Vibrator driver using Kconfig, go to <constant> Device Drivers -> Staging -> Android </constant> and enable the following: + </para> <itemizedlist> <listitem><para>ST-Ericsson Timed Output Vibrator driver</para></listitem> </itemizedlist> - </para> </section> </chapter> @@ -104,10 +122,18 @@ <itemizedlist> <listitem><para>/sys/class/timed_output/vibrator/enable</para></listitem> </itemizedlist> - To turn vibrator for 1s, following command should be executed: + To turn on the vibrator for 1s, following command should be executed: <itemizedlist> <listitem><para>echo 1000 > /sys/class/timed_output/vibrator/enable</para></listitem> </itemizedlist> + To turn off the vibrator if enabled, then the following command should be executed: + <itemizedlist> + <listitem><para>echo 0 > /sys/class/timed_output/vibrator/enable</para></listitem> + </itemizedlist> + To get the remaining time, the following command should be executed: + <itemizedlist> + <listitem><para>cat /sys/class/timed_output/vibrator/enable</para></listitem> + </itemizedlist> </para> </chapter> |