Bring USB Feature branch into master #9768

c1728p9 · 2019-02-19T21:59:36Z

Description

Bring feature-hal-spec-usb-device into master.

Pull request type

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

Reviewers

Release Notes

This feature brings USB Device support into Mbed OS from a feature branch. Targets that support USB include the LPC1768, ARCH_PRO, K64F, NUCLEO_F207ZG, NUCLEO_F412ZG, DISCO_F413ZH, NUCLEO_F413ZH, NUCLEO_F429ZI, NUCLEO_F446ZE, NUCLEO_F746ZG, NUCLEO_F756ZG, NUCLEO_F767ZI, DISCO_F469NI, DISCO_F746NG, DISCO_F769NI, DISCO_L475VG_IOT01A, DISCO_L476VG, RZ_A1H, GR_LYCHEE, DISCO_L496AG, NUCLEO_L496ZG, NUCLEO_L4R5ZI. Supported USB device classes include USBAudio, USBHID, USBMouse, USBKeyboard, USBMIDI, USBMSD, USBSerial and USBCDC.

ciarmcom · 2019-02-19T22:01:20Z

@c1728p9, thank you for your changes.
@ARMmbed/mbed-os-core @ARMmbed/mbed-os-tools @ARMmbed/mbed-os-maintainers @ARMmbed/mbed-os-hal please review.

juhaylinen · 2019-02-20T11:13:04Z

@c1728p9 Support for USBCDC_ECM class seems to be missing from the PR. Should I add the support here? My original PR #9443

TESTS/host_tests/usb_device_serial.py

cmonr · 2019-02-20T17:03:48Z

@c1728p9 Why is this PR your fork instead of ARMmbed:feature-hal-spec-usb-device

cmonr · 2019-02-20T17:04:47Z

Also, any chance of progressing these other PRs coming into the ARMmbed feature branch?
https://github.com/ARMmbed/mbed-os/pulls?utf8=%E2%9C%93&q=is%3Apr+is%3Aopen+base%3Afeature-hal-spec-usb-device+

c1728p9 · 2019-02-20T22:46:01Z

Also, any chance of progressing these other PRs coming into the ARMmbed feature branch?

Both of these need updates. It may be best re-create these PRs against master once this goes in.

cmonr · 2019-02-20T23:17:24Z

@ARMmbed/mbed-os-maintainers Note, this is a rebase ARMmbed:feature-hal-spec-usb-device and feature branch merge.

I'm fine with letting this come in asis, and removing ARMmbed:feature-hal-spec-usb-device once it's merged. Thoughts?

c1728p9 · 2019-02-20T23:54:27Z

Added SPDX license identifiers and fixed astyle problems.

bridadan

Seems ok to me!

Will there be a future PR to remove the unsupported USB stack? https://github.com/ARMmbed/mbed-os/tree/master/features/unsupported/USBDevice

bridadan · 2019-02-21T14:51:43Z

TESTS/host_tests/pyusb_basic.py

+    """
+
+    list = [64, 256]
+    dev = y


Holy smokes, what a host test! 🚢

bridadan · 2019-02-21T14:52:44Z

TESTS/usb_device/basic/README.md

+When you run the `tests-usb_device-basic` test suite on a Linux machine, please make
+sure that at least one of the following prerequisites are met:
+* using the Linux kernel ***4.17* or newer**,
+* using the ***eHCI*** USB driver instead of *xHCI*.


@ARMmbed/mbed-os-test FYI

@c1728p9 What's the technical reason for this limitation?

Are we expecting devlopers to have to load a specific OS driver to be able to test in Linux?

@c1728p9 What's the technical reason for this limitation?

Basically, an incomplete implementation of xHCI driver in kernels prior to 4.17. Please see the rest of this readme. I've also included some links for reference.

Basically, an incomplete implementation of xHCI driver in kernels prior to 4.17. Please see the rest of this readme. I've also included some links for reference.

Damn, those are actually good technical reasons...

Thanks for having them in the readme.

requirements.txt

c1728p9 · 2019-02-21T18:25:51Z

@ARMmbed/mbed-os-maintainers be aware, USB tests are currently not part of CI. @OPpuolitaival will need to make some infrastructure changes to enable this. The two biggest limitations are:

USB tests require that host tests run locally
CI needs to have the target USB cables connected

Add the USBPhy and USBPhyEvents abstract classes, the HAL header using this class and the EndpointResolver utility class.

Copy the USBDevice code out of unsupported and into a top level USB folder in preparation for development. squash

Update USB licenses from MIT to Apache 2 and run astyle on the code.

Update the USBDevice class API so it matches mbed-os's naming conventions, has a more robust API and uses USBPhy as its backend.

Add a USB test and the class USBTester.cpp to go along with it.

Move the LPC17xx USB driver files from mbed-os\features\unsupported\USBDevice\targets\TARGET_NXP and update them to match the new USBPhy API.

This function is for USB_OTG_FS devices only. Move it in the correct place (in "#ifdef USB_OTG_FS" area).

Abort all endpoint transfers before running the test again. Use an updated vendor request to explicitly restart device reads.

Remove mbed.h from USB files and fix the build errors this causes. This is required to pass CI.

Update the header of all files to use a newer license template which includes SPDX-License-Identifier.

Add an upper bound to the API version of pyusb. Co-Authored-By: c1728p9 <[email protected]>

c1728p9 · 2019-02-22T17:17:08Z

Rebased to fix conflicts with requirements.txt changes

0xc0170 · 2019-02-25T11:26:43Z

While reviewing, early CI run now

mbed-ci · 2019-02-25T15:55:40Z

Test run: SUCCESS

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

cmonr · 2019-02-25T17:26:40Z

@fkjagodzinski @jeromecoutant @ARMmbed/mbed-os-core @ARMmbed/mbed-os-hal @ARMmbed/mbed-os-test @bulislaw @donatieng @SenRamakri Please review. This appears to be ready for merge.

fkjagodzinski

Looks good for me 👍

bulislaw · 2019-02-26T15:30:29Z

This PR is at risk of missing 5.12 release as it's marked as "needs: review". Code freeze is coming! On Friday 1st. Please review the changes ASAP.

@ARMmbed/mbed-os-hal

bulislaw · 2019-02-26T15:32:12Z

This PR is at risk of missing 5.12 release as it's marked as "needs: review". Code freeze is coming! On Friday 1st. Please review the changes ASAP.

@ARMmbed/mbed-os-hal

ciarmcom requested review from a team February 19, 2019 22:01

ciarmcom added the needs: review label Feb 19, 2019

cmonr requested review from donatieng, bulislaw and SenRamakri February 19, 2019 22:57

cmonr added the release-version: 5.12.0-rc1 label Feb 19, 2019

cmonr requested a review from a team February 19, 2019 22:57

jeromecoutant approved these changes Feb 20, 2019

View reviewed changes

0xc0170 reviewed Feb 20, 2019

View reviewed changes

TESTS/host_tests/usb_device_serial.py Show resolved Hide resolved

cmonr added the do not merge label Feb 20, 2019

cmonr removed the do not merge label Feb 20, 2019

bridadan approved these changes Feb 21, 2019

View reviewed changes

c1728p9 added 6 commits February 22, 2019 10:52

Add USBPhy, USB HAL and Utility class

8ae123f

Add the USBPhy and USBPhyEvents abstract classes, the HAL header using this class and the EndpointResolver utility class.

Copy USBDevice from unsupported

a4b6cfe

Copy the USBDevice code out of unsupported and into a top level USB folder in preparation for development. squash

Update USB licenses and format code

f7cb2cd

Update USB licenses from MIT to Apache 2 and run astyle on the code.

Update USBDevice and configure to use a USBPhy

caace4a

Update the USBDevice class API so it matches mbed-os's naming conventions, has a more robust API and uses USBPhy as its backend.

Add USBDevice test code

f9f1276

Add a USB test and the class USBTester.cpp to go along with it.

Add USBPhy for the LPC17xx

4be11ff

Move the LPC17xx USB driver files from mbed-os\features\unsupported\USBDevice\targets\TARGET_NXP and update them to match the new USBPhy API.

bcostm and others added 15 commits February 22, 2019 10:53

STM32L4 USB: add patch in CubeL4 hal driver

4ca33aa

STM32L4 USB: add pins definition for STM32L496/L4R5 MCUs

82498cf

STM32L4 USB: move HAL_PCD_EP_Abort function

aa2b76a

This function is for USB_OTG_FS devices only. Move it in the correct place (in "#ifdef USB_OTG_FS" area).

STM32F7 USB: add patch in CubeF7 hal driver

28462d4

STM32F7 USB: change VBUS pin for DISCO_F746NG FS

e96b8a4

STM32F7 USB: add NUCLEO_F756ZG in pins definition

a98eb73

STM32F7 USB: enable USBDEVICE in targets.json

b6b7d00

Tests: USB: Fix 'endpoint halt' test

3803245

Abort all endpoint transfers before running the test again. Use an updated vendor request to explicitly restart device reads.

Tests: USB: Use astyle to format the test class

4a4dcdb

STM32L4 USB: enable USBDEVICE

bd6e9aa

Remove inclusion of mbed.h from USB

8d73156

Remove mbed.h from USB files and fix the build errors this causes. This is required to pass CI.

Applied suggested astyle fixes

005df35

Applied more astyle fixes

9f116d9

Update files to include SPDX-License-Identifier

6527cf2

Update the header of all files to use a newer license template which includes SPDX-License-Identifier.

Update requirements.txt

0e6056b

Add an upper bound to the API version of pyusb. Co-Authored-By: c1728p9 <[email protected]>

c1728p9 force-pushed the feature-hal-spec-usb-device branch from 152f9a4 to 0e6056b Compare February 22, 2019 17:16

cmonr added the risk: A label Feb 25, 2019

fkjagodzinski approved these changes Feb 26, 2019

View reviewed changes

bulislaw approved these changes Feb 26, 2019

View reviewed changes

deepikabhavnani approved these changes Feb 26, 2019

View reviewed changes

cmonr added ready for merge and removed needs: review labels Feb 26, 2019

cmonr merged commit 4b13c8a into ARMmbed:master Feb 27, 2019

cmonr removed the ready for merge label Feb 27, 2019

Bring USB Feature branch into master #9768

Bring USB Feature branch into master #9768

Uh oh!

Conversation

c1728p9 commented Feb 19, 2019

Description

Pull request type

Reviewers

Release Notes

Uh oh!

ciarmcom commented Feb 19, 2019

Uh oh!

juhaylinen commented Feb 20, 2019

Uh oh!

Uh oh!

cmonr commented Feb 20, 2019

Uh oh!

cmonr commented Feb 20, 2019

Uh oh!

c1728p9 commented Feb 20, 2019

Uh oh!

cmonr commented Feb 20, 2019

Uh oh!

c1728p9 commented Feb 20, 2019

Uh oh!

bridadan left a comment

Choose a reason for hiding this comment

Uh oh!

bridadan Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

bridadan Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

cmonr Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

fkjagodzinski Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

cmonr Feb 21, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

c1728p9 commented Feb 21, 2019

Uh oh!

c1728p9 commented Feb 22, 2019

Uh oh!

0xc0170 commented Feb 25, 2019

Uh oh!

mbed-ci commented Feb 25, 2019

Test run: SUCCESS

Uh oh!

cmonr commented Feb 25, 2019

Uh oh!

fkjagodzinski left a comment

Choose a reason for hiding this comment

Uh oh!

bulislaw commented Feb 26, 2019

Uh oh!

bulislaw commented Feb 26, 2019

Uh oh!

Uh oh!