mirror of
https://github.com/portapack-mayhem/mayhem-firmware.git
synced 2024-11-23 18:15:34 +00:00
Revamp upgrade doc WIP
gullradriel
parent
472da7afb1
commit
483b4778b6
@ -1,67 +1,60 @@
|
|||||||
# TLDR
|
# Update firmware
|
||||||
|
|
||||||
The basic procedure:
|
## Common workflow
|
||||||
|
|
||||||
1. Update your SD card content.
|
1. Update your SD card content
|
||||||
2. Update firmware, choose one method:
|
2. Connect USB cable
|
||||||
* Enter HackRF mode, flash with a USB cable.
|
3. Use one of the following methods:
|
||||||
* Use [hackrf.app](https://hackrf.app/) website.
|
* Enter HackRF mode, flash with hackrf_spiflash
|
||||||
* Copy firmware all in one tar package into SD card, and offline update with Flash Utility app in portapack.
|
* Stay in Mayhem mode, use [hackrf.app](https://hackrf.app/) website (this automatically update external sdcard apps corresponding to the firmware version)
|
||||||
|
* Copy firmware all in one tar package into SD card, and offline update with Flash Utility app in portapack (this automatically update external sdcard apps corresponding to the firmware version)
|
||||||
|
|
||||||
> [!Note]
|
### Detailed video guide
|
||||||
>- UNDER v2.0.0 or nightly n_240114, you can only update with HackRF mode with normal procedure
|
|
||||||
>- When downgrading, please make sure SD card content versions match.
|
|
||||||
>- Mayhem firmware contains HackRF firmware. You DO NOT need to flash HackRF firmware.
|
|
||||||
>- In theory, it is impossible to brick the device, since you can always try the DFU recovery procedure. However, the updating might become fiddly in certain conditions. So you probably need basic computer usage knowledge (running/installing software, read documents, knowing USB ports, adjust system settings, reading English, etc.) if you don't, you probably should ask your friends or someone who knows these things to do it for you.
|
|
||||||
|
|
||||||
# Detailed guide
|
|
||||||
|
|
||||||
If you prefer watching a video guide, check [this](https://www.youtube.com/watch?v=qM7Q9IidK2o).
|
If you prefer watching a video guide, check [this](https://www.youtube.com/watch?v=qM7Q9IidK2o).
|
||||||
|
|
||||||
## Firmware
|
# Detailed Firmware Update procedures
|
||||||
|
|
||||||
Get the latest firmware from the [](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page. Please check the [FAQ](https://github.com/portapack-mayhem/mayhem-firmware#frequently-asked-questions).
|
## Using firmware file from github release page and the [Flash Utility](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Flash-Utility)
|
||||||
|
|
||||||
### HackRF/PortaPack itself via Flash Utility
|
- Get the latest firmware from the [](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page
|
||||||
|
|
||||||
|
- Copy it to your SDCARD, put it back in your PortaPack
|
||||||
|
- Flash it via the [Flash Utility](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Flash-Utility) in "Utilities" menu on your PortaPack
|
||||||
> [!Note]
|
> [!Note]
|
||||||
> If you don't see the Flash Utility app, try using other methods to update to latest version.
|
>- If you don't see the Flash Utility app, try using other methods to update to latest version
|
||||||
|
>- The [Flash Utility](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Flash-Utility) can also be used to program new firmware from a bin file stored on a MicroSD card
|
||||||
|
|
||||||
The [Flash Utility](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Flash-Utility) can also be used to program new firmware from a bin file stored on a MicroSD card.
|
## Using firmware file from github release page and the classic hackrf_spiflash tool
|
||||||
|
> [!Note]
|
||||||
|
> :warning: Using that method, you NEED to update the SDCARD content accordingly to the release you choose, else the external apps will not work !
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
1. Connect the device via USB.
|
1. Connect the device via USB.
|
||||||
2. Switch to HackRF mode via the on-screen option. (In the PortaPack)
|
2. Switch to HackRF mode via the on-screen option. (In the PortaPack)
|
||||||
3. Double click `flash_portapack_mayhem.bat` and follow the instructions.
|
3. Double click `flash_portapack_mayhem.bat` and follow the instructions.
|
||||||
4. Reboot the device.
|
4. Reboot the device.
|
||||||
|
|
||||||
### Linux
|
### Linux
|
||||||
|
|
||||||
> [!NOTE]
|
|
||||||
> To Ubuntu and Mint user: Ubuntu based distro never maintains their repo for HackRF host (cli client) package. You’ll face a lot of weird problems if your HackRF is R9.
|
|
||||||
> To resolve these, please compile the HackRF package yourself, or use another distro.
|
|
||||||
|
|
||||||
1. Connect the device via USB
|
1. Connect the device via USB
|
||||||
2. Switch to HackRF mode via the on-screen option. (In the PortaPack)
|
2. Switch to HackRF mode via the on-screen option. (In the PortaPack)
|
||||||
3. Upload the firmware with `hackrf_spiflash -w new_firmware_file.bin` (eg. portapack-h1_h2-mayhem.bin for mayhem firmware or hackrf_one_usb.bin for stock HackRF firmware)
|
3. Upload the firmware with `hackrf_spiflash -w new_firmware_file.bin` (eg. portapack-h1_h2-mayhem.bin for mayhem firmware or hackrf_one_usb.bin for stock HackRF firmware)
|
||||||
4. Reboot the device
|
4. Reboot the device
|
||||||
|
> [!NOTE]
|
||||||
|
>- To Ubuntu and Mint user: Ubuntu based distro never maintains their repo for HackRF host (cli client) package. You’ll face a lot of weird problems if your HackRF is R9. To resolve these, please compile the HackRF package yourself, or use another distro.
|
||||||
|
|
||||||
### MacOS
|
### MacOS
|
||||||
|
|
||||||
_HackRF CLI tools for MacOS available through MacPorts or Homebrew_
|
|
||||||
|
|
||||||
1. If necessary, install the HackRF tools: `brew install hackrf`
|
1. If necessary, install the HackRF tools: `brew install hackrf`
|
||||||
2. Connect the device via USB
|
2. Connect the device via USB
|
||||||
3. Switch to HackRF mode via the on-screen option (in the PortaPack)
|
3. Switch to HackRF mode via the on-screen option (in the PortaPack)
|
||||||
4. Upload the firmware with `hackrf_spiflash -w new_firmware_file.bin`
|
4. Upload the firmware with `hackrf_spiflash -w new_firmware_file.bin`
|
||||||
5. Reboot the device
|
5. Reboot the device
|
||||||
|
|
||||||
## MicroSD card files
|
### Update SDCARD files
|
||||||
|
|
||||||
You need to provide a MicroSD with enough space (16GB is recommended, over 32GB will be omitted due the limits of the FAT32). This is necessary for certain functionality, like the world map, GPS simulator, external apps, and others.
|
You need to provide a MicroSD with enough space (16GB is recommended, over 32GB will be omitted due the limits of the FAT32). This is necessary for certain functionality, like the world map, GPS simulator, external apps, and others.
|
||||||
|
|
||||||
Get the latest files from the [](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page. You need to uncompress (using [7-zip](https://www.7-zip.org/download.html)) the files from `mayhem_vX.Y.Z_COPY_TO_SDCARD.7z` to a FAT32 formatted MicroSD card.
|
Get the latest files from the [](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page. You need to uncompress (using [7-zip](https://www.7-zip.org/download.html)) the files from `mayhem_vX.Y.Z_COPY_TO_SDCARD.7z` to a FAT32 formatted MicroSD card.
|
||||||
|
|
||||||
> [!NOTE]
|
> [!NOTE]
|
||||||
> How to put into SD card?
|
> How to put into SD card?
|
||||||
> Extract the root directory of the 7z archive into the root directory of your SD card.
|
> Extract the root directory of the 7z archive into the root directory of your SD card.
|
||||||
@ -70,11 +63,15 @@ Get the latest files from the [
|
> 
|
||||||
|
|
||||||
|
|
||||||
### External Apps
|
|
||||||
|
|
||||||
External apps (.ppma files in the APPS folder) will only function if their version matches the firmware version.
|
|
||||||
|
|
||||||
# Troubleshooting
|
# Troubleshooting
|
||||||
|
|
||||||
Please check [this guide](Update-firmware-troubleshooting).
|
- Please check [this guide](Update-firmware-troubleshooting)
|
||||||
|
- External apps (.ppma files in the APPS folder) will only function if their version matches the firmware version
|
||||||
|
|
||||||
|
> [!Note]
|
||||||
|
>- Please check the [FAQ](https://github.com/portapack-mayhem/mayhem-firmware#frequently-asked-questions)
|
||||||
|
>- If your fimware version is lower or equal to v2.0.0 or nightly n_240114, you can only update firmware in HackRF mode with classic procedure
|
||||||
|
>- Updating using the hackrf.app website is only working for stable version bigger or equal to v2.0.1, nightly version newer than n_240114
|
||||||
|
>- When downgrading, please make sure SD card content versions match.
|
||||||
|
>- Mayhem firmware contains HackRF firmware. You DO NOT need to flash HackRF firmware.
|
||||||
|
>- In theory, it is impossible to brick the device, since you can always try the DFU recovery procedure. However, the updating might become fiddly in certain conditions. So you probably need basic computer usage knowledge (running/installing software, read documents, knowing USB ports, adjust system settings, reading English, etc.) if you don't, you probably should ask your friends or someone who knows these things to do it for you.
|
||||||
Loading…
Reference in New Issue
Block a user