sravan/system76-embedded-controller
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Move flashing to a separate file

Browse Source
This commit is contained in:
Tim Crawford 2020-08-07 15:52:16 -06:00 committed by Jeremy Soller
parent 2414476a66
commit d44d5229ae
2 changed files with 43 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -39,36 +39,23 @@ Acronym | Feature | Description
------- | ---------------------------- | ----------- ------- | ---------------------------- | -----------
USB | Universal serial bus | Can be used to provide access to EC functions either to the host or to a remote machine USB | Universal serial bus | Can be used to provide access to EC functions either to the host or to a remote machine
## Flashing ## Dependencies
Requirements: The complete set of dependencies can be installed using the `deps.sh` script
from the [Open Firmware](https://github.com/system76/firmware-open) repo.
- [sdcc](http://sdcc.sourceforge.net/) Dependencies specific to EC development can be installed with:
- [Rust](https://www.rust-lang.org/)
### Internal programmer
Use this method for flashing a system already running System76 EC.
``` ```
make BOARD=<vendor>/<model> flash_internal sudo apt install \
avr-libc \
avrdude \
gcc-avr \
sdcc
``` ```
### External programmer ## Documentation
Use this method for first-time flashing or flashing a bricked controller. - [flashing](./doc/flashing.md)
- [debugging](./doc/debugging.md)
**The system must not have any power!** - [custom keyboard layout](./doc/keyboard-layout-customization.md)
1. Turn off the computer
2. Unplug the AC adapter
3. Remove the bottom panel
4. Disconnect the battery
5. Ground the laptop to the programmer
6. Disconnect the keyboard from its port
7. Attach the programmer to the keyboard port
8. Flash the firmware
```
make BOARD=<vendor>/<model> flash_external
```

30
doc/flashing.md Normal file
View File

@ -0,0 +1,30 @@
# Flashing firmware
## Internal programmer
Use this method for flashing a system already running System76 EC.
```
make BOARD=<vendor>/<model> flash_internal
```
## External programmer
Use this method for first-time flashing or flashing a bricked controller.
[A Mega 2560 is required for flashing.](./mega2560.md)
**The system must not have any power!**
1. Turn off the computer
2. Unplug the AC adapter
3. Remove the bottom panel
4. Disconnect the battery
5. Ground the laptop to the programmer
6. Disconnect the keyboard from its port
7. Attach the programmer to the keyboard port
8. Flash the firmware
```
make BOARD=<vendor>/<model> flash_external
```