staging: mei: adding mei_wd_stop function comment
authorOren Weil <oren.jer.weil@intel.com>
Wed, 7 Sep 2011 06:03:17 +0000 (09:03 +0300)
committerGreg Kroah-Hartman <gregkh@suse.de>
Fri, 9 Sep 2011 20:28:21 +0000 (13:28 -0700)
Signed-off-by: Oren Weil <oren.jer.weil@intel.com>
Acked-by: Tomas Winkler <tomas.winkler@intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
drivers/staging/mei/wd.c

index b56b1cc1e8dc3189e4cac6a0076f0e9cd19d3d01..ffca7ca3265861c4ee825cdbb99174c39fbaa852 100644 (file)
@@ -120,6 +120,16 @@ int mei_wd_send(struct mei_device *dev)
        return -EIO;
 }
 
+/**
+ * mei_wd_stop - sends watchdog stop message to fw.
+ *
+ * @dev: the device structure
+ * @preserve: indicate if to keep the timeout value
+ *
+ * returns 0 if success,
+ *     -EIO when message send fails
+ *     -EINVAL when invalid message is to be sent
+ */
 int mei_wd_stop(struct mei_device *dev, bool preserve)
 {
        int ret;