1 # ================================== Steps to add peripherals ============
2 # Step-1: create interface declaration for the peripheral to be added.
3 # Remember these are interfaces defined for the pinmux and hence
4 # will be opposite to those defined at the peripheral.
5 # For eg. the output TX from the UART will be input (method Action)
7 # These changes will have to be done in interface_decl.py
8 # Step-2 define the wires that will be required to transfer data from the
9 # peripheral interface to the IO cell and vice-versa. Create a
10 # mkDWire for each input/output between the peripheral and the
11 # pinmux. Also create an implicit wire of GenericIOType for each cell
12 # that can be connected to a each bit from the peripheral.
13 # These changes will have to be done in wire_def.py
14 # Step-3: create the definitions for each of the methods defined above.
15 # These changes will have to be done in interface_decl.py
16 # ========================================================================
18 # default module imports
24 # project module imports
25 from interface_decl
import *
26 from interface_def
import *
28 from wire_def
import *
29 from actual_pinmux
import *
31 if not os
.path
.exists("bsv_src"):
32 os
.makedirs("bsv_src")
34 bsv_file
= open("./bsv_src/pinmux.bsv", "w")
39 This BSV file has been generated by the PinMux tool available at:
40 https://bitbucket.org/casl/pinmux.
42 Authors: Neel Gala, Luke
43 Date of generation: ''' + time
.strftime("%c") + '''
48 Bit#(1) outputval; // output from core to pad bit7
49 Bit#(1) output_en; // output enable from core to pad bit6
50 Bit#(1) input_en; // input enable from core to io_cell bit5
51 Bit#(1) pullup_en; // pullup enable from core to io_cell bit4
52 Bit#(1) pulldown_en; // pulldown enable from core to io_cell bit3
53 Bit#(1) drivestrength; // drivestrength from core to io_cell bit2
54 Bit#(1) pushpull_en; // pushpull enable from core to io_cell bit1
55 Bit#(1) opendrain_en; // opendrain enable form core to io_cell bit0
56 } GenericIOType deriving(Eq,Bits,FShow);
64 # ============================================#
65 # ==== populating the file with the code =====#
66 # ============================================#
68 # package and interface declaration followed by the generic io_cell definition
69 bsv_file
.write(header
)
73 // declare the method which will capture the user pin-mux
74 // selection values.The width of the input is dependent on the number
75 // of muxes happening per IO. For now we have a generalized width
76 // where each IO will have the same number of muxes.''')
78 for cell
in muxed_cells
:
79 bsv_file
.write(mux_interface
.format(cell
[0],
80 int(math
.log(len(cell
) - 1, 2))))
84 // declare the interface to the IO cells.
85 // Each IO cell will have 8 input field (output from pin mux
86 // and on output field (input to pinmux)''')
87 for i
in range(0, N_IO
):
88 bsv_file
.write('''\n // interface for IO CEll-{0}''')
89 bsv_file
.write(io_interface
.format(i
))
90 # ==============================================================
92 # == create method definitions for all peripheral interfaces ==#
93 for i
in range(0, N_UART
):
95 // interface declaration between UART-{0} and pinmux'''.format(i
))
96 bsv_file
.write(uartinterface_decl
.format(i
))
98 for i
in range(0, N_SPI
):
100 // interface declaration between SPI-{0} and pinmux'''.format(i
))
101 bsv_file
.write(spiinterface_decl
.format(i
))
103 for i
in range(0, N_TWI
):
105 // interface declaration between TWI-{0} and pinmux'''.format(i
))
106 bsv_file
.write(twiinterface_decl
.format(i
))
108 for i
in range(0, N_SD
):
110 // interface declaration between SD-{0} and pinmux'''.format(i
))
111 bsv_file
.write(sdinterface_decl
.format(i
))
113 for i
in range(0, N_JTAG
):
115 // interface declaration between JTAG-{0} and pinmux'''.format(i
))
116 bsv_file
.write(jtaginterface_decl
.format(i
))
117 # ==============================================================
119 # ===== finish interface definition and start module definition=======
123 module mkpinmux(Ifc_pinmux);
125 # ====================================================================
127 # ======================= create wire and registers =================#
129 // the followins wires capture the pin-mux selection
130 // values for each mux assigned to a CELL
132 for cell
in muxed_cells
:
133 bsv_file
.write(muxwire
.format(cell
[0], int(math
.log(len(cell
) - 1, 2))))
137 '''\n // following wires capture the values sent to the IO Cell''')
138 for i
in range(0, N_IO
):
139 bsv_file
.write(generic_io
.format(i
))
141 for i
in range(0, N_UART
):
143 '''\n // following wires capture signals to IO CELL if uart-{0} is
144 // allotted to it'''.format(i
))
145 bsv_file
.write(uartwires
.format(i
))
147 for i
in range(0, N_SPI
):
149 '''\n // following wires capture signals to IO CELL if spi-{0} is
150 // allotted to it'''.format(i
))
151 bsv_file
.write(spiwires
.format(i
))
153 for i
in range(0, N_TWI
):
155 '''\n // following wires capture signals to IO CELL if twi-{0} is
156 // allotted to it'''.format(i
))
157 bsv_file
.write(twiwires
.format(i
))
159 for i
in range(0, N_SD
):
161 '''\n // following wires capture signals to IO CELL if sd-{0} is
162 // allotted to it'''.format(i
))
163 bsv_file
.write(sdwires
.format(i
))
165 for i
in range(0, N_JTAG
):
167 '''\n // following wires capture signals to IO CELL if jtag-{0} is
168 // allotted to it'''.format(i
))
169 bsv_file
.write(jtagwires
.format(i
))
171 # ====================================================================
172 # ========================= Actual pinmuxing ========================#
174 /*====== This where the muxing starts for each io-cell======*/
176 bsv_file
.write(pinmux
)
178 /*============================================================*/
180 # ====================================================================
181 # ================= interface definitions for each method =============#
182 for cell
in muxed_cells
:
183 bsv_file
.write(mux_interface_def
.format(cell
[0],
184 int(math
.log(len(cell
) - 1, 2))))
185 for i
in range(0, N_IO
):
186 bsv_file
.write(io_interface_def
.format(i
))
187 for i
in range(0, N_UART
):
188 bsv_file
.write(uartinterface_def
.format(i
))
189 for i
in range(0, N_SPI
):
190 bsv_file
.write(spiinterface_def
.format(i
))
191 for i
in range(0, N_TWI
):
192 bsv_file
.write(twiinterface_def
.format(i
))
193 for i
in range(0, N_SD
):
194 bsv_file
.write(sdinterface_def
.format(i
))
195 for i
in range(0, N_JTAG
):
196 bsv_file
.write(jtaginterface_def
.format(i
))
197 bsv_file
.write(footer
)
198 print("BSV file successfully generated: bsv_src/pinmux.bsv")
199 # ======================================================================