MCUXpresso SDK API Reference Manual  Rev. 0
NXP Semiconductors
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Introduction

The MCUXpresso Software Development Kit (MCUXpresso SDK) is a collection of software enablement for NXP Microcontrollers that includes peripheral drivers, multicore support and integrated RTOS support for FreeRTOSTM. In addition to the base enablement, the MCUXpresso SDK is augmented with demo applications, driver example projects, and API documentation to help users quickly leverage the support provided by MCUXpresso SDK. The MCUXpresso SDK Web Builder is available to provide access to all MCUXpresso SDK packages. See the MCUXpresso Software Development Kit (SDK) Release Notes (document MCUXSDKRN) in the Supported Devices section at MCUXpresso-SDK: Software Development Kit for MCUXpresso for details.

The MCUXpresso DSC SDK is variant of MCUXpresso SDK, built with the following runtime software components:

  • Device header files which provide direct access to the peripheral registers.
  • Peripheral drivers that provide stateless, high-performance, ease-of-use APIs. Communication drivers provide higher-level transactional APIs for a higher-performance option.
  • Stacks and middleware in source or object formats including:
    • Freemaster, a user-friendly real-time debug monitor and data visualization tool.
    • RTCESL: Real Time Control Embedded Software Motor Control and Power Conversion Libraries.
    • USB: USB slave stack if applicable.
  • The MCUXpresso DSC SDK comes complete with software examples demonstrating the usage of the peripheral drivers and middleware.

All demo applications and driver examples are provided with projects for the following toolchains:

  • CodeWarrior for MCUs (Eclipse IDE)

The peripheral drivers can be used across multiple devices within the product family without modification. The configuration items for each driver are encapsulated into C language data structures. Device-specific configuration information is provided as part of the MCUXpresso DSC SDK and should not be modified by the user. If necessary, the user could modify the peripheral driver configuration during runtime. The driver examples demonstrate how to configure the drivers by passing the proper configuration data to the APIs. The folder structure is organized to reduce the total number of includes required to compile a project.

MCUXpresso DSC SDK Folder Structure
DeliverableLocation
Demo Applications<install_dir>/boards/<board_name>/demo_apps
Driver Examples<install_dir>/boards/<board_name>/driver_examples
Documentation<install_dir>/docs
Middleware<install_dir>/middleware
Drivers<install_dir>/devices/<device_name>/drivers/
Device Startup and Linker<install_dir>/devices/<device_name>/<toolchain>/
MCUXpresso SDK Utilities<install_dir>/devices/<device_name>/utilities

The rest of this document describes the API references in detail for the peripheral drivers. For the latest version of this and other MCUXpresso SDK documents, see the mcuxpresso.nxp.com/apidoc/.