]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
pwm: pca9586: Convert to waveform API
authorUwe Kleine-König <u.kleine-koenig@baylibre.com>
Tue, 29 Jul 2025 10:36:04 +0000 (12:36 +0200)
committerUwe Kleine-König <ukleinek@kernel.org>
Mon, 15 Sep 2025 09:39:46 +0000 (11:39 +0200)
This allows to expose the duty_offset feature that the chip supports, and
so also emit inverted polarity waveforms. The conversion from a waveform to
hardware settings (and vice versa) is aligned to the usual rounding rules
silencing warnings with PWM_DEBUG.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@baylibre.com>
Link: https://lore.kernel.org/r/1927d115ae6797858e6c4537971dacf1d563854f.1753784092.git.u.kleine-koenig@baylibre.com
Signed-off-by: Uwe Kleine-König <ukleinek@kernel.org>
drivers/pwm/pwm-pca9685.c

index 3f04defd3718bc69857435db7da0ae1b6cd7e4af..107bebec3546edac2988dc1c524df7c78762f3d7 100644 (file)
 #define PCA9685_PRESCALE_MAX   0xFF    /* => min. frequency of 24 Hz */
 
 #define PCA9685_COUNTER_RANGE  4096
-#define PCA9685_OSC_CLOCK_MHZ  25      /* Internal oscillator with 25 MHz */
+#define PCA9685_OSC_CLOCK_HZ   25000000        /* Internal oscillator with 25 MHz */
+
+/*
+ * The time value of one counter tick. Note that NSEC_PER_SEC is an integer
+ * multiple of PCA9685_OSC_CLOCK_HZ, so there is no rounding involved and we're
+ * not loosing precision due to the early division.
+ */
+#define PCA9685_QUANTUM_NS(_prescale)  ((NSEC_PER_SEC / PCA9685_OSC_CLOCK_HZ) * (_prescale + 1))
 
 #define PCA9685_NUMREGS                0xFF
 #define PCA9685_MAXCHAN                0x10
@@ -141,200 +148,213 @@ static int pca9685_write_4reg(struct pwm_chip *chip, unsigned int reg, u8 val[4]
        return err;
 }
 
-/* Helper function to set the duty cycle ratio to duty/4096 (e.g. duty=2048 -> 50%) */
-static void pca9685_pwm_set_duty(struct pwm_chip *chip, int channel, unsigned int duty)
+static int pca9685_set_sleep_mode(struct pwm_chip *chip, bool enable)
 {
-       struct pwm_device *pwm = &chip->pwms[channel];
-       unsigned int on, off;
-
-       if (duty == 0) {
-               /* Set the full OFF bit, which has the highest precedence */
-               pca9685_write_reg(chip, REG_OFF_H(channel), LED_FULL);
-               return;
-       } else if (duty >= PCA9685_COUNTER_RANGE) {
-               /* Set the full ON bit and clear the full OFF bit */
-               pca9685_write_4reg(chip, REG_ON_L(channel), (u8[4]){ 0, LED_FULL, 0, 0 });
-               return;
-       }
+       struct pca9685 *pca = to_pca(chip);
+       int err;
 
-       if (pwm->state.usage_power && channel < PCA9685_MAXCHAN) {
-               /*
-                * If usage_power is set, the pca9685 driver will phase shift
-                * the individual channels relative to their channel number.
-                * This improves EMI because the enabled channels no longer
-                * turn on at the same time, while still maintaining the
-                * configured duty cycle / power output.
-                */
-               on = channel * PCA9685_COUNTER_RANGE / PCA9685_MAXCHAN;
-       } else
-               on = 0;
+       err = regmap_update_bits(pca->regmap, PCA9685_MODE1,
+                                MODE1_SLEEP, enable ? MODE1_SLEEP : 0);
+       if (err)
+               return err;
 
-       off = (on + duty) % PCA9685_COUNTER_RANGE;
+       if (!enable) {
+               /* Wait 500us for the oscillator to be back up */
+               udelay(500);
+       }
 
-       /* implicitly clear full ON and full OFF bit */
-       pca9685_write_4reg(chip, REG_ON_L(channel),
-                          (u8[4]){ on & 0xff, (on >> 8) & 0xf, off & 0xff, (off >> 8) & 0xf });
+       return 0;
 }
 
-static unsigned int pca9685_pwm_get_duty(struct pwm_chip *chip, int channel)
+struct pca9685_waveform {
+       u8 onoff[4];
+       u8 prescale;
+};
+
+static int pca9685_round_waveform_tohw(struct pwm_chip *chip, struct pwm_device *pwm, const struct pwm_waveform *wf, void *_wfhw)
 {
-       struct pwm_device *pwm = &chip->pwms[channel];
-       unsigned int off = 0, on = 0, val = 0;
+       struct pca9685_waveform *wfhw = _wfhw;
+       struct pca9685 *pca = to_pca(chip);
+       unsigned int best_prescale;
+       u8 prescale;
+       unsigned int period_ns, duty;
+       int ret_tohw = 0;
 
-       if (WARN_ON(channel >= PCA9685_MAXCHAN)) {
-               /* HW does not support reading state of "all LEDs" channel */
-               return 0;
-       }
+       if (!wf->period_length_ns) {
+               *wfhw = (typeof(*wfhw)){
+                       .onoff = { 0, 0, 0, LED_FULL, },
+                       .prescale = 0,
+               };
+
+               dev_dbg(&chip->dev, "pwm#%u: %lld/%lld [+%lld] -> [%hhx %hhx %hhx %hhx] PSC:%hhx\n",
+                       pwm->hwpwm, wf->duty_length_ns, wf->period_length_ns, wf->duty_offset_ns,
+                       wfhw->onoff[0], wfhw->onoff[1], wfhw->onoff[2], wfhw->onoff[3], wfhw->prescale);
 
-       pca9685_read_reg(chip, LED_N_OFF_H(channel), &off);
-       if (off & LED_FULL) {
-               /* Full OFF bit is set */
                return 0;
        }
 
-       pca9685_read_reg(chip, LED_N_ON_H(channel), &on);
-       if (on & LED_FULL) {
-               /* Full ON bit is set */
-               return PCA9685_COUNTER_RANGE;
+       if (wf->period_length_ns >= PCA9685_COUNTER_RANGE * PCA9685_QUANTUM_NS(255)) {
+               best_prescale = 255;
+       } else if (wf->period_length_ns < PCA9685_COUNTER_RANGE * PCA9685_QUANTUM_NS(3)) {
+               best_prescale = 3;
+               ret_tohw = 1;
+       } else {
+               best_prescale = (unsigned int)wf->period_length_ns / (PCA9685_COUNTER_RANGE * (NSEC_PER_SEC / PCA9685_OSC_CLOCK_HZ)) - 1;
        }
 
-       pca9685_read_reg(chip, LED_N_OFF_L(channel), &val);
-       off = ((off & 0xf) << 8) | (val & 0xff);
-       if (!pwm->state.usage_power)
-               return off;
+       guard(mutex)(&pca->lock);
 
-       /* Read ON register to calculate duty cycle of staggered output */
-       if (pca9685_read_reg(chip, LED_N_ON_L(channel), &val)) {
-               /* Reset val to 0 in case reading LED_N_ON_L failed */
-               val = 0;
-       }
-       on = ((on & 0xf) << 8) | (val & 0xff);
-       return (off - on) & (PCA9685_COUNTER_RANGE - 1);
-}
+       if (!pca9685_prescaler_can_change(pca, pwm->hwpwm)) {
+               unsigned int current_prescale;
+               int ret;
 
-static void pca9685_set_sleep_mode(struct pwm_chip *chip, bool enable)
-{
-       struct device *dev = pwmchip_parent(chip);
-       struct pca9685 *pca = to_pca(chip);
-       int err = regmap_update_bits(pca->regmap, PCA9685_MODE1,
-                                    MODE1_SLEEP, enable ? MODE1_SLEEP : 0);
-       if (err) {
-               dev_err(dev, "regmap_update_bits of register 0x%x failed: %pe\n",
-                       PCA9685_MODE1, ERR_PTR(err));
-               return;
+               ret = regmap_read(pca->regmap, PCA9685_PRESCALE, &current_prescale);
+               if (ret)
+                       return ret;
+
+               if (current_prescale > best_prescale)
+                       ret_tohw = 1;
+
+               prescale = current_prescale;
+       } else {
+               prescale = best_prescale;
        }
 
-       if (!enable) {
-               /* Wait 500us for the oscillator to be back up */
-               udelay(500);
+       period_ns = PCA9685_COUNTER_RANGE * PCA9685_QUANTUM_NS(prescale);
+
+       duty = (unsigned)min_t(u64, wf->duty_length_ns, period_ns) / PCA9685_QUANTUM_NS(prescale);
+
+       if (duty < PCA9685_COUNTER_RANGE) {
+               unsigned int on, off;
+
+               on = (unsigned)min_t(u64, wf->duty_offset_ns, period_ns) / PCA9685_QUANTUM_NS(prescale);
+               off = (on + duty) % PCA9685_COUNTER_RANGE;
+
+               /*
+                * With a zero duty cycle, it doesn't matter if period was
+                * rounded up
+                */
+               if (!duty)
+                       ret_tohw = 0;
+
+               *wfhw = (typeof(*wfhw)){
+                       .onoff = { on & 0xff, (on >> 8) & 0xf, off & 0xff, (off >> 8) & 0xf },
+                       .prescale = prescale,
+               };
+       } else {
+               *wfhw = (typeof(*wfhw)){
+                       .onoff = { 0, LED_FULL, 0, 0, },
+                       .prescale = prescale,
+               };
        }
+
+       dev_dbg(&chip->dev, "pwm#%u: %lld/%lld [+%lld] -> %s[%hhx %hhx %hhx %hhx] PSC:%hhx\n",
+               pwm->hwpwm, wf->duty_length_ns, wf->period_length_ns, wf->duty_offset_ns,
+               ret_tohw ? "#" : "", wfhw->onoff[0], wfhw->onoff[1], wfhw->onoff[2], wfhw->onoff[3], wfhw->prescale);
+
+       return ret_tohw;
 }
 
-static int __pca9685_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
-                              const struct pwm_state *state)
+static int pca9685_round_waveform_fromhw(struct pwm_chip *chip, struct pwm_device *pwm,
+                                        const void *_wfhw, struct pwm_waveform *wf)
 {
+       const struct pca9685_waveform *wfhw = _wfhw;
        struct pca9685 *pca = to_pca(chip);
-       unsigned long long duty, prescale;
-       unsigned int val = 0;
-
-       if (state->polarity != PWM_POLARITY_NORMAL)
-               return -EINVAL;
-
-       prescale = DIV_ROUND_CLOSEST_ULL(PCA9685_OSC_CLOCK_MHZ * state->period,
-                                        PCA9685_COUNTER_RANGE * 1000) - 1;
-       if (prescale < PCA9685_PRESCALE_MIN || prescale > PCA9685_PRESCALE_MAX) {
-               dev_err(pwmchip_parent(chip), "pwm not changed: period out of bounds!\n");
-               return -EINVAL;
-       }
+       unsigned int prescale;
 
-       if (!state->enabled) {
-               pca9685_pwm_set_duty(chip, pwm->hwpwm, 0);
-               return 0;
-       }
+       if (wfhw->prescale)
+               prescale = wfhw->prescale;
+       else
+               scoped_guard(mutex, &pca->lock) {
+                       int ret;
 
-       pca9685_read_reg(chip, PCA9685_PRESCALE, &val);
-       if (prescale != val) {
-               if (!pca9685_prescaler_can_change(pca, pwm->hwpwm)) {
-                       dev_err(pwmchip_parent(chip),
-                               "pwm not changed: periods of enabled pwms must match!\n");
-                       return -EBUSY;
+                       ret = regmap_read(pca->regmap, PCA9685_PRESCALE, &prescale);
+                       if (ret)
+                               return ret;
                }
 
-               /*
-                * 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(chip, true);
+       wf->period_length_ns = PCA9685_COUNTER_RANGE * PCA9685_QUANTUM_NS(prescale);
 
-               /* Change the chip-wide output frequency */
-               pca9685_write_reg(chip, PCA9685_PRESCALE, prescale);
+       if (wfhw->onoff[3] & LED_FULL) {
+               wf->duty_length_ns = 0;
+               wf->duty_offset_ns = 0;
+       } else if (wfhw->onoff[1] & LED_FULL) {
+               wf->duty_length_ns = wf->period_length_ns;
+               wf->duty_offset_ns = 0;
+       } else {
+               unsigned int on = wfhw->onoff[0] | (wfhw->onoff[1] & 0xf) << 8;
+               unsigned int off = wfhw->onoff[2] | (wfhw->onoff[3] & 0xf) << 8;
 
-               /* Wake the chip up */
-               pca9685_set_sleep_mode(chip, false);
+               wf->duty_length_ns = (off - on) % PCA9685_COUNTER_RANGE * PCA9685_QUANTUM_NS(prescale);
+               wf->duty_offset_ns = on * PCA9685_QUANTUM_NS(prescale);
        }
 
-       duty = PCA9685_COUNTER_RANGE * state->duty_cycle;
-       duty = DIV_ROUND_UP_ULL(duty, state->period);
-       pca9685_pwm_set_duty(chip, pwm->hwpwm, duty);
+       dev_dbg(&chip->dev, "pwm#%u: [%hhx %hhx %hhx %hhx] PSC:%hhx -> %lld/%lld [+%lld]\n",
+               pwm->hwpwm,
+               wfhw->onoff[0], wfhw->onoff[1], wfhw->onoff[2], wfhw->onoff[3], wfhw->prescale,
+               wf->duty_length_ns, wf->period_length_ns, wf->duty_offset_ns);
+
        return 0;
 }
 
-static int pca9685_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
-                            const struct pwm_state *state)
+static int pca9685_read_waveform(struct pwm_chip *chip, struct pwm_device *pwm, void *_wfhw)
 {
+       struct pca9685_waveform *wfhw = _wfhw;
        struct pca9685 *pca = to_pca(chip);
+       unsigned int prescale;
        int ret;
 
-       mutex_lock(&pca->lock);
-       ret = __pca9685_pwm_apply(chip, pwm, state);
-       if (ret == 0) {
-               if (state->enabled)
-                       set_bit(pwm->hwpwm, pca->pwms_enabled);
-               else
-                       clear_bit(pwm->hwpwm, pca->pwms_enabled);
-       }
-       mutex_unlock(&pca->lock);
+       guard(mutex)(&pca->lock);
 
-       return ret;
+       ret = regmap_bulk_read(pca->regmap, REG_ON_L(pwm->hwpwm), &wfhw->onoff, 4);
+       if (ret)
+               return ret;
+
+       ret = regmap_read(pca->regmap, PCA9685_PRESCALE, &prescale);
+       if (ret)
+               return ret;
+
+       wfhw->prescale = prescale;
+
+       return 0;
 }
 
-static int pca9685_pwm_get_state(struct pwm_chip *chip, struct pwm_device *pwm,
-                                struct pwm_state *state)
+static int pca9685_write_waveform(struct pwm_chip *chip, struct pwm_device *pwm, const void *_wfhw)
 {
-       unsigned long long duty;
-       unsigned int val = 0;
+       const struct pca9685_waveform *wfhw = _wfhw;
+       struct pca9685 *pca = to_pca(chip);
+       unsigned int current_prescale;
+       int ret;
 
-       /* Calculate (chip-wide) period from prescale value */
-       pca9685_read_reg(chip, PCA9685_PRESCALE, &val);
-       /*
-        * PCA9685_OSC_CLOCK_MHZ is 25, i.e. an integer divider of 1000.
-        * The following calculation is therefore only a multiplication
-        * and we are not losing precision.
-        */
-       state->period = (PCA9685_COUNTER_RANGE * 1000 / PCA9685_OSC_CLOCK_MHZ) *
-                       (val + 1);
+       guard(mutex)(&pca->lock);
 
-       /* The (per-channel) polarity is fixed */
-       state->polarity = PWM_POLARITY_NORMAL;
+       if (wfhw->prescale) {
+               ret = regmap_read(pca->regmap, PCA9685_PRESCALE, &current_prescale);
+               if (ret)
+                       return ret;
 
-       if (pwm->hwpwm >= PCA9685_MAXCHAN) {
-               /*
-                * The "all LEDs" channel does not support HW readout
-                * Return 0 and disabled for backwards compatibility
-                */
-               state->duty_cycle = 0;
-               state->enabled = false;
-               return 0;
-       }
+               if (current_prescale != wfhw->prescale) {
+                       if (!pca9685_prescaler_can_change(pca, pwm->hwpwm))
+                               return -EBUSY;
 
-       state->enabled = true;
-       duty = pca9685_pwm_get_duty(chip, pwm->hwpwm);
-       state->duty_cycle = DIV_ROUND_DOWN_ULL(duty * state->period, PCA9685_COUNTER_RANGE);
+                       /* Put chip into sleep mode */
+                       ret = pca9685_set_sleep_mode(chip, true);
+                       if (ret)
+                               return ret;
 
-       return 0;
+                       /* Change the chip-wide output frequency */
+                       ret = regmap_write(pca->regmap, PCA9685_PRESCALE, wfhw->prescale);
+                       if (ret)
+                               return ret;
+
+                       /* Wake the chip up */
+                       ret = pca9685_set_sleep_mode(chip, false);
+                       if (ret)
+                               return ret;
+               }
+       }
+
+       return regmap_bulk_write(pca->regmap, REG_ON_L(pwm->hwpwm), &wfhw->onoff, 4);
 }
 
 static int pca9685_pwm_request(struct pwm_chip *chip, struct pwm_device *pwm)
@@ -365,8 +385,11 @@ static void pca9685_pwm_free(struct pwm_chip *chip, struct pwm_device *pwm)
 }
 
 static const struct pwm_ops pca9685_pwm_ops = {
-       .apply = pca9685_pwm_apply,
-       .get_state = pca9685_pwm_get_state,
+       .sizeof_wfhw = sizeof(struct pca9685_waveform),
+       .round_waveform_tohw = pca9685_round_waveform_tohw,
+       .round_waveform_fromhw = pca9685_round_waveform_fromhw,
+       .read_waveform = pca9685_read_waveform,
+       .write_waveform = pca9685_write_waveform,
        .request = pca9685_pwm_request,
        .free = pca9685_pwm_free,
 };