summaryrefslogtreecommitdiff
path: root/inc/dram.h
blob: c6c3159bcf96b23d113157fc5a9ec57338e3debf (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
#ifndef DRAM_H
#define DRAM_H
#include "definitions.h"
#include "storage.h"
#include <functional>
#include <ostream>

class Dram : public Storage
{
  public:
	/**
	 * Constructor.
	 * @param The number of clock cycles each access takes.
	 * @return A new memory object.
	 */
	Dram(int delay);
	~Dram();

	int
	write_word(void *, signed int, int) override;
	int
	write_line(void *, std::array<signed int, LINE_SIZE>, int) override;
	int
	read_word(void *, int, signed int &) override;
	int
	read_line(void *, int, std::array<signed int, LINE_SIZE> &) override;

	/**
	 * TODO This will accept a file at a later date.
	 */
	void
	load(std::vector<signed int> program);

  private:
	/**
	 * Helper for all access methods.
	 * Calls `request_handler` when `id` is allowed to complete its
	 * request cycle.
	 * @param the source making the request
	 * @param the address to write to
	 * @param the function to call when an access should be completed
	 * @return 1 if the access completed successfully, 0 otherwise
	 */
	int
	process(void *id, int address, std::function<void(int line, int word)> request_handler);
	/**
	 * Returns OK if `id` is allowed to complete its request this cycle.
	 * Handles wait times, side door, and setting the current id this
	 * storage is serving.
	 * @param the source making the request
	 * @return 1 if the access can be completed this function call, 0 otherwise
	 */
	int
	is_access_cleared(void *id);
};

#endif /* DRAM_H_INCLUDED */