From: Florent Kermarrec <florent@enjoy-digital.fr>
Date: Fri, 5 Jul 2019 17:38:58 +0000 (+0200)
Subject: cores: add simple PWM (Pulse Width Modulation) module
X-Git-Tag: 24jan2021_ls180~1121
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=282ae9635465fca96f0c85da3eaa9a6f29197350;p=litex.git

cores: add simple PWM (Pulse Width Modulation) module
---

diff --git a/litex/soc/cores/pwm.py b/litex/soc/cores/pwm.py
new file mode 100644
index 00000000..6c369711
--- /dev/null
+++ b/litex/soc/cores/pwm.py
@@ -0,0 +1,57 @@
+# This file is Copyright (c) 2015 Florent Kermarrec <florent@enjoy-digital.fr>
+# License: BSD
+
+from migen import *
+from migen.genlib.cdc import MultiReg
+
+from litex.soc.interconnect.csr import *
+
+# Pulse Width Modulation ---------------------------------------------------------------------------
+
+class PWM(Module, AutoCSR):
+    """Pulse Width Modulation
+
+    Provides the minimal hardware to do Pulse Width Modulation.
+
+    Pulse Width Modulation can be useful for various purposes: dim leds, regulate a fan, control
+    an oscillator. Software can configure the PWM width and period and enable/disable it.
+    """
+    def __init__(self, pwm=None, clock_domain="sys"):
+        if pwm is None:
+            self.pwm = pwm = Signal()
+        self._enable = CSRStorage(reset=1)
+        self._width  = CSRStorage(32, reset=2**19)
+        self._period = CSRStorage(32, reset=2**20)
+
+        # # #
+
+        counter = Signal(32)
+        enable  = Signal()
+        width   = Signal(32)
+        period  = Signal(32)
+
+        # Resynchronize to clock_domain ------------------------------------------------------------
+        self.specials += [
+            MultiReg(self._enable.storage, enable, clock_domain),
+            MultiReg(self._width.storage,  width,  clock_domain),
+            MultiReg(self._period.storage, period, clock_domain),
+        ]
+
+        # PWM generation  --------------------------------------------------------------------------
+        sync = getattr(self.sync, clock_domain)
+        sync += \
+            If(enable,
+                If(counter < width,
+                    pwm.eq(1)
+                ).Else(
+                    pwm.eq(0)
+                ),
+                If(counter == period-1,
+                    counter.eq(0)
+                ).Else(
+                    counter.eq(counter+1)
+                )
+            ).Else(
+                counter.eq(0),
+                pwm.eq(0)
+            )