Skip to content

CellularBase/AT_CellularBase removal #11996

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 10, 2019
Merged

CellularBase/AT_CellularBase removal #11996

merged 7 commits into from
Dec 10, 2019

Conversation

AnttiKauppila
Copy link

@AnttiKauppila AnttiKauppila commented Dec 2, 2019

Removed CellularBase and AT_CellularBase from cellular stack and updated both code and unittests accordingly.

Description

Summary of change

Removed CellularBase and AT_CellularBase from cellular stack and updated both code and unittests accordingly. Also cellular drivers in Mbed OS have been updated.
Earlier cellular device properties were handled in AT_CellularBase class and after this change they are handled now correctly in AT_CellularDevice class. The properties are always modem specific and must be therefore handled in AT_CellularDevice class which is common for all contexts using it.

Also APN lookup and SMS features are now disabled by default
Disabling SMS will save ~4,5kB and APN lookup about ~2kB

Documentation


Pull request type

[] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[X] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[] No Tests required for this change (E.g docs only update)
[X] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers

@ARMmbed/mbed-os-wan

Release Notes

Summary of changes

Removed CellularBase and AT_CellularBase from cellular stack and updated both code and unittests accordingly. Cellular drivers in Mbed OS have been updated.

APN lookup and SMS features are now disabled by default

Impact of changes

Earlier cellular device properties were handled in AT_CellularBase class and after this change they are handled now correctly in AT_CellularDevice class. The properties are always modem specific and must be therefore handled in AT_CellularDevice class which is common for all contexts using it.

CellularBase has been completely removed so those using must now switch to use CellularInterface instead.
Disabling SMS will save ~4,5kB and APN lookup about ~2kB

Migration actions required

Cellular modem drivers must be updated (done for targets in Mbed OS) by removing references to CellularBase.
CellularBase must be changed to CellularInterface if still in use. (was already typedef'ed so no other changes needed)
If SMS or APN lookup are needed by application, those needs to be enabled in mbed_app.json
(cellular.use-apn-lookup: true or cellular.use-sms: true)

@AnttiKauppila AnttiKauppila added needs: review release-version: 6.0.0-alpha-1 First pre-release version of 6.0.0 labels Dec 2, 2019
@ciarmcom ciarmcom requested review from a team December 2, 2019 14:00
@ciarmcom
Copy link
Member

ciarmcom commented Dec 2, 2019

@AnttiKauppila, thank you for your changes.
@ARMmbed/mbed-os-ipcore @ARMmbed/mbed-os-wan @ARMmbed/mbed-os-maintainers please review.

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 2, 2019

CI started

@mbed-ci
Copy link

mbed-ci commented Dec 2, 2019

Test run: FAILED

Summary: 4 of 4 test jobs failed
Build number : 1
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_unittests
  • jenkins-ci/mbed-os-ci_build-ARM
  • jenkins-ci/mbed-os-ci_build-IAR
  • jenkins-ci/mbed-os-ci_build-GCC_ARM

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 3, 2019

features/cellular/framework/targets/MultiTech/DragonflyNano/PPP/SARA4_PPP.cpp

@AnttiKauppila There's rebase needed

@SeppoTakalo
Copy link
Contributor

I'm OK with the removal of the CellularBase class, I did not review functional changes.

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 5, 2019

CI restarted

@mbed-ci
Copy link

mbed-ci commented Dec 5, 2019

Test run: FAILED

Summary: 4 of 4 test jobs failed
Build number : 2
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_unittests
  • jenkins-ci/mbed-os-ci_build-ARM
  • jenkins-ci/mbed-os-ci_build-IAR
  • jenkins-ci/mbed-os-ci_build-GCC_ARM

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 5, 2019

CI restarted

@mbed-ci
Copy link

mbed-ci commented Dec 5, 2019

Test run: FAILED

Summary: 3 of 4 test jobs failed
Build number : 3
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_build-GCC_ARM
  • jenkins-ci/mbed-os-ci_build-ARM
  • jenkins-ci/mbed-os-ci_build-IAR

@0xc0170 0xc0170 requested a review from bulislaw December 5, 2019 13:25
@0xc0170
Copy link
Contributor

0xc0170 commented Dec 5, 2019

Regarding release notes:

Cellular modem drivers must be updated (done for targets in Mbed OS)

Is this sufficient? What changes need to be done for drivers - do we have it captured anywhere or do I need to go through the code in this PR to find out?

CellularBase must be changed to CellularInterface if still in use.

CellularBase -> CellularInterface - just replace and works the same ,no changes to the API?

If SMS or APN lookup are needed by application, those needs to be enabled in mbed_app.json

How to enable it, can we add the exact config to enable/disable ?

Antti Kauppila added 7 commits December 9, 2019 15:25
Removed CellularBase and AT_CellularBase from cellular stack and updated both code and unittests accordingly.

Moved property handling into AT_CellularDevice
tools folder had a reference to ppp-cell-iface.apn-lookup which is removed.
This commit removes the reference to non-existing configuration
@AnttiKauppila
Copy link
Author

Release notes updated

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 9, 2019

CI restarted

@mbed-ci
Copy link

mbed-ci commented Dec 9, 2019

Test run: SUCCESS

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

@0xc0170
Copy link
Contributor

0xc0170 commented Dec 10, 2019

@bulislaw Please review, this is then ready for integration

@0xc0170 0xc0170 merged commit f10e4ac into master Dec 10, 2019
@0xc0170 0xc0170 changed the title Feature cellular CellularBase/AT_CellularBase removal Dec 10, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BREAKING-CHANGE release-version: 6.0.0-alpha-1 First pre-release version of 6.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants