freescale mkw40z smac software - nxp semiconductors · freescale mkw40z smac software quick start...
TRANSCRIPT
Freescale Semiconductor, Inc. Document Number: MKW40ZSMACSW303QSG User's Guide Rev. 0, 09/2015
Freescale MKW40Z SMAC Software Quick Start Guide
This document is a brief presentation of the
Freescale SMAC Software for the KW40Z
wireless microcontroller platforms version
3.0.3. This software package is an add-on for
the Kinetis Software Development Kit (KSDK).
This document covers installation of the
software packages, hardware setup, build and
usage of the provided demo applications.
Contents
1 Installation ................................................. 2
2 Building the Binaries ................................. 6
2.1 Building the KSDK Libraries .................... 6
2.2 Building and Flashing the Freescale SMAC
Software Demo Applications ............................ 7
3 Hardware Setup ....................................... 11
4 Example: Running the Connectivity Test
Demo Application ........................................... 12
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
2 Freescale Semiconductor, Inc.
1 Installation
This section covers the steps for a successful installation of the required software packages: connectivity
and Kinetis SDK.
The first step is to download the “KW40Z_Connectivity_Software_1.0.0.exe” installer.
Figure 1: The KW40Z Connectivity Software Installer
On the main screen, press the Next button.
Figure 2: KW40Z Installer main screen
On the License Agreement screen press the I agree button to accept the license agreement.
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
Freescale Semiconductor, Inc.
Figure 3: License agreement screen
On the next screen click Browse to select another destination folder for the KW40Z SMAC installation
or click the Next button to continue.
Figure 4: Destination folder selection screen
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
4 Freescale Semiconductor, Inc.
On the following screen uncheck the first two options and press the Next button.
Figure 5: Component selection screen
Select a Start Menu folder and press the Install button.
Figure 6: KW40Z installer Start Menu Folder selection screen
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
Freescale Semiconductor, Inc.
Figure 7: KW40Z installation process
Click Finish to close the installer.
Figure 8: KW40Z SMAC installation complete
The installer automatically creates or updates the KSDK_1_3_0_PATH environment variable required
by the KW40Z SMAC projects.
Once the above steps are performed, you can start using the SMAC Demo Applications.
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
6 Freescale Semiconductor, Inc.
2 Building the Binaries
This section details the required steps for obtaining the binary files for usage with the boards.
NOTE
In order to be able to build any of these packages you need a copy of the
IAR Embedded Workbench for ARM® version 7.40.2 or higher. This
connectivity software package does not include support for any other
toolchains.
The packages must be built with the debug configuration in order to
enable debugging information.
2.1 Building the KSDK Libraries
This release supports all development platforms based on the KW40Z wireless microcontroller. The
KSDK platform libraries are RTOS dependent, so appropriate libraries must be built for the selected
RTOS.
For any connectivity application, the following Kinetis SDK libraries must be built with the IAR
Embedded Workbench for ARM® in order to enable the complete board support and RTOS kernel
support:
Platform drivers library
The location of the KSDK platform projects is described using the following placeholders for text:
<KSDK_1_3_0_PATH> : represents the root path of the KSDK installation folder
<device> : represents the board MCU: KW40Z4
<board> : represents the board: frdmkw40z
Using the placeholders, these are the required Kinetis SDK v1.3.0 projects locations:
<KSDK_1_3_0_PATH>\lib\ksdk_freertos_lib\iar\<device>\ksdk_freertos_lib.eww
<KSDK_1_3_0_PATH>\lib\ksdk_platform_lib\iar\<device>\ksdk_platform_lib.eww
NOTE
The IAR projects for KSDK libraries are included in the IAR workspaces
corresponding to the SMAC demonstration applications and it is
recommended to access them this way.
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
Freescale Semiconductor, Inc.
2.2 Building and Flashing the Freescale SMAC Software Demo Applications
The package contains various demo applications that can be used to get a first feel for the software.
In this section you will be guided through building the Connectivity Test Application, using the
following placeholders for text.
For brevity we shall introduce the following placeholders for text:
<connectivity_path> : represents the root path for the Freescale SMAC software package
<board> : represents the target board for the demo app, for example “frdmkw40z”
<demo_app> : represents the demo app name
<RTOS> : represents the Real Time Operating System
The demo applications general folder structure is the following:
<connectivity_path>\examples\smac\<demo_app>\<board>\<RTOS>\build\iar
Freescale SMAC Software Demo Application Build Example
Selected app: Connectivity_Test
Board: frdmkw40z
RTOS: bare-metal scheduler
Resulting location:
<connectivity_path>\ examples\smac\Connectivity_Test\frdmkw40z\bare-metal\build\iar\
Step 1:
Navigate to the resulting location.
Step 2:
Open the highlighted IAR workspace file (*.eww file format):
Figure 9: “Connectivity Test” Demo Application - project location
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
8 Freescale Semiconductor, Inc.
Step 3:
Select the KSDK platform (bare-metal) library project.
Figure 10: IAR project for KSDK platform (bare-metal) library
Step 4:
Build the KSDK platform library project.
Figure 11: KSDK platform library build
Step 5:
Select the Connectivity Test project.
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
Freescale Semiconductor, Inc.
Figure 12: IAR project for Connectivity Test with bare-metal scheduler
Step 6:
Build the Connectivity Test project.
Figure 13: Connectivity Test bare-metal build
Step 7:
Make the appropriate debugger settings in the project options window:
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
10 Freescale Semiconductor, Inc.
Figure 14: Debugger Settings
Step 8:
Click the “Download and Debug” button to flash the executable onto the board.
Figure 15: Connectivity Test Download and Debug
NOTE
The projects are configured with “CMSIS-DAP” firmware as the default
debug configuration. Please make sure that your board’s OpenSDA chip
contains a CMSIS-DAP firmware or that the debugger selection
corresponds to the physical interface used to connect to the boards. See the
section below for more information.
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
Freescale Semiconductor, Inc.
3 Hardware Setup
The hardware setup in this example uses a FRDM-KW40Z development platform shown in the figure
below:
Figure 16: FRDM-KW40Z
The FRDM-KW40Z should have its OpenSDA (OpenLink) USB port connected via micro-USB cable to
a Windows PC. The OpenSDA chip on the freedom platform should have appropriate firmware flashed,
with debugging and virtual serial COM port capabilities. For more information on OpenSDA please
refer to the following webpage: www.freescale.com/opensda.
Variants of embedded firmware for the OpenSDA chip can be downloaded from:
http://developer.mbed.org/handbook/CMSIS-DAP https://www.segger.com/opensda.html http://www.pemicro.com/opensda/
CMSIS-DAP is the default interface selected in the IAR Embedded Workbench for ARM® projects
included in this release.
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
12 Freescale Semiconductor, Inc.
4 Example: Running the Connectivity Test Demo Application
The SMAC based “Connectivity Test” demo application requires a serial terminal program to
communicate with the FRDM-KW40Z board. Any serial port terminal program is suitable, but for the
purposes of this demo, Tera Term was chosen.
Step 1:
Download the application on the target board using IAR Embedded Workbench for ARM® by clicking
the “Download and Debug” button as presented in Figure 11. You should see a progress bar that shows
the status of the download.
Figure 17: Connectivity Test loading stage example
Figure 18: Connectivity Test application loaded – halted at main
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
Freescale Semiconductor, Inc.
Step 2:
After loading the application, go to “Device Manager” to get the serial port number. It should appear
with the prefix “mbed Serial Port”.
Figure 19: Device Manager serial port look up
Step 3:
Using the port number discovered in “Device Manager”, open a Tera Term instance and connect to the
device using the 115200 baud rate. To change the baud rate of the terminal go to “Setup-> Serial Port”
menu.
Figure 20: Select mbed Serial Connection COM port
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
14 Freescale Semiconductor, Inc.
Figure 21: Setting the correct baud rate
Step 4:
Click “Go” to run the application.
Figure 22: Connectivity Test App resuming execution
Step 5:
The application displays a logo screen and waits for user intervention. When the [ENTER] key is
pressed, the application will show the main menu. If any other key is pressed, the logo screen is
redisplayed with on-screen instructions.
Freescale MKW40Z SMAC Software Quick Start Guide Rev. 0, 09/2015
Freescale Semiconductor, Inc.
Figure 23: Connectivity Test after reset or after pressing any key except [ENTER] (return) key
Figure 24: Connectivity Test after pressing the [ENTER] (return) key
To start any test, you can follow the on-screen instructions. In case a test needs a second FRDM-
KW40Z platform, redo the previous steps to connect to the PC, flash and run the application on it.
The previous section demonstrates only the basic steps to run a demo application. For detailed
information about the demo applications themselves, please refer the Demo Applications User’s Guide
included in the installer (MKW40ZSMACDAUG.pdf).
Home Page:
freescale.com
Web Support:
freescale.com/support4
Information in this document is provided solely to enable system and software implementers to use Freescale products. There are no express or implied copyright licenses granted hereunder to design or fabricate any integrated circuits based on the information in this document.
Freescale reserves the right to make changes without further notice to any products herein. Freescale makes no warranty, representation, or guarantee regarding the suitability of its products for any particular purpose, nor does Freescale assume any liability arising out of the application or use of any product or circuit, and specifically disclaims any and all liability, including without limitation consequential or incidental damages. “Typical” parameters that may be provided in Freescale data sheets and/or specifications can and do vary in different applications, and actual performance may vary over time. All operating parameters, including “typicals,” must be validated for each customer application by customer’s technical experts. Freescale does not convey any license under its patent rights nor the rights of others. Freescale sells products pursuant to standard terms and conditions of sale, which can be found at the following address: freescale.com/SalesTermsandConditions.
Freescale, the Freescale logo, AltiVec, C-5, CodeTest, CodeWarrior, ColdFire, C-Ware, Energy Efficient Solutions logo, Kinetis, mobileGT, PowerQUICC, Processor Expert, QorIQ, Qorivva, StarCore, Symphony, and VortiQa are trademarks of Freescale Semiconductor, Inc., Reg. U.S. Pat. & Tm. Off. Airfast, BeeKit, BeeStack, ColdFire+, CoreNet, Flexis, MagniV, MXC, Platform in a Package, QorIQ Qonverge, QUICC Engine, Ready Play, SafeAssure, SMARTMOS, TurboLink, Vybrid, and Xtrinsic are trademarks of Freescale Semiconductor, Inc. All other product or service names are the property of their respective owners. The Power Architecture and Power.org word marks and the Power and Power.org logos and related marks are trademarks and service marks licensed by Power.org. The ARM Powered Logo is a trademark of ARM Limited.
© 2015 Freescale Semiconductor, Inc.
Document number: MKW40ZSMACSW303QSG Rev. 0
09/2015