├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright (c) 2020-2021 Antmicro 2 | 3 | Apache License 4 | Version 2.0, January 2004 5 | http://www.apache.org/licenses/ 6 | 7 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 8 | 9 | 1. Definitions. 10 | 11 | "License" shall mean the terms and conditions for use, reproduction, 12 | and distribution as defined by Sections 1 through 9 of this document. 13 | 14 | "Licensor" shall mean the copyright owner or entity authorized by 15 | the copyright owner that is granting the License. 16 | 17 | "Legal Entity" shall mean the union of the acting entity and all 18 | other entities that control, are controlled by, or are under common 19 | control with that entity. For the purposes of this definition, 20 | "control" means (i) the power, direct or indirect, to cause the 21 | direction or management of such entity, whether by contract or 22 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 23 | outstanding shares, or (iii) beneficial ownership of such entity. 24 | 25 | "You" (or "Your") shall mean an individual or Legal Entity 26 | exercising permissions granted by this License. 27 | 28 | "Source" form shall mean the preferred form for making modifications, 29 | including but not limited to software source code, documentation 30 | source, and configuration files. 31 | 32 | "Object" form shall mean any form resulting from mechanical 33 | transformation or translation of a Source form, including but 34 | not limited to compiled object code, generated documentation, 35 | and conversions to other media types. 36 | 37 | "Work" shall mean the work of authorship, whether in Source or 38 | Object form, made available under the License, as indicated by a 39 | copyright notice that is included in or attached to the work 40 | (an example is provided in the Appendix below). 41 | 42 | "Derivative Works" shall mean any work, whether in Source or Object 43 | form, that is based on (or derived from) the Work and for which the 44 | editorial revisions, annotations, elaborations, or other modifications 45 | represent, as a whole, an original work of authorship. For the purposes 46 | of this License, Derivative Works shall not include works that remain 47 | separable from, or merely link (or bind by name) to the interfaces of, 48 | the Work and Derivative Works thereof. 49 | 50 | "Contribution" shall mean any work of authorship, including 51 | the original version of the Work and any modifications or additions 52 | to that Work or Derivative Works thereof, that is intentionally 53 | submitted to Licensor for inclusion in the Work by the copyright owner 54 | or by an individual or Legal Entity authorized to submit on behalf of 55 | the copyright owner. For the purposes of this definition, "submitted" 56 | means any form of electronic, verbal, or written communication sent 57 | to the Licensor or its representatives, including but not limited to 58 | communication on electronic mailing lists, source code control systems, 59 | and issue tracking systems that are managed by, or on behalf of, the 60 | Licensor for the purpose of discussing and improving the Work, but 61 | excluding communication that is conspicuously marked or otherwise 62 | designated in writing by the copyright owner as "Not a Contribution." 63 | 64 | "Contributor" shall mean Licensor and any individual or Legal Entity 65 | on behalf of whom a Contribution has been received by Licensor and 66 | subsequently incorporated within the Work. 67 | 68 | 2. Grant of Copyright License. Subject to the terms and conditions of 69 | this License, each Contributor hereby grants to You a perpetual, 70 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 71 | copyright license to reproduce, prepare Derivative Works of, 72 | publicly display, publicly perform, sublicense, and distribute the 73 | Work and such Derivative Works in Source or Object form. 74 | 75 | 3. Grant of Patent License. Subject to the terms and conditions of 76 | this License, each Contributor hereby grants to You a perpetual, 77 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 78 | (except as stated in this section) patent license to make, have made, 79 | use, offer to sell, sell, import, and otherwise transfer the Work, 80 | where such license applies only to those patent claims licensable 81 | by such Contributor that are necessarily infringed by their 82 | Contribution(s) alone or by combination of their Contribution(s) 83 | with the Work to which such Contribution(s) was submitted. If You 84 | institute patent litigation against any entity (including a 85 | cross-claim or counterclaim in a lawsuit) alleging that the Work 86 | or a Contribution incorporated within the Work constitutes direct 87 | or contributory patent infringement, then any patent licenses 88 | granted to You under this License for that Work shall terminate 89 | as of the date such litigation is filed. 90 | 91 | 4. Redistribution. You may reproduce and distribute copies of the 92 | Work or Derivative Works thereof in any medium, with or without 93 | modifications, and in Source or Object form, provided that You 94 | meet the following conditions: 95 | 96 | (a) You must give any other recipients of the Work or 97 | Derivative Works a copy of this License; and 98 | 99 | (b) You must cause any modified files to carry prominent notices 100 | stating that You changed the files; and 101 | 102 | (c) You must retain, in the Source form of any Derivative Works 103 | that You distribute, all copyright, patent, trademark, and 104 | attribution notices from the Source form of the Work, 105 | excluding those notices that do not pertain to any part of 106 | the Derivative Works; and 107 | 108 | (d) If the Work includes a "NOTICE" text file as part of its 109 | distribution, then any Derivative Works that You distribute must 110 | include a readable copy of the attribution notices contained 111 | within such NOTICE file, excluding those notices that do not 112 | pertain to any part of the Derivative Works, in at least one 113 | of the following places: within a NOTICE text file distributed 114 | as part of the Derivative Works; within the Source form or 115 | documentation, if provided along with the Derivative Works; or, 116 | within a display generated by the Derivative Works, if and 117 | wherever such third-party notices normally appear. The contents 118 | of the NOTICE file are for informational purposes only and 119 | do not modify the License. You may add Your own attribution 120 | notices within Derivative Works that You distribute, alongside 121 | or as an addendum to the NOTICE text from the Work, provided 122 | that such additional attribution notices cannot be construed 123 | as modifying the License. 124 | 125 | You may add Your own copyright statement to Your modifications and 126 | may provide additional or different license terms and conditions 127 | for use, reproduction, or distribution of Your modifications, or 128 | for any such Derivative Works as a whole, provided Your use, 129 | reproduction, and distribution of the Work otherwise complies with 130 | the conditions stated in this License. 131 | 132 | 5. Submission of Contributions. Unless You explicitly state otherwise, 133 | any Contribution intentionally submitted for inclusion in the Work 134 | by You to the Licensor shall be under the terms and conditions of 135 | this License, without any additional terms or conditions. 136 | Notwithstanding the above, nothing herein shall supersede or modify 137 | the terms of any separate license agreement you may have executed 138 | with Licensor regarding such Contributions. 139 | 140 | 6. Trademarks. This License does not grant permission to use the trade 141 | names, trademarks, service marks, or product names of the Licensor, 142 | except as required for reasonable and customary use in describing the 143 | origin of the Work and reproducing the content of the NOTICE file. 144 | 145 | 7. Disclaimer of Warranty. Unless required by applicable law or 146 | agreed to in writing, Licensor provides the Work (and each 147 | Contributor provides its Contributions) on an "AS IS" BASIS, 148 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 149 | implied, including, without limitation, any warranties or conditions 150 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 151 | PARTICULAR PURPOSE. You are solely responsible for determining the 152 | appropriateness of using or redistributing the Work and assume any 153 | risks associated with Your exercise of permissions under this License. 154 | 155 | 8. Limitation of Liability. In no event and under no legal theory, 156 | whether in tort (including negligence), contract, or otherwise, 157 | unless required by applicable law (such as deliberate and grossly 158 | negligent acts) or agreed to in writing, shall any Contributor be 159 | liable to You for damages, including any direct, indirect, special, 160 | incidental, or consequential damages of any character arising as a 161 | result of this License or out of the use or inability to use the 162 | Work (including but not limited to damages for loss of goodwill, 163 | work stoppage, computer failure or malfunction, or any and all 164 | other commercial damages or losses), even if such Contributor 165 | has been advised of the possibility of such damages. 166 | 167 | 9. Accepting Warranty or Additional Liability. While redistributing 168 | the Work or Derivative Works thereof, You may choose to offer, 169 | and charge a fee for, acceptance of support, warranty, indemnity, 170 | or other liability obligations and/or rights consistent with this 171 | License. However, in accepting such obligations, You may act only 172 | on Your own behalf and on Your sole responsibility, not on behalf 173 | of any other Contributor, and only if You agree to indemnify, 174 | defend, and hold each Contributor harmless for any liability 175 | incurred by, or claims asserted against, such Contributor by reason 176 | of your accepting any such warranty or additional liability. 177 | 178 | END OF TERMS AND CONDITIONS 179 | 180 | APPENDIX: How to apply the Apache License to your work. 181 | 182 | To apply the Apache License to your work, attach the following 183 | boilerplate notice, with the fields enclosed by brackets "[]" 184 | replaced with your own identifying information. (Don't include 185 | the brackets!) The text should be enclosed in the appropriate 186 | comment syntax for the file format. We also recommend that a 187 | file or class name and description of purpose be included on the 188 | same "printed page" as the copyright notice for easier 189 | identification within third-party archives. 190 | 191 | Copyright [yyyy] [name of copyright owner] 192 | 193 | Licensed under the Apache License, Version 2.0 (the "License"); 194 | you may not use this file except in compliance with the License. 195 | You may obtain a copy of the License at 196 | 197 | http://www.apache.org/licenses/LICENSE-2.0 198 | 199 | Unless required by applicable law or agreed to in writing, software 200 | distributed under the License is distributed on an "AS IS" BASIS, 201 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 202 | See the License for the specific language governing permissions and 203 | limitations under the License. 204 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Renode simulation of the BeagleV platform 2 | 3 | Copyright (c) 2021-2024 [Antmicro](https://www.antmicro.com/) 4 | 5 | [![View on Antmicro Open Source Portal](https://img.shields.io/badge/View%20on-Antmicro%20Open%20Source%20Portal-332d37?style=flat-square)](https://opensource.antmicro.com/projects/renode-beagle-v) 6 | 7 | This repository contains instructions how to simulate OpenSBI, U-Boot and Linux on [the BeagleV platform](https://beaglev.seeed.cc) in [Renode](https://renode.io). 8 | 9 | ## Installing Renode 10 | 11 | To run this platform it's recommended to install the latest Renode (not earlier than [`b339f650a54dbbbe26cd3a1eeb802277cfdc2982`](https://github.com/renode/renode/commit/b339f650a54dbbbe26cd3a1eeb802277cfdc2982) is required). 12 | See the [documentation](https://docs.renode.io/en/latest/introduction/installing.html) for details. 13 | 14 | For Linux, you can use the portable version: 15 | ``` 16 | wget https://builds.renode.io/renode-latest.linux-portable.tar.gz 17 | mkdir renode_portable 18 | tar xf renode-latest.linux-portable.tar.gz -C renode_portable --strip-components=1 19 | export PATH="`pwd`/renode_portable:$PATH" 20 | ``` 21 | 22 | To run Robot tests, you will also need to install some Python dependencies: 23 | ``` 24 | python3 -m pip install -r renode_portable/tests/requirements.txt 25 | ``` 26 | 27 | ## Running the simulation 28 | 29 | Assuming that Renode is installed and available in PATH, to run the demo execute: 30 | 31 | renode -e "start @scripts/single-node/beaglev_starlight.resc" 32 | 33 | You should see the following output on UART: 34 | 35 | ``` 36 | OpenSBI v0.9 37 | ____ _____ ____ _____ 38 | / __ \ / ____| _ \_ _| 39 | | | | |_ __ ___ _ __ | (___ | |_) || | 40 | | | | | '_ \ / _ \ '_ \ \___ \| _ < | | 41 | | |__| | |_) | __/ | | |____) | |_) || |_ 42 | \____/| .__/ \___|_| |_|_____/|____/_____| 43 | | | 44 | |_| 45 | Platform Name : StarFive VIC7100 46 | Platform Features : timer,mfdeleg 47 | Platform HART Count : 2 48 | Firmware Base : 0x80000000 49 | Firmware Size : 92 KB 50 | Runtime SBI Version : 0.2 51 | Domain0 Name : root 52 | Domain0 Boot HART : 1 53 | Domain0 HARTs : 0*,1* 54 | Domain0 Region00 : 0x0000000080000000-0x000000008001ffff () 55 | Domain0 Region01 : 0x0000000000000000-0xffffffffffffffff (R,W,X) 56 | Domain0 Next Address : 0x0000000080020000 57 | Domain0 Next Arg1 : 0x0000000088000000 58 | Domain0 Next Mode : S-mode 59 | Domain0 SysReset : yes 60 | Boot HART ID : 1 61 | Boot HART Domain : root 62 | Boot HART ISA : rv64imafdcs 63 | Boot HART Features : scounteren,mcounteren,time 64 | Boot HART PMP Count : 16 65 | Boot HART PMP Granularity : 4 66 | Boot HART PMP Address Bits: 54 67 | Boot HART MHPM Count : 0 68 | Boot HART MHPM Count : 0 69 | Boot HART MIDELEG : 0x0000000000000222 70 | Boot HART MEDELEG : 0x000000000000b109 71 | U-Boot 2021.01-g7dac1a6e-dirty (Apr 26 2021 - 09:57:51 +0000) 72 | ofnode_read_prop: riscv,isa: rv64imafdc 73 | CPU: rv64imafdc 74 | Model: sifive,freedom-u74-arty 75 | DRAM: 8 GiB 76 | ofnode_read_prop: tick-timer: 77 | ofnode_read_u32_array: ranges: ofnode_read_u32_array: ranges: ofnode_read_u32_index 78 | : timebase-frequency: (not found) 79 | ofnode_read_u32_index: timebase-frequency: 0x5f5e10 (6250000) 80 | ofnode_read_u32_index: timebase-frequency: (not found) 81 | ofnode_read_u32_index: timebase-frequency: 0x5f5e10 (6250000) 82 | MMC: VIC DWMMC0: 0 83 | In: serial 84 | Out: serial 85 | Err: serial 86 | Model: sifive,freedom-u74-arty 87 | Net: ofnode_read_prop: tick-timer: 88 | dwmac.10020000 89 | Hit any key to stop autoboot: 0 90 | ## Loading kernel from FIT Image at a0000000 ... 91 | Using 'config-1' configuration 92 | Trying 'vmlinux' kernel subimage 93 | Description: vmlinux 94 | Type: Kernel Image 95 | Compression: uncompressed 96 | Data Start: 0xa00000c8 97 | Data Size: 17660416 Bytes = 16.8 MiB 98 | Architecture: RISC-V 99 | OS: Linux 100 | Load Address: 0x80200000 101 | Entry Point: 0x80200000 102 | Verifying Hash Integrity ... OK 103 | ## Loading fdt from FIT Image at a0000000 ... 104 | Using 'config-1' configuration 105 | Trying 'fdt' fdt subimage 106 | Description: unavailable 107 | Type: Flat Device Tree 108 | Compression: uncompressed 109 | Data Start: 0xa4f297f8 110 | Data Size: 16655 Bytes = 16.3 KiB 111 | Architecture: RISC-V 112 | Load Address: 0x86000000 113 | Verifying Hash Integrity ... OK 114 | Loading fdt from 0xa4f297f8 to 0x86000000 115 | Booting using the fdt blob at 0x86000000 116 | ## Loading loadables from FIT Image at a0000000 ... 117 | Trying 'ramdisk' loadables subimage 118 | Description: buildroot initramfs 119 | Type: RAMDisk Image 120 | Compression: uncompressed 121 | Data Start: 0xa10d7b7c 122 | Data Size: 65346560 Bytes = 62.3 MiB 123 | Architecture: RISC-V 124 | OS: Linux 125 | Load Address: 0x86100000 126 | Entry Point: unavailable 127 | Verifying Hash Integrity ... OK 128 | Loading loadables from 0xa10d7b7c to 0x86100000 129 | Loading Kernel Image 130 | ## Flattened Device Tree blob at 86000000 131 | Booting using the fdt blob at 0x86000000 132 | Using Device Tree in place at 0000000086000000, end 000000008600710e 133 | Starting kernel ... 134 | [ 0.000000] Linux version 5.10.6-g93604a0a3ecc (root@runner-7005a2b9-project-347 135 | 5-concurrent-0) (riscv64-buildroot-linux-gnu-gcc.br_real (Buildroot -g2e13b6d) 10.2 136 | .0, GNU ld (GNU Binutils) 2.34) #1 SMP Mon Apr 26 09:57:54 UTC 2021 137 | [ 0.000000] OF: fdt: Ignoring memory range 0x80000000 - 0x80200000 138 | [ 0.000000] earlycon: sbi0 at I/O port 0x0 (options '') 139 | [ 0.000000] printk: bootconsole [sbi0] enabled 140 | ... 141 | ``` 142 | 143 | To log in to the system, use the following credentials: 144 | 145 | ``` 146 | user: root 147 | password: starfive 148 | ``` 149 | 150 | ## Automatic testing of the simulation 151 | 152 | You can also run an automated [robot](https://robotframework.org/) test: 153 | 154 | renode-test renode_portable/tests/platforms/BeagleV-StarLight.robot 155 | 156 | You should see the following result: 157 | 158 | Preparing suites 159 | Started Renode instance on port 49152; pid 1756415 160 | Starting suites 161 | Running renode_portable/tests/platforms/BeagleV-StarLight.robot 162 | +++++ Starting test 'BeagleV-StarLight.Should Boot U-Boot' 163 | +++++ Finished test 'BeagleV-StarLight.Should Boot U-Boot' in 6.16 seconds with status OK 164 | +++++ Starting test 'BeagleV-StarLight.Should Provide Two Linux Machines With Ethernet Connection' 165 | +++++ Finished test 'BeagleV-StarLight.Should Provide Two Linux Machines With Ethernet Connection' in 88.38 seconds with status OK 166 | +++++ Starting test 'BeagleV-StarLight.Should Ping' 167 | +++++ Finished test 'BeagleV-StarLight.Should Ping' in 88.22 seconds with status OK 168 | +++++ Starting test 'BeagleV-StarLight.Should Ping Large Payload' 169 | +++++ Finished test 'BeagleV-StarLight.Should Ping Large Payload' in 91.71 seconds with status OK 170 | Suite renode_portable/tests/platforms/BeagleV-StarLight.robot finished successfully in 274.77 seconds. 171 | Cleaning up suites 172 | Closing Renode pid 1756415 173 | Aggregating all robot results 174 | Output: /home/user/robot_output.xml 175 | Log: /home/user/log.html 176 | Report: /home/user/report.html 177 | Tests finished successfully :) 178 | --------------------------------------------------------------------------------