From 3374e566792b8083c52aa794feda31921dc998e8 Mon Sep 17 00:00:00 2001 From: Luke Kenneth Casson Leighton Date: Tue, 24 Jul 2018 06:57:32 +0100 Subject: [PATCH] add QSPI-to-SPI wrapper --- src/peripherals/spi/spi.bsv | 92 +++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 src/peripherals/spi/spi.bsv diff --git a/src/peripherals/spi/spi.bsv b/src/peripherals/spi/spi.bsv new file mode 100644 index 0000000..49e560e --- /dev/null +++ b/src/peripherals/spi/spi.bsv @@ -0,0 +1,92 @@ +/* +Copyright (c) 2013, IIT Madras +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +* Neither the name of IIT Madras nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +*/ +package spi; +/* + TODOs + To use the following registers: + dcr_csht +* Done Pre-scaler. +> Memory mapped mode should continue to fetch data and fill the fifo even if the Core + is not requesting +* Done Status polling mode. +> This could not be replicated since the tof flag is set. + Memory mapped mode with dcyc =10 creates an extra cycle after Dummy phase. +> Data Read phase is on posedge and Data write is on negdege +-- send the received arid and bid's so that DMA can identify. duplicate instead of extend +*/ + import qspi::*; + + (*always_ready, always_enabled*) + interface SPI_out; + interface Get#(Bit#(1)) clk_o; + interface Get#(Bit#(1)) io_out; + method Bit#(9) io0_sdio_ctrl; + method Bit#(9) io1_sdio_ctrl; + // index 0 is MOSI, index 1 is MISO. + interface Get#(Bit#(2)) io_out_en; + interface Put#(Bit#(2)) io_in; + interface Get#(Bit#(1)) ncs_o; + endinterface + + interface Ifc_spi; + interface SPI_out out; + interface AXI4_Lite_Slave_IFC#(`PADDR,`Reg_width,`USERSPACE) slave; + // 0=TOF, 1=SMF, 2=Threshold, 3=TCF, 4=TEF 5 = request_ready + method Bit#(6) interrupts; + endinterface + + + (*synthesize*) + module mkspi(Ifc_spi); + + Ifc_qspi qspi <- mkqspi(); + + interface SPI_out out; + method Bit#(9) io0_sdio_ctrl; + return qspi.out.io0_sdio_ctrl; + endmethod + method Bit#(9) io1_sdio_ctrl; + return qspi.out.io1_sdio_ctrl; + endmethod + interface io_out = interface Get + method ActionValue#(Bit#(2)) get; + return qspi.out.io_out[1:0]; + endmethod + endinterface; + interface io_out_en = interface Get + method ActionValue#(Bit#(2)) get; + return qspi.out.io_out_en[1:0]; + endmethod + endinterface; + interface io_in = interface Put + method Action put(Bit#(2) in); + Bit(#4) temp = { 0, 0, in[1], in[0] }; + qspi.out.io_in(temp); + endmethod + endinterface; + interface clk_o = qspi.out.clk_o; + interface io_out = qspi.out.io_out; + interface io_out_en = qspi.out.io_out_en; + interface io_in = qspi.out.io_in; + interface ncs_o = qspi.ncs_o; + endinterface + + interface slave = qspi.slave; + + // 0=TOF, 1=SMF, 2=Threshold, 3=TCF, 4=TEF 5=request_ready + method Bit#(6) interrupts; + return qspi.interripts; + endmethod + +endpackage -- 2.30.2