Struct FlipFlop

pub struct FlipFlop {
    pub data: Value,
    pub clock: ControlNet,
    pub clear: ControlNet,
    pub reset: ControlNet,
    pub enable: ControlNet,
    pub reset_over_enable: bool,
    pub clear_value: Const,
    pub reset_value: Const,
    pub init_value: Const,
}

A flip-flop cell.

The output is determined by the following rules:

• at the beginning of time, the output is set to init_value
• whenever clear as active, the output is set to clear_value
• whenever clear is not active, and an active edge happens on clock:
  • if reset_over_enable is true:
    • if reset is active, the output is set to reset_value
    • if enable is false, output value is unchanged
  • if reset_over_enable is false:
    • if enable is false, output value is unchanged
    • if reset is active, the output is set to reset_value
  • otherwise, the output is set to data

Fields

data: Value

clock: ControlNet

The clock. The active edge is rising if it is a ControlNet::Pos, and falling if it is a ControlNet::Neg.

clear: ControlNet

Asynchronous reset.

reset: ControlNet

Synchronous reset.

enable: ControlNet

Clock enable.

reset_over_enable: bool

If true, reset has priority over enable. Otherwise, enable has priority over reset.

clear_value: Const

Must have the same width as data.

reset_value: Const

Must have the same width as data.

init_value: Const

Must have the same width as data.

Implementations

impl FlipFlop

pub fn new(data: Value, clock: impl Into<ControlNet>) -> Self

pub fn with_data(self, data: impl Into<Value>) -> Self

pub fn with_clock(self, clock: impl Into<ControlNet>) -> Self

pub fn with_clear(self, clear: impl Into<ControlNet>) -> Self

pub fn with_clear_value( self, clear: impl Into<ControlNet>, clear_value: impl Into<Const>, ) -> Self

pub fn with_reset(self, reset: impl Into<ControlNet>) -> Self

pub fn with_reset_value( self, reset: impl Into<ControlNet>, reset_value: impl Into<Const>, ) -> Self

pub fn with_enable(self, enable: impl Into<ControlNet>) -> Self

pub fn with_init(self, value: impl Into<Const>) -> Self

pub fn output_len(&self) -> usize

pub fn has_clock(&self) -> bool

pub fn has_enable(&self) -> bool

pub fn has_reset(&self) -> bool

pub fn has_reset_value(&self) -> bool

pub fn has_clear(&self) -> bool

pub fn has_clear_value(&self) -> bool

pub fn has_init_value(&self) -> bool

pub fn slice(&self, range: impl RangeBounds<usize> + Clone) -> FlipFlop

pub fn remap_reset_over_enable(&mut self, design: &Design)

pub fn remap_enable_over_reset(&mut self, design: &Design)

pub fn unmap_reset(&mut self, design: &Design)

pub fn unmap_enable(&mut self, design: &Design, output: &Value)

pub fn invert(&mut self, design: &Design, output: &Value) -> Value

pub fn visit(&self, f: impl FnMut(Net))

pub fn visit_mut(&mut self, f: impl FnMut(&mut Net))

Trait Implementations

impl Clone for FlipFlop

fn clone(&self) -> FlipFlop

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FlipFlop

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for FlipFlop

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FlipFlop

fn eq(&self, other: &FlipFlop) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FlipFlop

impl StructuralPartialEq for FlipFlop