source: branches/v5/communication/dspin_dhccp_param/caba/source/include/dspin_dhccp_param.h @ 356

Last change on this file since 356 was 356, checked in by cfuguet, 11 years ago

Modifying comments in the dspin_dhccp_param to comply the type encoding defined
on the coherence infrastructure

File size: 15.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
62/*
63 * Memory Cache to L1 cache command packets
64 *
65 * CLEANUP ACKNOWLEDGEMENT
66 *
67 * flit 1
68 * ----------------------------------------------------------------------------------------------
69 * EOP:1 | DEST(14 bits) | X(3 bits) | SET_INDEX(16 bits) | WAY_INDEX(2 bits) | TYPE:0b10X | BC:0
70 * ----------------------------------------------------------------------------------------------
71 *                                                                            | X: 0 DATA  |
72 *                                                                            |    1 INST  |
73 *
74 * MULTICAST UPDATE
75 *
76 * flit 1
77 * ----------------------------------------------------------------------------------------------
78 * EOP:0 | DEST(14 bits) | X(3 bits) | MEMC_ID(14 bits) | UPDT_INDEX(4 bits) | TYPE:0b00X  | BC:0
79 * ----------------------------------------------------------------------------------------------
80 *                                                                           | X: 0 DATA   |
81 *                                                                           |    1 INST   |
82 * flit 2
83 * ----------------------------------------------------------------------------------------------
84 * EOP:0 | X | WORD_INDEX(4 bits)  |                                             NLINE (34 bits)
85 * ----------------------------------------------------------------------------------------------
86 *
87 * flit 3
88 * ----------------------------------------------------------------------------------------------
89 * EOP:0 | X(3 bits)  | BE(4 bits) |                                              WDATA(32 bits)
90 * ----------------------------------------------------------------------------------------------
91 *
92 * flit N
93 * ----------------------------------------------------------------------------------------------
94 * EOP:1 | X(3 bits)  | BE(4 bits) |                                              WDATA(32 bits)
95 * ----------------------------------------------------------------------------------------------
96 *
97 * MULTICAST INVALIDATE
98 *
99 * flit 1
100 * ----------------------------------------------------------------------------------------------
101 * EOP:0 | DEST(14 bits) | X(3 bits) | MEMC_ID(14 bits) | UPDT_INDEX(4 bits) | TYPE:0b01X | BC:0
102 * ----------------------------------------------------------------------------------------------
103 *                                                                           | X: 0 DATA  |
104 *                                                                           |    1 INST  |
105 * flit 2
106 * ----------------------------------------------------------------------------------------------
107 * EOP:1 | X(5 bits) |                                                           NLINE (34 bits)
108 * ----------------------------------------------------------------------------------------------
109 *
110 * BROADCAST INVALIDATE
111 *
112 * flit 1
113 *       | BOUNDING BOX(20 bits)            |
114 * ----------------------------------------------------------------------------------------------
115 * EOP:0 | XMIN   | XMAX   | YMIN   | YMAX  | MEMC_ID(14 bits) | NETWORK_RESERVED(4 bits) | BC:1
116 * ----------------------------------------------------------------------------------------------
117 *
118 * flit 2
119 * ----------------------------------------------------------------------------------------------
120 * EOP:1 |        X(5 bits)       |                                              NLINE (34 bits)
121 * ----------------------------------------------------------------------------------------------
122 */
123
124/*
125 * Utility MACROS
126 */
127#define GET_FIELD(x,y)\
128    case y: return ((x >> y##_SHIFT) & y##_MASK)
129
130#define SET_FIELD(x,y,z)\
131    case z: x |= ((y & z##_MASK) << z##_SHIFT);break
132
133class DspinDhccpParam
134{
135  public:
136
137    static const uint8_t  from_memc_flit_width         = 40;
138    static const uint8_t  from_l1_flit_width           = 33;
139
140    static const uint8_t  UPDT_INDEX_WIDTH             = 4;
141    static const uint8_t  NLINE_WIDTH                  = 34;
142    static const uint8_t  SRCID_WIDTH                  = 14;
143    static const uint8_t  GLOBALID_WIDTH               = 10;
144    static const uint8_t  WORD_INDEX_WIDTH             = 4;
145    static const uint8_t  BE_WIDTH                     = 4;
146    static const uint8_t  DATA_WIDTH                   = 32;
147    static const uint8_t  SET_INDEX_WIDTH              = 16;
148    static const uint8_t  WAY_INDEX_WIDTH              = 2;
149    static const uint8_t  BROADCAST_BOX_WIDTH          = 20;
150    static const uint8_t  MC_TYPE_WIDTH                = 3;
151    static const uint8_t  L1_TYPE_WIDTH                = 2;
152
153    static const uint8_t  FROM_L1_TYPE_SHIFT           = 1;
154    static const uint64_t FROM_L1_TYPE_MASK            = ((1ULL<<L1_TYPE_WIDTH)-1);
155    static const uint8_t  FROM_L1_EOP_SHIFT            = 32;
156    static const uint64_t FROM_L1_EOP_MASK             = 1;
157    static const uint8_t  FROM_L1_BC_SHIFT             = 0;
158    static const uint64_t FROM_L1_BC_MASK              = 1;
159
160    static const uint8_t  CLEANUP_DEST_SHIFT           = 22;
161    static const uint64_t CLEANUP_DEST_MASK            = ((1ULL<<GLOBALID_WIDTH)-1);
162    static const uint8_t  CLEANUP_SRCID_SHIFT          = 8;
163    static const uint64_t CLEANUP_SRCID_MASK           = ((1ULL<<SRCID_WIDTH)-1);
164    static const uint8_t  CLEANUP_NLINE_MSB_SHIFT      = 6;
165    static const uint64_t CLEANUP_NLINE_MSB_MASK       = ((1ULL<< 2)-1);
166    static const uint8_t  CLEANUP_WAY_INDEX_SHIFT      = 3;
167    static const uint64_t CLEANUP_WAY_INDEX_MASK       = ((1ULL<<WAY_INDEX_WIDTH)-1);
168    static const uint8_t  CLEANUP_NLINE_LSB_SHIFT      = 0;
169    static const uint64_t CLEANUP_NLINE_LSB_MASK       = ((1ULL<<32)-1);
170
171    static const uint8_t  MULTI_ACK_DEST_SHIFT         = CLEANUP_DEST_SHIFT;
172    static const uint64_t MULTI_ACK_DEST_MASK          = CLEANUP_DEST_MASK;
173    static const uint8_t  MULTI_ACK_UPDT_INDEX_SHIFT   = 3;
174    static const uint64_t MULTI_ACK_UPDT_INDEX_MASK    = ((1ULL<<UPDT_INDEX_WIDTH)-1);
175
176    static const uint8_t  FROM_MC_TYPE_SHIFT           = 1;
177    static const uint64_t FROM_MC_TYPE_MASK            = ((1ULL<<MC_TYPE_WIDTH)-1);
178    static const uint8_t  FROM_MC_EOP_SHIFT            = 39;
179    static const uint64_t FROM_MC_EOP_MASK             = 1;
180    static const uint8_t  FROM_MC_BC_SHIFT             = 0;
181    static const uint64_t FROM_MC_BC_MASK              = 1;
182
183    static const uint8_t  MULTI_INVAL_DEST_SHIFT       = 25;
184    static const uint64_t MULTI_INVAL_DEST_MASK        = ((1ULL<<SRCID_WIDTH)-1);
185    static const uint8_t  MULTI_INVAL_SRCID_SHIFT      = 8;
186    static const uint64_t MULTI_INVAL_SRCID_MASK       = ((1ULL<<SRCID_WIDTH)-1);
187    static const uint8_t  MULTI_INVAL_UPDT_INDEX_SHIFT = 4;
188    static const uint64_t MULTI_INVAL_UPDT_INDEX_MASK  = ((1ULL<<UPDT_INDEX_WIDTH)-1);
189    static const uint8_t  MULTI_INVAL_NLINE_SHIFT      = 0;
190    static const uint64_t MULTI_INVAL_NLINE_MASK       = ((1ULL<<NLINE_WIDTH)-1);
191
192    static const uint8_t  MULTI_UPDT_DEST_SHIFT        = MULTI_INVAL_DEST_SHIFT;
193    static const uint64_t MULTI_UPDT_DEST_MASK         = MULTI_INVAL_DEST_MASK;
194    static const uint8_t  MULTI_UPDT_SRCID_SHIFT       = MULTI_INVAL_SRCID_SHIFT;
195    static const uint64_t MULTI_UPDT_SRCID_MASK        = MULTI_INVAL_SRCID_MASK;
196    static const uint8_t  MULTI_UPDT_UPDT_INDEX_SHIFT  = MULTI_INVAL_UPDT_INDEX_SHIFT;
197    static const uint64_t MULTI_UPDT_UPDT_INDEX_MASK   = MULTI_INVAL_UPDT_INDEX_MASK;
198    static const uint8_t  MULTI_UPDT_WORD_INDEX_SHIFT  = 34;
199    static const uint64_t MULTI_UPDT_WORD_INDEX_MASK   = ((1ULL<<WORD_INDEX_WIDTH)-1);
200    static const uint8_t  MULTI_UPDT_NLINE_SHIFT       = MULTI_INVAL_NLINE_SHIFT;
201    static const uint64_t MULTI_UPDT_NLINE_MASK        = MULTI_INVAL_NLINE_MASK;
202    static const uint8_t  MULTI_UPDT_BE_SHIFT          = 32;
203    static const uint64_t MULTI_UPDT_BE_MASK           = ((1ULL<<BE_WIDTH)-1);
204    static const uint8_t  MULTI_UPDT_DATA_SHIFT        = 0;
205    static const uint64_t MULTI_UPDT_DATA_MASK         = ((1ULL<<DATA_WIDTH)-1);
206
207    static const uint8_t  CLEANUP_ACK_DEST_SHIFT       = MULTI_INVAL_DEST_SHIFT;
208    static const uint64_t CLEANUP_ACK_DEST_MASK        = MULTI_INVAL_DEST_MASK;
209    static const uint8_t  CLEANUP_ACK_SET_SHIFT        = 6;
210    static const uint64_t CLEANUP_ACK_SET_MASK         = ((1ULL<<SET_INDEX_WIDTH)-1);
211    static const uint8_t  CLEANUP_ACK_WAY_SHIFT        = 4;
212    static const uint64_t CLEANUP_ACK_WAY_MASK         = ((1ULL<<WAY_INDEX_WIDTH)-1);
213
214    static const uint8_t  BROADCAST_BOX_SHIFT          = 19;
215    static const uint64_t BROADCAST_BOX_MASK           = ((1ULL<<BROADCAST_BOX_WIDTH)-1);
216    static const uint8_t  BROADCAST_SRCID_SHIFT        = 5;
217    static const uint64_t BROADCAST_SRCID_MASK         = MULTI_INVAL_SRCID_MASK;
218    static const uint8_t  BROADCAST_NLINE_SHIFT        = 0;
219    static const uint64_t BROADCAST_NLINE_MASK         = MULTI_INVAL_NLINE_MASK;
220
221    /*
222     * L1 cache to Memory Cache command types
223     */
224    enum
225    {
226      TYPE_MULTI_ACK    = 0,
227      TYPE_CLEANUP      = 2,
228      TYPE_CLEANUP_DATA = TYPE_CLEANUP,
229      TYPE_CLEANUP_INST = 3
230    };
231
232    /*
233     * Memory Cache to L1 cache command types
234     */
235    enum
236    {
237      TYPE_MULTI_UPDT       = 0,
238      TYPE_MULTI_UPDT_DATA  = TYPE_MULTI_UPDT,
239      TYPE_MULTI_UPDT_INST  = 1,
240      TYPE_MULTI_INVAL      = 2,
241      TYPE_MULTI_INVAL_DATA = TYPE_MULTI_INVAL,
242      TYPE_MULTI_INVAL_INST = 3,
243      TYPE_CLEANUP_ACK      = 4,
244      TYPE_CLEANUP_ACK_DATA = TYPE_CLEANUP_ACK,
245      TYPE_CLEANUP_ACK_INST = 5
246    };
247
248    enum flit_field_e
249    {
250      FROM_L1_TYPE,
251      FROM_L1_EOP,
252      FROM_L1_BC,
253
254      CLEANUP_DEST,
255      CLEANUP_SRCID,
256      CLEANUP_NLINE_MSB,
257      CLEANUP_WAY_INDEX,
258      CLEANUP_NLINE_LSB,
259
260      MULTI_ACK_DEST,
261      MULTI_ACK_UPDT_INDEX,
262
263      FROM_MC_TYPE,
264      FROM_MC_EOP,
265      FROM_MC_BC,
266
267      MULTI_INVAL_DEST,
268      MULTI_INVAL_SRCID,
269      MULTI_INVAL_UPDT_INDEX,
270      MULTI_INVAL_NLINE,
271
272      MULTI_UPDT_DEST,
273      MULTI_UPDT_SRCID,
274      MULTI_UPDT_UPDT_INDEX,
275      MULTI_UPDT_WORD_INDEX,
276      MULTI_UPDT_NLINE,
277      MULTI_UPDT_BE,
278      MULTI_UPDT_DATA,
279
280      CLEANUP_ACK_DEST,
281      CLEANUP_ACK_SET,
282      CLEANUP_ACK_WAY,
283
284      BROADCAST_BOX,
285      BROADCAST_SRCID,
286      BROADCAST_NLINE
287    };
288
289    static uint64_t dspin_get(uint64_t flit, flit_field_e field)
290    {
291      switch(field)
292      {
293        GET_FIELD(flit,FROM_L1_TYPE);
294        GET_FIELD(flit,FROM_L1_EOP);
295        GET_FIELD(flit,FROM_L1_BC);
296        GET_FIELD(flit,CLEANUP_DEST);
297        GET_FIELD(flit,CLEANUP_SRCID);
298        GET_FIELD(flit,CLEANUP_NLINE_MSB);
299        GET_FIELD(flit,CLEANUP_WAY_INDEX);
300        GET_FIELD(flit,CLEANUP_NLINE_LSB);
301        GET_FIELD(flit,MULTI_ACK_DEST);
302        GET_FIELD(flit,MULTI_ACK_UPDT_INDEX);
303        GET_FIELD(flit,FROM_MC_TYPE);
304        GET_FIELD(flit,FROM_MC_EOP);
305        GET_FIELD(flit,FROM_MC_BC);
306        GET_FIELD(flit,MULTI_INVAL_DEST);
307        GET_FIELD(flit,MULTI_INVAL_SRCID);
308        GET_FIELD(flit,MULTI_INVAL_UPDT_INDEX);
309        GET_FIELD(flit,MULTI_INVAL_NLINE);
310        GET_FIELD(flit,MULTI_UPDT_DEST);
311        GET_FIELD(flit,MULTI_UPDT_SRCID);
312        GET_FIELD(flit,MULTI_UPDT_UPDT_INDEX);
313        GET_FIELD(flit,MULTI_UPDT_WORD_INDEX);
314        GET_FIELD(flit,MULTI_UPDT_NLINE);
315        GET_FIELD(flit,MULTI_UPDT_BE);
316        GET_FIELD(flit,MULTI_UPDT_DATA);
317        GET_FIELD(flit,CLEANUP_ACK_DEST);
318        GET_FIELD(flit,CLEANUP_ACK_SET);
319        GET_FIELD(flit,CLEANUP_ACK_WAY);
320        GET_FIELD(flit,BROADCAST_BOX);
321        GET_FIELD(flit,BROADCAST_SRCID);
322        GET_FIELD(flit,BROADCAST_NLINE);
323
324        default: assert(false && "Incorrect DHCCP DSPIN field");
325      }
326    }
327
328    static void dspin_set(uint64_t &flit, uint64_t value, flit_field_e field)
329    {
330      switch(field)
331      {
332        SET_FIELD(flit,value,FROM_L1_TYPE);
333        SET_FIELD(flit,value,FROM_L1_EOP);
334        SET_FIELD(flit,value,FROM_L1_BC);
335        SET_FIELD(flit,value,CLEANUP_DEST);
336        SET_FIELD(flit,value,CLEANUP_SRCID);
337        SET_FIELD(flit,value,CLEANUP_NLINE_MSB);
338        SET_FIELD(flit,value,CLEANUP_WAY_INDEX);
339        SET_FIELD(flit,value,CLEANUP_NLINE_LSB);
340        SET_FIELD(flit,value,MULTI_ACK_DEST);
341        SET_FIELD(flit,value,MULTI_ACK_UPDT_INDEX);
342        SET_FIELD(flit,value,FROM_MC_TYPE);
343        SET_FIELD(flit,value,FROM_MC_EOP);
344        SET_FIELD(flit,value,FROM_MC_BC);
345        SET_FIELD(flit,value,MULTI_INVAL_DEST);
346        SET_FIELD(flit,value,MULTI_INVAL_SRCID);
347        SET_FIELD(flit,value,MULTI_INVAL_UPDT_INDEX);
348        SET_FIELD(flit,value,MULTI_INVAL_NLINE);
349        SET_FIELD(flit,value,MULTI_UPDT_DEST);
350        SET_FIELD(flit,value,MULTI_UPDT_SRCID);
351        SET_FIELD(flit,value,MULTI_UPDT_UPDT_INDEX);
352        SET_FIELD(flit,value,MULTI_UPDT_WORD_INDEX);
353        SET_FIELD(flit,value,MULTI_UPDT_NLINE);
354        SET_FIELD(flit,value,MULTI_UPDT_BE);
355        SET_FIELD(flit,value,MULTI_UPDT_DATA);
356        SET_FIELD(flit,value,CLEANUP_ACK_DEST);
357        SET_FIELD(flit,value,CLEANUP_ACK_SET);
358        SET_FIELD(flit,value,CLEANUP_ACK_WAY);
359        SET_FIELD(flit,value,BROADCAST_BOX);
360        SET_FIELD(flit,value,BROADCAST_SRCID);
361        SET_FIELD(flit,value,BROADCAST_NLINE);
362
363        default: assert(false && "Incorrect DHCCP DSPIN field");
364      }
365    }
366};
367
368#undef GET_FIELD
369#undef SET_FIELD
370
371}} // end namespace soclib::caba
372
373#endif
374// Local Variables:
375// tab-width: 2
376// c-basic-offset: 2
377// c-file-offsets:((innamespace . 0)(inline-open . 0))
378// indent-tabs-mode: nil
379// End:
380
381// vim: filetype=cpp:expandtab:shiftwidth=2:tabstop=2:softtabstop=2
Note: See TracBrowser for help on using the repository browser.