1.. zephyr:board:: frdm_ke15z
2
3Overview
4********
5
6The FRDM-KE15Z is a development board for NXP Kinetis KE1xZ 32-bit
7MCU-based platforms. The FRDM-KE15Z 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- MKE15Z256VLL7 MCU (up to 72 MHz, 256 KB flash memory, 32 KB RAM)
16- OpenSDA Debug Circuit with a virtual serial port
17- Touch electrodes in the self-capacitive mode
18- Compatible with FRDM-TOUCH, FRDM-MC-LVBLDC, and Arduino® boards
19- User Components such as Reset; RGB LED and two user buttons
20- 6-axis FXOS8700CQ digital accelerometer and magnetometer
21
22For more information about the KE1xZ SoC and the FRDM-KE15Z board, see
23these NXP reference documents:
24
25- `KE1XZ SOC Website`_
26- `FRDM-KE15Z Datasheet`_
27- `FRDM-KE15Z Reference Manual`_
28- `FRDM-KE15Z Website`_
29- `FRDM-KE15Z User Guide`_
30- `FRDM-KE15Z Schematics`_
31
32Supported Features
33==================
34
35The frdm_ke15z board configuration supports the following hardware
36features:
37
38+-----------+------------+-------------------------------------+
39| Interface | Controller | Driver/Component                    |
40+===========+============+=====================================+
41| NVIC      | on-chip    | nested vector interrupt controller  |
42+-----------+------------+-------------------------------------+
43| SYSTICK   | on-chip    | systick                             |
44+-----------+------------+-------------------------------------+
45| GPIO      | on-chip    | gpio                                |
46+-----------+------------+-------------------------------------+
47| UART      | on-chip    | uart polling;                       |
48|           |            | uart interrupt                      |
49+-----------+------------+-------------------------------------+
50
51The default configuration can be found in the defconfig file:
52:zephyr_file:`boards/nxp/frdm_ke15z/frdm_ke15z_defconfig`.
53
54Other hardware features are not currently supported by the port.
55
56System Clock
57============
58
59The KE15 SoC is configured to run at 48 MHz using the FIRC.
60
61Serial Port
62===========
63
64The KE15 SoC has three UARTs. UART1 is configured for the console.
65
66Programming and Debugging
67*************************
68
69Build and flash applications as usual (see :ref:`build_an_application` and
70:ref:`application_run` for more details).
71
72Configuring a Debug Probe
73=========================
74
75A debug probe is used for both flashing and debugging the board. This board is
76configured by default to use Linkserver.
77
78Early versions of this board have an outdated version of the OpenSDA bootloader
79and require an update. Please see the `DAPLink Bootloader Update`_ page for
80instructions to update from the CMSIS-DAP bootloader to the DAPLink bootloader.
81
82Option 1: Linkserver
83-------------------------------------------------------
84
85Install the :ref:`linkserver-debug-host-tools` and make sure they are in your
86search path.  LinkServer works with the default CMSIS-DAP firmware included in
87the on-board debugger.
88
89Linkserver is the default for this board, ``west flash`` and ``west debug`` will
90call the linkserver runner.
91
92Option 2: :ref:`opensda-jlink-onboard-debug-probe`
93--------------------------------------------------
94
95Install the :ref:`jlink-debug-host-tools` and make sure they are in your search
96path.
97
98Follow the instructions in :ref:`opensda-jlink-onboard-debug-probe` to program
99the `OpenSDA J-Link Firmware for FRDM-KE15Z`_.
100Use the ``-r jlink`` option with west to use the jlink runner.
101
102.. code-block:: console
103
104   west flash -r jlink
105
106Configuring a Console
107=====================
108
109Regardless of your choice in debug probe, we will use the OpenSDA
110microcontroller as a usb-to-serial adapter for the serial console.
111
112Connect a USB cable from your PC to J5.
113
114Use the following settings with your serial terminal of choice (minicom, putty,
115etc.):
116
117- Speed: 115200
118- Data: 8 bits
119- Parity: None
120- Stop bits: 1
121
122Flashing
123========
124
125Here is an example for the :zephyr:code-sample:`hello_world` application.
126
127.. zephyr-app-commands::
128   :zephyr-app: samples/hello_world
129   :board: frdm_ke15z
130   :goals: flash
131
132Open a serial terminal, reset the board (press the SW1 button), and you should
133see the following message in the terminal:
134
135.. code-block:: console
136
137   *** Booting Zephyr OS build v3.6.0-3478-gb923667860b1 ***
138   Hello World! frdm_ke15z/mke15z7
139
140Debugging
141=========
142
143Here is an example for the :zephyr:code-sample:`hello_world` application.
144
145.. zephyr-app-commands::
146   :zephyr-app: samples/hello_world
147   :board: frdm_ke15z
148   :goals: debug
149
150Open a serial terminal, step through the application in your debugger, and you
151should see the following message in the terminal:
152
153.. code-block:: console
154
155   ***** Booting Zephyr OS v3.6.0-xxx-gxxxxxxxxxxxx *****
156   Hello World! frdm_ke15z
157
158.. include:: ../../common/board-footer.rst
159   :start-after: nxp-board-footer
160
161.. _KE1XZ SoC Website:
162   https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/ke-series-arm-cortex-m4-m0-plus/ke1xz-arm-cortex-m0-plus-5v-main-stream-mcu-with-nxp-touch-and-can-control:KE1xZ
163
164.. _FRDM-KE15Z Datasheet:
165   https://www.nxp.com/docs/en/data-sheet/KE1xZP100M72SF0.pdf
166
167.. _FRDM-KE15Z Reference Manual:
168   https://www.nxp.com/webapp/Download?colCode=KE1XZP100M72SF0RM
169
170.. _FRDM-KE15Z Website:
171   https://www.nxp.com/design/design-center/development-boards-and-designs/general-purpose-mcus/freedom-development-platform-for-kinetis-ke1xmcus:FRDM-KE15Z
172
173.. _FRDM-KE15Z User Guide:
174   https://www.nxp.com/document/guide/get-started-with-the-frdm-ke15z:NGS-FRDM-KE15Z
175
176.. _FRDM-KE15Z Schematics:
177   https://www.nxp.com/webapp/Download?colCode=FRDM-KE15Z-SCH-DESIGNFILES
178
179.. _DAPLink Bootloader Update:
180   https://os.mbed.com/blog/entry/DAPLink-bootloader-update/
181
182.. _OpenSDA J-Link Firmware for FRDM-KE15Z:
183   https://www.segger.com/downloads/jlink/OpenSDA_FRDM-KE15Z
184