Rust on Dreamcast - Revision history

Darc: Replaced content with "Ferris holding his Dreamcast controller '''Please visit [https://dreamcast.rs/ dreamcast.rs]!''' The Rust for Dreamcast documentation has now [https://dreamcast.rs been migrated into an mdBook]!"

2025-01-02T01:19:15Z

Replaced content with "thumb|Ferris holding his Dreamcast controller '''Please visit [https://dreamcast.rs/ dreamcast.rs]!''' The Rust for Dreamcast documentation has now [https://dreamcast.rs been migrated into an mdBook]!"

Show changes

Darc: /* Examples */

2024-12-11T23:20:55Z

Examples

Darc: /* Compiling individual modules into object files with rustc */

2024-12-11T23:04:27Z

Compiling individual modules into object files with rustc

@@ Line 197: / Line 197: @@
 printf("Five plus six is %d\n", add_integers(5, 6));
 </syntaxhighlight>
 ==Using the libc crate with KallistiOS==

Darc: /* Creating a Rust library */

2024-11-27T01:19:01Z

Creating a Rust library

← Older revision		Revision as of 01:19, 27 November 2024
Line 178:		Line 178:
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	The source code here starts similarly to the "Hello, world!" example, except we don't need to specify <syntaxhighlight lang="rust" inline>#![no_main]</syntaxhighlight> as this is a library which wouldn't have a <code>main()</code> function anyway.

	Two simple functions are provided: one for adding two integers and returning the result, and another for adding two integers and printing the result as text. Because these functions use <syntaxhighlight lang="rust" inline>#[no_mangle]</syntaxhighlight> and are declared <syntaxhighlight lang="rust" inline>extern "C"</syntaxhighlight>, they can be called by name in C code that links this library.		Two simple functions are provided: one for adding two integers and returning the result, and another for adding two integers and printing the result as text. Because these functions use <syntaxhighlight lang="rust" inline>#[no_mangle]</syntaxhighlight> and are declared <syntaxhighlight lang="rust" inline>extern "C"</syntaxhighlight>, they can be called by name in C code that links this library.

Darc: /* Installing our custom KallistiOS and GCC toolchain */

2024-11-26T22:46:27Z

Installing our custom KallistiOS and GCC toolchain

← Older revision		Revision as of 22:46, 26 November 2024
Line 57:		Line 57:

	To build the GCC toolchain using 2 CPU cores, simply type:		To build the GCC toolchain using 2 CPU cores, simply type:
	make makejobs=2 ~~sh_gcc_git_branch=master-88b2da3c175d34d65415f69961420f35ac1a1c56~~		make makejobs=2
	Adjust the <code>makejobs=...</code> value to use the number of CPU cores available to you on your system in order to speed up compilation. This may take a while to build, so be patient.		Adjust the <code>makejobs=...</code> value to use the number of CPU cores available to you on your system in order to speed up compilation. This may take a while to build, so be patient.

Darc: /* Installing our custom KallistiOS and GCC toolchain */

2024-11-25T18:00:06Z

Installing our custom KallistiOS and GCC toolchain

← Older revision		Revision as of 18:00, 25 November 2024
Line 57:		Line 57:

	To build the GCC toolchain using 2 CPU cores, simply type:		To build the GCC toolchain using 2 CPU cores, simply type:
	make makejobs=2		make makejobs=2 sh_gcc_git_branch=master-88b2da3c175d34d65415f69961420f35ac1a1c56
	Adjust the <code>makejobs=...</code> value to use the number of CPU cores available to you on your system in order to speed up compilation. This may take a while to build, so be patient.		Adjust the <code>makejobs=...</code> value to use the number of CPU cores available to you on your system in order to speed up compilation. This may take a while to build, so be patient.

Darc: /* Creating a new Rust project with Cargo */

2024-11-22T00:28:19Z

Creating a new Rust project with Cargo

← Older revision		Revision as of 00:28, 22 November 2024
Line 123:		Line 123:
	Now we can open up <code>src/main.rs</code> and write our "Hello, world!" example code:		Now we can open up <code>src/main.rs</code> and write our "Hello, world!" example code:
	<syntaxhighlight lang="rust" line>		<syntaxhighlight lang="rust" line>
	~~#![no_main]~~		fn main() {

	~~#[no_mangle]~~
	~~extern "C"~~ fn main(~~_argc: isize, _argv: const const u8~~) ~~-> isize~~ {
	println!("Hello, world from Rust!");		println!("Hello, world from Rust!");

	0
	}		}
	</syntaxhighlight>		</syntaxhighlight>

	* <syntaxhighlight lang="rust" inline>#![no_main]</syntaxhighlight> tells Rust that we will not have Rust use a <code>main</code> function as an entry point -- this will be handled by KallistiOS.
	* <syntaxhighlight lang="rust" inline>#[no_mangle]</syntaxhighlight> tells Rust to disable name mangling so that the <code>main</code> function can be used by KallistiOS's C code.
	* Finally, we have a <syntaxhighlight lang="rust" inline>fn main</syntaxhighlight> with the function signature of a typical C <code>main</code> function, containing a basic "Hello, world!" exclamation.

	Now we can use <code>kos-cargo build</code> to build our project. If all goes well, there will be a <code>target/sh-elf/debug/hello.elf</code> file that can be sent to the Dreamcast with <code>dc-tool</code>.		Now we can use <code>kos-cargo build</code> to build our project. If all goes well, there will be a <code>target/sh-elf/debug/hello.elf</code> file that can be sent to the Dreamcast with <code>dc-tool</code>.

Darc: /* Examples */

2024-11-14T14:04:10Z

Examples

← Older revision		Revision as of 14:04, 14 November 2024
Line 105:		Line 105:
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/filesystem-io <code>filesystem-io</code>] demonstrates listing directory contents and opening files.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/filesystem-io <code>filesystem-io</code>] demonstrates listing directory contents and opening files.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/network-time <code>network-time</code>] demonstrates displaying the system time and retrieving the current UTC time from an NTP server using the [[Broadband adapter]] or [[LAN adapter]].		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/network-time <code>network-time</code>] demonstrates displaying the system time and retrieving the current UTC time from an NTP server using the [[Broadband adapter]] or [[LAN adapter]].
			* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/pvr_strips_direct <code>pvr_strips_direct</code>] demonstrates the use of PVR direct rendering
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/threads <code>threads</code>] demonstrates the use of threads.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/threads <code>threads</code>] demonstrates the use of threads.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/tokio-async <code>tokio-async</code>] demonstrates the use of the '''tokio''' async runtime.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/tokio-async <code>tokio-async</code>] demonstrates the use of the '''tokio''' async runtime.

Darc: /* Current Status */

2024-11-14T01:07:38Z

Current Status

← Older revision		Revision as of 01:07, 14 November 2024
Line 14:		Line 14:
	** Wrappers are provided to invoke '''cargo''' and '''rustc''' in a familiar manner to compile projects.		** Wrappers are provided to invoke '''cargo''' and '''rustc''' in a familiar manner to compile projects.
	* A [https://github.com/dreamcast-rs/kos-sys '''kos-sys'''] raw/unsafe bindings crate is provided for easily linking KallistiOS and its unsafe C API into Rust crates. This crate is in active development, but with a large portion of KallistiOS functionality available now via C FFI.		* A [https://github.com/dreamcast-rs/kos-sys '''kos-sys'''] raw/unsafe bindings crate is provided for easily linking KallistiOS and its unsafe C API into Rust crates. This crate is in active development, but with a large portion of KallistiOS functionality available now via C FFI.
	* A [https://github.com/dreamcast-rs/kos-rs '''kos-rs'''] Rust crate is available but is ~~also~~ in early stages.		* A [https://github.com/dreamcast-rs/kos-rs '''kos-rs'''] Rust crate with safe idiomatic interfaces is available but is in very early stages.
	** Documentation for the bindings is available at [https://kos-rs.dreamcast.wiki/ kos-rs.dreamcast.wiki].		** Documentation for the bindings is available at [https://kos-rs.dreamcast.wiki/ kos-rs.dreamcast.wiki].
	** If bindings do not yet exist for desired functionality, wrapping of KallistiOS C functions is required to get proper use of KallistiOS at this time. See the [https://doc.rust-lang.org/nomicon/ffi.html Foreign Function Interface page] in the Rustonomicon for further understanding.		** If bindings do not yet exist for desired functionality, wrapping of KallistiOS C functions is required to get proper use of KallistiOS at this time. See the [https://doc.rust-lang.org/nomicon/ffi.html Foreign Function Interface page] in the Rustonomicon for further understanding.

Darc: /* Current Status */

2024-11-14T01:06:44Z

Current Status

← Older revision		Revision as of 01:06, 14 November 2024
Line 13:		Line 13:
	** This version includes minor changes for Rust and a beta libpthread addon layer to interface with the Rust standard library.		** This version includes minor changes for Rust and a beta libpthread addon layer to interface with the Rust standard library.
	** Wrappers are provided to invoke '''cargo''' and '''rustc''' in a familiar manner to compile projects.		** Wrappers are provided to invoke '''cargo''' and '''rustc''' in a familiar manner to compile projects.
	* A [https://github.com/dreamcast-rs/kos-sys '''kos-sys'''] raw/unsafe bindings crate is provided for easily linking KallistiOS and its unsafe C API into Rust crates. This crate is ~~in early stages and~~ in active development.		* A [https://github.com/dreamcast-rs/kos-sys '''kos-sys'''] raw/unsafe bindings crate is provided for easily linking KallistiOS and its unsafe C API into Rust crates. This crate is in active development, but with a large portion of KallistiOS functionality available now via C FFI.
	* A [https://github.com/dreamcast-rs/kos-rs '''kos-rs'''] Rust crate is available but is also in early stages.		* A [https://github.com/dreamcast-rs/kos-rs '''kos-rs'''] Rust crate is available but is also in early stages.
	** Documentation for the bindings is available at [https://kos-rs.dreamcast.wiki/ kos-rs.dreamcast.wiki].		** Documentation for the bindings is available at [https://kos-rs.dreamcast.wiki/ kos-rs.dreamcast.wiki].

← Older revision		Revision as of 23:20, 11 December 2024
Line 98:		Line 98:
	==Examples==		==Examples==
	Examples are included with the Rust for Dreamcast repo to help you get started.		Examples are included with the Rust for Dreamcast repo to help you get started.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/hello~~-cargo~~ <code>hello~~-cargo~~</code>] demonstrates how to create a simple "Hello, world!" application using cargo.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/hello <code>hello</code>] demonstrates how to create a simple "Hello, world!" application using cargo.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/hello-make <code>hello-make</code>] demonstrates how to create a simple "Hello, world!" application using standard Makefiles.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/gldc-cube <code>gldc-cube</code>] demonstrates a Rust project using the GLdc KOS port.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/gldc-cube <code>gldc-cube</code>] demonstrates a Rust project using the GLdc KOS port.
			* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/romdisk <code>romdisk</code>] demonstrates how to generate and mount a read-only ROMdisk with a KallistiOS project.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/addlib <code>addlib</code>] demonstrates how to create a Rust library that can be included with a KallistiOS project.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/addlib <code>addlib</code>] demonstrates how to create a Rust library that can be included with a KallistiOS project.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/atomics <code>atomics</code>] demonstrates the use of atomic functions.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/atomics <code>atomics</code>] demonstrates the use of atomic functions.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/filesystem-io <code>filesystem-io</code>] demonstrates listing directory contents and opening files.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/filesystem-io <code>filesystem-io</code>] demonstrates listing directory contents and opening files.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/network-time <code>network-time</code>] demonstrates displaying the system time and retrieving the current UTC time from an NTP server using the [[Broadband adapter]] or [[LAN adapter]].		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/network-time <code>network-time</code>] demonstrates displaying the system time and retrieving the current UTC time from an NTP server using the [[Broadband adapter]] or [[LAN adapter]].
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/~~pvr_strips_direct~~ <code>~~pvr_strips_direct~~</code>] demonstrates the use of PVR direct rendering		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/pvr/pvrmark_strips_direct <code>pvrmark_strips_direct</code>] demonstrates the use of PVR direct rendering
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/threads <code>threads</code>] demonstrates the use of threads.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/threads <code>threads</code>] demonstrates the use of threads.
	* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/tokio-async <code>tokio-async</code>] demonstrates the use of the '''tokio''' async runtime.		* [https://github.com/dreamcast-rs/rust-for-dreamcast/tree/master/examples/tokio-async <code>tokio-async</code>] demonstrates the use of the '''tokio''' async runtime.