# chisel3-idea-template

**Repository Path**: haitianjiang/chisel3-idea-template

## Basic Information

- **Project Name**: chisel3-idea-template
- **Description**: Ubuntu下的IDEA的Chisel工程模板
- **Primary Language**: Scala
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-25
- **Last Updated**: 2022-04-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Chisel Project Template
=======================

> Modify from [OpenXiangShan chisel-playground](https://github.com/OpenXiangShan/chisel-playground)

Another version of the [Chisel template](https://github.com/ucb-bar/chisel-template) supporting mill.
mill is another Scala/Java build tool without obscure DSL like SBT. It is much faster than SBT.

**This project uses Scalatest framework, not utest.**

Contents at a glance:

* `.gitignore` - helps Git ignore junk like generated files, build products, and temporary files.
* `build.sc` - instructs mill to build the Chisel project
* `Makefile` - rules to call mill
* `playground/src/GCD.scala` - GCD source file
* `playground/src/DecoupledGCD.scala` - another GCD source file
* `playground/src/resources/BlackBoxRealAdd2.v` - Verilog file, you can add it to chisel Module using BlackBox.
* `playground/src/BlackBoxRealAdd2.scala` - wrapper Verilog files using BlackBox, you should instantiate it to other modules  so that the black box can be converted to Verilog. 
* `playground/src/Elaborate.scala` - wrapper file to call chisel command with the Top module
* `playground/src/Top.scala` - top module, you can edit IO to fit external pins such as FPGA.
* `playground/test/src/GCDSpec.scala` - GCD tester. **Current project doesn't support utest framework.**

Feel free to rename or delete files under `playground/` or use them as a reference/template. **Don't rename the `playground` directory.**

## Getting Started

First, install mill by referring to the documentation [here](https://com-lihaoyi.github.io/mill).

Second,you should run `make idea` to initialize IntelliJ IDEA project, then you can open it using IDEA.(**It has been tested on Ubuntu20.04.**)
> You can install `Scala` and `EasySoc Chisel` Plugins on IDEA.
**NOTE**: If you update `build.sc`, you should run `make idea` again to update `.idea` file.

___

To run all tests in this design (recommended for test-driven development):
```bash
make test
```

To generate Verilog(you should edit `Top.scala` to generate different module):
```bash
make verilog
```

To test a single file(you should assign the chisel test filename to name argument):

```bash
make test-only name=???
```