Skip to content

Commit 161228f

Browse files
committed
README Add a placeholder for the readme, fix typos in images
1 parent 39a0dfc commit 161228f

2 files changed

Lines changed: 73 additions & 2 deletions

File tree

README.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## OpenRISC Tutorials
2+
3+
This repository contains the source for the [OpenRISC architecture tutorials](https://openrisc.io/tutorials/)
4+
5+
These documents are helpful for users who want to get started
6+
developing software and SoC's using the OpenRISC cpu architecture.
7+
8+
## Outline
9+
10+
We are currently in progress working on a new structure
11+
and the intended outline is:
12+
13+
```
14+
Getting started with OpenRISC
15+
16+
Programmers Guide
17+
- Link to the architecture
18+
19+
Toolchain Options
20+
Binaries
21+
- downloads from github, need to setup CI for building
22+
23+
Obtaining
24+
- or1k-linux- gcc
25+
- or1k-elf- newlib
26+
- or1k-unknown-gnu- glibc
27+
- or1k-unkiown-musl- musl
28+
- https://github.com/richfelker/musl-cross-make - or1k/openrisc needs update
29+
- or1k-unknown-uclibc-
30+
- https://uclibc-ng.org/docs/ - docs to build
31+
32+
Platforms
33+
Loading binaries into platforms. ELF binaries explaination.
34+
- or1ksim
35+
- QEMU
36+
- Fusesoc
37+
- Litex
38+
39+
Programs on OpenRISC
40+
41+
Memory layout
42+
- Elf binary lays out memeory for linux/bare metal.
43+
44+
Linux on OpenRISC
45+
Memory layout
46+
- In addition to ELF binary
47+
- Device tree
48+
- Rootfs loaded to memory for embedded systems / no sd card
49+
50+
Rootfs
51+
- buildroot
52+
- busybox
53+
54+
Running linux on or1ksim
55+
- defconfig + busybox
56+
57+
Running linux on QEMU
58+
- virt_defconfig + buildroot
59+
60+
Running linux on Litex SoC
61+
- SIM + litex_defconfig + buildroot
62+
- arty + litex_defconfig + buildroot
63+
64+
Running Linux on fusesoc SoC
65+
- SIM + defconfig + busybox
66+
- de0_nano + defconfig + busybox
67+
- de0_nano-multicore + smp_defconfig + busybox
68+
```
69+

images.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,14 +133,16 @@ podman run -it --rm stffrdhrn/or1k-verilog-env
133133
This will bring you to the container prompt which
134134
has access to the verilog development environment.
135135

136-
```
137136
Create the `hello.c` file as described above, then to compile our program run
138137
`gcc` from the OpenRISC toolchain as below:
139138

140139
```bash
141140
or1k-elf-gcc hello.c -o hello
142141
```
143142

143+
This will compile our Hello World program using the OpenRISC baremetal toolchain
144+
and output an ELF file to `hello`.
145+
144146
After our program is compiled we want to prepare to run the program, check that the
145147
fusesoc environment is setup correctly using the following commands:
146148

@@ -153,7 +155,7 @@ Changing directories to `/tmp/src/cores` is needed as fusesoc looks
153155
for verilog IP cores starting in the current directory. The `fusesoc core-info`
154156
command checks if our `mor1kx-generic` SoC is available as expected.
155157

156-
To compile to verilog SoC and run it we use:
158+
To compile and run the verilog SoC we use:
157159

158160
```bash
159161
fusesoc run --target mor1kx_tb mor1kx-generic --elf_load ../hello

0 commit comments

Comments
 (0)