| Copyright | (C) 2017 Google Inc |
|---|---|
| License | BSD2 (see the file LICENSE) |
| Maintainer | Christiaan Baaij <christiaan.baaij@gmail.com> |
| Safe Haskell | None |
| Language | Haskell2010 |
Clash.Xilinx.ClockGen
Description
PLL and other clock-related components for Xilinx FPGAs
Synopsis
- clockWizard :: forall domIn domOut periodIn periodOut edge init polarity name. (KnownConfiguration domIn ('DomainConfiguration domIn periodIn edge 'Asynchronous init polarity), KnownConfiguration domOut ('DomainConfiguration domOut periodOut edge 'Asynchronous init polarity)) => SSymbol name -> Clock domIn -> Reset domIn -> (Clock domOut, Enable domOut)
- clockWizardDifferential :: forall domIn domOut periodIn periodOut edge init polarity name. (KnownConfiguration domIn ('DomainConfiguration domIn periodIn edge 'Asynchronous init polarity), KnownConfiguration domOut ('DomainConfiguration domOut periodOut edge 'Asynchronous init polarity)) => SSymbol name -> Clock domIn -> Clock domIn -> Reset domIn -> (Clock domOut, Enable domOut)
Documentation
Arguments
| :: forall domIn domOut periodIn periodOut edge init polarity name. (KnownConfiguration domIn ('DomainConfiguration domIn periodIn edge 'Asynchronous init polarity), KnownConfiguration domOut ('DomainConfiguration domOut periodOut edge 'Asynchronous init polarity)) | |
| => SSymbol name | Name of the component, must correspond to the name entered in the "Clock Wizard" dialog. For example, when you entered "clockWizard50", instantiate as follows: SSymbol @ "clockWizard50" |
| -> Clock domIn | Free running clock (i.e. a clock pin connected to a crystal) |
| -> Reset domIn | Reset for the PLL |
| -> (Clock domOut, Enable domOut) | (Stable PLL clock, PLL lock) |
A clock source that corresponds to the Xilinx PLL/MMCM component created
with the "Clock Wizard" with settings to provide a stable Clock from
a single free-running input
Only works when configured with:
- 1 reference clock
- 1 output clock
- a reset port
- a locked port
You must use type applications to specify the output clock domain, e.g.:
type Dom100MHz = Dom "A" 10000
-- outputs a clock running at 100 MHz
clockWizard @Dom100MHz (SSymbol @"clkWizard50to100") clk50 rst
clockWizardDifferential Source #
Arguments
| :: forall domIn domOut periodIn periodOut edge init polarity name. (KnownConfiguration domIn ('DomainConfiguration domIn periodIn edge 'Asynchronous init polarity), KnownConfiguration domOut ('DomainConfiguration domOut periodOut edge 'Asynchronous init polarity)) | |
| => SSymbol name | Name of the component, must correspond to the name entered in the "Clock Wizard" dialog. For example, when you entered "clockWizardD50", instantiate as follows: SSymbol @ "clockWizardD50" |
| -> Clock domIn | Free running clock, negative phase |
| -> Clock domIn | Free running clock, positive phase |
| -> Reset domIn | Reset for the PLL |
| -> (Clock domOut, Enable domOut) | (Stable PLL clock, PLL lock) |
A clock source that corresponds to the Xilinx PLL/MMCM component created
with the "Clock Wizard", with settings to provide a stable Clock
from differential free-running inputs.
Only works when configured with:
- 1 differential reference pair
- 1 output clock
- a reset port
- a locked port
You must use type applications to specify the output clock domain, e.g.:
type Dom100MHz = Dom "A" 10000
-- outputs a clock running at 100 MHz
clockWizardDifferential @Dom100MHz (SSymbol @"clkWizardD50to100") clk50N clk50P rst