diff --git a/README.md b/README.md index bcd1cd4..64cc513 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,56 @@ # cycloader -tool for programming FPGA. Currently Trenz cyc1000 (memory and spi flash) and -Digilent arty 35T (memory) are supported +tool for programming FPGA. + +Current support: +* Trenz cyc1000 Cyclone 10 LP 10CL025 (memory and spi flash) +* Digilent arty 35T (memory) + +## compile and install + +This application uses libftdi1, so this library must be installed (and, +depending of the distribution, headers too) +```bash +apt-get install libftdi1-2 libftdi1-dev libftdipp1-3 libftdipp1-dev +``` + +To build the app: +```bash +$ make +``` +To install +```bash +$ sudo make install +``` +Currently, the install path is hardcoded to /usr/local + +## Usage + +```bash +cycloader --help +Usage: cycloader [OPTION...] BIT_FILE +cycloader -- a program to flash cyclone10 LP FPGA + + -b, --board=BOARD board name, may be used instead of cable + -c, --cable=CABLE jtag interface + -d, --display display FPGA and EEPROM model + -o, --offset=OFFSET start offset in EEPROM + -r, --reset reset FPGA after operations + -v, --verbose Produce verbose output + -?, --help Give this help list + --usage Give a short usage message + -V, --version Print program version + +``` +To have complete help + +### CYC1000 + +loading in memory: +```bash +cycloader -b cyc1000 /somewhere/file.svf +``` + +SPI flash: +```bash +cycloader -b cyc1000 -r /somewhere/file.rpd +```