USB Host + MSC #1196

rhapsodyv · 2020-10-04T01:09:46Z

Pull Request template

Summary

This PR fixes/implements the following bugs/features

USB Host
MSC for USB Host

It will allow STM users to use USB Host feature with MSC support.

I tried to follow the same development workflow from the usb device midleware. I created a folder cores/arduino/stm32/usb_host, and put the conf and the references to the middleware.

There's some work to do yet:

HCD shares a few definitions with PCD.
For example, the PinMap_USB_OTG_FS in the PeripheralPins.c for each variant. Do we need update all variants to include a "or" in the #ifdef?
Can HCD and PCD be enabled at same time? If so, we need to join IRQ handler.
Interface for USB Host Config + MSC operations. Right now, I'm just exposing the MSC interface from STM32 middleware.
Missing OTG HS
I didn't organize the comments, style and options in the files, yet.

It works if USBCON is disabled, and HAL_HCD_MODULE_ENABLED and USBHOST are enabled.

Sorry if I'm missing something. It's my first PR in this project, and it may take sometime to get everything as it should be.

Related to: #687

rhapsodyv · 2020-10-04T03:53:50Z

Usage:

Compile with:
-DHAL_HCD_MODULE_ENABLED -DUSBHOST -DHAL_PCD_MODULE_ENABLED

//includes
#include "usbh_core.h"
#include "usbh_msc.h"

//handle
USBH_HandleTypeDef hUsbHostFS;

//callback
static void USBH_UserProcess  (USBH_HandleTypeDef *phost, uint8_t id)
{
  /* USER CODE BEGIN CALL_BACK_1 */
  switch(id)
  {
    case HOST_USER_SELECT_CONFIGURATION:
    
    break;

    case HOST_USER_DISCONNECTION:

    break;

    case HOST_USER_CLASS_ACTIVE:
      //ready!
    break;

    case HOST_USER_CONNECTION:

    break;

    default:
    break;
  }
}

//init calls
void my_init_routine() {
  ...
  USBH_Init(&hUsbHostFS, USBH_UserProcess, HOST_FS);
  USBH_RegisterClass(&hUsbHostFS, USBH_MSC_CLASS);
  USBH_Start(&hUsbHostFS);
  ..
}

//loop call
void loop() {
  ..
  USBH_Process(&hUsbHostFS);
  ..
}

//read sample: it will read (sectors_to_read) * (sector size) bytes
USBH_StatusTypeDef ret = USBH_MSC_Read(&hUsbHostFS, lun, sector_addr, buffer, sectors_to_read);

rhapsodyv · 2020-10-04T18:44:37Z

Tested with success in: STM32F407VET6, STM32F407IGT6 and STM32F407ZGT6.

fpistm · 2020-10-05T08:55:20Z

Hi @rhapsodyv

thanks a lot for this PR.
I will try to do a first review soon.

MS1987 · 2020-10-27T01:29:20Z

@fpistm Can this PR be merged now?

rhapsodyv · 2020-10-27T01:49:47Z

I think the only important question to merge it is:

HCD shares a few definitions with PCD.
For example, the PinMap_USB_OTG_FS in the PeripheralPins.c for each variant. Do we need update all variants to include a "or" in the #ifdef?
Can HCD and PCD be enabled at same time? If so, we need to join IRQ handler.

I'm currently enabling PCD just to use the pins definitions.
But maybe we need update the variants to handle HCD too.

And soon I will receive a board with two usb, so I will test it and join the pcd/hcs irq handler.

I can send all changes. I just need that @fpistm point the direction for me :-)

fpistm · 2020-10-30T15:46:50Z

For example, the PinMap_USB_OTG_FS in the PeripheralPins.c for each variant. Do we need update all variants to include a "or" in the #ifdef?
Can HCD and PCD be enabled at same time? If so, we need to join IRQ handler.

Yes the "or" have to be added. I'm currently updating the files generation, I will add the HCD.

Can HCD and PCD be enabled at same time? If so, we need to join IRQ handler.

I don't know but I think as a first step it should be better to handle one at a time.

rhapsodyv · 2020-10-30T17:08:41Z

Can HCD and PCD be enabled at same time? If so, we need to join IRQ handler.

I don't know but I think as a first step it should be better to handle one at a time.

I'm about to receive a board that have two USB. One in OTG HS and other in OTG FS. The central idea is to use one to read a thumb drive (USB Host) and the other to connect to the computer and share the pendrive as mass storage.
I didn't tested it yet. But I can't see any reason for it not work.

But I really agree with you. For the first version, we must keep what is tested and working. As soon I test that dual mode on that board, I will let you know if it works.

Thanks.

fpistm · 2020-10-30T17:17:33Z

I'm about to receive a board that have two USB. One in OTG HS and other in OTG FS. The central idea is to use one to read a thumb drive (USB Host) and the other to connect to the computer and share the pendrive as mass storage.
I didn't tested it yet. But I can't see any reason for it not work.

Main issue would be the USBD part as currently if we enable both FS and HS this will not work, I guess.

rhapsodyv · 2020-10-30T17:28:19Z

Main issue would be the USBD part as currently if we enable both FS and HS this will not work, I guess.

Indeed. I don't know if it will work. I found some stm32 forum messages saying that it works. But only testing to confirm it or not.
I know that the code will need to be updated, so we can choose what enable in each mode. Today we just have USB_OTG_FS and USB_OTG_HS. We may need a way to specify, for example, that we want FS in PCD and HS in HCD.

fpistm · 2020-10-30T17:40:19Z

Today we just have USB_OTG_FS and USB_OTG_HS. We may need a way to specify, for example, that we want FS in PCD and HS in HCD.

Right.

stm32duino/Arduino_Core_STM32#1196 Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

Bob-the-Kuhn · 2020-12-07T02:47:35Z

GLad to see work in this area.

Does this replace PR #1088?

rhapsodyv · 2020-12-07T03:03:26Z

GLad to see work in this area.

Does this replace PR #1088?

I think #1088 is for usb mode device (PCD). My work is for usb mode host (HCD). They are complementary.

BTW, @fpistm I just received a board to test PCD+HCD. Soon I will start to push new code here.

rhapsodyv · 2020-12-10T04:49:59Z

@fpistm I pushed a version that will allow PCD and HCD working together. To avoid conflict and to not break compatibility, I added a new config to select HS on HCD (USE_USBHOST_HS).

It easier to just show the possible combinations:

To use HCD on FS:

#define HAL_HCD_MODULE_ENABLED
#define USBHOST

To use HCD on HS:

#define HAL_HCD_MODULE_ENABLED
#define USBHOST
#define USE_USBHOST_HS.  // <<<--- new macro, to select HS on HCD

To use PCD on FS: (current code, just to illustrate)

#define HAL_PCD_MODULE_ENABLED
#define USBCON

To use PCD on HS: (current code, just to illustrate)

#define HAL_PCD_MODULE_ENABLED
#define USBCON
#define USE_USB_HS

And we can to combine then:

HCD on FS + PCD on HS:

// HCD on FS
#define HAL_HCD_MODULE_ENABLED
#define USBHOST

// PCD on HS
#define HAL_PCD_MODULE_ENABLED
#define USBCON 
#define USE_USB_HS

Or: HCD on HS + PCD on FS:

// HCD on HS
#define HAL_HCD_MODULE_ENABLED
#define USBHOST
#define USE_USBHOST_HS

// PCD on FS
#define HAL_PCD_MODULE_ENABLED
#define USBCON

rhapsodyv · 2020-12-11T04:28:53Z

With this PR plus #1088 I'm able to use fully mix usb host / usb device mass storage.

Using OTG HS to host the thumb drive + using OTG FS to uses CDC + MSC, to share the thumb driver or the SD Card with the Computer.
Everything working together. The mount/unmont and media select work without any power cycle needed.

stm32duino/Arduino_Core_STM32#1196 Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

fpistm · 2021-05-03T12:54:57Z

hi @rhapsodyv
what is the status of this PR. I'm a bit lost when you said

With this PR plus #1088 I'm able to use fully mix usb host / usb device mass storage.

I though this one replace #1088 ?

Thanks

rhapsodyv · 2021-05-03T14:13:26Z

This is exclusively to USB host: for example, enable a board to use a usb disk drive using OTG (hs or fs - hcd).

#1088 is to share the board media with a computer/using using usb OTG. For example: to share a board sd card with a windows computer as a mass storage.

I merged both PRs in a local branch, so we can, for example: allow the board access and share a usb disk drive with the computer.

We are actively using it on Marlin.

The only issue with 1088 is the name of the usb class... it should be renamed to something like "USBComposite", instead of only "USB".

rhapsodyv · 2021-05-03T18:45:11Z

It's even allow a mouse to be attached to a board heheheh:

IMG_0523.MOV

gordo3di · 2021-07-19T18:15:40Z

This is exclusively to USB host: for example, enable a board to use a usb disk drive using OTG (hs or fs - hcd).

#1088 is to share the board media with a computer/using using usb OTG. For example: to share a board sd card with a windows computer as a mass storage.

I merged both PRs in a local branch, so we can, for example: allow the board access and share a usb disk drive with the computer.

We are actively using it on Marlin.

The only issue with 1088 is the name of the usb class... it should be renamed to something like "USBComposite", instead of only "USB".

Well thats cool! I'm trying to implement this for the newer skr v2 board any tips? I've been looking through this thread and #1088 but I'm not sure how much has already been implemented since then. Thanks

rhapsodyv · 2021-07-19T18:30:56Z

Well thats cool! I'm trying to implement this for the newer skr v2 board any tips? I've been looking through this thread and #1088 but I'm not sure how much has already been implemented since then. Thanks

It's already done on Marlin: MarlinFirmware/Marlin#22354

gordo3di · 2021-07-19T18:42:13Z

Well thats cool! I'm trying to implement this for the newer skr v2 board any tips? I've been looking through this thread and #1088 but I'm not sure how much has already been implemented since then. Thanks

It's already done on Marlin: MarlinFirmware/Marlin#22354

Interesting. Thank you. Now I have to figure out why it's not mounting for me.

rtek1000 · 2022-01-17T10:42:10Z

Hello,

Is USB HID Host (keyboard) working too?

Thank you.

rhapsodyv · 2022-01-17T14:48:53Z

Hello,

Is USB HID Host (keyboard) working too?

Thank you.

Mouse is working, keyboard should work too:

#1196 (comment)

BennehBoy · 2022-01-27T16:10:44Z

Hello,

Is USB HID Host (keyboard) working too?

Thank you.

Very interesting, I'm just looking around to see how to build a USB keyboard to legacy machine adapter (Commodore 128D in this case), and this would be extremely useful - I don't think I have the energy to dive into using raw CubeMX for it.

So what's this waiting for in terms of being able to be merged, it looks like the PCD+HCD test was successful... I guess it's just down to time from @fpistm

rtek1000 · 2022-01-27T16:20:09Z

Hello,
Is USB HID Host (keyboard) working too?
Thank you.

Very interesting, I'm just looking around to see how to build a USB keyboard to legacy machine adapter (Commodore 128D in this case), and this would be extremely useful - I don't think I have the energy to dive into using raw CubeMX for it.

So what's this waiting for in terms of being able to be merged, it looks like the PCD+HCD test was successful... I guess it's just down to time from @fpistm

Hello,

The USB Host library of the STM32 line is still very precarious, just didactic.

If you want something more fluid, check out this other alternative, which can accept the touchpad keyboard. Because it has the HUB part:

https://github.com/felis/UHS30

rtek1000 · 2022-01-27T16:26:59Z

https://community.st.com/s/question/0D53W00000GYsczSAD/is-it-possible-to-use-usb-hid-keyboard-and-mouse-at-the-same-time-on-a-stm32f469

quiret · 2023-02-15T21:29:27Z

I really wonder about the status of this PR since it has not been merged yet and there appear to be conflicts now. I would greatly appreciate any statement by participating parties. The features described in this PR seem amazing and worthwhile for the embedded world.

rhapsodyv marked this pull request as draft October 4, 2020 01:32

rhapsodyv force-pushed the usb-host-msc branch 2 times, most recently from 14d21ef to 4e4f213 Compare October 4, 2020 03:04

rhapsodyv mentioned this pull request Oct 4, 2020

[USB] Features request list #687

Open

8 tasks

rhapsodyv marked this pull request as ready for review October 4, 2020 03:54

fpistm added Enhancement New feature labels Oct 5, 2020

fpistm added this to In progress in STM32 core based on ST HAL via automation Oct 5, 2020

fpistm added a commit to fpistm/Arduino_Tools that referenced this pull request Oct 30, 2020

[genpinmap] Add HAL HCD module for USB

7c57b30

stm32duino/Arduino_Core_STM32#1196 Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

fpistm marked this pull request as draft November 6, 2020 14:33

fpistm added the Waiting feedback label Nov 6, 2020

fpistm added a commit to fpistm/Arduino_Tools that referenced this pull request Nov 26, 2020

[genpinmap] Add HAL HCD module for USB

bf37628

stm32duino/Arduino_Core_STM32#1196 Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

bigtreetech mentioned this pull request Nov 27, 2020

STM32F4 USB OTG Host msc MarlinFirmware/Marlin#20299

Closed

rhapsodyv mentioned this pull request Dec 10, 2020

Add USB MSC + MSC/CDC Composite Class #1088

Open

7 tasks

rhapsodyv marked this pull request as ready for review December 10, 2020 04:50

rhapsodyv changed the title ~~[WIP] USB Host + MSC~~ USB Host + MSC Dec 10, 2020

fpistm added this to the 2.x.x milestone Dec 14, 2020

fpistm added a commit to fpistm/Arduino_Tools that referenced this pull request Dec 22, 2020

[genpinmap] Add HAL HCD module for USB

10e2664

stm32duino/Arduino_Core_STM32#1196 Signed-off-by: Frederic Pillon <frederic.pillon@st.com>

rhapsodyv added 7 commits December 28, 2020 23:42

first working version of usb host + msc

eb37914

astyle

2a59eb5

fix include

95df014

remove debug code

a0c46a2

support for OTG HS on HCD

9691c9f

hid for usb host

6f56178

stop otg irqs

a9059d5

rhapsodyv force-pushed the usb-host-msc branch from cedc5d7 to a9059d5 Compare December 29, 2020 02:42

add HID to the build

4bfaf3d

jeno007 mentioned this pull request Jan 13, 2021

USB Flash Drive support using native USB Host + MSC MarlinFirmware/Marlin#20571

Merged

mrguen mentioned this pull request May 10, 2021

Question about PB_10 configuration on STM32F405RG probably related to USB_OTG_HS #1389

Closed

fpistm added this to Needs review in STM32duino libraries Jun 16, 2021

fpistm removed this from the 2.1.0 milestone Jul 13, 2021

rtek1000 mentioned this pull request Jan 17, 2022

[Question] Is it possible to use 2x USB Host MSC (Pendrive) and HID (Keyboard) at the same time with this core? #792

Closed

quiret mentioned this pull request Feb 15, 2023

Update toolchains to newer compilers MarlinFirmware/Marlin#25327

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

USB Host + MSC #1196

USB Host + MSC #1196

rhapsodyv commented Oct 4, 2020 •

edited

rhapsodyv commented Oct 4, 2020

rhapsodyv commented Oct 4, 2020

fpistm commented Oct 5, 2020

MS1987 commented Oct 27, 2020

rhapsodyv commented Oct 27, 2020

fpistm commented Oct 30, 2020 •

edited

rhapsodyv commented Oct 30, 2020

fpistm commented Oct 30, 2020

rhapsodyv commented Oct 30, 2020

fpistm commented Oct 30, 2020

Bob-the-Kuhn commented Dec 7, 2020

rhapsodyv commented Dec 7, 2020

rhapsodyv commented Dec 10, 2020

rhapsodyv commented Dec 11, 2020 •

edited

fpistm commented May 3, 2021 •

edited

rhapsodyv commented May 3, 2021

rhapsodyv commented May 3, 2021

gordo3di commented Jul 19, 2021

rhapsodyv commented Jul 19, 2021

gordo3di commented Jul 19, 2021

rtek1000 commented Jan 17, 2022 •

edited

rhapsodyv commented Jan 17, 2022

BennehBoy commented Jan 27, 2022

rtek1000 commented Jan 27, 2022 •

edited

rtek1000 commented Jan 27, 2022

quiret commented Feb 15, 2023 •

edited

USB Host + MSC #1196

Are you sure you want to change the base?

USB Host + MSC #1196

Conversation

rhapsodyv commented Oct 4, 2020 • edited

Pull Request template

rhapsodyv commented Oct 4, 2020

rhapsodyv commented Oct 4, 2020

fpistm commented Oct 5, 2020

MS1987 commented Oct 27, 2020

rhapsodyv commented Oct 27, 2020

fpistm commented Oct 30, 2020 • edited

rhapsodyv commented Oct 30, 2020

fpistm commented Oct 30, 2020

rhapsodyv commented Oct 30, 2020

fpistm commented Oct 30, 2020

Bob-the-Kuhn commented Dec 7, 2020

rhapsodyv commented Dec 7, 2020

rhapsodyv commented Dec 10, 2020

And we can to combine then:

rhapsodyv commented Dec 11, 2020 • edited

fpistm commented May 3, 2021 • edited

rhapsodyv commented May 3, 2021

rhapsodyv commented May 3, 2021

gordo3di commented Jul 19, 2021

rhapsodyv commented Jul 19, 2021

gordo3di commented Jul 19, 2021

rtek1000 commented Jan 17, 2022 • edited

rhapsodyv commented Jan 17, 2022

BennehBoy commented Jan 27, 2022

rtek1000 commented Jan 27, 2022 • edited

rtek1000 commented Jan 27, 2022

quiret commented Feb 15, 2023 • edited

rhapsodyv commented Oct 4, 2020 •

edited

fpistm commented Oct 30, 2020 •

edited

rhapsodyv commented Dec 11, 2020 •

edited

fpistm commented May 3, 2021 •

edited

rtek1000 commented Jan 17, 2022 •

edited

rtek1000 commented Jan 27, 2022 •

edited

quiret commented Feb 15, 2023 •

edited