Update UART pin names & add MBED_CONF_TARGET_STDIO_UART overrides #14457

gpsimenos · 2021-03-23T11:22:38Z

Summary of changes

This PR updates instances of USBTX and USBRX to CONSOLE_TX and CONSOLE_RX respectively, as the names of the UART pins used for console in Mbed boards.

All targets are also updated to support overriding the default CONSOLE_TX and CONSOLE_RX pin using the MBED_CONF_TARGET_STDIO_UART_TX and MBED_CONF_TARGET_STDIO_UART_RX options in mbed_app.json.

Impact of changes

No impact expected from application point of view. Legacy aliases are in place for now.

Migration actions required

Documentation

Pull request type

[X] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] 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

Verified compliance with pinvalidate tool. Some targets did not have USBTX/RX defined and consequently also do not have CONSOLE_TX/RX: S5JS100, S1SBP6A, ARM_MUSCA_B1, ARM_MUSCA_S1.

Travis is expected to fail the pinvalidate test because this PR modifies a lot of PinNames.h files which have not been migrated to the new standard yet.

Reviewers

ciarmcom · 2021-03-23T11:30:16Z

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

jeromecoutant · 2021-03-23T11:48:11Z

Note that pinvalidate script has not been executed...

@MarceloSalazar

edit: I see there are 2 Travis CI now:

on Travis CI Branch: pinvalidate script has not been executed
on Travis CI Pull Request: pinvalidate script has been executed and failed...

jeromecoutant

This doesn't compile:

$ mbed test --compile -m NUCLEO_L552ZE_Q -t ARM -n drivers-tests-tests-mbed_drivers-echo
[Error] mbed_pinmap_default.cpp@73,9: use of undeclared identifier 'USBTX'
[Error] mbed_pinmap_default.cpp@73,21: use of undeclared identifier 'USBRX'

jeromecoutant · 2021-03-23T13:24:49Z

Suggestion::

$ git diff hal/include/hal/PinNameAliases.h

/* Aliases for legacy reasons. To be removed in the next Mbed OS version */
-#if defined (CONSOLE_TX) && (CONSOLE_RX)
#define USBTX CONSOLE_TX
#define USBRX CONSOLE_RX
-#else
-#define CONSOLE_TX USBTX
-#define CONSOLE_RX USBRX
-#endif

jeromecoutant · 2021-03-23T13:26:32Z

Another comment: "git grep USBTX" still has some results...

Suggestion: update pinvalidate.py script, and set test as failed if USBTX is used

gpsimenos · 2021-03-23T17:09:59Z

The pinvalidate tool is already updated to fail targets that don't use CONSOLE_TX/CONSOLE_RX.

Travis is expected to fail the pinvalidate test because this PR modifies a lot of PinNames.h files which are not yet compliant.

gpsimenos · 2021-03-23T17:10:31Z

Suggestion::

$ git diff hal/include/hal/PinNameAliases.h

/* Aliases for legacy reasons. To be removed in the next Mbed OS version */
-#if defined (CONSOLE_TX) && (CONSOLE_RX)
#define USBTX CONSOLE_TX
#define USBRX CONSOLE_RX
-#else
-#define CONSOLE_TX USBTX
-#define CONSOLE_RX USBRX
-#endif

Applied!

jeromecoutant · 2021-03-24T07:53:12Z

Another comment: "git grep USBTX" still has some results...

Did you check this ?

gpsimenos · 2021-03-24T10:18:42Z

Another comment: "git grep USBTX" still has some results...

Did you check this ?

Done!

jeromecoutant

Let's start CI in order to check build ?

gpsimenos · 2021-03-25T09:57:01Z

@adbridge Let's start CI

gpsimenos · 2021-03-25T13:32:59Z

This doesn't compile:

$ mbed test --compile -m NUCLEO_L552ZE_Q -t ARM -n drivers-tests-tests-mbed_drivers-echo
[Error] mbed_pinmap_default.cpp@73,9: use of undeclared identifier 'USBTX'
[Error] mbed_pinmap_default.cpp@73,21: use of undeclared identifier 'USBRX'

Now compiles after suggestion above applied.

adbridge · 2021-03-25T14:05:52Z

CI started

adbridge · 2021-03-25T14:47:54Z

@gpsimenos looks like lots of failures...

mbed-ci · 2021-03-25T14:59:37Z

Jenkins CI Test : ❌ FAILED

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs	Status
jenkins-ci/mbed-os-ci_build-greentea-ARM	❌
jenkins-ci/mbed-os-ci_unittests	✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM	❌
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM	❌
jenkins-ci/mbed-os-ci_cmake-example-ARM	❌
jenkins-ci/mbed-os-ci_build-cloud-example-ARM	✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM	❌
jenkins-ci/mbed-os-ci_build-example-ARM	❌

gpsimenos · 2021-03-25T15:37:04Z

Let's retry, all targets should now build!

mbed-ci · 2021-03-25T21:09:25Z

Jenkins CI Test : ✔️ SUCCESS

Build Number: 2 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs	Status
jenkins-ci/mbed-os-ci_unittests	✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM	✔️
jenkins-ci/mbed-os-ci_cmake-example-ARM	✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM	✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-greentea-ARM	✔️
jenkins-ci/mbed-os-ci_build-example-ARM	✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_cmake-example-test	✔️
jenkins-ci/mbed-os-ci_greentea-test	✔️
jenkins-ci/mbed-os-ci_tfm-integration	✔️

gpsimenos · 2021-03-26T09:43:35Z

@adbridge Let's merge!

adbridge

Subject to fixing the travis failures

gpsimenos · 2021-03-26T15:12:36Z

Travis is expected to fail the pinvalidate test because this PR modifies a lot of PinNames.h files which are not yet compliant :)

There's no easy way to understand if ARMmbed/mbed-os#14457 has been applied or not in the tree we are compiling

Update UART pin names & add MBED_CONF_TARGET_STDIO_UART overrides

61cfaa1

ciarmcom added the release-type: patch Indentifies a PR as containing just a patch label Mar 23, 2021

ciarmcom requested a review from a team March 23, 2021 11:30

mergify bot added needs: work and removed needs: review labels Mar 23, 2021

jeromecoutant suggested changes Mar 23, 2021

View reviewed changes

Update USBTX/USBRX alias

8a4b88c

gpsimenos added 2 commits March 24, 2021 10:11

Replace USBTX/RX everywhere else

cd5330e

Replace USBTX/RX in docs

3e63fd9

jeromecoutant approved these changes Mar 24, 2021

View reviewed changes

Replace USBTX/RX

8600157

gpsimenos mentioned this pull request Mar 25, 2021

Add support for MIMXRT1170_EVK #14394

Closed

typo

9cc2deb

MarceloSalazar approved these changes Mar 26, 2021

View reviewed changes

adbridge approved these changes Mar 26, 2021

View reviewed changes

adbridge merged commit 0742135 into master Mar 26, 2021

MarceloSalazar mentioned this pull request Mar 28, 2021

Mbed config for STDIO_UART_TX not consistently implemented across targets #6689

Closed

3 tasks

facchinm added a commit to arduino/ArduinoCore-mbed that referenced this pull request Apr 6, 2021

TEMP: revert UART names for edge control

b64b3a3

There's no easy way to understand if ARMmbed/mbed-os#14457 has been applied or not in the tree we are compiling

s-bruce13 mentioned this pull request Apr 14, 2021

Adding NXP TARGET- MIMXRT1170_EVK #14505

Merged

mbedmain added release-version: 6.10.0 Release-pending labels Apr 16, 2021

mbedmain removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Apr 26, 2021

0xc0170 deleted the uart-stdio-alias branch October 7, 2021 13:52

sebromero pushed a commit to sebromero/ArduinoCore-mbed that referenced this pull request Feb 2, 2022

TEMP: revert UART names for edge control

9e106bf

There's no easy way to understand if ARMmbed/mbed-os#14457 has been applied or not in the tree we are compiling

Update UART pin names & add MBED_CONF_TARGET_STDIO_UART overrides #14457

Update UART pin names & add MBED_CONF_TARGET_STDIO_UART overrides #14457

Uh oh!

Conversation

gpsimenos commented Mar 23, 2021 • 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 23, 2021

Uh oh!

jeromecoutant commented Mar 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jeromecoutant left a comment

Choose a reason for hiding this comment

Uh oh!

jeromecoutant commented Mar 23, 2021

Uh oh!

jeromecoutant commented Mar 23, 2021

Uh oh!

gpsimenos commented Mar 23, 2021

Uh oh!

gpsimenos commented Mar 23, 2021

Uh oh!

jeromecoutant commented Mar 24, 2021

Uh oh!

gpsimenos commented Mar 24, 2021

Uh oh!

jeromecoutant left a comment

Choose a reason for hiding this comment

Uh oh!

gpsimenos commented Mar 25, 2021

Uh oh!

gpsimenos commented Mar 25, 2021

Uh oh!

adbridge commented Mar 25, 2021

Uh oh!

adbridge commented Mar 25, 2021

Uh oh!

mbed-ci commented Mar 25, 2021

Jenkins CI Test : ❌ FAILED

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

Uh oh!

gpsimenos commented Mar 25, 2021

Uh oh!

mbed-ci commented Mar 25, 2021

Jenkins CI Test : ✔️ SUCCESS

Build Number: 2 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

Uh oh!

gpsimenos commented Mar 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adbridge left a comment

Choose a reason for hiding this comment

Uh oh!

gpsimenos commented Mar 26, 2021

Uh oh!

Uh oh!

gpsimenos commented Mar 23, 2021 •

edited

Loading

jeromecoutant commented Mar 23, 2021 •

edited

Loading

gpsimenos commented Mar 26, 2021 •

edited

Loading