MCUXpresso SDK Documentation

Version: 26.09.00 26.06.00-lts 26.03.00 25.12.00 latest

Open on Repo Open an Issue

Source (.md/.rst) Page PDF (.pdf)

Getting Started with Repository-Layout SDK Package

Starting with version 25.09.00, MCUXpresso SDK introduced the Repository-Layout SDK Package for offline development:

• Repository-Layout SDK Package: A board-specific package that preserves the same structure and build system as the GitHub Repository SDK and provides offline access to the Repository SDK development experience. This package is available when you select the ARMGCC toolchain.

Starting with version 25.12.00, the SDK Builder downloads the Repository-Layout SDK Package by default when you select ARMGCC.

Note: MCUXpresso SDK first introduced the Repository-Layout SDK Package in version 25.09.00, but only for MCXW23x platforms.

Table of Contents

• Development Tools Installation
  • Quick Start: Automated Installation (Recommended)
  • Manual Installation
    • Essential Tools
      • Git - Version Control
      • Python - Scripting Environment
      • West - SDK Management Tool
    • Build System Tools
      • CMake - Build Configuration
      • Ninja - Fast Build System
      • Ruby - IDE Project Generation (Optional)
    • Compiler Toolchains
      • Setting Up Environment Variables
  • Verify Your Installation
    • Troubleshooting Installation Issues
• Workspace Structure
  • Top-Level Organization
  • SDK Component Layout
  • Example Organization
    • Common Example Files
    • Board-Specific Files
  • Device Support Structure
  • Middleware Organization
  • Documentation Structure
  • Understanding Example Structure
    • 1. General README: examples/demo_apps/hello_world/readme.md
    • 2. Board-Specific README: examples/_boards/{board_name}/demo_apps/hello_world/example_board_readme.md
• Building Your First Project
  • Prerequisites
  • Understanding Board Support
  • Basic Build Process
    • Simple Build
    • Specifying Configuration
    • Alternative Toolchains
  • Multicore Applications
  • Flash an Application
  • Debug
  • Common Build Options
    • Clean Build
    • Dry Run
    • Device Variants
  • Project Configuration
    • CMake Configuration Only
    • Interactive Configuration
  • Troubleshooting
    • Build Failures
    • Getting Help
    • Check Supported Configurations
  • Next Steps
• Run a Demo Using IAR
  • Prerequisite: Ruby
  • 1. Generate the IAR project
    • Generate into a custom folder
  • 2. Open the project in IAR Embedded Workbench
  • 3. Build the demo application
  • 4. Run the demo application
  • Next steps
• MCUXpresso for VS Code Development
  • Prerequisites
  • Extension Installation
    • Install MCUXpresso for VS Code
  • SDK Import and Setup
    • Import Methods
    • Import GitHub Repository SDK
    • Import Repository-Layout SDK Package
  • Building Example Applications
    • Import Example Project
    • Application Types
    • Trust Confirmation
  • Building Projects
    • Build Process
  • Running and Debugging
    • Serial Monitor Setup
    • Debug Session
    • Debug Controls
    • Monitor Output
  • Debug Probe Support
  • Project Configuration
    • Workspace Management
    • Multi-Project Support
  • Troubleshooting
    • Import Issues
    • Build Problems
    • Debug Issues
  • Integration with Command Line
  • Advanced Features
    • Project Types
    • Build System Integration
  • Next Steps
• How to determine COM Port
• How to set the board to the Bootloader ISP mode
• Updating debugger firmware
• Updating NBU for Wireless Examples