| .. zephyr:board:: frdm_kl25z |
| |
| Overview |
| ******** |
| |
| The Freedom KL25Z is an ultra-low-cost development platform for |
| Kinetis |reg| L Series KL1x (KL14/15) and KL2x (KL24/25) MCUs built |
| on ARM |reg| Cortex |reg|-M0+ processor. |
| |
| The FRDM-KL25Z features include easy access to MCU I/O, battery-ready, |
| low-power operation, a standard-based form factor with expansion board |
| options and a built-in debug interface for flash programming and run-control. |
| |
| Hardware |
| ******** |
| |
| - MKL25Z128VLK4 MCU @ 48 MHz, 128 KB flash, 16 KB SRAM, USB OTG (FS), 80LQFP |
| - On board capacitive touch "slider", MMA8451Q accelerometer, and tri-color LED |
| - OpenSDA debug interface |
| |
| For more information about the KL25Z SoC and FRDM-KL25Z board: |
| |
| - `KL25Z Website`_ |
| - `KL25Z Datasheet`_ |
| - `KL25Z Reference Manual`_ |
| - `FRDM-KL25Z Website`_ |
| - `FRDM-KL25Z User Guide`_ |
| - `FRDM-KL25Z Schematics`_ |
| |
| Supported Features |
| ================== |
| |
| .. zephyr:board-supported-hw:: |
| |
| Connections and IOs |
| =================== |
| |
| The KL25Z SoC has five pairs of pinmux/gpio controllers, and all are currently enabled |
| (PORTA/GPIOA, PORTB/GPIOB, PORTC/GPIOC, PORTD/GPIOD, and PORTE/GPIOE) for the FRDM-KL25Z board. |
| |
| +-------+-------------+---------------------------+ |
| | Name | Function | Usage | |
| +=======+=============+===========================+ |
| | PTB2 | ADC | ADC0 channel 12 | |
| +-------+-------------+---------------------------+ |
| | PTB18 | GPIO | Red LED | |
| +-------+-------------+---------------------------+ |
| | PTB19 | GPIO | Green LED | |
| +-------+-------------+---------------------------+ |
| | PTD1 | GPIO | Blue LED | |
| +-------+-------------+---------------------------+ |
| | PTA1 | UART0_RX | UART Console | |
| +-------+-------------+---------------------------+ |
| | PTA2 | UART0_TX | UART Console | |
| +-------+-------------+---------------------------+ |
| | PTE24 | I2C0_SCL | I2C | |
| +-------+-------------+---------------------------+ |
| | PTE25 | I2C0_SDA | I2C | |
| +-------+-------------+---------------------------+ |
| |
| |
| System Clock |
| ============ |
| |
| The KL25Z SoC is configured to use the 8 MHz external oscillator on the board |
| with the on-chip FLL to generate a 48 MHz system clock. |
| |
| Serial Port |
| =========== |
| |
| The KL25Z UART0 is used for the console. |
| |
| USB |
| === |
| |
| The KL25Z SoC has a USB OTG (USBOTG) controller that supports both |
| device and host functions through its mini USB connector (USB KL25Z). |
| Only USB device function is supported in Zephyr at the moment. |
| |
| Programming and Debugging |
| ************************* |
| |
| .. zephyr:board-supported-runners:: |
| |
| Build and flash applications as usual (see :ref:`build_an_application` and |
| :ref:`application_run` for more details). |
| |
| Configuring a Debug Probe |
| ========================= |
| |
| A debug probe is used for both flashing and debugging the board. This board is |
| configured by default to use the :ref:`opensda-daplink-onboard-debug-probe`. |
| |
| Early versions of this board have an outdated version of the OpenSDA bootloader |
| and require an update. Please see the `DAPLink Bootloader Update`_ page for |
| instructions to update from the CMSIS-DAP bootloader to the DAPLink bootloader. |
| |
| Option 1: Linkserver: :ref:`opensda-daplink-onboard-debug-probe` (Recommended) |
| ------------------------------------------------------------------------------ |
| |
| Install the :ref:`linkserver-debug-host-tools` and make sure they are in your |
| search path. LinkServer works with the CMSIS-DAP debug firmware. Please follow the |
| instructions on :ref:`opensda-daplink-onboard-debug-probe` and select the latest revision |
| of the firmware image. |
| |
| Linkserver is the default for this board, ``west flash`` and ``west debug`` will |
| call the linkserver runner. |
| |
| .. code-block:: console |
| |
| west flash |
| west debug |
| |
| Option 2: :ref:`opensda-jlink-onboard-debug-probe` |
| -------------------------------------------------- |
| |
| Install the :ref:`jlink-debug-host-tools` and make sure they are in your search |
| path. |
| |
| Follow the instructions in :ref:`opensda-jlink-onboard-debug-probe` to program |
| the `OpenSDA J-Link FRDM-KL25Z Firmware`_. |
| |
| Add the arguments ``-DBOARD_FLASH_RUNNER=jlink`` and |
| ``-DBOARD_DEBUG_RUNNER=jlink`` when you invoke ``west build`` to override the |
| default runner from pyOCD to J-Link: |
| |
| .. zephyr-app-commands:: |
| :zephyr-app: samples/hello_world |
| :board: frdm_kl25z |
| :gen-args: -DBOARD_FLASH_RUNNER=jlink -DBOARD_DEBUG_RUNNER=jlink |
| :goals: build |
| |
| Note: |
| ----- |
| |
| The runners supported by NXP are LinkServer and JLink. pyOCD is another potential option, |
| but NXP does not test or support the pyOCD runner. |
| |
| Configuring a Console |
| ===================== |
| |
| Regardless of your choice in debug probe, we will use the OpenSDA |
| microcontroller as a usb-to-serial adapter for the serial console. |
| |
| Connect a USB cable from your PC to J7. |
| |
| Use the following settings with your serial terminal of choice (minicom, putty, |
| etc.): |
| |
| - Speed: 115200 |
| - Data: 8 bits |
| - Parity: None |
| - Stop bits: 1 |
| |
| Flashing |
| ======== |
| |
| Here is an example for the :zephyr:code-sample:`hello_world` application. |
| |
| .. zephyr-app-commands:: |
| :zephyr-app: samples/hello_world |
| :board: frdm_kl25z |
| :goals: flash |
| |
| Open a serial terminal, reset the board (press the SW1 button), and you should |
| see the following message in the terminal: |
| |
| .. code-block:: console |
| |
| ***** Booting Zephyr OS v1.14.0-rc1 ***** |
| Hello World! frdm_kl25z |
| |
| Debugging |
| ========= |
| |
| Here is an example for the :zephyr:code-sample:`hello_world` application. |
| |
| .. zephyr-app-commands:: |
| :zephyr-app: samples/hello_world |
| :board: frdm_kl25z |
| :goals: debug |
| |
| Open a serial terminal, step through the application in your debugger, and you |
| should see the following message in the terminal: |
| |
| .. code-block:: console |
| |
| ***** Booting Zephyr OS v1.14.0-rc1 ***** |
| Hello World! frdm_kl25z |
| |
| .. include:: ../../common/board-footer.rst |
| :start-after: nxp-board-footer |
| |
| .. _FRDM-KL25Z Website: |
| https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/kinetis-cortex-m-mcus/l-seriesultra-low-powerm0-plus/freedom-development-platform-for-kinetis-kl14-kl15-kl24-kl25-mcus:FRDM-KL25Z |
| |
| .. _FRDM-KL25Z User Guide: |
| https://www.nxp.com/webapp/Download?colCode=FRDMKL25ZUM |
| |
| .. _FRDM-KL25Z Schematics: |
| https://www.nxp.com/downloads/en/schematics/FRDM-KL25Z_SCH_REV_E.pdf |
| |
| .. _KL25Z Website: |
| https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/kinetis-cortex-m-mcus/l-seriesultra-low-powerm0-plus/kinetis-kl2x-72-96mhz-usb-ultra-low-power-microcontrollers-mcus-based-on-arm-cortex-m0-plus-core:KL2x?&l |
| |
| .. _KL25Z Datasheet: |
| https://www.nxp.com/docs/en/data-sheet/KL25P80M48SF0.pdf |
| |
| .. _KL25Z Reference Manual: |
| https://www.nxp.com/webapp/Download?colCode=KL25P80M48SF0RM |
| |
| .. _DAPLink Bootloader Update: |
| https://os.mbed.com/blog/entry/DAPLink-bootloader-update/ |
| |
| .. _OpenSDA DAPLink FRDM-KL25Z Firmware: |
| https://www.nxp.com/downloads/en/ide-debug-compile-build-tools/OpenSDAv2.2_DAPLink_frdmkl25z_rev0242.zip |
| |
| .. _OpenSDA J-Link FRDM-KL25Z Firmware: |
| https://www.segger.com/downloads/jlink/OpenSDA_FRDM-KL25Z |
