Electronic System Design Group

Directory Layouts

Root Directory Processing

FPGAFlow operates on directory structures as defined in the Configuration YAML file. See <CATEGORY>_layout:.

The root directory of each layout is automatically determined by the script, if modifying the directory layouts the following rules must be applied to the layouts:

• The identifier to determine the root directory of libraries is the <NAME> tag.
• The identifier to determine the root directory of boards is the <TOOL_VERSION> tag.

Note

vendor_ip directory layout processing is handled separately.

FPGAFlow will parse the root directory for each enabled location and automatically add the first level of directories below the root directory. These are used to determine the locations of design files required to run designs through FPGAFlow.

First Level Directories

The following mappings are hard-coded in the script. See projectmanager.ProjectDependency.top_dir_lookup.

constraints

Directories matching any of following names are deemed to be the location of constraints:

• constraints
• constr
• constrs

docs

Directories matching any of following names are deemed to be the location of docs:

• docs
• doc
• documents
• documentation

netlists

Directories matching any of following names are deemed to be the location of netlists:

• netlists
• net
• nets

scripts

Directories matching any of following names are deemed to be the location of scripts:

• scripts
• script

settings

Directories matching any of following names are deemed to be the location of settings:

• settings
• setting

simulation

Directories matching any of following names are deemed to be the location of simulation:

• simulation
• sim
• sims

src

Directories matching any of following names are deemed to be the location of src:

• src
• srcs
• sources