script: Remove unwanted debug prints
[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="2.0",
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.8"
75 if (args.part == "dra74x" or args.part == "dra75x"):
76         if (args.revision == "1.0" or args.revision == "1.1"):
77                 args.revision = "1.x"
78         XML_PATH = "XMLFiles/DRA75x_DRA74x"
79         PART = "DRA75x_DRA74x"
80         PCT_VERSION = "v1.0.16"
81 elif (args.part == "dra72x"):
82         if (args.revision == "1.1"):
83                 print "dra72x doesn't have silicon revision 1.1"
84                 exit()
85         XML_PATH = "XMLFiles/DRA72x"
86         PART = "DRA72x"
87         PCT_VERSION = "v1.0.9"
89 pad_data_xml   = XML_PATH + "/CTRL_MODULE_CORE.xml"
90 iod_data_xml   = XML_PATH + "/IODELAYCONFIG.xml"
91 model_data_xml = XML_PATH + "/model_" + PART + "_SR" + args.revision + "_" + PCT_VERSION + ".xml"
92 modehelp_file  = XML_PATH + "/guidelines_SR" + args.revision + ".txt"
94 pad_file = "ctrl-core.dump"
95 sel_file = "selected-modes.txt"
97 def trace(level, msg):
98         if (args.debug >= level):
99                 print(msg)
100 def verbose(msg):
101         trace(4, "DEBUG: " + msg)
102 def debug(msg, args=None):
103         trace(3, "DEBUG: " + msg)
104 def info(msg):
105         trace(2, "INFO: " + msg)
106 def warn(msg):
107         trace(1, "WARN: " + msg)
108 def error(msg):
109         trace(0, "ERR: " + msg)
110 def fatal(msg):
111         trace(0, "FATAL: " + msg)
112         exit()
114 if (args.interactive):
115         print "iodelay-autogen.py - Python script to generate the IOdelay data."
116         print "v" + VERSION + " using PCT version " + PCT_VERSION
117         print "Parsing PCT data from " + model_data_xml + "..."
118         print ""
120 # Read the XML file database for pad and delay registers
121 pad_xml = ET.parse(pad_data_xml).getroot()
122 iod_xml = ET.parse(iod_data_xml).getroot()
123 model_xml = ET.parse(model_data_xml).getroot()
125 # Functions to parse the input files and build data structures
126 def read_guidelines(fname):
127         modehelp = {}
128         pattern = re.compile('([^\t.]+\w)\t+(.+)')
129         f = open(fname)
130         for line in f.readlines():
131                 list = re.match(pattern, line)
132                 if ( list == None):
133                         continue
134                 mode = list.groups(0)[0]
135                 info = list.groups(0)[1]
136                 modehelp[mode] = info
137                 verbose("Guideline: Mode '%30s' => '%s'" % (mode, info))
138         return modehelp
140 def read_selmodes(fname):
141         sel = {}
142         pattern = re.compile('(\w+)\W*,\W*(\w*)')
143         f = open(fname)
144         for line in f.readlines():
145                 list = re.match(pattern, line)
146                 if ( list == None):
147                         continue
148                 module = list.groups(0)[0]
149                 mode = list.groups(0)[1]
150                 sel[module] = mode
151                 verbose("Input modes: Select '%s' => '%s'" % (mode, module))
152         return sel
154 def read_pad_dump(file):
155         regmap = {}
156         pattern = re.compile('.*(0x[0-9A-Fa-f]+).*(0x[0-9A-Fa-f]+).*')
157         f = open(file, 'r')
158         for line in f:
159                 list = re.match(pattern, line)
160                 if ( list == None):
161                         continue
162                 addr = int(list.groups(0)[0], 16)
163                 val = int(list.groups(0)[1], 16)
164                 verbose("XML pad-reg: Addr = %08x Value = %08x" % (addr, val))
165                 regmap[addr] = val
166         return regmap
168 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
169 # Read all the input files and parse the required info
170 modehelp = read_guidelines(modehelp_file)
171 sel = read_selmodes(sel_file)
172 regmap = read_pad_dump(pad_file)
173 reglist = regmap.keys()
175 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
177 # Helper functions to parse XML nodes and get the desired data
178 # Hugely dependent on the XML format of the PCT files
179 # Uses XPath to search elements with queries and filters
180 # Parse the nodes to generate data in desired format
182 def xml_pad_get_name(offset):
183         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
184         if (len(padlist) == 0):
185                 return "Unknown"
186         else:
187                 return padlist[0].get("id")
189 def xml_pad_get_offset(name):
190         padlist = pad_xml.findall("register[@id='%s']" % name)
191         if (len(padlist) == 0):
192                 return None
193         else:
194                 return int(padlist[0].get("offset"), 16)
196 def xml_pad_get_slew(offset):
197         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
198         if (len(padlist) == 0):
199                 return 0x0
200         else:
201                 bitlist = padlist[0].findall("bitfield[@begin='19']")
202                 if (len(bitlist) == 0):
203                         return 0x0
204                 else:
205                         return int(bitlist[0].get("resetval"), 16)
207 # For DRA72x SoC, for "ball compatibility" purpose, some signals have same muxmode.
208 # CTRL_CORE_ALT_SELECT_MUX register allows to select between one of the signals
209 # Its like a board mux has been added inside the SoC, except it uses same muxmode.
210 def resolve_group(muxmode_str):
211         if (muxmode_str == "DRIVER OFF"):
212                 return muxmode_str
213         mmlist = muxmode_str.split(" ")
214         mmlen = len(mmlist)
215         if (mmlen == 1):
216                 def_mode = mmlist[0]
217                 return mmlist[0]
218         elif (mmlen == 2):
219                 def_mode = mmlist[0]
220                 grp1_mode = mmlist[1]
221         elif (mmlen == 3):
222                 def_mode = mmlist[0]
223                 grp1_mode = mmlist[1]
224                 grp2_mode = mmlist[2]
225         else:
226                 error("Cannot resolve muxmode group for '%s'" % muxmode_str)
228         #HACK for now
229         warn("Not resolving muxmode %s, assuming default %s" % (muxmode_str, def_mode))
230         return def_mode
232 def xml_model_get_signal(offset, muxmode):
233         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
234         if (len(padlist) == 0):
235                 return "Unknown"
236         else:
237                 mux_field = padlist[0].findall("./bitfield[@end='0']")
238                 if (len(mux_field) == 0):
239                         return "Unknown"
240                 modes = mux_field[0].findall("./bitenum[@value='%d']" % muxmode)
241                 if (len(modes) == 0):
242                         return "Unknown"
243                 return resolve_group(modes[0].get("id"))
245 def xml_iodelay_get_reg(name):
246         delaylist = iod_xml.findall("register[@id='%s']" % name)
247         if (len(delaylist) == 0):
248                 return 0
249         else:
250                 offset = delaylist[0].get("offset")
251                 verbose("XML delay-reg: Name = %s Offset = %s" % (name, offset))
252                 return int(offset, 16)
254 def xml_get_virtual(mode):
255         vmodes = {}
256         signal = mode.findtext("signal")
257         for virt in mode.findall("virtualmode/mode"):
258                 virt_mode = virt.findtext("value")
259                 virt_name = virt.findtext("name")
260                 if (virt_name == "NA"):
261                         continue
262                 virt_mode = int(virt_mode)
263                 vmodes[virt_name] = virt_mode
264                 debug("    * VIRTUAL: %s [%s] => delaymode = %d" % (signal, virt_name, virt_mode))
265         return vmodes
267 def xml_get_manual(mode):
268         mmodes = {}
269         signal = mode.findtext("signal")
270         for man in mode.findall("manualmode"):
271                 regname = man.findtext("cfgreg/name")
272                 for sel in man.findall("cfgreg/mode"):
273                         adel = sel.findtext("adelay")
274                         gdel = sel.findtext("gdelay")
275                         man_name = sel.findtext("name")
276                         if (man_name == "NA"):
277                                 continue
278                         adel = int(adel)
279                         gdel = int(gdel)
280                         if (man_name not in mmodes.keys()):
281                                 mmodes[man_name] = []
282                         mmodes[man_name].append((regname, adel, gdel))
283                         debug("    * MANUAL: %s [%s] => delay[%s] = %d, %d" % (signal, man_name, regname, adel, gdel))
284         return mmodes
286 def xml_get_additional_mode(orig):
287         additional_mux = orig.findall("additionalMux/confregisters")
288         if (len(additional_mux) == 0):
289                 return orig
290         else:
291                 additional_mux = additional_mux[0]
292                 mux_reg_name = additional_mux.findtext("register")
293                 offset = xml_pad_get_offset(mux_reg_name)
295                 if (offset == None):
296                         error("Could not find register address for register '%s'" % mux_reg_name)
297                         fatal("This pin may have virtual/manual modes, Fix XML file")
299                 addr = 0x4a002000 + offset
300                 if (addr not in reglist):
301                         error("register dump lacks data for additional muxes")
302                         warn("using default values")
303                         muxval = 0x0
304                 else:
305                         muxval = regmap[addr]
307                 values = additional_mux.findall("value")
308                 for value in values:
310                         option = int(value.findtext("option"))
311                         fieldpos = value.findtext("fieldPos")
312                         signal = value.findtext("signal").upper()
313                         matchlist = re.match("([0-9]+)[:]*([0-9]*)", fieldpos)
315                         verbose("++++ Additional mux %s possible" % signal)
316                         end = int(matchlist.groups(0)[0])
317                         if (matchlist.groups(0)[1] == ""):
318                                 start = end
319                         else:
320                                 start = int(matchlist.groups(0)[1])
322                         muxval = muxval & (1 << end)
323                         muxval = muxval >> start
325                         if (muxval == option):
326                                 debug(">>>> Additional mux %s[%s] = %d" % (mux_reg_name, fieldpos, option))
327                                 debug(">>>> Effective signal = %s" % signal)
328                                 return value
329                 error("None of the additional Mux value matched, using default")
330                 return values[0]
332 def xml_find_delaymodes(pad_name, muxmode):
333         virt = {}
334         man = {}
335         padlist = model_xml.findall("padDB/clockNode/type/pad")
336         for pad in padlist:
337                 if (pad_name == pad.findtext("confregisters/regbit/register")):
338                         muxmodes = pad.findall("muxmode")
339                         break
340         if not muxmodes:
341                 return None
342         for mode in muxmodes:
343                 if ("%d" % muxmode == mode.findtext("mode")):
344                         mode = xml_get_additional_mode(mode)
345                         virt = xml_get_virtual(mode)
346                         man = xml_get_manual(mode)
347                         return (virt, man)
348         return (virt, man)
350 def xml_check_correctness(modehelp):
352         print "###########################################"
353         print "XML correctness checks:"
354         padcore_list = []
355         padmodel_list = []
356         modes = {}
358         # Find all the pads in core XML
359         pad_list = pad_xml.findall("register")
360         for i in pad_list:
361                 name = i.get("id")
362                 if (re.match("CTRL_CORE_PAD_.*", name) == None):
363                         continue
364                 padcore_list.append(name)
365         print ">> Total pads defined in core XML = %d" % len(padcore_list)
367         # Find all the pads in model XML
368         pad_list = model_xml.findall("padDB/clockNode/type/pad/confregisters/regbit")
369         for i in pad_list:
370                 name = i.findtext("register")
371                 padmodel_list.append(name)
372         print ">> Total pads defined in model XML = %d" % len(padmodel_list)
374         # Find all the manual modes
375         manmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/manualmode/cfgreg/mode")
376         for i in manmode_list:
377                 man_name = i.findtext("name")
378                 modes[man_name] = "manual"
379         # Find all the additional manual modes
380         manmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/additionalMux/confregisters/value/manualmode/cfgreg/mode")
381         for i in manmode_list:
382                 man_name = i.findtext("name")
383                 modes[man_name] = "manual"
384         # Find all the virtual modes
385         virtmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/virtualmode/mode")
386         for i in virtmode_list:
387                 virt_name = i.findtext("name")
388                 modes[virt_name] = "virtual"
389         # Find all the additional virtual modes
390         virtmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/additionalMux/confregisters/value/virtualmode/mode")
391         for i in virtmode_list:
392                 virt_name = i.findtext("name")
393                 modes[virt_name] = "virtual"
394         print ">> Total delaymodes defined in model XML = %d" % len(modes)
396         # Print out all the errors found in the tests
397         print "== Pads defined in core XML but not in model XML =="
398         for i in padcore_list:
399                 if (i not in padmodel_list):
400                         print "\t%s" % i
401         print "== Pads defined in model XML but not in core XML =="
402         for i in padmodel_list:
403                 if (i not in padcore_list):
404                         print "\t%s" % i
406         # Check if description for each mode is available
407         print "== Delaymodes missing description in the guidelines.txt =="
408         for i in modes:
409                 if (i not in modehelp):
410                         print "\t%s" % i
412         # Check if description for unknown mode is documented
413         print "== Delaymodes unused from guidelines.txt =="
414         for i in modehelp:
415                 if (i not in modes):
416                         print "\t%s" % i
418         print "###########################################"
420 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
422 # Decision point of the script
423 # For each pad/pin, decide what delay method is used
424 # Lookup in the selection file or ask user with a menu
425 def select_mode(pad, pin, module, virt, man, modehelp, sel):
426         modelist = []
427         for modename in virt.keys():
428                 modelist.append(modename)
430         for modename in man.keys():
431                 modelist.append(modename)
433         if (len(modelist) == 0):
434                 return "LEGACY"
436         if (module in sel.keys()):
437                 mode = sel[module]
438                 if (mode == "SKIP" or mode == "LEGACY" or mode in modelist):
439                         return mode
440                 else:
441                         error("Invalid delaymode '%s' for module '%s'" % (mode, module))
443         if (args.interactive == 0):
444                 warn("No delay modes for %s found, skipping" % module)
445                 mode = "SKIP"
446                 return mode
448         # Display the menu and ask user to select the 'right' mode
449         while True:
450                 print ""
451                 print "MENU: Select delay mode for %s -> %s" % (pad, pin)
452                 i = 0
453                 print "MENU: %d: %s \t\t\t%s" % (i, "SKIP", "Skips this module for now")
454                 i = 1
455                 print "MENU: %d: %s \t\t%s" % (i, "LEGACY", "No external delay config (No virtual/manual needed)")
456                 for mode in modelist:
457                         i += 1
458                         if (mode in modehelp):
459                                 helptext = modehelp[mode]
460                         else:
461                                 helptext = "Unknown"
462                         print "MENU: %d: %s \t\t%s" % (i, mode, helptext)
463                 try:
464                         choice = int(raw_input("Select delay mode #> "))
465                         if (choice == 0):
466                                 mode = "SKIP"
467                                 break
468                         elif (choice == 1):
469                                 mode = "LEGACY"
470                                 break
471                         elif (choice >=2 and choice <= len(modelist) + 1):
472                                 mode = modelist[choice - 2]
473                                 break
474                         print "ERROR: Invalid choice"
475                 except ValueError:
476                         print "ERROR: Invalid choice"
477         print "MENU: Selected mode is %s" % mode
478         print ""
480         return mode
481 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
483 # Pad read using GPIO - Specific to linux only
484 # As each pad is muxed with a SoC gpio (for most of the pads)
485 # It's possible to read the pad data using gpio datain registers
486 # Change pad register to enable input path and export sysfs
487 # Use sysfs to read the status of GPIO and print in a loop
488 def pad_dump_gpio(padconf, per_padconf):
489         gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
490         module = args.module
492         # script header
493         gen_header = "###########################################\n" + \
494                      "# Read %s signals using GPIO sysfs\n" % module + \
495                      "###########################################\n\n"
496         gen_data = "%s_data=(\n" % module
498         for i in padconf:
499                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
501                 offset = addr - 0x4a002000
502                 gpio_name = xml_model_get_signal(offset, 14)
503                 matchlist = re.match("GPIO(.)_(.*)", gpio_name)
504                 if (matchlist == None):
505                         error("No GPIO for pad %s - cannot read from script" % pad_name)
506                         continue
508                 inst = int(matchlist.groups(0)[0])
509                 bit = int(matchlist.groups(0)[1])
510                 gpio_addr = gpio_data_addrs[inst]
511                 ngpio = (inst - 1) * 32 + bit
512                 pin_short = re.match(".+_(.*)", pin_name).groups(0)[0]
514                 gen_data += "\t%s:0x%x:%s:%d:0x%x:%d\n" % (pin_short, addr, gpio_name, ngpio, gpio_addr, bit)
516         gen_data += ")\n\n"
518         # Main script to probe the signal
519         gen_main = "echo; echo Probing %s signals\n\n" % module + \
520                    "for data in ${%s_data[@]}\n" % module + \
521                    "do\n" + \
522                    "    pin=`echo $data | cut -d ':' -f1`\n" + \
523                    "    pad=`echo $data | cut -d ':' -f2`\n" + \
524                    "    ngpio=`echo $data | cut -d ':' -f4`\n" + \
525                    "    echo $ngpio > /sys/class/gpio/export 2>/dev/null\n" + \
526                    "    omapconf set bit $pad 18 1>/dev/null 2>/dev/null\n" + \
527                    "    printf \"%8s\" $pin\n" + \
528                    "done\n" + \
529                    "echo\n\n"
531         gen_main += "while true;\n" + \
532                     "do\n" + \
533                     "    for data in ${%s_data[@]}\n" % module + \
534                     "    do\n" + \
535                     "#       pin=`echo $data | cut -d ':' -f1`\n" + \
536                     "#        pad=`echo $data | cut -d ':' -f2`\n" + \
537                     "#       gpio=`echo $data | cut -d ':' -f3`\n" + \
538                     "        ngpio=`echo $data | cut -d ':' -f4`\n" + \
539                     "#       addr=`echo $data | cut -d ':' -f5`\n" + \
540                     "#       bit=`echo $data | cut -d ':' -f6`\n" + \
541                     "        val=`cat /sys/class/gpio/gpio$ngpio/value`\n" + \
542                     "        printf %8d $val \n" + \
543                     "    done\n" + \
544                     "    echo\n" + \
545                     "done\n\n"
547         gen_footer = "###########################################\n"
549         # Generate the shell script
550         gen_script = gen_header + gen_data + gen_main + gen_footer
551         filename = ("./%s-probe.sh" % module).lower()
552         print "Generating '%s' script..." % filename
553         gen_file = open(filename, "w+")
554         gen_file.write(gen_script)
556 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
558 # Generate the final pad and delay data in the required format
559 def format_pad_regs(padconf, per_padconf):
560         print "######## Pad data output ########"
561         if (args.format == "uboot"):
562                 uboot_format_pad_regs(padconf, per_padconf)
563         elif (args.format == "linux"):
564                 linux_format_pad_regs(padconf, per_padconf)
565         elif (args.format == "bios"):
566                 bios_format_pad_regs(padconf, per_padconf)
567         else:
568                 error("Format %s not suppported" % args.format)
570 def format_delay_regs(delayconf, per_delayconf):
571         print "######## Delay data output ########"
572         if (args.format == "uboot"):
573                 uboot_format_delay_regs(delayconf, per_delayconf)
574         elif (args.format == "linux"):
575                 linux_format_delay_regs(delayconf, per_delayconf)
576         elif (args.format == "bios"):
577                 bios_format_delay_regs(delayconf, per_delayconf)
578         else:
579                 error("Format %s not suppported" % args.format)
581 def get_pin_info(val):
582         slew_fast = (val >> 19) & 0x1
583         inp_en = (val >> 18) & 0x1
584         pulltype = (val >> 17) & 0x1
585         pull_dis = (val >> 16) & 0x1
586         pin = "PIN"
587         if (inp_en):
588                 pin += "_INPUT"
589         else:
590                 pin += "_OUTPUT"
591         if (pull_dis == 0):
592                 if (pulltype):
593                         pin += "_PULLUP"
594                 else:
595                         pin += "_PULLDOWN"
596         if (slew_fast):
597                 pin += " | SLEWCONTROL"
598         return pin
600 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
602 # Generate output in u-boot format
603 def uboot_format_pad_regs(padconf, per_padconf):
604         print "\nconst struct pad_conf_entry dra74x_core_padconf_array[] = {"
605         for i in padconf:
606                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
608                 muxmode = val & 0xf
609                 (method, data) = delayinfo
610                 if (method == "LEGACY"):
611                         extramode = ""
612                 elif (method == "VIRTUAL"):
613                         delaymode = data
614                         extramode = " | VIRTUAL_MODE%d" % delaymode
615                 elif (method == "MANUAL"):
616                         extramode = " | MANUAL_MODE"
617                 else:
618                         error("Invalid delay method %s" % method)
620                 pin_info = get_pin_info(val) + extramode
621                 pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
622                 comment = (pad_short + "." + pin_name).lower()
624                 print "\t{ %s, (M%d | %s) },\t/* %s */" % (pad_short, muxmode, pin_info, comment)
625         print "};\n"
627 def uboot_format_delay_regs(delayconf, per_delayconf):
628         manual_del = []
629         for i in delayconf:
630                 (pad_name, pin_name, regname, del_offset, man_name, adel, gdel) = i
632                 entry = (del_offset, adel, gdel, regname, pin_name, man_name)
633                 manual_del.append(entry)
635         es_rev = args.revision.replace('.', '_')
636         print "\nconst struct iodelay_cfg_entry dra742_es" + es_rev + "_iodelay_cfg_array[] = {"
637         for entry in sorted(manual_del):
638                 print "\t{ 0x%04X, %5d, %5d },\t/* %s : %s - %s */" % entry
639         print "};\n"
641 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
643 # Generate output in linux format
644 def linux_format_pad_regs(padconf, per_padconf):
645         print "&dra7_pmx_core {"
646         for per in per_padconf:
648                 if (re.match("MMC.*", per) == None):
649                         warn("Only MMC padconf is recommended in kernel")
651                 # Get the mode from the first entry
652                 (pad_name, pin_name, addr, val, mode, delayinfo) = per_padconf[per][0]
654                 dtsnode = ("%s_pins_%s" % (per, mode)).lower()
655                 print ""
656                 print "\t%s: %s {" % (dtsnode, dtsnode)
657                 print "\t\tpinctrl-single,pins = <"
658                 for i in per_padconf[per]:
659                         (pad_name, pin_name, addr, val, mode, delayinfo) = i
661                         muxmode = val & 0xf
662                         (method, data) = delayinfo
663                         if (method == "LEGACY"):
664                                 extramode = ""
665                         elif (method == "VIRTUAL"):
666                                 delaymode = data
667                                 extramode = " | MUX_VIRTUAL_MODE%d" % delaymode
668                         elif (method == "MANUAL"):
669                                 extramode = " | MANUAL_MODE"
670                         else:
671                                 warn("Invalid method %s" % method)
673                         pin_info = get_pin_info(val) + extramode
674                         pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
675                         offset = addr - 0x4a003400
676                         comment = (pad_short + "." + pin_name).lower()
678                         print "\t\t\t0x%03X\t(%s | MUX_MODE%d)\t/* %s */" % (offset, pin_info, muxmode, comment)
679                 print "\t\t>;"
680                 print "\t};"
681         print "};\n"
684 def linux_format_delay_regs(delayconf, per_delayconf):
685         print "&dra7_iodelay_core {"
686         for per in per_delayconf.keys():
688                 if (re.match("MMC.*", per) == None):
689                         warn("Only MMC delayconf is recommended in kernel")
691                 # Get the mode from the first entry
692                 (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = per_delayconf[per][0]
694                 dtsnode = ("%s_iodelay_%s_conf" % (per, mode)).lower()
695                 print "\t%s: %s {" % (dtsnode, dtsnode)
696                 print "\t\tpinctrl-single,pins = <"
697                 for i in per_delayconf[per]:
698                         (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = i
700                         print "\t\t\t0x%03X (A_DELAY(%d) | G_DELAY(%d))\t/* %s */" % (del_offset, adel, gdel, regname)
701                 print "\t\t>;"
702                 print "\t};"
703         print "};\n"
705 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
707 # Generate output in bios format
708 def bios_format_pad_regs(padconf, per_padconf):
709         for i in padconf:
710                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
712                 delaylist = []
713                 (method, data) = delayinfo
714                 if (method == "VIRTUAL"):
715                         virt_mode = data
716                         val = val | ( virt_mode<< 4)
717                         val = val | (1 << 8)
718                 elif (method == "MANUAL"):
719                         delaylist = data
720                         val = val | (1 << 8)
722                 offset = addr - 0x4a003400
723                 out_delreg = out_adel = out_gdel = 0
724                 in_delreg  = in_adel  = in_gdel  = 0
725                 oen_delreg = oen_adel = oen_gdel = 0
727                 for j in delaylist:
728                         (regname, adel, gdel) = j
729                         if (re.match(".*_IN", regname) != None):
730                                 in_delreg = xml_iodelay_get_reg(regname)
731                                 in_adel = adel
732                                 in_gdel = gdel
733                         elif (re.match(".*_OEN", regname) != None):
734                                 oen_delreg = xml_iodelay_get_reg(regname)
735                                 oen_adel = adel
736                                 oen_gdel = gdel
737                         elif (re.match(".*_OUT", regname) != None):
738                                 out_delreg = xml_iodelay_get_reg(regname)
739                                 out_adel = adel
740                                 out_gdel = gdel
741                 indel  = "{ 0x%04X, %4d, %4d , 0}" % (in_delreg,  in_adel,  in_gdel)
742                 oendel = "{ 0x%04X, %4d, %4d , 0}" % (oen_delreg, oen_adel, oen_gdel)
743                 outdel = "{ 0x%04X, %4d, %4d , 0}" % (out_delreg, out_adel, out_gdel)
744                 pin_info = get_pin_info(val)
745                 print "\t/* %s -> %s (%s) %s delaymode */" % (pad_name, pin_name, pin_info, method)
746                 print "\t{ 0x%03X, 0x%08X, %s, %s, %s }" % (offset, val, indel, oendel, outdel)
748 def bios_format_delay_regs(delayconf, per_delayconf):
749         debug("Manual delays are not configured separately")
750         debug("Delays are configured as part of the padconf step only")
752 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
754 # Main execution starts here
755 # * Parse all the XML files - Get the pad data and IOdelay data
756 # * Iterate over the pad register dumps
757 # * For each pad, find out the muxmode being used and the pad direction, etc
758 # * For the muxmode being used, find out available virtual/modes
759 #   - Dump the virtual/manual modes available (based on options)
760 #   - Build up the gpio script to read the pad data using GPIO module
761 # * Select the correct mode to be used
762 #   - Check if the mode is described for the peripheral module, (from selected-modes.txt)
763 #   - Otherwise ask the user (with a menu) to decide the delaymode
764 #     => Update the selection for the whole of the peripheral module
765 #   - Worst case, skip the delaymode for this pad
766 # * Build the pad and delay register information
767 # * Create the dump for pad and delay data in linux/u-boot format
768 # * Dump the delaymode selection for each peripheral
769 # * Dump the GPIO script for each peripheral (all pads grouped together)
772 # List of all the pads being configured
773 padconf = []
774 # List of all the delay registers being configured (for manual mode)
775 delayconf = []
776 # Dictionary of pads grouped by peripheral/module
777 per_padconf = {}
778 # Dictionary of delay registers grouped by peripheral/module
779 per_delayconf = {}
781 if(args.check_xml):
782         xml_check_correctness(modehelp)
783         exit()
785 # Start iterating over each pad
786 for i in range(0, 260):
787         # Find out the muxmode and pad direction, etc
788         addr = 0x4a003400 + i * 4
789         offset = 0x1400 + i * 4
790         dts_offset = offset - 0x1400
792         if (addr not in reglist):
793                 warn("Register dump for pad 0x%X not found" % addr)
794                 continue
795         val = regmap[addr]
796         muxmode = val & 0xf
798         # Find out the pin based on the muxmode
799         pad_name = xml_pad_get_name(offset)
800         pin_name = xml_model_get_signal(offset, muxmode)
801         if (pad_name == "Unknown" or pin_name == "Unknown"):
802                 warn("Cannot find out Pad/Pin name for PAD address 0x%X (%s[%s] = %s)" \
803                 % (addr, pad_name, muxmode, pin_name))
804                 continue
805         if (pin_name == "DRIVER"):
806                 continue
808         # Find out if the delaymode for this module is already selected
809         match = re.match("([^_]+)_.*", pin_name)
810         if (match):
811                 module = match.groups(0)[0]
812         else:
813                 module = pin_name
815         if (args.module != "" and re.match("%s" % args.module, module) == None):
816                 continue
818         # It is recommended to keep the reset value of the slewcontrol bit
819         # Find out the reset value from XML and update if required
820         if (args.resetslew):
821                 val |= (xml_pad_get_slew(offset) & 0x1) << 19
823         debug("PAD: %s: Addr= 0x%08X Value = 0x%08X \"%s\"" \
824                 % (pad_name, addr, val, pin_name))
826         # Find out all the possible virtual, manual modes fot the specific pad -> pin combination
827         (virt, man) = xml_find_delaymodes(pad_name, muxmode)
829         if (args.gpio == True):
830                 mode = "LEGACY"
831         else:
832                 # Need to select one out of allowed modes
833                 mode = select_mode(pad_name, pin_name, module, virt, man, modehelp, sel)
835         # Remember the selection for that module, for later reuse
836         if (args.strict == False and module not in sel.keys()):
837                 sel[module] = mode
839         if (mode == "SKIP"):
840                 continue
841         elif (mode == "LEGACY"):
842                 delayinfo = ("LEGACY", "")
843         elif (mode in virt):
844                 delayinfo = ("VIRTUAL", virt[mode])
845         elif (mode in man):
846                 delayinfo = ("MANUAL", man[mode])
847         else:
848                 error("Unknown mode '%s' selected" % mode)
849                 continue
851         debug("  => Using mode %s" % mode)
852         paddata = (pad_name, pin_name, addr, val, mode, delayinfo)
853         if (module not in per_padconf.keys()):
854                 per_padconf[module] = []
855         padconf.append(paddata)
856         per_padconf[module].append(paddata)
858         if(mode not in man):
859                 continue
861         # Add the delay data if using manual mode
862         for regval in man[mode]:
863                 (regname, adel, gdel) = regval
864                 del_offset = xml_iodelay_get_reg(regname)
865                 if (del_offset == 0):
866                         error("Can't find delay offset of register %s" % regname)
867                         break
868                 debug("  => Manual delay[%s] = (%d, %d)" % (regname, adel, gdel))
869                 delaydata = (pad_name, pin_name, regname, del_offset, mode, adel, gdel)
870                 if (module not in per_delayconf.keys()):
871                         per_delayconf[module] = []
872                 delayconf.append(delaydata)
873                 per_delayconf[module].append(delaydata)
875 if(args.gpio == True):
876         pad_dump_gpio(padconf, per_padconf)
877         exit()
879 format_pad_regs(padconf, per_padconf)
880 format_delay_regs(delayconf, per_delayconf)
882 if (args.interactive):
883         # Summary of the generated data
884         print ""
885         print "Total PAD registers: %d" % len(padconf)
886         print "Total DELAY registers: %d" % len(delayconf)
887         print ""
888         # Dump the final selection for reuse
889         print "Selected modes for each peripheral module\n"
890         for group in sel:
891                 print "%s,\t%s" % (group, sel[group])
892         print ""
893 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #