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 = ["/etc/bitfield.d", "/etc/bitfield",
19 os.path.join(os.getenv("HOME"), ".bitfield.d"),
20 os.path.join(os.getenv("HOME"), ".bitfield.conf")]
23 def __init__(self, bits, name):
31 def add_value(self, value, description):
32 self.values[int(value)] = description
34 def mask(self, reg_width, value):
36 out_len = len(self.bits)
37 for out_bit in range(0, out_len):
38 in_bit = self.bits[out_bit]
39 # shift this bit down to the LSB (and mask the rest)
40 i = (value >> (reg_width - in_bit - 1)) & 1
41 # shift back to the output position in the field
42 i <<= out_len - out_bit - 1
46 def value(self, value):
47 if value in self.values:
48 return self.values[value]
52 def parse_bitfield(line, reg):
53 a = line.split(None, 1)
59 for s in range_str.split(','):
61 (start, end) = s.split(':')
62 start = reg.bit_number(int(start))
63 end = reg.bit_number(int(end))
64 bits.extend(range(start, end + 1, 1))
66 bits.append(reg.bit_number(int(s)))
68 return bitfield(bits, name)
71 def parse_value(line):
72 a = line.split(None, 1)
81 def __init__(self, id):
86 self.bit_order = self.bit_0_is_msb
89 def add_field(self, field):
90 self.fields.append(field)
92 def decode(self, value, ignore_zero):
93 field_width = (self.width + 3) / 4
94 name_width = max(map(lambda f: len(f.name), self.fields))
96 str = "0x%0*lx [%d]\n" % (field_width, value, value)
98 for field in self.fields:
99 v = field.mask(self.width, value);
100 if ignore_zero and v == 0:
102 desc = field.value(v)
104 str += "%*s: 0x%x [%s]\n" \
105 % (name_width, field.name, v, desc)
107 str += "%*s: 0x%x\n" \
108 % (name_width, field.name, v)
111 def bit_number(self, number):
112 if self.bit_order == self.bit_0_is_lsb:
113 number = self.width - 1 - number
117 for (id, r) in regs.iteritems():
118 print "%18s : %s" % (id, r.name)
120 def search_regs(regs, str):
121 return dict((k, regs[k]) for k in regs \
122 if str.lower() in regs[k].name.lower() + k.lower())
124 class ConfigurationError(Exception):
125 def __init__(self, file, message):
127 self.message = message
129 def parse_config(bnf, regs, file):
132 tokens = bnf.parseString(f.read())
134 order_map = {'bit-0-is-lsb': register.bit_0_is_lsb,
135 'bit-0-is-msb': register.bit_0_is_msb,
136 'ibm': register.bit_0_is_msb,
137 'default': register.bit_0_is_msb}
144 raise ConfigurationError(file,
145 "Register %s is already defined" % id)
155 reg.name = name.strip()
156 elif t[0] == 'width':
157 reg.width = int(t[1])
158 elif t[0] == 'field':
159 f = bitfield.parse_bitfield(t[1], reg)
161 raise ConfigurationError(file,
162 "Invalid field in %s" % id)
164 elif t[0] == 'value':
166 raise ConfigurationError(file,
167 "No field for value in %s" % id)
168 v = bitfield.parse_value(t[1])
170 raise ConfigurationError(file,
171 "Invalid value in %s" % id)
173 fields[-1].add_value(v[0], v[1])
174 elif t[0] == 'order':
176 raise ConfigurationError(file,
177 ("bit order defined after " \
178 + "fields in %s") % id)
180 order_str = t[1].strip().lower()
181 order_str = order_str.replace(' ', '-')
183 if order_str not in order_map.keys():
184 raise ConfigurationError(file,
185 "Invalid bit order %s in %s" % \
187 reg.bit_order = order_map[order_str]
189 elif t[0] == 'alias':
190 alias_id = t[1].strip()
192 if alias_id is not None:
193 if reg.name is not None or fields != []:
194 raise ConfigurationError(file, ("Definiton " \
195 + "for %s is an alias, but has other " \
196 + "attributes") % id)
198 if not regs.has_key(alias_id):
199 raise ConfigurationError(file, "Aliasing "
200 "non-existent register %s (from %s)" \
206 if reg.name is None or reg.name == '':
207 raise ConfigurationError(file,
208 "No name for entry %s" % id)
211 raise ConfigurationError(file,
212 "Register %s has no fields" % id)
219 def parse_config_dir(data, dir, fnames):
222 full_fname = os.path.join(dir, fname)
224 if os.path.isdir(full_fname):
227 if fname.endswith('.conf'):
228 parse_config(bnf, regs, full_fname)
230 def parse_all_configs(configs):
233 # set up the bnf to be used for each file
234 lbrack = Literal("[").suppress()
235 rbrack = Literal("]").suppress()
236 colon = Literal(":").suppress()
239 comment = semi + Optional(restOfLine)
241 nonrbrack = "".join([c for c in printables if c != "]"]) + " \t"
242 noncolon = "".join([c for c in printables if c != ":"]) + " \t"
244 sectionDef = lbrack + Word(nonrbrack) + rbrack
245 keyDef = ~lbrack + Word(noncolon) + colon + restOfLine
247 bnf = Dict(ZeroOrMore(Group(sectionDef + ZeroOrMore(Group(keyDef)))))
250 # bundle into a single var that can be passed to os.path.walk
251 conf_data = (bnf, regs)
254 if not os.path.exists(conf):
256 if os.path.isdir(conf):
257 os.path.walk(conf, parse_config_dir, conf_data)
259 parse_config(bnf, regs, conf)
263 print "Usage: %s <-l> | <-s pattern> | [-n] register [value...]" % prog
265 def decode_value(reg, value, options):
268 except ValueError, e:
269 print "error: invalid value '%s'" % value
272 if i > ((1 << reg.width) - 1):
273 print ("error: value '%s' is too large " + \
274 "for %d-bit register '%s'") % (value, reg.width, reg.id)
277 print reg.decode(i, options['non-zero'])
282 (opts, args) = getopt(sys.argv[1:], "hlns:", \
283 ["help", "list", "non-zero", "search="])
289 regs = parse_all_configs(configs)
290 except ConfigurationError, e:
291 print "Error parsing configuration file %s:\n\t%s" % \
296 print "No configuration available"
300 options['non-zero'] = False
303 if o in ("-h", "--help"):
307 if o in ("-l", "--list"):
311 if o in ("-s", "--search"):
312 list_regs(search_regs(regs, a))
315 if o in ("-n", "--non-zero"):
316 options['non-zero'] = True
323 if not regs.has_key(reg_id):
324 print "No such register '%s'" % reg_id
328 print "decoding as %s" % reg.name
331 value_iter = args.__iter__()
333 value_iter = iter(sys.stdin.readline, '')
336 for value in value_iter:
337 decode_value(reg, value.strip(), options)
338 except KeyboardInterrupt, e:
343 if __name__ == "__main__":