View source for SBEV-UCMIMX8PLUS: Yocto Linux: How-To Guide

=Device Tree=
== Available Device Tree ==
The current release come with these dtb files:

{| class="wikitable" style="text-align:left;"
|-
| align="center" | '''Device Tree'''
| align="center" | '''Input Components'''
| align="center" | '''Description'''
|-
| align="" |ucm-imx8m-plus-som.dtb
| align="" |
ucm-imx8m-plus-som.dtsi<br>
compulab-imx8m-plus-ldo4.dtsi<br>
|som hw only
|-
|ucm-imx8m-plus-sbev.dtb
|
ucm-imx8m-plus-som.dts<br>
ucm-imx8m-plus-pcie.dtsi<br>
sbev-ucmimx8plus.dtsi<br>
sbev-ucmimx8plus-mmc2.dtsi<br>
|
som<br>
+pcie<br>
+sbev i2c<br>
+sb-card<br>
|-
|sbev-ucmimx8plus-headless.dtb
|
ucm-imx8m-plus-sbev.dtb<br>
sbev-ucmimx8plus-enet1.dtbo<br>
sbev-ucmimx8plus-wm8962.dtbo<br>
sbev-ucmimx8plus-p15_spi.dtbo<br>
sbev-ucmimx8plus-p16_i2c.dtbo<br>
sbev-ucmimx8plus-p17_can.dtbo<br>
sbev-ucmimx8plus-p18_gpio.dtbo<br>
sbev-ucmimx8plus-p19_uart-b.dtbo<br>
sbev-ucmimx8plus-p20_uart-a.dtbo<br>
|
sbev<br>
+fec<br>
+wm8962<br>
+p15_spi<br>
+p16_i2c<br>
+p17_can<br>
+p18_gpio<br>
+p19_uart-b<br>
+p20_uart-a<br>
|-
|
'''sbev-ucmimx8plus.dtb'''<br>
sbev-ucmimx8plus-lvds.dtb<br>
|
sbev-ucmimx8plus-headless.dtb<br>
sbev-ucmimx8plus-lvds.dtbo<br>
|
sbev-headless<br>
+lvds<br>
|-
|
sbev-ucmimx8plus-hdmi.dtb
|
sbev-ucmimx8plus-headless.dtb<br>
sbev-ucmimx8plus-hdmi.dtbo<br>
|
sbev-headless<br>
+hdmi<br>
|-
|
sbev-ucmimx8plus-dualhead.dtb
|
sbev-ucmimx8plus-headless.dtb<br>
sbev-ucmimx8plus-lvds.dtbo<br>
sbev-ucmimx8plus-hdmi.dtbo<br>
|
sbev-headless<br>
+lvds<br>
+hdmi<br>
|}

== Available Device Tree Overlays ==
{{Note|The overlay load mode available with '''run bsp_bootcmd''' mode only.}}
{| class="wikitable" style="text-align:left;"
|-
| align="center" | '''DTB Overlay''' 
| align="center" | '''Hardware Configuration and Features'''
| align="center" | '''Required Jumpers Settings'''
|-
|sbev-ucmimx8plus.dtbo
|sbev i2c + usb vbus
|
|-
|sbev-ucmimx8plus-enet1.dtbo
|Enable fec
|
|-
|sbev-ucmimx8plus-wm8962.dtbo
|Enable Wolfson Audio Codec wm8962
|
|-
|sbev-ucmimx8plus-p15_spi.dtbo
|Enable spi on p15 header
|
|-
|sbev-ucmimx8plus-p16_i2c.dtbo
|Enable i2c on p16 header
|
|-
|sbev-ucmimx8plus-p17_can.dtbo
|Enable can on p17 header
|
|-
|sbev-ucmimx8plus-p18_gpio.dtbo
|Enable gpio on p18 header
|
|-
|sbev-ucmimx8plus-p19_uart-b.dtbo
|Enable uart2 on p19 header
|
|-
|sbev-ucmimx8plus-p20_uart-a.dtbo
|Enable uart1 on p20 header
|
|-
|sbev-ucmimx8plus-csi1-isp0.dtbo
|Enable csi1 with isp0 (Basler .mc sensor’s support)
|
|-
|sbev-ucmimx8plus-csi2-isp1.dtbo
|Enable csi2 with isp1 (Basler .mc sensor’s support)
|
|-
|sbev-ucmimx8plus-csi1-isi0.dtbo
|Enable csi1 with isi0 (Basler .mci sensor’s support)
|
|-
|sbev-ucmimx8plus-csi2-isi1.dtbo
|Enable csi2 with isi1 (Basler .mci sensor’s support)
|
|}

==Boot Modes==
The current release provides two methods to boot up the system:
{| class="wikitable" style="text-align:left;"
|-
| align="" | ''' ... ''' 
| align="" | '''Embedded w/out GRUB'''
| align="" | '''Desktop with GRUB'''
|-
| align="" |U-Boot bootcmd
| align="" |run bsp_booctmd
| align="" |run distro_bootcmd
|-
| align="" |Boot Menu
| align="" |n/a
| align="" |'''GNU GRUB  version 2.12'''<br>*Boot Linux Image-6.6.23-compulab-1.0-g370b4b3f2597<br> Install NXP i.MX Release Distro 6.6-scarthgap (scarthgap)<br> Advanced Boot Options<br>
|-
| align="" |pros/cons
| align="" |'''pros''':<br>Fast boot<br>'''cons''':<br>Install Mode requires to Linux boot 1-st<br> 
| align="" |'''pros''':<br>Install Mode<br>Allows changing the device tree for the current session<br>'''cons''':<br>Increases the boot time by the GRUB timeout<br> 
|-
|}

==Set a device tree==
The current release provides two methods to switch between dtb files:
* U-Boot environment
The U-boot '''fdtfile''' variable contains the device tree name that will be loaded into the RAM.
This variable can be changed by:
{| class="wikitable" style="text-align:left;"
|-
| align="" | '''Environment''' 
| align="" | '''Command''' 
|-
| align="" |U-Boot
| align="" |setenv fdtfile <fdt_file_name>; saveenv;
|-
| align="" |Linux
| align="" |fw_setenv fdtfile <fdt_file_name>
|-
|}
* GRUB environment (if the image was created with the meta-compulab-uefi layer)
{| class="wikitable" style="text-align:left;"
|-
| align="" | '''Environment''' 
| align="" | '''Command/Procedure''' 
|-
| align="" |GRUB Boot Menu
| align="" |Goto "Advanced Boot Options" and choose a device tree from the provided dtb list.
|-
| align="" |Linux
| align="" |grub-editenv /boot/EFI/BOOT/grubenv set fdt_file=<fdt_file_name>
|-
|}

=U-Boot=
=== Basic commands ===
* Restore default boot environment:
<pre>
env default -a
</pre>
* List boot candidates:
<pre>
printenv bootlist
</pre>
* Get/Set device tree:
{| class="wikitable" width="40%" style="text-align:left;"
|-
| align="" | '''get''' 
| align="" | '''set'''
|-
| align="" |printenv fdtfile
| align="" |setenv fdtfile sbev-ucmimx8plus-headless.dtb
|-
|}
* Get/Set device tree overlay:
The lates U-Boot supports device tree file overlays to be loaded after the main file.<br>The '''fdtofile''' can be a list of device tree files.
{{Note| The boot process will fail if a file in the fdtofile is not found on the boot device. }}
{| class="wikitable" width="40%" style="text-align:left;"
|-
| align="" | '''get''' 
| align="" | '''set'''
|-
| align="" |printenv fdtofile
| align="" |setenv fdtofile "sbev-ucmimx8plus-hdmi.dtbo sbev-ucmimx8plus-lvds.dtbo"
|-
|}

=== LDO4 - secondary RGMII voltage control ===
PMIC LDO4 controls voltage rail that powers secondary RGMII signal group.</br>
By default LDO4 is configured for 1.8V operation. In order to control LDO4 settings and have them passed correctly to the Linux kernel, use the command and device tree described below.

* ldo4 command:
<pre>
help ldo4
</pre>
* ldo4 modes:
{| class="wikitable" width="40%" style="text-align:left;"
|-
| width="20%" align="" | '''mode                       ''' 
| align="" | '''commands                   '''
|-
| align="" |1v8 mode
| align="" |ldo4 18; boot
|-
| align="" |3v3 mode
| align="" |ldo4 33; boot
|-
| align="" |off mode
| align="" |ldo4 0;boot
|-
|}

=== U-Boot overlays configuration ===

* Overlay load mode example:
{| class="wikitable" width="40%" style="text-align:left;"
|-
| align="" | '''command''' 
| align="" | '''description'''
|-
| align="" |setenv fdtfile sbev-ucmimx8plus-headless.dtb
| align="" |set the main device tree w/out any display interface enabled
|-
| align="" |setenv fdtofile 'sbev-ucmimx8plus-hdmi.dtbo sbev-ucmimx8plus-lvds.dtbo'
| align="" |set the overlay list that enables:<br>hdmi display<br>lvds display<br>
|-
| align="" |setenv bootcmd 'run bsp_bootcmd'
| align="" |set the boot command that allows loading the device tree overlays
|-
| align="" |saveenv
| align="" |save the environment
|}


<pre>
setenv fdtfile ucm-imx8m-plus-headless.dtb
setenv fdtofile "sbev-ucmimx8plus-hdmi.dtbo sbev-ucmimx8plus-csi1-isp0.dtbo"
setenv bootcmd 'run bsp_bootcmd'
saveenv
</pre>

= Serial Console =
UCM-iMX8M-Plus provides serial console on UART2.</br>
SBEV-UCMIMX8Plus evaluation carrier-board exposes the console UART via CP2104 serial-to-USB bridge on connector [[UCM-iMX8M-Plus: Evaluation Kit: Hardware Guide#Connector_Locations | '''P3''']].
== Connecting to a host PC ==
# Use a micro-USB cable to connect the console connector '''P3''' to a USB port on your host PC.
# Make sure the CP2104 driver is available with your operating system, otherwise install CP2104 driver onto the host PC from https://www.silabs.com/documents/public/software/CP210x_Windows_Drivers_with_Serial_Enumeration.zip
# Identify the host PC interface and port number that will be used for communication with the UCM-iMX8M-Plus evaluation kit:
#* In most Linux PCs, the serial port will be denoted as one of the following (where n is a positive integer): /dev/ttyUSB0, /dev/ttyUSB1 ... /dev/ttyUSBn
#* In Windows PCs, the serial port usually will be denoted as one of the following (where n is a positive integer): COM1, COM2 ... COMn
# Start a terminal emulation program (such as [https://www.putty.org/ PuTTY] on Windows or minicom on Linux).
# In the port configuration section of the terminal emulation program select the port identified in previous step and set the following serial port parameters:
<blockquote>
{{:SB-SOM: serial port parameters table}}
</blockquote>

=Display=
SBEV-UCMIMX8Plus supports two types of display interfaces: LVDS and HDMI.</br>
All interfaces are enabled in the default '''sbev-ucmimx8plus-dualhead.dtb''' device tree file.

==LVDS==
SBEV-UCMIMX8Plus supports connection with the Startec KD070HDTLA020 7" LVDS LCD panel using the '''EB-HDRLVDS''' adapter board (supplied by Compulab with the LCD panel).</br>
Connect the LCD data cable to adapter connector '''P7'''. Connect the LCD touch-panel cable to adapter connector '''P8'''.
Connect the adapter to LVDS and touch headers '''P14''' and '''P13'''.

The Linux device node for the LVDS display:
 /sys/class/drm/card1/card1-LVDS-1/
This device node contains information about the display, such as its supported modes and its current configuration.

==HDMI==

SBEV-UCMIMX8Plus supports HDMI output on connector [[UCM-iMX8M-Plus: Evaluation Kit: Hardware Guide#Connector_Locations | '''P22''']]. Connect to standard monitor using an HDMI cable.

The Linux device node for the HDMI display:
 /sys/class/drm/card1/card1-HDMI-A-1/
This device node contains information about the display, such as its supported modes and its current configuration.

==Display Manager==
UCM-iMX8M-Plus Yocto uses Weston as the default display manager. It can be configured in ''/etc/xdg/weston/weston.ini''.</br>
For example the transform setting can be set to rotate-90, rotate-180, rotate-270, or commented out.</br>
In order to apply the configuration, you need to restart the weston display manager:
 systemctl stop weston
 systemctl start weston

=USB=
SBEV-UCMIMX8MPLUS features two USB3.0 sharable ports that are derived from the i.MX8M Plus USB sub-system:<br>
USB connector '''J2''' is multiplexed with mini-PCIe '''P3''' socket. USB connector '''J3''' is multiplexed with with M.2 key-E '''P23''' that is used for optional WiFi module.
* The USB Type-A J2 and J3 connectors are enabled by populating jumpers E1 and E4 respectively

=== USB1 mode switch ===
* host<br>The device works in a host mode by default.
* device<br>The device works in a device mode when the '''ucm-imx8m-plus-usbdev.dtbo''' is in use.<br>In this mode the SOM can work in one of the usb device mode:<br>
{| class="wikitable" style="text-align:left;"
|-
| align="" | '''USB device mode''' 
| align="" | '''Command/Procedure''' 
| align="" | '''Test scenario''' 
|-
| align="" |usb serial device
| align="" |modprobe g_serial
| align="" |<pre>device: systemctl start serial-getty@ttyGS0
Linux PC: sudo minicom -D /dev/ttyACM0 115200</pre>
|-
| align="" |usb network device
| align="" |modprobe g_ether
| |
|-
| align="" |usb mass storage device
| align="" |modprobe g_mass_storage file=/dev/sdX
| |
|-
|}

= SPI bus =
SPI2 interface is available on SBEV-UCMIMX8PLUS via header '''P15'''. The following example shows the usage of the Linux spidev interface.

== spidev ==
* Device Tree:
<pre>
&iomuxc {
	pinctrl-names = "default";
	pinctrl-0 = <&pinctrl_hog>;
	....
	pinctrl_ecspi2: ecspi2grp {
		fsl,pins = <
			MX8MP_IOMUXC_ECSPI2_SCLK__ECSPI2_SCLK		0x82
			MX8MP_IOMUXC_ECSPI2_MOSI__ECSPI2_MOSI		0x82
			MX8MP_IOMUXC_ECSPI2_MISO__ECSPI2_MISO		0x82
		>;
	};

	pinctrl_ecspi2_cs: ecspi2cs {
		fsl,pins = <
			MX8MP_IOMUXC_ECSPI2_SS0__GPIO5_IO13		0x40000
		>;
	};
	....
};

&ecspi2 {
	#address-cells = <1>;
	#size-cells = <0>;
	fsl,spi-num-chipselects = <1>;
	pinctrl-names = "default";
	pinctrl-0 = <&pinctrl_ecspi2 &pinctrl_ecspi2_cs>;
	cs-gpios = <&gpio5 13 GPIO_ACTIVE_LOW>;
	status = "okay";

	spidev1: spi@0 {
		reg = <0>;
		compatible = "rohm,dh2228fv";
		spi-max-frequency = <500000>;
	};
};
</pre>

* System board setup:<br>short P15.3(MOSI) and  P15.2(MISO) pins.

* Linux command line test:
<pre>
root@ucm-imx8m-plus:~# spidev_test -p 1234/5678 -v -D /dev/spidev1.0
spi mode: 0x4
bits per word: 8
max speed: 500000 Hz (500 kHz)
TX | 31 32 33 34 2F 35 36 37 38 __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __  |1234/5678|
RX | 31 32 33 34 2F 35 36 37 38 __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __ __  |1234/5678|
</pre>

= WiFi =
SBEV-UCMIMX8PLUS implements 802.11ax WiFi and Bluetooth 5.3 BLE with an Intel AX210 wireless module installed in M.2 socket '''P23'''.</br>
To use the wireless functions use antenna cables to connect WiFi antennas (supplied with the eval-kit) to antenna connectors located on the AX210 module.<br>
The [https://manpages.debian.org/stretch/network-manager/nmcli.1.en.html NetworkManager] can be used to manage WiFi interface.

== Enable/Disable WiFi Interface ==
* To enable WiFi interface:
:<pre>nmcli radio wifi on</pre>
* To disable WiFi interface:
:<pre>nmcli radio wifi off</pre>

== Network Scanning ==
* Sample WiFi scanning:
:<pre>nmcli dev wifi list</pre>
:The output will show the list of Access Points and Ad-Hoc cells in range.

== Connecting to Access Point ==
In the following example:
* Replace <SSID> and <PASSWORD> with the actual access point parameters:
:<pre>nmcli device wifi connect <SSID> password <PASSWORD> name WifiCon</pre>
* Disconnect wireless network:
:<pre>nmcli connection down WifiCon</pre>
* Connect wireless network again:
:<pre>nmcli connection up WifiCon</pre>

== Creating Access Point ==
{{Note|Debian 12<br>ipv4 forwarding must be turned on manually}}
* Enable port forwarding:
:<pre>sed -i 's/^#\(net.ipv[4,6].*forward\)/\1/' /etc/sysctl.conf</pre>
In the following example:
* Replace <SSID> and <PASSWORD> with desired access point parameters:
:<pre>nmcli device wifi hotspot ssid <SSID> password <PASSWORD> con-name HotspotCon</pre>
* Disable wireless AP:
:<pre>nmcli connection down HotspotCon</pre>
* Enable wireless AP again:
:<pre>nmcli connection up HotspotCon</pre>

=CAN bus=
CAN bus interface is available via header '''P17'''.<br>
CAN bus on-board termination can be enabled by shorting jumper '''E6'''.<br>

==CAN interface configuration==
It is recommended configure the CAN interface, with the {{filename|iproute2}} utilities.

* To make sure the right '''ip''' utility is used, run:
<pre>
ip -V
ip utility, iproute2-v5.7.0-77-gb687d1067169 
</pre>
* Configure both CAN interface bit-rate to 1 Mbit/sec:
<pre>
ip link set can0 type can bitrate 1000000
ip link set can1 type can bitrate 1000000
</pre>
* Enable the CAN interface:
<pre>
ip link set can0 up
ip link set can1 up
</pre>

==Send/Receive packets==
Use {{filename|cansend}} and {{filename|candump}} utilities to send and receive packets via CAN interface.

* Send standard CAN frame (on the first device):
<pre>
cansend can0 111#1122334455667788
</pre>

* Send extended CAN frame (on the first device):
<pre>
cansend can0 11111111#1122334455667788
</pre>

* CAN frames (extended mode) generator, random payload, interval between two successive flames 50 msec:
<pre>
cangen -g 50 -e -D r -v can0

can: raw protocol (rev 20170425)
...
  can0  03FF0983#D7.61.FF.03.C1.F7.C1.34
  can0  19C34D32#F7.5A.C2.73.AD.0E.3F.0B
  can0  0675E391#2B.2D.D3.49
  can0  13091C55#99.32.EC.77.27.81.49.0B
  can0  098D67CF#22.50.AB.48.AD.7F.F4.26
  can0  05263FEC#1B.4C.02.45.6E
  can0  12B30E20#
  can0  1F193DF9#C5
  can0  1EB0B18F#3E.3F.DA.57.C2.FE.73.58
  can0  1E5C64D9#6F.0D.B3.63.6A
  can0  1E1DE3F9#96.48.AC.79.4E.00.27.71
  can0  0E1A11B7#75.81.70.7C.86.79.A7.77
  can0  05F8FD8B#33.F9.9B.1E.77.3D.1F
  can0  1E155FCD#E6.BA.F8.58.ED.6D.C8.10
  can0  1D91DF9E#5D.29.82.7B.97.1D.AB.5C
  can0  11FB3CDA#14.65.C3
  can0  091352C0#2C.ED
...
</pre>

* Dump all received data frames as well as error frames (on the second device):
<pre>
candump any,0:0,#FFFFFFFF

  can0  111   [8]  11 22 33 44 55 66 77 88
  can0  11111111   [8]  11 22 33 44 55 66 77 88
...
  can0  03FF0983   [8]  D7 61 FF 03 C1 F7 C1 34
  can0  19C34D32   [8]  F7 5A C2 73 AD 0E 3F 0B
  can0  0675E391   [4]  2B 2D D3 49
  can0  13091C55   [8]  99 32 EC 77 27 81 49 0B
  can0  098D67CF   [8]  22 50 AB 48 AD 7F F4 26
  can0  05263FEC   [5]  1B 4C 02 45 6E
  can0  12B30E20   [0] 
  can0  1F193DF9   [1]  C5
  can0  1EB0B18F   [8]  3E 3F DA 57 C2 FE 73 58
  can0  1E5C64D9   [5]  6F 0D B3 63 6A
  can0  1E1DE3F9   [8]  96 48 AC 79 4E 00 27 71
  can0  0E1A11B7   [8]  75 81 70 7C 86 79 A7 77
  can0  05F8FD8B   [7]  33 F9 9B 1E 77 3D 1F
  can0  1E155FCD   [8]  E6 BA F8 58 ED 6D C8 10
  can0  1D91DF9E   [8]  5D 29 82 7B 97 1D AB 5C
  can0  11FB3CDA   [3]  14 65 C3
  can0  091352C0   [2]  2C ED
...
</pre>

=Gstreamer=
Yocto Linux uses Gstreamer as a default multimedia framework. Here are some useful Gstreamer features:

Execute the following command to check all the source options:
 gst-inspect-1.0 | grep source

Execute the following command to check all the sink options:
 gst-inspect-1.0 | grep sink

==Video Playback==
{{note|The operation below requires '''root''' access.}}

UCM-iMX8M-Plus features 1080p60 H.264, VP8 video decoding capabilities. Before starting video playback, please, ensure that the display is connected to the board.

The following commands can be used to start video playback ('''1.mov''' is a media file):
* gst-play
<pre>
gst-play /path/to/1.mov
</pre>

* gplay-1.0
<pre>
gplay-1.0 /path/to/1.mov
</pre>

* gst-launch
This method is for advanced users. Please study this document before the start: [https://raw.githubusercontent.com/compulab-yokneam/Documentation/master/pdfs/i.MX8GStreamerUserGuide.pdf i.MX8GStreamerUserGuide.pdf]
<pre>
gst-launch-1.0 -v filesrc location=/path/to/1.mov ! qtdemux name=d.video_0 ! h264parse ! avdec_h264 ! autovideosink
</pre>

=Camera=
SBEV-UCMIMX8MPLUS features edge connector that exposes two MIPI-CSI interfaces provided by UCM-iMX8M-Plus.<br>
Use the '''EB-EVCAMBLR''' adapter (included with UCM-iMX8M-Plus evaluation kit) to connect the following Basler camera modules:
* daA4200-30mci/AR1335-3
* daA3840-30mc/AR0082x-2

==Video Capturing==
{{note|The operation below requires '''root''' access.}}

=== ISP Sensors ===
{{note|imx8-isp.service must be disabled<pre>systemctl disable imx8-isp.service; reboot</pre>}}
* Hardware setup: Basler daA4200-30mci/AR1335-3
* Software setup: csiX-isiY device tree overlays:
{| class="wikitable" style="text-align:left;"
|-
| align="" | '''Interface''' 
| align="" | '''Device tree, overlays and bootcmd''' 
|-
| align="" |MIPI_CSI1/MIPI_CSI2
| align="" |fw_setenv fdtfile sbev-ucmimx8plus-headless.dtb<br>fw_setenv fdtofile "sbev-ucmimx8plus-lvds.dtbo sbev-ucmimx8plus-csi1-isi0.dtbo sbev-ucmimx8plus-csi2-isi1.dtbo"<br>fw_setenv bootcmd "run bsp_bootcmd"
|-
|}
* sw: the '''mxc-isi-cap''' is registered:
<pre>
v4l2-ctl --list-devices
 ():
	/dev/v4l-subdev0

 ():
	/dev/v4l-subdev1

FSL Capture Media Device (platform:32c00000.bus:camera):
	/dev/media0

mxc-isi-cap_v1 (platform:32e00000.isi:cap_devic):
	/dev/video2

mxc-isi-cap_v1 (platform:32e02000.isi:cap_devic):
	/dev/video3

vsi_v4l2dec (platform:vsi_v4l2dec):
	/dev/video1

vsi_v4l2enc (platform:vsi_v4l2enc):
	/dev/video0

</pre>
==== gst examples ====
The following commands should be used to start video capturing:

* Default playback pipe line:
<pre>
gst-launch-1.0 pylonsrc ! videoconvert ! autovideosink
</pre>
If more that one sensor is in use then the command returns:
<pre>
At least 2 devices match the specified criteria, use "device-index", "device-serial-number" or "device-user-name" to select one from the following list:
[0]: 40121115   daA4200-30mci
[1]: 40121116   daA4200-30mci
</pre>
* Provide a '''device-index''' parameter to specify a device:
<pre>
gst-launch-1.0 pylonsrc device-index=0 ! videoconvert ! autovideosink
</pre>

=== ISI Sensors ===
{{note|imx8-isp.service must be enabled<pre>systemctl enable imx8-isp.service; reboot</pre>}}
* Hardware setup: Basler daA3840-30mc/AR0082x-2
* Software setup: csiX-ispY device tree overlays:
{| class="wikitable" style="text-align:left;"
|-
| align="" | '''Interface''' 
| align="" | '''Device tree, overlays and bootcmd''' 
|-
| align="" |MIPI_CSI1/MIPI_CSI2
| align="" |fw_setenv fdtfile sbev-ucmimx8plus-headless.dtb<br>fw_setenv fdtofile "sbev-ucmimx8plus-lvds.dtbo sbev-ucmimx8plus-csi1-isp0.dtbo sbev-ucmimx8plus-csi2-isp1.dtbo"<br>fw_setenv bootcmd "run bsp_bootcmd"
|-
|}
* sw: the '''platform:viv''' is registered:
<pre>
v4l2-ctl --list-devices
 ():
	/dev/v4l-subdev0
	/dev/v4l-subdev4
	/dev/v4l-subdev5

 ():
	/dev/v4l-subdev1
	/dev/v4l-subdev6
	/dev/v4l-subdev7

 (csi0):
	/dev/v4l-subdev3

 (csi1):
	/dev/v4l-subdev2

FSL Capture Media Device (platform:32c00000.bus:camera):
	/dev/media0

VIV (platform:viv0):
	/dev/video2

VIV (platform:viv1):
	/dev/video3

vsi_v4l2dec (platform:vsi_v4l2dec):
	/dev/video1

vsi_v4l2enc (platform:vsi_v4l2enc):
	/dev/video0

viv_media (platform:vvcam-video.0):
	/dev/media1
</pre>


For hardware setup and camera connection instructions please refer to UCM-iMX8M-Plus Hardware Guide.

==== gst examples ====
The following commands should be used to start video capturing:

* filesink
Write stream to a file. In this example the encoded output gets saved in the '''1.mov''' media file.
<pre>
gst-launch-1.0 v4l2src device=/dev/video2 ! 'video/x-raw,width=1280,height=720,format=NV12' ! vpuenc_h264 ! filesink location=/path/to/1.mov
</pre>

* waylandsink
Output to wayland surface.
<pre>
gst-launch-1.0 v4l2src device=/dev/video2 ! 'video/x-raw,width=1280,height=720,format=NV12' ! waylandsink window-width=1280 window-height=720
</pre>

* autovideosink
Wrapper video sink for automatically detected video sink.
<pre>
gst-launch-1.0 v4l2src device=/dev/video2 ! 'video/x-raw,width=1280,height=720,format=NV12' ! autovideosink
</pre>

* Single Image Capturing
<pre>
gst-launch v4l2src num-buffers=1 ! jpegenc ! filesink location=single_buffer.jpg
</pre>

==Video streaming==
{{note|The operation below requires '''root''' access.}}
The following command should be executed on UCM-iMX8M-Plus to start video streaming:
 gst-launch-1.0 v4l2src device=/dev/video2 ! video/x-raw, width=640, height=480 ! jpegenc ! udpsink host='''127.0.0.1''' port='''1234'''
'''127.0.0.1''' is the IP address of the host PC, and '''1234''' is the host PC port.

The following command should be executed on host PC (Linux) to receive the video stream:
 gst-launch-1.0 udpsrc port='''1234''' ! jpegdec ! autovideosink
'''1234''' is the host PC port.

=Analog Audio=

SBEV-UCMIMX8PLUS carrier-board features an on-board WM8962 audio codec with stereo line output and line input.

{| class="wikitable" style="text-align:left;"
|-
| align="" | '''Interface''' 
| align="" | '''Device tree, overlays and bootcmd''' 
|-
| align="" |Audio Interfaces
| align="" |fw_setenv fdtfile sbev-ucmimx8plus-headless.dtb<br>fw_setenv fdtofile "sbev-ucmimx8plus-hdmi.dtbo sbev-ucmimx8plus-lvds.dtbo sbev-ucmimx8plus-wm8962.dtbo"<br>fw_setenv bootcmd "run bsp_bootcmd"
|-
|}

===List of available sound cards===
* aplay
<pre>
aplay -l
**** List of PLAYBACK Hardware Devices ****
card 0: audiohdmi [audio-hdmi], device 0: i.MX HDMI i2s-hifi-0 [i.MX HDMI i2s-hifi-0]
  Subdevices: 1/1
  Subdevice #0: subdevice #0
card 1: wm8962audio [wm8962-audio], device 0: HiFi wm8962-0 [HiFi wm8962-0]
  Subdevices: 1/1
  Subdevice #0: subdevice #0
</pre>
* procfs
<pre>
cat /proc/asound/cards
 0 [audiohdmi      ]: audio-hdmi - audio-hdmi
                      audio-hdmi
 1 [wm8962audio    ]: fsl-asoc-card - wm8962-audio
                      wm8962-audio
</pre>

===Switch between the available output===
* cl-oselect allows select an output device:
<pre>
cl-oselect
1) alsa_output.platform-sound-hdmi.stereo-fallback
2) alsa_output.platform-sound-wm8962.stereo-fallback
3) <<
Sound sink [ alsa_output.platform-sound-hdmi.stereo-fallback ] >2
</pre>

===Audio playback===
* gplay-1.0 allows playing back media files:
<pre>
gplay-1.0 /path/to/media.file
</pre>

=Suspend / Resume=
{{note|The operation below requires '''root''' access.}}

UCM-iMX8M-Plus features suspend mode, which allows to minimize power consumption. 

The following command should be used to enter suspend mode:
<pre>
echo mem >/sys/power/state
</pre>

To resume normal operation press shortly the '''Power On''' button '''SW4'''.

=CPU frequency=
{{note|The operation below requires '''root''' access.}}
==CPU frequency current settings==
Execute the following command to get the current settings:
<pre>
grep -ir . /sys/devices/system/cpu/cpufreq/policy0/ 2>/dev/null

/sys/devices/system/cpu/cpufreq/policy0/scaling_min_freq:1200000
/sys/devices/system/cpu/cpufreq/policy0/scaling_available_governors:conservative ondemand userspace powersave performance schedutil 
/sys/devices/system/cpu/cpufreq/policy0/cpuinfo_cur_freq:1200000
/sys/devices/system/cpu/cpufreq/policy0/scaling_governor:ondemand
/sys/devices/system/cpu/cpufreq/policy0/cpuinfo_max_freq:1600000
/sys/devices/system/cpu/cpufreq/policy0/scaling_available_frequencies:1200000 1600000 
/sys/devices/system/cpu/cpufreq/policy0/related_cpus:0 1 2 3
/sys/devices/system/cpu/cpufreq/policy0/scaling_cur_freq:1200000
/sys/devices/system/cpu/cpufreq/policy0/scaling_setspeed:<unsupported>
/sys/devices/system/cpu/cpufreq/policy0/stats/trans_table:   From  :    To
/sys/devices/system/cpu/cpufreq/policy0/stats/trans_table:         :   1200000   1600000 
/sys/devices/system/cpu/cpufreq/policy0/stats/trans_table:  1200000:         0        65 
/sys/devices/system/cpu/cpufreq/policy0/stats/trans_table:  1600000:        65         0 
/sys/devices/system/cpu/cpufreq/policy0/stats/total_trans:130
/sys/devices/system/cpu/cpufreq/policy0/stats/time_in_state:1200000 643
/sys/devices/system/cpu/cpufreq/policy0/stats/time_in_state:1600000 474
/sys/devices/system/cpu/cpufreq/policy0/affected_cpus:0 1 2 3
/sys/devices/system/cpu/cpufreq/policy0/scaling_max_freq:1600000
/sys/devices/system/cpu/cpufreq/policy0/cpuinfo_transition_latency:182000
/sys/devices/system/cpu/cpufreq/policy0/scaling_driver:cpufreq-dt
/sys/devices/system/cpu/cpufreq/policy0/cpuinfo_min_freq:1200000
</pre>

==Changing the scaling governor==
Execute the following command to change the scaling governor:
<pre>
echo performance > /sys/devices/system/cpu/cpufreq/policy0/scaling_governor
</pre>

Where '''perfomance''' is name of the scaling governor.

Execute the following command to see available scaling governors:
<pre>
cat /sys/devices/system/cpu/cpufreq/policy0/scaling_available_governors
</pre>

Execute the following command to see current scaling governor:
<pre>
cat /sys/devices/system/cpu/cpufreq/policy0/scaling_governor
</pre>

==Changing CPU frequency==
{{note|CPU frequency can be changed only when the scaling governoris set to '''userspace'''.}}
Execute the following command to set CPU frequency:
<pre>
echo 1200000 > /sys/devices/system/cpu/cpufreq/policy0/scaling_setspeed
</pre>

'''1200000''' is one of the available CPU frequencies.

Execute the following command to see available CPU frequencies:
<pre>
cat /sys/devices/system/cpu/cpufreq/policy0/scaling_available_frequencies
</pre>

Execute the following command to see current CPU frequency:
<pre>
cat /sys/devices/system/cpu/cpufreq/policy0/cpuinfo_cur_freq
</pre>

=CPU temperature=
i.MX8M-Plus SoC features an internal temperature sensor which allows to measure the SoC temperature.
Execute the following command to read the current CPU temperature:
<pre>
cat /sys/class/thermal/thermal_zone0/temp
</pre>

=RTC=
There two rtc on the device:

==rtc0 (snvs-rtc-lp)==
* System information
<pre>
udevadm info -p /sys/class/rtc/rtc0

P: /devices/platform/soc@0/30000000.bus/30370000.snvs/30370000.snvs:snvs-rtc-lp/rtc/rtc0
N: rtc0
L: -100
S: rtc
E: DEVPATH=/devices/platform/soc@0/30000000.bus/30370000.snvs/30370000.snvs:snvs-rtc-lp/rtc/rtc0
E: DEVNAME=/dev/rtc0
E: MAJOR=251
E: MINOR=0
E: SUBSYSTEM=rtc
E: USEC_INITIALIZED=8188223
E: DEVLINKS=/dev/rtc
</pre>

* Wake up:
This rtc can be used as a wake up source, as a result an '''rtcwakeup''' can be used with this device:
<pre>
rtcwake --device /dev/rtc0 -s 5 -m mem
</pre>

==rtc1 (ab1805)==
* System information
<pre>
udevadm info -p /sys/class/rtc/rtc1

P: /devices/platform/soc@0/30800000.bus/30a30000.i2c/i2c-1/1-0069/rtc/rtc1
N: rtc1
L: 0
E: DEVPATH=/devices/platform/soc@0/30800000.bus/30a30000.i2c/i2c-1/1-0069/rtc/rtc1
E: DEVNAME=/dev/rtc1
E: MAJOR=251
E: MINOR=1
E: SUBSYSTEM=rtc
</pre>

* Set the date and write it into the RTC:
<pre>
date -s "12 SEP 2019 10:00:00"

Thu Sep 12 10:00:00 UTC 2019
hwclock --systohc --rtc /dev/rtc1
</pre>

* Read the RTC time and date:
<pre>
hwclock --show --rtc /dev/rtc1

Thu Sep 12 10:00:48 2019  0.000000 seconds
</pre>


= Device Serial Number=
Product information is stored in on-board EEPROM.<br>
* To read the product serial number, issue the folowing command:
<pre>
cat /proc/device-tree/product-sn
</pre>
* To read the product configuration part number, issue the following command:
<pre>
cat /proc/device-tree/product-options
</pre>

=See Also=
*[[UCM-iMX8M-Plus: Evaluation Kit: Getting Started | Getting started with UCM-iMX8M-Plus evaluation kit]] <br>
*[[UCM-iMX8M-Plus: Evaluation Kit: Hardware Guide | UCM-iMX8M-Plus evaluation kit hardware guide]]

[[Category:Yocto]]
[[Category:UCM-iMX8M-Plus]]