mirror of
https://github.com/portapack-mayhem/mayhem-firmware.git
synced 2024-11-23 18:15:34 +00:00
Updated Compile firmware (markdown)
GullCode
parent
81c897813c
commit
5bca607e65
@ -13,15 +13,15 @@ If you are using Windows, line endings may produce some errors. For example: `'p
|
||||
|
||||
`git config --global core.autocrlf false`
|
||||
|
||||
You can also check the current configuration by omitting the `false` at the end of the command:
|
||||
You can also check the current configuration by omitting the `false` at the end of the command.
|
||||
|
||||
<img src="img/git_linefeed.png" width="600">
|
||||
[[img/git_linefeed.png|600px]
|
||||
|
||||
**Important:** If you want to collaborate to the project, [Fork the repository](How-to-collaborate#fork-the-repository) to your own account and continue this instructions from your own fork.
|
||||
|
||||
Open Github Desktop, and click "Open with Github Desktop" from the main page of the repository (or your fork), under the button "Code".
|
||||
|
||||
<img src="img/github_clone.png" width="400">
|
||||
[[img/github_clone.png|400px]]
|
||||
|
||||
Finally, create a `build` folder inside of the repository. From Github Desktop, just click "Repository / Show in Explorer" and create an empty folder named `build`. This folder will be used for the compilation output.
|
||||
|
||||
@ -36,7 +36,7 @@ You need to configure the path to the source code from the Volumes of the contai
|
||||
|
||||
Everytime you run the container you prepared in the previous step, it will compile the source and (if successful) leave the results in `build/firmware/`
|
||||
|
||||
<img src="img/Kitematic_uvIvGXRbFR.png" width="600">
|
||||
[[img/Kitematic_uvIvGXRbFR.png|600px]]
|
||||
|
||||
If you have additional questions, please check [this guide](Using-MAC-OS).
|
||||
|
||||
@ -94,11 +94,79 @@ You can use the following _yml _as your template for your CI platform (pipeline
|
||||
`shell: "SH"
|
||||
```
|
||||
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
|
||||
If you decide to [ignore this guide](https://github.com/eried/portapack-mayhem/issues/75) and use the command line instead, you will need to include submodules
|
||||
|
||||
git clone --recurse-submodules --remote-submodules <url>
|
||||
git clone --recurse-submodules --remote-submodules <url>
|
||||
|
||||
|
||||
|
||||
# Using arm on Debian
|
||||
|
||||
* Untested on other linux flavors
|
||||
|
||||
* Thanks to @aj#3566 from discord for it
|
||||
|
||||
* For convenience the compiler will be installed to /opt/build
|
||||
|
||||
* Needed steps
|
||||
1. update a Debian based OS
|
||||
2. install the necessary ARM compiler to /opt/armbin (if not done before)
|
||||
3. make user mayhem dir
|
||||
3. clone mayhem repository from GitHub (if not done before)
|
||||
4. do required modification for python 3 on source
|
||||
5. setup environmental variables for compiler
|
||||
6. create makefile through cmake and compile
|
||||
7. flash the firmware
|
||||
|
||||
* Once done you only need to call 'make firmware' in the /opt/portapack-mayhem/firmware/build directory
|
||||
|
||||
* You can speed up the building process by calling 'make -j 8 firmware' instead, where 8 is the number of physical CPU cores (if you have
|
||||
some compiling errors to check it's better to call it without '-j 8')
|
||||
|
||||
## 1. Update a Debian based OS, install cmake, python, pyyaml (as root)
|
||||
|
||||
apt-get update
|
||||
apt-get install -y git tar wget dfu-util cmake python3 bzip2 curl hackrf python3-distutils python3-setuptools
|
||||
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py; python3 get-pip.py
|
||||
pip install pyyaml
|
||||
|
||||
## 2. Install the necessary ARM compiler to /opt/armbin (as root) (if not done before, root needed if you install it in /opt)
|
||||
|
||||
mkdir /opt/build; cd /opt/build
|
||||
wget -O gcc-arm-none-eabi.tar.bz2 'https://developer.arm.com/-/media/Files/downloads/gnu-rm/9-2020q2/gcc-arm-none-eabi-9-2020-q2-update-x86_64-linux.tar.bz2?revision=05382cca-1721-44e1-ae19-1e7c3dc96118&la=en&hash=D7C9D18FCA2DD9F894FD9F3C3DC9228498FA281A'
|
||||
mkdir armbin
|
||||
tar --strip=1 -xjvf gcc-arm-none-eabi.tar.bz2 -C armbin
|
||||
|
||||
## 3. Create portapack-mayhem directory and give permission to your user
|
||||
|
||||
mkdir /opt/portapack-mahem
|
||||
chown -R my_user:my_usergroup /opt/portapack-mayhem
|
||||
|
||||
## 4. Clone the eried's mayhem repository from GitHub (as user) (if not done before)
|
||||
|
||||
git clone --recurse-submodules https://github.com/eried/portapack-mayhem.git /opt/portapack-mayhem/
|
||||
|
||||
## 5. Replace the python version in libopencm3 to use python3 (as user)
|
||||
|
||||
sed -i 's/env python/env python3/g' /opt/portapack-mayhem/hackrf/firmware/libopencm3/scripts/irq2nvic_h
|
||||
|
||||
## 6. Setup environmental variables for compiler (as user)
|
||||
|
||||
cd /opt/portapack-mayhem/hackrf/firmware
|
||||
mkdir build; cd build
|
||||
PATH=/opt/build/armbin/bin:/opt/build/armbin/lib:$PATH
|
||||
|
||||
## 7. Create makefile through cmake and compile (as user) (it's important to call the PATH cmd in step 5 just before making the cmake)
|
||||
|
||||
cmake -B./ -S../../
|
||||
make firmware
|
||||
|
||||
## 8. Flash the firmware to HackRF
|
||||
|
||||
hackrf_spiflash -w /opt/portapack-mayhem/firmware/build/firmware/portapack-h1_h2-mayhem.bin
|
||||
|
||||
# Debian setup script repository
|
||||
|
||||
If you want to have all these commands in one go, go to https://github.com/GullCode/compile-flash-mayhem and download compile-flash-mayhem.sh and adjust it to fit your needs
|
||||
Loading…
Reference in New Issue
Block a user