include extra pin image and package marking
[pinmux.git] / src / spec / ifaceprint.py
index 04a79012f474c7a65259573fed17be4be6e089be..bdb7134b91d5e75a327b30cf1c787746cc1fd63a 100644 (file)
@@ -3,6 +3,53 @@
 from copy import deepcopy
 from collections import OrderedDict
 from math import pi
+import os
+import base64
+
+cwd = os.path.split(os.path.abspath(__file__))[0]
+lead_drawing = cwd + "/greatek_qfp_128L.png"
+pack_drawing = cwd + "/greatek_qfp_128_fp.png"
+
+def bond_int_to_ext(pin, bank):
+    """ note that internal numbering is 0-31 whereas the DISPLAY internal
+        numbering is 1-32.  this uses the INTERNAL numbering.
+
+        side: N S E W
+
+        outer ring numbers: the python list order of the outer pads
+        middle numbers: the package number wires (plus side they are on)
+        inner numbers:  the IO pad *python internal (0-31)* numbers plus side
+
+       0     1   2      3   N  34     35   36   37
+      N102 N101 N100    99  N  68    N67  N66  N65
+      W29  W30  W31     N0  N N31    E29  E30  E31
+
+    25  103 W28                       E28  64 25
+     W    W  W                         E  E   E
+     0  128 W3                        E3  39  0
+
+      W2  W1   W0      S0   S S31    E0   E1   E2
+      S1  S2   S3       4   S  35    S36  S37  S38
+       0     1   2      3   S  34     35   36   37
+
+    """
+    # returns side, order-on-the-side, pin number
+    if bank == 'N':
+        return 'N', pin+3, 99-pin
+    if bank == 'S':
+        return 'S', pin+3, 4+pin
+    if bank == 'W':
+        if pin >= 29: # 29, 30, 31
+            return 'N', pin-29, 100+(31-pin)
+        if pin <= 2: # 0, 1, 2
+            return 'S', 2-pin, 3-pin
+        return 'W', 28-pin, 103+(28-pin)
+    if bank == 'E':
+        if pin >= 29:
+            return 'N', 35+(31-pin), 67-(31-pin)
+        if pin <= 2:
+            return 'S', pin+35, 36+pin
+        return 'E', 28-pin, 39+(pin-3)
 
 
 def create_sv(fname, pins):
@@ -15,33 +62,70 @@ def create_sv(fname, pins):
         print ("WARNING, no SVG image, not producing image %s" % fname)
         return
 
+    # create internal to external map
+    bondmap = {'N': {}, 'S': {},  'E': {},  'W': {} }
+    padside = {'pads.north': 'N', 'pads.east': 'E', 'pads.south': 'S',
+               'pads.west': 'W'}
+    sidepad = {}
+    for pinpad, bank in padside.items():
+        sidepad[bank] = pinpad
+        for ipin in range(len(pins[pinpad])):
+            eside, enum, epinnum = bond_int_to_ext(ipin, bank)
+            bondmap[eside][enum] = (epinnum, ipin, bank)
+    with open("/tmp/bondmap.txt", "w") as f:
+        for k,v in bondmap.items():
+            f.write("%s\n" % k)
+            for enum, (epinnum, ipin, bank) in v.items():
+                f.write("    %d %d  -> %s %d\n" % (enum, epinnum, bank, ipin))
+
     scale = 15
+    outerscale = scale * 2.0
+
     width = len(pins['pads.north']) * scale
     height = len(pins['pads.east']) * scale
-    woffs = scale*18#-width/2
-    hoffs = scale*18#-height/2
+    woffs = scale*40#-width/2
+    hoffs = scale*40#-height/2
+
+    nepads = bondmap['N'].keys()
+    nepads.sort()
+    wepads = bondmap['W'].keys()
+    wepads.sort()
+    eepads = bondmap['E'].keys()
+    eepads.sort()
+    sepads = bondmap['S'].keys()
+    sepads.sort()
+
+    owoffs = woffs + (width/2) - len(nepads)/2 * outerscale
+    ohoffs = hoffs + (height/2) - len(wepads)/2 * outerscale
 
     dwg = svgwrite.Drawing(fname, profile='full',
-                           size=(width+scale*40, height+scale*40))
+                           size=(width+scale*85, height+scale*80))
+
+    # outer QFP rect
+    dwg.add(dwg.rect((owoffs-scale*2.5, ohoffs-scale*4.5),
+                        (len(nepads)*outerscale+scale*9,
+                         len(wepads)*outerscale+scale*13),
+            fill='white',
+            stroke=svgwrite.rgb(0, 128, 0, '%'),
+            stroke_width=scale/5.0))
+
+    # inner lead rect
     dwg.add(dwg.rect((woffs-scale*2, hoffs-scale*2),
-                        (woffs+width-scale*12, hoffs+height-scale*12),
+                        (width+scale*6, height+scale*6),
             stroke=svgwrite.rgb(16, 255, 16, '%'),
             stroke_width=scale/10.0))
 
-    dwg.add(dwg.text("Libre-SOC ls180 QFP-128",
-                       insert=(woffs+width/2-scale*5, woffs+height/2),
-                     fill='white'))
-    dwg.add(dwg.text("In collaboration with LIP6.fr",
-                       insert=(woffs+width/2-scale*5, woffs+height/2+scale),
-                     fill='white'))
-    dwg.add(dwg.text("Cell Libraries by Chips4Makers",
-                       insert=(woffs+width/2-scale*5, woffs+height/2+scale*2),
-                     fill='white'))
+    # record the inner line (iopad) position so that the outer one can
+    # match with it
+    innerpos = {'N': {}, 'S': {},  'E': {},  'W': {} }
 
+    # create the inner diagram
     for i, pin in enumerate(pins['pads.west']):
         ht = hoffs + height - (i * scale) + scale*0.5
+        endline = (woffs-scale*4.5, ht-scale*0.5)
+        innerpos['W'][i] = endline
         dwg.add(dwg.line((woffs-scale*2, ht-scale*0.5),
-                         (woffs-scale*4.5, ht-scale*0.5),
+                         endline,
                          stroke=svgwrite.rgb(16, 255, 16, '%'),
                          stroke_width=scale/10.0))
         dwg.add(dwg.text(pin.upper(), insert=(woffs-scale*14, ht),
@@ -52,8 +136,10 @@ def create_sv(fname, pins):
     for i, pin in enumerate(pins['pads.east']):
         ht = hoffs + height - (i * scale) + scale*0.5
         wd = width + woffs + scale*2
+        endline = (wd+scale*4.5, ht-scale*0.5)
+        innerpos['E'][i] = endline
         dwg.add(dwg.line((wd+scale*2, ht-scale*0.5),
-                         (wd+scale*4.5, ht-scale*0.5),
+                         endline,
                          stroke=svgwrite.rgb(16, 255, 16, '%'),
                          stroke_width=scale/10.0))
         dwg.add(dwg.text(pin.upper(), insert=(wd+scale*5, ht-scale*0.25),
@@ -63,8 +149,10 @@ def create_sv(fname, pins):
 
     for i, pin in enumerate(pins['pads.north']):
         wd = woffs + i * scale + scale*1.5
+        endline = (wd, hoffs-scale*4.5)
+        innerpos['N'][i] = endline
         dwg.add(dwg.line((wd, hoffs-scale*2),
-                         (wd, hoffs-scale*4.5),
+                         endline,
                          stroke=svgwrite.rgb(16, 255, 16, '%'),
                          stroke_width=scale/10.0))
         pos=(wd, hoffs-scale*5.0)
@@ -79,8 +167,10 @@ def create_sv(fname, pins):
     for i, pin in enumerate(pins['pads.south']):
         wd = woffs + i * scale + scale*1.5
         ht = hoffs + height + scale*2
+        endline = (wd, ht+scale*4.5)
+        innerpos['S'][i] = endline
         dwg.add(dwg.line((wd, ht+scale*2),
-                         (wd, ht+scale*4.5),
+                         endline,
                          stroke=svgwrite.rgb(16, 255, 16, '%'),
                          stroke_width=scale/10.0))
         pos=(wd-scale*0.25, ht+scale*5.0)
@@ -92,6 +182,163 @@ def create_sv(fname, pins):
         txt.rotate(90, pos)
         dwg.add(txt)
 
+    # north outer pads
+    for i in nepads:
+        (epinnum, ipin, bank) = pad = bondmap['N'][i]
+        wd = owoffs + i * outerscale + outerscale*1.5
+        endline = (wd, ohoffs-outerscale*2)
+        startline = innerpos[bank][ipin]
+        dwg.add(dwg.line(startline,
+                         endline,
+                         stroke=svgwrite.rgb(255, 16, 16, '%'),
+                         stroke_width=scale/10.0))
+        pin = pins[sidepad[bank]][ipin]
+        pos=(wd, ohoffs-outerscale*4.0)
+        txt = dwg.text("%s (%s%d)" % (pin.upper(), bank, ipin+1),
+                        insert=pos, fill='black')
+        txt.rotate(-90, pos)
+        dwg.add(txt)
+        pos=(wd, ohoffs-outerscale*2.5)
+        txt = dwg.text("%d N" % epinnum, insert=pos, fill='blue')
+        txt.rotate(-90, pos)
+        dwg.add(txt)
+
+    # west outer pads
+    for i in wepads:
+        (epinnum, ipin, bank) = pad = bondmap['W'][i]
+        ht = ohoffs + (i * outerscale) + outerscale*1.5
+        endline = (owoffs+outerscale*0.5, ht)
+        startline = innerpos[bank][ipin]
+        dwg.add(dwg.line(startline,
+                         endline,
+                         stroke=svgwrite.rgb(255, 16, 16, '%'),
+                         stroke_width=scale/10.0))
+        pin = pins[sidepad[bank]][ipin]
+        pos = (owoffs-outerscale*6.0, ht)
+        dwg.add(dwg.text("%s (%s%d)" % (pin.upper(), bank, ipin+1),
+                         pos,
+                         fill='black'))
+        pos = (owoffs-outerscale*1.0, ht)
+        dwg.add(dwg.text("%d W" % epinnum, insert=pos,
+                            fill='blue'))
+
+    # south outer pads
+    for i in sepads:
+        (epinnum, ipin, bank) = pad = bondmap['S'][i]
+        wd = owoffs + i * outerscale + outerscale*1.5
+        ht = ohoffs + len(wepads)*outerscale + outerscale*4
+        endline = (wd, ht)
+        startline = innerpos[bank][ipin]
+        dwg.add(dwg.line(startline,
+                         endline,
+                         stroke=svgwrite.rgb(255, 16, 16, '%'),
+                         stroke_width=scale/10.0))
+        pin = pins[sidepad[bank]][ipin]
+        pos=(wd-outerscale*0.25, ht+outerscale*1.5)
+        txt = dwg.text("%s (%s%d)" % (pin.upper(), bank, ipin+1),
+                        insert=pos, fill='black')
+        txt.rotate(90, pos)
+        dwg.add(txt)
+        pos=(wd-outerscale*0.25, ht+outerscale*0.5)
+        txt = dwg.text("%d S" % epinnum, insert=pos, fill='blue')
+        txt.rotate(90, pos)
+        dwg.add(txt)
+
+    # east outer pads
+    for i in eepads:
+        (epinnum, ipin, bank) = pad = bondmap['E'][i]
+        ht = ohoffs + (i * outerscale) + outerscale*1.5
+        wd = owoffs+len(nepads)*outerscale + outerscale*1
+        endline = (wd+outerscale*0.5, ht)
+        startline = innerpos[bank][ipin]
+        dwg.add(dwg.line(startline,
+                         endline,
+                         stroke=svgwrite.rgb(255, 16, 16, '%'),
+                         stroke_width=scale/10.0))
+        pin = pins[sidepad[bank]][ipin]
+        pos = (wd+outerscale*2.5, ht)
+        dwg.add(dwg.text("%s (%s%d)" % (pin.upper(), bank, ipin+1),
+                         pos,
+                         fill='black'))
+        pos = (wd+outerscale*1.0, ht)
+        dwg.add(dwg.text("%d E" % epinnum, insert=pos,
+                            fill='blue'))
+
+    # add QFP pack image in top-right
+    image_data = open(pack_drawing, "rb").read()
+    encoded = base64.b64encode(image_data).decode()
+    data = 'data:image/png;base64,{}'.format(encoded)
+    pos=(0, 0)
+    leads = svgwrite.image.Image(data, pos,
+                                       size=(327,300))
+    dwg.add(leads)
+    dwg.add(dwg.text("GREATEK QFP128L",
+                       insert=(50,150),
+                        font_size=20,
+                     fill='black'))
+    dwg.add(dwg.text("D/W J1-03128-001",
+                       insert=(50,180),
+                        font_size=20,
+                     fill='black'))
+
+
+    # add QFP lead image in centre
+    image_data = open(lead_drawing, "rb").read()
+    encoded = base64.b64encode(image_data).decode()
+    data = 'data:image/png;base64,{}'.format(encoded)
+    pos=(woffs+scale*3.5, hoffs+scale*3.5)
+    leads = svgwrite.image.Image(data, pos,
+                                       size=(400,400))
+    leads.rotate(-90, (pos[0]+200, pos[1]+200))
+    dwg.add(leads)
+
+    dwg.add(dwg.text("GREATEK ELECTRONICS INC.",
+                       insert=(woffs+width/2-scale*5, woffs+height/2-scale*6),
+                     fill='black'))
+    dwg.add(dwg.text("INNER LEAD DRAWING",
+                       insert=(woffs+width/2-scale*5, woffs+height/2-scale*5),
+                     fill='black'))
+    dwg.add(dwg.text("QFP 128L OPEN STAMPING",
+                       insert=(woffs+width/2-scale*5, woffs+height/2-scale*4),
+                     fill='black'))
+    dwg.add(dwg.text("BODY 14x20x2.75mm",
+                       insert=(woffs+width/2-scale*5, woffs+height/2-scale*3),
+                     fill='black'))
+    dwg.add(dwg.text("L/F PAD SIZE 236x236mil^2",
+                       insert=(woffs+width/2-scale*5, woffs+height/2-scale*2),
+                     fill='black'))
+
+    # add attribution
+    dwg.add(dwg.text("Libre-SOC ls180 QFP-128",
+                       insert=(woffs+width/2-scale*5, woffs+height/2),
+                     fill='black'))
+    dwg.add(dwg.text("In collaboration with LIP6.fr",
+                       insert=(woffs+width/2-scale*5, woffs+height/2+scale),
+                     fill='black'))
+    dwg.add(dwg.text("Cell Libraries by Chips4Makers",
+                       insert=(woffs+width/2-scale*5, woffs+height/2+scale*2),
+                     fill='black'))
+    dwg.add(dwg.text("IMEC TSMC 180nm",
+                       insert=(woffs+width/2-scale*5, woffs+height/2+scale*3),
+                     fill='black'))
+
+    # add package marking circles
+    pos = (owoffs-outerscale*0, ohoffs+len(wepads)*outerscale+outerscale*2.5)
+    dwg.add(dwg.circle(pos, scale*2,
+                         fill='white',
+                         stroke=svgwrite.rgb(16, 16, 16, '%'),
+                         stroke_width=scale/5.0))
+    dwg.add(dwg.circle(pos, scale*1,
+                         fill='black',
+                         stroke=svgwrite.rgb(255, 16, 16, '%'),
+                         stroke_width=scale/5.0))
+    pos = (owoffs+len(nepads)*outerscale+outerscale*2, ohoffs-outerscale*0.5)
+    dwg.add(dwg.circle(pos, scale*2,
+                         fill='white',
+                         stroke=svgwrite.rgb(16, 16, 16, '%'),
+                         stroke_width=scale/5.0))
+
+
     dwg.save()