From: Thierry Reding <thierry.reding@gmail.com>
To: "Uwe Kleine-König" <u.kleine-koenig@pengutronix.de>
Cc: Lee Jones <lee.jones@linaro.org>,
Jonathan Corbet <corbet@lwn.net>,
Michael Turquette <mturquette@baylibre.com>,
Stephen Boyd <sboyd@kernel.org>,
Jani Nikula <jani.nikula@linux.intel.com>,
Joonas Lahtinen <joonas.lahtinen@linux.intel.com>,
Rodrigo Vivi <rodrigo.vivi@intel.com>,
David Airlie <airlied@linux.ie>, Daniel Vetter <daniel@ffwll.ch>,
Support Opensource <support.opensource@diasemi.com>,
Dmitry Torokhov <dmitry.torokhov@gmail.com>,
Nicolas Ferre <nicolas.ferre@microchip.com>,
Alexandre Belloni <alexandre.belloni@bootlin.com>,
Ludovic Desroches <ludovic.desroches@microchip.com>,
Claudiu Beznea <claudiu.beznea@microchip.com>,
Shawn Guo <shawnguo@kernel.org>,
Sascha Hauer <s.hauer@pengutronix.de>,
Pengutronix Kernel Team <kernel@pengutronix.de>,
Fabio Estevam <festevam@gmail.com>,
NXP Linux Team <linux-imx@nxp.com>,
Heiko Stuebner <heiko@sntech.de>,
Fabrice Gasnier <fabrice.gasnier@st.com>,
Maxime Coquelin <mcoquelin.stm32@gmail.com>,
Alexandre Torgue <alexandre.torgue@st.com>,
Maxime Ripard <mripard@kernel.org>, Chen-Yu Tsai <wens@csie.org>,
Jernej Skrabec <jernej.skrabec@siol.net>,
Liam Girdwood <lgirdwood@gmail.com>,
Mark Brown <broonie@kernel.org>,
Daniel Thompson <daniel.thompson@linaro.org>,
Jingoo Han <jingoohan1@gmail.com>,
linux-pwm@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-clk@vger.kernel.org,
intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org,
linux-input@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linux-rockchip@lists.infradead.org,
linux-stm32@st-md-mailman.stormreply.com,
linux-fbdev@vger.kernel.org
Subject: Re: [PATCH] pwm: Rename pwm_get_state() to better reflect its semantic
Date: Tue, 6 Apr 2021 13:16:31 +0200 [thread overview]
Message-ID: <YGxDD4jVZx/H/Zdr@orome.fritz.box> (raw)
In-Reply-To: <20210406073036.26857-1-u.kleine-koenig@pengutronix.de>
[-- Attachment #1: Type: text/plain, Size: 1931 bytes --]
On Tue, Apr 06, 2021 at 09:30:36AM +0200, Uwe Kleine-König wrote:
> Given that lowlevel drivers usually cannot implement exactly what a
> consumer requests with pwm_apply_state() there is some rounding involved.
>
> pwm_get_state() traditionally returned the setting that was requested most
> recently by the consumer (opposed to what was actually implemented in
> hardware in reply to the last request). To make this semantic obvious
> rename the function.
>
> Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> ---
> Documentation/driver-api/pwm.rst | 6 +++-
> drivers/clk/clk-pwm.c | 2 +-
> drivers/gpu/drm/i915/display/intel_panel.c | 4 +--
> drivers/input/misc/da7280.c | 2 +-
> drivers/input/misc/pwm-beeper.c | 2 +-
> drivers/input/misc/pwm-vibra.c | 4 +--
> drivers/pwm/core.c | 4 +--
> drivers/pwm/pwm-atmel-hlcdc.c | 2 +-
> drivers/pwm/pwm-atmel.c | 2 +-
> drivers/pwm/pwm-imx27.c | 2 +-
> drivers/pwm/pwm-rockchip.c | 2 +-
> drivers/pwm/pwm-stm32-lp.c | 4 +--
> drivers/pwm/pwm-sun4i.c | 2 +-
> drivers/pwm/sysfs.c | 18 ++++++------
> drivers/regulator/pwm-regulator.c | 4 +--
> drivers/video/backlight/pwm_bl.c | 10 +++----
> include/linux/pwm.h | 34 ++++++++++++++--------
> 17 files changed, 59 insertions(+), 45 deletions(-)
Honestly, I don't think this is worth the churn. If you think people
will easily get confused by this then a better solution might be to more
explicitly document the pwm_get_state() function to say exactly what it
returns. But there's no need to make life difficult for everyone by
renaming this to something as cumbersome as this.
Thierry
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2021-04-06 11:16 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-06 7:30 [PATCH] pwm: Rename pwm_get_state() to better reflect its semantic Uwe Kleine-König
2021-04-06 9:32 ` Jani Nikula
2021-04-06 11:16 ` Thierry Reding [this message]
2021-04-06 13:43 ` Uwe Kleine-König
2021-04-09 12:09 ` Thierry Reding
2021-04-06 11:43 ` Mark Brown
2021-04-06 13:22 ` Roy Im
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=YGxDD4jVZx/H/Zdr@orome.fritz.box \
--to=thierry.reding@gmail.com \
--cc=airlied@linux.ie \
--cc=alexandre.belloni@bootlin.com \
--cc=alexandre.torgue@st.com \
--cc=broonie@kernel.org \
--cc=claudiu.beznea@microchip.com \
--cc=corbet@lwn.net \
--cc=daniel.thompson@linaro.org \
--cc=daniel@ffwll.ch \
--cc=dmitry.torokhov@gmail.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=fabrice.gasnier@st.com \
--cc=festevam@gmail.com \
--cc=heiko@sntech.de \
--cc=intel-gfx@lists.freedesktop.org \
--cc=jani.nikula@linux.intel.com \
--cc=jernej.skrabec@siol.net \
--cc=jingoohan1@gmail.com \
--cc=joonas.lahtinen@linux.intel.com \
--cc=kernel@pengutronix.de \
--cc=lee.jones@linaro.org \
--cc=lgirdwood@gmail.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-clk@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fbdev@vger.kernel.org \
--cc=linux-imx@nxp.com \
--cc=linux-input@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pwm@vger.kernel.org \
--cc=linux-rockchip@lists.infradead.org \
--cc=linux-stm32@st-md-mailman.stormreply.com \
--cc=ludovic.desroches@microchip.com \
--cc=mcoquelin.stm32@gmail.com \
--cc=mripard@kernel.org \
--cc=mturquette@baylibre.com \
--cc=nicolas.ferre@microchip.com \
--cc=rodrigo.vivi@intel.com \
--cc=s.hauer@pengutronix.de \
--cc=sboyd@kernel.org \
--cc=shawnguo@kernel.org \
--cc=support.opensource@diasemi.com \
--cc=u.kleine-koenig@pengutronix.de \
--cc=wens@csie.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).