FIJI.pm

#-----------------------------------------------------------------------
# Fault InJection Instrumenter (FIJI)
# https://embsys.technikum-wien.at/projects/vecs/fiji
#
# Copyright (C) 2017 Christian Fibich <fibich@technikum-wien.at>
# Copyright (C) 2017 Stefan Tauner <tauner@technikum-wien.at>
#
# This module is free software; you can redistribute it and/or modify
# it under the same terms as Perl itself.
#
# 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 LICENSE file for more details.
#-----------------------------------------------------------------------

## @file FIJI.pm
# @brief Contains class \ref FIJI

## @class FIJI
# @brief Various constants used in the FIJI packages.

package FIJI;

use strict;
use warnings;

use Cwd;
use Cwd 'realpath';
use File::Spec;
use Log::Log4perl qw(:easy);

use constant FIJI_DIR => realpath(File::Spec->rel2abs("..", $FindBin::Bin));

my $documentation_path;
BEGIN {
    my $pdf = 
        File::Spec->rel2abs(
            File::Spec->catfile(
                "..",
                "docs",
                "user_guide",
                "fiji_user_guide.pdf"
            ),
            $FindBin::Bin
        );
    
    eval { $pdf = realpath($pdf) };
    if ($@) {
        $pdf = undef;
    }
};
use constant FIJI_DOCUMENTATION_PATH => $documentation_path;

use constant FIJI_MEDIA_PATH => realpath(
    File::Spec->rel2abs(
        File::Spec->catfile(
            "..",
            "media",
        ),
        $FindBin::Bin
    )
);


my $version;
BEGIN {
    local $/ = undef;
    my $version_file = File::Spec->rel2abs(
        File::Spec->catfile(
            "..",
            "VERSION",
        ),
        $FindBin::Bin
    );
    open FILE, $version_file or die "Couldn't open VERSION file: $!";
    $version = <FILE>;
    close FILE;
};
use constant FIJI_VERSION => $version;

my @optimization_settings = qw(ALLOW OPT_OFF FIX_PLACEMENT);
use constant OPTIMIZATION_SETTINGS => \@optimization_settings;

#
# Maximal period polynomials for LFSRs of given lengths
# Thank you http://www.eej.ulst.ac.uk/~ian/modules/EEE515/files/old_files/lfsr/lfsr_table.pdf
# Our LFSR uses bit numbers are mirrored compared to the document above.
#
use constant LFSR_POLY_CHOICES => {
    2  => ['0x3'],
    3  => ['0x3'],
    4  => ['0x3'],
    5  => ['0x5', '0xF'],
    6  => ['0x3', '0x1B'],
    7  => ['0x3', '0xF'],
    8  => ['0x1D'],
    9  => ['0x11', '0x1B'],
    10 => ['0x9', '0x1B'],
    11 => ['0x5', '0x17'],
    12 => ['0x53'],
    13 => ['0x1B'],
    14 => ['0x2B'],
    15 => ['0x3', '0x17'],
    16 => ['0x2D'],
    17 => ['0x9', '0xF'],
    18 => ['0x81', '0x27'],
    19 => ['0x27'],
    20 => ['0x9', '0x53'],
    21 => ['0x5', '0x27'],
    22 => ['0x3', '0x39'],
    23 => ['0x21', '0x2B'],
    24 => ['0x1B'],
    25 => ['0x9', '0xF'],
    26 => ['0x47'],
    27 => ['0x27'],
    28 => ['0x9', '0x53'],
    29 => ['0x5', '0x17'],
    30 => ['0x53'],
    31 => ['0x9', '0xF'],
    32 => ['0xC5'],
    33 => ['0x2001', '0x53'],
    34 => ['0x119'],
    35 => ['0x5', '0x183'],
    36 => ['0x801', '0x183'],
    37 => ['0x53'],
    38 => ['0x63'],
    39 => ['0x11', '0x93'],
    40 => ['0x39'],
    41 => ['0x9', '0xF'],
    42 => ['0xA5'],
    43 => ['0x63'],
    44 => ['0x65'],
    45 => ['0x1B'],
    46 => ['0x1C1'],
    47 => ['0x21', '0x33'],
    48 => ['0x291'],
    49 => ['0x201', '0x71'],
    50 => ['0x1D'],
    51 => ['0x4B'],
    52 => ['0x9', '0x4B'],
    53 => ['0x47'],
    54 => ['0x149'],
    55 => ['0x1000001', '0x47'],
    56 => ['0x95'],
    57 => ['0x81', '0x2D'],
    58 => ['0x80001', '0x63'],
    59 => ['0x95'],
    60 => ['0x3', '0x35'],
    61 => ['0x27'],
    62 => ['0x69'],
    63 => ['0x3', '0x33'],
    64 => ['0x1B'],
};

use constant FIJI_LOGO => <<logo_end;
FIJIFIJIFIJIFIJIFIJIFIJIFIJIFIJIFIJIFIJI
FIJIFIJIFIJIFIJIF   FIJIFIJIFIJIFIJIFIJI
FIJIFIJIFIJIFIJ    IFIJIFIJIFIJIFIJIFIJI
FIJIF       FI           IJIFIJIFIJIFIJI
FIJIFIJIFI            JIFIJIFIJIFIJIFIJI
FIJIFIJI            FIJIFIJIFIJIFIJIFIJI
FIJIFI     I   IFI   IJIFIJIFIJIFIJIFIJI
FIJIF         JIFIJ   JIFIJIFIJIFIJIFIJI
FIJIFIJIFI   IJIFIJI   IFIJIFIJIFIJIFIJI
FIJIFIJIF    IJIFIJIFIJIFIJIFIJIFIJIFIJI
FIJIFIJI    FIJIFIJIFIJIFIJIFIJIFIJIFIJI
FIJIFIJ     FIJIF           FIJIFIJIFIJI
FIJIFI     IFI      Fault      IFIJIFIJI
FIJIF             InJection     FIJIFIJI
FIJ              Instrumenter    IJIFIJI
F                                    IJI
FIJIFIJIFIJIFIJIFIJIFIJIFIJIFIJIFIJIFIJI
logo_end

#** @var public %designmap Hash containing all FIJI::Settings
#
# Architecture from http://www.perlmonks.org/?node_id=1072731
#
# Fields:
#    - ini_name     key name in FIJI Settings file
#    - unit         (optional) physical unit
#    - type         enables type-specific conversions and tests:
#                   - natural: values must be oct, hex, binary strings looking like a real number.
#                   - hexadecimal: values must be hexadecimal numbers.
#                   - boolean: will be convert to a truth value by Perl semantics
#                   - net: name of a net from the input netlist
#                   FIXME: complete docs (e.g., dut_port, external_port)
#    - values       (optional) used to restrict valid values. Can be...
#                   - an array reference listing all valid values (emulates an enum)
#                   - a code reference to a function that gets the new plus old values
#                     (as well as the value of the dependency if there is one) and
#                     returns true if the new value is allowed, or false otherwise.
#    - phases_opt   (optional) list of phases (subset of "setup", "instrument", "download")
#                   where no value must be present in input (e.g. ID is only necessary while downloading).
#    - phases_moot  (optional) list of phases (subset of "setup", "instrument", "download")
#                   where values present in the input are not validated at all.
#    - depends_on   (optional) specifies the key of another constant.
#                   The respective constant is only relevant (and thus required as input)
#                   if the value of the referenced constant is true.
#    - group        (optional) specifies how to group this value in output. Value will not be displayed if undef
#    - order        (optional) specifies how to sort this value in output group
#    - noedit       (optional) display value, but don't allow to alter
#    - default      (optional) default value if not given in file and not determinable otherwise
#    - help         (optional) short help text, e.g. to be displayed via Tk:Balloon
#    - forbidden_by (optional) specifies the key of another constant
#                     The respective constant may not be enabled if the value
#                     of the referenced constant is true
my %designmap;

BEGIN {
    %designmap = (
        FIU_NUM => {
            description => "Number of FIUs",
            ini_name    => "FIU_NUM",
            type        => 'natural',
            phases_opt  => [qw(setup instrument download)],    # auto-generated if need be
        },
        FIU_CFG_BITS => {
            description => "Bits per FIU pattern",
            ini_name    => "FIU_CFG_BITS",
            default     => 3,
            type        => 'natural',
            phases_opt  => [qw(setup instrument download)],    # currently not user-configurable at all
        },
        CFGS_PER_MSG => {
            description => "Patterns sent per FIU configuration",
            ini_name    => "CFGS_PER_MSG",
            default     => 2,
            type        => 'natural',
            phases_opt  => [qw(setup instrument download)],    # currently not user-configurable at all
        },
        CLOCK_NET => {
            type        => 'net',
            description => "Clock net",
            help        => "Select a net in the DUT which shall be used to clock the FIJI logic",
            ini_name    => "CLOCK_NET",
            default     => "",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            group       => 'clock',
            order       => 10
        },
        FREQUENCY => {
            description => "Clock frequency",
            help        => "Enter the clock frequency in Hz.\n This information is needed e.g. to calculate the Baud rate prescaler",
            ini_name    => "FREQUENCY",
            default     => 50e6,
            type        => 'natural',
            phases_opt  => [qw(setup download)],
            unit        => 'Hz',
            group       => 'clock',
            order       => 20,
        },
        OUTPUT_DIR => {
            description => "Output directory",
            help        => "Output directory for FIJI Instrument (relative to location of FIJI settings file)",
            ini_name    => "OUTPUT_DIR",
            default     => ".",
            type        => 'dir',
            group       => 'general_control',
            phases_opt  => [qw(setup)],
            order       => 5,
        },
        INST_LOG => {
            description => "Instrumentation log file",
            help        => "Log file for FIJI Instrumentation tool (relative to location of FIJI settings file)",
            ini_name    => "INST_LOG",
            default     => "fiji_instrument.log",
            type        => 'file',
            group       => 'general_control',
            phases_opt  => [qw(setup)],
            order       => 6,
        },
        BAUDRATE => {
            description => "Baud rate",
            help        => "Enter the Baud rate for communication between Host and FIJI logic.",
            ini_name    => "BAUDRATE",
            default     => 115200,
            type        => 'natural',
            unit        => 'bps',
            group       => 'general_control',
            order       => 10,
            depends_on  => "FREQUENCY",
            values      => sub {
                my ($baud, $old, $fclk) = @_;
                if (defined $fclk) {
                    return $baud < $fclk;
                } else {
                    return 1;
                }
              }
        },
        ID => {
            description => "Design ID",
            help        => "The design ID is automatically calculated upon instrumentation.",
            ini_name    => "ID",
            type        => 'hexadecimal',
            phases_opt  => [qw(setup instrument)],                                              # generated in instrumentation
            noedit      => 1,
        },
        TIMER_WIDTH => {
            description => "Timer width",
            help        => "Enter the timer width in bytes.\n This influences the maximum fault duration.",
            ini_name    => "TIMER_WIDTH",
            default     => 4,
            type        => 'natural',
            unit        => 'bytes',
            values      => sub {
                my $val = shift;
                return ($val > 0 && $val <= 16);
            },
            group => 'general_control',
            order => 20,
        },
        LFSR_WIDTH => {
            description => "LFSR width",
            help        => "Enter the width of the LFSR in bits.\n The LFSR is used to emulate \"floating\" nets in the stuck-open model.",
            ini_name    => "LFSR_WIDTH",
            default     => 16,
            type        => 'natural',
            unit        => 'bits',
            values      => sub {
                my $val = shift;
                return $val > 0 && $val <= 64;
            },
            group => 'lfsr',
            order => 10,
        },
        LFSR_POLY => {
            description => "LFSR polynomial",
            help        => "Enter the polynomial for the LFSR.\n The LFSR is used to emulate \"floating\" nets in the stuck-open model.",
            ini_name    => "LFSR_POLY",
            default     => 0x2D,
            type        => 'lfsrpoly',
            unit        => 'hex',
            depends_on  => 'LFSR_WIDTH',
            values      => sub {
                my ($val, $old, $top) = @_;
                $top = 64 if !defined $top;
                return $val > 0 && $val <= (2**($top) - 1);
            },
            group => 'lfsr',
            order => 20,
        },
        LFSR_SEED => {
            description => "LFSR seed value",
            help        => "Enter the starting value for the LFSR.\n The LFSR is used to emulate \"floating\" nets in the stuck-open model.",
            ini_name    => "LFSR_SEED",
            default     => 0xCAFE,
            type        => 'hexadecimal',
            unit        => 'hex',
            depends_on  => 'LFSR_WIDTH',
            values      => sub {
                my ($val, $old, $top) = @_;
                $top = 64 if !defined $top;
                return $val > 0 && $val <= (2**($top) - 1);
            },
            group => 'lfsr',
            order => 30,
        },

        # External reset
        RST_EXT_EN => {
            description => "Use external reset",
            help        => "If enabled, the FIJI logic can be reset using an FPGA pin.",
            ini_name    => "RST_EXT_EN",
            type        => 'boolean',
            default     => 0,
            phases_opt  => ['setup'],
            group       => 'reset_external',
            order       => 10,
        },
        RST_EXT_ACT => {
            description => "External Reset: Active level",
            help        => "If enabled, the FIJI logic can be reset using an FPGA pin.",
            ini_name    => "RST_EXT_ACT",
            type        => 'bit',
            values      => [qw(0 1)],
            default     => '1',
            phases_opt  => ['setup', 'download'],
            depends_on  => 'RST_EXT_EN',
            group       => 'reset_external',
            order       => 20,
        },
        RST_EXT_IN_NAME => {
            description => "External Reset: Port name",
            help        => "Specify the name of the external reset port in the wrapper.\nThis port name must not exist in the toplevel.",
            ini_name    => "RST_EXT_IN_NAME",
            default     => "s_fiji_reset_i",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            type        => "external_port",
            group       => 'reset_external',
            depends_on  => 'RST_EXT_EN',
            order       => 30,
        },

        # Reset from DUT
        RST_DUT_OUT_EN => {
            description  => "Enable DUT-to-FIJI reset",
            help         => "If enabled, a net in the DUT is used as a reset source for the FIJI logic.",
            ini_name     => "RST_DUT_OUT_EN",
            type         => 'boolean',
            default      => 0,
            phases_opt  => ['setup'],
            group        => 'reset_from_dut',
            forbidden_by => 'RST_DUT_IN_EN',
            order        => 10,
        },
        RST_DUT_OUT_NAME => {
            description => "Source for DUT-to-FIJI reset",
            help        => "If enabled, a net in the DUT is used as a reset source for the FIJI logic.",
            ini_name    => "RST_DUT_OUT_NAME",
            depends_on  => 'RST_DUT_OUT_EN',
            type        => 'net',
            default     => "",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            group       => 'reset_from_dut',
            order       => 30,
        },
        RST_DUT_OUT_ACT => {
            description => "Active level of DUT-to-FIJI reset",
            help        => "If enabled, a net in the DUT is used as a reset source for the FIJI logic.",
            ini_name    => "RST_DUT_OUT_ACT",
            type        => 'bit',
            values      => [qw(0 1)],
            default     => '1',
            phases_opt  => ['setup'],
            depends_on  => 'RST_DUT_OUT_EN',
            group       => 'reset_from_dut',
            order       => 20,
        },

        # Reset to DUT
        RST_DUT_IN_EN => {
            description  => "Enable FIJI-to-DUT reset",
            help         => "If enabled, the DUT will be reset from the FIJI logic.",
            ini_name     => "RST_DUT_IN_EN",
            type         => 'boolean',
            default      => 0,
            phases_opt  => ['setup'],
            group        => 'reset_to_dut',
            forbidden_by => 'RST_DUT_OUT_EN',
            order        => 10,
        },
        RST_DUT_IN_NAME => {
            description => "Port for FIJI-to-DUT reset",
            help        => "The specified DUT reset input will be connected\n to the FIJI logic's reset output.",
            ini_name    => "RST_DUT_IN_NAME",
            default     => "",
            phases_opt  => [qw(setup download)],
            depends_on  => 'RST_DUT_IN_EN',
            type        => 'dut_port',
            group       => 'reset_to_dut',
            order       => 40,
        },
        RST_DUT_IN_DUR => {
            description => "Duration for FIJI-to-DUT reset",
            help        => "Enter the duration of each FIJI-to-DUT reset operation in clock cycles.",
            ini_name    => "RST_DUT_IN_DUR",
            type        => 'natural',
            default     => 1,
            phases_opt  => ['setup'],
            unit        => 'cycles',
            values      => sub {
                my $val = shift;
                return $val > 0 && $val <= 2**32 - 1;
            },
            depends_on => 'RST_DUT_IN_EN',
            group      => 'reset_to_dut',
            order      => 30,
        },
        RST_DUT_IN_ACT => {
            description => "Active level of FIJI-to-DUT reset",
            help        => "Enter the level the FIJI-to-DUT reset signal shall be brought to during reset.",
            ini_name    => "RST_DUT_IN_ACT",
            type        => 'bit',
            values      => [qw(0 1)],
            default     => '1',
            phases_opt  => ['setup'],
            depends_on  => 'RST_DUT_IN_EN',
            group       => 'reset_to_dut',
            order       => 20,
        },

        # Trigger from DUT
        TRIG_DUT_EN => {
            description => "Enable DUT-to-FIJI trigger",
            help        => "If enabled, a signal in the DUT can be selected to trigger fault injection operations.\n" . "Once a pattern is downloaded with the INTERNAL trigger enabled, the FIJI logic waits for\n" . "an inactive-to-active transition on this signal before starting to count down duration t1.",
            ini_name    => "TRIG_DUT_EN",
            type        => 'boolean',
            default     => 0,
            phases_opt  => ['setup'],
            group       => 'trigger',
            order       => 10,
        },

        TRIG_DUT_ACT => {
            description => "Active level of DUT-to-FIJI trigger",
            help        => "Select the signal level to trigger fault injection.",
            ini_name    => "TRIG_DUT_ACT",
            type        => 'bit',
            values      => [qw(0 1)],
            default     => '1',
            phases_opt  => ['setup'],
            depends_on  => 'TRIG_DUT_EN',
            group       => 'trigger',
            order       => 20,
        },

        TRIG_DUT_NAME => {
            description => "Source net for DUT-to-FIJI trigger",
            help        => "Select the net in the DUT which shall be used to trigger fault injection operations.",
            ini_name    => "TRIG_DUT_NAME",
            default     => "",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            depends_on  => 'TRIG_DUT_EN',
            type        => 'net',
            group       => 'trigger',
            order       => 30,
        },

        # External trigger
        TRIG_EXT_EN => {
            description => "Enable external trigger",
            help        => "If enabled, an I/O port can be selected to trigger fault injection operations.\n" . "Once a pattern is downloaded with the EXTERNAL trigger enabled, the FIJI logic waits for \n" . "an inactive-to-active transition on this port before starting to count down duration t1. \n" . "The port is synchronized to the FIJI logic's clock, thus introducing a few clock cycles delay.",
            ini_name    => "TRIG_EXT_EN",
            type        => 'boolean',
            default     => 0,
            phases_opt  => ['setup'],
            group       => 'trigger',
            order       => 40,
        },
        TRIG_EXT_ACT => {
            description => "Active level of external trigger",
            help        => "Select the port level to trigger fault injection.",
            ini_name    => "TRIG_EXT_ACT",
            type        => 'bit',
            values      => [qw(0 1)],
            default     => '1',
            phases_opt  => ['setup'],
            depends_on  => 'TRIG_EXT_EN',
            group       => 'trigger',
            order       => 50,
        },
        TRIG_EXT_IN_NAME => {
            description => "External trigger port name",
            help        => "Specify the name of the external trigger port in the wrapper.\nThis port name must not exist in the toplevel.",
            ini_name    => "TRIG_EXT_IN_NAME",
            type        => "external_port",
            default     => "s_fiji_trig_ext_i",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            depends_on  => 'TRIG_EXT_EN',
            group       => "trigger",
            order       => 60,
        },
        FD_1_EN => {
            description => "Enable fault-detect bit 1",
            help        => "If enabled, a signal in the DUT can be selected as a return channel.\n" . "This could e.g. be the output of a fault detection unit. \n" . "The FIJI logic registers inactive-to-active transition on this signal and returns the status \n" . "in the serial communication messages to the host.",
            ini_name    => "FD_1_EN",
            type        => 'boolean',
            default     => 0,
            phases_opt  => ['setup'],
            group       => 'fault_detect',
            order       => 10,
        },
        FD_1_NAME => {
            description => "Source net for fault-detect bit 1",
            help        => "Select the net in the DUT which shall be used for the fault detection feature.",
            ini_name    => "FD_1_NAME",
            type        => 'net',
            default     => "",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            depends_on  => 'FD_1_EN',
            group       => 'fault_detect',
            order       => 20,
        },
        FD_1_INVERT => {
            description => "Invert fault detect bit 1",
            help        => "Specifies if the selected net shall be inverted prior to edge detection.\n" . "Leave unchecked if the net uses positive logic.",
            ini_name    => "FD_1_INVERT",
            type        => 'boolean',
            values      => [qw(0 1)],
            default     => '0',
            phases_opt  => ['setup'],
            depends_on  => 'FD_1_EN',
            group       => 'fault_detect',
            order       => 30,
        },
        FD_2_EN => {
            description => "Enable fault-detect bit 2",
            help        => "If enabled, a signal in the DUT can be selected as a return channel.\n" . "This could e.g. be the output of a fault detection unit. \n" . "The FIJI logic registers inactive-to-active transition on this signal and returns the status \n" . "in the serial communication messages to the host.",
            ini_name    => "FD_2_EN",
            type        => 'boolean',
            default     => 0,
            phases_opt  => ['setup'],
            group       => 'fault_detect',
            order       => 40,
        },
        FD_2_NAME => {
            description => "Source net for fault-detect bit 2",
            help        => "Select the net in the DUT which shall be used for the fault detection feature.",
            ini_name    => "FD_2_NAME",
            type        => 'net',
            default     => "",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            depends_on  => 'FD_2_EN',
            group       => 'fault_detect',
            order       => 50,
        },
        FD_2_INVERT => {
            description => "Invert fault detect bit 2",
            help        => "Specify if the selected net shall be inverted prior to edge detection.\n" . "Leave unchecked if the net uses positive logic.",
            ini_name    => "FD_2_INVERT",
            type        => 'boolean',
            values      => [qw(0 1)],
            default     => '0',
            phases_opt  => ['setup'],
            depends_on  => 'FD_2_EN',
            group       => 'fault_detect',
            order       => 60,
        },
        RX_IN_NAME => {
            description => "RX port name",
            help        => "Specify the name of the Host-to-FIJI serial RX port in the wrapper.\nThis port name must not exist in the toplevel.",
            ini_name    => "RX_IN_NAME",
            type        => "external_port",
            default     => "s_fiji_rx_i",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            group       => "general_control",
            order       => 11,
        },
        TX_OUT_NAME => {
            description => "TX port name",
            help        => "Specify the name of the FIJI-to-Host serial TX port in the wrapper.\nThis port name must not exist in the toplevel.",
            ini_name    => "TX_OUT_NAME",
            type        => "external_port",
            default     => "s_fiji_tx_o",
            phases_opt  => [qw(setup)],
            phases_moot => [qw(download)],
            group       => "general_control",
            order       => 12,
        },
        OPTIMIZATIONS => {
            description => "Optimization Settings",
            help        => "Specifies which set of constraints to use in synthesis/P&R to\n- prevent optimizations and/or\n- fix physical placement.",
            ini_name    => "OPTIMIZATIONS",
            type        => "dropdown",
            values      => \@optimization_settings,
            default     => "ALLOW",
            phases_opt  => [qw(setup)],
            group       => "general_control",
            order       => 50,
        },
        SYNTHESIS_TOOL => {
            description => "Synthesis Tool",
            help        => "The FPGA synthesis tool that will be used. Needed for generating appropriate constraints.",
            ini_name    => "SYNTHESIS_TOOL",
            type        => "dropdown",
            values      => ["SYNPLIFY_PRO"],
            default     => "SYNPLIFY_PRO",
            phases_opt  => [qw(setup)],
            group       => "general_control",
            order       => 60,
        },
        IMPL_TOOL => {
            description => "Implementation Tool",
            help        => "The FPGA implementation tool that will be used. Needed for generating appropriate constraints.",
            ini_name    => "IMPL_TOOL",
            type        => "dropdown",
            values      => ["ALTERA_QUARTUS", "XILINX_VIVADO"],
            default     => "ALTERA_QUARTUS",
            phases_opt  => [qw(setup)],
            group       => "general_control",
            order       => 70,
        },
    );
}

use constant \%designmap;
use constant DESIGNMAP => \%designmap;

#** @var public %displaygroups Hash containing groups for displaying \ref designmap
##
# Fields:
#    -title         Just a short title
#    -subtitle      ...
#    -description   Longer description
#    -order         The sorting order to display this group
my %displaygroups;

BEGIN {
    %displaygroups = (
        fault_detect => {
            title       => "Fault Detection Settings",
            subtitle    => "",
            description => "Settings concerning internal fault detection propagation",
            order       => 80,
        },
        trigger => {
            title       => "Trigger Settings",
            subtitle    => "",
            description => "Settings concerning internal and external fault injection triggers",
            order       => 70,
        },
        reset_to_dut => {
            title       => "Reset from FIJI to DUT",
            subtitle    => "",
            description => "Settings concerning FIJI's ability to reset the DUT",
            order       => 60,
        },
        reset_from_dut => {
            title       => "Reset from DUT to FIJI",
            subtitle    => "",
            description => "Settings concerning FIJI's internal (from DUT) reset feature",
            order       => 50,
        },
        reset_external => {
            title       => "External Reset",
            subtitle    => "",
            description => "Settings concerning FIJI's external (via pin) reset feature",
            order       => 40,
        },
        lfsr => {
            title       => "LFSR Settings",
            subtitle    => "",
            description => "Settings concerning the LFSR for Stuck-open emulation",
            order       => 30,
        },
        general_control => {
            title       => "General settings",
            subtitle    => "",
            description => "Settings concerning miscellaneous features of FIJI",
            order       => 10,
        },
        clock => {
            title       => "Clock settings",
            subtitle    => "",
            description => "Settings concerning the clocking of the FIJI logic",
            order       => 20,
        },
        fius => {
            title       => "FIUs",
            subtitle    => "",
            description => "Settings concerning Fault Injection Units",
            order       => 100
        }
    );
}

use constant \%displaygroups;
use constant DISPLAYGROUPS => \%displaygroups;
use constant DISPLAYGROUPS_FIU_KEY => 'fius';

## @var public %fiumap Hash containing all FIJI::Settings for FIUs
#
# Fields:
#    - ini_name     key name in FIJI Settings file
#    - unit         (optional) physical unit
#    - type         (optional) enables type-specific conversions and tests:
#                   - natural: values must be oct, hex, binary strings looking like a real number.
#                   - hexadecimal: values must be hexadecimal numbers.
#                   - boolean: will be convert to a truth value by Perl semantics
#                   - net: hierarchical path of a net from the input netlist
#                   - driver: driver-specific hierarchical path of a net from the input netlist
#    - values       (optional) used to restrict valid values. Can be...
#                   - an array reference listing all valid values (emulates an enum)
#                   - a code reference to a function that gets the new and old values and
#                     returns true if the new value is allowed, or false otherwise.
#    - phases_opt   (optional) list of phases (subset of "setup", "instrument", "download")
#                   where no value must be present in input (e.g. ID is only necessary while downloading).
#    - group        (optional) specifies how to group this value in output. Value will not be displayed if undef
#    - default      (optional) default value if not given in file and not determinable otherwise.
#                   Can either be a scalar or a function pointer expecting following parameters:
#                   related FIJI settings hash, the tool phase, FIJI design settings, FIU number.
my %fiumap;

BEGIN {
    %fiumap = (
        FIU_NAME => {
            ini_name => "NAME",
            default  => "",
            help     => "Display name for this FIU",
            phases_opt => [qw(setup instrument download)]
        },
        FIU_NET_NAME => {
            ini_name   => "NET_NAME",
            default    => "",
            type       => 'net',
            help       => "String representation of the instrumented net.",
            phases_opt  => [qw(setup)], # Either FIU or net name is strongly recommended during download
            phases_moot => [qw(download)],
        },
        FIU_DRIVER_TYPE => {
            ini_name   => "DRIVER_TYPE",
            values     => [qw(PIN PORT ASSIGN)],
            default    => "PIN",
            phases_opt => [qw(setup)],
        },
        FIU_DRIVER_PATH => {
            ini_name   => "DRIVER_PATH",
            default    => "",
            type       => 'driver',
            help       => "String representation of a driver.",
            phases_opt  => [qw(setup)], # Either FIU or net name is strongly recommended during download
            phases_moot => [qw(download)],
        },
        FIU_MODEL => {
            ini_name   => "FAULT_MODEL",
            default    => "RUNTIME",
            values     => [qw(RUNTIME PASS_THRU STUCK_AT_0 STUCK_AT_1 STUCK_OPEN DELAY SEU)],
            help       => "Possible fault models: no fault (PASS_THRU), a single mode that can be switched on and off, or selection and activation of the type at RUNTIME.",
            phases_opt => [qw(setup)],
        },
        FIU_LFSR_MASK => {
            ini_name   => "LFSR_MASK",
            default    => sub {
                my ($consts_ref, $phase, $design_ref, $i) = @_;
                $i = 0 if !defined($i);
                my $mask_width = defined($design_ref) && defined($design_ref->{'LFSR_WIDTH'}) ? $design_ref->{'LFSR_WIDTH'} : 1;
                return 1 << ($i % $mask_width);
            },
            type       => 'hexadecimal',
            help       => "Selects the bits of the LFSR that are ANDed together to determine the value of a floating net.",
            phases_opt => [qw(setup)],
        },
    );
}

use constant \%fiumap;
use constant FIUMAP => \%fiumap;

#** @var public %testconstmap Hash containing all global values of FIJI::Tests
#
# Fields:
#    - ini_name     key name in FIJI Tests file
#    - unit         (optional) physical unit
#    - type         (optional) enables type-specific conversions and tests:
#                   - natural: values must be oct, hex, binary strings looking like a real number.
#                   - hexadecimal: values must be hexadecimal numbers.
#                   - boolean: will be convert to a truth value by Perl semantics
#                   - net: name of a net from the input netlist
#    - values       (optional) used to restrict valid values. Can be...
#                   - an array reference listing all valid values (emulates an enum)
#                   - a code reference to a function that gets the old value and current settings and
#                     returns the allowed value(s).
#    - phases_opt   (optional) list of phases (subset of "setup", "instrument", "download")
#                   where no value must be present in input (e.g. ID is only necessary while downloading).
#    - gui_modes    (optional) specifies in which mode of {manual,auto,random} this key will be displayed in the GUI
#    - depends_on   (optional) specifies the key of another constant.
#                   The respective constant is only relevant (and thuse required as input)
#                   if the value of the referenced constant is true.
#    - order        (optional) specifies how to sort this value in output group
#    - default      (optional) default value if not given in file and not determinable otherwise.
#                   Can either be a scalar or a function pointer expecting a FIJI settings reference.
#    - help         (optional) short help text, e.g. to be displayed via Tk:Balloon
#                     The respective constant may not be enabled if the value
#                     of the referenced constant is true
my %testconstmap;

BEGIN {
    %testconstmap = (
        FIJI_CFG => {
            description => "FIJI Settings File",
            ini_name    => "FIJI_CFG",
            default     => "fiji.cfg",

            #gui_modes   => [qw (manual auto random)],
        },
        UART => {
            description => "Control UART",
            ini_name    => "UART",
            default     => sub {
                my $devs = FIJI::Utils::get_uart_devs();
                return (scalar(@$devs) > 0) ? @{$devs}[0] : "";
            },
            help        => "The host's serial port connected to FIJI.\nLinux/Unix: /dev/ttyUSBx, /dev/ttyACMx, /dev/ttySx\nWindows: COMx",
            type        => "autocomplete",
        },
        HALT_ON_FAULT_DETECT => {
            description           => "Halt on detected fault?",
            ini_name              => "HALT_ON_FAULT_DETECT",
            default               => 1,
            type                  => 'boolean',
            phases_opt            => [qw(manual)],
            gui_modes             => [qw (auto random)],
            order                 => 10,
            activated_by_settings => sub {
                my $settings = shift;
                return ($settings->{'design'}->{'FD_1_EN'} == 1 || $settings->{'design'}->{'FD_2_EN'} == 1);
            },
            help                  => "Specify if the injection campaign shall be aborted when a fault has been detected"
        },
        NUM_TESTS => {
            ini_name   => "NUM_TESTS",
            type       => 'natural',
            phases_opt => [qw(manual)],
        },
        REPEAT => {
            description => "Repeat Injection?",
            ini_name    => "REPEAT",
            default     => 0,
            type        => 'boolean',
            phases_opt  => [qw(manual)],
            gui_modes   => [qw (auto)],
            order       => 12,
            help        => "Specify if the injection campaign shall start again after the last test",
        },
        REPEAT_OFFSET => {
            description => "Repetition start pattern",
            ini_name    => "REPEAT_OFFSET",
            default     => 0,
            type        => 'natural',
            phases_opt  => [qw(manual)],
            gui_modes   => [qw (auto)],
            order       => 13,
            depends_on  => "REPEAT",
            help        => "Specify an offset for all repetitions except the first"
        },
        REPEAT_NUM => {
            description => "Number of repetitions",
            ini_name    => "REPEAT_NUM",
            default     => 0,
            type        => 'natural',
            phases_opt  => [qw(manual)],
            gui_modes   => [qw (auto)],
            order       => 14,
            depends_on  => "REPEAT",
            help        => "Specify a number of repetitions"
        },

        HALT_ON_UART_ERROR => {
            ini_name   => "HALT_ON_UART_ERROR",
            default    => 1,
            type       => 'boolean',
            phases_opt => [qw(manual)],
        },
        HALT_ON_CRC_ERROR => {
            ini_name   => "HALT_ON_CRC_ERROR",
            default    => 1,
            type       => 'boolean',
            phases_opt => [qw(manual)],
        },
        HALT_ON_ID_ERROR => {
            ini_name   => "HALT_ON_ID_ERROR",
            default    => 1,
            type       => 'boolean',
            phases_opt => [qw(manual)],
        },
        HALT_ON_UNDERRUN => {
            description => "Halt on buffer underrun?",
            ini_name    => "HALT_ON_UNDERRUN",
            default     => 0,
            type        => 'boolean',
            phases_opt  => [qw(manual)],
            gui_modes   => [qw (auto random)],
            order       => 11,
            help        => "Specify if the injection campaign shall be halted when the FIC reported that a pattern did not arrive in time."
        },
        MULTIFAULT => {
            description => "Generate multiple faults per pattern?",
            ini_name    => "MULTIFAULT",
            default     => 1,
            type        => 'boolean',
            phases_opt  => [qw(manual auto)],
            gui_modes   => [qw (random)],
            order       => 60,
            help        => "Allow multiple FIUs to generate errors within one pattern"
        },
        MIN_DUR_T1 => {
            description => "Minimum Duration T1",
            ini_name    => "MIN_DUR_T1",
            default     => sub {shift->default_timer_value()},
            phases_opt  => [qw(manual auto)],
            gui_modes   => [qw (random)],
            type        => "min_duration",
            matching    => "MAX_DUR_T1",
            unit        => "cycles",
            order       => 20,
            help        => "Minimum duration before the first fault is applied."
        },
        MIN_DUR_T2 => {
            description => "Minimum Duration T2",
            ini_name    => "MIN_DUR_T2",
            default     => sub {shift->default_timer_value()},
            phases_opt  => [qw(manual auto)],
            gui_modes   => [qw (random)],
            type        => "min_duration",
            matching    => "MAX_DUR_T2",
            unit        => "cycles",
            order       => 40,
            help        => "Minimum duration to keep the first fault is enabled."
        },
        MAX_DUR_T1 => {
            description => "Maximum Duration T1",
            ini_name    => "MAX_DUR_T1",
            default     => sub {10 * shift->default_timer_value()},
            phases_opt  => [qw(manual auto)],
            gui_modes   => [qw (random)],
            type        => "max_duration",
            matching    => "MIN_DUR_T1",
            unit        => "cycles",
            order       => 30,
            help        => "Maximum duration before the first fault is applied."
        },
        MAX_DUR_T2 => {
            description => "Maximum Duration T2",
            ini_name    => "MAX_DUR_T2",
            default     => sub {10 * shift->default_timer_value()},