src/adafruit_blinka/microcontroller/rockchip/PWMOut.py

   1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4 """
   5 Much code from https://github.com/vsergeev/python-periphery/blob/master/periphery/pwm.py
   6 Copyright (c) 2015-2016 vsergeev / Ivan (Vanya) A. Sergeev
   7 License: MIT
   8 """
   9
  10 import os
  11 from time import sleep
  12 from errno import EACCES
  13
  14 try:
  15     from microcontroller.pin import pwmOuts
  16 except ImportError:
  17     raise RuntimeError("No PWM outputs defined for this board.") from ImportError
  18
  19
  20 # pylint: disable=unnecessary-pass, too-many-instance-attributes
  21
  22
  23 class PWMError(IOError):
  24     """Base class for PWM errors."""
  25
  26     pass
  27
  28
  29 # pylint: enable=unnecessary-pass
  30
  31
  32 class PWMOut:
  33     """Pulse Width Modulation Output Class"""
  34
  35     # Number of retries to check for successful PWM export on open
  36     PWM_STAT_RETRIES = 10
  37     # Delay between check for successful PWM export on open (100ms)
  38     PWM_STAT_DELAY = 0.1
  39
  40     # Sysfs paths
  41     _chip_path = "pwmchip{}"
  42     _channel_path = "pwm{}"
  43
  44     def __init__(self, pwm, *, frequency=500, duty_cycle=0, variable_frequency=False):
  45         """Instantiate a PWM object and open the sysfs PWM corresponding to the
  46         specified chip and channel.
  47         Args:
  48             pwm (str): PWM pin.
  49             frequency (int, float): target frequency in Hertz (32-bit).
  50             duty_cycle (int, float): The fraction of each pulse which is high (16-bit).
  51             variable_frequency (bool): True if the frequency will change over time.
  52         Returns:
  53             PWM: PWM object.
  54         Raises:
  55             PWMError: if an I/O or OS error occurs.
  56             TypeError: if `chip` or `channel` types are invalid.
  57             LookupError: if PWM chip does not exist.
  58             TimeoutError: if waiting for PWM export times out.
  59         """
  60
  61         self._chip = None
  62         self._channel = None
  63         self._period_ns = 0
  64         self._open(pwm, frequency, duty_cycle, variable_frequency)
  65
  66     def __del__(self):
  67         self.close()
  68
  69     def __enter__(self):
  70         return self
  71
  72     def __exit__(self, exc_type, exc_val, exc_tb):
  73         self.close()
  74
  75     def _open(self, pwm, frequency, duty_cycle, variable_frequency):
  76         for pwmout in pwmOuts:
  77             if pwmout[1] == pwm:
  78                 self._chip = pwmout[0][0]
  79                 self._channel = pwmout[0][1]
  80
  81         self._chip_path = os.path.join(
  82             "/sys/class/pwm", self._chip_path.format(self._chip)
  83         )
  84         self._channel_path = os.path.join(
  85             self._chip_path, self._channel_path.format(self._channel)
  86         )
  87
  88         if variable_frequency:
  89             print("Variable Frequency is not supported, continuing without it...")
  90
  91         if not os.path.isdir(self._chip_path):
  92             raise LookupError("Opening PWM: PWM chip {} not found.".format(self._chip))
  93
  94         if not os.path.isdir(self._channel_path):
  95             # Exporting the PWM.
  96             try:
  97                 with open(
  98                     os.path.join(self._chip_path, "export"), "w", encoding="utf-8"
  99                 ) as f_export:
 100                     f_export.write("{:d}\n".format(self._channel))
 101             except IOError as e:
 102                 raise PWMError(
 103                     e.errno, "Exporting PWM channel: " + e.strerror
 104                 ) from IOError
 105
 106             # Loop until PWM is exported
 107             exported = False
 108             for i in range(PWMOut.PWM_STAT_RETRIES):
 109                 if os.path.isdir(self._channel_path):
 110                     exported = True
 111                     break
 112
 113                 sleep(PWMOut.PWM_STAT_DELAY)
 114
 115             if not exported:
 116                 raise TimeoutError(
 117                     'Exporting PWM: waiting for "{:s}" timed out.'.format(
 118                         self._channel_path
 119                     )
 120                 )
 121
 122             # Loop until 'period' is writable, This could take some time after
 123             # export as application of the udev rules after export is asynchronous.
 124             # Without this loop, the following properties may not be writable yet.
 125             for i in range(PWMOut.PWM_STAT_RETRIES):
 126                 try:
 127                     with open(
 128                         os.path.join(self._channel_path, "period"),
 129                         "w",
 130                         encoding="utf-8",
 131                     ):
 132                         break
 133                 except IOError as e:
 134                     if e.errno != EACCES or (
 135                         e.errno == EACCES and i == PWMOut.PWM_STAT_RETRIES - 1
 136                     ):
 137                         raise PWMError(
 138                             e.errno, "Opening PWM period: " + e.strerror
 139                         ) from IOError
 140
 141                 sleep(PWMOut.PWM_STAT_DELAY)
 142
 143             self.frequency = frequency
 144             self.duty_cycle = duty_cycle
 145
 146             # Cache the period for fast duty cycle updates
 147             self._period_ns = self._get_period_ns()
 148
 149     def close(self):
 150         """Close the PWM."""
 151         if self._channel is not None:
 152             # Unexporting the PWM channel
 153             try:
 154                 unexport_fd = os.open(
 155                     os.path.join(self._chip_path, "unexport"), os.O_WRONLY
 156                 )
 157                 os.write(unexport_fd, "{:d}\n".format(self._channel).encode())
 158                 os.close(unexport_fd)
 159             except OSError as e:
 160                 raise PWMError(e.errno, "Unexporting PWM: " + e.strerror) from OSError
 161
 162         self._chip = None
 163         self._channel = None
 164
 165     def _write_channel_attr(self, attr, value):
 166         with open(
 167             os.path.join(self._channel_path, attr), "w", encoding="utf-8"
 168         ) as f_attr:
 169             f_attr.write(value + "\n")
 170
 171     def _read_channel_attr(self, attr):
 172         with open(
 173             os.path.join(self._channel_path, attr), "r", encoding="utf-8"
 174         ) as f_attr:
 175             return f_attr.read().strip()
 176
 177     # Methods
 178
 179     def enable(self):
 180         """Enable the PWM output."""
 181         self.enabled = True
 182
 183     def disable(self):
 184         """Disable the PWM output."""
 185         self.enabled = False
 186
 187     # Mutable properties
 188
 189     def _get_period(self):
 190         return float(self.period_ms) / 1000
 191
 192     def _set_period(self, period):
 193         if not isinstance(period, (int, float)):
 194             raise TypeError("Invalid period type, should be int.")
 195
 196         self.period_ms = int(period * 1000)
 197
 198     period = property(_get_period, _set_period)
 199     """Get or set the PWM's output period in seconds.
 200
 201     Raises:
 202         PWMError: if an I/O or OS error occurs.
 203         TypeError: if value type is not int.
 204
 205     :type: int, float
 206     """
 207
 208     def _get_period_ms(self):
 209         return self.period_us / 1000
 210
 211     def _set_period_ms(self, period_ms):
 212         if not isinstance(period_ms, (int, float)):
 213             raise TypeError("Invalid period type, should be int or float.")
 214         self.period_us = int(period_ms * 1000)
 215
 216     period_ms = property(_get_period_ms, _set_period_ms)
 217     """Get or set the PWM's output period in milliseconds.
 218
 219     Raises:
 220         PWMError: if an I/O or OS error occurs.
 221         TypeError: if value type is not int.
 222
 223     :type: int, float
 224     """
 225
 226     def _get_period_us(self):
 227         return self.period_ns / 1000
 228
 229     def _set_period_us(self, period_us):
 230         if not isinstance(period_us, int):
 231             raise TypeError("Invalid period type, should be int.")
 232
 233         self.period_ns = int(period_us * 1000)
 234
 235     period_us = property(_get_period_us, _set_period_us)
 236     """Get or set the PWM's output period in microseconds.
 237
 238     Raises:
 239         PWMError: if an I/O or OS error occurs.
 240         TypeError: if value type is not int.
 241
 242     :type: int
 243     """
 244
 245     def _get_period_ns(self):
 246         period_ns = self._read_channel_attr("period")
 247         try:
 248             period_ns = int(period_ns)
 249         except ValueError:
 250             raise PWMError(
 251                 None, 'Unknown period value: "%s".' % period_ns
 252             ) from ValueError
 253
 254         self._period_ns = period_ns
 255
 256         return period_ns
 257
 258     def _set_period_ns(self, period_ns):
 259         if not isinstance(period_ns, int):
 260             raise TypeError("Invalid period type, should be int.")
 261
 262         self._write_channel_attr("period", str(period_ns))
 263
 264         # Update our cached period
 265         self._period_ns = period_ns
 266
 267     period_ns = property(_get_period_ns, _set_period_ns)
 268     """Get or set the PWM's output period in nanoseconds.
 269
 270     Raises:
 271         PWMError: if an I/O or OS error occurs.
 272         TypeError: if value type is not int.
 273
 274     :type: int
 275     """
 276
 277     def _get_duty_cycle_ns(self):
 278         duty_cycle_ns_str = self._read_channel_attr("duty_cycle")
 279
 280         try:
 281             duty_cycle_ns = int(duty_cycle_ns_str)
 282         except ValueError:
 283             raise PWMError(
 284                 None, 'Unknown duty cycle value: "{:s}"'.format(duty_cycle_ns_str)
 285             ) from ValueError
 286
 287         return duty_cycle_ns
 288
 289     def _set_duty_cycle_ns(self, duty_cycle_ns):
 290         if not isinstance(duty_cycle_ns, int):
 291             raise TypeError("Invalid duty cycle type, should be int.")
 292
 293         self._write_channel_attr("duty_cycle", str(duty_cycle_ns))
 294
 295     duty_cycle_ns = property(_get_duty_cycle_ns, _set_duty_cycle_ns)
 296     """Get or set the PWM's output duty cycle in nanoseconds.
 297
 298     Raises:
 299         PWMError: if an I/O or OS error occurs.
 300         TypeError: if value type is not int.
 301
 302     :type: int
 303     """
 304
 305     def _get_duty_cycle(self):
 306         return float(self.duty_cycle_ns) / self._period_ns
 307
 308     def _set_duty_cycle(self, duty_cycle):
 309         if not isinstance(duty_cycle, (int, float)):
 310             raise TypeError("Invalid duty cycle type, should be int or float.")
 311
 312         if not 0.0 <= duty_cycle <= 1.0:
 313             raise ValueError("Invalid duty cycle value, should be between 0.0 and 1.0.")
 314
 315         # Convert duty cycle from ratio to nanoseconds
 316         self.duty_cycle_ns = int(duty_cycle * self._period_ns)
 317
 318     duty_cycle = property(_get_duty_cycle, _set_duty_cycle)
 319     """Get or set the PWM's output duty cycle as a ratio from 0.0 to 1.0.
 320     Raises:
 321         PWMError: if an I/O or OS error occurs.
 322         TypeError: if value type is not int or float.
 323         ValueError: if value is out of bounds of 0.0 to 1.0.
 324     :type: int, float
 325     """
 326
 327     def _get_frequency(self):
 328         return 1.0 / self.period
 329
 330     def _set_frequency(self, frequency):
 331         if not isinstance(frequency, (int, float)):
 332             raise TypeError("Invalid frequency type, should be int or float.")
 333
 334         self.period = 1.0 / frequency
 335
 336     frequency = property(_get_frequency, _set_frequency)
 337     """Get or set the PWM's output frequency in Hertz.
 338     Raises:
 339         PWMError: if an I/O or OS error occurs.
 340         TypeError: if value type is not int or float.
 341     :type: int, float
 342     """
 343
 344     def _get_polarity(self):
 345         return self._read_channel_attr("polarity")
 346
 347     def _set_polarity(self, polarity):
 348         if not isinstance(polarity, str):
 349             raise TypeError("Invalid polarity type, should be str.")
 350
 351         if polarity.lower() not in ["normal", "inversed"]:
 352             raise ValueError('Invalid polarity, can be: "normal" or "inversed".')
 353
 354         self._write_channel_attr("polarity", polarity.lower())
 355
 356     polarity = property(_get_polarity, _set_polarity)
 357     """Get or set the PWM's output polarity. Can be "normal" or "inversed".
 358     Raises:
 359         PWMError: if an I/O or OS error occurs.
 360         TypeError: if value type is not str.
 361         ValueError: if value is invalid.
 362     :type: str
 363     """
 364
 365     def _get_enabled(self):
 366         enabled = self._read_channel_attr("enable")
 367
 368         if enabled == "1":
 369             return True
 370         if enabled == "0":
 371             return False
 372
 373         raise PWMError(None, 'Unknown enabled value: "{:s}"'.format(enabled))
 374
 375     def _set_enabled(self, value):
 376         if not isinstance(value, bool):
 377             raise TypeError("Invalid enabled type, should be bool.")
 378
 379         self._write_channel_attr("enable", "1" if value else "0")
 380
 381     enabled = property(_get_enabled, _set_enabled)
 382     """Get or set the PWM's output enabled state.
 383     Raises:
 384         PWMError: if an I/O or OS error occurs.
 385         TypeError: if value type is not bool.
 386     :type: bool
 387     """
 388
 389     # String representation
 390
 391     def __str__(self):
 392         return (
 393             "PWM {:d}, chip {:d} (period={:f} sec, duty_cycle={:f}%,"
 394             " polarity={:s}, enabled={:s})".format(
 395                 self._channel,
 396                 self._chip,
 397                 self.period,
 398                 self.duty_cycle * 100,
 399                 self.polarity,
 400                 str(self.enabled),
 401             )
 402         )