summaryrefslogtreecommitdiff
path: root/src/systemc/ext/channel/sc_signal.hh
blob: 5da4116601c0798be1241f3123cf9453766b6fb0 (plain)
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
/*
 * Copyright 2018 Google, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Gabe Black
 */

#ifndef __SYSTEMC_EXT_CHANNEL_SC_SIGNAL_HH__
#define __SYSTEMC_EXT_CHANNEL_SC_SIGNAL_HH__

#include <iostream>
#include <string>
#include <vector>

#include "../core/sc_module.hh" // for sc_gen_unique_name
#include "../core/sc_prim.hh"
#include "sc_signal_inout_if.hh"
#include "warn_unimpl.hh" // for warn_unimpl

namespace sc_core
{

class sc_port_base;
class sc_trace_file;

// Nonstandard
// Despite having a warning "FOR INTERNAL USE ONLY!" in all caps above this
// class definition in the Accellera implementation, it appears in their
// examples and test programs, and so we need to have it here as well.
struct sc_trace_params
{
    sc_trace_file *tf;
    std::string name;

    sc_trace_params(sc_trace_file *tf, const std::string &name) :
        tf(tf), name(name)
    {}
};
typedef std::vector<sc_trace_params *> sc_trace_params_vec;

template <class T, sc_writer_policy WRITER_POLICY=SC_ONE_WRITER>
class sc_signal : public sc_signal_inout_if<T>,
                  public sc_prim_channel
{
  public:
    sc_signal() : sc_signal_inout_if<T>(),
                  sc_prim_channel(sc_gen_unique_name("signal"))
    {}
    explicit sc_signal(const char *name) : sc_signal_inout_if<T>(),
                                           sc_prim_channel(name)
    {}
    explicit sc_signal(const char *name, const T &initial_value) :
        sc_signal_inout_if<T>(), sc_prim_channel(name)
    {
        // Need to consume initial_value.
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual ~sc_signal() {}

    virtual void
    register_port(sc_port_base &, const char *)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual const T&
    read() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const T *)nullptr;
    }
    operator const T&() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const T *)nullptr;
    }

    virtual sc_writer_policy
    get_writer_policy() const
    {
        return WRITER_POLICY;
    }
    virtual void
    write(const T&)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    sc_signal<T, WRITER_POLICY> &
    operator = (const T&)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *this;
    }
    sc_signal<T, WRITER_POLICY> &
    operator = (const sc_signal<T, WRITER_POLICY> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *this;
    }

    virtual const sc_event &
    default_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    virtual const sc_event &
    value_changed_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    virtual bool
    event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }

    virtual void
    print(std::ostream & =std::cout) const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual void
    dump(std::ostream & =std::cout) const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual const char *kind() const { return "sc_signal"; }

  protected:
    virtual void
    update()
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    // These members which store the current and future value of the signal
    // are not specified in the standard but are referred to directly by one
    // of the tests.
    T m_cur_val;
    T m_new_val;

  private:
    // Disabled
    sc_signal(const sc_signal<T, WRITER_POLICY> &) :
            sc_signal_inout_if<T>(), sc_prim_channel("")
    {}
};

template <class T, sc_writer_policy WRITER_POLICY>
inline std::ostream &
operator << (std::ostream &os, const sc_signal<T, WRITER_POLICY> &)
{
    sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    return os;
}

template <sc_writer_policy WRITER_POLICY>
class sc_signal<bool, WRITER_POLICY> :
    public sc_signal_inout_if<bool>, public sc_prim_channel
{
  public:
    sc_signal()
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    explicit sc_signal(const char *)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    explicit sc_signal(const char *name, const bool &initial_value) :
        sc_signal_inout_if<bool>(), sc_prim_channel(name)
    {
        // Need to consume initial_value.
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual ~sc_signal()
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual void
    register_port(sc_port_base &, const char *)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual const bool &
    read() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const bool *)nullptr;
    }
    operator const bool &() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const bool *)nullptr;
    }

    virtual sc_writer_policy
    get_writer_policy() const
    {
        return WRITER_POLICY;
    }
    virtual void
    write(const bool &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    sc_signal<bool, WRITER_POLICY> &
    operator = (const bool &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *this;
    }
    sc_signal<bool, WRITER_POLICY> &
    operator = (const sc_signal<bool, WRITER_POLICY> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *this;
    }

    virtual const sc_event &
    default_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }

    virtual const sc_event &
    value_changed_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    virtual const sc_event &
    posedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    virtual const sc_event &
    negedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }

    virtual bool
    event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    virtual bool
    posedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    virtual bool
    negedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }

    virtual void
    print(std::ostream & =std::cout) const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual void
    dump(std::ostream & =std::cout) const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual const char *kind() const { return "sc_signal"; }

  protected:
    virtual void
    update()
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

  private:
    // Disabled
    sc_signal(const sc_signal<bool, WRITER_POLICY> &) :
            sc_signal_inout_if<bool>(), sc_prim_channel("")
    {}
};

template <sc_writer_policy WRITER_POLICY>
class sc_signal<sc_dt::sc_logic, WRITER_POLICY> :
    public sc_signal_inout_if<sc_dt::sc_logic>, public sc_prim_channel
{
  public:
    sc_signal()
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    explicit sc_signal(const char *)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    explicit sc_signal(const char *name,
            const sc_dt::sc_logic &initial_value) :
        sc_signal_inout_if<sc_dt::sc_logic>(), sc_prim_channel(name)
    {
        // Need to consume initial_value.
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual ~sc_signal()
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual void
    register_port(sc_port_base &, const char *)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual const sc_dt::sc_logic &
    read() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const sc_dt::sc_logic *)nullptr;
    }
    operator const sc_dt::sc_logic &() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const sc_dt::sc_logic *)nullptr;
    }

    virtual sc_writer_policy
    get_writer_policy() const
    {
        return WRITER_POLICY;
    }
    virtual void
    write(const sc_dt::sc_logic &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    sc_signal<sc_dt::sc_logic, WRITER_POLICY> &
    operator = (const sc_dt::sc_logic &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *this;
    }
    sc_signal<sc_dt::sc_logic, WRITER_POLICY> &
    operator = (const sc_signal<sc_dt::sc_logic, WRITER_POLICY> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *this;
    }

    virtual const sc_event &
    default_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }

    virtual const sc_event &
    value_changed_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    virtual const sc_event &
    posedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    virtual const sc_event &
    negedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }

    virtual bool
    event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    virtual bool
    posedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    virtual bool
    negedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }

    virtual void
    print(std::ostream & =std::cout) const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual void
    dump(std::ostream & =std::cout) const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    virtual const char *kind() const { return "sc_signal"; }

  protected:
    virtual void
    update()
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

  private:
    // Disabled
    sc_signal(const sc_signal<sc_dt::sc_logic, WRITER_POLICY> &) :
            sc_signal_inout_if<sc_dt::sc_logic>(), sc_prim_channel("")
    {}
};

} // namespace sc_core

#endif  //__SYSTEMC_EXT_CHANNEL_SC_SIGNAL_HH__