iodelay-autogen.py

   1 #!/usr/bin/python
   2 # Python script to automatically generate the IO pad and delay data
   3 # Author:- Nikhil Devshatwar
   4
   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
   9
  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
  14
  15 import xml.etree.ElementTree as ET
  16 import re
  17 import argparse
  18
  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')
  27
  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')
  31
  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')
  35
  36 parser.add_argument('-m', '--module', dest='module',
  37         action='store', type=str, default="",
  38         help='generate only for modules matching the provided RE')
  39
  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')
  43
  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')
  47
  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')
  51
  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')
  57
  58 parser.add_argument('-g', '--gpio', dest='gpio',
  59         action='store_true',
  60         help='generate script to probe signals using gpio')
  61
  62 parser.add_argument('-c', '--check', dest='check_xml',
  63         action='store_true',
  64         help='check consistency of the XML files and other data')
  65
  66 args = parser.parse_args()
  67
  68 # Some more knobs for developers, Don't want to expose them to cmd line
  69 args.resetslew = True
  70
  71 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
  72
  73 VERSION = "2.8"
  74
  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"
  88
  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"
  93
  94 pad_file = "ctrl-core.dump"
  95 sel_file = "selected-modes.txt"
  96
  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()
 113
 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 ""
 119
 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()
 124
 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
 139
 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
 153
 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
 167
 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()
 174
 175 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 176
 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
 181
 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")
 188
 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)
 195
 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)
 206
 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)
 227
 228         #HACK for now
 229         warn("Not resolving muxmode %s, assuming default %s" % (muxmode_str, def_mode))
 230         return def_mode
 231
 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"))
 244
 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)
 253
 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
 266
 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
 285
 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)
 294
 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")
 298
 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]
 306
 307                 values = additional_mux.findall("value")
 308                 for value in values:
 309
 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)
 314
 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])
 321
 322                         muxval = muxval & (1 << end)
 323                         muxval = muxval >> start
 324
 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]
 331
 332 def xml_find_delaymodes(pad_name, muxmode):
 333         print pad_name
 334         print muxmode
 335         virt = {}
 336         man = {}
 337         padlist = model_xml.findall("padDB/clockNode/type/pad")
 338         for pad in padlist:
 339                 if (pad_name == pad.findtext("confregisters/regbit/register")):
 340                         muxmodes = pad.findall("muxmode")
 341                         break
 342         if not muxmodes:
 343                 return None
 344         for mode in muxmodes:
 345                 if ("%d" % muxmode == mode.findtext("mode")):
 346                         mode = xml_get_additional_mode(mode)
 347                         virt = xml_get_virtual(mode)
 348                         man = xml_get_manual(mode)
 349                         return (virt, man)
 350         return (virt, man)
 351
 352 def xml_check_correctness(modehelp):
 353
 354         print "###########################################"
 355         print "XML correctness checks:"
 356         padcore_list = []
 357         padmodel_list = []
 358         modes = {}
 359
 360         # Find all the pads in core XML
 361         pad_list = pad_xml.findall("register")
 362         for i in pad_list:
 363                 name = i.get("id")
 364                 if (re.match("CTRL_CORE_PAD_.*", name) == None):
 365                         continue
 366                 padcore_list.append(name)
 367         print ">> Total pads defined in core XML = %d" % len(padcore_list)
 368
 369         # Find all the pads in model XML
 370         pad_list = model_xml.findall("padDB/clockNode/type/pad/confregisters/regbit")
 371         for i in pad_list:
 372                 name = i.findtext("register")
 373                 padmodel_list.append(name)
 374         print ">> Total pads defined in model XML = %d" % len(padmodel_list)
 375
 376         # Find all the manual modes
 377         manmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/manualmode/cfgreg/mode")
 378         for i in manmode_list:
 379                 man_name = i.findtext("name")
 380                 modes[man_name] = "manual"
 381         # Find all the additional manual modes
 382         manmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/additionalMux/confregisters/value/manualmode/cfgreg/mode")
 383         for i in manmode_list:
 384                 man_name = i.findtext("name")
 385                 modes[man_name] = "manual"
 386         # Find all the virtual modes
 387         virtmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/virtualmode/mode")
 388         for i in virtmode_list:
 389                 virt_name = i.findtext("name")
 390                 modes[virt_name] = "virtual"
 391         # Find all the additional virtual modes
 392         virtmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/additionalMux/confregisters/value/virtualmode/mode")
 393         for i in virtmode_list:
 394                 virt_name = i.findtext("name")
 395                 modes[virt_name] = "virtual"
 396         print ">> Total delaymodes defined in model XML = %d" % len(modes)
 397
 398         # Print out all the errors found in the tests
 399         print "== Pads defined in core XML but not in model XML =="
 400         for i in padcore_list:
 401                 if (i not in padmodel_list):
 402                         print "\t%s" % i
 403         print "== Pads defined in model XML but not in core XML =="
 404         for i in padmodel_list:
 405                 if (i not in padcore_list):
 406                         print "\t%s" % i
 407
 408         # Check if description for each mode is available
 409         print "== Delaymodes missing description in the guidelines.txt =="
 410         for i in modes:
 411                 if (i not in modehelp):
 412                         print "\t%s" % i
 413
 414         # Check if description for unknown mode is documented
 415         print "== Delaymodes unused from guidelines.txt =="
 416         for i in modehelp:
 417                 if (i not in modes):
 418                         print "\t%s" % i
 419
 420         print "###########################################"
 421
 422 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 423
 424 # Decision point of the script
 425 # For each pad/pin, decide what delay method is used
 426 # Lookup in the selection file or ask user with a menu
 427 def select_mode(pad, pin, module, virt, man, modehelp, sel):
 428         modelist = []
 429         for modename in virt.keys():
 430                 modelist.append(modename)
 431
 432         for modename in man.keys():
 433                 modelist.append(modename)
 434
 435         if (len(modelist) == 0):
 436                 return "LEGACY"
 437
 438         if (module in sel.keys()):
 439                 mode = sel[module]
 440                 if (mode == "SKIP" or mode == "LEGACY" or mode in modelist):
 441                         return mode
 442                 else:
 443                         error("Invalid delaymode '%s' for module '%s'" % (mode, module))
 444
 445         if (args.interactive == 0):
 446                 warn("No delay modes for %s found, skipping" % module)
 447                 mode = "SKIP"
 448                 return mode
 449
 450         # Display the menu and ask user to select the 'right' mode
 451         while True:
 452                 print ""
 453                 print "MENU: Select delay mode for %s -> %s" % (pad, pin)
 454                 i = 0
 455                 print "MENU: %d: %s \t\t\t%s" % (i, "SKIP", "Skips this module for now")
 456                 i = 1
 457                 print "MENU: %d: %s \t\t%s" % (i, "LEGACY", "No external delay config (No virtual/manual needed)")
 458                 for mode in modelist:
 459                         i += 1
 460                         if (mode in modehelp):
 461                                 helptext = modehelp[mode]
 462                         else:
 463                                 helptext = "Unknown"
 464                         print "MENU: %d: %s \t\t%s" % (i, mode, helptext)
 465                 try:
 466                         choice = int(raw_input("Select delay mode #> "))
 467                         if (choice == 0):
 468                                 mode = "SKIP"
 469                                 break
 470                         elif (choice == 1):
 471                                 mode = "LEGACY"
 472                                 break
 473                         elif (choice >=2 and choice <= len(modelist) + 1):
 474                                 mode = modelist[choice - 2]
 475                                 break
 476                         print "ERROR: Invalid choice"
 477                 except ValueError:
 478                         print "ERROR: Invalid choice"
 479         print "MENU: Selected mode is %s" % mode
 480         print ""
 481
 482         return mode
 483 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 484
 485 # Pad read using GPIO - Specific to linux only
 486 # As each pad is muxed with a SoC gpio (for most of the pads)
 487 # It's possible to read the pad data using gpio datain registers
 488 # Change pad register to enable input path and export sysfs
 489 # Use sysfs to read the status of GPIO and print in a loop
 490 def pad_dump_gpio(padconf, per_padconf):
 491         gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
 492         module = args.module
 493
 494         # script header
 495         gen_header = "###########################################\n" + \
 496                      "# Read %s signals using GPIO sysfs\n" % module + \
 497                      "###########################################\n\n"
 498         gen_data = "%s_data=(\n" % module
 499
 500         for i in padconf:
 501                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
 502
 503                 offset = addr - 0x4a002000
 504                 gpio_name = xml_model_get_signal(offset, 14)
 505                 matchlist = re.match("GPIO(.)_(.*)", gpio_name)
 506                 if (matchlist == None):
 507                         error("No GPIO for pad %s - cannot read from script" % pad_name)
 508                         continue
 509
 510                 inst = int(matchlist.groups(0)[0])
 511                 bit = int(matchlist.groups(0)[1])
 512                 gpio_addr = gpio_data_addrs[inst]
 513                 ngpio = (inst - 1) * 32 + bit
 514                 pin_short = re.match(".+_(.*)", pin_name).groups(0)[0]
 515
 516                 gen_data += "\t%s:0x%x:%s:%d:0x%x:%d\n" % (pin_short, addr, gpio_name, ngpio, gpio_addr, bit)
 517
 518         gen_data += ")\n\n"
 519
 520         # Main script to probe the signal
 521         gen_main = "echo; echo Probing %s signals\n\n" % module + \
 522                    "for data in ${%s_data[@]}\n" % module + \
 523                    "do\n" + \
 524                    "    pin=`echo $data | cut -d ':' -f1`\n" + \
 525                    "    pad=`echo $data | cut -d ':' -f2`\n" + \
 526                    "    ngpio=`echo $data | cut -d ':' -f4`\n" + \
 527                    "    echo $ngpio > /sys/class/gpio/export 2>/dev/null\n" + \
 528                    "    omapconf set bit $pad 18 1>/dev/null 2>/dev/null\n" + \
 529                    "    printf \"%8s\" $pin\n" + \
 530                    "done\n" + \
 531                    "echo\n\n"
 532
 533         gen_main += "while true;\n" + \
 534                     "do\n" + \
 535                     "    for data in ${%s_data[@]}\n" % module + \
 536                     "    do\n" + \
 537                     "#       pin=`echo $data | cut -d ':' -f1`\n" + \
 538                     "#        pad=`echo $data | cut -d ':' -f2`\n" + \
 539                     "#       gpio=`echo $data | cut -d ':' -f3`\n" + \
 540                     "        ngpio=`echo $data | cut -d ':' -f4`\n" + \
 541                     "#       addr=`echo $data | cut -d ':' -f5`\n" + \
 542                     "#       bit=`echo $data | cut -d ':' -f6`\n" + \
 543                     "        val=`cat /sys/class/gpio/gpio$ngpio/value`\n" + \
 544                     "        printf %8d $val \n" + \
 545                     "    done\n" + \
 546                     "    echo\n" + \
 547                     "done\n\n"
 548
 549         gen_footer = "###########################################\n"
 550
 551         # Generate the shell script
 552         gen_script = gen_header + gen_data + gen_main + gen_footer
 553         filename = ("./%s-probe.sh" % module).lower()
 554         print "Generating '%s' script..." % filename
 555         gen_file = open(filename, "w+")
 556         gen_file.write(gen_script)
 557
 558 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 559
 560 # Generate the final pad and delay data in the required format
 561 def format_pad_regs(padconf, per_padconf):
 562         print "######## Pad data output ########"
 563         if (args.format == "uboot"):
 564                 uboot_format_pad_regs(padconf, per_padconf)
 565         elif (args.format == "linux"):
 566                 linux_format_pad_regs(padconf, per_padconf)
 567         elif (args.format == "bios"):
 568                 bios_format_pad_regs(padconf, per_padconf)
 569         else:
 570                 error("Format %s not suppported" % args.format)
 571
 572 def format_delay_regs(delayconf, per_delayconf):
 573         print "######## Delay data output ########"
 574         if (args.format == "uboot"):
 575                 uboot_format_delay_regs(delayconf, per_delayconf)
 576         elif (args.format == "linux"):
 577                 linux_format_delay_regs(delayconf, per_delayconf)
 578         elif (args.format == "bios"):
 579                 bios_format_delay_regs(delayconf, per_delayconf)
 580         else:
 581                 error("Format %s not suppported" % args.format)
 582
 583 def get_pin_info(val):
 584         slew_fast = (val >> 19) & 0x1
 585         inp_en = (val >> 18) & 0x1
 586         pulltype = (val >> 17) & 0x1
 587         pull_dis = (val >> 16) & 0x1
 588         pin = "PIN"
 589         if (inp_en):
 590                 pin += "_INPUT"
 591         else:
 592                 pin += "_OUTPUT"
 593         if (pull_dis == 0):
 594                 if (pulltype):
 595                         pin += "_PULLUP"
 596                 else:
 597                         pin += "_PULLDOWN"
 598         if (slew_fast):
 599                 pin += " | SLEWCONTROL"
 600         return pin
 601
 602 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 603
 604 # Generate output in u-boot format
 605 def uboot_format_pad_regs(padconf, per_padconf):
 606         print "\nconst struct pad_conf_entry dra74x_core_padconf_array[] = {"
 607         for i in padconf:
 608                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
 609
 610                 muxmode = val & 0xf
 611                 (method, data) = delayinfo
 612                 if (method == "LEGACY"):
 613                         extramode = ""
 614                 elif (method == "VIRTUAL"):
 615                         delaymode = data
 616                         extramode = " | VIRTUAL_MODE%d" % delaymode
 617                 elif (method == "MANUAL"):
 618                         extramode = " | MANUAL_MODE"
 619                 else:
 620                         error("Invalid delay method %s" % method)
 621
 622                 pin_info = get_pin_info(val) + extramode
 623                 pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
 624                 comment = (pad_short + "." + pin_name).lower()
 625
 626                 print "\t{ %s, (M%d | %s) },\t/* %s */" % (pad_short, muxmode, pin_info, comment)
 627         print "};\n"
 628
 629 def uboot_format_delay_regs(delayconf, per_delayconf):
 630         manual_del = []
 631         for i in delayconf:
 632                 (pad_name, pin_name, regname, del_offset, man_name, adel, gdel) = i
 633
 634                 entry = (del_offset, adel, gdel, regname, pin_name, man_name)
 635                 manual_del.append(entry)
 636
 637         es_rev = args.revision.replace('.', '_')
 638         print "\nconst struct iodelay_cfg_entry dra742_es" + es_rev + "_iodelay_cfg_array[] = {"
 639         for entry in sorted(manual_del):
 640                 print "\t{ 0x%04X, %5d, %5d },\t/* %s : %s - %s */" % entry
 641         print "};\n"
 642
 643 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 644
 645 # Generate output in linux format
 646 def linux_format_pad_regs(padconf, per_padconf):
 647         print "&dra7_pmx_core {"
 648         for per in per_padconf:
 649
 650                 if (re.match("MMC.*", per) == None):
 651                         warn("Only MMC padconf is recommended in kernel")
 652
 653                 # Get the mode from the first entry
 654                 (pad_name, pin_name, addr, val, mode, delayinfo) = per_padconf[per][0]
 655
 656                 dtsnode = ("%s_pins_%s" % (per, mode)).lower()
 657                 print ""
 658                 print "\t%s: %s {" % (dtsnode, dtsnode)
 659                 print "\t\tpinctrl-single,pins = <"
 660                 for i in per_padconf[per]:
 661                         (pad_name, pin_name, addr, val, mode, delayinfo) = i
 662
 663                         muxmode = val & 0xf
 664                         (method, data) = delayinfo
 665                         if (method == "LEGACY"):
 666                                 extramode = ""
 667                         elif (method == "VIRTUAL"):
 668                                 delaymode = data
 669                                 extramode = " | MUX_VIRTUAL_MODE%d" % delaymode
 670                         elif (method == "MANUAL"):
 671                                 extramode = " | MANUAL_MODE"
 672                         else:
 673                                 warn("Invalid method %s" % method)
 674
 675                         pin_info = get_pin_info(val) + extramode
 676                         pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
 677                         offset = addr - 0x4a003400
 678                         comment = (pad_short + "." + pin_name).lower()
 679
 680                         print "\t\t\t0x%03X\t(%s | MUX_MODE%d)\t/* %s */" % (offset, pin_info, muxmode, comment)
 681                 print "\t\t>;"
 682                 print "\t};"
 683         print "};\n"
 684
 685
 686 def linux_format_delay_regs(delayconf, per_delayconf):
 687         print "&dra7_iodelay_core {"
 688         for per in per_delayconf.keys():
 689
 690                 if (re.match("MMC.*", per) == None):
 691                         warn("Only MMC delayconf is recommended in kernel")
 692
 693                 # Get the mode from the first entry
 694                 (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = per_delayconf[per][0]
 695
 696                 dtsnode = ("%s_iodelay_%s_conf" % (per, mode)).lower()
 697                 print "\t%s: %s {" % (dtsnode, dtsnode)
 698                 print "\t\tpinctrl-single,pins = <"
 699                 for i in per_delayconf[per]:
 700                         (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = i
 701
 702                         print "\t\t\t0x%03X (A_DELAY(%d) | G_DELAY(%d))\t/* %s */" % (del_offset, adel, gdel, regname)
 703                 print "\t\t>;"
 704                 print "\t};"
 705         print "};\n"
 706
 707 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 708
 709 # Generate output in bios format
 710 def bios_format_pad_regs(padconf, per_padconf):
 711         for i in padconf:
 712                 (pad_name, pin_name, addr, val, mode, delayinfo) = i
 713
 714                 delaylist = []
 715                 (method, data) = delayinfo
 716                 if (method == "VIRTUAL"):
 717                         virt_mode = data
 718                         val = val | ( virt_mode<< 4)
 719                         val = val | (1 << 8)
 720                 elif (method == "MANUAL"):
 721                         delaylist = data
 722                         val = val | (1 << 8)
 723
 724                 offset = addr - 0x4a003400
 725                 out_delreg = out_adel = out_gdel = 0
 726                 in_delreg  = in_adel  = in_gdel  = 0
 727                 oen_delreg = oen_adel = oen_gdel = 0
 728
 729                 for j in delaylist:
 730                         (regname, adel, gdel) = j
 731                         if (re.match(".*_IN", regname) != None):
 732                                 in_delreg = xml_iodelay_get_reg(regname)
 733                                 in_adel = adel
 734                                 in_gdel = gdel
 735                         elif (re.match(".*_OEN", regname) != None):
 736                                 oen_delreg = xml_iodelay_get_reg(regname)
 737                                 oen_adel = adel
 738                                 oen_gdel = gdel
 739                         elif (re.match(".*_OUT", regname) != None):
 740                                 out_delreg = xml_iodelay_get_reg(regname)
 741                                 out_adel = adel
 742                                 out_gdel = gdel
 743                 indel  = "{ 0x%04X, %4d, %4d , 0}" % (in_delreg,  in_adel,  in_gdel)
 744                 oendel = "{ 0x%04X, %4d, %4d , 0}" % (oen_delreg, oen_adel, oen_gdel)
 745                 outdel = "{ 0x%04X, %4d, %4d , 0}" % (out_delreg, out_adel, out_gdel)
 746                 pin_info = get_pin_info(val)
 747                 print "\t/* %s -> %s (%s) %s delaymode */" % (pad_name, pin_name, pin_info, method)
 748                 print "\t{ 0x%03X, 0x%08X, %s, %s, %s }" % (offset, val, indel, oendel, outdel)
 749
 750 def bios_format_delay_regs(delayconf, per_delayconf):
 751         debug("Manual delays are not configured separately")
 752         debug("Delays are configured as part of the padconf step only")
 753
 754 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 755
 756 # Main execution starts here
 757 # * Parse all the XML files - Get the pad data and IOdelay data
 758 # * Iterate over the pad register dumps
 759 # * For each pad, find out the muxmode being used and the pad direction, etc
 760 # * For the muxmode being used, find out available virtual/modes
 761 #   - Dump the virtual/manual modes available (based on options)
 762 #   - Build up the gpio script to read the pad data using GPIO module
 763 # * Select the correct mode to be used
 764 #   - Check if the mode is described for the peripheral module, (from selected-modes.txt)
 765 #   - Otherwise ask the user (with a menu) to decide the delaymode
 766 #     => Update the selection for the whole of the peripheral module
 767 #   - Worst case, skip the delaymode for this pad
 768 # * Build the pad and delay register information
 769 # * Create the dump for pad and delay data in linux/u-boot format
 770 # * Dump the delaymode selection for each peripheral
 771 # * Dump the GPIO script for each peripheral (all pads grouped together)
 772 #
 773
 774 # List of all the pads being configured
 775 padconf = []
 776 # List of all the delay registers being configured (for manual mode)
 777 delayconf = []
 778 # Dictionary of pads grouped by peripheral/module
 779 per_padconf = {}
 780 # Dictionary of delay registers grouped by peripheral/module
 781 per_delayconf = {}
 782
 783 if(args.check_xml):
 784         xml_check_correctness(modehelp)
 785         exit()
 786
 787 # Start iterating over each pad
 788 for i in range(0, 260):
 789         # Find out the muxmode and pad direction, etc
 790         addr = 0x4a003400 + i * 4
 791         offset = 0x1400 + i * 4
 792         dts_offset = offset - 0x1400
 793
 794         if (addr not in reglist):
 795                 warn("Register dump for pad 0x%X not found" % addr)
 796                 continue
 797         val = regmap[addr]
 798         muxmode = val & 0xf
 799
 800         # Find out the pin based on the muxmode
 801         pad_name = xml_pad_get_name(offset)
 802         pin_name = xml_model_get_signal(offset, muxmode)
 803         if (pad_name == "Unknown" or pin_name == "Unknown"):
 804                 warn("Cannot find out Pad/Pin name for PAD address 0x%X (%s[%s] = %s)" \
 805                 % (addr, pad_name, muxmode, pin_name))
 806                 continue
 807         if (pin_name == "DRIVER"):
 808                 continue
 809
 810         # Find out if the delaymode for this module is already selected
 811         match = re.match("([^_]+)_.*", pin_name)
 812         if (match):
 813                 module = match.groups(0)[0]
 814         else:
 815                 module = pin_name
 816
 817         if (args.module != "" and re.match("%s" % args.module, module) == None):
 818                 continue
 819
 820         # It is recommended to keep the reset value of the slewcontrol bit
 821         # Find out the reset value from XML and update if required
 822         if (args.resetslew):
 823                 val |= (xml_pad_get_slew(offset) & 0x1) << 19
 824
 825         debug("PAD: %s: Addr= 0x%08X Value = 0x%08X \"%s\"" \
 826                 % (pad_name, addr, val, pin_name))
 827
 828         # Find out all the possible virtual, manual modes fot the specific pad -> pin combination
 829         (virt, man) = xml_find_delaymodes(pad_name, muxmode)
 830
 831         if (args.gpio == True):
 832                 mode = "LEGACY"
 833         else:
 834                 # Need to select one out of allowed modes
 835                 mode = select_mode(pad_name, pin_name, module, virt, man, modehelp, sel)
 836
 837         # Remember the selection for that module, for later reuse
 838         if (args.strict == False and module not in sel.keys()):
 839                 sel[module] = mode
 840
 841         if (mode == "SKIP"):
 842                 continue
 843         elif (mode == "LEGACY"):
 844                 delayinfo = ("LEGACY", "")
 845         elif (mode in virt):
 846                 delayinfo = ("VIRTUAL", virt[mode])
 847         elif (mode in man):
 848                 delayinfo = ("MANUAL", man[mode])
 849         else:
 850                 error("Unknown mode '%s' selected" % mode)
 851                 continue
 852
 853         debug("  => Using mode %s" % mode)
 854         paddata = (pad_name, pin_name, addr, val, mode, delayinfo)
 855         if (module not in per_padconf.keys()):
 856                 per_padconf[module] = []
 857         padconf.append(paddata)
 858         per_padconf[module].append(paddata)
 859
 860         if(mode not in man):
 861                 continue
 862
 863         # Add the delay data if using manual mode
 864         for regval in man[mode]:
 865                 (regname, adel, gdel) = regval
 866                 del_offset = xml_iodelay_get_reg(regname)
 867                 if (del_offset == 0):
 868                         error("Can't find delay offset of register %s" % regname)
 869                         break
 870                 debug("  => Manual delay[%s] = (%d, %d)" % (regname, adel, gdel))
 871                 delaydata = (pad_name, pin_name, regname, del_offset, mode, adel, gdel)
 872                 if (module not in per_delayconf.keys()):
 873                         per_delayconf[module] = []
 874                 delayconf.append(delaydata)
 875                 per_delayconf[module].append(delaydata)
 876
 877 if(args.gpio == True):
 878         pad_dump_gpio(padconf, per_padconf)
 879         exit()
 880
 881 format_pad_regs(padconf, per_padconf)
 882 format_delay_regs(delayconf, per_delayconf)
 883
 884 if (args.interactive):
 885         # Summary of the generated data
 886         print ""
 887         print "Total PAD registers: %d" % len(padconf)
 888         print "Total DELAY registers: %d" % len(delayconf)
 889         print ""
 890         # Dump the final selection for reuse
 891         print "Selected modes for each peripheral module\n"
 892         for group in sel:
 893                 print "%s,\t%s" % (group, sel[group])
 894         print ""
 895 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #