Merge pull request #952 from Core-i99/main

[Adafruit_Blinka-hackapet.git] / src / adafruit_blinka / microcontroller / generic_linux / sysfs_pwmout.py

diff --git a/src/adafruit_blinka/microcontroller/generic_linux/sysfs_pwmout.py b/src/adafruit_blinka/microcontroller/generic_linux/sysfs_pwmout.py
index 5f72e4fd40d9d7cd738a8cebe5c31c7651a8a056..9bf26025d76406c3ae27f12e0a943583c6a9b5c8 100644 (file)
--- a/src/adafruit_blinka/microcontroller/generic_linux/sysfs_pwmout.py
+++ b/src/adafruit_blinka/microcontroller/generic_linux/sysfs_pwmout.py
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT

 """
 Much code from https://github.com/vsergeev/python-periphery/blob/master/periphery/pwm.py
 Copyright (c) 2015-2016 vsergeev / Ivan (Vanya) A. Sergeev
 """
 Much code from https://github.com/vsergeev/python-periphery/blob/master/periphery/pwm.py
 Copyright (c) 2015-2016 vsergeev / Ivan (Vanya) A. Sergeev


@@ -5,11 +8,13 @@ License: MIT
 """
 
 import os
 """
 
 import os

+from time import sleep
+from errno import EACCES

 
 try:
     from microcontroller.pin import pwmOuts
 except ImportError:
 
 try:
     from microcontroller.pin import pwmOuts
 except ImportError:

-    raise RuntimeError("No PWM outputs defined for this board")
+    raise RuntimeError("No PWM outputs defined for this board") from ImportError

 
 
 # pylint: disable=unnecessary-pass
 
 
 # pylint: disable=unnecessary-pass


@@ -25,6 +30,11 @@ class PWMError(IOError):
 class PWMOut:
     """Pulse Width Modulation Output Class"""
 
 class PWMOut:
     """Pulse Width Modulation Output Class"""
 

+    # Number of retries to check for successful PWM export on open
+    PWM_STAT_RETRIES = 10
+    # Delay between check for scucessful PWM export on open (100ms)
+    PWM_STAT_DELAY = 0.1
+

     # Sysfs paths
     _sysfs_path = "/sys/class/pwm/"
     _channel_path = "pwmchip{}"
     # Sysfs paths
     _sysfs_path = "/sys/class/pwm/"
     _channel_path = "pwmchip{}"


@@ -85,6 +95,9 @@ class PWMOut:
         if self._channel is None:
             raise RuntimeError("No PWM channel found for this Pin")
 
         if self._channel is None:
             raise RuntimeError("No PWM channel found for this Pin")
 

+        if variable_frequency:
+            print("Variable Frequency is not supported, continuing without it...")
+

         channel_path = os.path.join(
             self._sysfs_path, self._channel_path.format(self._channel)
         )
         channel_path = os.path.join(
             self._sysfs_path, self._channel_path.format(self._channel)
         )


@@ -93,19 +106,40 @@ class PWMOut:
                 "PWM channel does not exist, check that the required modules are loaded."
             )
 
                 "PWM channel does not exist, check that the required modules are loaded."
             )
 

-        pin_path = os.path.join(channel_path, self._pin_path.format(self._pwmpin))

         try:
             with open(
         try:
             with open(

-                os.path.join(channel_path, self._unexport_path), "w"
+                os.path.join(channel_path, self._unexport_path), "w", encoding="utf-8"

             ) as f_unexport:
                 f_unexport.write("%d\n" % self._pwmpin)
             ) as f_unexport:
                 f_unexport.write("%d\n" % self._pwmpin)

-        except IOError as e:
+        except IOError:

             pass  # not unusual, it doesnt already exist
         try:
             pass  # not unusual, it doesnt already exist
         try:

-            with open(os.path.join(channel_path, self._export_path), "w") as f_export:
+            with open(
+                os.path.join(channel_path, self._export_path), "w", encoding="utf-8"
+            ) as f_export:

                 f_export.write("%d\n" % self._pwmpin)
         except IOError as e:
                 f_export.write("%d\n" % self._pwmpin)
         except IOError as e:

-            raise PWMError(e.errno, "Exporting PWM pin: " + e.strerror)
+            raise PWMError(e.errno, "Exporting PWM pin: " + e.strerror) from IOError
+
+        # Loop until 'period' is writable, because application of udev rules
+        # after the above pin export is asynchronous.
+        # Without this loop, the following properties may not be writable yet.
+        for i in range(PWMOut.PWM_STAT_RETRIES):
+            try:
+                with open(
+                    os.path.join(
+                        channel_path, self._pin_path.format(self._pwmpin), "period"
+                    ),
+                    "w",
+                    encoding="utf-8",
+                ):
+                    break
+            except IOError as e:
+                if e.errno != EACCES or (
+                    e.errno == EACCES and i == PWMOut.PWM_STAT_RETRIES - 1
+                ):
+                    raise PWMError(e.errno, "Opening PWM period: " + e.strerror) from e
+            sleep(PWMOut.PWM_STAT_DELAY)

 
         # self._set_enabled(False) # This line causes a write error when trying to enable
 
 
         # self._set_enabled(False) # This line causes a write error when trying to enable
 


@@ -124,17 +158,20 @@ class PWMOut:
     def deinit(self):
         """Deinit the sysfs PWM."""
         if self._channel is not None:
     def deinit(self):
         """Deinit the sysfs PWM."""
         if self._channel is not None:

-            self.duty_cycle = 0

             try:
                 channel_path = os.path.join(
                     self._sysfs_path, self._channel_path.format(self._channel)
                 )
                 with open(
             try:
                 channel_path = os.path.join(
                     self._sysfs_path, self._channel_path.format(self._channel)
                 )
                 with open(

-                    os.path.join(channel_path, self._unexport_path), "w"
+                    os.path.join(channel_path, self._unexport_path),
+                    "w",
+                    encoding="utf-8",

                 ) as f_unexport:
                     f_unexport.write("%d\n" % self._pwmpin)
             except IOError as e:
                 ) as f_unexport:
                     f_unexport.write("%d\n" % self._pwmpin)
             except IOError as e:

-                raise PWMError(e.errno, "Unexporting PWM pin: " + e.strerror)
+                raise PWMError(
+                    e.errno, "Unexporting PWM pin: " + e.strerror
+                ) from IOError

 
         self._channel = None
         self._pwmpin = None
 
         self._channel = None
         self._pwmpin = None


@@ -157,7 +194,7 @@ class PWMOut:
             attr,
         )
 
             attr,
         )
 

-        with open(path, "w") as f_attr:
+        with open(path, "w", encoding="utf-8") as f_attr:

             # print(value, path)
             f_attr.write(value + "\n")
 
             # print(value, path)
             f_attr.write(value + "\n")
 


@@ -172,7 +209,7 @@ class PWMOut:
             attr,
         )
 
             attr,
         )
 

-        with open(path, "r") as f_attr:
+        with open(path, "r", encoding="utf-8") as f_attr:

             return f_attr.read().strip()
 
     # Mutable properties
             return f_attr.read().strip()
 
     # Mutable properties


@@ -182,7 +219,9 @@ class PWMOut:
         try:
             period_ns = int(period_ns)
         except ValueError:
         try:
             period_ns = int(period_ns)
         except ValueError:

-            raise PWMError(None, 'Unknown period value: "%s"' % period_ns)
+            raise PWMError(
+                None, 'Unknown period value: "%s"' % period_ns
+            ) from ValueError

 
         # Convert period from nanoseconds to seconds
         period = period_ns / 1e9
 
         # Convert period from nanoseconds to seconds
         period = period_ns / 1e9


@@ -220,7 +259,9 @@ class PWMOut:
         try:
             duty_cycle_ns = int(duty_cycle_ns)
         except ValueError:
         try:
             duty_cycle_ns = int(duty_cycle_ns)
         except ValueError:

-            raise PWMError(None, 'Unknown duty cycle value: "%s"' % duty_cycle_ns)
+            raise PWMError(
+                None, 'Unknown duty cycle value: "%s"' % duty_cycle_ns
+            ) from ValueError

 
         # Convert duty cycle from nanoseconds to seconds
         duty_cycle = duty_cycle_ns / 1e9
 
         # Convert duty cycle from nanoseconds to seconds
         duty_cycle = duty_cycle_ns / 1e9