Skip to content

Commit 33bf0a8

Browse files
authored
Merge pull request #3453 from nvlsianpu/nrf5_doc
[NRF5] documnetation - readme file for nRF5x bases targets
2 parents 15d1944 + 7dd5a59 commit 33bf0a8

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

targets/TARGET_NORDIC/README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Nordic platform's readme
2+
3+
This readme file contains several hints useful for any Nordic's user.
4+
5+
## 1. Nordic’s development kit targets
6+
7+
Nordic provides several development kit targets, called *[base target]*. For example:
8+
- NRF51_DK
9+
- NRF52_DK
10+
- NRF51_DONGLE
11+
12+
Nordic continuously supports mbed and other targets will become available with releases of new Nordic development kits.
13+
14+
## 2. Regular and FOTA targets types
15+
For most of nRF5x SoC development kits, three flavors of the targets are provided:
16+
17+
- *[base target]* is the default target. A compiled binary will incorporate both the user application and the SoftDevice. A binary built using this target is intended to be downloaded to the DK using an on-board USB debugger/programmer. For example, NRF52_DK target.
18+
19+
- *[base target]*_BOOT is a target with firmware update support. A compiled binary will incorporate a user application, the SoftDevice, and the precompiled BLE bootloader code. This target should be used to provide DFU capabilities by the application (e.g BLE DFU service). A binary built using this target is intended to be downloaded to the DK using an on-board USB debugger/programmer. For example, NRF52_DK_BOOT target.
20+
21+
*[base target]*_OTA. A compiled binary will contain only the application. A binary build using this target is intended to be downloaded to the DK using BLE Bootloader. For example, NRF52_DK_OTA target.
22+
23+
## 3. Bootloader selection
24+
25+
It is possible to select one of the provided precompiled bootloaders for NRF51_DK_BOOT and NRF52_DK_BOOT targets. Two versions of the bootloader are provided: single-bank bootloader and the dual-bank bootloader. For further information about the differences, see Nordic's [infocenter](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v11.0.0%2Fbledfu_memory_banks.html). To select the bootloader, use the *target.bootloader_select_index* keyword over [mbed configuration system](../../docs/config_system.md). The expected values are:
26+
- target.bootloader_select_index = 0 -> Use single-bank bootloader. It is the default value.
27+
- target.bootloader_select_index = 1 -> Use dual-bank bootloader.
28+
29+
The following is an example of selecting the dual-bank bootloader from application settings by putting a description into mbed_app.json:
30+
```json
31+
{
32+
"target_overrides": {
33+
"*": {
34+
"target.bootloader_select_index": 1
35+
}
36+
}
37+
}
38+
```
39+
40+
## 4. LF Clock configuration using mbed configuration system
41+
The feature is provided so far for NRF5 targets, such as NRF51_DK, NRF52_DK, and TARGET_TY51822R3. For further information, see [LF_Clock_config.md](./TARGET_NRF5/LF_Clock_config.md).
42+
43+
## 5. UART hardware flow control configuration using mbed configuration system
44+
The feature is provided so far for NRF5 targets, such as NRF51_DK, NRF52_DK, and TARGET_TY51822R3.
45+
In order to configure hardware flow control for nRF5x UART, use the target.uart_hwfc keyword. Value 0 will disable flow control. Value 1 will enable flow control. Flow control is turned on by default.
46+
For example, on application level, put the following description into the mbed_app.json file:
47+
```json
48+
"target_overrides": {
49+
"NRF51_DK": {
50+
"target.uart_hwfc": 0
51+
}
52+
}
53+
```
54+
55+
56+

0 commit comments

Comments
 (0)