From ff96ab345b7dd1c1462713efbe7be507ccd14ec8 Mon Sep 17 00:00:00 2001 From: philip r brenan Date: Fri, 4 Sep 2026 01:47:08 +0100 Subject: [PATCH] Expand FAQ section with new questions Added FAQs about word size measurement, smallest ROM, and words per row. --- docs/source/FAQ.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/FAQ.md b/docs/source/FAQ.md index a515b17ad..7922eff03 100644 --- a/docs/source/FAQ.md +++ b/docs/source/FAQ.md @@ -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