The magmathon from phanrahan

chisel_tutorial

I moved the chisel_tutorial examples from magma/examples to tutorial/chisel_tutorial/src. We should update these examples.

Working directory vs magmathon directory

We see this in cs107e as well, once users start editing notebooks/files in the magmathon repo, they can't easily pull changes/updates. Perhaps create a template working directory repo (starter project) and have magmathon as a supporting repo

Provide install script for icestorm tool chain?

We made one for the last hackathon: https://github.com/phanrahan/magma/blob/master/notebooks/icestick/install.py

The benefit is a one click solution for most people, the downside is that if it breaks, it can be more challenging to resolve the issue (compared to when a person is manually stepping through the install process for their specific system).

If we do plan to use this, we should test it both on macos and linux. We could also try it on a linux VM and see if we can get that working (for windows users)

Installation

We have two versions of the Install instructions. One is a jupyter notebook and the other is the top level README.md. I suggest we consolidate and just one version.

I vote for the README.md since this can all be done nicely with command line tools.

Note also that the tests directory contains only a single example blink.py

day1/day2 sub folders

These should be removed/renamed since we're only having a one-day session

Prep for Facebook Magmathon

Broken on linked version of Magma

This tutorial appears to be broken on the version of Magma that's linked to this repo:
https://github.com/phanrahan/magmathon/blob/master/notebooks/tutorial/FullAdder.ipynb

In general, is there any automatic testing of the tutorials here?

@leonardt @rsetaluri

Add links to existing projects to project/readme.md

Also include a note for future iterations that attendees should submit a PR with a link to a github repo containing their project

Installation issues with brew linking errors

I tried to run the install_icestorm.py script before I had read/write permission to /usr/local. The script tries to brew install, but fails at brew linking. After chmoding my /usr/local. rerunning the script does not work. I had to manually do:

brew link libftdi0
brew link libusb
brew link libusb-compat
brew install tcl-tk

to get the icestorm tools installed

Update year on repo description

Can't seem to do this as a collaborator, see below

Magmathon Plan

Part 0

o magmathon/README.md has installation instructions

Part 1

Getting Started - blink.py
Full Adder - combinational logic
Add - combinational logic
Register - sequential logic
Counter - synchronous
TFF
RIpple
Higher-order operators - braid
Register
- col
- join
ROM
- fork
SISO
- fold
SIPO
- scan
  o Metaprogramming
- popcount8
- popcount

o siggen exercise

square
triangle
pwm
sawtooth
delta-sigma
sine
dds

Part 2

inspect - print repr
debugger
simulate
verilator
coreir
firrtl
verilog (from verilog)
lut

Question about IceStick programmer

Hello,

Is it possible to use Lattice Standalone Programmer (for Windows) for uploading bin files to IceStick, instead of setup passthrough USB to VM to use IceStorm tool? If that is possible I can avoid setting up my VM with USB passthrough which seems not easy. The tool looks free to download at www.latticesemi.com.

Thank you.

/magmathon/notebooks/signal-generator/exercises/build is missing

Small docs update

Docs for Counter circuit definition seem to be out of date. They describe the parameter has_r, but parameter name in actual definition is "has_reset" (https://github.com/phanrahan/mantle/blob/master/mantle/common/counter.py)

Dry run of installation on MacOS/Linux

We should do a dry run of the installation process on both MacOS and Linux to verify everything is in order. In particular, we should test the install_icestorm.py script.

Update magmathon

Adder Simulator

I am trying to simulate an Add circuit with the following code:

from magma import *
set_mantle_target("ice40")
from mantle import*
from magma.simulator import PythonSimulator

Add = DefineAdd(8)
print(Add)
add_sim = PythonSimulator(Add)

high = uint(0x01,8)
low = uint(0x03,8)

add_sim.set_value(Add.I0, high)
add_sim.set_value(Add.I1, low)
print(add_sim.get_value(Add.O))

I expect to get 0x04 as output in bits form, but instead I get [False, False, False, False, False, False, False, False] (it seems python interprets the 1s as False). Am I doing something wrong here?

Add FSM example as notebook

Here's an example using the new @m.circuit.combinational syntax to implement an FSM similar to the Verilog case statement style. We should add a notebook for this that discusses this in more detail.

https://github.com/phanrahan/mantle/tree/master/examples/example/fsm

build vagrant and docker using CI

We ran into issues with the vagrant VM having out of date submodules. Ideally every time we check something into this repository (e.g. updating submodule commits) we should rebuild the docker and vagrant images and release them.

Simulate notebook improvements

Currently it only shows stepping and printing values, should also show how to set inputs/outputs
It should also clearly explain functions like evaluate, advance and advance_cycle, also cover the basics of the simulator semantics

MANTLE env var

Currently mantle defaults to the coreir backend since that has the most recent consistent usage. We should either update the default or make sure the users have this properly configured for the hackathon.