c72337f7eaa39a1b10d07cbb2f7dee93e5f96b24
[pinmux.git] / docs / AddingPeripherals.mdwn
1 # How to add a new peripheral
2
3 This document describes the process of adding a new peripheral to
4 the pinmux and auto-generator, through a worked example, adding
5 SDRAM.
6
7 # Creating the specifications
8
9 The tool is split into two halves that are separated by tab-separated
10 files. The first step is therefore to add a function that defines
11 the peripheral as a python function. That implies in turn that the
12 pinouts of the peripheral must be known. Looking at the BSV code
13 for the SDRAM peripheral, we find its interface is defined as follows:
14
15 interface Ifc_sdram_out;
16 (*always_enabled,always_ready*)
17 method Action ipad_sdr_din(Bit#(64) pad_sdr_din);
18 method Bit#(9) sdram_sdio_ctrl();
19 method Bit#(64) osdr_dout();
20 method Bit#(8) osdr_den_n();
21 method Bool osdr_cke();
22 method Bool osdr_cs_n();
23 method Bool osdr_ras_n ();
24 method Bool osdr_cas_n ();
25 method Bool osdr_we_n ();
26 method Bit#(8) osdr_dqm ();
27 method Bit#(2) osdr_ba ();
28 method Bit#(13) osdr_addr ();
29 interface Clock sdram_clk;
30 endinterface
31
32 So now we go to src/spec/pinfunctions.py and add a corresponding function
33 that returns a list of all of the required pin signals. However, we note
34 that it is a huge number of pins so a decision is made to split it into
35 groups: sdram1, sdram2 and sdram3. Firstly, sdram1, covering the base
36 functionality:
37
38 def sdram1(suffix, bank):
39 buspins = []
40 inout = []
41 for i in range(8):
42 pname = "SDRDQM%d*" % i
43 buspins.append(pname)
44 for i in range(8):
45 pname = "SDRD%d*" % i
46 buspins.append(pname)
47 inout.append(pname)
48 for i in range(12):
49 buspins.append("SDRAD%d+" % i)
50 for i in range(2):
51 buspins.append("SDRBA%d+" % i)
52 buspins += ['SDRCKE+', 'SDRRASn+', 'SDRCASn+', 'SDRWEn+',
53 'SDRCSn0++']
54 return (buspins, inout)
55
56 This function, if used on its own, would define an 8-bit SDRAM bus with
57 12-bit addressing. Checking off the names against the corresponding BSV
58 definition we find that most of them are straightforward. Outputs
59 must have a "+" after the name (in the python representation), inputs
60 must have a "-".
61
62 However we run smack into an interesting brick-wall with the in/out pins.
63 In/out pins which are routed through the same IO pad need a *triplet* of
64 signals: one input wire, one output wire and *one direction control wire*.
65 Here however we find that the SDRAM controller, which is a wrapper around
66 the opencores SDRAM controller, has a *banked* approach to direction-control
67 that will need to be dealt with, later. So we do *not* make the mistake
68 of adding 8 SDRDENx pins: the BSV code will need to be modified to
69 add 64 one-for-one enabling pins. We do not also make the mistake of
70 adding separate unidirectional "in" and separate unidirectional "out" signals
71 under different names, as the pinmux code is a *PAD* centric tool.
72
73 The second function extends the 8-bit data bus to 64-bits, and extends
74 the address lines to 13-bit wide:
75
76 def sdram3(suffix, bank):
77 buspins = []
78 inout = []
79 for i in range(12, 13):
80 buspins.append("SDRAD%d+" % i)
81 for i in range(8, 64):
82 pname = "SDRD%d*" % i
83 buspins.append(pname)
84 inout.append(pname)
85 return (buspins, inout)
86
87 In this way, alternative SDRAM controller implementations can use sdram1
88 on its own; implementors may add "extenders" (named sdram2, sdram4) that
89 cover extra functionality, and, interestingly, in a pinbank scenario,
90 the number of pins on any given GPIO bank may be kept to a sane level.
91
92 The next phase is to add the (now supported) peripheral to the list
93 of pinspecs at the bottom of the file, so that it can actually be used:
94
95 pinspec = (('IIS', i2s),
96 ('MMC', emmc),
97 ('FB', flexbus1),
98 ('FB', flexbus2),
99 ('SDR', sdram1),
100 ('SDR', sdram2),
101 ('SDR', sdram3), <---
102 ('EINT', eint),
103 ('PWM', pwm),
104 ('GPIO', gpio),
105 )
106
107 This gives a declaration that any time the function(s) starting with
108 "sdram" are used to add pins to a pinmux, it will be part of the
109 "SDR" peripheral. Note that flexbus is similarly subdivided into
110 two groups.
111
112 Note however that due to a naming convention issue, interfaces must
113 be declared with names that are lexicographically unique even in
114 subsets of their names. i.e two interfaces, one named "SD" which is
115 shorthand for SDMMC and another named "SDRAM" may *not* be added:
116 the first has to be the full "SDMMC" or renamed to "MMC".
117
118 # Adding the peripheral to a chip's pinmux specification
119
120 Next, we add the peripheral to an actual chip's specification. In this
121 case it is to be added to i\_class, so we open src/spec/i\_class.py. The
122 first thing to do is to add a single-mux (dedicated) bank of 92 pins (!)
123 which covers all of the 64-bit Data lines, 13 addresses and supporting
124 bank-selects and control lines. It is added as Bank "D", the next
125 contiguous bank:
126
127 def pinspec():
128 pinbanks = {
129 'A': (28, 4),
130 'B': (18, 4),
131 'C': (24, 1),
132 'D': (92, 1), <---
133 }
134 fixedpins = {
135 'CTRL_SYS': [
136
137 This declares the width of the pinmux to one (a dedicated peripheral
138 bank). Note in passing that A and B are both 4-entry.
139 Next, an SDRAM interface is conveniently added to the chip's pinmux
140 with two simple lines of code:
141
142 ps.gpio("", ('B', 0), 0, 0, 18)
143 ps.flexbus1("", ('B', 0), 1, spec=flexspec)
144
145 ps.flexbus2("", ('C', 0), 0)
146
147 ps.sdram1("", ('D', 0), 0) <--
148 ps.sdram3("", ('D', 35), 0) <--
149
150 Note that the first argument is blank, indicating that this is the only
151 SDRAM interface to be added. If more than one SDRAM interface is desired
152 they would be numbered from 0 and identified by their suffix. The second
153 argument is a tuple of (Bank Name, Bank Row Number), and the third argument
154 is the pinmux column (which in this case must be zero).
155
156 At the top level the following command is then run:
157
158 $ python src/pinmux_generator.py -o i_class -s i_class
159
160 The output may be found in the ./i\_class subdirectory, and it is worth
161 examining the i\_class.mdwn file. A table named "Bank D" will have been
162 created and it is worth just showing the first few entries here:
163
164 | Pin | Mux0 | Mux1 | Mux2 | Mux3 |
165 | --- | ----------- | ----------- | ----------- | ----------- |
166 | 70 | D SDR_SDRDQM0 |
167 | 71 | D SDR_SDRDQM1 |
168 | 72 | D SDR_SDRDQM2 |
169 | 73 | D SDR_SDRDQM3 |
170 | 74 | D SDR_SDRDQM4 |
171 | 75 | D SDR_SDRDQM5 |
172 | 76 | D SDR_SDRDQM6 |
173 | 77 | D SDR_SDRDQM7 |
174 | 78 | D SDR_SDRD0 |
175 | 79 | D SDR_SDRD1 |
176 | 80 | D SDR_SDRD2 |
177 | 81 | D SDR_SDRD3 |
178 | 82 | D SDR_SDRD4 |
179 | 83 | D SDR_SDRD5 |
180 | 84 | D SDR_SDRD6 |
181 | 85 | D SDR_SDRD7 |
182 | 86 | D SDR_SDRAD0 |
183 | 87 | D SDR_SDRAD1 |
184
185 Returning to the definition of sdram1 and sdram3, this table clearly
186 corresponds to the functions in src/spec/pinfunctions.py which is
187 exactly what we want. It is however extremely important to verify.
188
189 Lastly, the peripheral is a "fast" peripheral, i.e. it must not
190 be added to the "slow" peripherals AXI4-Lite Bus, so must be added
191 to the list of "fast" peripherals, here:
192
193 ps = PinSpec(pinbanks, fixedpins, function_names,
194 ['lcd', 'jtag', 'fb', 'sdr']) <--
195
196 # Bank A, 0-27
197 ps.gpio("", ('A', 0), 0, 0, 28)
198
199 This basically concludes the first stage of adding a peripheral to
200 the pinmux / autogenerator tool. It allows peripherals to be assessed
201 for viability prior to actually committing the engineering resources
202 to their deployment.
203
204 # Adding the code auto-generators.
205
206 With the specification now created and well-defined (and now including
207 the SDRAM interface), the next completely separate phase is to auto-generate
208 the code that will drop an SDRAM instance onto the fabric of the SoC.
209
210 This particular peripheral is classified as a "Fast Bus" peripheral.
211 "Slow" peripherals will need to be the specific topic of an alternative
212 document, however the principles are the same.
213
214 The first requirement is that the pins from the peripheral side be connected
215 through to IO cells. This can be verified by running the pinmux code
216 generator (to activate "default" behaviour), just to see what happens:
217
218 $ python src/pinmux_generator.py -o i_class
219
220 Files are auto-generated in ./i\_class/bsv\_src and it is recommended
221 to examine the pinmux.bsv file in an editor, and search for occurrences
222 of the string "sdrd63". It can clearly be seen that an interface
223 named "PeripheralSideSDR" has been auto-generated:
224
225 // interface declaration between SDR and pinmux
226 (*always_ready,always_enabled*)
227 interface PeripheralSideSDR;
228 interface Put#(Bit#(1)) sdrdqm0;
229 interface Put#(Bit#(1)) sdrdqm1;
230 interface Put#(Bit#(1)) sdrdqm2;
231 interface Put#(Bit#(1)) sdrdqm3;
232 interface Put#(Bit#(1)) sdrdqm4;
233 interface Put#(Bit#(1)) sdrdqm5;
234 interface Put#(Bit#(1)) sdrdqm6;
235 interface Put#(Bit#(1)) sdrdqm7;
236 interface Put#(Bit#(1)) sdrd0_out;
237 interface Put#(Bit#(1)) sdrd0_outen;
238 interface Get#(Bit#(1)) sdrd0_in;
239 ....
240 ....
241 endinterface
242
243 Note that for the data lines, that where in the sdram1 specification function
244 the signals were named "SDRDn+, out, out-enable *and* in interfaces/methods
245 have been created, as these will be *directly* connected to the I/O pads.
246
247 Further down the file we see the *actual* connection to the I/O pad (cell).
248 An example:
249
250 // --------------------
251 // ----- cell 161 -----
252
253 // output muxer for cell idx 161
254 cell161_mux_out=
255 wrsdr_sdrd63_out;
256
257 // outen muxer for cell idx 161
258 cell161_mux_outen=
259 wrsdr_sdrd63_outen; // bi-directional
260
261 // priority-in-muxer for cell idx 161
262
263 rule assign_wrsdr_sdrd63_in_on_cell161;
264 wrsdr_sdrd63_in<=cell161_mux_in;
265 endrule
266
267 Here, given that this is a "dedicated" cell (with no muxing), we have
268 *direct* assignment of all three signals (in, out, outen). 2-way, 3-way
269 and 4-way muxing creates the required priority-muxing for inputs and
270 straight-muxing for outputs, however in this instance, a deliberate
271 pragmatic decision is being taken not to put 92 pins of 133mhz+ signalling
272 through muxing.
273
274 In examining the slow\_peripherals.bsv file, there should at this stage
275 be no sign of an SDRAM peripheral having been added, at all. This is
276 because it is missing from the peripheral\_gen side of the tool.
277
278 However, as the slow\_peripherals module takes care of the IO cells
279 (because it contains a declared and configured instance of the pinmux
280 package), signals from the pinmux PeripheralSideSDR instance need
281 to be passed *through* the slow peripherals module as an external
282 interface. This will happen automatically once a code-generator class
283 is added.
284
285 So first, we must identify the nearest similar class. FlexBus looks
286 like a good candidate, so we take a copy of src/bsv/peripheral\_gen/flexbus.py
287 called sdram.py. The simplest next step is to global/search/replace
288 "flexbus" with "sdram", and for peripheral instance declaration replace
289 "fb" with "sdr". At this phase, despite knowing that it will
290 auto-generate the wrong code, we add it as a "supported" peripheral
291 at the bottom of src/bsv/peripheral\_gen/base.py, in the "PFactory"
292 (Peripheral Factory) class:
293
294 from gpio import gpio
295 from rgbttl import rgbttl
296 from flexbus import flexbus
297 from sdram import sdram <--
298
299 for k, v in {'uart': uart,
300 'rs232': rs232,
301 'sdr': sdram,
302 'twi': twi,
303 'quart': quart,
304
305 Note that the name "SDR" matches with the prefix used in the pinspec
306 declaration, back in src/spec/pinfunctions.py, except lower-cased. Once this
307 is done, and the auto-generation tool re-run, examining the
308 slow\_peripherals.bsv file again shows the following (correct) and only
309 the following (correct) additions:
310
311 method Bit#(1) quart0_intr;
312 method Bit#(1) quart1_intr;
313 interface GPIO_config#(28) pad_configa;
314 interface PeripheralSideSDR sdr0; <--
315 interface PeripheralSideFB fb0;
316
317 ....
318 ....
319 interface iocell_side=pinmux.iocell_side;
320 interface sdr0 = pinmux.peripheral_side.sdr; <--
321 interface fb0 = pinmux.peripheral_side.fb;
322
323 These automatically-generated declarations are sufficient to "pass through"
324 the SDRAM "Peripheral Side", which as we know from examination of the code
325 is directly connected to the relevant IO pad cells, so that the *actual*
326 peripheral may be declared in the "fast" fabric and connected up to the
327 relevant and required "fast" bus.
328
329 ## Connecting in the fabric
330
331 Now we can begin the process of systematically inserting the correct
332 "voodoo magic" incantations that, as far as this auto-generator tool is
333 concerned, are just bits of ASCII text. In this particular instance, an
334 SDRAM peripheral happened to already be *in* the SoC's BSV source code,
335 such that the process of adding it to the tool is primarily one of
336 *conversion*.
337
338 **Please note that it is NOT recommended to do two tasks at once.
339 It is strongly recommended to add any new peripheral to a pre-existing
340 verified project, manually, by hand, and ONLY then to carry out a
341 conversion process to have this tool understand how to auto-generate
342 the fabric**
343
344 So examining the i\_class socgen.bsv file, we also open up
345 src/bsv/bsv\_lib/soc\_template.bsv in side-by-side windows of maximum
346 80 characters in width each, and *respect the coding convention for
347 this exact purpose*, can easily fit two such windows side-by-side
348 *as well as* a third containing the source code files that turn that
349 same template into its corresponding output.
350
351 We can now begin by searching for strings "SDRAM" and "sdr" in both
352 the template and the auto-generated socgen.bsv file. The first such
353 encounter is the import, in the template:
354
355 `ifdef BOOTROM
356 import BootRom ::*;
357 `endif
358 `ifdef SDRAM <-- xxxx
359 import sdr_top :: *; <-- xxxx
360 `endif <-- xxxx
361 `ifdef BRAM
362
363 This we can **remove**, and drop the corresponding code-fragment into
364 the sdram slowimport function:
365
366 class sdram(PBase):
367
368 def slowimport(self):
369 return "import sdr_top::*;" <--
370
371 def num_axi_regs32(self):
372
373 Now we re-run the auto-generator tool and confirm that, indeed, the
374 ifdef'd code is gone and replaced with an unconditional import:
375
376 import mqspi :: *;
377 import sdr_top::*; <--
378 import Uart_bs :: *;
379 import RS232_modified::*;
380 import mspi :: *;
381
382 Progress! Next, we examine the instance declaration clause. Remember
383 that we cut/paste the flexbus class, so we are expecting to find code
384 that declares the sdr0 instance as a FlexBus peripheral. We are
385 also looking for the hand-created code that is to be *replaced*. Sure enough:
386
387 AXI4_Slave_to_FlexBus_Master_Xactor_IFC #(`PADDR, `DATA, `USERSPACE)
388 sdr0 <- mkAXI4_Slave_to_FlexBus_Master_Xactor; <--
389 AXI4_Slave_to_FlexBus_Master_Xactor_IFC #(`PADDR, `DATA, `USERSPACE)
390 fb0 <- mkAXI4_Slave_to_FlexBus_Master_Xactor;
391 ...
392 ...
393 `ifdef BOOTROM
394 BootRom_IFC bootrom <-mkBootRom;
395 `endif
396 `ifdef SDRAM <--
397 Ifc_sdr_slave sdram<- mksdr_axi4_slave(clk0); <--
398 `endif <--
399
400 So, the mksdr\_axi4\_slave call we *remove* from the template and cut/paste
401 it into the sdram class's mkfast_peripheral function, making sure to
402 substitute the hard-coded instance name "sdram" with a python-formatted
403 template that can insert numerical instance identifiers, should it ever
404 be desired that there be more than one SDRAM peripheral put into a chip:
405
406 class sdram(PBase):
407
408 ...
409 ...
410 def mkfast_peripheral(self):
411 return "Ifc_sdr_slave sdr{0} <- mksdr_axi4_slave(clk0);"
412
413 Re-run the tool and check that the correct-looking code has been created:
414
415 Ifc_sdr_slave sdr0 <- mksdr_axi4_slave(clk0); <--
416 AXI4_Slave_to_FlexBus_Master_Xactor_IFC #(`PADDR, `DATA, `USERSPACE)
417 fb0 <- mkAXI4_Slave_to_FlexBus_Master_Xactor;
418 Ifc_rgbttl_dummy lcd0 <- mkrgbttl_dummy();
419
420 The next thing to do: searching for the string "sdram\_out" shows that the
421 original hand-generated code contains (contained) a declaration of the
422 SDRAM Interface, presumably to which, when compiling to run on an FPGA,
423 the SDRAM interface would be connected at the top level. Through this
424 interface, connections would be done *by hand* to the IO pads, whereas
425 now they are to be connected *automatically* (on the peripheral side)
426 to the IO pads in the pinmux. However, at the time of writing this is
427 not fully understood by the author, so the fastifdecl and extfastifinstance
428 functions are modified to generate the correct output but the code is
429 *commented out*
430
431 def extfastifinstance(self, name, count):
432 return "// TODO" + self._extifinstance(name, count, "_out", "", True,
433 ".if_sdram_out")
434
435 def fastifdecl(self, name, count):
436 return "// (*always_ready*) interface " + \
437 "Ifc_sdram_out sdr{0}_out;".format(count)
438
439 Also the corresponding (old) manual declarations of sdram\_out
440 removed from the template:
441
442 `ifdef SDRAM <-- xxxx
443 (*always_ready*) interface Ifc_sdram_out sdram_out; <-- xxxx
444 `endif <-- xxxx
445 ...
446 ...
447 `ifdef SDRAM <--- xxxx
448 interface sdram_out=sdram.ifc_sdram_out; <--- xxxx
449 `endif <--- xxxx
450
451 Next, again searching for signs of the "hand-written" code, we encounter
452 the fabric connectivity, which wires the SDRAM to the AXI4. We note however
453 that there is not just one AXI slave device but *two*: one for the SDRAM
454 itself and one for *configuring* the SDRAM. We therefore need to be
455 quite careful about assigning these, as will be subsequently explained.
456 First however, the two AXI4 slave interfaces of this peripheral are
457 declared:
458
459 class sdram(PBase):
460
461 ...
462 ...
463 def _mk_connection(self, name=None, count=0):
464 return ["sdr{0}.axi4_slave_sdram",
465 "sdr{0}.axi4_slave_cntrl_reg"]
466
467 Note that, again, in case multiple instances are ever to be added, the
468 python "format" string "{0}" is inserted so that it can be substituted
469 with the numerical identifier suffix. Also note that the order
470 of declaration of these two AXI4 slave is **important**.
471
472 Re-running the auto-generator tool, we note the following output has
473 been created, and match it against the corresponding hand-generated (old)
474 code:
475
476 `ifdef SDRAM
477 mkConnection (fabric.v_to_slaves
478 [fromInteger(valueOf(Sdram_slave_num))],
479 sdram.axi4_slave_sdram); //
480 mkConnection (fabric.v_to_slaves
481 [fromInteger(valueOf(Sdram_cfg_slave_num))],
482 sdram.axi4_slave_cntrl_reg); //
483 `endif
484
485 // fabric connections
486 mkConnection (fabric.v_to_slaves
487 [fromInteger(valueOf(SDR0_fastslave_num))],
488 sdr0.axi4_slave_sdram);
489 mkConnection (fabric.v_to_slaves
490 [fromInteger(valueOf(SDR0_fastslave_num))],
491 sdr0.axi4_slave_cntrl_reg);
492
493 Immediately we can spot an issue: whilst the correctly-named slave(s) have
494 been added, they have been added with the *same* fabric slave index. This
495 is unsatisfactory and needs resolving.
496
497 Here we need to explain a bit more about what is going on. The fabric
498 on an AXI4 Bus is allocated numerical slave numbers, and each slave is
499 also allocated a memory-mapped region that must be resolved in a bi-directional
500 fashion. i.e whenever a particular memory region is accessed, the AXI
501 slave peripheral responsible for dealing with it **must** be correctly
502 identified. So this requires some further crucial information, which is
503 the size of the region that is to be allocated to each slave device. Later
504 this will be extended to being part of the specification, but for now
505 it is auto-allocated based on the size. As a huge hack, it is allocated
506 in 32-bit chunks, as follows:
507
508 class sdram(PBase):
509
510 def num_axi_regs32(self):
511 return [0x400000, # defines an entire memory range (hack...)
512 12] # defines the number of configuration regs
513
514 So after running the autogenerator again, to confirm that this has
515 generated the correct code, we examine several files, starting with
516 fast\+memory\_map.bsv:
517
518 /*====== Fast peripherals Memory Map ======= */
519 `define SDR0_0_Base 'h50000000
520 `define SDR0_0_End 'h5FFFFFFF // 4194304 32-bit regs
521 `define SDR0_1_Base 'h60000000
522 `define SDR0_1_End 'h600002FF // 12 32-bit regs
523
524 This looks slightly awkward (and in need of an external specification
525 section for addresses) but is fine: the range is 1GB for the main
526 map and covers 12 32-bit registers for the SDR Config map.
527 Next we note the slave numbering:
528
529 typedef 0 SDR0_0__fastslave_num;
530 typedef 1 SDR0_1__fastslave_num;
531 typedef 2 FB0_fastslave_num;
532 typedef 3 LCD0_fastslave_num;
533 typedef 3 LastGen_fastslave_num;
534 typedef TAdd#(LastGen_fastslave_num,1) Sdram_slave_num;
535 typedef TAdd#(Sdram_slave_num ,`ifdef SDRAM 1 `else 0 `endif )
536 Sdram_cfg_slave_num;
537
538 Again this looks reasonable and we may subsequently (carefully! noting
539 the use of the TAdd# chain!) remove the #define for Sdram\_cfg\_slave\_num.
540 The next phase is to examine the fn\_addr\_to\_fastslave\_num function,
541 where we note that there were *two* hand-created sections previously,
542 now joined by two *auto-generated* sections:
543
544 function Tuple2 #(Bool, Bit#(TLog#(Num_Fast_Slaves)))
545 fn_addr_to_fastslave_num (Bit#(`PADDR) addr);
546
547 if(addr>=`SDRAMMemBase && addr<=`SDRAMMemEnd)
548 return tuple2(True,fromInteger(valueOf(Sdram_slave_num))); <--
549 else if(addr>=`DebugBase && addr<=`DebugEnd)
550 return tuple2(True,fromInteger(valueOf(Debug_slave_num))); <--
551 `ifdef SDRAM
552 else if(addr>=`SDRAMCfgBase && addr<=`SDRAMCfgEnd )
553 return tuple2(True,fromInteger(valueOf(Sdram_cfg_slave_num)));
554 `endif
555
556 ...
557 ...
558 if(addr>=`SDR0_0_Base && addr<=`SDR0_0_End) <--
559 return tuple2(True,fromInteger(valueOf(SDR0_0__fastslave_num)));
560 else
561 if(addr>=`SDR0_1_Base && addr<=`SDR0_1_End) <--
562 return tuple2(True,fromInteger(valueOf(SDR0_1__fastslave_num)));
563 else
564 if(addr>=`FB0Base && addr<=`FB0End)
565
566 Now, here is where, in a slightly unusual unique set of circumstances, we
567 cannot just remove all instances of this address / typedef from the template
568 code. Looking in the shakti-core repository's src/lib/MemoryMap.bsv file,
569 the SDRAMMemBase macro is utilise in the is\_IO\_Addr function. So as a
570 really bad hack, which will need to be properly resolved, whilst the
571 hand-generated sections from fast\_tuple2\_template.bsv are removed,
572 and the corresponding (now redundant) defines in src/core/core\_parameters.bsv
573 are commented out, some temporary typedefs to deal with the name change are
574 also added:
575
576 `define SDRAMMemBase SDR0_0_Base
577 `define SDRAMMemEnd SDR0_0_End
578
579 This needs to be addressed (pun intended) including being able to specify
580 the name(s) of the configuration parameters, as well as specifying which
581 memory map range they must be added to.
582
583 Now however finally, after carefully comparing the hard-coded fabric
584 connections to what was formerly named sdram, we may remove the mkConnections
585 that drop sdram.axi4\_slave\_sdram and its associated cntrl reg from
586 the soc\_template.bsv file.
587
588 ## Connecting up the pins
589
590 We are still not done! It is however worth pointing out that if this peripheral
591 were not wired into the pinmux, we would in fact be finished. However there
592 is a task that (previously having been left to outside tools) now needs to
593 be specified, which is to connect the sdram's pins, declared in this
594 instance in Ifc\_sdram\_out, and the PeripheralSideSDR instance that
595 was kindly / strategically / thoughtfully / absolutely-necessarily exported
596 from slow\_peripherals for exactly this purpose.
597
598 Recall earlier that we took a cut/paste copy of the flexbus.py code. If
599 we now examine socgen.bsv we find that it contains connections to pins
600 that match the FlexBus specification, not SDRAM. So, returning to the
601 declaration of the Ifc\_sdram\_out interface, we first identify the
602 single-bit output-only pins, and add a mapping table between them:
603
604 class sdram(PBase):
605
606 def pinname_out(self, pname):
607 return {'sdrwen': 'ifc_sdram_out.osdr_we_n',
608 'sdrcsn0': 'ifc_sdram_out.osdr_cs_n',
609 'sdrcke': 'ifc_sdram_out.osdr_cke',
610 'sdrrasn': 'ifc_sdram_out.osdr_ras_n',
611 'sdrcasn': 'ifc_sdram_out.osdr_cas_n',
612 }.get(pname, '')
613
614 Re-running the tool confirms that the relevant mkConnections are generated:
615
616 //sdr {'action': True, 'type': 'out', 'name': 'sdrcke'}
617 mkConnection(slow_peripherals.sdr0.sdrcke,
618 sdr0_sdrcke_sync.get);
619 mkConnection(sdr0_sdrcke_sync.put,
620 sdr0.ifc_sdram_out.osdr_cke);
621 //sdr {'action': True, 'type': 'out', 'name': 'sdrrasn'}
622 mkConnection(slow_peripherals.sdr0.sdrrasn,
623 sdr0_sdrrasn_sync.get);
624 mkConnection(sdr0_sdrrasn_sync.put,
625 sdr0.ifc_sdram_out.osdr_ras_n);
626
627 Next, the multi-