• Guides
  • Videos
  • Publications
  • API
  • Github
  • Community
  • Release Notes
  • Plugins
Installing Origen
  • Introduction
  • How to Install
  • How to Install (Windows)
  • Company Customization
  • Understanding Gems
  • Invoking Considerations
  • Workspace Management
Getting Started with Origen
  • Core concepts
  • Creating a New App
  • Directory Structure
  • The Initial Commit
  • Creating New Files
  • Understanding Blocks
  • Application Architecture
Runtime Environment
  • Introduction
  • Mode
  • Environment
  • Target
  • Production Targets
  • Global Setup
  • Load Order
  • Programming
Models
  • Introduction
  • Naming
  • Definition & Hierarchy
  • Adding Attributes
  • Versioning
  • Bugs & Features
  • Package, Mode & Configuration
  • Registers
  • Pins
  • Power Domains
  • Hardware Attributes
  • Parameters
  • Specifications
  • Fuses
  • Generic Components
  • Creating Your Own Components
Compiler (Views)
  • Introduction
  • Creating Templates
  • Using Sub-Templates
  • Helpers
  • Running The Compiler
  • Inline Compiler
Controllers
  • Introduction
  • Shadow Controllers
  • Direct Controllers
Pattern Generator
  • Introduction
  • Creating Patterns
  • Pins
  • Timing and Waiting
  • Registers
  • Documenting Patterns
  • Generating by Name
  • Common API
  • J750 API
  • V93K API
  • UltraFlex API
  • STIL & Other Formats
  • Custom Testers
  • Running The PatGen
  • Concurrent Patterns
Test Program Generator
  • Introduction
  • Philosophy
  • Creating Flows
  • Managing Flow Control
  • Creating an Interface
  • Additional Resources
  • Dynamic Custom Code
  • Characterization API
  • J750 API
  • V93K Common API
  • V93K SMT7 API
  • V93K SMT8 API
  • UltraFLEX API
  • Documenting the Program
  • Creating Custom Testers
  • Running the ProgGen
Decompilation
  • Overview & Example
  • Decompiling, Adding Pins, & Executing
  • Working with Decompiled Patterns
  • Platform Specifics
Simulation
  • Introduction
  • How It Works
  • Compiling the DUT
  • AMS Support
  • Environment Setup
  • Application Setup
  • Simulating Patterns
  • Simulating Flows
  • Direct DUT Manipulation
  • Simulator Log Output
  • Artifacts
  • Debugging
Documentation Generator
  • Introduction
  • Markdown
  • Linking
  • Styling
  • Testing
  • API Generation
  • Deploying
Plugins
  • Introduction
  • Using a Plugin
  • Creating a Plugin
  • Current & Default Plugins
  • Dev Environment
  • Dev Considerations
  • Paths & Origen.root
  • Config & Origen.app
Miscellaneous
  • Revision Control
  • Origen Remotes
  • Lint Testing
  • Session Store
  • LSF API
  • Users, Emails & Maillists
  • Utilities & Helpers
  • Ruby Extensions
  • Logger
  • Adding Commands
  • Overriding Commands
  • Callbacks
  • Application Callbacks
  • Miscellaneous Topics
Advanced Topics
  • Introduction
  • Invocation Customization
  • Custom App Generators

Installing Origen

How to Install (Windows)


Origen can be installed on Linux or Windows, this guide refers to the Windows installation.

@powershell commands
All @powershell commands should be run from a commandshell other than powershell.

If you want to run on Linux then please see this guide instead: How to Install Origen on Linux

Last updated on 11th January 2021
The vast majority of Origen use in production is on Linux, and over time this Windows guide can become out of date and no one realizes. If you do experience any issues when following this guide, then please do let us know via the comments below and we will update it as required.

1. (Optional) Install a Better Console

Download Console by following this link.

Move the .zip file to C:/Program Files, then right click it and select Extract All....

Open the unzipped folder and right click on Console.exe and select Send to > Desktop (create shortcut).

Open the console from your desktop and execute the following command, we recommend that you create all of your Origen application workspaces in C:\origen:

mkdir C:\origen

Select Edit > Settings from the console menu and enable the checkbox at the bottom of the settings called Save settings to user directory.

Execute the following command to get a sensible set settings to start off with:

@powershell New-Item -ItemType directory -Force -Path %appdata%\Console; (new-object System.Net.WebClient).DownloadFile('https://origen-sdk.org/files/console.xml','%appdata%\Console\console.xml')

2. Install Pre-Requisites

Install unxutils by going to this link https://sourceforge.net/projects/unxutils/.

Install git from the official Git website https://git-scm.com/downloads

3. Install Ruby

We are currently recommending installing Ruby version 2.6.

Follow the instructions at https://www.ruby-lang.org/en/ to install Ruby with the devkit.

4. Install Origen

Finally, run this command to install Origen:

gem install origen --no-document

This can take several minutes to finish without updating the screen, so please be patient.

You can then verify Origen availability by running origen -v at which point you should see something like this:

    Origen: 0.60.18

4.1 Update PATH variable

This step is required to ensure that Origen boots correctly inside of a workspace. Add .\lbin as the first entry in your PATH variable by following this 3rd party tutorial on How to Create an Environment Variable in Windows. The SYSTEM VARIABLES PATH entry will need to be udpated.

You can check that the path was updated correctly by opening a new powershell console (after the variable update) and typing:

$env:path

.\lbin should appear as the first entry in your path. If it is not, be sure that you added it to the system variables (not user variables) PATH entry.

4.2 Install a newer bundler version

This step is not required. But, you may quickly encounter a scenario where a newer bundler version is required. In this case before Origen boots it will display a message with instructions for what is needed.

Run this command to install a newer version of bundler:

gem install bundler -v 2.1.4

Congratulations, Origen is now installed!

Some users have reported an error at this point which complains about the HOME environment variable not being set.

If you see that, set it to something like this by following this 3rd party tutorial on How to Create an Environment Variable in Windows:

HOME = C:\Users\my_user_id

Note that the version of Origen that is installed to your Ruby installation does not need to be kept up to date with the latest version of Origen. You can now consider your Ruby environment to be frozen for the foreseeable future.

See the section on Understanding Gems for details on why that is.


Comments

Generated with the Origen Semiconductor Developer's Kit

Origen is released under the terms of the MIT license