Remove Maxim and SoftDevice BLE stacks which do not support the latest APIs #12674

LDong-Arm · 2020-03-23T15:55:49Z

Summary of changes

Remove Nordic SoftDevice stack (used by nRF51* targets). Notes: nRF52* targets are unaffected as they use Cordio stack.
Remove the current Maxim BLE stack (until a newer version based on up-to-date Cordio stack becomes available).
Disable BLE features of affected targets from targets.json.

Note: Some references/macros for SoftDevice are still present in the Nordic SDK (targets/TARGET_NORDIC/*) and not cleanly separated with other components.

Impact of changes

BLE feature will be unavailable on nRF51* targets and temporarily unavailable on Maxim targets until the driver gets updated in the future.

Migration actions required

For nRF51* targets, use Mbed OS release 5.15 - future support for those targets are under review.
For nRF52* targets, ensure the default BLE configurations that enable Cordio stack is used.
For Maxim targets, use Mbed OS release 5.15 until the BLE driver gets updated.

Documentation

None

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

Note: This only disables BLE feature from targets.

Reviewers

@pan- @evedon

ciarmcom · 2020-03-23T16:00:37Z

@LDong-Arm, thank you for your changes.
@ARMmbed/mbed-os-maintainers @ARMmbed/mbed-os-pan please review.

LDong-Arm · 2020-03-23T16:00:56Z

Hi @pan- @evedon, this is the PR to remove deprecated target-specific BLE stacks.
For nRF51* targets this only disables BLE - their complete removal (e.g. of components other than BLE) would be future work.

As in the description, this gets rid of the API implementation by SoftDevice but is not a complete clean-up of the lower level SDK code - do we care about this at the moment?

evedon

LGTM

0xc0170 · 2020-03-24T13:36:28Z

FYI @ARMmbed/team-maximintegrated commit 7ef08df

0xc0170 · 2020-03-24T13:37:56Z

CI started

mbed-ci · 2020-03-24T18:47:16Z

Test run: FAILED

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

Failed test jobs:

jenkins-ci/mbed-os-ci_greentea-test

LDong-Arm · 2020-03-31T10:12:19Z

Hi @0xc0170, it looks like the CI failed at some HTTP request which is probably unrelated?

0xc0170 · 2020-03-31T16:09:26Z

test restarted

donatieng

Thanks @LDong-Arm, there are a few more things that need to be cleaned up in targets.json:

mbed-os/targets/targets.json

Lines 10947 to 10949 in ba6f89e

    
           "BLE_STACK_SUPPORT_REQD", 
        
           "SOFTDEVICE_PRESENT", 
        
           "S130",

mbed-os/targets/targets.json

Lines 10972 to 10979 in ba6f89e

    
           "MERGE_SOFT_DEVICE": true, 
        
           "EXPECTED_SOFTDEVICES_WITH_OFFSETS": [ 
        
               { 
        
                   "boot": "", 
        
                   "name": "s130_nrf51_2.0.0_softdevice.hex", 
        
                   "offset": 110592 
        
               } 
        
           ],

mbed-os/targets/targets.json

Line 7457 in ba6f89e

"BLE"

Otherwise, LGTM

Pull request has been modified.

0xc0170 · 2020-04-15T07:17:27Z

@LDong-Arm Please rebase (recent merges made unfortunately a conflict here), will restart testing and this should go in today.

The current Maxim BLE driver only implements the old BLE API which is deprecated and will be removed soon. Once an updated BLE stack for Maxim becomes available, BLE feature can be re-enabled.

…ets) The Nordic SoftDevice BLE stack used by NRF51* targets only supports legacy BLE APIs which we will removed completely. Note: NRF52* targets which use Cordio BLE stack are unaffected.

LDong-Arm · 2020-04-15T09:33:10Z

@0xc0170 Rebased

Pull request has been modified.

LDong-Arm · 2020-04-15T09:35:56Z

@0xc0170 @donatieng @evedon @bulislaw I resolved the merged conflicts in targets.json. The diff is identical to what it was before, could you re-approved? Cheers.

0xc0170 · 2020-04-15T09:53:07Z

CI started

0xc0170 · 2020-04-15T09:53:35Z

@0xc0170 @donatieng @evedon @bulislaw I resolved the merged conflicts in targets.json. The diff is identical to what it was before, could you re-approved? Cheers.

As it was just a rebase to resolve a conflict, all fine here.

mbed-ci · 2020-04-15T12:00:32Z

Test run: SUCCESS

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

…er used Previously we overrode NRF targets to have a larger stack due to memory required by SoftDevice. Having deprecated SoftDevice in favour of Cordio for BLE (ARMmbed#12674), such requirement does not apply anymore.

…used Previously we overrode nRF targets to have a larger stack due to memory required by SoftDevice. Having deprecated SoftDevice in favour of Cordio for BLE (ARMmbed#12674), such requirement does not apply anymore.

ciarmcom requested review from a team March 23, 2020 16:00

ciarmcom added the needs: review label Mar 23, 2020

evedon previously approved these changes Mar 24, 2020

View reviewed changes

mergify bot added needs: CI and removed needs: review labels Mar 24, 2020

0xc0170 added the BREAKING-CHANGE label Mar 24, 2020

0xc0170 requested a review from bulislaw March 24, 2020 13:36

0xc0170 previously approved these changes Mar 24, 2020

View reviewed changes

0xc0170 added the release-version: 6.0.0-beta-1 label Mar 24, 2020

mergify bot added needs: work and removed needs: CI labels Mar 24, 2020

0xc0170 added this to needs: work in Pull request triage Mar 25, 2020

mergify bot added needs: CI and removed needs: work labels Mar 30, 2020

LDong-Arm mentioned this pull request Mar 31, 2020

BLE Gap deprecation cleanup/rework #12730

Merged

donatieng previously requested changes Mar 31, 2020

View reviewed changes

mergify bot added needs: work and removed needs: CI labels Mar 31, 2020

LDong-Arm requested a review from donatieng April 1, 2020 08:57

mergify bot removed the needs: review label Apr 15, 2020

LDong-Arm added 5 commits April 15, 2020 09:51

Disable BLE on Maxim targets until an updated driver becomes available

ab8d84a

The current Maxim BLE driver only implements the old BLE API which is deprecated and will be removed soon. Once an updated BLE stack for Maxim becomes available, BLE feature can be re-enabled.

Remove Maxim BLE stack which does not implement the new API

4cb729f

Disable Nordic SoftDevice BLE stack from targets (affects NRF51* targ…

897acb8

…ets) The Nordic SoftDevice BLE stack used by NRF51* targets only supports legacy BLE APIs which we will removed completely. Note: NRF52* targets which use Cordio BLE stack are unaffected.

Remove Nordic SoftDevice BLE driver

a85c157

targets.json: further clean-up of SoftDevice configurations

6954dbe

LDong-Arm force-pushed the ble_remove_deprecated_targets branch from b475caf to 6954dbe Compare April 15, 2020 09:32

LDong-Arm requested review from bulislaw, donatieng, 0xc0170 and evedon April 15, 2020 09:33

0xc0170 approved these changes Apr 15, 2020

View reviewed changes

0xc0170 added needs: CI and removed needs: work labels Apr 15, 2020

mergify bot added ready for merge and removed needs: CI labels Apr 15, 2020

0xc0170 merged commit 58de040 into ARMmbed:master Apr 15, 2020

mergify bot removed the ready for merge label Apr 15, 2020

LDong-Arm mentioned this pull request Apr 27, 2020

nRF: use Mbed-default boot-stack-size & fix stack_size_unification test #12874

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove Maxim and SoftDevice BLE stacks which do not support the latest APIs #12674

Remove Maxim and SoftDevice BLE stacks which do not support the latest APIs #12674

LDong-Arm commented Mar 23, 2020 •

edited by 0xc0170

ciarmcom commented Mar 23, 2020

LDong-Arm commented Mar 23, 2020 •

edited

evedon left a comment

0xc0170 commented Mar 24, 2020

0xc0170 commented Mar 24, 2020

mbed-ci commented Mar 24, 2020

LDong-Arm commented Mar 31, 2020

0xc0170 commented Mar 31, 2020

donatieng left a comment

0xc0170 commented Apr 15, 2020

LDong-Arm commented Apr 15, 2020

LDong-Arm commented Apr 15, 2020

0xc0170 commented Apr 15, 2020

0xc0170 commented Apr 15, 2020

mbed-ci commented Apr 15, 2020

	"MERGE_SOFT_DEVICE": true,
	"EXPECTED_SOFTDEVICES_WITH_OFFSETS": [
	{
	"boot": "",
	"name": "s130_nrf51_2.0.0_softdevice.hex",
	"offset": 110592
	}
	],

Remove Maxim and SoftDevice BLE stacks which do not support the latest APIs #12674

Remove Maxim and SoftDevice BLE stacks which do not support the latest APIs #12674

Conversation

LDong-Arm commented Mar 23, 2020 • edited by 0xc0170

Summary of changes

Impact of changes

Migration actions required

Documentation

Pull request type

Test results

Reviewers

ciarmcom commented Mar 23, 2020

LDong-Arm commented Mar 23, 2020 • edited

evedon left a comment

Choose a reason for hiding this comment

0xc0170 commented Mar 24, 2020

0xc0170 commented Mar 24, 2020

mbed-ci commented Mar 24, 2020

Test run: FAILED

LDong-Arm commented Mar 31, 2020

0xc0170 commented Mar 31, 2020

donatieng left a comment

Choose a reason for hiding this comment

0xc0170 commented Apr 15, 2020

LDong-Arm commented Apr 15, 2020

LDong-Arm commented Apr 15, 2020

0xc0170 commented Apr 15, 2020

0xc0170 commented Apr 15, 2020

mbed-ci commented Apr 15, 2020

Test run: SUCCESS

LDong-Arm commented Mar 23, 2020 •

edited by 0xc0170

LDong-Arm commented Mar 23, 2020 •

edited