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: 1172332 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=linux-pwm-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="mT58WraE"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 46m9wl2nmDz9sPJ for ; Sun, 6 Oct 2019 15:43:34 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1725958AbfJFEnc (ORCPT ); Sun, 6 Oct 2019 00:43:32 -0400 Received: from mail-pf1-f195.google.com ([209.85.210.195]:32884 "EHLO mail-pf1-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725298AbfJFEnc (ORCPT ); Sun, 6 Oct 2019 00:43:32 -0400 Received: by mail-pf1-f195.google.com with SMTP id q10so6412122pfl.0 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=kLi9DXU4dsJynJxLpN7zwdz+9jvR8D9UC+hDUrGbLdEUGPRWZIvs4c1E8VwtfoX3Iu AuUdy+0uyBTYCZl6c38erM1ewOrflxHOjnT8xzPifHFe00b/4DWTmSyuCv/6/WTlS9Kf Tfall5ZCy0i7s3XSfM02dFS38bV9XKLrbxUTOgzvP5YRp/uMjAWgUSzdANTaSBPragAH T/B1v6Ph575Dmn69NoW2izRcKozVpyE/i6yxObVmGNi9Ye20ekgSTXoNdmo/aKkq8C6h EG9ICVXA8yVkMvfaEiBWTT5+S8scY20iPPnlWx+v5fKjhxAGBklrP07yoSmr5xxtRjsX L8kw== X-Gm-Message-State: APjAAAUEjaehffWu6vz8Q7LYtqbi8u4z/Tj7drYHFDzCApBw2rTpVlDy LSZ19ugvivWAAytVL0vwTa1aJjWC18s= X-Google-Smtp-Source: APXvYqyLpc5tvMaDdt2mWljW9j21Zq9//Fs8mt7wJ5+bP4PVVJoqyMexxAA46O4wXBov/mCGCwr+jg== 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-pwm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pwm@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(-) 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.