Page History

Warning
Documentation for 2023.2 can be changed permanently at the moment. With the current status documentation, everything can be created and used under WSL but 2023.2 under WSL2 is currently being evaluated.

NoteBeta Version description page is under construction

Expand
title Prepare PC/OS
Enable CPU virtualisation in BIOS
Open Windows Features
Enable Windows-Subsystem for Linux
Image Modified

Expand
title Change default WSL version from WSL1 to WSL2
Powershell as Admin:
dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
Reboot
Download and install: https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi
Powershell as Admin:
wsl --set-default-version 2

Expand
title

Linux Distribution installieren

Download Linux Distribution:https://docs.microsoft.com/de-de/windows/wsl/install-manual

Check supported Linux distribution for Vivado/Vitis/Petalinux ( ex. "Ubuntu 18.04 LTS" for works for 2020.2)

Open Powershell as AdminAdd-AppxPackage <download path>\Ubuntu_1804.2019.522.0_x64.appx

List of tested WSL Linux distributionen and Xilinx Tools

The list is only a guide that has worked for us, there may still be complications that we cannot help with at this time.

Vivado/Vitis/Petalinux 2023.2
- with WSL Ubuntu 22.04 LTS
Archive(was created with older version of this guideline)
- Vivado/Vitis/Petalinux 2020.2
  - with WSL Ubuntu 18.04 LTS
- Vivado/Vitis/Petalinux 2021.2/2022.2
  - with WSL Ubuntu 18.04 LTS
  - with WSL Ubuntu 20.04 LTS

Expand

title	Linux Distribution installieren

Install Ubuntu Distribution

Open Powershell as Admin
1. Show all available distributions wsl.exe --list --online
2. Install(Need for Multi Distributions): wsl.exe --install -d <linux distribution> or wsl.exe --install <linux distribution>

sudo <size>GB

1. 1. <size>GB
    processors=<cnt>
2. Other options: https://docs.microsoft.com/en-us/windows/wsl/wsl-config
Other Install options from MS:https://docs.microsoft.com/de-de/windows/wsl/install-manual

Mount external ext4 drive (optional)

mount ext4 drive (optimal as working drive instead if vhs): https://learn.microsoft.com/en-us/windows/wsl/wsl2-mount-disk
1. Mounting a partitioned disk
  1. Show drives on powershell: GET-CimInstance -query "SELECT * from Win32_DiskDrive"
  2. Mount drive inside powershell: wsl --mount <DiskPath> -p <partition number>
  3. Linux Console
    1. show available partitions: lsblk -lf
    2. Mount drive inside linux:
      1. sudo mkdir /mnt/<name>
      2. sudo mount /dev/sdd<Number> /mnt/<name>/
    3. Change Permission
      1. sudo chown <owner>:<owner> /mnt/<name>/
2. todo automount (otherwise ex4 is unmounted after wsl shutdown)
  1. https://learn.microsoft.com/de-de/windows/wsl/wsl-config

Expand

title	Setup DNS nameserver

Check that the DNS server is configured on the Linux console:
1. sudo vim /etc/resolv.conf
In case DNS server is correct, skip this instruction otherwise follow instruction below
Linux console:
1. sudo vim /etc/wsl.conf
  1. [network]
    generateResolvConf = false
2. (in case file can't be wrote):
  1. sudo rm /etc/.wsl.conf.swp
Powershell console:
1. wsl --shutdown
Get DNS Server IP over powershell:
1. ipconfig -all
Restart Linux (over powershell or win start button → Ubuntu)
Linux console:
1. sudo vim /etc/resolv.conf
  - nameserver <DNS IP>
2. (in case file can't be wrote, remove) and try again point a:
  1. sudo rm /etc/.resolv.conf.swp

Expandtitle

Expand

title	GUI Option 2: Ubuntu Desktop Modus over RDP

Start Ubuntu App (Windows Start Button → Ubuntu)
Add username and password
Update packet manager:
1. sudo apt update && sudo apt upgrade
Install:
1. sudo apt install xfce4 xrdp
Modify Remote Port
1. sudo sed -i 's/3389/3388/g' /etc/xrdp/xrdp.ini
Start XRDP Server
1. sudo /etc/init.d/xrdp start
(optional) XRDP autostart :
1. sudo vim /etc/bash.bashrc
  1. sudo /etc/init.d/xrdp start
Connect via RDP(Win10 Remote Desktop Connection):
1. localhost:3388
  Image Removed

GUI Option 1: GUI with X-Server

Install VcXsrv

Start VcXrvc (XLaunch)

Image Removed

Linux console:

sudo apt update && sudo apt upgrade
sudo apt install xfce4
sudo apt install build-essential
sudo apt install net-tools
sudo apt install xrdp -y && sudo systemctl enable xrdp

Linux console:

export DISPLAY=<host IP>:0.0
export LIBGL_ALWAYS_INDIRECT=1

(optional) Add environment to auto start of new console :

sudo vim /etc/bash.bashrc
1. export DISPLAY=<host IP>:0.0
2. export LIBGL_ALWAYS_INDIRECT=1
3. sudo /etc/init.d/dbus start
4. sudo /etc/init.d/xrdp start

Expand

title	Virtual WSL drive as network drive in WinOS

Open explore
Right click on PC icon --> Connect network drive
Select drive
Add to folder \\wsl$\Ubuntu-18.04
Click Finish

Prepare Linux for AMD Tools

Expand

title	Additional Packages

Resize WSL VHD, see "Resize WSL VHD" on "Notes and Hints and other stuff" section
Install browser
1. sudo

: in case script did not install all) python pylint3 Xilinx xvf Xilinx202011181232sudo chown <owner><owner>

1. <owner> /tools/Xilinx
Install Vitis
1. run:$ ./xsetup
2. select Vitis on default installation path
Vivado License
1. Open Xilinx License manager and chose Copy License and select your license file
2. In case license file is node-locked and shared with WinOS:
  1. sudo vim /etc/bash.bashrc
    1. sudo ip link add bond0 type bond
      1. in case bond0 is not available
    2. sudo ip link set dev bond0 address xx:xx:xx:xx:xx:xx
      1. (use MAC from Win OS)
Install petalinux
1. run:$ ./xsetup
2. select petalinux on default installation path
Add source environment to auto start of new console :
1. sudo vim /etc/bash.bashrc
  1. source /tools/Xilinx/PetaLinux/

2020

1. 1. 2023.2/tool/settings.sh

Notes and Hints and other stuff

Expand

title	Notes and hints and other stuff

Code Block

language	bash
title	sudo vim /etc/bash.bashrc (complete example)
collapse	true

#...
#(original part)
#...
#all extensions to setup environment and 
# load petalinux environment, can be overwrite via project scripts
export LM_LICENSE_FILE=<path to license file>
export GLOBAL_VIVADO=2023.2
source /tools/Xilinx/PetaLinux/

2020.26# finish function x_run () { #XServer Display export DISPLAY=xxx.xxx.xxx.xxx:0.0 # replace xxx.xxx.xxx.xxx with your win 10 host IP export LIBGL_ALWAYS_INDIRECT=1 sudo /etc/init.d/dbus start sudo /etc/init.d/xrdp start

export TE_WSL_USAGE=1
export TE_EDITOR=notepad++.exe
#export TE_SERIAL_PS=<path>
export TE_COM=/mnt/<path to putty on winOS>
export TE_PLX_SSTATE_CACHE_DOWNLOAD=~/design/sstate-cache/downloads_${GLOBAL_VIVADO}/downloads
export TE_PLX_SSTATE_CACHE_AARCH64=~/design/sstate-cache/sstate_aarch64_${GLOBAL_VIVADO}/aarch64
export TE_PLX_SSTATE_CACHE_ARM=~/design/sstate-cache/sstate_arm_${GLOBAL_VIVADO}/arm
export TE_PLX_SSTATE_CACHE_MB_FULL=~/design/sstate-cache/sstate_mb-full_${GLOBAL_VIVADO}/mb-full
# finish
echo "TE Enviroment Variables"
echo "TE_TIMEOUT=${TE_TIMEOUT}"
echo "TE_RUNNING_JOBS=${TE_RUNNING_JOBS}"
echo "TE_WSL_USAGE=${TE_WSL_USAGE}"
echo "TE_EDITOR=${TE_EDITOR}"
echo "TE_SERIAL_PS=${TE_SERIAL_PS}"
echo "TE_COM=${TE_COM}"
echo "TE_PLX_SSTATE_CACHE_DOWNLOAD=${TE_PLX_SSTATE_CACHE_DOWNLOAD}"
echo "TE_PLX_SSTATE_CACHE_AARCH64=${TE_PLX_SSTATE_CACHE_AARCH64}"
echo "TE_PLX_SSTATE_CACHE_ARM=${TE_PLX_SSTATE_CACHE_ARM}"
echo "TE_PLX_SSTATE_CACHE_MB_FULL=${TE_PLX_SSTATE_CACHE_MB_FULL}" # finish

function x_run () {
  sudo ip link add bond0 type bond
  # replace xx:xx:xx:xx:xx:xx with win 10 MAC
  sudo ip link set dev bond0 address xx:xx:xx:xx:xx:xx
}

#

x-server Setup

xSetup only needed in case wsl is rebooted
echo "Refresh XSetup? y/N"
read xsetup
if [ "${xsetup}" == "y" ]; then x_run; fi 

#show version
lsb_release -a

Code Block

language	powershell
title	Release reserved memory from Vmmem
collapse	true

#Sometimes Vmmem did not release DDR memory
# ###############
#Solution 1: 
# #######
#shutdown (close all running application before)
wsl --shutdown
#start WSL again
wsl
#Solution 2:
#todo

Code Block

language	powershell
title	Resize WSL VHD
collapse	true

# Resize VHD
# ###############
# see: https://docs.microsoft.com/en-us/windows/wsl/vhd-size  
#
#1 open powershell as admin
#Terminate WSL
wsl --shutdown
# https://learn.microsoft.com/en-us/windows/wsl/disk-space#how-to-locate-the-vhdx-file-and-disk-path-for-your-linux-distribution
#find your distribution installation.
#replace <distribution-name> with your Ubuntu Version, for example Ubuntu-22.04
(Get-ChildItem -Path HKCU:\Software\Microsoft\Windows\CurrentVersion\Lxss | Where-Object { $_.GetValue("DistributionName") -eq '<distribution-name>' }).GetValue("BasePath") + "\ext4.vhdx"

#Copy the path to that file, it should look something like %LOCALAPPDATA%\Packages\CanonicalGroupLimited.Ubuntu20.04onWindows_79xxxx\LocalState\ext4.vhdx
# This path will be called "<pathToVHD>" below
# -------------------------#start diskpartdiskpart# ----------
diskpart
#inside diskpart console
#select disk
DISKPART> Select vdisk file="<pathToVHD>"
#check details
DISKPART> detail vdisk
#(optional) shrink size
DISKPART> compact vdisk
#expand for example to 512GB  <sizeInMegaBytes>=512000
#Note: WSL2 and Ubuntu 22.04 has default maximum size from harddisk
DISKPART> expand vdisk maximum=512000 
#exit
DISKPART> exit
# ----------
#start WSL from powershell
sudo mount -t devtmpfs none /dev
#  "/dev: none already mounted on /dev." warning can be ignored
mount | grep ext4
#resize fs to 512GB <sizeInMegaBytes>=512000M
sudo resize2fs /dev/sdb 512000M

Code Block

language	bash
title	Warning "/bin/bash: warning: setlocale: LC_ALL: cannot change locale (en_US.UTF-8)
collapse	true

#change manually with
sudo dpkg-reconfigure locales

Obsolete Notes

Expand

title	GUI Option 1: GUI with X-Server (not longer needed))

Note
VCXsrv is not longer needed with newest WSL und Ubuntu 22.04

Install VcXsrv
Start VcXsrv (XLaunch)
1. Image Added
2. Image Added
  
  Image Added
3. (optional) Save Configuration and run XLaunch directly with "XLaunch -run <config.xlaunch>"
Linux console:
1. sudo apt update && sudo apt upgrade
2. sudo apt install xfce4
3. sudo apt install build-essential
4. sudo apt install net-tools
5. sudo apt install xrdp -y && sudo systemctl enable xrdp
Add environment to auto start of new console :

sudo vim /etc/bash.bashrc
1. export DISPLAY=<host IP>:0.0
2. export LIBGL_ALWAYS_INDIRECT=1
3. sudo /etc/init.d/dbus start
4. sudo /etc/init.d/xrdp start

Expand

title	GUI Option 2: Ubuntu Desktop Modus over RDP (not longer tested with 22.3 and newer))

Note
Currently not tested with newest WSL und Ubuntu 22.04

Start Ubuntu App (Windows Start Button → Ubuntu)
Add username and password
Update packet manager:
1. sudo apt update && sudo apt upgrade
Install:
1. sudo apt install xfce4 xrdp
Modify Remote Port
1. sudo sed -i 's/3389/3388/g' /etc/xrdp/xrdp.ini
Start XRDP Server
1. sudo /etc/init.d/xrdp start
(optional) XRDP autostart :
1. sudo vim /etc/bash.bashrc
  1. sudo /etc/init.d/xrdp start
Connect via RDP (Win10 Remote Desktop Connection):
1. localhost:3388
  Image Added

Expand

title	older version of bash.bashcr

Code Block

language	bash
title	sudo vim /etc/bash.bashrc (complete example)
collapse	true

#...
#(original part)
#...
#all extensions to setup environment and 
# load petalinux environment, can be overwrite via project scripts
export GLOBAL_VIVADO=2021.2
source /tools/Xilinx/PetaLinux/${GLOBAL_VIVADO}/tool/settings.sh

# additional TE environment variables to change timeout and used jobs

# additional TE envirnmoent variables
export TE_TIMEOUT=200
export TE_RUNNING_JOBS=16
export TE_WSL_USAGE=1
export TE_EDITOR=notepad++.exe
#export TE_SERIAL_PS=<path>
export TE_COM=/mnt/<path to putty on winOS>
export TE_PLX_SSTATE_CACHE_DOWNLOAD=~/design/sstate-cache/downloads_${GLOBAL_VIVADO}/downloads
export TE_PLX_SSTATE_CACHE_AARCH64=~/design/sstate-cache/sstate_aarch64_${GLOBAL_VIVADO}/aarch64
export TE_PLX_SSTATE_CACHE_ARM=~/design/sstate-cache/sstate_arm_${GLOBAL_VIVADO}/arm
export TE_PLX_SSTATE_CACHE_MB_FULL=~/design/sstate-cache/sstate_mb-full_${GLOBAL_VIVADO}/mb-full
# finish
echo "TE Enviroment Variables"
echo "TE_TIMEOUT=${TE_TIMEOUT}"
echo "TE_RUNNING_JOBS=${TE_RUNNING_JOBS}"
echo "TE_WSL_USAGE=${TE_WSL_USAGE}"
echo "TE_EDITOR=${TE_EDITOR}"
echo "TE_SERIAL_PS=${TE_SERIAL_PS}"
echo "TE_COM=${TE_COM}"
echo "TE_PLX_SSTATE_CACHE_DOWNLOAD=${TE_PLX_SSTATE_CACHE_DOWNLOAD}"
echo "TE_PLX_SSTATE_CACHE_AARCH64=${TE_PLX_SSTATE_CACHE_AARCH64}"
echo "TE_PLX_SSTATE_CACHE_ARM=${TE_PLX_SSTATE_CACHE_ARM}"
echo "TE_PLX_SSTATE_CACHE_MB_FULL=${TE_PLX_SSTATE_CACHE_MB_FULL}" # finish

function x_run () {
  #XServer Display
  export DISPLAY=xxx.xxx.xxx.xxx:0.0
  # replace xxx.xxx.xxx.xxx with your win 10 host IP
  export LIBGL_ALWAYS_INDIRECT=1

  sudo /etc/init.d/dbus start
  sudo /etc/init.d/xrdp start
  # replace xx:xx:xx:xx:xx:xx with win 10 MAC
  sudo ip link set dev bond0 address xx:xx:xx:xx:xx:xx
}

# x-server Setup only needed in case wsl is rebooted
echo "Refresh XSetup? y/N"
read xsetup
if [ "${xsetup}" == "y" ]; then x_run; fi 

#show version
lsb_release -a

Trenz Electronic Documentation

Versions Compared

Old Version 27

New Version Current

Key

Instructions

Setup WSL and Install Linux

Prepare Linux for AMD Tools

Notes and Hints and other stuff

Other Trenz Documentation around AMD Tool

Preview Screenshots

Vivado Linux GUI

on Windows Desktop

Vivado Linux GUI Linux Desktop in RDP

Linux Console on Win OS with Petalinux

Virtual Linux EXT4 Drive on Win Explorer

Linux Console on Win OS with Petalinux

Obsolete Notes