source: branches/reconfiguration/modules/dspin_router/caba/source/include/dspin_router.h @ 934

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

reconf: add unitary test for the segment migration mechanism in the
dspin router.

File size: 5.0 KB
Line 
1/* -*- c++ -*-
2  *
3  * File : dspin_router.h
4  * Copyright (c) UPMC, Lip6
5  * Authors : Alain Greiner, Abbas Sheibanyrad, Ivan Miro, Zhen Zhang
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    ///////////////////////////////////////////////////////////////////////////
30    // Implementation Note :
31    // The xfirst_route(), broadcast_route() and is_broadcast() functions
32    // defined below are used to decode the DSPIN first flit format:
33    // - In case of a non-broadcast packet :
34    //  |   X     |   Y     |---------------------------------------|BC |
35    //  | x_width | y_width |  flit_width - (x_width + y_width + 2) | 0 |
36    //
37    //  - In case of a broacast
38    //  |  XMIN   |  XMAX   |  YMIN   |  YMAX   |-------------------|BC |
39    //  |   5     |   5     |   5     |   5     | flit_width - 22   | 1 |
40    ///////////////////////////////////////////////////////////////////////////
41
42#ifndef DSPIN_ROUTER_H_
43#define DSPIN_ROUTER_H_
44
45#include <systemc>
46#include "caba_base_module.h"
47#include "generic_fifo.h"
48#include "dspin_interface.h"
49#include "alloc_elems.h"
50
51namespace soclib { namespace caba {
52
53using namespace sc_core;
54
55template<int flit_width>
56class DspinRouter
57: public soclib::caba::BaseModule
58{
59    // Input Port FSM
60    enum
61    {
62        INFSM_IDLE,
63        INFSM_REQ,
64        INFSM_ALLOC,
65        INFSM_REQ_FIRST,
66        INFSM_ALLOC_FIRST,
67        INFSM_REQ_SECOND,
68        INFSM_ALLOC_SECOND,
69        INFSM_REQ_THIRD,
70        INFSM_ALLOC_THIRD,
71        INFSM_REQ_FOURTH,
72        INFSM_ALLOC_FOURTH,
73    };
74
75    protected:
76    SC_HAS_PROCESS(DspinRouter);
77
78    public:
79
80    // ports
81    sc_in<bool>                 p_clk;
82    sc_in<bool>                 p_resetn;
83    DspinInput<flit_width>      *p_in;
84    DspinOutput<flit_width>     *p_out;
85
86    // reconfiguration port
87    sc_in<uint32_t>             *p_recovery_cfg;
88
89    // constructor / destructor
90    DspinRouter( sc_module_name  name,
91                 const size_t    x,
92                 const size_t    y,
93                 const size_t    x_width,
94                 const size_t    y_width,
95                 const size_t    in_fifo_depth,
96                 const size_t    out_fifo_depth,
97                 const bool      broadcast_supported = false );
98
99    ~DspinRouter();
100
101    private:
102
103    // define the FIFO flit
104    typedef struct internal_flit_s
105    {
106        sc_uint<flit_width>  data;
107        bool                 eop;
108    } internal_flit_t;
109
110    // registers
111    sc_signal<bool>             *r_alloc_out;   // output port is allocated
112    sc_signal<size_t>           *r_index_out;   // index of owner input port
113
114    sc_signal<int>              *r_fsm_in;      // input port state
115    sc_signal<size_t>           *r_index_in;    // index of requested output port
116    internal_flit_t             *r_buf_in;      // save first flit for a broadcast
117
118    // fifos
119    soclib::caba::GenericFifo<internal_flit_t>*  r_fifo_in;
120    soclib::caba::GenericFifo<internal_flit_t>*  r_fifo_out;
121
122    // structural parameters
123    size_t                      m_local_x;
124    size_t                      m_local_y;
125    size_t                      m_x_width;
126    size_t                      m_x_shift;
127    size_t                      m_x_mask;
128    size_t                      m_y_width;
129    size_t                      m_y_shift;
130    size_t                      m_y_mask;
131    bool                        m_broadcast_supported;
132    int                         m_disable_mask;
133
134    // methods
135    void    transition();
136    void    genMoore();
137    int     xfirst_route( size_t xdest, size_t ydest );
138    int     route( sc_uint<flit_width> data );
139    int     broadcast_route( int iter, int source, sc_uint<flit_width> data );
140    bool    is_broadcast( sc_uint<flit_width> data );
141
142    // fault-recovery methods
143    bool    need_reroute( size_t xdest, size_t ydest, int bhpos );
144    int     recovery_route( size_t xdest, size_t ydest );
145
146    public:
147
148    inline void set_disable_mask( int mask )
149    {
150        m_disable_mask = mask;
151    }
152
153    void bind_recovery_port( sc_core::sc_signal<uint32_t> &s );
154
155    void print_trace();
156};
157
158}} // end namespace
159
160#endif // DSPIN_ROUTER_BC_H_
161
162// Local Variables:
163// tab-width: 4
164// c-basic-offset: 4
165// c-file-offsets:((innamespace . 0)(inline-open . 0))
166// indent-tabs-mode: nil
167// End:
168
169// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
Note: See TracBrowser for help on using the repository browser.