(no commit message)
[libreriscv.git] / shakti / i_class / pinouts.py
1 #!/usr/bin/env python
2
3 from interfaces import pins, i2s, emmc, sdmmc, spi, quadspi, i2c
4 from interfaces import jtag, uart, ulpi, uartfull, rgbttl, rgmii
5 from interfaces import flexbus1, flexbus2, sdram1, sdram2, mcu8080
6 from interfaces import eint, pwm, gpio
7 from interfaces import display, display_fns, check_functions
8 from interfaces import pinmerge, display_fixed
9
10 if __name__ == '__main__':
11 pinouts = {}
12
13 pinbanks = {'A': 16,
14 'B': 16,
15 'C': 16,
16 'D': 16,
17 'E': 16,
18 'F': 48,
19 'G': 24,
20 }
21 bankspec = {}
22 pkeys = pinbanks.keys()
23 pkeys.sort()
24 offs = 0
25 for kn in pkeys:
26 bankspec[kn] = offs
27 offs += pinbanks[kn]
28
29 # Bank A, 0-15
30 pinmerge(pinouts, gpio(bankspec, "", ('A', 0), "A", 0, 16, 0))
31 pinmerge(pinouts, spi(bankspec, "0", ('A', 0), "A", 1))
32 pinmerge(pinouts, spi(bankspec, "1", ('A', 4), "A", 1))
33 pinmerge(pinouts, uart(bankspec, "0", ('A', 8), "A", 1))
34 pinmerge(pinouts, uart(bankspec, "1", ('A', 10), "A", 1))
35 pinmerge(pinouts, i2c(bankspec, "0", ('A', 12), "A", 1))
36 pinmerge(pinouts, i2c(bankspec, "1", ('A', 14), "A", 1))
37 for i in range(16):
38 pinmerge(pinouts, pwm(bankspec, str(i), ('A', i), "A", mux=2))
39
40 # Bank B, 16-31
41 pinmerge(pinouts, gpio(bankspec, "", ('B', 0), "B", 0, 16, 0))
42 pinmerge(pinouts, spi(bankspec, "2", ('B', 0), "B", 1))
43 pinmerge(pinouts, uart(bankspec, "2", ('B', 4), "B", 1))
44 pinmerge(pinouts, uart(bankspec, "3", ('B', 6), "B", 1))
45 pinmerge(pinouts, uart(bankspec, "4", ('B', 8), "B", 1))
46 pinmerge(pinouts, i2c(bankspec, "2", ('B', 10), "B", 1))
47 pinmerge(pinouts, i2c(bankspec, "3", ('B', 12), "B", 1))
48 pinmerge(pinouts, uart(bankspec, "5", ('B', 14), "B", 1))
49 for i in range(16):
50 pinmerge(pinouts, pwm(bankspec, str(i+16), ('B', i), "B", mux=2))
51
52 # Bank C, 32-47
53 pinmerge(pinouts, gpio(bankspec, "", ('C', 0), "C", 0, 16, 0))
54 pinmerge(pinouts, spi(bankspec, "1", ('C', 0), "C", 1))
55 pinmerge(pinouts, spi(bankspec, "2", ('C', 4), "C", 1))
56 pinmerge(pinouts, uart(bankspec, "2", ('C', 8), "C", 1))
57 pinmerge(pinouts, uart(bankspec, "3", ('C', 10), "C", 1))
58 pinmerge(pinouts, i2c(bankspec, "1", ('C', 12), "C", 1))
59 pinmerge(pinouts, i2c(bankspec, "3", ('C', 14), "C", 1))
60
61 # Bank D, 48-63
62 pinmerge(pinouts, ulpi(bankspec, "0", ('D', 0), "D", 1))
63 pinmerge(pinouts, spi(bankspec, "0", ('D', 12), "D", 1))
64
65 # Bank E, 64-80
66 pinmerge(pinouts, sdmmc(bankspec, "0", ('E', 0), "E", 1))
67 pinmerge(pinouts, jtag(bankspec, "0", ('E', 6), "E", 1))
68 pinmerge(pinouts, uart(bankspec, "0", ('E', 10), "E", 1))
69 pinmerge(pinouts, i2c(bankspec, "0", ('E', 12), "E", 1))
70 pinmerge(pinouts, uart(bankspec, "1", ('E', 14), "E", 1))
71
72 # Bank F, 80-127
73 flexspec = {
74 'FB_TS': ('FB_ALE', 2, "F"),
75 'FB_CS2': ('FB_BWE2', 2, "F"),
76 'FB_A0': ('FB_BWE2', 3, "F"),
77 'FB_CS3': ('FB_BWE3', 2, "F"),
78 'FB_A1': ('FB_BWE3', 3, "F"),
79 'FB_TBST': ('FB_OE', 2, "F"),
80 'FB_TSIZ0': ('FB_BWE0', 2, "F"),
81 'FB_TSIZ1': ('FB_BWE1', 2, "F"),
82 }
83 pinmerge(pinouts, flexbus1(bankspec, "", ('F', 0), "F", 1))
84 pinmerge(pinouts, flexbus2(bankspec, "", ('F', 30), "F", 1, limit=8))
85
86 # Bank G, 128-151
87
88 pinmerge(pinouts, rgmii(bankspec, "", ('G', 0), "G", 1))
89
90 print "# Pinouts (PinMux)"
91 print
92 print "auto-generated by [[pinouts.py]]"
93 print
94 print "[[!toc ]]"
95 print
96 display(pinouts)
97 print
98
99 print "# Pinouts (Fixed function)"
100 print
101
102 fixedpins = {
103 'CTRL_SYS':
104 [
105 'TEST', 'BOOT_SEL',
106 'NMI#', 'RESET#',
107 'CLK24M_IN', 'CLK24M_OUT',
108 'CLK32K_IN', 'CLK32K_OUT',
109 'PLLTEST', 'PLLREGIO', 'PLLVP25',
110 'PLLDV', 'PLLVREG', 'PLLGND',
111 ],
112
113 'POWER_CPU':
114 ['VDD0_CPU', 'VDD1_CPU', 'VDD2_CPU', 'VDD3_CPU', 'VDD4_CPU', 'VDD5_CPU',
115 'GND0_CPU', 'GND1_CPU', 'GND2_CPU', 'GND3_CPU', 'GND4_CPU', 'GND5_CPU',
116 ],
117
118 'POWER_DLL':
119 ['VDD0_DLL', 'VDD1_DLL', 'VDD2_DLL',
120 'GND0_DLL', 'GND1_DLL', 'GND2_DLL',
121 ],
122
123 'POWER_INT':
124 ['VDD0_INT', 'VDD1_INT', 'VDD2_INT', 'VDD3_INT', 'VDD4_INT',
125 'VDD5_INT', 'VDD6_INT', 'VDD7_INT', 'VDD8_INT', 'VDD9_INT',
126 'GND0_INT', 'GND1_INT', 'GND2_INT', 'GND3_INT', 'GND4_INT',
127 'GND5_INT', 'GND6_INT', 'GND7_INT', 'GND8_INT', 'GND9_INT',
128 ],
129
130 'POWER_GPIO':
131 ['VDD_GPIOA', 'VDD_GPIOB', 'VDD_GPIOC',
132 'VDD_GPIOD', 'VDD_GPIOE', 'VDD_GPIOF',
133 'VDD_GPIOG',
134 'GND_GPIOA', 'GND_GPIOB', 'GND_GPIOC',
135 'GND_GPIOD', 'GND_GPIOE', 'GND_GPIOF',
136 'GND_GPIOG',
137 ]
138
139 }
140
141 display_fixed(fixedpins, len(pinouts))
142
143 print "# Functions (PinMux)"
144 print
145 print "auto-generated by [[pinouts.py]]"
146 print
147
148 function_names = {'EINT': 'External Interrupt',
149 'FB': 'MC68k FlexBus',
150 'IIS': 'I2S Audio',
151 'JTAG0': 'JTAG',
152 'JTAG1': 'JTAG (same as JTAG2, JTAG_SEL=LOW)',
153 'JTAG2': 'JTAG (same as JTAG1, JTAG_SEL=HIGH)',
154 'LCD': '24-pin RGB/TTL LCD',
155 'RG': 'RGMII Ethernet',
156 'MMC': 'eMMC 1/2/4/8 pin',
157 'PWM': 'PWM (pulse-width modulation)',
158 'SD0': 'SD/MMC 0',
159 'SD1': 'SD/MMC 1',
160 'SD2': 'SD/MMC 2',
161 'SD3': 'SD/MMC 3',
162 'SPI0': 'SPI (Serial Peripheral Interface) 0',
163 'SPI1': 'SPI (Serial Peripheral Interface) 1',
164 'SPI2': 'SPI (Serial Peripheral Interface) 2',
165 'SPI3': 'Quad SPI (Serial Peripheral Interface) 3',
166 'TWI0': 'I2C 0',
167 'TWI1': 'I2C 1',
168 'TWI2': 'I2C 2',
169 'TWI3': 'I2C 3',
170 'UART0': 'UART (TX/RX) 0',
171 'UART1': 'UART (TX/RX) 1',
172 'UART2': 'UART (TX/RX) 2',
173 'UART3': 'UART (TX/RX) 3',
174 'UART4': 'UART (TX/RX) 4',
175 'UART5': 'UART (TX/RX) 5',
176 'ULPI0': 'ULPI (USB Low Pin-count) 0',
177 'ULPI1': 'ULPI (USB Low Pin-count) 1',
178 'ULPI2': 'ULPI (USB Low Pin-count) 2',
179 'ULPI3': 'ULPI (USB Low Pin-count) 3',
180 }
181
182 fns = display_fns(bankspec, pinouts, function_names)
183 print
184
185 # Scenarios below can be spec'd out as either "find first interface"
186 # by name/number e.g. SPI1, or as "find in bank/mux" which must be
187 # spec'd as "BM:Name" where B is bank (A-F), M is Mux (0-3)
188 # EINT and PWM are grouped together, specially, but may still be spec'd
189 # using "BM:Name". Pins are removed in-order as listed from
190 # lists (interfaces, EINTs, PWMs) from available pins.
191
192 # Robotics scenario.
193
194 robotics = ['FB', 'RG', 'ULPI0/8',
195 'SD0',
196 'JTAG0', 'E1:UART0',
197 'D1:SPI0', 'E1:TWI0']
198 robotics_pwm = []
199 for i in range(32):
200 robotics_pwm.append('PWM_%d' % i)
201 robotics_eint = ['EINT24', 'EINT25', 'EINT26', 'EINT27',
202 'EINT20', 'EINT21', 'EINT22', 'EINT23']
203 robotics_eint = []
204
205 unused_pins = check_functions("Robotics", bankspec, fns, pinouts,
206 robotics, robotics_eint, robotics_pwm)
207
208 print "# Reference Datasheets"
209 print
210 print "datasheets and pinout links"
211 print
212 print "* <http://datasheets.chipdb.org/AMD/8018x/80186/amd-80186.pdf>"
213 print "* <http://hands.com/~lkcl/eoma/shenzen/frida/FRD144A2701.pdf>"
214 print "* <http://pinouts.ru/Memory/sdcard_pinout.shtml>"
215 print "* p8 <http://www.onfi.org/~/media/onfi/specs/onfi_2_0_gold.pdf?la=en>"
216 print "* <https://www.heyrick.co.uk/blog/files/datasheets/dm9000aep.pdf>"
217 print "* <http://cache.freescale.com/files/microcontrollers/doc/app_note/AN4393.pdf>"
218 print "* <https://www.nxp.com/docs/en/data-sheet/MCF54418.pdf>"
219 print "* ULPI OTG PHY, ST <http://www.st.com/en/interfaces-and-transceivers/stulpi01a.html>"
220 print "* ULPI OTG PHY, TI TUSB1210 <http://ti.com/product/TUSB1210/>"
221