-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Add a sparc-unknown-none-elf target. #113535
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
d30294e
4bccf83
9efc683
3f3a855
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
use crate::abi::Endian; | ||
use crate::spec::{Cc, LinkerFlavor, Lld, PanicStrategy, RelocModel, Target, TargetOptions}; | ||
|
||
pub fn target() -> Target { | ||
let options = TargetOptions { | ||
linker_flavor: LinkerFlavor::Gnu(Cc::Yes, Lld::No), | ||
linker: Some("sparc-elf-gcc".into()), | ||
endian: Endian::Big, | ||
cpu: "v7".into(), | ||
abi: "elf".into(), | ||
max_atomic_width: Some(32), | ||
atomic_cas: true, | ||
panic_strategy: PanicStrategy::Abort, | ||
relocation_model: RelocModel::Static, | ||
no_default_libraries: false, | ||
emit_debug_gdb_scripts: false, | ||
eh_frame_header: false, | ||
..Default::default() | ||
}; | ||
Target { | ||
data_layout: "E-m:e-p:32:32-i64:64-f128:64-n32-S64".into(), | ||
llvm_target: "sparc-unknown-none-elf".into(), | ||
pointer_width: 32, | ||
arch: "sparc".into(), | ||
options, | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,164 @@ | ||
# `sparc-unknown-none-elf` | ||
|
||
**Tier: 3** | ||
|
||
Rust for bare-metal 32-bit SPARC V7 and V8 systems, e.g. the Gaisler LEON3. | ||
|
||
| Target | Descriptions | | ||
| ---------------------- | ----------------------------------------- | | ||
| sparc-unknown-none-elf | SPARC V7 32-bit (freestanding, hardfloat) | | ||
|
||
## Target maintainers | ||
|
||
- Jonathan Pallant, <[email protected]>, https://ferrous-systems.com | ||
|
||
## Requirements | ||
|
||
This target is cross-compiled. There is no support for `std`. There is no | ||
default allocator, but it's possible to use `alloc` by supplying an allocator. | ||
|
||
This allows the generated code to run in environments, such as kernels, which | ||
may need to avoid the use of such registers or which may have special | ||
considerations about the use of such registers (e.g. saving and restoring them | ||
to avoid breaking userspace code using the same registers). You can change code | ||
generation to use additional CPU features via the `-C target-feature=` codegen | ||
options to rustc, or via the `#[target_feature]` mechanism within Rust code. | ||
|
||
By default, code generated with this target should run on any `SPARC` hardware; | ||
enabling additional target features may raise this baseline. | ||
|
||
- `-Ctarget-cpu=v8` adds the extra SPARC V8 instructions. | ||
|
||
- `-Ctarget-cpu=leon3` adds the SPARC V8 instructions and sets up scheduling to | ||
suit the Gaisler Leon3. | ||
|
||
Functions marked `extern "C"` use the [standard SPARC architecture calling | ||
convention](https://sparc.org/technical-documents/). | ||
|
||
This target generates ELF binaries. Any alternate formats or special | ||
considerations for binary layout will require linker options or linker scripts. | ||
|
||
## Building the target | ||
|
||
You can build Rust with support for the target by adding it to the `target` | ||
list in `config.toml`: | ||
|
||
```toml | ||
[build] | ||
build-stage = 1 | ||
target = ["sparc-unknown-none-elf"] | ||
``` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-critical: Does using There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've only tried with build-std=core but that's how I've been using it (rather than having the toolchain build the libcore in advance). I suppose you could make this sparcv8-unknown-none-elf because I think SPARC V7 stuff is very very niche at this point. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, then I think we should document a recommendation to use |
||
|
||
## Building Rust programs | ||
|
||
```text | ||
cargo build --target sparc-unknown-none-elf | ||
``` | ||
|
||
This target uses GCC as a linker, and so you will need an appropriate GCC | ||
compatible `sparc-unknown-none` toolchain. | ||
|
||
The default linker name is `sparc-elf-gcc`, but you can override this in your | ||
project configuration. | ||
|
||
## Testing | ||
|
||
As `sparc-unknown-none-elf` supports a variety of different environments and does | ||
not support `std`, this target does not support running the Rust test suite. | ||
|
||
## Cross-compilation toolchains and C code | ||
|
||
This target was initially tested using [BCC2] from Gaisler, along with the TSIM | ||
Leon3 processor simulator. Both [BCC2] GCC and [BCC2] Clang have been shown to | ||
work. To work with these tools, your project configuration should contain | ||
something like: | ||
|
||
[BCC2]: https://www.gaisler.com/index.php/downloads/compilers | ||
|
||
`.cargo/config.toml`: | ||
```toml | ||
[target.sparc-unknown-none-elf] | ||
linker = "sparc-gaisler-elf-gcc" | ||
runner = "tsim-leon3" | ||
|
||
[build] | ||
target = ["sparc-unknown-none-elf"] | ||
rustflags = "-Ctarget-cpu=leon3" | ||
|
||
[unstable] | ||
build-std = ["core"] | ||
``` | ||
|
||
With this configuration, running `cargo run` will compile your code for the | ||
SPARC V8 compatible Gaisler Leon3 processor and then start the `tsim-leon3` | ||
simulator. Once the simulator is running, simply enter the command | ||
`run` to start the code executing in the simulator. | ||
|
||
The default C toolchain libraries are linked in, so with the Gaisler [BCC2] | ||
toolchain, and using its default Leon3 BSP, you can use call the C `putchar` | ||
function and friends to output to the simulator console. | ||
|
||
Here's a complete example: | ||
|
||
```rust,ignore (cannot-test-this-because-it-assumes-special-libc-functions) | ||
#![no_std] | ||
#![no_main] | ||
extern "C" { | ||
fn putchar(ch: i32); | ||
fn _exit(code: i32) -> !; | ||
} | ||
#[no_mangle] | ||
extern "C" fn main() -> i32 { | ||
let message = "Hello, this is Rust!"; | ||
for b in message.bytes() { | ||
unsafe { | ||
putchar(b as i32); | ||
} | ||
} | ||
0 | ||
} | ||
#[panic_handler] | ||
fn panic(_panic: &core::panic::PanicInfo) -> ! { | ||
unsafe { | ||
_exit(1); | ||
} | ||
} | ||
``` | ||
|
||
```console | ||
$ cargo run --target=sparc-unknown-none-elf | ||
Compiling sparc-demo-rust v0.1.0 (/work/sparc-demo-rust) | ||
Finished dev [unoptimized + debuginfo] target(s) in 3.44s | ||
Running `tsim-leon3 target/sparc-unknown-none-elf/debug/sparc-demo-rust` | ||
|
||
TSIM3 LEON3 SPARC simulator, version 3.1.9 (evaluation version) | ||
|
||
Copyright (C) 2023, Frontgrade Gaisler - all rights reserved. | ||
This software may only be used with a valid license. | ||
For latest updates, go to https://www.gaisler.com/ | ||
Comments or bug-reports to [email protected] | ||
|
||
This TSIM evaluation version will expire 2023-11-28 | ||
|
||
Number of CPUs: 2 | ||
system frequency: 50.000 MHz | ||
icache: 1 * 4 KiB, 16 bytes/line (4 KiB total) | ||
dcache: 1 * 4 KiB, 16 bytes/line (4 KiB total) | ||
Allocated 8192 KiB SRAM memory, in 1 bank at 0x40000000 | ||
Allocated 32 MiB SDRAM memory, in 1 bank at 0x60000000 | ||
Allocated 8192 KiB ROM memory at 0x00000000 | ||
section: .text, addr: 0x40000000, size: 20528 bytes | ||
section: .rodata, addr: 0x40005030, size: 128 bytes | ||
section: .data, addr: 0x400050b0, size: 1176 bytes | ||
read 347 symbols | ||
|
||
tsim> run | ||
Initializing and starting from 0x40000000 | ||
Hello, this is Rust! | ||
|
||
Program exited normally on CPU 0. | ||
tsim> | ||
``` |
Uh oh!
There was an error while loading. Please reload this page.