Remove mbed wait deprecated APIs #12572

rajkan01 · 2020-03-04T15:54:35Z

Summary of changes

Removed mbed wait deprecated APIs.

Impact of changes

Breaking change: wait and wait_ms APIs have been deprecated since Mbed OS 5.14 and they are removed now.

Migration actions required

If you wish to sleep, use ThisThread::sleep_for (C++) or thread_sleep_for (C). If you wish to wait (without sleeping), call wait_us. wait_us is safe to call from ISR context.

Documentation

ARMmbed/mbed-os-5-docs@19d1ed0

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

@evedon

ciarmcom · 2020-03-04T16:00:41Z

@rajkan01, thank you for your changes.
@evedon @ARMmbed/mbed-os-core @ARMmbed/mbed-os-wan @ARMmbed/mbed-os-pan @ARMmbed/mbed-os-hal @ARMmbed/mbed-os-test @ARMmbed/mbed-os-maintainers please review.

evedon · 2020-03-04T16:43:29Z

These APIs are widely used so we need to ensure that there is no internal usage in greentea tests, examples etc. before merging. @0xc0170 it would be useful to kick off CI to see which tests/targets fail to build.

maciejbocianski

Why some test use thread_sleep_for and the other use ThisThread::sleep_for ?

maciejbocianski · 2020-03-04T19:10:35Z

platform/mbed_wait_api.h

@@ -46,54 +46,14 @@ extern "C" {
 * int main() {
 *     while (1) {
 *         heartbeat = 1;
- *         wait(0.5);
+ *         wait_us(500);


Should be 500ms not 500us

maciejbocianski · 2020-03-04T19:12:44Z

platform/mbed_wait_api.h

 *         heartbeat = 0;
- *         wait(0.5);
+ *         wait_us(500);


@maciejbocianski We try to showcase time precision sleeping, but we are working on better example to showcase wait API.

cmonr · 2020-03-04T20:52:42Z

CI started

mbed-ci · 2020-03-04T21:30:45Z

Test run: FAILED

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

Failed test jobs:

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

rajkan01 · 2020-03-05T11:34:56Z

Why some test use thread_sleep_for and the other use ThisThread::sleep_for ?
@maciejbocianski
Thread_sleep_for is only supported in baremetal. if the test case requires to run bare metal and RTOS, then it uses this API.
Note:
Thread_sleep_for internally calls either ThisThread::sleep_for API for RTOS mode or do_timed_sleep_relative_or_forever for bare metal mode.

jamesbeyond · 2020-03-05T11:49:36Z

This PR needs to merge after : ARMmbed/mbed-os-examples-docs_only#59

kjbracey · 2020-03-05T12:06:14Z

if the test case requires to run bare metal and RTOS, then it uses this API.

To clarify, both APIs are available bare-metal, but you do have to ask for the C++ apis with requires: "rtos-api" in your mbed_app.json, as they're not enabled by default.

Biggest 2 reasons to use thread_sleep_for are (a) you're in writing a C file or (b) you're in the main Mbed OS hal/drivers/targets directories and want to cope with the RTOS API not being there - for now we've been avoiding having a dependency from those directories to the rtos one. (Because quite a few people put rtos in their .mbedignore).

It's no big deal which the tests use though. Using the C one is fine.

Note that all the C++ timing APIs you're switching to are planned to be deprecated by #12425 - they'll want to be changed again to ThisThread::sleep_for(1s) or ThisThread::sleep_for(500ms).

0xc0170 · 2020-03-09T07:11:21Z

there are two libraries that need to be rebuilt for this PR:

targets/TARGET_WICED/TOOLCHAIN_ARMC6/TARGET_MTB_MXCHIP_EMW3166/libwiced_drivers.ar - @michalpasztamobica @AnttiKauppila
targets/TARGET_STM/TARGET_STM32F4/TARGET_STM32F439xI/TARGET_MODULE_UBLOX_ODIN_W2/sdk/TOOLCHAIN_ARM/libublox-odin-w2-driver.ar
@ARMmbed/team-ublox

Can you please rebuilt the libraries using this PR and share SHA on your branch? We can cherry-pick them here so all goes in together.

@rajkan01 Please correct me if any other library missing in this list.

AnttiKauppila · 2020-03-09T08:10:01Z

@tymoteuszblochmobica / @mtomczykmobica - Could you check Martin's last comment regarding to libwiced drivers?

rajkan01 · 2020-03-09T12:06:50Z

there are two libraries that need to be rebuilt for this PR:

targets/TARGET_WICED/TOOLCHAIN_ARMC6/TARGET_MTB_MXCHIP_EMW3166/libwiced_drivers.ar - @michalpasztamobica @AnttiKauppila

targets/TARGET_STM/TARGET_STM32F4/TARGET_STM32F439xI/TARGET_MODULE_UBLOX_ODIN_W2/sdk/TOOLCHAIN_ARM/libublox-odin-w2-driver.ar
@ARMmbed/team-ublox

Can you please rebuilt the libraries using this PR and share SHA on your branch? We can cherry-pick them here so all goes in together.
@rajkan01 Please correct me if any other library missing in this list.

@0xc0170 yes, in addition to the previous list with below libraries also needs to be check for the wait API usage

mbed-ci · 2020-04-02T19:17:39Z

Test run: FAILED

Summary: 1 of 7 test jobs failed
Build number : 9
Build artifacts

Failed test jobs:

jenkins-ci/mbed-os-ci_greentea-test

rajkan01 · 2020-04-02T19:55:45Z

@0xc0170 mbed test setup handler was failed. Please restart the greentea test

[1585852052.00][urllib3.connectionpool]https://mervi.mbedcloudtesting.com:443 "PUT /resource/079602210525681A3A61FEB1/connect HTTP/1.1" 200 78
[1585852052.00][GLRM][INF] remote resources reset...
mbedgt: :73::FAIL: Expected 0 Was -3010
[1585852052.50][CONN][RXD] :73::FAIL: Expected 0 Was -3010
mbedgt: :73::FAIL: Expected 0 Was -3010
[1585852052.50][CONN][RXD] :73::FAIL: Expected 0 Was -3010
[1585852052.50][CONN][RXD] >>> failure with reason 'Assertion Failed' during 'Test Setup Handler'

0xc0170 · 2020-04-03T06:51:05Z

Restarted test, this is known issue

0xc0170 · 2020-04-06T09:58:21Z

Restarted tests, some targets were put into maintenance mode in CI.

…PI with IRQ masked, so wait_us is used to fix this issue as PWM testes to be executed with interrupt disabled to avoid context switch.

- Incorporate the review comment.

0xc0170 · 2020-04-08T10:31:33Z

CI restarted

mbed-ci · 2020-04-08T11:08:50Z

Test run: FAILED

Summary: 2 of 3 test jobs failed
Build number : 10
Build artifacts

Failed test jobs:

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

0xc0170 · 2020-04-08T18:43:41Z

CI restarted (ble example was fixed)

mbed-ci · 2020-04-08T20:19:15Z

Test run: SUCCESS

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

0xc0170 · 2020-04-09T07:02:48Z

CI passed, time for some reviews

evedon

Re-approved

rajkan01 force-pushed the waitapi_remove_deprecated branch from 7332519 to 8fa3202 Compare March 4, 2020 15:56

ciarmcom requested review from evedon and a team March 4, 2020 16:00

ciarmcom added the needs: review label Mar 4, 2020

evedon added the do not merge label Mar 4, 2020

rajkan01 mentioned this pull request Mar 4, 2020

Remove mbed wait deprecated API usage ARMmbed/ci-test-shield#96

Merged

maciejbocianski suggested changes Mar 4, 2020

View reviewed changes

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

mergify bot added needs: work and removed needs: review labels Mar 4, 2020

jamesbeyond mentioned this pull request Mar 5, 2020

update examplea replace deprecated wait and wait_ms api ARMmbed/mbed-os-examples-docs_only#59

Merged

rajkan01 force-pushed the waitapi_remove_deprecated branch from 67f1a6f to da3e53e Compare March 5, 2020 12:26

This was referenced Mar 6, 2020

Remove the deprecated wait API usage ARMmbed/i2cee-driver#6

Merged

Remove wait deprecated API usage ARMmbed/mbed-os-example-ble#286

Merged

rajkan01 force-pushed the waitapi_remove_deprecated branch from b3c8b9f to 1468a73 Compare March 6, 2020 16:04

0xc0170 added needs: CI mergify skip and removed ready for merge labels Apr 2, 2020

qasim-ublox mentioned this pull request Apr 3, 2020

Update ODIN drivers to v3.8.0 RC1 #12756

Closed

jamesbeyond mentioned this pull request Apr 4, 2020

FIX: update usb device tests for deprecated API #12739

Merged

rajkan01 added 4 commits April 8, 2020 10:35

Remove mbed wait deprecated APIs

83be3f2

Fix the CI build issue

9739b56

ThisThread::sleep_for is asserted when the PWM test case calls this A…

cbb15ad

…PI with IRQ masked, so wait_us is used to fix this issue as PWM testes to be executed with interrupt disabled to avoid context switch.

- Fix the CI build issue.

3d128e8

- Incorporate the review comment.

rajkan01 force-pushed the waitapi_remove_deprecated branch from 5eba674 to 3d128e8 Compare April 8, 2020 09:35

0xc0170 added needs: review and removed needs: CI labels Apr 9, 2020

0xc0170 approved these changes Apr 9, 2020

View reviewed changes

evedon approved these changes Apr 9, 2020

View reviewed changes

0xc0170 added the release-version: 6.0.0-beta-1 label Apr 9, 2020

bulislaw approved these changes Apr 9, 2020

View reviewed changes

0xc0170 added ready for merge and removed needs: review labels Apr 9, 2020

0xc0170 merged commit 7fce7f5 into ARMmbed:master Apr 9, 2020

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

ccli8 mentioned this pull request Apr 14, 2020

Update cmsis pack index.json partially #12800

Closed

Remove mbed wait deprecated APIs #12572

Remove mbed wait deprecated APIs #12572

Uh oh!

Conversation

rajkan01 commented Mar 4, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Impact of changes

Migration actions required

Documentation

Pull request type

Test results

Reviewers

Uh oh!

ciarmcom commented Mar 4, 2020

Uh oh!

evedon commented Mar 4, 2020

Uh oh!

maciejbocianski left a comment

Choose a reason for hiding this comment

Uh oh!

maciejbocianski Mar 4, 2020

Choose a reason for hiding this comment

Uh oh!

maciejbocianski Mar 4, 2020

Choose a reason for hiding this comment

Uh oh!

rajkan01 Mar 5, 2020 • 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!

cmonr commented Mar 4, 2020

Uh oh!

mbed-ci commented Mar 4, 2020

Test run: FAILED

Uh oh!

rajkan01 commented Mar 5, 2020

Uh oh!

jamesbeyond commented Mar 5, 2020

Uh oh!

kjbracey commented Mar 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0xc0170 commented Mar 9, 2020

Uh oh!

AnttiKauppila commented Mar 9, 2020

Uh oh!

rajkan01 commented Mar 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mbed-ci commented Apr 2, 2020

Test run: FAILED

Uh oh!

rajkan01 commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0xc0170 commented Apr 3, 2020

Uh oh!

0xc0170 commented Apr 6, 2020

Uh oh!

0xc0170 commented Apr 8, 2020

Uh oh!

mbed-ci commented Apr 8, 2020

Test run: FAILED

Uh oh!

0xc0170 commented Apr 8, 2020

Uh oh!

mbed-ci commented Apr 8, 2020

Test run: SUCCESS

Uh oh!

0xc0170 commented Apr 9, 2020

Uh oh!

evedon left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rajkan01 commented Mar 4, 2020 •

edited

Loading

rajkan01 Mar 5, 2020 •

edited

Loading

kjbracey commented Mar 5, 2020 •

edited

Loading

rajkan01 commented Mar 9, 2020 •

edited

Loading

rajkan01 commented Apr 2, 2020 •

edited

Loading