Kinetis SDK v.2.0 API Reference Manual
Rev. 0
NXP Semiconductors
|
The Kinetis Software Development Kit (KSDK) 2.0 is a collection of software enablement, for NXP Kinetis Microcontrollers, that includes peripheral drivers, high-level stacks including USB and lwIP, integration with WolfSSL and mbed TLS cryptography libraries, other middleware packages (multicore support and FatFS), and integrated RTOS support for FreeRTOS, µC/OS-II, and µC/OS-III. In addition to the base enablement, the KSDK is augmented with demo applications, driver example projects, and API documentation to help users quickly leverage the support of the Kinetis SDK. The Kinetis Expert (KEx) Web UI is available to provide access to all Kinetis SDK packages. See the Kinetis SDK v.2.0.0 Release Notes (document KSDK200RN) and the supported Devices section at www.nxp.com/ksdk for details.
The Kinetis 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 Kinetis product family without modification. The configuration items for each driver are encapsulated into C language data structures. Kinetis device-specific configuration information is provided as part of the KSDK 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 Kinetis SDK folder structure is organized to reduce the total number of includes required to compile a project.
Deliverable | Location |
---|---|
Examples | <install_dir>/examples/ |
Demo Applications | <install_dir>/examples/<board_name>/demo_apps/ |
Driver Examples | <install_dir>/examples/<board_name>/driver_examples/ |
Documentation | <install_dir>/docs/ |
USB Documentation | <install_dir>/docs/usb/ |
lwIP Documentation | <install_dir>/docs/tcpip/lwip/ |
Middleware | <install_dir>/middleware/ |
DMA Manager | <install_dir>/dma_manager_<version>/ |
FatFs | <install_dir>/middleware/fatfs_<version> |
lwIP TCP/IP | <install_dir>/middleware/lwip_<version>/ |
mmCAU | <install_dir>/mmcau_<version>/ |
SDMMC Support | <install_dir>/sdmmc_<version>/ |
USB Stack | <install_dir>/middleware/usb_<version> |
Drivers | <install_dir>/<device_name>/drivers/ |
CMSIS Standard ARM Cortex-M Headers, math and DSP Libraries | <install_dir>/<device_name>/CMSIS/ |
Device Startup and Linker | <install_dir>/<device_name>/<toolchain>/ |
KSDK Utilities | <install_dir>/<device_name>/utilities/ |
RTOS Kernels | <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 Kinetis SDK documents, see the kex.nxp.com/apidoc.