origen_std_lib 0.10.1 → 0.13.1

data/src/advantest/smt8/origen/test_methods/Base.java

@@ -0,0 +1,265 @@
+package origen.test_methods;
+
+import origen.common.Origen;
+import xoc.dta.TestMethod;
+import xoc.dta.datatypes.MultiSiteBoolean;
+import xoc.dta.datatypes.MultiSiteDouble;
+import xoc.dta.datatypes.MultiSiteLong;
+import xoc.dta.measurement.IMeasurement;
+import xoc.dta.resultaccess.IMeasurementResult;
+import xoc.dta.testdescriptor.IFunctionalTestDescriptor;
+import xoc.dta.testdescriptor.IParametricTestDescriptor;
+
+/** Origen testmethods base class. All testmethods inherit from this class */
+public class Base extends TestMethod {
+  /** General testmethod parameters, used by all testmethods */
+  public IMeasurement measurement;
+
+  public String testName;
+  // TODO Verify forcePass implementation (also check if implemented in DC_Measurements)
+  public Boolean forcePass = false;
+  // Sites that passed will contain a '1' if forcePass has been set, otherwise undefined
+  public MultiSiteLong setOnPassFlags;
+  // Sites that failed will contain a '1' if forcePass has been set, otherwise undefined
+  public MultiSiteLong setOnFailFlags;
+  // When set to true the tester will never be released by Origen code, though your application
+  // test method code is still free to do so if you want
+  public Boolean syncPar = false;
+  /**
+   * The log level that will be used during the execution of the TP. Change the value here to get
+   * more, or less logging info
+   */
+  int origenLoglevel = Origen.LOG_WARNING;
+
+  /**
+   * Execute the checkparms() function? This is used to check if all testmethod parameters are
+   * parsed
+   */
+  boolean checkParams = true;
+
+  public void logTrace(String className, String method) {
+    message(Origen.LOG_METHODTRACE, "\t" + className + "\t" + method + "()");
+  }
+
+  // ********* FLOW LOGIC BELOW **********
+
+  /**
+   * Overridden setup function from the testmethod
+   *
+   * <p>The order is that first the setup() function is called by SMT, then the update() function
+   * and then the execute() function
+   *
+   * <p>This setup() function calls the _setup function from the underlying class (Can be
+   * DC_Measurement or Function_test), depending on the type of TM These subclasses are responsible
+   * for proper handling of the TM setup.
+   */
+  @Override
+  public void setup() {
+    Origen.context = context;
+    Origen.meas = measurement;
+    messageLogLevel = origenLoglevel;
+    logTrace("Base", "setup");
+    if (!dependenciesUnchanged()) {
+      _setup();
+    }
+  }
+
+  /**
+   * Overridden update function from the testmethod
+   *
+   * <p>The order is that first the setup() function is called by SMT, then the update() function
+   * and then the execute() function
+   *
+   * <p>The update() function does nothing at the moment. It acts as a placeholder because all TM's
+   * should have an update function. If a TM wants the use the update() functionality from SMT it
+   * can implement this function itself
+   */
+  @Override
+  public void update() {
+    logTrace("Base", "update");
+  }
+
+  /**
+   * Overridden execute function from the testmethod
+   *
+   * <p>The order is that first the setup() function is called by SMT, then the update() function
+   * and then the execute() function
+   *
+   * <p>The execute() function first checks if the parameters are parsed. It then calls the body()
+   * function from the testmethod. This is the main function of the TM. Finally it necessary, it
+   * calls the process() function from the TM.
+   */
+  @Override
+  public void execute() {
+    logTrace("Base", "execute");
+
+    if (checkParams) {
+      checkParams();
+    }
+
+    if (forcePass) {
+      setOnPassFlags = new MultiSiteLong(1);
+      setOnFailFlags = new MultiSiteLong(0);
+    }
+
+    // Call the internal pre body function
+    _preBody();
+
+    // Call the application test method body
+    body();
+
+    // Call the application test method process method
+    process();
+
+    // Call the internal process results method
+    processResults();
+  }
+
+  /**
+   * Placeholder for the checkParams function. The goal of this function is to check if all the
+   * testmethod parameters that are passed to a testmethod are actually used This will make sure
+   * that parameters are not ignored. Should be overridden by testmethods when needed
+   */
+  public void checkParams() {
+    logTrace("Base", "checkParams");
+  }
+
+  public void measure_setup() {
+    logTrace("Base", "measure_setup");
+  }
+
+  public void process() {
+    logTrace("Base", "process");
+  }
+
+  public void _setup() {
+    logTrace("Base", "_setup");
+  }
+
+  public void run() {
+    logTrace("Base", "run");
+  }
+
+  public void _preBody() {
+    logTrace("Base", "_preBody");
+  }
+
+  public void body() {
+    logTrace("Base", "body");
+    run();
+  }
+
+  public void processResults() {
+    logTrace("Base", "processResults");
+  }
+
+  public void judgeAndDatalog(IFunctionalTestDescriptor t, MultiSiteBoolean passed) {
+    MultiSiteBoolean allPassed = new MultiSiteBoolean(true);
+
+    if (forcePass) {
+      for (int site : context.getActiveSites()) {
+        setOnPassFlags.set(site, setOnPassFlags.get(site) & (passed.get(site) ? 1 : 0));
+        setOnFailFlags.set(site, setOnFailFlags.get(site) | (passed.get(site) ? 0 : 1));
+      }
+      // Record that this test happened to STDF, but don't know how to log the true result
+      // without also causing it to fail/bin
+      t.evaluate(allPassed);
+    } else {
+      t.evaluate(passed);
+    }
+    for (int site : context.getActiveSites()) {
+      message(
+          Origen.LOG_PARAM,
+          "["
+              + site
+              + "]("
+              + t.getTestName()
+              + ") "
+              + " : "
+              + (passed.get(site) ? "PASSED" : "FAILED"));
+    }
+  }
+
+  public void judgeAndDatalog(IFunctionalTestDescriptor t, IMeasurementResult measurementResult) {
+    MultiSiteBoolean passed = measurementResult.hasPassed();
+    judgeAndDatalog(t, passed);
+  }
+
+  /**
+   * Log a multisite double
+   *
+   * @param t Name of the testdescriptor
+   * @param MSD
+   */
+  public void judgeAndDatalog(IParametricTestDescriptor t, MultiSiteDouble MSD) {
+
+    if (forcePass) {
+      boolean loLimitPresent, hiLimitPresent;
+      double lo = 0;
+      double hi = 0;
+
+      if (t.getLowLimit() == null) {
+        loLimitPresent = false;
+      } else {
+        loLimitPresent = true;
+        lo = t.getLowLimit().doubleValue();
+      }
+      if (t.getHighLimit() == null) {
+        hiLimitPresent = false;
+      } else {
+        hiLimitPresent = true;
+        hi = t.getHighLimit().doubleValue();
+      }
+
+      for (int site : context.getActiveSites()) {
+        boolean passed = true;
+        double val = MSD.get(site);
+
+        // TODO: How to handle difference between LT and LTE?
+        if (loLimitPresent) {
+          if (val < lo) {
+            passed = false;
+          }
+        }
+
+        if (hiLimitPresent) {
+          if (val > hi) {
+            passed = false;
+          }
+        }
+
+        setOnPassFlags.set(site, setOnPassFlags.get(site) & (passed ? 1 : 0));
+        setOnFailFlags.set(site, setOnFailFlags.get(site) | (passed ? 0 : 1));
+      }
+
+      t.setLowLimit(Double.NaN);
+      t.setHighLimit(Double.NaN);
+    }
+
+    t.evaluate(MSD);
+
+    MultiSiteBoolean pf = t.getPassFail();
+    for (int site : context.getActiveSites()) {
+      message(
+          Origen.LOG_PARAM,
+          "["
+              + site
+              + "]("
+              + t.getTestName()
+              + ") "
+              + MSD.get(site)
+              + " : "
+              + (pf.get(site) ? "PASSED" : "FAILED"));
+    }
+  }
+
+  /**
+   * Log a multisite long
+   *
+   * @param t Name of the testdescriptor
+   * @param MSL
+   */
+  public void judgeAndDatalog(IParametricTestDescriptor t, MultiSiteLong MSL) {
+    judgeAndDatalog(t, MSL.toMultiSiteDouble());
+  }
+}

data/src/advantest/smt8/origen/test_methods/DC_Measurement.java

@@ -0,0 +1,302 @@
+package origen.test_methods;
+
+import java.io.File;
+import origen.common.Origen;
+import origen.common.OrigenHelpers;
+import xoc.dsa.DeviceSetupFactory;
+import xoc.dsa.IDeviceSetup;
+import xoc.dta.datatypes.MultiSiteDouble;
+import xoc.dta.datatypes.MultiSiteDoubleArray;
+import xoc.dta.resultaccess.IDigInOutActionResults;
+import xoc.dta.resultaccess.IDigInOutActionResults.IIforceVmeasResults;
+import xoc.dta.resultaccess.IDigInOutActionResults.IVforceImeasResults;
+import xoc.dta.resultaccess.IMeasurementResult;
+import xoc.dta.testdescriptor.IFunctionalTestDescriptor;
+import xoc.dta.testdescriptor.IParametricTestDescriptor;
+
+/** An example test method using test descriptor */
+public class DC_Measurement extends Base {
+
+  public IFunctionalTestDescriptor FUNC;
+  public IParametricTestDescriptor PAR;
+
+  public enum MEAS {
+    CURR,
+    VOLT
+  }
+
+  MultiSiteDouble _result;
+
+  boolean _applyShutdown;
+  String _shutdownPattern;
+  int _checkShutdown;
+  MEAS _measure;
+  double _settlingTime;
+  String _pin;
+  double _forceValue;
+  double _iRange;
+  double _VclampLow;
+  double _VclampHigh;
+  boolean _highAccuracy;
+  double _limitsLow;
+  double _limitsHigh;
+  int _averages;
+
+  int _badc;
+  String _actionName;
+  public DC_Measurement origen;
+
+  static OrigenHelpers origenHelpers;
+
+  /** The result of executing the primary pattern */
+  private IMeasurementResult funcResult;
+
+  @Override
+  public void measure_setup() {
+    logTrace("DC_Measurement", "measure_setup");
+  }
+
+  public DC_Measurement applyShutdown(boolean v) {
+    _applyShutdown = v;
+    return this;
+  }
+
+  public DC_Measurement shutdownPattern(String v) {
+    _shutdownPattern = v;
+    return this;
+  }
+
+  public DC_Measurement checkShutdown(int v) {
+    _checkShutdown = v;
+    return this;
+  }
+
+  public DC_Measurement measure(MEAS volt) {
+    _measure = volt;
+    return this;
+  }
+
+  public DC_Measurement settlingTime(double v) {
+    _settlingTime = v;
+    return this;
+  }
+
+  public DC_Measurement averages(int v) {
+    _averages = v;
+    return this;
+  }
+
+  public DC_Measurement VclampLow(double v) {
+    _VclampLow = v;
+    return this;
+  }
+
+  public DC_Measurement VclampHigh(double v) {
+    _VclampHigh = v;
+    return this;
+  }
+
+  public DC_Measurement highAccuracy(boolean v) {
+    _highAccuracy = v;
+    return this;
+  }
+
+  public DC_Measurement limitsLow(double v) {
+    _limitsLow = v;
+    return this;
+  }
+
+  public DC_Measurement limitsHigh(double v) {
+    _VclampHigh = v;
+    return this;
+  }
+
+  public DC_Measurement pin(String v) {
+    _pin = v;
+    return this;
+  }
+
+  public DC_Measurement forceValue(double v) {
+    _forceValue = v;
+    return this;
+  }
+
+  public DC_Measurement iRange(double v) {
+    _iRange = v;
+    return this;
+  }
+
+  public DC_Measurement badc(int v) {
+    _badc = v;
+    return this;
+  }
+
+  public MultiSiteDouble result() {
+    return _result;
+  }
+
+  @Override
+  public void _setup() {
+    message(10, "DC_Measurement --> _Setup");
+    origen = this;
+    pin("NVM_ANALOGIO");
+    applyShutdown(true);
+    checkShutdown(1);
+    settlingTime(1000 * 1e-6);
+    forceValue(0);
+    iRange(0);
+    VclampLow(0);
+    VclampHigh(3);
+    highAccuracy(true);
+    limitsHigh(3);
+    limitsLow(0);
+    averages(1);
+    badc(0);
+    shutdownPattern("");
+
+    // Call setup from the testmethod
+    measure_setup();
+
+    message(Origen.LOG_METHODTRACE, "Setting up " + _measure + " measurement");
+
+    if (_measure == MEAS.VOLT) {
+      _actionName = "iforceVmeas";
+    } else {
+      _actionName = "vforceImeas";
+    }
+
+    if (_applyShutdown) {
+      if (_shutdownPattern.isEmpty()) {
+        // TODO Fix the relative paths for the shutdownpattern
+        shutdownPattern(measurement.getPatternName() + "_part1");
+        String workingDirectory = System.getProperty("user.dir");
+        String[] parts = _shutdownPattern.split("\\.");
+        String file = workingDirectory + "/src/patterns/" + parts[2] + ".pat";
+        File f = new File(measurement.getPatternName());
+        if (f.exists()) {
+          message(Origen.LOG_METHODTRACE, "Shutdown pattern " + file + " found, using it.");
+        } else {
+          message(
+              Origen.LOG_FAIL,
+              "Shutdown pattern " + file + " not found, NOT using a shutdown pattern!");
+          applyShutdown(false);
+          shutdownPattern("");
+        }
+      }
+    }
+
+    // Create an action sequence for the measurement
+    IDeviceSetup ds = DeviceSetupFactory.createInstance();
+    ds.importSpec(measurement.getSpecificationName());
+
+    //        ISetupDigInOut dcVISetup = ds.addDigInOut("NVM_ANA_PIN");
+    //        forceValue = I_force; // The forced current
+    //        waitTime = 1000us; // A delay between forcing the current and measuring the voltage
+    //        vclampHigh = 3V; // The upper-limit of the voltage clamp
+    //        vclampLow = 0.0V; // The lower-limit of the voltage clamp
+    //        highAccuracy = true; // The highAccuracy mode of the digInOut instrument is turned off
+    // in this example
+    //        limits.low = 0V; // The lower-limit for the measurment to pass
+    //        limits.high = 3V; // The upper-limit for the measurement to pass
+    //
+    //
+    //        IIforceVmeas iforceVmeas = dcVISetup.iforceVmeas("iforceVmeas");
+    //        iforceVmeas.setForceValue(0);
+    //        iforceVmeas.setVclampHigh(1);
+    //        iforceVmeas.setVclampLow(-1);
+    //        iforceVmeas.setAverages(_averages);
+    //        iforceVmeas.setWaitTime(_settlingTime)
+    //
+    //        action iforceVmeas iforceVmeas {
+    //            forceValue = I_force; // The forced current
+    //            waitTime = 1000us; // A delay between forcing the current and measuring the
+    // voltage
+    //            vclampHigh = 3V; // The upper-limit of the voltage clamp
+    //            vclampLow = 0.0V; // The lower-limit of the voltage clamp
+    //            highAccuracy = true; // The highAccuracy mode of the digInOut instrument is turned
+    // off in this example
+    //            limits.low = 0V; // The lower-limit for the measurment to pass
+    //            limits.high = 3V; // The upper-limit for the measurement to pass
+    //
+    //        }
+    //        action vforceImeas vforceImeas {
+    //            forceValue = V_force; // The forced voltage
+    //            waitTime = 1.5ms; // A delay between forcing the voltage and measuring the current
+    //            irange = 0.1uA; // The expected range of the measured current
+    //            highAccuracy = false; // The highAccuracy mode of the digInOut instrument is
+    // turned off in this example
+    //            limits.low = -20.0nA; // The lower-limit for the measurment to pass
+    //            limits.high = -5.0nA; // The upper-limit for the measurement to pass
+    //
+    //        }
+
+    // ds.parallelBegin("MeasurementSequence");
+    // {
+    ds.sequentialBegin("PatAndShutdownSeq");
+    {
+      ds.patternCall(measurement.getPatternName());
+      ds.actionCall(_actionName);
+      if (_applyShutdown) {
+        ds.patternCall(_shutdownPattern);
+      }
+    }
+    ds.sequentialEnd();
+    // }
+    // ds.parallelEnd();
+
+    measurement.setSetups(ds);
+  }
+
+  @Override
+  public void run() {
+    MultiSiteDoubleArray intermediateResult;
+
+    logTrace("DC_Measurement", "run");
+    super.run();
+    measurement.execute();
+
+    // postBody should be added and called here
+
+    // protect results to be not overwritten
+    IDigInOutActionResults actionResults = measurement.digInOut(_pin).preserveActionResults();
+    funcResult = measurement.preserveResult();
+
+    // Assume for now that if force pass is set then branching decision could be dependent on the
+    // result of this test, in future add another attribute to control async processing on/off
+    if (!syncPar && !forcePass) {
+      releaseTester();
+    }
+
+    // Make the DC measurement result available
+    if (_measure == MEAS.VOLT) {
+      IIforceVmeasResults ifvmResults = actionResults.iforceVmeas(_actionName);
+      intermediateResult = ifvmResults.getVoltage(_pin);
+
+    } else { // MEAS.CURR
+      IVforceImeasResults ifvmResults = actionResults.vforceImeas(_actionName);
+      intermediateResult = ifvmResults.getCurrent(_pin);
+    }
+
+    // Loop through the sites to get the data
+    _result = new MultiSiteDouble();
+    for (int site : context.getActiveSites()) {
+      if (intermediateResult.get(site).length > 1) {
+        message(
+            1,
+            "Warning: not all measurements are logged, only the first one, change in DC_Measurement.java to include more");
+      }
+      _result.set(site, intermediateResult.get(site)[0]);
+    }
+  }
+
+  @Override
+  public void processResults() {
+    judgeAndDatalog(FUNC, funcResult);
+
+    judgeAndDatalog(PAR, filterResult(_result));
+  }
+
+  public MultiSiteDouble filterResult(MultiSiteDouble MSD) {
+    return MSD;
+  }
+}

data/src/advantest/smt8/origen/test_methods/Empty.java

@@ -0,0 +1,12 @@
+package origen.test_methods;
+
+/** An empty test template */
+public class Empty extends Base {
+
+  /** Main run function for empty */
+  @Override
+  public void run() {
+    logTrace("Empty", "run");
+    super.run();
+  }
+}