Difference between revisions of "USBH internal peripheral"

[quality revision] [quality revision]
m
 
(Features)
Template:ArticleMainWriter Template:ArticleApprovedVersion

1 Article purpose[edit]

The purpose of this article is to

  • briefly introduce the USBH peripheral and its main features
  • indicate the level of security supported by this hardware block
  • explain how it can be allocated to the three runtime contexts and linked to the corresponding software components
  • explain, when needed, how to configure the USBH peripheral.

2 Peripheral overview[edit]

The USBH peripheral is used to interconnect other systems with STM32 MPU devices, using USB standard.

2.1 Features[edit]

The USBH peripheral is a USB Host controller supporting high-speed (480 Mbit/s) using an EHCI controller, and full- and low- speeds (12 and 1.5 Mbit/s) through OHCI controller.
The USBH peripheral has two physical ports providing a UTMI+ physical interface, mapped on an on-chip 2-port high-speed UTMI+ PHY.
It supports the standard registers used for low- and full-speed operation (OHCI model) and high-speed operation (EHCI model) and the power management feature called Link Power Management (LPM).

The supported standards are:

  • Universal Serial Bus Revision 2.0 Specification[1], Revision 2.0, April 27, 2000
  • USB 2.0 Link Power Management Addendum Engineering Change Notice to the USB 2.0 specification[2], July 16, 2007
  • Enhanced Host Controller Interface Specification for Universal Serial Bus[3], Revision 1.0, March 12, 2002
  • EHCI v1.1 Addendum[4], August 2008
  • Open Host Controller Interface Specification for USB[5], Release 1.0a, September 14, 1999
  • USB 2.0 Transceiver Macrocell Interface (UTMI) Specification[6], Version 1.05, March 29, 2001
  • UTMI+ Specification[7], Revision 1.0, February 25, 2004

Refer to STM32MP15 reference manuals for the complete features list, and to the software components, introduced below, to know which features are really implemented.

2.2 Security support[edit]

The USBH peripheral is a non-secure peripheral.

3 Peripheral usage and associated software[edit]

3.1 Boot time[edit]

The USBH peripheral is usually not used at boot time. But it may be used by the SSBL (see Boot chains overview), for example to boot a kernel stored on a USB key (mass storage).

3.2 Runtime[edit]

3.2.1 Overview[edit]

The USBH peripheral can be allocated to the Arm® Cortex®-A7 non-secure core to be used under Linux® with USB framework.

3.2.2 Software frameworks[edit]

Domain Peripheral Software frameworks Comment
Cortex-A7
secure
(OP-TEE)
Cortex-A7
non-secure
(Linux)
Cortex-M4

(STM32Cube)
High speed interface USBH (USB Host) Linux USB framework

3.2.3 Peripheral configuration[edit]

The configuration is applied by the firmware running in the context to which the peripheral is assigned. The configuration by itself can be performed via the STM32CubeMX tool for all internal peripherals. It can then be manually completed (especially for external peripherals) according to the information given in the corresponding software framework article.

For Linux kernel configuration, please refer to USBH device tree configuration.

3.2.4 Peripheral assignment[edit]

Internal peripherals

Check boxes illustrate the possible peripheral allocations supported by STM32 MPU Embedded Software:

  • means that the peripheral can be assigned () to the given runtime context.
  • is used for system peripherals that cannot be unchecked because they are statically connected in the device.

Refer to How to assign an internal peripheral to a runtime context for more information on how to assign peripherals manually or via STM32CubeMX.
The present chapter describes STMicroelectronics recommendations or choice of implementation. Additional possiblities might be described in STM32MP15 reference manuals.

Domain Peripheral Runtime allocation Comment
Instance Cortex-A7
secure
(OP-TEE)
Cortex-A7
non-secure
(Linux)
Cortex-M4

(STM32Cube)
High speed interface USBH (USB Host) USBH (USB Host)

4 References[edit]



<noinclude>

{{ArticleBasedOnModel | [[Internal peripheral article model]]}}
{{ArticleMainWriter | AmelieD}}
{{ArticleApprovedVersion | AmelieD | NathalieS (Passed), GeraldB (Not Done), LoicP (Not Done), FabriceG (Passed 25Jul'18) | No previous approved version | BrunoB - 20Sep'18 - 8440 | 20Sep'18}}

[[Category:High speed interface peripherals]]
{{ReviewsComments|JCT 1840: alignment needed with the last version of the model [[Internal peripheral article model]]<br>

[[Category:ToBeAlignedWithModel]]
}}</noinclude>

==Article purpose==
The purpose of this article is to
* briefly introduce the USBH peripheral and its main features
* indicate the level of security supported by this hardware block
* explain how it can be allocated to the three runtime contexts and linked to the corresponding software components
* explain, when needed, how to configure the USBH peripheral.

==Peripheral overview==
The '''USBH''' peripheral is used to interconnect other systems with STM32 MPU devices, using USB standard.

===Features===
The '''USBH''' peripheral is a USB Host controller supporting high-speed (480 Mbit/s) using an '''EHCI''' controller, and full- and low- speeds (12 and 1.5 Mbit/s) through '''OHCI''' controller. <br>

The '''USBH''' peripheral has two physical ports providing a '''UTMI+''' physical interface, mapped on an on-chip 2-port '''[[USBPHYC internal peripheral|high-speed UTMI+ PHY]]'''. <br>

It supports the standard registers used for low- and full-speed operation ('''OHCI''' model) and high-speed operation ('''EHCI''' model) and the power management feature called Link Power Management (LPM).

The supported standards are:
* ''Universal Serial Bus Revision 2.0 Specification''<ref name="usb2_specification">[http://www.usb.org/developers/docs/usb20_docs Universal Serial Bus Revision 2.0 Specification]</ref>, Revision 2.0, April 27, 2000
* ''USB 2.0 Link Power Management Addendum Engineering Change Notice to the USB 2.0 specification''<ref name="lpm_addendum">[http://www.usb.org/developers/docs/usb20_docs ECN USB 2.0 Link Power Management Addendum]</ref>, July 16, 2007
* ''Enhanced Host Controller Interface Specification for Universal Serial Bus''<ref name="ehci_specification">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/ehci-specification-for-usb.html Enhanced Host Controller Interface Specification for Universal Serial Bus]</ref>, Revision 1.0, March 12, 2002
* ''EHCI v1.1 Addendum''<ref name="ehci_addendum">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/ehci-v1-1-addendum.html Enhanced Host Controller Interface Specification: Addendum]</ref>, August 2008
* ''Open Host Controller Interface Specification for USB''<ref name="ohci_specification">[[media:Hcir1_0a.pdf‎|https://www.usb.org Open Host Controller Interface Specification for USB]]</ref>, Release 1.0a, September 14, 1999
* ''USB 2.0 Transceiver Macrocell Interface (UTMI) Specification''<ref name="utmi_specification">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/usb2-transceiver-macrocell-interface-specification.html USB 2.0 Transceiver Macrocell Interface (UTMI) Specification]</ref>, Version 1.05, March 29, 2001
* ''UTMI+ Specification''<ref name="utmi+_specification">[https://www.nxp.com/docs/en/brochure/UTMI-PLUS-SPECIFICATION.pdf UTMI+ Specification]</ref>, Revision 1.0, February 25, 2004

Refer to [[STM32MP15 resources#Reference manuals|STM32MP15 reference manuals]] for the complete features list, and to the software components, introduced below, to know which features are really implemented.

===Security support===
The '''USBH''' peripheral is a '''non-secure''' peripheral.

==Peripheral usage and associated software==
===Boot time===
The '''USBH''' peripheral is usually not used at boot time. But it may be used by the SSBL (see [[Boot chains overview]]), for example to boot a kernel stored on a USB key (mass storage).

===Runtime===
====Overview====
The '''USBH''' peripheral can be allocated to the Arm<sup>&reg;</sup> Cortex<sup>&reg;</sup>-A7 non-secure core to be used under Linux<sup>&reg;</sup> with [[USB overview|USB framework]].

====Software frameworks====
{{:Internal_peripherals_software_table_template}}
 | High speed interface
 | [[USBH internal peripheral|USBH (USB Host)]]
 | 
 | [[USB overview | Linux USB framework]]
 | 
 |
 |-
 |}

====Peripheral configuration====
The configuration is applied by the firmware running in the context to which the peripheral is assigned. The configuration by itself can be performed via the [[STM32CubeMX]] tool for all internal peripherals. It can then be manually completed (especially for external peripherals) according to the information given in the corresponding software framework article.

For Linux kernel configuration, please refer to [[USBH device tree configuration|USBH device tree configuration]].

====Peripheral assignment====
{{:Internal_peripherals_assignment_table_template}}<onlyinclude>

 | rowspan="1" | High speed interface
 | rowspan="1" | [[USBH internal peripheral|USBH (USB Host)]]
 | USBH (USB Host)
 | 
 | <span title="assignable peripheral" style="font-size:21px"></span>

 |
 |
 |-</onlyinclude>

 |}

==References==<references/>

<noinclude>

[[Category:High speed interface peripherals]]
{{PublicationRequestId | 8440 | 2018-09-20 | BrunoB}}
{{ArticleBasedOnModel | Internal peripheral article model}}
{{ReviewsComments|JCT 1840: alignment needed with the last version of the model<br>

[[Category:ToBeAlignedWithModel]]
}}</noinclude>
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>
 
{{ArticleBasedOnModel | [[Internal peripheral article model]]}}
 
{{ArticleMainWriter | AmelieD}}
 
{{ArticleApprovedVersion | AmelieD | NathalieS (Passed), GeraldB (Not Done), LoicP (Not Done), FabriceG (Passed 25Jul'18) | No previous approved version | BrunoB - 20Sep'18 - 8440 | 20Sep'18}}
 
 
[[Category:High speed interface peripherals]]
 
{{ReviewsComments|JCT 1840: alignment needed with the last version of the model [[Internal peripheral article model]]<br>
 
[[Category:ToBeAlignedWithModel]]
 
}}
 
</noinclude>
 
 
 
==Article purpose==
 
==Article purpose==
 
The purpose of this article is to
 
The purpose of this article is to
Line 30: Line 19:
 
* ''Enhanced Host Controller Interface Specification for Universal Serial Bus''<ref name="ehci_specification">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/ehci-specification-for-usb.html Enhanced Host Controller Interface Specification for Universal Serial Bus]</ref>, Revision 1.0, March 12, 2002
 
* ''Enhanced Host Controller Interface Specification for Universal Serial Bus''<ref name="ehci_specification">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/ehci-specification-for-usb.html Enhanced Host Controller Interface Specification for Universal Serial Bus]</ref>, Revision 1.0, March 12, 2002
 
* ''EHCI v1.1 Addendum''<ref name="ehci_addendum">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/ehci-v1-1-addendum.html Enhanced Host Controller Interface Specification: Addendum]</ref>, August 2008
 
* ''EHCI v1.1 Addendum''<ref name="ehci_addendum">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/ehci-v1-1-addendum.html Enhanced Host Controller Interface Specification: Addendum]</ref>, August 2008
* ''Open Host Controller Interface Specification for USB''<ref name="ohci_specification">[[media:Hcir1_0a.pdf‎|Open Host Controller Interface Specification for USB]]</ref>, Release 1.0a, September 14, 1999
+
* ''Open Host Controller Interface Specification for USB''<ref name="ohci_specification">[https://www.usb.org Open Host Controller Interface Specification for USB]</ref>, Release 1.0a, September 14, 1999
 
* ''USB 2.0 Transceiver Macrocell Interface (UTMI) Specification''<ref name="utmi_specification">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/usb2-transceiver-macrocell-interface-specification.html USB 2.0 Transceiver Macrocell Interface (UTMI) Specification]</ref>, Version 1.05, March 29, 2001
 
* ''USB 2.0 Transceiver Macrocell Interface (UTMI) Specification''<ref name="utmi_specification">[https://www.intel.com/content/www/us/en/io/universal-serial-bus/usb2-transceiver-macrocell-interface-specification.html USB 2.0 Transceiver Macrocell Interface (UTMI) Specification]</ref>, Version 1.05, March 29, 2001
 
* ''UTMI+ Specification''<ref name="utmi+_specification">[https://www.nxp.com/docs/en/brochure/UTMI-PLUS-SPECIFICATION.pdf UTMI+ Specification]</ref>, Revision 1.0, February 25, 2004
 
* ''UTMI+ Specification''<ref name="utmi+_specification">[https://www.nxp.com/docs/en/brochure/UTMI-PLUS-SPECIFICATION.pdf UTMI+ Specification]</ref>, Revision 1.0, February 25, 2004
Line 79: Line 68:
 
==References==
 
==References==
 
<references/>
 
<references/>
  +
  +
<noinclude>
  +
[[Category:High speed interface peripherals]]
  +
{{PublicationRequestId | 8440 | 2018-09-20 | BrunoB}}
  +
{{ArticleBasedOnModel | Internal peripheral article model}}
  +
{{ReviewsComments|JCT 1840: alignment needed with the last version of the model<br>
  +
[[Category:ToBeAlignedWithModel]]
  +
}}
  +
</noinclude>