pynvcm is a tool to program the non-volatile configuration memory (NVCM) inside the of a Tillitis' Tkey FPGA (ICE40).
Either clone this repository and run from the Python interpreter or download and run our pre-packed executables from releases.
Note: programming the NVCM is non-reversable.
Note: the NVCM (including the Unique Device Secret) can still be read out unless you set the security bit.
Set up a python virtualenv, unless if you are using the pre-packed executables you can skip this step.
For linux
sudo apt install python3.10-venv
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
for macOS
brew install python3.10
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
for Windows
winget install Python.Python.3.10
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
then run with the appropriate options
usage: pynvcm.py [-h] [-v] [-f] [-b] [--speed SPI_SPEED] [-i] [--read READ_FILE] [--verify VERIFY_FILE] [--write WRITE_FILE] [--ignore-blank] [--secure]
[--my-design-is-good-enough]
options:
-h, --help show this help message and exit
-v, --verbose Show debug information and serial read/writes
-f, --sleep_flash Put an attached SPI flash chip in deep sleep
-b, --boot Deassert the reset line to allow the FPGA to boot
--speed SPI_SPEED SPI clock speed, in MHz
-i, --info Read chip ID, trim and other info
--read READ_FILE Read contents of NVCM
--verify VERIFY_FILE Verify the contents of NVCM
--write WRITE_FILE bitstream file to write to NVCM (warning: not reversable!)
--ignore-blank Proceed even if the chip is not blank
--secure Set security bits to prevent modification (warning: not reversable!)
--my-design-is-good-enough
Enable the dangerous commands --write and --secure
For example to write the NVCM, verify and set the security bit use:
./pynvcm.py --my-design-is-good-enough --write application_fpga.bin --verify application_fpga.bin --ignore-blank --secure
Unless otherwise noted, the project sources are licensed under the terms and conditions of the "ISC license":
Copyright Tillitis AB.
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Some specific files, usually under the same license, have other
origin and copyright holders. pynvcm.py was originally written by:
- Trammell Hudson, hudson@trmm.net
- Matthew Mets, Github
- Peter Lawrence, Github
We keep a LICENSE file to easily autodetect the license.
External source code we have imported are isolated in their own
directories. They may be released under other licenses. This is noted
with a similar LICENSE file in every directory containing imported
sources.
The project uses single-line references to Unique License Identifiers as defined by the Linux Foundation's SPDX project on its own source files, but not necessarily imported files. The line in each individual source file identifies the license applicable to that file.
The current set of valid, predefined SPDX identifiers can be found on the SPDX License List at: