Tools Guide

The XTC Tools are required to develop and deploy an application on an XCore processor.

The command line interface to the tools is used in the examples that follow. These tools may also be integrated with your preferred IDE.

Support

For all support relating to the XTC Tools, raise a ticket. Be sure to supply the XTC Tools version within your ticket.

---

Full table of contents

• Installation and configuration
  • System requirements
  • Installation instructions
    • Download the tools
    • Install the tools
    • Check your installation
    • Configure the XTAG USB drivers
    • Check XTAG access
  • Configuring the command-line environment
    • Configure the environment
    • Quick check the environment
    • Query the XTC Tools version
  • Configuring an IDE
    • Configuration common to all IDEs
    • Visual Studio Code
    • Eclipse
    • xTIMEcomposer Studio
  • Transitioning from older tools releases
    • Programming language
    • Graphical IDE
    • Migrating existing projects
• Quick start
  • A single-tile program
    • Build an executable
    • Running the program on the simulator
    • Run on real hardware
    • Summary
  • Targeting multiple tiles
    • Providing a multi-tile file
    • Summary
  • Communicating between tiles
    • Declaring a channel in the multi-tile file
    • Using the channel
    • Summary
  • Using XSCOPE for fast “printf debugging”
    • Configuring and using XSCOPE
    • Using XSCOPE “probes”
    • Summary
  • Debugging with XGDB
    • Create example
    • Interactive debugging
    • Scripted debugging
    • Summary
• Advanced tutorials
  • Describe a target platform
    • Supported network topologies
    • A board with two packages
  • Working with targets
    • Terminology
    • Introduction
    • Key features
    • xTAG
    • Host tools
    • Target interaction
    • Host-IO
    • Xscope APIs
    • User-supplied host program
    • Host/target data throughput
    • Sample-based profiling of the target program
    • Target errors and warnings
    • Command examples
  • Design and manufacture systems with flash memory
    • Boot a program from flash memory
    • Generate a flash image for manufacture
    • Perform an in-field upgrade
    • Customize the flash loader
    • Reading the numerical and string identifiers in a flash image
  • Safeguard IP and device authenticity
    • The xCORE AES module
    • Develop with the AES module enabled
    • Production flash programming flow
    • Production OTP programming flow
    • Security implications of application design
  • Add support for a new flash device
    • Libflash Device ID
    • Page Size and Number of Pages
    • Address Size
    • Clock Rate
    • Read Device ID
    • Sector Erase
    • Write Enable/Disable
    • Memory Protection
    • Programming Command
    • Read Data
    • Sector Information
    • Status Register Bits
    • Quad Enable Bit
    • SFDP
    • Select a Flash Device
  • Using LPDDR
    • Accessing LPDDR in an application
    • Compiling for external memory (LPDDR) and software-defined memory
    • Hardware setup
    • Level 1 cache
  • Using software-defined memory
    • Level 1 cache
    • Application implementation
    • XTC Tools built-in support for flash storage
    • Compiling for software-defined memory
    • Examples
    • Using xrun and xgdb
  • How to use arguments and return codes
  • Using XSIM
    • Which tile is my code running on?
    • Using XScope during simulation
  • Understanding XE files and how they are loaded
    • Prepare an XE file
    • Examine the XE file
    • Load and execute the XE file
• Reference
  • Command line tools
    • XRUN
    • XSIM
    • XCC
    • XOBJDUMP
    • XGDB
    • XFLASH
    • XBURN
    • XMAKE
  • File formats and data descriptions
    • XMOS executable (XE) file format
    • XN Specification
    • XSIM Trace output
    • XSCOPE config file
  • xSCOPE performance figures
    • Transfer rates between the xCORE Tile and XTAG-3 or XTAG-4
    • Transfer rates between the XTAG-3 or XTAG-4 and Host PC
  • Libraries
    • lib_xcore
    • lib_xs1
    • libflash API
    • libquadflash API
    • List of devices natively supported by libflash
    • List of devices natively supported by libquadflash
  • XCOMMON build system
    • Using the XCOMMON build system
    • Using XMOS Makefiles to create binary libraries