Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Options:
--inputdeck-mode <INPUTDECK_MODE>
Set input deck power mode [possible values: auto, off, on] (Laptop 12, 13, 16) [possible values: auto, off, on]
--expansion-bay
Show status of the expansion bay (Framework 16 only)
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>...
Expand Down Expand Up @@ -141,7 +141,7 @@ Options:

### BIOS (Mainboard, UEFI, EC, PD, Retimer)

Example on Framework 13 AMD Ryzen AI 300 Series:
Example on Laptop 13 AMD Ryzen AI 300 Series:

```
> framework_tool --versions
Expand All @@ -160,7 +160,7 @@ PD Controllers
[...]
```

Example on Framework 13 Intel Core Ultra Series 1:
Example on Laptop 13 Intel Core Ultra Series 1:

```
> framework_tool --versions
Expand All @@ -179,9 +179,9 @@ PD Controllers
[...]
```

### Camera (Framework 12, Framework 13, Framework 16)
### Camera (Laptop 12, Laptop 13, Laptop 16)

Example on Framework 12:
Example on Laptop 12:

```
> framework_tool --versions
Expand All @@ -190,7 +190,7 @@ Framework Laptop 12 Webcam Module
Firmware Version: 0.1.6
```

Example on Framework 13:
Example on Laptop 13:

```
> framework_tool --versions
Expand All @@ -199,7 +199,7 @@ Laptop Webcam Module (2nd Gen)
Firmware Version: 1.1.1
```

### Touchscreen (Framework 12)
### Touchscreen (Laptop 12)

```
> framework_tool --versions
Expand All @@ -209,7 +209,7 @@ Touchscreen
Protocols: USI
```

### Stylus (Framework 12)
### Stylus (Laptop 12)

```
> sudo framework_tool --versions
Expand All @@ -222,7 +222,7 @@ Stylus
[...]
```

### Touchpad (Framework 12, Framework 13, Framework 16)
### Touchpad (Laptop 12, Laptop 13, Laptop 16)

```
> framework_tool --versions
Expand All @@ -231,7 +231,7 @@ Touchpad
Firmware Version: v0E07
```

### Input modules (Framework 16)
### Input modules (Laptop 16)

Shows firmware version and location of the modules.

Expand Down Expand Up @@ -295,7 +295,7 @@ CSME

All systems have at least an entry for BIOS. Intel systems also have CSME and some Retimers.

Example on Framework 13 Intel Core Ultra Series 1:
Example on Laptop 13 Intel Core Ultra Series 1:

```
> sudo framework_tool --esrt
Expand Down Expand Up @@ -343,7 +343,7 @@ ESRT Entry 3

## Check input deck status

### On Framework 12
### On Laptop 12

```
> framework_tool --inputdeck
Expand All @@ -357,7 +357,7 @@ Input Deck
ADC Value 1655mV
```

### On Framework 13
### On Laptop 13

```
> framework_tool --inputdeck
Expand All @@ -371,7 +371,7 @@ Input Deck
Touchpad present: true
```

### On Framework 16
### On Laptop 16

```
> framework_tool --inputdeck
Expand Down Expand Up @@ -420,14 +420,14 @@ Board IDs

## Check sensors

### Ambient Light (Framework 13, Framework 16)
### Ambient Light (Laptop 13, Laptop 16)

```
> sudo framework_tool --sensors
ALS: 76 Lux
```

### Accelerometer (Framework 12)
### Accelerometer (Laptop 12)

```
> sudo framework_tool --sensors
Expand Down Expand Up @@ -474,7 +474,7 @@ Accelerometers:
> sudo framework_tool --autofanctrl 1
```

## Check expansion bay (Framework 16)
## Check expansion bay (Laptop 16)

```
> sudo framework_tool --expansion-bay
Expand All @@ -493,7 +493,7 @@ Expansion Bay

Add `-vv` for more verbose details.

## Check charger and battery status (Framework 12/13/16)
## Check charger and battery status (Laptop 12/13/16)

```
> sudo framework_tool --power
Expand Down Expand Up @@ -629,8 +629,8 @@ Keyboard backlight: 5%

## Fingerprint/Powerbutton brightness

On Framework 13 and Framework 16 the power button has an integrated fingerprint reader, hence the name.
On Framework 12 it does not, but the same command can be used.
On Laptop 13 and Laptop 16 the power button has an integrated fingerprint reader, hence the name.
On Laptop 12 it does not, but the same command can be used.

```
# Check the current brightness
Expand Down Expand Up @@ -671,7 +671,7 @@ sudo framework_tool --rgbkbd 0 0 0 0 0 0 0 0 0
sudo framework_tool --rgbkbd 2 0xFF0000
```

## Stylus (Framework 12)
## Stylus (Laptop 12)

```
> sudo framework_tool --stylus-battery
Expand All @@ -680,15 +680,15 @@ Stylus Battery Strength: 77%

## Remap keyboard

Note that the keyboard matrix on Framework 12 and Framework 13 are
Note that the keyboard matrix on Laptop 12 and Laptop 13 are
different.
The scancodes are the same.

- Left-Ctrl 0x0014
- Left-Alt 0x0014
- Tab 0x0058

### Framework 12
### Laptop 12

```
# Remap capslock key as left-ctrl
Expand All @@ -699,7 +699,7 @@ The scancodes are the same.
> framework_tool --remap-key 6 13 0x0014
```

### Framework 13
### Laptop 13

```
# Remap capslock key as left-ctrl
Expand All @@ -710,7 +710,7 @@ The scancodes are the same.
> framework_tool --remap-key 1 3 0x0014
```

### Framework 16
### Laptop 16

It's not controlled by the EC, use https://keyboard.frame.work.

Expand Down
6 changes: 3 additions & 3 deletions EXAMPLES_ADVANCED.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Keyboard backlight: 0%

### Check PD state

Example on Framework 13 AMD Ryzen AI 300
Example on Framework Laptop 13 AMD Ryzen AI 300

```
> sudo framework_tool.exe --pd-info
Expand Down Expand Up @@ -192,7 +192,7 @@ This command has not been thoroughly tested on all Framework Computer systems
> framework_tool --reboot-ec jump-rw
```

## Flashing Expansion Bay EEPROM (Framework 16)
## Flashing Expansion Bay EEPROM (Framework Laptop 16)

This will render your dGPU unsuable if you flash the wrong file!
It's intended for advanced users who build their own expansion bay module.
Expand All @@ -217,7 +217,7 @@ Wrote 153 bytes to foo.bin

### EC

Note that only since Framework 13 Intel Core Ultra (and later) the version number embedded in the ED binary is meaningful. As you can see below, in this example on Intel Core 12th/13th Gen (hx30) it's always 0.0.1.
Note that only since Framework Laptop 13 Intel Core Ultra (and later) the version number embedded in the ED binary is meaningful. As you can see below, in this example on Intel Core 12th/13th Gen (hx30) it's always 0.0.1.
The commit hash though is accurate and reflects the git commit it was built from.

```
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,16 @@ On UEFI and FreeBSD raw port I/O is used - on Linux this can also be used as a f

| | Port I/O | Linux | Windows |
|---------------------|----------| ------|---------|
| Framework 12 | | | |
| Framework Laptop 12 | | | |
| Intel Core 12th Gen | Yes | [6.12](https://github.com/torvalds/linux/commit/62be134abf4250474a7a694837064bc783d2b291) | Yes |
| Framework 13 | | | |
| Framework Laptop 13 | | | |
| Intel Core 11th Gen | Yes | [6.11](https://github.com/torvalds/linux/commit/04ca0a51f1e63bd553fd4af8e9af0fe094fa4f0a) | Not yet |
| Intel Core 12th Gen | Yes | [6.13](https://github.com/torvalds/linux/commit/dcd59d0d7d51b2a4b768fc132b0d74a97dfd6d6a) | Not yet |
| Intel Core 13th Gen | Yes | [6.13](https://github.com/torvalds/linux/commit/dcd59d0d7d51b2a4b768fc132b0d74a97dfd6d6a) | Not yet |
| AMD Ryzen 7040 | Yes | [6.10](https://github.com/torvalds/linux/commit/c8f460d991df93d87de01a96b783cad5a2da9616) | BIOS 3.16+ |
| Intel Core Ultra S1 | Yes | [6.12](https://github.com/torvalds/linux/commit/62be134abf4250474a7a694837064bc783d2b291) | BIOS 3.06+ |
| AMD Ryzen AI 300 | Yes | [6.12](https://github.com/torvalds/linux/commit/62be134abf4250474a7a694837064bc783d2b291) | Yes |
| Framework 16 | | | |
| Framework Laptop 16 | | | |
| AMD Ryzen 7040 | Yes | [6.10](https://github.com/torvalds/linux/commit/c8f460d991df93d87de01a96b783cad5a2da9616) | BIOS 3.06+ |
| AMD Ryzen AI 300 | Yes | [6.10](https://github.com/torvalds/linux/commit/c8f460d991df93d87de01a96b783cad5a2da9616) | Yes |
| Framework Desktop | | | |
Expand Down
10 changes: 5 additions & 5 deletions framework_lib/src/chromium_ec/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1701,15 +1701,15 @@ impl EcRequest<EcResponseSetGpuSerial> for EcRequestSetGpuSerial {
pub enum BoardIdType {
/// Mainboard - any system
Mainboard = 0,
/// Power button board - Framework 12
/// Power button board - Laptop 12
PowerButtonBoard = 1,
/// Touchpad - Framework 12, 13, 16
/// Touchpad - Laptop 12, 13, 16
Touchpad = 2,
/// Audio Board - Framework 12, 13
/// Audio Board - Laptop 12, 13
AudioBoard = 3,
/// dGPU board - Framework 16
/// dGPU board - Laptop 16
DGpu0 = 4,
/// dGPU board - Framework 16
/// dGPU board - Laptop 16
DGpu1 = 5,
}

Expand Down
2 changes: 1 addition & 1 deletion framework_lib/src/chromium_ec/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ pub enum FrameworkHx20Hx30Adc {
}

/// So far on all Nuvoton/Zephyr EC based platforms
/// Until at least Framework 13 AMD Ryzen AI 300
/// Until at least Framework Laptop 13 AMD Ryzen AI 300
#[repr(u8)]
#[derive(Copy, Clone, Debug)]
pub enum Framework13Adc {
Expand Down
4 changes: 2 additions & 2 deletions framework_lib/src/commandline/clap_std.rs
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ struct ClapCli {
#[arg(long)]
inputdeck_mode: Option<InputDeckModeArg>,

/// Show status of the expansion bay (Framework 16 only)
/// Show status of the expansion bay (Laptop 16 only)
#[arg(long)]
expansion_bay: bool,

Expand Down Expand Up @@ -309,7 +309,7 @@ struct ClapCli {
#[arg(long)]
dump_gpu_descriptor_file: Option<std::path::PathBuf>,

/// Show NVIDIA GPU information (Framework 16 only)
/// Show NVIDIA GPU information (Laptop 16 only)
#[arg(long)]
nvidia: bool,

Expand Down
28 changes: 14 additions & 14 deletions framework_lib/src/commandline/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ fn print_versions(ec: &CrosEc) {
}
}
_err => {
// Only Framework 16 has dGPU support (which has Parade Retimer)
// Only Framework Laptop 16 has dGPU support (which has Parade Retimer)
if smbios::get_platform().and_then(Platform::which_family)
== Some(PlatformFamily::Framework16)
{
Expand Down Expand Up @@ -1361,7 +1361,7 @@ pub fn run_with_args(args: &Cli, _allupdate: bool) -> i32 {
Some(PlatformFamily::Framework16) => ec.print_fw16_inputdeck_status(),
// If we don't know which platform it is, we can use some heuristics
_ => {
// Only Framework 16 has this GPIO
// Only Framework Laptop 16 has this GPIO
if ec.get_gpio("sleep_l").is_ok() {
ec.print_fw16_inputdeck_status()
} else {
Expand Down Expand Up @@ -1874,9 +1874,9 @@ Options:
--s0ix-counter Show S0ix counter
--intrusion Show status of intrusion switch
--inputdeck Show status of the input deck
--inputdeck-mode Set input deck power mode [possible values: auto, off, on] (Framework 12, 13, 16)
--expansion-bay Show status of the expansion bay (Framework 16 only)
--nvidia Show NVIDIA GPU information (Framework 16 only)
--inputdeck-mode Set input deck power mode [possible values: auto, off, on] (Laptop 12, 13, 16)
--expansion-bay Show status of the expansion bay (Laptop 16 only)
--nvidia Show NVIDIA GPU information (Laptop 16 only)
--charge-limit [<VAL>] Get or set battery charge limit (Percentage number as arg, e.g. '100')
--charge-current-limit [<VAL>] Get or set battery current charge limit (Percentage number as arg, e.g. '100')
--charge-rate-limit [<VAL>] Set max charge rate limit
Expand Down Expand Up @@ -2051,26 +2051,26 @@ fn selftest(ec: &CrosEc) -> Option<()> {
}

// Platforms that have Retimers
// Retimer I2C is always connected to the CPU, except for the Framework 16 dGPU retimer.
// Retimer I2C is always connected to the CPU, except for the Framework Laptop 16 dGPU retimer.
//
// - Framework 12
// - Framework Laptop 12
// - No Retimer, only retimer for both left ports (no firmware)
// - Framework 13 Intel
// - Framework Laptop 13 Intel
// - One Intel retimer for each port (with firmware)
// - Framework 13 AMD 7040
// - Framework Laptop 13 AMD 7040
// - Kandou Retimer on top two ports (no firmware)
// - Analogix Retimer on bottom two ports (no firmware)
// - Framework 13 AMD AI 300
// - Framework Laptop 13 AMD AI 300
// - Parade Retimer on top two ports (with firmware)
// - Analogix Retimer on bottom two ports (no firmware)
// - Framework 16 AMD 7040
// - Framework Laptop 16 AMD 7040
// - Kandou Retimer on top two ports (no firmware)
// - Analogix Retimer on lower and middle left ports (no firmware)
// - Framework 16 AMD AI 300
// - Framework Laptop 16 AMD AI 300
// - Parade Retimer on top two ports (with firmware)
// - Framework 16 AMD dGPU
// - Framework Laptop 16 AMD dGPU
// - None
// - Framework 16 NVIDIA dGPU
// - Framework Laptop 16 NVIDIA dGPU
// - Parade Retimer
// - Framework Desktop
// - Parade Retimer on both back ports (with firmware)
Expand Down
Loading