Skip to content

Expand FAQ section with new questions #310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
philiprbrenan wants to merge 1 commit into
base: stable
Choose a base branch
from
Open

Expand FAQ section with new questions #310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/source/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

# Frequently Asked Questions

## What unit is the word size measured in?

Word sizes are measured in ``bytes`` not ``bits``. If your word size is nominally ``9`` bits, you will need to round the word size to ``16`` bits as the next multiple of ``8`` and set ``word_size = 2`` as **OpenRAM** assumes that there are ``8`` bits in a byte.

## What is the smallest ROM that can be produced?

Currently the smallest ``ROM`` that can be produced is ``6`` words, each word having a size of ``1`` byte, with ``8`` bits per byte being the default assumed by **OpenRAM**.

## Do I need to specify words_per_row

The ``words_per_row`` parameter can be safely allowed to default to an internally chosen value.

## What to do if OpenRAM encounters an error?

When OpenRAM runs, it puts files in a temporary directory that is
Expand Down