Welcome to nx_embedded_tools’s v2.1.2 documentation!

nx_embedded_tools is a toolsuite written in python3 that allow user to control the NGUltra chip.

At this time, the following peripheral are supported:

It also provides a bunch of helper:

nx_embedded_tools relies on two JTAG tools (only one is required):

• Lauterbach Trace32;

• openocd (provided as external package).

Setup instructions could be found here.

openocd could be used to debug program using GDB.

Contents:

• Environment setup
  • Minimal python version
  • For openocd
    • Install dependencies (if necessary)
    • udev rules for ftdi cable
  • For Lauterbach
  • Additionnal configuration
  • Start openocd for ngultra
    • Connect your board using the LA-3722 adapter (Bring UP)
    • Connection on development kit
    • Configure your board using nxbase2
      • Reboot your board on SPACEWIRE
    • Start openocd (Only needed if not working with Lauterbach probe)
  • Switching between Lauterbach and openocd
• Using scripts
  • Initialize the platform (including DDR) (Only compatible with NGUltra-v2 in NanoXplore devkit board)
  • Using ngultra_flash_programmer.py
    • Erase flash
      • Erase full flash (slow)
      • Erase flash (256KB) sectors
    • Write data to flash to a specific address
    • Dump data from flash from a specific address for a specific size
    • Write a BL1 into flash
    • Using fast commands
      • Write data to flash to a specific address using fast_write
      • Dump data from flash from a specific address for a specific size using fast_read
  • Using ngultra_memory_programmer.py
    • Write a file into memory
    • Dump memory into a file into memory
    • Read a single 32bits register
    • Writing a single 32bits register
    • Choosing the accessor for the memory access
  • Using ngultra_software_reboot.py
    • Perform a Power On Reset
    • Perform a System Reset
    • Perform a Post Mortem Reset
  • Using signer.py
    • Generate your key
    • Sign a binary for Flash
    • Sign a binary for SpaceWire
  • Using ngultra_bsm_loader.py
    • Programming the FPGA
  • Flash BL1
    • Validate the configuration file
    • Using ngultra_bsp_demo_programmer.py
    • Using ngultra_bl1_programmer.py
  • Using ngultra_read_sensor.py
• Using GDB
  • Activate GDB server for all cores
  • Start GDB on your PC
  • Using GDB
    • Getting GDB
    • Example1 : Load an ELF file and execute it on core0
• libnxembeddedtools
  • libnxembeddedtools package
    • Subpackages
      • libnxembeddedtools.hw package
        • Submodules
        • libnxembeddedtools.hw.reboot module
          • Reboot
        • libnxembeddedtools.hw.sonoff_powr2 module
          • off()
          • on()
          • toggle()
        • Module contents
      • libnxembeddedtools.ngultra package
        • Submodules
        • libnxembeddedtools.ngultra.address module
          • NGUltraAddress
        • libnxembeddedtools.ngultra.bl1 module
          • DescriptorGenerator
        • libnxembeddedtools.ngultra.bsm module
          • Loader
        • libnxembeddedtools.ngultra.fastcommands module
          • FastCommands
        • libnxembeddedtools.ngultra.flash module
          • Controller
        • libnxembeddedtools.ngultra.memory module
          • Memory
        • libnxembeddedtools.ngultra.reset module
          • Reset
        • Module contents
      • libnxembeddedtools.remoteapi package
        • Subpackages
          • libnxembeddedtools.remoteapi.runner package
        • Submodules
        • libnxembeddedtools.remoteapi.abstract module
          • IfaceName
          • Interface
          • MemoryType
          • getIfaceName()
        • libnxembeddedtools.remoteapi.factory module
          • get()
        • libnxembeddedtools.remoteapi.lauterbach module
          • Interface
        • libnxembeddedtools.remoteapi.openocd module
          • Interface
        • Module contents
      • libnxembeddedtools.tools package
        • Submodules
        • libnxembeddedtools.tools.elflib module
          • ELFLib
        • libnxembeddedtools.tools.gcov module
          • GCDAExtractor
        • libnxembeddedtools.tools.signer module
          • Signer
        • Module contents
    • Module contents