1.. zephyr:board:: frdm_ke17z
2
3Overview
4********
5
6The FRDM-KE17Z is a development board for NXP Kinetis KE1xZ 32-bit
7MCU-based platforms. The FRDM-KE17Z contains a robust TSI module
8with up to 50 channels which makes this board highly flexible
9for touch keys. Offers options for serial
10communication, flash programming, and run-control debugging.
11
12Hardware
13********
14
15- MKE17Z256VLL7 MCU (up to 72 MHz, 256 KB flash memory, 48 KB SRAM,
16  and 100 Low profile Quad Flat Package (LQFP))
17- 3.3 V or 5 V MCU operation
18- 6-axis FXOS8700CQ digital accelerometer
19- 3-axis digital angular rate gyroscope
20- One RGB LED
21- Two user push-buttons
22- Thermistor
23- Two capacitive touchpads
24- Flex I/O pin header
25
26For more information about the KE1xZ SoC and the FRDM-KE17Z board, see
27these NXP reference documents:
28
29- `FRDM-KE17Z Website`_
30- `FRDM-KE17Z User Guide`_
31- `FRDM-KE17Z Reference Manual`_
32- `FRDM-KE17Z Datasheet`_
33
34Supported Features
35==================
36
37The frdm_ke17z board configuration supports the following hardware
38features:
39
40+-----------+------------+-------------------------------------+
41| Interface | Controller | Driver/Component                    |
42+===========+============+=====================================+
43| NVIC      | on-chip    | nested vector interrupt controller  |
44+-----------+------------+-------------------------------------+
45| SYSTICK   | on-chip    | systick                             |
46+-----------+------------+-------------------------------------+
47| PINCTRL   | on-chip    | pinctrl                             |
48+-----------+------------+-------------------------------------+
49| ADC       | on-chip    | adc                                 |
50+-----------+------------+-------------------------------------+
51| GPIO      | on-chip    | gpio                                |
52+-----------+------------+-------------------------------------+
53| LPTMR     | on-chip    | counter                             |
54+-----------+------------+-------------------------------------+
55| UART      | on-chip    | uart                                |
56+-----------+------------+-------------------------------------+
57| SPI       | on-chip    | spi                                 |
58+-----------+------------+-------------------------------------+
59| DMA       | on-chip    | dma                                 |
60+-----------+------------+-------------------------------------+
61| FTM       | on-chip    | pwm                                 |
62+-----------+------------+-------------------------------------+
63| I2C       | on-chip    | i2c                                 |
64+-----------+------------+-------------------------------------+
65| ACMP      | on-chip    | sensor                              |
66+-----------+------------+-------------------------------------+
67| WATCHDOG  | on-chip    | watchdog                            |
68+-----------+------------+-------------------------------------+
69
70The default configuration can be found in the defconfig file:
71:zephyr_file:`boards/nxp/frdm_ke17z/frdm_ke17z_defconfig`.
72
73Other hardware features are not currently supported by the port.
74
75System Clock
76============
77
78The KE17Z SoC is configured to run at 48 MHz using the FIRC.
79
80Serial Port
81===========
82
83The KE17Z SoC has three UARTs. UART0 is configured for the console.
84
85Programming and Debugging
86*************************
87
88Build and flash applications as usual (see :ref:`build_an_application` and
89:ref:`application_run` for more details).
90
91Configuring a Debug Probe
92=========================
93
94A debug probe is used for both flashing and debugging the board. This board is
95configured by default to use Linkserver.
96
97Early versions of this board have an outdated version of the OpenSDA bootloader
98and require an update. Please see the `DAPLink Bootloader Update`_ page for
99instructions to update from the CMSIS-DAP bootloader to the DAPLink bootloader.
100
101Option 1: Linkserver
102--------------------
103
104Install the :ref:`linkserver-debug-host-tools` and make sure they are in your
105search path.  LinkServer works with the default CMSIS-DAP firmware included in
106the on-board debugger.
107
108      Linkserver is the default for this board, ``west flash`` and ``west debug`` will
109      call the linkserver runner.
110
111.. code-block:: console
112
113   west flash
114
115
116External JLink: :ref:`jlink-external-debug-probe`
117-------------------------------------------------
118
119Install the :ref:`jlink-debug-host-tools` and make sure they are in your search
120path.
121
122Attach a J-Link 10-pin connector to J14. Check that jumpers J8 and J9 are
123**off** (they are on by default when boards ship from the factory) to ensure
124SWD signals are disconnected from the OpenSDA microcontroller.
125Use the ``-r jlink`` option with west to use the jlink runner.
126
127.. code-block:: console
128
129   west flash -r jlink
130
131Configuring a Console
132=====================
133
134Regardless of your choice in debug probe, we will use the OpenSDA
135microcontroller as a usb-to-serial adapter for the serial console.
136
137Connect a USB cable from your PC to J6.
138
139Use the following settings with your serial terminal of choice (minicom, putty,
140etc.):
141
142- Speed: 115200
143- Data: 8 bits
144- Parity: None
145- Stop bits: 1
146
147Flashing
148========
149
150Here is an example for the :zephyr:code-sample:`hello_world` application.
151
152.. zephyr-app-commands::
153   :zephyr-app: samples/hello_world
154   :board: frdm_ke17z
155   :goals: flash
156
157Open a serial terminal, reset the board (press the SW1 button), and you should
158see the following message in the terminal:
159
160.. code-block:: console
161
162   *** Booting Zephyr OS build xxxxxxxxxxxx ***
163   Hello World! frdm_ke17z/mke17z7
164
165Debugging
166=========
167
168Here is an example for the :zephyr:code-sample:`hello_world` application.
169
170.. zephyr-app-commands::
171   :zephyr-app: samples/hello_world
172   :board: frdm_ke17z
173   :goals: debug
174
175Open a serial terminal, step through the application in your debugger, and you
176should see the following message in the terminal:
177
178.. code-block:: console
179
180   *** Booting Zephyr OS build xxxxxxxxxxxx ***
181   Hello World! frdm_ke17z/mke17z7
182
183.. include:: ../../common/board-footer.rst
184   :start-after: nxp-board-footer
185
186.. _FRDM-KE17Z Website:
187   https://www.nxp.com/design/design-center/development-boards-and-designs/general-purpose-mcus/freedom-development-platform-for-72mhz-ke17z-ke13z-ke12z-mcus:FRDM-KE17Z
188
189.. _FRDM-KE17Z User Guide:
190   https://www.nxp.com/docs/en/user-guide/KE17ZHDG.pdf
191
192.. _FRDM-KE17Z Reference Manual:
193   https://www.nxp.com/docs/en/reference-manual/KE1xZP100M72SF1RM.pdf
194
195.. _FRDM-KE17Z Datasheet:
196   https://www.nxp.com/docs/en/data-sheet/KE1xZP100M72SF1.pdf
197
198.. _DAPLink Bootloader Update:
199   https://os.mbed.com/blog/entry/DAPLink-bootloader-update/
200
201.. _OpenSDA DAPLink FRDM-KE17Z Firmware:
202   https://www.nxp.com/design/design-center/software/sensor-toolbox/opensda-serial-and-debug-adapter:OPENSDA?tid=vanOpenSDA
203
204.. _linkserver-debug-host-tools:
205   https://www.nxp.com/lgfiles/updates/mcuxpresso/LinkServer_1.5.30.exe
206
207.. _OpenSDA J-Link Firmware for FRDM-KE17Z:
208   https://www.segger.com/downloads/jlink/OpenSDA_FRDM-KE17Z
209