brainfuck_processor/TinyTapeout/info.yaml

78 lines
3.5 KiB
YAML

---
# TinyTapeout project information
project:
wokwi_id: 0 # If using wokwi, set this to your project's ID
# If using an HDL, set wokwi_id as 0 and uncomment and list your source files here.
# Source files must be in ./src and you must list each source file separately
source_files:
- bfpu.v
# - decoder.v
top_module: "tt_um_yannickreiss_bfpu" # Put the name of your top module here, must start with "tt_um_". Make it unique by including your github username
# How many tiles your design occupies? A single tile is about 167x108 uM.
tiles: "1x1" # Valid values: 1x1, 1x2, 2x2, 4x2 or 8x2
# Keep a track of the submission yaml
yaml_version: 4
# As everyone will have access to all designs, try to make it easy for someone new to your design to know what
# it does and how to operate it. This info will be automatically collected and used to make a datasheet for the chip.
#
# Here is a great example: https://github.com/davidsiaw/tt02-davidsiaw-stackcalc/blob/38c5647f83aad2aec675d566aa3d67b98f0aac81/info.yaml
documentation:
author: "Yannick Reiß" # Your name
title: "Brainfuck processing unit" # Project title
language: "Verilog" # other examples include Verilog, Amaranth, VHDL, etc
description: "MPU to process brainfuck instructions." # Short description of what your project does
# Longer description of how the project works. You can use standard markdown format.
how_it_works: |
Please refer to the README.md for additional information and where to find it.
# Instructions on how someone could test your project, include things like what buttons do what and how to set the clock if needed
how_to_test: |
The processing unit takes and prints a byte using the unidirectional pins when triggered by an instruction.
The instruction memory is controlled with a serial bus on the bidirectional pins.
Please refer to the README.md for further information.
# A description of what the inputs do (e.g. red button, SPI CLK, SPI MOSI, etc).
inputs:
- read lsb
- read
- read
- read
- read
- read
- read
- read msb
# A description of what the outputs do (e.g. status LED, SPI MISO, etc)
outputs:
- write lsb
- write
- write
- write
- write
- write
- write
- write msb
# A description of what the bidirectional I/O pins do (e.g. I2C SDA, I2C SCL, etc)
bidirectional:
- instruction bus lsb
- instruction bus
- instruction bus
- instruction bus
- instruction bus
- instruction bus
- instruction bus
- instruction bus msb
# The following fields are optional
tag: "microprocessor" # comma separated list of tags: test, encryption, experiment, clock, animation, utility, industrial, pwm, fpga, alu, microprocessor, risc, riscv, sensor, signal generator, fft, filter, music, bcd, sound, serial, timer, random number generator, calculator, decoder, counter, puzzle, multiplier, game, oscillator,
external_hw: "some pc to run the compiler, something to connect the input, output and bus for programming." # Describe any external hardware needed
discord: "schnick_" # Your discord handle, used for communication and automatically assigning tapeout role after a submission
doc_link: "https://gitlab.schnick.duckdns.org/schnick/bfpu" # URL to longer form documentation, eg the README.md in your repository
clock_hz: 0 # Clock frequency in Hz (if required)
picture: "" # relative path to a picture in your repository