Stack refactoring #6411

AnttiKauppila · 2018-03-21T07:23:48Z

Description

set_device_class() function added to LoRaWANInterface class to switch between classes at runtime

Mostly refactoring done.
Some small bug fixes done.
Green tea tests have been run manually in local machine

This is Mbed OS 5.9 content

Pull request type

- Only internal changes, no functionality changes - Some minor improvements to LoRaWanStack

… instead of a boolean Removed the while loop checking the return value from set_next_channel (GitHub Issue Lora-net/LoRaMac-node#357) The new return values are: LORAWAN_STATUS_OK : A channel has been found. LORAWAN_STATUS_NO_FREE_CHANNEL_FOUND : No free channel has been found (AS923 and KR920 regions) LORAWAN_STATUS_DUTYCYCLE_RESTRICTED : No channel found due to the duty-cycle or JoinReq back-off restrictions. Trial must be delayed. LORAWAN_STATUS_NO_CHANNEL_FOUND : No channel has been found. Re-enabled the default channels.

This issue is only present for a device in class c mode, which has perform unconfirmed uplinks. Lora-net/LoRaMac-node#327

Store the rx slot temporarily. When in class C, this variable will be changed in function OpenContinuousRx2Window.

Perform only an assignment. Lora-net/LoRaMac-node#282

1. Do not stop the 2nd window timer, as it is not running. 2. Wait for the OnAckTimeout event, before setting MacDone 3. Process for class c also the 2nd window timeout part, as we do not have a 2nd window timer.

This is especially important for class c devices.

In the DevStatusAns format, the protocol requires RFU(7:6) value = 0

Lora-net/LoRaMac-node#362

This API can be used to runtime change device class. Please note that only class A and C are supported at the moment. Trying to set class B will return LORAWAN_STATUS_UNSUPPORTED. Fix set_device_class documentation fix documentation

- Do not put radio into sleep when message is received in class c mode - Experimental feature for acknowledging confirmed downlink messages

Since our timers are now already using events, we no longer need to defer timer callback calls.

- This is internal change, no functionality has been changed - LoRaWanInterface cleaned up and code moved to LoRaMacStack - Compliance code in LoRaMacStack moved to EOF - Green tea tests have been run manually - Doxygen updated accordingly LoRA: reorder class members

- Only internal changes, no API has been broke. - Tested by manually running Green tea tests

- Internal change only, no functional changes - Tested by running Green tea tests manually

- Unneeded structs removed and replaced by variables in functions

…t's components

AnttiKauppila · 2018-03-21T07:25:31Z

@kivaisan @kjbracey-arm Please review

Fix compilation of compilance test and at the same time refactor compliance test handler. Renamed mcps_request as test_request as it is only used for compliance test. Also fixed a bug with null buffer in send_compliance_test_frame_to_mac.

0xc0170 · 2018-03-21T15:48:33Z

@AnttiKauppila Can this be done in smaller related PR ? (I set PR type in your first comment to only refactoring, but after looking at these changes, it's not just refactor. this is also introducing new API).

AnttiKauppila · 2018-03-22T07:04:50Z

I will start my Winter holiday today and because my previous commit took more than 2 weeks, this one got bigger and bigger meanwhile. I will be out next week and LoRa team needs this to proceed.
I already put Fix, refactor + feature in my commit details, because all of these are included in this PR.

0xc0170 · 2018-03-23T18:04:44Z

/morph build

mbed-ci · 2018-03-23T18:30:08Z

Build : FAILURE

Build number : 1551
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6411/

cmonr · 2018-03-23T18:34:27Z

Poor time for an ARM license issue...
/morph build

0xc0170 · 2018-03-23T18:35:34Z

/morph build

mbed-ci · 2018-03-23T18:38:33Z

Build : ABORTED

Build number : 1552
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6411/

mbed-ci · 2018-03-23T19:00:45Z

Build : SUCCESS

Build number : 1553
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6411/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-03-24T04:36:26Z

Exporter Build : FAILURE

Build number : 1191
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6411/

mbed-ci · 2018-03-24T05:14:00Z

Test : SUCCESS

Build number : 1330
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6411/1330

0xc0170 · 2018-03-24T08:53:08Z

/morph export-build

mbed-ci · 2018-03-24T11:02:40Z

Exporter Build : SUCCESS

Build number : 1193
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6411/

kjbracey · 2018-04-03T10:15:26Z

features/lorawan/lorastack/phy/LoRaPHY.cpp

-    } else {
-        return val_in_range(datarate, phy_params.dwell_limit_datarate,
-                            phy_params.max_tx_datarate);
+    if (is_datarate_supported(datarate)) {


Don't need to change it this time, but general style suggestion - use early exit for parameter validation

if (!is_datarate_supported(datarate)) { return false; }

Saves indenting all the body of the function, reducing diffs and merge conflicts. This style doesn't scale well as the number of parameter checks increases.

kjbracey · 2018-04-03T10:19:19Z

features/lorawan/system/lorawan_data_structures.h

+
+typedef struct {
+    /*!
+     * Compiliance test request


kjbracey · 2018-04-03T10:23:12Z

features/lorawan/LoRaWANStack.cpp

+    lorawan_connect_t connection_params;
+
+    //TODO: LoRaWANStack don't need to know these values, move to LoRaMac (or below)
+#if (1 == MBED_CONF_LORA_OVER_THE_AIR_ACTIVATION)


Just #if MBED_CONF_LORA_OVER_THE_AIR_ACTIVATION, surely?

You're not doing #if (1 == defined(XXX))...

kjbracey · 2018-04-03T10:23:28Z

features/lorawan/LoRaWANStack.cpp

+
+    //TODO: LoRaWANStack don't need to know these values, move to LoRaMac (or below)
+#if (1 == MBED_CONF_LORA_OVER_THE_AIR_ACTIVATION)
+    static uint8_t dev_eui[] = MBED_CONF_LORA_DEVICE_EUI;


These should be const to save RAM.

kjbracey · 2018-04-03T10:24:20Z

features/lorawan/LoRaWANBase.h

+     *                          LORAWAN_STATUS_UNSUPPORTED is requested class is not supported,
+     *                          or other negative error code if request failed.
+     */
+    virtual lorawan_status_t set_device_class(const device_class_t device_class) = 0;


The const here is meaningless - remove it to avoid confusion.

kjbracey · 2018-04-03T10:25:09Z

features/lorawan/LoRaWANInterface.cpp

-     stk_obj().set_lora_callbacks(callbacks);
-     return LORAWAN_STATUS_OK;
-  }
+lorawan_status_t LoRaWANInterface::set_device_class(const device_class_t device_class)


(You could keep the const here though, meaning "I don't change device_class after function entry" - just doesn't need to be in the prototype).

- changed few static variables to have const

AnttiKauppila · 2018-04-03T12:06:25Z

@kjbracey-arm I have modified the code as you suggested, can you please re-review

AnttiKauppila · 2018-04-03T12:09:31Z

@0xc0170 Could you trigger build for this?

0xc0170 · 2018-04-03T12:10:46Z

/morph build

mbed-ci · 2018-04-03T12:51:21Z

Build : SUCCESS

Build number : 1648
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6411/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

mbed-ci · 2018-04-03T18:36:40Z

Exporter Build : SUCCESS

Build number : 1280
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6411/

mbed-ci · 2018-04-03T23:21:01Z

Test : SUCCESS

Build number : 1437
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6411/1437

AnttiKauppila · 2018-04-04T13:17:32Z

@cmonr Will you do the trick and merge this in?

Antti Kauppila and others added 23 commits March 21, 2018 08:54

LoRa: LoRaWANInterface refactored.

a294aa0

- Only internal changes, no functionality changes - Some minor improvements to LoRaWanStack

Ensure DR_6 cannot be selected for IN865 region

339306e

Fix an issue with sequence calls.

6114f2b

This issue is only present for a device in class c mode, which has perform unconfirmed uplinks. Lora-net/LoRaMac-node#327

Do only set the MacDone if the MAC is not in class c

fc1696b

Fix rx slot handling

c1ea418

Store the rx slot temporarily. When in class C, this variable will be changed in function OpenContinuousRx2Window.

Fix calculation of the aggregated time-off.

256a3a5

Perform only an assignment. Lora-net/LoRaMac-node#282

Add the possibility to set the default antenna gain.

591bc7d

Bug fix in RX timeout and RX error handling for class c nodes.

a9e1076

1. Do not stop the 2nd window timer, as it is not running. 2. Wait for the OnAckTimeout event, before setting MacDone 3. Process for class c also the 2nd window timeout part, as we do not have a 2nd window timer.

Remove unused is_fPort_allowed method

e097429

Changed mcps confirmation ul_frequency to channel

6c165e0

Update handling for functions OnRadioRxError and OnRadioRxTimout.

e1fff2e

This is especially important for class c devices.

Update DevStatusAnd format

65b2dbc

In the DevStatusAns format, the protocol requires RFU(7:6) value = 0

Change minimum required channels from 6 to 2 (US915Hybrid)

4aba343

Lora-net/LoRaMac-node#362

Fix reception of class C messages

32075b9

- Do not put radio into sleep when message is received in class c mode - Experimental feature for acknowledging confirmed downlink messages

Simplify check for pending bit

c6eee4f

Remove redundant event from timer callbacks

fe225a8

Since our timers are now already using events, we no longer need to defer timer callback calls.

LoRaWANStack is made independent of MAC sublayers

6b54478

- Only internal changes, no API has been broke. - Tested by manually running Green tea tests

LoRa: LoRaMAC class refactored

489eecf

- Internal change only, no functional changes - Tested by running Green tea tests manually

LoRa: Struct cleanups

dc98228

- Unneeded structs removed and replaced by variables in functions

LoRa: Added API break warnings for lorawan_channelplan_t struct and i…

cbdeb7d

…t's components

0xc0170 added the needs: review label Mar 21, 2018

Fix compilance test compilation

c198357

Fix compilation of compilance test and at the same time refactor compliance test handler. Renamed mcps_request as test_request as it is only used for compliance test. Also fixed a bug with null buffer in send_compliance_test_frame_to_mac.

0xc0170 requested review from kivaisan and kjbracey March 21, 2018 15:45

0xc0170 added the release-version: 5.9.0-rc1 label Mar 22, 2018

kivaisan approved these changes Mar 26, 2018

View reviewed changes

kjbracey reviewed Apr 3, 2018

View reviewed changes

0xc0170 added needs: work and removed needs: review labels Apr 3, 2018

LoRa: Small fixes

10ad173

- changed few static variables to have const

kjbracey approved these changes Apr 3, 2018

View reviewed changes

0xc0170 added ready for merge and removed needs: work labels Apr 4, 2018

cmonr merged commit 75cb4d7 into ARMmbed:master Apr 4, 2018

cmonr removed the ready for merge label Apr 4, 2018

AnttiKauppila deleted the stack_refactoring branch April 10, 2018 07:18

adbridge mentioned this pull request Apr 20, 2018

Lora: small fixes #6569

Merged

Stack refactoring #6411

Stack refactoring #6411

Uh oh!

Conversation

AnttiKauppila commented Mar 21, 2018 • edited by SenRamakri Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Pull request type

Uh oh!

AnttiKauppila commented Mar 21, 2018

Uh oh!

0xc0170 commented Mar 21, 2018

Uh oh!

AnttiKauppila commented Mar 22, 2018

Uh oh!

0xc0170 commented Mar 23, 2018

Uh oh!

mbed-ci commented Mar 23, 2018

Uh oh!

cmonr commented Mar 23, 2018

Uh oh!

0xc0170 commented Mar 23, 2018

Uh oh!

mbed-ci commented Mar 23, 2018

Uh oh!

mbed-ci commented Mar 23, 2018

Triggering tests

Uh oh!

mbed-ci commented Mar 24, 2018

Uh oh!

mbed-ci commented Mar 24, 2018

Uh oh!

0xc0170 commented Mar 24, 2018

Uh oh!

mbed-ci commented Mar 24, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kjbracey Apr 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AnttiKauppila commented Apr 3, 2018

Uh oh!

AnttiKauppila commented Apr 3, 2018

Uh oh!

0xc0170 commented Apr 3, 2018

Uh oh!

mbed-ci commented Apr 3, 2018

Triggering tests

Uh oh!

mbed-ci commented Apr 3, 2018

Uh oh!

mbed-ci commented Apr 3, 2018

Uh oh!

AnttiKauppila commented Apr 4, 2018

Uh oh!

Uh oh!

AnttiKauppila commented Mar 21, 2018 •

edited by SenRamakri

Loading

kjbracey Apr 3, 2018 •

edited

Loading