[Beta] LVFS update for Framework Laptop 13 13th Gen Intel Core fingerprint reader on Linux

[Matt_Hartley]

We are releasing a beta release of the Framework fingerprint reader firmware to fix issues where the fingerprint reader is not recognized on Linux by libfprint. This is released to the lvfs-testing repository currently, and will be moved to the lvfs repository after our 1 week beta period if no issues are found during the beta testing period.

This will update the fingerprint reader firmware from 01000320 to 01000330.

Earlier systems might have version numbers lower than 01000300. While these have no incompatibility with Linux, it is harmless to update them to 01000330 as well.

You may need to update your fingerprint reader firmware to function correctly in the following conditions.

1. You received a Framework Laptop 13 DIY Edition produced during the time period where 01000320 firmware was used.
2. You swapped in an Input Cover from the Framework Marketplace that was produced in the time window where 01000320 was used.

Fingerprint support when dual booting Linux and Windows

Please note that enrolling fingerprints in multiple OSs at the same time will cause the previous OS to lose the fingerprint MOC state. This will cause fingerprint login to stop working on that OS. Furthermore if you dual boot to Windows, the manufacture driver will update the firmware to the version that paired with the windows driver.

Enable LVFS Testing

fwupdmgr enable-remote lvfs-testing

fwupdmgr refresh

Check what version of the fingerprint reader firmware you currently have.

fwupdmgr get-devices 1e8c8470-a49c-571a-82fd-19c9fa32b8c3

└─Fingerprint Sensor:

Device ID: 23ec719b6aabc2d2dac5176c232f0da7a21881b0

Summary: Match-On-Chip fingerprint sensor

Current version: 01000330

Update your fingerprint reader firmware

fwupdmgr update 1e8c8470-a49c-571a-82fd-19c9fa32b8c3

Check if your fingerprint module is functioning

After updating, you can check if fingerprint login is functional using the gnome-settings users page, and enroll your fingerprint by clicking on fingerprint login, fprintd-enroll or other apps to enroll your fingerprints.

Fingerprint Unlock Behavior

The fingerprint reader is a convenient way to log into the system, authenticate sudo and more, but it is not a replacement for the user’s password.

While it’s possible to log in the system with fingerprint when it turns on, you’ll need to enter the password once any program requires access to the gnome-keyring.

This is a security/usability trade-off and MacOS does it similarly: Use Touch ID on Mac - Apple Support (CA)

“For security, you need to enter your password when you start your Mac”

[Matt_Hartley]

Folks, if you have errors, please post below here vs opening new threads as I will begin merging them here.

[dimitris]

@Matt_Hartley no errors, but on this 11 Gen machine (with original reader) the update doesn’t seem available on lvfs-testing:

$ fwupdmgr refresh --force
Updating lvfs-testing
Downloading…             [     \                                 ]
Updating lvfs
Downloading…             [***************************************]
Successfully downloaded new metadata: 3 local devices supported
$ fwupdmgr get-devices 1e8c8470-a49c-571a-82fd-19c9fa32b8c3
Selected device: Fingerprint Sensor
Framework Laptop
│
└─Fingerprint Sensor:
      Device ID:          4295296d98b3ba38c72f6baa33d24f03a1d428f6
      Summary:            Match-On-Chip fingerprint sensor
      Current version:    01000248
      Vendor:             Goodix (USB:0x27C6)
      Install Duration:   10 seconds
      Serial Number:      ...
      GUID:               1e8c8470-a49c-571a-82fd-19c9fa32b8c3 ← USB\VID_27C6&PID_609C
      Device Flags:       • Updatable
                          • Device can recover flash failures
                          • Signed Payload

$ fwupdmgr update 1e8c8470-a49c-571a-82fd-19c9fa32b8c3
Devices with no available firmware updates: 
 • Fingerprint Sensor
 • SSD 970 EVO Plus 2TB
 • UEFI Device Firmware
 • UEFI Device Firmware
No updatable devices
$ fwupdmgr get-remotes
Framework Laptop
...
├─Linux Vendor Firmware Service (testing):
│     Remote ID:          lvfs-testing
│     Type:               download
│     Keyring:            jcat
│     Enabled:            true
│     P2P Metadata:       true
│     P2P Firmware:       false
│     Checksum:           cd5b3909613263280cf50bdf47161411a5ead9cc7f87d1cc199be3e57cd6fca7
│     Age:                7 minutes
...

[Cipher]

I have the testing branch enabled, there is no update available for the fingerprint sensor.

fwupdmgr refresh --force
Updating lvfs-testing
Downloading…             [   -                                   ]
Updating lvfs
Downloading…             [ -                                     ]
Successfully downloaded new metadata: 5 local devices supported

fwupdmgr get-devices 1e8c8470-a49c-571a-82fd-19c9fa32b8c3
Selected device: Fingerprint Sensor
Framework Laptop (12th Gen Intel Core)
│
└─Fingerprint Sensor:
      Device ID:          4295296d98b3ba38c72f6baa33d24f03a1d428f6
      Summary:            Match-On-Chip fingerprint sensor
      Current version:    01000252
      Vendor:             Goodix (USB:0x27C6)
      Install Duration:   10 seconds
      Serial Number:      UID5BFB6326_XXXX_MOC_B0
      GUID:               1e8c8470-a49c-571a-82fd-19c9fa32b8c3 ← USB\VID_27C6&PID_609C
      Device Flags:       • Updatable
                          • Device can recover flash failures
                          • Signed Payload

fwupdmgr update
Devices with no available firmware updates:
 • CT1000P5PSSD8
 • Fingerprint Sensor
 • Internal SPI Controller
Devices with the latest available firmware version:
 • System Firmware
 • UEFI Device Firmware
 • UEFI Device Firmware
 • UEFI dbx

[Matt_Hartley]

Folks, 13th Gen only and for those with replacement input kits only. This is not needed otherwise.

[Dan_Nicholson]

Hi @Matt_Hartley, for me I get the following:

My issue of ‘device disconnected’ on the last scan is still present. Following this error the fingerprint scanning UI says ‘…device is already claimed by another process’

fwupdmgr enable-remote lvfs-testing


╔══════════════════════════════════════════════════════════════════════════════╗
║ Enable new remote?                                                           ║
╠══════════════════════════════════════════════════════════════════════════════╣
║ The LVFS is a free service that operates as an independent legal entity and  ║
║ has no connection with Ubuntu. Your distributor may not have verified any    ║
║ of the firmware updates for compatibility with your system or connected      ║
║ devices. All firmware is provided only by the original equipment             ║
║ manufacturer.                                                                ║
║                                                                              ║
║ This remote contains firmware which is not embargoed, but is still being     ║
║ tested by the hardware vendor. You should ensure you have a way to manually  ║
║ downgrade the firmware if the firmware update fails.                         ║
║                                                                              ║
║ Enabling this functionality is done at your own risk, which means you have   ║
║ to contact your original equipment manufacturer regarding any problems       ║
║ caused by these updates. Only problems with the update process itself        ║
║ should be filed at https://bugs.launchpad.net/ubuntu/.                       ║
╚══════════════════════════════════════════════════════════════════════════════╝

Agree and enable the remote? [Y|n]: Y
Authenticating…          [-                                      ]
Authenticating…          [***************************************]
Do you want to refresh this remote now? (Requires internet connection) [Y|n]: Y
Downloading…             [***************************************]
Downloading…             [***************************************]

Successfully enabled and refreshed remote
➜  ~ fwupdmgr refresh


Firmware metadata last refresh: 23 hours ago. Use --force to refresh again.
➜  ~ fwupdmgr refresh --force


Updating lvfs-testing
Downloading…             [     \                                 ]Updating lvfs
Downloading…             [***************************************]
Downloading…             [***************************************]
Downloading…             [***************************************]
Successfully downloaded new metadata: 0 local devices supported
➜  ~ fwupdmgr get-devices 1e8c8470-a49c-571a-82fd-19c9fa32b8c3

[other unrelated devices output, removed from paste]

Laptop (13th Gen Intel Core)
│
├─Fingerprint Sensor:
│     Device ID:          d432baa2162a32c1554ef24bd8281953b9d07c11
│     Summary:            Match-On-Chip fingerprint sensor
│     Current version:    01000330
│     Vendor:             Goodix (USB:0x27C6)
│     Install Duration:   10 seconds
│     GUIDs:              34def4c7-9461-5a32-a945-5dde0ca57d88
│                         1e8c8470-a49c-571a-82fd-19c9fa32b8c3
│     Device Flags:       • Updatable
│                         • Device can recover flash failures
│                         • Signed Payload

➜  ~ fwupdmgr update 1e8c8470-a49c-571a-82fd-19c9fa32b8c3

Devices with no available firmware updates: 
 • Fingerprint Sensor
 • UEFI dbx
No updatable devices

[jlcfan]

@Matt_Hartley The instructions provided worked for me up to the updating of the fingerprint reader firmware (confirmed Laptop 13 DIY Edition with 01000320 firmware).

When updating the fingerprint reader firmware with the command above, I get this:

Devices with no available firmware updates:
• Fingerprint Sensor
• System Firmware
• UEFI Device Firmware
• UEFI Device Firmware
• UEFI Device Firmware
• UEFI dbx

[Matt_Hartley]

@Dan_Nicholson

My issue of ‘device disconnected’ on the last scan is still present. Following this error the fingerprint scanning UI says ‘…device is already claimed by another process’

I didn’t see a ticket open, let’s get you into a ticket and link this this thread. I suspect we may need to escalate this one.

[Matt_Hartley]

@jlcfan

The instructions provided worked for me up to the updating of the fingerprint reader firmware (confirmed Laptop 13 DIY Edition with 01000320 firmware).

When updating the fingerprint reader firmware with the command above, I get this:

So it did update successfully, then you rebooted and then tried to register a fingerprint, correct?

[jlcfan]

No. The fingerprint reader firmware did not update:

$ fwupdmgr update 1e8c8470-a49c-571a-82fd-19c9fa32b8c3
Devices with no available firmware updates:
• Fingerprint Sensor
• System Firmware
• UEFI Device Firmware
• UEFI Device Firmware
• UEFI Device Firmware
• UEFI dbx
• WD BLACK SN850X 1000GB
No updatable devices

[Evan_Raskob]

@Matt_Hartley

fwupdmgr refresh

I don’t even see the fingerprint reader, although I definitely have it and I’m sure I saw it listed before! Any idea how to check for this?

[Matt_Hartley]

All, if you are finding the reader is not showing up, please provide the output of lsusb to we can see what is happening at the hardware level.

[Matt_Hartley]

To all those who are having issues with your Framework Laptop 13 (13th Gen Intel Core), please provide the output as seen here from Cipher which helps me understand what is happening.

If you are using 11th or 12th gen, this is none of this is needed. This is for those who use 13th Gen Intel Core laptops or have replaced their input kit recently.

[jlcfan]

$ fwupdmgr refresh --force
Updating lvfs-testing
[ ]
Successfully downloaded new metadata: 1 local device supported

$ fwupdmgr get-devices 1e8c8470-a49c-571a-82fd-19c9fa32b8c3
Selected device: Fingerprint Sensor
Framework Laptop (13th Gen Intel Core)
│
└─Fingerprint Sensor:
Device ID: d432baa2162a32c1554ef24bd8281953b9d07c11
Summary: Match-On-Chip fingerprint sensor
Current version: 01000320
Vendor: Goodix (USB:0x27C6)
Install Duration: 10 seconds
Serial Number: UIDXXXXXXXX_XXXX_MOC_B0
GUIDs: 1e8c8470-a49c-571a-82fd-19c9fa32b8c3 ← USB\VID_27C6&PID_609C
34def4c7-9461-5a32-a945-5dde0ca57d88 ← USB\VID_27C6&PID_609C&REV_0100
Device Flags: • Updatable
• Device can recover flash failures
• Signed Payload

$ fwupdmgr update 1e8c8470-a49c-571a-82fd-19c9fa32b8c3
Devices with no available firmware updates:
• Fingerprint Sensor
• System Firmware
• TPS DMC Family
• TPS6598X PD#0
• TPS6598X PD#1
• UEFI Device Firmware
• UEFI Device Firmware
• UEFI Device Firmware
• UEFI dbx
• USB4 Retimer
• USB4 Retimer
• WD BLACK SN850X 1000GB
No updatable devices

$ fprintd-enroll
Using device /net/reactivated/Fprint/Device/0
failed to claim device: GDBus.Error:net.reactivated.Fprint.Error.Internal: Open failed with error: Please update firmware using fwupd

[Matt_Hartley]

Okay, just replicated this myself on an input kit and had the following results.

I too, was unable to update the firmware using LVFS. However, on a whim, decided to try the fingerprint reader anyway. Registered my print without any issues.

---

Those who have found that it seems your stuck on 01000252 firmware, try again to register the fingerprint reader using the GUI as you see in the image. This was on a clean install of Fedora 38, fully updated.

@jlcfan in your instance, please try the GUI as I am getting the same error after I registered my prints using the Users GUI.

Removed my print, re-registered it using the GUI - working here. Skip the CLI and try that please.

[jlcfan]

@Matt_Hartley Success!

I decided to use the manual method as described in your post of August 21 in another thread:

[TRACKING] Fingerprint reader failing to register on 13th gen

Alright, here is updated guidance. Please note the header of the file- if you are not wanting to take this approach or it errors out, please wait for the LVFS update. For earlier beta testers, this is a new cab file - if it failed for you previously: Check sudo cat /usr/share/fwupd/quirks.d/goodixmoc.quirk and make sure both entries are present and there is no duplication. Try the updated instructions linked above.

and managed to update the firmware to 01000330:

├─Fingerprint Sensor:
│     Device ID:          d432baa2162a32c1554ef24bd8281953b9d07c11
│     Summary:            Match-On-Chip fingerprint sensor
│     Current version:    01000330
│     Vendor:             Goodix (USB:0x27C6)
│     Install Duration:   10 seconds
│     Serial Number:      UIDD84A7896_XXXX_MOC_B0
│     GUIDs:              [****]
│     Device Flags:       • Updatable
│                         • Device can recover flash failures
│                         • Signed Payload

Lastly, note:

• Framework Laptop 13" 13th Gen Intel Core
• DIY Edition
• Delivered beginning of September
• MX Linux 23 (Xcfe)

Thanks for your help!

[tolbertm]

@Matt_Hartley Do you know when this update will leave lvfs-testing for lvfs?

[Davvo]

I was able to fix the issue using the manual update posted here by @jlcfan (btw, thank you for bringing that thread to my attention).

• Framework Laptop 13" 13th Gen Intel Core
• DIY Edition
• Delivered end of September
• Pop!_OS 22.04 LTS

[Matt_Hartley]

@jlcfan

and managed to update the firmware to 01000330:

Okay, awesome. We’re taking notes on who the lvfs method is working for and who is not having success with it. Seems the manual method has had a higher degree of success overall at this time. Good feedback.