diff --git a/mcdp/src/ch/ntb/mcdp/dict/Register.java b/mcdp/src/ch/ntb/mcdp/dict/Register.java
index 3ad0a44..2ee0a8d 100644
--- a/mcdp/src/ch/ntb/mcdp/dict/Register.java
+++ b/mcdp/src/ch/ntb/mcdp/dict/Register.java
@@ -1,11 +1,61 @@
package ch.ntb.mcdp.dict;
-public class Register {
+/**
+ * Representation of a register.
+ *
+ * @author schlaepfer
+ */
+public abstract class Register {
- // Register Types
+ /**
+ * Register specific type values.
+ * The index of each type in the types array represents its numeric value.
+ * When the register is read from an xml file, its type is converted from a
+ * string (xml file) to an integer (index of types field). Therefore each
+ * type in the corresponding xml file must be included in the type array.
+ * The type field must be initialised in the static { }
+ * section of the subclass.
+ */
protected static String[] types = null;
- public Register(String name, int type, int value, int size,
+ /**
+ * Name of the register. Registers are identified by this value.
+ */
+ public String name = "NOT INITIALISED";
+
+ /**
+ * Register specific type
+ */
+ public int type;
+
+ /**
+ * Address or a register specific value (e.g. BDI-identifier)
+ */
+ public int value;
+
+ /**
+ * Size in bytes (width)
+ */
+ public int size;
+
+ /**
+ * A string description of the register
+ */
+ public String description;
+
+ /**
+ * @param name
+ * name of the register. Registers are identified by this value.
+ * @param type
+ * register specific type
+ * @param value
+ * address or a register specific value (e.g. BDI-identifier)
+ * @param size
+ * size in bytes
+ * @param description
+ * a string description of the register
+ */
+ public void init(String name, int type, int value, int size,
String description) {
this.name = name;
this.type = type;
@@ -14,23 +64,18 @@ public class Register {
this.description = description;
}
- public final String name;
-
- public final int type;
-
- public final int value;
-
- public final int size;
-
- public final String description;
-
@Override
public String toString() {
return new String(name + "\t" + types[type] + "\t0x"
+ Integer.toHexString(value) + "\t" + size + "\t" + description);
}
-
- public String[] getTypes(){
- return types;
+
+ /**
+ * Get the register specific type strings.
+ *
+ * @return types strings
+ */
+ public static String[] getTypes() {
+ return types;
}
}
diff --git a/mcdp/src/ch/ntb/mcdp/dict/RegisterDict.java b/mcdp/src/ch/ntb/mcdp/dict/RegisterDict.java
index 075ee70..cb599e5 100644
--- a/mcdp/src/ch/ntb/mcdp/dict/RegisterDict.java
+++ b/mcdp/src/ch/ntb/mcdp/dict/RegisterDict.java
@@ -2,7 +2,7 @@ package ch.ntb.mcdp.dict;
import java.io.File;
import java.io.IOException;
-import java.lang.reflect.Constructor;
+import java.lang.reflect.Method;
import java.util.Iterator;
import java.util.LinkedList;
@@ -18,11 +18,27 @@ import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
+/**
+ * Representation of a register dictionary. All registers are read from an
+ * xml-file specified by registerDictionary.dtd. Note that the
+ * type values are implementation specific. Therefore each Register has
+ * its own registerDictionary.dtd definition. For an example see
+ * MPC555Register and the corresponding
+ * resources/targets/mpc555/registerDictionary.dtd file.
+ *
+ * @author schlaepfer
+ */
public abstract class RegisterDict {
private LinkedList registers;
- private Class regClass;
+ private Class regClass;
+
+ private Method regClassGetTypesMethod;
+
+ private static final String GetTypes_METHOD_NAME = "getTypes";
+
+ private String[] types;
private static final long serialVersionUID = -582382284126896830L;
@@ -44,29 +60,58 @@ public abstract class RegisterDict {
private static final String REG_ATTR_SIZE = "size";
- protected RegisterDict(String registerClass) {
+ /**
+ * Default constructor which takes the Class object from a
+ * Register subclass as argument. The registerDict will be of
+ * this Register-type.
+ * An example:
+ * MPC555Register extends Register -> use MPC555Register.class as parameter.
+ *
+ * @param registerClass
+ * subclass of Register
+ */
+ protected RegisterDict(Class registerClass) {
+ this.regClass = registerClass;
try {
- this.regClass = Class.forName(registerClass);
- } catch (ClassNotFoundException e) {
+ this.regClassGetTypesMethod = regClass.getMethod(
+ GetTypes_METHOD_NAME, (Class[]) null);
+ this.regClass.newInstance();
+ this.types = (String[]) regClassGetTypesMethod.invoke(
+ (Object[]) null, (Object[]) null);
+ } catch (Exception e) {
e.printStackTrace();
System.exit(1);
}
this.registers = new LinkedList();
}
+ /**
+ * Add a new register to the registerDict.
+ *
+ * @param name
+ * name of the register. Registers are identified by this value.
+ * @param type
+ * register specific type
+ * @param value
+ * address or a register specific value (e.g. BDI-identifier)
+ * @param size
+ * size in bytes
+ * @param description
+ * a string description of the register
+ */
@SuppressWarnings("unchecked")
- protected void add(String name, int type, int value, int size,
+ public void add(String name, int type, int value, int size,
String description) {
// remove before add for updates
for (Iterator i = registers.iterator(); i.hasNext();) {
- if (((Register)i.next()).name.equals(name)) {
+ if (((Register) i.next()).name.equals(name)) {
i.remove();
}
}
- Constructor[] regConstructors = regClass.getDeclaredConstructors();
Register reg = null;
try {
- reg = (Register) regConstructors[0].newInstance(name, type, value, size, description);
+ reg = (Register) regClass.newInstance();
+ reg.init(name, type, value, size, description);
} catch (Exception e) {
e.printStackTrace();
System.exit(1);
@@ -74,7 +119,7 @@ public abstract class RegisterDict {
registers.add(reg);
}
- protected int parseInt(String s) {
+ private int parseInt(String s) {
if (s == "")
return 0;
if (s.indexOf('x') > 0) {
@@ -94,6 +139,13 @@ public abstract class RegisterDict {
}
}
+ /**
+ * Get a register by its name.
+ *
+ * @param name
+ * the register name
+ * @return register on null if no register is found
+ */
public Register getRegister(String name) {
for (Iterator i = registers.iterator(); i.hasNext();) {
Register r = (Register) i.next();
@@ -104,6 +156,9 @@ public abstract class RegisterDict {
return null;
}
+ /**
+ * Print a list of Registers to standard out.
+ */
public void printRegisters() {
System.out
.println("******************** register dictionary *********************");
@@ -122,14 +177,21 @@ public abstract class RegisterDict {
* Adds the registers from the specified xml-file to the register
* dictionary.
* The xml-file must be structured according to
- * registerDictionary.dtd. Include
+ * registerDictionary.dtd. The dtd-file must be adapted to
+ * the type values specific to this register. Include
*