From patchwork Wed Nov 6 13:28:23 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Amit Kucheria X-Patchwork-Id: 178702 Delivered-To: patch@linaro.org Received: by 2002:a92:38d5:0:0:0:0:0 with SMTP id g82csp608366ilf; Wed, 6 Nov 2019 05:29:07 -0800 (PST) X-Google-Smtp-Source: APXvYqwtvzch5/CQlqdKCzM/Eu2lHfhi9JFyckZj2ylKb/AY9KfmGrMUT0bgezsIyysCHrM00abU X-Received: by 2002:a17:906:300a:: with SMTP id 10mr34795371ejz.104.1573046947660; Wed, 06 Nov 2019 05:29:07 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1573046947; cv=none; d=google.com; s=arc-20160816; b=Ka/66xRm6wPCmUCtymEl1E9pU5dOA+y+0uGqjyN8l7ZyhYP7wCLwC3KMEwv8tNWemx zcglH/w0xmVcd+zKrGkzd7VUie+wnD5Rc/B04/U9Q6v4Mgx0/C4p2pZGDgayfgzIPju2 rl0BGgVc0JUo5eqpp4U27+0HKniO58aURQHTUNgT2TtiCTHZIugAJOjsuq4RIoYvxIO5 L5G01TwdR1tGy6U2XpzlA6I/rRR/N2dC18dn/6yT/hU/ln2t2C4ZttmQY4GsQkkIlLsE elaeAqihmyJ4YyySJPpg42iDupYEEkyGmopofKvIc5NYnqNRb95Rh0/4pRZPcQ7yz81u Y5Fg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:references :in-reply-to:message-id:date:subject:cc:to:from:dkim-signature; bh=Rxuz5AKRhYwDEc2ju4DSL4K4+pPb8Uk4j39gu0W8ZCQ=; b=Q9CILYNlA398J8q3/Cqz31EqSED4FFq045uH0dZCA++5LFL4tsE/+39jVATANSTciE 7c+7jWOaoziaWsiTNP7JXTebwU//KxFVLPZu5fx+PkdrCzYPNZ+RO7c0JCzQC4ziUjzj nBeA8hykVakutlb8ZHuYzK3C60FgiFAxYB2zinvxAuzr/NvLuGJJ/7eMD3p5xTkiG7jM PjrqHdbxy31KftIdtXpqK7e3Yl+S8RersKZob9OXOKGzL2K+1/HALChq1YMHWUfUBwJs ny4WEn7EXCDEwO63RsfFglCfijEaz3lc2/XWBnsTDRvMSrTsdbgdInYqEE85HDFzUXrH OQ3A== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=EEInOP7D; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id u11si13801342edi.385.2019.11.06.05.29.07; Wed, 06 Nov 2019 05:29:07 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=EEInOP7D; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731860AbfKFN3G (ORCPT + 26 others); Wed, 6 Nov 2019 08:29:06 -0500 Received: from mail-pg1-f193.google.com ([209.85.215.193]:39652 "EHLO mail-pg1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731826AbfKFN3E (ORCPT ); Wed, 6 Nov 2019 08:29:04 -0500 Received: by mail-pg1-f193.google.com with SMTP id 29so5829949pgm.6 for ; Wed, 06 Nov 2019 05:29:04 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :in-reply-to:references; bh=Rxuz5AKRhYwDEc2ju4DSL4K4+pPb8Uk4j39gu0W8ZCQ=; b=EEInOP7DB8lbrJuWagzB9tYaHP/rrHOL2bKvo3JM0gyhWrT02CnUe9hqCCpm9PcO8j gMqiSIawVDAZ9mrcDA7xtuPbw8DnA9wWCxCIN03EONVvvd5nLDPAIWmTK2INLgKQuQCx r6Cad7CUa3txk8jRPoX6WL2fRVXxszPE6VbNZZyVPcayMLaYC1hAhJCMMz4iHZRF7ait 66JHaWPmgAmyRGvaszkezzMGCCxKaBMwhpPm4DIP6mOB3GfVoH4vigDdZdfNMhuObvv+ tosGonmI/ET9XLrsIZUy9SQ/G5jAVgOWFvlk9QFQA7r9xN/NIhsoA4jYgcd7AanNv73u U9IQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:in-reply-to:references; bh=Rxuz5AKRhYwDEc2ju4DSL4K4+pPb8Uk4j39gu0W8ZCQ=; b=BREhtdcjJicDFHg4IXaz0IhvssRl7hIaSNRbdgMYdYHPdtUWBvqGHXPTL610QI72g5 zECZwWqR5+AdiCFampFojGV6KGYtWp8jZfzzarCdCOwbRfbHNQDENF0lvvoJ7Ksifh7N Kwnhuclc9siq5d2NuQd7GKXkQxlKrFWXtT4V8766t/bLX29r43Zt5TYi8T8sOGX1WAH3 3JXXOr/ckzEMpxj5XDTWqRiMFAFTQLE0rtoEJatQ1ztNhdsAr7tETdUp7I8kmLLzOs23 dVyX6udcoz+HDRn7cG5szUfZOuuMwhNBitpTptcJEZhO1goyY1BrfSBlndxxqKXiJYQK w2Gg== X-Gm-Message-State: APjAAAXrEuVnWK674OAK4FySkZbHZ+ilrFTjvFgL0b6ws4sCl1OXKGUS XlLP/tYSwSWXI+i2/8fkgZSFtSl3hrqMgg== X-Received: by 2002:a17:90b:24c:: with SMTP id fz12mr3761393pjb.51.1573046943798; Wed, 06 Nov 2019 05:29:03 -0800 (PST) Received: from localhost ([49.248.202.230]) by smtp.gmail.com with ESMTPSA id hi2sm2412031pjb.22.2019.11.06.05.29.02 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Wed, 06 Nov 2019 05:29:03 -0800 (PST) From: Amit Kucheria To: linux-kernel@vger.kernel.org, edubezval@gmail.com, Amit Daniel Kachhap , Amit Kucheria , Bartlomiej Zolnierkiewicz , Daniel Lezcano , Guillaume La Roque , Heiko Stuebner , Javi Merino , Jonathan Hunter , Jun Nie , Krzysztof Kozlowski , Kukjin Kim , Matthias Brugger , Shawn Guo , Thierry Reding , Viresh Kumar , Zhang Rui Cc: linux-pm@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-rockchip@lists.infradead.org Subject: [PATCH 07/11] thermal: rockchip: Appease the kernel-doc deity Date: Wed, 6 Nov 2019 18:58:23 +0530 Message-Id: <290895a22aa8a13c13b3a4ae77c13244b4ecee58.1573046440.git.amit.kucheria@linaro.org> X-Mailer: git-send-email 2.17.1 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Replace a comment starting with /** by simply /* to avoid having it interpreted as a kernel-doc comment. Describe missing function parameters where needed. Fixes up the following warnings when compiled with make W=1: linux.git/drivers/thermal/rockchip_thermal.c:27: warning: cannot understand function prototype: 'enum tshut_mode ' linux.git/drivers/thermal/rockchip_thermal.c:37: warning: cannot understand function prototype: 'enum tshut_polarity ' linux.git/drivers/thermal/rockchip_thermal.c:46: warning: cannot understand function prototype: 'enum sensor_id ' linux.git/drivers/thermal/rockchip_thermal.c:56: warning: cannot understand function prototype: 'enum adc_sort_mode ' linux.git/drivers/thermal/rockchip_thermal.c:123: warning: Function parameter or member 'chn_id' not described in 'rockchip_tsadc_chip' linux.git/drivers/thermal/rockchip_thermal.c:123: warning: Function parameter or member 'control' not described in 'rockchip_tsadc_chip' linux.git/drivers/thermal/rockchip_thermal.c:167: warning: Function parameter or member 'sensors' not described in 'rockchip_thermal_data' linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function parameter or member 'grf' not described in 'rk_tsadcv2_initialize' linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function parameter or member 'regs' not described in 'rk_tsadcv2_initialize' linux.git/drivers/thermal/rockchip_thermal.c:608: warning: Function parameter or member 'tshut_polarity' not described in 'rk_tsadcv2_initialize' linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function parameter or member 'grf' not described in 'rk_tsadcv3_initialize' linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function parameter or member 'regs' not described in 'rk_tsadcv3_initialize' linux.git/drivers/thermal/rockchip_thermal.c:644: warning: Function parameter or member 'tshut_polarity' not described in 'rk_tsadcv3_initialize' linux.git/drivers/thermal/rockchip_thermal.c:732: warning: Function parameter or member 'regs' not described in 'rk_tsadcv3_control' linux.git/drivers/thermal/rockchip_thermal.c:732: warning: Function parameter or member 'enable' not described in 'rk_tsadcv3_control' linux.git/drivers/thermal/rockchip_thermal.c:1211: warning: Function parameter or member 'reset' not described in 'rockchip_thermal_reset_controller' Signed-off-by: Amit Kucheria --- drivers/thermal/rockchip_thermal.c | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) -- 2.17.1 diff --git a/drivers/thermal/rockchip_thermal.c b/drivers/thermal/rockchip_thermal.c index 343c2f5c5a259..9ed8085bb7924 100644 --- a/drivers/thermal/rockchip_thermal.c +++ b/drivers/thermal/rockchip_thermal.c @@ -19,7 +19,7 @@ #include #include -/** +/* * If the temperature over a period of time High, * the resulting TSHUT gave CRU module,let it reset the entire chip, * or via GPIO give PMIC. @@ -29,7 +29,7 @@ enum tshut_mode { TSHUT_MODE_GPIO, }; -/** +/* * The system Temperature Sensors tshut(tshut) polarity * the bit 8 is tshut polarity. * 0: low active, 1: high active @@ -39,7 +39,7 @@ enum tshut_polarity { TSHUT_HIGH_ACTIVE, }; -/** +/* * The system has two Temperature Sensors. * sensor0 is for CPU, and sensor1 is for GPU. */ @@ -48,7 +48,7 @@ enum sensor_id { SENSOR_GPU, }; -/** +/* * The conversion table has the adc value and temperature. * ADC_DECREMENT: the adc value is of diminishing.(e.g. rk3288_code_table) * ADC_INCREMENT: the adc value is incremental.(e.g. rk3368_code_table) @@ -80,13 +80,14 @@ struct chip_tsadc_table { /** * struct rockchip_tsadc_chip - hold the private data of tsadc chip - * @chn_id[SOC_MAX_SENSORS]: the sensor id of chip correspond to the channel + * @chn_id: array of sensor ids of chip corresponding to the channel * @chn_num: the channel number of tsadc chip * @tshut_temp: the hardware-controlled shutdown temperature value * @tshut_mode: the hardware-controlled shutdown mode (0:CRU 1:GPIO) * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH) * @initialize: SoC special initialize tsadc controller method * @irq_ack: clear the interrupt + * @control: enable/disable method for the tsadc controller * @get_temp: get the temperature * @set_alarm_temp: set the high temperature interrupt * @set_tshut_temp: set the hardware-controlled shutdown temperature @@ -139,7 +140,7 @@ struct rockchip_thermal_sensor { * @chip: pointer to the platform/configuration data * @pdev: platform device of thermal * @reset: the reset controller of tsadc - * @sensors[SOC_MAX_SENSORS]: the thermal sensor + * @sensors: array of thermal sensors * @clk: the controller clock is divided by the exteral 24MHz * @pclk: the advanced peripherals bus clock * @grf: the general register file will be used to do static set by software @@ -590,6 +591,9 @@ static int rk_tsadcv2_code_to_temp(const struct chip_tsadc_table *table, /** * rk_tsadcv2_initialize - initialize TASDC Controller. + * @grf: the general register file will be used to do static set by software + * @regs: the base address of tsadc controller + * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH) * * (1) Set TSADC_V2_AUTO_PERIOD: * Configure the interleave between every two accessing of @@ -624,6 +628,9 @@ static void rk_tsadcv2_initialize(struct regmap *grf, void __iomem *regs, /** * rk_tsadcv3_initialize - initialize TASDC Controller. + * @grf: the general register file will be used to do static set by software + * @regs: the base address of tsadc controller + * @tshut_polarity: the hardware-controlled active polarity (0:LOW 1:HIGH) * * (1) The tsadc control power sequence. * @@ -723,6 +730,8 @@ static void rk_tsadcv2_control(void __iomem *regs, bool enable) /** * rk_tsadcv3_control - the tsadc controller is enabled or disabled. + * @regs: the base address of tsadc controller + * @enable: boolean flag to enable the controller * * NOTE: TSADC controller works at auto mode, and some SoCs need set the * tsadc_q_sel bit on TSADCV2_AUTO_CON[1]. The (1024 - tsadc_q) as output @@ -1206,6 +1215,7 @@ rockchip_thermal_register_sensor(struct platform_device *pdev, /** * Reset TSADC Controller, reset all tsadc registers. + * @reset: the reset controller of tsadc */ static void rockchip_thermal_reset_controller(struct reset_control *reset) {