[2/6] Haptic: Documentation for haptic class (v2)

Commit Message

Kyungmin Park Oct. 9, 2009, 9:01 a.m. UTC

None

Patch

diff --git a/Documentation/haptic-class.txt b/Documentation/haptic-class.txt
new file mode 100644
index 0000000..6bee82a
--- /dev/null
+++ b/Documentation/haptic-class.txt
@@ -0,0 +1,20 @@ 
+
+Haptic handling under Linux
+========================
+
+In its simplest form, the haptic class just allows control of Haptics from
+userspace. Haptic appears in /sys/class/haptic/. The maximum level of the
+haptic is defined in max_level file.
+
+The interface is pretty simple - it provides oneshot mode where user
+can specify duration of the effect (in milliseconds) and desired level
+Of course, you can adjust the level by setting level property
+
+# echo ${millisecond} > /sys/class/haptic/<device>/oneshot
+
+# echo ${level} > /sys/class/haptic/<device>/level
+
+You can also enable or disable haptics devices by manipulating 'enable' attribute:
+
+# echo 1 > /sys/class/haptic/<device>/enable	-> Enable
+# echo 0 > /sys/class/haptic/<device>/enable	-> Disable