Skip to content
Snippets Groups Projects
Commit 613e4af2 authored by Daniel Newbrook's avatar Daniel Newbrook
Browse files

Update readme to with run instructions

parent 73e8ef70
No related branches found
No related tags found
No related merge requests found
# SRAM Chiplet # SRAM Chiplet
## Prerequisite
You will need the following IP from Arm, all available through Arm Academic Access (AAA)
- NIC400
- NIC450 (at least the thin links IP)
- BP301 (SIE300)
Software you will need:
- Socrates (with NIC400 and NIC450 licenses)
- CocoTB
- A simulator (e.g. QuestSim, VCS, icarus Verilog)
## Getting started ## Getting started
1. Setup socrates to include the Arm IP
If you have not already done so, open socrates and associate the IP mentioned above, you will need to do this so socrates can find the IP files
2. Edit make.cfg to include the BP301 path.
A default path is already there that uses the ARM_IP_LIBRARY_PATH environment variable but you should edit this if needed
3. Run first time setup
If this is a fresh clone of the repository you can run:
```make first_time_setup```
To make it easy for you to get started with GitLab, here's a list of recommended next steps. This will first create the socrates project needed to build the NIC400 and TLX IPs. And will also generate the RTL for the BP301 sram controller.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! If you have already run ```make first_time_setup``` or ```make make_project``` you can run
```make build_ip```
which will build all the necessary IP.
## Add your files 4. Setup environment variables
Run ```source set_sram_chiplet_env.sh``` which will set up the local environment variables for running the flows.
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files ## Simulation
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: Currently cocoTB is the only supported method of simulation.
``` To run the cocoTB verification, cd to verif/cocotb and run ```make```
cd existing_repo This will run the default tests for the SRAM chiplet system.
git remote add origin https://git.soton.ac.uk/soclabs/sram_chiplet.git
git branch -M main
git push -uf origin main
```
## Integrate with your tools ## Memory Map
| Region | Base Adress | Size | End Adress |
- [ ] [Set up project integrations](https://git.soton.ac.uk/soclabs/sram_chiplet/-/settings/integrations) | ------ | ------ | ------ | ------ |
| System (AXI) | 0x00000000 | 0x1F0000 | 0x001F0000 |
## Collaborate with your team | Chiplet Debug | 0x001F0000 | 0x10000 | 0x001FFFFF |
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support ## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. For support please go to [soclabs.org](https://soclabs.org/)
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing ## Contributing
State if you are open to contributions and what your requirements are for accepting them. Open to collaborations, if you're interested please head over to soclabs.org and register your interest on the millisoc reference design project
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment ## Authors and acknowledgment
Show your appreciation to those who have contributed to the project. Daniel Newbrook (d.newbrook@soton.ac.uk)
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
...@@ -17,5 +17,7 @@ build_tlx_sram_chiplet: ...@@ -17,5 +17,7 @@ build_tlx_sram_chiplet:
make_project: make_project:
socrates_cli --project sram_chiplet -data ../ --flow AddNewProject socrates_cli --project sram_chiplet -data ../ --flow AddNewProject
build_ip: build_sie300_sram_ctrl build_nic400_sram_chiplet build_nic400_tb build_tlx_sram_chiplet
first_time_setup: make_project build_sie300_sram_ctrl build_nic400_sram_chiplet build_nic400_tb build_tlx_sram_chiplet first_time_setup: make_project build_sie300_sram_ctrl build_nic400_sram_chiplet build_nic400_tb build_tlx_sram_chiplet
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment