Subversion Repositories qspiflash

////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////

//

//

// Filename:    eqspiflash.v

// Filename:    eqspiflash.v

//

//

// Project:     OpenArty, an entirely open SoC based upon the Arty platform

// Project:     OpenArty, an entirely open SoC based upon the Arty platform

//

//

// Purpose:     Provide access to the flash device on an Arty, via the Extended

// Purpose:     Provide access to the flash device on an Arty, via the Extended

//              SPI interface.  Reads and writes will use the QuadSPI interface

//              SPI interface.  Reads and writes will use the QuadSPI interface

//      (4-bits at a time) all other commands (register and otherwise) will use

//      (4-bits at a time) all other commands (register and otherwise) will use

//      the SPI interface (1 bit at a time).

//      the SPI interface (1 bit at a time).

//

//

// Registers:

// Registers:

//      0. Erase register control.  Provides status of pending writes, erases,

//      0. Erase register control.  Provides status of pending writes, erases,

//              and commands (sub)sector erase operations.

//              and commands (sub)sector erase operations.

//         Bit-Fields:

//         Bit-Fields:

//              31. WIP (Write-In-Progress), write a '1' to this bit to command

//              31. WIP (Write-In-Progress), write a '1' to this bit to command

//                      an erase sequence.

//                      an erase sequence.

//              30. WriteEnabled -- set to a '1' to disable write protection and

//              30. WriteEnabled -- set to a '1' to disable write protection and

//                      to write a WRITE-ENABLE to the device.  Set to a '0' to

//                      to write a WRITE-ENABLE to the device.  Set to a '0' to

//                      disable WRITE-ENABLE-LATCH.  (Key is required to enable

//                      disable WRITE-ENABLE-LATCH.  (Key is required to enable

//                      writes)

//                      writes)

//              29. Quad mode read/writes enabled.  (Rest of controller will use

//              29. Quad mode read/writes enabled.  (Rest of controller will use

//                      extended SPI mode, but reads and writes will use Quad

//                      extended SPI mode, but reads and writes will use Quad

//                      mode.)

//                      mode.)

//              28. Subsector erase bit (set 1 to erase a subsector, 0 to 

//              28. Subsector erase bit (set 1 to erase a subsector, 0 to 

//                      erase a full sector, maintains last value written from

//                      erase a full sector, maintains last value written from

//                      an erase command, starts at '0')

//                      an erase command, starts at '0')

//              27. SD ID loaded

//              27. SD ID loaded

//              26. Write protect violation--cleared upon any valid write

//              26. Write protect violation--cleared upon any valid write

//              25. XIP enabled.  (Leave read mode in XIP, so you can start

//              25. XIP enabled.  (Leave read mode in XIP, so you can start

//                      next read faster.)

//                      next read faster.)

//              24. Unused

//              24. Unused

//              23..0: Address of erase sector upon erase command

//              23..0: Address of erase sector upon erase command

//              23..14: Sector address (can only be changed w/ key)

//              23..14: Sector address (can only be changed w/ key)

//              23..10: Subsector address (can only be changed w/ key)

//              23..10: Subsector address (can only be changed w/ key)

//               9.. 0: write protect KEY bits, always read a '0', write

//               9.. 0: write protect KEY bits, always read a '0', write

//                      commands, such as WP disable or erase, must always

//                      commands, such as WP disable or erase, must always

//                      write with a '1be' to activate.

//                      write with a '1be' to activate.

//      0. WEL: All writes that do not command an erase will be used

//      0. WEL: All writes that do not command an erase will be used

//                      to set/clear the write enable latch.

//                      to set/clear the write enable latch.

//                      Send 0x06, return, if WP is clear (enable writes)

//                      Send 0x06, return, if WP is clear (enable writes)

//                      Send 0x04, return

//                      Send 0x04, return

//      1. STATUS

//      1. STATUS

//              Send 0x05, read  1-byte

//              Send 0x05, read  1-byte

//              Send 0x01, write 1-byte: i_wb_data[7:0]

//              Send 0x01, write 1-byte: i_wb_data[7:0]

//      2. NV-CONFIG (16-bits)

//      2. NV-CONFIG (16-bits)

//              Send 0xB5, read  2-bytes

//              Send 0xB5, read  2-bytes

//              Send 0xB1, write 2-bytes: i_wb_data[15:0]

//              Send 0xB1, write 2-bytes: i_wb_data[15:0]

//      3. V-CONFIG (8-bits)

//      3. V-CONFIG (8-bits)

//              Send 0x85, read  1-byte

//              Send 0x85, read  1-byte

//              Send 0x81, write 1-byte: i_wb_data[7:0]

//              Send 0x81, write 1-byte: i_wb_data[7:0]

//      4. EV-CONFIG (8-bits)

//      4. EV-CONFIG (8-bits)

//              Send 0x65, read  1-byte

//              Send 0x65, read  1-byte

//              Send 0x61, write 1-byte: i_wb_data[7:0]

//              Send 0x61, write 1-byte: i_wb_data[7:0]

//      5. Lock (send 32-bits, rx 1 byte)

//      5. Lock (send 32-bits, rx 1 byte)

//              Send 0xE8, last-sector-addr (3b), read  1-byte

//              Send 0xE8, last-sector-addr (3b), read  1-byte

//              Send 0xE5, last-sector-addr (3b), write 1-byte: i_wb_data[7:0]

//              Send 0xE5, last-sector-addr (3b), write 1-byte: i_wb_data[7:0]

//      6. Flag Status

//      6. Flag Status

//              Send 0x70, read  1-byte

//              Send 0x70, read  1-byte

//              Send 0x50, to clear, no bytes to write

//              Send 0x50, to clear, no bytes to write

//      7. Asynch Read-ID: Write here to cause controller to read ID into buffer

//      7. Asynch Read-ID: Write here to cause controller to read ID into buffer

//      8.-12.  ID buffer (20 bytes, 5 words)

//      8.-12.  ID buffer (20 bytes, 5 words)

//              Attempted reads before buffer is full will stall bus until 

//              Attempted reads before buffer is full will stall bus until 

//              buffer is read.  Writes act like the asynch-Read-ID command,

//              buffer is read.  Writes act like the asynch-Read-ID command,

//              and will cause the controller to read the buffer.

//              and will cause the controller to read the buffer.

//      13.-14. Unused, mapped to Asynch-read-ID

//      13.-14. Unused, mapped to Asynch-read-ID

//      15.     OTP control word

//      15.     OTP control word

//                      Write zero to permanently lock OTP

//                      Write zero to permanently lock OTP

//                      Read to determine if OTP is permanently locked

//                      Read to determine if OTP is permanently locked

//      16.-31. OTP (64-bytes, 16 words, buffered until write)

//      16.-31. OTP (64-bytes, 16 words, buffered until write)

//              (Send DWP before writing to clear write enable latch)

//              (Send DWP before writing to clear write enable latch)

//

//

//

//

// Creator:     Dan Gisselquist, Ph.D.

// Creator:     Dan Gisselquist, Ph.D.

//              Gisselquist Technology, LLC

//              Gisselquist Technology, LLC

//

//

////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////

//

//

// Copyright (C) 2015-2016, Gisselquist Technology, LLC

// Copyright (C) 2015-2016, Gisselquist Technology, LLC

//

//

// This program is free software (firmware): you can redistribute it and/or

// This program is free software (firmware): you can redistribute it and/or

// modify it under the terms of  the GNU General Public License as published

// modify it under the terms of  the GNU General Public License as published

// by the Free Software Foundation, either version 3 of the License, or (at

// by the Free Software Foundation, either version 3 of the License, or (at

// your option) any later version.

// your option) any later version.

//

//

// This program is distributed in the hope that it will be useful, but WITHOUT

// This program is distributed in the hope that it will be useful, but WITHOUT

// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or

// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or

// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

// for more details.

// for more details.

//

//

// You should have received a copy of the GNU General Public License along

// You should have received a copy of the GNU General Public License along

// with this program.  (It's in the $(ROOT)/doc directory, run make with no

// with this program.  (It's in the $(ROOT)/doc directory, run make with no

// target there if the PDF file isn't present.)  If not, see

// target there if the PDF file isn't present.)  If not, see

// <http://www.gnu.org/licenses/> for a copy.

// <http://www.gnu.org/licenses/> for a copy.

//

//

// License:     GPL, v3, as defined and found on www.gnu.org,

// License:     GPL, v3, as defined and found on www.gnu.org,

//              http://www.gnu.org/licenses/gpl.html

//              http://www.gnu.org/licenses/gpl.html

//

//

//

//

////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////

//

//

//

//

// `define      QSPI_READ_ONLY

// `define      QSPI_READ_ONLY

module  eqspiflash(i_clk_200mhz, i_rst,

module  eqspiflash(i_clk_200mhz, i_rst,

                // Incoming wishbone connection(s)

                // Incoming wishbone connection(s)

                //      The two strobe lines allow the data to live on a

                //      The two strobe lines allow the data to live on a

                //      separate part of the master bus from the control 

                //      separate part of the master bus from the control 

                //      registers.  Only one strobe will ever be active at any

                //      registers.  Only one strobe will ever be active at any

                //      time, no strobes will ever be active unless i_wb_cyc

                //      time, no strobes will ever be active unless i_wb_cyc

                //      is also active.

                //      is also active.

                i_wb_cyc, i_wb_data_stb, i_wb_ctrl_stb, i_wb_we,

                i_wb_cyc, i_wb_data_stb, i_wb_ctrl_stb, i_wb_we,

                i_wb_addr, i_wb_data,

                i_wb_addr, i_wb_data,

                // Outgoing wishbone data

                // Outgoing wishbone data

                o_wb_ack, o_wb_stall, o_wb_data,

                o_wb_ack, o_wb_stall, o_wb_data,

                // Quad SPI connections

                // Quad SPI connections

                o_qspi_sck, o_qspi_cs_n, o_qspi_mod, o_qspi_dat, i_qspi_dat,

                o_qspi_sck, o_qspi_cs_n, o_qspi_mod, o_qspi_dat, i_qspi_dat,

                // Interrupt the CPU

                // Interrupt the CPU

                o_interrupt, o_cmd_accepted,

                o_interrupt, o_cmd_accepted,

                // Debug the interface

                // Debug the interface

                o_dbg);

                o_dbg);

        input                   i_clk_200mhz, i_rst;

        input                   i_clk_200mhz, i_rst;

        // Wishbone bus inputs

        // Wishbone bus inputs

        input                   i_wb_cyc, i_wb_data_stb, i_wb_ctrl_stb, i_wb_we;

        input                   i_wb_cyc, i_wb_data_stb, i_wb_ctrl_stb, i_wb_we;

        input           [21:0]   i_wb_addr;      // 24 bits of addr space

        input           [21:0]   i_wb_addr;      // 24 bits of addr space

        input           [31:0]   i_wb_data;

        input           [31:0]   i_wb_data;

        // Wishbone bus outputs

        // Wishbone bus outputs

        output  reg             o_wb_ack;

        output  reg             o_wb_ack;

        output  wire            o_wb_stall;

        output  wire            o_wb_stall;

        output  reg     [31:0]   o_wb_data;

        output  reg     [31:0]   o_wb_data;

        // Quad SPI connections

        // Quad SPI connections

        output  wire            o_qspi_sck, o_qspi_cs_n;

        output  wire            o_qspi_sck, o_qspi_cs_n;

        output  wire    [1:0]    o_qspi_mod;

        output  wire    [1:0]    o_qspi_mod;

        output  wire    [3:0]    o_qspi_dat;

        output  wire    [3:0]    o_qspi_dat;

        input   wire    [3:0]    i_qspi_dat;

        input   wire    [3:0]    i_qspi_dat;

        //

        //

        output  reg             o_interrupt;

        output  reg             o_interrupt;

        //

        //

        output  reg             o_cmd_accepted;

        output  reg             o_cmd_accepted;

        //

        //

        output  wire    [31:0]   o_dbg;

        output  wire    [31:0]   o_dbg;

        initial o_cmd_accepted = 1'b0;

        initial o_cmd_accepted = 1'b0;

        always @(posedge i_clk_200mhz)

        always @(posedge i_clk_200mhz)

                o_cmd_accepted=((i_wb_data_stb)||(i_wb_ctrl_stb))&&(~o_wb_stall);

                o_cmd_accepted=((i_wb_data_stb)||(i_wb_ctrl_stb))&&(~o_wb_stall);

        //

        //

        // lleqspi

        // lleqspi

        //

        //

        //      Providing the low-level SPI interface

        //      Providing the low-level SPI interface

        //

        //

        reg     spi_wr, spi_hold, spi_spd, spi_dir, spi_recycle;

        reg     spi_wr, spi_hold, spi_spd, spi_dir, spi_recycle;

        reg     [31:0]   spi_word;

        reg     [31:0]   spi_word;

        reg     [1:0]    spi_len;

        reg     [1:0]    spi_len;

        wire    [31:0]   spi_out;

        wire    [31:0]   spi_out;

        wire            spi_valid, spi_busy, spi_stopped;

        wire            spi_valid, spi_busy, spi_stopped;

        lleqspi lowlvl(i_clk_200mhz, spi_wr, spi_hold, spi_word, spi_len,

        lleqspi lowlvl(i_clk_200mhz, spi_wr, spi_hold, spi_word, spi_len,

                        spi_spd, spi_dir, spi_recycle, spi_out, spi_valid, spi_busy,

                        spi_spd, spi_dir, spi_recycle, spi_out, spi_valid, spi_busy,

                o_qspi_sck, o_qspi_cs_n, o_qspi_mod, o_qspi_dat, i_qspi_dat);

                o_qspi_sck, o_qspi_cs_n, o_qspi_mod, o_qspi_dat, i_qspi_dat);

        assign  spi_stopped = (o_qspi_cs_n)&&(~spi_busy)&&(~spi_wr);

        assign  spi_stopped = (o_qspi_cs_n)&&(~spi_busy)&&(~spi_wr);

        //

        //

        // Bus module

        // Bus module

        //

        //

        //      Providing a shared interface to the WB bus

        //      Providing a shared interface to the WB bus

        //

        //

        // Wishbone data (returns)

        // Wishbone data (returns)

        wire            bus_wb_ack, bus_wb_stall;

        wire            bus_wb_ack, bus_wb_stall;

        wire    [31:0]   bus_wb_data;

        wire    [31:0]   bus_wb_data;

        // Latched request data

        // Latched request data

        wire            bus_wr;

        wire            bus_wr;

        wire    [21:0]   bus_addr;

        wire    [21:0]   bus_addr;

        wire    [31:0]   bus_data;

        wire    [31:0]   bus_data;

        wire    [21:0]   bus_sector;

        wire    [21:0]   bus_sector;

        // Strobe commands

        // Strobe commands

        wire    bus_ack;

        wire    bus_ack;

        wire    bus_readreq, bus_piperd, bus_ereq, bus_wreq,

        wire    bus_readreq, bus_piperd, bus_ereq, bus_wreq,

                        bus_pipewr, bus_endwr, bus_ctreq, bus_idreq,

                        bus_pipewr, bus_endwr, bus_ctreq, bus_idreq,

                        bus_other_req,

                        bus_other_req,

        // Live parameters

        // Live parameters

                        w_xip, w_quad, w_idloaded;

                        w_xip, w_quad, w_idloaded;

        reg             bus_wip;

        reg             bus_wip;

        qspibus preproc(i_clk_200mhz, i_rst,

        qspibus preproc(i_clk_200mhz, i_rst,

                        i_wb_cyc, i_wb_data_stb, i_wb_ctrl_stb,

                        i_wb_cyc, i_wb_data_stb, i_wb_ctrl_stb,

                                i_wb_we, i_wb_addr, i_wb_data,

                                i_wb_we, i_wb_addr, i_wb_data,

                                bus_wb_ack, bus_wb_stall, bus_wb_data,

                                bus_wb_ack, bus_wb_stall, bus_wb_data,

                        bus_wr, bus_addr, bus_data, bus_sector,

                        bus_wr, bus_addr, bus_data, bus_sector,

                                bus_readreq, bus_piperd,

                                bus_readreq, bus_piperd,

                                        bus_wreq, bus_ereq,

                                        bus_wreq, bus_ereq,

                                        bus_pipewr, bus_endwr,

                                        bus_pipewr, bus_endwr,

                                bus_ctreq, bus_idreq, bus_other_req, bus_ack,

                                bus_ctreq, bus_idreq, bus_other_req, bus_ack,

                        w_xip, w_quad, w_idloaded, bus_wip, spi_stopped);

                        w_xip, w_quad, w_idloaded, bus_wip, spi_stopped);

        //

        //

        // Read flash module

        // Read flash module

        //

        //

        //      Providing a means of (and the logic to support) reading from

        //      Providing a means of (and the logic to support) reading from

        //      the flash

        //      the flash

        //

        //

        wire            rd_data_ack;

        wire            rd_data_ack;

        wire    [31:0]   rd_data;

        wire    [31:0]   rd_data;

        //

        //

        wire            rd_bus_ack;

        wire            rd_bus_ack;

        //

        //

        wire            rd_qspi_req;

        wire            rd_qspi_req;

        wire            rd_qspi_grant;

        wire            rd_qspi_grant;

        //

        //

        wire            rd_spi_wr, rd_spi_hold, rd_spi_spd, rd_spi_dir,

        wire            rd_spi_wr, rd_spi_hold, rd_spi_spd, rd_spi_dir,

                        rd_spi_recycle;

                        rd_spi_recycle;

        wire    [31:0]   rd_spi_word;

        wire    [31:0]   rd_spi_word;

        wire    [1:0]    rd_spi_len;

        wire    [1:0]    rd_spi_len;

        //

        //

        readqspi        rdproc(i_clk_200mhz, bus_readreq, bus_piperd,

        readqspi        rdproc(i_clk_200mhz, bus_readreq, bus_piperd,

                                        bus_other_req,

                                        bus_other_req,

                                bus_addr, rd_bus_ack,

                                bus_addr, rd_bus_ack,

                                rd_qspi_req, rd_qspi_grant,

                                rd_qspi_req, rd_qspi_grant,

                                rd_spi_wr, rd_spi_hold, rd_spi_word, rd_spi_len,

                                rd_spi_wr, rd_spi_hold, rd_spi_word, rd_spi_len,

                                rd_spi_spd, rd_spi_dir, rd_spi_recycle,

                                rd_spi_spd, rd_spi_dir, rd_spi_recycle,

                                        spi_out, spi_valid,

                                        spi_out, spi_valid,

                                        spi_busy, spi_stopped, rd_data_ack, rd_data,

                                        spi_busy, spi_stopped, rd_data_ack, rd_data,

                                        w_quad, w_xip);

                                        w_quad, w_xip);

        //

        //

        // Write/Erase flash module

        // Write/Erase flash module

        //

        //

        //      Logic to write (program) and erase the flash.

        //      Logic to write (program) and erase the flash.

        //

        //

        // Wishbone bus return

        // Wishbone bus return

        wire            ew_data_ack;

        wire            ew_data_ack;

        wire    [31:0]   ew_data;

        wire    [31:0]   ew_data;

        // Arbiter interaction

        // Arbiter interaction

        wire            ew_qspi_req;

        wire            ew_qspi_req;

        wire            ew_qspi_grant;

        wire            ew_qspi_grant;

        // Bus controller return

        // Bus controller return

        wire            ew_bus_ack;

        wire            ew_bus_ack;

        // SPI control wires

        // SPI control wires

        wire            ew_spi_wr, ew_spi_hold, ew_spi_spd, ew_spi_dir;

        wire            ew_spi_wr, ew_spi_hold, ew_spi_spd, ew_spi_dir;

        wire    [31:0]   ew_spi_word;

        wire    [31:0]   ew_spi_word;

        wire    [1:0]    ew_spi_len;

        wire    [1:0]    ew_spi_len;

        //

        //

        wire            w_ew_wip;

        wire            w_ew_wip;

        //

        //

        writeqspi       ewproc(i_clk_200mhz, bus_wreq,bus_ereq,

        writeqspi       ewproc(i_clk_200mhz, bus_wreq,bus_ereq,

                                        bus_pipewr, bus_endwr,

                                        bus_pipewr, bus_endwr,

                                        bus_addr, bus_data,

                                        bus_addr, bus_data,

                                ew_bus_ack, ew_qspi_req, ew_qspi_grant,

                                ew_bus_ack, ew_qspi_req, ew_qspi_grant,

                                ew_spi_wr, ew_spi_hold, ew_spi_word, ew_spi_len,

                                ew_spi_wr, ew_spi_hold, ew_spi_word, ew_spi_len,

                                        ew_spi_spd, ew_spi_dir,

                                        ew_spi_spd, ew_spi_dir,

                                        spi_out, spi_valid, spi_busy, spi_stopped,

                                        spi_out, spi_valid, spi_busy, spi_stopped,

                                ew_data_ack, w_quad, w_ew_wip);

                                ew_data_ack, w_quad, w_ew_wip);

        //

        //

        // Control module

        // Control module

        //

        //

        //      Logic to read/write status and configuration registers

        //      Logic to read/write status and configuration registers

        //

        //

        // Wishbone bus return

        // Wishbone bus return

        wire            ct_data_ack;

        wire            ct_data_ack;

        wire    [31:0]   ct_data;

        wire    [31:0]   ct_data;

        // Arbiter interaction

        // Arbiter interaction

        wire            ct_qspi_req;

        wire            ct_qspi_req;

        wire            ct_grant;

        wire            ct_grant;

        // Bus controller return

        // Bus controller return

        wire            ct_ack;

        wire            ct_ack;

        // SPI control wires

        // SPI control wires

        wire            ct_spi_wr, ct_spi_hold, ct_spi_spd, ct_spi_dir;

        wire            ct_spi_wr, ct_spi_hold, ct_spi_spd, ct_spi_dir;

        wire    [31:0]   ct_spi_word;

        wire    [31:0]   ct_spi_word;

        wire    [1:0]    ct_spi_len;

        wire    [1:0]    ct_spi_len;

        //

        //

        ctrlspi         ctproc(i_clk_200mhz,

        ctrlspi         ctproc(i_clk_200mhz,

                                bus_ctreq, bus_wr, bus_addr[2:0], bus_data, bus_sector,

                                bus_ctreq, bus_wr, bus_addr[2:0], bus_data, bus_sector,

                                ct_qspi_req, ct_grant,

                                ct_qspi_req, ct_grant,

                                ct_spi_wr, ct_spi_hold, ct_spi_word, ct_spi_len,

                                ct_spi_wr, ct_spi_hold, ct_spi_word, ct_spi_len,

                                        ct_spi_spd, ct_spi_dir,

                                        ct_spi_spd, ct_spi_dir,

                                        spi_out, spi_valid, spi_busy, spi_stopped,

                                        spi_out, spi_valid, spi_busy, spi_stopped,

                                ct_ack, ct_data_ack, ct_data, w_xip, w_quad);

                                ct_ack, ct_data_ack, ct_data, w_xip, w_quad);

        assign  ct_spi_hold = 1'b0;

        assign  ct_spi_hold = 1'b0;

        assign  ct_spi_spd  = 1'b0;

        assign  ct_spi_spd  = 1'b0;

        //

        //

        // ID/OTP module

        // ID/OTP module

        //

        //

        //      Access to ID and One-Time-Programmable registers, but to read

        //      Access to ID and One-Time-Programmable registers, but to read

        //      and to program (the OTP), and to finally lock (OTP) registers.

        //      and to program (the OTP), and to finally lock (OTP) registers.

        //

        //

        // Wishbone bus return

        // Wishbone bus return

        wire            id_data_ack;

        wire            id_data_ack;

        wire    [31:0]   id_data;

        wire    [31:0]   id_data;

        // Arbiter interaction

        // Arbiter interaction

        wire            id_qspi_req;

        wire            id_qspi_req;

        wire            id_qspi_grant;

        wire            id_qspi_grant;

        // Bus controller return

        // Bus controller return

        wire            id_bus_ack;

        wire            id_bus_ack;

        // SPI control wires

        // SPI control wires

        wire            id_spi_wr, id_spi_hold, id_spi_spd, id_spi_dir;

        wire            id_spi_wr, id_spi_hold, id_spi_spd, id_spi_dir;

        wire    [31:0]   id_spi_word;

        wire    [31:0]   id_spi_word;

        wire    [1:0]    id_spi_len;

        wire    [1:0]    id_spi_len;

        //

        //

        wire            w_id_wip;

        wire            w_id_wip;

        //

        //

        idotpqspi       idotp(i_clk_200mhz, bus_idreq,

        idotpqspi       idotp(i_clk_200mhz, bus_idreq,

                                bus_wr, bus_pipewr, bus_addr[4:0], bus_data, id_bus_ack,

                                bus_wr, bus_pipewr, bus_addr[4:0], bus_data, id_bus_ack,

                                id_qspi_req, id_qspi_grant,

                                id_qspi_req, id_qspi_grant,

                                id_spi_wr, id_spi_hold, id_spi_word, id_spi_len,

                                id_spi_wr, id_spi_hold, id_spi_word, id_spi_len,

                                        id_spi_spd, id_spi_dir,

                                        id_spi_spd, id_spi_dir,

                                        spi_out, spi_valid, spi_busy, spi_stopped,

                                        spi_out, spi_valid, spi_busy, spi_stopped,

                                id_data_ack, id_data, w_idloaded, w_id_wip);

                                id_data_ack, id_data, w_idloaded, w_id_wip);

        // Arbitrator

        // Arbitrator

        reg             owned;

        reg             owned;

        reg     [1:0]    owner;

        reg     [1:0]    owner;

        initial         owned = 1'b0;

        initial         owned = 1'b0;

        always @(posedge i_clk_200mhz) // 7 inputs (spi_stopped is the CE)

        always @(posedge i_clk_200mhz) // 7 inputs (spi_stopped is the CE)

                if ((~owned)&&(spi_stopped))

                if ((~owned)&&(spi_stopped))

                begin

                begin

                        casez({rd_qspi_req,ew_qspi_req,id_qspi_req,ct_qspi_req})

                        casez({rd_qspi_req,ew_qspi_req,id_qspi_req,ct_qspi_req})

                        4'b1???: begin owned<= 1'b1; owner <= 2'b00; end

                        4'b1???: begin owned<= 1'b1; owner <= 2'b00; end

                        4'b01??: begin owned<= 1'b1; owner <= 2'b01; end

                        4'b01??: begin owned<= 1'b1; owner <= 2'b01; end

                        4'b001?: begin owned<= 1'b1; owner <= 2'b10; end

                        4'b001?: begin owned<= 1'b1; owner <= 2'b10; end

                        4'b0001: begin owned<= 1'b1; owner <= 2'b11; end

                        4'b0001: begin owned<= 1'b1; owner <= 2'b11; end

                        default: begin owned<= 1'b0; owner <= 2'b00; end

                        default: begin owned<= 1'b0; owner <= 2'b00; end

                        endcase

                        endcase

                end else if ((owned)&&(spi_stopped))

                end else if ((owned)&&(spi_stopped))

                begin

                begin

                        casez({rd_qspi_req,ew_qspi_req,id_qspi_req,ct_qspi_req,owner})

                        casez({rd_qspi_req,ew_qspi_req,id_qspi_req,ct_qspi_req,owner})

                        6'b0???00: owned<= 1'b0;

                        6'b0???00: owned<= 1'b0;

                        6'b?0??01: owned<= 1'b0;

                        6'b?0??01: owned<= 1'b0;

                        6'b??0?10: owned<= 1'b0;

                        6'b??0?10: owned<= 1'b0;

                        6'b???011: owned<= 1'b0;

                        6'b???011: owned<= 1'b0;

                        default: begin ; end

                        default: begin ; end

                        endcase

                        endcase

                end

                end

        assign  rd_qspi_grant = (owned)&&(owner == 2'b00);

        assign  rd_qspi_grant = (owned)&&(owner == 2'b00);

        assign  ew_qspi_grant = (owned)&&(owner == 2'b01);

        assign  ew_qspi_grant = (owned)&&(owner == 2'b01);

        assign  id_qspi_grant = (owned)&&(owner == 2'b10);

        assign  id_qspi_grant = (owned)&&(owner == 2'b10);

        assign  ct_grant      = (owned)&&(owner == 2'b11);

        assign  ct_grant      = (owned)&&(owner == 2'b11);

        // Module controller

        // Module controller

        always @(posedge i_clk_200mhz)

        always @(posedge i_clk_200mhz)

        case(owner)

        case(owner)

        2'b00: begin

        2'b00: begin

                spi_wr      <= (owned)&&(rd_spi_wr);

                spi_wr      <= (owned)&&(rd_spi_wr);

                spi_hold    <= rd_spi_hold;

                spi_hold    <= rd_spi_hold;

                spi_word    <= rd_spi_word;

                spi_word    <= rd_spi_word;

                spi_len     <= rd_spi_len;

                spi_len     <= rd_spi_len;

                spi_spd     <= rd_spi_spd;

                spi_spd     <= rd_spi_spd;

                spi_dir     <= rd_spi_dir;

                spi_dir     <= rd_spi_dir;

                spi_recycle <= rd_spi_recycle;

                spi_recycle <= rd_spi_recycle;

                end

                end

        2'b01: begin

        2'b01: begin

                spi_wr      <= (owned)&&(ew_spi_wr);

                spi_wr      <= (owned)&&(ew_spi_wr);

                spi_hold    <= ew_spi_hold;

                spi_hold    <= ew_spi_hold;

                spi_word    <= ew_spi_word;

                spi_word    <= ew_spi_word;

                spi_len     <= ew_spi_len;

                spi_len     <= ew_spi_len;

                spi_spd     <= ew_spi_spd;

                spi_spd     <= ew_spi_spd;

                spi_dir     <= ew_spi_dir;

                spi_dir     <= ew_spi_dir;

                spi_recycle <= 1'b1; // Long recycle time

                spi_recycle <= 1'b1; // Long recycle time

                end

                end

        2'b10: begin

        2'b10: begin

                spi_wr      <= (owned)&&(id_spi_wr);

                spi_wr      <= (owned)&&(id_spi_wr);

                spi_hold    <= id_spi_hold;

                spi_hold    <= id_spi_hold;

                spi_word    <= id_spi_word;

                spi_word    <= id_spi_word;

                spi_len     <= id_spi_len;

                spi_len     <= id_spi_len;

                spi_spd     <= id_spi_spd;

                spi_spd     <= id_spi_spd;

                spi_dir     <= id_spi_dir;

                spi_dir     <= id_spi_dir;

                spi_recycle <= 1'b1; // Long recycle time

                spi_recycle <= 1'b1; // Long recycle time

                end

                end

        2'b11: begin

        2'b11: begin

                spi_wr      <= (owned)&&(ct_spi_wr);

                spi_wr      <= (owned)&&(ct_spi_wr);

                spi_hold    <= ct_spi_hold;

                spi_hold    <= ct_spi_hold;

                spi_word    <= ct_spi_word;

                spi_word    <= ct_spi_word;

                spi_len     <= ct_spi_len;

                spi_len     <= ct_spi_len;

                spi_spd     <= ct_spi_spd;

                spi_spd     <= ct_spi_spd;

                spi_dir     <= ct_spi_dir;

                spi_dir     <= ct_spi_dir;

                spi_recycle <= 1'b1; // Long recycle time

                spi_recycle <= 1'b1; // Long recycle time

                end

                end

        endcase

        endcase

        reg     last_wip;

        reg     last_wip;

        initial bus_wip = 1'b0;

        initial bus_wip = 1'b0;

        initial last_wip = 1'b0;

        initial last_wip = 1'b0;

        initial o_interrupt = 1'b0;

        initial o_interrupt = 1'b0;

        always @(posedge i_clk_200mhz)

        always @(posedge i_clk_200mhz)

        begin

        begin

                bus_wip <= w_ew_wip || w_id_wip;

                bus_wip <= w_ew_wip || w_id_wip;

                last_wip <= bus_wip;

                last_wip <= bus_wip;

                o_interrupt <= ((~bus_wip)&&(last_wip));

                o_interrupt <= ((~bus_wip)&&(last_wip));

        end

        end

        // Now, let's return values onto the wb bus

        // Now, let's return values onto the wb bus

        always @(posedge i_clk_200mhz)

        always @(posedge i_clk_200mhz)

        begin

        begin

                // Ack our internal bus controller.  This means the command was

                // Ack our internal bus controller.  This means the command was

                // accepted, and the bus can go on to looking for the next 

                // accepted, and the bus can go on to looking for the next 

                // command.  It controls the i_wb_stall line, just not the

                // command.  It controls the i_wb_stall line, just not the

                // i_wb_ack line.

                // i_wb_ack line.

                // Ack the wishbone with any response

                // Ack the wishbone with any response

                o_wb_ack <= (bus_wb_ack)|(rd_data_ack)|(ew_data_ack)|(id_data_ack)|(ct_data_ack);

                o_wb_ack <= (bus_wb_ack)|(rd_data_ack)|(ew_data_ack)|(id_data_ack)|(ct_data_ack);

                o_wb_data <= (bus_wb_ack)?bus_wb_data

                o_wb_data <= (bus_wb_ack)?bus_wb_data

                        : (id_data_ack) ? id_data : spi_out;

                        : (id_data_ack) ? id_data : spi_out;

        end

        end

        assign  o_wb_stall = bus_wb_stall;

        assign  o_wb_stall = bus_wb_stall;

        assign  bus_ack = (rd_bus_ack|ew_bus_ack|id_bus_ack|ct_ack);

        assign  bus_ack = (rd_bus_ack|ew_bus_ack|id_bus_ack|ct_ack);

        assign  o_dbg = {

        assign  o_dbg = {

                i_wb_cyc, i_wb_ctrl_stb, i_wb_data_stb, o_wb_ack, bus_ack, //5

                i_wb_cyc, i_wb_ctrl_stb, i_wb_data_stb, o_wb_ack, bus_ack, //5

                //

                //

                (spi_wr)&&(~spi_busy), spi_valid, spi_word[31:25],

                (spi_wr)&&(~spi_busy), spi_valid, spi_word[31:25],

                spi_out[7:2],

                spi_out[7:2],

                //

                //

                o_qspi_cs_n, o_qspi_sck, o_qspi_mod,    // 4 bits

                o_qspi_cs_n, o_qspi_sck, o_qspi_mod,    // 4 bits

                o_qspi_dat, i_qspi_dat                  // 8 bits

                o_qspi_dat, i_qspi_dat                  // 8 bits

                };

                };

endmodule

endmodule

module  qspibus(i_clk, i_rst, i_cyc, i_data_stb, i_ctrl_stb,

module  qspibus(i_clk, i_rst, i_cyc, i_data_stb, i_ctrl_stb,

                i_we, i_addr, i_data,

                i_we, i_addr, i_data,

                        o_wb_ack, o_wb_stall, o_wb_data,

                        o_wb_ack, o_wb_stall, o_wb_data,

                o_wr, o_addr, o_data, o_sector,

                o_wr, o_addr, o_data, o_sector,

                o_readreq, o_piperd, o_wrreq, o_erreq, o_pipewr, o_endwr,

                o_readreq, o_piperd, o_wrreq, o_erreq, o_pipewr, o_endwr,

                        o_ctreq, o_idreq, o_other,

                        o_ctreq, o_idreq, o_other,

                i_ack, i_xip, i_quad, i_idloaded, i_wip, i_spi_stopped);

                i_ack, i_xip, i_quad, i_idloaded, i_wip, i_spi_stopped);

        //

        //

        input                   i_clk, i_rst;

        input                   i_clk, i_rst;

        // Wishbone bus inputs

        // Wishbone bus inputs

        input                   i_cyc, i_data_stb, i_ctrl_stb, i_we;

        input                   i_cyc, i_data_stb, i_ctrl_stb, i_we;

        input           [21:0]   i_addr;

        input           [21:0]   i_addr;

        input           [31:0]   i_data;

        input           [31:0]   i_data;

        // Wishbone bus outputs

        // Wishbone bus outputs

        output  reg             o_wb_ack;

        output  reg             o_wb_ack;

        output  reg             o_wb_stall;

        output  reg             o_wb_stall;

        output  wire    [31:0]   o_wb_data;

        output  wire    [31:0]   o_wb_data;

        // Internal signals to the QSPI flash interface

        // Internal signals to the QSPI flash interface

        output  reg             o_wr;

        output  reg             o_wr;

        output  reg     [21:0]   o_addr;

        output  reg     [21:0]   o_addr;

        output  reg     [31:0]   o_data;

        output  reg     [31:0]   o_data;

        output  wire    [21:0]   o_sector;

        output  wire    [21:0]   o_sector;

        output  reg             o_readreq, o_piperd, o_wrreq, o_erreq,

        output  reg             o_readreq, o_piperd, o_wrreq, o_erreq,

                                o_pipewr, o_endwr,

                                o_pipewr, o_endwr,

                                o_ctreq, o_idreq;

                                o_ctreq, o_idreq;

        output  wire            o_other;

        output  wire            o_other;

        input                   i_ack, i_xip, i_quad, i_idloaded;

        input                   i_ack, i_xip, i_quad, i_idloaded;

        input                   i_wip, i_spi_stopped;

        input                   i_wip, i_spi_stopped;

        //

        //

        reg     pending, lcl_wrreq, lcl_ctreq, lcl_ack, ack, wp_err, wp;

        reg     pending, lcl_wrreq, lcl_ctreq, lcl_ack, ack, wp_err, wp;

        reg     lcl_reg;

        reg     lcl_reg;

        reg     [14:0]   esector;

        reg     [14:0]   esector;

        reg     [21:0]   next_addr;

        reg     [21:0]   next_addr;

        reg     pipeable;

        reg     pipeable;

        reg     same_page;

        reg     same_page;

        always @(posedge i_clk)

        always @(posedge i_clk)

                same_page <= (i_data_stb)&&(i_we)

                same_page <= (i_data_stb)&&(i_we)

                        &&(i_addr[21:6] == o_addr[21:6])

                        &&(i_addr[21:6] == o_addr[21:6])

                        &&(i_addr[5:0] == o_addr[5:0] + 6'h1);

                        &&(i_addr[5:0] == o_addr[5:0] + 6'h1);

        initial pending = 1'b0;

        initial pending = 1'b0;

        initial o_readreq = 1'b0;

        initial o_readreq = 1'b0;

        initial lcl_wrreq = 1'b0;

        initial lcl_wrreq = 1'b0;

        initial lcl_ctreq = 1'b0;

        initial lcl_ctreq = 1'b0;

        initial o_ctreq   = 1'b0;

        initial o_ctreq   = 1'b0;

        initial o_idreq   = 1'b0;

        initial o_idreq   = 1'b0;

        initial ack = 1'b0;

        initial ack = 1'b0;

        always @(posedge i_clk)

        always @(posedge i_clk)

                ack <= (i_ack)||(lcl_ack);

                ack <= (i_ack)||(lcl_ack);

        // wire [9:0]   key;

        // wire [9:0]   key;

        // assign       key = 10'h1be;

        // assign       key = 10'h1be;

        reg     lcl_key, set_sector, ctreg_stb;

        reg     lcl_key, set_sector, ctreg_stb;

        initial lcl_key = 1'b0;

        initial lcl_key = 1'b0;

        always @(posedge i_clk)

        always @(posedge i_clk)

                // Write protect "key" to enable the disabling of write protect

                // Write protect "key" to enable the disabling of write protect

                lcl_key<= (i_ctrl_stb)&&(~wp)&&(i_we)&&(i_addr[5:0]==6'h00)

                lcl_key<= (i_ctrl_stb)&&(~wp)&&(i_we)&&(i_addr[5:0]==6'h00)

                                &&(i_data[9:0] == 10'h1be)&&(i_data[31:30]==2'b11);

                                &&(i_data[9:0] == 10'h1be)&&(i_data[31:30]==2'b11);

        initial set_sector = 1'b0;

        initial set_sector = 1'b0;

        always @(posedge i_clk)

        always @(posedge i_clk)

                set_sector <= (i_ctrl_stb)&&(~o_wb_stall)

                set_sector <= (i_ctrl_stb)&&(~o_wb_stall)

                                &&(i_we)&&(i_addr[5:0]==6'h00)

                                &&(i_we)&&(i_addr[5:0]==6'h00)

                                &&(i_data[9:0] == 10'h1be);

                                &&(i_data[9:0] == 10'h1be);

        always @(posedge i_clk)

        always @(posedge i_clk)

                if (i_ctrl_stb)

                if (i_ctrl_stb)

                        lcl_reg <= (i_addr[3:0] == 4'h00);

                        lcl_reg <= (i_addr[3:0] == 4'h00);

        initial ctreg_stb = 1'b0;

        initial ctreg_stb = 1'b0;

        initial o_wb_stall = 1'b0;

        initial o_wb_stall = 1'b0;

        always @(posedge i_clk)

        always @(posedge i_clk)

        begin // Inputs: rst, stb, stb, stall, ack, addr[4:0] -- 9

        begin // Inputs: rst, stb, stb, stall, ack, addr[4:0] -- 9

                if (i_rst)

                if (i_rst)

                        o_wb_stall <= 1'b0;

                        o_wb_stall <= 1'b0;