Display Guide¶
Here you find documented everything supported displays and how to add support for displays to our CoMs software.
Supported Displays¶
The following table gives an overview of displays that can be connected to the various baseboards.
Display / Bridge |
Connected via |
Compatible Baseboards |
Description |
|---|---|---|---|
Raspberry Pi Display |
DSI Connector |
|
|
SN65DSI83 (default for 10” panel) |
DSI Connector |
|
MIPI-to-LVDS bridge |
TC358867 |
DSI Connector |
|
MIPI-to-RGB bridge Glyn Displays via MIPI |
LCD |
40 Pin LCD header |
|
RGB interface |
Enable Display¶
More details: Devicetree Overlays
Depending on the module one or two overlays are required to use the module with a display. Generally one activates the display output, the other configures the settings for the display itself.
(Re-)boot the board and “Hit any key to stop autoboot” to get to the U-Boot command line interface:
setenv overlays_<baseboard> ${overlays_<baseboard>} lvds-panel karo-panel-tm101jvhg32
saveenv
reset
STM display setting¶
For our STM modules, QSMP* and TXMP*, you need to set the videomode variable in U-Boot as follows:
setenv videomode TM101
saveenv
With the videomode variable U-Boot selects the display-timing out of the dtb.
You can see the available displays for your module with the following command in U-Boot
fdt ls display/display-timings
Choose your connected display and replace TM101 in the command above.
Raspberry Pi Touch Display¶
For more see: Raspberry Pi 7inch Touch Display Site Site.
Usage: add the *-raspi-display FDT overlay.
Fixed resolution
RGB Displays¶
Glyn’s Family Concept displays
Usage:
Direct connection to MB7 or QSBASE1
Via Toshiba TC358867 with corresponding
*-tc358867.dtbfor specific CoM.For fitting resolution see Setting Display Resolution
MIPI Bridges¶
MIPI to LVDS: Texas Instruments SN65DSI83
Usage: Corresponding
*-dsi83.dtbfor specific CoM, or already enabled on mipi-mb and tx8m-1620.
MIPI to RGB: Toshiba TC358867
Usage: Corresponding
*-tc358867.dtbfor specific CoM.
For fitting resolution see Setting Display Resolution
Texas Instruments SN65DSI83¶
The default MIPI-2-LVDS bridge used by Ka-Ro is the Texas Instruments SN65DSI83.
An overview of its features is given by this excerpt from the Product Manual:
The SN65DSI83 DSI to FlatLink bridge device features a single-channel MIPI D-PHY receiver front- end configuration with four lanes per channel operating at 1 Gbps per lane; a maximum input bandwidth of 4 Gbps. The bridge decodes MIPI DSI 18 bpp RGB666 and 24 bpp RGB888 packets and converts the formatted video data stream to a FlatLink-compatible LVDS output operating at pixel clocks operating from 25 MHz to 154 MHz, offering a Single-Link LVDS with four data lanes per link.
The SN65DSI83 device can support up to WUXGA 1920×1200 at 60 frames per second, at 24 bpp with reduced blanking. The SN65DSI83 device is also suitable for applications using 60 fps 1366×768 / 1280×800 at 18 bpp and 24 bpp. Partial line buffering is implemented to accommodate the data stream mismatch between the DSI and LVDS interfaces.
For more see its Product Page.
Toshiba TC358867¶
The Toshiba TC358867 - in its industrial version called TC9595XBG - is used as a standard MIPI to RGB bridge for the TX8M, QS8M and QSXM/QSXP COMs. Despite the different names, there is no difference in functionality, and as such the Linux kernel only refers to it as a device named TC358867.
Some information of this is as follows (from the Product Manual, emphasis added):
Possible modes of Operation:
MODE S2P: TC9595XBG uses only Parallel output port and disables DisplayPort™ Tx to interface to single RGB display device. Videostream source is from MIPI® DSI Host.
RGB Parallel Output Interface:
RGB888 output (DisplayPort™ disabled) with only DSI input supported in this mode
More information can be found at the Product Overview, Product Page and the Product Manual available there.
Setting Display Resolution¶
Setting or changing the display resolution the device tree (short DT) for the Linux kernel needs to be adjusted and recompiled.
Changes might include the setting of other values of the DT node like pixelclock frequency, active high or active low, front porch and back porch, etc. These values are usually found in the sepcific display’s reference manual.
As a general rule changes to the device tree should be done by creating a new dts file that follows the include structure and changes the specific devices nodes and properties therein as needed. Changes in a dts file, which represents the leaf of the structure, will overwrite previous set values.
MIPI to LVDS Bridge¶
On the example of the SN65DSI83 MIPI-2-LVDS bridge. The current (default) values of a system set up with this bridge are given in the following DTS file:
imx8mm-tx8m-1620.dts
A more comprehensive excerpt (incl. github) of the whole SN65DSI83 device node is found here.
An the excerpt (also github reference) for the whole TC358867 device node can be found here.
The node’s properties to change display setting look as follows, where each of the values shown has been taken from the respective display’s reference manual:
lvds {
clock-frequency = <62500000>;
hactive = <1280>;
vactive = <800>;
hback-porch = <6>;
hfront-porch = <5>;
vback-porch = <2>;
vfront-porch = <3>;
hsync-len = <2>;
vsync-len = <1>;
hsync-active = <0>;
vsync-active = <0>;
de-active = <0>;
pixelclk-active = <0>;
};
Further on with the procedure of changing the resolution - assuming a display of some values - would look like this:
cd <bsp>/sources/meta-karo-nxp/recipes-kernel/linux/linux-karo-6.6/dts/freescale
cp imx8mm-qsxm-qsbase3.dts imx8mm-qsxm-qsbase3-my-product-changes.dts
$EDITOR imx8mm-qsxm-qsbase3-my-product-changes.dts
Note
$EDITOR is a system variable of Linux pointing to an editor, usually something like vim or nano.
Replace the command as needed.
The original file’s (imx8mm-qsxm-qsbase3.dts) content looks like this:
// SPDX-License-Identifier: (GPL-2.0 OR MIT)
/*
* Copyright (C) 2021 Markus Bauer <MB@KARO-electronics.de>
*
*/
#include "imx8mm-qsxm-mm60-qsbase3.dts"
#include "imx8m-qs8m-dsi83.dtsi"
/ {
model = "Ka-Ro electronics QSXM-MM60 (NXP i.MX8MM) module on QSBASE3 baseboard with DSI83 MIPI2LVDS bridge";
};
&vpu_g1 {
status = "okay";
};
&vpu_g2 {
status = "okay";
};
&vpu_h1 {
status = "okay";
};
Edting the file to respresenting own changes, particularly the display of choice, with a display of exemplary values of:
Property |
Value |
|---|---|
Pixelclock frequency: |
50 MHz |
Horizontal resolution: |
1024 |
Vertical resolution: |
800 |
Back porch: |
12 |
Pixelclock Active: |
high |
// SPDX-License-Identifier: (GPL-2.0 OR MIT)
/*
* Copyright (C) 2021 Oliver Wendt <OW@KARO-electronics.de>
*
*/
#include "imx8mm-qsxm-qsbase3.dts"
/ {
model = "Ka-Ro electronics QSXM-MM60 (NXP i.MX8MM) module on QSBASE3 baseboard with DSI83 MIPI2LVDS bridge + My Changes";
};
&lvds {
clock-frequency = <50000000>;
hactive = <1024>;
vactive = <800>;
hback-porch = <12>;
pixelclk-active = <1>;
};
This changed DT file, is then to be compiled into a DTB which then needs to be uploaded to the COM.
MIPI to RGB Bridge¶
There is an exception pertaining RGB TFT displays (specifically Glyn’s Family Concept displays) connected via the TC358867 MIPI-2-RGB bridge. As also stated in the DTS file itself, does the TC358867 bridge require to be set to an specific pixelclock frequency, see also example below.
For more see the RGB Bridge Display Device Tree.
display-timings {
lcd {
// all EDT displays - Leave clock at 25175000!!!
clock-frequency = <25175000>;
hactive = <320>;
vactive = <240>;
hback-porch = <38>;
hfront-porch = <20>;
vback-porch = <14>;
vfront-porch = <4>;
hsync-len = <30>;
vsync-len = <4>;
hsync-active = <0>;
vsync-active = <0>;
de-active = <1>;
pixelclk-active = <0>;
};
};
Custom Panel¶
Easily configure your own display using a customised Yocto Layer
The necessary steps are briefly explained here.
This is basically all you need for an addition to Yocto:
meta-mypanel/
├── COPYING.MIT
├── README
├── conf
│ └── layer.conf
└── recipes-kernel
└── linux
├── linux-karo
│ └── dts
│ └── freescale
│ └── {name}.dts
└── linux-karo_%.bbappend
6 directories, 5 files
{name}.dts contains the configuration of your display.
Prerequisites
karo-nxp-bsp is used here as an example BSP directory
You have setup the environment and build directory (Refer to: Yocto Guide)
You can successfully built the image
1. Create your custom layer with the name “mypanel” as example
bitbake-layers create-layer ~/karo-nxp-bsp/sources/meta-mypanel
2. Remove the example and setup the required directories
cd ~/karo-nxp-bsp/sources/meta-mypanel
rm -rf recipes-example/
mkdir -p recipes-kernel/linux/linux-karo/dts/freescale
cd recipes-kernel/linux
echo 'FILESEXTRAPATHS:prepend := "${THISDIR}/${PN}:"' > linux-karo_%.bbappend
3. Copy an existing panel .dts as reference.
cd linux-karo-6.1/dts/freescale
cp $(find ~/karo-nxp-bsp/sources/meta-karo-nxp/ -name "karo-panel-t*.dts") mypanel.dts
4. Edit mypanel.dts (see complete contents below)
...
* Copyright ...
...
overlays {
mypanel;
};
...
label = "MyPANEL";
...
4. Add mypanel to DTB_OVERLAYS
cd ~/karo-nxp-bsp/sources/meta-mypanel/conf
echo 'DTB_OVERLAYS:append = " mypanel"' >> layer.conf
5. Add the new layer and create the images as usual.
Change to your build directory and add the new layer.
bitbake-layers add-layer ../sources/meta-mypanel
bitbake {your image}
mypanel.dtb will be added to the boot partition image.
karo-panel-tm101jvhg32.dts
// SPDX-License-Identifier: (GPL-2.0 OR MIT)
/*
* Copyright 2022 Lothar Waßmann <LW@KARO-electronics.de>
*
*/
/dts-v1/;
/plugin/;
&{/chosen} {
overlays {
karo-panel-tm101jvhg32;
};
};
&panel {
label = "TM101JVHG32";
width-mm = <217>;
height-mm = <136>;
status = "okay";
panel-timing {
clock-frequency = <62500000>;
hactive = <1280>;
vactive = <800>;
hback-porch = <80>;
hfront-porch = <80>;
vback-porch = <12>;
vfront-porch = <11>;
hsync-len = <2>;
vsync-len = <1>;
hsync-active = <0>;
vsync-active = <0>;
de-active = <0>;
pixelclk-active = <0>;
};
};