From 774f8a5bce485fff36f382e7fdbad9b4ed71ed3b Mon Sep 17 00:00:00 2001 From: Andrzej Puzdrowski Date: Tue, 13 Dec 2016 17:39:56 +0100 Subject: [PATCH 1/6] Add ReadMe description for NRF5 targets. --- targets/TARGET_NORDIC/ReadMe.md.txt | 54 +++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 targets/TARGET_NORDIC/ReadMe.md.txt diff --git a/targets/TARGET_NORDIC/ReadMe.md.txt b/targets/TARGET_NORDIC/ReadMe.md.txt new file mode 100644 index 00000000000..f13016189aa --- /dev/null +++ b/targets/TARGET_NORDIC/ReadMe.md.txt @@ -0,0 +1,54 @@ +# Nordic platforms ReadMe + +This Description contains several hints useful for any Nordic's user. + +## 1. Nordic’s development kit targets + + +Nordic provide few development kit targets - called beyond *[base target]*, for example: +- NRF51_DK +- NRF51_DK_LEGACY +- NRF52_DK +- NRF51_DONGLE +- others, mbed-os is under continuous construction! + +For most of Nordic’s development kits few version of targets are provided: +A *[base target]* is the default target. Compiled binary will incorporate both a user application and the SoftDevice. Binary build using this target is intended to be download to DK using on-board USB debugger/programmer. For example, NRF52_DK target. + +*[base target]*_BOOT – it is target with firmware update support. 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 an application (e.g BLE DFU service). Binary build using this target is intended to be download to DK using on-board USB debugger/programmer. For example, NRF52_DK_BOOT target. + +*[base target]*_OTA – Compiled binary will contain only an application. Binary build using this target is intended to be download to DK using BLE Bootloader. For example, NRF52_DK_OTA target. + +## 2. Bootloader selection +It is posisble to select on of provided precompiled bootloader for NRF51_DK_BOOT and NRF52_DK_BOOT targets. There are provide two version of bootloader: the single bank bootloader and the dual bank bootloader. For further information about differences look into Nordic's [infocenter](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v11.0.0%2Fbledfu_memory_banks.html). Selection is possible using *target.bootloader_select_index* keyword over [mbed configuration system](https://github.com/ARMmbed/mbed-os/blob/master/docs/config_system.md). Expected values are: + - target.bootloader_select_index = 0 -> use single bank bootloader. It is default value. + - target.bootloader_select_index = 1 -> use dual bank bootloader + +For example selecting dual bank bootloader from application settings by putting description into mbed_app.json +```json +{ +"target_overrides": { + "*": { + "target.bootloader_select_index": 1 + } + } +} +``` + +## 3. LF Clock configuration using mbed configuration system +Feature is provided so far for NRF5 targets e.g.: (NRF51_DK, NRF52_DK, TARGET_TY51822R3). For further information see [LF_Clock_config.md](https://github.com/ARMmbed/mbed-os/blob/mbed-os-5.3.0-rc3/targets/TARGET_NORDIC/TARGET_NRF5/LF_Clock_config.md). + +## 4. UART hardware flow control configuration using mbed configuration system. +Feature is provided so far for NRF5 targets e.g.: (NRF51_DK, NRF52_DK, TARGET_TY51822R3). +In order to configure hardware flow control for nRF5x UART use target.uart_hwfc keyword. Value 0 will disable flow control. Value 1 will enable flow control. Flow control is turn on by default. +For example on application level put bellow description into mbed_app.json file. +```json +"target_overrides": { + "NRF51_DK": { + "target.uart_hwfc": 0 + } +} +``` + + + From dab3b8a9c74079ddf64dc9d1a9d17e001f349d4e Mon Sep 17 00:00:00 2001 From: Andrzej Puzdrowski Date: Tue, 13 Dec 2016 17:50:11 +0100 Subject: [PATCH 2/6] rename ReadMe.md.txt to ReadMe.md --- targets/TARGET_NORDIC/{ReadMe.md.txt => ReadMe.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename targets/TARGET_NORDIC/{ReadMe.md.txt => ReadMe.md} (100%) diff --git a/targets/TARGET_NORDIC/ReadMe.md.txt b/targets/TARGET_NORDIC/ReadMe.md similarity index 100% rename from targets/TARGET_NORDIC/ReadMe.md.txt rename to targets/TARGET_NORDIC/ReadMe.md From 109c284c58adda9da7e154d6f55de92f907f6104 Mon Sep 17 00:00:00 2001 From: Andrzej Puzdrowski Date: Wed, 14 Dec 2016 07:39:49 +0100 Subject: [PATCH 3/6] make internal links a local links --- targets/TARGET_NORDIC/ReadMe.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/targets/TARGET_NORDIC/ReadMe.md b/targets/TARGET_NORDIC/ReadMe.md index f13016189aa..5b2a6b21ca4 100644 --- a/targets/TARGET_NORDIC/ReadMe.md +++ b/targets/TARGET_NORDIC/ReadMe.md @@ -20,7 +20,7 @@ A *[base target]* is the default target. Compiled binary will incorporate both a *[base target]*_OTA – Compiled binary will contain only an application. Binary build using this target is intended to be download to DK using BLE Bootloader. For example, NRF52_DK_OTA target. ## 2. Bootloader selection -It is posisble to select on of provided precompiled bootloader for NRF51_DK_BOOT and NRF52_DK_BOOT targets. There are provide two version of bootloader: the single bank bootloader and the dual bank bootloader. For further information about differences look into Nordic's [infocenter](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v11.0.0%2Fbledfu_memory_banks.html). Selection is possible using *target.bootloader_select_index* keyword over [mbed configuration system](https://github.com/ARMmbed/mbed-os/blob/master/docs/config_system.md). Expected values are: +It is posisble to select on of provided precompiled bootloader for NRF51_DK_BOOT and NRF52_DK_BOOT targets. There are provide two version of bootloader: the single bank bootloader and the dual bank bootloader. For further information about differences look into Nordic's [infocenter](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v11.0.0%2Fbledfu_memory_banks.html). Selection is possible using *target.bootloader_select_index* keyword over [mbed configuration system](../../docs/config_system.md). Expected values are: - target.bootloader_select_index = 0 -> use single bank bootloader. It is default value. - target.bootloader_select_index = 1 -> use dual bank bootloader @@ -36,7 +36,7 @@ For example selecting dual bank bootloader from application settings by putting ``` ## 3. LF Clock configuration using mbed configuration system -Feature is provided so far for NRF5 targets e.g.: (NRF51_DK, NRF52_DK, TARGET_TY51822R3). For further information see [LF_Clock_config.md](https://github.com/ARMmbed/mbed-os/blob/mbed-os-5.3.0-rc3/targets/TARGET_NORDIC/TARGET_NRF5/LF_Clock_config.md). +Feature is provided so far for NRF5 targets e.g.: (NRF51_DK, NRF52_DK, TARGET_TY51822R3). For further information see [LF_Clock_config.md](./TARGET_NRF5/LF_Clock_config.md). ## 4. UART hardware flow control configuration using mbed configuration system. Feature is provided so far for NRF5 targets e.g.: (NRF51_DK, NRF52_DK, TARGET_TY51822R3). From 39b74f38b30155db08a5c2bf8cc9a1057dcf6ef2 Mon Sep 17 00:00:00 2001 From: Bartosz Gentkowski Date: Thu, 15 Dec 2016 16:58:46 +0100 Subject: [PATCH 4/6] readme doc review --- targets/TARGET_NORDIC/ReadMe.md | 43 +++++++++++++++++---------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/targets/TARGET_NORDIC/ReadMe.md b/targets/TARGET_NORDIC/ReadMe.md index 5b2a6b21ca4..b3a9bd64d3b 100644 --- a/targets/TARGET_NORDIC/ReadMe.md +++ b/targets/TARGET_NORDIC/ReadMe.md @@ -1,30 +1,31 @@ -# Nordic platforms ReadMe +# Nordic platform's readme -This Description contains several hints useful for any Nordic's user. +This readme file contains several hints useful for any Nordic's user. ## 1. Nordic’s development kit targets +Nordic provides several development kit targets, called *[base target]*. For example: +- NRF51_DK +- NRF51_DK_LEGACY +- NRF52_DK +- NRF51_DONGLE +- others are incoming as mbed-os is under continuous construction! -Nordic provide few development kit targets - called beyond *[base target]*, for example: -- NRF51_DK -- NRF51_DK_LEGACY -- NRF52_DK -- NRF51_DONGLE -- others, mbed-os is under continuous construction! +For most of Nordic’s development kits, a few versions of the targets are provided: -For most of Nordic’s development kits few version of targets are provided: -A *[base target]* is the default target. Compiled binary will incorporate both a user application and the SoftDevice. Binary build using this target is intended to be download to DK using on-board USB debugger/programmer. For example, NRF52_DK target. +- *[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. -*[base target]*_BOOT – it is target with firmware update support. 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 an application (e.g BLE DFU service). Binary build using this target is intended to be download to DK using on-board USB debugger/programmer. For example, NRF52_DK_BOOT target. +- *[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. -*[base target]*_OTA – Compiled binary will contain only an application. Binary build using this target is intended to be download to DK using BLE Bootloader. For example, NRF52_DK_OTA target. +*[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. ## 2. Bootloader selection -It is posisble to select on of provided precompiled bootloader for NRF51_DK_BOOT and NRF52_DK_BOOT targets. There are provide two version of bootloader: the single bank bootloader and the dual bank bootloader. For further information about differences look into Nordic's [infocenter](http://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v11.0.0%2Fbledfu_memory_banks.html). Selection is possible using *target.bootloader_select_index* keyword over [mbed configuration system](../../docs/config_system.md). Expected values are: - - target.bootloader_select_index = 0 -> use single bank bootloader. It is default value. - - target.bootloader_select_index = 1 -> use dual bank bootloader -For example selecting dual bank bootloader from application settings by putting description into mbed_app.json +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: + - target.bootloader_select_index = 0 -> Use single-bank bootloader. It is the default value. + - target.bootloader_select_index = 1 -> Use dual-bank bootloader. + +The following is an example of selecting the dual-bank bootloader from application settings by putting a description into mbed_app.json: ```json { "target_overrides": { @@ -36,12 +37,12 @@ For example selecting dual bank bootloader from application settings by putting ``` ## 3. LF Clock configuration using mbed configuration system -Feature is provided so far for NRF5 targets e.g.: (NRF51_DK, NRF52_DK, TARGET_TY51822R3). For further information see [LF_Clock_config.md](./TARGET_NRF5/LF_Clock_config.md). +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). -## 4. UART hardware flow control configuration using mbed configuration system. -Feature is provided so far for NRF5 targets e.g.: (NRF51_DK, NRF52_DK, TARGET_TY51822R3). -In order to configure hardware flow control for nRF5x UART use target.uart_hwfc keyword. Value 0 will disable flow control. Value 1 will enable flow control. Flow control is turn on by default. -For example on application level put bellow description into mbed_app.json file. +## 4. UART hardware flow control configuration using mbed configuration system +The feature is provided so far for NRF5 targets, such as NRF51_DK, NRF52_DK, and TARGET_TY51822R3. +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. +For example, on application level, put the following description into the mbed_app.json file: ```json "target_overrides": { "NRF51_DK": { From 54804fe54fac6cf9ea2fbd68a463da56dc8fd973 Mon Sep 17 00:00:00 2001 From: Andrzej Puzdrowski Date: Tue, 20 Dec 2016 15:12:29 +0100 Subject: [PATCH 5/6] changed name of nordic's ReadMe.md to README.md --- targets/TARGET_NORDIC/{ReadMe.md => README.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename targets/TARGET_NORDIC/{ReadMe.md => README.md} (100%) diff --git a/targets/TARGET_NORDIC/ReadMe.md b/targets/TARGET_NORDIC/README.md similarity index 100% rename from targets/TARGET_NORDIC/ReadMe.md rename to targets/TARGET_NORDIC/README.md From 7dd5a59a95b7756835340fd586985ca08b909945 Mon Sep 17 00:00:00 2001 From: Andrzej Puzdrowski Date: Wed, 11 Jan 2017 14:18:32 +0100 Subject: [PATCH 6/6] Corectons of Nordic tagrets redme file (repharse) --- targets/TARGET_NORDIC/README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/targets/TARGET_NORDIC/README.md b/targets/TARGET_NORDIC/README.md index b3a9bd64d3b..0aba2367146 100644 --- a/targets/TARGET_NORDIC/README.md +++ b/targets/TARGET_NORDIC/README.md @@ -6,12 +6,13 @@ This readme file contains several hints useful for any Nordic's user. Nordic provides several development kit targets, called *[base target]*. For example: - NRF51_DK -- NRF51_DK_LEGACY - NRF52_DK - NRF51_DONGLE -- others are incoming as mbed-os is under continuous construction! -For most of Nordic’s development kits, a few versions of the targets are provided: +Nordic continuously supports mbed and other targets will become available with releases of new Nordic development kits. + +## 2. Regular and FOTA targets types +For most of nRF5x SoC development kits, three flavors of the targets are provided: - *[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. @@ -19,7 +20,7 @@ For most of Nordic *[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. -## 2. Bootloader selection +## 3. Bootloader selection 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: - target.bootloader_select_index = 0 -> Use single-bank bootloader. It is the default value. @@ -36,10 +37,10 @@ The following is an example of selecting the dual-bank bootloader from applicati } ``` -## 3. LF Clock configuration using mbed configuration system +## 4. LF Clock configuration using mbed configuration system 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). -## 4. UART hardware flow control configuration using mbed configuration system +## 5. UART hardware flow control configuration using mbed configuration system The feature is provided so far for NRF5 targets, such as NRF51_DK, NRF52_DK, and TARGET_TY51822R3. 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. For example, on application level, put the following description into the mbed_app.json file: