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 ListenEvent : public PollEvent
62 ListenEvent(SimConsole *c, int fd, int e);
63 void process(int revent);
66 friend class ListenEvent;
67 ListenEvent *listenEvent;
69 class DataEvent : public PollEvent
75 DataEvent(SimConsole *c, int fd, int e);
76 void process(int revent);
79 friend class DataEvent;
87 SimConsole(const std::string &name, std::ostream *os, int num, int port);
91 ListenSocket listener;
93 void listen(int port);
99 std::ostream *outfile;
105 ///////////////////////
106 // Terminal Interface
110 void read(uint8_t &c) { read(&c, 1); }
111 size_t read(uint8_t *buf, size_t len);
112 void write(uint8_t c) { write(&c, 1); }
113 size_t write(const uint8_t *buf, size_t len);
120 // Get a character from the console.
123 // get a character from the console in the console specific format
124 // corresponds to GETC:
126 // 000: success: character received
127 // 001: success: character received, more pending
128 // 100: failure: no character ready
129 // 110: failure: character received with error
130 // 111: failure: character received with error, more pending
132 // character read from console
134 // Interrupts are cleared when the buffer is empty.
135 uint64_t console_in();
137 // Send a character to the console
140 //Ask the console if data is available
141 bool dataAvailable() { return !rxbuf.empty(); }
144 #endif // __CONSOLE_HH__