source: branches/RWT/communication/dspin_dhccp_param/caba/source/include/dspin_dhccp_param.h @ 477

Last change on this file since 477 was 477, checked in by lgarcia, 9 years ago

Reintroducing RWT branch merging the last modifications of the
trunk (CLACK channel)
WARNING: bugs remaining (with 1c16p and small caches (L2:16*16; L1:4*4))

File size: 17.0 KB
Line 
1/* -*- c++ -*-
2 * File         : dspin_dhccp_param.h
3 * Date         : 01/03/2013
4 * Copyright    : UPMC / LIP6
5 * Authors      : Cesar Fuguet
6 *
7 * SOCLIB_LGPL_HEADER_BEGIN
8 *
9 * This file is part of SoCLib, GNU LGPLv2.1.
10 *
11 * SoCLib is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU Lesser General Public License as published
13 * by the Free Software Foundation; version 2.1 of the License.
14 *
15 * SoCLib is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with SoCLib; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 * 02110-1301 USA
24 *
25 * SOCLIB_LGPL_HEADER_END
26 */
27
28
29#ifndef DSPIN_DHCCP_PARAMS_H
30#define DSPIN_DHCCP_PARAMS_H
31
32#include <inttypes.h>
33#include <assert.h>
34
35namespace soclib { namespace caba {
36
37/*
38 * L1 cache to Memory Cache command packets
39 *
40 * CLEANUP
41 *
42 * flit 1
43 * --------------------------------------------------------------------------------------------------------
44 * EOP:0 |    DEST    |   SRCID   | NLINE MSB(2 bits)| CONTAINS_DATA | WAY_INDEX(2 bits) | TYPE:0b1X | BC:0
45 *       |  (10 bits) | (14 bits) |                  |               |                   |           |
46 * --------------------------------------------------------------------------------------------------------
47 *                                                                                 | X: 0 DATA  |
48 *                                                                                 |    1 INST  |
49 * flit 2
50 * ----------------------------------------------------------------------------------------------
51 * EOP:0/1 |                                                                       NLINE(32 bits)
52 * ----------------------------------------------------------------------------------------------
53 *
54 * flit N for data
55 * ----------------------------------------------------------------------------------------------
56 * EOP:0/1 |                                                                       WDATA(32 bits)
57 * ----------------------------------------------------------------------------------------------
58 *
59 * MULTICAST ACKNOWLEDGEMENT
60 *
61 * flit 1
62 * ----------------------------------------------------------------------------------------------
63 * EOP:1 |     DEST(10 bits)     |       X(15 bits)       | UPDT_INDEX(4 bits) | TYPE:0b00 | BC:0
64 * ----------------------------------------------------------------------------------------------
65 */
66
67/*
68 * M2P command packets
69 *
70 * MULTICAST UPDATE
71 *
72 * flit 1
73 * ----------------------------------------------------------------------------------------------
74 * EOP:0 | DEST(14 bits) | X(4 bits) | MEMC_ID(14 bits) | UPDT_INDEX(4 bits) | TYPE:0b0X   | BC:0
75 * ----------------------------------------------------------------------------------------------
76 *                                                                           | X: 0 DATA   |
77 *                                                                           |    1 INST   |
78 * flit 2
79 * ----------------------------------------------------------------------------------------------
80 * EOP:0 | X | WORD_INDEX(4 bits)  |                                             NLINE (34 bits)
81 * ----------------------------------------------------------------------------------------------
82 *
83 * flit 3
84 * ----------------------------------------------------------------------------------------------
85 * EOP:0 | X(3 bits)  | BE(4 bits) |                                              WDATA(32 bits)
86 * ----------------------------------------------------------------------------------------------
87 *
88 * flit N
89 * ----------------------------------------------------------------------------------------------
90 * EOP:1 | X(3 bits)  | BE(4 bits) |                                              WDATA(32 bits)
91 * ----------------------------------------------------------------------------------------------
92 *
93 * MULTICAST INVALIDATE
94 *
95 * flit 1
96 * ----------------------------------------------------------------------------------------------
97 * EOP:0 | DEST(14 bits) | X(4 bits) | MEMC_ID(14 bits) | UPDT_INDEX(4 bits) | TYPE:0b1X  | BC:0
98 * ----------------------------------------------------------------------------------------------
99 *                                                                           | X: 0 DATA  |
100 *                                                                           |    1 INST  |
101 * flit 2
102 * ----------------------------------------------------------------------------------------------
103 * EOP:1 | X(5 bits) |                                                           NLINE (34 bits)
104 * ----------------------------------------------------------------------------------------------
105 *
106 * BROADCAST INVALIDATE
107 *
108 * flit 1
109 *       | BOUNDING BOX(20 bits)            |
110 * ----------------------------------------------------------------------------------------------
111 * EOP:0 | XMIN   | XMAX   | YMIN   | YMAX  | MEMC_ID(14 bits) | NETWORK_RESERVED(4 bits) | BC:1
112 * ----------------------------------------------------------------------------------------------
113 *
114 * flit 2
115 * ----------------------------------------------------------------------------------------------
116 * EOP:1 |        X(5 bits)       |                                              NLINE (34 bits)
117 * ----------------------------------------------------------------------------------------------
118 *
119 * M2P clack commands
120 *
121 * CLEANUP ACKNOWLEDGEMENT
122 *
123 * flit 1
124 * ----------------------------------------------------------------------------------------------
125 * EOP:1 | DEST(14 bits) | X(5 bits) | SET_INDEX(16 bits) | WAY_INDEX(2 bits) | TYPE:0bX   | BC:0
126 * ----------------------------------------------------------------------------------------------
127 *                                                                            | X: 0 CLACK |
128 *                                                                            |      DATA  |
129 *                                                                            |    1 CLACK |
130 *                                                                            |      INST  |
131 *
132 */
133
134/*
135 * Utility MACROS
136 */
137#define GET_FIELD(x,y)\
138    case y: return ((x >> y##_SHIFT) & y##_MASK)
139
140#define SET_FIELD(x,y,z)\
141    case z: x |= ((y & z##_MASK) << z##_SHIFT);break
142
143class DspinDhccpParam
144{
145  public:
146
147    static const uint8_t  m2p_flit_width               = 40;
148    static const uint8_t  p2m_flit_width               = 33;
149    static const uint8_t  clack_flit_width             = 40;
150
151    static const uint8_t  UPDT_INDEX_WIDTH             = 4;
152    static const uint8_t  NLINE_WIDTH                  = 34;
153    static const uint8_t  SRCID_WIDTH                  = 14;
154    static const uint8_t  GLOBALID_WIDTH               = 10;
155    static const uint8_t  WORD_INDEX_WIDTH             = 4;
156    static const uint8_t  BE_WIDTH                     = 4;
157    static const uint8_t  DATA_WIDTH                   = 32;
158    static const uint8_t  SET_INDEX_WIDTH              = 16;
159    static const uint8_t  WAY_INDEX_WIDTH              = 2;
160    static const uint8_t  BROADCAST_BOX_WIDTH          = 20;
161    static const uint8_t  M2P_TYPE_WIDTH               = 2;
162    static const uint8_t  P2M_TYPE_WIDTH               = 2;
163    static const uint8_t  CLACK_TYPE_WIDTH             = 1;
164
165    static const uint8_t  P2M_TYPE_SHIFT               = 1;
166    static const uint64_t P2M_TYPE_MASK                = ((1ULL<<P2M_TYPE_WIDTH)-1);
167    static const uint8_t  P2M_EOP_SHIFT                = 32;
168    static const uint64_t P2M_EOP_MASK                 = 1;
169    static const uint8_t  P2M_BC_SHIFT                 = 0;
170    static const uint64_t P2M_BC_MASK                  = 1;
171
172    static const uint8_t  CLEANUP_DEST_SHIFT           = 22;
173    static const uint64_t CLEANUP_DEST_MASK            = ((1ULL<<GLOBALID_WIDTH)-1);
174    static const uint8_t  CLEANUP_SRCID_SHIFT          = 8;
175    static const uint64_t CLEANUP_SRCID_MASK           = ((1ULL<<SRCID_WIDTH)-1);
176    static const uint8_t  CLEANUP_NLINE_MSB_SHIFT      = 6;
177    static const uint64_t CLEANUP_NLINE_MSB_MASK       = ((1ULL<< 2)-1);
178    static const uint8_t  CLEANUP_WAY_INDEX_SHIFT      = 3;
179    static const uint64_t CLEANUP_WAY_INDEX_MASK       = ((1ULL<<WAY_INDEX_WIDTH)-1);
180    static const uint8_t  CLEANUP_NLINE_LSB_SHIFT      = 0;
181    static const uint64_t CLEANUP_NLINE_LSB_MASK       = ((1ULL<<32)-1);
182    static const uint8_t  CLEANUP_DATA_UPDT_SHIFT      = 0;
183    static const uint64_t CLEANUP_DATA_UPDT_MASK       = ((1ULL<<32)-1);
184    static const uint8_t  CLEANUP_NCC_SHIFT  = 5;
185    static const uint64_t CLEANUP_NCC_MASK   = 1;
186
187    static const uint8_t  MULTI_ACK_DEST_SHIFT         = CLEANUP_DEST_SHIFT;
188    static const uint64_t MULTI_ACK_DEST_MASK          = CLEANUP_DEST_MASK;
189    static const uint8_t  MULTI_ACK_UPDT_INDEX_SHIFT   = 3;
190    static const uint64_t MULTI_ACK_UPDT_INDEX_MASK    = ((1ULL<<UPDT_INDEX_WIDTH)-1);
191
192    static const uint8_t  M2P_TYPE_SHIFT               = 1;
193    static const uint64_t M2P_TYPE_MASK                = ((1ULL<<M2P_TYPE_WIDTH)-1);
194    static const uint8_t  M2P_EOP_SHIFT                = 39;
195    static const uint64_t M2P_EOP_MASK                 = 1;
196    static const uint8_t  M2P_BC_SHIFT                 = 0;
197    static const uint64_t M2P_BC_MASK                  = 1;
198
199    static const uint8_t  MULTI_INVAL_DEST_SHIFT       = 25;
200    static const uint64_t MULTI_INVAL_DEST_MASK        = ((1ULL<<SRCID_WIDTH)-1);
201    static const uint8_t  MULTI_INVAL_SRCID_SHIFT      = 8;
202    static const uint64_t MULTI_INVAL_SRCID_MASK       = ((1ULL<<SRCID_WIDTH)-1);
203    static const uint8_t  MULTI_INVAL_UPDT_INDEX_SHIFT = 4;
204    static const uint64_t MULTI_INVAL_UPDT_INDEX_MASK  = ((1ULL<<UPDT_INDEX_WIDTH)-1);
205    static const uint8_t  MULTI_INVAL_NLINE_SHIFT      = 0;
206    static const uint64_t MULTI_INVAL_NLINE_MASK       = ((1ULL<<NLINE_WIDTH)-1);
207
208    static const uint8_t  MULTI_UPDT_DEST_SHIFT        = MULTI_INVAL_DEST_SHIFT;
209    static const uint64_t MULTI_UPDT_DEST_MASK         = MULTI_INVAL_DEST_MASK;
210    static const uint8_t  MULTI_UPDT_SRCID_SHIFT       = MULTI_INVAL_SRCID_SHIFT;
211    static const uint64_t MULTI_UPDT_SRCID_MASK        = MULTI_INVAL_SRCID_MASK;
212    static const uint8_t  MULTI_UPDT_UPDT_INDEX_SHIFT  = MULTI_INVAL_UPDT_INDEX_SHIFT;
213    static const uint64_t MULTI_UPDT_UPDT_INDEX_MASK   = MULTI_INVAL_UPDT_INDEX_MASK;
214    static const uint8_t  MULTI_UPDT_WORD_INDEX_SHIFT  = 34;
215    static const uint64_t MULTI_UPDT_WORD_INDEX_MASK   = ((1ULL<<WORD_INDEX_WIDTH)-1);
216    static const uint8_t  MULTI_UPDT_NLINE_SHIFT       = MULTI_INVAL_NLINE_SHIFT;
217    static const uint64_t MULTI_UPDT_NLINE_MASK        = MULTI_INVAL_NLINE_MASK;
218    static const uint8_t  MULTI_UPDT_BE_SHIFT          = 32;
219    static const uint64_t MULTI_UPDT_BE_MASK           = ((1ULL<<BE_WIDTH)-1);
220    static const uint8_t  MULTI_UPDT_DATA_SHIFT        = 0;
221    static const uint64_t MULTI_UPDT_DATA_MASK         = ((1ULL<<DATA_WIDTH)-1);
222
223    static const uint8_t  BROADCAST_BOX_SHIFT          = 19;
224    static const uint64_t BROADCAST_BOX_MASK           = ((1ULL<<BROADCAST_BOX_WIDTH)-1);
225    static const uint8_t  BROADCAST_SRCID_SHIFT        = 5;
226    static const uint64_t BROADCAST_SRCID_MASK         = MULTI_INVAL_SRCID_MASK;
227    static const uint8_t  BROADCAST_NLINE_SHIFT        = 0;
228    static const uint64_t BROADCAST_NLINE_MASK         = MULTI_INVAL_NLINE_MASK;
229
230    static const uint8_t  CLACK_TYPE_SHIFT             = 1;
231    static const uint64_t CLACK_TYPE_MASK              = ((1ULL<<CLACK_TYPE_WIDTH)-1);
232    static const uint8_t  CLACK_EOP_SHIFT              = 39;
233    static const uint64_t CLACK_EOP_MASK               = 1;
234    static const uint8_t  CLACK_BC_SHIFT               = 0;
235    static const uint64_t CLACK_BC_MASK                = 1;
236    static const uint8_t  CLACK_DEST_SHIFT             = 25;
237    static const uint64_t CLACK_DEST_MASK              = ((1ULL<<SRCID_WIDTH)-1);
238    static const uint8_t  CLACK_SET_SHIFT              = 6;
239    static const uint64_t CLACK_SET_MASK               = ((1ULL<<SET_INDEX_WIDTH)-1);
240    static const uint8_t  CLACK_WAY_SHIFT              = 4;
241    static const uint64_t CLACK_WAY_MASK               = ((1ULL<<WAY_INDEX_WIDTH)-1);
242
243    /*
244     * P2M command types
245     */
246    enum
247    {
248      TYPE_MULTI_ACK    = 0,
249      TYPE_CLEANUP      = 2,
250      TYPE_CLEANUP_DATA = TYPE_CLEANUP,
251      TYPE_CLEANUP_INST = 3
252    };
253
254    /*
255     * M2P command types
256     */
257    enum
258    {
259      TYPE_MULTI_UPDT       = 0,
260      TYPE_MULTI_UPDT_DATA  = TYPE_MULTI_UPDT,
261      TYPE_MULTI_UPDT_INST  = 1,
262      TYPE_MULTI_INVAL      = 2,
263      TYPE_MULTI_INVAL_DATA = TYPE_MULTI_INVAL,
264      TYPE_MULTI_INVAL_INST = 3
265    };
266
267    /*
268     * CLACK command types
269     */
270    enum
271    {
272      TYPE_CLACK      = 0,
273      TYPE_CLACK_DATA = TYPE_CLACK,
274      TYPE_CLACK_INST = 1
275    };
276
277    enum flit_field_e
278    {
279      P2M_TYPE,
280      P2M_EOP,
281      P2M_BC,
282
283      CLEANUP_DEST,
284      CLEANUP_SRCID,
285      CLEANUP_NLINE_MSB,
286      CLEANUP_WAY_INDEX,
287      CLEANUP_NLINE_LSB,
288      CLEANUP_DATA_UPDT,
289      CLEANUP_NCC,
290
291      MULTI_ACK_DEST,
292      MULTI_ACK_UPDT_INDEX,
293
294      M2P_TYPE,
295      M2P_EOP,
296      M2P_BC,
297
298      MULTI_INVAL_DEST,
299      MULTI_INVAL_SRCID,
300      MULTI_INVAL_UPDT_INDEX,
301      MULTI_INVAL_NLINE,
302
303      MULTI_UPDT_DEST,
304      MULTI_UPDT_SRCID,
305      MULTI_UPDT_UPDT_INDEX,
306      MULTI_UPDT_WORD_INDEX,
307      MULTI_UPDT_NLINE,
308      MULTI_UPDT_BE,
309      MULTI_UPDT_DATA,
310
311      CLACK_TYPE,
312
313      CLACK_DEST,
314      CLACK_SET,
315      CLACK_WAY,
316
317      BROADCAST_BOX,
318      BROADCAST_SRCID,
319      BROADCAST_NLINE
320    };
321
322    static uint64_t dspin_get(uint64_t flit, flit_field_e field)
323    {
324      switch(field)
325      {
326        GET_FIELD(flit,P2M_TYPE);
327        GET_FIELD(flit,P2M_EOP);
328        GET_FIELD(flit,P2M_BC);
329        GET_FIELD(flit,CLEANUP_DEST);
330        GET_FIELD(flit,CLEANUP_SRCID);
331        GET_FIELD(flit,CLEANUP_NLINE_MSB);
332        GET_FIELD(flit,CLEANUP_WAY_INDEX);
333        GET_FIELD(flit,CLEANUP_NLINE_LSB);
334        GET_FIELD(flit,CLEANUP_DATA_UPDT);
335        GET_FIELD(flit,CLEANUP_NCC);
336        GET_FIELD(flit,MULTI_ACK_DEST);
337        GET_FIELD(flit,MULTI_ACK_UPDT_INDEX);
338        GET_FIELD(flit,M2P_TYPE);
339        GET_FIELD(flit,M2P_EOP);
340        GET_FIELD(flit,M2P_BC);
341        GET_FIELD(flit,MULTI_INVAL_DEST);
342        GET_FIELD(flit,MULTI_INVAL_SRCID);
343        GET_FIELD(flit,MULTI_INVAL_UPDT_INDEX);
344        GET_FIELD(flit,MULTI_INVAL_NLINE);
345        GET_FIELD(flit,MULTI_UPDT_DEST);
346        GET_FIELD(flit,MULTI_UPDT_SRCID);
347        GET_FIELD(flit,MULTI_UPDT_UPDT_INDEX);
348        GET_FIELD(flit,MULTI_UPDT_WORD_INDEX);
349        GET_FIELD(flit,MULTI_UPDT_NLINE);
350        GET_FIELD(flit,MULTI_UPDT_BE);
351        GET_FIELD(flit,MULTI_UPDT_DATA);
352        GET_FIELD(flit,CLACK_TYPE);
353        GET_FIELD(flit,CLACK_DEST);
354        GET_FIELD(flit,CLACK_SET);
355        GET_FIELD(flit,CLACK_WAY);
356        GET_FIELD(flit,BROADCAST_BOX);
357        GET_FIELD(flit,BROADCAST_SRCID);
358        GET_FIELD(flit,BROADCAST_NLINE);
359
360        default: assert(false && "Incorrect DHCCP DSPIN field");
361      }
362    }
363
364    static void dspin_set(uint64_t &flit, uint64_t value, flit_field_e field)
365    {
366      switch(field)
367      {
368        SET_FIELD(flit,value,P2M_TYPE);
369        SET_FIELD(flit,value,P2M_EOP);
370        SET_FIELD(flit,value,P2M_BC);
371        SET_FIELD(flit,value,CLEANUP_DEST);
372        SET_FIELD(flit,value,CLEANUP_SRCID);
373        SET_FIELD(flit,value,CLEANUP_NLINE_MSB);
374        SET_FIELD(flit,value,CLEANUP_WAY_INDEX);
375        SET_FIELD(flit,value,CLEANUP_NLINE_LSB);
376        SET_FIELD(flit,value,CLEANUP_DATA_UPDT);
377        SET_FIELD(flit,value,CLEANUP_NCC);
378        SET_FIELD(flit,value,MULTI_ACK_DEST);
379        SET_FIELD(flit,value,MULTI_ACK_UPDT_INDEX);
380        SET_FIELD(flit,value,M2P_TYPE);
381        SET_FIELD(flit,value,M2P_EOP);
382        SET_FIELD(flit,value,M2P_BC);
383        SET_FIELD(flit,value,MULTI_INVAL_DEST);
384        SET_FIELD(flit,value,MULTI_INVAL_SRCID);
385        SET_FIELD(flit,value,MULTI_INVAL_UPDT_INDEX);
386        SET_FIELD(flit,value,MULTI_INVAL_NLINE);
387        SET_FIELD(flit,value,MULTI_UPDT_DEST);
388        SET_FIELD(flit,value,MULTI_UPDT_SRCID);
389        SET_FIELD(flit,value,MULTI_UPDT_UPDT_INDEX);
390        SET_FIELD(flit,value,MULTI_UPDT_WORD_INDEX);
391        SET_FIELD(flit,value,MULTI_UPDT_NLINE);
392        SET_FIELD(flit,value,MULTI_UPDT_BE);
393        SET_FIELD(flit,value,MULTI_UPDT_DATA);
394        SET_FIELD(flit,value,CLACK_TYPE);
395        SET_FIELD(flit,value,CLACK_DEST);
396        SET_FIELD(flit,value,CLACK_SET);
397        SET_FIELD(flit,value,CLACK_WAY);
398        SET_FIELD(flit,value,BROADCAST_BOX);
399        SET_FIELD(flit,value,BROADCAST_SRCID);
400        SET_FIELD(flit,value,BROADCAST_NLINE);
401
402        default: assert(false && "Incorrect DHCCP DSPIN field");
403      }
404    }
405};
406
407#undef GET_FIELD
408#undef SET_FIELD
409
410}} // end namespace soclib::caba
411
412#endif
413// Local Variables:
414// tab-width: 2
415// c-basic-offset: 2
416// c-file-offsets:((innamespace . 0)(inline-open . 0))
417// indent-tabs-mode: nil
418// End:
419
420// vim: filetype=cpp:expandtab:shiftwidth=2:tabstop=2:softtabstop=2
Note: See TracBrowser for help on using the repository browser.