rp2/PWM: Add duty_xx() checks and return 0 if PWM is not started.

robert-hh · robert-hh · commit 37ef0c1967f9 · 2023-04-28T21:03:59.000+02:00
- Limit duty_u16() to 65535 and duty_ns() to the period duration.
- Return 0 for pwm.freq() if the frequency has not been set yet.
- Return 0 for pwm.duty_us16() and duty_ns() unless both frequency and
  duty cycle have been set.
diff --git a/ports/rp2/machine_pwm.c b/ports/rp2/machine_pwm.c
@@ -150,6 +150,9 @@ STATIC mp_obj_t mp_machine_pwm_make_new(const mp_obj_type_t *type, size_t n_args
     mp_map_init_fixed_table(&kw_args, n_kw, all_args + n_args);
     mp_machine_pwm_init_helper(self, n_args - 1, all_args + 1, &kw_args);
 
+    // Select PWM function for given GPIO.
+    gpio_set_function(gpio, GPIO_FUNC_PWM);
+
     return MP_OBJ_FROM_PTR(self);
 }
 
@@ -158,7 +161,15 @@ void machine_pwm_deinit_all(void) {
     for (int i = 0; i < 8; i++) {
         slice_freq_set[i] = false;
         pwm_set_enabled(machine_pwm_obj[i].slice, false);
+        // pwm_set_chan_level(i, 0, 0);
+        // pwm_set_chan_level(i, 1, 0);
     }
+    // Clean out the table
+    // for (int i = 0; i < 16; i++) {
+    //     machine_pwm_obj[i].invert = 0;
+    //     machine_pwm_obj[i].duty = 0;
+    //     machine_pwm_obj[i].duty_type = DUTY_NOT_SET;
+    // }
 }
 
 STATIC void mp_machine_pwm_deinit(machine_pwm_obj_t *self) {
@@ -189,10 +200,14 @@ uint32_t get_slice_hz_ceil(uint32_t div16) {
 }
 
 STATIC mp_obj_t mp_machine_pwm_freq_get(machine_pwm_obj_t *self) {
-    uint32_t div16 = pwm_hw->slice[self->slice].div;
-    uint32_t top = pwm_hw->slice[self->slice].top;
-    uint32_t pwm_freq = get_slice_hz_round(div16 * (top + 1));
-    return MP_OBJ_NEW_SMALL_INT(pwm_freq);
+    if (slice_freq_set[self->slice] == true) {
+        uint32_t div16 = pwm_hw->slice[self->slice].div;
+        uint32_t top = pwm_hw->slice[self->slice].top;
+        uint32_t pwm_freq = get_slice_hz_round(div16 * (top + 1));
+        return MP_OBJ_NEW_SMALL_INT(pwm_freq);
+    } else {
+        return MP_OBJ_NEW_SMALL_INT(0);
+    }
 }
 
 STATIC void mp_machine_pwm_freq_set(machine_pwm_obj_t *self, mp_int_t freq) {
@@ -245,19 +260,27 @@ STATIC void mp_machine_pwm_freq_set(machine_pwm_obj_t *self, mp_int_t freq) {
 }
 
 STATIC mp_obj_t mp_machine_pwm_duty_get_u16(machine_pwm_obj_t *self) {
-    uint32_t top = pwm_hw->slice[self->slice].top;
-    uint32_t cc = pwm_hw->slice[self->slice].cc;
-    cc = (cc >> (self->channel ? PWM_CH0_CC_B_LSB : PWM_CH0_CC_A_LSB)) & 0xffff;
-
-    // Use rounding (instead of flooring) here to give as accurate an
-    // estimate as possible.
-    return MP_OBJ_NEW_SMALL_INT((cc * 65535 + (top + 1) / 2) / (top + 1));
+    if (self->duty_type != DUTY_NOT_SET && slice_freq_set[self->slice] == true) {
+        uint32_t top = pwm_hw->slice[self->slice].top;
+        uint32_t cc = pwm_hw->slice[self->slice].cc;
+        cc = (cc >> (self->channel ? PWM_CH0_CC_B_LSB : PWM_CH0_CC_A_LSB)) & 0xffff;
+
+        // Use rounding (instead of flooring) here to give as accurate an
+        // estimate as possible.
+        return MP_OBJ_NEW_SMALL_INT((cc * 65535 + (top + 1) / 2) / (top + 1));
+    } else {
+        return MP_OBJ_NEW_SMALL_INT(0);
+    }
 }
 
 STATIC void mp_machine_pwm_duty_set_u16(machine_pwm_obj_t *self, mp_int_t duty_u16) {
     uint32_t top = pwm_hw->slice[self->slice].top;
 
+    // Limit duty_u16 to 65535
     // Use rounding here to set it as accurately as possible.
+    if (duty_u16 > 65535) {
+        duty_u16 = 65535;
+    }
     uint32_t cc = (duty_u16 * (top + 1) + 65535 / 2) / 65535;
     pwm_set_chan_level(self->slice, self->channel, cc);
     self->duty = duty_u16;
@@ -266,17 +289,22 @@ STATIC void mp_machine_pwm_duty_set_u16(machine_pwm_obj_t *self, mp_int_t duty_u
 }
 
 STATIC mp_obj_t mp_machine_pwm_duty_get_ns(machine_pwm_obj_t *self) {
-    uint32_t slice_hz = get_slice_hz_round(pwm_hw->slice[self->slice].div);
-    uint32_t cc = pwm_hw->slice[self->slice].cc;
-    cc = (cc >> (self->channel ? PWM_CH0_CC_B_LSB : PWM_CH0_CC_A_LSB)) & 0xffff;
-    return MP_OBJ_NEW_SMALL_INT(((uint64_t)cc * 1000000000ULL + slice_hz / 2) / slice_hz);
+    if (self->duty_type != DUTY_NOT_SET && slice_freq_set[self->slice] == true) {
+        uint32_t slice_hz = get_slice_hz_round(pwm_hw->slice[self->slice].div);
+        uint32_t cc = pwm_hw->slice[self->slice].cc;
+        cc = (cc >> (self->channel ? PWM_CH0_CC_B_LSB : PWM_CH0_CC_A_LSB)) & 0xffff;
+        return MP_OBJ_NEW_SMALL_INT(((uint64_t)cc * 1000000000ULL + slice_hz / 2) / slice_hz);
+    } else {
+        return MP_OBJ_NEW_SMALL_INT(0);
+    }
 }
 
 STATIC void mp_machine_pwm_duty_set_ns(machine_pwm_obj_t *self, mp_int_t duty_ns) {
     uint32_t slice_hz = get_slice_hz_round(pwm_hw->slice[self->slice].div);
     uint32_t cc = ((uint64_t)duty_ns * slice_hz + 500000000ULL) / 1000000000ULL;
-    if (cc > 65535) {
-        mp_raise_ValueError(MP_ERROR_TEXT("duty larger than period"));
+    uint32_t top = pwm_hw->slice[self->slice].top;
+    if (cc > (top + 1)) {
+        cc = top + 1;
     }
     pwm_set_chan_level(self->slice, self->channel, cc);
     self->duty = duty_ns;
