|
| 1 | +.. zephyr:board:: frdm_ke16z |
| 2 | +
|
| 3 | +Overview |
| 4 | +******** |
| 5 | + |
| 6 | +The FRDM-KE16Z is a development board for NXP Kinetis KE1xZ 32-bit |
| 7 | +MCU-based platforms. The FRDM-KE16Z contains a robust TSI module |
| 8 | +with up to 25 channels which makes this board highly flexible |
| 9 | +for touch keys. Offers options for serial |
| 10 | +communication, flash programming, and run-control debugging. |
| 11 | + |
| 12 | +Hardware |
| 13 | +******** |
| 14 | + |
| 15 | +- MKE16Z64VLF4 MCU (up to 48 MHz, 64 KB flash memory, 8 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 | + |
| 22 | +For more information about the KE1xZ SoC and the FRDM-KE16Z board, see |
| 23 | +these NXP reference documents: |
| 24 | + |
| 25 | +- `KE1XZ SOC Website`_ |
| 26 | +- `FRDM-KE16Z Datasheet`_ |
| 27 | +- `FRDM-KE16Z Reference Manual`_ |
| 28 | +- `FRDM-KE16Z Website`_ |
| 29 | +- `FRDM-KE16Z User Guide`_ |
| 30 | +- `FRDM-KE16Z Schematics`_ |
| 31 | + |
| 32 | +Supported Features |
| 33 | +================== |
| 34 | + |
| 35 | +.. zephyr:board-supported-hw:: |
| 36 | +
|
| 37 | +System Clock |
| 38 | +============ |
| 39 | + |
| 40 | +The KE16 SoC is configured to run at 48 MHz using the FIRC. |
| 41 | + |
| 42 | +Serial Port |
| 43 | +=========== |
| 44 | + |
| 45 | +The KE16 SoC has three UARTs. UART0 (PTB1, PTB0) is configured for the console. |
| 46 | + |
| 47 | +Programming and Debugging |
| 48 | +************************* |
| 49 | + |
| 50 | +.. zephyr:board-supported-runners:: |
| 51 | +
|
| 52 | +Build and flash applications as usual (see :ref:`build_an_application` and |
| 53 | +:ref:`application_run` for more details). |
| 54 | + |
| 55 | +Configuring a Debug Probe |
| 56 | +========================= |
| 57 | + |
| 58 | +A debug probe is used for both flashing and debugging the board. This board is |
| 59 | +configured by default to use Linkserver. |
| 60 | + |
| 61 | +Early versions of this board have an outdated version of the OpenSDA bootloader |
| 62 | +and require an update. Please see the `DAPLink Bootloader Update`_ page for |
| 63 | +instructions to update from the CMSIS-DAP bootloader to the DAPLink bootloader. |
| 64 | + |
| 65 | +Option 1: Linkserver |
| 66 | +------------------------------------------------------- |
| 67 | + |
| 68 | +Install the :ref:`linkserver-debug-host-tools` and make sure they are in your |
| 69 | +search path. LinkServer works with the default CMSIS-DAP firmware included in |
| 70 | +the on-board debugger. |
| 71 | + |
| 72 | +Linkserver is the default for this board, ``west flash`` and ``west debug`` will |
| 73 | +call the linkserver runner. |
| 74 | + |
| 75 | +Option 2: :ref:`opensda-jlink-onboard-debug-probe` |
| 76 | +-------------------------------------------------- |
| 77 | + |
| 78 | +Install the :ref:`jlink-debug-host-tools` and make sure they are in your search |
| 79 | +path. |
| 80 | + |
| 81 | + |
| 82 | +Use the ``-r jlink`` option with west to use the jlink runner. |
| 83 | + |
| 84 | +.. code-block:: console |
| 85 | +
|
| 86 | + west flash -r jlink |
| 87 | +
|
| 88 | +Configuring a Console |
| 89 | +===================== |
| 90 | + |
| 91 | +Regardless of your choice in debug probe, we will use the OpenSDA |
| 92 | +microcontroller as a usb-to-serial adapter for the serial console. |
| 93 | + |
| 94 | +Connect a USB cable from your PC to J6. |
| 95 | + |
| 96 | +Use the following settings with your serial terminal of choice (minicom, putty, |
| 97 | +etc.): |
| 98 | + |
| 99 | +- Speed: 115200 |
| 100 | +- Data: 8 bits |
| 101 | +- Parity: None |
| 102 | +- Stop bits: 1 |
| 103 | + |
| 104 | +Flashing |
| 105 | +======== |
| 106 | + |
| 107 | +Here is an example for the :zephyr:code-sample:`hello_world` application. |
| 108 | + |
| 109 | +.. zephyr-app-commands:: |
| 110 | + :zephyr-app: samples/hello_world |
| 111 | + :board: frdm_ke16z |
| 112 | + :goals: flash |
| 113 | + |
| 114 | +Open a serial terminal, reset the board (press the SW1 button), and you should |
| 115 | +see the following message in the terminal: |
| 116 | + |
| 117 | +.. code-block:: console |
| 118 | +
|
| 119 | + *** Booting Zephyr OS build v3.6.0-3478-gb923667860b1 *** |
| 120 | + Hello World! frdm_ke16z/mke16z4 |
| 121 | +
|
| 122 | +Debugging |
| 123 | +========= |
| 124 | + |
| 125 | +Here 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_ke16z |
| 130 | + :goals: debug |
| 131 | + |
| 132 | +Open a serial terminal, step through the application in your debugger, and you |
| 133 | +should see the following message in the terminal: |
| 134 | + |
| 135 | +.. code-block:: console |
| 136 | +
|
| 137 | + ***** Booting Zephyr OS v3.6.0-xxx-gxxxxxxxxxxxx ***** |
| 138 | + Hello World! frdm_ke16z |
| 139 | +
|
| 140 | +.. include:: ../../common/board-footer.rst.inc |
| 141 | + |
| 142 | +.. _KE1XZ SoC Website: |
| 143 | + 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 |
| 144 | + |
| 145 | +.. _FRDM-KE16Z Datasheet: |
| 146 | + https://www.nxp.com/docs/en/data-sheet/KE1xZP48M48SF0.pdf |
| 147 | + |
| 148 | +.. _FRDM-KE16Z Reference Manual: |
| 149 | + https://www.nxp.com/docs/en/reference-manual/KE1xZP48M48SF0RM.pdf |
| 150 | + |
| 151 | +.. _FRDM-KE16Z Website: |
| 152 | + https://www.nxp.com/design/design-center/development-boards-and-designs/general-purpose-mcus/freedom-development-platform-for-kinetis-ke1xmcus:FRDM-KE16Z |
| 153 | + |
| 154 | +.. _FRDM-KE16Z User Guide: |
| 155 | + https://www.nxp.com/document/guide/get-started-with-the-frdm-ke16z:NGS-FRDM-KE16Z |
| 156 | + |
| 157 | +.. _FRDM-KE16Z Schematics: |
| 158 | + https://www.nxp.com/downloads/en/schematics/FRDM-KE16ZSCH.zip |
| 159 | + |
| 160 | +.. _DAPLink Bootloader Update: |
| 161 | + https://os.mbed.com/blog/entry/DAPLink-bootloader-update/ |
0 commit comments