3 # Utility to decode register values
4 # Copyright (c) 2006 Jeremy Kerr <jk@ozlabs.org>
5 # Released under the GNU General Public License version 2 or later
7 # Documentation and updates at: http://ozlabs.org/~jk/code/bitfield
12 from pyparsing import Literal, Word, ZeroOrMore, Group, Dict, Optional, \
13 printables, ParseException, restOfLine
14 from getopt import getopt, GetoptError
16 # List of paths to look for configuration files. If a directory is specified,
17 # it will be (recursively) scanned for .conf files.
18 configs = [os.path.join(os.getenv("HOME"), ".bitfields.conf"),
19 os.path.join(os.getenv("HOME"), ".bitfields.d")]
22 def __init__(self, start_bit, end_bit, name):
23 self.start_bit = start_bit
24 self.end_bit = end_bit
35 return 1 + self.end_bit - self.start_bit
37 def add_value(self, value, description):
38 self.values[int(value)] = description
40 def mask(self, reg_width, value):
41 shift = (reg_width - 1) - self.end_bit
42 return (((2 ** self.width() - 1) << (shift))
45 def value(self, value):
46 if value in self.values:
47 return self.values[value]
51 return "[%2d:%-2d] %s 0x%x" % (int(self.start_bit),
52 int(self.end_bit), self.name, self.mask())
55 def parse_bitfield(line):
56 a = line.split(None, 1)
62 if range_str.find(':') != -1:
63 r = range_str.split(":")
64 range = (int(r[0]),int(r[1]))
66 range = (int(range_str),int(range_str))
68 return bitfield(range[0], range[1], name)
71 def parse_value(line):
72 a = line.split(None, 1)
78 def __init__(self, name, width):
83 def add_field(self, field,):
84 self.fields.append(field)
86 def decode(self, value):
87 field_width = (self.width + 3) / 4
88 name_width = max(map(lambda f: len(f.name), self.fields))
89 str = "0x%0*lx [%d]\n" % (field_width, value, value)
90 for field in self.fields:
91 v = field.mask(self.width, value);
94 str += "%*s: 0x%s [%s]\n" \
95 % (name_width, field.name, v, desc)
97 str += "%*s: 0x%x\n" \
98 % (name_width, field.name, v)
102 str = self.name + "\n"
103 for f in self.fields:
108 for (id, r) in regs.iteritems():
109 print "%18s : %s" % (id, r.name)
111 def search_regs(regs, str):
112 return dict((k, regs[k]) for k in regs \
113 if str.lower() in regs[k].name.lower() + k.lower())
115 class ConfigurationError(Exception):
116 def __init__(self, file, message):
118 self.message = message
120 def parse_config(bnf, regs, file):
123 tokens = bnf.parseString("".join(f.readlines()))
130 raise ConfigurationError(file,
131 "Register %s is already defined" % id)
133 # default to 64 bit registers
142 elif t[0] == 'width':
144 elif t[0] == 'field':
145 f = bitfield.parse_bitfield(t[1])
147 raise ConfigurationError(file,
148 "Invalid field in %s" % id)
150 elif t[0] == 'value':
152 raise ConfigurationError(file,
153 "No field for value in %s" % id)
154 v = bitfield.parse_value(t[1])
156 raise ConfigurationError(file,
157 "Invalid value in %s" % id)
159 fields[-1].add_value(v[0], v[1])
161 if name is None or name == '':
162 raise ConfigurationError(file,
163 "No name for entry %s" % id)
166 raise ConfigurationError(file,
167 "Register %s has no fields" % id)
169 r = register(name, width)
175 def parse_config_dir(data, dir, fnames):
178 full_fname = os.path.join(dir, fname)
180 if os.path.isdir(full_fname):
183 if fname.endswith('.conf'):
184 parse_config(bnf, regs, full_fname)
186 def parse_all_configs(configs):
189 # set up the bnf to be used for each file
190 lbrack = Literal("[").suppress()
191 rbrack = Literal("]").suppress()
192 colon = Literal(":").suppress()
195 comment = semi + Optional(restOfLine)
197 nonrbrack = "".join([c for c in printables if c != "]"]) + " \t"
198 noncolon = "".join([c for c in printables if c != ":"]) + " \t"
200 sectionDef = lbrack + Word(nonrbrack) + rbrack
201 keyDef = ~lbrack + Word(noncolon) + colon + restOfLine
203 bnf = Dict(ZeroOrMore(Group(sectionDef + ZeroOrMore(Group(keyDef)))))
206 # bundle into a single var that can be passed to os.path.walk
207 conf_data = (bnf, regs)
210 if not os.path.exists(conf):
212 if os.path.isdir(conf):
213 os.path.walk(conf, parse_config_dir, conf_data)
215 parse_config(bnf, regs, conf)
219 print "Usage: %s <-l> | <-s pattern> | register [value...]" % prog
223 (opts, args) = getopt(sys.argv[1:], "hls:", \
224 ["help", "list", "search="])
230 regs = parse_all_configs(configs)
231 except ConfigurationError, e:
232 print "Error parsing configuration file %s:\n\t%s" % \
237 print "No configuration available"
241 if o in ("-h", "--help"):
245 if o in ("-l", "--list"):
249 if o in ("-s", "--search"):
250 list_regs(search_regs(regs, a))
259 if not regs.has_key(reg_id):
260 print "No such register '%s'" % reg_id
264 print "decoding as %s" % r.name
270 values = sys.stdin.readlines()
271 except KeyboardInterrupt, e:
275 i = long(value.strip(), 0)
280 if __name__ == "__main__":