n64-pac 0.1.0

Provides low-level CPU and register abstractions for the Nintendo 64 console
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

[![License: MIT](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE)
[![Crates.io](https://img.shields.io/crates/v/n64-pac?style=flat-square)](https://crates.io/crates/n64-pac)
[![Documentation](https://img.shields.io/docsrs/n64-pac?style=flat-square)](https://docs.rs/n64-pac)

### Description

This crate is a low-level abstraction (aka a [Peripheral Access Crate](https://rust-embedded.github.io/book/start/registers.html))
over the CPU and memory-mapped registers available on the Nintendo 64 console.

Due to the low-level nature of the API, most projects (games especially) are unlikely to use this crate directly.

### API Coverage

| Peripheral | Registers |        Complete        |
|:----------:|:---------:|:----------------------:|
|    CP0     |  1 of 32  |          :x:           |
|    CP1     |  0 of 32  |          :x:           |
|     MI     |  0 of 4   |          :x:           |
|     VI     | 15 of 15  |   :heavy_check_mark:   |
|     AI     |  0 of ?   |          :x:           |
|     PI     |  0 of ?   |          :x:           |
|     RI     |  0 of ?   |          :x:           |
|     SI     |  0 of 6?  |          :x:           |


### Usage

In your project's `Cargo.toml`:
```Toml
[dependencies]
n64-pac = "0.0.1"
```

Refer to the [docs](https://docs.rs/n64-pac) for examples and details regarding safety.

This crate is only intended to be used in the N64 embedded environment. 

### Nightly Rust

Unfortunately, the unstable `build-std` cargo feature needed to build the project, still requires a nightly rust toolchain. If/when that is stabilized, this crate should no longer require nightly rust.