// ----------------------------------------------------------------------
// "THE BEER-WARE LICENSE" (Revision 42):
//    <yasu@prosou.nu> wrote this file. As long as you retain this
//    notice you can do whatever you want with this stuff. If we meet
//    some day, and you think this stuff is worth it, you can buy me a
//    beer in return Yasunori Osana at University of the Ryukyus,
//    Japan.
// ----------------------------------------------------------------------
// OpenFC project: an open FPGA accelerated cluster toolkit
// Kyokko project: an open Multi-vendor Aurora 64B/66B-compatible link
//
// Modules in this file:
//    c10gx_kyokko: Kyokko + Transceiver wrapper for Cyclone 10 GX Dev board
// ----------------------------------------------------------------------

`default_nettype none

module c10gx_kyokko # ( parameter NumCh=2 )
  ( input wire CLK100, RST,
    
    input wire                 CLK644P,
    output wire [1:0]          SFP_TXP, SFP_TXN,
    input wire [1:0]           SFP_RXP, SFP_RXN,

    // ------------------------------
    // Aurora compatible interface signals
    
    output wire [NumCh-1:0]    CH_UP, USER_CLK,
    
    // Data channel
    input wire [64*NumCh-1:0]  S_AXI_TX_TDATA,
    input wire [ NumCh-1:0]    S_AXI_TX_TLAST, S_AXI_TX_TVALID,
    output wire [NumCh-1:0]    S_AXI_TX_TREADY,
    
    output wire [64*NumCh-1:0] M_AXI_RX_TDATA,
    output wire [ NumCh-1:0]   M_AXI_RX_TLAST, M_AXI_RX_TVALID,

    // UFC channel
    input wire [NumCh-1:0]     UFC_TX_REQ,
    input wire [8*NumCh-1:0]   UFC_TX_MS,
    
    input wire [64*NumCh-1:0]  S_AXI_UFC_TX_TDATA,
    input wire [NumCh-1:0]     S_AXI_UFC_TX_TVALID,
    output wire [NumCh-1:0]    S_AXI_UFC_TX_TREADY,

    output wire [64*NumCh-1:0] M_AXI_UFC_RX_TDATA,
    output wire [ NumCh-1:0]   M_AXI_UFC_RX_TLAST, M_AXI_UFC_RX_TVALID,
    
    // NFC channel
    input wire [16*NumCh-1:0]  S_AXI_NFC_TDATA,
    input wire [NumCh-1:0]     S_AXI_NFC_TVALID,
    output wire [NumCh-1:0]    S_AXI_NFC_TREADY
    
   );

   wire                        GT_RST;
   gt_rst grst
     ( .CLK(CLK100), .RST(RST), .GT_RST(GT_RST) );

   // ------------------------------
   // Kyokko instances

   wire                        PLL_LOCKED;
   wire [NumCh-1:0]            RX_LOCKED;
   
   wire [NumCh-1:0]            TXUSERCLK2;
   wire [NumCh-1:0]            RXUSERCLK2;
   wire [63:0]                 TXS [NumCh-1:0],
                               RXS [NumCh-1:0];
   
   wire [1:0]                  TXHDRi [NumCh-1:0];
   wire [1:0]                  RXHDRi [NumCh-1:0];
   
   wire [NumCh-1:0]            RXRST = ~RX_LOCKED;
   wire [NumCh-1:0]            TXRST = ~{NumCh{PLL_LOCKED}};
   
   wire [NumCh-1:0]            RXPATH_RST, RXSLIP;

   assign USER_CLK = TXUSERCLK2;
   
   genvar             ch;
   generate
      for (ch=0; ch<NumCh; ch=ch+1)
        begin : kyokko_gen
           wire [5:0] RXHDRc = RXHDRi[ch];
           kyokko ky
             ( .CLK(),  // still not used
               .CLK100(CLK100),
               .RXCLK(RXUSERCLK2[ch]),  .TXCLK(TXUSERCLK2[ch]),
               .RXRST(RXRST[ch]),       .TXRST(TXRST[ch]),
               .CH_UP(CH_UP[ch]),

               .RXHDR(RXHDRc[1:0]),   .RXS(RXS[ch]),
               .TXHDR(TXHDRi[ch]),        .TXS(TXS[ch]),
               .RXSLIP(RXSLIP[ch]),
               .RXPATH_RST(RXPATH_RST[ch]),

               // Data channels
               .M_AXIS_TVALID(M_AXI_RX_TVALID[ch]),
               .M_AXIS_TLAST (M_AXI_RX_TLAST [ch]),
               .M_AXIS_TDATA (M_AXI_RX_TDATA [ch*64+63 : ch*64]),

               .S_AXIS_TVALID (S_AXI_TX_TVALID[ch]),
               .S_AXIS_TREADY (S_AXI_TX_TREADY[ch]),
               .S_AXIS_TLAST  (S_AXI_TX_TLAST [ch]),
               .S_AXIS_TDATA  (S_AXI_TX_TDATA [ch*64+63 : ch*64]),

               // UFC channels
               .UFC_REQ           (UFC_TX_REQ [ch]),
               .UFC_MS            (UFC_TX_MS  [ch*8+7 : ch*8]),

               .S_AXIS_UFC_TVALID (S_AXI_UFC_TX_TVALID[ch]),
               .S_AXIS_UFC_TREADY (S_AXI_UFC_TX_TREADY[ch]),
               .S_AXIS_UFC_TDATA  (S_AXI_UFC_TX_TDATA [ch*64+63 : ch*64]),

               .M_AXIS_UFC_TVALID (M_AXI_UFC_RX_TVALID[ch]),
               .M_AXIS_UFC_TLAST  (M_AXI_UFC_RX_TLAST [ch]),
               .M_AXIS_UFC_TDATA  (M_AXI_UFC_RX_TDATA [ch*64+63 : ch*64]),

               // NFC channels
               .S_AXIS_NFC_TVALID (S_AXI_NFC_TVALID[ch]),
               .S_AXIS_NFC_TREADY (S_AXI_NFC_TREADY[ch]),
               .S_AXIS_NFC_TDATA  (S_AXI_NFC_TDATA [ch*16+15 : ch*16])
               );
        end // block: kyokko-gen
   endgenerate
   
   // ------------------------------
   // GT wizard cores

  c10_xcvr_2ch xcv
     ( .RST(RST | GT_RST), .USRCLK(CLK100), .REFCLK644P(CLK644P),
       .SFP_RXP(SFP_RXP),  .SFP_TXP(SFP_TXP),

       .TX_DATA  ({TXS[1], TXS[0]}),     
       .RX_DATA  ({RXS[1], RXS[0]}),
       .TX_CTRL  ({TXHDRi[1], TXHDRi[0]}), 
       .RX_CTRL  ({RXHDRi[1], RXHDRi[0]}),
       .TX_USRCLK(TXUSERCLK2),  
       .RX_USRCLK(RXUSERCLK2),
       .TX_VALID (1'b1),    
       .RX_BITSLIP(RXSLIP),

       .PLL_LOCKED(PLL_LOCKED), .RX_LOCKED(RX_LOCKED)
       );
   
endmodule // ku040_kyokko

`default_nettype wire