Skip to content

Commit e9fd4b1

Browse files
butokkartben
authored andcommitted
boards: nxp: mimxrt1170_evk: Update the documentation
- Adds reference to the MIMXRT1170-EVKB Board Hardware User's Guide. - Mentions that LinkServer is the default runner (not Jlink). Signed-off-by: Andrej Butok <[email protected]>
1 parent d75fe02 commit e9fd4b1

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

boards/nxp/mimxrt1170_evk/doc/index.rst

+14-11
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ these references:
7373
- `i.MX RT1170 Datasheet`_
7474
- `i.MX RT1170 Reference Manual`_
7575
- `MIMXRT1170-EVK Website`_
76+
- `MIMXRT1170-EVKB Board Hardware User's Guide`_
7677
- `MIMXRT1170-EVK Board Hardware User's Guide`_
7778

7879
External Memory
@@ -295,29 +296,28 @@ reprogrammed with JLink firmware.
295296
- MIMXRT1170-EVKB: :ref:`mcu-link-cmsis-onboard-debug-probe`
296297
- MIMXRT1170-EVK: :ref:`opensda-daplink-onboard-debug-probe`
297298

299+
Using LinkServer
300+
----------------
301+
302+
Install the :ref:`linkserver-debug-host-tools` and make sure they are in your
303+
search path. LinkServer works with the default CMSIS-DAP firmware included in
304+
the on-board debugger.
305+
298306
Using J-Link
299307
------------
300308

301-
JLink is the default runner for this board. Install the
302-
:ref:`jlink-debug-host-tools` and make sure they are in your search path.
309+
Install the :ref:`jlink-debug-host-tools` and make sure they are in your search path.
303310

304311
There are two options: the onboard debug circuit can be updated with Segger
305312
J-Link firmware, or :ref:`jlink-external-debug-probe` can be attached to the
306313
EVK. See `Using J-Link with MIMXRT1170-EVKB`_ or
307314
`Using J-Link with MIMXRT1160-EVK or MIMXRT1170-EVK`_ for more details.
308315

309-
Using LinkServer
310-
----------------
311-
312-
Install the :ref:`linkserver-debug-host-tools` and make sure they are in your
313-
search path. LinkServer works with the default CMSIS-DAP firmware included in
314-
the on-board debugger.
315-
316-
Use the ``-r linkserver`` option with West to use the LinkServer runner.
316+
Use the ``-r jlink`` option with West to use the jlink runner.
317317

318318
.. code-block:: console
319319
320-
west flash -r linkserver
320+
west flash -r jlink
321321
322322
Alternatively, pyOCD can be used to flash and debug the board by using the
323323
``-r pyocd`` option with West. pyOCD is installed when you complete the
@@ -404,6 +404,9 @@ the option ``-DEXTRA_DTC_OVERLAY_FILE=nxp,enet1g.overlay`` instead.
404404
.. _MIMXRT1170-EVK Board Hardware User's Guide:
405405
https://www.nxp.com/webapp/Download?colCode=MIMXRT1170EVKHUG
406406

407+
.. _MIMXRT1170-EVKB Board Hardware User's Guide:
408+
https://www.nxp.com/webapp/Download?colCode=MIMXRT1170EVKBHUG
409+
407410
.. _i.MX RT1170 Website:
408411
https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/i-mx-rt-crossover-mcus/i-mx-rt1170-crossover-mcu-family-first-ghz-mcu-with-arm-cortex-m7-and-cortex-m4-cores:i.MX-RT1170
409412

0 commit comments

Comments
 (0)