221074bc357fb2586f069eb043d465e781c98273
[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 args = parser.parse_args()
41 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
43 # Read the XML file database for pad and delay registers
44 pad_xml = ET.parse(pad_data_xml).getroot()
45 iod_xml = ET.parse(iod_data_xml).getroot()
46 model_xml = ET.parse(model_data_xml).getroot()
48 # Functions to parse the input files and build data structures
49 def read_guidelines(fname):
50         modehelp = {}
51         pattern = re.compile('(.+\w)\t+(.+)')
52         f = open(fname)
53         for line in f.readlines():
54                 list = re.match(pattern, line)
55                 if ( list == None):
56                         continue
57                 mode = list.groups(0)[0]
58                 info = list.groups(0)[1]
59                 modehelp[mode] = info
60                 if (args.debug >= 2):
61                         print "Help: Mode '%s' is used for '%s'" % (mode, info)
62         return modehelp
64 def read_selmodes(fname):
65         sel = {}
66         pattern = re.compile('(\w+)\W*,\W*(\w*)')
67         f = open(fname)
68         for line in f.readlines():
69                 list = re.match(pattern, line)
70                 if ( list == None):
71                         continue
72                 module = list.groups(0)[0]
73                 mode = list.groups(0)[1]
74                 sel[module] = mode
75                 if (args.debug >= 2):
76                         print "INFO: Select '%s' for '%s'" % (mode, module)
77         return sel
79 def read_pad_dump(file):
80         regmap = {}
81         pattern = re.compile('.*(0x[0-9A-F]+).*(0x[0-9A-F]+).*')
82         f = open(file, 'r')
83         for line in f:
84                 list = re.match(pattern, line)
85                 if ( list == None):
86                         continue
87                 addr = int(list.groups(0)[0], 16)
88                 val = int(list.groups(0)[1], 16)
89                 #print "PADXML: Addr = %08x Value = %08x" % (addr, val)
90                 regmap[addr] = val
91         return regmap
92 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
94 # Helper functions to parse XML nodes and get the desired data
95 # Hugely dependent on the XML format of the PCT files
96 # Uses XPath to search elements with queries and filters
97 # Parse the nodes to generate data in desired format
99 def xml_pad_get_name(offset):
100         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
101         if (len(padlist) == 0):
102                 return "Unknown"
103         else:
104                 return padlist[0].get("id")
106 def xml_pad_get_pin(offset, muxmode):
107         padlist = pad_xml.findall("register[@offset='0x%X']" % offset)
108         if (len(padlist) == 0):
109                 return "Unknown"
110         else:
111                 mux_field = padlist[0].findall("./bitfield[@end='0']")
112                 if (len(mux_field) == 0):
113                         return "Unknown"
114                 modes = mux_field[0].findall("./bitenum[@value='%d']" % muxmode)
115                 if (len(modes) == 0):
116                         return "Unknown"
117                 return modes[0].get("id")
119 def xml_iodelay_get_reg(name):
120         delaylist = iod_xml.findall("register[@id='%s']" % name)
121         if (len(delaylist) == 0):
122                 return 0
123         else:
124                 offset = delaylist[0].get("offset")
125                 #print "IOD: Name = %s Offset = %s" % (del_reg, offset)
126                 return int(offset, 16)
128 def xml_get_virtual(mode):
129         vmodes = {}
130         signal = mode.findtext("signal")
131         for virt in mode.findall("virtualmode/mode"):
132                 virt_mode = virt.findtext("value")
133                 virt_name = virt.findtext("name")
134                 if (virt_name == "NA"):
135                         continue
136                 virt_mode = int(virt_mode)
137                 vmodes[virt_name] = virt_mode
138                 if (args.debug >= 1):
139                         print ("    * VIRTUAL: %s [%s] => delaymode = %d" % (signal, virt_name, virt_mode))
140         return vmodes
142 def xml_get_manual(mode):
143         mmodes = {}
144         signal = mode.findtext("signal")
145         for man in mode.findall("manualmode"):
146                 regname = man.findtext("cfgreg/name")
147                 for sel in man.findall("cfgreg/mode"):
148                         adel = sel.findtext("adelay")
149                         gdel = sel.findtext("gdelay")
150                         man_name = sel.findtext("name")
151                         if (man_name == "NA"):
152                                 continue
153                         adel = int(adel)
154                         gdel = int(gdel)
155                         if (man_name not in mmodes.keys()):
156                                 mmodes[man_name] = []
157                         mmodes[man_name].append((regname, adel, gdel))
158                         if (args.debug >= 1):
159                                 print ("    * MANUAL: %s [%s] => delay[%s] = %d, %d" % (signal, man_name, regname, adel, gdel))
160         return mmodes
161                 
163 def xml_find_delaymodes(pad_name, muxmode):
164         padlist = model_xml.findall("padDB/clockNode/type/pad")
165         for pad in padlist:
166                 if (pad_name == pad.findtext("confregisters/regbit/register")):
167                         muxmodes = pad.findall("muxmode")
168                         break
169         if not muxmodes:
170                 return None
171         for mode in muxmodes:
172                 if ("%d" % muxmode == mode.findtext("mode")):
173                         virt = xml_get_virtual(mode)
174                         man = xml_get_manual(mode)
175                         return (virt, man)
176         return None
177 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
179 # Decision point of the script
180 # For each pad/pin, decide what delay method is used
181 # Lookup in the selection file or ask user with a menu
182 def select_mode(pad, pin, virt, man, modehelp, sel):
183         modelist = []
184         for modename in virt.keys():
185                 modelist.append(modename)
187         for modename in man.keys():
188                 modelist.append(modename)
190         if (len(modelist) == 0):
191                 return "LEGACY"
193         # Find out if the delaymode for this module is already selected
194         module = re.match("([^_]+)_.*", pin).groups(0)[0]
195         if (module in sel.keys()):
196                 mode = sel[module]
197                 if (mode == "SKIP" or mode in modelist):
198                         return mode
199                 else:
200                         print("ERR: Invalid delaymode '%s' for module '%s'" & (mode, module))
202         if (args.interactive == 0):
203                 print "WARN: No delay modes for %s:%s found, skipping" % (pad, pin)
204                 mode = "SKIP"
205                 sel[module] = mode
206                 return mode
208         # Display the menu and ask user to select the 'right' mode
209         while True:
210                 print ""
211                 print "MENU: Select delay mode for %s -> %s" % (pad, pin)
212                 i = 0
213                 print "MENU: %d: %s \t\t\t%s" % (i, "SKIP", "Skips this module for now")
214                 for mode in modelist:
215                         i += 1
216                         print "MENU: %d: %s \t\t%s" % (i, mode, modehelp[mode])
217                 try:
218                         choice = int(raw_input("Select delay mode #> "))
219                         if (choice == 0):
220                                 mode = "SKIP"
221                                 break
222                         elif (choice >=0 and choice <= len(modelist)):
223                                 mode = modelist[choice - 1]
224                                 break
225                         print "ERROR: Invalid choice"
226                 except ValueError:
227                         print "ERROR: Invalid choice"
228         print "MENU: Selected mode is %s" % mode
229         print ""
231         # Remember the selection for that module, for later reuse
232         sel[module] = mode
233         return mode
234 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
236 # Pad read using GPIO - Specific to linux only
237 # As each pad is muxed with a SoC gpio (for most of the pads)
238 # It's possible to read the pad data using gpio datain registers
239 # Dump the linux commands to read the gpio registers and read the pad data
240 def pad_dump_gpio(addr, offset, pin_name):
241         # Dump the script to read this pad using the gpio data register
242         gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
243         gpio_name = xml_pad_get_pin(offset, 14)
244         matchlist = re.match("GPIO(.)_(.)", gpio_name)
245         if (matchlist == None):
246                 return
247         inst = int(matchlist.groups(0)[0])
248         bit = int(matchlist.groups(0)[1])
249         gpio_addr = gpio_data_addrs[inst]
250         print "echo %d > /sys/class/gpio/export 2>/dev/null;" % (inst - 1) * 32
251         print "val=`omapconf read 0x%x 2>&1 | grep -v \"support\"`;" % gpio_addr
252         print "status=$((0x$val >> %d & 0x1));" % bit
253         print "echo -e \"%s (%s)\t = $status\";" % (pin_name, gpio_name)
254 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
256 # Generate the final pad and delay data in the required format
257 # This can be changed to work for linux / u-boot / QNX / other format
258 def format_pin_info(val):
259         inp_en = (val >> 18) & 0x1
260         pulltype = (val >> 17) & 0x1
261         pull_dis = (val >> 16) & 0x1
262         pin = "PIN"
263         if (inp_en):
264                 pin += "_INPUT"
265         else:
266                 pin += "_OUTPUT"
267         if (pull_dis == 0):
268                 if (pulltype):
269                         pin += "_PULLUP"
270                 else:
271                         pin += "_PULLDOWN"
272         return pin
274 def format_pad_regs(padconf):
275         # Generate the padmux data in kernel format
276         print "###########################################"
277         print "Pad data for u-boot (with the delay modes):"
278         print "###########################################"
279         print "\nconst struct pad_conf_entry dra74x_core_padconf_array[] = {"
280         for i in padconf:
281                 (pad_name, pin_name, addr, val, delaydata) = i
282                 muxmode = val & 0xf
283                 (method, data) = delaydata
284                 if (method == "LEGACY"):
285                         extramode = ""
286                 elif (method == "VIRTUAL"):
287                         delaymode = data
288                         extramode = " | VIRTUAL_MODE%d" % delaymode
289                 elif (method == "MANUAL"):
290                         extramode = " | MANUAL_MODE"
291                 else:
292                         print "ERR: Invalid method %s" % method
294                 pin_info = format_pin_info(val) + extramode
295                 pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
296                 comment = (pad_short + "." + pin_name).lower()
297                 print "\t{ %s, (M%d | %s) },\t/* %s */" % (pad_short, muxmode, pin_info, comment)
298         print "};\n"
300 def format_delay_regs(delayconf):
301         # Generate the delay data in kernel format
302         print "#########################################"
303         print "Delay data for u-boot (for manual modes):"
304         print "#########################################"
305         print "\nconst struct iodelay_cfg_entry dra742_iodelay_cfg_array[] = {"
306         for i in delayconf:
307                 (pad_name, pin_name, regname, del_offset, adel, gdel) = i
308                 print "\t{ 0x%04X, %5d, %5d },\t/* %s */" % (del_offset, adel, gdel, regname)
309         print "};\n"
310 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
312 # Main execution starts here
313 # * Parse all the XML files - Get the pad data and IOdelay data
314 # * Iterate over the pad register dumps
315 # * For each pad, find out the muxmode being used and the pad direction, etc
316 # * For the muxmode being used, find out available virtual/modes
317 #   - Dump the virtual/manual modes available (based on options)
318 #   - Build up the gpio script to read the pad data using GPIO module
319 # * Select the correct mode to be used
320 #   - Check if the mode is described for the peripheral module, (from selected-modes.txt)
321 #   - Otherwise ask the user (with a menu) to decide the delaymode
322 #     => Update the selection for the whole of the peripheral module
323 #   - Worst case, skip the delaymode for this pad
324 # * Build the pad and delay register information
325 # * Create the dump for pad and delay data in kernel/u-boot format
326 # * Dump the delaymode selection for each peripheral
327 # * Dump the GPIO script for each peripheral (all pads grouped together)
330 # Read all the input files and parse the required info
331 modehelp = read_guidelines(modehelp_file)
332 sel = read_selmodes(sel_file)
333 regmap = read_pad_dump(pad_file)
334 reglist = regmap.keys()
336 padconf = []
337 delayconf = []
338 padinfo = []
340 # Start iterating over each pad
341 for i in range(0, 260):
342         # Find out the muxmode and pad direction, etc
343         addr = 0x4a003400 + i * 4
344         offset = 0x1400 + i * 4
345         dts_offset = offset - 0x1400
347         if (addr not in reglist):
348                 print "WARN: Register dump for pad 0x%X not found" % addr
349                 continue
350         val = regmap[addr]
351         muxmode = val & 0xf
353         # Find out the pin based on the muxmode
354         pad_name = xml_pad_get_name(offset)
355         pin_name = xml_pad_get_pin(offset, muxmode)
356         if (pad_name == "Unknown" or pin_name == "Unknown"):
357                 print "WARN: Cannot find out Pad/Pin name for PAD address 0x%X (%s[%s] = %s)" \
358                 % (addr, pad_name, muxmode, pin_name)
359                 continue
360         if (pin_name == "DRIVER OFF"):
361                 continue
363         padinfo.append((pad_name, pin_name, addr, offset, val))
364         if (args.debug >= 1):
365                 print "\nPAD: %s: Addr= 0x%08X Value = 0x%08X \"%s\"" \
366                 % (pad_name, addr, val, pin_name)
368         # Find out all the possible virtual, manual modes fot the specific pad -> pin combination
369         (virt, man) = xml_find_delaymodes(pad_name, muxmode)
371         # Need to select one out of allowed modes
372         mode = select_mode(pad_name, pin_name, virt, man, modehelp, sel)
373         if (mode == "SKIP"):
374                 continue
376         if (mode == "LEGACY"):
377                 delaydata = ("LEGACY", "")
378         elif (mode in virt):
379                 delaydata = ("VIRTUAL", virt[mode])
380         elif (mode in man):
381                 delaydata = ("MANUAL", man[mode])
382         else:
383                 print "ERR: Unknown mode '%s' selected" % mode
384                 continue
386         if (args.debug >= 1):
387                 print "  => Using mode %s" % mode
388         padconf.append((pad_name, pin_name, addr, val, delaydata))
390         if(mode not in man):
391                 continue
393         # Add the delay data if using manual mode
394         for regval in man[mode]:
395                 (regname, adel, gdel) = regval
396                 del_offset = xml_iodelay_get_reg(regname)
397                 if (del_offset == 0):
398                         print "WARN: Can't find delay offset of register %s" % regname
399                         break
400                 if (args.debug >= 1):
401                         print "  => Manual delay[%s] = (%d, %d)" % (regname, adel, gdel)
402                 delayconf.append((pad_name, pin_name, regname, del_offset, adel, gdel))
404 print ""
405 print "Total PAD registers: %d" % len(padconf)
406 print "Total DELAY registers: %d" % len(delayconf)
407 print ""
409 format_pad_regs(padconf)
410 format_delay_regs(delayconf)
412 # Dump the final selection for reuse
413 print "Selected modes for each peripheral module\n"
414 for group in sel:
415         print "%s,\t%s" % (group, sel[group])
416 print ""
417 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #