src/spec/base.py

   1 from spec.interfaces import Pinouts
   2
   3 from spec.ifaceprint import display, display_fns, check_functions
   4 from spec.ifaceprint import display_fixed
   5
   6
   7 class PinSpec(Pinouts):
   8     def __init__(self, pinbanks, fixedpins, function_names):
   9         self.pinbanks = pinbanks
  10         self.fixedpins = fixedpins
  11         self.function_names = function_names
  12         bankspec = {}
  13         self.offs = 0
  14         pkeys = sorted(pinbanks.keys())
  15         for kn in pkeys:
  16             bankspec[kn] = self.offs
  17             self.offs += pinbanks[kn]
  18
  19         self.scenarios = []
  20
  21         Pinouts.__init__(self, bankspec)
  22
  23     def add_scenario(self, name, needed, eint, pwm, descriptions):
  24         # Scenarios below can be spec'd out as either "find first interface"
  25         # by name/number e.g. SPI0, or as "find in bank/mux" which must be
  26         # spec'd as "BM:Name" where B is bank (A-F), M is Mux (0-3)
  27         # EINT and PWM are grouped together, specially, but may still be spec'd
  28         # using "BM:Name".  Pins are removed in-order as listed from
  29         # lists (interfaces, EINTs, PWMs) from available pins.
  30
  31         self.scenarios.append((name, needed, eint, pwm, descriptions))
  32
  33     def write(self, of):
  34         of.write("""# Pinouts (PinMux)
  35 auto-generated by [[pinouts.py]]
  36
  37 [[!toc  ]]
  38
  39 """)
  40         bk = self.pinbanks.keys()
  41         bk.sort()
  42         for bank in bk:
  43             of.write("\n## Bank %s (%d pins)\n\n" % (bank, self.pinbanks[bank]))
  44             display(of, self, bank)
  45
  46         of.write("\n# Pinouts (Fixed function)\n\n")
  47         fixedpins = display_fixed(of, self.fixedpins, len(self))
  48
  49         of.write("""# Functions (PinMux)
  50
  51 auto-generated by [[pinouts.py]]
  52
  53 """)
  54         fns = display_fns(of, self.bankspec, self, self.function_names)
  55         of.write('\n')
  56
  57         for scenario in self.scenarios:
  58             name, needed, eint, pwm, descriptions = scenario
  59             unused_pins = check_functions(of, name, self.bankspec, fns,
  60                                           self,
  61                                           needed, eint, pwm,
  62                                           descriptions)
  63
  64         of.write("""# Reference Datasheets
  65
  66 datasheets and pinout links
  67 * <http://datasheets.chipdb.org/AMD/8018x/80186/amd-80186.pdf>
  68 * <http://hands.com/~lkcl/eoma/shenzen/frida/FRD144A2701.pdf>
  69 * <http://pinouts.ru/Memory/sdcard_pinout.shtml>
  70 * p8 <http://www.onfi.org/~/media/onfi/specs/onfi_2_0_gold.pdf?la=en>
  71 * <https://www.heyrick.co.uk/blog/files/datasheets/dm9000aep.pdf>
  72 * <http://cache.freescale.com/files/microcontrollers/doc/app_note/AN4393.pdf>
  73 * <https://www.nxp.com/docs/en/data-sheet/MCF54418.pdf>
  74 * ULPI OTG PHY, ST <http://www.st.com/en/interfaces-and-transceivers/stulpi01a.html>
  75 * ULPI OTG PHY, TI TUSB1210 <http://ti.com/product/TUSB1210/>
  76
  77 """)
  78
  79         return self, self.bankspec, self.pinbanks, fixedpins