2 * Copyright (c) 2001-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Nathan Binkert
33 * User Console Interface
36 #ifndef __CONSOLE_HH__
37 #define __CONSOLE_HH__
41 #include "base/circlebuf.hh"
42 #include "cpu/intr_control.hh"
43 #include "base/pollevent.hh"
44 #include "base/socket.hh"
45 #include "sim/sim_object.hh"
47 class ConsoleListener;
50 class SimConsole : public SimObject
56 class Event : public PollEvent
62 Event(SimConsole *c, int fd, int e);
63 void process(int revent);
73 ConsoleListener *listener;
76 SimConsole(const std::string &name, std::ostream *os, int num);
82 std::ostream *outfile;
88 ///////////////////////
91 void attach(int fd, ConsoleListener *l = NULL) { attach(fd, fd, l); }
92 void attach(int in, int out, ConsoleListener *l = NULL);
98 void read(uint8_t &c) { read(&c, 1); }
99 size_t read(uint8_t *buf, size_t len);
100 void write(uint8_t c) { write(&c, 1); }
101 size_t write(const uint8_t *buf, size_t len);
107 // Get a character from the console.
110 // get a character from the console in the console specific format
111 // corresponds to GETC:
113 // 000: success: character received
114 // 001: success: character received, more pending
115 // 100: failure: no character ready
116 // 110: failure: character received with error
117 // 111: failure: character received with error, more pending
119 // character read from console
121 // Interrupts are cleared when the buffer is empty.
122 uint64_t console_in();
124 // Send a character to the console
127 //Ask the console if data is available
128 bool dataAvailable() { return !rxbuf.empty(); }
130 virtual void serialize(std::ostream &os);
131 virtual void unserialize(Checkpoint *cp, const std::string §ion);
134 class ConsoleListener : public SimObject
137 class Event : public PollEvent
140 ConsoleListener *listener;
143 Event(ConsoleListener *l, int fd, int e)
144 : PollEvent(fd, e), listener(l) {}
145 void process(int revent);
151 typedef std::list<SimConsole *> list_t;
152 typedef list_t::iterator iter_t;
156 ListenSocket listener;
159 ConsoleListener(const std::string &name);
162 void add(SimConsole *cons);
165 void listen(int port);
168 #endif // __CONSOLE_HH__