Lenovo ThinkPad X1 Yoga (Gen 3)

From ArchWiki
Jump to navigation Jump to search

The Lenovo ThinkPad X1 Yoga, 3th generation is a 2-in-1 convertible laptop introduced in early 2018. Its design is closely related to the Lenovo ThinkPad X1 Carbon (Gen 6). It features a 14" screen, 8th-gen Intel Core processors and integrated Intel UHD 620 graphics.

To ensure you have this version, install the package dmidecode and run:

# dmidecode -t system | grep Version
	Version: ThinkPad X1 Yoga 3rd
Device Working Modules
Intel graphics Yes i915, (intel_agp)
Wireless network Yes iwlmvm
Native Ethernet with included dongle Yes ?
Mobile broadband No¹ ?
Audio Yes snd_hda_intel
Touchpad Yes psmouse, rmi_smbus, i2c_i801
TrackPoint Yes psmouse, rmi_smbus, i2c_i801
TouchScreen Yes x86-input-wacom, libwacom
Stylus Yes x86-input-wacom, libwacom
Camera Yes uvcvideo
Fingerprint Reader No² ?
Power management Yes ?
Bluetooth Yes btusb
microSD card reader Yes scsi_mod
Keyboard Backlight Yes thinkpad_acpi
Function/Multimedia Keys Yes ?
  1. No working Linux driver for Fibocom L850-GL. See this thread and this thread for more info.
  2. The Validity90 project began reverse engineering the reader, but updates have stopped recently.

BIOS

Thunderbolt BIOS assist potential brick issue

Several linux users reported their systems were bricked after enabling "Thunderbolt BIOS assist" in the UEFI menu. Lenovo has released BIOS version 1.27 which prevents this issue. See this thread on the Lenovo forums for details.

EC Fan issues under Linux

Under BIOS version 1.24 the embedded controller will no longer spin the fan up properly during high system load causing CPU throttling issues. Reverting to version 1.21 will restore normal functions or you can use the ThinkFanAUR package to control it via the OS. See Fan speed control#ThinkPad laptops for details.

Updates

Automatic (Linux Vendor Firmware Service)

In August of 2018 Lenovo has joined the Linux Vendor Firmware Service (LVFS) project, which enables firmware updates from within the OS. BIOS updates (and possibly other firmware such as the Thunderbolt controller) can be queried for and installed through fwupd.

Manual

Download the latest BIOS image from the Lenovo Thinkpad X1 Yoga 3rd Gen downloads page. Obtain geteltoritoAUR and run geteltorito.pl -o bios-update.img xxxxxxxx.iso on the downloaded ISO file to create a valid El Torito image file, then flash this file on a USB drive via dd like you would flash Arch installation media. For further information see flashing BIOS from Linux.

The ThinkPad X1 Yoga supports setting a custom splash image at the earliest boot stage (instead of the red "Lenovo" logo), more information can be found in the README.TXT located in the FLASH folder of the update image.

Suspend issues

In the past 3rd Generation X1 Yoga supports S0i3 (also known as Windows Modern Standby), but not S3 by default. This changed as of May, 17, 2019. Lenovo included a BIOS option to enable S3 from BIOS 1.33 onward.


Verifying S3

To check whether S3 is recognized and usable by Linux, run:

 dmesg | grep -i "acpi: (supports"

and check for S3 in the list.

Enabling S3 (with BIOS version 1.33 and after)

Since of May 17, 2019, Lenovo released firmware 1.33, which let you enable legacy S3 sleep in UEFI/BIOS. You can find the option in ThinkPad Setup: Config -> Power and disable the option "Optimized Sleep State for Modern Standby".

Optimized Sleep State for Modern Standby:

  • Disabled: "legacy" S3 sleep
  • Enabled: modern standby

By setting this option to "Disabled", a warning will appear. The warning describes that a reinstallation of your OS might be mandatory. Accept the warning and both Windows and Linux should work fine. You can do this step even if you already installed a patch to enable s3 sleep. After disabling the optimized sleep state in the bios, and if you did the method to enable s3 sleep before the 1.33 bios update, it is best to remove GRUB_EARLY_INITRD_LINUX_CUSTOM="/acpi_override" in your /etc/default/grub (if you placed that there before), and regenerate the grub cfg using sudo update-grub. Don't forget to remove the acpi_override file as well.


Reboot and verify whether S3 is working by running:

 dmesg | grep -i "acpi: (supports"

You should now see something like this:

 [    0.230796] ACPI: (supports S0 S3 S4 S5)

Enabling S3 (before BIOS version 1.33)

There is an automated script called x1carbon2018s3 by fiji-flo that was originally intended for use for the X1 Carbon 6th Gen (source). The script and documentation were updated and maintained by lsmith77 to adapt it for the X1 Yoga 3rd Gen. The latest known version is in a fork by ryankhart currently awaiting a pull request. These scripts are recommended for debian-based distributions because of the script including debian-based bash commands.

(Optional) To check out this script and its history, visit these GitHub repositories:

Manual method

The manual method can be used in any distribution of Linux. Below is a modified version of the source instructions because some things are hard to understand.


1. Reboot, enter BIOS/UEFI. Go to Config - Thunderbolt (TM) 3 - set Thunderbolt BIOS Assist Mode to Enabled. Set also Security - Secure Boot to Disabled.

2. Install iasl (Intel's compiler/decompiler for ACPI machine language) and cpio iasl in Ubuntu and possibly other distributions probably do not have the latest release for it to fully work. To make sure you have the latest version, download the source code and make install iasl. cpio can be installed normally with your distribution's package manager


3. Get a dump of ACPI DSDT table: cat /sys/firmware/acpi/tables/DSDT > dsdt.aml

4. Decompile the dump, which will generate a .dsl source based on the .aml ACPI machine language dump: iasl -d dsdt.aml

5. Download the [patch](http://kernel.dk/acpi.patch) and apply it against dsdt.dsl: patch --verbose < acpi.patch

Hunk 2 failed for me, I manually looked for the following in dsdt.dsl:

   Name (SS1, 0x00)
   Name (SS2, 0x00)
   Name (SS3, One)
   One
   Name (SS4, One)
   One


and replaced it with the following (removing the two "One" lines):

   Name (SS1, 0x00)
   Name (SS2, 0x00)
   Name (SS3, One)
   Name (SS4, One)


6. Recompile your patched version of the .dsl source: iasl -ve -tc dsdt.dsl

7. Create a CPIO archive with the correct structure, which GRUB can load on boot. We name the final image acpi_override and copy it into /boot/:

 mkdir -p kernel/firmware/acpi
 cp dsdt.aml kernel/firmware/acpi
 find kernel | cpio -H newc --create > acpi_override
 cp acpi_override /boot


8. GRUB needs to boot the kernel with a parameter setting the deep sleep state as default. Edit /etc/default/grub and add the following:

 GRUB_CMDLINE_LINUX_DEFAULT="mem_sleep_default=deep"
 GRUB_EARLY_INITRD_LINUX_CUSTOM="/boot/acpi_override"

9. Regenerate the GRUB configuration: sudo update-grub

If the second line of the previous step does not generate the grub to make the initrd lines look like "initrd /boot/acpi_override" in the beginning, then follow the next steps as normal. If it does generate those lines, skip to step 11


10. Tell GRUB to load the new DSDT table on boot in its configuration file usually located in /boot/grub/grub.cfg. Find the relevant GRUB menu entry and add the new image /boot/acpi_override to the initrd lines for the images that you want the s3 sleep to work in:

 Before:
 initrd /initramfs-4.17.4-200.fc28.x86_64.img
 
 After:
 initrd /boot/acpi_override /initramfs-4.17.4-200.fc28.x86_64.img

11. Reboot and enjoy having a laptop running Linux again... close the lid and the battery does not get drained in a few hours, also the battery no longer stays warm in sleep mode. To verify that things are working:

 dmesg | grep ACPI | grep supports
 #[    0.195933] ACPI: (supports S0 S3 S4 S5)
 
  cat /sys/power/mem_sleep
 #s2idle [deep]

Fix touchscreen after resume

When the above fix is applied to allow S3 suspend, the touchscreen will not work upon resume from sleep. This fix was pulled from: Lenovo Linux Forums

The touchscreen functionality can be restored by freezing system (s2idle):

create a unit file:

 /etc/systemd/system/wake_wacom_hack.service 

with content:

 [Unit]
 Description= s2idle fo 1 second after resume
 After=suspend.target
 [Service]
 Type=oneshot
 ExecStart=/usr/sbin/rtcwake -m freeze -s 1
[Install]
 WantedBy=suspend.target

enable in standard waycreate a unit file:

 sudo systemctl enable wake_wacom_hack.service


Enabling S2idle

Note: Since kernel version 4.18 acpi.ec_no_wakeup=1 is set by default

From the Lenovo forums: Add the following kernel parameter to enable S2idle support:

 acpi.ec_no_wakeup=1

For example, for GRUB, one might edit /etc/default/grub and edit GRUB_CMDLINE_LINUX_DEFAULT:

 GRUB_CMDLINE_LINUX_DEFAULT="quiet acpi.ec_no_wakeup=1"

then perform

 sudo update-grub

and restart the system.

Note: This supports only S2idle state, not S0i3 state as some seem to have been led to believe!

The power consumption might still be higher than that of the S3 state in this case.

Tablet Functions

For the most part, the touch screen and stylus work under Xorg after installing xf86-input-wacom package with no issues. See Tablet PC for further information.

Stylus

The default stylus buttons are mapped by the wacom driver as follows:

Physical Button Xorg mouse number
Top 2
Bottom "Eraser"

These can be changed with xsetwacom. To set the top button of the stylus to the equivalent of a middle click or Xorg mouse button 3:

 xsetwacom --set "Wacom Pen and multitouch sensor Pen stylus" Button 2 3

To register the "eraser" as a right click use:

 xsetwacom --set "Wacom Pen and multitouch sensor Pen eraser" Button 1 2

Screen Rotation

Automatic Screen Rotation in Gnome

The iio-sensor-proxy package provides automatic screen rotation for me in Gnome. The package is available in the community repo

sudo pacman -S iio-sensor-proxy 

No configuration was needed for my machine.

With Screen Rotator

Automatic screen rotation works well with ScreenRotator which has no configuration necessary. The touchscreen two finger swipe does not follow rotation at this time. Install iio-sensor-proxy-gitAUR and screenrotator-gitAUR.

Note: ScreenRotator is in early development stages.