src/spec/m_class.py

   1 #!/usr/bin/env python
   2
   3 from spec.interfaces import Pinouts
   4
   5 from spec.ifaceprint import display, display_fns, check_functions
   6 from spec.ifaceprint import display_fixed
   7
   8
   9 def pinspec():
  10     pinbanks = {'A': 16,
  11                 'B': 28,
  12                 'C': 24,
  13                 'D': 24,
  14                 'E': 24,
  15                 'F': 10,
  16                 'G': 32,
  17                 }
  18     bankspec = {}
  19     pkeys = sorted(pinbanks.keys())
  20     offs = 0
  21     for kn in pkeys:
  22         bankspec[kn] = offs
  23         offs += pinbanks[kn]
  24
  25     pinouts = Pinouts(bankspec)
  26
  27     # Bank A, 0-15
  28     pinouts.gpio("", ('A', 0), "A", 0, 0, 16)
  29     pinouts.spi("0", ('A', 0), "A", 3)
  30     pinouts.uartfull("1", ('A', 0), "A", 2)
  31     pinouts.i2c("0", ('A', 4), "A", 2)
  32     pinouts.emmc("", ('A', 0), "A", 1)
  33     #pinouts.uart("0", ('A', 14), "A", 1)
  34     pinouts.spi("1", ('A', 6), "A", 2)
  35     pinouts.eint("", ('A', 10), "A", 1, start=0, limit=6)
  36     pinouts.eint("", ('A', 4), "A", 3, start=0, limit=6)
  37     pinouts.sdmmc("0", ('A', 10), "A", 2)
  38     pinouts.jtag("0", ('A', 10), "A", 3)
  39     pinouts.uart("0", ('A', 14), "A", 3)
  40
  41     # Bank B, 16-47
  42     pinouts.gpio("", ('B', 0), "B", 0, 0, 28)
  43     pinouts.rgbttl("0", ('B', 0), "B", 1)
  44     pinouts.spi("0", ('B', 12), "B", 2)
  45     pinouts.quadspi("", ('B', 4), "B", 2, limit=4)
  46     pinouts.uart("1", ('B', 16), "B", 2)
  47     pinouts.i2c("2", ('B', 18), "B", 2)
  48     pinouts.pwm("", ('B', 9), "B", 2, start=0, limit=1)
  49     pinouts.pwm("", ('B', 20), "B", 2, start=1, limit=2)
  50     pinouts.sdmmc("0", ('B', 22), "B", 2)
  51     pinouts.eint("", ('B', 0), "B", 3, start=6, limit=4)
  52     pinouts.flexbus2("", ('B', 4), "B", 3)
  53     pinouts.i2c("0", ('B', 0), "B", 2)
  54     pinouts.uart("0", ('B', 2), "B", 2)
  55     pinouts.uart("2", ('B', 10), "B", 2)
  56
  57     # Bank C, 48-71
  58     pinouts.gpio("", ("C", 0), "C", 0, 0, 24)
  59     pinouts.ulpi("0", ('C', 0), "C", 1)
  60     pinouts.ulpi("1", ('C', 12), "C", 1)
  61     pinouts.spi("1", ('C', 8), "C", 2)
  62     #pinouts.spi("1", ('C', 28), "C", 2)
  63     pinouts.uartfull("0", ('C', 20), "C", 3)
  64     pinouts.eint("", ('C', 0), "C", 3, start=10, limit=8)
  65     pinouts.jtag("1", ('C', 8), "C", 3)
  66     pinouts.eint("", ('C', 12), "C", 3, start=22, limit=8)
  67     pinouts.uart("0", ('C', 22), "C", 2)
  68     pinouts.i2s("", ('C', 13), "C", 2)
  69     pinouts.pwm("", ('C', 21), "C", 2, start=2, limit=1)
  70
  71     # Bank D, 72-96
  72
  73     # ok this is slightly complicated, basically there's extra
  74     # functions that we want to be on the same pin (but a different mux)
  75     # because their use is mutually-exclusive.  you can't have FB_TS
  76     # at the same time as FB_ALE for example.  FB_BWE2 even has two
  77     # mutually exclusive functions.  these extra functions are
  78     # specified here, so that when e.g. FB_BWE2 has been positioned,
  79     # FB_A0 will be placed in bank d, mux column 3, *on the same pin*.
  80     # this saves messing about, because if FB_BWE2 moved to a
  81     # different pin so would FB_A0 (and FB_CS2) likewise have to be
  82     # moved.  and the rest.
  83     flexspec = {
  84         'FB_TS': ('FB_ALE', 2, "D"),
  85         'FB_CS2': ('FB_BWE2', 2, "D"),
  86         'FB_A0': ('FB_BWE2', 3, "D"),
  87         'FB_CS3': ('FB_BWE3', 2, "D"),
  88         'FB_A1': ('FB_BWE3', 3, "D"),
  89         'FB_TBST': ('FB_OE', 2, "D"),
  90         'FB_TSIZ0': ('FB_BWE0', 2, "D"),
  91         'FB_TSIZ1': ('FB_BWE1', 2, "D"),
  92     }
  93     #pinouts.mcu8080("", 72, "D", 1)
  94     pinouts.gpio("", ('D', 0), "D", 0, 0, 24)
  95     pinouts.flexbus1("", ('D', 0), "D", 1, spec=flexspec)
  96     pinouts.i2c("1", ('D', 8), "D", 3)
  97     pinouts.pwm("", ('D', 21), "D", 1, start=0, limit=3)
  98     pinouts.i2c("0", ('D', 10), "D", 3)
  99     pinouts.i2c("2", ('D', 19), "D", 2)
 100     pinouts.uartfull("0", ('D', 0), "D", 2)
 101     pinouts.uart("1", ('D', 21), "D", 2)
 102     pinouts.uart("2", ('D', 13), "D", 2)
 103     pinouts.eint("", ('D', 19), "D", 3, start=18, limit=4)
 104     pinouts.eint("", ('D', 23), "D", 3, start=9, limit=1)
 105     pinouts.eint("", ('D', 13), "D", 3, start=5, limit=4)
 106     pinouts.eint("", ('D', 0), "D", 3, start=30, limit=2)
 107     pinouts.i2c("1", ('D', 2), "D", 3)
 108     pinouts.sdmmc("1", ('D', 4), "D", 2)
 109
 110     # Bank E
 111     pinouts.gpio("", ('E', 0), "E", 0, 0, 24)
 112     pinouts.flexbus2("", ('E', 0), "E", 1)
 113     pinouts.sdmmc("1", ('E', 0), "E", 2)
 114     pinouts.sdmmc("2", ('E', 8), "E", 2)
 115     pinouts.quadspi("", ('E', 18), "E", 2)
 116     pinouts.uartfull("1", ('E', 14), "E", 2)
 117     pinouts.i2c("1", ('E', 6), "E", 2)
 118     pinouts.eint("", ('E', 0), "E", 3, start=10, limit=8)
 119     pinouts.eint("", ('E', 8), "E", 3, start=22, limit=6)
 120     pinouts.emmc("", ('E', 14), "E", 3)
 121
 122     # Bank F
 123     pinouts.gpio("", ('F', 0), "F", 0, 0, 10)
 124     pinouts.i2s("", ('F', 0), "F", 1)
 125     pinouts.i2c("0", ('F', 6), "F", 2)
 126     pinouts.pwm("", ('F', 8), "F", 2, start=0, limit=1)
 127     pinouts.pwm("", ('F', 9), "F", 2, start=1, limit=1)
 128     pinouts.uart("2", ('F', 8), "F", 1)
 129     pinouts.sdmmc("2", ('F', 0), "F", 2)
 130     pinouts.eint("", ('F', 0), "F", 3, start=18, limit=4)
 131     pinouts.pwm("", ('F', 4), "F", 3, start=2, limit=1)
 132     pinouts.eint("", ('F', 5), "F", 3, start=7, limit=1)
 133     pinouts.eint("", ('F', 6), "F", 3, start=28, limit=4)
 134
 135     # Bank G
 136     pinouts.gpio("", ('G', 0), "G", 0, 0, 32)
 137     pinouts.rgmii("", ('G', 0), "G", 1)
 138     pinouts.ulpi("2", ('G', 20), "G", 1)
 139     pinouts.rgbttl("1", ('G', 0), "G", 2)
 140     pinouts.quadspi("", ('G', 26), "G", 3)
 141     pinouts.flexbus2("", ('G', 0), "G", 3)
 142     pinouts.sdmmc("1", ('G', 24), "G", 3, limit=2)
 143     pinouts.sdmmc("1", ('G', 28), "G", 2, start=2)
 144
 145     print ("""# Pinouts (PinMux)
 146 auto-generated by [[pinouts.py]]
 147
 148 [[!toc  ]]
 149 """)
 150     display(pinouts)
 151
 152     print ("\n# Pinouts (Fixed function)\n")
 153
 154     fixedpins = {
 155         'DDR3': [
 156             'SDQ0',
 157             'SDQ1',
 158             'SDQ2',
 159             'SDQ3',
 160             'SDQ4',
 161             'SDQ5',
 162             'SDQ6',
 163             'SDQ7',
 164             'SDQ8',
 165             'SDQ9',
 166             'SDQ10',
 167             'SDQ11',
 168             'SDQ12',
 169             'SDQ13',
 170             'SDQ14',
 171             'SDQ15',
 172             'SDQ16',
 173             'SDQ17',
 174             'SDQ18',
 175             'SDQ19',
 176             'SDQ20',
 177             'SDQ21',
 178             'SDQ22',
 179             'SDQ23',
 180             'SDQ24',
 181             'SDQ25',
 182             'SDQ26',
 183             'SDQ27',
 184             'SDQ28',
 185             'SDQ29',
 186             'SDQ30',
 187             'SDQ31',
 188             'SVREF0',
 189             'SVREF1',
 190             'SVREF2',
 191             'SVREF3',
 192             'SDQS0',
 193             'SDQS0#',
 194             'SDQS1',
 195             'SDQS1#',
 196             'SDQS2',
 197             'SDQS2#',
 198             'SDQS3',
 199             'SDQS3#',
 200             'SDQM0',
 201             'SDQM1',
 202             'SDQM2',
 203             'SDQM3',
 204             'SCK#',
 205             'SCK',
 206             'SCKE0',
 207             'SCKE1',
 208             'SA0',
 209             'SA1',
 210             'SA2',
 211             'SA3',
 212             'SA4',
 213             'SA5',
 214             'SA6',
 215             'SA7',
 216             'SA8',
 217             'SA9',
 218             'SA10',
 219             'SA11',
 220             'SA12',
 221             'SA13',
 222             'SA14',
 223             'SBA0',
 224             'SBA1',
 225             'SBA2',
 226             'SWE',
 227             'SCAS',
 228             'SRAS',
 229             'SCS0',
 230             'SCS1',
 231             'SZQ',
 232             'SRST',
 233             'SDBG0',
 234             'SDBG1',
 235             'ADBG',
 236             'ODT0',
 237             'ODT1'],
 238         'CTRL_SYS': [
 239             'TEST',
 240             'JTAG_SEL',
 241             'UBOOT_SEL',
 242             'NMI#',
 243             'RESET#',
 244             'CLK24M_IN',
 245             'CLK24M_OUT',
 246             'PLLTEST',
 247             'PLLREGIO',
 248             'PLLVP25',
 249             'PLLDV',
 250             'PLLVREG',
 251             'PLLGND',
 252         ],
 253         'POWER_DRAM': [
 254             'VCC0_DRAM',
 255             'VCC1_DRAM',
 256             'VCC2_DRAM',
 257             'VCC3_DRAM',
 258             'VCC4_DRAM',
 259             'VCC5_DRAM',
 260             'VCC6_DRAM',
 261             'VCC7_DRAM',
 262             'VCC8_DRAM',
 263             'VCC9_DRAM',
 264             'GND0_DRAM',
 265             'GND1_DRAM',
 266             'GND2_DRAM',
 267             'GND3_DRAM',
 268             'GND4_DRAM',
 269             'GND5_DRAM',
 270             'GND6_DRAM',
 271             'GND7_DRAM',
 272             'GND8_DRAM',
 273             'GND9_DRAM',
 274         ],
 275         'POWER_CPU': [
 276             'VDD0_CPU',
 277             'VDD1_CPU',
 278             'VDD2_CPU',
 279             'VDD3_CPU',
 280             'VDD4_CPU',
 281             'VDD5_CPU',
 282             'GND0_CPU',
 283             'GND1_CPU',
 284             'GND2_CPU',
 285             'GND3_CPU',
 286             'GND4_CPU',
 287             'GND5_CPU',
 288         ],
 289         'POWER_DLL': [
 290             'VDD0_DLL',
 291             'VDD1_DLL',
 292             'VDD2_DLL',
 293             'GND0_DLL',
 294             'GND1_DLL',
 295             'GND2_DLL',
 296         ],
 297         'POWER_INT': [
 298             'VDD0_INT',
 299             'VDD1_INT',
 300             'VDD2_INT',
 301             'VDD3_INT',
 302             'VDD4_INT',
 303             'VDD5_INT',
 304             'VDD6_INT',
 305             'VDD7_INT',
 306             'VDD8_INT',
 307             'VDD9_INT',
 308             'GND0_INT',
 309             'GND1_INT',
 310             'GND2_INT',
 311             'GND3_INT',
 312             'GND4_INT',
 313             'GND5_INT',
 314             'GND6_INT',
 315             'GND7_INT',
 316             'GND8_INT',
 317             'GND9_INT',
 318         ],
 319         'POWER_GPIO': [
 320             'VDD_GPIOA',
 321             'VDD_GPIOB',
 322             'VDD_GPIOC',
 323             'VDD_GPIOD',
 324             'VDD_GPIOE',
 325             'VDD_GPIOF',
 326             'VDD_GPIOG',
 327             'GND_GPIOA',
 328             'GND_GPIOB',
 329             'GND_GPIOC',
 330             'GND_GPIOD',
 331             'GND_GPIOE',
 332             'GND_GPIOF',
 333             'GND_GPIOG',
 334         ]}
 335
 336     fixedpins = display_fixed(fixedpins, len(pinouts))
 337
 338     print ("""# Functions (PinMux)
 339
 340 auto-generated by [[pinouts.py]]
 341 """)
 342
 343     function_names = {'EINT': 'External Interrupt',
 344                       'FB': 'MC68k FlexBus',
 345                       'IIS': 'I2S Audio',
 346                       'JTAG0': 'JTAG (same as JTAG1, JTAG_SEL=LOW)',
 347                       'JTAG1': 'JTAG (same as JTAG0, JTAG_SEL=HIGH)',
 348                       'LCD': '24-pin RGB/TTL LCD',
 349                       'RG': 'RGMII Ethernet',
 350                       'MMC': 'eMMC 1/2/4/8 pin',
 351                       'PWM': 'PWM (pulse-width modulation)',
 352                       'SD0': 'SD/MMC 0',
 353                       'SD1': 'SD/MMC 1',
 354                       'SD2': 'SD/MMC 2',
 355                       'SPI0': 'SPI (Serial Peripheral Interface) 0',
 356                       'SPI1': 'SPI (Serial Peripheral Interface) 1',
 357                       'QSPI': 'Quad SPI (Serial Peripheral Interface) 1',
 358                       'TWI0': 'I2C 1',
 359                       'TWI1': 'I2C 2',
 360                       'TWI2': 'I2C 3',
 361                       'UARTQ0': 'UART (TX/RX/CTS/RTS) 0',
 362                       'UARTQ1': 'UART (TX/RX/CTS/RTS) 1',
 363                       'UART0': 'UART (TX/RX) 0',
 364                       'UART1': 'UART (TX/RX) 1',
 365                       'UART2': 'UART (TX/RX) 2',
 366                       'ULPI0': 'ULPI (USB Low Pin-count) 1',
 367                       'ULPI1': 'ULPI (USB Low Pin-count) 2',
 368                       'ULPI2': 'ULPI (USB Low Pin-count) 3',
 369                       }
 370
 371     fns = display_fns(bankspec, pinouts, function_names)
 372     print
 373
 374     # Scenarios below can be spec'd out as either "find first interface"
 375     # by name/number e.g. SPI0, or as "find in bank/mux" which must be
 376     # spec'd as "BM:Name" where B is bank (A-F), M is Mux (0-3)
 377     # EINT and PWM are grouped together, specially, but may still be spec'd
 378     # using "BM:Name".  Pins are removed in-order as listed from
 379     # lists (interfaces, EINTs, PWMs) from available pins.
 380
 381     # EOMA68 scenario.  not totally complete (some GPIO needed for PMIC)
 382     # One interface to be connected to the MCU to give RTC and boot/dbg
 383     # VBUS_EN, OTG_ID etc. are all not included below, there is plenty
 384     # of spare GPIO.
 385
 386     eoma68 = ['B1:LCD/22', 'ULPI0/8', 'ULPI1', 'MMC', 'SD0', 'UART1',
 387               'TWI2', 'SPI1', 'E2:SD1', ]
 388     eoma68_eint = ['EINT_16', 'EINT_17', 'EINT_18', 'EINT_19']
 389     eoma68_pwm = ['D1:PWM_2']
 390     descriptions = {
 391         'MMC': 'internal (on Card)',
 392         'SD0': 'user-facing: internal (on Card), multiplexed with JTAG0\n'
 393         'and UART0, for debug purposes',
 394         'TWI2': 'EOMA68-compliance: must be entirely free of devices.\n'
 395         'Address 0x51 used (externally) for EOMA68 EEPROM Id',
 396         'E2:SD1': 'EOMA68-compliance',
 397         'SPI1': 'EOMA68-compliance',
 398         'UART1': 'EOMA68-compliance',
 399         'B1:LCD/22': 'EOMA68-compliance, 18-bit RGB/TTL LCD',
 400         'ULPI0/8': 'user-facing: internal (on Card), USB-OTG ULPI PHY',
 401         'ULPI1': 'EOMA68-compliance: dual USB2 Host ULPI PHY'
 402     }
 403
 404     unused_pins = check_functions("EOMA68", bankspec, fns, pinouts,
 405                                   eoma68, eoma68_eint, eoma68_pwm,
 406                                   descriptions)
 407
 408     # Industrial scenario.  not totally complete (some GPIO needed for PMIC)
 409     # One interface to be connected to the MCU to give RTC, boot/dbg,
 410     # option of CAN Bus, ADC, DAC, OWB, more GPIO, more PWM etc. etc.
 411     # Focus is on getting as many UARTs, SPIs and TWIs as possible.
 412     # OTG_ID (if to be used) would require dropping some functions in order
 413     # to free up GPIO.  LCD could be reduced to 15-bit (freeing 3).
 414     # MMC could be reduced to 4-bit-wide, used as SD/MMC (freeing 4).
 415     # QSPI could be used in 1-bit (MOSI/MISO) mode (freeing up 2 more).
 416
 417     industrial = ['D1:FB/17', 'E1:FB/8', 'B1:LCD/22', 'ULPI0/8', 'ULPI1/8',
 418                   'MMC', 'B2:SD0',
 419                   'JTAG0', 'A3:UART0', 'E2:UARTQ1', 'C3:UARTQ0',
 420                   'F2:TWI0', 'D2:TWI1', 'D2:TWI2', 'SPI1', 'QSPI', 'F2:SD2']
 421     industrial_pwm = ['F2:PWM_0', 'F2:PWM_1', 'D1:PWM_2']
 422     industrial_eint = ['EINT_24', 'EINT_25', 'EINT_26', 'EINT_27',
 423                        'EINT_20', 'EINT_21', 'EINT_22', 'EINT_23']
 424
 425     unused_pins = check_functions("Industrial", bankspec, fns, pinouts,
 426                                   industrial, industrial_eint, industrial_pwm)
 427
 428     # Industrial scenario, using an SPI-based LCD instead of RGB/TTL
 429     # not totally complete (some GPIO needed for PMIC)
 430     # One interface to be connected to the MCU to give RTC, boot/dbg,
 431     # option of CAN Bus, ADC, DAC, OWB, more GPIO, more PWM etc. etc.
 432     # Focus is on getting as many UARTs, SPIs and TWIs as possible,
 433     # leaving some GPIO spare from the RGB/TTL bank (SPI CS#)
 434     # also possibility of freeing up FlexBus CS# with a little reorg.
 435
 436     industrial = ['D1:FB/17', 'E1:FB/8', 'B2:SPI0', 'ULPI0/8', 'ULPI1/8',
 437                   'MMC', 'B2:SD0',
 438                   'JTAG0',
 439                   'A3:UART0', 'E2:UARTQ1', 'C3:UARTQ0', 'B2:UART2', 'B2:UART1',
 440                   'F2:TWI0', 'D2:TWI1', 'D2:TWI2', 'SPI1', 'QSPI', 'F2:SD2']
 441     industrial_pwm = ['F2:PWM_0', 'F2:PWM_1', 'D1:PWM_2']
 442     industrial_eint = ['EINT_24', 'EINT_25', 'EINT_26', 'EINT_27',
 443                        'EINT_20', 'EINT_21', 'EINT_22', 'EINT_23']
 444     ind_descriptions = {
 445         'B2:SPI0': 'Used for 320x240 or 640x480 etc. SPI-based LCD.\n'
 446         'Frees up large numbers of GPIO from RGB/TTL bank'
 447     }
 448     unused_pins = check_functions("Industrial with SPI-LCD",
 449                                   bankspec, fns, pinouts,
 450                                   industrial, industrial_eint, industrial_pwm,
 451                                   ind_descriptions)
 452
 453     # Smartphone / Tablet - basically the same thing
 454
 455     tablet = ['B1:LCD/22', 'ULPI0/8', 'ULPI1/8',
 456               'MMC', 'SD0',
 457               'F1:IIS',  # I2C Audio
 458               'TWI1',   # I2C Audio
 459               'E2:UARTQ1',  # WIFI/BT
 460               'E2:SD1',   # WIFI
 461               'C3:UARTQ0',  # GPS
 462               'D2:UART1',
 463               'D2:UART2',
 464               'D3:TWI0', 'D2:TWI2', 'SPI1', 'QSPI']
 465     tablet_pwm = ['F2:PWM_0',  # LCD_BACKLIGHT
 466                   'F2:PWM_1', 'D1:PWM_2']
 467     tablet_eint = ['EINT_24',  # BT_HOST_WAKE
 468                    'EINT_25',  # WIFI_HOST_WAKE
 469                    'EINT_26',  # CTP_INT
 470                    'EINT_27',  # GSENSOR_INT
 471                    'EINT_8',  # GPS_INT
 472                    'EINT_7',  # TILT_SENSOR_INT
 473                    'EINT_22',  # COMPASS_INT
 474                    'EINT_23',  # MCU_INT
 475                    'EINT_16',  # PMIC_INT
 476                    'EINT_17',  # PWR_BUTTON_INT
 477                    'EINT_30',  # OTG_ID
 478                    'EINT_31',
 479                    ]
 480     descriptions = {
 481         'B1:LCD/22':
 482         'RGB/TTL LCD, 800x480 or use SN75LVDS83b for up to 1440x900',
 483         'MMC': 'eMMC: main internal storage',
 484         'ULPI0/8': 'USB-OTG, connect to ULPI OTG PHY (for charging)\n'
 485                    'as well as USB Host or USB Device',
 486         'ULPI1/8': 'USB2 Host, connect to ULPI PHY w/and 4-port USB2 Hub\n'
 487         'for example GL850G or FE1.1. '
 488         'Connects to 2/3/4G/LTE Modem, 2x USB-Camera (VC0345)',
 489         'SD0': 'internal, multiplexed with JTAG0\n'
 490                'and UART0, for debug purposes',
 491         'F1:IIS': 'I2C Audio, connect to AC97 Audio IC',
 492         'TWI1': 'Connect to AC97 Audio IC',
 493         'E2:UARTQ1': 'Connect to BT on AP6234/AP6335',
 494         'E2:SD1': 'Connect to WIFI on AP6234/AP6335',
 495         'QSPI': 'Boot Storage (connection to companion / debug / boot MCU)\n'
 496                 'Only actually needs MISO/MOSI, bootstrap loader v. small\n'
 497                 'Bootstrap loader checks eMMC, USB-OTG, SD/MMC, SPI, etc.',
 498         'SPI1': 'Spare? SPI, connect to higher-speed sensor?',
 499         'D2:UART1': 'Spare? UART (or 2 extra GPIO / EINT)',
 500         'D2:UART2': 'Spare? UART (or 2 extra GPIO)',
 501         'D3:TWI0': 'Connect to PMIC',
 502         'D2:TWI2': 'Connect to sensors (Trackpad? CTP GSENSOR TILT COMPASS)',
 503         'GPIO': '9 spare GPIO pins for miscellaneous functions:\n'
 504                 'wake-up of BT, WIFI, LCD power, sensor power etc.\n'
 505                 '4 GPIO may be needed for PWM Audio from Modem.\n'
 506                 'LED lights for camera will be needed.\n'
 507                 'Some phones may have clam-shell or lid switch.\n'
 508                 'Some Modems have spare GPIO (over AT commandset).\n'
 509                 'AXP209 PMIC has 4x GPIO, accessible over I2C.\n'
 510                 'SPI1, UART1-4, PWM1-2 may also be spare (10 extra GPIO).\n'
 511                 'If more needed, companion MCU may be used (48+ pin variant)\n'
 512                 'which also includes ADC, DAC, more PWM etc.',
 513         'F2:PWM_0': 'LCD Backlight',
 514         'F2:PWM_1': 'Spare? PWM (or extra GPIO / EINT)',
 515         'D1:PWM_2': 'Spare? PWM (or extra GPIO / EINT)',
 516         'EINT_24': 'BT_HOST_WAKE',
 517         'EINT_25': 'WIFI_HOST_WAKE',
 518         'EINT_26': 'CTP_INT',
 519         'EINT_27': 'GSENSOR_INT',
 520         'EINT_8': 'GPS_INT',
 521         'EINT_7': 'TILT_SENSOR_INT',
 522         'EINT_22': 'COMPASS_INT',
 523         'EINT_23': 'MCU_INT',
 524         'EINT_16': 'PMIC_INT',
 525         'EINT_17': 'PWR_BUTTON_INT',
 526         'EINT_30': 'OTG_ID',
 527         'EINT_31': 'Spare?',
 528     }
 529     unused_pins = check_functions("Smartphone / Tablet",
 530                                   bankspec, fns, pinouts,
 531                                   tablet, tablet_eint, tablet_pwm,
 532                                   descriptions)
 533
 534     # Laptop
 535
 536     laptop = ['D1:FB/17', 'E1:FB/8', 'B1:LCD/22', 'ULPI0/8', 'ULPI1/8',
 537               'MMC', 'SD0',
 538               'F1:IIS',  # I2C Audio
 539               'TWI1',   # I2C Audio
 540               'E2:UARTQ1',  # WIFI/BT
 541               'E2:SD2',   # WIFI
 542               'D2:TWI2', 'QSPI']
 543     laptop_pwm = ['F2:PWM_0',  # LCD_BACKLIGHT
 544                   ]
 545     laptop_eint = ['EINT_20',  # BT_HOST_WAKE
 546                    'EINT_21',  # WIFI_HOST_WAKE
 547                    'EINT_9',  # MCU_INT
 548                    'EINT_31',  # PMIC_INT
 549                    ]
 550     descriptions = {
 551         'D1:FB/17': 'FlexBus.  Connect to DM9000 or AX99896A MCU-style Bus\n'
 552         '10/100 Ethernet PHY.',
 553         'E1:FB/8': 'FlexBus bus bits 8-15, needed to make a 16-bit bus width',
 554         'B1:LCD/22': 'RGB/TTL LCD, use SN75LVDS83b for '
 555                      'LVDS or SSD2828 for MIPI,\n'
 556         'or a Chrontel CH7039, CH7038, CH7034 or CH7018 for dual\n'
 557         'display output (eDP/LVDS and HDMI/VGA) '
 558         'conversion.',
 559         'MMC': 'eMMC: main internal storage',
 560         'ULPI0/8': 'USB-OTG, connect to ULPI OTG PHY (for charging)\n'
 561         'as well as USB Host or USB Device',
 562         'ULPI1/8': 'USB2 Host, connect to ULPI PHY w/and 4-port USB2 Hub\n'
 563         'for example GL850G or FE1.1. '
 564         'Connects to USB-Camera (VC0345 and 3x external USB Ports)',
 565         'SD0': 'internal, multiplexed with JTAG0\n'
 566         'and UART0, for debug purposes',
 567         'F1:IIS': 'I2C Audio, connect to AC97 Audio IC',
 568         'TWI1': 'Connect to AC97 Audio IC',
 569         'E2:UARTQ1': 'Connect to BT on AP6234/AP6335',
 570         'E2:SD2': 'Connect to WIFI on AP6234/AP6335',
 571         'QSPI': 'Boot Storage (connection to companion / debug / boot MCU)\n'
 572         'Only actually needs MISO/MOSI, bootstrap loader v. small\n'
 573         'Bootstrap loader checks eMMC, USB-OTG, SD/MMC, SPI, etc.\n'
 574         'MCU implements keyboard-matrix for keyboard (also trackpad?)',
 575         'D2:TWI2': 'Connect to PMIC',
 576         'GPIO': 'Plenty of spare GPIO pins for miscellaneous functions\n'
 577         'MCU EINT-capable GPIO may be used to generate extra EINTs\n'
 578         'on the single MCU_INT line, if really needed',
 579         'F2:PWM_0': 'LCD Backlight',
 580         'EINT_20': 'BT_HOST_WAKE',
 581         'EINT_21': 'WIFI_HOST_WAKE',
 582         'EINT_9': 'MCU_INT',
 583         'EINT_31': 'PMIC_INT',
 584     }
 585     unused_pins = check_functions("Laptop / Netbook",
 586                                   bankspec, fns, pinouts,
 587                                   laptop, laptop_eint, laptop_pwm,
 588                                   descriptions)
 589
 590     # IoT
 591
 592     iot = ['B1:LCD', 'ULPI1/8', 'ULPI0/8',
 593            'MMC', 'SD0',
 594            'F1:IIS',  # I2C Audio
 595            #'TWI1',   # I2C Audio
 596            'C3:UARTQ0',  # HSPA UART
 597            'E2:UARTQ1',  # BT UART
 598            'C2:SPI1',  # HSPI SPI
 599            'E2:SD2',   # WIFI
 600            'D3:TWI0',  # sensors CTP,
 601            'D2:TWI2', 'QSPI']
 602     iot_pwm = ['F2:PWM_0',  # LCD_BACKLIGHT
 603                ]
 604     iot_eint = ['EINT_5',  # 'HSPA_MST_RDY',
 605                 'EINT_6',  # 'HSPA_SL_RDY',
 606                 'EINT_7',  # 'HSPA_RING',
 607                 'EINT_8',  # 'WL_PMU_EN',
 608                 'EINT_9',  # HSPA_GPIO1
 609                 'EINT_10',  # IR_DT
 610                 'EINT_11',  # 'BT_PCM_CLK',
 611                 'EINT_12',  # 'BT_PCM_DIN',
 612                 'EINT_13',  # 'BT_PCM_SYNC',
 613                 'EINT_14',  # 'BT_PCM_DOUT',
 614                 'EINT_16',  # 'USB_DRVVBUS',
 615                 'EINT_17',  # 'USB_VBUSDET',
 616                 'EINT_21',  # 'USB_ID',
 617                 'EINT_30',  # 'CTP_INT',
 618                 'EINT_31',  # 'SD_DET#',
 619                 ]
 620     descriptions = {
 621         'B1:LCD':
 622         'RGB/TTL LCD, use SN75LVDS83b for LVDS or SSD2828 for MIPI,\n'
 623         'or a Chrontel CH7039, CH7038, CH7034 or CH7018 for dual\n'
 624         'display output (eDP/LVDS and HDMI/VGA) '
 625         'conversion.',
 626         'MMC': 'eMMC: main internal storage',
 627         'F1:IIS': 'I2C Audio, connect to AC97 Audio IC',
 628         'ULPI1/8': 'USB-OTG, connect to ULPI OTG PHY (for charging)\n'
 629                    'as well as USB Host or USB Device',
 630         'ULPI0/8': 'USB2 Host, connect to ULPI PHY',
 631         'SD0': 'internal, multiplexed with JTAG0\n'
 632                'and UART0, for debug purposes',
 633         'C3:UARTQ0': 'Connect to HSPA UART',
 634         'E2:UARTQ1': 'Connect to BT UART',
 635         'E2:SD2': 'Connect to WIFI',
 636         'C2:SPI1': 'HSPA SPI',
 637         'QSPI': 'Boot Storage (connection to companion / debug / boot MCU)\n'
 638                 'Only actually needs MISO/MOSI, bootstrap loader v. small\n'
 639                 'Bootstrap loader checks eMMC, USB-OTG, SD/MMC, SPI, etc.\n'
 640                 'MCU implements keyboard-matrix for keyboard (also trackpad?)',
 641         'D2:TWI2': 'Connect to PMIC',
 642         'D3:TWI0': 'Connect to sensors CTP',
 643         'GPIO': 'Plenty of spare GPIO pins for miscellaneous functions\n'
 644                 'MCU EINT-capable GPIO may be used to generate extra EINTs\n'
 645                 'on the single MCU_INT line, if really needed',
 646         'F2:PWM_0': 'LCD Backlight',
 647         'GPIOD_D4': 'WL_WAKE_AP',
 648         'GPIOD_D5': 'BT_WAKE_AP',
 649         'GPIOD_D6': 'AP_WAKE_BT',
 650         'GPIOD_D7': 'AP_CK32KO',
 651         'GPIOD_D8': 'HSPA_PWRON',
 652         'GPIOD_D9': 'BT_RST_N',
 653         'GPIOE_E5': 'HSPA_ON_OFF',
 654         'GPIOD_D2': 'HSPA_SHUTDOWN',
 655         'GPIOD_D3': 'CTP_RST',
 656         'GPIOD_D12': 'LCD_RDN',
 657         'GPIOD_D17': 'LCD_WRN',
 658         'GPIOD_D18': 'LCD_RS',
 659         'GPIOD_D21': 'LCD_CSN',
 660
 661         'EINT_5': 'HSPA_MST_RDY',
 662         'EINT_6': 'HSPA_SL_RDY',
 663         'EINT_7': 'HSPA_RING',
 664         'EINT_8': 'WL_PMU_EN',
 665         'EINT_9': 'HSPA_GPIO1',
 666         'EINT_10': 'IR_DT',
 667         'EINT_11': 'BT_PCM_CLK',
 668         'EINT_12': 'BT_PCM_DIN',
 669         'EINT_13': 'BT_PCM_SYNC',
 670         'EINT_14': 'BT_PCM_DOUT',
 671
 672         'EINT_16': 'USB_DRVVBUS',
 673         'EINT_17': 'USB_VBUSDET',
 674         'EINT_21': 'USB_ID',
 675         'EINT_30': 'CTP_INT',
 676         'EINT_31': 'SD_DETN',
 677     }
 678     unused_pins = check_functions("IoT",
 679                                   bankspec, fns, pinouts,
 680                                   iot, iot_eint, iot_pwm,
 681                                   descriptions)
 682
 683     print ("""# Reference Datasheets
 684
 685 datasheets and pinout links
 686 * <http://datasheets.chipdb.org/AMD/8018x/80186/amd-80186.pdf>
 687 * <http://hands.com/~lkcl/eoma/shenzen/frida/FRD144A2701.pdf>
 688 * <http://pinouts.ru/Memory/sdcard_pinout.shtml>
 689 * p8 <http://www.onfi.org/~/media/onfi/specs/onfi_2_0_gold.pdf?la=en>
 690 * <https://www.heyrick.co.uk/blog/files/datasheets/dm9000aep.pdf>
 691 * <http://cache.freescale.com/files/microcontrollers/doc/app_note/AN4393.pdf>
 692 * <https://www.nxp.com/docs/en/data-sheet/MCF54418.pdf>
 693 * ULPI OTG PHY, ST <http://www.st.com/en/interfaces-and-transceivers/stulpi01a.html>
 694 * ULPI OTG PHY, TI TUSB1210 <http://ti.com/product/TUSB1210/>
 695 """)
 696
 697     return pinouts, bankspec, pinbanks, fixedpins