extmod/machine_pulse: Make time_pulse_us() not throw exceptions.

pfalcon · pfalcon · commit d5e9ab6e6172 · 2017-02-05T14:20:17.000+03:00
machine.time_pulse_us() is intended to provide very fine timing, including
while working with signal bursts, where each transition is tracked in row.
Throwing and handling an exception may take too much time and "signal loss".
So instead, in case of a timeout, just return negative value. Cases of
timeout while waiting for initial signal stabilization, and during actual
timing, are recognized.

The documentation is updated accordingly, and rewritten somewhat to clarify
the function behavior.
diff --git a/docs/library/machine.rst b/docs/library/machine.rst
@@ -118,12 +118,15 @@ Miscellaneous functions
    microseconds.  The `pulse_level` argument should be 0 to time a low pulse
    or 1 to time a high pulse.
 
-   The function first waits while the pin input is different to the `pulse_level`
-   parameter, then times the duration that the pin is equal to `pulse_level`.
+   If the current input value of the pin is different to `pulse_level`,
+   the function first (*) waits until the pin input becomes equal to `pulse_level`,
+   then (**) times the duration that the pin is equal to `pulse_level`.
    If the pin is already equal to `pulse_level` then timing starts straight away.
 
-   The function will raise an OSError with ETIMEDOUT if either of the waits is
-   longer than the given timeout value (which is in microseconds).
+   The function will return -2 if there was timeout waiting for condition marked
+   (*) above, and -1 if there was timeout during the main measurement, marked (**)
+   above. The timeout is the same for both cases and given by `timeout_us` (which
+   is in microseconds).
 
 .. _machine_constants:
 
diff --git a/drivers/dht/dht.c b/drivers/dht/dht.c
@@ -65,15 +65,15 @@ STATIC mp_obj_t dht_readinto(mp_obj_t pin_in, mp_obj_t buf_in) {
 
     // time pulse, should be 80us
     ticks = machine_time_pulse_us(pin, 1, 150);
-    if (ticks == (mp_uint_t)-1) {
+    if ((mp_int_t)ticks < 0) {
         goto timeout;
     }
 
     // time 40 pulses for data (either 26us or 70us)
     uint8_t *buf = bufinfo.buf;
     for (int i = 0; i < 40; ++i) {
         ticks = machine_time_pulse_us(pin, 1, 100);
-        if (ticks == (mp_uint_t)-1) {
+        if ((mp_int_t)ticks < 0) {
             goto timeout;
         }
         buf[i / 8] = (buf[i / 8] << 1) | (ticks > 48);
diff --git a/extmod/machine_pulse.c b/extmod/machine_pulse.c
@@ -34,7 +34,7 @@ mp_uint_t machine_time_pulse_us(mp_hal_pin_obj_t pin, int pulse_level, mp_uint_t
     mp_uint_t start = mp_hal_ticks_us();
     while (mp_hal_pin_read(pin) != pulse_level) {
         if ((mp_uint_t)(mp_hal_ticks_us() - start) >= timeout_us) {
-            return (mp_uint_t)-1;
+            return (mp_uint_t)-2;
         }
     }
     start = mp_hal_ticks_us();
@@ -57,9 +57,7 @@ STATIC mp_obj_t machine_time_pulse_us_(size_t n_args, const mp_obj_t *args) {
         timeout_us = mp_obj_get_int(args[2]);
     }
     mp_uint_t us = machine_time_pulse_us(pin, level, timeout_us);
-    if (us == (mp_uint_t)-1) {
-        mp_raise_OSError(MP_ETIMEDOUT);
-    }
+    // May return -1 or -2 in case of timeout
     return mp_obj_new_int(us);
 }
 MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_time_pulse_us_obj, 2, 3, machine_time_pulse_us_);
diff --git a/tests/extmod/machine_pulse.py b/tests/extmod/machine_pulse.py
@@ -43,12 +43,5 @@ def value(self, v=None):
 print(type(t))
 
 p = ConstPin(0)
-try:
-    machine.time_pulse_us(p, 1, 10)
-except OSError:
-    print("OSError")
-
-try:
-    machine.time_pulse_us(p, 0, 10)
-except OSError:
-    print("OSError")
+print(machine.time_pulse_us(p, 1, 10))
+print(machine.time_pulse_us(p, 0, 10))
diff --git a/tests/extmod/machine_pulse.py.exp b/tests/extmod/machine_pulse.py.exp
@@ -5,5 +5,5 @@ value: 1
 value: 0
 value: 1
 <class 'int'>
-OSError
-OSError
+-2
+-1

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ mp_uint_t machine_time_pulse_us(mp_hal_pin_obj_t pin, int pulse_level, mp_uint_t`
`34`	`34`	`mp_uint_t start = mp_hal_ticks_us();`
`35`	`35`	`while (mp_hal_pin_read(pin) != pulse_level) {`
`36`	`36`	`if ((mp_uint_t)(mp_hal_ticks_us() - start) >= timeout_us) {`
`37`		`- return (mp_uint_t)-1;`
	`37`	`+ return (mp_uint_t)-2;`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	`start = mp_hal_ticks_us();`
`@@ -57,9 +57,7 @@ STATIC mp_obj_t machine_time_pulse_us_(size_t n_args, const mp_obj_t *args) {`
`57`	`57`	`timeout_us = mp_obj_get_int(args[2]);`
`58`	`58`	`}`
`59`	`59`	`mp_uint_t us = machine_time_pulse_us(pin, level, timeout_us);`
`60`		`- if (us == (mp_uint_t)-1) {`
`61`		`- mp_raise_OSError(MP_ETIMEDOUT);`
`62`		`- }`
	`60`	`+ // May return -1 or -2 in case of timeout`
`63`	`61`	`return mp_obj_new_int(us);`
`64`	`62`	`}`
`65`	`63`	`MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(machine_time_pulse_us_obj, 2, 3, machine_time_pulse_us_);`