reformat header

[shakti-peripherals.git] / src / peripherals / spi / spi.bsv

diff --git a/src/peripherals/spi/spi.bsv b/src/peripherals/spi/spi.bsv
index 49e560e102ffed0b12a8b56a2477632788e861e2..850cdba5a166fb7705d0c75c1c84e3f8c0ea0cdc 100644 (file)
--- a/src/peripherals/spi/spi.bsv
+++ b/src/peripherals/spi/spi.bsv
@@ -2,38 +2,49 @@
 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:
+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.
+*  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. 
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+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 AXI4_Lite_Types   :: *;
+    import AXI4_Lite_Fabric  :: *;
+       import GetPut::*;
        import qspi::*;
+    `include "instance_defines.bsv"
+
 
     (*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;
         interface Get#(Bit#(2)) io_out_en;
         interface Put#(Bit#(2)) io_in;
         interface Get#(Bit#(1)) ncs_o;
@@ -52,7 +63,7 @@ package spi;
        
     Ifc_qspi qspi <- mkqspi();
 
-    interface SPI_out out;
+    interface out = interface SPI_out
        method Bit#(9) io0_sdio_ctrl;
                return qspi.out.io0_sdio_ctrl;
        endmethod
@@ -71,16 +82,17 @@ package spi;
       endinterface;
       interface io_in = interface Put
         method Action put(Bit#(2) in);
-            Bit(#4) temp = { 0, 0, in[1], in[0] };
+            Bit#(4) temp;
+            temp[3] = 0;
+            temp[2] = 0;
+            temp[1] = in[1];
+            temp[0] = 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
+    endinterface;
 
     interface slave = qspi.slave;
 
@@ -89,4 +101,5 @@ package spi;
                return qspi.interripts;
        endmethod
 
+  endmodule
 endpackage