b7368e8202
Give an overview of the different tools required for development and what they're used for. Signed-off-by: Tim Crawford <tcrawford@system76.com>
67 lines
1.7 KiB
Markdown
67 lines
1.7 KiB
Markdown
# System76 EC
|
|
|
|
System76 EC is a GPLv3 licensed embedded controller firmware for System76
|
|
laptops.
|
|
|
|
## Documentation
|
|
|
|
- [Supported embedded controllers](./doc/controllers.md)
|
|
- [Flashing firmware](./doc/flashing.md)
|
|
- [Debugging](./doc/debugging.md)
|
|
- [Creating a custom keyboard layout](./doc/keyboard-layout-customization.md)
|
|
- [Development environment](./doc/dev-env.md)
|
|
- [Adding a new board](./doc/adding-a-new-board.md)
|
|
|
|
## Quickstart
|
|
|
|
Install dependencies using the provided script.
|
|
|
|
```sh
|
|
./scripts/deps.sh
|
|
```
|
|
|
|
If rustup was installed as part of this, then the correct `cargo` will not be
|
|
available in the running session. Start a new shell session or source the env
|
|
file to update `PATH`.
|
|
|
|
```sh
|
|
source $HOME/.cargo/env
|
|
```
|
|
|
|
Then build the firmware for your laptop model.
|
|
|
|
```sh
|
|
make BOARD=system76/<model>
|
|
```
|
|
|
|
See [Flashing](./doc/flashing.md) for how to use the new firmware image.
|
|
|
|
## Releases
|
|
|
|
The EC firmware itself does not have tagged releases. Any commit of this repo
|
|
may be used as a part of a [System76 Open Firmware][firmware-open] release.
|
|
|
|
In official releases the EC shares the same version as the BIOS firmware. Run
|
|
the follow command from firmware-open to determine the corresponding EC commit
|
|
for a release.
|
|
|
|
```
|
|
git ls-tree <release_hash> ec
|
|
```
|
|
|
|
[firmware-open]: https://github.com/system76/firmware-open
|
|
|
|
## Legal
|
|
|
|
System76 EC is copyright System76 and contributors.
|
|
|
|
System76 EC firmware is made available under the terms of the GNU General
|
|
Public License, version 3. See [LICENSE](./LICENSE) for details.
|
|
|
|
- firmware: GPL-3.0-only
|
|
- ecflash: LGPL-2.1-or-later
|
|
- ecsim: MIT
|
|
- ectool: MIT
|
|
|
|
Datasheets for ITE embedded controllers cannot be shared outside of System76.
|