Christmas tree controller (ASIC)

This design implements a Christmas tree controller that include four dedicated modules :

• Infrared receiver (protocol NEC)
• StepMotor controller (full-step, half-step, with strenght control)
• Led string controller (compatibles WS2812B)
• Pseudo-random generator (32bits)

The purpose of this System On Chip (SoC) is to control a Christmas tree. This controller allows, thanks to an infrared remote control, to control an garland of RGB LEDs as well as its rotating star at its top.

Architecture

This design is based on Caravel user project template.

Below is a representation of the architecture:

Memory mapping

The Wishbone bus address mapping below :

ADDRESS	DESCRIPTION
0x30000000	NEC IR receiver
0x30010000	PseudoRandom generator
0x30020000	Step motor controller
0x30030000	String Led controller

ASIC layout

Below is a representation of the ASIC layout:

USAGE

Install dependencies

sudo apt-get update
sudo apt-get install m4 --assume-yes
sudo apt-get install tcsh --assume-yes
sudo apt-get install csh --assume-yes
sudo apt-get install libx11-dev --assume-yes
sudo apt-get install tcl-dev tk-dev --assume-yes
sudo apt-get install libcairo2-dev --assume-yes
sudo apt-get install mesa-common-dev libglu1-mesa-dev --assume-yes
sudo apt-get install libncurses-dev --assume-yes
sudo apt-get install git --assume-yes

# install magic
git clone https://github.com/RTimothyEdwards/magic.git
cd magic
./configure 
sudo make
sudo make install
 
# install YOSYS
sudo apt-get install build-essential clang bison flex \
	libreadline-dev gawk tcl-dev libffi-dev git \
	graphviz xdot pkg-config python3 python3-pip python3.8-venv libboost-system-dev \
	libboost-python-dev libboost-filesystem-dev zlib1g-dev --assume-yes
git clone https://github.com/YosysHQ/yosys.git
cd yosys
sudo make
sudo make install

# install DOCKER
sudo apt-get remove docker docker-engine docker.io containerd runc --assume-yes
sudo apt-get update --assume-yes
sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg \
    lsb-release --assume-yes
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg --yes
echo \
  "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \
  $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update --assume-yes
sudo apt-get install docker-ce docker-ce-cli containerd.io --assume-yes

sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker

Set environnement variables (must be achieved before : Install the project, Compile the project, Run RTL/GL simulations, ZIP/UNZIP ASIC database files, clean)

HOMEDIR=/home/<your-name>
BASEDIR=<target-folder-path>
project_name=EfablessGFMPW0
design_name=ChristmasTreeController

project_folder=$BASEDIR/$project_name
design_folder=$project_folder/$design_name

export OPENLANE_ROOT=$project_folder/dependencies/openlane_src
export PDK_ROOT=$project_folder/dependencies/pdks
export CARAVEL_ROOT=$design_folder/caravel
export PRECHECK_ROOT=$project_folder/precheck

export PDK=sky130A

export PATH="$HOMEDIR.local/bin:$PATH"

sudo service docker start

Install the project

rm -rf $project_folder
mkdir -p $project_folder
cd $project_folder

git clone https://github.com/JulienOury/ChristmasTreeController.git $design_name

cd $design_folder
make setup

Compile the project

cd $design_folder

make user_proj_example
make user_project_wrapper

Run RTL simulations

cd $design_folder

export SIM=RTL

make verify-all-rtl

Run GL simulation

cd $design_folder
make simenv
make simlink

export SIM=GL

make verify-all-gl

ZIP ASIC database files

cd $design_folder
make zip

UNZIP ASIC database files

cd $design_folder
make unzip

Clean

cd $design_folder
make clean
make clean-user_project_wrapper
make clean-user_proj_example
rm -rf openlane/user_proj_example/runs
rm -rf openlane/user_project_wrapper/runs
rm -f ./def/*
rm -f ./lef/*
rm -f ./gds/*
rm -f ./mag/*
rm -f ./maglef/*
rm -f ./spef/*
rm -f ./spi/lvs/*
rm -f ./sdf/*
rm -rf ./sdf

Refer to README for a quickstart of how to use caravel_user_project

Refer to README for this sample project documentation.