summaryrefslogtreecommitdiff
path: root/hdl/mem_cache.sv
blob: e7fcac7213f95633d81042d85b166230d2d71446 (plain) (blame)
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
`include "defs.svh"

module mem_cache
    #(  SET_BITS    = 8
    )
    (   input   bit clock
    ,   input   bit reset

    ,   output  bit             core_command_ready
    ,   input   bit             core_command_valid
    ,   input   core_to_mem_t   core_command_data

    ,   input   bit             ram_command_ready
    ,   output  bit             ram_command_valid
    ,   output  core_to_mem_t   ram_command_data

    ,   output  bit                 ram_response_ready
    ,   input   bit                 ram_response_valid
    ,   input   mem_to_core_t       ram_response_data

    ,   input   bit                 core_response_ready
    ,   output  bit                 core_response_valid
    ,   output  mem_to_core_t       core_response_data
    );

    localparam ADDRESS_TAG_LO   = $clog2(`RAM_LINE_WORDS)+SET_BITS;

    typedef bit [`PDP_ADDRESS_BITS-1:ADDRESS_TAG_LO]        address_tag_t;
    typedef bit [ADDRESS_TAG_LO-1:$clog2(`RAM_LINE_WORDS)]  set_t;

    typedef struct packed {
        bit             valid;
        bit             dirty;
        address_tag_t   address;
    } tag_t;

    typedef struct packed {
        tag_t       tag;
        ram_line_t  data;
    } cache_entry_t;

    struct packed {
        set_t           address;
        bit             read_enable;
        bit             write_enable;
        cache_entry_t   read_data;
        cache_entry_t   write_data;
    } cache[1:0];

    altsyncram
        #(  .address_reg_b("CLOCK0")
        ,   .clock_enable_input_a("BYPASS"), .clock_enable_input_b("BYPASS")
        ,   .clock_enable_output_a("BYPASS"), .clock_enable_output_b("BYPASS")
        ,   .indata_reg_b("CLOCK0")
        ,   .numwords_a(1 << SET_BITS), .numwords_b(1 << SET_BITS)
        ,   .operation_mode("BIDIR_DUAL_PORT")
        ,   .outdata_aclr_a("NONE"), .outdata_aclr_b("NONE")
        ,   .outdata_reg_a("UNREGISTERED"), .outdata_reg_b("UNREGISTERED")
        ,   .power_up_uninitialized("TRUE")
        ,   .ram_block_type("M9K")
        ,   .read_during_write_mode_mixed_ports("OLD_DATA")
        ,   .read_during_write_mode_port_a("OLD_DATA"), .read_during_write_mode_port_b("OLD_DATA")
        ,   .widthad_a(SET_BITS), .widthad_b(SET_BITS)
        ,   .width_a($bits(cache_entry_t)), .width_b($bits(cache_entry_t))
        ,   .width_byteena_a(1), .width_byteena_b(1)
        ,   .wrcontrol_wraddress_reg_b("CLOCK0")
        )   cache_controller
        (   .address_a(cache[0].address), .address_b(cache[1].address)
        ,   .clock0(~clock)
        ,   .data_a(cache[0].write_data), .data_b(cache[1].write_data)
        ,   .rden_a(cache[0].read_enable), .rden_b(cache[1].read_enable)
        ,   .wren_a(cache[0].write_enable), .wren_b(cache[1].write_enable)
        ,   .q_a(cache[0].read_data), .q_b(cache[1].read_data)
        ,   .aclr0(1'b0), .aclr1(1'b0)
        ,   .addressstall_a(1'b0), .addressstall_b(1'b0)
        ,   .byteena_a(1'b1), .byteena_b(1'b1)
        ,   .clock1(1'b1)
        ,   .clocken0(1'b1), .clocken1(1'b1), .clocken2(1'b1), .clocken3(1'b1)
        ,   .eccstatus()
        );

    bit [SET_BITS:0]    reset_entry;

    // "The" fill buffer
    address_tag_t   working_tag;
    set_t           working_set;

    (* syn_encoding = "one-hot" *) enum int unsigned
        {   AWAIT_CORE_COMMAND
        ,   AWAIT_CACHE
        ,   SEND_FILL_REQUEST
        ,   AWAIT_RAM_RESPONSE
        } state;

    always @(posedge clock) begin
        if (reset) begin
            core_command_ready = 0;
            ram_command_valid = 0;
            ram_response_ready = 0;
            core_response_valid = 0;
            reset_entry = 0;
            cache[0].address = 0; cache[1].address = 0;
            cache[0].read_enable = 0; cache[1].read_enable = 0;
            cache[0].write_enable = 0; cache[1].write_enable = 0;
            cache[0].write_data = 0; cache[1].write_data = 0;
            state = state.first;
        end else begin
            if (ram_command_ready && ram_command_valid)
                ram_command_valid = 0;
            if (core_response_ready && core_response_valid)
                core_response_valid = 0;

            if (!reset_entry[SET_BITS]) begin
                cache[0].address = reset_entry[SET_BITS-1:0];
                cache[1].address = reset_entry[SET_BITS-1:0] + 1;
                cache[0].read_enable = 0; cache[1].read_enable = 0;
                cache[0].write_enable = 1; cache[1].write_enable = 1;
                cache[0].write_data = 0; cache[1].write_data = 0;
                reset_entry += 2;
            end else begin
                case (state)

                AWAIT_CORE_COMMAND: begin
                    cache[0].read_enable = 0;
                    cache[0].write_enable = 0;

                    if (core_command_ready && core_command_valid) begin
                        {working_tag, working_set} = core_command_data.address;
                        cache[0].address = working_set;
                        cache[0].read_enable = 1;
                        cache[0].write_enable = core_command_data.write;
                        cache[0].write_data.tag.valid = 1;
                        cache[0].write_data.tag.dirty = 1;
                        cache[0].write_data.tag.address = working_tag;
                        cache[0].write_data.data = core_command_data.data;
                        state = AWAIT_CACHE;
                    end
                end

                AWAIT_CACHE: begin
                    if (cache[0].read_data.tag.valid && cache[0].read_data.tag.dirty && cache[0].read_data.tag.address != working_tag) begin
                        ram_command_valid = 1;
                        ram_command_data.address = {cache[0].read_data.tag.address, working_set};
                        ram_command_data.write = 1;
                        ram_command_data.snoop_response = 0;
                        ram_command_data.data = cache[0].read_data.data;
                        ram_command_data.mask = ~0;
                        state = cache[0].write_enable ? AWAIT_CORE_COMMAND : SEND_FILL_REQUEST;
                    end else if (cache[0].write_enable) begin
                        core_command_ready = !core_response_valid && !ram_command_valid;
                        state = AWAIT_CORE_COMMAND;
                    end else if (cache[0].read_data.tag.valid && cache[0].read_data.tag.address == working_tag) begin
                        core_response_valid = 1;
                        core_response_data.address = {working_tag, working_set};
                        core_response_data.snoop = 0;
                        core_response_data.data_valid = 1;
                        core_response_data.data = cache[0].read_data.data;
                        state = AWAIT_CORE_COMMAND;
                    end else begin
                        ram_command_valid = 1;
                        ram_command_data.address = {working_tag, working_set};
                        ram_command_data.write = 0;
                        ram_command_data.snoop_response = 0;
                        state = AWAIT_RAM_RESPONSE;
                    end

                    cache[0].read_enable = 0;
                    cache[0].write_enable = 0;
                end

                SEND_FILL_REQUEST: begin
                    cache[0].read_enable = 0;
                    cache[0].write_enable = 0;

                    if (!ram_command_valid) begin
                        ram_command_valid = 1;
                        ram_command_data.address = {working_tag, working_set};
                        ram_command_data.write = 0;
                        ram_command_data.snoop_response = 0;
                        state = AWAIT_RAM_RESPONSE;
                    end
                end

                AWAIT_RAM_RESPONSE: begin
                    cache[0].read_enable = 0;
                    cache[0].write_enable = 0;

                    if (ram_response_valid && ram_response_data.address == {working_tag, working_set} && ram_response_data.data_valid) begin
                        core_response_valid = 1;
                        core_response_data = ram_response_data;
                        cache[0].address = working_set;
                        cache[0].read_enable = 0;
                        cache[0].write_enable = 1;
                        cache[0].write_data.tag.valid = 1;
                        cache[0].write_data.tag.dirty = 0;
                        cache[0].write_data.tag.address = working_tag;
                        cache[0].write_data.data = ram_response_data.data;
                        state = AWAIT_CORE_COMMAND;
                    end
                end

                endcase

                core_command_ready = state == AWAIT_CORE_COMMAND && !core_response_valid && !ram_command_valid;
                ram_response_ready = state == AWAIT_RAM_RESPONSE && !core_response_valid && !ram_command_valid;
            end
        end
    end

endmodule