n64-pac 0.3.1

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

[![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     | 32 of 32  | ✓ |
|    CP1     |  2 of 2*  | ✓ |
|     MI     |  4 of 4   | ✓ |
|     VI     | 16 of 16  | ✓ |
|     AI     |  6 of 6   | ✓ |
|     PI     | 13 of 13  | ✓ |
|     RI     |  0 of ?   | ✕ |
|     SI     | 6 of 6**  | ✓ |

_* The CP1/FPU has two control registers. The general purpose floating-point registers are manually accessible, but are
typically handled by the compiler when using `f32` or `f64` types._<br>
_** The SI might contain more registers that haven't been fully researched._

### Usage

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

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

Please note this crate requires a nightly rust toolchain in order to use nightly-only inline assembly features and
arbitrary discriminants.