aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 13c10a9383195278754f807d673d02943ffd4fc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# smctool

A Linux userspace tool to read Apple SMC keys. Supports various data types and output formats.
This tool is a part of the coreboot project.

### Usage

##### Main options

```
-h, --help:         print help
-k, --key <name>:   key name
-t, --type <type>:  data type, see below
```

##### Output format options:
```
--output-hex:  print value as a hexadecimal number
--output-bin:  print binary representation
```

##### Supported data types
`ui8`, `ui16`, `ui32`, `si8`, `si16`, `flag`, `fpXY`, `spXY`

**fp** and **sp** are unsigned and signed fixed point data types respectively.
The `X` in **fp** and **sp** data types is integer bits count and `Y` is fraction bits count.

For example: `fpe2` means 14 integer bits, 2 fraction bits, `sp78` means 7 integer bits, 8 fraction bits (and one sign bit).

### Examples

Reading battery level:
```
smctool -k B0FC -t ui16  # returns Full Capacity of Battery 0
smctool -k B0RM -t ui16  # returns Remaining Capacity of Batery 0
```

Reading fan speed:
```
smctool -k F0Ac -t fpe2
```

### License

GPLv2