Switch to pin, frequency and duty_cycle PulseOut

Passing in a PWMOut still works but is deprecated. It will be
removed in CircuitPython 8.0.0

This also switches STM32 timer indices and channel indices to
0-based in our pin data rather than `- 1` everywhere. The latter is
more bug prone.

Most of the way for micropython#3264

Tested on Metro M0, Metro M4, Feather S2, Feather nRF52840, Feather
STM32F4 and Arduino RP2040.

Author: tannewt

locale/circuitpython.pot

@@ -1877,21 +1877,6 @@ msgstr ""
 msgid "Polygon needs at least 3 points"
 msgstr ""
 
-#: ports/esp32s2/common-hal/pulseio/PulseOut.c
-msgid ""
-"Port does not accept PWM carrier. Pass a pin, frequency and duty cycle "
-"instead"
-msgstr ""
-
-#: ports/atmel-samd/common-hal/pulseio/PulseOut.c
-#: ports/cxd56/common-hal/pulseio/PulseOut.c
-#: ports/nrf/common-hal/pulseio/PulseOut.c
-#: ports/stm/common-hal/pulseio/PulseOut.c
-msgid ""
-"Port does not accept pins or frequency. Construct and pass a PWMOut Carrier "
-"instead"
-msgstr ""
-
 #: shared-bindings/_bleio/Adapter.c
 msgid "Prefix buffer must be on the heap"
 msgstr ""

ports/atmel-samd/common-hal/pulseio/PulseOut.c

@@ -103,13 +103,15 @@ void pulseout_reset() {
 }
 
 void common_hal_pulseio_pulseout_construct(pulseio_pulseout_obj_t *self,
-    const pwmio_pwmout_obj_t *carrier,
     const mcu_pin_obj_t *pin,
     uint32_t frequency,
     uint16_t duty_cycle) {
-    if (!carrier || pin || frequency) {
-        mp_raise_NotImplementedError(translate("Port does not accept pins or frequency. Construct and pass a PWMOut Carrier instead"));
-    }
+
+    pwmout_result_t result = common_hal_pwmio_pwmout_construct(
+        &self->pwmout, pin, duty_cycle, frequency, false);
+
+    // This will raise an exception and not return if needed.
+    common_hal_pwmio_pwmout_raise_error(result);
 
     if (refcount == 0) {
         // Find a spare timer.
@@ -155,7 +157,7 @@ void common_hal_pulseio_pulseout_construct(pulseio_pulseout_obj_t *self,
     }
     refcount++;
 
-    self->pin = carrier->pin->number;
+    self->pin = pin->number;
 
     PortGroup *const port_base = &PORT->Group[GPIO_PORT(self->pin)];
     self->pincfg = &port_base->PINCFG[self->pin % 32];
@@ -173,7 +175,7 @@ void common_hal_pulseio_pulseout_construct(pulseio_pulseout_obj_t *self,
 }
 
 bool common_hal_pulseio_pulseout_deinited(pulseio_pulseout_obj_t *self) {
-    return self->pin == NO_PIN;
+    return common_hal_pwmio_pwmout_deinited(&self->pwmout);
 }
 
 void common_hal_pulseio_pulseout_deinit(pulseio_pulseout_obj_t *self) {
@@ -191,6 +193,7 @@ void common_hal_pulseio_pulseout_deinit(pulseio_pulseout_obj_t *self) {
         pulseout_tc_index = 0xff;
     }
     self->pin = NO_PIN;
+    common_hal_pwmio_pwmout_deinit(&self->pwmout);
     #ifdef SAMD21
     rtc_end_pulse();
     #endif

ports/atmel-samd/common-hal/pulseio/PulseOut.h

@@ -30,10 +30,12 @@
 #include "common-hal/microcontroller/Pin.h"
 
 #include "py/obj.h"
+#include "shared-bindings/pwmio/PWMOut.h"
 
 typedef struct {
     mp_obj_base_t base;
     __IO PORT_PINCFG_Type *pincfg;
+    pwmio_pwmout_obj_t pwmout;
     uint8_t pin;
 } pulseio_pulseout_obj_t;
 

ports/atmel-samd/common-hal/pwmio/PWMOut.c

@@ -493,3 +493,7 @@ uint32_t common_hal_pwmio_pwmout_get_frequency(pwmio_pwmout_obj_t *self) {
 bool common_hal_pwmio_pwmout_get_variable_frequency(pwmio_pwmout_obj_t *self) {
     return self->variable_frequency;
 }
+
+const mcu_pin_obj_t *common_hal_pwmio_pwmout_get_pin(pwmio_pwmout_obj_t *self) {
+    return self->pin;
+}

ports/cxd56/common-hal/pulseio/PulseOut.c

@@ -58,13 +58,15 @@ static bool pulseout_timer_handler(unsigned int *next_interval_us, void *arg) {
 }
 
 void common_hal_pulseio_pulseout_construct(pulseio_pulseout_obj_t *self,
-    const pwmio_pwmout_obj_t *carrier,
     const mcu_pin_obj_t *pin,
     uint32_t frequency,
     uint16_t duty_cycle) {
-    if (!carrier || pin || frequency) {
-        mp_raise_NotImplementedError(translate("Port does not accept pins or frequency. Construct and pass a PWMOut Carrier instead"));
-    }
+
+    pwmout_result_t result = common_hal_pwmio_pwmout_construct(
+        &self->pwmout, pin, duty_cycle, frequency, false);
+
+    // This will raise an exception and not return if needed.
+    common_hal_pwmio_pwmout_raise_error(result);
 
     if (pulse_fd < 0) {
         pulse_fd = open("/dev/timer0", O_RDONLY);
@@ -74,7 +76,7 @@ void common_hal_pulseio_pulseout_construct(pulseio_pulseout_obj_t *self,
         mp_raise_RuntimeError(translate("All timers in use"));
     }
 
-    self->pwm_num = carrier->number;
+    self->pwm_num = self->pwmout.number;
 }
 
 void common_hal_pulseio_pulseout_deinit(pulseio_pulseout_obj_t *self) {
@@ -86,6 +88,8 @@ void common_hal_pulseio_pulseout_deinit(pulseio_pulseout_obj_t *self) {
     close(pulse_fd);
     pulse_fd = -1;
 
+    common_hal_pwmio_pwmout_deinit(&self->pwmout);
+
     pulse_buffer = NULL;
 }
 

ports/cxd56/common-hal/pulseio/PulseOut.h

@@ -29,9 +29,12 @@
 
 #include "py/obj.h"
 
+#include "shared-bindings/pwmio/PWMOut.h"
+
 typedef struct {
     mp_obj_base_t base;
     uint8_t pwm_num;
+    pwmio_pwmout_obj_t pwmout;
 } pulseio_pulseout_obj_t;
 
 void pulseout_reset(void);

ports/cxd56/common-hal/pwmio/PWMOut.c

@@ -157,3 +157,7 @@ void pwmout_start(uint8_t pwm_num) {
 void pwmout_stop(uint8_t pwm_num) {
     ioctl(pwmout_dev[pwm_num].fd, PWMIOC_STOP, 0);
 }
+
+const mcu_pin_obj_t *common_hal_pwmio_pwmout_get_pin(pwmio_pwmout_obj_t *self) {
+    return self->pin;
+}

ports/esp32s2/common-hal/pulseio/PulseOut.c

@@ -32,13 +32,9 @@
 // Requires rmt.c void esp32s2_peripherals_reset_all(void) to reset
 
 void common_hal_pulseio_pulseout_construct(pulseio_pulseout_obj_t *self,
-    const pwmio_pwmout_obj_t *carrier,
     const mcu_pin_obj_t *pin,
     uint32_t frequency,
     uint16_t duty_cycle) {
-    if (carrier || !pin || !frequency) {
-        mp_raise_NotImplementedError(translate("Port does not accept PWM carrier. Pass a pin, frequency and duty cycle instead"));
-    }
 
     rmt_channel_t channel = esp32s2_peripherals_find_and_reserve_rmt();
     if (channel == RMT_CHANNEL_MAX) {

ports/esp32s2/common-hal/pwmio/PWMOut.c

@@ -152,7 +152,7 @@ pwmout_result_t common_hal_pwmio_pwmout_construct(pwmio_pwmout_obj_t *self,
         varfreq_timers[timer_index] = true;
     }
     self->variable_frequency = variable_frequency;
-    self->pin_number = pin->number;
+    self->pin = pin;
     self->deinited = false;
     self->duty_resolution = duty_bits;
     claim_pin(pin);
@@ -167,7 +167,7 @@ void common_hal_pwmio_pwmout_never_reset(pwmio_pwmout_obj_t *self) {
     never_reset_tim[self->tim_handle.timer_num] = true;
     never_reset_chan[self->chan_handle.channel] = true;
 
-    never_reset_pin_number(self->pin_number);
+    never_reset_pin_number(self->pin->number);
 }
 
 void common_hal_pwmio_pwmout_reset_ok(pwmio_pwmout_obj_t *self) {
@@ -202,7 +202,7 @@ void common_hal_pwmio_pwmout_deinit(pwmio_pwmout_obj_t *self) {
         // if timer isn't varfreq this will be off aleady
         varfreq_timers[self->tim_handle.timer_num] = false;
     }
-    reset_pin_number(self->pin_number);
+    common_hal_reset_pin(self->pin);
     self->deinited = true;
 }
 
@@ -232,3 +232,7 @@ uint32_t common_hal_pwmio_pwmout_get_frequency(pwmio_pwmout_obj_t *self) {
 bool common_hal_pwmio_pwmout_get_variable_frequency(pwmio_pwmout_obj_t *self) {
     return self->variable_frequency;
 }
+
+const mcu_pin_obj_t *common_hal_pwmio_pwmout_get_pin(pwmio_pwmout_obj_t *self) {
+    return self->pin;
+}

ports/esp32s2/common-hal/pwmio/PWMOut.h

@@ -34,7 +34,7 @@ typedef struct {
     mp_obj_base_t base;
     ledc_timer_config_t tim_handle;
     ledc_channel_config_t chan_handle;
-    uint16_t pin_number;
+    const mcu_pin_obj_t *pin;
     uint8_t duty_resolution;
     bool variable_frequency : 1;
     bool deinited : 1;