linux-pm.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Eduardo Valentin <eduardo.valentin@ti.com>
To: Zhang Rui <rui.zhang@intel.com>
Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
	Eduardo Valentin <eduardo.valentin@ti.com>
Subject: [PATCH 07/11] thermal: update kernel-doc for thermal_zone_bind_cooling_device
Date: Fri, 22 Mar 2013 17:00:50 -0400	[thread overview]
Message-ID: <1363986054-24637-8-git-send-email-eduardo.valentin@ti.com> (raw)
In-Reply-To: <1363986054-24637-1-git-send-email-eduardo.valentin@ti.com>

This patch updates the documentation for thermal_zone_bind_cooling_device
and removes the warnings generated by scripts/kernel-doc -v.

Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
---
 drivers/thermal/thermal_sys.c |   16 +++++++++++++---
 1 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/drivers/thermal/thermal_sys.c b/drivers/thermal/thermal_sys.c
index 602596e..8acaab6 100644
--- a/drivers/thermal/thermal_sys.c
+++ b/drivers/thermal/thermal_sys.c
@@ -1097,13 +1097,23 @@ thermal_remove_hwmon_sysfs(struct thermal_zone_device *tz)
 #endif
 
 /**
- * thermal_zone_bind_cooling_device - bind a cooling device to a thermal zone
- * @tz:		thermal zone device
+ * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal zone
+ * @tz:		pointer to struct thermal_zone_device
  * @trip:	indicates which trip point the cooling devices is
  *		associated with in this thermal zone.
- * @cdev:	thermal cooling device
+ * @cdev:	pointer to struct thermal_cooling_device
+ * @upper:	the Maximum cooling state for this trip point.
+ *		THERMAL_NO_LIMIT means no upper limit,
+ *		and the cooling device can be in max_state.
+ * @lower:	the Minimum cooling state can be used for this trip point.
+ *		THERMAL_NO_LIMIT means no lower limit,
+ *		and the cooling device can be in cooling state 0.
  *
+ * This interface function bind a thermal cooling device to the certain trip
+ * point of a thermal zone device.
  * This function is usually called in the thermal zone device .bind callback.
+ *
+ * Return: 0 on success, the proper error value otherwise.
  */
 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
 				     int trip,
-- 
1.7.7.1.488.ge8e1c


  parent reply	other threads:[~2013-03-22 21:03 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-22 21:00 [PATCH 00/11] thermal: clean ups on thermal code base Eduardo Valentin
2013-03-22 21:00 ` [PATCH 01/11] thermal: use strlcpy instead of strcpy Eduardo Valentin
2013-03-22 21:00 ` [PATCH 02/11] thermal: update driver license Eduardo Valentin
2013-03-22 21:00 ` [PATCH 03/11] thermal: rename notify_thermal_framework to thermal_notify_framework Eduardo Valentin
2013-03-22 21:00 ` [PATCH 04/11] thermal: rename get_thermal_instance to thermal_instance_get Eduardo Valentin
2013-03-22 21:00 ` [PATCH 05/11] thermal: rename get_tz_trend to thermal_zone_trend_get Eduardo Valentin
2013-03-22 21:00 ` [PATCH 06/11] thermal: use EXPORT_SYMBOL_GPL Eduardo Valentin
2013-03-22 21:00 ` Eduardo Valentin [this message]
2013-03-22 21:00 ` [PATCH 08/11] thermal: update kernel-doc for thermal_zone_unbind_cooling_device Eduardo Valentin
2013-03-22 21:00 ` [PATCH 09/11] thermal: update kernel-doc for thermal_cooling_device_register Eduardo Valentin
2013-03-22 21:00 ` [PATCH 10/11] thermal: update kernel-doc for create_trip_attrs Eduardo Valentin
2013-03-22 21:00 ` [PATCH 11/11] thermal: update kernel-doc for thermal_zone_device_register Eduardo Valentin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1363986054-24637-8-git-send-email-eduardo.valentin@ti.com \
    --to=eduardo.valentin@ti.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=rui.zhang@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).