From patchwork Mon Feb 9 21:34:12 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eduardo Valentin X-Patchwork-Id: 5804241 Return-Path: X-Original-To: patchwork-linux-pm@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 934B9BF440 for ; Tue, 10 Feb 2015 00:39:06 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id B41EE2011E for ; Tue, 10 Feb 2015 00:39:05 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 5275E2012E for ; Tue, 10 Feb 2015 00:39:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S964921AbbBJAio (ORCPT ); Mon, 9 Feb 2015 19:38:44 -0500 Received: from mail-pd0-f182.google.com ([209.85.192.182]:40435 "EHLO mail-pd0-f182.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S964835AbbBJAim (ORCPT ); Mon, 9 Feb 2015 19:38:42 -0500 Received: by pdev10 with SMTP id v10so17587201pde.7; Mon, 09 Feb 2015 16:38:41 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=FKOYrLdJVICvgPSyskXf+WNeusleQ9IQhzRbgFY074s=; b=OfDap/iR0fsKsH0ZtnEhfsz+MhIvgCombSVMy6mvNv60Socue2aS/FWY5JC8rZ6cNm b8wR0H/k5mOENZhgnZwbe8xoqUcMicjiL9mB8N1lHeByp9iWS9mamZMQSL8Dejs5Ljs4 CIF8XvfhD0s3XgnQdAftY2FfZfbsh0XNfjCRiHkDDOZn1pR+CvfCJtR/XoAHU49eS1ZJ wRZUmXDJqna488JpDNudTtjAeTyxgtDuh7jVvAk7Rp5xWKwQE0zUlVZ+Y0PHz6szdZDl BcNxIkNbm3VJnBOGiZ0cV7dNjkZdPk8W/Wa5vrmc/XaDmOr6V98hDyKwMG/9IQpHm5HA K4Mg== X-Received: by 10.66.132.6 with SMTP id oq6mr34056136pab.29.1423528721910; Mon, 09 Feb 2015 16:38:41 -0800 (PST) Received: from localhost (amazon.gigabitethernet4-0-6.asr1.snv2.gblx.net. [64.211.110.86]) by mx.google.com with ESMTPSA id l3sm17501621pdc.46.2015.02.09.16.38.39 (version=TLSv1.2 cipher=AES128-GCM-SHA256 bits=128/128); Mon, 09 Feb 2015 16:38:40 -0800 (PST) From: Eduardo Valentin To: Rui Zhang , ezequiel.garcia@free-electrons.com, amit.kachhap@linaro.org, viresh.kumar@linaro.org, amit.daniel@samsung.com, hongbo.zhang@linaro.com, andrew@lunn.ch, durgadoss.r@intel.com, peter@piie.net, shawn.guo@linaro.org, aaron.lu@intel.com, caesar.wang@rock-chips.com, b.zolnierkie@samsung.com, l.majewski@samsung.com, vincenzo.frascino@st.com, mperttunen@nvidia.com, mikko.perttunen@kapsi.fi, srinivas.pandruvada@linux.intel.com, jacob.jun.pan@linux.intel.com, bcousson@baylibre.com Cc: LKML , Linux PM , Eduardo Valentin Subject: [PATCH RFC 11/12] thermal: step wise: fix kernel doc entry Date: Mon, 9 Feb 2015 17:34:12 -0400 Message-Id: <1423517653-11359-12-git-send-email-edubezval@gmail.com> X-Mailer: git-send-email 2.1.3 In-Reply-To: <1423517653-11359-1-git-send-email-edubezval@gmail.com> References: <1423517653-11359-1-git-send-email-edubezval@gmail.com> Sender: linux-pm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org X-Spam-Status: No, score=-5.2 required=5.0 tests=BAYES_00, DATE_IN_PAST_03_06, DKIM_ADSP_CUSTOM_MED,DKIM_SIGNED,FREEMAIL_FROM,RCVD_IN_DNSWL_HI, T_DKIM_INVALID, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Update kernel doc entry and correct the format. Now kernel doc does not complain about it. In this change we reuse the comment that explain the algorithm as a kernel doc entry. However, blank lines are added, otherwise it will appear in a single paragraph in the kernel doc output. Signed-off-by: Eduardo Valentin --- drivers/thermal/step_wise.c | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/drivers/thermal/step_wise.c b/drivers/thermal/step_wise.c index fdd1f52..413ee30 100644 --- a/drivers/thermal/step_wise.c +++ b/drivers/thermal/step_wise.c @@ -27,22 +27,34 @@ #include "thermal_core.h" -/* - * If the temperature is higher than a trip point, +/** + * DOC: Algorithm + * + * If the temperature is higher than a trip point: + * * a. if the trend is THERMAL_TREND_RAISING, use higher cooling * state for this trip point + * * b. if the trend is THERMAL_TREND_DROPPING, use lower cooling * state for this trip point + * * c. if the trend is THERMAL_TREND_RAISE_FULL, use upper limit * for this trip point + * * d. if the trend is THERMAL_TREND_DROP_FULL, use lower limit * for this trip point + * + * * If the temperature is lower than a trip point, + * * a. if the trend is THERMAL_TREND_RAISING, do nothing + * * b. if the trend is THERMAL_TREND_DROPPING, use lower cooling * state for this trip point, if the cooling state already * equals lower limit, deactivate the thermal instance + * * c. if the trend is THERMAL_TREND_RAISE_FULL, do nothing + * * d. if the trend is THERMAL_TREND_DROP_FULL, use lower limit, * if the cooling state already equals lower limit, * deactive the thermal instance @@ -169,16 +181,17 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip) } /** - * step_wise_throttle - throttles devices asscciated with the given zone - * @tz - thermal_zone_device - * @trip - the trip point - * @trip_type - type of the trip point + * step_wise_throttle - throttles devices associated with the given zone + * @tz: thermal_zone_device + * @trip: the trip point * * Throttling Logic: This uses the trend of the thermal zone to throttle. * If the thermal zone is 'heating up' this throttles all the cooling * devices associated with the zone and its particular trip point, by one * step. If the zone is 'cooling down' it brings back the performance of * the devices by one step. + * + * Return: 0. */ static int step_wise_throttle(struct thermal_zone_device *tz, int trip) {