Scroll to navigation

framework_tool(1) General Commands Manual framework_tool(1)

NAME

framework_tool - Swiss army knife for Framework laptops

SYNOPSIS

framework_tool [--flash-gpu-descriptor] [-v|--verbose]... [-q|--quiet]... [--versions] [--version] [--features] [--esrt] [--device] [--compare-version] [--power] [--smartbattery] [--smartbattery-auth] [--thermal] [--thermalget] [--thermalset] [--sensors] [--fansetduty] [--fansetrpm] [--autofanctrl] [--pdports] [--pdports-chromebook] [--info] [--meinfo] [--pd-info] [--pd-reset] [--pd-disable] [--pd-enable] [--dp-hdmi-info] [--dp-hdmi-update] [--audio-card-info] [--privacy] [--pd-bin] [--ec-bin] [--capsule] [--dump] [--h2o-capsule] [--dump-ec-flash] [--flash-full-ec] [--flash-ec] [--flash-ro-ec] [--flash-rw-ec] [--intrusion] [--inputdeck] [--inputdeck-mode] [--expansion-bay] [--charge-limit] [--charge-current-limit] [--charge-rate-limit] [--get-gpio] [--fp-led-level] [--fp-brightness] [--kblight] [--remap-key] [--rgbkbd] [--tablet-mode] [--touchscreen-enable] [--haptic-intensity] [--click-force] [--stylus-battery] [--console] [--reboot-ec] [--ec-hib-delay] [--sysinfo] [--uptimeinfo] [--s0ix-counter] [--hello] [--protoinfo] [--switches] [--port80read] [--panicinfo] [--hash] [--driver] [--pd-addrs] [--pd-ports] [-t|--test] [--test-retimer] [--boardid] [-f|--force] [--dry-run] [--flash-gpu-descriptor-file] [--dump-gpu-descriptor-file] [--validate-gpu-descriptor-file] [--nvidia] [--host-command] [-h|--help]

DESCRIPTION

framework_tool is a command-line utility for interacting with Framework Computer laptops and desktops.

It communicates with the Embedded Controller (EC) to query firmware versions, battery and USB-C status, thermal data, privacy and intrusion switches, and expansion card details. It can also adjust system settings and flash EC firmware.

Most operations require root privileges.

OPTIONS

Increase logging verbosity
Decrease logging verbosity
List current firmware versions
Show tool version information (Add -vv for more details)
Show features support by the firmware
Display the UEFI ESRT table
Device type to compare the --compare-version string against

Possible values:

  • bios
  • ec
  • pd0
  • pd1
  • rtm01
  • rtm23
  • ac-left
  • ac-right
Version to compare device firmware version with
Show current power status of battery and AC (Add -vv for more details)
Show detailed smart battery information, or load from dump file
Authenticate smart battery (requires unseal and auth keys)
Print thermal information (Temperatures and Fan speed)
Print thermal thresholds of the temperature sensors
Set thermal thresholds of a sensor in degrees Celsius: <SENSOR> <WARN> [<HIGH> [<HALT> [<FAN_OFF> [<FAN_MAX>]]]] (-1 keeps the current threshold, 0 disables it)
Print sensor information (ALS, G-Sensor)
Set fan duty cycle (0-100%)
Set fan RPM (limited by EC fan table max RPM)
Turn on automatic fan speed control
Show USB-C PD port state
Show PD port info (generic Chromium EC)
Show info from SMBIOS (Only on UEFI)
Show Intel ME information (from SMBIOS type 0xDB). Optionally provide a dmidecode binary dump file path
Show details about the PD controllers
Reset a specific PD controller (for debugging only)
Disable all ports on a specific PD controller (for debugging only)
Enable all ports on a specific PD controller (for debugging only)
Show details about connected DP or HDMI Expansion Cards
Update the DisplayPort or HDMI Expansion Card
Show details about connected Audio Expansion Cards (Needs root privileges)
Show privacy switch statuses (camera and microphone)
Parse versions from PD firmware binary file
Parse versions from EC firmware binary file
Parse UEFI Capsule information from binary file
Dump extracted UX capsule bitmap image to a file
Parse UEFI Capsule information from binary file
Dump EC flash contents
Flash full EC flash with new firmware from file - may render your hardware unbootable!
Flash EC (RO+RW) with new firmware from file - may render your hardware unbootable!
Flash EC with new RO firmware from file - may render your hardware unbootable!
Flash EC with new RW firmware from file
Show status of intrusion switch
Show status of the input modules
Set input deck power mode [possible values: auto, off, on, reset] (Laptop 12, 13, 16)

Possible values:

  • auto
  • off
  • on
  • reset
Show status of the expansion bay (Laptop 16 only)
Get or set max charge limit
Set max charge current limit
Set max charge current limit
Get GPIO value by name or all, if no name provided
Get or set fingerprint LED brightness level

Possible values:

  • high
  • medium
  • low
  • ultra-low
  • auto
Get or set fingerprint LED brightness percentage
Set keyboard backlight percentage or get, if no value provided
Remap a key by changing the scancode
Set the color of <key> to <RGB>. Multiple colors for adjacent keys can be set at once. <key> <RGB> [<RGB> ...] Example: 0 0xFF000 0x00FF00 0x0000FF
Set tablet mode override

Possible values:

  • auto
  • tablet
  • laptop
Enable/disable touchscreen

Possible values:

  • true
  • false
Set touchpad haptic feedback intensity

Possible values:

  • 0
  • 25
  • 50
  • 75
  • 100
Set touchpad click force / sensitivity

Possible values:

  • low
  • medium
  • high
Check stylus battery level (USI 2.0 stylus only)
Get EC console, choose whether recent or to follow the output

Possible values:

  • recent
  • follow
Control EC RO/RW jump

Possible values:

  • reboot
  • jump-ro
  • jump-rw
  • cancel-jump
  • disable-jump
Get or set EC hibernate delay (S5 to G3)
Show system info (reset flags, current image, locked state)

Check basic communication with EC
Show EC host command protocol info
Show current EC switch positions (lid, power button, ...)
Show history of port 80 writes (POST codes)
Show saved EC panic info
Hash a file of arbitrary data
Select which driver is used. By default portio is used

Possible values:

  • portio
  • cros-ec
  • windows
Specify I2C addresses of the PD chips (Advanced)
Specify I2C ports of the PD chips (Advanced)
Run self-test to check if interaction with EC is possible
Run self-test to check if interaction with retimers is possible
Print all board IDs
Force execution of an unsafe command - may render your hardware unbootable!
Simulate execution of a command (e.g. --flash-ec)
File to write to the gpu EEPROM
File to dump the gpu EEPROM to
File to validate the gpu EEPROM against
Show NVIDIA GPU information (Laptop 16 only)
Send an EC host command. Args: <CMD_ID> <VERSION> [DATA...]
Print help (see a summary with '-h')

EXAMPLES

List all firmware versions:

# framework_tool --versions

Show battery and AC status:

# framework_tool --power

Get keyboard backlight level:

# framework_tool --kblight

Set keyboard backlight to 50%:

# framework_tool --kblight 50

Set battery charge limit to 80%:

# framework_tool --charge-limit 80

Parse version from EC firmware file:

$ framework_tool --ec-bin ec.bin

Flash EC RW firmware:

# framework_tool --flash-rw-ec ec_rw.bin
framework_tool 0.6.6