gba_save 0.4.0

Tools for interacting with backup media on Game Boy Advance cartridges.
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
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

use crate::{
    eeprom::{ADDRESS_LEN_8KB, ADDRESS_LEN_512B, populate_address, read, write},
    log,
};
use core::{cmp::min, convert::Infallible, marker::PhantomData};
use deranged::RangedUsize;
use embedded_io::{ErrorType, Read};

#[derive(Debug)]
struct Reader<'a> {
    address: *mut u8,
    len: usize,
    lifetime: PhantomData<&'a ()>,
}

impl Reader<'_> {
    unsafe fn new_unchecked(address: *mut u8, len: usize) -> Self {
        Self {
            address,
            len,
            lifetime: PhantomData,
        }
    }

    fn read<const ADDRESS_LEN: usize>(&mut self, buf: &mut [u8]) -> Result<usize, Infallible> {
        let mut bits = [0u16; 68];

        // Read in chunks of 8 bytes.
        let mut read_count = 0;
        let read_limit = min(buf.len(), self.len);
        loop {
            if read_count >= read_limit {
                return Ok(read_count);
            }

            // Request a read of EEPROM data.
            bits[0] = 1;
            bits[1] = 1;
            populate_address::<ADDRESS_LEN>(&mut bits[2..], self.address);

            // Send to EEPROM
            write(&bits[..(ADDRESS_LEN + 3)]);
            // Receive from EEPROM.
            let bytes_to_read = read_limit - read_count;
            let offset = unsafe { RangedUsize::new_unchecked(self.address as usize & 0b0000_0111) };
            if bytes_to_read < (8 - offset.get()) {
                read(
                    bits,
                    &mut buf[read_count..(read_count + bytes_to_read)],
                    offset,
                );
            } else {
                read(bits, &mut buf[read_count..], offset);
            }

            let amount_read = min(8 - offset.get(), bytes_to_read);
            read_count += amount_read;
            self.address = unsafe { self.address.byte_add(amount_read) };
            self.len -= amount_read;
        }
    }
}

/// A reader on a 512B EEPROM device.
///
/// This type allows reading data over the range specified upon creation.
#[derive(Debug)]
pub struct Reader512B<'a> {
    reader: Reader<'a>,
}

impl Reader512B<'_> {
    pub(in crate::eeprom) unsafe fn new_unchecked(address: *mut u8, len: usize) -> Self {
        log::info!(
            "Creating EEPROM 512B reader at address 0x{:08x?} with length {len}",
            address as usize
        );
        Self {
            reader: unsafe { Reader::new_unchecked(address, len) },
        }
    }
}

impl ErrorType for Reader512B<'_> {
    type Error = Infallible;
}

impl Read for Reader512B<'_> {
    fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error> {
        self.reader.read::<ADDRESS_LEN_512B>(buf)
    }
}

/// A reader on an 8KiB EEPROM device.
///
/// This type allows reading data over the range specified upon creation.
#[derive(Debug)]
pub struct Reader8K<'a> {
    reader: Reader<'a>,
}

impl Reader8K<'_> {
    pub(in crate::eeprom) unsafe fn new_unchecked(address: *mut u8, len: usize) -> Self {
        log::info!(
            "Creating EEPROM 8KiB reader at address 0x{:08x?} with length {len}",
            address as usize
        );
        Self {
            reader: unsafe { Reader::new_unchecked(address, len) },
        }
    }
}

impl ErrorType for Reader8K<'_> {
    type Error = Infallible;
}

impl Read for Reader8K<'_> {
    fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error> {
        self.reader.read::<ADDRESS_LEN_8KB>(buf)
    }
}