Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions projects/tt_um_khatam_v/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
8 changes: 8 additions & 0 deletions projects/tt_um_khatam_v/commit_id.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"app": "Tiny Tapeout main 8f7b5060",
"repo": "https://github.com/hexa3/khatam-v",
"commit": "f060978e367fb38a2ecfa6ae504d8e27a727a8d6",
"workflow_url": "https://github.com/hexa3/khatam-v/actions/runs/43901125163",
"project_id": 9,
"sort_id": 1794847563195
}
53 changes: 53 additions & 0 deletions projects/tt_um_khatam_v/docs/info.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!---

This file is used to generate your project datasheet. Please fill in the information below and delete any unused
sections.

You can also include images in this folder and reference them in the markdown. Each image must be less than
512 kb in size, and the combined size of all images must be less than 1 MB.
-->

## How it works

Khatam-V is a small game console. There's a RISC-V CPU that runs C, a GPU that draws to VGA, and a sound chip, all in one design. The name comes from the khatam, the eight pointed star you see in islamic geometric patterns, and that's what the background of the screen is made of.

**CPU.** RV32E with the multiply instructions (Zmmul). It's multi-cycle and not pipelined at all, because the code runs straight out of SPI flash and a fetch takes ~70 clocks anyway, so a pipeline wouldn't buy anything. It's built to be small and to make timing on GF180 instead. No interrupts or traps, FENCE/ECALL/EBREAK/CSR do nothing.

**Memory.** Everything lives on the QSPI Pmod. Code and constants are in the flash, RAM is in the PSRAM. It talks plain 1-bit SPI at clk/2. To make fetch less slow, after a flash read CS stays low, and if the next read is the next address it just keeps clocking instead of sending the command and address again.

| Address | What |
|-------------|-------------------------------|
| `0x0000000` | flash, 16 MB, read only, program starts at 0 |
| `0x1000000` | PSRAM, 8 MB |
| `0x2000000` | I/O (gpu, audio, buttons) |

**Graphics.** 640x480 at 60 Hz, and there's no framebuffer, every pixel is worked out from (x, y) as the beam goes past. Back to front:

1. the background, one of 4 khatam star patterns. It can scroll, the stars can "breathe" (the radius goes in and out) and there's a shimmer on it
2. 4 shape sprites: square, diamond, star or octagon, up to 63 px
3. 2 bitmap sprites: 8x8, 1 bit, scaled 1x/2x/4x/8x

It also does collision detection in hardware, so a game can just read a register to see if a sprite hit a line of the pattern or another sprite.

**Sound.** 2 square wave voices and 1 noise voice, each with 4 bit volume, mixed into a PWM output on uio[7] (same pin as the TT audio Pmod). Note frequency is 25 MHz / 128 / period.

The full register list is at the top of `src/gpu.v`, `src/audio.v` and `src/project.v`, and `sdk/khatam.h` has C names for all of it.

## How to test

You need the flash on the QSPI Pmod to have a game in it. There's one in the repo, Starfall: catch the falling stars and dodge the red octagons.

1. Build it: `make` (needs clang + lld). That gives `build/starfall.bin`.
2. Write `build/starfall.bin` to the flash at address 0. While rst_n is low all the uio pins are inputs, so the RP2040 on the demo board can program the flash without the chip getting in the way.
3. Plug in the VGA Pmod and the QSPI Pmod (and the audio Pmod if you want sound), set the clock to 25 MHz (25.175 is also fine) and let go of reset.

You should see the star pattern. Press start (ui[2]) to play, ui[0] and ui[1] move left and right. Every 10 stars you go up a level, which changes the pattern and the colours and makes the stars faster. You get 3 lives.

To write your own game, copy `games/starfall.c` and `make GAME=mygame`.

## External hardware

- [TinyVGA Pmod](https://github.com/mole99/tiny-vga) on the outputs
- [QSPI Pmod](https://github.com/mole99/qspi-pmod) on the bidirectional pins (W25Q128 flash on CS0, APS6404 PSRAM on CS1)
- audio Pmod, or just a speaker/amp with a filter, on uio[7]
- buttons on ui[0]..ui[7], active high. Starfall only uses the first 3
56 changes: 56 additions & 0 deletions projects/tt_um_khatam_v/info.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Tiny Tapeout project information
project:
title: "Khatam-V"
author: "Sheheryar"
discord: ""
description: "RISC-V game console: RV32E CPU running C from QSPI flash, VGA graphics with islamic star patterns, sprites and sound"
language: "Verilog"
clock_hz: 25000000

# How many tiles your design occupies? A single tile is about 340x160 uM.
tiles: "4x2"

top_module: "tt_um_khatam_v"

source_files:
- "project.v"
- "cpu.v"
- "adder.v"
- "qspi.v"
- "gpu.v"
- "audio.v"

# The pinout of your project. Leave unused pins blank. DO NOT delete or add any pins.
pinout:
# Inputs
ui[0]: "button 0 (left in starfall)"
ui[1]: "button 1 (right)"
ui[2]: "button 2 (start)"
ui[3]: "button 3"
ui[4]: "button 4"
ui[5]: "button 5"
ui[6]: "button 6"
ui[7]: "button 7"

# Outputs
uo[0]: "R1"
uo[1]: "G1"
uo[2]: "B1"
uo[3]: "VSync"
uo[4]: "R0"
uo[5]: "G0"
uo[6]: "B0"
uo[7]: "HSync"

# Bidirectional pins
uio[0]: "flash CS"
uio[1]: "SPI MOSI"
uio[2]: "SPI MISO"
uio[3]: "SPI SCK"
uio[4]: "IO2 (held high)"
uio[5]: "IO3 (held high)"
uio[6]: "PSRAM CS"
uio[7]: "audio out (PWM)"

# Do not change!
yaml_version: 6
7 changes: 7 additions & 0 deletions projects/tt_um_khatam_v/pdk.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"FLOW_NAME": "LibreLane",
"FLOW_VERSION": "3.0.14",
"PDK": "gf180mcuD",
"PDK_SOURCE": "open_pdks",
"PDK_VERSION": "54435919abffb937387ec956209f9cf5fd2dfbee"
}
Loading
Loading