X-Git-Url: https://git.ozlabs.org/?p=bitfield;a=blobdiff_plain;f=bitfield;h=345ee9fe060ac394b95e20e6736adbd1ca946609;hp=27605d33bf3a7cdcb52e3f3f686f8b0c71b43a89;hb=HEAD;hpb=f28ac723f98f1618f4cbf203cf226f1e9c37cdc4 diff --git a/bitfield b/bitfield old mode 100644 new mode 100755 index 27605d3..345ee9f --- a/bitfield +++ b/bitfield @@ -1,4 +1,4 @@ -#!/usr/bin/python2.4 +#!/usr/bin/env python3 # # Utility to decode register values # Copyright (c) 2006 Jeremy Kerr @@ -9,6 +9,7 @@ import os import sys import pprint +import math from pyparsing import Literal, Word, ZeroOrMore, Group, Dict, Optional, \ printables, ParseException, restOfLine from getopt import getopt, GetoptError @@ -29,15 +30,20 @@ class bitfield: return len(self.bits) def add_value(self, value, description): - self.values[int(value)] = description + self.values[int(value, 0)] = description - def mask(self, reg_width, value): + def mask(self, reg, value): ret = 0 out_len = len(self.bits) - for out_bit in range(0, out_len): - in_bit = self.bits[out_bit] + + if reg.bit_order == reg.bit_0_is_msb: + bit_pairs = zip(self.bits, range(0, out_len)) + else: + bit_pairs = zip(self.bits, range(out_len - 1, -1, -1)) + + for (in_bit, out_bit) in bit_pairs: # shift this bit down to the LSB (and mask the rest) - i = (value >> (reg_width - in_bit - 1)) & 1 + i = (value >> (reg.width - in_bit - 1)) & 1 # shift back to the output position in the field i <<= out_len - out_bit - 1 ret |= i @@ -49,7 +55,20 @@ class bitfield: return None @staticmethod - def parse_bitfield(line): + def mask_and_shift_to_bits(width, mask, shift): + bits = [] + val = mask << shift + for i in range(0, width): + if mask & (1 << i): + bits.insert(0, width - i - 1 - shift) + return bits + + @staticmethod + def mask_to_bits(width, mask): + return bitfield.mask_and_shift_to_bits(width, mask, 0) + + @staticmethod + def parse_bitfield(line, reg): a = line.split(None, 1) if len(a) != 2: return None @@ -58,13 +77,26 @@ class bitfield: bits = [] for s in range_str.split(','): if ':' in s: - (start, end) = s.split(':') - bits.extend(range(int(start), int(end) + 1, 1)) + (start, end) = map( \ + lambda s: reg.bit_number(int(s)), + s.split(':')) + bits.extend(range(start, end - 1, -1)) + elif '<<' in s: + (mask, shift) = map(lambda s: int(s.strip()), + s.split('<<')) + bits.extend(bitfield.mask_and_shift_to_bits( \ + reg.width, mask, shift)) + elif s.startswith('&'): + mask = int(s[1:], 0) + bits.extend(bitfield.mask_to_bits(reg.width, \ + mask)) else: - bits.append(int(s)) - + bits.append(reg.bit_number(int(s))) + return bitfield(bits, name) + + @staticmethod def parse_value(line): a = line.split(None, 1) @@ -73,23 +105,28 @@ class bitfield: return a class register: - def __init__(self, id, name, width): + bit_0_is_msb = 0 + bit_0_is_lsb = 1 + + def __init__(self, id): self.id = id - self.name = name - self.width = width self.fields = [] + # set defaults + self.name = None + self.bit_order = self.bit_0_is_msb + self.width = 64 def add_field(self, field): self.fields.append(field) def decode(self, value, ignore_zero): - field_width = (self.width + 3) / 4 + field_width = math.floor((self.width + 3) / 4) name_width = max(map(lambda f: len(f.name), self.fields)) str = "0x%0*lx [%d]\n" % (field_width, value, value) for field in self.fields: - v = field.mask(self.width, value); + v = field.mask(self, value); if ignore_zero and v == 0: continue desc = field.value(v) @@ -101,9 +138,14 @@ class register: % (name_width, field.name, v) return str + def bit_number(self, number): + if self.bit_order == self.bit_0_is_lsb: + number = self.width - number - 1 + return number + def list_regs(regs): - for (id, r) in regs.iteritems(): - print "%18s : %s" % (id, r.name) + for (id, r) in regs.items(): + print("%18s : %s" % (id, r.name)) def search_regs(regs, str): return dict((k, regs[k]) for k in regs \ @@ -119,27 +161,32 @@ def parse_config(bnf, regs, file): tokens = bnf.parseString(f.read()) + order_map = {'bit-0-is-lsb': register.bit_0_is_lsb, + 'bit-0-is-msb': register.bit_0_is_msb, + 'ibm': register.bit_0_is_msb, + 'default': register.bit_0_is_msb} + for tok in tokens: ts = tok.asList() id = ts.pop(0) - if regs.has_key(id): + if id in regs: raise ConfigurationError(file, "Register %s is already defined" % id) - # default to 64 bit registers - width = 64 - name = None + reg = register(id) + + alias_id = None fields = [] for t in ts: if t[0] == 'name': name = t[1] - name = name.strip() + reg.name = name.strip() elif t[0] == 'width': - width = int(t[1]) + reg.width = int(t[1]) elif t[0] == 'field': - f = bitfield.parse_bitfield(t[1]) + f = bitfield.parse_bitfield(t[1], reg) if f is None: raise ConfigurationError(file, "Invalid field in %s" % id) @@ -154,8 +201,39 @@ def parse_config(bnf, regs, file): "Invalid value in %s" % id) fields[-1].add_value(v[0], v[1]) + elif t[0] == 'order': + if len(fields) != 0: + raise ConfigurationError(file, + ("bit order defined after " \ + + "fields in %s") % id) + + order_str = t[1].strip().lower() + order_str = order_str.replace(' ', '-') + + if order_str not in order_map.keys(): + raise ConfigurationError(file, + "Invalid bit order %s in %s" % \ + (order_str, id)) + reg.bit_order = order_map[order_str] - if name is None or name == '': + elif t[0] == 'alias': + alias_id = t[1].strip() + + if alias_id is not None: + if reg.name is not None or fields != []: + raise ConfigurationError(file, ("Definiton " \ + + "for %s is an alias, but has other " \ + + "attributes") % id) + + if not regs.has_key(alias_id): + raise ConfigurationError(file, "Aliasing " + "non-existent register %s (from %s)" \ + % (alias_id, id)) + + reg = regs[alias_id] + continue + + if reg.name is None or reg.name == '': raise ConfigurationError(file, "No name for entry %s" % id) @@ -163,11 +241,10 @@ def parse_config(bnf, regs, file): raise ConfigurationError(file, "Register %s has no fields" % id) - r = register(id, name, width) for f in fields: - r.add_field(f) + reg.add_field(f) - regs[id] = r + regs[id] = reg def parse_config_dir(data, dir, fnames): (bnf, regs) = data @@ -207,27 +284,28 @@ def parse_all_configs(configs): if not os.path.exists(conf): continue if os.path.isdir(conf): - os.path.walk(conf, parse_config_dir, conf_data) + for c in os.walk(conf): + parse_config_dir(conf_data, c[0], c[2]) else: parse_config(bnf, regs, conf) return regs def usage(prog): - print "Usage: %s <-l> | <-s pattern> | [-n] register [value...]" % prog + print("Usage: %s <-l> | <-s pattern> | [-n] register [value...]" % prog) def decode_value(reg, value, options): try: - i = long(value, 0) - except ValueError, e: - print "error: invalid value '%s'" % value + i = int(value, 0) + except ValueError: + print("error: invalid value '%s'" % value) return if i > ((1 << reg.width) - 1): - print ("error: value '%s' is too large " + \ + print("error: value '%s' is too large " + \ "for %d-bit register '%s'") % (value, reg.width, reg.id) return - print reg.decode(i, options['non-zero']) + print(reg.decode(i, options['non-zero'])) def main(): @@ -240,13 +318,13 @@ def main(): try: regs = parse_all_configs(configs) - except ConfigurationError, e: - print "Error parsing configuration file %s:\n\t%s" % \ - (e.file, e.message) + except ConfigurationError as e: + print("Error parsing configuration file %s:\n\t%s" % \ + (e.file, e.message)) return 1 if regs == {}: - print "No configuration available" + print("No configuration available") return 1 options = {} @@ -273,22 +351,22 @@ def main(): return 1 reg_id = args.pop(0) - if not regs.has_key(reg_id): - print "No such register '%s'" % reg_id + if reg_id not in regs: + print("No such register '%s'" % reg_id) return 1 reg = regs[reg_id] - print "decoding as %s" % reg.name + print("decoding as %s" % reg.name) if args: value_iter = args.__iter__() else: value_iter = iter(sys.stdin.readline, '') - + try: for value in value_iter: decode_value(reg, value.strip(), options) - except KeyboardInterrupt, e: + except KeyboardInterrupt: pass return 0