Skip to content

Commit

Permalink
docs(interface docs): Added ID Interface outline (#84)
Browse files Browse the repository at this point in the history
* Update interface_doc_template.md

* Create 00_ID_Interface

* Rename 00_ID_Interface to 00_ID_Interface.md

* docs(00_ID_Interface.md): Completed Outline for ID interface

* Update 00_ID_Interface.md

* Update interface_doc_template.md
  • Loading branch information
ShinyMiraidon authored Oct 10, 2023
1 parent 8f924fa commit f7e221d
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
36 changes: 36 additions & 0 deletions Documentation/Interface-Docs/00_ID_Interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# ID Interface #
(Connects Outputs of IF/ID Latch to Inputs of ID/EX Latch)

## Contents
* [Modules](#modules)
* [IF/ID Latch](#if/id_latch)
* [ID/EX Latch](#id/ex_latch)
* [Connections](#connections)

## Modules

### IF/ID Latch

#### Outputs
|Input|Bits wide|
|:---|:---:|
|```imm```|32-bit|
|```pc```|32-bit|
|```rdn```|5-bit|

### ID/EX Latch

#### Inputs
|Input|Bits wide|
|:---|:---:|
|```imm```|32-bit|
|```pc_in```|32-bit|
|```rdn_in```|5-bit|

## Connections

|IF/ID|ID/EX|
|:---|:---:|
|```imm```|```imm```|
|```pc```|```pc_in```|
|```rdn```|```rdn_in```|
9 changes: 9 additions & 0 deletions Documentation/Interface-Docs/interface_doc_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ USE THIS TEMPLATE AS A GUIDE TO DOCUMENT OUTLINED INTERFACES

## Contents
* [Modules](#modules)
* [Module 1](#module1)
* [Module 2](#module2)

## Modules

Expand Down Expand Up @@ -36,4 +38,11 @@ USE THIS TEMPLATE AS A GUIDE TO DOCUMENT OUTLINED INTERFACES
|```name```|#-bit|
|```name```|#-bit|

## Connections

|Module 1|Module 2|
|:---|:---:|
|```name```|```name```|
|```name```|```name```|
|```name```|```name```|
|```name```|```name```|

0 comments on commit f7e221d

Please sign in to comment.