Nanostack RF driver updates for Mbed OS 5.14.1

[JarkkoPaso]

Description

Nanostack RF driver updates for Mbed OS 5.14.1

S2-LP RF driver:

v1.0.0

• Fixed channel spacing configuration
• Changed to use 4-octet FCS
• Fixed configuration follows Wi-SUN and 802.15.4g specifications

Note: This is a breaking change because new RF configuration is not backward compatible.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[x] Breaking change

Reviewers

@mikter @juhhei01 @artokin

Release Notes

Summary of changes:

• 4-octet FCS which follows IEEE Std 802.15.4-2015
• Bug fix related to channel spacing configuration

Impact of changes:

This release contains version of a S2-LP driver which is not inter-operable with previous versions of the driver.

Migration actions required:

To make previous version (Mbed OS 5.14.0) of the S2-LP driver inter-operable with this release, following changes are needed.

/components/802.15.4_RF/stm-s2lp-rf-driver/source/NanostackRfPhys2lp.cpp
@@ -553 +553 @@ static void rf_init_registers(void)
-    rf_write_register_field(PCKTCTRL1, PCKT_CRCMODE_FIELD, PCKT_CRCMODE_0X1021);
+    rf_write_register_field(PCKTCTRL1, PCKT_CRCMODE_FIELD, PCKT_CRCMODE_0x04C11DB7);
@@ -556,0 +557 @@ static void rf_init_registers(void)
+    rf_write_register_field(PCKTCTRL2, PCKT_FCS_TYPE_FIELD, PCKT_FCS_TYPE_4_OCTET);
@@ -1001,0 +1003 @@ static void rf_receive(uint8_t rx_channel)
+        rf_channel_multiplier = 1;
/components/802.15.4_RF/stm-s2lp-rf-driver/source/s2lpReg.h
@@ -251,0 +252,3 @@ extern "C" {
+#define PCKT_FCS_TYPE_FIELD     0x20
+#define PCKT_FCS_TYPE_4_OCTET   (0 << 5)
+#define PCKT_FCS_TYPE_2_OCTET   (1 << 5)
@@ -255,0 +259 @@ extern "C" {
+#define PCKT_CRCMODE_0x04C11DB7 (5 << 5)

[ciarmcom]

@JarkkoPaso, thank you for your changes.
@juhhei01 @artokin @mikter @ARMmbed/mbed-os-ipcore @ARMmbed/mbed-os-maintainers please review.

[bulislaw]

Breaking changes are not accepted in patch releases.

[juhhei01]

@bulislaw "Same story again.." so sad. This changes is mandatory and fix PHY driver wrong setup. I think rules what we have are not good for development something new like wi-sun. I understand If we are state when we have certified stuff we can't do this. Without this fix we are not following wi-sun standard.

[bulislaw]

Ah yeah, I didn't connect this PR to the email conversation. Please follow the breaking changes "release note" guidance (https://os.mbed.com/docs/mbed-os/v5.14/contributing/workflow.html#pull-request-types)

@ARMmbed/mbed-os-maintainers that was approved by the product

[adbridge]

CI started

[mbed-ci]

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 1
Build artifacts

[0xc0170]

@JarkkoPaso Can you add these details:

Summary of changes

Impact of changes

Migration actions required

The release notes section contain what is breaking but not sufficient details. these 3 sections should help users during updating.

[0xc0170]

Changes look fine to me. Just need "Release notes" update and approval. See comment above

[0xc0170]

Travis fix should go in soon, this might need a rebase and CI restarted. I can do it to accelerate this one.

[0xc0170]

Rebased, starting CI now

[JarkkoPaso]

@0xc0170 Release notes updated. Please review.

[mbed-ci]

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 2
Build artifacts

[0xc0170]

@AnttiKauppila Please review (also Release section).

Otherwise this is ready!