origen_std_lib 0.10.1 → 0.13.1

data/src/advantest/smt8/origen/common/Origen.java

@@ -0,0 +1,334 @@
+package origen.common;
+
+import java.util.List;
+import xoc.dta.ITestContext;
+import xoc.dta.datatypes.MultiSiteLong;
+import xoc.dta.datatypes.MultiSiteString;
+import xoc.dta.measurement.IMeasurement;
+import xoc.dta.setupaccess.IPattern;
+import xoc.dta.signals.ISignal;
+
+public class Origen {
+
+  /**
+   * Define the different loglevels <br>
+   * Internally the SMT8 logging system will be used (message()) the constants here just work as
+   * shorthand for default use cases
+   */
+  public static final int LOG_METHODTRACE = 9;
+
+  public static final int LOG_DATA = 10;
+  public static final int LOG_PARAM = 3;
+  public static final int LOG_FUNC = 4;
+  public static final int LOG_FAIL = 2;
+  public static final int LOG_WARNING = 1;
+  public static final int LOG_ERROR = 0;
+
+  // All general multisite variables
+  // The booleans keep track of their state, these are not multisite since we only use multisite
+  // assignments for the _vars
+  private static MultiSiteString _lotid;
+  private static boolean _lotidSet;
+
+  private static MultiSiteLong _wafer;
+  private static boolean _waferSet;
+
+  private static MultiSiteLong _x;
+  private static boolean _xSet;
+
+  private static MultiSiteLong _y;
+  private static boolean _ySet;
+
+  public static ITestContext context;
+  public static IMeasurement meas;
+
+  /**
+   * Implementing the SMT8 message system also for this non-TM class. Perhaps not the prettiest
+   * thing to do but it fixes the logging. The context needs to be set from a TM (like Base)
+   *
+   * @param level
+   * @param msg
+   */
+  public static void message(int level, String msg) {
+    // No longer works on SMT 8.2, should this function be removed completely?
+    // context.message(level,msg);
+  }
+
+  public Origen() {
+    _lotidSet = false;
+    _waferSet = false;
+    _xSet = false;
+    _ySet = false;
+  }
+
+  /**
+   * Returns the IPattern from the name of the pattern
+   *
+   * @param patname
+   * @return
+   */
+  public static IPattern getPat(String patname) {
+    return context.pattern(patname);
+  }
+
+  /**
+   * Patch data per site
+   *
+   * @param subroutinePattern Name of the pattern to patch
+   * @param pin Name of the pin to use
+   * @param decData The data to patch with
+   * @param size The amount of vectors to patch
+   */
+  public static void overlaySubroutinePerSite(
+      String subroutinePattern, String pin, MultiSiteLong decData, int size) {
+    message(Origen.LOG_METHODTRACE, "Performing patching on " + subroutinePattern);
+    OrigenHelpers.overlaySubroutine(
+        getPat(subroutinePattern),
+        Origen.pinFromGroup(pin),
+        decData,
+        size,
+        context.getActiveSites());
+  }
+
+  /**
+   * Patch the same data to all sites
+   *
+   * @param subroutinePattern Name of the pattern to patch
+   * @param pin Name of the pin to use
+   * @param decData The data to patch with
+   * @param size The amount of vectors to patch
+   */
+  public static void overlaySubroutineAllSites(
+      String subroutinePattern, String pin, long decData, int size) {
+    message(Origen.LOG_METHODTRACE, "Performing patching on " + subroutinePattern);
+    OrigenHelpers.overlaySubroutine(
+        getPat(subroutinePattern), Origen.pinFromGroup(pin), decData, size);
+  }
+
+  /**
+   * Get 1 pin name from a pingroup. Throws an exception if the group contains more than 1 pin
+   *
+   * @param group
+   * @return
+   */
+  public static String pinFromGroup(String group) {
+    List<ISignal> dutGroup = meas.getSignalGroup(group).getDutSignals();
+    if (dutGroup.size() > 1) {
+      throw new NumberFormatException("Can only patch one signal at a time");
+    }
+    return dutGroup.get(0).toString();
+  }
+
+  //    /**
+  //     * Debug function to display the STDF variables to check if they are properly setup
+  //     */
+  //    public static void showDieInfoFromSTDF() {
+  //      MultiSiteLong x_coord =context.testProgram().variables().getLong("STDF.X_COORD");
+  //      MultiSiteLong y_coord =context.testProgram().variables().getLong("STDF.Y_COORD");
+  //      MultiSiteString wafer_id =context.testProgram().variables().getString("STDF.WAFER_ID");
+  //      MultiSiteString lot_id =context.testProgram().variables().getString("STDF.LOT_ID");
+  //      String sublot_id =context.testProgram().variables().getString("STDF.SBLOT_ID").get();
+  //      message(Origen.LOG_DATA,"Wafer_id:" + wafer_id);
+  //      message(Origen.LOG_DATA,"Lot_id:" + lot_id);
+  //      message(Origen.LOG_DATA,"Sublot_id:" + sublot_id);
+  //      message(Origen.LOG_DATA,"(x,y):(" + x_coord + "," + y_coord + ")");
+  //    }
+
+  /** Set the lot ID to the given value, e.g. "ABC1234" */
+  public static void lotid(MultiSiteString v) {
+    _lotid = v;
+    _lotidSet = true;
+  }
+
+  /** Convert long value to 8 character ASCII string */
+  private static String toASCII(long value) {
+    int length = 8;
+    StringBuilder builder = new StringBuilder(length);
+    for (int i = length - 1; i >= 0; i--) {
+      builder.append((char) ((value >> (8 * i)) & 0xFF));
+    }
+    return builder.toString();
+  }
+
+  /** Set the lot ID based on the integer representation returned from lotidInt */
+  public static void lotid(MultiSiteLong v) {
+    MultiSiteString lotStr = new MultiSiteString("");
+    for (int site : v.getActiveSites()) {
+      long val = v.get(site);
+      lotStr.set(site, toASCII(val));
+    }
+    lotid(lotStr);
+  }
+
+  /* Get the lot ID. If it has not previously been set to a value it will be automatically queried
+   * from the test system.
+   */
+  public static MultiSiteString lotid() {
+    if (!_lotidSet) {
+
+      MultiSiteString lot_id = new MultiSiteString("TR7T7290W25D0");
+
+      if(!context.testProgram().variables().getString("mi8_recipe_version").get().isEmpty()) {
+          lot_id = context.testProgram().variables().getString("STDF.WAFER_ID"); //for use with prober
+      }
+
+      MultiSiteString batch_id = new MultiSiteString();
+      for (int site : context.getActiveSites()) {
+        String perSiteWID = lot_id.get(site); // per site string contains batch id & wafer number
+        String sBatch =
+            perSiteWID.substring(
+                0, Math.min(perSiteWID.length(), 8)); // this will give you batch id
+        batch_id.set(site, sBatch);
+        System.out.println("Wafer batch " + sBatch);
+      }
+
+      _lotid = batch_id; // store the batch number
+      //          _lotidSet = true;
+    }
+
+    return _lotid;
+  }
+
+  /**
+   * Returns the lot ID as a 64-bit integer that is suitable for programming to the device. Each
+   * character in the lotID is converted to its ASCII code. An error will be raised if the length of
+   * the current lotID overflows 64-bits.STDF.WAFER_ID
+   */
+  public static MultiSiteLong lotidInt() {
+    MultiSiteLong tempLong = new MultiSiteLong();
+    MultiSiteString lotid = lotid();
+    for (int site : lotid.getActiveSites()) {
+      String id = lotid.get(site);
+
+      // Convert each character to ascii using 2 hex (8 bytes)
+      StringBuilder sb = new StringBuilder();
+      char[] letters = id.toCharArray();
+      for (char ch : letters) {
+        sb.append(Long.toHexString(ch));
+      }
+      // Convert the hex string to long again
+      tempLong.set(site, Long.parseLong(sb.toString(), 16));
+    }
+    return tempLong;
+  }
+
+  /** Set the wafer number to the given value */
+  public static void wafer(MultiSiteLong valMSL) {
+    _wafer = valMSL;
+    _waferSet = true;
+  }
+
+  /**
+   * Get the wafer number. If it has not previously been set to a value it will be automatically
+   * queried from the test system.
+   */
+  public static MultiSiteLong wafer() {
+    if (!_waferSet) {
+ 
+      MultiSiteString wafer_id = new MultiSiteString("TR7T7290W55D0");
+
+      if(!context.testProgram().variables().getString("mi8_recipe_version").get().isEmpty()) {
+          wafer_id = context.testProgram().variables().getString("STDF.WAFER_ID"); //for use with prober
+          // Expect to return something like "TR7T7290W25D0)", where 25 is the wafer number
+      }
+
+      MultiSiteLong mslWnum = new MultiSiteLong(0);
+      for (int site : context.getActiveSites()) {
+        String perSiteWID = wafer_id.get(site); // per site string contains batch id & wafer number
+        String sWnum =
+            perSiteWID.substring(
+                perSiteWID.length() - 4,
+                perSiteWID.length() - 2); // extracted wafer number as string
+        Long lWnum = new Long(sWnum); // wafer number in Long
+        mslWnum.set(site, lWnum);
+        System.out.println("Wafer number " + lWnum);
+      }
+
+      // TBD :check for valid value
+      //        if (lWnum < 1 || lWnum > 25) {
+      //                  throw new Error("ERROR: Wafer is out of the range : " + mslWnum);
+      //              }
+
+      _wafer = mslWnum; // store the wafer number
+      //          _waferSet = true;
+    }
+    return _wafer;
+  }
+
+  /** Query the X and Y coordinates from the test system and set them for all sites. */
+  public static void setXY() {
+
+    MultiSiteLong x_coord = new MultiSiteLong(90); // for debug purpose
+    MultiSiteLong y_coord = new MultiSiteLong(100); // for debug purpose
+
+    if(!context.testProgram().variables().getString("mi8_recipe_version").get().isEmpty()) {
+        x_coord =context.testProgram().variables().getLong("STDF.X_COORD"); //for use with probe
+        y_coord =context.testProgram().variables().getLong("STDF.Y_COORD"); //for use with probe
+    }
+
+    //        MultiSiteLong x_coord = new MultiSiteLong(90); // for debug purpose
+    //        MultiSiteLong y_coord = new MultiSiteLong(100); // for debug purpose
+
+    // TBD
+    //        if (x_coord.lessThan(-32768) || x_coord.greaterThan(32767) ) {
+
+    //             throw new NumberFormatException("Can only patch one signal at a time");
+    //           cout << "ERROR: X is out of the range of an Int16: " << lx << endl;
+    //           ERROR_EXIT(TM::EXIT_FLOW);
+
+    //         }
+
+    //         GetDiePosXYOfSite(_number, &lx, &ly);
+    //         if (lx < -32768 || lx > 32767) {
+    //         cout << "ERROR: X is out of the range of an Int16: " << lx << endl;
+    //         ERROR_EXIT(TM::EXIT_FLOW);
+    //         }
+    //         if (ly < -32768 || ly > 32767) {
+    //         cout << "ERROR: Y is out of the range of an Int16: " << ly << endl;
+    //         ERROR_EXIT(TM::EXIT_FLOW);
+    //         }
+    //         _x = (int) lx;
+    //         _y = (int) ly;
+
+    _x = x_coord;
+    _y = y_coord;
+    //       _xSet = true;
+    //       _ySet = true;
+  }
+
+  /**
+   * Get the X co-ord. If it has not previously been set to a value it will be automatically queried
+   * from the test system.
+   */
+  public static MultiSiteLong x() {
+    if (!_xSet) {
+      setXY();
+    }
+    return _x;
+  }
+
+  /**
+   * Get the Y co-ord. If it has not previously been set to a value it will be automatically queried
+   * from the test system.
+   *
+   * @return
+   */
+  public static MultiSiteLong y() {
+    if (!_ySet) {
+      setXY();
+    }
+    return _y;
+  }
+
+  /** Set the X co-ordinate to the given value */
+  public static void x(MultiSiteLong v) {
+    _x = v;
+    _xSet = true;
+  }
+
+  /** Set the Y co-ordinate to the given value */
+  public static void y(MultiSiteLong v) {
+    _y = v;
+    _ySet = true;
+  }
+}