Getting Started with ModusToolbox™

This section provides various documents and links to help get you started working with ModusToolbox™ software.

• ModusToolbox™ tools package release notes
  • 1 Primary changes
    • 1.1 Multi-core platform support
      • 1.1.1 Multi-core application development
      • 1.1.2 Multi-core device configuration
      • 1.1.3 BSP development flows and tools
      • 1.1.4 PSoC™ 6 ETM support in µVision and EW-ARM
    • 1.2 Core build infrastructure
    • 1.3 Infineon Developer Center
    • 1.4 ModusToolbox™ packs
    • 1.5 Reset button in VS Code
    • 1.6 Support for new operating systems
  • 2 What’s included
    • 2.1 Supported tool chains
    • 2.2 Supported boards
    • 2.3 Open source
  • 3 Design impact
    • 3.1 Limited 3.x code examples
    • 3.2 Migrating ModusToolbox™ applications from version 2.x to version 3.x
    • 3.3 Legacy dual-core and multi-project applications not supported
    • 3.4 No arguments for make getlibs target
    • 3.5 ModusToolbox™ version 2.1 “LIB” flow no longer supported
    • 3.6 Issue with setting CY_BUILD_LOCATION variable
    • 3.7 .cyignore files not detected
  • 4 Known issues/limitations
    • 4.1 ModusToolbox™ issues from previous releases
    • 4.2 Proxy
    • 4.3 Eclipse IDE
    • 4.4 Visual Studio Code
    • 4.5 Library Manager/make getlibs
    • 4.6 CySecureTools
    • 4.7 Building/programming/debugging
    • 4.8 BSP Assistant
    • 4.9 Device Configurator
    • 4.10 CAPSENSE™ Tuner
    • 4.11 Documentation
• ModusToolbox™ tools package installation guide
  • About this document
  • 1 General information
    • 1.1 System requirements
    • 1.2 Uninstall Beta versions
  • 2 Step 1: Download the software
    • 2.1 Prerequisites
    • 2.2 SEGGER J-Link
  • 3 Step 2: Install ModusToolbox™ software
    • 3.1 Installing in non-default location
    • 3.2 Installing with previous versions
    • 3.3 Windows
    • 3.4 Linux
    • 3.5 macOS
  • 4 Step 3: Run the Eclipse IDE
  • 5 Default versus advanced Windows installation
  • 6 Installing with spaces in user home directory
    • 6.1 Step 1: Install at a custom path.
    • 6.2 Step 2: Create a variable to specify the path to Tools.
    • 6.3 Step 3: Create a variable to specify the path to cache.
    • 6.4 Step 4: Create a variable to specify the global path.
    • 6.5 Step 5: Specify the custom path to use for offline content and manifest.loc.
      • 6.5.1 Offline content path
      • 6.5.2 manifest.loc
  • Revision history
• ModusToolbox™ tools package user guide
  • About this document
    • Scope and purpose
    • Intended audience
    • Document conventions
  • 1 Introduction
    • 1.1 What is ModusToolbox™ software?
    • 1.2 Run-time software
      • 1.2.1 Code examples
      • 1.2.2 Libraries (middleware)
        • 1.2.2.1 Common library types:
        • 1.2.2.2 AIROC™ Bluetooth® Libraries:
        • 1.2.2.3 BSP-specific base libraries:
        • 1.2.2.4 PSoC™ 6 additional libraries:
      • 1.2.3 BSPs
        • 1.2.3.1 Supported devices
        • 1.2.3.2 BSP releases
    • 1.3 Development tools
      • 1.3.1 Directory structure
      • 1.3.2 Documentation
        • 1.3.2.1 Release notes
        • 1.3.2.2 Top-level documents
        • 1.3.2.3 Document index page
      • 1.3.3 IDE support
      • 1.3.4 Tools
        • 1.3.4.1 Configurators
        • 1.3.4.2 Other tools
        • 1.3.4.3 Utilities
        • 1.3.4.4 Build system infrastructure
        • 1.3.4.5 Program and debug support
    • 1.4 Product versioning
      • 1.4.1 General philosophy
      • 1.4.2 Tools package versioning
      • 1.4.3 Multiple tools versions installed
      • 1.4.4 Specifying alternate tools version
        • 1.4.4.1 Environment variable
        • 1.4.4.2 Specific project Makefile
      • 1.4.5 Tools and configurators versioning
        • 1.4.5.1 Configurator messages
      • 1.4.6 GitHub libraries versioning
      • 1.4.7 Dependencies between libraries
        • 1.4.7.1 Git repo dependencies via .mtb files
        • 1.4.7.2 Regular C dependencies via #include
    • 1.5 Partner ecosystems
  • 2 Getting started
    • 2.1 Install and configure software
      • 2.1.1 GUI set-up instructions
      • 2.1.2 CLI set-up instructions
    • 2.2 Open help documentation
      • 2.2.1 GUI documentation
        • 2.2.1.1 Eclipse IDE
        • 2.2.1.2 Other IDEs
        • 2.2.1.3 Configurator and tool guides
      • 2.2.2 CLI documentation
    • 2.3 Create application from template
      • 2.3.1 Project Creator GUI
      • 2.3.2 project-creator-cli
    • 2.4 Understand application structures
      • 2.4.1 Version 2.x BSPs/applications versus 3.x BSPs/applications
      • 2.4.2 Single-core 3.x application
      • 2.4.3 Multi-core 3.x application
        • 2.4.3.1 Multi-core application directory
        • 2.4.3.2 Multi-core project directories
      • Getting started
      • 2.4.4 mtb_shared directory
    • 2.5 Build and program
      • 2.5.1 Use Eclipse ID
      • 2.5.2 Export to another IDE
      • 2.5.3 Use command line
        • 2.5.3.1 make build
        • 2.5.3.2 make program
  • 3 Updating the example application
    • 3.1 Update libraries
    • 3.2 Update BSPs
    • 3.3 Configure settings for devices, peripherals, and libraries
      • 3.3.1 Configurator GUI tools
      • 3.3.2 Configurator CLI tools
    • 3.4 Write application code
      • 3.4.1 Application layers
        • 3.4.1.1 HAL
        • 3.4.1.2 PDL
        • 3.4.1.3 Configurators
    • 3.5 Debug the application
      • 3.5.1 Use Eclipse IDE
      • 3.5.2 Export to another IDE
      • 3.5.3 Use command line
  • 4 ModusToolbox™ build system
    • 4.1 Overview
    • 4.2 make help
    • 4.3 make getlibs
      • 4.3.1 repos
    • 4.4 BSPs
    • 4.5 Environment variables
    • 4.6 Adding source files
      • 4.6.1 Auto-discovery
        • 4.6.1.1 .cyignore
        • 4.6.1.2 TOOLCHAIN_<NAME>
        • 4.6.1.3 TARGET_<NAME>
        • 4.6.1.4 CONFIG_<NAME>
        • 4.6.1.5 COMPONENT_<NAME>
        • 4.6.1.6 BSP makefile
    • 4.7 Pre-builds and post-builds
    • 4.8 Available make targets
      • 4.8.1 General make targets
      • 4.8.3 Tools targets
      • 4.8.4 Utility make targets
    • 4.9 Available make variables
      • 4.9.1 Basic configuration make variables
      • 4.9.2 Advanced configuration make variables
      • 4.9.3 Getlibs make variables
      • 4.9.4 Path make variables
      • 4.9.5 Miscellaneous make variables
  • 5 Board support packages
    • 5.1 Overview
    • 5.2 What’s in a BSP
      • 5.2.1 TARGET
      • 5.2.2 config
      • 5.2.3 COMPONENT
      • 5.2.4 TOOLCHAIN
      • 5.2.5 deps subdirectory
      • 5.2.6 docs subdirectory
      • 5.2.7 Support files
      • 5.2.8 bsp.mk
      • 5.2.9 README/RELEASE.md
      • 5.2.10 BTSDK-specific BSP files
    • 5.3 Creating your own BSP
  • 6 Manifest files
    • 6.1 Overview
    • 6.2 Create your own manifest
      • 6.2.1 Supplementing super-manifest using manifest.loc
      • 6.2.2 Replacing standard super-manifest using variable
      • 6.2.3 Processing
      • 6.2.4 Conflicting data
    • 6.3 Using offline content
    • 6.4 Access private repositories
  • 7 Using applications with third-party tools
    • 7.1 Version Control and sharing applications
      • 7.1.1 Files to include/exclude
      • 7.1.2 Using version control software
      • 7.1.3 Manual file copy
      • 7.1.4 Saving/exporting from IDE
    • 7.2 Import to Eclipse
    • 7.3 Exporting to supported IDEs
      • 7.3.1 Overview
      • 7.3.2 Export to VS Code
        • 7.3.2.1 Prerequisites
        • 7.3.2.2 Process example
        • 7.3.2.3 To debug using KitProg3/MiniProg4
        • 7.3.2.4 To debug using J-Link
      • 7.3.3 Export IAR EWARM (Windows only)
        • 7.3.3.1 Prerequisites
        • 7.3.3.2 Process example
        • 7.3.3.3 XMC7000 and TRAVEO™ II specific steps
        • 7.3.3.4 To use KitProg3/MiniProg4
        • 7.3.3.5 To use MiniProg4 with PSoC™ 6 single core and PSoC™ 6 256K
        • 7.3.3.6 To use J-Link
      • 7.3.4 Export to Keil µVision 5 (Windows only)
        • 7.3.4.1 Prerequisites
        • 7.3.4.2 Process example
        • 7.3.4.3 To use KitProg3/MiniProg4, CMSIS-DAP, and ULink2 debuggers
        • 7.3.4.4 To use J-Link debugger with PSoC™ MCUs
        • 7.3.4.5 To use J-Link debugger with XMC7000 devices
        • 7.3.4.6 Program external memory
        • 7.3.4.7 Erase external memory
    • 7.4 Multi-core debugging
      • 7.4.1 Timing
      • 7.4.2 CM0+ core rule
      • 7.4.3 Eclipse IDE for ModusToolbox™
      • 7.4.4 VS Code
      • 7.4.5 IAR Embedded Workbench for Arm
        • 7.4.5.1 Supported debugger probes
        • 7.4.5.2 Create IAR workspace and projects
        • 7.4.5.3 Customizing linker scripts
        • 7.4.5.4 Configuring IAR projects
      • Project configuration for CM4/CM7 (slave) core(s)
      • 7.4.6 Keil µVision
        • 7.4.6.2 Opening µVision multi-core projects
        • 7.4.6.3 Customizing linker scripts
        • 7.4.6.4 Debugger configuration
        • 7.4.6.5 Launching multi-core debug session
    • 7.5 Patched flashloaders for AIROC™ CYW208xx devices
    • 7.6 Generating files for XMC™ Simulator tool
    • Revision history
• Eclipse IDE for ModusToolbox™
  • Eclipse IDE for ModusToolbox™ Quick Start Guide
    • 1. Download/Install/Run Eclipse IDE
    • 2. Create new application
      • 2.1 Step 1: Open Project Creator tool
      • 2.2 Step 2: Choose Board Support Package (BSP)
      • 2.3 Step 3: Select application
      • 2.4 Step 4: Create application
    • 3. Add/modify application code
    • 4. View device resources
    • 5. Build the Application
    • 6. Program the Device
      • 6.1 Connect the Kit
      • 6.2 Program
    • 7. Debug the program
  • Eclipse IDE for ModusToolbox™ user guide
    • 1 Getting started
      • 1.1 Launch Eclipse IDE
      • 1.2 Open Project Creator tool
      • 1.3 Create an application
        • 1.3.1 Choose board support package
        • 1.3.2. Select application
        • 1.3.3 Project Creator Browse option
        • 1.3.4 Create application
      • 1.4 Build application
      • 1.5 Program application
      • 1.6 Export/share application
      • 1.7 Import application/code example
      • 1.8 Search online for code examples
      • 1.9 Search online for libraries/BSPs
      • 1.10 Access training material
    • 2 IDE description
      • 2.1 Project Explorer
      • 2.2 Quick Panel
    • 3 Configure applications
      • 3.1 Modify code
      • 3.2 Use configurators
        • 3.2.1 Launching configurators from the IDE
        • 3.2.2 Launching configurators without the IDE
      • 3.3 Use tools
        • 3.3.1 Launching tools from the IDE
        • 3.3.2 Library Manager
        • 3.3.3 BTSpy and ClientControl
        • 3.3.4 DFU Host tool
      • 3.4 Use integrated terminal
        • 3.4.1 Switch projects
        • 3.4.2 Specify alternate shell
        • 3.4.3 Update local terminal settings
        • 3.4.4 Connect to remote machine/board
      • 3.5 Refresh Quick Panel
      • 3.6 Rename application
        • 3.6.1 Single-core application
      • 3.7 Restore shared directory
    • 4 Build applications
      • 4.1 Build with Make
      • 4.2 Build with IDE
      • 4.3 GCC version
    • 5 Program and debug
      • 5.1 PSoC™ MCU programming/debugging
        • 5.1.1 Launch configurations
        • 5.1.2 Using JTAG interface in MiniProg4
        • 5.1.3 Erasing external memory
        • 5.1.4 Programming eFuse
        • 5.1.5 Debug connection options
        • 5.1.6 Select specific CMSIS-DAP device
          • 5.1.6.1 Selecting by VID and PID
          • 5.1.6.2 Selecting by serial number
          • 5.1.6.3 Selecting by both VID/PID and serial number
        • 5.1.7 Select Specific J-Link Device
        • 5.1.8 KitProg Firmware Loader
        • 5.1.9 Power cycle programming mode with KitProg3_MiniProg4
        • 5.1.10 PSoC™ 4 flash security programming
      • 5.2 AIROC™ Bluetooth® programming/debugging
        • 5.2.1 Program configuration
        • 5.2.2 Attach configurations
        • 5.2.3 Debug settings
    • Revision history
  • Eclipse IDE Survival Guide
• ModusToolbox™ Training material