...

The Training_package environment is a help for customers as it provides multiple several tests. These tests are meant to use a Nxmap function, instantiate a Nx component or show a design example.

...

The following installations must be done to be compliant with the whole environment:

Python 3.6 - On CentOS machine, please launch the following commands:
- sudo yum install rh-python36
PyQt5 - On CentOS machine, please launch the following commands:
- sudo yum install qt5-qtbase-devel
- sudo yum install python3-qt5

The environment is dedicated to be used in a Linux OS.

...

In order to get all info about all Makefile targets, please enter the following command:

Code Block
make

In order to launch the GUI, please enter the following command:

Code Block

language	py

python3 Training_Gui.py

System errors

If one of the following error messages appears when performing a command, please send the associated command:

“Warning **: Error retrieving accessibility bus address”
- Code Block
  sudo apt-get install at-spi-core

Directory content

The directory is divided in multiple sub-directories and files to be clearer.

...

For instance, it gives the ability to launch a test through nxpython, open a test through nxmap, open logs, etc,…

Test_Plan.csv

This table file contains all available tests in the training environment. Each test gets the following information:

...

This script is automatically generated when launching Makefile commands through the GUI. It gives the ability to perform the same action actions without using the GUI.

Path.mk

This is the configuration file for the Makefile and the GUI. It is used to configure some paths and commands related to needed software. In the GUI, these parameters values are only default ones and can be changed into.

The only available parameters to configure are the following:

...

This is where documentation is stored.

Test

All tests are stored in this category with the path “test/[category]/[test]/”.

...

script_[variant].py: script to launch by nxpython script_[variant].py [option].
src: all needed RTL sources.
sub_scripts: all needed python files to create the project.
- pads_[variant].py: defined banks and pads.
- project_files.py: defined RTL files.
- project_parameters.py: defined parameters and options.
- script.py: main script.
- variant_custom.py: board class.
[top_cell]_[variant]_[option]: created project once launched.
- Logs: all logs.
- Rtl: all projects savings progress by progress.
- Bitstream.nxb: Generated bitstream.
- *.nym: Auto generated project savings.

...

This directory is divided in nxmap directory, containing result files from nxpython command, and simu directory, containing result files from vsim command. A report file contains a summary of its associated result as parameters, option, used resources, reported timings etc …

...

Hereafter, a list of multiple Makefile commands.

All commands but must be launched as follows:

Code Block
make [command] [parameter0]=[parameter0_value] [parameter1]=[parameter1_value]

Parameters under brackets “()” are optional. That means a default value is set but can be overridden.

The following table describes the exhaustive list of values and the default values for each optional parameter:

Parameter	Available values	Default value	Description
OPTION		‘’	Option launched with nxpython script
VARIANT	NG-MEDIUM NG-LARGE NG-ULTRA NG-MEDIUM-EMBEDDED NG-LARGE-EMBEDDED NG-ULTRA-EMBEDDED	NG-MEDIUM	Used variant
PROGRESS	native synthesized_1 synthesized_2 placed_1 placed_2 placed_3 placed_4 placed_5 routed_1 routed_2 routed_3	routed_3	Progress of bitstreaming flow
SEVERITY	WARNING ERROR	ERROR	Severity in reporting

...

Command

info

Description

Get information about the version

Parameters

Example

Code Block
make info

Table: info Makefile command

...

Command

test_list

Description

Get list of tests by category, name and option

Parameters

Example

Code Block
make test_list

Table: test_list Makefile command

...

Command

open_test_plan

Description

Open Test_Plan.csv

Parameters

Example

Code Block
make open_test_plan

Table: open_test_plan Makefile command

...

Command

archive_test

Description

Create a .zip archive for a test in the parent directory

Parameters

CATEGORY NAME

Example

Code Block
make archive_test CATEGORY=ClockConstraint NAME=GeneratedClock

Table: archive_test Makefile command

...

Command

edit_script_files

Description

edit all python sub-scripts of a project

Parameters

CATEGORY NAME

Example

Code Block
make edit_script_files CATEGORY=ClockConstraint NAME=GeneratedClock

Table: edit_script_files Makefile command

...

Command

edit_src_files

Description

edit all RTL sources of a project

Parameters

CATEGORY NAME

Example

Code Block
make edit_src_files CATEGORY=ClockConstraint NAME=GeneratedClock

Table: edit_src_files Makefile command

...

Command

launch_test

Description

Launch a test through nxpython

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make launch_test CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: launch_test Makefile command

...

Command

open_test

Description

Open a test through nxmap3

Parameters

CATEGORY NAME (OPTION) (VARIANT) (PROGRESS)

Example

Code Block
make open_test CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE PROGRESS=placed

Table: open_test Makefile command

...

Command

open_log

Description

Open all .log files in project log directory

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make open_log CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: open_log Makefile command

...

Command

open_rpt

Description

Open all .rpt files in project log directory

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make open_rpt CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: open_rpt Makefile command

...

Command

open_timing

Description

Open all .timing files in project log directory

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make open_timing CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: open_timing Makefile command

...

Command

run_simu

Description

Run a simu through ModelSim

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make run_simu CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: run_simu Makefile command

...

Command

open_simu

Description

Open a simu through ModelSim

Parameters

CATEGORY NAME (OPTION) (VARIANT) (PROGRESS)

Example

Code Block
make open_simu CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE PROGRESS=placed

Table: open_simu Makefile command

...

Command

open_result

Description

Open result file

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make open_result CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: open_result Makefile command

...

Command

report_result

Description

Generate report file from the result file

Parameters

CATEGORY NAME (OPTION) (VARIANT) (SEVERITY)

Example

Code Block
make report_result CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE SEVERITY=ERROR

Table: report_result Makefile command

...

Command

open_report

Description

Open result file

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make open_report CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: open_report Makefile command

...

Command

open_simu_result

Description

Open simu result file

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make open_simu_result CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: open_simu_result Makefile command

...

Command

report_simu_result

Description

Generate simu report file from the result file

Parameters

CATEGORY NAME (OPTION) (VARIANT) (SEVERITY)

Example

Code Block
make report_simu_result CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE SEVERITY=ERROR

Table: report_simu_result Makefile command

...

Command

open_simu_report

Description

Open simu report file

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make open_simu_report CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: open_simu_report Makefile command

...

Command

load_bitstream

Description

Load a bitstream through NxBase2

Parameters

CATEGORY NAME (OPTION) (VARIANT)

Example

Code Block
make load_bitstream CATEGORY=ClockConstraint NAME=GeneratedClock OPTION=ClockConstraint VARIANT=LARGE

Table: load bitstream Makefile command

...

Table: Table Editor GUI action

...

If no text editor has been configured in the configuration file config.cfg, the default one is “libreoffice”.

...

If no text editor has been configured in the configuration file config.cfg, the default one is “nedit”.

Info

Action	Info
Description	It gives information about this software version.
Shortcut
Makefile command

...

Table: Find Nxmap Function / Nx Component GUI action

...

Only a pattern is needed meaning this is a research of a string containing the word and not a research of the whole word.

Test Management

Action	Test Management
Description	Open the Test Management Window.
Shortcut	CTRL+T
Makefile command

...

All information about the test stored in the Test_Plan.csv is displayed in a more readable way.

...

Quit

Action	Quit
Description	Quit the window.
Shortcut	CTRL+Q
Makefile command

...

Action

Launch Test

Description

Open a test through nxmap3.

Shortcut

CTRL+O

Makefile command

Code Block
open_test

Table: Open Test GUI action

...

Action

Open Log

Description

Open .log files in project log directory.

Shortcut

Makefile command

Code Block
open_log

Table: Open Log GUI action

...

Action

Open Rpt

Description

Open .rpt files in project log directory.

Shortcut

Makefile command

Code Block
open_rpt

Table: Open Rpt GUI action

...

Action

Open Timing

Description

Open .timing files in project log directory.

Shortcut

Makefile command

Code Block
open_timing

Table: Open Timing GUI action

...

Action

Open Result

Description

Open the result file of the test.

Shortcut

Makefile command

Code Block
open_result

Table: Open Result GUI action

...

Before opening a result file, the test has to be launched.

Open Report

Action

Open Report

Description

Open the report file of the test.

Shortcut

Makefile command

Code Block
open_report

Table: Open Report GUI action

...

Before opening a report file, the test has to be launched.

Open Simu Result

Action

Open Simu Result

Description

Open the result simu file of the test.

Shortcut

Makefile command

Code Block
open_simu_result

Table: Open Result GUI action

...

Before opening a simu result file, the simu has to be run.

Open Simu Report

Action

Open Report

Description

Open the report simu file of the test.

Shortcut

Makefile command

Code Block
open_simu_report

Table: Open Report GUI action

...

Before opening a simu report file, the simu has to be run.

Bitstream

Load Bitstream

Action

Archive Test

Description

Load a bitstream through NxBase2

Shortcut

Makefile command

Code Block
load _bitstream

Table: Load Bitstream GUI action

...

Action

Archive Test

Description

Create a .zip archive of the test in the parent directory.

Shortcut

Makefile command

Code Block
archive_test

Table: Archive Test GUI action

Versions Compared

Old Version 1

New Version 2

Key

System errors

Directory content

Test_Plan.csv

Path.mk

Test

Info

Test Management

Menu

Quit

Open Report

Open Simu Result

Open Simu Report

Bitstream

Load Bitstream

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

System errors

Directory content

Test_Plan.csv

Path.mk

Test

Info

Test Management

Menu

Quit

Open Report

Open Simu Result

Open Simu Report

Bitstream

Load Bitstream