From patchwork Thu Feb 7 10:49:19 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Amit Kucheria X-Patchwork-Id: 10800809 X-Patchwork-Delegate: agross@codeaurora.org Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 6E97A13A4 for ; Thu, 7 Feb 2019 10:50:09 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 5BD762A75F for ; Thu, 7 Feb 2019 10:50:09 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4D07F2A790; Thu, 7 Feb 2019 10:50:09 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id E36B72A75F for ; Thu, 7 Feb 2019 10:50:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727002AbfBGKuD (ORCPT ); Thu, 7 Feb 2019 05:50:03 -0500 Received: from mail-wr1-f67.google.com ([209.85.221.67]:35328 "EHLO mail-wr1-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726642AbfBGKuD (ORCPT ); Thu, 7 Feb 2019 05:50:03 -0500 Received: by mail-wr1-f67.google.com with SMTP id z18so10245783wrh.2 for ; Thu, 07 Feb 2019 02:50:01 -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=H2crl7RmZMvIJT00kHO5k98tCahG1bLmtk7Nv322/6A=; b=woMmpAbvOB6OAKBWoHY/WgFkqOflUkOdg3Vm0er4QEBoZU7IqZm1lCqnEx7Y96OPaK iH+F7H4/gwJCqvko0pwphaML5ZFTF8p472cuMSj9KUx55y/S3obdknFha/JWtdBc5MYH HciZLy7gx0VqnRRZUQbdAeK5rtjlhoPfZPDg7STgYZZiEnEJBMH5l2dppVr/m/sAlN4u A+zenUaj6QahFzLwhUGMib6Pgv6tJjUHWALyQPp/ziCXbqZvFFGpdAVOpomACsPmrKbW sp1EgUSSdzffKRcAM5lXIwniD0ExKTkcbL8gPnYXQ+6SGzwV2K+/Y7uL9K6daKNmd+9K R4xg== 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=H2crl7RmZMvIJT00kHO5k98tCahG1bLmtk7Nv322/6A=; b=YHi2mULgWcuEeq67sP2uyXWPcQAWCLHRSYvUGy1Szs3TcytCcAuAgrxKH/bdIgLqUj nde+Sx9T/QSSIqjJal1unwUgn0E8qrIdbUcZKhkq9V+XCvWZRfpIafPn0U0r/wve0uCT rzFnW2GTntFvgSP9rfXffIul6pqD+SgXfhDpwQVXv8uWclXyj60bvh01IsJyuwO9Dj2n 1MJsIc/TV3H7DhZSZCWlNwuLzMiYYGhJkcmBfhoorDr3ZCfTrtDTmRNwQ8xkR+sjhXxB sRGzafVCaL1nWErus6v2dLV6DEvoq7GVIqullWmRYRtk5Ky+O+exG//Jfm7HAR+33dEo 2pLw== X-Gm-Message-State: AHQUAuZ4NA7aw04uwFm9ZCnY/VBStoK3aFVBCUyA2PNA5YXtKTxoQlmU iDmnh+5MiucgkWisAiWDhoqtUQ== X-Google-Smtp-Source: AHgI3Iat+Abn4qc0mXn6/0b0ujcT/x+ZFVj0KtmB5KVeD65d3Rgs/xtM7xBVL/Xh/hbC3304qgflPg== X-Received: by 2002:a5d:6803:: with SMTP id w3mr12013788wru.272.1549536600901; Thu, 07 Feb 2019 02:50:00 -0800 (PST) Received: from localhost ([49.248.196.115]) by smtp.gmail.com with ESMTPSA id a62sm24387481wmf.47.2019.02.07.02.49.59 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 07 Feb 2019 02:50:00 -0800 (PST) From: Amit Kucheria To: linux-kernel@vger.kernel.org, linux-arm-msm@vger.kernel.org, bjorn.andersson@linaro.org, edubezval@gmail.com, andy.gross@linaro.org, Daniel Lezcano , David Brown , Zhang Rui Cc: linux-pm@vger.kernel.org Subject: [PATCH v1 01/24] drivers: thermal: tsens: Document the data structures Date: Thu, 7 Feb 2019 16:19:19 +0530 Message-Id: X-Mailer: git-send-email 2.17.1 In-Reply-To: References: In-Reply-To: References: Sender: linux-arm-msm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-arm-msm@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Describe how the TSENS device and the various sensors connected to it are described in the driver Signed-off-by: Amit Kucheria --- drivers/thermal/qcom/tsens.h | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/drivers/thermal/qcom/tsens.h b/drivers/thermal/qcom/tsens.h index 7b7feee5dc46..89318523c848 100644 --- a/drivers/thermal/qcom/tsens.h +++ b/drivers/thermal/qcom/tsens.h @@ -14,6 +14,16 @@ struct tsens_device; +/** + * struct tsens_sensor - data for each sensor connected to the tsens device + * @tmdev: tsens device instance that this sensor is connected to + * @tzd: pointer to the thermal zone that this sensor is in + * @offset: offset of temperature adjustment curve + * @id: Sensor ID + * @hw_id: HW ID can be used in case of platform-specific IDs + * @slope: slope of temperature adjustment curve + * @status: 8960-specific variable to track 8960 and 8660 status register offset + */ struct tsens_sensor { struct tsens_device *tmdev; struct thermal_zone_device *tzd; @@ -55,8 +65,8 @@ enum reg_list { }; /** - * struct tsens_data - tsens instance specific data - * @num_sensors: Max number of sensors supported by platform + * struct tsens_data - tsens platform data + * @num_sensors: Number of sensors supported by platform * @ops: operations the tsens instance supports * @hw_ids: Subset of sensors ids supported by platform, if not the first n * @reg_offsets: Register offsets for commonly used registers @@ -68,12 +78,27 @@ struct tsens_data { unsigned int *hw_ids; }; -/* Registers to be saved/restored across a context loss */ +/** + * struct tsens_context - Registers to be saved/restored across a context loss + */ struct tsens_context { int threshold; int control; }; +/** + * struct tsens_device - private data for each instance of the tsens IP + * @dev: pointer to struct device + * @num_sensors: number of sensors enabled on this device + * @tm_map: pointer to TM register address space + * @srot_map: pointer to SROT register address space + * @tm_offset: deal with old device trees that don't address TM and SROT + * address space separately + * @reg_offsets: array of offsets to important regs for this version of IP + * @ctx: registers to be saved and restored during suspend/resume + * @ops: pointer to list of callbacks supported by this device + * @sensor: list of sensors attached to this device + */ struct tsens_device { struct device *dev; u32 num_sensors;