1. Article purpose[edit source]
This article explains how to configure the USBPHYC internal peripheral when it is assigned to the Linux® OS. In that case, it is controlled by the PHY framework.
The configuration is performed using the device tree mechanism.
It is used by the USBPHYC Linux driver[1] which registers the relevant information in PHY framework.
2. DT bindings documentation[edit source]
USBPHYC device tree bindings[2] describe all the required and optional functions.
USBPHYC
|_ PLL
|
|_ PHY port#1 _________________ HOST controller
| _ |
| / 1|________________|
|_ PHY port#2 ----| |________________
| \_0| |
|_ UTMI switch_______| OTG controller
3. DT configuration[edit source]
This hardware description is a combination of the STM32 microprocessor device tree files (.dtsi extension) and board device tree files (.dts extension). See the Device tree for an explanation of the device tree file split.
STM32CubeMX can be used to generate the board device tree. Refer to How to configure the DT using STM32CubeMX for more details.
3.1. DT configuration (STM32 level)[edit source]
The USBPHYC node is declared in stm32mp151.dtsi[3].
- root node e.g. usbphyc describes the USBPHYC hardware block parameters such as registers, clocks, resets and supplies.
- child nodes e.g. usbphyc_port0 and usbphyc_port1 describe the two high speed PHY ports: port#1 and port#2.
usbphyc: usbphyc@address {
compatible = "st,stm32mp1-usbphyc";
... /* usbphyc resources: registers, clocks, resets and supplies */
usbphyc_port0: usb-phy@0 {
... /* usbphyc HS PHY port#1 */
};
usbphyc_port1: usb-phy@1 {
... /* usbphyc HS PHY port#2 */
};
};
3.2. DT configuration (board level)[edit source]
Follow the sequences described in the below chapters to configure and enable the USBPHYC on your board.
The 'usbphyc' root node must be filled in:
- Enable the USBPHYC block by setting status = "okay".
The child nodes for each port must be filled in:
- Configure the USBPHYC 3V3 regulator[4] by setting phy-supply = <&your_regulator>.
- Optional, for ecosystem release ≥ v2.1.0
, you may configure the VBUS 5V regulator[4] by setting vbus-supply = <&your_regulator>.
The child nodes for each port may also be tuned:
- Optional: create a usb_phy_tuning node that can take optional parameters in DT root folder ('/')
- Optional: add 'st,phy-tuning = <&usb_phy_tuning>' in 'usbphyc_port0' and/or 'usbphyc_port1' node to use this tuning.
3.3. DT configuration example[edit source]
The example below shows how to enable and configure USBPHYC ports in the board file.
For ecosystem release ≥ v2.1.0
&usbphyc {
status = "okay"; /* enable USB HS PHY controller */
};
&usbphyc_port0 {
phy-supply = <&vdd_usb>; /* references the 3V3 voltage regulator on the user board */
vbus-supply = <&vbus_sw>; /* references the optional 5V voltage regulator on the user board */
st,phy-tuning = <&usb_phy_tuning>; /* optional USB HS PHY port#1 tuning */
};
&usbphyc_port1 {
phy-supply = <&vdd_usb>; /* references the 3V3 voltage regulator on the user board */
st,phy-tuning = <&usb_phy_tuning>; /* optional USB HS PHY port#2 tuning */
};
/ { /* optional USB HS PHY tuning example, to be added in DT root node, e.g. '/' */
usb_phy_tuning: usb-phy-tuning {
st,current-boost = <2>;
st,no-lfs-fb-cap;
st,hs-dc-level = <2>;
st,hs-rftime-reduction;
st,hs-current-trim = <5>;
st,hs-impedance-trim = <0>;
st,squelch-level = <1>;
st,no-hs-ftime-ctrl;
st,hs-tx-staggering;
};
};
For ecosystem release v1.0.0 to v2.1.0
&usbphyc {
status = "okay"; /* enable USB HS PHY controller */
};
&usbphyc_port0 {
phy-supply = <&vdd_usb>; /* references the 3V3 voltage regulator on the user board */
st,phy-tuning = <&usb_phy_tuning>; /* optional USB HS PHY port#1 tuning */
};
&usbphyc_port1 {
phy-supply = <&vdd_usb>; /* references the 3V3 voltage regulator on the user board */
st,phy-tuning = <&usb_phy_tuning>; /* optional USB HS PHY port#2 tuning */
};
/ { /* optional USB HS PHY tuning example, to be added in DT root node, e.g. '/' */
usb_phy_tuning: usb-phy-tuning {
st,current-boost = <2>;
st,no-lfs-fb-cap;
st,hs-dc-level = <2>;
st,hs-rftime-reduction;
st,hs-current-trim = <5>;
st,hs-impedance-trim = <0>;
st,squelch-level = <1>;
st,no-hs-ftime-ctrl;
st,hs-tx-staggering;
};
};
Abstract of the example to configure port#2, to be assigned to the USBH:
&usbh_ehci {
phys = <&usbphyc_port0>, <&usbphyc_port1 1>; /* 1: UTMI switch selects the USBH */
phy-names = "usb", "usb";
...
}
Abstract of the example to configure port#2, to be assigned to the OTG:
&usbotg_hs {
phys = <&usbphyc_port1 0>; /* 0: UTMI switch selects the OTG */
phy-names = "usb2-phy";
...
}
4. How to configure the DT using STM32CubeMX[edit source]
The STM32CubeMX tool can be used to configure the STM32MPU device and get the corresponding platform configuration device tree files.
The STM32CubeMX may not support all the properties described in the above DT bindings documentation paragraph. If so, the tool inserts user sections in the generated device tree. These sections can then be edited to add some properties and they are preserved from one generation to another. Refer to STM32CubeMX user manual for further information.
5. References[edit source]
Please refer to the following links for additional information:
- ↑ drivers/phy/st/phy-stm32-usbphyc.c , STM32 USB PHY Controller driver
- ↑ 2.0 2.1 Documentation/devicetree/bindings/phy/phy-stm32-usbphyc.txt , USBPHYC device tree bindings
- ↑ arch/arm/boot/dts/stm32mp151.dtsi , STM32MP151 device tree file
- ↑ 4.0 4.1 Regulator overview
- ↑ Documentation/devicetree/bindings/phy/phy-bindings.txt ,PHY generic bindings