From 81cd6acd339876cf388b845d7e03d8b19128a497 Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 07:50:04 -0700 Subject: [PATCH 01/10] update README --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bc261049..611e69de 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,26 @@ ## Using Chipyard -To get started using Chipyard, see the documentation on the Chipyard documentation site: https://chipyard.readthedocs.io/en/latest/ +To get started using Chipyard, see the documentation on the Chipyard documentation site: https://chipyard.readthedocs.io/ ## What is Chipyard -Chipyard is an open source starter template for your custom Chisel project. +Chipyard is an open source framework for agile development of Chisel-based Systems-on-Chip. It will allow you to leverage the Chisel HDL, Rocket Chip SoC generator, and other [Berkeley][berkeley] projects to produce a [RISC-V][riscv] SoC with everything from MMIO-mapped peripherals to custom accelerators. -It contains processor cores ([Rocket][rocket-chip], [BOOM][boom]), accelerators ([Hwacha][hwacha]), FPGA simulation tools ([FireSim][firesim]), ASIC tools ([HAMMER][hammer]) and other tooling to help create a full featured SoC. +Chipyard contains processor cores ([Rocket][rocket-chip], [BOOM][boom]), accelerators ([Hwacha][hwacha]), memory systems, and additional peripherals and tooling to help create a full featured SoC. +Chipyard supports multiple conccurent flows of agile hardware development, including software RTL simulaiton, FPGA-accelerated simulation ([FireSim][firesim]), automated VLSI flows ([Hammer][hammer]), and software workload generation for bare-metal and Linux-based systems ([FireMarshal][firemarshal]). Chipyard is actively developed in the [Berkeley Architecture Research Group][ucb-bar] in the [Electrical Engineering and Computer Sciences Department][eecs] at the [University of California, Berkeley][berkeley]. ## Resources -* Chipyard Website: ...TBD at a later date... * Chipyard Documentation: https://chipyard.readthedocs.io/ +* Chipyard Basics slides: + +## Need help? + +* Join the Chipyard Mailing list: https://groups.google.com/forum/#!forum/chipyard +* Post an issue on this repo + [hwacha]:http://hwacha.org [hammer]:https://github.com/ucb-bar/hammer @@ -27,3 +34,4 @@ Chipyard is actively developed in the [Berkeley Architecture Research Group][ucb [riscv]: https://riscv.org/ [rocket-chip]: https://github.com/freechipsproject/rocket-chip [boom]: https://github.com/ucb-bar/riscv-boom +[firemarshal]: https://github.com/firesim/FireMarshal/ From 8d93f602d13d34f0fd66999d5211d401fa25c5f7 Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 08:17:20 -0700 Subject: [PATCH 02/10] more readme updates --- CONTRIBUTING.md | 8 ++++++++ README.md | 11 ++++++++--- 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..2616c8df --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ +Contributing to Chipyard +============================= + +### Branch management: + +1) github:com/ucb-bar/chipyard: master = stable release. All merges to master must go through PR. +2) github:com/ucb-bar/dev: dev = pre-release non-stable branch with latest features. All merges to dev must go through PR. +3) Other dependancies pointed at by Chipyard (e.g. firesim, boom): master should be the version submoduled in ucb-bar/chipyard master. diff --git a/README.md b/README.md index 611e69de..168900c5 100644 --- a/README.md +++ b/README.md @@ -11,19 +11,24 @@ To get started using Chipyard, see the documentation on the Chipyard documentati Chipyard is an open source framework for agile development of Chisel-based Systems-on-Chip. It will allow you to leverage the Chisel HDL, Rocket Chip SoC generator, and other [Berkeley][berkeley] projects to produce a [RISC-V][riscv] SoC with everything from MMIO-mapped peripherals to custom accelerators. Chipyard contains processor cores ([Rocket][rocket-chip], [BOOM][boom]), accelerators ([Hwacha][hwacha]), memory systems, and additional peripherals and tooling to help create a full featured SoC. -Chipyard supports multiple conccurent flows of agile hardware development, including software RTL simulaiton, FPGA-accelerated simulation ([FireSim][firesim]), automated VLSI flows ([Hammer][hammer]), and software workload generation for bare-metal and Linux-based systems ([FireMarshal][firemarshal]). +Chipyard supports multiple concurrent flows of agile hardware development, including software RTL simulation, FPGA-accelerated simulation ([FireSim][firesim]), automated VLSI flows ([Hammer][hammer]), and software workload generation for bare-metal and Linux-based systems ([FireMarshal][firemarshal]). Chipyard is actively developed in the [Berkeley Architecture Research Group][ucb-bar] in the [Electrical Engineering and Computer Sciences Department][eecs] at the [University of California, Berkeley][berkeley]. ## Resources * Chipyard Documentation: https://chipyard.readthedocs.io/ -* Chipyard Basics slides: +* Chipyard Basics slides: https://fires.im/micro19-slides-pdf/02_chipyard_basics.pdf +* Chipyard Tutorial Exercise slides: https://fires.im/micro19-slides-pdf/03_building_custom_socs.pdf ## Need help? -* Join the Chipyard Mailing list: https://groups.google.com/forum/#!forum/chipyard +* Join the Chipyard Mailing List: https://groups.google.com/forum/#!forum/chipyard * Post an issue on this repo +## Contributing + +* See [CONTRIBUTING.md](/CONTRIBUTING.md) + [hwacha]:http://hwacha.org [hammer]:https://github.com/ucb-bar/hammer From afbba2fa10deb7be5d4457388e4f3820d444faa8 Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 08:22:38 -0700 Subject: [PATCH 03/10] add CHANGELOG --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..f00f76e7 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +[1.0.0] - 2019-10-11 +Added +This repository used to be "project-template", a template for Chisel-based project. Through tighter integration of multiple projects from the Berkeley Architecture Research group at UC Berkeley, this repository is re-released as Chipyard - a framework for agile hardware development of RISC-V based systems-on-chip. From aadefff84af63e372f0335de5efd862005953ad1 Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 08:24:55 -0700 Subject: [PATCH 04/10] Update README.md Co-Authored-By: David Biancolin --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 168900c5..bea9f9ce 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ To get started using Chipyard, see the documentation on the Chipyard documentati ## What is Chipyard -Chipyard is an open source framework for agile development of Chisel-based Systems-on-Chip. +Chipyard is an open source framework for agile development of Chisel-based systems-on-chip. It will allow you to leverage the Chisel HDL, Rocket Chip SoC generator, and other [Berkeley][berkeley] projects to produce a [RISC-V][riscv] SoC with everything from MMIO-mapped peripherals to custom accelerators. Chipyard contains processor cores ([Rocket][rocket-chip], [BOOM][boom]), accelerators ([Hwacha][hwacha]), memory systems, and additional peripherals and tooling to help create a full featured SoC. Chipyard supports multiple concurrent flows of agile hardware development, including software RTL simulation, FPGA-accelerated simulation ([FireSim][firesim]), automated VLSI flows ([Hammer][hammer]), and software workload generation for bare-metal and Linux-based systems ([FireMarshal][firemarshal]). From 33726fad5e8f2452df7b85efbed59965cfa6ac87 Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 08:26:45 -0700 Subject: [PATCH 05/10] typo --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f00f76e7..935c72f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ [1.0.0] - 2019-10-11 Added -This repository used to be "project-template", a template for Chisel-based project. Through tighter integration of multiple projects from the Berkeley Architecture Research group at UC Berkeley, this repository is re-released as Chipyard - a framework for agile hardware development of RISC-V based systems-on-chip. +This repository used to be "project-template", a template for Chisel-based projects. Through tighter integration of multiple projects from the Berkeley Architecture Research group at UC Berkeley, this repository is re-released as Chipyard - a framework for agile hardware development of RISC-V based Systems-on-Chip. From 10e062771bf29c4d5988739662ed479ee1ea2d9d Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 09:17:34 -0700 Subject: [PATCH 06/10] specify opening an issue --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bea9f9ce..79a6b533 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Chipyard is actively developed in the [Berkeley Architecture Research Group][ucb ## Need help? * Join the Chipyard Mailing List: https://groups.google.com/forum/#!forum/chipyard -* Post an issue on this repo +* If you find a bug, post an issue on this repo ## Contributing From 7e96d4c6e2c6d732ae81778b8acdea3b2e1b7746 Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 09:26:52 -0700 Subject: [PATCH 07/10] Update CONTRIBUTING.md Co-Authored-By: David Biancolin --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2616c8df..646554f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,4 +5,4 @@ Contributing to Chipyard 1) github:com/ucb-bar/chipyard: master = stable release. All merges to master must go through PR. 2) github:com/ucb-bar/dev: dev = pre-release non-stable branch with latest features. All merges to dev must go through PR. -3) Other dependancies pointed at by Chipyard (e.g. firesim, boom): master should be the version submoduled in ucb-bar/chipyard master. +3) Other dependencies pointed at by Chipyard (e.g. firesim, boom): master should be the version submoduled in ucb-bar/chipyard master. From 249bce9251d3933da1b22a431ff2d9c7580951ce Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 09:31:11 -0700 Subject: [PATCH 08/10] Update CONTRIBUTING.md Co-Authored-By: David Biancolin --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 646554f5..1f523835 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,5 +4,5 @@ Contributing to Chipyard ### Branch management: 1) github:com/ucb-bar/chipyard: master = stable release. All merges to master must go through PR. -2) github:com/ucb-bar/dev: dev = pre-release non-stable branch with latest features. All merges to dev must go through PR. +2) github:com/ucb-bar/chipyard: dev = pre-release non-stable branch with latest features. All merges to dev must go through PR. 3) Other dependencies pointed at by Chipyard (e.g. firesim, boom): master should be the version submoduled in ucb-bar/chipyard master. From b44f4c3468f3a0c86cb0c7080cb12f67946bcfcd Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 09:53:43 -0700 Subject: [PATCH 09/10] LICENSE year --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 538a4c02..8fbb59ea 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2017, The Regents of the University of California (Regents). +Copyright (c) 2019, The Regents of the University of California (Regents). All Rights Reserved. Redistribution and use in source and binary forms, with or without From 140b90ff4d926c71bc389fe692029dff34df1b5c Mon Sep 17 00:00:00 2001 From: alonamid Date: Fri, 11 Oct 2019 09:56:41 -0700 Subject: [PATCH 10/10] LICENSE year --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 8fbb59ea..c6092e14 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2019, The Regents of the University of California (Regents). +Copyright (c) 2017-2019, The Regents of the University of California (Regents). All Rights Reserved. Redistribution and use in source and binary forms, with or without