script: Fix the gpio script for bit > 9
[glsdk/iodelay-config.git] / iodelay-autogen.py
index 221074bc357fb2586f069eb043d465e781c98273..d6a8701f91a3a63ae3dd1b2be4c767ed6be36aba 100755 (executable)
@@ -16,18 +16,14 @@ import xml.etree.ElementTree as ET
 import re
 import argparse
 
-pad_data_xml = "XMLFiles/CTRL_MODULE_CORE.xml"
-iod_data_xml = "XMLFiles/IODELAYCONFIG.xml"
-model_data_xml = "XMLFiles/model_DRA75x_DRA74x_SR1.1_v1.0.6.xml"
-modehelp_file = "guidelines.txt"
-
-pad_file = "ctrl-core.dump"
-sel_file = "selected-modes.txt"
-
 # Handle the command line arguments
 parser = argparse.ArgumentParser(prog='iodelay-autogen.py',
-       description='Python script to generate the IOdelay data',
-       epilog='Generate the pad and delay data using pad regdump')
+       description='Python script to generate the IOdelay data.\n' \
+               'This script refers to the XML data and automatically generates\n' \
+               'PAD and DELAY data for the same use case.\n' \
+               'Note that only the PADs which are used in the dump are configured.',
+       epilog='Generate the pad and delay data using pad register dumps. For this,\n' \
+               'Run omapconf dump 0x4a003400 0x4a00380c and save the output')
 
 parser.add_argument('-d', '--debug', dest='debug',
        action='store', type=int, choices=[0, 1, 2], default=0,
@@ -37,9 +33,44 @@ parser.add_argument('-i', '--interactive', dest='interactive',
        action='store', type=int, choices=[0, 1], default=1,
        help='run interactively with menus for resolving conflicts')
 
+parser.add_argument('-f', '--format', dest='format',
+       action='store', type=str, choices=["linux", "uboot", "bios"], default="uboot",
+       help='select the output format to be used')
+
+parser.add_argument('-r', '--revision', dest='revision',
+       action='store', type=str, choices=["1.1", "2.0"], default="1.1",
+       help='select the silicon revision')
+
+parser.add_argument('-m', '--module', dest='module',
+       action='store', type=str, default="",
+       help='generate only for this module')
+
+parser.add_argument('-s', '--strict', dest='strict',
+       action='store_true',
+       help='strict mode - ask for each pad of the group, do not save selection.\n' \
+               'For some peripherals, same delaymode cannot be used for all the pads.\n' \
+               'Use this mode to select different modes for each pad')
+
+parser.add_argument('-g', '--gpio', dest='gpio',
+       action='store_true',
+       help='generate script to read pad data from GPIO')
+
+parser.add_argument('-c', '--check', dest='check_xml',
+       action='store_true',
+       help='check consistency of the XML files and other data')
+
 args = parser.parse_args()
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
+PCT_VERSION = "v1.0.7"
+pad_data_xml = "XMLFiles/CTRL_MODULE_CORE.xml"
+iod_data_xml = "XMLFiles/IODELAYCONFIG.xml"
+model_data_xml = "XMLFiles/model_DRA75x_DRA74x_SR" + args.revision + "_" + PCT_VERSION + ".xml"
+
+modehelp_file = "guidelines.txt"
+pad_file = "ctrl-core.dump"
+sel_file = "selected-modes.txt"
+
 # Read the XML file database for pad and delay registers
 pad_xml = ET.parse(pad_data_xml).getroot()
 iod_xml = ET.parse(iod_data_xml).getroot()
@@ -158,7 +189,6 @@ def xml_get_manual(mode):
                        if (args.debug >= 1):
                                print ("    * MANUAL: %s [%s] => delay[%s] = %d, %d" % (signal, man_name, regname, adel, gdel))
        return mmodes
-               
 
 def xml_find_delaymodes(pad_name, muxmode):
        padlist = model_xml.findall("padDB/clockNode/type/pad")
@@ -174,12 +204,69 @@ def xml_find_delaymodes(pad_name, muxmode):
                        man = xml_get_manual(mode)
                        return (virt, man)
        return None
+
+def xml_check_correctness(modehelp):
+       if(args.check_xml == False):
+               return
+
+       print "###########################################"
+       print "XML correctness checks:"
+       padcore_list = []
+       padmodel_list = []
+       modes = {}
+
+       # Fint all the pads in core XML
+       pad_list = pad_xml.findall("register")
+       for i in pad_list:
+               name = i.get("id")
+               if (re.match("CTRL_CORE_PAD_.*", name) == None):
+                       continue
+               padcore_list.append(name)
+       print ">> Total pads defined in core XML = %d" % len(padcore_list)
+
+       # Find all the pads in model XML
+       pad_list = model_xml.findall("padDB/clockNode/type/pad/confregisters/regbit")
+       for i in pad_list:
+               name = i.findtext("register")
+               padmodel_list.append(name)
+       print ">> Total pads defined in model XML = %d" % len(padmodel_list)
+
+       # Find all the manual modes
+       manmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/manualmode/cfgreg/mode")
+       for i in manmode_list:
+               man_name = i.findtext("name")
+               modes[man_name] = "manual"
+       # Find all the virtual modes
+       virtmode_list = model_xml.findall("padDB/clockNode/type/pad/muxmode/virtualmode/mode")
+       for i in virtmode_list:
+               virt_name = i.findtext("name")
+               modes[virt_name] = "virtual"
+       print ">> Total delaymodes defined in model XML = %d" % len(modes)
+
+       # Print out all the errors found in the tests
+       print "== Pads defined in core XML but not in model XML =="
+       for i in padcore_list:
+               if (i not in padmodel_list):
+                       print "\t%s" % i
+       print "== Pads defined in model XML but not in core XML =="
+       for i in padmodel_list:
+               if (i not in padcore_list):
+                       print "\t%s" % i
+
+       # Check if description for each mode is available
+       print "== Delaymodes missing description in the guidelines.txt =="
+       for i in modes:
+               if (i not in modehelp):
+                       print "\t%s" % i
+
+       print "###########################################"
+
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
 # Decision point of the script
 # For each pad/pin, decide what delay method is used
 # Lookup in the selection file or ask user with a menu
-def select_mode(pad, pin, virt, man, modehelp, sel):
+def select_mode(pad, pin, module, virt, man, modehelp, sel):
        modelist = []
        for modename in virt.keys():
                modelist.append(modename)
@@ -190,17 +277,15 @@ def select_mode(pad, pin, virt, man, modehelp, sel):
        if (len(modelist) == 0):
                return "LEGACY"
 
-       # Find out if the delaymode for this module is already selected
-       module = re.match("([^_]+)_.*", pin).groups(0)[0]
        if (module in sel.keys()):
                mode = sel[module]
                if (mode == "SKIP" or mode in modelist):
                        return mode
                else:
-                       print("ERR: Invalid delaymode '%s' for module '%s'" & (mode, module))
+                       print("ERR: Invalid delaymode '%s' for module '%s'" % (mode, module))
 
        if (args.interactive == 0):
-               print "WARN: No delay modes for %s:%s found, skipping" % (pad, pin)
+               print "WARN: No delay modes for %s found, skipping" % module
                mode = "SKIP"
                sel[module] = mode
                return mode
@@ -213,7 +298,11 @@ def select_mode(pad, pin, virt, man, modehelp, sel):
                print "MENU: %d: %s \t\t\t%s" % (i, "SKIP", "Skips this module for now")
                for mode in modelist:
                        i += 1
-                       print "MENU: %d: %s \t\t%s" % (i, mode, modehelp[mode])
+                       if (mode in modehelp):
+                               helptext = modehelp[mode]
+                       else:
+                               helptext = "Unknown"
+                       print "MENU: %d: %s \t\t%s" % (i, mode, helptext)
                try:
                        choice = int(raw_input("Select delay mode #> "))
                        if (choice == 0):
@@ -228,8 +317,6 @@ def select_mode(pad, pin, virt, man, modehelp, sel):
        print "MENU: Selected mode is %s" % mode
        print ""
 
-       # Remember the selection for that module, for later reuse
-       sel[module] = mode
        return mode
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
@@ -237,25 +324,64 @@ def select_mode(pad, pin, virt, man, modehelp, sel):
 # As each pad is muxed with a SoC gpio (for most of the pads)
 # It's possible to read the pad data using gpio datain registers
 # Dump the linux commands to read the gpio registers and read the pad data
-def pad_dump_gpio(addr, offset, pin_name):
-       # Dump the script to read this pad using the gpio data register
-       gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
-       gpio_name = xml_pad_get_pin(offset, 14)
-       matchlist = re.match("GPIO(.)_(.)", gpio_name)
-       if (matchlist == None):
+def pad_dump_gpio(padconf, per_padconf):
+       if(args.gpio == False):
                return
-       inst = int(matchlist.groups(0)[0])
-       bit = int(matchlist.groups(0)[1])
-       gpio_addr = gpio_data_addrs[inst]
-       print "echo %d > /sys/class/gpio/export 2>/dev/null;" % (inst - 1) * 32
-       print "val=`omapconf read 0x%x 2>&1 | grep -v \"support\"`;" % gpio_addr
-       print "status=$((0x$val >> %d & 0x1));" % bit
-       print "echo -e \"%s (%s)\t = $status\";" % (pin_name, gpio_name)
+
+       print "# Read pad signals using GPIO DATA-IN registers"
+       print "# Works only for the input signals"
+       gpio_data_addrs = (0, 0x4ae10138, 0x48055138, 0x48057138, 0x48059138, 0x4805b138, 0x4805d138, 0x48051138, 0x48053138)
+       for i in padconf:
+               (pad_name, pin_name, addr, val, delayinfo) = i
+
+               offset = addr - 0x4a002000
+               gpio_name = xml_pad_get_pin(offset, 14)
+               matchlist = re.match("GPIO(.)_(.*)", gpio_name)
+               if (matchlist == None):
+                       print "ERR: No GPIO for pad %s" % pad_name
+                       continue
+
+               inst = int(matchlist.groups(0)[0])
+               bit = int(matchlist.groups(0)[1])
+               gpio_addr = gpio_data_addrs[inst]
+
+               print "#Read GPIO%d_%d to sample %s" % (inst, bit, pin_name)
+               print " echo %d > /sys/class/gpio/export 2>/dev/null;" % ((inst - 1) * 32)
+               print " val=`omapconf read 0x%x 2>&1 | grep -v \"support\"`;" % gpio_addr
+               print " status=$((0x$val >> %d & 0x1));" % bit
+               print " echo -e \"%s (%s)\t = $status\";" % (pin_name, gpio_name)
+               print ""
+       print ""
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
 # Generate the final pad and delay data in the required format
-# This can be changed to work for linux / u-boot / QNX / other format
-def format_pin_info(val):
+def format_pad_regs(padconf, per_padconf):
+       print "###########################################"
+       print "Pad data output (with the delay modes)"
+       print "###########################################"
+       if (args.format == "uboot"):
+               uboot_format_pad_regs(padconf, per_padconf)
+       elif (args.format == "linux"):
+               linux_format_pad_regs(padconf, per_padconf)
+       elif (args.format == "bios"):
+               bios_format_pad_regs(padconf, per_padconf)
+       else:
+               print "ERR: Format %s not suppported" % args.format
+
+def format_delay_regs(delayconf, per_delayconf):
+       print "#########################################"
+       print "Delay data output (for manual modes)"
+       print "#########################################"
+       if (args.format == "uboot"):
+               uboot_format_delay_regs(delayconf, per_delayconf)
+       elif (args.format == "linux"):
+               linux_format_delay_regs(delayconf, per_delayconf)
+       elif (args.format == "bios"):
+               bios_format_delay_regs(delayconf, per_delayconf)
+       else:
+               print "ERR: Format %s not suppported" % args.format
+
+def get_pin_info(val):
        inp_en = (val >> 18) & 0x1
        pulltype = (val >> 17) & 0x1
        pull_dis = (val >> 16) & 0x1
@@ -271,16 +397,20 @@ def format_pin_info(val):
                        pin += "_PULLDOWN"
        return pin
 
-def format_pad_regs(padconf):
-       # Generate the padmux data in kernel format
-       print "###########################################"
-       print "Pad data for u-boot (with the delay modes):"
-       print "###########################################"
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+# Generate output in u-boot format
+def uboot_format_pad_regs(padconf, per_padconf):
        print "\nconst struct pad_conf_entry dra74x_core_padconf_array[] = {"
        for i in padconf:
-               (pad_name, pin_name, addr, val, delaydata) = i
+               (pad_name, pin_name, addr, val, delayinfo) = i
+
+               if (re.match("MMC.*", pin_name) != None):
+                       print "WARN: Skipping MMC padconf in uboot"
+                       continue
+
                muxmode = val & 0xf
-               (method, data) = delaydata
+               (method, data) = delayinfo
                if (method == "LEGACY"):
                        extramode = ""
                elif (method == "VIRTUAL"):
@@ -291,22 +421,141 @@ def format_pad_regs(padconf):
                else:
                        print "ERR: Invalid method %s" % method
 
-               pin_info = format_pin_info(val) + extramode
+               pin_info = get_pin_info(val) + extramode
                pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
                comment = (pad_short + "." + pin_name).lower()
+
                print "\t{ %s, (M%d | %s) },\t/* %s */" % (pad_short, muxmode, pin_info, comment)
        print "};\n"
 
-def format_delay_regs(delayconf):
-       # Generate the delay data in kernel format
-       print "#########################################"
-       print "Delay data for u-boot (for manual modes):"
-       print "#########################################"
-       print "\nconst struct iodelay_cfg_entry dra742_iodelay_cfg_array[] = {"
+def uboot_format_delay_regs(delayconf, per_delayconf):
+       manual_del = []
        for i in delayconf:
-               (pad_name, pin_name, regname, del_offset, adel, gdel) = i
-               print "\t{ 0x%04X, %5d, %5d },\t/* %s */" % (del_offset, adel, gdel, regname)
+               (pad_name, pin_name, regname, del_offset, man_name, adel, gdel) = i
+
+               if (re.match("MMC.*", pin_name) != None):
+                       print "WARN: Skipping MMC delayconf in uboot"
+                       continue
+
+               entry = (del_offset, adel, gdel, regname, pin_name, man_name)
+               manual_del.append(entry)
+
+       es_rev = args.revision.replace('.', '_')
+       print "\nconst struct iodelay_cfg_entry dra742_es" + es_rev + "_iodelay_cfg_array[] = {"
+       for entry in sorted(manual_del):
+               print "\t{ 0x%04X, %5d, %5d },\t/* %s : %s - %s */" % entry
+       print "};\n"
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+# Generate output in linux format
+def linux_format_pad_regs(padconf, per_padconf):
+       print "&dra7_pmx_core {"
+       for per in per_padconf:
+
+               if (re.match("MMC.*", per) == None):
+                       print "ERR: Only MMC padconf is recommended in kernel"
+                       continue
+
+               dtsnode = ("%s_pins_default" % per).lower()
+               print ""
+               print "\t%s: %s {" % (dtsnode, dtsnode)
+               print "\t\tpinctrl-single,pins = <"
+               for i in per_padconf[per]:
+                       (pad_name, pin_name, addr, val, delayinfo) = i
+
+                       muxmode = val & 0xf
+                       (method, data) = delayinfo
+                       if (method == "LEGACY"):
+                               extramode = ""
+                       elif (method == "VIRTUAL"):
+                               delaymode = data
+                               extramode = " | VIRTUAL_MODE%d" % delaymode
+                       elif (method == "MANUAL"):
+                               extramode = " | MANUAL_MODE"
+                       else:
+                               print "ERR: Invalid method %s" % method
+
+                       pin_info = get_pin_info(val) + extramode
+                       pad_short = re.sub("CTRL_CORE_PAD_", "", pad_name)
+                       offset = addr - 0x4a003400
+                       comment = (pad_short + "." + pin_name).lower()
+
+                       print "\t\t\t0x%03X\t(%s | MUM_MODE%d)\t/* %s */" % (offset, pin_info, muxmode, comment)
+               print "\t\t>;"
+               print "\t};"
        print "};\n"
+
+
+def linux_format_delay_regs(delayconf, per_delayconf):
+       print "&dra7_iodelay_core {"
+       for per in per_delayconf.keys():
+
+               if (re.match("MMC.*", per) == None):
+                       print "ERR: Only MMC delayconf is recommended in kernel"
+                       continue
+
+               # Get the mode from the first entry
+               (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = per_delayconf[per][0]
+
+               dtsnode = ("%s_iodelay_%s_conf" % (per, mode)).lower()
+               print "\t%s: %s {" % (dtsnode, dtsnode)
+               print "\t\tpinctrl-single,pins = <"
+               for i in per_delayconf[per]:
+                       (pad_name, pin_name, regname, del_offset, mode, adel, gdel) = i
+
+                       print "\t\t\t0x%03X A_DELAY(%d) | G_DELAY(%d)\t/* %s */" % (del_offset, adel, gdel, regname)
+               print "\t\t>;"
+               print "\t};"
+       print "};\n"
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+# Generate output in bios format
+def bios_format_pad_regs(padconf, per_padconf):
+       for i in padconf:
+               (pad_name, pin_name, addr, val, delayinfo) = i
+
+               delaylist = []
+               (method, data) = delayinfo
+               if (method == "VIRTUAL"):
+                       virt_mode = data
+                       val = val | ( virt_mode<< 4)
+                       val = val | (1 << 8)
+               elif (method == "MANUAL"):
+                       delaylist = data
+                       val = val | (1 << 8)
+
+               offset = addr - 0x4a003400
+               out_delreg = out_adel = out_gdel = 0
+               in_delreg  = in_adel  = in_gdel  = 0
+               oen_delreg = oen_adel = oen_gdel = 0
+
+               for j in delaylist:
+                       (regname, adel, gdel) = j
+                       if (re.match(".*_IN", regname) != None):
+                               in_delreg = xml_iodelay_get_reg(regname)
+                               in_adel = adel
+                               in_gdel = gdel
+                       elif (re.match(".*_OEN", regname) != None):
+                               oen_delreg = xml_iodelay_get_reg(regname)
+                               oen_adel = adel
+                               oen_gdel = gdel
+                       elif (re.match(".*_OUT", regname) != None):
+                               out_delreg = xml_iodelay_get_reg(regname)
+                               out_adel = adel
+                               out_gdel = gdel
+               indel  = "{ 0x%04X, %4d, %4d }" % (in_delreg,  in_adel,  in_gdel)
+               oendel = "{ 0x%04X, %4d, %4d }" % (oen_delreg, oen_adel, oen_gdel)
+               outdel = "{ 0x%04X, %4d, %4d }" % (out_delreg, out_adel, out_gdel)
+               pin_info = get_pin_info(val)
+               print "\t/* %s -> %s (%s) %s delaymode */" % (pad_name, pin_name, pin_info, method)
+               print "\t{ 0x%03X, 0x%08X, %s, %s, %s }" % (offset, val, indel, oendel, outdel)
+
+def bios_format_delay_regs(delayconf, per_delayconf):
+       print "Manual delays are not configured separately"
+       print "Delays are configured as part of the padconf step only"
+
 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
 
 # Main execution starts here
@@ -322,7 +571,7 @@ def format_delay_regs(delayconf):
 #     => Update the selection for the whole of the peripheral module
 #   - Worst case, skip the delaymode for this pad
 # * Build the pad and delay register information
-# * Create the dump for pad and delay data in kernel/u-boot format
+# * Create the dump for pad and delay data in linux/u-boot format
 # * Dump the delaymode selection for each peripheral
 # * Dump the GPIO script for each peripheral (all pads grouped together)
 #
@@ -333,10 +582,16 @@ sel = read_selmodes(sel_file)
 regmap = read_pad_dump(pad_file)
 reglist = regmap.keys()
 
+# List of all the pads being configured
 padconf = []
+# List of all the delay registers being configured (for manual mode)
 delayconf = []
-padinfo = []
+# Dictionary of pads grouped by peripheral/module
+per_padconf = {}
+# Dictionary of delay registers grouped by peripheral/module
+per_delayconf = {}
 
+xml_check_correctness(modehelp)
 # Start iterating over each pad
 for i in range(0, 260):
        # Find out the muxmode and pad direction, etc
@@ -360,7 +615,12 @@ for i in range(0, 260):
        if (pin_name == "DRIVER OFF"):
                continue
 
-       padinfo.append((pad_name, pin_name, addr, offset, val))
+       # Find out if the delaymode for this module is already selected
+       module = re.match("([^_]+)_.*", pin_name).groups(0)[0]
+
+       if (args.module != "" and args.module != module):
+               continue
+
        if (args.debug >= 1):
                print "\nPAD: %s: Addr= 0x%08X Value = 0x%08X \"%s\"" \
                % (pad_name, addr, val, pin_name)
@@ -369,23 +629,31 @@ for i in range(0, 260):
        (virt, man) = xml_find_delaymodes(pad_name, muxmode)
 
        # Need to select one out of allowed modes
-       mode = select_mode(pad_name, pin_name, virt, man, modehelp, sel)
+       mode = select_mode(pad_name, pin_name, module, virt, man, modehelp, sel)
+
+       # Remember the selection for that module, for later reuse
+       if (args.strict == False):
+               sel[module] = mode
+
        if (mode == "SKIP"):
                continue
-
-       if (mode == "LEGACY"):
-               delaydata = ("LEGACY", "")
+       elif (mode == "LEGACY"):
+               delayinfo = ("LEGACY", "")
        elif (mode in virt):
-               delaydata = ("VIRTUAL", virt[mode])
+               delayinfo = ("VIRTUAL", virt[mode])
        elif (mode in man):
-               delaydata = ("MANUAL", man[mode])
+               delayinfo = ("MANUAL", man[mode])
        else:
                print "ERR: Unknown mode '%s' selected" % mode
                continue
 
        if (args.debug >= 1):
                print "  => Using mode %s" % mode
-       padconf.append((pad_name, pin_name, addr, val, delaydata))
+       paddata = (pad_name, pin_name, addr, val, delayinfo)
+       if (module not in per_padconf.keys()):
+               per_padconf[module] = []
+       padconf.append(paddata)
+       per_padconf[module].append(paddata)
 
        if(mode not in man):
                continue
@@ -399,15 +667,20 @@ for i in range(0, 260):
                        break
                if (args.debug >= 1):
                        print "  => Manual delay[%s] = (%d, %d)" % (regname, adel, gdel)
-               delayconf.append((pad_name, pin_name, regname, del_offset, adel, gdel))
+               delaydata = (pad_name, pin_name, regname, del_offset, mode, adel, gdel)
+               if (module not in per_delayconf.keys()):
+                       per_delayconf[module] = []
+               delayconf.append(delaydata)
+               per_delayconf[module].append(delaydata)
 
 print ""
 print "Total PAD registers: %d" % len(padconf)
 print "Total DELAY registers: %d" % len(delayconf)
 print ""
 
-format_pad_regs(padconf)
-format_delay_regs(delayconf)
+format_pad_regs(padconf, per_padconf)
+format_delay_regs(delayconf, per_delayconf)
+pad_dump_gpio(padconf, per_padconf)
 
 # Dump the final selection for reuse
 print "Selected modes for each peripheral module\n"