aboutsummaryrefslogtreecommitdiff
path: root/src/peripherals/eeprom.spec.ts
blob: 8f08e47026c79591bc4e45911e542dc0a0236327 (plain)
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
import { CPU } from '../cpu/cpu';
import { AVREEPROM, EEPROMMemoryBackend } from './eeprom';
import { asmProgram, TestProgramRunner } from '../utils/test-utils';

// EEPROM Registers
const EECR = 0x3f;
const EEDR = 0x40;
const EEARL = 0x41;
const EEARH = 0x42;
const SREG = 95;

// Register bit names
/* eslint-disable @typescript-eslint/no-unused-vars */
const EERE = 1;
const EEPE = 2;
const EEMPE = 4;
const EERIE = 8;
const EEPM0 = 16;
const EEPM1 = 32;
/* eslint-enable @typescript-eslint/no-unused-vars */

describe('EEPROM', () => {
  describe('Reading the EEPROM', () => {
    it('should return 0xff when reading from an empty location', () => {
      const cpu = new CPU(new Uint16Array(0x1000));
      new AVREEPROM(cpu, new EEPROMMemoryBackend(1024));
      cpu.writeData(EEARL, 0);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EERE);
      cpu.tick();
      expect(cpu.cycles).toEqual(4);
      expect(cpu.data[EEDR]).toEqual(0xff);
    });

    it('should return the value stored at the given EEPROM address', () => {
      const cpu = new CPU(new Uint16Array(0x1000));
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);
      eepromBackend.memory[0x250] = 0x42;
      cpu.writeData(EEARL, 0x50);
      cpu.writeData(EEARH, 0x2);
      cpu.writeData(EECR, EERE);
      cpu.tick();
      expect(cpu.data[EEDR]).toEqual(0x42);
    });
  });

  describe('Writing to the EEPROM', () => {
    it('should write a byte to the given EEPROM address', () => {
      const cpu = new CPU(new Uint16Array(0x1000));
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);
      cpu.writeData(EEDR, 0x55);
      cpu.writeData(EEARL, 15);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EEMPE);
      cpu.writeData(EECR, EEPE);
      cpu.tick();
      expect(cpu.cycles).toEqual(2);
      expect(eepromBackend.memory[15]).toEqual(0x55);
      expect(cpu.data[EECR] & EEPE).toEqual(EEPE);
    });

    it('should not erase the memory when writing if EEPM1 is high', () => {
      // We subtract 0x20 to translate from RAM address space to I/O register space
      const { program, instructionCount } = asmProgram(`
        ; register addresses
        _REPLACE TWSR, ${EECR - 0x20}
        _REPLACE EEARL, ${EEARL - 0x20}
        _REPLACE EEDR, ${EEDR - 0x20}
        _REPLACE EECR, ${EECR - 0x20}

        LDI r16, 0x55
        OUT EEDR, r16
        LDI r16, 9
        OUT EEARL, r16
        SBI EECR, 5     ; EECR |= EEPM1
        SBI EECR, 2     ; EECR |= EEMPE
        SBI EECR, 1     ; EECR |= EEPE
      `);

      const cpu = new CPU(program);
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);
      eepromBackend.memory[9] = 0x0f; // high four bits are cleared

      const runner = new TestProgramRunner(cpu);
      runner.runInstructions(instructionCount);

      // EEPROM was 0x0f, and our program wrote 0x55.
      // Since write (without erase) only clears bits, we expect 0x05 now.
      expect(eepromBackend.memory[9]).toEqual(0x05);
    });

    it('should clear the EEPE bit and fire an interrupt when write has been completed', () => {
      const cpu = new CPU(new Uint16Array(0x1000));
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);
      cpu.writeData(EEDR, 0x55);
      cpu.writeData(EEARL, 15);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EEMPE | EERIE);
      cpu.data[SREG] = 0x80; // SREG: I-------
      cpu.writeData(EECR, EEPE);
      cpu.cycles += 1000;
      cpu.tick();
      // At this point, write shouldn't be complete yet
      expect(cpu.data[EECR] & EEPE).toEqual(EEPE);
      expect(cpu.pc).toEqual(0);
      cpu.cycles += 10000000;
      // And now, 10 million cycles later, it should.
      cpu.tick();
      expect(eepromBackend.memory[15]).toEqual(0x55);
      expect(cpu.data[EECR] & EEPE).toEqual(0);
      expect(cpu.pc).toEqual(0x2c); // EEPROM Ready interrupt
    });

    it('should skip the write if EEMPE is clear', () => {
      const cpu = new CPU(new Uint16Array(0x1000));
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);
      cpu.writeData(EEDR, 0x55);
      cpu.writeData(EEARL, 15);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EEMPE);
      cpu.cycles = 8; // waiting for more than 4 cycles should clear EEMPE
      cpu.tick();
      cpu.writeData(EECR, EEPE);
      cpu.tick();
      // Ensure that nothing was written, and EEPE bit is clear
      expect(cpu.cycles).toEqual(8);
      expect(eepromBackend.memory[15]).toEqual(0xff);
      expect(cpu.data[EECR] & EEPE).toEqual(0);
    });

    it('should skip the write if another write is already in progress', () => {
      const cpu = new CPU(new Uint16Array(0x1000));
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);

      // Write 0x55 to address 15
      cpu.writeData(EEDR, 0x55);
      cpu.writeData(EEARL, 15);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EEMPE);
      cpu.writeData(EECR, EEPE);
      cpu.tick();
      expect(cpu.cycles).toEqual(2);

      // Write 0x66 to address 16 (first write is still in progress)
      cpu.writeData(EEDR, 0x66);
      cpu.writeData(EEARL, 16);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EEMPE);
      cpu.writeData(EECR, EEPE);
      cpu.tick();

      // Ensure that second write didn't happen
      expect(cpu.cycles).toEqual(2);
      expect(eepromBackend.memory[15]).toEqual(0x55);
      expect(eepromBackend.memory[16]).toEqual(0xff);
    });

    it('should write two bytes sucessfully', () => {
      const cpu = new CPU(new Uint16Array(0x1000));
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);

      // Write 0x55 to address 15
      cpu.writeData(EEDR, 0x55);
      cpu.writeData(EEARL, 15);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EEMPE);
      cpu.writeData(EECR, EEPE);
      cpu.tick();
      expect(cpu.cycles).toEqual(2);

      // wait long enough time for the first write to finish
      cpu.cycles += 10000000;
      cpu.tick();

      // Write 0x66 to address 16
      cpu.writeData(EEDR, 0x66);
      cpu.writeData(EEARL, 16);
      cpu.writeData(EEARH, 0);
      cpu.writeData(EECR, EEMPE);
      cpu.writeData(EECR, EEPE);
      cpu.tick();

      // Ensure both writes took place
      expect(cpu.cycles).toEqual(10000004);
      expect(eepromBackend.memory[15]).toEqual(0x55);
      expect(eepromBackend.memory[16]).toEqual(0x66);
    });
  });

  describe('EEPROM erase', () => {
    it('should only erase the memory when EEPM0 is high', () => {
      // We subtract 0x20 to translate from RAM address space to I/O register space
      const { program, instructionCount } = asmProgram(`
          ; register addresses
          _REPLACE EEARL, ${EEARL - 0x20}
          _REPLACE EEDR, ${EEDR - 0x20}
          _REPLACE EECR, ${EECR - 0x20}

          LDI r16, 0x55
          OUT EEDR, r16
          LDI r16, 9
          OUT EEARL, r16
          SBI EECR, 4     ; EECR |= EEPM0
          SBI EECR, 2     ; EECR |= EEMPE
          SBI EECR, 1     ; EECR |= EEPE
        `);

      const cpu = new CPU(program);
      const eepromBackend = new EEPROMMemoryBackend(1024);
      new AVREEPROM(cpu, eepromBackend);
      eepromBackend.memory[9] = 0x22;

      const runner = new TestProgramRunner(cpu);
      runner.runInstructions(instructionCount);

      expect(eepromBackend.memory[9]).toEqual(0xff);
    });
  });
});