Linux USB OTG: Difference between revisions

From Variscite Wiki
No edit summary
No edit summary
Line 4: Line 4:
--> {{#lst:B2QT_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#lst:B2QT_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#lst:Android_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#lst:Android_Platform_Customization|{{#var:RELEASE_PARAM}}}} <!--
--> {{#vardefine:DTS_DIR|arch/{{#switch: {{#var:SOC_SERIES}}|imx8|imx9=arm64|arm}}/boot/dts/{{#ifeq: {{#var:HARDWARE_NAME}}|
DART-MX8M|{{#ifeq: {{#var:YOCTO_NAME}}|Morty|variscite/|freescale/}}|{{#switch: {{#var:SOC_SERIES}} | imx8|imx9=freescale/|}}}}}} <!--
--> {{PageHeader|{{#var:HARDWARE_NAME}} USB OTG}} {{DocImage|category1=Yocto|category2=Android}}[[Category:Debian]][[Category:DART-MX8M-MINI]][[Category:DART-MX8M]][[Category:DART-MX8M-PLUS]] __toc__
--> {{PageHeader|{{#var:HARDWARE_NAME}} USB OTG}} {{DocImage|category1=Yocto|category2=Android}}[[Category:Debian]][[Category:DART-MX8M-MINI]][[Category:DART-MX8M]][[Category:DART-MX8M-PLUS]] __toc__


Line 14: Line 16:
Follow either the "Build the Linux kernel from source code" or "Customizing the Linux kernel" Wiki pages and edit the following device tree file:<br>
Follow either the "Build the Linux kernel from source code" or "Customizing the Linux kernel" Wiki pages and edit the following device tree file:<br>
{{#switch: {{#var:HARDWARE_NAME}}
{{#switch: {{#var:HARDWARE_NAME}}
|DART-MX8M={{#ifeq: {{#var:YOCTO_NAME}}|Morty|arch/arm64/boot/dts/variscite/imx8m-var-dart-common.dtsi|arch/arm64/boot/dts/freescale/{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dtsi | fsl-imx8mq-var-dart-common.dtsi }}}}
|DART-MX8M={{#ifeq: {{#var:YOCTO_NAME}}|Morty|{{#var:DTS_DIR}}imx8m-var-dart-common.dtsi|{{#var:DTS_DIR}}{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dtsi | fsl-imx8mq-var-dart-common.dtsi }}}}
|DART-MX8M-MINI=arch/arm64/boot/dts/freescale/{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dts | fsl-imx8mm-var-dart.dts }} for DART-MX8M-MINI, or arch/arm64/boot/dts/freescale/{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dts | fsl-imx8mm-var-som.dts }} for VAR-SOM-MX8M-MINI
|DART-MX8M-MINI={{#var:DTS_DIR}}{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dts | fsl-imx8mm-var-dart.dts }} for DART-MX8M-MINI, or {{#var:DTS_DIR}}{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dts | fsl-imx8mm-var-som.dts }} for VAR-SOM-MX8M-MINI
|DART-MX8M-PLUS=arch/arm64/boot/dts/freescale/imx8mp-var-dart.dts for DART-MX8M-PLUS, or arch/arm64/boot/dts/freescale/imx8mp-var-som.dts for VAR-SOM-MX8M-PLUS
|DART-MX8M-PLUS={{#var:DTS_DIR}}imx8mp-var-dart.dts for DART-MX8M-PLUS, or {{#var:DTS_DIR}}imx8mp-var-som.dts for VAR-SOM-MX8M-PLUS
|VAR-SOM-MX8M-NANO=freescale/{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dts | fsl-imx8mn-var-som.dts }}
|VAR-SOM-MX8M-NANO={{#var:DTS_DIR}}{{#if: {{#var:DTB_PREFIX}} | {{#var:DTB_PREFIX}}.dts | fsl-imx8mn-var-som.dts }}
|VAR-SOM-MX93={{#var:DTB_PREFIX}}.dts
|VAR-SOM-MX93={{#var:DTS_DIR}}{{#var:DTB_PREFIX}}.dts
}} <br>
}} <br>



Revision as of 19:36, 19 January 2023

Warning: This page is designed to be used with a 'release' URL parameter.

This page is using the default release RELEASE_SUMO_V1.0_DART-MX8M.
To view this page for a specific Variscite SoM and software release, please follow these steps:

  1. Visit variwiki.com
  2. Select your SoM
  3. Select the software release
DART-MX8M USB OTG

Configuring the USB OTG port under Linux

By default, the USB OTG port is configured as OTG in the device tree, and a USB type-C receptacle is assembled on the DART-MX8M custom board.
To use it as host only or peripheral only you need to change the value of the dr_mode property under the USB node in the device tree.
dr_mode: One of "host", "peripheral" or "otg". Defaults to "otg"

For example:
Follow either the "Build the Linux kernel from source code" or "Customizing the Linux kernel" Wiki pages and edit the following device tree file:
arch/arm64/boot/dts/freescale/fsl-imx8mq-var-dart-common.dtsi

&usb_dwc3_0 {
	status = "okay";
	extcon = <&typec_ptn5150>;
-	dr_mode = "otg";
+	dr_mode = "host";
};

If you build the kernel manually from source code, you should build only the device trees and copy them to your SD card or eMMC.

Note: You can read the current dr_mode value on a running target, by executing the following command:

# cat /sys/firmware/devicetree/base/usb@38100000/dwc3/dr_mode;

Using the USB OTG port under Linux

As host (default)

USB host

As peripheral

In order to use the board as a peripheral, an appropriate module needs to be loaded.
For example, there is an Ethernet gadget module called g_ether, a mass storage gadget called g_mass_storage, a serial gadget called g_serial, etc.

Examples

Connect a type-C plug to Standard-A plug cable between the board and a host PC, and run the following examples on the target board:

Mass Storage Device

The following uses the g_mass_storage module to expose the root partition on eMMC to a PC while booting from recovery SD card:

# umount /dev/mmcblk0p1
# modprobe g_mass_storage file=/dev/mmcblk0p1

The partition should be loaded on the PC as a mass storage device.

USB Debug Console

The following uses the g_serial module to spawn a new debug console over USB:

On target:

# echo g_serial > /etc/modules-load.d/g_serial.conf       # Load g_serial module on boot
# sudo systemctl enable getty@ttyGS0.service              # Spawn a new tty session on ttyGS0
# reboot                                                  # Reboot to take effect

On Host:

$ minicom -D /dev/ttyACM0                                 # Launch minicom on Host computer to login to target tty console

As OTG

With OTG, the board can be either a host, or a peripheral.
In order to use it as a host and connect a peripheral (e.g. a USB flash drive) to it, either use a peripheral with type-C connector or use type-C to type-A adapter.
In order to use it as a peripheral and connect it to a PC, for example, a cable with a type-C plug on one end and a Standard-A plug on the other is needed.