You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ As well as a higher-level abstracted interface for easy access to some of the mo
8
8
9
9
## Installation
10
10
11
-
### Linux
11
+
### Linux & FreeBSD
12
12
13
13
> [!NOTE]
14
14
> Don't forget to read the [permissions](#permissions) section below.
@@ -19,13 +19,13 @@ For a basic installation with full Linux Device support, run:
19
19
pip install cros-ec-python
20
20
```
21
21
22
-
Some interfaces require additional dependencies, for example the LPC interface performs best with the `portio` package:
22
+
Some interfaces require additional dependencies, for example the LPC & MEC interface performs best with the `portio` package:
23
23
24
24
```bash
25
25
pip install cros-ec-python[lpc]
26
26
```
27
27
28
-
#### Permissions
28
+
#### Linux Permissions
29
29
30
30
Since we're playing around with actual hardware, we're going to need some pretty high permissions.
31
31
@@ -56,7 +56,7 @@ It's easiest just to run your script as root.
56
56
> [!NOTE]
57
57
> Loading a driver will likely require administrator permissions, so you may need to run your script as an administrator.
58
58
59
-
The Windows version supports 3 different drivers to access the EC:
59
+
The Windows version supports 3 different drivers to access the EC (only one is required):
60
60
61
61
- The Framework EC driver which is provided in the driver bundles and requires a supported BIOS version. This driver does not require administrator and is the recommended way of using CrOS_EC_Python on supported devices.
62
62
-`PawnIO` which is a fairly new scriptable kernel driver, the official signed version can be downloaded [here](https://pawnio.eu/).
@@ -76,7 +76,7 @@ pip install cros-ec-python
76
76
[PawnIO](https://pawnio.eu/) can be installed using the installer from the website.
77
77
PawnIO is signed and does not require disabling driver signature enforcement.
78
78
79
-
You will also need to download the [`LpcCrOSEC`](https://github.com/namazso/PawnIO.Modules/pull/3) module, and copy it to your working directory.
79
+
You will also need to download the [latest release](https://github.com/namazso/PawnIO.Modules/releases/) of the PawnIO modules and copy `LpcCrOSEC.bin` to your working directory.
80
80
81
81
#### WinRing0
82
82
@@ -125,7 +125,7 @@ pdoc cros_ec_python
125
125
126
126
-[x] Linux Device (Requires the `cros_ec_dev` kernel module)
127
127
-[x] Windows Framework EC Driver
128
-
-[x] Windows [PawnIO](https://pawnio.eu/) using [LpcCrOSEC](https://github.com/namazso/PawnIO.Modules/pull/3)
128
+
-[x] Windows [PawnIO](https://pawnio.eu/) using [LpcCrOSEC](https://github.com/namazso/PawnIO.Modules/releases/)
129
129
-[x] LPC Bus Interface (Soft-requires the [`portio` package](https://pypi.org/project/portio/))
130
130
-[x] MEC LPC Interface (Soft-requires the [`portio` package](https://pypi.org/project/portio/))
0 commit comments