1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
# SiFive Freedom E SDK README #
This repository, maintained by SiFive Inc, makes it easy to get started developing
software for the Freedom E and Freedom S Embedded RISC-V Platforms. This SDK
is intended to work on any target supported by SiFive's distributions of the
RISC-V GNU Toolchain.
[Documentation for Freedom E SDK is available here](https://sifive.github.io/freedom-e-sdk-docs/index.html)
### Under Construction ###
This repository is currently under construction as we transition from the
legacy Freedom E SDK API to the new Freedom Metal Compatibility Library.
#### What is Freedom Metal? ###
[Freedom Metal](https://github.com/sifive/freedom-metal) ([Documentation](https://sifive.github.io/freedom-metal-docs/index.html))
is a library developed by SiFive for writing portable software for all of SiFive's
RISC-V IP, RISC-V FPGA evaluation images, and development boards. Programs written
against the Freedom Metal API are intended to build and run for all SiFive RISC-V
targets. This makes Freedom Metal suitable for writing portable tests, bare metal
application programming, and as a hardware abstraction layer for porting
operating systems to RISC-V.
Consumers of E SDK should also be aware that as we make this transition,
we are still making refinements to the API provided by Freedom Metal. As such,
**the Freedom Metal API should be considered in beta** until we tag a stable release
of Freedom E SDK.
### Contents ###
#### Freedom Metal Compatibility Library ####
* Board Support Packages (found under `bsp/`)
- Supported Targets:
- [SiFive HiFive 1](https://www.sifive.com/boards/hifive1)
- sifive-hifive1
- [SiFive Freedom E310 Arty](https://github.com/sifive/freedom)
- freedom-e310-arty
- SiFive CoreIP
- coreip-e31
- coreip-s51
- SiFive CoreIP Arty FPGA Evaluation targets
- coreip-e31-arty
- coreip-s51-arty
- The board support files for the Freedom Metal library are located entirely
within a single target directory in `bsp/<target>/`. For example, the HiFive 1
board support files for Freedom Metal are entirely within `bsp/sifive-hifive1/`
and consist of the following:
* design.dts
- The DeviceTree description of the target. This file is used to parameterize
the Freedom Metal library to the target device. It is included as reference
so that users of Freedom Metal are aware of what features and peripherals
are available on the target.
* metal.h
- The Freedom Metal machine header which is used internally to Freedom Metal
to instantiate structures to support the target device.
* metal.lds
- The linker script for the target device.
* openocd.cfg (for development board and FPGA targets)
- Used to configure OpenOCD for flashing and debugging the target device.
* settings.mk
- Used to set `-march` and `-mabi` arguments to the RISC-V GNU Toolchain.
* A Few Example Programs (found under `software/`)
- hello
- Prints "Hello, World!" to stdout, if a serial device is present on the target.
- return-pass
- Returns status code 0 indicating program success.
- return-fail
- Returns status code 1 indicating program failure.
- example-itim
- Demonstrates how to statically link application code into the Instruction
Tightly Integrated Memory (ITIM) if an ITIM is present on the target.
- software-interrupt
- Demonstrates how to register a handler for and trigger a software interrupt
- timer-interrupt
- Demonstrates how to register a handler for and trigger a timer interrupt
- local-interrupt
- Demonstrates how to register a handler for and trigger a local interrupt
- example-pmp
- Demonstrates how to configure a Physical Memory Protection (PMP) region
- example-coreip-welcome
- Prints the SiFive banner and blinks LEDs
### Setting up the SDK ###
#### Prerequisites ####
To use this SDK, you will need the following software available on your machine:
* GNU Make
* Git
* RISC-V GNU Toolchain
* RISC-V OpenOCD (for use with development board and FPGA targets)
##### Install the RISC-V Toolchain and OpenOCD #####
The RISC-V GNU Toolchain and OpenOCD are available from the SiFive Website at
https://www.sifive.com/boards
For OpenOCD and/or RISC-V GNU Toolchain, download the .tar.gz for your platform,
and unpack it to your desired location. Then, use the `RISCV_PATH` and
`RISCV_OPENOCD_PATH` variables when using the tools:
```
cp openocd-<date>-<platform>.tar.gz /my/desired/location/
cp riscv64-unknown-elf-gcc-<date>-<platform>.tar.gz /my/desired/location
cd /my/desired/location
tar -xvf openocd-<date>-<platform>.tar.gz
tar -xvf riscv64-unknown-elf-gcc-<date>-<platform>.tar.gz
export RISCV_OPENOCD_PATH=/my/desired/location/openocd
export RISCV_PATH=/my/desired/location/riscv64-unknown-elf-gcc-<date>-<version>
```
#### Cloning the Repository ####
This repository can be cloned by running the following commands:
```
git clone --recursive https://github.com/sifive/freedom-e-sdk.git
cd freedom-e-sdk
```
The `--recursive` option is required to clone the git submodules included in the
repository. If at first you omit the `--recursive` option, you can achieve
the same effect by updating submodules using the command:
```
git submodule update --init --recursive
```
### Updating your SDK ###
If you'd like to update your SDK to the latest version:
```
git pull origin master
git submodule update --init --recursive
```
### Using the Tools ###
#### Building an Example ####
To compile a bare-metal RISC-V program:
```
make [PROGRAM=hello] [TARGET=sifive-hifive1] software
```
The square brackets in the above command indicate optional parameters for the
Make invocation. As you can see, the default values of these parameters tell
the build script to build the `hello` example for the `sifive-hifive1` target.
If, for example, you wished to build the `timer-interrupt` example for the S51
Arty FPGA Evaluation target, you would instead run the command
```
make PROGRAM=timer-interrupt TARGET=coreip-s51-arty software
```
#### Uploading to the Target Board ####
```
make [PROGRAM=hello] [TARGET=sifive-hifive1] upload
```
#### Debugging a Target Program ####
```
make [PROGRAM=hello] [TARGET=sifive-hifive1] debug
```
#### Cleaning a Target Program Build Directory ####
```
make [PROGRAM=hello] [TARGET=sifive-hifive1] clean
```
#### Create a Standalone Project ####
You can export a program to a standalone project directory using the `standalone`
target. The resulting project will be locked to a specific `TARGET`. Note
that this functionality is only supported for Freedom Metal programs, not the
Legacy Freedom E SDK.
`STANDALONE_DEST` is a required argument to provide the desired project location.
You can include the argument `INCLUDE_METAL_SOURCES=1` if you would like to
include the sources for the Freedom Metal library in the generated standalone
project. If this argument is not included, then the Freedom Metal library will
be included in the generated project as a pre-built archive.
```
make [PROGRAM=hello] [TARGET=sifive-hifive1] [INCLUDE_METAL_SOURCES=1] STANDALONE_DEST=/path/to/desired/location standalone
```
Run `make help` for more commands.
### For More Information ###
Documentation, Forums, and much more available at
[dev.sifive.com](https://dev.sifive.com)
|
