feeder.hh revision 13373:962c151f213c 
1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_SIMPLE_OBJECT_FEEDER_HH__
31#define __SYSTEMC_SIMPLE_OBJECT_FEEDER_HH__
32
33#include <string>
34#include <vector>
35
36#include "sim/eventq.hh"
37#include "sim/sim_object.hh"
38#include "systemc_simple_object/printer.hh"
39
40// The "external" header interface for systemc is in systemc/ext and is what
41// a model which doesn't know anything about gem5 would use. This includes a
42// particular file from those headers, but alternatively we could include
43// systemc/ext/systemc or systemc/ext/systemc.h.
44#include "systemc/ext/channel/sc_buffer.hh"
45
46// This implementation (mostly) just uses standard gem5 mechanisms.
47class Gem5_FeederParams;
48
49class Feeder : public SimObject
50{
51  public:
52    Feeder(Gem5_FeederParams *params);
53
54    void feed();
55
56  private:
57    Printer *printer;
58    Tick delay;
59    std::vector<std::string> strings;
60    int index;
61
62    // SystemC types can be used in gem5 classes, but that should be avoided
63    // except to help interact with systemc objects/models.
64    sc_core::sc_buffer<const char *> buf;
65
66    EventWrapper<Feeder, &Feeder::feed> event;
67
68    void startup() override;
69};
70
71#endif // __SYSTEMC_SIMPLE_OBJECT_PRINTER_HH__
72