Getting Started with the FRDM-KV31F

Download PDF.

Install KDS Updates

Before using KDS IDE with KSDK, it is recommended that you make sure that your tools are up-to-date. The steps discussed below are shown using the Windows version of KDS, but are identical for Mac and Linux users.

1. Select "Help" → "Check for Updates"

   
2. Install all updates from Freescale/NXP - these are denoted by "com.freescale.xxx" or "com.nxp.xxx". There may also be updates for things such as toolchain or debug interfaces. While these additional updates are typically OK to install, sometimes they may cause issues since they aren't released as part of the KDS toolchain

Build an Example Application

The following steps will guide you through opening the hello_world application. These steps may change slightly for other example applications as some of these applications may have additional layers of folders in their path.

Note: The steps required for Linux and Mac OS are identical to those for Windows.

1. Select File → Import from the KDS IDE menu. In the window that appears, expand the "Project of Projects" folder and select "Existing Project Sets". Then, click the "Next" button

   

2. Click the "Browse" button next to the "Import from file" option

   

3. Point to the example application project, which can be found using this path:

   <install_dir>/boards/<board_name>/<example_type>/<application_name>/kds

   For this guide, choose the specific location:

   <install_dir>/boards/KV31F512/demo_apps/hello_world/kds

4. After pointing to the correct directory, your "Import Working Sets and Projects" window should look like the figure below. Click the "Finish" button

   

5. There are two project configurations (build targets) supported for each KSDK project:

   • Debug - Compiler optimization is set to low, and debug information is generated for the executable. This target should be selected for development and debug
   • Release - Compiler optimization is set to high, and debug information is not generated. This target should be selected for final application deployment

6. Choose the appropriate build target, "Debug" or "Release", by clicking the downward facing arrow next to the hammer icon, as shown below. For this example, select the Debug target

   

7. The library starts building after the build target is selected. To rebuild the library in the future, click the hammer icon (assuming the same build target is chosen)

Run an Example Application

The FRDM-KV31F board comes loaded with the PEmicro interface from the factory. If you have changed the debug OpenSDA application on your board, visit OpenSDA for information on updating or restoring your board to the factory state.

Note: Mac users must install the J-Link OpenSDA application to use the KDS IDE to download and debug their board.

1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector

2. Open the terminal application on the PC (such as PuTTY or Tera Term) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:

   • 115,200 baud rate
   • No parity
   • 8 data bits
   • 1 stop bit

   For Linux OS users only, run the following commands in your terminal. These install libudev onto your system, which is required by KDS IDE to launch the debugger:

   user@ubuntu:~$ sudo apt-get install libudev-dev libudev1 

   user@ubuntu:~$ sudo ln -s /usr/lib/x86_64-linux-gnu/libudev.so /usr/lib/x86_64-linux-gnu/libudev.so.0 

3. Ensure that the debugger configuration is correct for the target you're attempting to connect. This refers to the OpenSDA interface of your board. If you're unsure what your board has, please consult Appendix B of the PDF

   1. To check the available debugger configurations, click the small downward arrow next to the green "Debug" button and select "Debug Configurations"

      

   2. In the Debug Configurations dialog box, select a debug configuration that corresponds to the hardware platform you're using. For Windows or Linux users, select the "mbed/CMSIS-DAP" option under OpenOCD. For Mac users, select "J-Link"

   3. After selecting the debugger interface, click the "Debug" button to launch the debugger

   

4. The application is downloaded to the target and automatically run to main():

   

5. Start the application by clicking the "Resume" button:

   

6. The hello_world application is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections

   

Download PDF.

Build a Demo Application

The following steps will guide you through opening the hello_world application. These steps may change slightly for other example applications as some of these applications may have additional layers of folders in their path.

1. If not already done, open the desired example application workspace. Most example application workspace files can be located using the following path:

   <install_dir>/boards/<sdk_board_name>/<example_type>/<application_name>/iar

   Using the hello_world demo as an example, the path is:

   <install_dir>/boards/frdmkv31f/demo_apps/hello_world/iar

2. Select the desired build target from the drop-down. For this example, select the "hello_world - Debug" target

   

3. To build the application, click the "Make" button, highlighted in red below

   

4. The build will complete without errors

Run an Example Application

The FRDM-KV31F board comes loaded with the PEmicro debug interface from the factory. If you have changed the debug OpenSDA application on your board, visit OpenSDA for information on updating or restoring your board to the factory state.

1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector

2. Open the terminal application on the PC (such as PuTTY or Tera Term) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:

   • 115,200 baud rate
   • No parity
   • 8 data bits
   • 1 stop bit

3. Click the "Download and Debug" button to download the application to the target

   

4. The application is then downloaded to the target and automatically runs to the main() function

   

5. Run the code by clicking the "Go" button to start the application

   

6. The hello_world application is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections

   

Download PDF.

Install CMSIS device pack

After the MDK tools are installed, Cortex® Microcontroller Software Interface Standard (CMSIS) device packs must be installed to fully support the device from a debug perspective. These packs include things such as memory map information, register definitions and flash programming algorithms. Follow these steps to install the appropriate CMSIS pack.

1. Open the MDK IDE, which is called µVision. In the IDE, select the "Pack Installer" icon

   

2. In the Pack Installer window, navigate to the section with the Kinetis packs (they are in alphabetical order). The Kinetis packs start with "Keil::Kinetis" and are followed by the MCU family name, for example "Keil::Kinetis_KLxx_DFP". Because this example uses the FRDM-KV31F platform, the KVxx family pack is selected. Click on the "Install" button next to the pack. This process requires an internet connection to successfully complete

   

3. After the installation finishes, close the Pack Installer window and return to the µVision IDE

Build the Example Application

The following steps will guide you through opening the hello_world application. These steps may change slightly for other example applications as some of these applications may have additional layers of folders in their path.

1. If not already done, open the desired demo application workspace in:

   <install_dir>/boards/<sdk_board_name>/<example_type>/<application_name>/mdk

   The workspace file is named <application_name>.uvmpw, so for this specific example, the actual path is:

    <install_dir>/boards/frdmkv31f/demo_apps/hello_world/mdk/hello_world.uvmpw

2. To build the demo project, select the "Rebuild" button, highlighted in red

   

3. The build will complete without errors

Run an Example Application

The FRDM-KV31F board comes loaded with the PEmicro debug interface from the factory. If you have changed the debug OpenSDA application on your board, visit OpenSDA for information on updating or restoring your board to the factory state.

1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector

2. Open the terminal application on the PC (such as PuTTY or Tera Term) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:

   • 115,200 baud rate
   • No parity
   • 8 data bits
   • 1 stop bit

3. After the application is properly built, click the "Download" button to download the application to the target

   

4. After clicking the "Download" button, the application downloads to the target and should be running. To debug the application, click the "Start/Stop Debug Session" button, highlighted in red

   

5. Run the code by clicking the "Run" button to start the application

   

6. The hello_world application is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections

   

Download PDF.

Set Up Toolchain

This section contains the steps to install the necessary components required to build and run a KSDK demo application with the Arm GCC Toolchain, as supported by the Kinetis SDK.

There are many ways to use Arm GCC tools, but this example focuses on a Windows environment. Though not discussed here, GCC tools can also be used with both Linux OS and Mac OSX.

Install GCC Arm Embedded Toolchain

Download and run the installer from GNU Arm Embedded Toolchain . This is the actual toolchain (i.e., compiler, linker, etc.). The GCC toolchain should correspond to the latest supported version, as described in the Kinetis SDK Release Notes.

Install MinGW

The Minimalist GNU for Windows (MinGW) development tools provide a set of tools that are not dependent on third-party C-Runtime DLLs (such as Cygwin). The build environment used by the KSDK does not utilize the MinGW build tools, but does leverage the base install of both MinGW and MSYS. MSYS provides a basic shell with a UNIX-like interface and tools.

1. Download the latest MinGW mingw-get-setup installer from MinGW - Minimalist GNU for Windows Files

2. Run the installer. The recommended installation path is C:\MinGW, however, you may install to any location

Note: The installation path cannot contain any spaces.

3. Ensure that the "mingw32-base" and "msys-base" are selected under Basic Setup

   

4. Click "Apply Changes" in the "Installation" menu and follow the remaining instructions to complete the installation

   

5. Add the appropriate item to the Windows operating system path environment variable. It can be found under Control Panel → System and Security → System → Advanced System Settings in the "Environment Variables" section. The path is:

   <mingw_install_dir>\bin 

   Assuming the default installation path, C:\MinGW, an example is shown below. If the path is not set correctly, the toolchain does not work

   Note: If you have C:\MinGW\msys\x.x\bin in your PATH variable (as required by KSDK 1.0.0), remove it to ensure that the new GCC build system works correctly.

   

Add a New Environment Variable for ARMGCC_DIR

1. Create a new system environment variable and name it ARMGCC_DIR. The value of this variable should point to the Arm GCC Embedded Toolchain installation path, which, for this example, is:

C:\Program Files (x86)\GNU Tools Arm Embedded\5.2 2015q4

2. Reference the installation folder of the GNU Arm GCC Embedded tools for the exact path name of your installation

Install CMake

1. Download CMake 3.0.x from CMake

2. Install CMake, ensuring that the option "Add CMake to system PATH" is selected when installing. It's up to the user to select whether it's installed into the PATH for all users or just the current user. In this example, the assumption is that it's installed for all users

   

3. Follow the remaining instructions of the installer

4. You may need to reboot your system for the PATH changes to take effect

Build the Platform Library

1. Open a GCC Arm Embedded Toolchain command window. To launch the window, from the Windows operating system Start menu, go to "Programs → GNU Tools Arm Embedded <version>" and select "GCC Command Prompt"

2. Change the directory of the command window to the platform library directory in the KSDK:

<install_dir>/lib/ksdk_platform_lib/armgcc/KV31F51212

3. There are two project configurations (build targets) supported for each KSDK project:

   • Debug - Compiler optimization is set to low, and debug information is generated for the executable. This target should be selected for development and debug
   • Release - Compiler optimization is set to high, and debug information is not generated. This target should be selected for final application deployment

   There are batch files provided to build both configurations. For this example, the "Debug" target is built and "build_debug.bat" is typed on the command line. If the "Release" target is desired, type the "build_release.bat" instead. Alternatively, if using the command line is not desired, you can double click on the batch files from Windows Explorer


4. When the build finishes, the output looks like the image below

5. The library (libksdk_platform.a) is generated in one of these directories, according to the build target:

<install_dir>/lib/ksdk_platform_lib/armgcc/KV31F51212/debug

<install_dir>/lib/ksdk_platform_lib/armgcc/KV31F51212/release

Build the Platform Library

KSDK demo applications require that the platform library for the same build target (Debug or Release) is present. Please ensure that you follow the steps in previous sections to attempting to build a demo application. To build an example application, follow these steps:

1. If not already running, open a GCC Arm Embedded Toolchain command window. To launch the window, from the Windows operating system Start menu, go to "Programs → GNU Tools Arm Embedded <version>" and select "GCC Command Prompt"

   

2. Change the directory to the example application project directory, which has a path like this:

   <install_dir>/examples/frdmkv31f/demo_apps/<demo_name>/armgcc

   For this guide, the exact path is:

   <install_dir>/examples/frdmkv31f/demo_apps/bubble_level_ftm/armgcc

3. Type "build_debug.bat" on the command line or double click on the "build_debug.bat" file in Windows operating system explorer to perform the build. The output is shown in this figure:

   

Run an Example Application

The GCC tools require a J-Link debug interface. To update the OpenSDA firmware on your board to the latest J-Link app, visit OpenSDA. After installing the J-Link OpenSDA application, download the J-Link driver and software package from SEGGER Downloads .

1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector

2. Open the terminal application on the PC (such as PuTTY or Tera Term) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:

   • 115,200 baud rate
   • No parity
   • 8 data bits
   • 1 stop bit

3. Open the J-Link GDB Server application. Assuming the J-Link software is installed, the application can be launched by going to the Windows operating system Start menu and selecting "Programs → SEGGER → J-Link <version> J-Link GDB Server"

4. Modify the settings as shown below. The target device selection chosen for this example is the "MKV31F512xxx12"

   
5. Hit OK to connect to the board. You may see a warning about licensing, so accept the terms to move on

6. After it is connected, the screen should resemble this figure:

   

7. If not already running, open a GCC Arm Embedded Toolchain command window. To launch the window from the Windows operating system Start menu, go to "Programs → GNU Tools Arm Embedded <version>" and select "GCC Command Prompt"

   

8. Change to the directory that contains the demo application output. The output can be found in using one of these paths, depending on the build target selected:

   <install_dir>/examples/<board_name>/demo_apps/<demo_name>/armgcc/debug

   <install_dir>/examples/<board_name>/demo_apps/<demo_name>/armgcc/release

   For this example, the path is:

   <install_dir>/examples/frdmkv31f/demo_apps/bubble_level_ftm/armgcc/debug

9. Run the command:

   arm-none-eabi-gdb.exe <demo_name>.elf

   For this example, it is:

   arm-none-eabi-gdb.exe bubble_level_ftm.elf

   

10. Run these commands:

    • target remote localhost:2331
    • monitor reset
    • monitor halt
    • load
    • monitor reset
    • monitor go
11. The application is now downloaded and halted at the reset vector. By executing the "monitor go" command, the demo application will begin
12. The bubble_level_ftm application is now running and a banner is displayed in the terminal window