/*
 *  nextpnr -- Next Generation Place and Route
 *
 *  Copyright (C) 2018  Claire Xenia Wolf <claire@yosyshq.com>
 *  Copyright (C) 2018  gatecat <gatecat@ds0.me>
 *  Copyright (C) 2018  Serge Bazanski <q3k@q3k.org>
 *
 *  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 "cells.h"
#include "nextpnr.h"
#include "util.h"

#include <boost/range/iterator_range.hpp>

NEXTPNR_NAMESPACE_BEGIN

bool Arch::logic_cells_compatible(const CellInfo **it, const size_t size) const
{
    bool dffs_exist = false, dffs_neg = false;
    const NetInfo *cen = nullptr, *clk = nullptr, *sr = nullptr;
    int locals_count = 0;

    for (auto cell : boost::make_iterator_range(it, it + size)) {
        NPNR_ASSERT(cell->type == id_ICESTORM_LC);
        if (cell->lcInfo.dffEnable) {
            if (!dffs_exist) {
                dffs_exist = true;
                cen = cell->lcInfo.cen;
                clk = cell->lcInfo.clk;
                sr = cell->lcInfo.sr;

                if (cen != nullptr && !cen->is_global)
                    locals_count++;
                if (clk != nullptr && !clk->is_global)
                    locals_count++;
                if (sr != nullptr && !sr->is_global)
                    locals_count++;

                if (cell->lcInfo.negClk) {
                    dffs_neg = true;
                }
            } else {
                if (cen != cell->lcInfo.cen)
                    return false;
                if (clk != cell->lcInfo.clk)
                    return false;
                if (sr != cell->lcInfo.sr)
                    return false;
                if (dffs_neg != cell->lcInfo.negClk)
                    return false;
            }
        }

        locals_count += cell->lcInfo.inputCount;
    }

    return locals_count <= 32;
}

static inline bool _io_pintype_need_clk_in(unsigned pin_type) { return (pin_type & 0x01) == 0x00; }

static inline bool _io_pintype_need_clk_out(unsigned pin_type)
{
    return ((pin_type & 0x30) == 0x30) || ((pin_type & 0x3c) && ((pin_type & 0x0c) != 0x08));
}

static inline bool _io_pintype_need_clk_en(unsigned pin_type)
{
    return _io_pintype_need_clk_in(pin_type) || _io_pintype_need_clk_out(pin_type);
}

bool Arch::isBelLocationValid(BelId bel) const
{
    if (getBelType(bel) == id_ICESTORM_LC) {
        std::array<const CellInfo *, 8> bel_cells;
        size_t num_cells = 0;
        Loc bel_loc = getBelLocation(bel);
        for (auto bel_other : getBelsByTile(bel_loc.x, bel_loc.y)) {
            CellInfo *ci_other = getBoundBelCell(bel_other);
            if (ci_other != nullptr)
                bel_cells[num_cells++] = ci_other;
        }
        return logic_cells_compatible(bel_cells.data(), num_cells);
    } else {
        const CellInfo *cell = getBoundBelCell(bel);
        if (cell == nullptr)
            return true;
        else if (cell->type == id_SB_IO) {
            // Do not allow placement of input SB_IOs on blocks where there a PLL is outputting to.

            // Find shared PLL by looking for driving bel siblings from D_IN_0
            // that are a PLL clock output.
            auto wire = getBelPinWire(bel, id_D_IN_0);
            for (auto pin : getWireBelPins(wire)) {
                if (pin.pin.in(id_PLLOUT_A, id_PLLOUT_B)) {
                    // Is there a PLL there ?
                    const CellInfo *pll_cell = getBoundBelCell(pin.bel);
                    if (pll_cell == nullptr)
                        break;

                    // Is that port actually used ?
                    if ((pin.pin == id_PLLOUT_B) && !is_sb_pll40_dual(this, pll_cell))
                        break;

                    // Is that SB_IO used at an input ?
                    if ((cell->getPort(id_D_IN_0) == nullptr) && (cell->getPort(id_D_IN_1) == nullptr))
                        break;

                    // Are we perhaps a PAD INPUT Bel that can be placed here?
                    if (str_or_default(pll_cell->attrs, id_BEL_PAD_INPUT, "") == getBelName(bel).str(getCtx()))
                        return true;

                    // Conflict
                    return false;
                }
            }

            Loc ioLoc = getBelLocation(bel);
            Loc compLoc = ioLoc;
            compLoc.z = 1 - compLoc.z;

            // Check LVDS pairing
            if (cell->ioInfo.lvds) {
                // Check correct z and complement location is free
                if (ioLoc.z != 0)
                    return false;
                BelId compBel = getBelByLocation(compLoc);
                CellInfo *compCell = getBoundBelCell(compBel);
                if (compCell)
                    return false;
            } else {
                // Check LVDS IO is not placed at complement location
                BelId compBel = getBelByLocation(compLoc);
                const CellInfo *compCell = getBoundBelCell(compBel);
                if (compCell && compCell->ioInfo.lvds)
                    return false;

                // Check for conflicts on shared nets
                // - CLOCK_ENABLE
                // - OUTPUT_CLK
                // - INPUT_CLK
                if (compCell) {
                    bool use[6] = {
                            _io_pintype_need_clk_in(cell->ioInfo.pintype),
                            _io_pintype_need_clk_in(compCell->ioInfo.pintype),
                            _io_pintype_need_clk_out(cell->ioInfo.pintype),
                            _io_pintype_need_clk_out(compCell->ioInfo.pintype),
                            _io_pintype_need_clk_en(cell->ioInfo.pintype),
                            _io_pintype_need_clk_en(compCell->ioInfo.pintype),
                    };
                    const NetInfo *nets[] = {
                            cell->getPort(id_INPUT_CLK),    compCell->getPort(id_INPUT_CLK),
                            cell->getPort(id_OUTPUT_CLK),   compCell->getPort(id_OUTPUT_CLK),
                            cell->getPort(id_CLOCK_ENABLE), compCell->getPort(id_CLOCK_ENABLE),
                    };

                    for (int i = 0; i < 6; i++)
                        if (use[i] && (nets[i] != nets[i ^ 1]) && (use[i ^ 1] || (nets[i ^ 1] != nullptr)))
                            return false;
                }
            }

            return get_bel_package_pin(bel) != "";
        } else if (cell->type == id_SB_GB) {
            if (cell->gbInfo.forPadIn)
                return true;
            NPNR_ASSERT(cell->ports.at(id_GLOBAL_BUFFER_OUTPUT).net != nullptr);
            const NetInfo *net = cell->ports.at(id_GLOBAL_BUFFER_OUTPUT).net;
            int glb_id = get_driven_glb_netwk(bel);
            if (net->is_reset && net->is_enable)
                return false;
            else if (net->is_reset)
                return (glb_id % 2) == 0;
            else if (net->is_enable)
                return (glb_id % 2) == 1;
            else
                return true;
        } else {
            // TODO: IO cell clock checks
            return true;
        }
    }
}

NEXTPNR_NAMESPACE_END
149'>149</a>
<a id='n150' href='#n150'>150</a>
</pre></td>
<td class='lines'><pre><code><style>pre { line-height: 125%; margin: 0; }
td.linenos pre { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px; }
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #ffffff; }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span><span class="gh">TMK Keyboard Firmware Core Library</span>
<span class="gh">==================================</span>
This is a keyboard firmware library with some useful features for Atmel AVR and Cortex-M.

Source code is available here: &lt;https://github.com/tmk/tmk_keyboard/tree/master/tmk_core&gt;


<span class="gu">Updates</span>
<span class="gu">-------</span>
<span class="gu">#### 2016/02/10</span>
flabbergast&#39;s Chibios protocol was merged from &lt;https://github.com/flabbergast/tmk_keyboard/tree/chibios&gt;. See [<span class="nt">protocol/chibios/README.md</span>](<span class="na">protocol/chibios/README.md</span>). Chibios protocol supports Cortex-M such as STM32 and Kinetis.

<span class="gu">#### 2015/04/22</span>
separated with TMK Keyboard Firmware Collection



<span class="gu">Features</span>
<span class="gu">--------</span>
These features can be used in your keyboard.

<span class="k">*</span> Multi-layer Keymap  - Multiple keyboard layouts with layer switching
<span class="k">*</span> Mouse key           - Mouse control with keyboard
<span class="k">*</span> System Control Key  - Power Down, Sleep, Wake Up and USB Remote Wake up
<span class="k">*</span> Media Control Key   - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
<span class="k">*</span> USB NKRO            - 248 keys(+ 8 modifiers) simultaneously
<span class="k">*</span> PS/2 mouse support  - PS/2 mouse(TrackPoint) as composite device
<span class="k">*</span> Keyboard protocols  - PS/2, ADB, M0110, Sun and other old keyboard protocols
<span class="k">*</span> User Function       - Customizable function of key with writing code
<span class="k">*</span> Macro               - Very primitive at this time
<span class="k">*</span> Keyboard Tricks     - Oneshot modifier and modifier with tapping feature
<span class="k">*</span> Debug Console       - Messages for debug and interaction with firmware
<span class="k">*</span> Virtual DIP Switch  - Configurations stored EEPROM(Boot Magic)
<span class="k">*</span> Locking CapsLock    - Mechanical switch support for CapsLock
<span class="k">*</span> Breathing Sleep LED - Sleep indicator with charm during USB suspend
<span class="k">*</span> Backlight           - Control backlight levels



<span class="gu">TMK Keyboard Firmware Collection</span>
<span class="gu">--------------------------------</span>
Complete firmwares for various keyboards and protocol converters.

&lt;https://github.com/tmk/tmk_keyboard&gt;



<span class="gu">License</span>
<span class="gu">-------</span>
<span class="gs">**GPLv2**</span> or later. Some protocol files are under <span class="gs">**Modified BSD License**</span>.
LUFA, PJRC and V-USB stack have their own license respectively.



<span class="gu">Build Firmware and Program Controller</span>
<span class="gu">-------------------------------------</span>
See [<span class="nt">doc/build.md</span>](<span class="na">https://github.com/tmk/tmk_keyboard/blob/master/tmk_core/doc/build.md</span>).



<span class="gu">Start Your Own Project</span>
<span class="gu">-----------------------</span>
<span class="gs">**TBD**</span>
<span class="gu">### Config.h Options</span>
<span class="gu">#### 1. USB vendor/product ID and device description</span>
    <span class="ni">#define</span> VENDOR_ID       0xFEED
    <span class="ni">#define</span> PRODUCT_ID      0xBEEF
    <span class="ni">#define</span> MANUFACTURER    t.m.k.
    <span class="ni">#define</span> PRODUCT         Macway mod
    <span class="ni">#define</span> DESCRIPTION     t.m.k. keyboard firmware for Macway mod

<span class="gu">#### 2. Keyboard matrix configuration</span>
    <span class="ni">#define</span> MATRIX_ROWS 8
    <span class="ni">#define</span> MATRIX_COLS 8
    <span class="ni">#define</span> MATRIX_HAS_GHOST



<span class="gu">Architecture</span>
<span class="gu">------------</span>
    Architecture Diagram
                               +---------------+---------------+-------------+
                               |    Host       |   Keyboard    | Matrix, LED |
       ___________             |-----------+-+ +-------------+ | +-----------|
      /          /| Keys/Mouse | Protocol  |d| | Action      | | | Protocol  |
     /__________/ |&lt;-----------|  LUFA     |r| |  Layer, Tap | | |  Matrix   |
     |.--------.| |   LED      |  V-USB    |i| |-------------| | |  PS/2,IBM |             __________________
     ||        || |-----------&gt;|  PJRC     |v| | Keymap      | | |  ADB,M0110|  Keys      / /_/_/_/_/_/_/_/ /|
     ||  Host  || |  Console   |  iWRAP(BT)|e| | Mousekey    | | |  SUN/NEWS |&lt;----------/ /_/_/_/_/_/_/_/ / /
     ||________||/.&lt;-----------|  UART     |r| | Report      | | |  X68K/PC98| Control  / /_/_/_/_/_/_/_/ / /
     `_========_&#39;/|            |---------------------------------------------|--------&gt;/___ /_______/ ___/ /
     |_o______o_|/             | Sendchar, Print, Debug, Command, ...        |         |_________________|/
                               +---------------------------------------------+              Keyboard



<span class="gu">Debugging</span>
<span class="gu">--------</span>
Use PJRC&#39;s <span class="sb">`hid_listen`</span> to see debug messages. You can use the tool for debug even if firmware use LUFA stack.

You can use xprintf() to display debug info on <span class="sb">`hid_listen`</span>, see <span class="sb">`common/xprintf.h`</span>.



<span class="gu">Files and Directories</span>
<span class="gu">-------------------</span>
<span class="gu">### Top</span>
<span class="k">*</span> common/       - common codes
<span class="k">*</span> protocol/     - keyboard protocol support
<span class="k">*</span> doc/          - documents
<span class="k">*</span> common.mk     - Makefile for common
<span class="k">*</span> protocol.mk    - Makefile for protocol
<span class="k">*</span> rules.mk      - Makefile for build rules

<span class="gu">### Common</span>
<span class="k">*</span> host.h
<span class="k">*</span> host_driver.h
<span class="k">*</span> keyboard.h
<span class="k">*</span> command.h
<span class="k">*</span> keymap.h
<span class="k">*</span> action.h
<span class="k">*</span> keycode.h
<span class="k">*</span> matrix.h
<span class="k">*</span> led.h
<span class="k">*</span> mousekey.h
<span class="k">*</span> report.h
<span class="k">*</span> debug.h
<span class="k">*</span> print.h
<span class="k">*</span> bootloader.h
<span class="k">*</span> sendchar.h
<span class="k">*</span> timer.h
<span class="k">*</span> util.h

<span class="gu">### Keyboard Protocols</span>
<span class="k">*</span> lufa/     - LUFA USB stack
<span class="k">*</span> pjrc/     - PJRC USB stack
<span class="k">*</span> vusb/     - Objective Development V-USB
<span class="k">*</span> iwrap/    - Bluetooth HID for Bluegiga iWRAP
<span class="k">*</span> ps2.c     - PS/2 protocol
<span class="k">*</span> adb.c     - Apple Desktop Bus protocol
<span class="k">*</span> m0110.c   - Macintosh 128K/512K/Plus keyboard protocol
<span class="k">*</span> news.c    - Sony NEWS keyboard protocol
<span class="k">*</span> x68k.c    - Sharp X68000 keyboard protocol
<span class="k">*</span> serial_soft.c - Asynchronous Serial protocol implemented by software



<span class="gu">Coding Style</span>
<span class="gu">-------------</span>
<span class="k">-</span> Doesn&#39;t use Tab to indent, use 4-spaces instead.
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.zx2c4.com/cgit/about/'>cgit v1.2.3</a> (<a href='https://git-scm.com/'>git 2.25.1</a>) at 2025-07-28 07:19:31 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>