Skip to content

Commit

Permalink
feat: update project tt_um_couchand_cora16 from couchand/tt06-cora16
Browse files Browse the repository at this point in the history 
Commit: f3b79c50fff115c8dd11945afc08489f3463dab1
Workflow: https://github.com/couchand/tt06-cora16/actions/runs/8756517453
  • Loading branch information
@TinyTapeoutBot @urish
TinyTapeoutBot authored and urish committed Apr 19, 2024
1 parent 6a6531a commit fe61d72
Show file tree
Hide file tree
Showing 10 changed files with 153,949 additions and 0 deletions.
201 changes: 201 additions & 0 deletions projects/tt_um_couchand_cora16/LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
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.
9 changes: 9 additions & 0 deletions projects/tt_um_couchand_cora16/commit_id.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"app": "Tiny Tapeout tt06 7f56a586",
"repo": "https://github.com/couchand/tt06-cora16",
"commit": "f3b79c50fff115c8dd11945afc08489f3463dab1",
"workflow_url": "https://github.com/couchand/tt06-cora16/actions/runs/8756517453",
"sort_id": 1713544112105,
"openlane_version": "OpenLane f691c8c0712ca6c6645e3fd548985b3cbcf08c78",
"pdk_version": "open_pdks e0f692f46654d6c7c99fc70a0c94a080dab53571"
}
127 changes: 127 additions & 0 deletions projects/tt_um_couchand_cora16/docs/info.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<!---
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.
-->

Couch's One-Register Accumulator machine, 16-bit width.

## How it works

One register should be enough for anybody. Well, there's also the program counter, status flags, stack pointer, data pointer, but who's counting?

External SPI memory is used for a simple instruction fetch/execute cycle. High-bandwidth I/O is provided through a full byte-width input and output bus. The machine allows single-stepping through execution to aid debugging.

Pin | Function
----+---------
`step` | Set high for a clock cycle to step, hold high to run.
`busy` | When high, the machine is currently working on an instruction.
`halt` | When high, the machine has halted execution.
`trap` | When `halt` is low and `trap` is high, the machine has trapped. Step once to attempt recovery (success depends significantly on context).
| Note: when both `halt` and `trap` are high, the machine has experienced an irrecoverable fault, please reset.
`in[7:0]` | General-purpose byte input. Use as data source `IN` for any one-argument instruction.
`out[7:0]` | General-purpose byte output. Set with the `OUT` instruction.

## How to test

1. Load the program to run into the external SPI RAM.
2. Reset the CPU.
3. Raise `step` high for a clock for each instruction to step.
4. Hold `step` high to run free (you are advised to handle `trap`).
5. Observe `busy`, `halt` and `trap` for the module status.

## External hardware

The module expects an SPI RAM attached to the relevant SPI pins. The onboard Raspberry Pi emulation should work just fine.

## Instruction set

Status byte | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0
------------+---+---+---+---+---+---+---+--
| x | x | **E**lse | x | x | x | **N**eg | **Z**ero

Impact on the status flags is documented as:

* `-`: No effect
* `0`: The flag is cleared to zero
* `1`: The flag is set to one
* `#`: The flag is affected by the operation

### One-byte instructions

Name | Bit Pattern | Description | Status
-----+-------------+-------------+-------
Nop | `0000 0000` | No operation | `---- ----`
Halt | `0000 0001` | Halt machine | `---- ----`
Trap | `0000 0010` | Trap execution | `---- ----`
Drop | `0000 0011` | Drop a word from the stack | `---- ----`
Push | `0000 0100` | Push a word to the stack | `---- ----`
Pop | `0000 0101` | Pop a word from the stack to the accumulator | `---- ----`
Return | `0000 0110` | Return to the address on top of the stack | `---- ----`
Not | `0000 0111` | One's complement of the accumulator | `---- --##`
Out Lo | `0000 1000` | Output the low byte of the accumulator | `---- ----`
Out Hi | `0000 1001` | Output the high byte of the accumulator | `---- ----`
Set DP | `0000 1010` | Set the data pointer value to the accumulator value | `---- ----`
Test | `0000 1011` | Set the status flags based on the accumulator value | `---- --##`
Branch Indirect | `0000 1100` | Add the accumulator to the program counter | `---- ----`
Call Indirect | `0000 1101` | Call the subroutine address in the accumulator | `---- ----`
Load Indirect | `0100 01mm` | Load a word from the address in the accumulator, using addressing mode `m` (bug: modes not supported) | `---- ----`


### Two-byte instructions

Name | Bit Pattern | Description | Status
-----+-------------+-------------+-------
Load | `1000 0sss vvvv vvvv` | Load a value into the accumulator | `---- ----`
Store | `1001 0sss vvvv vvvv` | Store a value to memory | `---- ----`
Add | `1000 1sss vvvv vvvv` | Add a value to the accumulator | `---- --##`
Sub | `1001 1sss vvvv vvvv` | Subtract a value from the accumulator | `---- --##`
And | `1010 0sss vvvv vvvv` | Bitwise and a value with the accumulator | `---- --##`
Or | `1010 1sss vvvv vvvv` | Bitwise or a value with the accumulator | `---- --##`
Xor | `1011 0sss vvvv vvvv` | Bitwise exclusive or a value with the accumulator | `---- --##`
Shift | `1011 1sss vvvv vvvv` | Shift the accumulator (see note below on direction) | `---- --##`
Branch | `1100 0pp pppp pppp` | Add the offset `p` to the program counter | `---- ----`
Call | `1101 0pp pppp pppp` | Call the subroutine at address `p` | `---- ----`
If | `1111 000 0000 cccc` | Skip the following instruction if the condition doesn't hold | `---- ----`

Many of these instructions specify a source type `s` and value `v`. These are the options:

Source Type | Bit Pattern | Interpretation
------------+-------------+---------------
Const Lo | `000` | Take the value `v` as the low byte of a constant
Const Hi | `001` | Take the value `v` as the high byte of a constant
Input Lo | `010` | Input the low byte, ignore the value `v`
Input Hi | `011` | Input the high byte, ignore the value `v`
Data Direct | `100` | Read a value from the address `v` (relative to the data pointer)
Data Indirect | `101` | Read a pointer from the address `v` (relative to the data pointer), and load a value from that address
Stack Direct | `110` | Read a value from the address `v` (relative to the stack pointer)
Stack Indirect | `111` | Read a pointer from the address `v` (relative to the stack pointer), and load a value from that address

Note: the `SHIFT` instruction stashes the shift direction within this source field.

Source Type | Shift Bit | Source Limitation
------------+-----------+------------------
Constant | Lo/Hi | Only 8-bit constants supported
Input | Lo/Hi | Only 8-bit inputs supported
Memory | Addr[0] | Only aligned addresses supported (TODO: maybe require that everywhere??)

The following table lists the condition codes for the `IF` instruction.

Condition | Bit Pattern | Description
----------+-------------+------------
Zero | `0000` | Skip the next instruction if the `Z` bit is cleared
Not Zero | `0001` | Skip the next instruction if the `Z` bit is set
Else | `0010` | Skip the next instruction if the `E` bit is cleared
Not Else | `0011` | Skip the next instruction if the `E` bit is set
Neg | `0100` | Skip the next instruction if the `N` bit is cleared
Not Neg | `0101` | Skip the next instruction if the `N` bit is set

### Three-byte instructions

Name | Bit Pattern | Description | Status
-----+-------------+-------------+-------
Call Word | `0000 1110 wwww wwww wwww wwww` | Call the subroutine at address `w` | `---- ----`
Load Immediate Word | `0000 1111 wwww wwww wwww wwww` | Set the accumulator to `w` | `---- ----`
Loading

0 comments on commit fe61d72

Please sign in to comment.