Tutorial  Updated

How to boot Linux on your Switch

THIS GUIDE IS DEPRECATED
THIS IS BETTER https://github.com/natinusala/painless-linux


I've successfully booted ArchLinux using ShofEL2. Here is a quick guide on how to do it - I'll assume you're computer literate and know how to use a terminal / Linux commands / git.
Everything is taken from the README of the ShofEL2 repo so if you want to go even faster, go read that instead.

Thanks to NightHammer1000 and Y2K-x for the help !

There is a simplified and faster version of this tutorial available here, with precompiled binaries so you don't have to build everything : https://github.com/SoulCipher/shofel2_linux

The result

Without a SD card ("waiting for root device mmcblk0p2") : https://photos.app.goo.gl/7y6ut5ObuHMUIMZg2
Stock Arch Linux : https://photos.app.goo.gl/yALqe3zMZRe2dSQf1
Arch Linux with LXDE : https://photos.app.goo.gl/xaEgRqeSi8jvAwpz5
RetroArch running : https://photos.app.goo.gl/vBLPo5wiBto1qiUH3
Arch Linux with GNOME : https://gbatemp.net/attachments/img_0005-jpg.121608/
Arch Linux with KDE : https://gbatemp.net/attachments/img_20180427_121605-jpg.121666/

What works / what doesn't
  • Desktop environment : Gnome, LXDE, KDE
  • Wi-Fi : works
    • You will need to reboot your Switch and run the exploit again to make the Wi-Fi work (it never works on the first boot)
    • Then enter the Network Manager Application and add your network from there
    • If it doesn't work, you will need to edit the configuration on the host computer (see the additional notes at the end of this post)
    • With LXDE : Can cause a kernel panic if used at the same time as Bluetooth
  • Bluetooth : works but Joy-Cons can't be paired
  • Touch screen : works, although LXDE is not very touch-friendly
  • Audio : doesn't work yet
  • GPU acceleration : works (via mesa), with OpenGL (and maybe Vulkan too ?)
  • Joy-Cons : not recognized
  • Volume buttons : working with Gnome but not doing anything since there is no audio device
  • Power button : doesn't do anything, no sleep mode, no graceful shutdown
  • USB : doesn't work
  • Dock : not tested yet, but I bet it doesn't do anything besides charging the battery
  • Power management / battery level : working with Gnome
What you'll need
  • A computer running Linux with a blue USB SuperSpeed port, or a Mac
    • A Linux VM can work in theory, but it depends on how the USB passthrough is implemented (apparently VMWare works, VirtualBox doesn't)
  • A USB A-to-C cable (with data support, obviously)
    • be careful as cheap cables were reported to work randomly / not work at all
  • Some time (you know, Linux is kinda large)

Prep work

First, you'll need to install the required toolchains. Open this link and download the tar.gz binaries for
  • aarch64-linux-gnu
  • arm-linux-gnueabi
Be careful to choose the right architecture for your PC (for me it was x86_64 so "gcc-linaro-7.2.1-2017.11-x86_64_arm-linux-gnueabi.tar.xz").

Once you have them, extract them somewhere nice and add the "bin" (not "lib" as I previously stated) folder of both toolchains to your PATH ("$ export PATH=$PATH:/path/to/toolchain1/lib:/path/to/toolchain2/lib"). The building process won't work otherwise.

Then, install those dependencies (how to install them and their name might depend on your distribution) :
  • build-essential (sorry I didn't add it it was obvious to me)
  • libssl-dev
  • swig
  • bison
  • pkg-config
  • flex
  • zlib1g-dev
  • python3
  • python-dev
  • python3-pip
  • pyusb 1.0.0 : "$ sudo pip3 install pyusb==1.0.0"
  • libusb-1.0-0-dev

Compiling

Clone each required repository :

Code:
$ git clone https://github.com/fail0verflow/shofel2.git
$ git clone --recursive --depth=1 https://github.com/fail0verflow/switch-coreboot.git coreboot
$ git clone https://github.com/fail0verflow/switch-u-boot.git u-boot
$ git clone --depth=1 https://github.com/fail0verflow/switch-linux.git linux
$ git clone https://github.com/boundarydevices/imx_usb_loader.git

You can grab a coffee or two because Linux has more than 5 million files to download.

Then, build everything :

Code:
$ cd shofel2/exploit
$ make

Code:
$ cd u-boot
$ export CROSS_COMPILE=aarch64-linux-gnu-
$ make nintendo-switch_defconfig
$ make

Code:
$ cd coreboot
$ make nintendo_switch_defconfig
$ make iasl
$ make

If you have a tegra_mtc.bin file error, you'll have to extract it from a Pixel C stock image :
"$ ./build/util/cbfstool/cbfstool bootloader-dragon-google_smaug.7900.97.0.img extract -n fallback/tegra_mtc -f tegra_mtc.bin"

Or you can download it directly from here : https://0w0.st/tegra_mtc.bin (thanks to @CptPotato for uploading this)

You'll have to put it in the "coreboot/src/soc/nvidia/tegra210" directory.

Code:
$ cd imx_usb_loader
$ git reset --hard 0a322b01cacf03e3be727e3e4c3d46d69f2e343e
$ make

The big one :

Code:
$ cd linux
$ export ARCH=arm64
$ export CROSS_COMPILE=aarch64-linux-gnu-
$ make nintendo-switch_defconfig
$ make

If you encounter issues about a missing rule "/lib/firmware/nvidia/tegra210/vic04_ucode.bin" for the target "firmware" you'll have to :
  • install the firmware-misc-nonfree package
  • if you can't install it, or if it still doesn't work, download the package manually from debian sid and extract the file "/lib/firmware/nvidia/tegra210/vic04_ucode.bin" (from the root of your PC, not on the cloned repo) from the DEB (and chmod it if needed)
If you encounter issues about a missing rule "/lib/firmware/brcm/brcmfmac4356-pcie.txt", download this file and put it in "/lib/firmware/brcm/" (from the root of your PC, not on the cloned repo)

Building the rootfs

This is the annoying part. Download the archive / image corresponding to the distribution you want to use :
If it's a tarball you just downloaded

While it's downloading, you'll have to take a microSD card and, using the software of your choice (I used GParted) :
  • remove every existing partition to only have unallocated space on it (do I need to tell you that you're going to loose everything on the card ?)
  • create a tiny FAT32 partition (I chose 200mb but it doesn't matter) - that'll be mmcbkl0p1, you can label it "garbage"
  • create an ext4 partition on the remaining part of the card - that'll be mmcblk0p2, you can label it "rootfs"
  • it's important that the FAT32 partition comes first and the ext4 one comes after - on the Switch, Linux will look for mmcblk0p2, the second partition, if you have scrolling boot logs and then back to RCM it means you did it wrong
Once the rootfs tarball is downloaded, you can simple extract it to the mounting point of the ext4 partition you just created :

Code:
$ tar xvf ArchLinuxARM-aarch64-latest.tar.gz -C /mounting/point/of/ext4/partition && sync
$ cp ArchLinuxARM-aarch64-latest.tar.gz /mounting/point/of/ext4/partition/root && sync

("/mounting/point/of/ext4/partition/root" is the "root" directory on the partition)

Don't forget to properly eject the SD Card !

If "tar xvf" doesn't work for you you can install "bsdtar" and use "bsdtar -xpf" instead

Then you can put the SD card in the console.

If it's a img / bin file you just downloaded

You can simply write it on your SD card using :
  • If you're on Windows, Ether or Win32DiskImager
  • If you're on Linux / Mac OS : "sudo dd if=yourimage.img of=/dev/sdX && sync" where /dev/sdX is the device of your SD card (unmounted)
You will probably want to open a partition manager to resize the ext4 partition once it's flashed, so that it fits your SD card.

Then you can put the SD card in the console.

Booting linux

Run the exploit :

Code:
$ cd shofel2/exploit
$ sudo ./shofel2.py cbfs.bin ../../coreboot/build/coreboot.rom

Your terminal should now be waiting for the Switch to enter RCM mode.

To do so : (I don't have pictures but that's the same method as fusée gelée, just look at some video tutorials)
  • plug the Switch on your PC using the USB A-to-C cable - use a blue SuperSpeed port if you have one
  • shut it down
  • remove the right joy-con
  • using a method of your choice, short the 10th pin of the right joy-con (the last pin on the right, away from the screen, closer to the back) with the ground : that can be pin 1, 2 or 7, that can also be a screw on the joy-con rack or the console's fan - I personnaly stick a RPi jumper wire in the fan and touch the 10th pin on the other side, works everytime (like this)
  • keep the pins shorted and power the Switch while pressing the volume UP button
If it worked, the console will show a black screen and you'll see the exploit running on your terminal. If you see the Nintendo logo, it has failed. You can power off the console and try again.

Then, run those last commands :

Code:
$ cd shofel2/usb_loader
$ ../../u-boot/tools/mkimage -A arm64 -T script -C none -n "boot.scr" -d switch.scr switch.scr.img
$ sudo ../../imx_usb_loader/imx_usb -c .

Linux should then boot on your console - first the boot logs with the penguins, and then an ArchLinux login prompt. Voilà !
Again, if you have the boot logs and then a black screen, it means you did the SD card part wrong.

Additional notes

Hardware graphics acceleration


The most recents image already contain this fix.

To add mesa drivers install this package using pacman :
https://0w0.st/mesa-full-tegra-r101876.bf5e0276b6-1-aarch64.pkg.tar.xz

You will need a working internet connection to do so.

Then, use this script to choose your power profile : https://0w0.st/power.sh

Full speed RAM


According to the blog post ("Linux on Switch boot chain" section), you need to extract a file from a Pixel C factory image in order to have the RAM working at full speed. I didn't do it so I won't cover it here.

Fixing calibration issues of the touch screen (thanks to @Wizardy)

To fix calibration issues of the touch screen, edit the file /usr/share/X11/xorg.conf.d/10-evdev.confg (of the rootfs)

And change the InputClass section to :

Code:
Section "InputClass"
        Identifier "evdev touchscreen catchall"
        MatchIsTouchscreen "on"
        MatchDevicePath "/dev/input/event*"
        Driver "evdev"
        Option "InvertX" "no"
        Option "InvertY" "yes"
        Option "SwapAxes" "yes"
        Option "Calibration" "0 1279 0 719"
EndSection

Wi-Fi

To setup Wi-Fi, mount the rootfs partition on your host PC and edit the configuration for your network in the file "/etc/NetworkManager/system-connections" (if it doesn't exist, take Gigaspot).

To have a working Wi-Fi you must reboot your Switch and run the exploit again each time you power it off

Moving the rootfs to another partition

If you want to move the rootfs to another partition on your SD card, edit the "shofel2/usb_loader/switch.scr" file and replace "/dev/mmcblk0p2" by the partition you want to use.
 
Last edited by natinusala,

benjy3gg

Member
Newcomer
Joined
Apr 25, 2018
Messages
6
Trophies
0
Age
33
XP
423
Country
Germany
does the fan of the switch work in linux? i noticed the device getting kind of hot.
i installed lm_sensors and it doesn't show any fan device. can someone look into this?
 

Gnarmagon

Noob <3
Member
Joined
Dec 12, 2016
Messages
647
Trophies
0
Age
22
XP
794
Country
Germany
Can someone say how you are supposed to flash the arch_lxde.bin onto the microsd ?
How should I partition the drive beforehand ? like in the guide ? (didn't work with the dd command, because gparted said the partitions are corrupted...)
 

Gigaa

Well-Known Member
Member
Joined
Apr 25, 2018
Messages
108
Trophies
0
Age
26
Location
Norway
Website
giga.is
XP
130
Country
Norway
Just pulled it last night, I haven't been messing with this stuff for long at all.
You might have a better result if you try to compile it yourself.
Can someone say how you are supposed to flash the arch_lxde.bin onto the microsd ?
How should I partition the drive beforehand ? like in the guide ? (didn't work with the dd command, because gparted said the partitions are corrupted...)
To be honest you should just give up on the bin files and use the tar files instead. It's much simpler really.
Hey, is the sound finally fixed or not? I was away since few days
Sound is still not fixed, i would image this has to be fixed in the kernel really.
 
  • Like
Reactions: Hisakiyo

Gnarmagon

Noob <3
Member
Joined
Dec 12, 2016
Messages
647
Trophies
0
Age
22
XP
794
Country
Germany
To be honest you should just give up on the bin files and use the tar files instead. It's much simpler really.
Actually I tried it but the op really confuses me;
how are you supposed to run those commands ?
The first one extracts the tar to the SD-Card ? (should I select the 200mb partition or the rootfs here ?)
$ tar xvf ArchLinuxARM-aarch64-latest.tar.gz -C /mounting/point/of/ext4/partition; sync
Why should I copy the tar.gz to the SD-Card ? and what's the difference between the above ? Why are the paths different in the example with only one ext4 partition on the sdcard ?
$ cp ArchLinuxARM-aarch64-latest.tar.gz /mounting/point/of/ext4/partition/root; sync
 

Gigaa

Well-Known Member
Member
Joined
Apr 25, 2018
Messages
108
Trophies
0
Age
26
Location
Norway
Website
giga.is
XP
130
Country
Norway
Actually I tried it but the op really confuses me;
how are you supposed to run those commands ?
The first one extracts the tar to the SD-Card ? (should I select the 200mb partition or the rootfs here ?)
$ tar xvf ArchLinuxARM-aarch64-latest.tar.gz -C /mounting/point/of/ext4/partition; sync
Why should I copy the tar.gz to the SD-Card ? and what's the difference between the above ? Why are the paths different in the example with only one ext4 partition on the sdcard ?
$ cp ArchLinuxARM-aarch64-latest.tar.gz /mounting/point/of/ext4/partition/root; sync
You will need to run these in a linux terminal. Yes the first one extracts it to the the SD-card
tar xvf "name of the tar file" -C /mounting/point/of/ext4/partition
then run sync
You should extract it to the rootfs partition as shown in the tar command. You don't need to copy the tar to the root folder, it works just fine without it.
 
Last edited by Gigaa,
  • Like
Reactions: Gnarmagon
D

Deleted User

Guest
partially with:
- VMWare Workstation Pro for triggering the exploit
- Some crappy 3rd party tools like PartitionGuru (for partitioning the sdcard)
- and Ext2Fsd for mounting the ext4 partition

but linux is just so much easier ;)

sure if you could help me patch the linux (ubuntu kernel) so it works with usb 2.0 i would be thankful (sehr dankbar)
 

RHOPKINS13

Geek
Member
Joined
Jan 31, 2009
Messages
1,354
Trophies
2
XP
2,625
Country
United States
Is there a way to setup autologin on Gigaa's KDE build, because I'm stuck at the archlinux login
When I ran it, it autologged in fine. But if you let it timeout and the screen locks, you're locked out and can't log back in, unless I guess if you paired a bluetooth keyboard beforehand.
 

Gigaa

Well-Known Member
Member
Joined
Apr 25, 2018
Messages
108
Trophies
0
Age
26
Location
Norway
Website
giga.is
XP
130
Country
Norway
Is there a way to setup autologin on Gigaa's KDE build, because I'm stuck at the archlinux login
Then you might have done something wrong. Slim should automatically log you in.
When I ran it, it autologged in fine. But if you let it timeout and the screen locks, you're locked out and can't log back in, unless I guess if you paired a bluetooth keyboard beforehand.
Yea that was an oversight on my part, you can turn it off in kde's settings.
Also kinda funny that my desktop KDE got onscreen keyboard on lock but the switch doesn't lol.
 

Jafece

Member
Newcomer
Joined
Apr 29, 2018
Messages
8
Trophies
0
Age
40
XP
848
Country
United States
Can someone point out what I seem to be missing here, I am using the precompiled kernel and I get this error when I run the script which I believe is causing my issues

File descriptor: 5
b''
entry 400168ed
throwing more
Performing hax...
Size: 0x6c68
b'820000000000686c'
b'0200000000000000000000000000000000a400b7f37f0000716c000000000000000000000000000000000000000000000f0f00000000000000'
URB address: 0x7ff3b7000600
Traceback (most recent call last):
File "./shofel2.py", line 247, in <module>
rcm.pwn()
File "./shofel2.py", line 205, in pwn
s.ep0_read_unbounded(overwrite_len)
File "./shofel2.py", line 76, in ep0_read_unbounded
fcntl.ioctl(s.fd, USBDEVFS_SUBMITURB, urb)
OSError: [Errno 9] Bad file descriptor
 

natinusala

Win32 error 31 is not an error
OP
Member
Joined
Dec 1, 2012
Messages
1,032
Trophies
0
Age
44
XP
2,914
Country
France
does the fan of the switch work in linux? i noticed the device getting kind of hot.
i installed lm_sensors and it doesn't show any fan device. can someone look into this?

The device gets hot on CPU-intensive tasks, such as installing packages or building things. GPU-intensive tasks will however trigger the fan.
 

RHOPKINS13

Geek
Member
Joined
Jan 31, 2009
Messages
1,354
Trophies
2
XP
2,625
Country
United States
I ran into trouble trying to compile the Linux kernel. It kept throwing this error message:
Code:
No rule to make target '/lib/firmware/brcm/brcmfmac4356-pcie.bin'

(I'm running Debian Sid btw)

Note that the file ends in .bin, not .txt. I tried downloading the .txt file and throwing it in /lib/firmware/brcm/ like it said in the tutorial, but it didn't fix the problem. Couldn't find anywhere where someone ran into that exact same problem, but what worked for me was installing the firmware-brcm80211 package:
Code:
sudo apt install firmware-brcm80211

After that, I was able to compile everything fine.
 
  • Like
Reactions: Gigaa

OkazakiTheOtaku

no thanks, I don't want a custom title
Member
Joined
Jul 20, 2016
Messages
1,461
Trophies
1
Location
127.0.0.1
XP
3,114
Country
Japan
sure if you could help me patch the linux (ubuntu kernel) so it works with usb 2.0 i would be thankful (sehr dankbar)
It doesn't work on a VM on MacOS out of the box. It never will work, unless Parallels or VMWare adds in passthrough. You either need to recompile the linux kernel with the patch or run linux on bare metal and use the dangerous RAM manipulation script.
 
Last edited by OkazakiTheOtaku,

Gigaa

Well-Known Member
Member
Joined
Apr 25, 2018
Messages
108
Trophies
0
Age
26
Location
Norway
Website
giga.is
XP
130
Country
Norway
I'm not getting autologin on your latest rootfs with the GPU power management either. I was getting it on previous rootfses. I'll try downloading and extracting it again, but I don't think it's working.
Huh, people seems to have different results with my rootfs. This is all very strange as you are all using the same rootfs.
All i can think of is that maybe some you didn't sync or you got a strange sd card or something as it should most definitely work.
Sorry if this has been asked before, but I just got into the GUI with KDE version and then went to reboot to hopefully get wifi working but now my switch doesn't do anything when trying to boot into Linux. Absolutely nothing appears when I try to boot it with or without an sd card in. I get no errors when running boot_linux.sh and the device is in definitely in RCM every time. Anyone got any ideas as to why?
Have you tried to power cycle it?
 
Last edited by Gigaa,

Site & Scene News

Popular threads in this forum

General chit-chat
Help Users
    I @ I-need-help-with-wup-wiiu: i have an issue with loading games on usb with usbloadergx on vwii. Is there anyone that can...