script: Add option to filter module and to dump gpio
[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 pad_data_xml = "XMLFiles/CTRL_MODULE_CORE.xml"
20 iod_data_xml = "XMLFiles/IODELAYCONFIG.xml"
21 model_data_xml = "XMLFiles/model_DRA75x_DRA74x_SR1.1_v1.0.6.xml"
22 modehelp_file = "guidelines.txt"
24 pad_file = "ctrl-core.dump"
25 sel_file = "selected-modes.txt"
27 # Handle the command line arguments
28 parser = argparse.ArgumentParser(prog='iodelay-autogen.py',
29         description='Python script to generate the IOdelay data',
30         epilog='Generate the pad and delay data using pad regdump')
32 parser.add_argument('-d', '--debug', dest='debug',
33         action='store', type=int, choices=[0, 1, 2], default=0,
34         help='set the debug level')
36 parser.add_argument('-i', '--interactive', dest='interactive',
37         action='store', type=int, choices=[0, 1], default=1,
38         help='run interactively with menus for resolving conflicts')
40 parser.add_argument('-f', '--format', dest='format',
41         action='store', type=str, choices=["linux", "uboot"], default="uboot",
42         help='select the output format to be used')
44 parser.add_argument('-m', '--module', dest='module',
45         action='store', type=str, default="",
46         help='generate only for this module')
48 parser.add_argument('-g', '--gpio', dest='gpio',
49         action='store_true',
50         help='generate script to read pad data from GPIO')
52 args = parser.parse_args()
53 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
55 # Read the XML file database for pad and delay registers
56 pad_xml = ET.parse(pad_data_xml).getroot()
57 iod_xml = ET.parse(iod_data_xml).getroot()
58 model_xml = ET.parse(model_data_xml).getroot()
60 # Functions to parse the input files and build data structures
61 def read_guidelines(fname):
62         modehelp = {}
63         pattern = re.compile('(.+\w)\t+(.+)')
64         f = open(fname)
65         for line in f.readlines():
66                 list = re.match(pattern, line)
67                 if ( list == None):
68                         continue
69                 mode = list.groups(0)[0]
70                 info = list.groups(0)[1]
71                 modehelp[mode] = info
72                 if (args.debug >= 2):
73                         print "Help: Mode '%s' is used for '%s'" % (mode, info)
74         return modehelp
76 def read_selmodes(fname):
77         sel = {}
78         pattern = re.compile('(\w+)\W*,\W*(\w*)')
79         f = open(fname)
80         for line in f.readlines():
81                 list = re.match(pattern, line)
82                 if ( list == None):
83                         continue
84                 module = list.groups(0)[0]
85                 mode = list.groups(0)[1]
86                 sel[module] = mode
87                 if (args.debug >= 2):
88                         print "INFO: Select '%s' for '%s'" % (mode, module)
89         return sel
91 def read_pad_dump(file):
92         regmap = {}
93         pattern = re.compile('.*(0x[0-9A-F]+).*(0x[0-9A-F]+).*')
94         f = open(file, 'r')
95         for line in f:
96                 list = re.match(pattern, line)
97                 if ( list == None):
98                         continue
99                 addr = int(list.groups(0)[0], 16)
100                 val = int(list.groups(0)[1], 16)
101                 #print "PADXML: Addr = %08x Value = %08x" % (addr, val)
102                 regmap[addr] = val
103         return regmap
104 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
106 # Helper functions to parse XML nodes and get the desired data
107 # Hugely dependent on the XML format of the PCT files
108 # Uses XPath to search elements with queries and filters
109 # Parse the nodes to generate data in desired format
111 def xml_pad_get_name(offset):
112         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
113         if (len(padlist) == 0):
114                 return "Unknown"
115         else:
116                 return padlist[0].get("id")
118 def xml_pad_get_pin(offset, muxmode):
119         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
120         if (len(padlist) == 0):
121                 return "Unknown"
122         else:
123                 mux_field = padlist[0].findall("./bitfield[@end='0']")
124                 if (len(mux_field) == 0):
125                         return "Unknown"
126                 modes = mux_field[0].findall("./bitenum[@value='%d']" % muxmode)
127                 if (len(modes) == 0):
128                         return "Unknown"
129                 return modes[0].get("id")
131 def xml_iodelay_get_reg(name):
132         delaylist = iod_xml.findall("register[@id='%s']" % name)
133         if (len(delaylist) == 0):
134                 return 0
135         else:
136                 offset = delaylist[0].get("offset")
137                 #print "IOD: Name = %s Offset = %s" % (del_reg, offset)
138                 return int(offset, 16)
140 def xml_get_virtual(mode):
141         vmodes = {}
142         signal = mode.findtext("signal")
143         for virt in mode.findall("virtualmode/mode"):
144                 virt_mode = virt.findtext("value")
145                 virt_name = virt.findtext("name")
146                 if (virt_name == "NA"):
147                         continue
148                 virt_mode = int(virt_mode)
149                 vmodes[virt_name] = virt_mode
150                 if (args.debug >= 1):
151                         print ("    * VIRTUAL: %s [%s] => delaymode = %d" % (signal, virt_name, virt_mode))
152         return vmodes
154 def xml_get_manual(mode):
155         mmodes = {}
156         signal = mode.findtext("signal")
157         for man in mode.findall("manualmode"):
158                 regname = man.findtext("cfgreg/name")
159                 for sel in man.findall("cfgreg/mode"):
160                         adel = sel.findtext("adelay")
161                         gdel = sel.findtext("gdelay")
162                         man_name = sel.findtext("name")
163                         if (man_name == "NA"):
164                                 continue
165                         adel = int(adel)
166                         gdel = int(gdel)
167                         if (man_name not in mmodes.keys()):
168                                 mmodes[man_name] = []
169                         mmodes[man_name].append((regname, adel, gdel))
170                         if (args.debug >= 1):
171                                 print ("    * MANUAL: %s [%s] => delay[%s] = %d, %d" % (signal, man_name, regname, adel, gdel))
172         return mmodes
173                 
175 def xml_find_delaymodes(pad_name, muxmode):
176         padlist = model_xml.findall("padDB/clockNode/type/pad")
177         for pad in padlist:
178                 if (pad_name == pad.findtext("confregisters/regbit/register")):
179                         muxmodes = pad.findall("muxmode")
180                         break
181         if not muxmodes:
182                 return None
183         for mode in muxmodes:
184                 if ("%d" % muxmode == mode.findtext("mode")):
185                         virt = xml_get_virtual(mode)
186                         man = xml_get_manual(mode)
187                         return (virt, man)
188         return None
189 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
191 # Decision point of the script
192 # For each pad/pin, decide what delay method is used
193 # Lookup in the selection file or ask user with a menu
194 def select_mode(pad, pin, module, virt, man, modehelp, sel):
195         modelist = []
196         for modename in virt.keys():
197                 modelist.append(modename)
199         for modename in man.keys():
200                 modelist.append(modename)
202         if (len(modelist) == 0):
203                 return "LEGACY"
205         if (module in sel.keys()):
206                 mode = sel[module]
207                 if (mode == "SKIP" or mode in modelist):
208                         return mode
209                 else:
210                         print("ERR: Invalid delaymode '%s' for module '%s'" & (mode, module))
212         if (args.interactive == 0):
213                 print "WARN: No delay modes for %s found, skipping" % module
214                 mode = "SKIP"
215                 sel[module] = mode
216                 return mode
218         # Display the menu and ask user to select the 'right' mode
219         while True:
220                 print ""
221                 print "MENU: Select delay mode for %s -> %s" % (pad, pin)
222                 i = 0
223                 print "MENU: %d: %s \t\t\t%s" % (i, "SKIP", "Skips this module for now")
224                 for mode in modelist:
225                         i += 1
226                         print "MENU: %d: %s \t\t%s" % (i, mode, modehelp[mode])
227                 try:
228                         choice = int(raw_input("Select delay mode #> "))
229                         if (choice == 0):
230                                 mode = "SKIP"
231                                 break
232                         elif (choice >=0 and choice <= len(modelist)):
233                                 mode = modelist[choice - 1]
234                                 break
235                         print "ERROR: Invalid choice"
236                 except ValueError:
237                         print "ERROR: Invalid choice"
238         print "MENU: Selected mode is %s" % mode
239         print ""
241         # Remember the selection for that module, for later reuse
242         sel[module] = mode
243         return mode
244 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
246 # Pad read using GPIO - Specific to linux only
247 # As each pad is muxed with a SoC gpio (for most of the pads)
248 # It's possible to read the pad data using gpio datain registers
249 # Dump the linux commands to read the gpio registers and read the pad data
250 def pad_dump_gpio(padconf, per_padconf):
251         if(args.gpio == False):
252                 return
254         print "# Read pad signals using GPIO DATA-IN registers"
255         print "# Works only for the input signals"
256         gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
257         for i in padconf:
258                 (pad_name, pin_name, addr, val, delayinfo) = i
260                 offset = addr - 0x4a002000
261                 gpio_name = xml_pad_get_pin(offset, 14)
262                 matchlist = re.match("GPIO(.)_(.)", gpio_name)
263                 if (matchlist == None):
264                         print "ERR: No GPIO for pad %s" % pad_name
265                         continue
267                 inst = int(matchlist.groups(0)[0])
268                 bit = int(matchlist.groups(0)[1])
269                 gpio_addr = gpio_data_addrs[inst]
271                 print "#Read GPIO%d_%d to sample %s" % (inst, bit, pin_name)
272                 print " echo %d > /sys/class/gpio/export 2>/dev/null;" % ((inst - 1) * 32)
273                 print " val=`omapconf read 0x%x 2>&1 | grep -v \"support\"`;" % gpio_addr
274                 print " status=$((0x$val >> %d & 0x1));" % bit
275                 print " echo -e \"%s (%s)\t = $status\";" % (pin_name, gpio_name)
276                 print ""
277         print ""
278 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
280 # Generate the final pad and delay data in the required format
281 def format_pad_regs(padconf, per_padconf):
282         print "###########################################"
283         print "Pad data for u-boot (with the delay modes):"
284         print "###########################################"
285         if (args.format == "uboot"):
286                 uboot_format_pad_regs(padconf, per_padconf)
287         elif (args.format == "linux"):
288                 linux_format_pad_regs(padconf, per_padconf)
289         else:
290                 print "ERR: Format %s not suppported" % args.format
292 def format_delay_regs(delayconf, per_delayconf):
293         print "#########################################"
294         print "Delay data for u-boot (for manual modes):"
295         print "#########################################"
296         if (args.format == "uboot"):
297                 uboot_format_delay_regs(delayconf, per_delayconf)
298         elif (args.format == "linux"):
299                 linux_format_delay_regs(delayconf, per_delayconf)
300         else:
301                 print "ERR: Format %s not suppported" % args.format
303 def get_pin_info(val):
304         inp_en = (val >> 18) & 0x1
305         pulltype = (val >> 17) & 0x1
306         pull_dis = (val >> 16) & 0x1
307         pin = "PIN"
308         if (inp_en):
309                 pin += "_INPUT"
310         else:
311                 pin += "_OUTPUT"
312         if (pull_dis == 0):
313                 if (pulltype):
314                         pin += "_PULLUP"
315                 else:
316                         pin += "_PULLDOWN"
317         return pin
319 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
321 # Generate output in u-boot format
322 def uboot_format_pad_regs(padconf, per_padconf):
323         print "\nconst struct pad_conf_entry dra74x_core_padconf_array[] = {"
324         for i in padconf:
325                 (pad_name, pin_name, addr, val, delayinfo) = i
327                 if (re.match("MMC.*", pin_name) != None):
328                         print "WARN: Skipping MMC padconf in uboot"
329                         continue
331                 muxmode = val & 0xf
332                 (method, data) = delayinfo
333                 if (method == "LEGACY"):
334                         extramode = ""
335                 elif (method == "VIRTUAL"):
336                         delaymode = data
337                         extramode = " | VIRTUAL_MODE%d" % delaymode
338                 elif (method == "MANUAL"):
339                         extramode = " | MANUAL_MODE"
340                 else:
341                         print "ERR: Invalid method %s" % method
343                 pin_info = get_pin_info(val) + extramode
344                 pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
345                 comment = (pad_short + "." + pin_name).lower()
347                 print "\t{ %s, (M%d | %s) },\t/* %s */" % (pad_short, muxmode, pin_info, comment)
348         print "};\n"
350 def uboot_format_delay_regs(delayconf, per_delayconf):
351         print "\nconst struct iodelay_cfg_entry dra742_iodelay_cfg_array[] = {"
352         for i in delayconf:
353                 (pad_name, pin_name, regname, del_offset, man_name, adel, gdel) = i
355                 if (re.match("MMC.*", pin_name) != None):
356                         print "WARN: Skipping MMC padconf in uboot"
357                         continue
359                 print "\t{ 0x%04X, %5d, %5d },\t/* %s */" % (del_offset, adel, gdel, regname)
360         print "};\n"
361 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
363 # Generate output in linux format
364 def linux_format_pad_regs(padconf, per_padconf):
365         print "&dra7_pmx_core {"
366         for per in per_padconf:
368                 if (re.match("MMC.*", per) == None):
369                         print "ERR: Only MMC padconf is recommended in kernel"
370                         continue
372                 dtsnode = ("%s_pins_default" % per).lower()
373                 print ""
374                 print "\t%s: %s {" % (dtsnode, dtsnode)
375                 print "\t\tpinctrl-single,pins = <"
376                 for i in per_padconf[per]:
377                         (pad_name, pin_name, addr, val, delayinfo) = i
379                         muxmode = val & 0xf
380                         (method, data) = delayinfo
381                         if (method == "LEGACY"):
382                                 extramode = ""
383                         elif (method == "VIRTUAL"):
384                                 delaymode = data
385                                 extramode = " | VIRTUAL_MODE%d" % delaymode
386                         elif (method == "MANUAL"):
387                                 extramode = " | MANUAL_MODE"
388                         else:
389                                 print "ERR: Invalid method %s" % method
391                         pin_info = get_pin_info(val) + extramode
392                         pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
393                         offset = addr - 0x4a003400
394                         comment = (pad_short + "." + pin_name).lower()
396                         print "\t\t\t0x%03X\t(%s | MUM_MODE%d)\t/* %s */" % (offset, pin_info, muxmode, comment)
397                 print "\t\t>;"
398                 print "\t};"
399         print "};\n"
402 def linux_format_delay_regs(delayconf, per_delayconf):
403         print "&dra7_iodelay_core {"
404         for per in per_delayconf.keys():
406                 if (re.match("MMC.*", per) == None):
407                         print "ERR: Only MMC delayconf is recommended in kernel"
408                         continue
410                 # Get the mode from the first entry
411                 (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = per_delayconf[per][0]
413                 dtsnode = ("%s_iodelay_%s_conf" % (per, mode)).lower()
414                 print "\t%s: %s {" % (dtsnode, dtsnode)
415                 print "\t\tpinctrl-single,pins = <"
416                 for i in per_delayconf[per]:
417                         (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = i
419                         print "\t\t\t0x%03X A_DELAY(%d) | G_DELAY(%d)\t/* %s */" % (del_offset, adel, gdel, regname)
420                 print "\t\t>;"
421                 print "\t};"
422         print "};\n"
424 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
426 # Main execution starts here
427 # * Parse all the XML files - Get the pad data and IOdelay data
428 # * Iterate over the pad register dumps
429 # * For each pad, find out the muxmode being used and the pad direction, etc
430 # * For the muxmode being used, find out available virtual/modes
431 #   - Dump the virtual/manual modes available (based on options)
432 #   - Build up the gpio script to read the pad data using GPIO module
433 # * Select the correct mode to be used
434 #   - Check if the mode is described for the peripheral module, (from selected-modes.txt)
435 #   - Otherwise ask the user (with a menu) to decide the delaymode
436 #     => Update the selection for the whole of the peripheral module
437 #   - Worst case, skip the delaymode for this pad
438 # * Build the pad and delay register information
439 # * Create the dump for pad and delay data in linux/u-boot format
440 # * Dump the delaymode selection for each peripheral
441 # * Dump the GPIO script for each peripheral (all pads grouped together)
444 # Read all the input files and parse the required info
445 modehelp = read_guidelines(modehelp_file)
446 sel = read_selmodes(sel_file)
447 regmap = read_pad_dump(pad_file)
448 reglist = regmap.keys()
450 # List of all the pads being configured
451 padconf = []
452 # List of all the delay registers being configured (for manual mode)
453 delayconf = []
454 # Dictionary of pads grouped by peripheral/module
455 per_padconf = {}
456 # Dictionary of delay registers grouped by peripheral/module
457 per_delayconf = {}
459 # Start iterating over each pad
460 for i in range(0, 260):
461         # Find out the muxmode and pad direction, etc
462         addr = 0x4a003400 + i * 4
463         offset = 0x1400 + i * 4
464         dts_offset = offset - 0x1400
466         if (addr not in reglist):
467                 print "WARN: Register dump for pad 0x%X not found" % addr
468                 continue
469         val = regmap[addr]
470         muxmode = val & 0xf
472         # Find out the pin based on the muxmode
473         pad_name = xml_pad_get_name(offset)
474         pin_name = xml_pad_get_pin(offset, muxmode)
475         if (pad_name == "Unknown" or pin_name == "Unknown"):
476                 print "WARN: Cannot find out Pad/Pin name for PAD address 0x%X (%s[%s] = %s)" \
477                 % (addr, pad_name, muxmode, pin_name)
478                 continue
479         if (pin_name == "DRIVER OFF"):
480                 continue
482         # Find out if the delaymode for this module is already selected
483         module = re.match("([^_]+)_.*", pin_name).groups(0)[0]
485         if (args.module != "" and args.module != module):
486                 continue
488         if (args.debug >= 1):
489                 print "\nPAD: %s: Addr= 0x%08X Value = 0x%08X \"%s\"" \
490                 % (pad_name, addr, val, pin_name)
492         # Find out all the possible virtual, manual modes fot the specific pad -> pin combination
493         (virt, man) = xml_find_delaymodes(pad_name, muxmode)
495         # Need to select one out of allowed modes
496         mode = select_mode(pad_name, pin_name, module, virt, man, modehelp, sel)
497         if (mode == "SKIP"):
498                 continue
500         if (mode == "LEGACY"):
501                 delayinfo = ("LEGACY", "")
502         elif (mode in virt):
503                 delayinfo = ("VIRTUAL", virt[mode])
504         elif (mode in man):
505                 delayinfo = ("MANUAL", man[mode])
506         else:
507                 print "ERR: Unknown mode '%s' selected" % mode
508                 continue
510         if (args.debug >= 1):
511                 print "  => Using mode %s" % mode
512         paddata = (pad_name, pin_name, addr, val, delayinfo)
513         if (module not in per_padconf.keys()):
514                 per_padconf[module] = []
515         padconf.append(paddata)
516         per_padconf[module].append(paddata)
518         if(mode not in man):
519                 continue
521         # Add the delay data if using manual mode
522         for regval in man[mode]:
523                 (regname, adel, gdel) = regval
524                 del_offset = xml_iodelay_get_reg(regname)
525                 if (del_offset == 0):
526                         print "WARN: Can't find delay offset of register %s" % regname
527                         break
528                 if (args.debug >= 1):
529                         print "  => Manual delay[%s] = (%d, %d)" % (regname, adel, gdel)
530                 delaydata = (pad_name, pin_name, regname, del_offset, mode, adel, gdel)
531                 if (module not in per_delayconf.keys()):
532                         per_delayconf[module] = []
533                 delayconf.append(delaydata)
534                 per_delayconf[module].append(delaydata)
536 print ""
537 print "Total PAD registers: %d" % len(padconf)
538 print "Total DELAY registers: %d" % len(delayconf)
539 print ""
541 format_pad_regs(padconf, per_padconf)
542 format_delay_regs(delayconf, per_delayconf)
543 pad_dump_gpio(padconf, per_padconf)
545 # Dump the final selection for reuse
546 print "Selected modes for each peripheral module\n"
547 for group in sel:
548         print "%s,\t%s" % (group, sel[group])
549 print ""
550 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #