Merge feature cellular refactor #9568

AriParkkila · 2019-01-31T11:24:56Z

Description

Merge the feature-cellular-refactor branch to mbed-os/master.

This is a breaking change and needed due to without this cellular stack cannot for example support upcoming multihoming requirement, see a comment below.

Pull request type

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

Reviewers

Release Notes

This PR has impact on cellular application development and porting of new cellular devices.

Application developers need to select the suitable NetworkInterface type. When using NetworkInterface NSAPI configuration defines are applied by default, see NSAPI configuration options for cellular in more details. CellularBase users have a new function set_default_parameters to apply NSAPI configuration options. CellularContext is to be used instead of CellularBase for new extended cellular functionality, such as NonIP sockets and EPS CP optimization...

Migration guidelines for application developers:

Change CELLULAR_DEVICE macro to get_default_instance
Change OnboardCellularInterface or EasyCellularConnection to CellularContext
Call CellularDevice::set_data_carrier_detect to set HUP signal detection

Cellular API changes need to be taken into account when porting new cellular devices. This PR already contains the changes needed for the existing cellular drivers and the onboard modems. Arm has an internal ticket to update the cellular porting documentation for Mbed OS 5.12.

Migration guidelines for porting developers:

Follow GENERIC_AT3GPP implementation when porting new AT based cellular devices
Change power_on/off to onboard_modem_api with soft_power_on/off and hard_power_on/off
Move implementation from CellularSIM and CellularPower to CellularInformation and CellularDevice
Implement CellularDevice::init and CellularDevice::shutdown
Use CellularNetwork::get_signal_quality instead of CellularNetwork::get_extended_signal_quality

…quality

Moved methods to classes CellularDevice and CellularInformation. SIM interface was removed to simplify cellular usage and methods better suite new classes. Updated greentea and unit tests.

-added an API for checking network eps ciot optimization support -renamed the API for getting the UE parameters -the API for setting the UE parameters includes now a callback, which will be called once network support for eps ciot optimization is known

After this change we were able to change methods ATHandler::set_urc_handler and CellularDevice::set_ready_cb to void and simplify error handling.

This change enables removing function has_registration from class AT_CellularNetwork and all targets inheriting AT_CellularNetwork.

After AT_CellularNetwork::has_registration was replaced with CellularProperties and better AT_CellularNetwork::set_access_technology_impl default implementation we can delete most of the target specific classes that inherit AT_CellularNetwork.

Change usage of AT_CellularContext::stack_type_supported to AT_CellularBase::get_property. This way we can rid of targets overriding stack_type_supported and delete unnecessary classes and simplify new targets.

Generic cellular module (GENERIC_AT3GPP) can by used as a default module when porting new cellular module. It's a good starting point and eases porting of new modules. GENERIC_AT3GPP uses only standard 3GPP AT commands when communicating with the modem.

_sim_pin was changed to pointer from array and length was checked with strlen. If _sim_pin was null it caused crash. Fix by checking _sim_pin against NULL. Power class could have been called without checking if power is NULL. Fix by checking that power class is not null. Fix state machine to return correct states when queried.

…livery

…face

AnttiKauppila · 2019-02-01T14:02:05Z

Hi @bulislaw, This is mandatory change needed for cellular stack, without this we cannot for example support upcoming multihoming requirement. This change has been widely discussed internally including Product management, PE team and Cellular team and we have created a list of changes we are about to do. @AriParkkila please make sure that all stakeholders will get the list of changes!
What I agree though is that the description of the PR is almost non-existent and causes this kind of uncertainty amongst people not aware of the background of this change.

cmonr · 2019-02-02T03:47:39Z

CI started.
Testing since CI load during weekend should be low, and I'd like to see what else might technically be needed for the PR

cmonr · 2019-02-02T03:50:44Z

@ARMmbed/mbed-os-maintainers another breaking change here without explanation

PR opened on 5:30am Jan 31st,
lack of a breaking change statement found Feb 1st ~6am. (#9568 (review))

@bulislaw Would you be interested in being a maintainer, or was the rapid response just a coincidense? 😄

mbed-ci · 2019-02-02T09:35:51Z

Test run: SUCCESS

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

0xc0170 · 2019-02-04T16:33:12Z

@AriParkkila Please can you write release notes section following this ARMmbed/mbed-os-5-docs#933 (will be integrated soon) - edit the first comment (introduction of PR, adding new release notes section) and let us know once updated

AriParkkila · 2019-02-05T07:55:21Z

@0xc0170 please see Release Notes

jarvte · 2019-02-05T10:56:05Z

@cmonr @0xc0170 @bulislaw can we proceed with this one? We need this to 5.12 and we need to still fix/add features and have time to test before 5.12.

bulislaw · 2019-02-05T11:03:37Z

We need approval from @AnttiKauppila

AriParkkila · 2019-02-06T10:42:11Z

@bulislaw do you think we can continue with merging this PR now?

NirSonnenschein · 2019-02-06T13:00:50Z

starting CI

theotherjimmy · 2019-02-06T14:25:33Z

Why was mbed-os-tools tagged for review? There are no tools changes to speak of.

mbed-ci · 2019-02-06T14:58:11Z

Test run: SUCCESS

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

jarvte · 2019-02-07T10:42:21Z

Merge?

Teppo Järvelin and others added 30 commits January 22, 2019 02:23

Cellular: Fixed CellularStateMachine to stop on all target states.

08bd651

Cellular: Removed get_extended_signal_quality and changed get_signal_…

235c2bc

…quality

Removed CellularSIM interface.

22d9105

Moved methods to classes CellularDevice and CellularInformation. SIM interface was removed to simplify cellular usage and methods better suite new classes. Updated greentea and unit tests.

cellular: eps ciot optimization network support check astyle fix

22a536a

Cellular: Move eDRX setting from power to network

36292a4

Cellular: Move PSM setting from power to device

38f79a9

Cellular: Move device_ready from power to device

e49f90f

Cellular: AT remove_urc_handler changed to set_urc_handler(prefix, 0)

19b2494

Cellular: Move ready_cb from power to device

2dde5a4

Cellular: Unify set_at_mode and init_module into init()

0813b96

Cellular: Removed set_power_level()

1bc8440

Cellular: Moved reset from power to device

bdddb44

Cellular: Added shutdown()

c7486b2

Cellular: changed support features to CellularProperty array.

8fcd2e0

Cellular: Removed unnecessary checks after new

b0d37eb

After this change we were able to change methods ATHandler::set_urc_handler and CellularDevice::set_ready_cb to void and simplify error handling.

Cellular: Change AT_CellularNetwork to use CellularProperties.

9a72c22

This change enables removing function has_registration from class AT_CellularNetwork and all targets inheriting AT_CellularNetwork.

Cellular: change stack_type_supported to get_property

0c9130e

Change usage of AT_CellularContext::stack_type_supported to AT_CellularBase::get_property. This way we can rid of targets overriding stack_type_supported and delete unnecessary classes and simplify new targets.

Cellular: Add State machine unit tests.

725e14d

Cellular: added setting of data carrier support for UART.

84e5013

Cellular: Non-IP socket and PDP context for EPS control plane data de…

d301e13

…livery

Cellular: Unit tests for Non-IP socket

ba3727b

Cellular: Added API for setting default parameters to a network inter…

55b54f7

…face

Cellular: Move power on/off to device and remove CellularPower

139d506

Cellular: Remove netsocket/generic_modem_driver

59972b6

Cellular: Add get_target_default_instance in CellularDevice

75caa75

Cellular: Default modem drivers with FF_ARDUINO

269d151

bulislaw requested a review from AnttiKauppila February 5, 2019 11:03

AnotherButler mentioned this pull request Feb 5, 2019

Cellular: Documenting the support for Non-IP data delivery feature ARMmbed/mbed-os-5-docs#928

Merged

AnttiKauppila approved these changes Feb 6, 2019

View reviewed changes

NirSonnenschein added the BREAKING-CHANGE label Feb 6, 2019

NirSonnenschein mentioned this pull request Feb 6, 2019

Sleep: error flags fix #9277

Merged

bulislaw approved these changes Feb 6, 2019

View reviewed changes

0xc0170 removed the request for review from a team February 7, 2019 12:13

0xc0170 approved these changes Feb 7, 2019

View reviewed changes

0xc0170 added ready for merge and removed needs: review labels Feb 7, 2019

0xc0170 mentioned this pull request Feb 7, 2019

Cellular: UBLOX_C030_N211 Cellular API's #9637

Merged

NirSonnenschein merged commit 8c2ad14 into master Feb 7, 2019

NirSonnenschein removed the ready for merge label Feb 7, 2019

SeppoTakalo mentioned this pull request Feb 8, 2019

Add Cypress PSoC 6 targets #9481

Merged

0Grit mentioned this pull request Feb 8, 2019

Telit LE910 and ME910 #8666

Closed

vidavidorra mentioned this pull request Feb 27, 2019

fix: compare current stm state in pre_event #9815

Closed

adbridge deleted the feature-cellular-refactor branch August 20, 2019 10:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Merge feature cellular refactor #9568

Merge feature cellular refactor #9568

Uh oh!

AriParkkila commented Jan 31, 2019 •

edited

Loading

Uh oh!

AnttiKauppila commented Feb 1, 2019

Uh oh!

cmonr commented Feb 2, 2019

Uh oh!

cmonr commented Feb 2, 2019

Uh oh!

mbed-ci commented Feb 2, 2019

Uh oh!

0xc0170 commented Feb 4, 2019 •

edited

Loading

Uh oh!

AriParkkila commented Feb 5, 2019

Uh oh!

jarvte commented Feb 5, 2019

Uh oh!

bulislaw commented Feb 5, 2019

Uh oh!

AriParkkila commented Feb 6, 2019

Uh oh!

NirSonnenschein commented Feb 6, 2019

Uh oh!

theotherjimmy commented Feb 6, 2019

Uh oh!

mbed-ci commented Feb 6, 2019

Uh oh!

jarvte commented Feb 7, 2019

Uh oh!

Uh oh!

Merge feature cellular refactor #9568

Merge feature cellular refactor #9568

Uh oh!

Conversation

AriParkkila commented Jan 31, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Pull request type

Reviewers

Release Notes

Uh oh!

AnttiKauppila commented Feb 1, 2019

Uh oh!

cmonr commented Feb 2, 2019

Uh oh!

cmonr commented Feb 2, 2019

Uh oh!

mbed-ci commented Feb 2, 2019

Test run: SUCCESS

Uh oh!

0xc0170 commented Feb 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AriParkkila commented Feb 5, 2019

Uh oh!

jarvte commented Feb 5, 2019

Uh oh!

bulislaw commented Feb 5, 2019

Uh oh!

AriParkkila commented Feb 6, 2019

Uh oh!

NirSonnenschein commented Feb 6, 2019

Uh oh!

theotherjimmy commented Feb 6, 2019

Uh oh!

mbed-ci commented Feb 6, 2019

Test run: SUCCESS

Uh oh!

jarvte commented Feb 7, 2019

Uh oh!

Uh oh!

AriParkkila commented Jan 31, 2019 •

edited

Loading

0xc0170 commented Feb 4, 2019 •

edited

Loading