aboutsummaryrefslogtreecommitdiff
path: root/platform/ext/target/nordic_nrf/nrf5340pdk_nrf5340_cpuapp/README.rst
blob: 64b87655a854ecca7085e21833d54928250db1da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
Nordic nRF5340
==============

The nRF5340 preview development kit (PDK) is a single-board development kit for
the evaluation and development on the Nordic nRF5340 System-on-Chip (SoC).

The nRF5340 is a dual-core SoC based on the Arm® Cortex®-M33 architecture, with:

* a full-featured ARM Cortex-M33F core with DSP instructions, FPU, and
  ARMv8-M Security Extension, running at up to 128 MHz, referred to as
  the **Application MCU**
* a secondary ARM Cortex-M33 core, with a reduced feature set, running at
  a fixed 64 MHz, referred to as the **Network MCU**.

The nRF5340 Application MCU supports the Armv8m Security Extension.

Documentation
-------------

The following links provide useful information about the nRF5340

nRF5340 PDK website:
   https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF5340-PDK

Nordic Semiconductor Infocenter: https://infocenter.nordicsemi.com


Building TF-M on nRF5340 Application MCU
----------------------------------------

To build an S and NS application image for the nRF5340 Application MCU run the
following commands:

    **Note**: On OS X change ``readlink`` to ``greadlink``, available by
    running ``brew install coreutils``.

.. code:: bash

    $ mkdir build && cd build
    $ cmake -DTFM_PLATFORM=nordic_nrf/nrf5340pdk_nrf5340_cpuapp \
            -DTFM_TOOLCHAIN_FILE=../toolchain_GNUARM.cmake \
            ../
    $ make install

    **Note**: Currently, applications can only be built using GCC
    (GNU ARM Embedded toolchain).

    **Note**: For BL2 (MCUBoot) logging output to be available, the project needs
    to be built with Debug configuration (CMAKE_BUILD_TYPE=Debug).

Flashing and debugging with Nordic nRF Segger J-Link
-----------------------------------------------------

nRF5340 PDK is equipped with a Debug IC (Atmel ATSAM3U2C) which provides the
following functionality:

* Segger J-Link firmware and desktop tools
* SWD debug for the nRF5340 IC
* Mass Storage device for drag-and-drop image flashing
* USB CDC ACM Serial Port bridged to the nRFx UART peripheral
* Segger RTT Console
* Segger Ozone Debugger

To install the J-Link Software and documentation pack, follow the steps below:

#. Download the appropriate package from the `J-Link Software and documentation pack`_ website
#. Depending on your platform, install the package or run the installer
#. When connecting a J-Link-enabled board such as an nRF5340 PDK, a
   drive corresponding to a USB Mass Storage device as well as a serial port should come up

nRF Command-Line Tools Installation
*************************************

The nRF Command-line Tools allow you to control your nRF5340 device from the command line,
including resetting it, erasing or programming the flash memory and more.

To install them, visit `nRF Command-Line Tools`_ and select your operating
system.

After installing, make sure that ``nrfjprog`` is somewhere in your executable path
to be able to invoke it from anywhere.

BL2, S, and NS application images can be flashed into nRF5340 separately or may be merged
together into a single binary.

Flashing the nRF5340 PDK
************************

To program the flash with a compiled TF-M image (i.e. S, NS or both) after having
followed the instructions to install the Segger J-Link Software and the nRF
Command-Line Tools, follow the steps below:

Generate Intel hex files from the output binary (bin) files as follows:

.. code-block:: console

   srec_cat install/outputs/NORDIC_NRF/NRF5340PDK_NRF5340_CPUAPP/tfm_s_ns_signed.bin -binary --offset=0x10000 -o install/outputs/NORDIC_NRF/NRF5340PDK_NRF5340_CPUAPP/tfm_s_ns_signed.hex -intel

* Connect the micro-USB cable to the nRF5340 PDK and to your computer
* Erase the flash memory in the nRF5340 IC:

.. code-block:: console

   nrfjprog --eraseall -f nrf53

* Flash the BL2 and the TF-M image binaries from the sample folder of your choice:

.. code-block:: console

   nrfjprog --program <sample folder>/install/outputs/NORDIC_NRF/NRF5340PDK_NRF5340_CPUAPP/bl2.hex -f nrf53 --sectorerase
   nrfjprog --program <sample folder>/install/outputs/NORDIC_NRF/NRF5340PDK_NRF5340_CPUAPP/tfm_s_ns_signed.hex -f nrf53 --sectorerase

* Reset and start TF-M:

.. code-block:: console

   nrfjprog --reset -f nrf53


Secure UART Console on nRF5340 PDK
**********************************

SECURE_UART1 is enabled by default when building TF-M on nRF5340 PDK, so the secure firmware console output
is available via USART1. To route the USART1 output to one of the serial ports, wire the default USART1 TxD
and RxD (pins P0.25 and P0.26) to RxD and TxD pins on the PDK.

Non-Secure console output is available via USART0.

    **Note**: By default USART0 and USART1 outputs are routed to separate serial ports.

.. _nRF Command-Line Tools: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools

.. _J-Link Software and documentation pack: https://www.segger.com/jlink-software.html

--------------

*Copyright (c) 2020, Arm Limited. All rights reserved.*
*Copyright (c) 2020, Nordic Semiconductor. All rights reserved.*