src/spec/c_class.py

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