colognechip integration: initial commit

This commit adds support for the Cologne Chip GateMate FPGA series. Both
Evaluation Board and Programmer Cable are supported. Configurations can be
loaded into the FPGA with both devices via JTAG or SPI. In addition to
reading/writing data from/to flashes directly via SPI, this can also be done
via the built-in JTAG-SPI-bypass. A direct wiring between programming hardware
and flash is no longer necessary in this case.

Signed-off-by: Patrick Urban <[email protected]>
This commit is contained in:
Patrick Urban
2021-12-10 12:12:32 +01:00
parent e182a53659
commit d09e5da0ba
13 changed files with 672 additions and 3 deletions
+5
View File
@@ -120,6 +120,11 @@ static std::map <std::string, target_board_t> board_list = {
SPI_BOARD("fireant", "efinix", "ft232",
DBUS4, DBUS5, 0, DBUS3, DBUS0, DBUS1, DBUS2, DBUS6, 0, CABLE_DEFAULT),
DFU_BOARD("fomu", "", "dfu", 0x1209, 0x5bf0, 0),
SPI_BOARD("gatemate_pgm_spi", "colognechip", "gatemate_pgm",
DBUS4, DBUS5, CBUS0, DBUS3, DBUS0, DBUS1, DBUS2, 0, 0, CABLE_DEFAULT),
JTAG_BOARD("gatemate_evb_jtag", "", "gatemate_evb_jtag", 0, 0, CABLE_DEFAULT),
SPI_BOARD("gatemate_evb_spi", "colognechip", "gatemate_evb_spi",
DBUS4, DBUS5, CBUS0, DBUS3, DBUS0, DBUS1, DBUS2, 0, 0, CABLE_DEFAULT),
/* most ice40 boards uses the same pinout */
SPI_BOARD("ice40_generic", "lattice", "ft2232",
DBUS7, DBUS6, 0,
+3
View File
@@ -38,6 +38,9 @@ static std::map <std::string, cable_t> cable_list = {
{"bus_blaster_b", {MODE_FTDI_SERIAL, {0x0403, 0x6010, INTERFACE_B, 0x08, 0x0B, 0x08, 0x0B}}},
{"ch552_jtag", {MODE_FTDI_SERIAL, {0x0403, 0x6010, INTERFACE_A, 0x08, 0x0B, 0x08, 0x0B}}},
{"cmsisdap", {MODE_CMSISDAP, {0x0d28, 0x0204, 0, 0, 0, 0, 0 }}},
{"gatemate_pgm", {MODE_FTDI_SERIAL, {0x0403, 0x6014, INTERFACE_A, 0x10, 0x9B, 0x14, 0x17}}},
{"gatemate_evb_jtag", {MODE_FTDI_SERIAL, {0x0403, 0x6010, INTERFACE_A, 0x10, 0x1B, 0x00, 0x01}}},
{"gatemate_evb_spi", {MODE_FTDI_SERIAL, {0x0403, 0x6010, INTERFACE_B, 0x00, 0x1B, 0x00, 0x01}}},
{"dfu", {MODE_DFU, {}}},
{"digilent", {MODE_FTDI_SERIAL, {0x0403, 0x6010, INTERFACE_A, 0xe8, 0xeb, 0x00, 0x60}}},
{"digilent_b", {MODE_FTDI_SERIAL, {0x0403, 0x6010, INTERFACE_B, 0xe8, 0xeb, 0x00, 0x60}}},
+445
View File
@@ -0,0 +1,445 @@
// SPDX-License-Identifier: Apache-2.0
/*
* Copyright (C) 2021 Gwenhael Goavec-Merou <[email protected]>
* Copyright (C) 2021 Cologne Chip AG <[email protected]>
*/
#include "colognechip.hpp"
#define JTAG_CONFIGURE 0x06
#define JTAG_SPI_BYPASS 0x05
#define SLEEP_US 500
CologneChip::CologneChip(FtdiSpi *spi, const std::string &filename,
const std::string &file_type, Device::prog_type_t prg_type,
uint16_t rstn_pin, uint16_t done_pin, uint16_t failn_pin, uint16_t oen_pin,
bool verify, int8_t verbose) :
Device(NULL, filename, file_type, verify, verbose), _rstn_pin(rstn_pin),
_done_pin(done_pin), _failn_pin(failn_pin), _oen_pin(oen_pin)
{
_spi = spi;
_spi->gpio_set_input(_done_pin | _failn_pin);
_spi->gpio_set_output(_rstn_pin | _oen_pin);
if (prg_type == Device::WR_SRAM) {
_mode = Device::MEM_MODE;
}
else {
_mode = Device::FLASH_MODE;
}
}
CologneChip::CologneChip(Jtag* jtag, const std::string &filename,
const std::string &file_type, Device::prog_type_t prg_type,
const std::string &board_name, const std::string &cable_name,
bool verify, int8_t verbose) :
Device(jtag, filename, file_type, verify, verbose)
{
/* check which cable/board we're using in order to select pin definitions */
std::string spi_board_name;
if (board_name != "-") {
spi_board_name = std::regex_replace(board_name, std::regex("jtag"), "spi");
}
else if (cable_name == "gatemate_pgm") {
spi_board_name = "gatemate_pgm_spi";
}
target_board_t *spi_board = &(board_list[spi_board_name]);
cable_t *spi_cable = &(cable_list[spi_board->cable_name]);
/* pin configurations valid for both evaluation board and programer */
_rstn_pin = spi_board->reset_pin;
_done_pin = spi_board->done_pin;
_failn_pin = DBUS6;
_oen_pin = spi_board->oe_pin;
/* cast _jtag->_jtag from JtagInterface to FtdiJtagMPSSE to access GPIO */
_ftdi_jtag = reinterpret_cast<FtdiJtagMPSSE *>(_jtag->_jtag);
_ftdi_jtag->gpio_set_input(_done_pin | _failn_pin);
_ftdi_jtag->gpio_set_output(_rstn_pin | _oen_pin);
if (prg_type == Device::WR_SRAM) {
_mode = Device::MEM_MODE;
}
else {
_mode = Device::FLASH_MODE;
}
}
/**
* Enable outputs and hold FPGA in active hardware reset for SLEEP_US.
*/
void CologneChip::reset()
{
if (_spi)
{
_spi->gpio_clear(_rstn_pin | _oen_pin);
usleep(SLEEP_US);
_spi->gpio_set(_rstn_pin);
}
else if (_ftdi_jtag)
{
_ftdi_jtag->gpio_clear(_rstn_pin | _oen_pin);
usleep(SLEEP_US);
_ftdi_jtag->gpio_set(_rstn_pin);
}
}
/**
* Obtain CFG_DONE and ~CFG_FAILED signals. Configuration is successfull iff
* CFG_DONE=true and ~CFG_FAILED=false.
*/
bool CologneChip::cfgDone()
{
uint16_t status = 0;
if (_spi) {
status = _spi->gpio_get(true);
}
else if (_ftdi_jtag) {
status = _ftdi_jtag->gpio_get(true);
}
bool done = (status & _done_pin) > 0;
bool fail = (status & _failn_pin) == 0;
return (done && !fail);
}
/**
* Dump flash contents to file. Works in both SPI and JTAG-SPI-bypass mode.
*/
bool CologneChip::dumpFlash(const std::string &filename, uint32_t base_addr,
uint32_t len)
{
if (_spi) {
/* enable output and hold reset */
_spi->gpio_clear(_rstn_pin | _oen_pin);
}
else if (_ftdi_jtag) {
/* enable output and disable reset */
_ftdi_jtag->gpio_clear(_oen_pin);
_ftdi_jtag->gpio_set(_rstn_pin);
}
/* prepare SPI access */
printInfo("Read Flash ", false);
try {
SPIFlash *flash;
if (_spi) {
flash = new SPIFlash(reinterpret_cast<SPIInterface *>(_spi), _verbose);
}
else if (_ftdi_jtag) {
flash = new SPIFlash(this, _verbose);
}
flash->reset();
flash->power_up();
flash->dump(filename, base_addr, len);
} catch (std::exception &e) {
printError("Fail");
printError(std::string(e.what()));
return false;
}
if (_spi) {
/* disable output and release reset */
_spi->gpio_set(_rstn_pin | _oen_pin);
}
else if (_ftdi_jtag) {
/* disable output */
_ftdi_jtag->gpio_set(_oen_pin);
}
usleep(SLEEP_US);
return true;
}
/**
* Parse bitstream from *.bit or *.cfg and program FPGA in SPI or JTAG mode
* or write configuration to external flash via SPI or JTAG-SPI-bypass.
*/
void CologneChip::program(unsigned int offset)
{
ConfigBitstreamParser *cfg;
if (_file_extension == "bit") {
cfg = new RawParser(_filename, false);
}
else if (_file_extension == "cfg") {
cfg = new CologneChipCfgParser(_filename, false);
}
cfg->parse();
uint8_t *data = cfg->getData();
int length = cfg->getLength() / 8;
switch (_mode) {
case Device::FLASH_MODE:
if (_jtag != NULL) {
programJTAG_flash(offset, data, length);
}
else if (_jtag == NULL) {
programSPI_flash(offset, data, length);
}
break;
case Device::MEM_MODE:
if (_jtag != NULL) {
programJTAG_sram(data, length);
}
else if (_jtag == NULL) {
programSPI_sram(data, length);
}
break;
}
}
/**
* Write configuration into FPGA latches via SPI after active reset.
* CFG_MD[3:0] must be set to 0x40 (SPI passive).
*/
void CologneChip::programSPI_sram(uint8_t *data, int length)
{
uint32_t timeout = 1000;
/* hold device in reset for a moment */
reset();
uint8_t *recv = new uint8_t[length];
_spi->gpio_set(_rstn_pin);
_spi->spi_put(data, recv, length); // TODO _spi->spi_put(data, null, length) does not work?
printInfo("Wait for CFG_DONE ", false);
do {
timeout--;
usleep(SLEEP_US);
} while (!cfgDone() && timeout > 0);
if (timeout == 0) {
printError("FAIL");
}
else {
printSuccess("DONE");
}
_spi->gpio_set(_oen_pin);
delete [] recv;
}
/**
* Write configuration to flash via SPI while FPGA is in active reset. When
* done, release reset to start FPGA in active SPI mode (load from flash).
* CFG_MD[3:0] must be set to 0x00 (SPI active).
*/
void CologneChip::programSPI_flash(unsigned int offset, uint8_t *data, int length)
{
uint32_t timeout = 1000;
/* hold device in reset during flash write access */
_spi->gpio_clear(_rstn_pin | _oen_pin);
usleep(SLEEP_US);
SPIFlash flash(reinterpret_cast<SPIInterface *>(_spi), _verbose);
flash.reset();
flash.power_up();
printf("%02x\n", flash.read_status_reg());
flash.read_id();
flash.erase_and_prog(offset, data, length);
/* verify write if required */
if (_verify)
flash.verify(offset, data, length);
_spi->gpio_set(_rstn_pin);
usleep(SLEEP_US);
printInfo("Wait for CFG_DONE ", false);
do {
timeout--;
usleep(SLEEP_US);
} while (!cfgDone() && timeout > 0);
if (timeout == 0) {
printError("FAIL");
}
else {
printSuccess("DONE");
}
_spi->gpio_set(_oen_pin);
}
/**
* Write configuration into FPGA latches via JTAG after active reset.
* CFG_MD[3:0] must be set to 0xF0 (JTAG).
*/
void CologneChip::programJTAG_sram(uint8_t *data, int length)
{
uint32_t timeout = 1000;
/* hold device in reset for a moment */
reset();
_jtag->set_state(Jtag::RUN_TEST_IDLE);
uint8_t tmp[1024];
int size = 1024;
_jtag->shiftIR(JTAG_CONFIGURE, 6, Jtag::SELECT_DR_SCAN);
//ProgressBar progress("Loading", length, 50, _quiet);
for (int i = 0; i < length; i += size) {
//progress.display(i);
if (length < i + size)
size = length-i;
for (int ii = 0; ii < size; ii++)
tmp[ii] = data[i+ii];
_jtag->shiftDR(tmp, NULL, size*8, Jtag::SHIFT_DR);
}
//progress.done();
_jtag->set_state(Jtag::RUN_TEST_IDLE);
printInfo("Wait for CFG_DONE ", false);
do {
timeout--;
usleep(SLEEP_US);
} while (!cfgDone() && timeout > 0);
if (timeout == 0) {
printError("FAIL");
}
else {
printSuccess("DONE");
}
_ftdi_jtag->gpio_set(_oen_pin);
}
/**
* Write configuration to flash via JTAG-SPI-bypass. The FPGA will not start
* as it is in JTAG mode with CFG_MD[3:0] set to 0xF0 (JTAG).
*/
void CologneChip::programJTAG_flash(unsigned int offset, uint8_t *data, int length)
{
/* hold device in reset for a moment */
reset();
SPIFlash flash(this, _verbose);
flash.reset();
flash.power_up();
printf("%02x\n", flash.read_status_reg());
flash.read_id();
flash.erase_and_prog(offset, data, length);
/* verify write if required */
if (_verify)
flash.verify(offset, data, length);
_ftdi_jtag->gpio_set(_oen_pin);
}
/**
* Overrides spi_put() to access SPI components via JTAG-SPI-bypass.
*/
int CologneChip::spi_put(uint8_t cmd, uint8_t *tx, uint8_t *rx, uint32_t len)
{
int xfer_len = len + 1;
uint8_t jtx[xfer_len+2];
uint8_t jrx[xfer_len+2];
jtx[0] = ConfigBitstreamParser::reverseByte(cmd);
if (tx != NULL) {
for (uint32_t i=0; i < len; i++)
jtx[i+1] = ConfigBitstreamParser::reverseByte(tx[i]);
}
_jtag->shiftIR(JTAG_SPI_BYPASS, 6, Jtag::SELECT_DR_SCAN);
int test = (rx == NULL) ? 8*xfer_len+1 : 8*xfer_len+2;
_jtag->shiftDR(jtx, (rx == NULL)? NULL: jrx, test, Jtag::SELECT_DR_SCAN);
if (rx != NULL) {
for (uint32_t i=0; i < len; i++) {
uint8_t b0 = ConfigBitstreamParser::reverseByte(jrx[i+1]);
uint8_t b1 = ConfigBitstreamParser::reverseByte(jrx[i+2]);
rx[i] = (b0 << 1) | ((b1 >> 7) & 0x01);
}
}
return 0;
}
/**
* Overrides spi_put() to access SPI components via JTAG-SPI-bypass.
*/
int CologneChip::spi_put(uint8_t *tx, uint8_t *rx, uint32_t len)
{
int xfer_len = len;
uint8_t jtx[xfer_len+2];
uint8_t jrx[xfer_len+2];
if (tx != NULL) {
for (uint32_t i=0; i < len; i++)
jtx[i] = ConfigBitstreamParser::reverseByte(tx[i]);
}
_jtag->shiftIR(JTAG_SPI_BYPASS, 6, Jtag::SELECT_DR_SCAN);
_jtag->shiftDR(jtx, (rx == NULL)? NULL: jrx, 8*xfer_len+1, Jtag::SELECT_DR_SCAN);
if (rx != NULL) {
for (uint32_t i=0; i < len; i++) {
uint8_t b0 = ConfigBitstreamParser::reverseByte(jrx[i]);
uint8_t b1 = ConfigBitstreamParser::reverseByte(jrx[i+1]);
rx[i] = (b0 << 1) | ((b1 >> 7) & 0x01);
}
}
return 0;
}
/**
* Overrides spi_put() to access SPI components via JTAG-SPI-bypass.
*/
int CologneChip::spi_wait(uint8_t cmd, uint8_t mask, uint8_t cond,
uint32_t timeout, bool verbose)
{
uint8_t rx[2];
uint8_t dummy[2];
uint8_t tmp;
uint8_t tx = ConfigBitstreamParser::reverseByte(cmd);
uint32_t count = 0;
_jtag->shiftIR(JTAG_SPI_BYPASS, 6, Jtag::SHIFT_DR);
_jtag->read_write(&tx, NULL, 8, 0);
do {
if (count == 0) {
_jtag->read_write(dummy, rx, 9, 0);
uint8_t b0 = ConfigBitstreamParser::reverseByte(rx[0]);
uint8_t b1 = ConfigBitstreamParser::reverseByte(rx[1]);
tmp = (b0 << 1) | ((b1 >> 7) & 0x01);
}
else {
_jtag->read_write(dummy, rx, 8, 0);
tmp = ConfigBitstreamParser::reverseByte(rx[0]);
}
count++;
if (count == timeout) {
printf("timeout: %x %u\n", tmp, count);
break;
}
if (verbose) {
printf("%x %x %x %u\n", tmp, mask, cond, count);
}
} while ((tmp & mask) != cond);
_jtag->set_state(Jtag::RUN_TEST_IDLE);
if (count == timeout) {
printf("%x\n", tmp);
std::cout << "wait: Error" << std::endl;
return -ETIME;
} else {
return 0;
}
}
+61
View File
@@ -0,0 +1,61 @@
// SPDX-License-Identifier: Apache-2.0
/*
* Copyright (C) 2021 Gwenhael Goavec-Merou <[email protected]>
* Copyright (C) 2021 Cologne Chip AG <[email protected]>
*/
#ifndef SRC_COLOGNECHIP_HPP_
#define SRC_COLOGNECHIP_HPP_
#include <unistd.h>
#include <regex>
#include "device.hpp"
#include "jtag.hpp"
#include "ftdispi.hpp"
#include "ftdiJtagMPSSE.hpp"
#include "rawParser.hpp"
#include "colognechipCfgParser.hpp"
#include "spiFlash.hpp"
class CologneChip: public Device, SPIInterface {
public:
CologneChip(FtdiSpi *spi, const std::string &filename,
const std::string &file_type, Device::prog_type_t prg_type,
uint16_t rstn_pin, uint16_t done_pin, uint16_t failn_pin, uint16_t oen_pin,
bool verify, int8_t verbose);
CologneChip(Jtag* jtag, const std::string &filename,
const std::string &file_type, Device::prog_type_t prg_type,
const std::string &board_name, const std::string &cable_name,
bool verify, int8_t verbose);
~CologneChip() {}
bool cfgDone();
bool dumpFlash(const std::string &filename, uint32_t base_addr, uint32_t len);
void program(unsigned int offset = 0) override;
int idCode() override {return 0;}
void reset() override;
private:
void programSPI_sram(uint8_t *data, int length);
void programSPI_flash(unsigned int offset, uint8_t *data, int length);
void programJTAG_sram(uint8_t *data, int length);
void programJTAG_flash(unsigned int offset, uint8_t *data, int length);
/* spi interface via jtag */
int spi_put(uint8_t cmd, uint8_t *tx, uint8_t *rx,
uint32_t len) override;
int spi_put(uint8_t *tx, uint8_t *rx, uint32_t len) override;
int spi_wait(uint8_t cmd, uint8_t mask, uint8_t cond, uint32_t timeout,
bool verbose=false) override;
FtdiSpi *_spi = NULL;
FtdiJtagMPSSE *_ftdi_jtag = NULL;
uint16_t _rstn_pin;
uint16_t _done_pin;
uint16_t _failn_pin;
uint16_t _oen_pin;
};
#endif // SRC_COLOGNECHIP_HPP_
+31
View File
@@ -0,0 +1,31 @@
// SPDX-License-Identifier: Apache-2.0
/*
* Copyright (C) 2021 Gwenhael Goavec-Merou <[email protected]>
* Copyright (C) 2021 Cologne Chip AG <[email protected]>
*/
#include <sstream>
#include "colognechipCfgParser.hpp"
CologneChipCfgParser::CologneChipCfgParser(const std::string &filename, bool reverseOrder):
ConfigBitstreamParser(filename, ConfigBitstreamParser::ASCII_MODE,
false), _reverseOrder(reverseOrder)
{}
int CologneChipCfgParser::parse()
{
std::string buffer;
std::istringstream lineStream(_raw_data);
while (std::getline(lineStream, buffer, '\n')) {
std::string val = buffer.substr(0, buffer.find("//"));
val.erase(std::remove_if(val.begin(), val.end(), ::isspace), val.end());
if (val != "") {
_bit_data += std::stol(val, nullptr, 16);
}
}
_bit_length = _bit_data.size() * 8;
return EXIT_SUCCESS;
}
+25
View File
@@ -0,0 +1,25 @@
// SPDX-License-Identifier: Apache-2.0
/*
* Copyright (C) 2021 Gwenhael Goavec-Merou <[email protected]>
* Copyright (C) 2021 Cologne Chip AG <[email protected]>
*/
#ifndef SRC_COLOGNECHIPCFGPARSER_HPP_
#define SRC_COLOGNECHIPCFGPARSER_HPP_
#include <string>
#include <algorithm>
#include "configBitstreamParser.hpp"
class CologneChipCfgParser: public ConfigBitstreamParser {
public:
CologneChipCfgParser(const std::string &filename, bool reverseOrder);
int parse() override;
private:
bool _reverseOrder;
};
#endif // SRC_COLOGNECHIPCFGPARSER_HPP_
+1 -1
View File
@@ -20,7 +20,7 @@
* \author Gwenhael Goavec-Merou
*/
class FtdiJtagMPSSE : public JtagInterface, private FTDIpp_MPSSE {
class FtdiJtagMPSSE : public JtagInterface, public FTDIpp_MPSSE {
public:
FtdiJtagMPSSE(const FTDIpp_MPSSE::mpsse_bit_config &cable, std::string dev,
const std::string &serial, uint32_t clkHZ, uint8_t verbose = 0);
+1 -1
View File
@@ -136,7 +136,7 @@ int Jtag::detectChain(int max_dev)
for (int ii=0; ii < 4; ii++)
tmp |= (rx_buff[ii] << (8*ii));
if (tmp != 0 && tmp != 0xffffffff) {
tmp &= 0x0fffffff;
tmp &= 0xffffffff;
_devices_list.insert(_devices_list.begin(), tmp);
/* search for irlength in fpga_list or misc_dev_list */
+2 -1
View File
@@ -92,6 +92,8 @@ class Jtag {
/* utilities */
void setVerbose(int8_t verbose){_verbose = verbose;}
JtagInterface *_jtag;
private:
void init_internal(cable_t &cable, const std::string &dev, const std::string &serial,
const jtag_pins_conf_t *pin_conf, uint32_t clkHZ,
@@ -102,7 +104,6 @@ class Jtag {
int _num_tms;
unsigned char *_tms_buffer;
std::string _board_name;
JtagInterface *_jtag;
int device_index; /*!< index for targeted FPGA */
std::vector<int32_t> _devices_list; /*!< ordered list of devices idcode */
+17
View File
@@ -16,6 +16,7 @@
#include "anlogic.hpp"
#include "board.hpp"
#include "cable.hpp"
#include "colognechip.hpp"
#include "device.hpp"
#include "dfu.hpp"
#include "display.hpp"
@@ -227,6 +228,19 @@ int main(int argc, char **argv)
} else {
target.program(args.offset);
}
} else if (board->manufacturer == "colognechip") {
CologneChip target(spi, args.bit_file, args.file_type, args.prg_type,
board->reset_pin, board->done_pin, DBUS6, board->oe_pin,
args.verify, args.verbose);
if (args.prg_type == Device::RD_FLASH) {
if (args.file_size == 0) {
printError("Error: 0 size for dump");
} else {
target.dumpFlash(args.bit_file, args.offset, args.file_size);
}
} else {
target.program(args.offset);
}
} else {
RawParser *bit = NULL;
if (board->reset_pin) {
@@ -443,6 +457,9 @@ int main(int argc, char **argv)
} else if (fab == "lattice") {
fpga = new Lattice(jtag, args.bit_file, args.file_type,
args.prg_type, args.flash_sector, args.verify, args.verbose);
} else if (fab == "colognechip") {
fpga = new CologneChip(jtag, args.bit_file, args.file_type,
args.prg_type, args.board, args.cable, args.verify, args.verbose);
} else {
printError("Error: manufacturer " + fab + " not supported");
delete(jtag);
+2
View File
@@ -107,6 +107,8 @@ static std::map <int, fpga_model> fpga_list = {
{0x0100381B, {"Gowin", "GW1N", "GW1N-4", 8}},
{0x0300181b, {"Gowin", "GW1NS", "GW1NS-2C", 8}},
{0x0100981b, {"Gowin", "GW1NSR", "GW1NSR-4C", 8}},
{0x20000001, {"colognechip", "GateMate Series", "GM1Ax", 6}},
};
/* device potentially in JTAG chain but not handled */