UberDDR3/delete_later/rtl/cpu/idecode.v

2182 lines
54 KiB
Verilog

////////////////////////////////////////////////////////////////////////////////
//
// Filename: idecode.v
// {{{
// Project: 10Gb Ethernet switch
//
// Purpose: This RTL file specifies how instructions are to be decoded
// into their underlying meanings.
//
// Creator: Dan Gisselquist, Ph.D.
// Gisselquist Technology, LLC
//
////////////////////////////////////////////////////////////////////////////////
// }}}
// Copyright (C) 2023, Gisselquist Technology, LLC
// {{{
// This file is part of the ETH10G project.
//
// The ETH10G project contains free software and gateware, licensed under the
// Apache License, Version 2.0 (the "License"). You may not use this project,
// or this file, except in compliance with the License. You may obtain a copy
// of the License at
// }}}
// http://www.apache.org/licenses/LICENSE-2.0
// {{{
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations
// under the License.
//
////////////////////////////////////////////////////////////////////////////////
//
`default_nettype none
// }}}
module idecode #(
// {{{
parameter ADDRESS_WIDTH=24,
parameter [0:0] OPT_MPY = 1'b1,
parameter [0:0] OPT_SHIFTS = 1'b1,
parameter [0:0] OPT_EARLY_BRANCHING = 1'b1,
parameter [0:0] OPT_PIPELINED = 1'b1,
parameter [0:0] OPT_DIVIDE = (OPT_PIPELINED),
parameter [0:0] OPT_FPU = 1'b0,
parameter [0:0] OPT_CIS = 1'b1,
parameter [0:0] OPT_LOCK = (OPT_PIPELINED),
parameter [0:0] OPT_OPIPE = (OPT_PIPELINED),
parameter [0:0] OPT_SIM = 1'b0,
parameter [0:0] OPT_SUPPRESS_NULL_BRANCHES = 1'b0,
parameter [0:0] OPT_USERMODE = 1'b1,
parameter [0:0] OPT_LOWPOWER = 1'b0,
localparam AW = ADDRESS_WIDTH
// }}}
) (
// {{{
input wire i_clk, i_reset, i_ce, i_stalled,
input wire [31:0] i_instruction,
input wire i_gie,
input wire [(AW+1):0] i_pc,
input wire i_pf_valid, i_illegal,
output wire o_valid, o_phase,
output reg o_illegal,
output reg [(AW+1):0] o_pc,
output reg [6:0] o_dcdR, o_dcdA, o_dcdB,
output wire [4:0] o_preA, o_preB,
output wire [31:0] o_I,
output reg o_zI,
output reg [3:0] o_cond,
output reg o_wF,
output reg [3:0] o_op,
output reg o_ALU, o_M, o_DV, o_FP, o_break,
output reg o_lock,
output reg o_wR, o_rA, o_rB,
output wire o_early_branch, o_early_branch_stb,
output wire [(AW+1):0] o_branch_pc,
output wire o_ljmp,
output wire o_pipe,
output reg o_sim /* verilator public_flat */,
output reg [22:0] o_sim_immv /* verilator public_flat */
`ifdef FORMAL
, output reg [31:0] f_insn_word,
output reg f_insn_gie,
output wire f_insn_is_pipeable
`endif
// }}}
);
// Declarations
// {{{
localparam [3:0] CPU_SP_REG = 4'hd,
CPU_CC_REG = 4'he,
CPU_PC_REG = 4'hf;
localparam CISBIT = 31,
CISIMMSEL = 23,
IMMSEL = 18;
wire [4:0] w_op;
wire w_ldi, w_mov, w_cmptst, w_ldilo, w_ALU, w_brev,
w_noop, w_lock, w_sim, w_break, w_special, w_add, w_mpy;
wire [4:0] w_dcdR, w_dcdB, w_dcdA;
wire w_dcdR_pc, w_dcdR_cc;
wire w_dcdA_pc, w_dcdA_cc;
wire w_dcdB_pc, w_dcdB_cc;
wire [3:0] w_cond;
wire w_wF, w_mem, w_sto, w_div, w_fpu;
wire w_wR, w_rA, w_rB, w_wR_n;
wire w_ljmp, w_ljmp_dly, w_cis_ljmp;
wire [31:0] iword;
wire pf_valid;
reg [14:0] r_nxt_half;
reg [4:0] w_cis_op;
reg [22:0] r_I, w_fullI;
wire [22:0] w_I;
wire w_Iz;
reg [1:0] w_immsrc;
reg r_valid;
wire insn_is_pipeable, illegal_shift;
// }}}
assign pf_valid = (i_pf_valid)&&(!o_early_branch_stb);
// iword
// {{{
generate if (OPT_CIS)
begin : SET_IWORD
assign iword = (o_phase)
// set second half as a NOOP ... but really
// shouldn't matter
? { 1'b1, r_nxt_half[14:0], i_instruction[15:0] }
: i_instruction;
end else begin : CLR_IWORD
assign iword = { 1'b0, i_instruction[30:0] };
// verilator coverage_off
// verilator lint_off UNUSED
wire unused_nxt_half;
assign unused_nxt_half = &{ 1'b0, r_nxt_half };
// verilator lint_on UNUSED
// verilator coverage_on
end endgenerate
// }}}
// w_ljmp, w_cis_ljmp : Long jump early branching
// {{{
generate
if (OPT_EARLY_BRANCHING)
begin : GEN_CIS_LONGJUMP
if (OPT_CIS)
begin : CIS_EARLY_BRANCHING
assign w_cis_ljmp = (o_phase)&&(iword[31:16] == 16'hfcf8);
end else begin : NOCIS_EARLY_BRANCH
assign w_cis_ljmp = 1'b0;
end
assign w_ljmp = (iword == 32'h7c87c000);
end else begin : NO_CIS_JUMPING
assign w_cis_ljmp = 1'b0;
assign w_ljmp = 1'b0;
end endgenerate
// }}}
// w_cis_op : Get the opcode
// {{{
generate if (OPT_CIS)
begin : GEN_CIS_OP
always @(*)
if (!iword[CISBIT])
w_cis_op = iword[26:22];
else case(iword[26:24])
3'h0: w_cis_op = 5'h00; // SUB
3'h1: w_cis_op = 5'h01; // AND
3'h2: w_cis_op = 5'h02; // ADD
3'h3: w_cis_op = 5'h10; // CMP
3'h4: w_cis_op = 5'h12; // LW
3'h5: w_cis_op = 5'h13; // SW
3'h6: w_cis_op = 5'h18; // LDI
3'h7: w_cis_op = 5'h0d; // MOV
endcase
end else begin : GEN_NOCIS_OP
always @(*)
w_cis_op = w_op;
end endgenerate
// }}}
// Decode instructions
// {{{
assign w_op= iword[26:22];
assign w_mov = (w_cis_op == 5'h0d);
assign w_ldi = (w_cis_op[4:1] == 4'hc);
assign w_brev = (w_cis_op == 5'h08);
assign w_mpy = (w_cis_op[4:1] == 4'h5)||(w_cis_op[4:0]==5'h0c);
assign w_cmptst = (w_cis_op[4:1] == 4'h8);
assign w_ldilo = (w_cis_op[4:0] == 5'h09);
assign w_ALU = (!w_cis_op[4]) // anything with [4]==0, but ...
&&(w_cis_op[3:1] != 3'h7); // not the divide
assign w_add = (w_cis_op[4:0] == 5'h02);
assign w_mem = (w_cis_op[4:3] == 2'b10)&&(w_cis_op[2:1] !=2'b00);
assign w_sto = (w_mem)&&( w_cis_op[0]);
assign w_div = (!iword[CISBIT])&&(w_op[4:1] == 4'h7);
assign w_fpu = (!iword[CISBIT])&&(w_op[4:3] == 2'b11)
&&(w_dcdR[3:1] != 3'h7)
&&(w_op[2:1] != 2'b00);
// If the result register is either CC or PC, and this would otherwise
// be a floating point instruction with floating point opcode of 0,
// then this is a NOOP.
assign w_special= (!iword[CISBIT])&&(w_dcdR[3:1]==3'h7)
&&(w_op[4:2] == 3'b111);
assign w_break = (w_special)&&(w_op[4:0]==5'h1c);
assign w_lock = (w_special)&&(w_op[4:0]==5'h1d);
assign w_sim = (w_special)&&(w_op[4:0]==5'h1e);
assign w_noop = (w_special)&&(w_op[4:1]==4'hf); // Must include w_sim
`ifdef FORMAL
always @(*)
assert(!w_special || !w_fpu);
`endif
// }}}
// w_dcdR, w_dcdA
// {{{
// What register will we be placing results into (if at all)?
//
// Two parts to the result register: the register set, given for
// moves in iword[18] but only for the supervisor, and the other
// four bits encoded in the instruction.
//
assign w_dcdR = { ((!iword[CISBIT])&&(OPT_USERMODE)&&(w_mov)&&(!i_gie))?iword[IMMSEL]:i_gie,
iword[30:27] };
// 0 LUTs
assign w_dcdA = w_dcdR; // on ZipCPU, A is always result reg
// 0 LUTs
assign w_dcdA_pc = w_dcdR_pc;
assign w_dcdA_cc = w_dcdR_cc;
// 2 LUTs, 1 delay each
assign w_dcdR_pc = (w_dcdR == {i_gie, CPU_PC_REG});
assign w_dcdR_cc = (w_dcdR == {i_gie, CPU_CC_REG});
// }}}
// dcdB - What register is used in the opB?
// {{{
assign w_dcdB[4] = ((!iword[CISBIT])&&(w_mov)&&(OPT_USERMODE)&&(!i_gie))?iword[13]:i_gie;
assign w_dcdB[3:0]= (iword[CISBIT])
? (((!iword[CISIMMSEL])&&(iword[26:25]==2'b10))
? CPU_SP_REG : iword[22:19])
: iword[17:14];
// 2 LUTs, 1 delays each
assign w_dcdB_pc = (w_rB)&&(w_dcdB[3:0] == CPU_PC_REG);
assign w_dcdB_cc = (w_rB)&&(w_dcdB[3:0] == CPU_CC_REG);
// }}}
// w_cond
// {{{
// Under what condition will we execute this instruction? Only the
// load immediate instruction and the CIS instructions are completely
// unconditional. Well ... not quite. The BREAK, LOCK, and SIM/NOOP
// instructions are also unconditional.
//
assign w_cond = ((w_ldi)||(w_special)||(iword[CISBIT])) ? 4'h8 :
{ (iword[21:19]==3'h0), iword[21:19] };
// }}}
// rA - do we need to read register A?
// {{{
assign w_rA = // Floating point reads reg A
(w_fpu)
// Divide's read A
||(w_div)
// ALU ops read A,
// except for MOV's and BREV's which don't
||((w_ALU)&&(!w_brev)&&(!w_mov))
// STO's read A
||(w_sto)
// Test/compares
||(w_cmptst);
// }}}
// rB -- do we read a register for operand B?
// {{{
// Specifically, do we add the registers value to the immediate to
// create opB?
assign w_rB = (w_mov)
||((!iword[CISBIT])&&(iword[IMMSEL])&&(!w_ldi)&&(!w_special))
||(( iword[CISBIT])&&(iword[CISIMMSEL])&&(!w_ldi))
// If using compressed instruction sets,
// we *always* read on memory operands.
||(( iword[CISBIT])&&(w_mem));
// }}}
// wR -- will we be writing our result back?
// {{{
// wR_n = !wR
// All but STO, NOOP/BREAK/LOCK, and CMP/TST write back to w_dcdR
assign w_wR_n = (w_sto)
||(w_special)
||(w_cmptst);
assign w_wR = !w_wR_n;
// }}}
//
// wF -- do we write flags when we are done?
// {{{
assign w_wF = (w_cmptst)
||((w_cond[3])&&(w_fpu||w_div
||((w_ALU)&&(!w_mov)&&(!w_ldilo)&&(!w_brev)
&&(w_dcdR[3:1] != 3'h7))));
// }}}
// w_immsrc - where does the immediate value come from
// {{{
// Bottom 13 bits: no LUT's
// w_dcd[12: 0] -- no LUTs
// w_dcd[ 13] -- 2 LUTs
// w_dcd[17:14] -- (5+i0+i1) = 3 LUTs, 1 delay
// w_dcd[22:18] : 5 LUTs, 1 delay (assuming high bit is o/w determined)
always @(*)
if (w_ldi)
w_immsrc = 0;
else if (w_mov)
w_immsrc = 1;
else if (!iword[IMMSEL])
w_immsrc = 2;
else // if (!iword[IMMSEL])
w_immsrc = 3;
// }}}
// w_fullI -- extracting the immediate value from the insn word
// {{{
always @(*)
case(w_immsrc)
2'b00: w_fullI = { iword[22:0] }; // LDI
2'b01: w_fullI = { {(23-13){iword[12]}}, iword[12:0] }; // MOV
2'b10: w_fullI = { {(23-18){iword[17]}}, iword[17:0] }; // Immediate
2'b11: w_fullI = { {(23-14){iword[13]}}, iword[13:0] }; // Reg + Imm
endcase
/*
assign w_fullI = (w_ldi) ? { iword[22:0] } // LDI
// MOVE immediates have one less bit
:((w_mov) ?{ {(23-13){iword[12]}}, iword[12:0] }
// Normal Op-B immediate ... 18 or 14 bits
:((!iword[IMMSEL]) ? { {(23-18){iword[17]}}, iword[17:0] }
: { {(23-14){iword[13]}}, iword[13:0] }
));
*/
// }}}
// w_I and w_Iz: Immediate value decoding
// {{{
generate if (OPT_CIS)
begin : GEN_CIS_IMMEDIATE
wire [7:0] w_halfI, w_halfbits;
assign w_halfbits = iword[CISIMMSEL:16];
assign w_halfI = (iword[26:24]==3'h6) ? w_halfbits[7:0] // 8'b for LDI
:(w_halfbits[7])?
{ {(6){w_halfbits[2]}}, w_halfbits[1:0]}
:{ w_halfbits[6], w_halfbits[6:0] };
assign w_I = (iword[CISBIT])
? {{(23-8){w_halfI[7]}}, w_halfI }
: w_fullI;
end else begin : GEN_NOCIS_IMMEDIATE
assign w_I = w_fullI;
end endgenerate
assign w_Iz = (w_I == 0);
// }}}
// o_phase
// {{{
// The o_phase parameter is special. It needs to let the software
// following know that it cannot break/interrupt on an o_phase asserted
// instruction, lest the break take place between the first and second
// half of a CIS instruction. To do this, o_phase must be asserted
// when the first instruction half is valid, but not asserted on either
// a 32-bit instruction or the second half of a 2x16-bit instruction.
generate if (OPT_CIS)
begin : GEN_CIS_PHASE
// {{{
reg r_phase;
// Phase is '1' on the first instruction of a two-part set
// But, due to the delay in processing, it's '1' when our
// output is valid for that first part, but that'll be the
// same time we are processing the second part ... so it may
// look to us like a '1' on the second half of processing.
// When no instruction is in the pipe, phase is zero
initial r_phase = 1'b0;
always @(posedge i_clk)
if (i_reset || w_ljmp_dly)
r_phase <= 1'b0;
else if ((i_ce)&&(pf_valid))
begin
if (o_phase)
// CIS instructions only have two parts. On
// the second part (o_phase is true), return
// back to the first
r_phase <= 0;
else
r_phase <= (i_instruction[CISBIT])&&(!i_illegal);
end else if (i_ce)
r_phase <= 1'b0;
assign o_phase = r_phase;
// }}}
end else begin : NO_CIS
// {{{
assign o_phase = 1'b0;
// }}}
end endgenerate
// }}}
// illegal_shift
// {{{
generate if (OPT_SHIFTS)
begin : LEGAL_SHIFTS
assign illegal_shift = 1'b0;
end else begin : GEN_ILLEGAL_SHIFT
reg r_illegal_shift;
always @(*)
begin
r_illegal_shift = 1'b1;
if (i_instruction[CISBIT])
r_illegal_shift = 1'b0;
else if ((i_instruction[26:22] != 5'h5)
&&(i_instruction[26:22] != 5'h6)
&&(i_instruction[26:22] != 5'h7))
r_illegal_shift = 1'b0;
else if (!i_instruction[18]
&& (i_instruction[17:0] == 18'h1))
r_illegal_shift = 1'b0;
end
assign illegal_shift = r_illegal_shift;
end endgenerate
// }}}
// o_illegal
// {{{
initial o_illegal = 1'b0;
always @(posedge i_clk)
if (i_reset)
o_illegal <= 1'b0;
else if (i_ce && o_phase)
begin
// {{{
o_illegal <= o_illegal;
// Cannot happen in compressed word ...
// 1. multiply op-codes
// 2. divide opcodes
// 3. FPU opcodes
// 4. special opcodes
// }}}
end else if (i_ce && i_pf_valid)
begin
// {{{
o_illegal <= 1'b0;
if (illegal_shift)
o_illegal <= 1'b1;
if ((!OPT_CIS)&&(i_instruction[CISBIT]))
o_illegal <= 1'b1;
if ((!OPT_MPY)&&(w_mpy))
o_illegal <= 1'b1;
if ((!OPT_DIVIDE)&&(w_div))
o_illegal <= 1'b1;
else if ((OPT_DIVIDE)&&(w_div)&&(w_dcdR[3:1]==3'h7))
o_illegal <= 1'b1;
if ((!OPT_FPU)&&(w_fpu))
o_illegal <= 1'b1;
if ((!OPT_SIM)&&(w_sim))
// Simulation instructions on real hardware should
// always cause an illegal instruction error
o_illegal <= 1'b1;
// There are two (missing) special instructions, after
// BREAK, LOCK, SIM, and NOOP. These are special if their
// (unused-result) register is either the PC or CC register.
//
// These should cause an illegal instruction error
if ((w_dcdR[3:1]==3'h7)&&(w_cis_op[4:1]==4'b1101))
o_illegal <= 1'b1;
// If the lock function isn't implemented, this should
// also cause an illegal instruction error
if ((!OPT_LOCK)&&(w_lock))
o_illegal <= 1'b1;
// Bus errors always create illegal instructions
if (i_illegal)
o_illegal <= 1'b1;
// }}}
end
// }}}
// o_pc
// {{{
initial o_pc = 0;
always @(posedge i_clk)
if ((i_ce)&&((o_phase)||(i_pf_valid)))
begin
o_pc[0] <= 1'b0;
if (OPT_CIS)
begin
if (iword[CISBIT])
begin
if (o_phase)
o_pc[AW+1:1] <= o_pc[AW+1:1] + 1'b1;
else
o_pc <= { i_pc[AW+1:2], 1'b1, 1'b0 };
end else begin
// The normal, non-CIS case
o_pc <= { i_pc[AW+1:2] + 1'b1, 2'b00 };
end
end else begin
// The normal, non-CIS case
o_pc <= { i_pc[AW+1:2] + 1'b1, 2'b00 };
end
end
// }}}
// Generate output products
// {{{
initial o_dcdR = 0;
initial o_dcdA = 0;
initial o_dcdB = 0;
initial o_DV = 0;
initial o_FP = 0;
initial o_lock = 0;
initial o_sim = 1'b0;
initial o_sim_immv = 0;
// r_I, o_zI, o_wR, o_rA, o_rB, o_dcdR, o_dcdA, o_dcdB
always @(posedge i_clk)
if (i_ce)
begin
// {{{
// o_cond, o_wF
// {{{
// Under what condition will we execute this
// instruction? Only the load immediate instruction
// is completely unconditional.
o_cond <= w_cond;
// Don't change the flags on conditional instructions,
// UNLESS: the conditional instruction was a CMP
// or TST instruction.
o_wF <= w_wF;
// }}}
// o_op
// {{{
// Record what operation/op-code (4-bits) we are doing
// Note that LDI magically becomes a MOV
// instruction here. That way it's a pass through
// the ALU. Likewise, the two compare instructions
// CMP and TST becomes SUB and AND here as well.
// We keep only the bottom four bits, since we've
// already done the rest of the decode necessary to
// settle between the other instructions. For example,
// o_FP plus these four bits uniquely defines the FP
// instruction, o_DV plus the bottom of these defines
// the divide, etc.
o_op <= w_cis_op[3:0];
if ((w_ldi)||(w_noop)||(w_lock))
o_op <= 4'hd;
// }}}
o_dcdR <= { w_dcdR_cc, w_dcdR_pc, w_dcdR};
o_dcdA <= { w_dcdA_cc, w_dcdA_pc, w_dcdA};
o_dcdB <= { w_dcdB_cc, w_dcdB_pc, w_dcdB};
o_wR <= w_wR;
o_rA <= w_rA;
o_rB <= w_rB;
r_I <= w_I;
o_zI <= w_Iz;
// o_ALU, o_M, o_DV, o_FP
// {{{
// Turn a NOOP into an ALU operation--subtract in
// particular, although it doesn't really matter as long
// as it doesn't take longer than one clock. Note
// also that this depends upon not setting any registers
// or flags, which should already be true.
o_ALU <= (w_ALU)||(w_ldi)||(w_cmptst)||(w_noop)
||((!OPT_LOCK)&&(w_lock));
o_M <= w_mem;
o_DV <= (OPT_DIVIDE)&&(w_div);
o_FP <= (OPT_FPU)&&(w_fpu);
// }}}
// o_break, o_lock
// {{{
o_break <= w_break;
o_lock <= (OPT_LOCK)&&(w_lock);
// }}}
if (OPT_CIS)
r_nxt_half <= { iword[14:0] };
else
r_nxt_half <= 0;
// o_sim, o_sim_immv -- simulation instructions vs NOOPs
// {{{
if (OPT_SIM)
begin
// Support the SIM instruction(s)
o_sim <= (w_sim)||(w_noop);
o_sim_immv <= iword[22:0];
if (OPT_LOWPOWER && !w_sim && !w_noop)
o_sim_immv <= 0;
end else begin
o_sim <= 1'b0;
o_sim_immv <= 0;
end
// }}}
// }}}
end
// }}}
assign o_preA = w_dcdA;
assign o_preB = w_dcdB;
// o_early_branch, o_early_branch_stb, o_branch_pc
// {{{
generate if (OPT_EARLY_BRANCHING)
begin : GEN_EARLY_BRANCH_LOGIC
// {{{
reg r_early_branch, r_early_branch_stb,
r_ljmp;
reg [(AW+1):0] r_branch_pc;
wire w_add_to_pc;
initial r_ljmp = 1'b0;
always @(posedge i_clk)
if (i_reset)
r_ljmp <= 1'b0;
else if (i_ce)
begin
if ((r_ljmp)&&(pf_valid))
r_ljmp <= 1'b0;
else if (o_early_branch_stb)
r_ljmp <= 1'b0;
else if (pf_valid)
begin
if ((OPT_CIS)&&(iword[CISBIT]))
r_ljmp <= w_cis_ljmp;
else
r_ljmp <= (w_ljmp);
end else if ((OPT_CIS)&&(o_phase)&&(iword[CISBIT]))
r_ljmp <= w_cis_ljmp;
end
assign o_ljmp = r_ljmp;
assign w_add_to_pc = (!o_phase
&& (!OPT_CIS || !i_instruction[CISBIT])
&& (i_instruction[30:27]==CPU_PC_REG) // Rd=PC
&& (i_instruction[26:22] == 5'h02) // ADD
&& (i_instruction[21:19]==3'h0) // NONE
&& !i_instruction[IMMSEL]);
initial r_early_branch = 1'b0;
initial r_early_branch_stb = 1'b0;
always @(posedge i_clk)
if (i_reset)
begin
r_early_branch <= 1'b0;
r_early_branch_stb <= 1'b0;
end else if (i_ce && pf_valid)
begin
if (r_ljmp)
begin
// LW (PC),PC
r_early_branch <= 1'b1;
r_early_branch_stb <= 1'b1;
end else if (w_add_to_pc)
begin
// Add x,PC
r_early_branch <= 1'b1;
r_early_branch_stb <= (!OPT_SUPPRESS_NULL_BRANCHES)
|| (i_instruction[IMMSEL-1:0] != 0);
// LDI #x,PC is no longer supported
end else begin
r_early_branch <= 1'b0;
r_early_branch_stb <= 1'b0;
end
end else begin
r_early_branch_stb <= 1'b0;
if (i_ce)
r_early_branch <= 1'b0;
end
initial r_branch_pc = 0;
always @(posedge i_clk)
if (OPT_LOWPOWER && i_reset)
r_branch_pc <= 0;
else if (i_ce)
begin
if (r_ljmp)
r_branch_pc <= { iword[(AW+1):2],
2'b00 };
else if (!OPT_LOWPOWER || w_add_to_pc)
begin
// Add x,PC
r_branch_pc[AW+1:2] <= i_pc[AW+1:2]
+ {{(AW-15){i_instruction[17]}},
i_instruction[16:2]}
+ {{(AW-1){1'b0}},1'b1};
r_branch_pc[1:0] <= 2'b00;
end else if (OPT_LOWPOWER)
r_branch_pc <= 0;
if (OPT_LOWPOWER && !pf_valid)
r_branch_pc <= 0;
end
assign w_ljmp_dly = r_ljmp;
assign o_early_branch = r_early_branch;
assign o_early_branch_stb = r_early_branch_stb;
assign o_branch_pc = r_branch_pc;
`ifdef FORMAL
always @(*)
if (OPT_LOWPOWER && !r_early_branch)
assert(r_branch_pc == 0);
`endif
// }}}
end else begin : NO_EARLY_BRANCHING
// {{{
assign w_ljmp_dly = 1'b0;
assign o_early_branch = 1'b0;
assign o_early_branch_stb = 1'b0;
assign o_branch_pc = {(AW+2){1'b0}};
assign o_ljmp = 1'b0;
// verilator coverage_off
// verilator lint_off UNUSED
wire early_branch_unused;
assign early_branch_unused = &{ 1'b0, w_add };
// verilator lint_on UNUSED
// verilator coverage_on
// }}}
end endgenerate
// }}}
// o_pipe
// {{{
// To be a pipeable operation there must be ...
// 1. Two valid adjacent instructions
// 2. Both must be memory operations, of the same time (both lods
// or both stos)
// 3. Both must use the same register base address
// 4. Both must be to the same address, or the address incremented
// by one
// Note that we're not using iword here ... there's a lot of logic
// taking place, and it's only valid if the new word is not compressed.
//
generate if (OPT_OPIPE)
begin : GEN_OPIPE
// {{{
reg r_pipe, r_insn_is_pipeable;
// Pipeline logic is too extreme for a single clock.
// Let's break it into two clocks, using r_insn_is_pipeable
// If this function is true, then the instruction associated
// with the current output *may* have a pipeable instruction
// following it.
//
initial r_insn_is_pipeable = 1'b0;
always @(posedge i_clk)
if (i_reset)
r_insn_is_pipeable <= 1'b0;
else if ((i_ce)&&((!pf_valid)||(i_illegal))&&(!o_phase))
// Pipeline bubble, can't pipe through it
r_insn_is_pipeable <= 1'b0;
else if (o_ljmp)
r_insn_is_pipeable <= 1'b0;
else if ((i_ce)&&((!OPT_CIS)&&(i_instruction[CISBIT])))
r_insn_is_pipeable <= 1'b0;
else if (i_ce)
begin // This is a valid instruction
r_insn_is_pipeable <= (w_mem)&&(w_rB)
// PC (and CC) registers can change
// underneath us. Therefore they cannot
// be used as a base register for piped
// memory ops
&&(w_dcdB[3:1] != 3'h7)
// Writes to PC or CC will destroy any
// possibility of pipeing--since they
// could create a jump
&&(w_dcdR[3:1] != 3'h7)
//
// Loads landing in the current address
// pointer register are not allowed,
// as they could then be used to violate
// our rule(s)
&&((w_cis_op[0])||(w_dcdB != w_dcdA));
end // else
// The pipeline is stalled
assign insn_is_pipeable = r_insn_is_pipeable;
initial r_pipe = 1'b0;
always @(posedge i_clk)
if (i_reset)
r_pipe <= 1'b0;
else if (i_ce)
r_pipe <= ((pf_valid)||(o_phase))
// The last operation must be capable of
// being followed by a pipeable memory op
&&(r_insn_is_pipeable)
// Both must be memory operations
&&(w_mem)
// Both must be writes, or both stores
&&(o_op[0] == w_cis_op[0])
// Both must be register ops
&&(w_rB)
// Both must use the same register for B
&&(w_dcdB[3:0] == o_dcdB[3:0]);
// // CC or PC registers are not valid addresses
// // Captured above
// // But ... the result can never be B
// // Captured above
// //
// // Reads to CC or PC not allowed
// // &&((o_op[0])||(w_dcdR[3:1] != 3'h7))
// // Prior-reads to CC or PC not allowed
// // Captured above
// // Same condition, or no condition now
// &&((w_cond[2:0]==o_cond[2:0])
// ||(w_cond[2:0] == 3'h0));
// // Same or incrementing immediate
// &&(w_I[22]==r_I[22]);
assign o_pipe = r_pipe;
// }}}
end else begin : GEN_NO_PIPE
// {{{
assign o_pipe = 1'b0;
assign insn_is_pipeable = 1'b0;
// verilator coverage_off
// verilator lint_off UNUSED
wire unused_pipable;
assign unused_pipable = &{ 1'b0, insn_is_pipeable };
// verilator lint_on UNUSED
// verilator coverage_on
// }}}
end endgenerate
// }}}
// o_valid
// {{{
initial r_valid = 1'b0;
generate if (OPT_PIPELINED)
begin : GEN_DCD_VALID
always @(posedge i_clk)
if (i_reset)
r_valid <= 1'b0;
else if (i_ce)
r_valid <= ((pf_valid)||(o_phase))&&(!o_ljmp);
else if (!i_stalled)
r_valid <= 1'b0;
end else begin : GEN_DCD_VALID
always @(posedge i_clk)
if (i_reset)
r_valid <= 1'b0;
else if (!i_stalled)
r_valid <= ((pf_valid)||(o_phase))&&(!o_ljmp);
else
r_valid <= 1'b0;
end endgenerate
assign o_valid = r_valid;
// }}}
assign o_I = { {(32-22){r_I[22]}}, r_I[21:0] };
// Make Verilator happy across all our various options
// {{{
// verilator coverage_off
// verilator lint_off UNUSED
wire possibly_unused;
assign possibly_unused = &{ 1'b0, w_lock, w_ljmp, w_ljmp_dly,
insn_is_pipeable, w_cis_ljmp, i_pc[1:0], w_add };
// verilator lint_on UNUSED
// verilator coverage_on
// }}}
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
//
// Formal properties
// {{{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
`ifdef FORMAL
reg f_past_valid;
initial f_past_valid = 1'b0;
always @(posedge i_clk)
f_past_valid <= 1'b1;
`define ASSERT assert
`ifdef IDECODE
`define ASSUME assume
`else
`define ASSUME assert
`endif
always @(posedge i_clk)
if ((i_ce)&&(i_pf_valid)&&(!o_phase))
f_insn_word <= i_instruction;
assign f_insn_is_pipeable = insn_is_pipeable;
always @(posedge i_clk)
if ((i_ce)&&(i_pf_valid)&&(!o_phase))
f_insn_gie <= i_gie;
always @(posedge i_clk)
if (!i_reset && o_valid)
`ASSUME(f_insn_gie == i_gie);
always @(*)
if (o_phase)
assert(r_nxt_half == f_insn_word[14:0]);
////////////////////////////
//
//
// Assumptions about our inputs
//
//
///////////////////////////
always @(*)
if (OPT_PIPELINED)
begin
`ASSUME(i_ce == ((!o_valid)||(!i_stalled)));
end else
`ASSUME(i_ce == !i_stalled);
always @(posedge i_clk)
if (!f_past_valid || $past(i_reset))
begin
`ASSERT(!o_valid);
// `ASSERT(!o_illegal);
`ASSERT(!o_phase);
`ASSERT(!o_ljmp);
`ASSERT(!o_pipe);
// `ASSUME(!i_pf_valid);
end
always @(posedge i_clk)
if ((f_past_valid)&&(!i_reset))
`ASSUME(i_gie == $past(i_gie));
`ifdef IDECODE
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset))&&(!$past(i_ce))
&&($past(f_past_valid))&&(!$past(i_reset,2))&&(!$past(i_ce,2)))
assume(i_ce);
`endif
reg f_new_insn, f_last_insn;
initial f_new_insn = 1'b0;
always @(posedge i_clk)
if (i_reset)
f_new_insn <= 1'b0;
else
f_new_insn <= ((pf_valid)&&(!i_stalled));
initial f_last_insn = 1'b0;
always @(posedge i_clk)
if (i_reset)
f_last_insn <= 1'b0;
else
f_last_insn <= (o_valid)&&(i_stalled);
always @(posedge i_clk)
if ((f_past_valid)&&(f_last_insn)&&(!i_reset))
begin
if (($past(pf_valid))&&(pf_valid))
begin
`ASSUME(i_illegal || i_instruction == $past(i_instruction));
`ASSUME(i_gie == $past(i_gie));
`ASSUME(i_pc == $past(i_pc));
`ASSUME(i_illegal == $past(i_illegal));
end
end
always @(posedge i_clk)
if ((f_past_valid)&&(o_early_branch_stb))
`ASSUME(!pf_valid);
always @(*)
if (i_pf_valid)
`ASSUME(i_pc[1:0] == 2'b00);
always @(*)
if ((o_valid)&&(!o_early_branch))
`ASSERT((o_illegal)||(o_pc[1] == o_phase));
wire [3+7+7+7+32+1+4+1+4+10+(AW+2)+3+23+(AW+2)-1:0] f_result;
assign f_result = { o_phase, o_illegal, i_gie,
o_dcdR, o_dcdA, o_dcdB,
o_I, o_zI, o_cond, o_wF, o_op,
o_ALU, o_M, o_DV, o_FP, o_break, o_lock,
o_wR, o_rA, o_rB, o_early_branch,
o_branch_pc, o_ljmp, o_pipe, o_sim,
o_sim_immv, o_pc };
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset))&&($stable(i_gie))&&(f_last_insn))
begin
`ASSERT($stable(f_result));
if (OPT_PIPELINED)
// All but valid will be stable
`ASSERT($stable(o_valid));
end
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset))&&($past(pf_valid))
&&(!$past(o_ljmp)))
`ASSERT((!OPT_PIPELINED)||(o_valid));
always @(posedge i_clk)
if ((f_past_valid)&&(f_new_insn)
&&($past(pf_valid))&&($past(i_illegal))&&(!$past(o_phase)))
`ASSERT(o_illegal);
`ifdef IDECODE
////////////////////////////////////////////////////////////////////////
//
// Let's walk through some basic instructions
// {{{
////////////////////////////////////////////////////////////////////////
//
//
// First 8-instructions, SUB - ASR
// {{{
always @(*)
if ((!iword[CISBIT])&&(iword[26:25]==2'b00))
begin
// {{{
`ASSERT(!w_cmptst);
`ASSERT(!w_div);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(!w_mpy);
`ASSERT((w_rA)&&(w_wR)&&(w_ALU));
`ASSERT(w_rB == iword[IMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT((w_wF == w_cond[3])||(w_dcdA[3:1]==3'b111));
// }}}
end else if ((iword[CISBIT])&&(iword[26:24]<3'b011))
begin
// {{{
`ASSERT(!w_cmptst);
`ASSERT(!w_div);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(!w_mpy);
`ASSERT((w_rA)&&(w_wR)&&(w_ALU));
`ASSERT(w_rB == iword[CISIMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[22:19]);
if (iword[26:24] == 3'b000)
begin
`ASSERT(w_cis_op == 5'h0);
end else if (iword[26:24] == 5'h01)
begin
`ASSERT(w_cis_op == 5'h01);
end else // if (iword[26:24] == 3'b010)
`ASSERT(w_cis_op == 5'h02);
`ASSERT(w_cond == 4'h8);
if (iword[CISIMMSEL])
begin
`ASSERT(w_I == { {(23-3){iword[18]}}, iword[18:16] });
end else
`ASSERT(w_I == { {(23-7){iword[22]}}, iword[22:16] });
// }}}
end else
`ASSERT(!w_add);
// }}}
// BREV and LDILO
// {{{
always @(*)
if ((!iword[CISBIT])&&((w_cis_op == 5'h8)
||(w_cis_op == 5'h09)))
begin
// {{{
`ASSERT(!w_mpy);
`ASSERT(!w_div);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
if (w_cis_op == 5'h8)
begin
`ASSERT(w_brev);
`ASSERT(!w_ldilo);
`ASSERT((!w_rA)&&(w_wR)&&(w_ALU));
end else begin// if (w_cis_op == 5'h9)
`ASSERT(w_ldilo);
`ASSERT(!w_brev);
`ASSERT((w_rA)&&(w_wR)&&(w_ALU));
end
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(w_rB == iword[IMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT(!w_wF);
// }}}
end else begin
// {{{
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
// }}}
end
// }}}
// Multiply instructions
// {{{
always @(*)
if ((!iword[CISBIT])&&((w_cis_op == 5'ha)
||(w_cis_op == 5'h0b)
||(w_cis_op == 5'h0c)))
begin
// {{{
`ASSERT(w_mpy);
`ASSERT(!w_div);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT((w_rA)&&(w_wR)&&(w_ALU));
`ASSERT(w_rB == iword[IMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT((w_wF == w_cond[3])||(w_dcdA[3:1]==3'b111));
// }}}
end else
`ASSERT(!w_mpy);
// }}}
// Move instruction
// {{{
always @(*)
if ((!iword[CISBIT])&&((w_cis_op == 5'hd)))
begin
// {{{
`ASSERT(w_mov);
`ASSERT(!w_div);
`ASSERT(!w_mpy);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT((!w_rA)&&(w_wR)&&(w_ALU));
`ASSERT(w_rB);
`ASSERT(w_dcdA[4] == ((i_gie)||(iword[IMMSEL])));
`ASSERT(w_dcdB[4] == ((i_gie)||(iword[13])));
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT(!w_wF);
// }}}
end else if ((iword[CISBIT])&&(iword[26:24]==3'b111))
begin
// {{{
`ASSERT(w_mov);
`ASSERT(!w_div);
`ASSERT(!w_mpy);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT((!w_rA)&&(w_wR)&&(w_ALU));
`ASSERT(w_rB);
`ASSERT(w_dcdA[4] == (i_gie));
`ASSERT(w_dcdB[4] == (i_gie));
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[22:19]);
`ASSERT(w_cis_op == 5'h0d);
`ASSERT(w_cond == 4'h8);
`ASSERT(!w_wF);
// }}}
end else
`ASSERT(!w_mov);
// }}}
// Divide instruction
// {{{
always @(*)
if ((!iword[CISBIT])&&(iword[26:23]==4'b0111))
begin
// {{{
`ASSERT(w_div);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(!w_mpy);
`ASSERT((w_rA)&&(w_wR));
`ASSERT(w_rB == iword[IMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT((w_wF == w_cond[3])||(w_dcdA[3:1]==3'b111));
// }}}
end else
`ASSERT(!w_div);
// }}}
// Comparison instructions
// {{{
always @(*)
if ((!iword[CISBIT])&&(iword[26:23]==4'b1000))
begin
// {{{
`ASSERT(w_cmptst);
`ASSERT(!w_div);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(!w_mpy);
`ASSERT((w_rA)&&(!w_wR)&&(!w_ALU));
`ASSERT(w_rB == iword[IMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT(w_wF);
// }}}
end else if ((iword[CISBIT])&&(iword[26:24]==3'b011))
begin
// {{{
`ASSERT(w_cmptst);
`ASSERT(!w_div);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(!w_mpy);
`ASSERT((w_rA)&&(!w_wR)&&(!w_ALU));
`ASSERT(w_rB == iword[CISIMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[22:19]);
`ASSERT(w_cis_op == 5'h10);
`ASSERT(w_cond == 4'h8);
if (iword[CISIMMSEL])
begin
`ASSERT(w_I == { {(23-3){iword[18]}}, iword[18:16] });
end else
`ASSERT(w_I == { {(23-7){iword[22]}}, iword[22:16] });
`ASSERT(w_wF);
// }}}
end else
`ASSERT(!w_cmptst);
// }}}
always @(posedge i_clk)
if ((f_new_insn)&&($past(w_cmptst)))
`ASSERT(o_ALU);
// Memory instructions
// {{{
always @(*)
if ((!iword[CISBIT])&&(
(iword[26:23]==4'b1001) // Word
||(iword[26:23]==4'b1010) // Half-word, or short
||(iword[26:23]==4'b1011))) // Byte ops
begin
// {{{
`ASSERT(w_mem);
`ASSERT(w_sto == iword[22]);
`ASSERT(!w_cmptst);
`ASSERT(!w_div);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(!w_mpy);
if (w_sto)
begin
`ASSERT((w_rA)&&(!w_wR));
end else
`ASSERT((!w_rA)&&(w_wR));
`ASSERT(!w_ALU);
`ASSERT(w_rB == iword[IMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT(!w_wF);
// }}}
end else if ((iword[CISBIT])&&(iword[26:25]==2'b10))
begin
// {{{
`ASSERT(w_mem);
`ASSERT(w_sto == iword[24]);
`ASSERT(!w_cmptst);
`ASSERT(!w_div);
`ASSERT(!w_ldi);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(!w_mpy);
if (w_sto)
begin
`ASSERT((w_rA)&&(!w_wR));
end else
`ASSERT((!w_rA)&&(w_wR));
`ASSERT(!w_ALU);
`ASSERT(w_rB);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
if (iword[CISIMMSEL])
begin
`ASSERT(w_dcdB[3:0] == iword[22:19]);
end else
`ASSERT(w_dcdB[3:0] == CPU_SP_REG);
if (w_sto)
begin
`ASSERT(w_cis_op == 5'h13);
end else
`ASSERT(w_cis_op == 5'h12);
`ASSERT(w_cond == 4'h8);
`ASSERT(!w_wF);
// }}}
end else begin
// {{{
`ASSERT(!w_sto);
`ASSERT(!w_mem);
// }}}
end
always @(*)
if (w_sto)
`ASSERT(w_mem);
// }}}
// LDI -- Load immediate
// {{{
always @(*)
if ((!iword[CISBIT])&&(w_op[4:1] == 4'hc))
begin
// {{{
`ASSERT(w_ldi);
`ASSERT(!w_mpy);
`ASSERT(!w_div);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT((!w_rA)&&(w_wR)&&(!w_ALU));
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(w_rB == 1'b0);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond == 4'h8);
`ASSERT(!w_wF);
`ASSERT(w_Iz == (iword[22:0] == 0));
`ASSERT(w_I[22:0] == iword[22:0]);
// }}}
end else if ((iword[CISBIT])&&(iword[26:24] == 3'b110))
begin
// {{{
`ASSERT(w_ldi);
`ASSERT(!w_mpy);
`ASSERT(!w_div);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT((!w_rA)&&(w_wR)&&(!w_ALU));
`ASSERT(!w_special);
`ASSERT(!w_fpu);
`ASSERT(w_rB == 1'b0);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_cis_op[4:1] == 4'hc);
`ASSERT(w_cond == 4'h8);
`ASSERT(!w_wF);
`ASSERT(w_Iz == (iword[23:16] == 0));
`ASSERT(w_I[22:0] == { {(23-8){iword[23]}}, iword[23:16] });
// }}}
end else
`ASSERT(!w_ldi);
// }}}
`endif // IDECODE
always @(posedge i_clk)
if ((f_new_insn)&&($past(w_ldi)))
`ASSERT(o_ALU);
always @(*)
if (!OPT_LOCK)
`ASSERT(!o_lock);
`ifdef IDECODE
always @(*)
if ((w_break)||(w_lock)||(w_sim)||(w_noop))
`ASSERT(w_special);
// FPU -- Floating point instructions
// {{{
always @(*)
if ((!iword[CISBIT])&&(
(w_cis_op[4:1] == 4'hd)
||(w_cis_op[4:1] == 4'he)
||(w_cis_op[4:1] == 4'hf))
&&(iword[30:28] != 3'h7))
begin
// {{{
`ASSERT(w_fpu);
`ASSERT(!w_ldi);
`ASSERT(!w_mpy);
`ASSERT(!w_div);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT((w_wR)&&(!w_ALU));
if ((w_cis_op == 5'he)||(w_cis_op == 5'hf))
begin
`ASSERT(!w_rA);
end else begin
`ASSERT(w_rA);
end
`ASSERT(!w_special);
`ASSERT(w_rB == iword[IMMSEL]);
`ASSERT(w_dcdA[4] == i_gie);
`ASSERT(w_dcdB[4] == i_gie);
`ASSERT(w_dcdA[3:0] == iword[30:27]);
`ASSERT(w_dcdB[3:0] == iword[17:14]);
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond[3] == (iword[21:19] == 3'b000));
`ASSERT(w_cond[2:0] == iword[21:19]);
`ASSERT((w_wF == w_cond[3])||(w_dcdA[3:1]==3'b111)); // !!!
// }}}
end else
`ASSERT(!w_fpu);
// }}}
// Special instructions
// {{{
always @(*)
if ((!iword[CISBIT])&&(
(w_cis_op == 5'h1c)
||(w_cis_op == 5'h1d)
||(w_cis_op == 5'h1e)
||(w_cis_op == 5'h1f))
&&(iword[30:28] == 3'h7))
begin
// {{{
`ASSERT(w_special);
if (w_cis_op == 5'h1c)
begin // Break instruction
`ASSERT(w_break);
`ASSERT(!w_lock);
`ASSERT(!w_sim);
`ASSERT(!w_noop);
end else if (w_cis_op == 5'h1d)
begin // Lock instruction
`ASSERT(!w_break);
`ASSERT( w_lock);
`ASSERT(!w_sim);
`ASSERT(!w_noop);
end else if (w_cis_op == 5'h1e)
begin // Sim instruction
`ASSERT(!w_break);
`ASSERT(!w_lock);
`ASSERT( w_sim);
`ASSERT( w_noop);
end else begin // NOOP instruction
`ASSERT(!w_break);
`ASSERT(!w_lock);
`ASSERT(!w_sim);
`ASSERT( w_noop);
end
`ASSERT((!w_fpu)||(!OPT_FPU));
`ASSERT(!w_ldi);
`ASSERT(!w_mpy);
`ASSERT(!w_div);
`ASSERT(!w_cmptst);
`ASSERT(!w_mem);
`ASSERT(!w_sto);
`ASSERT(!w_mov);
`ASSERT(!w_brev);
`ASSERT(!w_ldilo);
`ASSERT((!w_rA)&&(!w_rB)&&(!w_wR)&&(!w_ALU));
`ASSERT(w_cis_op == w_op);
`ASSERT(w_cond == 4'h8);
`ASSERT(!w_wF);
// }}}
end else begin
// {{{
`ASSERT(!w_special);
`ASSERT(!w_break);
`ASSERT(!w_lock);
`ASSERT(!w_sim);
`ASSERT(!w_noop);
// }}}
end
// }}}
// }}}
`endif
////////////////////////////////////////////////////////////////////////
//
// Early branching checks
// {{{
////////////////////////////////////////////////////////////////////////
//
//
generate if (OPT_EARLY_BRANCHING)
begin
always @(posedge i_clk)
if ((f_past_valid)&&($past(i_ce))&&(!$past(i_reset))&&(!i_reset))
begin
if ($past(pf_valid))
begin
if ($past(o_ljmp))
begin
// 2nd half of LW (PC),PC
`ASSERT(o_early_branch);
`ASSERT(o_early_branch_stb);
end else if ((!$past(iword[CISBIT]))&&($past(w_add))
&&(!$past(w_rB))
&&($past(w_cond[3]))
&&(o_dcdR[4:0]=={ i_gie, 4'hf }))
begin
// ADD #x,PC
`ASSERT(o_early_branch);
`ASSERT(o_early_branch_stb);
end else if ((!$past(iword[CISBIT]))
&&($past(w_cis_op == 5'h12))
&&($past(w_rB))
&&($past(w_cond[3]))
&&(o_zI)
&&(o_dcdB[4:0]=={ i_gie, 4'hf })
&&(o_dcdR[4:0]=={ i_gie, 4'hf }))
begin
// LW (PC),PC
`ASSERT(!o_early_branch);
`ASSERT(!o_early_branch_stb);
end else if ((OPT_CIS)&&($past(o_phase))
&&($past(w_cis_op == 5'h12))
&&($past(w_rB))
&&($past(w_cond[3]))
&&($past(w_Iz))
&&($past(w_dcdB_pc))
&&($past(w_dcdR_pc))
&&(o_dcdR[4:0]=={ i_gie, 4'hf }))
begin
// (CIS) LW (PC),PC
`ASSERT(!o_early_branch);
`ASSERT(!o_early_branch_stb);
end else begin
`ASSERT(!o_early_branch);
end
end else if ((OPT_CIS)&&($past(o_phase)))
begin
if (($past(w_cis_op == 5'h12))
&&($past(w_rB))
&&($past(w_cond[3]))
&&($past(w_Iz))
&&($past(w_dcdB_pc))
&&($past(w_dcdR_pc)))
begin
// (CIS) LW (PC),PC
`ASSERT(!o_early_branch);
`ASSERT(!o_early_branch_stb);
end else begin
`ASSERT(!o_early_branch);
`ASSERT(!o_early_branch_stb);
end
end
end else if (!i_reset)
`ASSERT(!o_early_branch_stb);
// // CIS instruction 16'hfcf8 decodes into:
// // 1.1111.100.1.1111.0000
// // = LW (PC),PC
// always @(*)
// assume(i_instruction[31:16] != 16'hfcf8);
end else begin
always @(*)
`ASSERT(!o_early_branch_stb);
always @(*)
`ASSERT(!o_early_branch);
end endgenerate
always @(*)
if (o_early_branch_stb)
`ASSERT(o_early_branch);
always @(posedge i_clk)
if ((f_past_valid)&&($past(o_early_branch_stb))&&(!$past(pf_valid)))
`ASSERT(!o_early_branch_stb);
// }}}
// CIS specific checks
// {{{
generate if (OPT_CIS)
begin : F_OPT_CIS
// {{{
always @(*)
if (OPT_PIPELINED && !o_valid)
`ASSERT(!o_phase);
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset)))
begin
if ((o_phase)&&($past(i_ce)))
begin
`ASSERT((iword[30:16] == $past(i_instruction[14:0]))
&&(iword[CISBIT]));
end else if (!o_phase)
`ASSERT(iword == i_instruction);
if ((!$past(o_phase))&&($past(i_ce))
&&($past(pf_valid))
&&(!$past(i_illegal))
&&(!$past(w_ljmp_dly))
&&($past(i_instruction[CISBIT]))
&&((!$past(w_dcdR_pc))
||(!$past(w_wR))))
begin
`ASSERT(o_phase);
end else if (($past(o_phase))&&($past(i_ce)))
`ASSERT(!o_phase);
if (($past(i_ce))&&(!$past(o_phase))
&&($past(i_illegal))&&($past(i_pf_valid)))
`ASSERT((o_illegal)&&(!o_phase));
`ASSERT((!o_phase)||(!o_ljmp));
end
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_stalled))&&($past(pf_valid))
&&($past(i_ce)))
begin
`ASSERT(o_pc[0] == 1'b0);
if (!$past(iword[CISBIT]))
begin
`ASSERT(o_pc[1:0]==2'b00);
`ASSERT(o_pc[AW+1:2] == $past(i_pc[AW+1:2])+1'b1);
end else if ($past(iword[CISBIT])&&($past(o_phase)))
begin
`ASSERT(o_pc[(AW+1):1] == $past(o_pc[(AW+1):1]) + 1'b1);
end else if ($past(iword[CISBIT]))
begin
`ASSERT(o_pc[(AW+1):1] == { $past(i_pc[(AW+1):2]), 1'b1});
if (o_valid)
begin
`ASSERT(o_pc[1]);
`ASSERT((o_illegal)||(o_phase));
end
end
end
always @(*)
if (iword[CISBIT])
begin
`ASSERT((!w_ldi)||(w_I == { {(23-8){iword[23]}}, iword[23:16] }));
`ASSERT((w_ldi)||(iword[CISIMMSEL])
||(w_I == { {(23-7){iword[22]}}, iword[22:16] }));
`ASSERT((w_ldi)||(!iword[CISIMMSEL])
||(w_I == { {(23-3){iword[18]}}, iword[18:16] }));
end else begin
`ASSERT((!w_ldi)||(w_I == iword[22:0]));
`ASSERT((!w_mov)||(w_I == { {(23-13){iword[12]}}, iword[12:0] }));
`ASSERT((w_ldi)||(w_mov)||(iword[IMMSEL])
||(w_I == { {(23-18){iword[17]}}, iword[17:0] }));
`ASSERT((w_ldi)||(w_mov)||(!iword[IMMSEL])
||(w_I == { {(23-14){iword[13]}}, iword[13:0] }));
end
always @(posedge i_clk)
if ((f_past_valid)&&(o_phase)&&($past(i_ce)))
`ASSERT(($past(i_instruction[CISBIT]))
&&(r_nxt_half[14:0]==$past(i_instruction[14:0])));
// }}}
end else begin
// {{{
always @(*)
begin
`ASSERT((o_phase)||(iword[30:0] == i_instruction[30:0]));
`ASSERT(o_phase == 1'b0);
`ASSERT(o_pc[0] == 1'b0);
end
always @(posedge i_clk)
if ((f_past_valid)&&($past(i_ce))&&($past(i_pf_valid)))
begin
`ASSERT(o_pc[AW+1:2] == $past(i_pc[AW+1:2]) + 1'b1);
end else if (f_past_valid)
`ASSERT(o_pc == $past(o_pc));
always @(*)
`ASSERT(o_pc[1:0] == 2'b00);
always @(*)
`ASSERT((!w_ldi)||(w_I == iword[22:0]));
always @(*)
`ASSERT((!w_mov)||(w_I == { {(23-13){iword[12]}}, iword[12:0] }));
always @(*)
`ASSERT((w_ldi)||(w_mov)||(iword[IMMSEL])
||(w_I == { {(23-18){iword[17]}}, iword[17:0] }));
always @(*)
`ASSERT((w_ldi)||(w_mov)||(!iword[IMMSEL])
||(w_I == { {(23-14){iword[13]}}, iword[13:0] }));
always @(posedge i_clk)
if ((f_past_valid)&&($past(i_ce))&&(!$past(i_reset)))
`ASSERT((!$past(i_instruction[CISBIT]))
||(!$past(pf_valid))||(o_illegal));
// }}}
end endgenerate
// }}}
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset))&&($past(i_ce && pf_valid))
&&($past(w_fpu)))
begin
if (OPT_FPU)
begin
`ASSERT(o_FP);
end else if (!$past(w_special))
`ASSERT(o_illegal);
end
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset))&&($past(i_ce && pf_valid))&&($past(w_lock)))
begin
if (OPT_LOCK)
begin
`ASSERT(o_lock);
end else
`ASSERT(o_illegal);
end
////////////////////////////////////////////////////////////////////////
//
// Check pipelined memory instructions
// {{{
////////////////////////////////////////////////////////////////////////
//
//
// wire [20:0] f_next_pipe_I, f_this_pipe_I;
// assign f_this_pipe_I = r_I[22:2];
// assign f_next_pipe_I = r_I[22:2]+1'b1;
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset)))
begin
if (OPT_OPIPE)
begin
if (($past(i_ce))
&&(($past(pf_valid))||($past(o_phase))))
begin
if ((!$past(o_M))||(!o_M))
begin
`ASSERT(!o_pipe);
end else if ($past(o_op[0])!=o_op[0])
begin
`ASSERT(!o_pipe);
end else if ($past(o_rB)!=o_rB)
begin
`ASSERT(!o_pipe);
end else if ((o_rB)&&($past(o_dcdB) != o_dcdB))
begin
`ASSERT(!o_pipe);
end else if (($past(o_wR))
&&($past(o_dcdR[3:1]) == 3'h7))
begin
`ASSERT(!o_pipe);
end else if (o_wR != $past(o_wR))
begin
`ASSERT(!o_pipe);
end else if ((o_wR)&&($past(o_dcdR) == o_dcdB))
begin
`ASSERT(!o_pipe);
end else if ((o_wR)&&(o_dcdB[3:1] == 3'h7))
begin
`ASSERT(!o_pipe);
//
// Allow reading into the PC register as a form of jumping
// // else if ((o_wR)&&(o_dcdR[3:1] == 3'h7))
// // `ASSERT(!o_pipe);
// Allow discontinuous reads -- since our crossbar can now
// handle them
// else if (($past(o_cond) != 4'h8)
// &&($past(o_cond) != o_cond))
// `ASSERT(!o_pipe);
// This never really guaranteed that addresses would only
// increment, nor does it guarantee that addresses won't
// wrap around, so ... we'll just ignore this and (instead)
// generate a bus error in the memory controller on bad
// addresses
// else if ($past(r_I[22])!=r_I[22])
// `ASSERT(!o_pipe);
// else if (r_I[22:0] - $past(r_I[22:0])>23'h4)
// `ASSERT(!o_pipe);
end else if (!$past(o_valid))
`ASSERT(!o_pipe);
// else
// assert(o_pipe);
end else if ($past(i_stalled))
`ASSERT(o_pipe == $past(o_pipe));
end
end
always @(*)
`ASSERT((OPT_OPIPE)||(!o_pipe));
// }}}
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset))&&($past(i_ce))
&&($past(i_pf_valid))&&($past(w_mpy)))
`ASSERT((OPT_MPY)||(o_illegal));
always @(*)
if (o_valid)
`ASSERT((!o_phase)||(!o_early_branch));
always @(posedge i_clk)
if ((f_past_valid)&&($past(o_valid))&&($past(o_ljmp))&&($past(!i_stalled)))
`ASSERT(!o_valid);
always @(posedge i_clk)
if ((f_past_valid)&&($past(o_early_branch_stb)))
begin
`ASSERT(!o_phase);
if (!$past(i_stalled))
`ASSERT(!o_valid);
`ASSERT(!o_ljmp);
end
// Unless another valid instruction comes along, once o_ljmp is asserted
// it should stay asserted until either a reset or an early branch
// strobe.
always @(posedge i_clk)
if ((OPT_EARLY_BRANCHING)&&(f_past_valid)
&&($past(o_ljmp))&&(!$past(pf_valid))
&&(!$past(i_reset))&&(!$past(o_early_branch_stb)))
`ASSERT(o_ljmp);
// o_ljmp should only ever be asserted following a valid prefetch
// input. Hence, if the prefetch input isn't valid, then o_ljmp
// should be left low
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(o_ljmp))
&&( (!$past(pf_valid)) || (!$past(i_ce)) )
&&( !$past(o_phase) )
&&(!$past(i_reset))&&(!$past(o_early_branch_stb)))
`ASSERT(!o_ljmp);
always @(posedge i_clk)
if ((OPT_EARLY_BRANCHING)&&(f_past_valid)&&($past(o_ljmp))&&(!o_ljmp)
&&(!$past(i_reset)))
`ASSERT((o_early_branch_stb)&&(!o_valid));
always @(posedge i_clk)
`ASSERT((!o_early_branch_stb)||(!o_ljmp));
always @(posedge i_clk)
`ASSERT((!o_valid)||(!o_ljmp)||(o_phase == o_pc[1]));
always @(posedge i_clk)
if (!OPT_CIS)
begin
`ASSERT(!o_phase);
end else if (!f_insn_word[31])
begin
`ASSERT(!o_phase);
end else if (o_phase)
`ASSERT(o_pc[1]);
always @(*)
if ((o_early_branch)&&(!o_early_branch_stb))
`ASSERT(!o_pipe);
always @(*)
if (o_ljmp)
`ASSERT(!o_pipe);
always @(*)
`ASSERT(o_dcdR == o_dcdA);
always @(*)
if ((o_valid)&&(o_phase))
begin
`ASSERT(!o_illegal);
`ASSERT(o_pc[1]);
`ASSERT(f_insn_word[31]);
end
always @(posedge i_clk)
if ($rose(o_illegal))
`ASSERT(o_valid || $past(o_early_branch || o_ljmp));
always @(*)
`ASSERT(o_branch_pc[1:0] == 2'b00);
always @(*)
`ASSERT(o_pc[0] == 1'b0);
always @(posedge i_clk)
if ((f_past_valid)&&($past(i_pf_valid))&&(i_pf_valid))
`ASSUME((i_reset)||($stable(i_gie)));
////////////////////////////////////////////////////////////////////////
//
// Contract checking
// {{{
////////////////////////////////////////////////////////////////////////
//
//
wire fc_illegal, fc_wF, fc_ALU, fc_M, fc_DV, fc_FP, fc_break,
fc_lock, fc_wR, fc_rA, fc_rB, fc_prepipe, fc_sim;
wire [6:0] fc_dcdR, fc_dcdA, fc_dcdB;
wire [31:0] fc_I;
wire [3:0] fc_cond;
wire [3:0] fc_op;
wire [22:0] fc_sim_immv;
f_idecode #(
// {{{
.OPT_MPY(OPT_MPY),
.OPT_DIVIDE(OPT_DIVIDE),
.OPT_FPU(OPT_FPU),
.OPT_CIS(OPT_CIS),
.OPT_LOCK(OPT_LOCK),
.OPT_OPIPE(OPT_OPIPE),
.OPT_LOWPOWER(OPT_LOWPOWER),
.OPT_USERMODE(OPT_USERMODE),
.OPT_SIM(OPT_SIM)
// }}}
) formal_decoder(
// {{{
.i_instruction(f_insn_word), .i_phase(o_phase),
.i_gie(f_insn_gie),
.o_illegal(fc_illegal),
.o_dcdR(fc_dcdR), .o_dcdA(fc_dcdA), .o_dcdB(fc_dcdB),
.o_I(fc_I), .o_cond(fc_cond), .o_wF(fc_wF), .o_op(fc_op),
.o_ALU(fc_ALU), .o_M(fc_M), .o_DV(fc_DV), .o_FP(fc_FP),
.o_break(fc_break), .o_lock(fc_lock),
.o_wR(fc_wR), .o_rA(fc_rA), .o_rB(fc_rB),
.o_prepipe(fc_prepipe), .o_sim(fc_sim), .o_sim_immv(fc_sim_immv)
// }}}
);
always @(posedge i_clk)
if (o_valid && fc_illegal)
assert(o_illegal);
always @(posedge i_clk)
if (o_valid && !o_illegal)
begin
if (i_reset)
begin
`ASSERT(fc_dcdR[3:0]== o_dcdR[3:0]); //
`ASSERT(fc_dcdA[3:0]== o_dcdA[3:0]); //
`ASSERT(fc_dcdB[3:0]== o_dcdB[3:0]); //
end else begin
`ASSERT(fc_dcdR== o_dcdR); //
`ASSERT(fc_dcdA== o_dcdA); //
`ASSERT(fc_dcdB== o_dcdB); //
end
`ASSERT(fc_I == o_I);
`ASSERT(o_zI == (fc_I == 0));
`ASSERT(fc_cond== o_cond);
`ASSERT(fc_wF == o_wF);
`ASSERT(fc_op == o_op);
`ASSERT(fc_ALU == o_ALU);
`ASSERT(fc_M == o_M);
`ASSERT(fc_DV == o_DV);
`ASSERT(fc_FP == o_FP);
`ASSERT(fc_break== o_break);
`ASSERT(fc_lock == o_lock);
`ASSERT(fc_wR == o_wR);
`ASSERT(fc_rA == o_rA);
`ASSERT(fc_rB == o_rB);
`ASSERT(fc_sim == o_sim);
`ASSERT(fc_sim_immv == o_sim_immv);
`ASSERT(fc_prepipe == insn_is_pipeable);
end else
`ASSERT((i_reset)||(!insn_is_pipeable));
always @(*)
if (o_phase)
`ASSERT(r_nxt_half[14:0] == f_insn_word[14:0]);
always @(posedge i_clk)
if ((f_past_valid)&&(!$past(i_reset))&&(!i_reset)
&&($past(i_ce))&&(o_valid))
begin
`ASSERT(((fc_illegal)
||$past((i_illegal)&&(!o_phase))
||$past((o_illegal)&&( o_phase)))== o_illegal);
end
always @(posedge i_clk)
if ((!o_valid)||(o_illegal))
`ASSERT(!insn_is_pipeable);
generate if ((OPT_CIS)&&(OPT_EARLY_BRANCHING))
begin
always @(*)
if ((o_valid)
// LW
&&(o_M)&&(o_op[2:0]==3'b010)
// Zero immediate
&&(o_zI)
// Unconditional
&&(o_cond[3])
// From PC to PC
&&(o_dcdR[5])&&(o_dcdB[5]))
begin
`ASSERT((o_ljmp)
||((f_insn_word[31])&&(o_phase || o_illegal)));
end else if (o_valid)
`ASSERT(!o_ljmp);
end endgenerate
// }}}
`endif // FORMAL
// }}}
endmodule