#!/usr/bin/env python

from copy import deepcopy

def pins(pingroup, bankspec, suffix, offs, bank, mux, spec=None, limit=None):
    res = {}
    names = {}
    idx = 0
    for name in pingroup[:limit]:
        if suffix:
            name_ = "%s_%s" % (name, suffix)
        else:
            name_ = name
        if spec and spec.has_key(name):
            continue
        pin = {mux: (name_, bank)}
        offs_bank, offs_ = offs
        idx_ = offs_ + idx
        idx += 1
        idx_ += bankspec[bank]
        res[idx_] = pin
        names[name] = idx_
    for name in pingroup:
        if suffix:
            name_ = "%s_%s" % (name, suffix)
        else:
            name_ = name
        if not spec:
            continue
        if not spec.has_key(name):
            continue
        idx_, mux_, bank_ = spec[name]
        idx_ = names[idx_]
        #idx_ += bankspec[bank_]
        pin = {mux_: (name_, bank_)}
        if res.has_key(idx_):
            res[idx_].update(pin)
        else:
            res[idx_] = pin
    return res

def i2s(bankspec, suffix, offs, bank, mux=1, spec=None, limit=None):
    i2spins = ['IISMCK', 'IISBCK', 'IISLRCK', 'IISDI']
    for i in range(4):
        i2spins.append("IISDO%d" % i)
    return pins(i2spins, bankspec, suffix, offs, bank, mux, spec, limit)

def emmc(bankspec, suffix, offs, bank, mux=1, spec=None):
    emmcpins = ['MMCCMD', 'MMCCLK']
    for i in range(8):
        emmcpins.append("MMCD%d" % i)
    return pins(emmcpins, bankspec, suffix, offs, bank, mux, spec)

def sdmmc(bankspec, suffix, offs, bank, mux=1, spec=None,
                start=None, limit=None):
    sdmmcpins = ['CMD', 'CLK']
    for i in range(4):
        sdmmcpins.append("D%d" % i)
    sdmmcpins = sdmmcpins[start:limit]
    sdmmcpins = namesuffix('SD', suffix, sdmmcpins)
    return pins(sdmmcpins, bankspec, '', offs, bank, mux, spec)

def spi(bankspec, suffix, offs, bank, mux=1, spec=None):
    spipins = namesuffix('SPI', suffix,
                ['CLK', 'NSS', 'MOSI', 'MISO', 'NSS'])
    return pins(spipins, bankspec, '', offs, bank, mux, spec)

def quadspi(bankspec, suffix, offs, bank, mux=1, spec=None, limit=None):
    spipins = namesuffix('SPI', suffix,
                ['CK', 'NSS', 'IO0', 'IO1', 'IO2', 'IO3'])
    return pins(spipins, bankspec, '', offs, bank, mux, spec, limit)

def i2c(bankspec, suffix, offs, bank, mux=1, spec=None):
    spipins = namesuffix('TWI', suffix,
                ['SDA', 'SCL'])
    return pins(spipins, bankspec, '', offs, bank, mux, spec)

def jtag(bankspec, suffix, offs, bank, mux=1, spec=None):
    uartpins = namesuffix('JTAG', suffix, ['MS', 'DI', 'DO', 'CK'])
    return pins(uartpins, bankspec, '', offs, bank, mux, spec)

def uart(bankspec, suffix, offs, bank, mux=1, spec=None):
    uartpins = namesuffix('UART', suffix, ['TX', 'RX'])
    return pins(uartpins, bankspec, '', offs, bank, mux, spec)

def namesuffix(name, suffix, namelist):
    names = []
    for n in namelist:
        names.append("%s%s_%s" % (name, suffix, n))
    return names

def ulpi(bankspec, suffix, offs, bank, mux=1, spec=None):
    ulpipins = namesuffix('ULPI', suffix, ['CK', 'DIR', 'STP', 'NXT'])
    for i in range(8):
        ulpipins.append('ULPI%s_D%d' % (suffix, i))
    return pins(ulpipins, bankspec, "", offs, bank, mux, spec)

def uartfull(bankspec, suffix, offs, bank, mux=1, spec=None):
    uartpins = namesuffix('UART', suffix, ['TX', 'RX', 'CTS', 'RTS'])
    return pins(uartpins, bankspec, '', offs, bank, mux, spec)

def rgbttl(bankspec, suffix, offs, bank, mux=1, spec=None):
    ttlpins = ['LCDCK', 'LCDDE', 'LCDHS', 'LCDVS']
    for i in range(24):
        ttlpins.append("LCD%d" % i)
    return pins(ttlpins, bankspec, suffix, offs, bank, mux, spec)

def rgmii(bankspec, suffix, offs, bank, mux=1, spec=None):
    buspins = []
    for i in range(4):
        buspins.append("RG_ERXD%d" % i)
    for i in range(4):
        buspins.append("RG_ETXD%d" % i)
    for i in range(2):
        buspins.append("RG_FB_CS%d" % i)
    buspins += ['RG_ERXCK', 'RG_ERXERR', 'RG_ERXDV',
                'RG_EMDC', 'RG_EMDIO',
                'RG_ETXEN', 'RG_ETXCK', 'RG_ECRS',
                'RG_ECOL', 'RG_ETXERR']
    return pins(buspins, bankspec, suffix, offs, bank, mux, spec)

def flexbus1(bankspec, suffix, offs, bank, mux=1, spec=None):
    buspins = []
    for i in range(8):
        buspins.append("FB_AD%d" % i)
    for i in range(2):
        buspins.append("FB_CS%d" % i)
    buspins += ['FB_ALE', 'FB_OE', 'FB_RW', 'FB_TA', 'FB_CLK',
                'FB_A0', 'FB_A1', 'FB_TS', 'FB_TBST',
                'FB_TSIZ0', 'FB_TSIZ1']
    for i in range(4):
        buspins.append("FB_BWE%d" % i)
    for i in range(2,6):
        buspins.append("FB_CS%d" % i)
    return pins(buspins, bankspec, suffix, offs, bank, mux, spec)

def flexbus2(bankspec, suffix, offs, bank, mux=1, spec=None):
    buspins = []
    for i in range(8,32):
        buspins.append("FB_AD%d" % i)
    return pins(buspins, bankspec, suffix, offs, bank, mux, spec)

def mcu8080(bankspec, suffix, offs, bank, mux=1, spec=None):
    buspins = []
    for i in range(8):
        buspins.append("MCUD%d" % i)
    for i in range(8):
        buspins.append("MCUAD%d" % (i+8))
    for i in range(6):
        buspins.append("MCUCS%d" % i)
    for i in range(2):
        buspins.append("MCUNRB%d" % i)
    buspins += ['MCUCD', 'MCURD', 'MCUWR', 'MCUCLE', 'MCUALE',
                'MCURST']
    return pins(buspins, bankspec, suffix, offs, bank, mux, spec)

def _pinbank(bankspec, prefix, suffix, offs, bank, gpiooffs, gpionum=1, mux=1, spec=None):
    gpiopins = []
    for i in range(gpiooffs, gpiooffs+gpionum):
        gpiopins.append("%s%s%d" % (prefix, bank, i))
    return pins(gpiopins, bankspec, suffix, offs, bank, mux, spec)

def eint(bankspec, suffix, offs, bank, gpiooffs, gpionum=1, mux=1, spec=None):
    gpiopins = []
    for i in range(gpiooffs, gpiooffs+gpionum):
        gpiopins.append("EINT%d" % (i))
    return pins(gpiopins, bankspec, suffix, offs, bank, mux, spec)

def pwm(bankspec, suffix, offs, bank, mux=1, spec=None):
    return pins(['PWM', ], bankspec, suffix, offs, bank, mux, spec)

def gpio(bankspec, suffix, offs, bank, gpiooffs, gpionum=1, mux=1, spec=None):
    return _pinbank(bankspec, "GPIO", suffix, offs, bank, gpiooffs,
                              gpionum, mux=0, spec=None)

def display(pins):
    print "| Pin | Mux0        | Mux1        | Mux2        | Mux3        |"
    print "| --- | ----------- | ----------- | ----------- | ----------- |"
    pinidx = pins.keys()
    pinidx.sort()
    for pin in pinidx:
        pdata = pins[pin]
        res = '| %3d |' % pin
        for mux in range(4):
            if not pdata.has_key(mux):
                res += "             |"
                continue
            name, bank = pdata[mux]
            res += " %s %-9s |" % (bank, name)
        print res

def fnsplit(f):
    a = ''
    n = 0
    if not f.startswith('FB_'):
        f2 = f.split('_')
        if len(f2) == 2:
            if f2[1].isdigit():
                return f2[0], int(f2[1])
            return f2[0], f2[1]
    #print f
    while f and not f[0].isdigit():
        a += f[0]
        f = f[1:]
    return a, int(f) if f else None

def fnsort(f1, f2):
    a1, n1 = fnsplit(f1)
    a2, n2 = fnsplit(f2)
    x = cmp(a1, a2)
    if x != 0:
        return x
    return cmp(n1, n2)
    
def find_fn(fname, names):
    for n in names:
        if fname.startswith(n):
            return n

def display_fns(bankspec, pins, function_names):
    fn_names = function_names.keys()
    fns = {}
    for (pin, pdata) in pins.items():
        for mux in range(1,4): # skip GPIO for now
            if not pdata.has_key(mux):
                continue
            name, bank = pdata[mux]
            if not fns.has_key(name):
                fns[name] = []
            fns[name].append((pin-bankspec[bank], mux, bank))

    fnidx = fns.keys()
    fnidx.sort(fnsort)
    current_fn = None
    for fname in fnidx:
        fnbase = find_fn(fname, fn_names)
        if fnbase != current_fn:
            if current_fn is not None:
                print
            print "## %s" % fnbase
            print
            print function_names[fnbase]
            print
            current_fn = fnbase
        print "* %-9s :" % fname,
        for (pin, mux, bank) in fns[fname]:
            print "%s%d/%d" % (bank, pin, mux),
        print

    return fns

def check_functions(title, bankspec, fns, pins, required, eint, pwm,
                    descriptions=None):
    fns = deepcopy(fns)
    pins = deepcopy(pins)
    if descriptions is None:
        descriptions = {}

    print "# Pinmap for %s" % title
    print


    for name in required:
        print "## %s" % name
        print
        if descriptions and descriptions.has_key(name):
            print descriptions[name]
            print

        name = name.split(':')
        if len(name) == 2:
            findbank = name[0][0]
            findmux = int(name[0][1:])
            name = name[1]
        else:
            name = name[0]
            findbank = None
            findmux = None
        name = name.split('/')
        if len(name) == 2:
            count = int(name[1])
        else:
            count = 100000
        name = name[0]
        found = set()
        fnidx = fns.keys()
        #fnidx.sort(fnsort)
        pinfound = {}
        for fname in fnidx:
            if not fname.startswith(name):
                continue
            for pin, mux, bank in fns[fname]:
                if findbank is not None:
                    if findbank != bank:
                        continue
                    if findmux != mux:
                        continue
                pin_ = pin + bankspec[bank]
                if pins.has_key(pin_):
                    pinfound[pin_] = (fname, pin_, bank, pin, mux)

        pinidx = pinfound.keys()
        pinidx.sort()

        for pin_ in pinidx:
            fname, pin_, bank, pin, mux = pinfound[pin_]
            if fname in found:
                continue
            found.add(fname)
            if len(found) > count:
                continue
            del pins[pin_]
            print "* %s %d %s%d/%d" % (fname, pin_, bank, pin, mux)

        print

    # gpios
    gpios = []
    for name in descriptions.keys():
        if not name.startswith('GPIO'):
            continue
        if name == 'GPIO':
            continue
        gpios.append(name)
    gpios.sort()
    
    if gpios:
        print "## GPIO"
        print

        for fname in gpios:
            if fname in found:
                continue
            desc = ''
            if descriptions and descriptions.has_key(fname):
                desc = ': %s' % descriptions[fname]
            bank = fname[4]
            pin = int(fname[5:])
            pin_ = pin + bankspec[bank]
            if not pins.has_key(pin_):
                continue
            del pins[pin_]
            found.add(fname)
            print "* %-8s %d %s%-2d %s" % (fname, pin_, bank, pin, desc)
        print

    if eint:
        display_group("EINT", eint, fns, pins, descriptions)
    if pwm:
        display_group("PWM", pwm, fns, pins, descriptions)

    print "## Unused Pinouts (spare as GPIO) for '%s'" % title
    print
    if descriptions and descriptions.has_key('GPIO'):
        print descriptions['GPIO']
        print 
    display(pins)
    print

    return pins # unused

def display_group(title, todisplay, fns, pins, descriptions):
    print "## %s" % title
    print

    found = set()
    for fname in todisplay:
        desc = ''
        if descriptions and descriptions.has_key(fname):
            desc = ': %s' % descriptions[fname]
        fname = fname.split(':')
        if len(fname) == 2:
            findbank = fname[0][0]
            findmux = int(fname[0][1:])
            fname = fname[1]
        else:
            fname = fname[0]
            findbank = None
            findmux = None
        for (pin, mux, bank) in fns[fname]:
            if findbank is not None:
                if findbank != bank:
                    continue
                if findmux != mux:
                    continue
            if fname in found:
                continue
            pin_ = pin + bankspec[bank]
            if not pins.has_key(pin_):
                continue
            del pins[pin_]
            found.add(fname)
            print "* %s %d %s%d/%d %s" % (fname, pin_, bank, pin, mux, desc)
    print

def pinmerge(pins, fn):
    for (pinidx, v) in fn.items():
        if not pins.has_key(pinidx):
            pins[pinidx] = v
            continue
        pins[pinidx].update(v)

def display_fixed(fixed, offs):

    fkeys = fixed.keys()
    fkeys.sort()
    pin_ = offs
    for pin, k in enumerate(fkeys):
        print "## %s" % k
        print
        prevname = ''
        linecount = 0
        for name in fixed[k]:
            if linecount == 4:
                linecount = 0
                print
            if prevname[:2] == name[:2] and linecount != 0:
                print name,
                linecount += 1
            else:
                if linecount != 0:
                    print
                print "* %d: %d %s" % (pin_, pin, name),
                linecount = 1
            prevname = name
            pin_ += 1
        if linecount != 0:
            print
        print

if __name__ == '__main__':
    pinouts = {}

    pinbanks = {'A': 16,
                'B': 28,
                'C': 24,
                'D': 24,
                'E': 24,
                'F': 10,
                'G': 32,
              }
    bankspec = {}
    pkeys = pinbanks.keys()
    pkeys.sort()
    offs = 0
    for kn in pkeys:
        bankspec[kn] = offs
        offs += pinbanks[kn]

    # Bank A, 0-15
    pinmerge(pinouts, gpio(bankspec, "", ('A', 0), "A", 0, 16, 0))
    pinmerge(pinouts, spi(bankspec, "1", ('A', 0), "A", 3))
    pinmerge(pinouts, uartfull(bankspec, "1", ('A', 0), "A", 2))
    pinmerge(pinouts, i2c(bankspec, "1", ('A', 4), "A", 2))
    pinmerge(pinouts, emmc(bankspec, "", ('A', 0), "A", 1))
    #pinmerge(pinouts, uart(bankspec, "2", ('A', 14), "A", 1))
    pinmerge(pinouts, spi(bankspec, "2", ('A', 6), "A", 2))
    pinmerge(pinouts, eint(bankspec, "", ('A', 10), "A", 0, 6))
    pinmerge(pinouts, eint(bankspec, "", ('A', 4), "A", 0, 6, mux=3))
    pinmerge(pinouts, sdmmc(bankspec, "1", ('A', 10), "A", 2))
    pinmerge(pinouts, jtag(bankspec, "1", ('A', 10), "A", 3))
    pinmerge(pinouts, uart(bankspec, "2", ('A', 14), "A", 3))

    # Bank B, 16-47
    pinmerge(pinouts, gpio(bankspec, "", ('B', 0), "B", 0, 28, 0))
    pinmerge(pinouts, rgbttl(bankspec, "0", ('B', 0), "B", 1))
    pinmerge(pinouts, spi(bankspec, "1", ('B', 12), "B", 2))
    pinmerge(pinouts, quadspi(bankspec, "3", ('B', 4), "B", 2, limit=4))
    pinmerge(pinouts, uart(bankspec, "3", ('B', 16), "B", 2))
    pinmerge(pinouts, i2c(bankspec, "3", ('B', 18), "B", 2))
    pinmerge(pinouts, pwm(bankspec, "0", ('B', 9), "B", mux=2))
    pinmerge(pinouts, pwm(bankspec, "1", ('B', 20), "B", mux=2))
    pinmerge(pinouts, pwm(bankspec, "2", ('B', 21), "B", mux=2))
    pinmerge(pinouts, sdmmc(bankspec, "1", ('B', 22), "B", 2))
    pinmerge(pinouts, eint(bankspec, "", ('B', 0), "B", 6, 4, mux=3))
    pinmerge(pinouts, flexbus2(bankspec, "", ('B', 4), "B", 3))
    pinmerge(pinouts, i2c(bankspec, "1", ('B', 0), "B", 2))
    pinmerge(pinouts, uart(bankspec, "2", ('B', 2), "B", 2))
    pinmerge(pinouts, uart(bankspec, "4", ('B', 10), "B", 2))

    # Bank C, 48-71
    pinmerge(pinouts, gpio(bankspec, "", ("C", 0), "C", 0, 24, 0))
    pinmerge(pinouts, ulpi(bankspec, "1", ('C', 0), "C", 1))
    pinmerge(pinouts, ulpi(bankspec, "2", ('C', 12), "C", 1))
    pinmerge(pinouts, spi(bankspec, "2", ('C', 8), "C", 2))
    #pinmerge(pinouts, spi(bankspec, "2", ('C', 28), "C", 2))
    pinmerge(pinouts, uartfull(bankspec, "0", ('C', 20), "C", 3))
    pinmerge(pinouts, eint(bankspec, "", ('C', 0), "C", 10, 8, mux=3))
    pinmerge(pinouts, jtag(bankspec, "2", ('C', 8), "C", 3))
    pinmerge(pinouts, eint(bankspec, "", ('C', 12), "C", 22, 8, mux=3))
    pinmerge(pinouts, uart(bankspec, "2", ('C', 22), "C", 2))
    pinmerge(pinouts, i2s(bankspec, "", ('C', 13), "C", 2))
    pinmerge(pinouts, pwm(bankspec, "2", ('C', 21), "C", mux=2))

    # Bank D, 72-96
    flexspec = {
        'FB_TS': ('FB_ALE', 2, "D"),
        'FB_CS2': ('FB_BWE2', 2, "D"),
        'FB_A0': ('FB_BWE2', 3, "D"),
        'FB_CS3': ('FB_BWE3', 2, "D"),
        'FB_A1': ('FB_BWE3', 3, "D"),
        'FB_TBST': ('FB_OE', 2, "D"),
        'FB_TSIZ0': ('FB_BWE0', 2, "D"),
        'FB_TSIZ1': ('FB_BWE1', 2, "D"),
    }
    #pinmerge(pinouts, mcu8080("", 72, "D", 1))
    pinmerge(pinouts, gpio(bankspec, "", ('D', 0), "D", 0, 24, 0))
    pinmerge(pinouts, flexbus1(bankspec, "", ('D', 0), "D", 1, spec=flexspec))
    pinmerge(pinouts, i2c(bankspec, "2", ('D', 17), "D", 2))
    pinmerge(pinouts, pwm(bankspec, "0", ('D', 21), "D", mux=1))
    pinmerge(pinouts, pwm(bankspec, "1", ('D', 22), "D", mux=1))
    pinmerge(pinouts, pwm(bankspec, "2", ('D', 23), "D", mux=1))
    pinmerge(pinouts, i2c(bankspec, "1", ('D', 10), "D", 3))
    pinmerge(pinouts, i2c(bankspec, "3", ('D', 19), "D", 2))
    pinmerge(pinouts, uartfull(bankspec, "0", ('D', 0), "D", 2))
    pinmerge(pinouts, uart(bankspec, "3", ('D', 21), "D", 2))
    pinmerge(pinouts, uart(bankspec, "4", ('D', 13), "D", 2))
    pinmerge(pinouts, eint(bankspec, "", ('D', 19), "D", 18, 4, mux=3))
    pinmerge(pinouts, eint(bankspec, "", ('D', 23), "D", 9, 1, mux=3))
    pinmerge(pinouts, eint(bankspec, "", ('D', 13), "D", 5, 4, mux=3))
    pinmerge(pinouts, eint(bankspec, "", ('D', 0), "D", 30, 2, mux=3))
    pinmerge(pinouts, i2c(bankspec, "2", ('D', 2), "D", 3))
    pinmerge(pinouts, sdmmc(bankspec, "2", ('D', 4), "D", 2))

    # Bank E
    pinmerge(pinouts, gpio(bankspec, "", ('E', 0), "E", 0, 24, 0))
    pinmerge(pinouts, flexbus2(bankspec, "", ('E', 0), "E", 1))
    pinmerge(pinouts, sdmmc(bankspec, "2", ('E', 0), "E", 2))
    pinmerge(pinouts, sdmmc(bankspec, "3", ('E', 8), "E", 2))
    pinmerge(pinouts, quadspi(bankspec, "3", ('E', 18), "E", 2))
    pinmerge(pinouts, uartfull(bankspec, "1", ('E', 14), "E", 2))
    pinmerge(pinouts, i2c(bankspec, "2", ('E', 6), "E", 2))
    pinmerge(pinouts, eint(bankspec, "", ('E', 0), "E", 10, 8, mux=3))
    pinmerge(pinouts, eint(bankspec, "", ('E', 8), "E", 22, 6, mux=3))
    pinmerge(pinouts, emmc(bankspec, "", ('E', 14), "E", 3))

    # Bank F
    pinmerge(pinouts, gpio(bankspec, "", ('F', 0), "F", 0, 10, 0))
    pinmerge(pinouts, i2s(bankspec, "", ('F', 0), "F", 1))
    pinmerge(pinouts, i2c(bankspec, "1", ('F', 6), "F", 2))
    pinmerge(pinouts, pwm(bankspec, "0", ('F', 8), "F", mux=2))
    pinmerge(pinouts, pwm(bankspec, "1", ('F', 9), "F", mux=2))
    pinmerge(pinouts, uart(bankspec, "4", ('F', 8), "F", 1))
    pinmerge(pinouts, sdmmc(bankspec, "3", ('F', 0), "F", 2))
    pinmerge(pinouts, eint(bankspec, "", ('F', 0), "F", 18, 4, mux=3))
    pinmerge(pinouts, pwm(bankspec, "2", ('F', 4), "F", mux=3))
    pinmerge(pinouts, eint(bankspec, "", ('F', 5), "F", 7, 1, mux=3))
    pinmerge(pinouts, eint(bankspec, "", ('F', 6), "F", 28, 4, mux=3))

    # Bank G
    pinmerge(pinouts, gpio(bankspec, "", ('G', 0), "G", 0, 32, 0))
    pinmerge(pinouts, rgmii(bankspec, "", ('G', 0), "G", 1))
    pinmerge(pinouts, ulpi(bankspec, "3", ('G', 20), "G", 1))
    pinmerge(pinouts, rgbttl(bankspec, "1", ('G', 0), "G", 2))
    pinmerge(pinouts, quadspi(bankspec, "3", ('G', 26), "G", 3))
    pinmerge(pinouts, flexbus2(bankspec, "", ('G', 0), "G", 3))
    mmc2 = sdmmc(bankspec, "2", ('G', 24), "G", 3, limit=2)
    pinmerge(pinouts, mmc2)
    mmc2 = sdmmc(bankspec, "2", ('G', 28), "G", 2, start=2)
    pinmerge(pinouts, mmc2)

    print "# Pinouts (PinMux)"
    print
    print "auto-generated by <span class="selflink">pinouts.py</span>"
    print
    print "
<div class="toc"></div>
"
    print
    display(pinouts)
    print

    print "# Pinouts (Fixed function)"
    print

    fixedpins = {
      'DDR3':
        ['SDQ0', 'SDQ1', 'SDQ2', 'SDQ3', 'SDQ4', 'SDQ5', 'SDQ6', 'SDQ7',
         'SDQ8', 'SDQ9', 'SDQ10', 'SDQ11', 'SDQ12', 'SDQ13', 'SDQ14', 'SDQ15',
         'SDQ16', 'SDQ17', 'SDQ18', 'SDQ19', 'SDQ20', 'SDQ21', 'SDQ22', 'SDQ23',
         'SDQ24', 'SDQ25', 'SDQ26', 'SDQ27', 'SDQ28', 'SDQ29', 'SDQ30', 'SDQ31',
         'SVREF0', 'SVREF1', 'SVREF2', 'SVREF3',
         'SDQS0', 'SDQS0#', 'SDQS1', 'SDQS1#',
         'SDQS2', 'SDQS2#', 'SDQS3', 'SDQS3#',
         'SDQM0', 'SDQM1', 'SDQM2', 'SDQM3',
         'SCK#', 'SCK', 'SCKE0', 'SCKE1',
         'SA0', 'SA1', 'SA2', 'SA3', 'SA4', 'SA5', 'SA6', 'SA7',
         'SA8', 'SA9', 'SA10', 'SA11', 'SA12', 'SA13', 'SA14',
         'SBA0', 'SBA1', 'SBA2',
         'SWE', 'SCAS', 'SRAS',
         'SCS0', 'SCS1',
         'SZQ', 'SRST',
         'SDBG0', 'SDBG1', 'ADBG',
         'ODT0', 'ODT1'
        ],

      'CTRL_SYS':
        [
        'TEST', 'JTAG_SEL', 'UBOOT_SEL', 
        'NMI#', 'RESET#', 
        'CLK24M_IN', 'CLK24M_OUT', 
        'PLLTEST', 'PLLREGIO', 'PLLVP25', 
        'PLLDV', 'PLLVREG', 'PLLGND', 
       ],

      'POWER_DRAM':
        ['VCC0_DRAM', 'VCC1_DRAM', 'VCC2_DRAM', 'VCC3_DRAM', 'VCC4_DRAM', 
         'VCC5_DRAM', 'VCC6_DRAM', 'VCC7_DRAM', 'VCC8_DRAM', 'VCC9_DRAM',
        'GND0_DRAM', 'GND1_DRAM', 'GND2_DRAM', 'GND3_DRAM', 'GND4_DRAM',
        'GND5_DRAM', 'GND6_DRAM', 'GND7_DRAM', 'GND8_DRAM', 'GND9_DRAM',
        ],

      'POWER_CPU':
        ['VDD0_CPU', 'VDD1_CPU', 'VDD2_CPU', 'VDD3_CPU', 'VDD4_CPU', 'VDD5_CPU',
         'GND0_CPU', 'GND1_CPU', 'GND2_CPU', 'GND3_CPU', 'GND4_CPU', 'GND5_CPU',
        ],

      'POWER_DLL':
        ['VDD0_DLL', 'VDD1_DLL', 'VDD2_DLL', 
         'GND0_DLL', 'GND1_DLL', 'GND2_DLL', 
        ],

      'POWER_INT':
        ['VDD0_INT', 'VDD1_INT', 'VDD2_INT', 'VDD3_INT', 'VDD4_INT', 
         'VDD5_INT', 'VDD6_INT', 'VDD7_INT', 'VDD8_INT', 'VDD9_INT', 
         'GND0_INT', 'GND1_INT', 'GND2_INT', 'GND3_INT', 'GND4_INT', 
         'GND5_INT', 'GND6_INT', 'GND7_INT', 'GND8_INT', 'GND9_INT', 
        ],

      'POWER_GPIO':
        ['VDD_GPIOA', 'VDD_GPIOB', 'VDD_GPIOC',
         'VDD_GPIOD', 'VDD_GPIOE', 'VDD_GPIOF',
         'VDD_GPIOG',
         'GND_GPIOA', 'GND_GPIOB', 'GND_GPIOC',
         'GND_GPIOD', 'GND_GPIOE', 'GND_GPIOF', 
         'GND_GPIOG',
        ]

      }

    display_fixed(fixedpins, len(pinouts))

    print "# Functions (PinMux)"
    print
    print "auto-generated by <span class="selflink">pinouts.py</span>"
    print

    function_names = {'EINT': 'External Interrupt',
                      'FB': 'MC68k FlexBus',
                      'IIS': 'I2S Audio',
                      'JTAG1': 'JTAG (same as JTAG2, JTAG_SEL=LOW)',
                      'JTAG2': 'JTAG (same as JTAG1, JTAG_SEL=HIGH)',
                      'LCD': '24-pin RGB/TTL LCD',
                      'RG': 'RGMII Ethernet',
                      'MMC': 'eMMC 1/2/4/8 pin',
                      'PWM': 'PWM (pulse-width modulation)',
                      'SD1': 'SD/MMC 1',
                      'SD2': 'SD/MMC 2',
                      'SD3': 'SD/MMC 3',
                      'SPI1': 'SPI (Serial Peripheral Interface) 1',
                      'SPI2': 'SPI (Serial Peripheral Interface) 2',
                      'SPI3': 'Quad SPI (Serial Peripheral Interface) 3',
                      'TWI1': 'I2C 1',
                      'TWI2': 'I2C 2',
                      'TWI3': 'I2C 3',
                      'UART0': 'UART (TX/RX/CTS/RTS) 0',
                      'UART1': 'UART (TX/RX/CTS/RTS) 1',
                      'UART2': 'UART (TX/RX) 2',
                      'UART3': 'UART (TX/RX) 3',
                      'UART4': 'UART (TX/RX) 4',
                      'ULPI1': 'ULPI (USB Low Pin-count) 1',
                      'ULPI2': 'ULPI (USB Low Pin-count) 2',
                      'ULPI3': 'ULPI (USB Low Pin-count) 3',
                    }
            
    fns = display_fns(bankspec, pinouts, function_names)
    print

    # Scenarios below can be spec'd out as either "find first interface"
    # by name/number e.g. SPI1, or as "find in bank/mux" which must be
    # spec'd as "BM:Name" where B is bank (A-F), M is Mux (0-3)
    # EINT and PWM are grouped together, specially, but may still be spec'd
    # using "BM:Name".  Pins are removed in-order as listed from
    # lists (interfaces, EINTs, PWMs) from available pins.

    # EOMA68 scenario.  not totally complete (some GPIO needed for PMIC)
    # One interface to be connected to the MCU to give RTC and boot/dbg
    # VBUS_EN, OTG_ID etc. are all not included below, there is plenty
    # of spare GPIO.

    eoma68 = ['B1:LCD/22', 'ULPI1/8', 'ULPI2', 'MMC', 'SD1', 'UART3',
              'TWI3', 'SPI2', 'E2:SD2',]
    eoma68_eint = ['EINT16', 'EINT17', 'EINT18', 'EINT19']
    eoma68_pwm = ['D1:PWM_2']
    descriptions = {
            'MMC': 'internal (on Card)',
            'SD1': 'user-facing: internal (on Card), multiplexed with JTAG1\n'
                   'and UART2, for debug purposes',
            'TWI3': 'EOMA68-compliance: must be entirely free of devices.\n'
                    'Address 0x51 used (externally) for EOMA68 EEPROM Id',
            'E2:SD2': 'EOMA68-compliance',
            'SPI2': 'EOMA68-compliance',
            'UART3': 'EOMA68-compliance',
            'B1:LCD/22': 'EOMA68-compliance, 18-bit RGB/TTL LCD',
            'ULPI1/8': 'user-facing: internal (on Card), USB-OTG ULPI PHY',
            'ULPI2': 'EOMA68-compliance: dual USB2 Host ULPI PHY'
    }

    unused_pins = check_functions("EOMA68", bankspec, fns, pinouts,
                 eoma68, eoma68_eint, eoma68_pwm,
                 descriptions)

    # Industrial scenario.  not totally complete (some GPIO needed for PMIC)
    # One interface to be connected to the MCU to give RTC, boot/dbg,
    # option of CAN Bus, ADC, DAC, OWB, more GPIO, more PWM etc. etc.
    # Focus is on getting as many UARTs, SPIs and TWIs as possible.
    # OTG_ID (if to be used) would require dropping some functions in order
    # to free up GPIO.  LCD could be reduced to 15-bit (freeing 3).
    # MMC could be reduced to 4-bit-wide, used as SD/MMC (freeing 4).
    # SPI3 could be used in 1-bit (MOSI/MISO) mode (freeing up 2 more).

    industrial = ['D1:FB/17', 'E1:FB/8', 'B1:LCD/22', 'ULPI1/8', 'ULPI2/8',
                'MMC', 'B2:SD1',
                'JTAG1', 'A3:UART2', 'E2:UART1', 'C3:UART0',
              'F2:TWI1', 'D2:TWI2', 'D2:TWI3', 'SPI2', 'SPI3', 'F2:SD3']
    industrial_pwm = ['F2:PWM_0', 'F2:PWM_1', 'D1:PWM_2']
    industrial_eint = ['EINT24', 'EINT25', 'EINT26', 'EINT27',
                       'EINT20', 'EINT21', 'EINT22', 'EINT23']

    unused_pins = check_functions("Industrial", bankspec, fns, pinouts,
                 industrial, industrial_eint, industrial_pwm)

    # Industrial scenario, using an SPI-based LCD instead of RGB/TTL
    # not totally complete (some GPIO needed for PMIC)
    # One interface to be connected to the MCU to give RTC, boot/dbg,
    # option of CAN Bus, ADC, DAC, OWB, more GPIO, more PWM etc. etc.
    # Focus is on getting as many UARTs, SPIs and TWIs as possible,
    # leaving some GPIO spare from the RGB/TTL bank (SPI CS#)
    # also possibility of freeing up FlexBus CS# with a little reorg.

    industrial = ['D1:FB/17', 'E1:FB/8', 'B2:SPI1', 'ULPI1/8', 'ULPI2/8',
                'MMC', 'B2:SD1',
                'JTAG1',
                'A3:UART2', 'E2:UART1', 'C3:UART0', 'B2:UART4', 'B2:UART3',
              'F2:TWI1', 'D2:TWI2', 'D2:TWI3', 'SPI2', 'SPI3', 'F2:SD3']
    industrial_pwm = ['F2:PWM_0', 'F2:PWM_1', 'D1:PWM_2']
    industrial_eint = ['EINT24', 'EINT25', 'EINT26', 'EINT27',
                       'EINT20', 'EINT21', 'EINT22', 'EINT23']
    ind_descriptions = {
            'B2:SPI1': 'Used for 320x240 or 640x480 etc. SPI-based LCD.\n'
                        'Frees up large numbers of GPIO from RGB/TTL bank'
    }
    unused_pins = check_functions("Industrial with SPI-LCD",
                 bankspec, fns, pinouts,
                 industrial, industrial_eint, industrial_pwm,
                 ind_descriptions)

    # Smartphone / Tablet - basically the same thing

    tablet = ['B1:LCD/22', 'ULPI1/8', 'ULPI2/8',
                'MMC', 'SD1',
                'F1:IIS', # I2C Audio
                'TWI2',   # I2C Audio
                'E2:UART1', # WIFI/BT 
                'E2:SD2',   # WIFI
                'C3:UART0', # GPS
                'D2:UART3', 
                'D2:UART4', 
              'D3:TWI1', 'D2:TWI3', 'SPI2', 'SPI3']
    tablet_pwm = ['F2:PWM_0', # LCD_BACKLIGHT
                  'F2:PWM_1', 'D1:PWM_2']
    tablet_eint = ['EINT24', # BT_HOST_WAKE
                   'EINT25', # WIFI_HOST_WAKE 
                   'EINT26', # CTP_INT
                    'EINT27', # GSENSOR_INT
                    'EINT8', # GPS_INT
                    'EINT7', # TILT_SENSOR_INT
                    'EINT22', # COMPASS_INT
                    'EINT23',  # MCU_INT
                    'EINT16', # PMIC_INT
                    'EINT17',  # PWR_BUTTON_INT
                    'EINT30', # OTG_ID
                    'EINT31',
                ]
    descriptions = {
        'B1:LCD/22':
             'RGB/TTL LCD, 800x480 or use SN75LVDS83b for up to 1440x900',
        'MMC': 'eMMC: main internal storage',
        'ULPI1/8': 'USB-OTG, connect to ULPI OTG PHY (for charging)\n'
                   'as well as USB Host or USB Device',
        'ULPI2/8': 'USB2 Host, connect to ULPI PHY w/and 4-port USB2 Hub\n'
                    'for example GL850G or FE1.1. '
                    'Connects to 2/3/4G/LTE Modem, 2x USB-Camera (VC0345)',
        'SD1': 'internal, multiplexed with JTAG1\n'
               'and UART2, for debug purposes',
        'F1:IIS': 'I2C Audio, connect to AC97 Audio IC',
        'TWI2': 'Connect to AC97 Audio IC',
        'E2:UART1': 'Connect to BT on AP6234/AP6335',
        'E2:SD2': 'Connect to WIFI on AP6234/AP6335',
        'SPI3': 'Boot Storage (connection to companion / debug / boot MCU)\n'
                'Only actually needs MISO/MOSI, bootstrap loader v. small\n'
                'Bootstrap loader checks eMMC, USB-OTG, SD/MMC, SPI, etc.',
        'SPI2': 'Spare? SPI, connect to higher-speed sensor?',
        'D2:UART3': 'Spare? UART (or 2 extra GPIO / EINT)',
        'D2:UART4': 'Spare? UART (or 2 extra GPIO)',
        'D3:TWI1': 'Connect to PMIC',
        'D2:TWI3': 'Connect to sensors (Trackpad? CTP GSENSOR TILT COMPASS)',
        'GPIO': '9 spare GPIO pins for miscellaneous functions:\n'
                'wake-up of BT, WIFI, LCD power, sensor power etc.\n'
                '4 GPIO may be needed for PWM Audio from Modem.\n'
                'LED lights for camera will be needed.\n'
                'Some phones may have clam-shell or lid switch.\n'
                'Some Modems have spare GPIO (over AT commandset).\n'
                'AXP209 PMIC has 4x GPIO, accessible over I2C.\n'
                'SPI2, UART3-4, PWM1-2 may also be spare (10 extra GPIO).\n'
                'If more needed, companion MCU may be used (48+ pin variant)\n'
                'which also includes ADC, DAC, more PWM etc.',
        'F2:PWM_0': 'LCD Backlight',
        'F2:PWM_1': 'Spare? PWM (or extra GPIO / EINT)',
        'D1:PWM_2': 'Spare? PWM (or extra GPIO / EINT)',
        'EINT24': 'BT_HOST_WAKE',
        'EINT25': 'WIFI_HOST_WAKE',
        'EINT26': 'CTP_INT',
        'EINT27': 'GSENSOR_INT',
        'EINT8': 'GPS_INT',
        'EINT7': 'TILT_SENSOR_INT',
        'EINT22': 'COMPASS_INT',
        'EINT23': 'MCU_INT',
        'EINT16': 'PMIC_INT',
        'EINT17': 'PWR_BUTTON_INT',
        'EINT30': 'OTG_ID',
        'EINT31': 'Spare?',
    }
    unused_pins = check_functions("Smartphone / Tablet",
                 bankspec, fns, pinouts,
                 tablet, tablet_eint, tablet_pwm,
                 descriptions)

    # Laptop

    laptop = ['D1:FB/17', 'E1:FB/8', 'B1:LCD/22', 'ULPI1/8', 'ULPI2/8',
                'MMC', 'SD1',
                'F1:IIS', # I2C Audio
                'TWI2',   # I2C Audio
                'E2:UART1', # WIFI/BT 
                'E2:SD3',   # WIFI
              'D2:TWI3', 'SPI3']
    laptop_pwm = ['F2:PWM_0', # LCD_BACKLIGHT
                 ]
    laptop_eint = ['EINT20', # BT_HOST_WAKE
                   'EINT21', # WIFI_HOST_WAKE 
                    'EINT9',  # MCU_INT
                    'EINT31', # PMIC_INT
                ]
    descriptions = {
        'D1:FB/17': 'FlexBus.  Connect to DM9000 or AX99896A MCU-style Bus\n'
                    '10/100 Ethernet PHY.',
        'E1:FB/8': 'FlexBus bus bits 8-15, needed to make a 16-bit bus width',
        'B1:LCD/22':
             'RGB/TTL LCD, use SN75LVDS83b for LVDS or SSD2828 for MIPI,\n'
             'or a Chrontel CH7039, CH7038, CH7034 or CH7018 for dual\n'
             'display output (eDP/LVDS and HDMI/VGA) '
             'conversion.',
        'MMC': 'eMMC: main internal storage',
        'ULPI1/8': 'USB-OTG, connect to ULPI OTG PHY (for charging)\n'
                   'as well as USB Host or USB Device',
        'ULPI2/8': 'USB2 Host, connect to ULPI PHY w/and 4-port USB2 Hub\n'
                    'for example GL850G or FE1.1. '
                    'Connects to USB-Camera (VC0345 and 3x external USB Ports)',
        'SD1': 'internal, multiplexed with JTAG1\n'
               'and UART2, for debug purposes',
        'F1:IIS': 'I2C Audio, connect to AC97 Audio IC',
        'TWI2': 'Connect to AC97 Audio IC',
        'E2:UART1': 'Connect to BT on AP6234/AP6335',
        'E2:SD3': 'Connect to WIFI on AP6234/AP6335',
        'SPI3': 'Boot Storage (connection to companion / debug / boot MCU)\n'
                'Only actually needs MISO/MOSI, bootstrap loader v. small\n'
                'Bootstrap loader checks eMMC, USB-OTG, SD/MMC, SPI, etc.\n'
                'MCU implements keyboard-matrix for keyboard (also trackpad?)',
        'D2:TWI3': 'Connect to PMIC',
        'GPIO': 'Plenty of spare GPIO pins for miscellaneous functions\n'
                'MCU EINT-capable GPIO may be used to generate extra EINTs\n'
                'on the single MCU_INT line, if really needed',
        'F2:PWM_0': 'LCD Backlight',
        'EINT20': 'BT_HOST_WAKE',
        'EINT21': 'WIFI_HOST_WAKE',
        'EINT9': 'MCU_INT',
        'EINT31': 'PMIC_INT',
    }
    unused_pins = check_functions("Laptop / Netbook",
                 bankspec, fns, pinouts,
                 laptop, laptop_eint, laptop_pwm,
                 descriptions)

    # IoT

    iot = ['B1:LCD', 'ULPI2/8', 'ULPI1/8',
                'MMC', 'SD1',
                'F1:IIS', # I2C Audio
                #'TWI2',   # I2C Audio
                'C3:UART0', # HSPA UART
                'E2:UART1', # BT UART
                'C2:SPI2', # HSPI SPI
                'E2:SD3',   # WIFI
                'D3:TWI1', # sensors CTP,
              'D2:TWI3', 'SPI3']
    iot_pwm = ['F2:PWM_0', # LCD_BACKLIGHT
                 ]
    iot_eint = [ 'EINT5', # 'HSPA_MST_RDY',
                'EINT6', # 'HSPA_SL_RDY',
                'EINT7', # 'HSPA_RING',
                'EINT8', # 'WL_PMU_EN',
                'EINT9', # HSPA_GPIO1
                'EINT10', # IR_DT
                'EINT11', # 'BT_PCM_CLK',
                'EINT12', # 'BT_PCM_DIN',
                'EINT13', # 'BT_PCM_SYNC',
                'EINT14', # 'BT_PCM_DOUT',
                'EINT16', # 'USB_DRVVBUS',
                'EINT17', # 'USB_VBUSDET',
                'EINT21', # 'USB_ID',
                'EINT30', # 'CTP_INT',
                'EINT31', # 'SD_DET#',
                ]
    descriptions = {
        'B1:LCD':
             'RGB/TTL LCD, use SN75LVDS83b for LVDS or SSD2828 for MIPI,\n'
             'or a Chrontel CH7039, CH7038, CH7034 or CH7018 for dual\n'
             'display output (eDP/LVDS and HDMI/VGA) '
             'conversion.',
        'MMC': 'eMMC: main internal storage',
        'F1:IIS': 'I2C Audio, connect to AC97 Audio IC',
        'ULPI2/8': 'USB-OTG, connect to ULPI OTG PHY (for charging)\n'
                   'as well as USB Host or USB Device',
        'ULPI1/8': 'USB2 Host, connect to ULPI PHY',
        'SD1': 'internal, multiplexed with JTAG1\n'
               'and UART2, for debug purposes',
        'C3:UART0': 'Connect to HSPA UART',
        'E2:UART1': 'Connect to BT UART',
        'E2:SD3': 'Connect to WIFI',
        'C2:SPI2': 'HSPA SPI',
        'SPI3': 'Boot Storage (connection to companion / debug / boot MCU)\n'
                'Only actually needs MISO/MOSI, bootstrap loader v. small\n'
                'Bootstrap loader checks eMMC, USB-OTG, SD/MMC, SPI, etc.\n'
                'MCU implements keyboard-matrix for keyboard (also trackpad?)',
        'D2:TWI3': 'Connect to PMIC',
        'D3:TWI1': 'Connect to sensors CTP',
        'GPIO': 'Plenty of spare GPIO pins for miscellaneous functions\n'
                'MCU EINT-capable GPIO may be used to generate extra EINTs\n'
                'on the single MCU_INT line, if really needed',
        'F2:PWM_0': 'LCD Backlight',
        'GPIOD4': 'WL_WAKE_AP',
        'GPIOD5': 'BT_WAKE_AP',
        'GPIOD6': 'AP_WAKE_BT',
        'GPIOD7': 'AP_CK32KO',
        'GPIOD8': 'HSPA_PWRON',
        'GPIOD9': 'BT_RST_N',
        'GPIOE5': 'HSPA_ON_OFF',
        'GPIOD2': 'HSPA_SHUTDOWN',
        'GPIOD3': 'CTP_RST',
        'GPIOD12': 'LCD_RDN',
        'GPIOD17': 'LCD_WRN',
        'GPIOD18': 'LCD_RS',
        'GPIOD21': 'LCD_CSN',

        'EINT5': 'HSPA_MST_RDY',
        'EINT6': 'HSPA_SL_RDY',
        'EINT7': 'HSPA_RING',
        'EINT8': 'WL_PMU_EN',
        'EINT9': 'HSPA_GPIO1',
        'EINT10': 'IR_DT',
        'EINT11': 'BT_PCM_CLK',
        'EINT12': 'BT_PCM_DIN',
        'EINT13': 'BT_PCM_SYNC',
        'EINT14': 'BT_PCM_DOUT',

        'EINT16': 'USB_DRVVBUS',
        'EINT17': 'USB_VBUSDET',
        'EINT21': 'USB_ID',
        'EINT30': 'CTP_INT',
        'EINT31': 'SD_DETN',
    }
    unused_pins = check_functions("IoT",
                 bankspec, fns, pinouts,
                 iot, iot_eint, iot_pwm,
                 descriptions)

    print "# Reference Datasheets"
    print
    print "datasheets and pinout links"
    print
    print "* <http://datasheets.chipdb.org/AMD/8018x/80186/amd-80186.pdf>"
    print "* <http://hands.com/~lkcl/eoma/shenzen/frida/FRD144A2701.pdf>"
    print "* <http://pinouts.ru/Memory/sdcard_pinout.shtml>"
    print "* p8 <http://www.onfi.org/~/media/onfi/specs/onfi_2_0_gold.pdf?la=en>"
    print "* <https://www.heyrick.co.uk/blog/files/datasheets/dm9000aep.pdf>"
    print "* <http://cache.freescale.com/files/microcontrollers/doc/app_note/AN4393.pdf>"
    print "* <https://www.nxp.com/docs/en/data-sheet/MCF54418.pdf>"
    print "* ULPI OTG PHY, ST <http://www.st.com/en/interfaces-and-transceivers/stulpi01a.html>"
    print "* ULPI OTG PHY, TI TUSB1210 <http://ti.com/product/TUSB1210/>"