From patchwork Sun Oct 6 04:43:26 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bjorn Andersson X-Patchwork-Id: 175283 Delivered-To: patch@linaro.org Received: by 2002:a92:7e96:0:0:0:0:0 with SMTP id q22csp2705984ill; Sat, 5 Oct 2019 21:44:17 -0700 (PDT) X-Google-Smtp-Source: APXvYqy9NJVNaHLvzrQZarJMN9IqSd2YXMxKL6tbtuQRntQnq/LANBrdZJxK4KXM52QSTjElXCtn X-Received: by 2002:aa7:c2ce:: with SMTP id m14mr23301266edp.191.1570337057790; Sat, 05 Oct 2019 21:44:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1570337057; cv=none; d=google.com; s=arc-20160816; b=jb4LNq6NSM9+UmgjOBhZGk4csEujuZUrwshXIVCqUsPtuCmheCWsFNek+M6T8cjDNA GetIIeHx9xjjh5x79V9+rH2xTmR5fNOefrE8adVJQzSKRH7E/oocF5mn5AWEMQ8LAcGD f60QBSb7d27tF25xu7fo5PORv0Ou3PwZPJ152IKv6/6PgaWUtTYTy2PqrZGWlvvvh6iQ 0P/xdC2MrRPXHQgSxSv6lndJtCalNrcKSa98Ejwmp73w80Kgm0LCrP0+WoW/rmS58FIW pVvToEQZAazdPPS49NvCe97D9BE0gBOwDxIrXqYZyFuCCk/6MVk65J08qQXuO9DYIqdQ x5Jg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:message-id:date:subject:cc:to:from :dkim-signature; bh=O9DS1pnBfgmugCUm9X9KTPp9NfZzZz5SWHJyycSHOa8=; b=a8wxBsF1L+GIOFH3kI46Tzq83b1S0kwwIhNqDbMz2o83XJEuDUrvw31qE3gOz1Neen aHcWVedCkaOk77sIGB6fsvFAwB7G/S5lt8z1CZ4D5Jf3ahpupokjb0DBZOFCrFQbGAIy 8/JsusIxLIRCV6kUJGMiQdi4Wdpmk/jYvkatwNZGYK8ZviTaW38grPpeVFNlAkb+Quhq vixjuZ7G9KhgbV1cnLsK0nuJYmr+K0Qj5/2DLRuJ760CQywyeTf3FbLcljsyyiFO7bus rUMZXmxEo1IWd7b5y/trOjnKRPUmWuWf5IhrthMmns01lrz+s1OrC+U36IpvOY0FnZws tLLA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=mT58WraE; 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 u30si6096812edl.366.2019.10.05.21.44.14; Sat, 05 Oct 2019 21:44:17 -0700 (PDT) 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=mT58WraE; 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 S1726092AbfJFEnd (ORCPT + 27 others); Sun, 6 Oct 2019 00:43:33 -0400 Received: from mail-pf1-f193.google.com ([209.85.210.193]:42184 "EHLO mail-pf1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725899AbfJFEnc (ORCPT ); Sun, 6 Oct 2019 00:43:32 -0400 Received: by mail-pf1-f193.google.com with SMTP id q12so6363228pff.9 for ; Sat, 05 Oct 2019 21:43:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=O9DS1pnBfgmugCUm9X9KTPp9NfZzZz5SWHJyycSHOa8=; b=mT58WraESphLJi1YCTvdXwLK4HZ+G+XXhBacRETPW8JOgN3S7kFkm9n/heVUasoAKS eYfuhgYINyTf8aK5G/fzyOnntkIaQNCWhViL/nyY1TKoBBQP8fVYwZoBW4O/BRlN/gER Tnkjj6AXJqlueRhFuH9ludKHb9Q+OoB6KL6wLJ3QJsA+7zF7o9/zQVCyVuW1QMiCQG4Y s7XRdSCmObHhK8LXOEfPN30nHUEZm2hXBHaMu0P8wBL3cmGP9issZ9u7n71Ivy+kR6mz mOReCVGTSzKoP1GFpGGqnDpvdQpbUPg1L0U3eiFeGmg3FtjPT+WXRwBwP5xEUt1YXEAy hekQ== 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; bh=O9DS1pnBfgmugCUm9X9KTPp9NfZzZz5SWHJyycSHOa8=; b=TV5GTCaDWT0v8qBV1gMbcfUw7AsclpoGCbc+JZp4PWl6toREEOSUimd0nOK7torBWe vVW6cZhHYnPdEY9QFdLf+BYa7a4RSpyB89KkwerSJjWmhbTwgIydBy7eiKxy1HWg3r0O pRomZrMkZjOeLQZVjmBgnhPEXVFYd2zy3AaMST8M2mUPQSMGRjiFPi3Bf7zmuRBHb7AE xkxBwNg7HnmGMYL/2vpe+HXYSC0Rh2yWwg6y26QjY1B9KPAkG4AbGtcr48n+s+Bq/lyl pmH59zg8aoram77U02a+2Algm+lfITnZXMWUbOUdS8lFmBod8vx8jKdEi21pfdv41N6v zpKQ== X-Gm-Message-State: APjAAAXl60h3G4eheAdzSiKhwlKiyDrtSO20xNPysu3oVL0SiCthtx1D HAshGGdAey7sOcGb/Q5xDaL1PQ== X-Received: by 2002:aa7:96b8:: with SMTP id g24mr26938028pfk.163.1570337011730; Sat, 05 Oct 2019 21:43:31 -0700 (PDT) Received: from localhost.localdomain (104-188-17-28.lightspeed.sndgca.sbcglobal.net. [104.188.17.28]) by smtp.gmail.com with ESMTPSA id s5sm8157384pjn.24.2019.10.05.21.43.30 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sat, 05 Oct 2019 21:43:31 -0700 (PDT) From: Bjorn Andersson To: Thierry Reding , =?utf-8?q?Uwe_Kleine-K?= =?utf-8?b?w7ZuaWc=?= Cc: linux-pwm@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] pwm: Fix kerneldoc for apply operation Date: Sat, 5 Oct 2019 21:43:26 -0700 Message-Id: <20191006044326.12043-1-bjorn.andersson@linaro.org> X-Mailer: git-send-email 2.18.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org As the @state passed to apply() is now const the comment in the kerneldoc about drivers being expected to adjust the parameters is no longer valid. Update it to reflect the API change. Fixes: 71523d1812ac ("pwm: Ensure pwm_apply_state() doesn't modify the state argument") Signed-off-by: Bjorn Andersson --- include/linux/pwm.h | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) -- 2.18.0 diff --git a/include/linux/pwm.h b/include/linux/pwm.h index b2c9c460947d..8bc86f645d0d 100644 --- a/include/linux/pwm.h +++ b/include/linux/pwm.h @@ -243,10 +243,7 @@ pwm_set_relative_duty_cycle(struct pwm_state *state, unsigned int duty_cycle, * @request: optional hook for requesting a PWM * @free: optional hook for freeing a PWM * @capture: capture and report PWM signal - * @apply: atomically apply a new PWM config. The state argument - * should be adjusted with the real hardware config (if the - * approximate the period or duty_cycle value, state should - * reflect it) + * @apply: atomically apply a new PWM config. * @get_state: get the current PWM state. This function is only * called once per PWM device when the PWM chip is * registered.