- Analog Toolbox
- Getting Started with the FRDM-KL28Z
Getting Started with the FRDM-KL28Z
Contents of this document
-
Plug It In
-
Get Software
-
Build, Run
-
Create
Sign in to save your progress. Don't have an account? Create one.
Purchase your FRDM-KL28Z | KL28 | Dev Platform
1. Plug It In
1.2 Setup Board and PC
With the board plugged in, you'll then see a disk drive named "FRDM-KL28ZD" enumerated. Download the demo file from the link below, then drag and drop the bubble(FRDM-KL28Z).bin file
into "FRDM-KL28ZD" disk drive. Press the reset button (SW1) to initiate the board.
2. Get Software
2.1 Jump Start Your Design with the Kinetis SDK
The Kinetis Software Development Kit (SDK) is complimentary and includes full source code under a permissive open-source license for all hardware abstraction and peripheral driver software.
Click below to download the SDK Release appropriate for your computer's operating system.
2.2 Install Your Toolchain
NXP offers a complimentary toolchain called Kinetis Design Studio (KDS).
Want to use a different toolchain?
No problem. The Kinetis SDK includes support for other tools such as IAR , Keil and command-line GCC .
2.3 Tool Update
If using Kinetis Design Studio or Arm GCC toolchains, the latest SEGGER J-Link software tools need to be downloaded and installed. This update is required for those tools to support the KL28 family. Ensure you install this update after installing the IDE of your choice.
First, download the latest "Software and Documentation pack", from SEGGER Downloads .
Then, install the software and at the end of the installation, there will be a dialog box asking to update installed IDEs. Make sure that the KDS 3.2.0 IDE is checked if using Kinetis Design Studio.
2.4 PC Configuration
Many of the example applications output data over the MCU UART so you'll want to make sure that the driver for the board's virtual COM port is installed. Before you run the driver installer, you must have the board plugged into your PC.
With the serial port driver installed, run your favorite terminal application to view the serial output from the MCU's UART. Configure the terminal to 115,200 baud rate, 8 data bits, no parity and 1 stop bit. To determine the port number of the FRDM-KL28Z's virtual COM port, open the device manager and look under the "Ports" group.
Not sure how to use a terminal application? Try one of these tutorials: Tera Term Tutorial, PuTTY Tutorial.
3. Build, Run
3.1 Explore the SDK Example Code
The Kinetis SDK comes with a long list of demo applications and driver examples. To see what's available, browse to the SDK 'boards' folder of your SDK installation and select your board, the FRDM-KL28Z (<sdk_install_directory>/boards/frdmkl28z).
To learn more about demo applications or driver examples, open the readme.txt, located in each of the demo/driver example folder.
3.2 Build, Run and Debug SDK Examples
If one or more of the demo applications or driver examples sounds interesting, you're probably wanting to know how you can build and debug yourself. The Getting Started with Kinetis SDK guide provides easy, step-by-step instructions on how to configure, build, and debug demos for all toolchains supported by the SDK.
Use the guide below to learn how to open, build and debug an example application using the Kinetis Design Studio (KDS) IDE.
Running a Demo using Kinetis Design Studio IDE
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.
- Select "Help" → "Check for Updates"
- Install all updates from Freescale/NXP - these are denoted by "com.NXP.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.
- 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
- Click the "Browse" button next to the "Import from file" option
Point to the example application project, which can be found using this path:
1
<install_dir>/boards/<board_name>/<example_type>/<application_name>/kdsFor this guide, choose the specific location:
1
<install_dir>/boards/frdmkl28z/demo_apps/hello_world/kds- After pointing to the correct directory, your "Import Working Sets and Projects" window should look like the figure below. Click the "Finish" button
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
- 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
- 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-KL28Z board comes loaded with the mbed/CMSIS-DAP 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.
- Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector
-
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
libudevonto your system, which is required by KDS IDE to launch the debugger1
user@ubuntu:~$ sudo apt-get install libudev-dev libudev11
user@ubuntu:~$ sudo ln -s /usr/lib/x86_82-linux-gnu/libudev.so /usr/lib/x86_82-linux-gnu/libudev.so.0 -
Ensure that the debugger configuration is correct for the target you're attempting to connect to. This refers to the OpenSDA interface of your board
-
To check the available debugger configurations, click
the small downward arrow next to the green "Debug"
button and select "Debug Configurations"
- In the "Debug Configurations" dialog box, select debug configuration that corresponds to the hardware platform you're using. For Windows or Linux users, select is the "CMSIS-DAP/DAPLink" option under OpenOCD. For Mac users, select "J-Link"
- After selecting the debugger interface, click the "Debug" button to launch the debugger
-
To check the available debugger configurations, click
the small downward arrow next to the green "Debug"
button and select "Debug Configurations"
-
The application is downloaded to the target and
automatically run to main():
-
Start the application by clicking the "Resume" button:
-
The
hello_worldapplication is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections
Using a different toolchain?
Running a Demo using IAR
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.
-
If not already done, open the desired example application workspace. Most example application workspace files can be located using the following path:
1
<install_dir>/boards/<sdk_board_name>/<example_type>/<application_name>/iarUsing the
hello_worlddemo as an example, the path is:1
<install_dir>/boards/frdmkl28z/demo_apps/hello_world/iar -
Select the desired build target from the drop-down. For
this example, select the "hello_world - Debug"
target
-
To build the application, click the "Make" button, highlighted in red below
- The build will complete without errors
Run an Example Application
The FRDM-KL28Z board comes loaded with the mbed/CMSIS-DAP 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.
- Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector
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
-
Click the "Download and Debug" button to download the application to the target
-
The application is then downloaded to the target and
automatically runs to the main() function
-
Run the code by clicking the "Go" button to start the
application
-
The
hello_worldapplication is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections
Running a Demo using Keil® MDK/µVision®
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.
-
Open the MDK IDE, which is called µVision. In the IDE, select the "Pack Installer" icon
-
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_K60_DFP". Because this example uses the FRDM-KL28Z platform, the KLxx family pack is selected. Click on the "Install" button next to the pack. This process requires an internet connection to successfully complete
-
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.
-
If not already done, open the desired demo application workspace in:
1
<install_dir>/boards/<sdk_board_name>/<example_type>/<application_name>/mdkThe workspace file is named <demo_name>.uvmpw, so for this specific example, the actual path is:
1
<install_dir>/examples/frdmkl28z/demo_apps/hello_world/mdk/hello_world.uvmpw -
To build the demo project, select the "Rebuild" button,
highlighted in red
- The build will complete without errors
Run an Example Application
The FRDM-KL28Z board comes loaded with the mbed/CMSIS-DAP 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.
-
Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector
-
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
-
After the application is properly built, click the "Start/Stop Debug Session" button to download the application to the target
-
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
-
Run the code by clicking the "Run" button to start the application
-
The
hello_worldapplication is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections
Running a Demo using Arm® GCC
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.
-
Download the latest MinGW
mingw-get-setupinstaller from MinGW - Minimalist GNU for Windows Files -
Run the installer. The recommended installation path is
C:\MinGW, however, you may install to any location -
Ensure that the "mingw32-base" and "msys-base" are selected under Basic Setup
-
Click "Apply Changes" in the "Installation" menu and follow the remaining instructions to complete the installation
-
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:
1
<mingw_install_dir>\binAssuming the default installation path,
C:\MinGW, an example is shown below. If the path is not set correctly, the toolchain does not work
Add a New Environment Variable for ARMGCC_DIR
Create a new system environment variable and name it
ARMGCC_DIR. The value of this variable should point to the Arm GCC Embedded tool chain installation path, which, for this example, is:1
C:\Program Files (x86)\GNU Tools Arm Embedded\4.9 2015q3- Reference the installation folder of the GNU Arm GCC Embedded tools for the exact path name of your installation
Install CMake
-
Download CMake 3.0.x from CMake
-
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
-
Follow the remaining instructions of the installer
-
You may need to reboot your system for the PATH changes to take effect
Build an Example Application
To build an example application, follow these steps.
-
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"
-
Change the directory to the example application project directory, which has a path like this:
1
<install_dir>/boards/<board_name>/<example_type>/<application_name</armgccFor this guide, the exact path is:
1
<install_dir>/boards/frdmkl28z/demo_apps/hello_world/armgcc - 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 .
-
Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector
-
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
-
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"
-
Modify the settings as shown below. The target device selection chosen for this example is the "MKL28Z512xxx7"
-
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"
-
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:
1
<install_dir>/boards/<board_name>/<example_type>/<application_name>/armgcc/debug1
<install_dir>/boards/<board_name>/<example_type>/<application_name>/armgcc/releaseFor this example, the path is:
1
<install_dir>/boards/frdmkl28z/demo_apps/hello_world/armgcc/debug -
Run the command
arm-none-eabi-gdb.exe <demo_name>.elf. For this example, it isarm-none-eabi-gdb.exe hello_world.elf
-
Run these commands:
- target remote localhost:2331
- monitor reset
- monitor halt
- load
- monitor reset
- The application is now downloaded and halted at the reset vector. Execute the "monitor go" command to start the example application
- The
hello_worldapplication is now running and a banner is displayed in the terminal window
After it is connected, the screen should resemble this figure:
4. Create
4.1 Get SDK Project Generator
Let's create our own project and make a simple SDK-based application. NXP provides an intuitive, simple project generation utility that allows creation of custom projects based on the Kinetis SDK.
4.2 Run the SDK Project Generator
After extracting the ZIP file, open the utility by clicking on the "KSDK_Project_Generator" executable for your computer's operating system. Point the tool to your SDK installation path, name your project, and select the board that it uses as a reference. Click on the "Quick Generate" button to finish.
4.3 Open Your Project
Your new project will be located in
<sdk_install_directory>/boards/frdmkl28z/user_apps. Open the project in your toolchain of choice by using the same process described in section 3.2.
4.4 Write Some Code
Now, let's make our new project do something other than spin in an infinite loop. The SDK examples provide a board support package (BSP) to do various things specific to the board, including macros and definitions for items such as LEDs, switches and peripheral instances. To keep things simple, lets make the LED blink using the BSP macros.
Update the main() function in your project's main.c file with the following code:
1234567891011121314151617181920212223volatile int delay;
// Configure board specific pin muxing
BOARD_InitPins();
// Configure clock source
BOARD_BootClockRUN();
// Initialize the UART terminal
BOARD_InitDebugConsole();
PRINTF("myProject project\n\r");
// Enable GPIO port for the red LED
CLOCK_EnableClock(kCLOCK_PortE);
PORT_SetPinMux(BOARD_LED_RED_GPIO_PORT, BOARD_LED_RED_GPIO_PIN, kPORT_MuxAsGpio);
LED_RED_INIT(LOGIC_LED_OFF);
for (;;)
{
LED_RED_TOGGLE();
delay = 5000000;
while(delay--);
}Tera Term Tutorial
Tera Term Tutorial
Tera Term is a very popular open source terminal emulation application. This program can be used to display information sent from your NXP development platform's virtual serial port.
- Download Tera Term from SourceForge. After the download, run the installer and then return to this webpage to continue
- Launch Tera Term. The first time it launches, it will show you the following dialog. Select the Serial option. Assuming your board is plugged in, there should be a COM port automatically populated in the list
- Configure the serial port settings (using the COM port number identified earlier) to 115,200 baud rate, 8 data bits, no parity and 1 stop bit. To do this, go to Setup → Serial Port and change the settings
- Verify that the connection is open. If connected, Tera Term will show something like below in its title bar
- You're ready to go
PuTTY Tutorial
PuTTY Tutorial
PuTTY is a popular terminal emulation application. This program can be used to display information sent from your NXP development platform's virtual serial port.
- Download PuTTY using the button below. After the download, run the installer and then return to this webpage to continue
- Launch PuTTY by either double clicking on the *.exe file you downloaded or from the Start menu, depending on the type of download you selected
- Configure in the window that launches, select the Serial radio button and enter the COM port number that you determined earlier. Also, enter the baud rate, in this case 115,200
- Click Open to open the serial connection. Assuming the board is connected, and you entered the correct COM port, the terminal window will open. If the configuration is not correct, PuTTY will alert you
- You're ready to go
Support
Troubleshooting
Did your board come in a box that looks like this?
No problem! Your board simply came in the old packaging and has a different out-of-box demo loaded into the flash memory.
You should be seeing the RGB LED toggling between each of the three colors: red, blue and green. It's OK to move onto the next step when you're ready.
Still not working?
Try proceeding to the next steps to get other example applications running on your board. If you still have problems, try contacting us through the NXP Community .