FPGA
Flashing Guide
⚠️Modifying FPGA source may have unintended consequences⚠️
Device Compatibility
Overview
The FPGA handles:
- GPIO output
- Connections between board components
- Microphone processing (not provided in source code)
FPGA Source
FPGA source code is located here.
Verilog Cheat Sheet
For refreshers on FPGA Verilog HDL syntax and concepts, check out this cheat sheet.
FPGA Flashing
Below is a guide on how to flash a premade user-provided FPGA bitstream onto the Xilinx Spartan-6 FPGA for the MATRIX Voice.
We first need to install a few prerequisites.
Add the MATRIX repository and key.
curl https://apt.matrix.one/doc/apt-key.gpg | sudo apt-key add - echo "deb https://apt.matrix.one/raspbian $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/matrixlabs.list
Update your repository and packages.
sudo apt-get update sudo apt-get upgrade
Install the required packages.
sudo apt-get install matrixio-creator-init
Reboot your device.
sudo reboot
system_voice.bit file.
sudo mv /usr/share/matrixlabs/matrixio-devices/blob/system_voice.bit /usr/share/matrixlabs/matrixio-devices/blob/system_voice_stock.bit
Copy your built system_voice.bit FPGA bitstream file to the blob folder.
sudo cp /path/to/your/file /usr/share/matrixlabs/matrixio-devices/blob/system_voice.bit
Now you can flash the FPGA.
Reset the FPGA.
echo 26 > /sys/class/gpio/export 2>/dev/null echo out > /sys/class/gpio/gpio26/direction echo 1 > /sys/class/gpio/gpio26/value echo 0 > /sys/class/gpio/gpio26/value echo 1 > /sys/class/gpio/gpio26/value
Flash the SPI Flash bootloader onto FPGA.
xc3sprog -c matrix_voice blob/bscan_spi_s6lx9_ftg256.bit
You should receive the following (may vary due to user-provided file).
XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 774 $ OS: Linux Free software: If you contribute nothing, expect nothing! Feedback on success/failure/enhancement requests: http://sourceforge.net/mail/?group_id=170565 Check Sourceforge for updates: http://sourceforge.net/projects/xc3sprog/develop DNA is 0xf9d61a1ecbb64401
Flash the SPI Flash.
xc3sprog -c matrix_voice -I blob/system_voice.bit
You should receive the following (may vary due to user-provided file).
XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 774 $ OS: Linux Free software: If you contribute nothing, expect nothing! Feedback on success/failure/enhancement requests: http://sourceforge.net/mail/?group_id=170565 Check Sourceforge for updates: http://sourceforge.net/projects/xc3sprog/develop JEDEC: c2 20 0x17 0xc2 Found Macronix MX25L Device, Device ID 0x2017 256 bytes/page, 262144 pages = 67108864 bytes total Verify: Success!
Reset the FPGA.
echo 26 > /sys/class/gpio/export 2>/dev/null echo out > /sys/class/gpio/gpio26/direction echo 1 > /sys/class/gpio/gpio26/value echo 0 > /sys/class/gpio/gpio26/value echo 1 > /sys/class/gpio/gpio26/value
In order to maintain compatibility with the matrixio-creator-init package, you'll need to backup the original voice.version file, and create your own.
cd /usr/share/matrixlabs/matrixio-devices/ sudo mv /usr/share/matrixlabs/matrixio-devices/voice.version /usr/share/matrixlabs/matrixio-devices/voice_stock.version (./fpga_info | grep FPGA) | sudo tee voice.version
Updating the matrixio-creator-init package will cause the stock FPGA bitstream to be flashed upon next boot.
You can stop sudo apt-get upgrade from automatically updating the matrixio-creator-init package with the following command.
sudo apt-mark hold matrixio-creator-init
Power off your device.
sudo poweroff
Wait until the green led on your Raspberry Pi blinks 10 times, then unplug the power cable from your Raspberry Pi.
Plug the power cable back into your Raspberry Pi.
Restore Original Firmware
To restore the original firmware, restore the stock system_voice.bit file in the blob folder.
sudo rm /usr/share/matrixlabs/matrixio-devices/blob/system_voice.bit sudo cp /usr/share/matrixlabs/matrixio-devices/blob/system_voice_stock.bit /usr/share/matrixlabs/matrixio-devices/blob/system_voice.bit
Now you can flash the FPGA.
Reset the FPGA.
echo 26 > /sys/class/gpio/export 2>/dev/null echo out > /sys/class/gpio/gpio26/direction echo 1 > /sys/class/gpio/gpio26/value echo 0 > /sys/class/gpio/gpio26/value echo 1 > /sys/class/gpio/gpio26/value
Flash the SPI Flash bootloader onto FPGA.
xc3sprog -c matrix_voice blob/bscan_spi_s6lx9_ftg256.bit
You should receive the following.
XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 774 $ OS: Linux Free software: If you contribute nothing, expect nothing! Feedback on success/failure/enhancement requests: http://sourceforge.net/mail/?group_id=170565 Check Sourceforge for updates: http://sourceforge.net/projects/xc3sprog/develop DNA is 0xf9d61a1ecbb64401
Flash the SPI Flash.
xc3sprog -c matrix_voice -I blob/system_voice.bit
You should receive the following.
XC3SPROG (c) 2004-2011 xc3sprog project $Rev: 774 $ OS: Linux Free software: If you contribute nothing, expect nothing! Feedback on success/failure/enhancement requests: http://sourceforge.net/mail/?group_id=170565 Check Sourceforge for updates: http://sourceforge.net/projects/xc3sprog/develop JEDEC: c2 20 0x17 0xc2 Found Macronix MX25L Device, Device ID 0x2017 256 bytes/page, 262144 pages = 67108864 bytes total Verify: Success!
Reset the FPGA.
echo 26 > /sys/class/gpio/export 2>/dev/null echo out > /sys/class/gpio/gpio26/direction echo 1 > /sys/class/gpio/gpio26/value echo 0 > /sys/class/gpio/gpio26/value echo 1 > /sys/class/gpio/gpio26/value
Restore the stock voice.version file.
sudo rm /usr/share/matrixlabs/matrixio-devices/voice.version sudo cp /usr/share/matrixlabs/matrixio-devices/voice_stock.version /usr/share/matrixlabs/matrixio-devices/voice.version
Allow sudo apt-get upgrade to update the matrixio-creator-init package.
sudo apt-mark unhold matrixio-creator-init
Power off your device.
sudo poweroff
Wait until the green led on your Raspberry Pi blinks 10 times, then unplug the power cable from your Raspberry Pi.
Plug the power cable back into your Raspberry Pi.