1 Copyright
2 Introduction
- 2.1 Aim of document
- 2.2 Package installation
- 2.3 Operation
- 2.4 Commands
- 2.5 System errors
3 Directory content
- 3.1 Files
  - 3.1.1 Makefile
  - 3.1.2 Test_Plan.csv
  - 3.1.3 Training_Gui.py
  - 3.1.4 Training_Transcript.sh
  - 3.1.5 Path.mk
- 3.2 Directories
  - 3.2.1 Doc
  - 3.2.2 Test
  - 3.2.3 Results
  - 3.2.4 Reports
4 Makefile commands
- 4.1 Information
  - 4.1.1 Info
  - 4.1.2 Test_list
- 4.2 Package management
  - 4.2.1 Open_test_plan
  - 4.2.2 Archive_test
- 4.3 Test management
  - 4.3.1 Edit_script_files
  - 4.3.2 Edit_src_files
  - 4.3.3 Launch_test
  - 4.3.4 Open_test
  - 4.3.5 Open_log
  - 4.3.6 Open_rpt
  - 4.3.7 Open_timing
- 4.4 Simulation Management
  - 4.4.1 Run_simu
  - 4.4.2 Open_simu
- 4.5 Result Management
  - 4.5.1 Open_result
  - 4.5.2 Report_result
  - 4.5.3 Open_report
- 4.6 Simulation Result Management
  - 4.6.1 Open_simu_result
  - 4.6.2 Report_simu_result
  - 4.6.3 Open_simu_report
- 4.7 Bistream management
  - 4.7.1 Load_bitstream
5 GUI interface
- 5.1 Main window
  - 5.1.1 Overview
  - 5.1.2 Menu
    - 5.1.2.1 Software Path/Command
    - 5.1.2.2 Info
    - 5.1.2.3 Quit
  - 5.1.3 Test
    - 5.1.3.1 Find Nxmap Function / Nx Component
    - 5.1.3.2 Test Management
  - 5.1.4 Database
    - 5.1.4.1 Open Test Plan
- 5.2 Test management window
  - 5.2.1 Overview
  - 5.2.2 Menu
    - 5.2.2.1 Quit
  - 5.2.3 File
    - 5.2.3.1 Edit Files
  - 5.2.4 Test
    - 5.2.4.1 Launch Test
    - 5.2.4.2 Open Test
    - 5.2.4.3 Open Log
    - 5.2.4.4 Open Rpt
    - 5.2.4.5 Open Timing
    - 5.2.4.6 Open Result
    - 5.2.4.7 Open Report
    - 5.2.4.8 Open Simu Result
    - 5.2.4.9 Open Simu Report
  - 5.2.5 Bitstream
    - 5.2.5.1 Load Bitstream
  - 5.2.6 Database
    - 5.2.6.1 Archive Test

Copyright

All the contents of this document are protected by the copyright law. They may not be disclosed to third parties or copied or duplicated in any form without consent of NanoXplore.

Introduction

Aim of document

This document is intended to guide users on Training_package environment.

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

To be more user friendly, some features are added to the environment as Makefile and GUI.

For any kind of help or error reporting, please contact NanoXplore support team at support@nanoxplore.com.

Package installation

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.

Operation

The environment is based on Makefile use and the GUI is only a graphical interface which sends Makefile targets in the Linux terminal.

It is recommended to check frequently the Linux terminal when using the GUI as some key information can be displayed.

Commands

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

make

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

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”
- sudo apt-get install at-spi-core

Directory content

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

Files

Makefile

This is the Makefile which contains many targets in order to manage every test from the main directory.

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

Test_Plan.csv

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

Category, Test and Argument names.
Compliant variants.
Description and Results.
NxPython function and Nx components.

Training_Gui.py

This is the script to launch in order to open the training GUI.

Training_Transcript.sh

This script is automatically generated when launching Makefile commands through the GUI. It gives the ability to perform the same 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.

The only available parameters to configure are the following:

NXDESIGNSUITE_PATH=[path to nxpython and impulse bin directory]
NXDESIGNSUITE_MODEL_PATH=[path to modelsim/backannoted NX libraries directory]
NXBASE2_PATH=[path to nxbase2_cli directory]
TEXT_EDITOR_CMD=[text editor command to open a text file]
TABLE_EDITOR_CMD=[table editor command to open a csv file]

Directories

Doc

This is where documentation is stored.

Test

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

Then each test directory gets the following files and directories:

nxpython_script.py: script to launch by nxpython nxpython_script.py <options>
project_variables.py: all variables used for the test are defined.
src: all needed RTL sources.
sub_scripts: all needed python files to create the project.
- project_ios.py: defined banks voltages and pads configurations.
- project_files.py: defined RTL files.
- project_parameters.py: defined top generic parameters.
- project_options.py: defined NxPython options.
- project_constraints.py: defined constraints for synthesis or P&R.
- project_class.py: chip class.
- script.py: main script.
[top_cell]_[variant](_[options]): created project once launched.
- LogsPython: all logs and reports.
- *.nym: nxpython project files.
- *.vhd/*.v: netlists.
- *.sdf: Backannoted SDF files.
- Bitstream.nxb: bitstream binary file.

Results

This directory is divided in nxpython directory containing result files from nxpython command and simu directory containing result files from vsim command. A result file contains all printed messages.

All result files are sorted variant by variant.

Reports

This directory is divided in nxpython 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 …

All result files are sorted variant by variant.

Makefile commands

Hereafter, a list of multiple Makefile commands.

All commands must be launched as follows:

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
ARGUMENT		‘’	Argument launched with nxpython script
BACKANNOTED	Yes No	Yes	Simulation run is launched in backannoted mode or not
NETLIST	VHDL Verilog	VHDL	Backannoted simulation is done with VHDL or Verilog netlist
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	REMARK WARNING ERROR	WARNING	Severity in reporting

Information

Info

Command	info
Description	Get information about the version
Parameters
Example

Table: info Makefile command

Test_list

Command	test_list
Description	Get list of tests by category, name and argument
Parameters
Example

Table: test_list Makefile command

Package management

Open_test_plan

Command	open_test_plan
Description	Open Test_Plan.csv
Parameters
Example

Table: open_test_plan Makefile command

Archive_test

Command	archive_test
Description	Create a .zip archive for a test in the parent directory
Parameters	CATEGORY NAME
Example

Table: archive_test Makefile command

Test management

Edit_script_files

Command	edit_script_files
Description	edit all python sub-scripts of a project
Parameters	CATEGORY NAME
Example

Table: edit_script_files Makefile command

Edit_src_files

Command	edit_src_files
Description	edit all RTL sources of a project
Parameters	CATEGORY NAME
Example

Table: edit_src_files Makefile command

Launch_test

Command	launch_test
Description	Launch a test through nxpython
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT)
Example

Table: launch_test Makefile command

Open_test

Command	open_test
Description	Open a test through Impulse
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT) (PROGRESS)
Example

Table: open_test Makefile command

Open_log

Command	open_log
Description	Open all .log files in project log directory
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT)
Example

Table: open_log Makefile command

Open_rpt

Command	open_rpt
Description	Open all .rpt files in project log directory
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT)
Example

Table: open_rpt Makefile command

Open_timing

Command	open_timing
Description	Open all .timing files in project log directory
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT)
Example

Table: open_timing Makefile command

Simulation Management

Run_simu

Command	run_simu
Description	Run a simu through ModelSim
Parameters	CATEGORY NAME (ARGUMENT) (BACKANNOTED) (NETLIST) (VARIANT)
Example

Table: run_simu Makefile command

Open_simu

Command	open_simu
Description	Open a simu through ModelSim
Parameters	CATEGORY NAME (ARGUMENT) (BACKANNOTED) (NETLIST) (VARIANT)
Example

Table: open_simu Makefile command

Result Management

Open_result

Command	open_result
Description	Open result file
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT)
Example

Table: open_result Makefile command

Report_result

Command	report_result
Description	Generate report file from the result file
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT) (SEVERITY)
Example

Table: report_result Makefile command

Open_report

Command	open_report
Description	Open result file
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT)
Example

Table: open_report Makefile command

Simulation Result Management

Open_simu_result

Command	open_simu_result
Description	Open simu result file
Parameters	CATEGORY NAME (ARGUMENT) (BACKANNOTED) (NETLIST) (VARIANT)
Example

Table: open_simu_result Makefile command

Report_simu_result

Command	report_simu_result
Description	Generate simu report file from the result file
Parameters	CATEGORY NAME (ARGUMENT) (BACKANNOTED) (NETLIST) (VARIANT) (SEVERITY)
Example

Table: report_simu_result Makefile command

Open_simu_report

Command	open_simu_report
Description	Open simu report file
Parameters	CATEGORY NAME (ARGUMENT) (BACKANNOTED) (NETLIST) (VARIANT)
Example

Table: open_simu_report Makefile command

Bistream management

Load_bitstream

Command	load_bitstream
Description	Load a bitstream through NxBase2
Parameters	CATEGORY NAME (ARGUMENT) (VARIANT)
Example

Table: load bitstream Makefile command

GUI interface

For each window, all actions are available in the bar menu. Some of them get shortcuts and some of them get quick buttons.

Only these actions will be described in this document as quick buttons do exactly the same action as the associated menu bar action.

Main window

Overview

The Test_Plan.csv file is displayed as a table as a central widget.

Main window overview

Test

Find Nxmap Function / Nx Component

Action	Find
Description	Find a NxPython Function or a Nx Component among all tests.
Shortcut	CTRL+Q
Makefile command

Table: Find NxPython 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

Table: Test Management GUI action

Database

Open Test Plan

Action	Test Management
Description	Open Test_Plan.csv
Shortcut
Makefile command	open_test_plan

Table: Open Test Plan GUI action

Test management window

Overview

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

Test management window overview

File

Edit Files

Action	Open Timing
Description	Open a Notepad editor in order to edit source and script files of the test.
Shortcut
Makefile command

Table: Edit Files GUI action

Test

Launch Test

Action	Launch Test
Description	Launch a test through nxpython.
Shortcut	CTRL+L
Makefile command	launch_test

Table: Launch Test GUI action

Open Test

Action	Launch Test
Description	Open a test through Impulse.
Shortcut	CTRL+O
Makefile command

Table: Open Test GUI action

Open Log

Action	Open Log
Description	Open .log files in project log directory.
Shortcut
Makefile command

Table: Open Log GUI action

Open Rpt

Action	Open Rpt
Description	Open .rpt files in project log directory.
Shortcut
Makefile command

Table: Open Rpt GUI action

Open Timing

Action	Open Timing
Description	Open .timing files in project log directory.
Shortcut
Makefile command

Table: Open Timing GUI action

Open Result

Action	Open Result
Description	Open the result file of the test.
Shortcut
Makefile command

Table: Open Result GUI action

Open Report

Action	Open Report
Description	Open the report file of the test.
Shortcut
Makefile command

Table: Open Report GUI action

Open Simu Result

Action	Open Simu Result
Description	Open the result simu file of the test.
Shortcut
Makefile command

Table: Open Result GUI action

Open Simu Report

Action	Open Report
Description	Open the report simu file of the test.
Shortcut
Makefile command

Table: Open Report GUI action

Bitstream

Load Bitstream

Action	Archive Test
Description	Load a bitstream through NxBase2
Shortcut
Makefile command

Table: Load Bitstream GUI action

Database

Archive Test

Action	Archive Test
Description	Create a .zip archive of the test in the parent directory.
Shortcut
Makefile command

Table: Archive Test GUI action

Action	Software Path/Command
Description	Change the NxDesignSuite path, NxBase2 path, text editor command or table editor command.
Shortcut
Makefile command

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

Impulse Training Package User Manual

Copyright

Introduction

Aim of document

Package installation

Operation

Commands

System errors

Directory content

Files

Makefile

Test_Plan.csv

Training_Gui.py

Training_Transcript.sh

Path.mk

Directories

Doc

Test

Results

Reports

Makefile commands

Information

Info

Test_list

Package management

Open_test_plan

Archive_test

Test management

Edit_script_files

Edit_src_files

Launch_test

Open_test

Open_log

Open_rpt

Open_timing

Simulation Management

Run_simu

Open_simu

Result Management

Open_result

Report_result

Open_report

Simulation Result Management

Open_simu_result

Report_simu_result

Open_simu_report

Bistream management

Load_bitstream

GUI interface

Main window

Overview

Menu

Software Path/Command

Info

Quit

Test

Find Nxmap Function / Nx Component

Test Management

Database

Open Test Plan

Test management window

Overview

Menu

Quit

File

Edit Files

Test

Launch Test

Open Test

Open Log

Open Rpt

Open Timing

Open Result

Open Report

Open Simu Result

Open Simu Report

Bitstream

Load Bitstream

Database

Archive Test