Skip to content

Commit defd6c0

Browse files
TinyTapeoutBoturish
authored andcommitted
feat: update project tt_um_urish_simon from urish/tt10-simon-game
Commit: 1e0f26fa224d369c76c6349d9298514cad6d727a Workflow: https://github.com/urish/tt10-simon-game/actions/runs/12453725870
1 parent 6efd7a3 commit defd6c0

10 files changed

+16792
-0
lines changed

projects/tt_um_urish_simon/LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"app": "Tiny Tapeout tt10 d89635e1",
3+
"repo": "https://github.com/urish/tt10-simon-game",
4+
"commit": "1e0f26fa224d369c76c6349d9298514cad6d727a",
5+
"workflow_url": "https://github.com/urish/tt10-simon-game/actions/runs/12453725870",
6+
"sort_id": 1734941984438,
7+
"openlane_version": "OpenLane2 2.2.9",
8+
"pdk_version": "open_pdks 0fe599b2afb6708d281543108caf8310912f54af"
9+
}
+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
![Simon Says Game](tt-simon-game.jpg)
2+
3+
## How it works
4+
5+
Simon says is a simple electronic memory game: the user has to repeat a growing sequence of colors.
6+
The sequence is displayed by lighting up the LEDs. Each color also has a corresponding tone.
7+
8+
In each turn, the game will play the sequence, and then wait for the user to repeat the sequence
9+
by pressing the buttons according to the color sequence.
10+
If the user repeated the sequence correctly, the game will play a "leveling-up" sound,
11+
add a new color at the end of the sequence, and move to the next turn.
12+
13+
The game continues until the user has made a mistake. Then a game over sound is played, and the game restarts.
14+
15+
Check out the online simulation at https://wokwi.com/projects/408757730664700929 (including wiring diagram).
16+
17+
## Clock settings
18+
19+
The `clk_sel` input selects the clock source:
20+
- `0`: external 50 KHz clock, provided through the `clk` input.
21+
- `1`: internal clock, generated by the `ring_osc` module, with a frequency of ~62.5 KHz.
22+
23+
The internal clock is generated by a 13-stage ring oscillator, divided by 8192 to get the desired frequency. The divider value was determined by measuring the output frequency of [tt_um_urish_ringosc_cnt](https://tinytapeout.com/runs/tt05/tt_um_urish_ringosc_cnt) from Tiny Tapeout 5.
24+
25+
When using the internal clock, its signal is also output on the `uo_out[7]` pin for debugging purposes.
26+
27+
## How to test
28+
29+
Use a [Simon Says Pmod](https://github.com/urish/tt-simon-pmod) to test the game.
30+
31+
Provide a 50 KHz clock input, reset the game, and enjoy!
32+
33+
If you don't have the Pmod, you can still connect the hardware manually as follows:
34+
35+
1. Connect the four push buttons to pins `btn1`, `btn2`, `btn3`, and `btn4`.
36+
Also connect each button to a pull down resistor.
37+
2. Connect the LEDs to pins `led1`, `led2`, `led3`, and `led4`, matching
38+
the colors of the buttons (so `led1` and `btn1` have the same color, etc.).
39+
Don't forget current-limiting resistors!
40+
3. Connect the speaker to the `speaker` pin (optional).
41+
4. Connect the seven segment display as follows: `seg_a` through `sev_g` to
42+
individual segments, `dig1` to the common pin of the tens digit, `dig2`
43+
to the common pin of the ones digit.
44+
Set `seginv` according to the type of 7 segment display you have: high
45+
for common anode, low for common cathode.
46+
5. Reset the game, and then press any button to start it. Enjoy!
47+
48+
## External Hardware
49+
50+
[Simon Says Pmod](https://github.com/urish/tt-simon-pmod) or four push buttons (with pull-down resistors), four LEDs, and optionally a speaker/buzzer and two digit 7-segment display.
Loading

projects/tt_um_urish_simon/info.yaml

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Tiny Tapeout project information
2+
project:
3+
title: "Simon Says memory game" # Project title
4+
author: "Uri Shaked" # Your name
5+
discord: "urish" # Your discord username, for communication and automatically assigning you a Tapeout role (optional)
6+
description: "Repeat the sequence of colors and sounds to win the game" # One line description of what your project does
7+
language: "Verilog" # other examples include SystemVerilog, Amaranth, VHDL, etc
8+
clock_hz: 50000 # Clock frequency in Hz (or 0 if not applicable)
9+
10+
# How many tiles your design occupies? A single tile is about 167x108 uM.
11+
tiles: "1x1" # Valid values: 1x1, 1x2, 2x2, 3x2, 4x2, 6x2 or 8x2
12+
13+
# Your top module name must start with "tt_um_". Make it unique by including your github username:
14+
top_module: "tt_um_urish_simon"
15+
16+
# List your project's source files here. Source files must be in ./src and you must list each source file separately, one per line:
17+
source_files:
18+
- "galois_lfsr.v"
19+
- "inverter.v"
20+
- "project.v"
21+
- "ring_osc.v"
22+
- "score.v"
23+
- "simon.v"
24+
- "sound_gen.v"
25+
26+
# The pinout of your project. Leave unused pins blank. DO NOT delete or add any pins.
27+
pinout:
28+
# Inputs
29+
ui[0]: "btn1"
30+
ui[1]: "btn2"
31+
ui[2]: "btn3"
32+
ui[3]: "btn4"
33+
ui[4]: "seginv"
34+
ui[5]: ""
35+
ui[6]: ""
36+
ui[7]: "clk_sel"
37+
38+
# Outputs
39+
uo[0]: "led1"
40+
uo[1]: "led2"
41+
uo[2]: "led3"
42+
uo[3]: "led4"
43+
uo[4]: "speaker"
44+
uo[5]: "dig1"
45+
uo[6]: "dig2"
46+
uo[7]: "clk_internal"
47+
48+
# Bidirectional pins
49+
uio[0]: "seg_a"
50+
uio[1]: "seg_b"
51+
uio[2]: "seg_c"
52+
uio[3]: "seg_d"
53+
uio[4]: "seg_e"
54+
uio[5]: "seg_f"
55+
uio[6]: "seg_g"
56+
uio[7]: ""
57+
58+
# Do not change!
59+
yaml_version: 6

0 commit comments

Comments
 (0)