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,

nswebfrog

Member
Newcomer
Joined
Apr 29, 2018
Messages
5
Trophies
0
Age
34
XP
58
Country
China
That was user fault when manually build the kernel. When you download the brcm...-pcie.txt from the direct link i.e. from the OP, it downloads the txt file BUT the content, on my case, is base64 encoded. So that was why my wifi wasnt working.

I would suggest you go check that file on your build machine /lib/firmware/brcm and make sure its clear text before attempt building the kernel.

Cheers.

@Mittytoto You're right. That is the base64 encoded 'brcmfmac4356-pcie.txt' file caused the WiFi problem. I redownload it and compile the kernel, it works!!!
Thanks~~
 
  • Like
Reactions: Mittytoto

nswebfrog

Member
Newcomer
Joined
Apr 29, 2018
Messages
5
Trophies
0
Age
34
XP
58
Country
China
Anyone else have issues with a missing virtual keyboard when using KDE? Virtual keyboard pops up for Gnome and LXE builds, and the Ubuntu build I've tired. KDE seems to be a lot more responsive (and dare i say faster) compared to the others hence the reason to want to get the virtual keyboard working.
Me too. I use my bluetooth keyboard instead.
 
  • Like
Reactions: KIT786

Rainbowfied Pokemaster

Well-Known Member
Newcomer
Joined
Jun 28, 2016
Messages
47
Trophies
0
XP
191
Country
United States
I made an account just to help you with this.
I ran into the same thing.

You have to install “pkg-config”.

It’s not on te requirements list, and missing in minimum Ubuntu installs.



Another package I was missing is zlib, eg. “
zlib1g-dev”
Thank you!

--------------------- MERGED ---------------------------

running make in the "linux" folder gives me this error:

Code:
make: aarch64-linux-gnu-gcc: Command not found
scripts/kconfig/conf  --silentoldconfig Kconfig
arch/arm64/Makefile:27: ld does not support --fix-cortex-a53-843419; kernel may be susceptible to erratum
arch/arm64/Makefile:48: Detected assembler with broken .inst; disassembly will be unreliable
  CHK     include/config/kernel.release
  UPD     include/config/kernel.release
Cannot use CONFIG_CC_STACKPROTECTOR_STRONG: -fstack-protector-strong not supported by compiler
Makefile:1129: recipe for target 'prepare-compiler-check' failed
make: *** [prepare-compiler-check] Error 1
 

nswebfrog

Member
Newcomer
Joined
Apr 29, 2018
Messages
5
Trophies
0
Age
34
XP
58
Country
China
Thank you!

--------------------- MERGED ---------------------------

running make in the "linux" folder gives me this error:

Code:
make: aarch64-linux-gnu-gcc: Command not found
scripts/kconfig/conf  --silentoldconfig Kconfig
arch/arm64/Makefile:27: ld does not support --fix-cortex-a53-843419; kernel may be susceptible to erratum
arch/arm64/Makefile:48: Detected assembler with broken .inst; disassembly will be unreliable
  CHK     include/config/kernel.release
  UPD     include/config/kernel.release
Cannot use CONFIG_CC_STACKPROTECTOR_STRONG: -fstack-protector-strong not supported by compiler
Makefile:1129: recipe for target 'prepare-compiler-check' failed
make: *** [prepare-compiler-check] Error 1

Install the cross-compile tools. If you are using ubuntu, run command:

sudo apt install gcc-arm-linux-gnueabi
sudo apt install gcc-aarch64-linux-gnu
 

Pinda

Well-Known Member
Newcomer
Joined
Jan 16, 2015
Messages
48
Trophies
0
Age
33
Location
Amstelveen
Website
jasonmeulenhoff.nl
XP
96
Country
Netherlands
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

Did anyone encounter this too? can't seem to fix this one
 

Rainbowfied Pokemaster

Well-Known Member
Newcomer
Joined
Jun 28, 2016
Messages
47
Trophies
0
XP
191
Country
United States
Install the cross-compile tools. If you are using ubuntu, run command:

sudo apt install gcc-arm-linux-gnueabi
sudo apt install gcc-aarch64-linux-gnu
That fixed the "command not found" error but now I get this:

Code:
arch/arm64/Makefile:27: ld does not support --fix-cortex-a53-843419; kernel may be susceptible to erratum
arch/arm64/Makefile:48: Detected assembler with broken .inst; disassembly will be unreliable
  CHK     include/config/kernel.release
Cannot use CONFIG_CC_STACKPROTECTOR_STRONG: -fstack-protector-strong not supported by compiler
Makefile:1129: recipe for target 'prepare-compiler-check' failed
make: *** [prepare-compiler-check] Error 1
 
Last edited by Rainbowfied Pokemaster,

Kobigov

Well-Known Member
Member
Joined
Jan 10, 2018
Messages
129
Trophies
0
Age
44
XP
300
Country
United States
no kernal panics if you are connected to wifi and a bluetooth device anymore? if so i'll use a bluetooth keyboard too
It does rarely, I've got a bluetooth mouse and keyboard with wifi on the KDE image right now and haven't had any crashes since it started.
 

EclipseSin

Ignorant Wizard
Member
Joined
Apr 1, 2015
Messages
2,063
Trophies
1
Age
35
Location
221b Baker Street
XP
1,737
Country
United Kingdom
Didn't search, didn't look. Just leaving a note.

If you shutdown linux after accessing your nand, then on the next boot everything seems fine (nintendo logo, switch logo) until it should show the lock screen but only the backlight is on, give about 10 seconds then push the power button. Should come up then. Idk, just had it happen to me twice now.
 
  • Like
Reactions: natinusala

orangy57

bruh
Member
Joined
Aug 17, 2015
Messages
916
Trophies
1
Age
21
Location
New Jersey
XP
2,947
Country
United States
You mean, take the switch apart and do that? I'll do that, but only in worst case situation. I'm really hoping for a fix using only software right now.
just use the switch on the actual uhh console part and not linux, and then play it until it dies. Plug in the charger, and charge it until the battery is full, and leave the charger plugged in for another hour. Restart the switch and it should be fine, it worked for me.
 

TerraPhantm

Well-Known Member
Member
Joined
Jul 27, 2007
Messages
498
Trophies
0
XP
680
Country
United States
just use the switch on the actual uhh console part and not linux, and then play it until it dies. Plug in the charger, and charge it until the battery is full, and leave the charger plugged in for another hour. Restart the switch and it should be fine, it worked for me.
Mine was still dying at 30% when I tried that.

I just let it drain fully with a fusee-payload running, and am letting it fully charge overnight. We'll see how it does
 

J-Lit

Member
Newcomer
Joined
May 1, 2018
Messages
9
Trophies
0
Age
30
XP
63
Country
United States
Hi guys, I'm pretty noob to Linux, but this is the output I've been getting when using SoulCipher's GitHub repo and trying to run the exploit.

I flashed arch_lxde.zip onto a 128GB sd card using Etcher. After the output from below spits out, my screen stays black and the kernel never loads. Any ideas?

Code:
>>> Switching to cbfs mode...
sending 0x7000 bytes @0x0
sending 0x4 bytes @0xffffc
sending 0x20 bytes @0x20138
sending 0x18 bytes @0x20100
sending 0x20 bytes @0x20118
sending 0x18 bytes @0x20180
sending 0x20 bytes @0x20198
sending 0x1c bytes @0x201b8
sending 0x533e bytes @0x201d4
sending 0x100000 bytes @0x0
you have been served

Detected. Waiting 5 seconds

config file <conf//imx_usb.conf>
vid=0x0955 pid=0x701a file_name=switch.conf
config file <conf//switch.conf>
parse conf//switch.conf
conf//switch.conf: syntax error: _direct 0x8e000000
 {image/switch.scr.img:load 0x8e000000,jump_direct 0x8e000000
}
Trying to open device vid=0x0955 pid=0x701a
Interface 0 claimed
HAB security state: development mode (0x56787856)
== work item
filename kernel/Image.gz
load_size 0 bytes
load_addr 0x83000000
dcd 0
clear_dcd 0
plug 0
jump_mode 0
jump_addr 0x00000000
== end work item
load_addr=83000000

loading binary file(kernel/Image.gz) to 83000000, skip=0, fsize=8433b7 type=0

<<<8663991, 8664064 bytes>>>
succeeded (status 0x88888888)
HAB security state: development mode (0x56787856)
== work item
filename dtb/tegra210-nintendo-switch.dtb
load_size 0 bytes
load_addr 0x8d000000
dcd 0
clear_dcd 0
plug 0
jump_mode 0
jump_addr 0x00000000
== end work item
load_addr=8d000000

loading binary file(dtb/tegra210-nintendo-switch.dtb) to 8d000000, skip=0, fsize=a040 type=0

<<<41024, 41984 bytes>>>
succeeded (status 0x88888888)
HAB security state: development mode (0x56787856)
== work item
filename image/switch.scr.img
load_size 0 bytes
load_addr 0x8e000000
dcd 0
clear_dcd 0
plug 0
jump_mode 1
jump_addr 0x00000000
== end work item
load_addr=8e000000

loading binary file(image/switch.scr.img) to 8e000000, skip=0, fsize=162 type=aa

<<<354, 1024 bytes>>>
succeeded (status 0x88888888)
jumping to 0x8e000000

Done. You should see kernel booting on switch soon

-//- kombos.org -//-
 

TerraPhantm

Well-Known Member
Member
Joined
Jul 27, 2007
Messages
498
Trophies
0
XP
680
Country
United States
Hi guys, I'm pretty noob to Linux, but this is the output I've been getting when using SoulCipher's GitHub repo and trying to run the exploit.

I flashed arch_lxde.zip onto a 128GB sd card using Etcher. After the output from below spits out, my screen stays black and the kernel never loads. Any ideas?

Code:
>>> Switching to cbfs mode...
sending 0x7000 bytes @0x0
sending 0x4 bytes @0xffffc
sending 0x20 bytes @0x20138
sending 0x18 bytes @0x20100
sending 0x20 bytes @0x20118
sending 0x18 bytes @0x20180
sending 0x20 bytes @0x20198
sending 0x1c bytes @0x201b8
sending 0x533e bytes @0x201d4
sending 0x100000 bytes @0x0
you have been served

Detected. Waiting 5 seconds

config file <conf//imx_usb.conf>
vid=0x0955 pid=0x701a file_name=switch.conf
config file <conf//switch.conf>
parse conf//switch.conf
conf//switch.conf: syntax error: _direct 0x8e000000
 {image/switch.scr.img:load 0x8e000000,jump_direct 0x8e000000
}
Trying to open device vid=0x0955 pid=0x701a
Interface 0 claimed
HAB security state: development mode (0x56787856)
== work item
filename kernel/Image.gz
load_size 0 bytes
load_addr 0x83000000
dcd 0
clear_dcd 0
plug 0
jump_mode 0
jump_addr 0x00000000
== end work item
load_addr=83000000

loading binary file(kernel/Image.gz) to 83000000, skip=0, fsize=8433b7 type=0

<<<8663991, 8664064 bytes>>>
succeeded (status 0x88888888)
HAB security state: development mode (0x56787856)
== work item
filename dtb/tegra210-nintendo-switch.dtb
load_size 0 bytes
load_addr 0x8d000000
dcd 0
clear_dcd 0
plug 0
jump_mode 0
jump_addr 0x00000000
== end work item
load_addr=8d000000

loading binary file(dtb/tegra210-nintendo-switch.dtb) to 8d000000, skip=0, fsize=a040 type=0

<<<41024, 41984 bytes>>>
succeeded (status 0x88888888)
HAB security state: development mode (0x56787856)
== work item
filename image/switch.scr.img
load_size 0 bytes
load_addr 0x8e000000
dcd 0
clear_dcd 0
plug 0
jump_mode 1
jump_addr 0x00000000
== end work item
load_addr=8e000000

loading binary file(image/switch.scr.img) to 8e000000, skip=0, fsize=162 type=aa

<<<354, 1024 bytes>>>
succeeded (status 0x88888888)
jumping to 0x8e000000

Done. You should see kernel booting on switch soon

-//- kombos.org -//-

I found it to work more reliably when I loaded the kernel without the SD card plugged in, and then put the SD in when it said something to the effect of "waiting for mmc0blk2". Still took multiple tries on occasion.
 

Site & Scene News

Popular threads in this forum

General chit-chat
Help Users
  • No one is chatting at the moment.
    K3Nv2 @ K3Nv2: https://youtube.com/shorts/WOppJ92RgGU?si=KE79L6A_3jESsGQM