CLI Reference

This chapter contains the auto-generated documentation of the command line interface for padrick. The information you find here is identical to the info found in the CLI command help pages.

padrick

Generate padframes for SoC

padrick [OPTIONS] COMMAND [ARGS]...

Options

--version: Show the version and exit.

config

Print the parsed padframe configuration file

padrick config [OPTIONS] FILE

Options

-v, --verbosity <LVL>: Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

FILE: Required argument

fusesoc-gen

Generator invocation for FuseSoC.

Parses the supplied config_file command and generates RTL + Core files in the current direcotry. Check the documentation for more information about available FuseSoC Generator parameters.

padrick fusesoc-gen [OPTIONS] CONFIG_FILE

Arguments

CONFIG_FILE: Required argument

generate

Generate various output files for the provided pad_frame configuration

padrick generate [OPTIONS] COMMAND [ARGS]...

Options

-s, --generator_settings_file <generator_settings_file>: A yaml file containing custom settings for the generate command.

constraints

Generate an SDC constraints file with set_case_analysis on all configuration registers of the padmultiplexer.

The generated SDC file is usefull in constraining the padmultiplexer to only consider a fixed static configuration to prevent STA from considering all possible multiplex configurations.

On top of the usual pad configuration file (CONFIG_FILE), this command accepts a case specification file as the second argument that specifies to which values the different multiplex registers shall be constrained to.

padrick generate constraints [OPTIONS] CONFIG_FILE CONSTRAINTS_SPEC_FILE

Options

-o, --output <output>: Directory where to save the SDC files

--header <header>: A text file who’s content (extended with appropriate comment characters) is inserted as the header in each auto-generated file. Useful for copyright and author information.

--version-string, --no-version-string

Append current version of padrick to the header of each generated file.

Default: True

-v, --verbosity <LVL>: Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

CONFIG_FILE: Required argument

CONSTRAINTS_SPEC_FILE: Required argument

custom

Render a user-specified custom Mako Template TEMPLATE file using the parsed CONFIG_FILE pad configuration data.

This command is usefull for any kind of desired output format for which Padrick doesn’t already ship with the right template. The rendered template will be printed to OUTPUT. Both TEMPLATE and OUTPUT accept either a path to a file or the special argument ‘-’ to read from/write to stdin/stdout.

padrick generate custom [OPTIONS] CONFIG_FILE TEMPLATE OUTPUT

Options

-v, --verbosity <LVL>: Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

CONFIG_FILE: Required argument

TEMPLATE: Required argument

OUTPUT: Required argument

driver

Generate C driver to interact with the padframe.

padrick generate driver [OPTIONS] CONFIG_FILE

Options

-o, --output <output>: Location where to save the driver

--header <header>: A text file who’s content (extended with appropriate comment characters) is inserted as the header in each auto-generated file. Useful for copyright and author information.

--version-string, --no-version-string

Append current version of padrick to the header of each generated file.

Default: True

-v, --verbosity <LVL>: Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

CONFIG_FILE: Required argument

padlist

Generate a CSV file that lists all pads in your configuration.

padrick generate padlist [OPTIONS] CONFIG_FILE

Options

-o, --output <output>: Directory where to save the padlist CSV

-v, --verbosity <LVL>: Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

CONFIG_FILE: Required argument

rtl

Generate SystemVerilog implementation from the padframe configuration.

padrick generate rtl [OPTIONS] CONFIG_FILE

Options

-o, --output <output>: Location where to save the RTL

--header <header>: A text file who’s content (extended with appropriate comment characters) is inserted as the header in each auto-generated file. Useful for copyright and author information.

--version-string, --no-version-string

Append current version of padrick to the header of each generated file.

Default: True

-v, --verbosity <LVL>: Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

CONFIG_FILE: Required argument

template-customization

Generate a padrick_gen_settings.yml file and folder structure containing copies of all internal Mako templates for customization of the generated file formats.

This is an advanced feature and allows the user to customize the internal Mako templates used to generate the various export files. In order for the customize option to have any effect, you need to invoke the generate commands with the additional -s flag: e.g.: padrick generate -s padrick_gen_settings.yml rtl my_padframe.yml

The -s option needs to come before the subcommand (in this case ‘rtl’).

padrick generate template-customization [OPTIONS]

Options

-o, --output <output>: Location where to save the RTL

install-completions

Install the command line tool’s bash completion for your shell

If you don’t provide any additional arguments this command tries to detect your current shell in use and appends the relevant settings to your .bashrc, .zshrc etc.

padrick install-completions [OPTIONS] [[bash|fish|zsh|powershell]] [PATH]

Options

--append, --overwrite: Append the completion code to the file

-i, --case-insensitive, --no-case-insensitive: Case insensitive completion

Arguments

SHELL: Optional argument

PATH: Optional argument

validate

Parse and validate the given config file

padrick validate [OPTIONS] FILE

Options

-v, --verbosity <LVL>: Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Arguments

FILE: Required argument