michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/boards/raytac/mdbt50q_cx_40_dongle/doc/index.rst

297 lines
10 KiB
ReStructuredText
Raw Normal View History

boards: raytac: Add support for raytac_mdbt50q_cx_40_dongle Add support for Raytac's new TYPE-C dongle. Signed-off-by: Stanley Huang <stanley@raytac.com>
2025-04-23 09:54:31 +08:00
.. zephyr:board:: raytac_mdbt50q_cx_40_dongle
Overview
********
The Raytac MDBT50Q-CX-40 Dongle hardware provides support for the Nordic
Semiconductor nRF52840 ARM Cortex-M4F CPU and the following devices:
- Nordic nRF52840 SoC Solution Dongle
- A recommended 3rd-party module by Nordic Semiconductor.
- BT5.4 & BT5.2 & BT5.1 & BT5 Bluetooth Specification Certified.
- Type C USB
- Supports Open Bootloader
- Supports BT5 Long Range Feature
- Deployed Raytac MDBT50Q-P1M Module
- Certifications: FCC, IC, CE, UKCA, Telec (MIC), KC, SRRC, NCC, RCM, WPC
- 32-bit ARM® Cortex™ M4F CPU
- 1MB Flash Memory / 256kB RAM
- RoHS & Reach Compliant.
- Dimension：26.2 x 15.1 x 6.8 mm (excluding Type C USB Connector)
- Highly flexible multiprotocol SoC ideally suited for Bluetooth® Low Energy,
ANT+, Zigbee, Thread (802.15.4) ultra low-power wireless applications.
Hardware
********
The ``raytac_mdbt50q_cx_40_dongle/nrf52840`` board target has two external oscillators. The frequency of
the slow clock is 32.768 kHz. The frequency of the main clock is 32 MHz.
Supported Features
==================
.. zephyr:board-supported-hw::
Connections and IOs
===================
LED
---
* LED0 ( blue ) = P0.8
* LED1 ( blue ) = P0.6 (No pasted components by default)
Push buttons
------------
* BUTTON1 = SW1 = P1.6
Programming and Debugging
*************************
.. zephyr:board-supported-runners::
Applications for the ``raytac_mdbt50q_cx_40_dongle/nrf52840`` board target can be
built in the usual way (see :ref:`build_an_application` for more details).
Flashing
========
The board supports the following programming options:
1. Using the built-in bootloader only
2. Using MCUboot in serial recovery mode
3. Using an external :ref:`debug probe <debug-probes>`
These instructions use the :ref:`west <west>` tool and assume you are in the
root directory of your :term:`west installation`.
Option 1: Using the Built-In Bootloader Only
--------------------------------------------
The board is factory-programmed with Open bootloader from Nordic's nRF5
SDK. With this option, you'll use Nordic's `nrfutil`_ program to create
firmware packages supported by this bootloader and flash them to the
device. Make sure ``nrfutil`` is installed before proceeding.
#. Hold the button and plug it into the USB socket in the bootloader.
The push button is on the far side of the board from the USB connector. Note
that the button does not face up. You will have to push it from the outside
in, towards the USB connector:
.. image:: img/raytac_mdbt50q_cx_40_dongle_button_led.webp
:alt: Location of the user button and LED.
The red LED should start a fade pattern, signalling the bootloader is
running.
#. Compile a Zephyr application; we'll use :zephyr:code-sample:`blinky`.
.. zephyr-app-commands::
:app: zephyr/samples/basic/blinky
:board: raytac_mdbt50q_cx_40_dongle/nrf52840
:goals: build
#. Package the application for the bootloader using ``nrfutil``:
.. code-block:: console
nrfutil nrf5sdk-tools pkg generate \
--hw-version 52 \
--sd-req=0x00 \
--application build/zephyr/zephyr.hex \
--application-version 1 \
blinky.zip
#. Flash it onto the board. Note :file:`/dev/ttyACM0` is for Linux; it will be
something like ``COMx`` on Windows, and something else on macOS.
.. code-block:: console
nrfutil nrf5sdk-tools dfu usb-serial -pkg blinky.zip -p /dev/ttyACM0
When this command exits, observe the green LED on the board blinking,
instead of the red LED used by the bootloader.
For more information, see `Nordic Semiconductor USB DFU`_.
Option 2: Using MCUboot in Serial Recovery Mode
-----------------------------------------------
It is also possible to use the MCUboot bootloader with this board to flash
Zephyr applications. You need to do some one-time set-up to build and flash
MCUboot on your board. From that point on, you can build and flash other Zephyr
applications using MCUboot's serial recovery mode. This process does not
overwrite the built-in Nordic bootloader, so you can always go back to using
Option 1 later.
Install `nrfutil`_ and `mcumgr`_ first, and make sure MCUboot's ``imgtool`` is
available for signing your binary for MCUboot as described on :ref:`west-sign`.
Next, do the **one-time setup** to flash MCUboot. We'll assume you've cloned
the `MCUboot`_ repository into the directory ``mcuboot``, and that it is next
to the zephyr repository on your computer.
#. Reset the board into the Nordic bootloader as described above.
#. Compile MCUboot as a Zephyr application.
.. zephyr-app-commands::
:app: mcuboot/boot/zephyr
:board: raytac_mdbt50q_cx_40_dongle/nrf52840
:build-dir: mcuboot
:goals: build
#. Package the application for the bootloader using ``nrfutil``:
.. code-block:: console
nrfutil nrf5sdk-tools pkg generate \
--hw-version 52 \
--sd-req=0x00 \
--application build/mcuboot/zephyr/zephyr.hex \
--application-version 1 \
mcuboot.zip
#. Flash it onto the board. Note :file:`/dev/ttyACM0` is for Linux; it will be
something like ``COMx`` on Windows, and something else on macOS.
.. code-block:: console
nrfutil nrf5sdk-tools dfu usb-serial -pkg mcuboot.zip -p /dev/ttyACM0
You can now flash a Zephyr application to the board using MCUboot's serial
recovery mode. We'll use the :zephyr:code-sample:`smp-svr` sample since it's ready to be
compiled for chain-loading by MCUboot (and itself supports firmware updates
over Bluetooth).
#. Boot into MCUboot serial recovery mode by plugging the board in with the SW1
button pressed down. See above for a picture showing where SW1 is.
A serial port will enumerate on your board. On Windows, "MCUBOOT" should
appear under "Other Devices" in the Device Manager (in addition to the usual
``COMx`` device). On Linux, something like
:file:`/dev/serial/by-id/usb-ZEPHYR_MCUBOOT_0.01-if00` should be created.
If no serial port appears, try plugging it in again, making sure SW1 is
pressed. If it still doesn't appear, retry the one-time MCUboot setup.
#. Compile ``smp_svr``.
.. zephyr-app-commands::
:app: zephyr/samples/subsys/mgmt/mcumgr/smp_svr
:board: raytac_mdbt50q_cx_40_dongle/nrf52840
:build-dir: smp_svr
:goals: build
#. Sign ``smp_svr`` for chain-loading by MCUboot.
.. code-block:: console
west sign -t imgtool --bin --no-hex -d build/smp_svr \
-B smp_svr.signed.bin -- --key mcuboot/root-rsa-2048.pem
#. Flash the application to the MCUboot serial port using ``mcumgr``:
.. code-block:: console
mcumgr --conntype=serial --connstring='dev=/dev/ttyACM0,baud=115200' \
image upload -e smp_svr.signed.bin
#. Reset the device:
.. code-block:: console
mcumgr --conntype=serial --connstring='dev=/dev/ttyACM0,baud=115200' reset
You should now be able to scan for Bluetooth devices using a smartphone or
computer. The device you just flashed will be listed with ``Zephyr`` in its
name.
.. note::
This board supports building other Zephyr applications for flashing with
MCUboot in this way also. Just make sure :kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT`
is set when building your application. For example, to compile blinky for
loading by MCUboot, use this:
.. zephyr-app-commands::
:app: zephyr/samples/basic/blinky
:board: raytac_mdbt50q_cx_40_dongle/nrf52840
:build-dir: blinky
:goals: build
:gen-args: -DCONFIG_BOOTLOADER_MCUBOOT=y
You can then sign and flash it using the steps above.
Option 3: Using an External Debug Probe
---------------------------------------
If you have one, you can also use an external :ref:`debug probe <debug-probes>`
to flash and debug Zephyr applications, but you need to solder an SWD header
onto the back side of the board.
For Segger J-Link debug probes, follow the instructions in the
:ref:`nordic_segger` page to install and configure all the necessary
software. Further information can be found in :ref:`nordic_segger_flashing`.
Locate the DTS file: :``boards/raytac/raytac_mdbt50q_cx_40_dongle_nrf52840.dts``.
This file requires a small modification to use a different partition table.
Edit the include directive to include "fstab-debugger" instead of "fstab-stock".
In addition, the Kconfig file in the same directory must be modified by setting
``BOARD_HAS_NRF5_BOOTLOADER`` to be default ``n``, otherwise the code will be
flashed with an offset.
Then build and flash applications as usual (see :ref:`build_an_application` and
:ref:`application_run` for more details).
Here is an example for the :zephyr:code-sample:`blinky` application.
.. zephyr-app-commands::
:zephyr-app: samples/basic/blinky
:board: raytac_mdbt50q_cx_40_dongle/nrf52840
:goals: build flash
Observe the LED on the board blinking.
Debugging
=========
The ``raytac_mdbt50q_cx_40_dongle/nrf52840`` board does not have an on-board J-Link debug IC
as some nRF5x development boards, however, instructions from the
:ref:`nordic_segger` page also apply to this board, with the additional step
of connecting an external debugger.
Testing the LEDs and buttons on the Raytac MDBT50Q-CX-40 Dongle
***************************************************************
There are 2 samples that allow you to test that the buttons (switches) and LEDs on
the board are working properly with Zephyr:
* :zephyr:code-sample:`blinky`
* :zephyr:code-sample:`button`
You can build and program the examples to make sure Zephyr is running correctly
on your board.
References
**********
.. target-notes::
.. _Raytac MDBT50Q-CX-40 Dongle website:
https://www.raytac.com/product/ins.php?index_id=156
.. _Raytac MDBT50Q-CX-40 Dongle Spec: https://www.raytac.com/download/index.php?index_id=72
.. _Raytac MDBT50Q-CX-40 Dongle Hardware description: https://www.raytac.com/product/ins.php?index_id=156
.. _Nordic Semiconductor USB DFU:
https://docs.nordicsemi.com/bundle/sdk_nrf5_v17.1.0/page/sdk_app_serial_dfu_bootloader.html
.. _nrfutil:
https://www.nordicsemi.com/Products/Development-tools/nrf-util
.. _MCUboot:
https://github.com/JuulLabs-OSS/mcuboot
.. _mcumgr:
https://github.com/apache/mynewt-mcumgr-cli
Copy permalink