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 Nxmap 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 nxmap, 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.

• Nxmap 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:

• NXMAP_PATH=[path to nxpython and nxmap3 bin 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:

• nxmap_script.py: script to launch by nxpython nxmap_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 Nxmap 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.

  • Rtl: all projects savings progress by progress.

  • *.nym: nxmap project files.

  • *.vhd: netlists.

  • Bitstream.nxb: bitstream binary file.

Results

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

All result files are sorted variant by variant.

Makefile commands

Hereafter, a list of multiple Makefile commands.

All commands must be launched as follows:

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:

Information

Info

make info

Table: info Makefile command

Test_list

make test_list

Table: test_list Makefile command

Package management

Open_test_plan

make open_test_plan

Table: open_test_plan Makefile command

Archive_test

make archive_test CATEGORY=ClockConstraint NAME=GeneratedClock

Table: archive_test Makefile command

Test management

Edit_script_files

make edit_script_files CATEGORY=ClockConstraint NAME=GeneratedClock

Table: edit_script_files Makefile command

Edit_src_files

make edit_src_files CATEGORY=ClockConstraint NAME=GeneratedClock

Table: edit_src_files Makefile command

Launch_test

make launch_test CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: launch_test Makefile command

Open_test

make open_test CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE PROGRESS=placed

Table: open_test Makefile command

Open_log

make open_log CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: open_log Makefile command

Open_rpt

make open_rpt CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: open_rpt Makefile command

Open_timing

make open_timing CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: open_timing Makefile command

Simulation Management

Run_simu

make run_simu CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: run_simu Makefile command

Open_simu

make open_simu CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE PROGRESS=placed

Table: open_simu Makefile command

Result Management

Open_result

make open_result CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: open_result Makefile command

Report_result

make report_result CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE SEVERITY=ERROR

Table: report_result Makefile command

Open_report

make open_report CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: open_report Makefile command

Simulation Result Management

Open_simu_result

make open_simu_result CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: open_simu_result Makefile command

Report_simu_result

make report_simu_result CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE SEVERITY=ERROR

Table: report_simu_result Makefile command

Open_simu_report

make open_simu_report CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

Table: open_simu_report Makefile command

Bistream management

Load_bitstream

make load_bitstream CATEGORY=ClockConstraint NAME=GeneratedClock ARGUMENT=ClockConstraint VARIANT=LARGE

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.

Menu

Software Path/Command

Table: Table Editor GUI action

Info

Table: Info GUI action

Quit

Table: Quit GUI action

Test

Find Nxmap Function / Nx Component

Table: Find Nxmap Function / Nx Component GUI action

Test Management

Table: Test Management GUI action

Database

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.

Menu

Quit

Table: Quit GUI action

File

Edit Files

Table: Edit Files GUI action

Test

Launch Test

Table: Launch Test GUI action

Open Test

open_test

Table: Open Test GUI action

Open Log

open_log

Table: Open Log GUI action

Open Rpt

open_rpt

Table: Open Rpt GUI action

Open Timing

open_timing

Table: Open Timing GUI action

Open Result

open_result

Table: Open Result GUI action

Open Report

open_report

Table: Open Report GUI action

Open Simu Result

open_simu_result

Table: Open Result GUI action

Open Simu Report

open_simu_report

Table: Open Report GUI action

Bitstream

Load Bitstream

load _bitstream

Table: Load Bitstream GUI action

Database

Archive Test

archive_test

Table: Archive Test GUI action