MCUXpresso SDK API Reference Manual
Rev. 0
NXP Semiconductors
|
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 SDK is built with the following runtime software components:
Stacks and middleware in source or object formats including:
All demo applications and driver examples are provided with projects for the following toolchains:
The peripheral drivers and RTOS driver wrappers 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 SDK and need not be modified by the user. If necessary, the user is able to modify the peripheral driver and RTOS wrapper 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.
Deliverable | Location |
---|---|
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>/<device_name>/drivers/ |
CMSIS Standard Arm Cortex-M Headers, math and DSP Libraries | <install_dir>/CMSIS |
Device Startup and Linker | <install_dir>/<device_name>/<toolchain>/ |
MCUXpresso SDK Utilities | <install_dir>/devices/<device_name>/utilities |
RTOS Kernel Code | <install_dir>/rtos |
The rest of this document describes the API references in detail for the peripheral drivers and RTOS wrapper drivers. For the latest version of this and other MCUXpresso SDK documents, see the mcuxpresso.nxp.com/apidoc/.