Welcome to nx_embedded_tools’s 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
    • Configuration:
  • Openocd
  • Lauterbach
  • Switching between Lauterbach and openocd
  • Additionnal configuration
    • Start OpenOCD:
  • Board connection:
  • Board configuration (Bring-up only):
  • Start OpenOCD
    • Known issues
  • OpenOCD errors
  • OpenOCD and EL1 execution
  • Multiple ELF file load with OpenOCD when instruction cache is activated
  • Using Angie probe may be very slow
• Using scripts
  • Using ngultra_init.py
  • 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
  • SpaceWire BL1 (Boot Loader level 1)
    • Validate the configuration file
    • Using ngultra_bl1_programmer.py
      • Loading one bitstream and one application
      • Loading one bitstream and several applications
  • Clock generator configuration Guide:
  • GPIO extender configuration Guide:
    • Example:
  • I2C Library Guide
    • Definition:
    • Example:
  • Devkit jumpers configuration Guide:
    • Set jumper values:
    • Get jumper values:
      • Warning: Get operation works only if a set has been done before.
  • Using ngultra_eram_scrubber.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
          • toT32CoprocEncoding()
        • 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
      • libnxembeddedtools.ul_dv package
        • Submodules
        • libnxembeddedtools.ul_dv.io_extender module
          • IO_EXTENDER
          • PCA9554
        • libnxembeddedtools.ul_dv.program_angie module
          • ProgramAngie
        • libnxembeddedtools.ul_dv.si5351c module
          • SI5351C
        • libnxembeddedtools.ul_dv.ul_dv module
          • NgULTRADevKit
        • Module contents
    • Module contents