1c9259132fdec7e188e2d2aedad8430da30ad077
[glsdk/iodelay-config.git] / iodelay-autogen.py
1 #!/usr/bin/python
2 # Python script to automatically generate the IO pad and delay data
3 # Author:- Nikhil Devshatwar
5 # This script uses regdump of the pad registers to figure out the muxmodes
6 # Based on the pad and muxmode, it find out all possible virtual/manual modes
7 # by referring to the PCT XML model. Using the, selection file, script
8 # decides which modes to be selected. Finally it dumps the required array entries
10 # This script depends on following files:-
11 # * XML data files      - Shipped with the DRA7xx PCT tool
12 # * Pad register dump   - Generate using omapconf dump 0x4a003400 0x4a00380c
13 # * selection file      - List of selected virtual/manual modes to be used
15 import xml.etree.ElementTree as ET
16 import re
17 import argparse
19 # Handle the command line arguments
20 parser = argparse.ArgumentParser(prog='iodelay-autogen.py',
21         description='Python script to generate the IOdelay data.\n' \
22                 'This script refers to the XML data and automatically generates\n' \
23                 'PAD and DELAY data for the same use case.\n' \
24                 'Note that only the PADs which are used in the dump are configured.',
25         epilog='Generate the pad and delay data using pad register dumps. For this,\n' \
26                 'Run omapconf dump 0x4a003400 0x4a00380c and save the output')
28 parser.add_argument('-p', '--part', dest='part',
29         action='store', type=str, choices=["dra74x", "dra75x", "dra72x"], default="dra74x",
30         help='select the device part')
32 parser.add_argument('-r', '--revision', dest='revision',
33         action='store', type=str, choices=["1.0", "1.1", "2.0"], default="1.1",
34         help='select the silicon revision')
36 parser.add_argument('-m', '--module', dest='module',
37         action='store', type=str, default="",
38         help='generate only for modules matching the provided RE')
40 parser.add_argument('-f', '--format', dest='format',
41         action='store', type=str, choices=["linux", "uboot", "bios"], default="uboot",
42         help='select the output format to be used')
44 parser.add_argument('-d', '--debug', dest='debug',
45         action='store', type=int, choices=[0, 1, 2, 3, 4], default=0,
46         help='set the debug level - ERR,WARN,INFO,DBG,VERBOSE')
48 parser.add_argument('-i', '--interactive', dest='interactive',
49         action='store', type=int, choices=[0, 1], default=1,
50         help='run interactively with menus for resolving conflicts')
52 parser.add_argument('-s', '--strict', dest='strict',
53         action='store_true',
54         help='strict mode - ask for each pad of the group, do not save selection.\n' \
55                 'For some peripherals, same delaymode cannot be used for all the pads.\n' \
56                 'Use this mode to select different modes for each pad')
58 parser.add_argument('-g', '--gpio', dest='gpio',
59         action='store_true',
60         help='generate script to probe signals using gpio')
62 parser.add_argument('-c', '--check', dest='check_xml',
63         action='store_true',
64         help='check consistency of the XML files and other data')
66 args = parser.parse_args()
68 # Some more knobs for developers, Don't want to expose them to cmd line
69 args.resetslew = True
71 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
73 VERSION = "2.5"
75 if (args.part == "dra74x" or args.part == "dra75x"):
76         XML_PATH = "XMLFiles/DRA75x_DRA74x"
77         PART = "DRA75x_DRA74x"
78         PCT_VERSION = "v1.0.10"
79 elif (args.part == "dra72x"):
80         XML_PATH = "XMLFiles/DRA72x"
81         PART = "DRA72x"
82         PCT_VERSION = "v1.0.7"
84 pad_data_xml   = XML_PATH + "/CTRL_MODULE_CORE.xml"
85 iod_data_xml   = XML_PATH + "/IODELAYCONFIG.xml"
86 model_data_xml = XML_PATH + "/model_" + PART + "_SR" + args.revision + "_" + PCT_VERSION + ".xml"
87 modehelp_file  = XML_PATH + "/guidelines_SR" + args.revision + ".txt"
89 pad_file = "ctrl-core.dump"
90 sel_file = "selected-modes.txt"
92 def trace(level, msg):
93         if (args.debug >= level):
94                 print(msg)
95 def verbose(msg):
96         trace(4, "DEBUG: " + msg)
97 def debug(msg, args=None):
98         trace(3, "DEBUG: " + msg)
99 def info(msg):
100         trace(2, "INFO: " + msg)
101 def warn(msg):
102         trace(1, "WARN: " + msg)
103 def error(msg):
104         trace(0, "ERR: " + msg)
106 if (args.interactive):
107         print "iodelay-autogen.py - Python script to generate the IOdelay data."
108         print "v" + VERSION + " using PCT version " + PCT_VERSION
109         print "Parsing PCT data from " + model_data_xml + "..."
110         print ""
112 # Read the XML file database for pad and delay registers
113 pad_xml = ET.parse(pad_data_xml).getroot()
114 iod_xml = ET.parse(iod_data_xml).getroot()
115 model_xml = ET.parse(model_data_xml).getroot()
117 # Functions to parse the input files and build data structures
118 def read_guidelines(fname):
119         modehelp = {}
120         pattern = re.compile('([^\t.]+\w)\t+(.+)')
121         f = open(fname)
122         for line in f.readlines():
123                 list = re.match(pattern, line)
124                 if ( list == None):
125                         continue
126                 mode = list.groups(0)[0]
127                 info = list.groups(0)[1]
128                 modehelp[mode] = info
129                 verbose("Guideline: Mode '%30s' => '%s'" % (mode, info))
130         return modehelp
132 def read_selmodes(fname):
133         sel = {}
134         pattern = re.compile('(\w+)\W*,\W*(\w*)')
135         f = open(fname)
136         for line in f.readlines():
137                 list = re.match(pattern, line)
138                 if ( list == None):
139                         continue
140                 module = list.groups(0)[0]
141                 mode = list.groups(0)[1]
142                 sel[module] = mode
143                 verbose("Input modes: Select '%s' => '%s'" % (mode, module))
144         return sel
146 def read_pad_dump(file):
147         regmap = {}
148         pattern = re.compile('.*(0x[0-9A-F]+).*(0x[0-9A-F]+).*')
149         f = open(file, 'r')
150         for line in f:
151                 list = re.match(pattern, line)
152                 if ( list == None):
153                         continue
154                 addr = int(list.groups(0)[0], 16)
155                 val = int(list.groups(0)[1], 16)
156                 verbose("XML pad-reg: Addr = %08x Value = %08x" % (addr, val))
157                 regmap[addr] = val
158         return regmap
159 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
161 # Helper functions to parse XML nodes and get the desired data
162 # Hugely dependent on the XML format of the PCT files
163 # Uses XPath to search elements with queries and filters
164 # Parse the nodes to generate data in desired format
166 def xml_pad_get_name(offset):
167         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
168         if (len(padlist) == 0):
169                 return "Unknown"
170         else:
171                 return padlist[0].get("id")
173 def xml_pad_get_slew(offset):
174         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
175         if (len(padlist) == 0):
176                 return 0x0
177         else:
178                 bitlist = padlist[0].findall("bitfield[@begin='19']")
179                 if (len(bitlist) == 0):
180                         return 0x0
181                 else:
182                         return int(bitlist[0].get("resetval"), 16)
184 # For DRA72x SoC, for "ball compatibility" purpose, some signals have same muxmode.
185 # CTRL_CORE_ALT_SELECT_MUX register allows to select between one of the signals
186 # Its like a board mux has been added inside the SoC, except it uses same muxmode.
187 def resolve_group(muxmode_str):
188         mmlist = muxmode_str.split(" ")
189         mmlen = len(mmlist)
190         if (mmlen == 1):
191                 def_mode = mmlist[0]
192                 return mmlist[0]
193         elif (mmlen == 2):
194                 def_mode = mmlist[0]
195                 grp1_mode = mmlist[1]
196         elif (mmlen == 3):
197                 def_mode = mmlist[0]
198                 grp1_mode = mmlist[1]
199                 grp2_mode = mmlist[2]
200         else:
201                 error("Cannot resolve muxmode group for '%s'" % muxmode_str)
203         #HACK for now
204         return def_mode
206 def xml_model_get_signal(offset, muxmode):
207         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
208         if (len(padlist) == 0):
209                 return "Unknown"
210         else:
211                 mux_field = padlist[0].findall("./bitfield[@end='0']")
212                 if (len(mux_field) == 0):
213                         return "Unknown"
214                 modes = mux_field[0].findall("./bitenum[@value='%d']" % muxmode)
215                 if (len(modes) == 0):
216                         return "Unknown"
217                 return resolve_group(modes[0].get("id"))
219 def xml_iodelay_get_reg(name):
220         delaylist = iod_xml.findall("register[@id='%s']" % name)
221         if (len(delaylist) == 0):
222                 return 0
223         else:
224                 offset = delaylist[0].get("offset")
225                 verbose("XML delay-reg: Name = %s Offset = %s" % (name, offset))
226                 return int(offset, 16)
228 def xml_get_virtual(mode):
229         vmodes = {}
230         signal = mode.findtext("signal")
231         for virt in mode.findall("virtualmode/mode"):
232                 virt_mode = virt.findtext("value")
233                 virt_name = virt.findtext("name")
234                 if (virt_name == "NA"):
235                         continue
236                 virt_mode = int(virt_mode)
237                 vmodes[virt_name] = virt_mode
238                 debug("    * VIRTUAL: %s [%s] => delaymode = %d" % (signal, virt_name, virt_mode))
239         return vmodes
241 def xml_get_manual(mode):
242         mmodes = {}
243         signal = mode.findtext("signal")
244         for man in mode.findall("manualmode"):
245                 regname = man.findtext("cfgreg/name")
246                 for sel in man.findall("cfgreg/mode"):
247                         adel = sel.findtext("adelay")
248                         gdel = sel.findtext("gdelay")
249                         man_name = sel.findtext("name")
250                         if (man_name == "NA"):
251                                 continue
252                         adel = int(adel)
253                         gdel = int(gdel)
254                         if (man_name not in mmodes.keys()):
255                                 mmodes[man_name] = []
256                         mmodes[man_name].append((regname, adel, gdel))
257                         debug("    * MANUAL: %s [%s] => delay[%s] = %d, %d" % (signal, man_name, regname, adel, gdel))
258         return mmodes
260 def xml_find_delaymodes(pad_name, muxmode):
261         padlist = model_xml.findall("padDB/clockNode/type/pad")
262         for pad in padlist:
263                 if (pad_name == pad.findtext("confregisters/regbit/register")):
264                         muxmodes = pad.findall("muxmode")
265                         break
266         if not muxmodes:
267                 return None
268         for mode in muxmodes:
269                 if ("%d" % muxmode == mode.findtext("mode")):
270                         virt = xml_get_virtual(mode)
271                         man = xml_get_manual(mode)
272                         return (virt, man)
273         return None
275 def xml_check_correctness(modehelp):
277         print "###########################################"
278         print "XML correctness checks:"
279         padcore_list = []
280         padmodel_list = []
281         modes = {}
283         # Find all the pads in core XML
284         pad_list = pad_xml.findall("register")
285         for i in pad_list:
286                 name = i.get("id")
287                 if (re.match("CTRL_CORE_PAD_.*", name) == None):
288                         continue
289                 padcore_list.append(name)
290         print ">> Total pads defined in core XML = %d" % len(padcore_list)
292         # Find all the pads in model XML
293         pad_list = model_xml.findall("padDB/clockNode/type/pad/confregisters/regbit")
294         for i in pad_list:
295                 name = i.findtext("register")
296                 padmodel_list.append(name)
297         print ">> Total pads defined in model XML = %d" % len(padmodel_list)
299         # Find all the manual modes
300         manmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/manualmode/cfgreg/mode")
301         for i in manmode_list:
302                 man_name = i.findtext("name")
303                 modes[man_name] = "manual"
304         # Find all the virtual modes
305         virtmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/virtualmode/mode")
306         for i in virtmode_list:
307                 virt_name = i.findtext("name")
308                 modes[virt_name] = "virtual"
309         print ">> Total delaymodes defined in model XML = %d" % len(modes)
311         # Print out all the errors found in the tests
312         print "== Pads defined in core XML but not in model XML =="
313         for i in padcore_list:
314                 if (i not in padmodel_list):
315                         print "\t%s" % i
316         print "== Pads defined in model XML but not in core XML =="
317         for i in padmodel_list:
318                 if (i not in padcore_list):
319                         print "\t%s" % i
321         # Check if description for each mode is available
322         print "== Delaymodes missing description in the guidelines.txt =="
323         for i in modes:
324                 if (i not in modehelp):
325                         print "\t%s" % i
327         # Check if description for unknown mode is documented
328         print "== Delaymodes unused from guidelines.txt =="
329         for i in modehelp:
330                 if (i not in modes):
331                         print "\t%s" % i
333         print "###########################################"
335 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
337 # Decision point of the script
338 # For each pad/pin, decide what delay method is used
339 # Lookup in the selection file or ask user with a menu
340 def select_mode(pad, pin, module, virt, man, modehelp, sel):
341         modelist = []
342         for modename in virt.keys():
343                 modelist.append(modename)
345         for modename in man.keys():
346                 modelist.append(modename)
348         if (len(modelist) == 0):
349                 return "LEGACY"
351         if (module in sel.keys()):
352                 mode = sel[module]
353                 if (mode == "SKIP" or mode == "LEGACY" or mode in modelist):
354                         return mode
355                 else:
356                         error("Invalid delaymode '%s' for module '%s'" % (mode, module))
358         if (args.interactive == 0):
359                 warn("No delay modes for %s found, skipping" % module)
360                 mode = "SKIP"
361                 return mode
363         # Display the menu and ask user to select the 'right' mode
364         while True:
365                 print ""
366                 print "MENU: Select delay mode for %s -> %s" % (pad, pin)
367                 i = 0
368                 print "MENU: %d: %s \t\t\t%s" % (i, "SKIP", "Skips this module for now")
369                 i = 1
370                 print "MENU: %d: %s \t\t%s" % (i, "LEGACY", "No external delay config (No virtual/manual needed)")
371                 for mode in modelist:
372                         i += 1
373                         if (mode in modehelp):
374                                 helptext = modehelp[mode]
375                         else:
376                                 helptext = "Unknown"
377                         print "MENU: %d: %s \t\t%s" % (i, mode, helptext)
378                 try:
379                         choice = int(raw_input("Select delay mode #> "))
380                         if (choice == 0):
381                                 mode = "SKIP"
382                                 break
383                         elif (choice == 1):
384                                 mode = "LEGACY"
385                                 break
386                         elif (choice >=2 and choice <= len(modelist) + 1):
387                                 mode = modelist[choice - 2]
388                                 break
389                         print "ERROR: Invalid choice"
390                 except ValueError:
391                         print "ERROR: Invalid choice"
392         print "MENU: Selected mode is %s" % mode
393         print ""
395         return mode
396 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
398 # Pad read using GPIO - Specific to linux only
399 # As each pad is muxed with a SoC gpio (for most of the pads)
400 # It's possible to read the pad data using gpio datain registers
401 # Change pad register to enable input path and export sysfs
402 # Use sysfs to read the status of GPIO and print in a loop
403 def pad_dump_gpio(padconf, per_padconf):
404         gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
405         module = args.module
407         # script header
408         gen_header = "###########################################\n" + \
409                      "# Read %s signals using GPIO sysfs\n" % module + \
410                      "###########################################\n\n"
411         gen_data = "%s_data=(\n" % module
413         for i in padconf:
414                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
416                 offset = addr - 0x4a002000
417                 gpio_name = xml_model_get_signal(offset, 14)
418                 matchlist = re.match("GPIO(.)_(.*)", gpio_name)
419                 if (matchlist == None):
420                         error("No GPIO for pad %s - cannot read from script" % pad_name)
421                         continue
423                 inst = int(matchlist.groups(0)[0])
424                 bit = int(matchlist.groups(0)[1])
425                 gpio_addr = gpio_data_addrs[inst]
426                 ngpio = (inst - 1) * 32 + bit
427                 pin_short = re.match(".+_(.*)", pin_name).groups(0)[0]
429                 gen_data += "\t%s:0x%x:%s:%d:0x%x:%d\n" % (pin_short, addr, gpio_name, ngpio, gpio_addr, bit)
431         gen_data += ")\n\n"
433         # Main script to probe the signal
434         gen_main = "echo; echo Probing %s signals\n\n" % module + \
435                    "for data in ${%s_data[@]}\n" % module + \
436                    "do\n" + \
437                    "    pin=`echo $data | cut -d ':' -f1`\n" + \
438                    "    pad=`echo $data | cut -d ':' -f2`\n" + \
439                    "    ngpio=`echo $data | cut -d ':' -f4`\n" + \
440                    "    echo $ngpio > /sys/class/gpio/export 2>/dev/null\n" + \
441                    "    omapconf set bit $pad 18 1>/dev/null 2>/dev/null\n" + \
442                    "    printf \"%8s\" $pin\n" + \
443                    "done\n" + \
444                    "echo\n\n"
446         gen_main += "while true;\n" + \
447                     "do\n" + \
448                     "    for data in ${%s_data[@]}\n" % module + \
449                     "    do\n" + \
450                     "#       pin=`echo $data | cut -d ':' -f1`\n" + \
451                     "#        pad=`echo $data | cut -d ':' -f2`\n" + \
452                     "#       gpio=`echo $data | cut -d ':' -f3`\n" + \
453                     "        ngpio=`echo $data | cut -d ':' -f4`\n" + \
454                     "#       addr=`echo $data | cut -d ':' -f5`\n" + \
455                     "#       bit=`echo $data | cut -d ':' -f6`\n" + \
456                     "        val=`cat /sys/class/gpio/gpio$ngpio/value`\n" + \
457                     "        printf %8d $val \n" + \
458                     "    done\n" + \
459                     "    echo\n" + \
460                     "done\n\n"
462         gen_footer = "###########################################\n"
464         # Generate the shell script
465         gen_script = gen_header + gen_data + gen_main + gen_footer
466         filename = ("./%s-probe.sh" % module).lower()
467         print "Generating '%s' script..." % filename
468         gen_file = open(filename, "w+")
469         gen_file.write(gen_script)
471 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
473 # Generate the final pad and delay data in the required format
474 def format_pad_regs(padconf, per_padconf):
475         print "######## Pad data output ########"
476         if (args.format == "uboot"):
477                 uboot_format_pad_regs(padconf, per_padconf)
478         elif (args.format == "linux"):
479                 linux_format_pad_regs(padconf, per_padconf)
480         elif (args.format == "bios"):
481                 bios_format_pad_regs(padconf, per_padconf)
482         else:
483                 error("Format %s not suppported" % args.format)
485 def format_delay_regs(delayconf, per_delayconf):
486         print "######## Delay data output ########"
487         if (args.format == "uboot"):
488                 uboot_format_delay_regs(delayconf, per_delayconf)
489         elif (args.format == "linux"):
490                 linux_format_delay_regs(delayconf, per_delayconf)
491         elif (args.format == "bios"):
492                 bios_format_delay_regs(delayconf, per_delayconf)
493         else:
494                 error("Format %s not suppported" % args.format)
496 def get_pin_info(val):
497         slew_fast = (val >> 19) & 0x1
498         inp_en = (val >> 18) & 0x1
499         pulltype = (val >> 17) & 0x1
500         pull_dis = (val >> 16) & 0x1
501         pin = "PIN"
502         if (inp_en):
503                 pin += "_INPUT"
504         else:
505                 pin += "_OUTPUT"
506         if (pull_dis == 0):
507                 if (pulltype):
508                         pin += "_PULLUP"
509                 else:
510                         pin += "_PULLDOWN"
511         if (slew_fast):
512                 pin += " | SLEWCONTROL"
513         return pin
515 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
517 # Generate output in u-boot format
518 def uboot_format_pad_regs(padconf, per_padconf):
519         print "\nconst struct pad_conf_entry dra74x_core_padconf_array[] = {"
520         for i in padconf:
521                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
523                 muxmode = val & 0xf
524                 (method, data) = delayinfo
525                 if (method == "LEGACY"):
526                         extramode = ""
527                 elif (method == "VIRTUAL"):
528                         delaymode = data
529                         extramode = " | VIRTUAL_MODE%d" % delaymode
530                 elif (method == "MANUAL"):
531                         extramode = " | MANUAL_MODE"
532                 else:
533                         error("Invalid delay method %s" % method)
535                 pin_info = get_pin_info(val) + extramode
536                 pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
537                 comment = (pad_short + "." + pin_name).lower()
539                 print "\t{ %s, (M%d | %s) },\t/* %s */" % (pad_short, muxmode, pin_info, comment)
540         print "};\n"
542 def uboot_format_delay_regs(delayconf, per_delayconf):
543         manual_del = []
544         for i in delayconf:
545                 (pad_name, pin_name, regname, del_offset, man_name, adel, gdel) = i
547                 entry = (del_offset, adel, gdel, regname, pin_name, man_name)
548                 manual_del.append(entry)
550         es_rev = args.revision.replace('.', '_')
551         print "\nconst struct iodelay_cfg_entry dra742_es" + es_rev + "_iodelay_cfg_array[] = {"
552         for entry in sorted(manual_del):
553                 print "\t{ 0x%04X, %5d, %5d },\t/* %s : %s - %s */" % entry
554         print "};\n"
556 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
558 # Generate output in linux format
559 def linux_format_pad_regs(padconf, per_padconf):
560         print "&dra7_pmx_core {"
561         for per in per_padconf:
563                 if (re.match("MMC.*", per) == None):
564                         warn("Only MMC padconf is recommended in kernel")
566                 # Get the mode from the first entry
567                 (pad_name, pin_name, addr, val, mode, delayinfo) = per_padconf[per][0]
569                 dtsnode = ("%s_pins_%s" % (per, mode)).lower()
570                 print ""
571                 print "\t%s: %s {" % (dtsnode, dtsnode)
572                 print "\t\tpinctrl-single,pins = <"
573                 for i in per_padconf[per]:
574                         (pad_name, pin_name, addr, val, mode, delayinfo) = i
576                         muxmode = val & 0xf
577                         (method, data) = delayinfo
578                         if (method == "LEGACY"):
579                                 extramode = ""
580                         elif (method == "VIRTUAL"):
581                                 delaymode = data
582                                 extramode = " | MUX_VIRTUAL_MODE%d" % delaymode
583                         elif (method == "MANUAL"):
584                                 extramode = " | MANUAL_MODE"
585                         else:
586                                 warn("Invalid method %s" % method)
588                         pin_info = get_pin_info(val) + extramode
589                         pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
590                         offset = addr - 0x4a003400
591                         comment = (pad_short + "." + pin_name).lower()
593                         print "\t\t\t0x%03X\t(%s | MUX_MODE%d)\t/* %s */" % (offset, pin_info, muxmode, comment)
594                 print "\t\t>;"
595                 print "\t};"
596         print "};\n"
599 def linux_format_delay_regs(delayconf, per_delayconf):
600         print "&dra7_iodelay_core {"
601         for per in per_delayconf.keys():
603                 if (re.match("MMC.*", per) == None):
604                         warn("Only MMC delayconf is recommended in kernel")
606                 # Get the mode from the first entry
607                 (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = per_delayconf[per][0]
609                 dtsnode = ("%s_iodelay_%s_conf" % (per, mode)).lower()
610                 print "\t%s: %s {" % (dtsnode, dtsnode)
611                 print "\t\tpinctrl-single,pins = <"
612                 for i in per_delayconf[per]:
613                         (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = i
615                         print "\t\t\t0x%03X (A_DELAY(%d) | G_DELAY(%d))\t/* %s */" % (del_offset, adel, gdel, regname)
616                 print "\t\t>;"
617                 print "\t};"
618         print "};\n"
620 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
622 # Generate output in bios format
623 def bios_format_pad_regs(padconf, per_padconf):
624         for i in padconf:
625                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
627                 delaylist = []
628                 (method, data) = delayinfo
629                 if (method == "VIRTUAL"):
630                         virt_mode = data
631                         val = val | ( virt_mode<< 4)
632                         val = val | (1 << 8)
633                 elif (method == "MANUAL"):
634                         delaylist = data
635                         val = val | (1 << 8)
637                 offset = addr - 0x4a003400
638                 out_delreg = out_adel = out_gdel = 0
639                 in_delreg  = in_adel  = in_gdel  = 0
640                 oen_delreg = oen_adel = oen_gdel = 0
642                 for j in delaylist:
643                         (regname, adel, gdel) = j
644                         if (re.match(".*_IN", regname) != None):
645                                 in_delreg = xml_iodelay_get_reg(regname)
646                                 in_adel = adel
647                                 in_gdel = gdel
648                         elif (re.match(".*_OEN", regname) != None):
649                                 oen_delreg = xml_iodelay_get_reg(regname)
650                                 oen_adel = adel
651                                 oen_gdel = gdel
652                         elif (re.match(".*_OUT", regname) != None):
653                                 out_delreg = xml_iodelay_get_reg(regname)
654                                 out_adel = adel
655                                 out_gdel = gdel
656                 indel  = "{ 0x%04X, %4d, %4d }" % (in_delreg,  in_adel,  in_gdel)
657                 oendel = "{ 0x%04X, %4d, %4d }" % (oen_delreg, oen_adel, oen_gdel)
658                 outdel = "{ 0x%04X, %4d, %4d }" % (out_delreg, out_adel, out_gdel)
659                 pin_info = get_pin_info(val)
660                 print "\t/* %s -> %s (%s) %s delaymode */" % (pad_name, pin_name, pin_info, method)
661                 print "\t{ 0x%03X, 0x%08X, %s, %s, %s }" % (offset, val, indel, oendel, outdel)
663 def bios_format_delay_regs(delayconf, per_delayconf):
664         debug("Manual delays are not configured separately")
665         debug("Delays are configured as part of the padconf step only")
667 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
669 # Main execution starts here
670 # * Parse all the XML files - Get the pad data and IOdelay data
671 # * Iterate over the pad register dumps
672 # * For each pad, find out the muxmode being used and the pad direction, etc
673 # * For the muxmode being used, find out available virtual/modes
674 #   - Dump the virtual/manual modes available (based on options)
675 #   - Build up the gpio script to read the pad data using GPIO module
676 # * Select the correct mode to be used
677 #   - Check if the mode is described for the peripheral module, (from selected-modes.txt)
678 #   - Otherwise ask the user (with a menu) to decide the delaymode
679 #     => Update the selection for the whole of the peripheral module
680 #   - Worst case, skip the delaymode for this pad
681 # * Build the pad and delay register information
682 # * Create the dump for pad and delay data in linux/u-boot format
683 # * Dump the delaymode selection for each peripheral
684 # * Dump the GPIO script for each peripheral (all pads grouped together)
687 # Read all the input files and parse the required info
688 modehelp = read_guidelines(modehelp_file)
689 sel = read_selmodes(sel_file)
690 regmap = read_pad_dump(pad_file)
691 reglist = regmap.keys()
693 # List of all the pads being configured
694 padconf = []
695 # List of all the delay registers being configured (for manual mode)
696 delayconf = []
697 # Dictionary of pads grouped by peripheral/module
698 per_padconf = {}
699 # Dictionary of delay registers grouped by peripheral/module
700 per_delayconf = {}
702 if(args.check_xml):
703         xml_check_correctness(modehelp)
704         exit()
706 # Start iterating over each pad
707 for i in range(0, 260):
708         # Find out the muxmode and pad direction, etc
709         addr = 0x4a003400 + i * 4
710         offset = 0x1400 + i * 4
711         dts_offset = offset - 0x1400
713         if (addr not in reglist):
714                 warn("Register dump for pad 0x%X not found" % addr)
715                 continue
716         val = regmap[addr]
717         muxmode = val & 0xf
719         # Find out the pin based on the muxmode
720         pad_name = xml_pad_get_name(offset)
721         pin_name = xml_model_get_signal(offset, muxmode)
722         if (pad_name == "Unknown" or pin_name == "Unknown"):
723                 warn("Cannot find out Pad/Pin name for PAD address 0x%X (%s[%s] = %s)" \
724                 % (addr, pad_name, muxmode, pin_name))
725                 continue
726         if (pin_name == "DRIVER"):
727                 continue
729         # Find out if the delaymode for this module is already selected
730         module = re.match("([^_]+)_.*", pin_name).groups(0)[0]
732         if (args.module != "" and re.match("%s" % args.module, module) == None):
733                 continue
735         # It is recommended to keep the reset value of the slewcontrol bit
736         # Find out the reset value from XML and update if required
737         if (args.resetslew):
738                 val |= (xml_pad_get_slew(offset) & 0x1) << 19
740         debug("\nPAD: %s: Addr= 0x%08X Value = 0x%08X \"%s\"" \
741                 % (pad_name, addr, val, pin_name))
743         # Find out all the possible virtual, manual modes fot the specific pad -> pin combination
744         (virt, man) = xml_find_delaymodes(pad_name, muxmode)
746         if (args.gpio == True):
747                 mode = "LEGACY"
748         else:
749                 # Need to select one out of allowed modes
750                 mode = select_mode(pad_name, pin_name, module, virt, man, modehelp, sel)
752         # Remember the selection for that module, for later reuse
753         if (args.strict == False and module not in sel.keys()):
754                 sel[module] = mode
756         if (mode == "SKIP"):
757                 continue
758         elif (mode == "LEGACY"):
759                 delayinfo = ("LEGACY", "")
760         elif (mode in virt):
761                 delayinfo = ("VIRTUAL", virt[mode])
762         elif (mode in man):
763                 delayinfo = ("MANUAL", man[mode])
764         else:
765                 error("Unknown mode '%s' selected" % mode)
766                 continue
768         debug("  => Using mode %s" % mode)
769         paddata = (pad_name, pin_name, addr, val, mode, delayinfo)
770         if (module not in per_padconf.keys()):
771                 per_padconf[module] = []
772         padconf.append(paddata)
773         per_padconf[module].append(paddata)
775         if(mode not in man):
776                 continue
778         # Add the delay data if using manual mode
779         for regval in man[mode]:
780                 (regname, adel, gdel) = regval
781                 del_offset = xml_iodelay_get_reg(regname)
782                 if (del_offset == 0):
783                         error("Can't find delay offset of register %s" % regname)
784                         break
785                 debug("  => Manual delay[%s] = (%d, %d)" % (regname, adel, gdel))
786                 delaydata = (pad_name, pin_name, regname, del_offset, mode, adel, gdel)
787                 if (module not in per_delayconf.keys()):
788                         per_delayconf[module] = []
789                 delayconf.append(delaydata)
790                 per_delayconf[module].append(delaydata)
792 if(args.gpio == True):
793         pad_dump_gpio(padconf, per_padconf)
794         exit()
796 format_pad_regs(padconf, per_padconf)
797 format_delay_regs(delayconf, per_delayconf)
799 if (args.interactive):
800         # Summary of the generated data
801         print ""
802         print "Total PAD registers: %d" % len(padconf)
803         print "Total DELAY registers: %d" % len(delayconf)
804         print ""
805         # Dump the final selection for reuse
806         print "Selected modes for each peripheral module\n"
807         for group in sel:
808                 print "%s,\t%s" % (group, sel[group])
809         print ""
810 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #