_origen

This is the top-level _origen module which can be imported by Python

Submodules

• _origen.logger
  • Functions
• _origen.dut
  • Submodules
    • _origen.dut.pins
      • Classes
    • _origen.dut.registers
      • Functions
      • Classes
    • _origen.dut.timesets
      • Classes
  • Classes
• _origen.tester
  • Classes
• _origen.application
  • Classes
• _origen.interface
  • Classes
• _origen.producer
  • Classes
• _origen.services
  • Classes
• _origen.utility
  • Submodules
    • _origen.utility.mailer
      • Functions
      • Classes
    • _origen.utility.session_store
      • Functions
      • Classes
    • _origen.utility.ldap
      • Functions
      • Classes
  • Functions
  • Classes
• _origen.tester_apis
  • Classes
• _origen.standard_sub_blocks
  • Submodules
    • _origen.standard_sub_blocks.arm_debug
      • Classes
• _origen.prog_gen
  • Functions
• _origen.users
  • Functions
  • Classes

Functions

• initialize(): Called automatically when Origen is first loaded

• status(): Returns the Origen status which informs whether an app is present, the Origen version,

• version(): Returns the Origen version formatted into PEP440, e.g. “1.2.3.dev4”

• config(): Returns the Origen configuration (as defined in origen.toml files)

• app_config(): Returns the Origen application configuration (as defined in application.toml)

• clean_mode(): clean_mode(name)

• target_file(): target_file(name, dir)

• file_handler(): Returns a file handler object (iterable) for consuming the file arguments

• test(): Prints out the AST for the current test to the console

• test_ast(): Returns the AST for the current test in Python

• flow(): Prints out the AST for the current flow to the console

• flow_ast(): Returns the AST for the current flow in Python

• output_directory(): Undocumented.

• website_output_directory(): Undocumented.

• website_source_directory(): Undocumented.

• on_windows(): Undocumented.

• on_linux(): Undocumented.

• prepare_for_target_load(): This will be called by Origen immediately before loading a fresh set of targets

• start_new_test(): Clears the current test (pattern) AST and starts a new one

• unhandled_error_count(): Returns the number of unhandled errors that have been encountered since the Origen

• set_output_dir(): Set the output directory to be used instead of <APP ROOT>/output

• set_reference_dir(): Set the output directory to be used instead of <APP ROOT>/output

• exit_pass(): Exit with a passing status code and print a big PASS to the console

• exit_fail(): Exit with a failing status code and print a big FAIL to the console

• enable_debug(): Enable Python source line tracking

• set_operation(): Set the current Origen operation (generate, compile, etc.)

_origen.initialize()

Called automatically when Origen is first loaded

_origen.status()

Returns the Origen status which informs whether an app is present, the Origen version, etc.

_origen.version()

Returns the Origen version formatted into PEP440, e.g. “1.2.3.dev4”

_origen.config()

Returns the Origen configuration (as defined in origen.toml files)

_origen.app_config()

Returns the Origen application configuration (as defined in application.toml)

_origen.clean_mode(name)

Sanitizes the given mode string and returns it, but will exit the process if it is invalid

_origen.target_file(name, dir)

Sanitizes the given target/env name and returns the matching file, but will exit the process if it does not uniquely identify a single target/env file.

_origen.file_handler()

Returns a file handler object (iterable) for consuming the file arguments given to the CLI

_origen.test()

Prints out the AST for the current test to the console

_origen.test_ast()

Returns the AST for the current test in Python

_origen.flow()

Prints out the AST for the current flow to the console

_origen.flow_ast()

Returns the AST for the current flow in Python

_origen.output_directory()

_origen.website_output_directory()

_origen.website_source_directory()

_origen.on_windows()

_origen.on_linux()

_origen.prepare_for_target_load()

This will be called by Origen immediately before loading a fresh set of targets

_origen.start_new_test()

Clears the current test (pattern) AST and starts a new one

_origen.unhandled_error_count()

Returns the number of unhandled errors that have been encountered since the Origen invocation started. An unhandled error is something that ultimately resulted in a pattern not being generated or something equally serious.

_origen.set_output_dir()

Set the output directory to be used instead of <APP ROOT>/output

_origen.set_reference_dir()

Set the output directory to be used instead of <APP ROOT>/output

_origen.exit_pass()

Exit with a passing status code and print a big PASS to the console

_origen.exit_fail()

Exit with a failing status code and print a big FAIL to the console

_origen.enable_debug()

Enable Python source line tracking

_origen.set_operation()

Set the current Origen operation (generate, compile, etc.)