add base class for scenario and pinspecs
[pinmux.git] / src / spec / base.py
1 from spec.interfaces import Pinouts
2
3 from spec.ifaceprint import display, display_fns, check_functions
4 from spec.ifaceprint import display_fixed
5
6
7 class PinSpec(Pinouts):
8 def __init__(self, pinbanks, fixedpins, function_names):
9 self.pinbanks = pinbanks
10 self.fixedpins = fixedpins
11 self.function_names = function_names
12 bankspec = {}
13 self.offs = 0
14 pkeys = sorted(pinbanks.keys())
15 for kn in pkeys:
16 bankspec[kn] = self.offs
17 self.offs += pinbanks[kn]
18
19 self.scenarios = []
20
21 Pinouts.__init__(self, bankspec)
22
23 def add_scenario(self, name, needed, eint, pwm, descriptions):
24 # Scenarios below can be spec'd out as either "find first interface"
25 # by name/number e.g. SPI0, or as "find in bank/mux" which must be
26 # spec'd as "BM:Name" where B is bank (A-F), M is Mux (0-3)
27 # EINT and PWM are grouped together, specially, but may still be spec'd
28 # using "BM:Name". Pins are removed in-order as listed from
29 # lists (interfaces, EINTs, PWMs) from available pins.
30
31 self.scenarios.append((name, needed, eint, pwm, descriptions))
32
33 def write(self, of):
34 of.write ("""# Pinouts (PinMux)
35 auto-generated by [[pinouts.py]]
36
37 [[!toc ]]
38
39 """)
40 display(of, self)
41
42 of.write ("\n# Pinouts (Fixed function)\n\n")
43 fixedpins = display_fixed(of, self.fixedpins, len(self))
44
45 of.write ("""# Functions (PinMux)
46
47 auto-generated by [[pinouts.py]]
48
49 """)
50 fns = display_fns(of, self.bankspec, self, self.function_names)
51 of.write('\n')
52
53 for scenario in self.scenarios:
54 name, needed, eint, pwm, descriptions = scenario
55 unused_pins = check_functions(of, name, self.bankspec, fns,
56 self,
57 needed, eint, pwm,
58 descriptions)
59
60
61 of.write ("""# Reference Datasheets
62
63 datasheets and pinout links
64 * <http://datasheets.chipdb.org/AMD/8018x/80186/amd-80186.pdf>
65 * <http://hands.com/~lkcl/eoma/shenzen/frida/FRD144A2701.pdf>
66 * <http://pinouts.ru/Memory/sdcard_pinout.shtml>
67 * p8 <http://www.onfi.org/~/media/onfi/specs/onfi_2_0_gold.pdf?la=en>
68 * <https://www.heyrick.co.uk/blog/files/datasheets/dm9000aep.pdf>
69 * <http://cache.freescale.com/files/microcontrollers/doc/app_note/AN4393.pdf>
70 * <https://www.nxp.com/docs/en/data-sheet/MCF54418.pdf>
71 * ULPI OTG PHY, ST <http://www.st.com/en/interfaces-and-transceivers/stulpi01a.html>
72 * ULPI OTG PHY, TI TUSB1210 <http://ti.com/product/TUSB1210/>
73
74 """)
75
76 return self, self.bankspec, self.pinbanks, fixedpins
77