Received: by 2002:a05:6a10:f347:0:0:0:0 with SMTP id d7csp1269232pxu; Mon, 23 Nov 2020 16:34:34 -0800 (PST) X-Google-Smtp-Source: ABdhPJzbL7E7m71+rWGSz9zuXQta0yF0SguDmoJPwbnnWeeyK+p7kJvwV1oRch4sZgvZw37LUTHe X-Received: by 2002:a17:906:170e:: with SMTP id c14mr2049245eje.117.1606178074547; Mon, 23 Nov 2020 16:34:34 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1606178074; cv=none; d=google.com; s=arc-20160816; b=fZkf/Jvxo2ieY6VHhonkAj2dE3Lcqc+1AlXuMULsuctchLeAlqcrKCnBBiIf2AUtPu /ouIFRcQa7NRtLsn1MePe5EeDRs8IyUgmkM6SpHoS/b2mld3al+cnFgiGb0EpPWhl/hK KyUHB0AzGfoUC1/JB9GTh4TRFPC3erHnsb3HgvXc8I1orXvdTNbkaDKBROGHngrxrAUo 4RL6msDVh1CALUHrCdbaCVjvFn7aALdl31HRYxmXUsMWuqUTP6lc7NUIRHpfA0/7h0P+ sS5MqLnPCsmrUabTXsxHXJCrEqU58NxZmNBcx7QtddsGSLfcy5n9IXk0nFKHmb+QeQL0 GzSQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=hz41Z7I9zqzApgPMAgsAHyGF2DXhsrx8qvTtKK3pLh4=; b=UsQRVOTDqFLjFGGgIQCQv6P9gmhQj/AkeP7eI3l43WbEPqdvgfo+uQcqDuzhgwcATo tSAu7Dq0C6qixO8NELD9YDK/A4ucUCYot/MFZWgvt2qhrCxU6yUjLaJR8L8s1SNiwiH+ SV4iR06fG74gYsYLhT0Ij6bIx5Ip92Z7jG1m/B7pu4hPUh1OheamTFkkvmZ35AXW2vVS GB2JNQYFq0wxUPlkzw9I3E99z/xVVvP4ice9V6sxVogrY9s+iJ3Q6xfu+X15AJQSc/jg WfKAX7gn5Kzj6qbPl/m0Qmwne+8Pz1AvXePKX+hgHDWxCzm98PlbMsUtXqMlCGSwtuDk 2fdA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@pqgruber.com header.s=mail header.b=kATSGPeJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=pqgruber.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id q4si8887472eji.62.2020.11.23.16.34.12; Mon, 23 Nov 2020 16:34:34 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@pqgruber.com header.s=mail header.b=kATSGPeJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=pqgruber.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2390107AbgKWQgt (ORCPT + 99 others); Mon, 23 Nov 2020 11:36:49 -0500 Received: from mail.pqgruber.com ([52.59.78.55]:41296 "EHLO mail.pqgruber.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2390052AbgKWQgs (ORCPT ); Mon, 23 Nov 2020 11:36:48 -0500 Received: from workstation.tuxnet (213-47-165-233.cable.dynamic.surfer.at [213.47.165.233]) by mail.pqgruber.com (Postfix) with ESMTPSA id 1D026C81EEB; Mon, 23 Nov 2020 17:36:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pqgruber.com; s=mail; t=1606149404; bh=hz41Z7I9zqzApgPMAgsAHyGF2DXhsrx8qvTtKK3pLh4=; h=From:To:Cc:Subject:Date:From; b=kATSGPeJgjkR1bWYcVASYBbDIU6G/k+iCDutWhBuy2HNURdglU+BJLxi+vykNxnEk H04xUD7icnDZDanZs/J89JurRbxv+lh9qyx9CSwC6cpy9GohYkHMhPD0x1wtanerki pUaUHI3hKDzWwYtfvY9NXGahiWrcyCae+R1l1h3s= From: Clemens Gruber To: linux-pwm@vger.kernel.org Cc: Thierry Reding , u.kleine-koenig@pengutronix.de, Lee Jones , linux-kernel@vger.kernel.org, Sven Van Asbroeck , Mika Westerberg , David Jander , Clemens Gruber Subject: [PATCH v2 1/4] pwm: pca9685: Switch to atomic API Date: Mon, 23 Nov 2020 17:36:20 +0100 Message-Id: <20201123163622.166048-1-clemens.gruber@pqgruber.com> X-Mailer: git-send-email 2.29.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This switch to the atomic API goes hand in hand with a few fixes to previously experienced issues: - The duty cycle is no longer lost after disable/enable (previously the OFF registers were cleared in disable and the user was required to call config to restore the duty cycle settings) - The prescale register is now read out. If one sets a period resulting in the same prescale register value, the sleep and write to the register is skipped - On systems without CONFIG_PM, the chip is now woken up in probe and put to sleep in remove (before, the chip was stuck in sleep when the default period was configured after POR) The hardware readout may return slightly different values than those that were set in apply due to the limited range of possible prescale and counter register values. If one channel is reconfigured with new duty cycle and period, the others will keep the same relative duty cycle to period ratio as they had before, even though the per-chip / global frequency changed. (The PCA9685 has only one prescaler!) Note that although the datasheet mentions 200 Hz as default frequency when using the internal 25 MHz oscillator, the calculated period from the default prescaler register setting of 30 is 5079040ns. Signed-off-by: Clemens Gruber --- Changes since v1: - Fixed a logic error - Impoved PM runtime handling and fixed !CONFIG_PM - Write default prescale reg value if invalid in probe - Reuse full_off/_on functions throughout driver - Use cached prescale value whenever possible drivers/pwm/pwm-pca9685.c | 295 ++++++++++++++++++++------------------ 1 file changed, 159 insertions(+), 136 deletions(-) diff --git a/drivers/pwm/pwm-pca9685.c b/drivers/pwm/pwm-pca9685.c index 4a55dc18656c..47a69ee7951f 100644 --- a/drivers/pwm/pwm-pca9685.c +++ b/drivers/pwm/pwm-pca9685.c @@ -47,11 +47,11 @@ #define PCA9685_ALL_LED_OFF_H 0xFD #define PCA9685_PRESCALE 0xFE +#define PCA9685_PRESCALE_DEF 0x1E /* => default frequency of ~200 Hz */ #define PCA9685_PRESCALE_MIN 0x03 /* => max. frequency of 1526 Hz */ #define PCA9685_PRESCALE_MAX 0xFF /* => min. frequency of 24 Hz */ #define PCA9685_COUNTER_RANGE 4096 -#define PCA9685_DEFAULT_PERIOD 5000000 /* Default period_ns = 1/200 Hz */ #define PCA9685_OSC_CLOCK_MHZ 25 /* Internal oscillator with 25 MHz */ #define PCA9685_NUMREGS 0xFF @@ -74,7 +74,7 @@ struct pca9685 { struct pwm_chip chip; struct regmap *regmap; - int period_ns; + int prescale; #if IS_ENABLED(CONFIG_GPIOLIB) struct mutex lock; struct gpio_chip gpio; @@ -87,6 +87,61 @@ static inline struct pca9685 *to_pca(struct pwm_chip *chip) return container_of(chip, struct pca9685, chip); } +static inline bool is_prescale_valid(int prescale) +{ + return prescale >= PCA9685_PRESCALE_MIN && + prescale <= PCA9685_PRESCALE_MAX; +} + +static void pca9685_pwm_full_off(struct pca9685 *pca, int index) +{ + int reg; + + /* + * Set the full OFF bit to cause the PWM channel to be always off. + * The full OFF bit has precedence over the other register values. + */ + + if (index >= PCA9685_MAXCHAN) + reg = PCA9685_ALL_LED_OFF_H; + else + reg = LED_N_OFF_H(index); + + regmap_write(pca->regmap, reg, LED_FULL); +} + +static void pca9685_pwm_full_on(struct pca9685 *pca, int index) +{ + int reg; + + /* + * Clear the OFF registers (including the full OFF bit) and set + * the full ON bit to cause the PWM channel to be always on. + */ + + if (index >= PCA9685_MAXCHAN) + reg = PCA9685_ALL_LED_OFF_L; + else + reg = LED_N_OFF_L(index); + + regmap_write(pca->regmap, reg, 0); + + if (index >= PCA9685_MAXCHAN) + reg = PCA9685_ALL_LED_OFF_H; + else + reg = LED_N_OFF_H(index); + + regmap_write(pca->regmap, reg, 0); + + if (index >= PCA9685_MAXCHAN) + reg = PCA9685_ALL_LED_ON_H; + else + reg = LED_N_ON_H(index); + + regmap_write(pca->regmap, reg, LED_FULL); +} + + #if IS_ENABLED(CONFIG_GPIOLIB) static bool pca9685_pwm_test_and_set_inuse(struct pca9685 *pca, int pwm_idx) { @@ -141,31 +196,27 @@ static int pca9685_pwm_gpio_get(struct gpio_chip *gpio, unsigned int offset) struct pwm_device *pwm = &pca->chip.pwms[offset]; unsigned int value; - regmap_read(pca->regmap, LED_N_ON_H(pwm->hwpwm), &value); + regmap_read(pca->regmap, LED_N_OFF_H(pwm->hwpwm), &value); - return value & LED_FULL; + return !(value & LED_FULL); } static void pca9685_pwm_gpio_set(struct gpio_chip *gpio, unsigned int offset, int value) { struct pca9685 *pca = gpiochip_get_data(gpio); - struct pwm_device *pwm = &pca->chip.pwms[offset]; - unsigned int on = value ? LED_FULL : 0; - - /* Clear both OFF registers */ - regmap_write(pca->regmap, LED_N_OFF_L(pwm->hwpwm), 0); - regmap_write(pca->regmap, LED_N_OFF_H(pwm->hwpwm), 0); - /* Set the full ON bit */ - regmap_write(pca->regmap, LED_N_ON_H(pwm->hwpwm), on); + if (value) + pca9685_pwm_full_on(pca, offset); + else + pca9685_pwm_full_off(pca, offset); } static void pca9685_pwm_gpio_free(struct gpio_chip *gpio, unsigned int offset) { struct pca9685 *pca = gpiochip_get_data(gpio); - pca9685_pwm_gpio_set(gpio, offset, 0); + pca9685_pwm_full_off(pca, offset); pm_runtime_put(pca->chip.dev); pca9685_pwm_clear_inuse(pca, offset); } @@ -246,36 +297,75 @@ static void pca9685_set_sleep_mode(struct pca9685 *pca, bool enable) } } -static int pca9685_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm, - int duty_ns, int period_ns) +static void pca9685_set_prescale(struct pca9685 *pca, int prescale) +{ + /* Put chip into sleep mode */ + pca9685_set_sleep_mode(pca, true); + + /* Change the chip-wide output frequency */ + regmap_write(pca->regmap, PCA9685_PRESCALE, prescale); + + /* Wake the chip up */ + pca9685_set_sleep_mode(pca, false); + + pca->prescale = prescale; +} + +static void pca9685_pwm_get_state(struct pwm_chip *chip, struct pwm_device *pwm, + struct pwm_state *state) +{ + struct pca9685 *pca = to_pca(chip); + unsigned int val, duty; + int reg; + + /* Calculate (chip-wide) period from cached prescale value */ + state->period = (PCA9685_COUNTER_RANGE * 1000 / PCA9685_OSC_CLOCK_MHZ) * + (pca->prescale + 1); + + /* The (per-channel) polarity is fixed */ + state->polarity = PWM_POLARITY_NORMAL; + + /* Read out current duty cycle and enabled state */ + reg = pwm->hwpwm >= PCA9685_MAXCHAN ? PCA9685_ALL_LED_OFF_H : + LED_N_OFF_H(pwm->hwpwm); + regmap_read(pca->regmap, reg, &val); + duty = (val & 0xf) << 8; + + state->enabled = !(val & LED_FULL); + + reg = pwm->hwpwm >= PCA9685_MAXCHAN ? PCA9685_ALL_LED_OFF_L : + LED_N_OFF_L(pwm->hwpwm); + regmap_read(pca->regmap, reg, &val); + duty |= (val & 0xff); + + if (duty < PCA9685_COUNTER_RANGE) { + duty *= state->period; + state->duty_cycle = duty / (PCA9685_COUNTER_RANGE - 1); + } else + state->duty_cycle = 0; +} + +static int pca9685_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm, + const struct pwm_state *state) { struct pca9685 *pca = to_pca(chip); - unsigned long long duty; + unsigned long long duty, prescale; unsigned int reg; - int prescale; - if (period_ns != pca->period_ns) { - prescale = DIV_ROUND_CLOSEST(PCA9685_OSC_CLOCK_MHZ * period_ns, - PCA9685_COUNTER_RANGE * 1000) - 1; + if (state->polarity != PWM_POLARITY_NORMAL) + return -EOPNOTSUPP; - if (prescale >= PCA9685_PRESCALE_MIN && - prescale <= PCA9685_PRESCALE_MAX) { + prescale = DIV_ROUND_CLOSEST_ULL(PCA9685_OSC_CLOCK_MHZ * state->period, + PCA9685_COUNTER_RANGE * 1000) - 1; + if (prescale != pca->prescale) { + if (is_prescale_valid(prescale)) { /* * Putting the chip briefly into SLEEP mode * at this point won't interfere with the * pm_runtime framework, because the pm_runtime * state is guaranteed active here. */ - /* Put chip into sleep mode */ - pca9685_set_sleep_mode(pca, true); - - /* Change the chip-wide output frequency */ - regmap_write(pca->regmap, PCA9685_PRESCALE, prescale); - - /* Wake the chip up */ - pca9685_set_sleep_mode(pca, false); - - pca->period_ns = period_ns; + pca9685_set_prescale(pca, (int)prescale); } else { dev_err(chip->dev, "prescaler not set: period out of bounds!\n"); @@ -283,46 +373,18 @@ static int pca9685_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm, } } - if (duty_ns < 1) { - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_OFF_H; - else - reg = LED_N_OFF_H(pwm->hwpwm); - - regmap_write(pca->regmap, reg, LED_FULL); - + if (!state->enabled || state->duty_cycle < 1) { + pca9685_pwm_full_off(pca, pwm->hwpwm); return 0; } - if (duty_ns == period_ns) { - /* Clear both OFF registers */ - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_OFF_L; - else - reg = LED_N_OFF_L(pwm->hwpwm); - - regmap_write(pca->regmap, reg, 0x0); - - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_OFF_H; - else - reg = LED_N_OFF_H(pwm->hwpwm); - - regmap_write(pca->regmap, reg, 0x0); - - /* Set the full ON bit */ - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_ON_H; - else - reg = LED_N_ON_H(pwm->hwpwm); - - regmap_write(pca->regmap, reg, LED_FULL); - + if (state->duty_cycle == state->period) { + pca9685_pwm_full_on(pca, pwm->hwpwm); return 0; } - duty = PCA9685_COUNTER_RANGE * (unsigned long long)duty_ns; - duty = DIV_ROUND_UP_ULL(duty, period_ns); + duty = (PCA9685_COUNTER_RANGE - 1) * state->duty_cycle; + duty = DIV_ROUND_UP_ULL(duty, state->period); if (pwm->hwpwm >= PCA9685_MAXCHAN) reg = PCA9685_ALL_LED_OFF_L; @@ -349,64 +411,6 @@ static int pca9685_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm, return 0; } -static int pca9685_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm) -{ - struct pca9685 *pca = to_pca(chip); - unsigned int reg; - - /* - * The PWM subsystem does not support a pre-delay. - * So, set the ON-timeout to 0 - */ - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_ON_L; - else - reg = LED_N_ON_L(pwm->hwpwm); - - regmap_write(pca->regmap, reg, 0); - - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_ON_H; - else - reg = LED_N_ON_H(pwm->hwpwm); - - regmap_write(pca->regmap, reg, 0); - - /* - * Clear the full-off bit. - * It has precedence over the others and must be off. - */ - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_OFF_H; - else - reg = LED_N_OFF_H(pwm->hwpwm); - - regmap_update_bits(pca->regmap, reg, LED_FULL, 0x0); - - return 0; -} - -static void pca9685_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm) -{ - struct pca9685 *pca = to_pca(chip); - unsigned int reg; - - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_OFF_H; - else - reg = LED_N_OFF_H(pwm->hwpwm); - - regmap_write(pca->regmap, reg, LED_FULL); - - /* Clear the LED_OFF counter. */ - if (pwm->hwpwm >= PCA9685_MAXCHAN) - reg = PCA9685_ALL_LED_OFF_L; - else - reg = LED_N_OFF_L(pwm->hwpwm); - - regmap_write(pca->regmap, reg, 0x0); -} - static int pca9685_pwm_request(struct pwm_chip *chip, struct pwm_device *pwm) { struct pca9685 *pca = to_pca(chip); @@ -422,15 +426,14 @@ static void pca9685_pwm_free(struct pwm_chip *chip, struct pwm_device *pwm) { struct pca9685 *pca = to_pca(chip); - pca9685_pwm_disable(chip, pwm); + pca9685_pwm_full_off(pca, pwm->hwpwm); pm_runtime_put(chip->dev); pca9685_pwm_clear_inuse(pca, pwm->hwpwm); } static const struct pwm_ops pca9685_pwm_ops = { - .enable = pca9685_pwm_enable, - .disable = pca9685_pwm_disable, - .config = pca9685_pwm_config, + .get_state = pca9685_pwm_get_state, + .apply = pca9685_pwm_apply, .request = pca9685_pwm_request, .free = pca9685_pwm_free, .owner = THIS_MODULE, @@ -448,7 +451,7 @@ static int pca9685_pwm_probe(struct i2c_client *client, { struct pca9685 *pca; unsigned int reg; - int ret; + int prescale = 0, ret; pca = devm_kzalloc(&client->dev, sizeof(*pca), GFP_KERNEL); if (!pca) @@ -461,10 +464,17 @@ static int pca9685_pwm_probe(struct i2c_client *client, ret); return ret; } - pca->period_ns = PCA9685_DEFAULT_PERIOD; i2c_set_clientdata(client, pca); + regmap_read(pca->regmap, PCA9685_PRESCALE, &prescale); + if (is_prescale_valid(prescale)) + pca->prescale = prescale; + else { + /* If invalid, use HW default prescale value */ + pca9685_set_prescale(pca, PCA9685_PRESCALE_DEF); + } + regmap_read(pca->regmap, PCA9685_MODE2, ®); if (device_property_read_bool(&client->dev, "invert")) @@ -505,14 +515,20 @@ static int pca9685_pwm_probe(struct i2c_client *client, return ret; } - /* The chip comes out of power-up in the active state */ - pm_runtime_set_active(&client->dev); - /* - * Enable will put the chip into suspend, which is what we - * want as all outputs are disabled at this point - */ + /* Set runtime PM status according to chip sleep state */ + if (reg & MODE1_SLEEP) + pm_runtime_set_suspended(&client->dev); + else + pm_runtime_set_active(&client->dev); + + /* If active, enable puts chip into suspend until first use */ pm_runtime_enable(&client->dev); + if (!IS_ENABLED(CONFIG_PM)) { + /* Wake the chip up on non-PM environments */ + pca9685_set_sleep_mode(pca, false); + } + return 0; } @@ -524,7 +540,14 @@ static int pca9685_pwm_remove(struct i2c_client *client) ret = pwmchip_remove(&pca->chip); if (ret) return ret; + pm_runtime_disable(&client->dev); + + if (!IS_ENABLED(CONFIG_PM)) { + /* Put chip in sleep state on non-PM environments */ + pca9685_set_sleep_mode(pca, true); + } + return 0; } -- 2.29.2