script: Add support for output format linux and uboot
[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 args = parser.parse_args()
45 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
47 # Read the XML file database for pad and delay registers
48 pad_xml = ET.parse(pad_data_xml).getroot()
49 iod_xml = ET.parse(iod_data_xml).getroot()
50 model_xml = ET.parse(model_data_xml).getroot()
52 # Functions to parse the input files and build data structures
53 def read_guidelines(fname):
54         modehelp = {}
55         pattern = re.compile('(.+\w)\t+(.+)')
56         f = open(fname)
57         for line in f.readlines():
58                 list = re.match(pattern, line)
59                 if ( list == None):
60                         continue
61                 mode = list.groups(0)[0]
62                 info = list.groups(0)[1]
63                 modehelp[mode] = info
64                 if (args.debug >= 2):
65                         print "Help: Mode '%s' is used for '%s'" % (mode, info)
66         return modehelp
68 def read_selmodes(fname):
69         sel = {}
70         pattern = re.compile('(\w+)\W*,\W*(\w*)')
71         f = open(fname)
72         for line in f.readlines():
73                 list = re.match(pattern, line)
74                 if ( list == None):
75                         continue
76                 module = list.groups(0)[0]
77                 mode = list.groups(0)[1]
78                 sel[module] = mode
79                 if (args.debug >= 2):
80                         print "INFO: Select '%s' for '%s'" % (mode, module)
81         return sel
83 def read_pad_dump(file):
84         regmap = {}
85         pattern = re.compile('.*(0x[0-9A-F]+).*(0x[0-9A-F]+).*')
86         f = open(file, 'r')
87         for line in f:
88                 list = re.match(pattern, line)
89                 if ( list == None):
90                         continue
91                 addr = int(list.groups(0)[0], 16)
92                 val = int(list.groups(0)[1], 16)
93                 #print "PADXML: Addr = %08x Value = %08x" % (addr, val)
94                 regmap[addr] = val
95         return regmap
96 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
98 # Helper functions to parse XML nodes and get the desired data
99 # Hugely dependent on the XML format of the PCT files
100 # Uses XPath to search elements with queries and filters
101 # Parse the nodes to generate data in desired format
103 def xml_pad_get_name(offset):
104         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
105         if (len(padlist) == 0):
106                 return "Unknown"
107         else:
108                 return padlist[0].get("id")
110 def xml_pad_get_pin(offset, muxmode):
111         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
112         if (len(padlist) == 0):
113                 return "Unknown"
114         else:
115                 mux_field = padlist[0].findall("./bitfield[@end='0']")
116                 if (len(mux_field) == 0):
117                         return "Unknown"
118                 modes = mux_field[0].findall("./bitenum[@value='%d']" % muxmode)
119                 if (len(modes) == 0):
120                         return "Unknown"
121                 return modes[0].get("id")
123 def xml_iodelay_get_reg(name):
124         delaylist = iod_xml.findall("register[@id='%s']" % name)
125         if (len(delaylist) == 0):
126                 return 0
127         else:
128                 offset = delaylist[0].get("offset")
129                 #print "IOD: Name = %s Offset = %s" % (del_reg, offset)
130                 return int(offset, 16)
132 def xml_get_virtual(mode):
133         vmodes = {}
134         signal = mode.findtext("signal")
135         for virt in mode.findall("virtualmode/mode"):
136                 virt_mode = virt.findtext("value")
137                 virt_name = virt.findtext("name")
138                 if (virt_name == "NA"):
139                         continue
140                 virt_mode = int(virt_mode)
141                 vmodes[virt_name] = virt_mode
142                 if (args.debug >= 1):
143                         print ("    * VIRTUAL: %s [%s] => delaymode = %d" % (signal, virt_name, virt_mode))
144         return vmodes
146 def xml_get_manual(mode):
147         mmodes = {}
148         signal = mode.findtext("signal")
149         for man in mode.findall("manualmode"):
150                 regname = man.findtext("cfgreg/name")
151                 for sel in man.findall("cfgreg/mode"):
152                         adel = sel.findtext("adelay")
153                         gdel = sel.findtext("gdelay")
154                         man_name = sel.findtext("name")
155                         if (man_name == "NA"):
156                                 continue
157                         adel = int(adel)
158                         gdel = int(gdel)
159                         if (man_name not in mmodes.keys()):
160                                 mmodes[man_name] = []
161                         mmodes[man_name].append((regname, adel, gdel))
162                         if (args.debug >= 1):
163                                 print ("    * MANUAL: %s [%s] => delay[%s] = %d, %d" % (signal, man_name, regname, adel, gdel))
164         return mmodes
165                 
167 def xml_find_delaymodes(pad_name, muxmode):
168         padlist = model_xml.findall("padDB/clockNode/type/pad")
169         for pad in padlist:
170                 if (pad_name == pad.findtext("confregisters/regbit/register")):
171                         muxmodes = pad.findall("muxmode")
172                         break
173         if not muxmodes:
174                 return None
175         for mode in muxmodes:
176                 if ("%d" % muxmode == mode.findtext("mode")):
177                         virt = xml_get_virtual(mode)
178                         man = xml_get_manual(mode)
179                         return (virt, man)
180         return None
181 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
183 # Decision point of the script
184 # For each pad/pin, decide what delay method is used
185 # Lookup in the selection file or ask user with a menu
186 def select_mode(pad, pin, module, virt, man, modehelp, sel):
187         modelist = []
188         for modename in virt.keys():
189                 modelist.append(modename)
191         for modename in man.keys():
192                 modelist.append(modename)
194         if (len(modelist) == 0):
195                 return "LEGACY"
197         if (module in sel.keys()):
198                 mode = sel[module]
199                 if (mode == "SKIP" or mode in modelist):
200                         return mode
201                 else:
202                         print("ERR: Invalid delaymode '%s' for module '%s'" & (mode, module))
204         if (args.interactive == 0):
205                 print "WARN: No delay modes for %s found, skipping" % module
206                 mode = "SKIP"
207                 sel[module] = mode
208                 return mode
210         # Display the menu and ask user to select the 'right' mode
211         while True:
212                 print ""
213                 print "MENU: Select delay mode for %s -> %s" % (pad, pin)
214                 i = 0
215                 print "MENU: %d: %s \t\t\t%s" % (i, "SKIP", "Skips this module for now")
216                 for mode in modelist:
217                         i += 1
218                         print "MENU: %d: %s \t\t%s" % (i, mode, modehelp[mode])
219                 try:
220                         choice = int(raw_input("Select delay mode #> "))
221                         if (choice == 0):
222                                 mode = "SKIP"
223                                 break
224                         elif (choice >=0 and choice <= len(modelist)):
225                                 mode = modelist[choice - 1]
226                                 break
227                         print "ERROR: Invalid choice"
228                 except ValueError:
229                         print "ERROR: Invalid choice"
230         print "MENU: Selected mode is %s" % mode
231         print ""
233         # Remember the selection for that module, for later reuse
234         sel[module] = mode
235         return mode
236 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
238 # Pad read using GPIO - Specific to linux only
239 # As each pad is muxed with a SoC gpio (for most of the pads)
240 # It's possible to read the pad data using gpio datain registers
241 # Dump the linux commands to read the gpio registers and read the pad data
242 def pad_dump_gpio(addr, offset, pin_name):
243         # Dump the script to read this pad using the gpio data register
244         gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
245         gpio_name = xml_pad_get_pin(offset, 14)
246         matchlist = re.match("GPIO(.)_(.)", gpio_name)
247         if (matchlist == None):
248                 return
249         inst = int(matchlist.groups(0)[0])
250         bit = int(matchlist.groups(0)[1])
251         gpio_addr = gpio_data_addrs[inst]
252         print "echo %d > /sys/class/gpio/export 2>/dev/null;" % (inst - 1) * 32
253         print "val=`omapconf read 0x%x 2>&1 | grep -v \"support\"`;" % gpio_addr
254         print "status=$((0x$val >> %d & 0x1));" % bit
255         print "echo -e \"%s (%s)\t = $status\";" % (pin_name, gpio_name)
256 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
258 # Generate the final pad and delay data in the required format
259 def format_pad_regs(padconf, per_padconf):
260         print "###########################################"
261         print "Pad data for u-boot (with the delay modes):"
262         print "###########################################"
263         if (args.format == "uboot"):
264                 uboot_format_pad_regs(padconf, per_padconf)
265         elif (args.format == "linux"):
266                 linux_format_pad_regs(padconf, per_padconf)
267         else:
268                 print "ERR: Format %s not suppported" % args.format
269         print "###########################################"
271 def format_delay_regs(delayconf, per_delayconf):
272         print "#########################################"
273         print "Delay data for u-boot (for manual modes):"
274         print "#########################################"
275         if (args.format == "uboot"):
276                 uboot_format_delay_regs(delayconf, per_delayconf)
277         elif (args.format == "linux"):
278                 linux_format_delay_regs(delayconf, per_delayconf)
279         else:
280                 print "ERR: Format %s not suppported" % args.format
281         print "###########################################"
283 def get_pin_info(val):
284         inp_en = (val >> 18) & 0x1
285         pulltype = (val >> 17) & 0x1
286         pull_dis = (val >> 16) & 0x1
287         pin = "PIN"
288         if (inp_en):
289                 pin += "_INPUT"
290         else:
291                 pin += "_OUTPUT"
292         if (pull_dis == 0):
293                 if (pulltype):
294                         pin += "_PULLUP"
295                 else:
296                         pin += "_PULLDOWN"
297         return pin
299 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
301 # Generate output in u-boot format
302 def uboot_format_pad_regs(padconf, per_padconf):
303         print "\nconst struct pad_conf_entry dra74x_core_padconf_array[] = {"
304         for i in padconf:
305                 (pad_name, pin_name, addr, val, delayinfo) = i
306                 muxmode = val & 0xf
307                 (method, data) = delayinfo
308                 if (method == "LEGACY"):
309                         extramode = ""
310                 elif (method == "VIRTUAL"):
311                         delaymode = data
312                         extramode = " | VIRTUAL_MODE%d" % delaymode
313                 elif (method == "MANUAL"):
314                         extramode = " | MANUAL_MODE"
315                 else:
316                         print "ERR: Invalid method %s" % method
318                 pin_info = get_pin_info(val) + extramode
319                 pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
320                 comment = (pad_short + "." + pin_name).lower()
321                 print "\t{ %s, (M%d | %s) },\t/* %s */" % (pad_short, muxmode, pin_info, comment)
322         print "};\n"
324 def uboot_format_delay_regs(delayconf, per_delayconf):
325         print "\nconst struct iodelay_cfg_entry dra742_iodelay_cfg_array[] = {"
326         for i in delayconf:
327                 (pad_name, pin_name, regname, del_offset, man_name, adel, gdel) = i
328                 print "\t{ 0x%04X, %5d, %5d },\t/* %s */" % (del_offset, adel, gdel, regname)
329         print "};\n"
330 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
332 # Generate output in linux format
333 def linux_format_pad_regs(padconf, per_padconf):
334         print "&dra7_pmx_core {"
335         for per in per_padconf:
337                 if (re.match("MMC.*", per) == None):
338                         print "ERR: Only MMC padconf is recommended in kernel"
339                         continue
341                 dtsnode = ("%s_pins_default" % per).lower()
342                 print ""
343                 print "\t%s: %s {" % (dtsnode, dtsnode)
344                 print "\t\tpinctrl-single,pins = <"
345                 for i in per_padconf[per]:
346                         (pad_name, pin_name, addr, val, delayinfo) = i
347                         muxmode = val & 0xf
348                         (method, data) = delayinfo
349                         if (method == "LEGACY"):
350                                 extramode = ""
351                         elif (method == "VIRTUAL"):
352                                 delaymode = data
353                                 extramode = " | VIRTUAL_MODE%d" % delaymode
354                         elif (method == "MANUAL"):
355                                 extramode = " | MANUAL_MODE"
356                         else:
357                                 print "ERR: Invalid method %s" % method
359                         pin_info = get_pin_info(val) + extramode
360                         pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
361                         offset = addr - 0x4a003400
362                         comment = (pad_short + "." + pin_name).lower()
363                         print "\t\t\t0x%03X\t(%s | MUM_MODE%d)\t/* %s */" % (offset, pin_info, muxmode, comment)
364                 print "\t\t>;"
365                 print "\t};"
366         print "};\n"
369 def linux_format_delay_regs(delayconf, per_delayconf):
370         print "&dra7_iodelay_core {"
371         for per in per_delayconf.keys():
373                 if (re.match("MMC.*", per) == None):
374                         print "ERR: Only MMC delayconf is recommended in kernel"
375                         continue
377                 # Get the mode from the first entry
378                 (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = per_delayconf[per][0]
379                 dtsnode = ("%s_iodelay_%s_conf" % (per, mode)).lower()
380                 print "\t%s: %s {" % (dtsnode, dtsnode)
381                 print "\t\tpinctrl-single,pins = <"
382                 for i in per_delayconf[per]:
383                         (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = i
384                         print "\t\t\t0x%03X A_DELAY(%d) | G_DELAY(%d)\t/* %s */" % (del_offset, adel, gdel, regname)
385                 print "\t\t>;"
386                 print "\t};"
387         print "};\n"
389 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
391 # Main execution starts here
392 # * Parse all the XML files - Get the pad data and IOdelay data
393 # * Iterate over the pad register dumps
394 # * For each pad, find out the muxmode being used and the pad direction, etc
395 # * For the muxmode being used, find out available virtual/modes
396 #   - Dump the virtual/manual modes available (based on options)
397 #   - Build up the gpio script to read the pad data using GPIO module
398 # * Select the correct mode to be used
399 #   - Check if the mode is described for the peripheral module, (from selected-modes.txt)
400 #   - Otherwise ask the user (with a menu) to decide the delaymode
401 #     => Update the selection for the whole of the peripheral module
402 #   - Worst case, skip the delaymode for this pad
403 # * Build the pad and delay register information
404 # * Create the dump for pad and delay data in linux/u-boot format
405 # * Dump the delaymode selection for each peripheral
406 # * Dump the GPIO script for each peripheral (all pads grouped together)
409 # Read all the input files and parse the required info
410 modehelp = read_guidelines(modehelp_file)
411 sel = read_selmodes(sel_file)
412 regmap = read_pad_dump(pad_file)
413 reglist = regmap.keys()
415 # List of all the pads being configured
416 padconf = []
417 # List of all the delay registers being configured (for manual mode)
418 delayconf = []
419 # Dictionary of pads grouped by peripheral/module
420 per_padconf = {}
421 # Dictionary of delay registers grouped by peripheral/module
422 per_delayconf = {}
424 # Start iterating over each pad
425 for i in range(0, 260):
426         # Find out the muxmode and pad direction, etc
427         addr = 0x4a003400 + i * 4
428         offset = 0x1400 + i * 4
429         dts_offset = offset - 0x1400
431         if (addr not in reglist):
432                 print "WARN: Register dump for pad 0x%X not found" % addr
433                 continue
434         val = regmap[addr]
435         muxmode = val & 0xf
437         # Find out the pin based on the muxmode
438         pad_name = xml_pad_get_name(offset)
439         pin_name = xml_pad_get_pin(offset, muxmode)
440         if (pad_name == "Unknown" or pin_name == "Unknown"):
441                 print "WARN: Cannot find out Pad/Pin name for PAD address 0x%X (%s[%s] = %s)" \
442                 % (addr, pad_name, muxmode, pin_name)
443                 continue
444         if (pin_name == "DRIVER OFF"):
445                 continue
447         # Find out if the delaymode for this module is already selected
448         module = re.match("([^_]+)_.*", pin_name).groups(0)[0]
450         if (args.debug >= 1):
451                 print "\nPAD: %s: Addr= 0x%08X Value = 0x%08X \"%s\"" \
452                 % (pad_name, addr, val, pin_name)
454         # Find out all the possible virtual, manual modes fot the specific pad -> pin combination
455         (virt, man) = xml_find_delaymodes(pad_name, muxmode)
457         # Need to select one out of allowed modes
458         mode = select_mode(pad_name, pin_name, module, virt, man, modehelp, sel)
459         if (mode == "SKIP"):
460                 continue
462         if (mode == "LEGACY"):
463                 delayinfo = ("LEGACY", "")
464         elif (mode in virt):
465                 delayinfo = ("VIRTUAL", virt[mode])
466         elif (mode in man):
467                 delayinfo = ("MANUAL", man[mode])
468         else:
469                 print "ERR: Unknown mode '%s' selected" % mode
470                 continue
472         if (args.debug >= 1):
473                 print "  => Using mode %s" % mode
474         paddata = (pad_name, pin_name, addr, val, delayinfo)
475         if (module not in per_padconf.keys()):
476                 per_padconf[module] = []
477         padconf.append(paddata)
478         per_padconf[module].append(paddata)
480         if(mode not in man):
481                 continue
483         # Add the delay data if using manual mode
484         for regval in man[mode]:
485                 (regname, adel, gdel) = regval
486                 del_offset = xml_iodelay_get_reg(regname)
487                 if (del_offset == 0):
488                         print "WARN: Can't find delay offset of register %s" % regname
489                         break
490                 if (args.debug >= 1):
491                         print "  => Manual delay[%s] = (%d, %d)" % (regname, adel, gdel)
492                 delaydata = (pad_name, pin_name, regname, del_offset, mode, adel, gdel)
493                 if (module not in per_delayconf.keys()):
494                         per_delayconf[module] = []
495                 delayconf.append(delaydata)
496                 per_delayconf[module].append(delaydata)
498 print ""
499 print "Total PAD registers: %d" % len(padconf)
500 print "Total DELAY registers: %d" % len(delayconf)
501 print ""
503 format_pad_regs(padconf, per_padconf)
504 format_delay_regs(delayconf, per_delayconf)
506 # Dump the final selection for reuse
507 print "Selected modes for each peripheral module\n"
508 for group in sel:
509         print "%s,\t%s" % (group, sel[group])
510 print ""
511 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #