PulseSynchronizer is inconsistent and usage is not documented

[dragonmux]

Version

0.6.2

What happened?

In the CDC library, there are two major primitives for signal clock domain crossing - FFSynchronizer, and PulseSynchronizer.

FFSynchronizer is mostly well documented and its usage makes sense - signal in, signal out, domain on which the output signal is to be registered, and job's a good'n once handed to the module's submodules.

However, PulseSynchronizer has an entirely different API and no documentation on how it should be wired up and used. This API only concerns itself with the input and output domains, and then expects the user to m.d.comb the input and output signals to the .i and .o signals the block provides. This is harder to use and inconsistent, and should be fixed.

Code of Conduct

• I agree to follow this project's Code of Conduct