68

Update firmware

Micr0byte edited this page 2024-12-19 15:51:53 -05:00

Table of Contents

• Common workflow
• Detailed video guide
• Detailed Firmware Update procedures
• Using firmware file from github release page and the Flash Utility
• Using firmware file from github release page and the classic hackrf_spiflash tool
• Windows
• Linux
• MacOS
• Update SDCARD files
• Using the hackrf.app website
• Procedure
• Troubleshooting

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Common workflow

1. Update your SD card content
2. Connect USB cable
3. Use one of the following methods:
   • Enter HackRF mode, flash with hackrf_spiflash
   • Stay in Mayhem mode, use 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)

Detailed video guide

If you prefer watching a video guide, check this.

Detailed Firmware Update procedures

Using firmware file from github release page and the Flash Utility

• Get the latest firmware from the page

• Copy it to your SDCARD, put it back in your PortaPack

• Flash it via the Flash Utility in "Utilities" menu on your PortaPack

Note

• If you don't see the Flash Utility app, try using other methods to update to latest version
• The 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

⚠️ Using that method, you NEED to update the SDCARD content accordingly to the release you choose, else the external apps will not work !

Windows

1. Connect the device via USB.
2. Switch to HackRF mode via the on-screen option. (In the PortaPack)
3. Double click flash_portapack_mayhem.bat and follow the instructions.
4. Reboot the device.

Linux

1. Connect the device via USB
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)
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

1. If necessary, install the HackRF tools: brew install hackrf
2. Connect the device via USB
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
5. Reboot the device

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 SD reader supporting only SDHC). This is necessary for certain functionality, like the world map, GPS simulator, external apps, and others.

Get the latest files from the page. You need to uncompress (using 7-zip) the files from mayhem_vX.Y.Z_COPY_TO_SDCARD.7z to a FAT32 formatted MicroSD card.

Note

How to put into SD card?
Extract the root directory of the 7z archive into the root directory of your SD card.

• Don't put the 7z archive file directly into your SD card.
• Don't extract into any sub-folder of SD card.
• Don't use unbranded SD card.
  

Using the hackrf.app website

• You need to use a browser compatible with Web USB Serial
• The update using the website is only updating the firmware and external apps on the sdcard. If you want/need a full sdcard content update, please follow first the Update SDCARD files article, then update using the website

Procedure

• Connect portapack using an USB cable with DATA enabled
• Navigate to https://hackrf.app/
• If never done, click on "Connect Device"

• On the little pop up, select your Portapack, click 'Connect'

• You should see "HackRF Connected" on top of the page, and the Live Screen will load the first screenshot
• Scroll down to "Manage Firmware", and click it

• Choose the firmware version to install (stable, nightly, or from a custom ppfw file)

• Wait for the file to be uploaded, and for your device to automatically reboot
• Done !

Troubleshooting

• Please check this guide
• External apps (.ppma files in the APPS folder) will only function if their version matches the firmware version
• Please check the FAQ
• 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.

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Start here

How to collaborate
How to ask questions correctly

User manual

• First steps
  • About firmwares
  • Redirections on this manual/project
• Usage cautions
• Intended use and Legality
• Features
• PortaPack Versions (which one to buy)
• HackRF Versions
  • Original GSG HackRF One
  • Clifford's-version
• Firmware update procedure
  • Updating the Xilinx CPLD on hackrf board
• Description of the hardware
  • Enclosure/cases
    • 3d printed enclosure
  • Internal speaker
  • SMD buttons and caps
  • Encoder knob
  • SMA Connector replacement or removal
• User interface
  • Splash screen
  • Title bar
  • Main menu
  • Main Controls
  • SD Card content and modification
  • Text Entry
• Powering the PortaPack
• Troubleshooting
  • Won't boot
  • Config Menu
  • Firmware upgrade
  • Diagnose firmware update in Windows
  • Receive Quality Issues
  • No TX/RX
  • TX Carrier Only
  • H2+ speaker modifications
  • Dead Coin Cell Battery
  • Factory Defaults
  • SD card not recognized by PC with the SD-card over USB selected
  • DFU overlay
  • Full reset
  • SolveBoard
  • How to Format SDCard
• Applications
  • Receivers
    • ADS-B
    • AFSK
    • AIS Boats
    • Analog TV
    • APRS
    • Audio
    • BLE RX
    • ERT Meter
    • Level
    • NRF
    • POCSAG
    • Radiosonde
    • Recon
    • Search
    • TPMS Cars
    • Weather/SubGhzD
    • Fox-Hunt
    • ProtoView
  • Transmitters
    • ADS-B(S)
    • APRS
    • BHT Xy/EP
    • BLE TX
    • Burger Pager
    • GPS Sim
    • Jammer
    • LGE Tool
    • Morse
    • OOK
    • OOK Editor
    • POCSAG
    • RDS
    • Soundboard
    • Spectrum Painter
    • SSTV
    • TEDI/LCR
    • TouchTunes
    • BLESpam
  • Capture
    • C16 Format
  • Replay
  • Remote
  • Scanner
  • Microphone Transceiver
  • Looking Glass
  • Utilities
    • Antenna length
    • File manager
    • Freq manager
    • Notepad
    • IQ Trim
    • SD over USB
    • Signal gen
    • Wav Viewer
    • Flash Utility
    • Wipe SD card
    • Pac-Man
    • WardriveMap
    • Random password
  • Settings
    • App Settings
    • Audio
    • Blacklist
    • Calibration
    • Touchscreen Threshold
    • Config Mode
    • Converter
    • Date/time
    • Encoder Dial
    • Freq. Correct
    • P.Mem Mgmt
    • QR code
    • Radio
    • User Interface
    • Brightness
    • Menu Color
  • Debug
    • Memory Usage
    • SD Card
    • Peripherals
    • Temperature
    • Buttons Test
    • Touch Test
    • P.Memory
    • Debug Dump
    • M0 Stack Dump
    • Fonts Viewer
    • Audio Test
  • HackRF Mode
  • USB Serial Console

Developer Manual

• Compilation of the firmware
  • Compile on WSL with ninja
  • How to compile on Windows faster with WSL 2
  • Using Docker and Kitematic
  • Docker command-line reference
  • Using Buddyworks and other CI platforms
  • Notes for Buddy.Works (and other CI platforms)
  • Using ARM on Debian host
  • All in one script for ARM on Debian host
  • Compile on Arch based distro (exclude Asahi)
  • Dev build versions
  • Notes About ccache
• Create a custom map
• Code formatting
• PR process
• Description of the Structure
  • At First Glance
  • Boot Process
  • Firmware Architecture
  • Persistent Memory
  • ChibiOS Notes
• Software Dev Guides
  • Code contribution rules
  • Create a Simple App
  • Building External Apps
  • Widgets
  • SD Card
  • Access Radio Hardware
  • Interpret Guru meditation crashes
  • Create a Complex App
  • Theme-system
  • Debug via SWD & JTAG
  • Debug with serial
  • I2C drivers
• Tools
  • make_airlines_db.py
  • make_icao24_db.py
  • world_map.bin
  • converter
  • Bitmap reverse decode
• Research
  • Dissecting the Temperature Logger
  • Differences between H1 and H2
• UI Screenshots
• Maintaining
  • Creating a prod/stable release (Maintainers only)
  • Maintaining rules
• Development States Notes
  • Work Needed (Future Enhancement Suggestions)
  • External App Roadmap
  • SD card

Hardware Hacks

• Repairs
  • Replace AMP
• Mods
  • Add GPIO TO H2
  • USB‐C charging modification for older HackRF boards

Note

The wiki is incomplete. Please add content and collaborate.

Important

• This is a public wiki. Everything is visible to everyone. Don't use it for personal notes.
• Avoid linking to external tutorials/articles; they may become outdated or contain false information.