[2/6] Haptic: Documentation for haptic class
diff mbox

Message ID 20091007061754.GA7588@july
State New, archived
Headers show

Commit Message

Kyungmin Park Oct. 7, 2009, 6:17 a.m. UTC
None

Patch
diff mbox

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.
+
+To use simple. it provides the oneshot mode. Give millisecond time to this
+property. It working at given time with pre-defined 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
+
+Also you can enable/disable by setting enable property
+
+# echo 1 > /sys/class/haptic/<device>/level	-> Enable
+# echo 0 > /sys/class/haptic/<device>/level	-> Disable