source: branches/reconfiguration/communication/dspin_dhccp_param/caba/source/include/dspin_dhccp_param.h @ 864

Last change on this file since 864 was 864, checked in by cfuguet, 10 years ago

reconf: introducing TEST packets for the coherence network

  • Introducing TEST packets for: P2M, M2P and CLACK subnetworks
  • In the case of P2M packets, to distinguish a Test packet, the P2M type should be 11 (the same as CLEANUP INST) and additionally the 5th bit must be set.
  • In the case of M2P and CLACK packets, the 25th bit is the only bit decoded to distinguish a Test packet.
File size: 18.6 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)| X | 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:1 |                                                                         NLINE(32 bits)
52 * ----------------------------------------------------------------------------------------------
53 *
54 * MULTICAST ACKNOWLEDGEMENT
55 *
56 * flit 1
57 * ----------------------------------------------------------------------------------------------
58 * EOP:1 |     DEST(10 bits)     |       X(15 bits)       | UPDT_INDEX(4 bits) | TYPE:0b00 | BC:0
59 * ----------------------------------------------------------------------------------------------
60 *
61 * TEST
62 *
63 *
64 * flit 1
65 * ----------------------------------------------------------------------------------------------
66 * EOP:0 |    DEST     |    SRCID    |      X       |   TEST  |       X       | TYPE:0b11 | BC:0
67 *       |  (10 bits)  |  (14 bits)  |   (2 bits)   | (1 bit) |    (2 bits)   |           |
68 * ----------------------------------------------------------------------------------------------
69 *
70 * flit 2
71 * ----------------------------------------------------------------------------------------------
72 * EOP:1 |                                                                     SIGNATURE(32 bits)
73 * ----------------------------------------------------------------------------------------------
74 */
75
76/*
77 * M2P command packets
78 *
79 * MULTICAST UPDATE
80 *
81 * flit 1
82 * ----------------------------------------------------------------------------------------------
83 * EOP:0 | DEST(14 bits) | X(4 bits) | MEMC_ID(14 bits) | UPDT_INDEX(4 bits) | TYPE:0b0X   | BC:0
84 * ----------------------------------------------------------------------------------------------
85 *                                                                           | X: 0 DATA   |
86 *                                                                           |    1 INST   |
87 * flit 2
88 * ----------------------------------------------------------------------------------------------
89 * EOP:0 | X | WORD_INDEX(4 bits)  |                                             NLINE (34 bits)
90 * ----------------------------------------------------------------------------------------------
91 *
92 * flit 3
93 * ----------------------------------------------------------------------------------------------
94 * EOP:0 | X(3 bits)  | BE(4 bits) |                                              WDATA(32 bits)
95 * ----------------------------------------------------------------------------------------------
96 *
97 * flit N
98 * ----------------------------------------------------------------------------------------------
99 * EOP:1 | X(3 bits)  | BE(4 bits) |                                              WDATA(32 bits)
100 * ----------------------------------------------------------------------------------------------
101 *
102 * MULTICAST INVALIDATE
103 *
104 * flit 1
105 * ----------------------------------------------------------------------------------------------
106 * EOP:0 | DEST(14 bits) | X(4 bits) | MEMC_ID(14 bits) | UPDT_INDEX(4 bits) | TYPE:0b1X  | BC:0
107 * ----------------------------------------------------------------------------------------------
108 *                                                                           | X: 0 DATA  |
109 *                                                                           |    1 INST  |
110 * flit 2
111 * ----------------------------------------------------------------------------------------------
112 * EOP:1 | X(5 bits) |                                                           NLINE (34 bits)
113 * ----------------------------------------------------------------------------------------------
114 *
115 * BROADCAST INVALIDATE
116 *
117 * flit 1
118 *       | BOUNDING BOX(20 bits)            |
119 * ----------------------------------------------------------------------------------------------
120 * EOP:0 | XMIN   | XMAX   | YMIN   | YMAX  | MEMC_ID(14 bits) | NETWORK_RESERVED(4 bits) | BC:1
121 * ----------------------------------------------------------------------------------------------
122 *
123 * flit 2
124 * ----------------------------------------------------------------------------------------------
125 * EOP:1 |        X(5 bits)       |                                              NLINE (34 bits)
126 * ----------------------------------------------------------------------------------------------
127 *
128 * TEST
129 *
130 * flit 1
131 * ----------------------------------------------------------------------------------------------
132 * EOP:0 |  DEST(14 bits)  | TEST: 1      | X(3 bits)  |  MEMC_ID(14 bits)  | X(10 bits)  | BC:0
133 * ----------------------------------------------------------------------------------------------
134 *
135 * flit 2
136 * ----------------------------------------------------------------------------------------------
137 * EOP:1 | SIGNATURE MSB(7 bits) |                                           SIGNATURE (32 bits)
138 * ----------------------------------------------------------------------------------------------
139 *
140 * CLACK commands
141 *
142 * CLEANUP ACKNOWLEDGEMENT
143 *
144 * flit 1
145 * ----------------------------------------------------------------------------------------------
146 * EOP:1 | DEST(14 bits) | X(5 bits) | SET_INDEX(16 bits) | WAY_INDEX(2 bits) | TYPE:0bX   | BC:0
147 * ----------------------------------------------------------------------------------------------
148 *                                                                            | X: 0 CLACK |
149 *                                                                            |      DATA  |
150 *                                                                            |    1 CLACK |
151 *                                                                            |      INST  |
152 * TEST
153 *
154 * flit 1
155 * ----------------------------------------------------------------------------------------------
156 * EOP:0 |  DEST(14 bits)  | TEST:1  | X(3 bits)  |  MEMC_ID(14 bits)  | X(10 bits)  | BC:0
157 * ----------------------------------------------------------------------------------------------
158 *
159 * flit 2
160 * ----------------------------------------------------------------------------------------------
161 * EOP:1 | SIGNATURE MSB(7 bits) |                                           SIGNATURE (32 bits)
162 * ----------------------------------------------------------------------------------------------
163 *
164 *
165 */
166
167/*
168 * Utility MACROS
169 */
170#define GET_FIELD(x,y)\
171    case y: return ((x >> y##_SHIFT) & y##_MASK)
172
173#define SET_FIELD(x,y,z)\
174    case z: x |= ((y & z##_MASK) << z##_SHIFT);break
175
176class DspinDhccpParam
177{
178  public:
179
180    static const uint8_t  m2p_flit_width               = 40;
181    static const uint8_t  p2m_flit_width               = 33;
182    static const uint8_t  clack_flit_width             = 40;
183
184    static const uint8_t  UPDT_INDEX_WIDTH             = 4;
185    static const uint8_t  NLINE_WIDTH                  = 34;
186    static const uint8_t  SRCID_WIDTH                  = 14;
187    static const uint8_t  GLOBALID_WIDTH               = 10;
188    static const uint8_t  WORD_INDEX_WIDTH             = 4;
189    static const uint8_t  BE_WIDTH                     = 4;
190    static const uint8_t  DATA_WIDTH                   = 32;
191    static const uint8_t  SET_INDEX_WIDTH              = 6;
192    static const uint8_t  WAY_INDEX_WIDTH              = 2;
193    static const uint8_t  BROADCAST_BOX_WIDTH          = 20;
194    static const uint8_t  M2P_TYPE_WIDTH               = 2;
195    static const uint8_t  P2M_TYPE_WIDTH               = 2;
196    static const uint8_t  CLACK_TYPE_WIDTH             = 1;
197
198    static const uint8_t  P2M_TYPE_SHIFT               = 1;
199    static const uint64_t P2M_TYPE_MASK                = ((1ULL<<P2M_TYPE_WIDTH)-1);
200    static const uint8_t  P2M_EOP_SHIFT                = 32;
201    static const uint64_t P2M_EOP_MASK                 = 1;
202    static const uint8_t  P2M_BC_SHIFT                 = 0;
203    static const uint64_t P2M_BC_MASK                  = 1;
204    static const uint8_t  P2M_TEST_SHIFT               = 5;
205    static const uint64_t P2M_TEST_MASK                = 1;
206
207    static const uint8_t  CLEANUP_DEST_SHIFT           = 22;
208    static const uint64_t CLEANUP_DEST_MASK            = ((1ULL<<GLOBALID_WIDTH)-1);
209    static const uint8_t  CLEANUP_SRCID_SHIFT          = 8;
210    static const uint64_t CLEANUP_SRCID_MASK           = ((1ULL<<SRCID_WIDTH)-1);
211    static const uint8_t  CLEANUP_NLINE_MSB_SHIFT      = 6;
212    static const uint64_t CLEANUP_NLINE_MSB_MASK       = ((1ULL<< 2)-1);
213    static const uint8_t  CLEANUP_WAY_INDEX_SHIFT      = 3;
214    static const uint64_t CLEANUP_WAY_INDEX_MASK       = ((1ULL<<WAY_INDEX_WIDTH)-1);
215    static const uint8_t  CLEANUP_NLINE_LSB_SHIFT      = 0;
216    static const uint64_t CLEANUP_NLINE_LSB_MASK       = ((1ULL<<32)-1);
217
218    static const uint8_t  MULTI_ACK_DEST_SHIFT         = CLEANUP_DEST_SHIFT;
219    static const uint64_t MULTI_ACK_DEST_MASK          = CLEANUP_DEST_MASK;
220    static const uint8_t  MULTI_ACK_UPDT_INDEX_SHIFT   = 3;
221    static const uint64_t MULTI_ACK_UPDT_INDEX_MASK    = ((1ULL<<UPDT_INDEX_WIDTH)-1);
222
223    static const uint8_t  M2P_TYPE_SHIFT               = 1;
224    static const uint64_t M2P_TYPE_MASK                = ((1ULL<<M2P_TYPE_WIDTH)-1);
225    static const uint8_t  M2P_EOP_SHIFT                = 39;
226    static const uint64_t M2P_EOP_MASK                 = 1;
227    static const uint8_t  M2P_BC_SHIFT                 = 0;
228    static const uint64_t M2P_BC_MASK                  = 1;
229    static const uint8_t  M2P_TEST_SHIFT               = 24;
230    static const uint64_t M2P_TEST_MASK                = 1;
231
232    static const uint8_t  MULTI_INVAL_DEST_SHIFT       = 25;
233    static const uint64_t MULTI_INVAL_DEST_MASK        = ((1ULL<<SRCID_WIDTH)-1);
234    static const uint8_t  MULTI_INVAL_SRCID_SHIFT      = 7;
235    static const uint64_t MULTI_INVAL_SRCID_MASK       = ((1ULL<<SRCID_WIDTH)-1);
236    static const uint8_t  MULTI_INVAL_UPDT_INDEX_SHIFT = 3;
237    static const uint64_t MULTI_INVAL_UPDT_INDEX_MASK  = ((1ULL<<UPDT_INDEX_WIDTH)-1);
238    static const uint8_t  MULTI_INVAL_NLINE_SHIFT      = 0;
239    static const uint64_t MULTI_INVAL_NLINE_MASK       = ((1ULL<<NLINE_WIDTH)-1);
240
241    static const uint8_t  MULTI_UPDT_DEST_SHIFT        = MULTI_INVAL_DEST_SHIFT;
242    static const uint64_t MULTI_UPDT_DEST_MASK         = MULTI_INVAL_DEST_MASK;
243    static const uint8_t  MULTI_UPDT_SRCID_SHIFT       = MULTI_INVAL_SRCID_SHIFT;
244    static const uint64_t MULTI_UPDT_SRCID_MASK        = MULTI_INVAL_SRCID_MASK;
245    static const uint8_t  MULTI_UPDT_UPDT_INDEX_SHIFT  = MULTI_INVAL_UPDT_INDEX_SHIFT;
246    static const uint64_t MULTI_UPDT_UPDT_INDEX_MASK   = MULTI_INVAL_UPDT_INDEX_MASK;
247    static const uint8_t  MULTI_UPDT_WORD_INDEX_SHIFT  = 34;
248    static const uint64_t MULTI_UPDT_WORD_INDEX_MASK   = ((1ULL<<WORD_INDEX_WIDTH)-1);
249    static const uint8_t  MULTI_UPDT_NLINE_SHIFT       = MULTI_INVAL_NLINE_SHIFT;
250    static const uint64_t MULTI_UPDT_NLINE_MASK        = MULTI_INVAL_NLINE_MASK;
251    static const uint8_t  MULTI_UPDT_BE_SHIFT          = 32;
252    static const uint64_t MULTI_UPDT_BE_MASK           = ((1ULL<<BE_WIDTH)-1);
253    static const uint8_t  MULTI_UPDT_DATA_SHIFT        = 0;
254    static const uint64_t MULTI_UPDT_DATA_MASK         = ((1ULL<<DATA_WIDTH)-1);
255
256    static const uint8_t  BROADCAST_BOX_SHIFT          = 19;
257    static const uint64_t BROADCAST_BOX_MASK           = ((1ULL<<BROADCAST_BOX_WIDTH)-1);
258    static const uint8_t  BROADCAST_SRCID_SHIFT        = 5;
259    static const uint64_t BROADCAST_SRCID_MASK         = MULTI_INVAL_SRCID_MASK;
260    static const uint8_t  BROADCAST_NLINE_SHIFT        = 0;
261    static const uint64_t BROADCAST_NLINE_MASK         = MULTI_INVAL_NLINE_MASK;
262
263    static const uint8_t  CLACK_TYPE_SHIFT             = 1;
264    static const uint64_t CLACK_TYPE_MASK              = ((1ULL<<CLACK_TYPE_WIDTH)-1);
265    static const uint8_t  CLACK_EOP_SHIFT              = 39;
266    static const uint64_t CLACK_EOP_MASK               = 1;
267    static const uint8_t  CLACK_BC_SHIFT               = 0;
268    static const uint64_t CLACK_BC_MASK                = 1;
269    static const uint8_t  CLACK_DEST_SHIFT             = 25;
270    static const uint64_t CLACK_DEST_MASK              = ((1ULL<<SRCID_WIDTH)-1);
271    static const uint8_t  CLACK_SET_SHIFT              = 4;
272    static const uint64_t CLACK_SET_MASK               = ((1ULL<<SET_INDEX_WIDTH)-1);
273    static const uint8_t  CLACK_WAY_SHIFT              = 2;
274    static const uint64_t CLACK_WAY_MASK               = ((1ULL<<WAY_INDEX_WIDTH)-1);
275
276    /*
277     * P2M command types
278     */
279    enum
280    {
281      TYPE_MULTI_ACK    = 0,
282      TYPE_CLEANUP      = 2,
283      TYPE_CLEANUP_DATA = TYPE_CLEANUP,
284      TYPE_CLEANUP_INST = 3,
285      TYPE_TEST         = TYPE_CLEANUP_INST
286    };
287
288    /*
289     * M2P command types
290     */
291    enum
292    {
293      TYPE_MULTI_UPDT       = 0,
294      TYPE_MULTI_UPDT_DATA  = TYPE_MULTI_UPDT,
295      TYPE_MULTI_UPDT_INST  = 1,
296      TYPE_MULTI_INVAL      = 2,
297      TYPE_MULTI_INVAL_DATA = TYPE_MULTI_INVAL,
298      TYPE_MULTI_INVAL_INST = 3
299    };
300
301    /*
302     * CLACK command types
303     */
304    enum
305    {
306      TYPE_CLACK      = 0,
307      TYPE_CLACK_DATA = TYPE_CLACK,
308      TYPE_CLACK_INST = 1
309    };
310
311    enum flit_field_e
312    {
313      P2M_TYPE,
314      P2M_EOP,
315      P2M_BC,
316      P2M_TEST,
317
318      CLEANUP_DEST,
319      CLEANUP_SRCID,
320      CLEANUP_NLINE_MSB,
321      CLEANUP_WAY_INDEX,
322      CLEANUP_NLINE_LSB,
323
324      MULTI_ACK_DEST,
325      MULTI_ACK_UPDT_INDEX,
326
327      M2P_TYPE,
328      M2P_EOP,
329      M2P_BC,
330      M2P_TEST,
331
332      MULTI_INVAL_DEST,
333      MULTI_INVAL_SRCID,
334      MULTI_INVAL_UPDT_INDEX,
335      MULTI_INVAL_NLINE,
336
337      MULTI_UPDT_DEST,
338      MULTI_UPDT_SRCID,
339      MULTI_UPDT_UPDT_INDEX,
340      MULTI_UPDT_WORD_INDEX,
341      MULTI_UPDT_NLINE,
342      MULTI_UPDT_BE,
343      MULTI_UPDT_DATA,
344
345      CLACK_TYPE,
346
347      CLACK_DEST,
348      CLACK_SET,
349      CLACK_WAY,
350
351      BROADCAST_BOX,
352      BROADCAST_SRCID,
353      BROADCAST_NLINE
354    };
355
356    static uint64_t dspin_get(uint64_t flit, flit_field_e field)
357    {
358      switch(field)
359      {
360        GET_FIELD(flit,P2M_TYPE);
361        GET_FIELD(flit,P2M_EOP);
362        GET_FIELD(flit,P2M_BC);
363        GET_FIELD(flit,P2M_TEST);
364        GET_FIELD(flit,CLEANUP_DEST);
365        GET_FIELD(flit,CLEANUP_SRCID);
366        GET_FIELD(flit,CLEANUP_NLINE_MSB);
367        GET_FIELD(flit,CLEANUP_WAY_INDEX);
368        GET_FIELD(flit,CLEANUP_NLINE_LSB);
369        GET_FIELD(flit,MULTI_ACK_DEST);
370        GET_FIELD(flit,MULTI_ACK_UPDT_INDEX);
371        GET_FIELD(flit,M2P_TYPE);
372        GET_FIELD(flit,M2P_EOP);
373        GET_FIELD(flit,M2P_BC);
374        GET_FIELD(flit,M2P_TEST);
375        GET_FIELD(flit,MULTI_INVAL_DEST);
376        GET_FIELD(flit,MULTI_INVAL_SRCID);
377        GET_FIELD(flit,MULTI_INVAL_UPDT_INDEX);
378        GET_FIELD(flit,MULTI_INVAL_NLINE);
379        GET_FIELD(flit,MULTI_UPDT_DEST);
380        GET_FIELD(flit,MULTI_UPDT_SRCID);
381        GET_FIELD(flit,MULTI_UPDT_UPDT_INDEX);
382        GET_FIELD(flit,MULTI_UPDT_WORD_INDEX);
383        GET_FIELD(flit,MULTI_UPDT_NLINE);
384        GET_FIELD(flit,MULTI_UPDT_BE);
385        GET_FIELD(flit,MULTI_UPDT_DATA);
386        GET_FIELD(flit,CLACK_TYPE);
387        GET_FIELD(flit,CLACK_DEST);
388        GET_FIELD(flit,CLACK_SET);
389        GET_FIELD(flit,CLACK_WAY);
390        GET_FIELD(flit,BROADCAST_BOX);
391        GET_FIELD(flit,BROADCAST_SRCID);
392        GET_FIELD(flit,BROADCAST_NLINE);
393
394        default: assert(false && "Incorrect DHCCP DSPIN field");
395      }
396    }
397
398    static void dspin_set(uint64_t &flit, uint64_t value, flit_field_e field)
399    {
400      switch(field)
401      {
402        SET_FIELD(flit,value,P2M_TYPE);
403        SET_FIELD(flit,value,P2M_EOP);
404        SET_FIELD(flit,value,P2M_BC);
405        SET_FIELD(flit,value,P2M_TEST);
406        SET_FIELD(flit,value,CLEANUP_DEST);
407        SET_FIELD(flit,value,CLEANUP_SRCID);
408        SET_FIELD(flit,value,CLEANUP_NLINE_MSB);
409        SET_FIELD(flit,value,CLEANUP_WAY_INDEX);
410        SET_FIELD(flit,value,CLEANUP_NLINE_LSB);
411        SET_FIELD(flit,value,MULTI_ACK_DEST);
412        SET_FIELD(flit,value,MULTI_ACK_UPDT_INDEX);
413        SET_FIELD(flit,value,M2P_TYPE);
414        SET_FIELD(flit,value,M2P_EOP);
415        SET_FIELD(flit,value,M2P_BC);
416        SET_FIELD(flit,value,M2P_TEST);
417        SET_FIELD(flit,value,MULTI_INVAL_DEST);
418        SET_FIELD(flit,value,MULTI_INVAL_SRCID);
419        SET_FIELD(flit,value,MULTI_INVAL_UPDT_INDEX);
420        SET_FIELD(flit,value,MULTI_INVAL_NLINE);
421        SET_FIELD(flit,value,MULTI_UPDT_DEST);
422        SET_FIELD(flit,value,MULTI_UPDT_SRCID);
423        SET_FIELD(flit,value,MULTI_UPDT_UPDT_INDEX);
424        SET_FIELD(flit,value,MULTI_UPDT_WORD_INDEX);
425        SET_FIELD(flit,value,MULTI_UPDT_NLINE);
426        SET_FIELD(flit,value,MULTI_UPDT_BE);
427        SET_FIELD(flit,value,MULTI_UPDT_DATA);
428        SET_FIELD(flit,value,CLACK_TYPE);
429        SET_FIELD(flit,value,CLACK_DEST);
430        SET_FIELD(flit,value,CLACK_SET);
431        SET_FIELD(flit,value,CLACK_WAY);
432        SET_FIELD(flit,value,BROADCAST_BOX);
433        SET_FIELD(flit,value,BROADCAST_SRCID);
434        SET_FIELD(flit,value,BROADCAST_NLINE);
435
436        default: assert(false && "Incorrect DHCCP DSPIN field");
437      }
438    }
439};
440
441#undef GET_FIELD
442#undef SET_FIELD
443
444}} // end namespace soclib::caba
445
446#endif
447// Local Variables:
448// tab-width: 2
449// c-basic-offset: 2
450// c-file-offsets:((innamespace . 0)(inline-open . 0))
451// indent-tabs-mode: nil
452// End:
453
454// vim: filetype=cpp:expandtab:shiftwidth=2:tabstop=2:softtabstop=2
Note: See TracBrowser for help on using the repository browser.