table of contents
| 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¶
- --flash-gpu-descriptor
- -v, --verbose
- Increase logging verbosity
- -q, --quiet
- Decrease logging verbosity
- --versions
- List current firmware versions
- --version
- Show tool version information (Add -vv for more details)
- --features
- Show features support by the firmware
- --esrt
- Display the UEFI ESRT table
- --device <DEVICE>
- Device type to compare the --compare-version string against
Possible values:
- bios
- ec
- pd0
- pd1
- rtm01
- rtm23
- ac-left
- ac-right
- --compare-version <COMPARE_VERSION>
- Version to compare device firmware version with
- --power
- Show current power status of battery and AC (Add -vv for more details)
- --smartbattery [<FILE>]
- Show detailed smart battery information, or load from dump file
- --smartbattery-auth
- Authenticate smart battery (requires unseal and auth keys)
- --thermal
- Print thermal information (Temperatures and Fan speed)
- --thermalget
- Print thermal thresholds of the temperature sensors
- --thermalset <THERMALSET>...
- 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)
- --sensors
- Print sensor information (ALS, G-Sensor)
- --fansetduty [<FANSETDUTY>...]
- Set fan duty cycle (0-100%)
- --fansetrpm [<FANSETRPM>...]
- Set fan RPM (limited by EC fan table max RPM)
- --autofanctrl [<AUTOFANCTRL>]
- Turn on automatic fan speed control
- --pdports
- Show USB-C PD port state
- --pdports-chromebook
- Show PD port info (generic Chromium EC)
- --info
- Show info from SMBIOS (Only on UEFI)
- --meinfo [<MEINFO>]
- Show Intel ME information (from SMBIOS type 0xDB). Optionally provide a dmidecode binary dump file path
- --pd-info
- Show details about the PD controllers
- --pd-reset <PD_RESET>
- Reset a specific PD controller (for debugging only)
- --pd-disable <PD_DISABLE>
- Disable all ports on a specific PD controller (for debugging only)
- --pd-enable <PD_ENABLE>
- Enable all ports on a specific PD controller (for debugging only)
- --dp-hdmi-info
- Show details about connected DP or HDMI Expansion Cards
- --dp-hdmi-update <UPDATE_BIN>
- Update the DisplayPort or HDMI Expansion Card
- --audio-card-info
- Show details about connected Audio Expansion Cards (Needs root privileges)
- --privacy
- Show privacy switch statuses (camera and microphone)
- --pd-bin <PD_BIN>
- Parse versions from PD firmware binary file
- --ec-bin <EC_BIN>
- Parse versions from EC firmware binary file
- --capsule <CAPSULE>
- Parse UEFI Capsule information from binary file
- --dump <DUMP>
- Dump extracted UX capsule bitmap image to a file
- --h2o-capsule <H2O_CAPSULE>
- Parse UEFI Capsule information from binary file
- --dump-ec-flash <DUMP_EC_FLASH>
- Dump EC flash contents
- --flash-full-ec <FLASH_FULL_EC>
- Flash full EC flash with new firmware from file - may render your hardware unbootable!
- --flash-ec <FLASH_EC>
- Flash EC (RO+RW) with new firmware from file - may render your hardware unbootable!
- --flash-ro-ec <FLASH_RO_EC>
- Flash EC with new RO firmware from file - may render your hardware unbootable!
- --flash-rw-ec <FLASH_RW_EC>
- Flash EC with new RW firmware from file
- --intrusion
- Show status of intrusion switch
- --inputdeck
- Show status of the input modules
- --inputdeck-mode <INPUTDECK_MODE>
- Set input deck power mode [possible values: auto, off, on, reset] (Laptop
12, 13, 16)
Possible values:
- auto
- off
- on
- reset
- --expansion-bay
- Show status of the expansion bay (Laptop 16 only)
- --charge-limit [<CHARGE_LIMIT>]
- Get or set max charge limit
- --charge-current-limit <CHARGE_CURRENT_LIMIT>...
- Set max charge current limit
- --charge-rate-limit <CHARGE_RATE_LIMIT>...
- Set max charge current limit
- --get-gpio [<GET_GPIO>]
- Get GPIO value by name or all, if no name provided
- --fp-led-level [<FP_LED_LEVEL>]
- Get or set fingerprint LED brightness level
Possible values:
- high
- medium
- low
- ultra-low
- auto
- --fp-brightness [<FP_BRIGHTNESS>]
- Get or set fingerprint LED brightness percentage
- --kblight [<KBLIGHT>]
- Set keyboard backlight percentage or get, if no value provided
- --remap-key <REMAP_KEY>...
- Remap a key by changing the scancode
- --rgbkbd <START> <HEXCOLOR>...
- 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
- --tablet-mode <TABLET_MODE>
- Set tablet mode override
Possible values:
- auto
- tablet
- laptop
- --touchscreen-enable <TOUCHSCREEN_ENABLE>
- Enable/disable touchscreen
Possible values:
- true
- false
- --haptic-intensity <INTENSITY>
- Set touchpad haptic feedback intensity
Possible values:
- 0
- 25
- 50
- 75
- 100
- --click-force <CLICK_FORCE>
- Set touchpad click force / sensitivity
Possible values:
- low
- medium
- high
- --stylus-battery
- Check stylus battery level (USI 2.0 stylus only)
- --console <CONSOLE>
- Get EC console, choose whether recent or to follow the output
Possible values:
- recent
- follow
- --reboot-ec <REBOOT_EC>
- Control EC RO/RW jump
Possible values:
- reboot
- jump-ro
- jump-rw
- cancel-jump
- disable-jump
- --ec-hib-delay [<EC_HIB_DELAY>]
- Get or set EC hibernate delay (S5 to G3)
- --sysinfo
- Show system info (reset flags, current image, locked state)
- --uptimeinfo
- --s0ix-counter
- --hello
- Check basic communication with EC
- --protoinfo
- Show EC host command protocol info
- --switches
- Show current EC switch positions (lid, power button, ...)
- --port80read
- Show history of port 80 writes (POST codes)
- --panicinfo
- Show saved EC panic info
- --hash <HASH>
- Hash a file of arbitrary data
- --driver <DRIVER>
- Select which driver is used. By default portio is used
Possible values:
- portio
- cros-ec
- windows
- --pd-addrs <PD_ADDRS>...
- Specify I2C addresses of the PD chips (Advanced)
- --pd-ports <PD_PORTS>...
- Specify I2C ports of the PD chips (Advanced)
- -t, --test
- Run self-test to check if interaction with EC is possible
- --test-retimer
- Run self-test to check if interaction with retimers is possible
- --boardid
- Print all board IDs
- -f, --force
- Force execution of an unsafe command - may render your hardware unbootable!
- --dry-run
- Simulate execution of a command (e.g. --flash-ec)
- --flash-gpu-descriptor-file <FLASH_GPU_DESCRIPTOR_FILE>
- File to write to the gpu EEPROM
- --dump-gpu-descriptor-file <DUMP_GPU_DESCRIPTOR_FILE>
- File to dump the gpu EEPROM to
- --validate-gpu-descriptor-file <VALIDATE_GPU_DESCRIPTOR_FILE>
- File to validate the gpu EEPROM against
- --nvidia
- Show NVIDIA GPU information (Laptop 16 only)
- --host-command <HOST_COMMAND>...
- Send an EC host command. Args: <CMD_ID> <VERSION> [DATA...]
- -h, --help
- 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 |