Struct Memory

pub struct Memory {
    pub depth: usize,
    pub width: usize,
    pub init_value: Const,
    pub write_ports: Vec<MemoryWritePort>,
    pub read_ports: Vec<MemoryReadPort>,
}

An all-in-one random-access memory cell.

A memory is made of depth rows, each of them width bits wide. While a memory row is considered to be the basic access unit, we support the notion of “wide ports”, which access a (naturally aligned) power-of-two number of memory rows at once.

While any number and combination of read and write ports is considered valid in the netlist, the rules for what memories can actually be realized in hardware depend on the target, and can be quite byzantine.

There are no priority rules among write ports. If more than one port writes to the same memory bit at the same time, the value written is undefined.

The output of the memory cell consists of the read data from all the read ports, concatenated in order.

Fields

depth: usize

The number of rows in the memory.

For every port on the memory, depth must be evenly divisible by port.data_len / memory.width. This ensures that, for wide ports, every access is either completely in-bounds, or completely out-of-bounds.

width: usize

The width of single memory row.

init_value: Const

Initial value for the memory, with all the rows concatenated in order. Must have a length equal to depth * width.

write_ports: Vec<MemoryWritePort>

read_ports: Vec<MemoryReadPort>

Implementations

impl Memory

pub fn output_len(&self) -> usize

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

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

pub fn read_port_output_slice(&self, port_index: usize) -> Range<usize>

Trait Implementations

impl Clone for Memory

fn clone(&self) -> Memory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Memory

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

Formats the value using the given formatter.

impl Hash for Memory

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 Memory

fn eq(&self, other: &Memory) -> 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 Memory

impl StructuralPartialEq for Memory