pcf.cc

/* Copyright (C) 2015 Cotton Seed
   
   This file is part of arachne-pnr.  Arachne-pnr is free software;
   you can redistribute it and/or modify it under the terms of the GNU
   General Public License version 2 as published by the Free Software
   Foundation.
   
   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.
   
   You should have received a copy of the GNU General Public License
   along with this program. If not, see <http://www.gnu.org/licenses/>. */

#include "util.hh"
#include "chipdb.hh"
#include "netlist.hh"
#include "pcf.hh"
#include "line_parser.hh"
#include "designstate.hh"
#include "casting.hh"

#include <stdlib.h>
#include <cstring>
#include <istream>
#include <fstream>

class PCFParser : public LineParser
{
  const Package &package;
  Model *top;
  Constraints &constraints;
  
public:
  PCFParser(const std::string &f, std::istream &s_, DesignState &ds)
    : LineParser(f, s_),
      package(ds.package),
      top(ds.top),
      constraints(ds.constraints)
  {}
  
  void parse();
};

namespace
{
// Extract integer ranges that don't have holes.
std::vector<std::pair<int, int>> extract_ranges(const std::set<int> &full_set)
{
  using ReturnType = std::vector<std::pair<int, int>>;
  ReturnType result;
  ReturnType::iterator current;
  int last = -2;
  for (const int bit : full_set)
    {
      if (bit > last+1) {
        result.push_back({bit, bit});
        current = result.end()-1;
      }
      current->second = bit;
      last = bit;
    }
  return result;
}

// Given a field prefix and a set of bit-positions, print a compact
// representation. Resets the given fields.
void print_coalesced_field_range(std::string *last_prefix,
                                 std::set<int> *missing_bits)
{
  if (last_prefix->empty()) return;
  for (auto range : extract_ranges(*missing_bits)) {
    if (range.first != range.second) {
      note(fmt("no set_io constraints for pins `"
               << *last_prefix << "[" << range.first << ".."
               << range.second << "]'"));
    } else {
      note(fmt("no set_io constraints for pin `" << *last_prefix
               << "[" << range.first << "]'"));
    }
  }

  last_prefix->clear();
  missing_bits->clear();
}

}  // namespace

void
PCFParser::parse()
{
  std::map<std::string, Location> net_pin_loc;
  std::map<Location, std::string> pin_loc_net;
  std::map<std::string, bool> net_pin_pull_up;
  std::set<std::string> extra_ports;

  for (auto p : top->ordered_ports())
    extra_ports.insert(p->name());
  
  for (;;)
    {
      if (eof())
        break;
      
      read_line();
      if (words.empty())
        continue;
      
      const std::string &cmd = words[0];
      if (cmd == "set_io")
        {
          bool no_warn = false;
          bool pull_up = false;
          bool pull_up_set = false;
          
          const char *net_name = nullptr,
            *pin_name = nullptr;
          for (int i = 1; i < (int)words.size(); ++i)
            {
              if (words[i][0] == '-')
                {
                  if (words[i] == "--warn-no-port")
                    {
                      /* ignored for backward compatibility */
                    }
                  else if (words[i] == "-nowarn")
                    {
                      no_warn = true;
                    }
                  else if (words[i] == "-pullup")
                    {
                      if (i+1 == (int)words.size())
                        fatal(fmt("-pullup needs yes/no"));
                      i++;
                      if (words[i] == "yes")
                        {
                          pull_up = true;
                          pull_up_set = true;
                        }
                      else if (words[i] == "no")
                        pull_up_set = true;
                      else
                        fatal(fmt("unknown pullup option `" << words[i] << "'"));
                    }
                  else
                    fatal(fmt("unknown option `" << words[i] << "'"));
                }
              else
                {
                  if (net_name == nullptr)
                    net_name = words[i].c_str();
                  else if (pin_name == nullptr)
                    pin_name = words[i].c_str();
                  else
                    fatal("set_io: too many arguments");
                }
            }
          
          if (!net_name || !pin_name)
            fatal("set_io: too few arguments");
          
          Port *p = top->find_port(net_name);
          if (!p)
            {
              if (!no_warn)
                warning(fmt("no port `" << net_name << "' in top-level module `"
                            << top->name() << "', constraint ignored."));
              continue;
            }
          
          extra_ports.erase(p->name());
          
          auto i = package.pin_loc.find(pin_name);
          if (i == package.pin_loc.end())
            fatal(fmt("unknown pin `" << pin_name << "' on package `"
                      << package.name << "'"));
          
          if (contains(net_pin_loc, net_name))
            fatal(fmt("duplicate pin constraints for net `" << net_name << "'"));
          
          const Location &loc = i->second;
          if (contains(pin_loc_net, loc))
            fatal(fmt("duplicate pin constraints for pin `" << pin_name <<"'"));
          
          extend(net_pin_loc, net_name, loc);
          extend(pin_loc_net, loc, net_name);
          if (pull_up_set)
            extend(net_pin_pull_up, net_name, pull_up);
        }
      else
        fatal(fmt("unknown command `" << cmd << "'"));
    }
  
  if (!extra_ports.empty())
    {
      // Print some somewhat compact list of all missing constraints,
      // coalescing bit numbers.
      std::string last_prefix;
      std::set<int> missing_bits;
      for (const std::string &pin_name : extra_ports)
        {
          auto bracket = pin_name.find_first_of('[');
          if (bracket != std::string::npos)
            {
              std::string prefix = pin_name.substr(0, bracket);
              if (prefix != last_prefix)
                {
                  print_coalesced_field_range(&last_prefix, &missing_bits);
                  last_prefix = prefix;
                }
              missing_bits.insert(atoi(pin_name.substr(bracket+1).c_str()));
            }
          else
            {
              print_coalesced_field_range(&last_prefix, &missing_bits);
              note(fmt("no set_io constraints for pin `" << pin_name << "'"));
            }
        }
      fatal(fmt("Missing " << extra_ports.size() << " set_io constraints"));
    }
  
  constraints.net_pin_loc = net_pin_loc;
  constraints.net_pin_pull_up = net_pin_pull_up;
}

void
read_pcf(const std::string &filename, DesignState &ds)
{
  std::string expanded = expand_filename(filename);
  std::ifstream fs(expanded);
  if (fs.fail())
    fatal(fmt("read_pcf: failed to open `" << expanded << "': "
              << strerror(errno)));
  PCFParser parser(filename, fs, ds);
  return parser.parse();
}

class ConstraintsPlacer
{
  DesignState &ds;
  const ChipDB *chipdb;
  const Models &models;
  Model *top;
  const Constraints &constraints;
  
  BasedVector<Instance *, 1> cell_gate;
  
  Instance *top_port_io_gate(const std::string &net_name);
  
public:
  ConstraintsPlacer(DesignState &ds_);
  
  void place();
};

Instance *
ConstraintsPlacer::top_port_io_gate(const std::string &net_name)
{
  Port *p = top->find_port(net_name);
  assert(p);
  
  Port *p2 = p->connection_other_port();
  
  Instance *inst = cast<Instance>(p2->node());
  assert(models.is_ioX(inst)
         || models.is_pllX(inst)
         || models.is_rgba_drv(inst));
  
  return inst;
}

ConstraintsPlacer::ConstraintsPlacer(DesignState &ds_)
  : ds(ds_),
    chipdb(ds.chipdb),
    models(ds.models),
    top(ds.top),
    constraints(ds.constraints),
    cell_gate(chipdb->n_cells, nullptr)
{
  assert(ds.placement.empty());
}

void
ConstraintsPlacer::place()
{
  std::vector<Net *> bank_latch(4, nullptr);
  for (const auto &p : constraints.net_pin_loc)
    {
      Instance *inst = top_port_io_gate(p.first);
      
      const Location &loc = p.second;
      int t = loc.tile();
      assert(chipdb->tile_type[t] == TileType::IO);
      int b = chipdb->tile_bank(t);
      
      int c = 0;
      if (models.is_ioX(inst))
        {
          Net *latch = inst->find_port("LATCH_INPUT_VALUE")->connection();
          if (latch)
            {
              if (bank_latch[b])
                {
                  if (bank_latch[b] != latch)
                    fatal(fmt("pcf error: multiple LATCH_INPUT_VALUE drivers in bank " << b));
                }
              else
                bank_latch[b] = latch;
            }

          if (inst->get_param("IO_STANDARD").as_string() == "SB_LVDS_INPUT")
            {
              if (b != 3)
                fatal(fmt("pcf error: LVDS port `" << p.first << "' not in bank 3\n"));
              if (loc.pos() != 0)
                fatal(fmt("pcf error: LVDS port `" << p.first << "' not a DPxxB input\n"));
            }
          
          Location loc_other(t,
                             loc.pos() ? 0 : 1);
          int cell_other = chipdb->loc_cell(loc_other);
          if (cell_other)
            {
              Instance *inst_other = cell_gate[cell_other];
              if (inst_other)
                {
                  int x = chipdb->tile_x(t),
                    y = chipdb->tile_y(t);
                  
                  if (inst->get_param("NEG_TRIGGER").get_bit(0)
                      != inst_other->get_param("NEG_TRIGGER").get_bit(0))
                    fatal(fmt("pcf error: incompatible NEG_TRIGGER parameters in PIO at (" 
                              << inst->find_port("PACKAGE_PIN")->connection()->name() << ","
                              << inst_other->find_port("PACKAGE_PIN")->connection()->name() << ") at ("
                              << x << ", " << y << ")"));
                  
                  Net *cen = inst->find_port("CLOCK_ENABLE")->connection(),
                    *cen_other = inst_other->find_port("CLOCK_ENABLE")->connection();
                  if (cen && cen_other && cen != cen_other)
                    fatal(fmt("pcf error: multiple CLOCK_ENABLE drivers in PIO at ("
                              << inst->find_port("PACKAGE_PIN")->connection()->name() << ","
                              << inst_other->find_port("PACKAGE_PIN")->connection()->name() << ") at ("
                              << x << ", " << y << ")"));
                  
                  Net *inclk = inst->find_port("INPUT_CLK")->connection(),
                    *inclk_other = inst_other->find_port("INPUT_CLK")->connection();
                  if (inclk && inclk_other && inclk != inclk_other)
                    fatal(fmt("pcf error: multiple INPUT_CLK drivers in PIO at ("
                              << inst->find_port("PACKAGE_PIN")->connection()->name() << ","
                              << inst_other->find_port("PACKAGE_PIN")->connection()->name() << ") at ("
                              << x << ", " << y << ")"));
                  
                  Net *outclk = inst->find_port("OUTPUT_CLK")->connection(),
                    *outclk_other = inst_other->find_port("OUTPUT_CLK")->connection();
                  if (outclk && outclk_other && outclk != outclk_other)
                    fatal(fmt("pcf error: multiple OUTPUT_CLK drivers in PIO at ("
                              << inst->find_port("PACKAGE_PIN")->connection()->name() << ","
                              << inst_other->find_port("PACKAGE_PIN")->connection()->name() << ") at ("
                              << x << ", " << y << ")"));
                }
            }

          std::map<std::string, bool>::const_iterator it;
          it = constraints.net_pin_pull_up.find(p.first);
          if (it != constraints.net_pin_pull_up.end())
            { // Pull-up constraint for this pin
             inst->set_param("PULLUP", BitVector(1, it->second ? 1 : 0));
             note(fmt("forcing pull-up for `" << it->first << "' to `"
                      << it->second << "'"));
            }

          if(models.is_io_i3c(inst))
            {
              bool found = false;
              for (int icell : chipdb->cell_type_cells[cell_type_idx(CellType::IO_I3C)])
              {
                auto pin = chipdb->cell_mfvs.at(icell).at("PACKAGE_PIN");
                if(loc.tile() == pin.first && loc.pos() == std::stoi(pin.second))
                {
                  found = true;
                  break;
                }
              }
              if(!found)
              {
                fatal(fmt("bad constraint on `"
                          << p.first << "': pin "
                          << ds.package.loc_pin.at(loc)
                          << " is not I3C IO capable"));
              }
            }
          else if (models.is_io_od(inst))
            {
              int rgb_cell = chipdb->cell_type_cells[cell_type_idx(CellType::RGBA_DRV)].at(0);
              bool found = false;
              for (int i = 0; i <= 2; i++)
              {
                std::string op = "RGB" + std::to_string(i);
                auto op_loc = chipdb->cell_mfvs.at(rgb_cell).at(op);
                if(loc.tile() == op_loc.first && loc.pos() == std::stoi(op_loc.second))
                {
                  for(auto rinst : top->instances())
                  {
                    if(models.is_rgba_drv(rinst))
                    {
                      if(rinst->get_param(op + "_CURRENT").as_string() != "0b000000")
                        fatal(fmt("bad constraint on `"
                                  << p.first << "': IO_OD on pin "
                                  << ds.package.loc_pin.at(loc)
                                  << " conflicts with RGBA_DRV output "
                                  << op << " (set " << op << "_CURRENT to 0b000000 to use IO_OD)"));
                    }
                  }
                  found = true;
                  break;
                }
              }
              if(!found)
                fatal(fmt("bad constraint on `"
                          << p.first << "': pin "
                          << ds.package.loc_pin.at(loc)
                          << " is not an IO_OD location"));
            }
          c = chipdb->loc_cell(loc);
        }
      else if (models.is_rgba_drv(inst))
        {
          Port *port = top->find_port(p.first);
          assert(port);
          Port *p2 = port->connection_other_port();
          std::string op = p2->name();
          if (op == "RGB0" || op == "RGB1" || op == "RGB2")
          {
            int rgb_cell = chipdb->cell_type_cells[cell_type_idx(CellType::RGBA_DRV)].at(0);
            auto op_loc = chipdb->cell_mfvs.at(rgb_cell).at(op);
            if(loc.tile() != op_loc.first || loc.pos() != std::stoi(op_loc.second))
            {
              fatal(fmt("bad constraint on `"
                        << p.first << "': pin "
                        << ds.package.loc_pin.at(loc)
                        << " does not correspond to RGB driver output `"
                        << op << "'"));
            }
          }
          continue;
        }
      else
        {
          assert(models.is_pllX(inst));
          
          Location pll_loc(loc.tile(), 3);
          
          c = chipdb->loc_cell(pll_loc);
          if (!c
              || chipdb->cell_type[c] != CellType::PLL
              || contains(chipdb->cell_locked_pkgs.at(c), ds.package.name))
            fatal(fmt("bad constraint on `"
                      << p.first << "': no PLL at pin "
                      << ds.package.loc_pin.at(loc)));
        }
      
      cell_gate[c] = inst;
      extend(ds.placement, inst, c);
    }
  
  for (int c : chipdb->cell_type_cells[cell_type_idx(CellType::PLL)])
    {
      Instance *pll = cell_gate[c];
      if (!pll)
        continue;
      assert(models.is_pllX(pll));
      for (int io_cell : ds.pll_out_io_cells(pll, c))
        {
          Instance *io = cell_gate[io_cell];
          if (!io)
            continue;
          
          const BitVector &pin_type = io->get_param("PIN_TYPE").as_bits();
          if (io->find_port("D_IN_0")->connected()
              || io->find_port("D_IN_1")->connected()
              || !pin_type[0]
              || pin_type[1])
            {
              const Location &pll_loc = chipdb->cell_location[c];
              const std::string &io_pin = ds.package.loc_pin.at(chipdb->cell_location[io_cell]);
              fatal(fmt("PLL at `" << chipdb->tile_x(pll_loc.tile())
                        << " " << chipdb->tile_y(pll_loc.tile())
                        << "' conflicts with pin " << io_pin << " input path"));
            }
        }
    }
  
  int n_pll = 0,
    n_pll_placed = 0;
  for (Instance *inst : top->instances())
    {
      if (contains(ds.placement, inst))
        continue;
      
      // FIXME relax
      if (models.is_gb_io(inst))
        fatal("physical constraint required for GB_IO");
      else if(models.is_io_i3c(inst))
        fatal("physical constraint required for IO_I3C");
      else if(models.is_io_od(inst))
        fatal("physical constraint required for IO_OD");
      else if (models.is_lfosc(inst))
        {
          bool good = false;
          for (int c : chipdb->cell_type_cells[cell_type_idx(CellType::LFOSC)])
            {
              if (cell_gate[c])
                continue;
              good = true;
              cell_gate[c] = inst;
              extend(ds.placement, inst, c);
              break;
            }
          if (!good)
            fatal("failed to place LFOSC");
        }
      else if (models.is_hfosc(inst))
        {
          bool good = false;
          for (int c : chipdb->cell_type_cells[cell_type_idx(CellType::HFOSC)])
            {
              if (cell_gate[c])
                continue;
              good = true;
              cell_gate[c] = inst;
              extend(ds.placement, inst, c);
              break;
            }
          if (!good)
            fatal("failed to place HFOSC");
        }
      else if (models.is_pllX(inst))
        {
          ++n_pll;
          
          bool good = false;
          for (int c : chipdb->cell_type_cells[cell_type_idx(CellType::PLL)])
            {
              if (cell_gate[c])
                continue;
              if (contains(chipdb->cell_locked_pkgs.at(c), ds.package.name))
                continue;
              good = true;
              for (int io_cell : ds.pll_out_io_cells(inst, c))
                {
                  Instance *io = cell_gate[io_cell];
                  if (io)
                    {
                      const BitVector &pin_type = io->get_param("PIN_TYPE").as_bits();
                      if (io->find_port("D_IN_0")->connected()
                          || io->find_port("D_IN_1")->connected()
                          || !pin_type[0]
                          || pin_type[1])
                        {
                          good = false;
                          break;
                        }
                    }
                }
              if (good)
                {
                  cell_gate[c] = inst;
                  extend(ds.placement, inst, c);
                  ++n_pll_placed;
                  break;
                }
            }
          int n_pkg_pll = 0;
          for (auto cell : chipdb->cell_type_cells[cell_type_idx(CellType::PLL)]) {
            if (!contains(chipdb->cell_locked_pkgs.at(cell), ds.package.name))
              n_pkg_pll++;
          }
          if (!good)
            fatal(fmt("failed to place: placed " << n_pll_placed
                      << " PLLs of " << n_pll
                      << " / " << n_pkg_pll));
        }
    }
}

void
place_constraints(DesignState &ds)
{
  ConstraintsPlacer placer(ds);
  placer.place();
}