Skip to content

Commit

Permalink
Add CCF parsing
Browse files Browse the repository at this point in the history
  • Loading branch information
mmicko committed Dec 16, 2024
1 parent 4d46e57 commit 0add621
Show file tree
Hide file tree
Showing 3 changed files with 264 additions and 30 deletions.
218 changes: 218 additions & 0 deletions himbaechel/uarch/gatemate/ccf.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
/*
* nextpnr -- Next Generation Place and Route
*
* Copyright (C) 2024 The Project Peppercorn Authors.
*
* 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.
*
*/

#include <algorithm>
#include <boost/algorithm/string.hpp>
#include <boost/lexical_cast.hpp>
#include <fstream>
#include <regex>

#include "extra_data.h"
#include "himbaechel_api.h"
#include "log.h"
#include "nextpnr.h"
#include "util.h"

#include "gatemate.h"

#define HIMBAECHEL_CONSTIDS "uarch/gatemate/constids.inc"
#include "himbaechel_constids.h"

NEXTPNR_NAMESPACE_BEGIN

struct GateMateCCFReader
{
Context *ctx;
std::istream &in;
int lineno;
dict<IdString, Property> defaults;

GateMateCCFReader(Context *ctx, std::istream &in) : ctx(ctx), in(in) {};

std::string strip_quotes(const std::string &str)
{
if (str.at(0) == '"') {
if (str.back() != '"') {
log_error("expected '\"' at end of string '%s' (on line %d).\n", str.c_str(), lineno);
}
return str.substr(1, str.size() - 2);
} else {
return str;
}
};

void parse_params(std::vector<std::string> &params, bool is_default, dict<IdString, Property> *props)
{
for (auto param : params) {
std::vector<std::string> expr;
boost::split(expr, param, boost::is_any_of("="));
if (expr.size() != 2)
log_error("each parameter must be in form NAME=VALUE (on line %d)\n", lineno);

std::string name = expr.at(0);
boost::algorithm::trim(name);
boost::algorithm::to_upper(name);
std::string value = strip_quotes(expr.at(1));
boost::algorithm::trim(value);
boost::algorithm::to_upper(value);

if (name == "LOC") {
if (is_default)
log_error("Value '%s' can not be defined for default GPIO in line %d.\n", name.c_str(), lineno);
props->emplace(ctx->id(name.c_str()), Property(value));
} else if (name == "SCHMITT_TRIGGER" || name == "PULLUP" || name == "PULLDOWN" || name == "KEEPER" ||
name == "FF_IBF" || name == "FF_OBF" || name == "LVDS_BOOST" || name == "LVDS_RTERM") {
if (value == "TRUE") {
props->emplace(ctx->id(name.c_str()), Property(Property::State::S1));
} else if (value == "FALSE") {
props->emplace(ctx->id(name.c_str()), Property(Property::State::S0));
} else
log_error("Uknown value '%s' for parameter '%s' in line %d, must be TRUE or FALSE.\n",
value.c_str(), name.c_str(), lineno);
} else if (name == "SLEW") {
if (value == "FAST") {
props->emplace(ctx->id(name.c_str()), Property(Property::State::S1));
} else if (value == "SLOW") {
props->emplace(ctx->id(name.c_str()), Property(Property::State::S0));
} else
log_error("Uknown value '%s' for parameter '%s' in line %d, must be SLOW or FAST.\n", value.c_str(),
name.c_str(), lineno);
} else if (name == "DRIVE") {
try {
int drive = boost::lexical_cast<int>(value.c_str());
if (drive == 3 || drive == 6 || drive == 9 || drive == 12) {
props->emplace(ctx->id(name.c_str()), Property((drive - 3) / 3, 2));
} else
log_error("Parameter '%s' must have value 3,6,9 or 12 in line %d.\n", name.c_str(), lineno);
} catch (boost::bad_lexical_cast const &) {
log_error("Parameter '%s' must be number in line %d.\n", name.c_str(), lineno);
}
} else if (name == "DELAY_IBF" || name == "DELAY_OBF") {
try {
int delay = boost::lexical_cast<int>(value.c_str());
if (delay >= 0 && delay <= 15) {
props->emplace(ctx->id(name.c_str()), Property(delay, 4));
} else
log_error("Parameter '%s' must have value from 0 to 15 in line %d.\n", name.c_str(), lineno);
} catch (boost::bad_lexical_cast const &) {
log_error("Parameter '%s' must be number in line %d.\n", name.c_str(), lineno);
}
} else {
log_error("Uknown parameter name '%s' in line %d.\n", name.c_str(), lineno);
}
}
}

bool run()
{
try {
log_info("Parsing CCF file..\n");

std::string line;
std::string linebuf;
defaults.clear();

auto isempty = [](const std::string &str) {
return std::all_of(str.begin(), str.end(), [](char c) { return isblank(c) || c == '\r' || c == '\n'; });
};
lineno = 0;
while (std::getline(in, line)) {
++lineno;
// Both // and # are considered start of comment
size_t com_start = line.find("//");
if (com_start != std::string::npos)
line = line.substr(0, com_start);
com_start = line.find('#');
if (com_start != std::string::npos)
line = line.substr(0, com_start);
if (isempty(line))
continue;
linebuf += line;

size_t pos = linebuf.find(';');
// Need to concatenate lines until there is closing ; sign
while (pos != std::string::npos) {
std::string content = linebuf.substr(0, pos);

std::vector<std::string> params;
boost::split(params, content, boost::is_any_of("|"));
std::string command = params.at(0);

std::stringstream ss(command);
std::vector<std::string> words;
std::string tmp;
while (ss >> tmp)
words.push_back(tmp);
std::string type = words.at(0);

boost::algorithm::to_lower(type);
if (type == "default_gpio") {
if (words.size() != 1)
log_error("line with default_GPIO should not contain only parameters (in line %d).\n",
lineno);
params.erase(params.begin());
parse_params(params, true, &defaults);

} else if (type == "pin_in" || type == "pin_out" || type == "pin_inout") {
if (words.size() < 3 || words.size() > 5)
log_error("pin definition line not properly formed (in line %d).\n", lineno);
std::string pin_name = strip_quotes(words.at(1));
printf("name:%s\n", pin_name.c_str());

// put back other words and use them as parameters
std::stringstream ss;
for (size_t i = 2; i < words.size(); i++)
ss << words.at(i);
params[0] = ss.str();

IdString cellname = ctx->id(pin_name);
if (ctx->cells.count(cellname)) {
CellInfo *cell = ctx->cells.at(cellname).get();
for (auto p : defaults)
cell->params[p.first] = p.second;
parse_params(params, false, &cell->params);
} else
log_warning("Pad with name '%s' not found in netlist.\n", pin_name.c_str());
} else {
log_error("unknown type '%s' in line %d.\n", type.c_str(), lineno);
}

linebuf = linebuf.substr(pos + 1);
pos = linebuf.find(';');
}
}
if (!isempty(linebuf))
log_error("unexpected end of CCF file\n");
return true;
} catch (log_execution_error_exception) {
return false;
}
}
};

bool GateMateImpl::parse_ccf(const std::string &filename)
{
std::ifstream in(filename);
if (!in)
log_error("failed to open CCF file '%s'\n", filename.c_str());
GateMateCCFReader reader(ctx, in);
return reader.run();
}

NEXTPNR_NAMESPACE_END
74 changes: 44 additions & 30 deletions himbaechel/uarch/gatemate/gatemate.cc
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@

#include "himbaechel_helpers.h"

#include "gatemate.h"
#include "config.h"
#include "gatemate.h"

#define GEN_INIT_CONSTIDS
#define HIMBAECHEL_CONSTIDS "uarch/gatemate/constids.inc"
Expand Down Expand Up @@ -80,6 +80,11 @@ void GateMateImpl::drawBel(std::vector<GraphicElement> &g, GraphicElement::style

void GateMateImpl::pack()
{
const ArchArgs &args = ctx->args;
if (args.options.count("ccf")) {
parse_ccf(args.options.at("ccf"));
}

const pool<CellTypePort> top_ports{
CellTypePort(id_CC_IBUF, id_I),
CellTypePort(id_CC_OBUF, id_O),
Expand All @@ -93,17 +98,19 @@ void GateMateImpl::pack()
if (ci.type == id_CC_IBUF) {
ci.renamePort(id_I, id_DI);
ci.renamePort(id_Y, id_IN1);
ci.params[ctx->id("INIT")] = Property("000000000000000000000001000000000000000000000000000000000000000001010000");
ci.params[ctx->id("INIT")] =
Property("000000000000000000000001000000000000000000000000000000000000000001010000");
// x=-2 y=99
BelId bel = ctx->getBelByName(IdStringList::concat(ctx->idf("X%dY%d",-2+2,99+2), id_GPIO));
BelId bel = ctx->getBelByName(IdStringList::concat(ctx->idf("X%dY%d", -2 + 2, 99 + 2), id_GPIO));
ctx->bindBel(bel, &ci, PlaceStrength::STRENGTH_FIXED);
}
if (ci.type == id_CC_OBUF) {
ci.renamePort(id_O, id_DO);
ci.renamePort(id_A, id_OUT2);
ci.params[ctx->id("INIT")] = Property("000000000000000000000000000000000000000100000000000000010000100100000000");
ci.params[ctx->id("INIT")] =
Property("000000000000000000000000000000000000000100000000000000010000100100000000");
// x=-2 y=95
BelId bel = ctx->getBelByName(IdStringList::concat(ctx->idf("X%dY%d",-2+2,95+2), id_GPIO));
BelId bel = ctx->getBelByName(IdStringList::concat(ctx->idf("X%dY%d", -2 + 2, 95 + 2), id_GPIO));
ctx->bindBel(bel, &ci, PlaceStrength::STRENGTH_FIXED);
}
ci.type = id_GPIO;
Expand All @@ -116,16 +123,20 @@ delay_t GateMateImpl::estimateDelay(WireId src, WireId dst) const
tile_xy(ctx->chip_info, src.tile, sx, sy);
tile_xy(ctx->chip_info, dst.tile, dx, dy);

return 100 * (std::abs(dx - sx)/4 + std::abs(dy - sy)/4 + 2);
return 100 * (std::abs(dx - sx) / 4 + std::abs(dy - sy) / 4 + 2);
}

void get_bitstream_tile(int x,int y,int &b_x,int &b_y)
void get_bitstream_tile(int x, int y, int &b_x, int &b_y)
{
// Edge blocks are bit bigger
if (x==-2) x++;
if (x==163) x--;
if (y==-2) y++;
if (y==131) y--;
if (x == -2)
x++;
if (x == 163)
x--;
if (y == -2)
y++;
if (y == 131)
y--;
b_x = (x + 1) / 2;
b_y = (y + 1) / 2;
}
Expand Down Expand Up @@ -156,7 +167,7 @@ CfgLoc getConfigLoc(Context *ctx, int tile)
int x0, y0;
int bx, by;
tile_xy(ctx->chip_info, tile, x0, y0);
get_bitstream_tile(x0 - 2,y0 - 2, bx, by);
get_bitstream_tile(x0 - 2, y0 - 2, bx, by);
CfgLoc loc;
loc.die = 0;
loc.x = bx;
Expand All @@ -170,23 +181,25 @@ void GateMateImpl::postRoute()
if (args.options.count("out")) {
ChipConfig cc;
cc.chip_name = args.device;
cc.configs[0].add_word("GPIO.BANK_E1", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_E2", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_N1", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_N2", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_S1", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_S2", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_W1", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_W2", int_to_bitvector(1,1));
cc.configs[0].add_word("GPIO.BANK_E1", int_to_bitvector(1, 1));
cc.configs[0].add_word("GPIO.BANK_E2", int_to_bitvector(1, 1));
cc.configs[0].add_word("GPIO.BANK_N1", int_to_bitvector(1, 1));
cc.configs[0].add_word("GPIO.BANK_N2", int_to_bitvector(1, 1));
cc.configs[0].add_word("GPIO.BANK_S1", int_to_bitvector(1, 1));
cc.configs[0].add_word("GPIO.BANK_S2", int_to_bitvector(1, 1));
cc.configs[0].add_word("GPIO.BANK_W1", int_to_bitvector(1, 1));
cc.configs[0].add_word("GPIO.BANK_W2", int_to_bitvector(1, 1));
for (auto &cell : ctx->cells) {
switch (cell.second->type.index) {
case id_GPIO.index: {
CfgLoc loc = getConfigLoc(ctx, cell.second.get()->bel.tile);
cc.tiles[loc].add_word("GPIO.INIT", str_to_bitvector(str_or_default(cell.second.get()->params,ctx->id("INIT"),""), 72));
break;
}
default:
break;
case id_GPIO.index: {
CfgLoc loc = getConfigLoc(ctx, cell.second.get()->bel.tile);
cc.tiles[loc].add_word(
"GPIO.INIT",
str_to_bitvector(str_or_default(cell.second.get()->params, ctx->id("INIT"), ""), 72));
break;
}
default:
break;
}
}

Expand All @@ -198,11 +211,12 @@ void GateMateImpl::postRoute()
for (auto &w : ni->wires) {
if (w.second.pip != PipId()) {
PipId pip = w.second.pip;
const auto extra_data = *reinterpret_cast<const GateMatePipExtraDataPOD *>(chip_pip_info(ctx->chip_info, pip).extra_data.get());
if (extra_data.name!=0) {
const auto extra_data = *reinterpret_cast<const GateMatePipExtraDataPOD *>(
chip_pip_info(ctx->chip_info, pip).extra_data.get());
if (extra_data.name != 0) {
IdString name = IdString(extra_data.name);
CfgLoc loc = getConfigLoc(ctx, pip.tile);
cc.tiles[loc].add_word(name.c_str(ctx),int_to_bitvector(extra_data.value, extra_data.bits));
cc.tiles[loc].add_word(name.c_str(ctx), int_to_bitvector(extra_data.value, extra_data.bits));
}
}
}
Expand Down
2 changes: 2 additions & 0 deletions himbaechel/uarch/gatemate/gatemate.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ struct GateMateImpl : HimbaechelAPI

void drawBel(std::vector<GraphicElement> &g, GraphicElement::style_t style, IdString bel_type, Loc loc) override;

bool parse_ccf(const std::string &filename);

private:
HimbaechelHelpers h;
};
Expand Down

0 comments on commit 0add621

Please sign in to comment.