From: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Date: Tue, 30 Jul 2019 12:32:29 +0000 (+0200)
Subject: pwm: jz4740: Document known limitations
X-Git-Tag: v5.15~5402^2~31
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=3b442c60cf9766c76bc3c1e44e3e387853074a08;p=platform%2Fkernel%2Flinux-starfive.git

pwm: jz4740: Document known limitations

The JZ4740 PWM implementation doesn't fulfill the (up to now
insufficiently documented) requirements of the PWM API. At least
document them in the driver.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Reviewed-by: Paul Cercueil <paul@crapouillou.net>
Signed-off-by: Thierry Reding <thierry.reding@gmail.com>
---

diff --git a/drivers/pwm/pwm-jz4740.c b/drivers/pwm/pwm-jz4740.c
index f901e8a..9d444d01 100644
--- a/drivers/pwm/pwm-jz4740.c
+++ b/drivers/pwm/pwm-jz4740.c
@@ -2,6 +2,11 @@
 /*
  *  Copyright (C) 2010, Lars-Peter Clausen <lars@metafoo.de>
  *  JZ4740 platform PWM support
+ *
+ * Limitations:
+ * - The .apply callback doesn't complete the currently running period before
+ *   reconfiguring the hardware.
+ * - Each period starts with the inactive part.
  */
 
 #include <linux/clk.h>