README.md

# riscv_vm
&nbsp;<img src="https://github.com/openhwgroup/riscv_vm/blob/master/RISCV_VM.png" width="200" title="RISC-V VM">

The OpenHW Group's RISC-V Virtual Machine (riscv_vm) is intended for anyone wanting to study, configure as-preferred, modify, implement or release hardware based the RISC-V Instruction Set Architecture. The VM is preconfigured for RISC-V HW development.
   * RISC-V SW tool chain using the Eclipse-IDE
   * RISC-V Imperas OVPSim model
   * RISC-V Verilator model
   * The files in the ~/bin directory are used to create the VM Linux image after Ubuntu 18.04LT has been installed. 
   * The VM'sminimal configuration is 2CPU/4G-RAM/20GB-DISK with USB 2.0 enabled
   * To donwload a protable *.osa appliance file, go to:
     - [RISCV_VM *.OVA image on Google Drive](https://drive.google.com/drive/folders/18njYttFpczl-CrHkZ7HQ-lLf-w2fBcL9)
   * **Note that the virtual machine userID /password is _user/abc123_**
 
## Importing VM into VirtualBox on Windows10 host
The instructions to install and run are:
1. Open a Windows Command-line prompt with Admin privileges:
   * Press the Windows-Start key
   * search for the _"cmd.exe"_ program
   * right-click on CMD icon
   * select _“Run as administrator”_
2. Download and run the installer batch file available in this repository: 
   - [riscv_vm Windows10 Install script](https://github.com/openhwgroup/riscv_vm/blob/master/riscv_vm_win10_install.bat)
3. Install VirtualBox and its corresponding Extension Pack downloaded by the installer script
4. Import the *.OVA “appliance” into VirtualBox
5. Start the VcXsrv client
6. Start git-bash to run the following:
   - Start the VM from the git-bash in head-less mode (your path may be different):
  ```
        <PROMPT$>/c/bta_cadtree/VirtualBox/vb6_0_10/VBoxManage startvm riscv_vm2 --type headless
        <PROMPT$>export DISPLAY=localhost:0.0
  ```
7. SSH into the VM using the command:
   - ssh -Yv user@<_IP of riscv_vm2_>
   - In my case that is: ssh -Yv user@192.168.56.101

## Installing the riscv_vm tools directly on Ubuntu 18.04LT host (UNTESTED)
On a Linux machine with Ubuntu 18.04LT installed, follow these instructions:
1. clone the repo from your Linux machine:
   - git clone git@github.com:openhwgroup/riscv_vm.git
2. run the installe and follow the prompts on the screen:
   - sudo riscv_vm/bin/ubuntu_post-install.sh
 
## Importing VM into VirtualBox on MacOS host
The instructions to install and run are:
1. Open the “Terminal” application, found in /Applications/Utilities/
2. Download and run the installer script  available in this repository: 
   - [riscv_vm MacOS Install script](https://github.com/openhwgroup/riscv_vm/blob/master/riscv_vm_macos_install.command) 
3. Install VirtualBox and its corresponding Extension Pack downloaded by the installer script
4. Import the *.OVA “appliance” into VirtualBox
5. Start the XQuartz client:
   - Install XQuartz on your Mac, which is the official X server software for Mac
   - Run Applications > Utilities > XQuartz.app
6. Right click on the XQuartz icon in the dock and select Applications > Terminal.  This should bring up a new xterm terminal windows to run the following:
   - Start the VM from the xquartz-terminal in head-less mode (your path may be different):
  ```
        <PROMPT$>/c/bta_cadtree/VirtualBox/vb6_0_10/VBoxManage startvm riscv_vm2 --type headless
        <PROMPT$>export DISPLAY=localhost:0.0
  ```
7. SSH into the VM using the command:
   - ssh -Yv user@<_IP of riscv_vm2_>
   - In my case that is: ssh -Yv user@192.168.56.101